1 -*- buffer-read-only: t -*-
3 !!!!!!! DO NOT EDIT THIS FILE !!!!!!!
4 This file is built by autodoc.pl extracting documentation from the C source
9 perlapi - autogenerated documentation for the perl public API
12 X<Perl API> X<API> X<api>
14 This file contains the documentation of the perl public API generated by
15 embed.pl, specifically a listing of functions, macros, flags, and variables
16 that may be used by extension writers. The interfaces of any functions that
17 are not listed here are subject to change without notice. For this reason,
18 blindly using functions listed in proto.h is to be avoided when writing
21 Note that all Perl API global variables must be referenced with the C<PL_>
22 prefix. Some macros are provided for compatibility with the older,
23 unadorned names, but this support may be disabled in a future release.
25 The listing is alphabetical, case insensitive.
35 A backward-compatible version of C<GIMME_V> which can only return
36 C<G_SCALAR> or C<G_ARRAY>; in a void context, it returns C<G_SCALAR>.
37 Deprecated. Use C<GIMME_V> instead.
47 The XSUB-writer's equivalent to Perl's C<wantarray>. Returns C<G_VOID>,
48 C<G_SCALAR> or C<G_ARRAY> for void, scalar or list context,
59 Used to indicate list context. See C<GIMME_V>, C<GIMME> and
68 Indicates that arguments returned from a callback should be discarded. See
77 Used to force a Perl C<eval> wrapper around a callback. See
86 Indicates that no arguments are being sent to a callback. See
95 Used to indicate scalar context. See C<GIMME_V>, C<GIMME>, and
104 Used to indicate void context. See C<GIMME_V> and L<perlcall>.
112 =head1 Array Manipulation Functions
119 Same as C<av_len()>. Deprecated, use C<av_len()> instead.
129 Clears an array, making it empty. Does not free the memory used by the
132 void av_clear(AV* ar)
137 =item av_create_and_push
138 X<av_create_and_push>
140 Push an SV onto the end of the array, creating the array if necessary.
141 A small internal helper function to remove a commonly duplicated idiom.
143 NOTE: this function is experimental and may change or be
144 removed without notice.
146 void av_create_and_push(AV **const avp, SV *const val)
151 =item av_create_and_unshift_one
152 X<av_create_and_unshift_one>
154 Unshifts an SV onto the beginning of the array, creating the array if
156 A small internal helper function to remove a commonly duplicated idiom.
158 NOTE: this function is experimental and may change or be
159 removed without notice.
161 SV** av_create_and_unshift_one(AV **const avp, SV *const val)
169 Deletes the element indexed by C<key> from the array. Returns the
170 deleted element. If C<flags> equals C<G_DISCARD>, the element is freed
171 and null is returned.
173 SV* av_delete(AV* ar, I32 key, I32 flags)
181 Returns true if the element indexed by C<key> has been initialized.
183 This relies on the fact that uninitialized array elements are set to
186 bool av_exists(AV* ar, I32 key)
194 Pre-extend an array. The C<key> is the index to which the array should be
197 void av_extend(AV* ar, I32 key)
205 Returns the SV at the specified index in the array. The C<key> is the
206 index. If C<lval> is set then the fetch will be part of a store. Check
207 that the return value is non-null before dereferencing it to a C<SV*>.
209 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for
210 more information on how to use this function on tied arrays.
212 SV** av_fetch(AV* ar, I32 key, I32 lval)
220 Set the highest index in the array to the given number, equivalent to
221 Perl's C<$#array = $fill;>.
223 The number of elements in the an array will be C<fill + 1> after
224 av_fill() returns. If the array was previously shorter then the
225 additional elements appended are set to C<PL_sv_undef>. If the array
226 was longer, then the excess elements are freed. C<av_fill(av, -1)> is
227 the same as C<av_clear(av)>.
229 void av_fill(AV* ar, I32 fill)
237 Returns the highest index in the array. The number of elements in the
238 array is C<av_len(av) + 1>. Returns -1 if the array is empty.
240 I32 av_len(const AV* ar)
248 Creates a new AV and populates it with a list of SVs. The SVs are copied
249 into the array, so they may be freed after the call to av_make. The new AV
250 will have a reference count of 1.
252 AV* av_make(I32 size, SV** svp)
260 Pops an SV off the end of the array. Returns C<&PL_sv_undef> if the array
271 Pushes an SV onto the end of the array. The array will grow automatically
272 to accommodate the addition.
274 void av_push(AV* ar, SV* val)
282 Shifts an SV off the beginning of the array.
292 Stores an SV in an array. The array index is specified as C<key>. The
293 return value will be NULL if the operation failed or if the value did not
294 need to be actually stored within the array (as in the case of tied
295 arrays). Otherwise it can be dereferenced to get the original C<SV*>. Note
296 that the caller is responsible for suitably incrementing the reference
297 count of C<val> before the call, and decrementing it if the function
300 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for
301 more information on how to use this function on tied arrays.
303 SV** av_store(AV* ar, I32 key, SV* val)
311 Undefines the array. Frees the memory used by the array itself.
313 void av_undef(AV* ar)
321 Unshift the given number of C<undef> values onto the beginning of the
322 array. The array will grow automatically to accommodate the addition. You
323 must then use C<av_store> to assign values to these new elements.
325 void av_unshift(AV* ar, I32 num)
333 Returns the AV of the specified Perl array. If C<create> is set and the
334 Perl variable does not exist then it will be created. If C<create> is not
335 set and the variable does not exist then NULL is returned.
337 NOTE: the perl_ form of this function is deprecated.
339 AV* get_av(const char* name, I32 create)
347 Creates a new AV. The reference count is set to 1.
357 Sort an array. Here is an example:
359 sortsv(AvARRAY(av), av_len(av)+1, Perl_sv_cmp_locale);
361 Currently this always uses mergesort. See sortsv_flags for a more
364 void sortsv(SV** array, size_t num_elts, SVCOMPARE_t cmp)
367 Found in file pp_sort.c
372 Sort an array, with various options.
374 void sortsv_flags(SV** array, size_t num_elts, SVCOMPARE_t cmp, U32 flags)
377 Found in file pp_sort.c
382 =head1 Callback Functions
389 Performs a callback to the specified Perl sub. See L<perlcall>.
391 NOTE: the perl_ form of this function is deprecated.
393 I32 call_argv(const char* sub_name, I32 flags, char** argv)
401 Performs a callback to the specified Perl method. The blessed object must
402 be on the stack. See L<perlcall>.
404 NOTE: the perl_ form of this function is deprecated.
406 I32 call_method(const char* methname, I32 flags)
414 Performs a callback to the specified Perl sub. See L<perlcall>.
416 NOTE: the perl_ form of this function is deprecated.
418 I32 call_pv(const char* sub_name, I32 flags)
426 Performs a callback to the Perl sub whose name is in the SV. See
429 NOTE: the perl_ form of this function is deprecated.
431 I32 call_sv(SV* sv, I32 flags)
439 Opening bracket on a callback. See C<LEAVE> and L<perlcall>.
444 Found in file scope.h
449 Tells Perl to C<eval> the given string and return an SV* result.
451 NOTE: the perl_ form of this function is deprecated.
453 SV* eval_pv(const char* p, I32 croak_on_error)
461 Tells Perl to C<eval> the string in the SV.
463 NOTE: the perl_ form of this function is deprecated.
465 I32 eval_sv(SV* sv, I32 flags)
473 Closing bracket for temporaries on a callback. See C<SAVETMPS> and
479 Found in file scope.h
484 Closing bracket on a callback. See C<ENTER> and L<perlcall>.
489 Found in file scope.h
494 Opening bracket for temporaries on a callback. See C<FREETMPS> and
500 Found in file scope.h
505 =head1 Character classes
512 Returns a boolean indicating whether the C C<char> is an ASCII alphanumeric
513 character (including underscore) or digit.
515 bool isALNUM(char ch)
518 Found in file handy.h
523 Returns a boolean indicating whether the C C<char> is an ASCII alphabetic
526 bool isALPHA(char ch)
529 Found in file handy.h
534 Returns a boolean indicating whether the C C<char> is an ASCII
537 bool isDIGIT(char ch)
540 Found in file handy.h
545 Returns a boolean indicating whether the C C<char> is a lowercase
548 bool isLOWER(char ch)
551 Found in file handy.h
556 Returns a boolean indicating whether the C C<char> is whitespace.
558 bool isSPACE(char ch)
561 Found in file handy.h
566 Returns a boolean indicating whether the C C<char> is an uppercase
569 bool isUPPER(char ch)
572 Found in file handy.h
577 Converts the specified character to lowercase.
579 char toLOWER(char ch)
582 Found in file handy.h
587 Converts the specified character to uppercase.
589 char toUPPER(char ch)
592 Found in file handy.h
597 =head1 Cloning an interpreter
604 Create and return a new interpreter by cloning the current one.
606 perl_clone takes these flags as parameters:
608 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
609 without it we only clone the data and zero the stacks,
610 with it we copy the stacks and the new perl interpreter is
611 ready to run at the exact same point as the previous one.
612 The pseudo-fork code uses COPY_STACKS while the
613 threads->create doesn't.
615 CLONEf_KEEP_PTR_TABLE
616 perl_clone keeps a ptr_table with the pointer of the old
617 variable as a key and the new variable as a value,
618 this allows it to check if something has been cloned and not
619 clone it again but rather just use the value and increase the
620 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
621 the ptr_table using the function
622 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
623 reason to keep it around is if you want to dup some of your own
624 variable who are outside the graph perl scans, example of this
625 code is in threads.xs create
628 This is a win32 thing, it is ignored on unix, it tells perls
629 win32host code (which is c++) to clone itself, this is needed on
630 win32 if you want to run two threads at the same time,
631 if you just want to do some stuff in a separate perl interpreter
632 and then throw it away and return to the original one,
633 you don't need to do anything.
635 PerlInterpreter* perl_clone(PerlInterpreter* interp, UV flags)
643 =head1 CV Manipulation Functions
650 Returns the stash of the CV.
660 Uses C<strlen> to get the length of C<name>, then calls C<get_cvn_flags>.
662 NOTE: the perl_ form of this function is deprecated.
664 CV* get_cv(const char* name, I32 flags)
672 Returns the CV of the specified Perl subroutine. C<flags> are passed to
673 C<gv_fetchpvn_flags>. If C<GV_ADD> is set and the Perl subroutine does not
674 exist then it will be declared (which has the same effect as saying
675 C<sub name;>). If C<GV_ADD> is not set and the subroutine does not exist
676 then NULL is returned.
678 NOTE: the perl_ form of this function is deprecated.
680 CV* get_cvn_flags(const char* name, STRLEN len, I32 flags)
688 =head1 Embedding Functions
695 Clear out all the active components of a CV. This can happen either
696 by an explicit C<undef &foo>, or by the reference count going to zero.
697 In the former case, we keep the CvOUTSIDE pointer, so that any anonymous
698 children can still follow the full lexical scope chain.
700 void cv_undef(CV* cv)
708 Loads the module whose name is pointed to by the string part of name.
709 Note that the actual module name, not its filename, should be given.
710 Eg, "Foo::Bar" instead of "Foo/Bar.pm". flags can be any of
711 PERL_LOADMOD_DENY, PERL_LOADMOD_NOIMPORT, or PERL_LOADMOD_IMPORT_OPS
712 (or 0 for no flags). ver, if specified, provides version semantics
713 similar to C<use Foo::Bar VERSION>. The optional trailing SV*
714 arguments can be used to specify arguments to the module's import()
715 method, similar to C<use Foo::Bar VERSION LIST>.
717 void load_module(U32 flags, SV* name, SV* ver, ...)
725 Stub that provides thread hook for perl_destruct when there are
736 Allocates a new Perl interpreter. See L<perlembed>.
738 PerlInterpreter* perl_alloc()
746 Initializes a new Perl interpreter. See L<perlembed>.
748 void perl_construct(PerlInterpreter* interp)
756 Shuts down a Perl interpreter. See L<perlembed>.
758 int perl_destruct(PerlInterpreter* interp)
766 Releases a Perl interpreter. See L<perlembed>.
768 void perl_free(PerlInterpreter* interp)
776 Tells a Perl interpreter to parse a Perl script. See L<perlembed>.
778 int perl_parse(PerlInterpreter* interp, XSINIT_t xsinit, int argc, char** argv, char** env)
786 Tells a Perl interpreter to run. See L<perlembed>.
788 int perl_run(PerlInterpreter* interp)
796 Tells Perl to C<require> the file named by the string argument. It is
797 analogous to the Perl code C<eval "require '$file'">. It's even
798 implemented that way; consider using load_module instead.
800 NOTE: the perl_ form of this function is deprecated.
802 void require_pv(const char* pv)
810 =head1 Functions in file dump.c
818 char *pv_display(SV *dsv, const char *pv, STRLEN cur, STRLEN len,
819 STRLEN pvlim, U32 flags)
823 pv_escape(dsv,pv,cur,pvlim,PERL_PV_ESCAPE_QUOTE);
825 except that an additional "\0" will be appended to the string when
826 len > cur and pv[cur] is "\0".
828 Note that the final string may be up to 7 chars longer than pvlim.
830 char* pv_display(SV *dsv, const char *pv, STRLEN cur, STRLEN len, STRLEN pvlim)
838 |const STRLEN count|const STRLEN max
839 |STRLEN const *escaped, const U32 flags
841 Escapes at most the first "count" chars of pv and puts the results into
842 dsv such that the size of the escaped string will not exceed "max" chars
843 and will not contain any incomplete escape sequences.
845 If flags contains PERL_PV_ESCAPE_QUOTE then any double quotes in the string
846 will also be escaped.
848 Normally the SV will be cleared before the escaped string is prepared,
849 but when PERL_PV_ESCAPE_NOCLEAR is set this will not occur.
851 If PERL_PV_ESCAPE_UNI is set then the input string is treated as Unicode,
852 if PERL_PV_ESCAPE_UNI_DETECT is set then the input string is scanned
853 using C<is_utf8_string()> to determine if it is Unicode.
855 If PERL_PV_ESCAPE_ALL is set then all input chars will be output
856 using C<\x01F1> style escapes, otherwise only chars above 255 will be
857 escaped using this style, other non printable chars will use octal or
858 common escaped patterns like C<\n>. If PERL_PV_ESCAPE_NOBACKSLASH
859 then all chars below 255 will be treated as printable and
860 will be output as literals.
862 If PERL_PV_ESCAPE_FIRSTCHAR is set then only the first char of the
863 string will be escaped, regardles of max. If the string is utf8 and
864 the chars value is >255 then it will be returned as a plain hex
865 sequence. Thus the output will either be a single char,
866 an octal escape sequence, a special escape like C<\n> or a 3 or
867 more digit hex value.
869 If PERL_PV_ESCAPE_RE is set then the escape char used will be a '%' and
870 not a '\\'. This is because regexes very often contain backslashed
871 sequences, whereas '%' is not a particularly common character in patterns.
873 Returns a pointer to the escaped text as held by dsv.
875 NOTE: the perl_ form of this function is deprecated.
877 char* pv_escape(SV *dsv, char const * const str, const STRLEN count, const STRLEN max, STRLEN * const escaped, const U32 flags)
885 |const STRLEN count|const STRLEN max\
886 |const char const *start_color| const char const *end_color\
889 Converts a string into something presentable, handling escaping via
890 pv_escape() and supporting quoting and elipses.
892 If the PERL_PV_PRETTY_QUOTE flag is set then the result will be
893 double quoted with any double quotes in the string escaped. Otherwise
894 if the PERL_PV_PRETTY_LTGT flag is set then the result be wrapped in
897 If the PERL_PV_PRETTY_ELIPSES flag is set and not all characters in
898 string were output then an elipses C<...> will be appended to the
899 string. Note that this happens AFTER it has been quoted.
901 If start_color is non-null then it will be inserted after the opening
902 quote (if there is one) but before the escaped text. If end_color
903 is non-null then it will be inserted after the escaped text but before
904 any quotes or elipses.
906 Returns a pointer to the prettified text as held by dsv.
908 NOTE: the perl_ form of this function is deprecated.
910 char* pv_pretty(SV *dsv, char const * const str, const STRLEN count, const STRLEN max, char const * const start_color, char const * const end_color, const U32 flags)
918 =head1 Functions in file mathoms.c
926 See L<gv_fetchmethod_autoload>.
928 GV* gv_fetchmethod(HV* stash, const char* name)
931 Found in file mathoms.c
936 The engine implementing pack() Perl function. Note: parameters next_in_list and
937 flags are not used. This call should not be used; use packlist instead.
939 void pack_cat(SV *cat, const char *pat, const char *patend, SV **beglist, SV **endlist, SV ***next_in_list, U32 flags)
942 Found in file mathoms.c
944 =item sv_2pvbyte_nolen
947 Return a pointer to the byte-encoded representation of the SV.
948 May cause the SV to be downgraded from UTF-8 as a side-effect.
950 Usually accessed via the C<SvPVbyte_nolen> macro.
952 char* sv_2pvbyte_nolen(SV* sv)
955 Found in file mathoms.c
957 =item sv_2pvutf8_nolen
960 Return a pointer to the UTF-8-encoded representation of the SV.
961 May cause the SV to be upgraded to UTF-8 as a side-effect.
963 Usually accessed via the C<SvPVutf8_nolen> macro.
965 char* sv_2pvutf8_nolen(SV* sv)
968 Found in file mathoms.c
973 Like C<sv_2pv()>, but doesn't return the length too. You should usually
974 use the macro wrapper C<SvPV_nolen(sv)> instead.
975 char* sv_2pv_nolen(SV* sv)
978 Found in file mathoms.c
983 Like C<sv_catpvn>, but also handles 'set' magic.
985 void sv_catpvn_mg(SV *sv, const char *ptr, STRLEN len)
988 Found in file mathoms.c
993 Like C<sv_catsv>, but also handles 'set' magic.
995 void sv_catsv_mg(SV *dstr, SV *sstr)
998 Found in file mathoms.c
1000 =item sv_force_normal
1003 Undo various types of fakery on an SV: if the PV is a shared string, make
1004 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
1005 an xpvmg. See also C<sv_force_normal_flags>.
1007 void sv_force_normal(SV *sv)
1010 Found in file mathoms.c
1015 A private implementation of the C<SvIVx> macro for compilers which can't
1016 cope with complex macro expressions. Always use the macro instead.
1021 Found in file mathoms.c
1026 Dummy routine which "locks" an SV when there is no locking module present.
1027 Exists to avoid test for a NULL function pointer and because it could
1028 potentially warn under some level of strict-ness.
1030 "Superseded" by sv_nosharing().
1032 void sv_nolocking(SV *sv)
1035 Found in file mathoms.c
1037 =item sv_nounlocking
1040 Dummy routine which "unlocks" an SV when there is no locking module present.
1041 Exists to avoid test for a NULL function pointer and because it could
1042 potentially warn under some level of strict-ness.
1044 "Superseded" by sv_nosharing().
1046 void sv_nounlocking(SV *sv)
1049 Found in file mathoms.c
1054 A private implementation of the C<SvNVx> macro for compilers which can't
1055 cope with complex macro expressions. Always use the macro instead.
1060 Found in file mathoms.c
1065 Use the C<SvPV_nolen> macro instead
1070 Found in file mathoms.c
1075 Use C<SvPVbyte_nolen> instead.
1077 char* sv_pvbyte(SV *sv)
1080 Found in file mathoms.c
1085 A private implementation of the C<SvPVbyte> macro for compilers
1086 which can't cope with complex macro expressions. Always use the macro
1089 char* sv_pvbyten(SV *sv, STRLEN *len)
1092 Found in file mathoms.c
1097 A private implementation of the C<SvPV> macro for compilers which can't
1098 cope with complex macro expressions. Always use the macro instead.
1100 char* sv_pvn(SV *sv, STRLEN *len)
1103 Found in file mathoms.c
1108 Use the C<SvPVutf8_nolen> macro instead
1110 char* sv_pvutf8(SV *sv)
1113 Found in file mathoms.c
1118 A private implementation of the C<SvPVutf8> macro for compilers
1119 which can't cope with complex macro expressions. Always use the macro
1122 char* sv_pvutf8n(SV *sv, STRLEN *len)
1125 Found in file mathoms.c
1130 Taint an SV. Use C<SvTAINTED_on> instead.
1131 void sv_taint(SV* sv)
1134 Found in file mathoms.c
1139 Unsets the RV status of the SV, and decrements the reference count of
1140 whatever was being referenced by the RV. This can almost be thought of
1141 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
1142 being zero. See C<SvROK_off>.
1144 void sv_unref(SV* sv)
1147 Found in file mathoms.c
1152 Tells an SV to use C<ptr> to find its string value. Implemented by
1153 calling C<sv_usepvn_flags> with C<flags> of 0, hence does not handle 'set'
1154 magic. See C<sv_usepvn_flags>.
1156 void sv_usepvn(SV* sv, char* ptr, STRLEN len)
1159 Found in file mathoms.c
1164 Like C<sv_usepvn>, but also handles 'set' magic.
1166 void sv_usepvn_mg(SV *sv, char *ptr, STRLEN len)
1169 Found in file mathoms.c
1174 A private implementation of the C<SvUVx> macro for compilers which can't
1175 cope with complex macro expressions. Always use the macro instead.
1180 Found in file mathoms.c
1185 The engine implementing unpack() Perl function. Note: parameters strbeg, new_s
1186 and ocnt are not used. This call should not be used, use unpackstring instead.
1188 I32 unpack_str(const char *pat, const char *patend, const char *s, const char *strbeg, const char *strend, char **new_s, I32 ocnt, U32 flags)
1191 Found in file mathoms.c
1196 =head1 Functions in file pp_ctl.c
1204 Locate the CV corresponding to the currently executing sub or eval.
1205 If db_seqp is non_null, skip CVs that are in the DB package and populate
1206 *db_seqp with the cop sequence number at the point that the DB:: code was
1207 entered. (allows debuggers to eval in the scope of the breakpoint rather
1208 than in the scope of the debugger itself).
1210 CV* find_runcv(U32 *db_seqp)
1213 Found in file pp_ctl.c
1218 =head1 Functions in file pp_pack.c
1226 The engine implementing pack() Perl function.
1228 void packlist(SV *cat, const char *pat, const char *patend, SV **beglist, SV **endlist)
1231 Found in file pp_pack.c
1236 The engine implementing unpack() Perl function. C<unpackstring> puts the
1237 extracted list items on the stack and returns the number of elements.
1238 Issue C<PUTBACK> before and C<SPAGAIN> after the call to this function.
1240 I32 unpackstring(const char *pat, const char *patend, const char *s, const char *strend, U32 flags)
1243 Found in file pp_pack.c
1255 Return the SV from the GV.
1265 If C<gv> is a typeglob whose subroutine entry is a constant sub eligible for
1266 inlining, or C<gv> is a placeholder reference that would be promoted to such
1267 a typeglob, then returns the value returned by the sub. Otherwise, returns
1270 SV* gv_const_sv(GV* gv)
1278 Returns the glob with the given C<name> and a defined subroutine or
1279 C<NULL>. The glob lives in the given C<stash>, or in the stashes
1280 accessible via @ISA and UNIVERSAL::.
1282 The argument C<level> should be either 0 or -1. If C<level==0>, as a
1283 side-effect creates a glob with the given C<name> in the given C<stash>
1284 which in the case of success contains an alias for the subroutine, and sets
1285 up caching info for this glob.
1287 This function grants C<"SUPER"> token as a postfix of the stash name. The
1288 GV returned from C<gv_fetchmeth> may be a method cache entry, which is not
1289 visible to Perl code. So when calling C<call_sv>, you should not use
1290 the GV directly; instead, you should use the method's CV, which can be
1291 obtained from the GV with the C<GvCV> macro.
1293 GV* gv_fetchmeth(HV* stash, const char* name, STRLEN len, I32 level)
1298 =item gv_fetchmethod_autoload
1299 X<gv_fetchmethod_autoload>
1301 Returns the glob which contains the subroutine to call to invoke the method
1302 on the C<stash>. In fact in the presence of autoloading this may be the
1303 glob for "AUTOLOAD". In this case the corresponding variable $AUTOLOAD is
1306 The third parameter of C<gv_fetchmethod_autoload> determines whether
1307 AUTOLOAD lookup is performed if the given method is not present: non-zero
1308 means yes, look for AUTOLOAD; zero means no, don't look for AUTOLOAD.
1309 Calling C<gv_fetchmethod> is equivalent to calling C<gv_fetchmethod_autoload>
1310 with a non-zero C<autoload> parameter.
1312 These functions grant C<"SUPER"> token as a prefix of the method name. Note
1313 that if you want to keep the returned glob for a long time, you need to
1314 check for it being "AUTOLOAD", since at the later time the call may load a
1315 different subroutine due to $AUTOLOAD changing its value. Use the glob
1316 created via a side effect to do this.
1318 These functions have the same side-effects and as C<gv_fetchmeth> with
1319 C<level==0>. C<name> should be writable if contains C<':'> or C<'
1320 ''>. The warning against passing the GV returned by C<gv_fetchmeth> to
1321 C<call_sv> apply equally to these functions.
1323 GV* gv_fetchmethod_autoload(HV* stash, const char* name, I32 autoload)
1328 =item gv_fetchmeth_autoload
1329 X<gv_fetchmeth_autoload>
1331 Same as gv_fetchmeth(), but looks for autoloaded subroutines too.
1332 Returns a glob for the subroutine.
1334 For an autoloaded subroutine without a GV, will create a GV even
1335 if C<level < 0>. For an autoloaded subroutine without a stub, GvCV()
1336 of the result may be zero.
1338 GV* gv_fetchmeth_autoload(HV* stash, const char* name, STRLEN len, I32 level)
1346 Returns a pointer to the stash for a specified package. Uses C<strlen> to
1347 determine the length of C<name>, then calls C<gv_stashpvn()>.
1349 HV* gv_stashpv(const char* name, I32 flags)
1357 Returns a pointer to the stash for a specified package. The C<namelen>
1358 parameter indicates the length of the C<name>, in bytes. C<flags> is passed
1359 to C<gv_fetchpvn_flags()>, so if set to C<GV_ADD> then the package will be
1360 created if it does not already exist. If the package does not exist and
1361 C<flags> is 0 (or any other setting that does not create packages) then NULL
1365 HV* gv_stashpvn(const char* name, U32 namelen, I32 flags)
1373 Like C<gv_stashpvn>, but takes a literal string instead of a string/length pair.
1375 HV* gv_stashpvs(const char* name, I32 create)
1378 Found in file handy.h
1383 Returns a pointer to the stash for a specified package. See C<gv_stashpvn>.
1385 HV* gv_stashsv(SV* sv, I32 flags)
1408 Null character pointer.
1411 Found in file handy.h
1435 Found in file handy.h
1440 =head1 Hash Manipulation Functions
1447 Returns the HV of the specified Perl hash. If C<create> is set and the
1448 Perl variable does not exist then it will be created. If C<create> is not
1449 set and the variable does not exist then NULL is returned.
1451 NOTE: the perl_ form of this function is deprecated.
1453 HV* get_hv(const char* name, I32 create)
1456 Found in file perl.c
1461 This flag, used in the length slot of hash entries and magic structures,
1462 specifies the structure contains an C<SV*> pointer where a C<char*> pointer
1463 is to be expected. (For information only--not to be used).
1471 Returns the computed hash stored in the hash entry.
1481 Returns the actual pointer stored in the key slot of the hash entry. The
1482 pointer may be either C<char*> or C<SV*>, depending on the value of
1483 C<HeKLEN()>. Can be assigned to. The C<HePV()> or C<HeSVKEY()> macros are
1484 usually preferable for finding the value of a key.
1494 If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry
1495 holds an C<SV*> key. Otherwise, holds the actual length of the key. Can
1496 be assigned to. The C<HePV()> macro is usually preferable for finding key
1499 STRLEN HeKLEN(HE* he)
1507 Returns the key slot of the hash entry as a C<char*> value, doing any
1508 necessary dereferencing of possibly C<SV*> keys. The length of the string
1509 is placed in C<len> (this is a macro, so do I<not> use C<&len>). If you do
1510 not care about what the length of the key is, you may use the global
1511 variable C<PL_na>, though this is rather less efficient than using a local
1512 variable. Remember though, that hash keys in perl are free to contain
1513 embedded nulls, so using C<strlen()> or similar is not a good way to find
1514 the length of hash keys. This is very similar to the C<SvPV()> macro
1515 described elsewhere in this document.
1517 char* HePV(HE* he, STRLEN len)
1525 Returns the key as an C<SV*>, or C<NULL> if the hash entry does not
1526 contain an C<SV*> key.
1536 Returns the key as an C<SV*>. Will create and return a temporary mortal
1537 C<SV*> if the hash entry contains only a C<char*> key.
1539 SV* HeSVKEY_force(HE* he)
1547 Sets the key to a given C<SV*>, taking care to set the appropriate flags to
1548 indicate the presence of an C<SV*> key, and returns the same
1551 SV* HeSVKEY_set(HE* he, SV* sv)
1559 Returns the value slot (type C<SV*>) stored in the hash entry.
1569 Returns the package name of a stash, or NULL if C<stash> isn't a stash.
1570 See C<SvSTASH>, C<CvSTASH>.
1572 char* HvNAME(HV* stash)
1580 Check that a hash is in an internally consistent state.
1582 void hv_assert(HV* tb)
1590 Clears a hash, making it empty.
1592 void hv_clear(HV* tb)
1597 =item hv_clear_placeholders
1598 X<hv_clear_placeholders>
1600 Clears any placeholders from a hash. If a restricted hash has any of its keys
1601 marked as readonly and the key is subsequently deleted, the key is not actually
1602 deleted but is marked by assigning it a value of &PL_sv_placeholder. This tags
1603 it so it will be ignored by future operations such as iterating over the hash,
1604 but will still allow the hash to have a value reassigned to the key at some
1605 future point. This function clears any such placeholder keys from the hash.
1606 See Hash::Util::lock_keys() for an example of its use.
1608 void hv_clear_placeholders(HV* hb)
1616 Deletes a key/value pair in the hash. The value SV is removed from the
1617 hash and returned to the caller. The C<klen> is the length of the key.
1618 The C<flags> value will normally be zero; if set to G_DISCARD then NULL
1621 SV* hv_delete(HV* tb, const char* key, I32 klen, I32 flags)
1629 Deletes a key/value pair in the hash. The value SV is removed from the
1630 hash and returned to the caller. The C<flags> value will normally be zero;
1631 if set to G_DISCARD then NULL will be returned. C<hash> can be a valid
1632 precomputed hash value, or 0 to ask for it to be computed.
1634 SV* hv_delete_ent(HV* tb, SV* key, I32 flags, U32 hash)
1642 Returns a boolean indicating whether the specified hash key exists. The
1643 C<klen> is the length of the key.
1645 bool hv_exists(HV* tb, const char* key, I32 klen)
1653 Returns a boolean indicating whether the specified hash key exists. C<hash>
1654 can be a valid precomputed hash value, or 0 to ask for it to be
1657 bool hv_exists_ent(HV* tb, SV* key, U32 hash)
1665 Returns the SV which corresponds to the specified key in the hash. The
1666 C<klen> is the length of the key. If C<lval> is set then the fetch will be
1667 part of a store. Check that the return value is non-null before
1668 dereferencing it to an C<SV*>.
1670 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1671 information on how to use this function on tied hashes.
1673 SV** hv_fetch(HV* tb, const char* key, I32 klen, I32 lval)
1681 Like C<hv_fetch>, but takes a literal string instead of a string/length pair.
1683 SV** hv_fetchs(HV* tb, const char* key, I32 lval)
1686 Found in file handy.h
1691 Returns the hash entry which corresponds to the specified key in the hash.
1692 C<hash> must be a valid precomputed hash number for the given C<key>, or 0
1693 if you want the function to compute it. IF C<lval> is set then the fetch
1694 will be part of a store. Make sure the return value is non-null before
1695 accessing it. The return value when C<tb> is a tied hash is a pointer to a
1696 static location, so be sure to make a copy of the structure if you need to
1699 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1700 information on how to use this function on tied hashes.
1702 HE* hv_fetch_ent(HV* tb, SV* key, I32 lval, U32 hash)
1710 Prepares a starting point to traverse a hash table. Returns the number of
1711 keys in the hash (i.e. the same as C<HvKEYS(tb)>). The return value is
1712 currently only meaningful for hashes without tie magic.
1714 NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
1715 hash buckets that happen to be in use. If you still need that esoteric
1716 value, you can get it through the macro C<HvFILL(tb)>.
1719 I32 hv_iterinit(HV* tb)
1727 Returns the key from the current position of the hash iterator. See
1730 char* hv_iterkey(HE* entry, I32* retlen)
1738 Returns the key as an C<SV*> from the current position of the hash
1739 iterator. The return value will always be a mortal copy of the key. Also
1742 SV* hv_iterkeysv(HE* entry)
1750 Returns entries from a hash iterator. See C<hv_iterinit>.
1752 You may call C<hv_delete> or C<hv_delete_ent> on the hash entry that the
1753 iterator currently points to, without losing your place or invalidating your
1754 iterator. Note that in this case the current entry is deleted from the hash
1755 with your iterator holding the last reference to it. Your iterator is flagged
1756 to free the entry on the next call to C<hv_iternext>, so you must not discard
1757 your iterator immediately else the entry will leak - call C<hv_iternext> to
1758 trigger the resource deallocation.
1760 HE* hv_iternext(HV* tb)
1768 Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
1771 SV* hv_iternextsv(HV* hv, char** key, I32* retlen)
1776 =item hv_iternext_flags
1777 X<hv_iternext_flags>
1779 Returns entries from a hash iterator. See C<hv_iterinit> and C<hv_iternext>.
1780 The C<flags> value will normally be zero; if HV_ITERNEXT_WANTPLACEHOLDERS is
1781 set the placeholders keys (for restricted hashes) will be returned in addition
1782 to normal keys. By default placeholders are automatically skipped over.
1783 Currently a placeholder is implemented with a value that is
1784 C<&Perl_sv_placeholder>. Note that the implementation of placeholders and
1785 restricted hashes may change, and the implementation currently is
1786 insufficiently abstracted for any change to be tidy.
1788 NOTE: this function is experimental and may change or be
1789 removed without notice.
1791 HE* hv_iternext_flags(HV* tb, I32 flags)
1799 Returns the value from the current position of the hash iterator. See
1802 SV* hv_iterval(HV* tb, HE* entry)
1810 Adds magic to a hash. See C<sv_magic>.
1812 void hv_magic(HV* hv, GV* gv, int how)
1820 Evaluates the hash in scalar context and returns the result. Handles magic when the hash is tied.
1822 SV* hv_scalar(HV* hv)
1830 Stores an SV in a hash. The hash key is specified as C<key> and C<klen> is
1831 the length of the key. The C<hash> parameter is the precomputed hash
1832 value; if it is zero then Perl will compute it. The return value will be
1833 NULL if the operation failed or if the value did not need to be actually
1834 stored within the hash (as in the case of tied hashes). Otherwise it can
1835 be dereferenced to get the original C<SV*>. Note that the caller is
1836 responsible for suitably incrementing the reference count of C<val> before
1837 the call, and decrementing it if the function returned NULL. Effectively
1838 a successful hv_store takes ownership of one reference to C<val>. This is
1839 usually what you want; a newly created SV has a reference count of one, so
1840 if all your code does is create SVs then store them in a hash, hv_store
1841 will own the only reference to the new SV, and your code doesn't need to do
1842 anything further to tidy up. hv_store is not implemented as a call to
1843 hv_store_ent, and does not create a temporary SV for the key, so if your
1844 key data is not already in SV form then use hv_store in preference to
1847 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1848 information on how to use this function on tied hashes.
1850 SV** hv_store(HV* tb, const char* key, I32 klen, SV* val, U32 hash)
1858 Like C<hv_store>, but takes a literal string instead of a string/length pair
1859 and omits the hash parameter.
1861 SV** hv_stores(HV* tb, const char* key, NULLOK SV* val)
1864 Found in file handy.h
1869 Stores C<val> in a hash. The hash key is specified as C<key>. The C<hash>
1870 parameter is the precomputed hash value; if it is zero then Perl will
1871 compute it. The return value is the new hash entry so created. It will be
1872 NULL if the operation failed or if the value did not need to be actually
1873 stored within the hash (as in the case of tied hashes). Otherwise the
1874 contents of the return value can be accessed using the C<He?> macros
1875 described here. Note that the caller is responsible for suitably
1876 incrementing the reference count of C<val> before the call, and
1877 decrementing it if the function returned NULL. Effectively a successful
1878 hv_store_ent takes ownership of one reference to C<val>. This is
1879 usually what you want; a newly created SV has a reference count of one, so
1880 if all your code does is create SVs then store them in a hash, hv_store
1881 will own the only reference to the new SV, and your code doesn't need to do
1882 anything further to tidy up. Note that hv_store_ent only reads the C<key>;
1883 unlike C<val> it does not take ownership of it, so maintaining the correct
1884 reference count on C<key> is entirely the caller's responsibility. hv_store
1885 is not implemented as a call to hv_store_ent, and does not create a temporary
1886 SV for the key, so if your key data is not already in SV form then use
1887 hv_store in preference to hv_store_ent.
1889 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1890 information on how to use this function on tied hashes.
1892 HE* hv_store_ent(HV* tb, SV* key, SV* val, U32 hash)
1902 void hv_undef(HV* tb)
1910 Creates a new HV. The reference count is set to 1.
1920 =head1 Magical Functions
1927 Clear something magical that the SV represents. See C<sv_magic>.
1929 int mg_clear(SV* sv)
1937 Copies the magic from one SV to another. See C<sv_magic>.
1939 int mg_copy(SV* sv, SV* nsv, const char* key, I32 klen)
1947 Finds the magic pointer for type matching the SV. See C<sv_magic>.
1949 MAGIC* mg_find(const SV* sv, int type)
1957 Free any magic storage used by the SV. See C<sv_magic>.
1967 Do magic after a value is retrieved from the SV. See C<sv_magic>.
1977 Report on the SV's length. See C<sv_magic>.
1979 U32 mg_length(SV* sv)
1987 Turns on the magical status of an SV. See C<sv_magic>.
1989 void mg_magical(SV* sv)
1997 Do magic after a value is assigned to the SV. See C<sv_magic>.
2007 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
2008 argument more than once.
2010 void SvGETMAGIC(SV* sv)
2018 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
2029 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
2030 argument more than once.
2032 void SvSETMAGIC(SV* sv)
2040 Like C<SvSetSV>, but does any set magic required afterwards.
2042 void SvSetMagicSV(SV* dsb, SV* ssv)
2047 =item SvSetMagicSV_nosteal
2048 X<SvSetMagicSV_nosteal>
2050 Like C<SvSetSV_nosteal>, but does any set magic required afterwards.
2052 void SvSetMagicSV_nosteal(SV* dsv, SV* ssv)
2060 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
2063 void SvSetSV(SV* dsb, SV* ssv)
2068 =item SvSetSV_nosteal
2071 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
2072 ssv. May evaluate arguments more than once.
2074 void SvSetSV_nosteal(SV* dsv, SV* ssv)
2082 Arranges for sv to be shared between threads if a suitable module
2085 void SvSHARE(SV* sv)
2093 Releases a mutual exclusion lock on sv if a suitable module
2096 void SvUNLOCK(SV* sv)
2104 =head1 Memory Management
2111 The XSUB-writer's interface to the C C<memcpy> function. The C<src> is the
2112 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
2113 the type. May fail on overlapping copies. See also C<Move>.
2115 void Copy(void* src, void* dest, int nitems, type)
2118 Found in file handy.h
2123 Like C<Copy> but returns dest. Useful for encouraging compilers to tail-call
2126 void * CopyD(void* src, void* dest, int nitems, type)
2129 Found in file handy.h
2134 The XSUB-writer's interface to the C C<memmove> function. The C<src> is the
2135 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
2136 the type. Can do overlapping moves. See also C<Copy>.
2138 void Move(void* src, void* dest, int nitems, type)
2141 Found in file handy.h
2146 Like C<Move> but returns dest. Useful for encouraging compilers to tail-call
2149 void * MoveD(void* src, void* dest, int nitems, type)
2152 Found in file handy.h
2157 The XSUB-writer's interface to the C C<malloc> function.
2159 In 5.9.3, Newx() and friends replace the older New() API, and drops
2160 the first parameter, I<x>, a debug aid which allowed callers to identify
2161 themselves. This aid has been superseded by a new build option,
2162 PERL_MEM_LOG (see L<perlhack/PERL_MEM_LOG>). The older API is still
2163 there for use in XS modules supporting older perls.
2165 void Newx(void* ptr, int nitems, type)
2168 Found in file handy.h
2173 The XSUB-writer's interface to the C C<malloc> function, with
2174 cast. See also C<Newx>.
2176 void Newxc(void* ptr, int nitems, type, cast)
2179 Found in file handy.h
2184 The XSUB-writer's interface to the C C<malloc> function. The allocated
2185 memory is zeroed with C<memzero>. See also C<Newx>.
2187 void Newxz(void* ptr, int nitems, type)
2190 Found in file handy.h
2195 PoisonWith(0xEF) for catching access to freed memory.
2197 void Poison(void* dest, int nitems, type)
2200 Found in file handy.h
2205 PoisonWith(0xEF) for catching access to freed memory.
2207 void PoisonFree(void* dest, int nitems, type)
2210 Found in file handy.h
2215 PoisonWith(0xAB) for catching access to allocated but uninitialized memory.
2217 void PoisonNew(void* dest, int nitems, type)
2220 Found in file handy.h
2225 Fill up memory with a byte pattern (a byte repeated over and over
2226 again) that hopefully catches attempts to access uninitialized memory.
2228 void PoisonWith(void* dest, int nitems, type, U8 byte)
2231 Found in file handy.h
2236 The XSUB-writer's interface to the C C<realloc> function.
2238 void Renew(void* ptr, int nitems, type)
2241 Found in file handy.h
2246 The XSUB-writer's interface to the C C<realloc> function, with
2249 void Renewc(void* ptr, int nitems, type, cast)
2252 Found in file handy.h
2257 The XSUB-writer's interface to the C C<free> function.
2259 void Safefree(void* ptr)
2262 Found in file handy.h
2267 Perl's version of C<strdup()>. Returns a pointer to a newly allocated
2268 string which is a duplicate of C<pv>. The size of the string is
2269 determined by C<strlen()>. The memory allocated for the new string can
2270 be freed with the C<Safefree()> function.
2272 char* savepv(const char* pv)
2275 Found in file util.c
2280 Perl's version of what C<strndup()> would be if it existed. Returns a
2281 pointer to a newly allocated string which is a duplicate of the first
2282 C<len> bytes from C<pv>, plus a trailing NUL byte. The memory allocated for
2283 the new string can be freed with the C<Safefree()> function.
2285 char* savepvn(const char* pv, I32 len)
2288 Found in file util.c
2293 Like C<savepvn>, but takes a literal string instead of a string/length pair.
2295 char* savepvs(const char* s)
2298 Found in file handy.h
2303 A version of C<savepv()> which allocates the duplicate string in memory
2304 which is shared between threads.
2306 char* savesharedpv(const char* pv)
2309 Found in file util.c
2314 A version of C<savepvn()> which allocates the duplicate string in memory
2315 which is shared between threads. (With the specific difference that a NULL
2316 pointer is not acceptable)
2318 char* savesharedpvn(const char *const pv, const STRLEN len)
2321 Found in file util.c
2326 A version of C<savepv()>/C<savepvn()> which gets the string to duplicate from
2327 the passed in SV using C<SvPV()>
2329 char* savesvpv(SV* sv)
2332 Found in file util.c
2337 This is an architecture-independent macro to copy one structure to another.
2339 void StructCopy(type src, type dest, type)
2342 Found in file handy.h
2347 The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the
2348 destination, C<nitems> is the number of items, and C<type> is the type.
2350 void Zero(void* dest, int nitems, type)
2353 Found in file handy.h
2358 Like C<Zero> but returns dest. Useful for encouraging compilers to tail-call
2361 void * ZeroD(void* dest, int nitems, type)
2364 Found in file handy.h
2369 =head1 Miscellaneous Functions
2376 Analyses the string in order to make fast searches on it using fbm_instr()
2377 -- the Boyer-Moore algorithm.
2379 void fbm_compile(SV* sv, U32 flags)
2382 Found in file util.c
2387 Returns the location of the SV in the string delimited by C<str> and
2388 C<strend>. It returns C<NULL> if the string can't be found. The C<sv>
2389 does not have to be fbm_compiled, but the search will not be as fast
2392 char* fbm_instr(unsigned char* big, unsigned char* bigend, SV* littlesv, U32 flags)
2395 Found in file util.c
2400 Takes a sprintf-style format pattern and conventional
2401 (non-SV) arguments and returns the formatted string.
2403 (char *) Perl_form(pTHX_ const char* pat, ...)
2405 can be used any place a string (char *) is required:
2407 char * s = Perl_form("%d.%d",major,minor);
2409 Uses a single private buffer so if you want to format several strings you
2410 must explicitly copy the earlier strings away (and free the copies when you
2413 char* form(const char* pat, ...)
2416 Found in file util.c
2421 Fill the sv with current working directory
2423 int getcwd_sv(SV* sv)
2426 Found in file util.c
2431 The C library C<snprintf> functionality, if available and
2432 standards-compliant (uses C<vsnprintf>, actually). However, if the
2433 C<vsnprintf> is not available, will unfortunately use the unsafe
2434 C<vsprintf> which can overrun the buffer (there is an overrun check,
2435 but that may be too late). Consider using C<sv_vcatpvf> instead, or
2436 getting C<vsnprintf>.
2438 int my_snprintf(char *buffer, const Size_t len, const char *format, ...)
2441 Found in file util.c
2446 The C library C<sprintf>, wrapped if necessary, to ensure that it will return
2447 the length of the string written to the buffer. Only rare pre-ANSI systems
2448 need the wrapper function - usually this is a direct call to C<sprintf>.
2450 int my_sprintf(char *buffer, const char *pat, ...)
2453 Found in file util.c
2458 The C library C<vsnprintf> if available and standards-compliant.
2459 However, if if the C<vsnprintf> is not available, will unfortunately
2460 use the unsafe C<vsprintf> which can overrun the buffer (there is an
2461 overrun check, but that may be too late). Consider using
2462 C<sv_vcatpvf> instead, or getting C<vsnprintf>.
2464 int my_vsnprintf(char *buffer, const Size_t len, const char *format, va_list ap)
2467 Found in file util.c
2472 Returns a new version object based on the passed in SV:
2474 SV *sv = new_version(SV *ver);
2476 Does not alter the passed in ver SV. See "upg_version" if you
2477 want to upgrade the SV.
2479 SV* new_version(SV *ver)
2482 Found in file util.c
2487 Returns a pointer to the next character after the parsed
2488 version string, as well as upgrading the passed in SV to
2491 Function must be called with an already existing SV like
2494 s = scan_version(s, SV *sv, bool qv);
2496 Performs some preprocessing to the string to ensure that
2497 it has the correct characteristics of a version. Flags the
2498 object if it contains an underscore (which denotes this
2499 is an alpha version). The boolean qv denotes that the version
2500 should be interpreted as if it had multiple decimals, even if
2503 const char* scan_version(const char *vstr, SV *sv, bool qv)
2506 Found in file util.c
2511 Test two strings to see if they are equal. Returns true or false.
2513 bool strEQ(char* s1, char* s2)
2516 Found in file handy.h
2521 Test two strings to see if the first, C<s1>, is greater than or equal to
2522 the second, C<s2>. Returns true or false.
2524 bool strGE(char* s1, char* s2)
2527 Found in file handy.h
2532 Test two strings to see if the first, C<s1>, is greater than the second,
2533 C<s2>. Returns true or false.
2535 bool strGT(char* s1, char* s2)
2538 Found in file handy.h
2543 Test two strings to see if the first, C<s1>, is less than or equal to the
2544 second, C<s2>. Returns true or false.
2546 bool strLE(char* s1, char* s2)
2549 Found in file handy.h
2554 Test two strings to see if the first, C<s1>, is less than the second,
2555 C<s2>. Returns true or false.
2557 bool strLT(char* s1, char* s2)
2560 Found in file handy.h
2565 Test two strings to see if they are different. Returns true or
2568 bool strNE(char* s1, char* s2)
2571 Found in file handy.h
2576 Test two strings to see if they are equal. The C<len> parameter indicates
2577 the number of bytes to compare. Returns true or false. (A wrapper for
2580 bool strnEQ(char* s1, char* s2, STRLEN len)
2583 Found in file handy.h
2588 Test two strings to see if they are different. The C<len> parameter
2589 indicates the number of bytes to compare. Returns true or false. (A
2590 wrapper for C<strncmp>).
2592 bool strnNE(char* s1, char* s2, STRLEN len)
2595 Found in file handy.h
2600 Dummy routine which "shares" an SV when there is no sharing module present.
2601 Or "locks" it. Or "unlocks" it. In other words, ignores its single SV argument.
2602 Exists to avoid test for a NULL function pointer and because it could
2603 potentially warn under some level of strict-ness.
2605 void sv_nosharing(SV *sv)
2608 Found in file util.c
2613 In-place upgrade of the supplied SV to a version object.
2615 SV *sv = upg_version(SV *sv, bool qv);
2617 Returns a pointer to the upgraded SV. Set the boolean qv if you want
2618 to force this SV to be interpreted as an "extended" version.
2620 SV* upg_version(SV *ver, bool qv)
2623 Found in file util.c
2628 Version object aware cmp. Both operands must already have been
2629 converted into version objects.
2631 int vcmp(SV *lvs, SV *rvs)
2634 Found in file util.c
2639 Accepts a version object and returns the normalized string
2640 representation. Call like:
2644 NOTE: you can pass either the object directly or the SV
2645 contained within the RV.
2650 Found in file util.c
2655 Accepts a version object and returns the normalized floating
2656 point representation. Call like:
2660 NOTE: you can pass either the object directly or the SV
2661 contained within the RV.
2666 Found in file util.c
2671 In order to maintain maximum compatibility with earlier versions
2672 of Perl, this function will return either the floating point
2673 notation or the multiple dotted notation, depending on whether
2674 the original version contained 1 or more dots, respectively
2676 SV* vstringify(SV *vs)
2679 Found in file util.c
2684 Validates that the SV contains a valid version object.
2686 bool vverify(SV *vobj);
2688 Note that it only confirms the bare minimum structure (so as not to get
2689 confused by derived classes which may contain additional hash entries):
2691 bool vverify(SV *vs)
2694 Found in file util.c
2699 =head1 MRO Functions
2703 =item mro_get_linear_isa
2704 X<mro_get_linear_isa>
2706 Returns either C<mro_get_linear_isa_c3> or
2707 C<mro_get_linear_isa_dfs> for the given stash,
2708 dependant upon which MRO is in effect
2709 for that stash. The return value is a
2712 You are responsible for C<SvREFCNT_inc()> on the
2713 return value if you plan to store it anywhere
2714 semi-permanently (otherwise it might be deleted
2715 out from under you the next time the cache is
2718 AV* mro_get_linear_isa(HV* stash)
2723 =item mro_get_linear_isa_c3
2724 X<mro_get_linear_isa_c3>
2726 Returns the C3 linearization of @ISA
2727 the given stash. The return value is a read-only AV*.
2728 C<level> should be 0 (it is used internally in this
2729 function's recursion).
2731 You are responsible for C<SvREFCNT_inc()> on the
2732 return value if you plan to store it anywhere
2733 semi-permanently (otherwise it might be deleted
2734 out from under you the next time the cache is
2737 AV* mro_get_linear_isa_c3(HV* stash, I32 level)
2742 =item mro_get_linear_isa_dfs
2743 X<mro_get_linear_isa_dfs>
2745 Returns the Depth-First Search linearization of @ISA
2746 the given stash. The return value is a read-only AV*.
2747 C<level> should be 0 (it is used internally in this
2748 function's recursion).
2750 You are responsible for C<SvREFCNT_inc()> on the
2751 return value if you plan to store it anywhere
2752 semi-permanently (otherwise it might be deleted
2753 out from under you the next time the cache is
2756 AV* mro_get_linear_isa_dfs(HV* stash, I32 level)
2761 =item mro_method_changed_in
2762 X<mro_method_changed_in>
2764 Invalidates method caching on any child classes
2765 of the given stash, so that they might notice
2766 the changes in this one.
2768 Ideally, all instances of C<PL_sub_generation++> in
2769 perl source outside of C<mro.c> should be
2770 replaced by calls to this.
2772 Perl automatically handles most of the common
2773 ways a method might be redefined. However, there
2774 are a few ways you could change a method in a stash
2775 without the cache code noticing, in which case you
2776 need to call this method afterwards:
2778 1) Directly manipulating the stash HV entries from
2781 2) Assigning a reference to a readonly scalar
2782 constant into a stash entry in order to create
2783 a constant subroutine (like constant.pm
2786 This same method is available from pure perl
2787 via, C<mro::method_changed_in(classname)>.
2789 void mro_method_changed_in(HV* stash)
2797 =head1 Multicall Functions
2804 Declare local variables for a multicall. See L<perlcall/Lightweight Callbacks>.
2814 Make a lightweight callback. See L<perlcall/Lightweight Callbacks>.
2824 Closing bracket for a lightweight callback.
2825 See L<perlcall/Lightweight Callbacks>.
2832 =item PUSH_MULTICALL
2835 Opening bracket for a lightweight callback.
2836 See L<perlcall/Lightweight Callbacks>.
2846 =head1 Numeric functions
2853 converts a string representing a binary number to numeric form.
2855 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2856 conversion flags, and I<result> should be NULL or a pointer to an NV.
2857 The scan stops at the end of the string, or the first invalid character.
2858 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2859 invalid character will also trigger a warning.
2860 On return I<*len> is set to the length of the scanned string,
2861 and I<*flags> gives output flags.
2863 If the value is <= C<UV_MAX> it is returned as a UV, the output flags are clear,
2864 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_bin>
2865 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2866 and writes the value to I<*result> (or the value is discarded if I<result>
2869 The binary number may optionally be prefixed with "0b" or "b" unless
2870 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
2871 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the binary
2872 number may use '_' characters to separate digits.
2874 UV grok_bin(const char* start, STRLEN* len_p, I32* flags, NV *result)
2877 Found in file numeric.c
2882 converts a string representing a hex number to numeric form.
2884 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2885 conversion flags, and I<result> should be NULL or a pointer to an NV.
2886 The scan stops at the end of the string, or the first invalid character.
2887 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2888 invalid character will also trigger a warning.
2889 On return I<*len> is set to the length of the scanned string,
2890 and I<*flags> gives output flags.
2892 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2893 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_hex>
2894 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2895 and writes the value to I<*result> (or the value is discarded if I<result>
2898 The hex number may optionally be prefixed with "0x" or "x" unless
2899 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
2900 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the hex
2901 number may use '_' characters to separate digits.
2903 UV grok_hex(const char* start, STRLEN* len_p, I32* flags, NV *result)
2906 Found in file numeric.c
2911 Recognise (or not) a number. The type of the number is returned
2912 (0 if unrecognised), otherwise it is a bit-ORed combination of
2913 IS_NUMBER_IN_UV, IS_NUMBER_GREATER_THAN_UV_MAX, IS_NUMBER_NOT_INT,
2914 IS_NUMBER_NEG, IS_NUMBER_INFINITY, IS_NUMBER_NAN (defined in perl.h).
2916 If the value of the number can fit an in UV, it is returned in the *valuep
2917 IS_NUMBER_IN_UV will be set to indicate that *valuep is valid, IS_NUMBER_IN_UV
2918 will never be set unless *valuep is valid, but *valuep may have been assigned
2919 to during processing even though IS_NUMBER_IN_UV is not set on return.
2920 If valuep is NULL, IS_NUMBER_IN_UV will be set for the same cases as when
2921 valuep is non-NULL, but no actual assignment (or SEGV) will occur.
2923 IS_NUMBER_NOT_INT will be set with IS_NUMBER_IN_UV if trailing decimals were
2924 seen (in which case *valuep gives the true value truncated to an integer), and
2925 IS_NUMBER_NEG if the number is negative (in which case *valuep holds the
2926 absolute value). IS_NUMBER_IN_UV is not set if e notation was used or the
2927 number is larger than a UV.
2929 int grok_number(const char *pv, STRLEN len, UV *valuep)
2932 Found in file numeric.c
2934 =item grok_numeric_radix
2935 X<grok_numeric_radix>
2937 Scan and skip for a numeric decimal separator (radix).
2939 bool grok_numeric_radix(const char **sp, const char *send)
2942 Found in file numeric.c
2947 converts a string representing an octal number to numeric form.
2949 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2950 conversion flags, and I<result> should be NULL or a pointer to an NV.
2951 The scan stops at the end of the string, or the first invalid character.
2952 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2953 invalid character will also trigger a warning.
2954 On return I<*len> is set to the length of the scanned string,
2955 and I<*flags> gives output flags.
2957 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2958 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_oct>
2959 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2960 and writes the value to I<*result> (or the value is discarded if I<result>
2963 If C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the octal
2964 number may use '_' characters to separate digits.
2966 UV grok_oct(const char* start, STRLEN* len_p, I32* flags, NV *result)
2969 Found in file numeric.c
2974 Return a non-zero integer if the sign bit on an NV is set, and 0 if
2977 If Configure detects this system has a signbit() that will work with
2978 our NVs, then we just use it via the #define in perl.h. Otherwise,
2979 fall back on this implementation. As a first pass, this gets everything
2980 right except -0.0. Alas, catching -0.0 is the main use for this function,
2981 so this is not too helpful yet. Still, at least we have the scaffolding
2982 in place to support other systems, should that prove useful.
2985 Configure notes: This function is called 'Perl_signbit' instead of a
2986 plain 'signbit' because it is easy to imagine a system having a signbit()
2987 function or macro that doesn't happen to work with our particular choice
2988 of NVs. We shouldn't just re-#define signbit as Perl_signbit and expect
2989 the standard system headers to be happy. Also, this is a no-context
2990 function (no pTHX_) because Perl_signbit() is usually re-#defined in
2991 perl.h as a simple macro call to the system's signbit().
2992 Users should just always call Perl_signbit().
2994 NOTE: this function is experimental and may change or be
2995 removed without notice.
2997 int Perl_signbit(NV f)
3000 Found in file numeric.c
3005 For backwards compatibility. Use C<grok_bin> instead.
3007 NV scan_bin(const char* start, STRLEN len, STRLEN* retlen)
3010 Found in file numeric.c
3015 For backwards compatibility. Use C<grok_hex> instead.
3017 NV scan_hex(const char* start, STRLEN len, STRLEN* retlen)
3020 Found in file numeric.c
3025 For backwards compatibility. Use C<grok_oct> instead.
3027 NV scan_oct(const char* start, STRLEN len, STRLEN* retlen)
3030 Found in file numeric.c
3035 =head1 Optree Manipulation Functions
3042 If C<cv> is a constant sub eligible for inlining. returns the constant
3043 value returned by the sub. Otherwise, returns NULL.
3045 Constant subs can be created with C<newCONSTSUB> or as described in
3046 L<perlsub/"Constant Functions">.
3048 SV* cv_const_sv(CV* cv)
3056 Creates a constant sub equivalent to Perl C<sub FOO () { 123 }> which is
3057 eligible for inlining at compile-time.
3059 CV* newCONSTSUB(HV* stash, const char* name, SV* sv)
3067 Used by C<xsubpp> to hook up XSUBs as Perl subs. I<filename> needs to be
3068 static storage, as it is used directly as CvFILE(), without a copy being made.
3076 =head1 Pad Data Structures
3083 Get the value at offset po in the current pad.
3084 Use macro PAD_SV instead of calling this function directly.
3086 SV* pad_sv(PADOFFSET po)
3094 =head1 Per-Interpreter Variables
3101 C<PL_modglobal> is a general purpose, interpreter global HV for use by
3102 extensions that need to keep information on a per-interpreter basis.
3103 In a pinch, it can also be used as a symbol table for extensions
3104 to share data among each other. It is a good idea to use keys
3105 prefixed by the package name of the extension that owns the data.
3110 Found in file intrpvar.h
3115 A convenience variable which is typically used with C<SvPV> when one
3116 doesn't care about the length of the string. It is usually more efficient
3117 to either declare a local variable and use that instead or to use the
3118 C<SvPV_nolen> macro.
3123 Found in file intrpvar.h
3128 This is the C<false> SV. See C<PL_sv_yes>. Always refer to this as
3134 Found in file intrpvar.h
3139 This is the C<undef> SV. Always refer to this as C<&PL_sv_undef>.
3144 Found in file intrpvar.h
3149 This is the C<true> SV. See C<PL_sv_no>. Always refer to this as
3155 Found in file intrpvar.h
3160 =head1 REGEXP Functions
3167 Convenience macro to get the REGEXP from a SV. This is approximately
3168 equivalent to the following snippet:
3173 (tmpsv = (SV*)SvRV(sv)) &&
3174 SvTYPE(tmpsv) == SVt_PVMG &&
3175 (tmpmg = mg_find(tmpsv, PERL_MAGIC_qr)))
3177 return (REGEXP *)tmpmg->mg_obj;
3180 NULL will be returned if a REGEXP* is not found.
3182 REGEXP * SvRX(SV *sv)
3185 Found in file regexp.h
3190 Returns a boolean indicating whether the SV contains qr magic
3193 If you want to do something with the REGEXP* later use SvRX instead
3199 Found in file regexp.h
3204 =head1 Simple Exception Handling Macros
3211 Set up necessary local variables for exception handling.
3212 See L<perlguts/"Exception Handling">.
3217 Found in file XSUB.h
3222 Introduces a catch block. See L<perlguts/"Exception Handling">.
3225 Found in file XSUB.h
3230 Rethrows a previously caught exception. See L<perlguts/"Exception Handling">.
3235 Found in file XSUB.h
3240 Ends a try block. See L<perlguts/"Exception Handling">.
3243 Found in file XSUB.h
3245 =item XCPT_TRY_START
3248 Starts a try block. See L<perlguts/"Exception Handling">.
3251 Found in file XSUB.h
3256 =head1 Stack Manipulation Macros
3263 Declare a stack marker variable, C<mark>, for the XSUB. See C<MARK> and
3274 Saves the original stack mark for the XSUB. See C<ORIGMARK>.
3284 Declares a local copy of perl's stack pointer for the XSUB, available via
3285 the C<SP> macro. See C<SP>.
3295 Used to extend the argument stack for an XSUB's return values. Once
3296 used, guarantees that there is room for at least C<nitems> to be pushed
3299 void EXTEND(SP, int nitems)
3307 Stack marker variable for the XSUB. See C<dMARK>.
3315 Push an integer onto the stack. The stack must have room for this element.
3316 Handles 'set' magic. Does not use C<TARG>. See also C<PUSHi>, C<mXPUSHi>
3327 Push a double onto the stack. The stack must have room for this element.
3328 Handles 'set' magic. Does not use C<TARG>. See also C<PUSHn>, C<mXPUSHn>
3339 Push a string onto the stack. The stack must have room for this element.
3340 The C<len> indicates the length of the string. Handles 'set' magic. Does
3341 not use C<TARG>. See also C<PUSHp>, C<mXPUSHp> and C<XPUSHp>.
3343 void mPUSHp(char* str, STRLEN len)
3351 Push an unsigned integer onto the stack. The stack must have room for this
3352 element. Handles 'set' magic. Does not use C<TARG>. See also C<PUSHu>,
3353 C<mXPUSHu> and C<XPUSHu>.
3363 Push an integer onto the stack, extending the stack if necessary. Handles
3364 'set' magic. Does not use C<TARG>. See also C<XPUSHi>, C<mPUSHi> and
3375 Push a double onto the stack, extending the stack if necessary. Handles
3376 'set' magic. Does not use C<TARG>. See also C<XPUSHn>, C<mPUSHn> and
3387 Push a string onto the stack, extending the stack if necessary. The C<len>
3388 indicates the length of the string. Handles 'set' magic. Does not use
3389 C<TARG>. See also C<XPUSHp>, C<mPUSHp> and C<PUSHp>.
3391 void mXPUSHp(char* str, STRLEN len)
3399 Push an unsigned integer onto the stack, extending the stack if necessary.
3400 Handles 'set' magic. Does not use C<TARG>. See also C<XPUSHu>, C<mPUSHu>
3411 The original stack mark for the XSUB. See C<dORIGMARK>.
3419 Pops an integer off the stack.
3429 Pops a long off the stack.
3439 Pops a double off the stack.
3449 Pops a string off the stack. Deprecated. New code should use POPpx.
3459 Pops a string off the stack which must consist of bytes i.e. characters < 256.
3469 Pops a string off the stack.
3479 Pops an SV off the stack.
3489 Push an integer onto the stack. The stack must have room for this element.
3490 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3491 called to declare it. Do not call multiple C<TARG>-oriented macros to
3492 return lists from XSUB's - see C<mPUSHi> instead. See also C<XPUSHi> and
3503 Opening bracket for arguments on a callback. See C<PUTBACK> and
3514 Push a new mortal SV onto the stack. The stack must have room for this
3515 element. Does not handle 'set' magic. Does not use C<TARG>. See also
3516 C<PUSHs>, C<XPUSHmortal> and C<XPUSHs>.
3526 Push a double onto the stack. The stack must have room for this element.
3527 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3528 called to declare it. Do not call multiple C<TARG>-oriented macros to
3529 return lists from XSUB's - see C<mPUSHn> instead. See also C<XPUSHn> and
3540 Push a string onto the stack. The stack must have room for this element.
3541 The C<len> indicates the length of the string. Handles 'set' magic. Uses
3542 C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to declare it. Do not
3543 call multiple C<TARG>-oriented macros to return lists from XSUB's - see
3544 C<mPUSHp> instead. See also C<XPUSHp> and C<mXPUSHp>.
3546 void PUSHp(char* str, STRLEN len)
3554 Push an SV onto the stack. The stack must have room for this element.
3555 Does not handle 'set' magic. Does not use C<TARG>. See also C<PUSHmortal>,
3556 C<XPUSHs> and C<XPUSHmortal>.
3566 Push an unsigned integer onto the stack. The stack must have room for this
3567 element. Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG>
3568 should be called to declare it. Do not call multiple C<TARG>-oriented
3569 macros to return lists from XSUB's - see C<mPUSHu> instead. See also
3570 C<XPUSHu> and C<mXPUSHu>.
3580 Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
3581 See C<PUSHMARK> and L<perlcall> for other uses.
3591 Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and
3600 Refetch the stack pointer. Used after a callback. See L<perlcall>.
3610 Push an integer onto the stack, extending the stack if necessary. Handles
3611 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
3612 declare it. Do not call multiple C<TARG>-oriented macros to return lists
3613 from XSUB's - see C<mXPUSHi> instead. See also C<PUSHi> and C<mPUSHi>.
3623 Push a new mortal SV onto the stack, extending the stack if necessary. Does
3624 not handle 'set' magic. Does not use C<TARG>. See also C<XPUSHs>,
3625 C<PUSHmortal> and C<PUSHs>.
3635 Push a double onto the stack, extending the stack if necessary. Handles
3636 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
3637 declare it. Do not call multiple C<TARG>-oriented macros to return lists
3638 from XSUB's - see C<mXPUSHn> instead. See also C<PUSHn> and C<mPUSHn>.
3648 Push a string onto the stack, extending the stack if necessary. The C<len>
3649 indicates the length of the string. Handles 'set' magic. Uses C<TARG>, so
3650 C<dTARGET> or C<dXSTARG> should be called to declare it. Do not call
3651 multiple C<TARG>-oriented macros to return lists from XSUB's - see
3652 C<mXPUSHp> instead. See also C<PUSHp> and C<mPUSHp>.
3654 void XPUSHp(char* str, STRLEN len)
3662 Push an SV onto the stack, extending the stack if necessary. Does not
3663 handle 'set' magic. Does not use C<TARG>. See also C<XPUSHmortal>,
3664 C<PUSHs> and C<PUSHmortal>.
3674 Push an unsigned integer onto the stack, extending the stack if necessary.
3675 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3676 called to declare it. Do not call multiple C<TARG>-oriented macros to
3677 return lists from XSUB's - see C<mXPUSHu> instead. See also C<PUSHu> and
3688 Return from XSUB, indicating number of items on the stack. This is usually
3689 handled by C<xsubpp>.
3691 void XSRETURN(int nitems)
3694 Found in file XSUB.h
3696 =item XSRETURN_EMPTY
3699 Return an empty list from an XSUB immediately.
3704 Found in file XSUB.h
3709 Return an integer from an XSUB immediately. Uses C<XST_mIV>.
3711 void XSRETURN_IV(IV iv)
3714 Found in file XSUB.h
3719 Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
3724 Found in file XSUB.h
3729 Return a double from an XSUB immediately. Uses C<XST_mNV>.
3731 void XSRETURN_NV(NV nv)
3734 Found in file XSUB.h
3739 Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
3741 void XSRETURN_PV(char* str)
3744 Found in file XSUB.h
3746 =item XSRETURN_UNDEF
3749 Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
3754 Found in file XSUB.h
3759 Return an integer from an XSUB immediately. Uses C<XST_mUV>.
3761 void XSRETURN_UV(IV uv)
3764 Found in file XSUB.h
3769 Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
3774 Found in file XSUB.h
3779 Place an integer into the specified position C<pos> on the stack. The
3780 value is stored in a new mortal SV.
3782 void XST_mIV(int pos, IV iv)
3785 Found in file XSUB.h
3790 Place C<&PL_sv_no> into the specified position C<pos> on the
3793 void XST_mNO(int pos)
3796 Found in file XSUB.h
3801 Place a double into the specified position C<pos> on the stack. The value
3802 is stored in a new mortal SV.
3804 void XST_mNV(int pos, NV nv)
3807 Found in file XSUB.h
3812 Place a copy of a string into the specified position C<pos> on the stack.
3813 The value is stored in a new mortal SV.
3815 void XST_mPV(int pos, char* str)
3818 Found in file XSUB.h
3823 Place C<&PL_sv_undef> into the specified position C<pos> on the
3826 void XST_mUNDEF(int pos)
3829 Found in file XSUB.h
3834 Place C<&PL_sv_yes> into the specified position C<pos> on the
3837 void XST_mYES(int pos)
3840 Found in file XSUB.h
3852 An enum of flags for Perl types. These are found in the file B<sv.h>
3853 in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
3861 Integer type flag for scalars. See C<svtype>.
3869 Double type flag for scalars. See C<svtype>.
3877 Pointer type flag for scalars. See C<svtype>.
3885 Type flag for arrays. See C<svtype>.
3893 Type flag for code refs. See C<svtype>.
3901 Type flag for hashes. See C<svtype>.
3909 Type flag for blessed scalars. See C<svtype>.
3917 =head1 SV Manipulation Functions
3924 Returns the SV of the specified Perl scalar. If C<create> is set and the
3925 Perl variable does not exist then it will be created. If C<create> is not
3926 set and the variable does not exist then NULL is returned.
3928 NOTE: the perl_ form of this function is deprecated.
3930 SV* get_sv(const char* name, I32 create)
3933 Found in file perl.c
3938 Creates an RV wrapper for an SV. The reference count for the original SV is
3941 SV* newRV_inc(SV* sv)
3949 Returns the length of the string which is in the SV. See C<SvLEN>.
3951 STRLEN SvCUR(SV* sv)
3959 Set the current length of the string which is in the SV. See C<SvCUR>
3962 void SvCUR_set(SV* sv, STRLEN len)
3970 Returns a pointer to the last character in the string which is in the SV.
3971 See C<SvCUR>. Access the character as *(SvEND(sv)).
3981 Returns true if the SV has get magic or overloading. If either is true then
3982 the scalar is active data, and has the potential to return a new value every
3983 time it is accessed. Hence you must be careful to only read it once per user
3984 logical operation and work with that returned value. If neither is true then
3985 the scalar's value cannot change unless written to.
3987 char* SvGAMAGIC(SV* sv)
3995 Expands the character buffer in the SV so that it has room for the
3996 indicated number of bytes (remember to reserve space for an extra trailing
3997 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
3998 Returns a pointer to the character buffer.
4000 char * SvGROW(SV* sv, STRLEN len)
4008 Returns a U32 value indicating whether the SV contains an integer.
4018 Returns a U32 value indicating whether the SV contains an integer. Checks
4019 the B<private> setting. Use C<SvIOK>.
4029 Returns a boolean indicating whether the SV contains a signed integer.
4031 bool SvIOK_notUV(SV* sv)
4039 Unsets the IV status of an SV.
4041 void SvIOK_off(SV* sv)
4049 Tells an SV that it is an integer.
4051 void SvIOK_on(SV* sv)
4059 Tells an SV that it is an integer and disables all other OK bits.
4061 void SvIOK_only(SV* sv)
4069 Tells and SV that it is an unsigned integer and disables all other OK bits.
4071 void SvIOK_only_UV(SV* sv)
4079 Returns a boolean indicating whether the SV contains an unsigned integer.
4081 bool SvIOK_UV(SV* sv)
4089 Returns a boolean indicating whether the SV is Copy-On-Write. (either shared
4090 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
4093 bool SvIsCOW(SV* sv)
4098 =item SvIsCOW_shared_hash
4099 X<SvIsCOW_shared_hash>
4101 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
4104 bool SvIsCOW_shared_hash(SV* sv)
4112 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
4113 version which guarantees to evaluate sv only once.
4123 Returns the raw value in the SV's IV slot, without checks or conversions.
4124 Only use when you are sure SvIOK is true. See also C<SvIV()>.
4134 Coerces the given SV to an integer and returns it. Guarantees to evaluate
4135 C<sv> only once. Only use this if C<sv> is an expression with side effects,
4136 otherwise use the more efficient C<SvIV>.
4146 Like C<SvIV> but doesn't process magic.
4148 IV SvIV_nomg(SV* sv)
4156 Set the value of the IV pointer in sv to val. It is possible to perform
4157 the same function of this macro with an lvalue assignment to C<SvIVX>.
4158 With future Perls, however, it will be more efficient to use
4159 C<SvIV_set> instead of the lvalue assignment to C<SvIVX>.
4161 void SvIV_set(SV* sv, IV val)
4169 Returns the size of the string buffer in the SV, not including any part
4170 attributable to C<SvOOK>. See C<SvCUR>.
4172 STRLEN SvLEN(SV* sv)
4180 Set the actual length of the string which is in the SV. See C<SvIV_set>.
4182 void SvLEN_set(SV* sv, STRLEN len)
4190 Set the value of the MAGIC pointer in sv to val. See C<SvIV_set>.
4192 void SvMAGIC_set(SV* sv, MAGIC* val)
4200 Returns a U32 value indicating whether the SV contains a number, integer or
4211 Returns a U32 value indicating whether the SV contains a number, integer or
4212 double. Checks the B<private> setting. Use C<SvNIOK>.
4222 Unsets the NV/IV status of an SV.
4224 void SvNIOK_off(SV* sv)
4232 Returns a U32 value indicating whether the SV contains a double.
4242 Returns a U32 value indicating whether the SV contains a double. Checks the
4243 B<private> setting. Use C<SvNOK>.
4253 Unsets the NV status of an SV.
4255 void SvNOK_off(SV* sv)
4263 Tells an SV that it is a double.
4265 void SvNOK_on(SV* sv)
4273 Tells an SV that it is a double and disables all other OK bits.
4275 void SvNOK_only(SV* sv)
4283 Coerce the given SV to a double and return it. See C<SvNVx> for a version
4284 which guarantees to evaluate sv only once.
4294 Returns the raw value in the SV's NV slot, without checks or conversions.
4295 Only use when you are sure SvNOK is true. See also C<SvNV()>.
4305 Coerces the given SV to a double and returns it. Guarantees to evaluate
4306 C<sv> only once. Only use this if C<sv> is an expression with side effects,
4307 otherwise use the more efficient C<SvNV>.
4317 Set the value of the NV pointer in sv to val. See C<SvIV_set>.
4319 void SvNV_set(SV* sv, NV val)
4327 Returns a U32 value indicating whether the value is an SV. It also tells
4328 whether the value is defined or not.
4338 Returns a U32 indicating whether the SvIVX is a valid offset value for
4339 the SvPVX. This hack is used internally to speed up removal of characters
4340 from the beginning of a SvPV. When SvOOK is true, then the start of the
4341 allocated string buffer is really (SvPVX - SvIVX).
4351 Returns a U32 value indicating whether the SV contains a character
4362 Returns a U32 value indicating whether the SV contains a character string.
4363 Checks the B<private> setting. Use C<SvPOK>.
4373 Unsets the PV status of an SV.
4375 void SvPOK_off(SV* sv)
4383 Tells an SV that it is a string.
4385 void SvPOK_on(SV* sv)
4393 Tells an SV that it is a string and disables all other OK bits.
4394 Will also turn off the UTF-8 status.
4396 void SvPOK_only(SV* sv)
4401 =item SvPOK_only_UTF8
4404 Tells an SV that it is a string and disables all other OK bits,
4405 and leaves the UTF-8 status as it was.
4407 void SvPOK_only_UTF8(SV* sv)
4415 Returns a pointer to the string in the SV, or a stringified form of
4416 the SV if the SV does not contain a string. The SV may cache the
4417 stringified version becoming C<SvPOK>. Handles 'get' magic. See also
4418 C<SvPVx> for a version which guarantees to evaluate sv only once.
4420 char* SvPV(SV* sv, STRLEN len)
4428 Like C<SvPV>, but converts sv to byte representation first if necessary.
4430 char* SvPVbyte(SV* sv, STRLEN len)
4438 Like C<SvPV>, but converts sv to byte representation first if necessary.
4439 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
4442 char* SvPVbytex(SV* sv, STRLEN len)
4447 =item SvPVbytex_force
4450 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
4451 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
4454 char* SvPVbytex_force(SV* sv, STRLEN len)
4459 =item SvPVbyte_force
4462 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
4464 char* SvPVbyte_force(SV* sv, STRLEN len)
4469 =item SvPVbyte_nolen
4472 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
4474 char* SvPVbyte_nolen(SV* sv)
4482 Like C<SvPV>, but converts sv to utf8 first if necessary.
4484 char* SvPVutf8(SV* sv, STRLEN len)
4492 Like C<SvPV>, but converts sv to utf8 first if necessary.
4493 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
4496 char* SvPVutf8x(SV* sv, STRLEN len)
4501 =item SvPVutf8x_force
4504 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
4505 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
4508 char* SvPVutf8x_force(SV* sv, STRLEN len)
4513 =item SvPVutf8_force
4516 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
4518 char* SvPVutf8_force(SV* sv, STRLEN len)
4523 =item SvPVutf8_nolen
4526 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
4528 char* SvPVutf8_nolen(SV* sv)
4536 Returns a pointer to the physical string in the SV. The SV must contain a
4547 A version of C<SvPV> which guarantees to evaluate C<sv> only once.
4548 Only use this if C<sv> is an expression with side effects, otherwise use the
4549 more efficient C<SvPVX>.
4551 char* SvPVx(SV* sv, STRLEN len)
4559 Like C<SvPV> but will force the SV into containing just a string
4560 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
4563 char* SvPV_force(SV* sv, STRLEN len)
4568 =item SvPV_force_nomg
4571 Like C<SvPV> but will force the SV into containing just a string
4572 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
4573 directly. Doesn't process magic.
4575 char* SvPV_force_nomg(SV* sv, STRLEN len)
4583 Returns a pointer to the string in the SV, or a stringified form of
4584 the SV if the SV does not contain a string. The SV may cache the
4585 stringified form becoming C<SvPOK>. Handles 'get' magic.
4587 char* SvPV_nolen(SV* sv)
4595 Like C<SvPV> but doesn't process magic.
4597 char* SvPV_nomg(SV* sv, STRLEN len)
4605 Set the value of the PV pointer in sv to val. See C<SvIV_set>.
4607 void SvPV_set(SV* sv, char* val)
4615 Returns the value of the object's reference count.
4617 U32 SvREFCNT(SV* sv)
4625 Decrements the reference count of the given SV.
4627 void SvREFCNT_dec(SV* sv)
4635 Increments the reference count of the given SV.
4637 All of the following SvREFCNT_inc* macros are optimized versions of
4638 SvREFCNT_inc, and can be replaced with SvREFCNT_inc.
4640 SV* SvREFCNT_inc(SV* sv)
4645 =item SvREFCNT_inc_NN
4648 Same as SvREFCNT_inc, but can only be used if you know I<sv>
4649 is not NULL. Since we don't have to check the NULLness, it's faster
4652 SV* SvREFCNT_inc_NN(SV* sv)
4657 =item SvREFCNT_inc_simple
4658 X<SvREFCNT_inc_simple>
4660 Same as SvREFCNT_inc, but can only be used with expressions without side
4661 effects. Since we don't have to store a temporary value, it's faster.
4663 SV* SvREFCNT_inc_simple(SV* sv)
4668 =item SvREFCNT_inc_simple_NN
4669 X<SvREFCNT_inc_simple_NN>
4671 Same as SvREFCNT_inc_simple, but can only be used if you know I<sv>
4672 is not NULL. Since we don't have to check the NULLness, it's faster
4675 SV* SvREFCNT_inc_simple_NN(SV* sv)
4680 =item SvREFCNT_inc_simple_void
4681 X<SvREFCNT_inc_simple_void>
4683 Same as SvREFCNT_inc_simple, but can only be used if you don't need the
4684 return value. The macro doesn't need to return a meaningful value.
4686 void SvREFCNT_inc_simple_void(SV* sv)
4691 =item SvREFCNT_inc_simple_void_NN
4692 X<SvREFCNT_inc_simple_void_NN>
4694 Same as SvREFCNT_inc, but can only be used if you don't need the return
4695 value, and you know that I<sv> is not NULL. The macro doesn't need
4696 to return a meaningful value, or check for NULLness, so it's smaller
4699 void SvREFCNT_inc_simple_void_NN(SV* sv)
4704 =item SvREFCNT_inc_void
4705 X<SvREFCNT_inc_void>
4707 Same as SvREFCNT_inc, but can only be used if you don't need the
4708 return value. The macro doesn't need to return a meaningful value.
4710 void SvREFCNT_inc_void(SV* sv)
4715 =item SvREFCNT_inc_void_NN
4716 X<SvREFCNT_inc_void_NN>
4718 Same as SvREFCNT_inc, but can only be used if you don't need the return
4719 value, and you know that I<sv> is not NULL. The macro doesn't need
4720 to return a meaningful value, or check for NULLness, so it's smaller
4723 void SvREFCNT_inc_void_NN(SV* sv)
4731 Tests if the SV is an RV.
4741 Unsets the RV status of an SV.
4743 void SvROK_off(SV* sv)
4751 Tells an SV that it is an RV.
4753 void SvROK_on(SV* sv)
4761 Dereferences an RV to return the SV.
4771 Set the value of the RV pointer in sv to val. See C<SvIV_set>.
4773 void SvRV_set(SV* sv, SV* val)
4781 Returns the stash of the SV.
4791 Set the value of the STASH pointer in sv to val. See C<SvIV_set>.
4793 void SvSTASH_set(SV* sv, HV* val)
4801 Taints an SV if tainting is enabled.
4803 void SvTAINT(SV* sv)
4811 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
4814 bool SvTAINTED(SV* sv)
4822 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
4823 some of Perl's fundamental security features. XS module authors should not
4824 use this function unless they fully understand all the implications of
4825 unconditionally untainting the value. Untainting should be done in the
4826 standard perl fashion, via a carefully crafted regexp, rather than directly
4827 untainting variables.
4829 void SvTAINTED_off(SV* sv)
4837 Marks an SV as tainted if tainting is enabled.
4839 void SvTAINTED_on(SV* sv)
4847 Returns a boolean indicating whether Perl would evaluate the SV as true or
4848 false, defined or undefined. Does not handle 'get' magic.
4858 Returns the type of the SV. See C<svtype>.
4860 svtype SvTYPE(SV* sv)
4868 Returns a boolean indicating whether the SV contains an unsigned integer.
4878 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
4879 perform the upgrade if necessary. See C<svtype>.
4881 void SvUPGRADE(SV* sv, svtype type)
4889 Returns a U32 value indicating whether the SV contains UTF-8 encoded data.
4890 Call this after SvPV() in case any call to string overloading updates the
4901 Unsets the UTF-8 status of an SV.
4903 void SvUTF8_off(SV *sv)
4911 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
4912 Do not use frivolously.
4914 void SvUTF8_on(SV *sv)
4922 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
4923 for a version which guarantees to evaluate sv only once.
4933 Returns the raw value in the SV's UV slot, without checks or conversions.
4934 Only use when you are sure SvIOK is true. See also C<SvUV()>.
4944 Coerces the given SV to an unsigned integer and returns it. Guarantees to
4945 C<sv> only once. Only use this if C<sv> is an expression with side effects,
4946 otherwise use the more efficient C<SvUV>.
4956 Like C<SvUV> but doesn't process magic.
4958 UV SvUV_nomg(SV* sv)
4966 Set the value of the UV pointer in sv to val. See C<SvIV_set>.
4968 void SvUV_set(SV* sv, UV val)
4976 Returns a boolean indicating whether the SV contains a v-string.
4983 =item sv_catpvn_nomg
4986 Like C<sv_catpvn> but doesn't process magic.
4988 void sv_catpvn_nomg(SV* sv, const char* ptr, STRLEN len)
4996 Like C<sv_catsv> but doesn't process magic.
4998 void sv_catsv_nomg(SV* dsv, SV* ssv)
5003 =item sv_derived_from
5006 Returns a boolean indicating whether the SV is derived from the specified class
5007 I<at the C level>. To check derivation at the Perl level, call C<isa()> as a
5010 bool sv_derived_from(SV* sv, const char* name)
5013 Found in file universal.c
5018 Returns a boolean indicating whether the SV performs a specific, named role.
5019 The SV can be a Perl object or the name of a Perl class.
5021 bool sv_does(SV* sv, const char* name)
5024 Found in file universal.c
5026 =item sv_report_used
5029 Dump the contents of all SVs not yet freed. (Debugging aid).
5031 void sv_report_used()
5039 Like C<sv_setsv> but doesn't process magic.
5041 void sv_setsv_nomg(SV* dsv, SV* ssv)
5049 =head1 SV-Body Allocation
5053 =item looks_like_number
5054 X<looks_like_number>
5056 Test if the content of an SV looks like a number (or is a number).
5057 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
5058 non-numeric warning), even if your atof() doesn't grok them.
5060 I32 looks_like_number(SV* sv)
5068 Creates an RV wrapper for an SV. The reference count for the original
5069 SV is B<not> incremented.
5071 SV* newRV_noinc(SV* sv)
5079 Creates a new SV. A non-zero C<len> parameter indicates the number of
5080 bytes of preallocated string space the SV should have. An extra byte for a
5081 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
5082 space is allocated.) The reference count for the new SV is set to 1.
5084 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
5085 parameter, I<x>, a debug aid which allowed callers to identify themselves.
5086 This aid has been superseded by a new build option, PERL_MEM_LOG (see
5087 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
5088 modules supporting older perls.
5090 SV* newSV(STRLEN len)
5098 Creates a new SV from the hash key structure. It will generate scalars that
5099 point to the shared string table where possible. Returns a new (undefined)
5100 SV if the hek is NULL.
5102 SV* newSVhek(const HEK *hek)
5110 Creates a new SV and copies an integer into it. The reference count for the
5121 Creates a new SV and copies a floating point value into it.
5122 The reference count for the SV is set to 1.
5132 Creates a new SV and copies a string into it. The reference count for the
5133 SV is set to 1. If C<len> is zero, Perl will compute the length using
5134 strlen(). For efficiency, consider using C<newSVpvn> instead.
5136 SV* newSVpv(const char* s, STRLEN len)
5144 Creates a new SV and initializes it with the string formatted like
5147 SV* newSVpvf(const char* pat, ...)
5155 Creates a new SV and copies a string into it. The reference count for the
5156 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
5157 string. You are responsible for ensuring that the source string is at least
5158 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
5160 SV* newSVpvn(const char* s, STRLEN len)
5165 =item newSVpvn_share
5168 Creates a new SV with its SvPVX_const pointing to a shared string in the string
5169 table. If the string does not already exist in the table, it is created
5170 first. Turns on READONLY and FAKE. If the C<hash> parameter is non-zero, that
5171 value is used; otherwise the hash is computed. The string's hash can be later
5172 be retrieved from the SV with the C<SvSHARED_HASH()> macro. The idea here is
5173 that as the string table is used for shared hash keys these strings will have
5174 SvPVX_const == HeKEY and hash lookup will avoid string compare.
5176 SV* newSVpvn_share(const char* s, I32 len, U32 hash)
5184 Like C<newSVpvn>, but takes a literal string instead of a string/length pair.
5186 SV* newSVpvs(const char* s)
5189 Found in file handy.h
5191 =item newSVpvs_share
5194 Like C<newSVpvn_share>, but takes a literal string instead of a string/length
5195 pair and omits the hash parameter.
5197 SV* newSVpvs_share(const char* s)
5200 Found in file handy.h
5205 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
5206 it will be upgraded to one. If C<classname> is non-null then the new SV will
5207 be blessed in the specified package. The new SV is returned and its
5208 reference count is 1.
5210 SV* newSVrv(SV* rv, const char* classname)
5218 Creates a new SV which is an exact duplicate of the original SV.
5221 SV* newSVsv(SV* old)
5229 Creates a new SV and copies an unsigned integer into it.
5230 The reference count for the SV is set to 1.
5240 Creates a new SV, of the type specificied. The reference count for the new SV
5243 SV* newSV_type(svtype type)
5251 This function is only called on magical items, and is only used by
5252 sv_true() or its macro equivalent.
5254 bool sv_2bool(SV* sv)
5262 Using various gambits, try to get a CV from an SV; in addition, try if
5263 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
5264 The flags in C<lref> are passed to sv_fetchsv.
5266 CV* sv_2cv(SV* sv, HV** st, GV** gvp, I32 lref)
5274 Using various gambits, try to get an IO from an SV: the IO slot if its a
5275 GV; or the recursive result if we're an RV; or the IO slot of the symbol
5276 named after the PV if we're a string.
5286 Return the integer value of an SV, doing any necessary string
5287 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
5288 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
5290 IV sv_2iv_flags(SV* sv, I32 flags)
5298 Marks an existing SV as mortal. The SV will be destroyed "soon", either
5299 by an explicit call to FREETMPS, or by an implicit call at places such as
5300 statement boundaries. SvTEMP() is turned on which means that the SV's
5301 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
5302 and C<sv_mortalcopy>.
5304 SV* sv_2mortal(SV* sv)
5312 Return the num value of an SV, doing any necessary string or integer
5313 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
5324 Return a pointer to the byte-encoded representation of the SV, and set *lp
5325 to its length. May cause the SV to be downgraded from UTF-8 as a
5328 Usually accessed via the C<SvPVbyte> macro.
5330 char* sv_2pvbyte(SV* sv, STRLEN* lp)
5338 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
5339 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
5341 Usually accessed via the C<SvPVutf8> macro.
5343 char* sv_2pvutf8(SV* sv, STRLEN* lp)
5351 Returns a pointer to the string value of an SV, and sets *lp to its length.
5352 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
5354 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
5355 usually end up here too.
5357 char* sv_2pv_flags(SV* sv, STRLEN* lp, I32 flags)
5365 Return the unsigned integer value of an SV, doing any necessary string
5366 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
5367 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
5369 UV sv_2uv_flags(SV* sv, I32 flags)
5377 Remove any string offset. You should normally use the C<SvOOK_off> macro
5380 int sv_backoff(SV* sv)
5388 Blesses an SV into a specified package. The SV must be an RV. The package
5389 must be designated by its stash (see C<gv_stashpv()>). The reference count
5390 of the SV is unaffected.
5392 SV* sv_bless(SV* sv, HV* stash)
5400 Concatenates the string onto the end of the string which is in the SV.
5401 If the SV has the UTF-8 status set, then the bytes appended should be
5402 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
5404 void sv_catpv(SV* sv, const char* ptr)
5412 Processes its arguments like C<sprintf> and appends the formatted
5413 output to an SV. If the appended data contains "wide" characters
5414 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
5415 and characters >255 formatted with %c), the original SV might get
5416 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
5417 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
5418 valid UTF-8; if the original SV was bytes, the pattern should be too.
5420 void sv_catpvf(SV* sv, const char* pat, ...)
5428 Like C<sv_catpvf>, but also handles 'set' magic.
5430 void sv_catpvf_mg(SV *sv, const char* pat, ...)
5438 Concatenates the string onto the end of the string which is in the SV. The
5439 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5440 status set, then the bytes appended should be valid UTF-8.
5441 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
5443 void sv_catpvn(SV* sv, const char* ptr, STRLEN len)
5448 =item sv_catpvn_flags
5451 Concatenates the string onto the end of the string which is in the SV. The
5452 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5453 status set, then the bytes appended should be valid UTF-8.
5454 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
5455 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
5456 in terms of this function.
5458 void sv_catpvn_flags(SV* sv, const char* ptr, STRLEN len, I32 flags)
5466 Like C<sv_catpvn>, but takes a literal string instead of a string/length pair.
5468 void sv_catpvs(SV* sv, const char* s)
5471 Found in file handy.h
5476 Like C<sv_catpv>, but also handles 'set' magic.
5478 void sv_catpv_mg(SV *sv, const char *ptr)
5486 Concatenates the string from SV C<ssv> onto the end of the string in
5487 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
5488 not 'set' magic. See C<sv_catsv_mg>.
5490 void sv_catsv(SV* dsv, SV* ssv)
5495 =item sv_catsv_flags
5498 Concatenates the string from SV C<ssv> onto the end of the string in
5499 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
5500 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
5501 and C<sv_catsv_nomg> are implemented in terms of this function.
5503 void sv_catsv_flags(SV* dsv, SV* ssv, I32 flags)
5511 Efficient removal of characters from the beginning of the string buffer.
5512 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
5513 the string buffer. The C<ptr> becomes the first character of the adjusted
5514 string. Uses the "OOK hack".
5515 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
5516 refer to the same chunk of data.
5518 void sv_chop(SV* sv, const char* ptr)
5526 Clear an SV: call any destructors, free up any memory used by the body,
5527 and free the body itself. The SV's head is I<not> freed, although
5528 its type is set to all 1's so that it won't inadvertently be assumed
5529 to be live during global destruction etc.
5530 This function should only be called when REFCNT is zero. Most of the time
5531 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5534 void sv_clear(SV* sv)
5542 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5543 string in C<sv1> is less than, equal to, or greater than the string in
5544 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5545 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
5547 I32 sv_cmp(SV* sv1, SV* sv2)
5555 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
5556 'use bytes' aware, handles get magic, and will coerce its args to strings
5557 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
5559 I32 sv_cmp_locale(SV* sv1, SV* sv2)
5567 Add Collate Transform magic to an SV if it doesn't already have it.
5569 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
5570 scalar data of the variable, but transformed to such a format that a normal
5571 memory comparison can be used to compare the data according to the locale
5574 char* sv_collxfrm(SV* sv, STRLEN* nxp)
5582 Copies a stringified representation of the source SV into the
5583 destination SV. Automatically performs any necessary mg_get and
5584 coercion of numeric values into strings. Guaranteed to preserve
5585 UTF8 flag even from overloaded objects. Similar in nature to
5586 sv_2pv[_flags] but operates directly on an SV instead of just the
5587 string. Mostly uses sv_2pv_flags to do its work, except when that
5588 would lose the UTF-8'ness of the PV.
5590 void sv_copypv(SV* dsv, SV* ssv)
5598 Auto-decrement of the value in the SV, doing string to numeric conversion
5599 if necessary. Handles 'get' magic.
5609 Returns a boolean indicating whether the strings in the two SVs are
5610 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5611 coerce its args to strings if necessary.
5613 I32 sv_eq(SV* sv1, SV* sv2)
5618 =item sv_force_normal_flags
5619 X<sv_force_normal_flags>
5621 Undo various types of fakery on an SV: if the PV is a shared string, make
5622 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
5623 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
5624 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
5625 then a copy-on-write scalar drops its PV buffer (if any) and becomes
5626 SvPOK_off rather than making a copy. (Used where this scalar is about to be
5627 set to some other value.) In addition, the C<flags> parameter gets passed to
5628 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
5629 with flags set to 0.
5631 void sv_force_normal_flags(SV *sv, U32 flags)
5639 Decrement an SV's reference count, and if it drops to zero, call
5640 C<sv_clear> to invoke destructors and free up any memory used by
5641 the body; finally, deallocate the SV's head itself.
5642 Normally called via a wrapper macro C<SvREFCNT_dec>.
5644 void sv_free(SV* sv)
5652 Get a line from the filehandle and store it into the SV, optionally
5653 appending to the currently-stored string.
5655 char* sv_gets(SV* sv, PerlIO* fp, I32 append)
5663 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
5664 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
5665 Use the C<SvGROW> wrapper instead.
5667 char* sv_grow(SV* sv, STRLEN newlen)
5675 Auto-increment of the value in the SV, doing string to numeric conversion
5676 if necessary. Handles 'get' magic.
5686 Inserts a string at the specified offset/length within the SV. Similar to
5687 the Perl substr() function.
5689 void sv_insert(SV* bigsv, STRLEN offset, STRLEN len, const char* little, STRLEN littlelen)
5697 Returns a boolean indicating whether the SV is blessed into the specified
5698 class. This does not check for subtypes; use C<sv_derived_from> to verify
5699 an inheritance relationship.
5701 int sv_isa(SV* sv, const char* name)
5709 Returns a boolean indicating whether the SV is an RV pointing to a blessed
5710 object. If the SV is not an RV, or if the object is not blessed, then this
5713 int sv_isobject(SV* sv)
5721 Returns the length of the string in the SV. Handles magic and type
5722 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5724 STRLEN sv_len(SV* sv)
5732 Returns the number of characters in the string in an SV, counting wide
5733 UTF-8 bytes as a single character. Handles magic and type coercion.
5735 STRLEN sv_len_utf8(SV* sv)
5743 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
5744 then adds a new magic item of type C<how> to the head of the magic list.
5746 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
5747 handling of the C<name> and C<namlen> arguments.
5749 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
5750 to add more than one instance of the same 'how'.
5752 void sv_magic(SV* sv, SV* obj, int how, const char* name, I32 namlen)
5760 Adds magic to an SV, upgrading it if necessary. Applies the
5761 supplied vtable and returns a pointer to the magic added.
5763 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
5764 In particular, you can add magic to SvREADONLY SVs, and add more than
5765 one instance of the same 'how'.
5767 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
5768 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
5769 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
5770 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
5772 (This is now used as a subroutine by C<sv_magic>.)
5774 MAGIC * sv_magicext(SV* sv, SV* obj, int how, const MGVTBL *vtbl, const char* name, I32 namlen)
5782 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
5783 The new SV is marked as mortal. It will be destroyed "soon", either by an
5784 explicit call to FREETMPS, or by an implicit call at places such as
5785 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
5787 SV* sv_mortalcopy(SV* oldsv)
5795 Creates a new null SV which is mortal. The reference count of the SV is
5796 set to 1. It will be destroyed "soon", either by an explicit call to
5797 FREETMPS, or by an implicit call at places such as statement boundaries.
5798 See also C<sv_mortalcopy> and C<sv_2mortal>.
5808 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5811 SV* sv_newref(SV* sv)
5819 Converts the value pointed to by offsetp from a count of bytes from the
5820 start of the string, to a count of the equivalent number of UTF-8 chars.
5821 Handles magic and type coercion.
5823 void sv_pos_b2u(SV* sv, I32* offsetp)
5831 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5832 the start of the string, to a count of the equivalent number of bytes; if
5833 lenp is non-zero, it does the same to lenp, but this time starting from
5834 the offset, rather than from the start of the string. Handles magic and
5837 void sv_pos_u2b(SV* sv, I32* offsetp, I32* lenp)
5842 =item sv_pvbyten_force
5845 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
5847 char* sv_pvbyten_force(SV* sv, STRLEN* lp)
5855 Get a sensible string out of the SV somehow.
5856 A private implementation of the C<SvPV_force> macro for compilers which
5857 can't cope with complex macro expressions. Always use the macro instead.
5859 char* sv_pvn_force(SV* sv, STRLEN* lp)
5864 =item sv_pvn_force_flags
5865 X<sv_pvn_force_flags>
5867 Get a sensible string out of the SV somehow.
5868 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
5869 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
5870 implemented in terms of this function.
5871 You normally want to use the various wrapper macros instead: see
5872 C<SvPV_force> and C<SvPV_force_nomg>
5874 char* sv_pvn_force_flags(SV* sv, STRLEN* lp, I32 flags)
5879 =item sv_pvutf8n_force
5882 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
5884 char* sv_pvutf8n_force(SV* sv, STRLEN* lp)
5892 Returns a string describing what the SV is a reference to.
5894 const char* sv_reftype(const SV* sv, int ob)
5902 Make the first argument a copy of the second, then delete the original.
5903 The target SV physically takes over ownership of the body of the source SV
5904 and inherits its flags; however, the target keeps any magic it owns,
5905 and any magic in the source is discarded.
5906 Note that this is a rather specialist SV copying operation; most of the
5907 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5909 void sv_replace(SV* sv, SV* nsv)
5917 Underlying implementation for the C<reset> Perl function.
5918 Note that the perl-level function is vaguely deprecated.
5920 void sv_reset(const char* s, HV* stash)
5928 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
5929 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
5930 push a back-reference to this RV onto the array of backreferences
5931 associated with that magic. If the RV is magical, set magic will be
5932 called after the RV is cleared.
5934 SV* sv_rvweaken(SV *sv)
5942 Copies an integer into the given SV, upgrading first if necessary.
5943 Does not handle 'set' magic. See also C<sv_setiv_mg>.
5945 void sv_setiv(SV* sv, IV num)
5953 Like C<sv_setiv>, but also handles 'set' magic.
5955 void sv_setiv_mg(SV *sv, IV i)
5963 Copies a double into the given SV, upgrading first if necessary.
5964 Does not handle 'set' magic. See also C<sv_setnv_mg>.
5966 void sv_setnv(SV* sv, NV num)
5974 Like C<sv_setnv>, but also handles 'set' magic.
5976 void sv_setnv_mg(SV *sv, NV num)
5984 Copies a string into an SV. The string must be null-terminated. Does not
5985 handle 'set' magic. See C<sv_setpv_mg>.
5987 void sv_setpv(SV* sv, const char* ptr)
5995 Works like C<sv_catpvf> but copies the text into the SV instead of
5996 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
5998 void sv_setpvf(SV* sv, const char* pat, ...)
6006 Like C<sv_setpvf>, but also handles 'set' magic.
6008 void sv_setpvf_mg(SV *sv, const char* pat, ...)
6016 Copies an integer into the given SV, also updating its string value.
6017 Does not handle 'set' magic. See C<sv_setpviv_mg>.
6019 void sv_setpviv(SV* sv, IV num)
6027 Like C<sv_setpviv>, but also handles 'set' magic.
6029 void sv_setpviv_mg(SV *sv, IV iv)
6037 Copies a string into an SV. The C<len> parameter indicates the number of
6038 bytes to be copied. If the C<ptr> argument is NULL the SV will become
6039 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
6041 void sv_setpvn(SV* sv, const char* ptr, STRLEN len)
6049 Like C<sv_setpvn>, but also handles 'set' magic.
6051 void sv_setpvn_mg(SV *sv, const char *ptr, STRLEN len)
6059 Like C<sv_setpvn>, but takes a literal string instead of a string/length pair.
6061 void sv_setpvs(SV* sv, const char* s)
6064 Found in file handy.h
6069 Like C<sv_setpv>, but also handles 'set' magic.
6071 void sv_setpv_mg(SV *sv, const char *ptr)
6079 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
6080 argument will be upgraded to an RV. That RV will be modified to point to
6081 the new SV. The C<classname> argument indicates the package for the
6082 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
6083 will have a reference count of 1, and the RV will be returned.
6085 SV* sv_setref_iv(SV* rv, const char* classname, IV iv)
6093 Copies a double into a new SV, optionally blessing the SV. The C<rv>
6094 argument will be upgraded to an RV. That RV will be modified to point to
6095 the new SV. The C<classname> argument indicates the package for the
6096 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
6097 will have a reference count of 1, and the RV will be returned.
6099 SV* sv_setref_nv(SV* rv, const char* classname, NV nv)
6107 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
6108 argument will be upgraded to an RV. That RV will be modified to point to
6109 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
6110 into the SV. The C<classname> argument indicates the package for the
6111 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
6112 will have a reference count of 1, and the RV will be returned.
6114 Do not use with other Perl types such as HV, AV, SV, CV, because those
6115 objects will become corrupted by the pointer copy process.
6117 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
6119 SV* sv_setref_pv(SV* rv, const char* classname, void* pv)
6127 Copies a string into a new SV, optionally blessing the SV. The length of the
6128 string must be specified with C<n>. The C<rv> argument will be upgraded to
6129 an RV. That RV will be modified to point to the new SV. The C<classname>
6130 argument indicates the package for the blessing. Set C<classname> to
6131 C<NULL> to avoid the blessing. The new SV will have a reference count
6132 of 1, and the RV will be returned.
6134 Note that C<sv_setref_pv> copies the pointer while this copies the string.
6136 SV* sv_setref_pvn(SV* rv, const char* classname, const char* pv, STRLEN n)
6144 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
6145 argument will be upgraded to an RV. That RV will be modified to point to
6146 the new SV. The C<classname> argument indicates the package for the
6147 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
6148 will have a reference count of 1, and the RV will be returned.
6150 SV* sv_setref_uv(SV* rv, const char* classname, UV uv)
6158 Copies the contents of the source SV C<ssv> into the destination SV
6159 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
6160 function if the source SV needs to be reused. Does not handle 'set' magic.
6161 Loosely speaking, it performs a copy-by-value, obliterating any previous
6162 content of the destination.
6164 You probably want to use one of the assortment of wrappers, such as
6165 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
6166 C<SvSetMagicSV_nosteal>.
6168 void sv_setsv(SV* dsv, SV* ssv)
6173 =item sv_setsv_flags
6176 Copies the contents of the source SV C<ssv> into the destination SV
6177 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
6178 function if the source SV needs to be reused. Does not handle 'set' magic.
6179 Loosely speaking, it performs a copy-by-value, obliterating any previous
6180 content of the destination.
6181 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
6182 C<ssv> if appropriate, else not. If the C<flags> parameter has the
6183 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
6184 and C<sv_setsv_nomg> are implemented in terms of this function.
6186 You probably want to use one of the assortment of wrappers, such as
6187 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
6188 C<SvSetMagicSV_nosteal>.
6190 This is the primary function for copying scalars, and most other
6191 copy-ish functions and macros use this underneath.
6193 void sv_setsv_flags(SV* dsv, SV* ssv, I32 flags)
6201 Like C<sv_setsv>, but also handles 'set' magic.
6203 void sv_setsv_mg(SV *dstr, SV *sstr)
6211 Copies an unsigned integer into the given SV, upgrading first if necessary.
6212 Does not handle 'set' magic. See also C<sv_setuv_mg>.
6214 void sv_setuv(SV* sv, UV num)
6222 Like C<sv_setuv>, but also handles 'set' magic.
6224 void sv_setuv_mg(SV *sv, UV u)
6232 Test an SV for taintedness. Use C<SvTAINTED> instead.
6233 bool sv_tainted(SV* sv)
6241 Returns true if the SV has a true value by Perl's rules.
6242 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
6243 instead use an in-line version.
6253 Removes all magic of type C<type> from an SV.
6255 int sv_unmagic(SV* sv, int type)
6260 =item sv_unref_flags
6263 Unsets the RV status of the SV, and decrements the reference count of
6264 whatever was being referenced by the RV. This can almost be thought of
6265 as a reversal of C<newSVrv>. The C<cflags> argument can contain
6266 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
6267 (otherwise the decrementing is conditional on the reference count being
6268 different from one or the reference being a readonly SV).
6271 void sv_unref_flags(SV* sv, U32 flags)
6279 Untaint an SV. Use C<SvTAINTED_off> instead.
6280 void sv_untaint(SV* sv)
6288 Upgrade an SV to a more complex form. Generally adds a new body type to the
6289 SV, then copies across as much information as possible from the old body.
6290 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
6292 void sv_upgrade(SV* sv, svtype new_type)
6297 =item sv_usepvn_flags
6300 Tells an SV to use C<ptr> to find its string value. Normally the
6301 string is stored inside the SV but sv_usepvn allows the SV to use an
6302 outside string. The C<ptr> should point to memory that was allocated
6303 by C<malloc>. The string length, C<len>, must be supplied. By default
6304 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
6305 so that pointer should not be freed or used by the programmer after
6306 giving it to sv_usepvn, and neither should any pointers from "behind"
6307 that pointer (e.g. ptr + 1) be used.
6309 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
6310 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
6311 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
6312 C<len>, and already meets the requirements for storing in C<SvPVX>)
6314 void sv_usepvn_flags(SV* sv, char* ptr, STRLEN len, U32 flags)
6319 =item sv_utf8_decode
6322 If the PV of the SV is an octet sequence in UTF-8
6323 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
6324 so that it looks like a character. If the PV contains only single-byte
6325 characters, the C<SvUTF8> flag stays being off.
6326 Scans PV for validity and returns false if the PV is invalid UTF-8.
6328 NOTE: this function is experimental and may change or be
6329 removed without notice.
6331 bool sv_utf8_decode(SV *sv)
6336 =item sv_utf8_downgrade
6337 X<sv_utf8_downgrade>
6339 Attempts to convert the PV of an SV from characters to bytes.
6340 If the PV contains a character beyond byte, this conversion will fail;
6341 in this case, either returns false or, if C<fail_ok> is not
6344 This is not as a general purpose Unicode to byte encoding interface:
6345 use the Encode extension for that.
6347 NOTE: this function is experimental and may change or be
6348 removed without notice.
6350 bool sv_utf8_downgrade(SV *sv, bool fail_ok)
6355 =item sv_utf8_encode
6358 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
6359 flag off so that it looks like octets again.
6361 void sv_utf8_encode(SV *sv)
6366 =item sv_utf8_upgrade
6369 Converts the PV of an SV to its UTF-8-encoded form.
6370 Forces the SV to string form if it is not already.
6371 Always sets the SvUTF8 flag to avoid future validity checks even
6372 if all the bytes have hibit clear.
6374 This is not as a general purpose byte encoding to Unicode interface:
6375 use the Encode extension for that.
6377 STRLEN sv_utf8_upgrade(SV *sv)
6382 =item sv_utf8_upgrade_flags
6383 X<sv_utf8_upgrade_flags>
6385 Converts the PV of an SV to its UTF-8-encoded form.
6386 Forces the SV to string form if it is not already.
6387 Always sets the SvUTF8 flag to avoid future validity checks even
6388 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
6389 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
6390 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
6392 This is not as a general purpose byte encoding to Unicode interface:
6393 use the Encode extension for that.
6395 STRLEN sv_utf8_upgrade_flags(SV *sv, I32 flags)
6403 Processes its arguments like C<vsprintf> and appends the formatted output
6404 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
6406 Usually used via its frontend C<sv_catpvf>.
6408 void sv_vcatpvf(SV* sv, const char* pat, va_list* args)
6416 Processes its arguments like C<vsprintf> and appends the formatted output
6417 to an SV. Uses an array of SVs if the C style variable argument list is
6418 missing (NULL). When running with taint checks enabled, indicates via
6419 C<maybe_tainted> if results are untrustworthy (often due to the use of
6422 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
6424 void sv_vcatpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
6432 Like C<sv_vcatpvf>, but also handles 'set' magic.
6434 Usually used via its frontend C<sv_catpvf_mg>.
6436 void sv_vcatpvf_mg(SV* sv, const char* pat, va_list* args)
6444 Works like C<sv_vcatpvf> but copies the text into the SV instead of
6445 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
6447 Usually used via its frontend C<sv_setpvf>.
6449 void sv_vsetpvf(SV* sv, const char* pat, va_list* args)
6457 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
6460 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
6462 void sv_vsetpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
6470 Like C<sv_vsetpvf>, but also handles 'set' magic.
6472 Usually used via its frontend C<sv_setpvf_mg>.
6474 void sv_vsetpvf_mg(SV* sv, const char* pat, va_list* args)
6482 =head1 Unicode Support
6486 =item bytes_from_utf8
6489 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
6490 Unlike C<utf8_to_bytes> but like C<bytes_to_utf8>, returns a pointer to
6491 the newly-created string, and updates C<len> to contain the new
6492 length. Returns the original string if no conversion occurs, C<len>
6493 is unchanged. Do nothing if C<is_utf8> points to 0. Sets C<is_utf8> to
6494 0 if C<s> is converted or contains all 7bit characters.
6496 NOTE: this function is experimental and may change or be
6497 removed without notice.
6499 U8* bytes_from_utf8(const U8 *s, STRLEN *len, bool *is_utf8)
6502 Found in file utf8.c
6507 Converts a string C<s> of length C<len> from ASCII into UTF-8 encoding.
6508 Returns a pointer to the newly-created string, and sets C<len> to
6509 reflect the new length.
6511 If you want to convert to UTF-8 from other encodings than ASCII,
6512 see sv_recode_to_utf8().
6514 NOTE: this function is experimental and may change or be
6515 removed without notice.
6517 U8* bytes_to_utf8(const U8 *s, STRLEN *len)
6520 Found in file utf8.c
6525 Return true if the strings s1 and s2 differ case-insensitively, false
6526 if not (if they are equal case-insensitively). If u1 is true, the
6527 string s1 is assumed to be in UTF-8-encoded Unicode. If u2 is true,
6528 the string s2 is assumed to be in UTF-8-encoded Unicode. If u1 or u2
6529 are false, the respective string is assumed to be in native 8-bit
6532 If the pe1 and pe2 are non-NULL, the scanning pointers will be copied
6533 in there (they will point at the beginning of the I<next> character).
6534 If the pointers behind pe1 or pe2 are non-NULL, they are the end
6535 pointers beyond which scanning will not continue under any
6536 circumstances. If the byte lengths l1 and l2 are non-zero, s1+l1 and
6537 s2+l2 will be used as goal end pointers that will also stop the scan,
6538 and which qualify towards defining a successful match: all the scans
6539 that define an explicit length must reach their goal pointers for
6540 a match to succeed).
6542 For case-insensitiveness, the "casefolding" of Unicode is used
6543 instead of upper/lowercasing both the characters, see
6544 http://www.unicode.org/unicode/reports/tr21/ (Case Mappings).
6546 I32 ibcmp_utf8(const char* a, char **pe1, UV l1, bool u1, const char* b, char **pe2, UV l2, bool u2)
6549 Found in file utf8.c
6554 Tests if some arbitrary number of bytes begins in a valid UTF-8
6555 character. Note that an INVARIANT (i.e. ASCII) character is a valid
6556 UTF-8 character. The actual number of bytes in the UTF-8 character
6557 will be returned if it is valid, otherwise 0.
6559 STRLEN is_utf8_char(const U8 *p)
6562 Found in file utf8.c
6564 =item is_utf8_string
6567 Returns true if first C<len> bytes of the given string form a valid
6568 UTF-8 string, false otherwise. Note that 'a valid UTF-8 string' does
6569 not mean 'a string that contains code points above 0x7F encoded in UTF-8'
6570 because a valid ASCII string is a valid UTF-8 string.
6572 See also is_utf8_string_loclen() and is_utf8_string_loc().
6574 bool is_utf8_string(const U8 *s, STRLEN len)
6577 Found in file utf8.c
6579 =item is_utf8_string_loc
6580 X<is_utf8_string_loc>
6582 Like is_utf8_string() but stores the location of the failure (in the
6583 case of "utf8ness failure") or the location s+len (in the case of
6584 "utf8ness success") in the C<ep>.
6586 See also is_utf8_string_loclen() and is_utf8_string().
6588 bool is_utf8_string_loc(const U8 *s, STRLEN len, const U8 **p)
6591 Found in file utf8.c
6593 =item is_utf8_string_loclen
6594 X<is_utf8_string_loclen>
6596 Like is_utf8_string() but stores the location of the failure (in the
6597 case of "utf8ness failure") or the location s+len (in the case of
6598 "utf8ness success") in the C<ep>, and the number of UTF-8
6599 encoded characters in the C<el>.
6601 See also is_utf8_string_loc() and is_utf8_string().
6603 bool is_utf8_string_loclen(const U8 *s, STRLEN len, const U8 **ep, STRLEN *el)
6606 Found in file utf8.c
6608 =item pv_uni_display
6611 Build to the scalar dsv a displayable version of the string spv,
6612 length len, the displayable version being at most pvlim bytes long
6613 (if longer, the rest is truncated and "..." will be appended).
6615 The flags argument can have UNI_DISPLAY_ISPRINT set to display
6616 isPRINT()able characters as themselves, UNI_DISPLAY_BACKSLASH
6617 to display the \\[nrfta\\] as the backslashed versions (like '\n')
6618 (UNI_DISPLAY_BACKSLASH is preferred over UNI_DISPLAY_ISPRINT for \\).
6619 UNI_DISPLAY_QQ (and its alias UNI_DISPLAY_REGEX) have both
6620 UNI_DISPLAY_BACKSLASH and UNI_DISPLAY_ISPRINT turned on.
6622 The pointer to the PV of the dsv is returned.
6624 char* pv_uni_display(SV *dsv, const U8 *spv, STRLEN len, STRLEN pvlim, UV flags)
6627 Found in file utf8.c
6632 The encoding is assumed to be an Encode object, the PV of the ssv is
6633 assumed to be octets in that encoding and decoding the input starts
6634 from the position which (PV + *offset) pointed to. The dsv will be
6635 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
6636 when the string tstr appears in decoding output or the input ends on
6637 the PV of the ssv. The value which the offset points will be modified
6638 to the last input position on the ssv.
6640 Returns TRUE if the terminator was found, else returns FALSE.
6642 bool sv_cat_decode(SV* dsv, SV *encoding, SV *ssv, int *offset, char* tstr, int tlen)
6647 =item sv_recode_to_utf8
6648 X<sv_recode_to_utf8>
6650 The encoding is assumed to be an Encode object, on entry the PV
6651 of the sv is assumed to be octets in that encoding, and the sv
6652 will be converted into Unicode (and UTF-8).
6654 If the sv already is UTF-8 (or if it is not POK), or if the encoding
6655 is not a reference, nothing is done to the sv. If the encoding is not
6656 an C<Encode::XS> Encoding object, bad things will happen.
6657 (See F<lib/encoding.pm> and L<Encode>).
6659 The PV of the sv is returned.
6661 char* sv_recode_to_utf8(SV* sv, SV *encoding)
6666 =item sv_uni_display
6669 Build to the scalar dsv a displayable version of the scalar sv,
6670 the displayable version being at most pvlim bytes long
6671 (if longer, the rest is truncated and "..." will be appended).
6673 The flags argument is as in pv_uni_display().
6675 The pointer to the PV of the dsv is returned.
6677 char* sv_uni_display(SV *dsv, SV *ssv, STRLEN pvlim, UV flags)
6680 Found in file utf8.c
6685 The "p" contains the pointer to the UTF-8 string encoding
6686 the character that is being converted.
6688 The "ustrp" is a pointer to the character buffer to put the
6689 conversion result to. The "lenp" is a pointer to the length
6692 The "swashp" is a pointer to the swash to use.
6694 Both the special and normal mappings are stored lib/unicore/To/Foo.pl,
6695 and loaded by SWASHNEW, using lib/utf8_heavy.pl. The special (usually,
6696 but not always, a multicharacter mapping), is tried first.
6698 The "special" is a string like "utf8::ToSpecLower", which means the
6699 hash %utf8::ToSpecLower. The access to the hash is through
6700 Perl_to_utf8_case().
6702 The "normal" is a string like "ToLower" which means the swash
6705 UV to_utf8_case(const U8 *p, U8* ustrp, STRLEN *lenp, SV **swashp, const char *normal, const char *special)
6708 Found in file utf8.c
6713 Convert the UTF-8 encoded character at p to its foldcase version and
6714 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6715 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6716 foldcase version may be longer than the original character (up to
6719 The first character of the foldcased version is returned
6720 (but note, as explained above, that there may be more.)
6722 UV to_utf8_fold(const U8 *p, U8* ustrp, STRLEN *lenp)
6725 Found in file utf8.c
6730 Convert the UTF-8 encoded character at p to its lowercase version and
6731 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6732 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6733 lowercase version may be longer than the original character.
6735 The first character of the lowercased version is returned
6736 (but note, as explained above, that there may be more.)
6738 UV to_utf8_lower(const U8 *p, U8* ustrp, STRLEN *lenp)
6741 Found in file utf8.c
6746 Convert the UTF-8 encoded character at p to its titlecase version and
6747 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6748 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6749 titlecase version may be longer than the original character.
6751 The first character of the titlecased version is returned
6752 (but note, as explained above, that there may be more.)
6754 UV to_utf8_title(const U8 *p, U8* ustrp, STRLEN *lenp)
6757 Found in file utf8.c
6762 Convert the UTF-8 encoded character at p to its uppercase version and
6763 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6764 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since
6765 the uppercase version may be longer than the original character.
6767 The first character of the uppercased version is returned
6768 (but note, as explained above, that there may be more.)
6770 UV to_utf8_upper(const U8 *p, U8* ustrp, STRLEN *lenp)
6773 Found in file utf8.c
6775 =item utf8n_to_uvchr
6780 Returns the native character value of the first character in the string
6782 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6783 length, in bytes, of that character.
6785 Allows length and flags to be passed to low level routine.
6787 UV utf8n_to_uvchr(const U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags)
6790 Found in file utf8.c
6792 =item utf8n_to_uvuni
6795 Bottom level UTF-8 decode routine.
6796 Returns the Unicode code point value of the first character in the string C<s>
6797 which is assumed to be in UTF-8 encoding and no longer than C<curlen>;
6798 C<retlen> will be set to the length, in bytes, of that character.
6800 If C<s> does not point to a well-formed UTF-8 character, the behaviour
6801 is dependent on the value of C<flags>: if it contains UTF8_CHECK_ONLY,
6802 it is assumed that the caller will raise a warning, and this function
6803 will silently just set C<retlen> to C<-1> and return zero. If the
6804 C<flags> does not contain UTF8_CHECK_ONLY, warnings about
6805 malformations will be given, C<retlen> will be set to the expected
6806 length of the UTF-8 character in bytes, and zero will be returned.
6808 The C<flags> can also contain various flags to allow deviations from
6809 the strict UTF-8 encoding (see F<utf8.h>).
6811 Most code should use utf8_to_uvchr() rather than call this directly.
6813 UV utf8n_to_uvuni(const U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags)
6816 Found in file utf8.c
6821 Returns the number of UTF-8 characters between the UTF-8 pointers C<a>
6824 WARNING: use only if you *know* that the pointers point inside the
6827 IV utf8_distance(const U8 *a, const U8 *b)
6830 Found in file utf8.c
6835 Return the UTF-8 pointer C<s> displaced by C<off> characters, either
6836 forward or backward.
6838 WARNING: do not use the following unless you *know* C<off> is within
6839 the UTF-8 data pointed to by C<s> *and* that on entry C<s> is aligned
6840 on the first byte of character or just after the last byte of a character.
6842 U8* utf8_hop(const U8 *s, I32 off)
6845 Found in file utf8.c
6850 Return the length of the UTF-8 char encoded string C<s> in characters.
6851 Stops at C<e> (inclusive). If C<e E<lt> s> or if the scan would end
6852 up past C<e>, croaks.
6854 STRLEN utf8_length(const U8* s, const U8 *e)
6857 Found in file utf8.c
6862 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
6863 Unlike C<bytes_to_utf8>, this over-writes the original string, and
6864 updates len to contain the new length.
6865 Returns zero on failure, setting C<len> to -1.
6867 If you need a copy of the string, see C<bytes_from_utf8>.
6869 NOTE: this function is experimental and may change or be
6870 removed without notice.
6872 U8* utf8_to_bytes(U8 *s, STRLEN *len)
6875 Found in file utf8.c
6880 Returns the native character value of the first character in the string C<s>
6881 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6882 length, in bytes, of that character.
6884 If C<s> does not point to a well-formed UTF-8 character, zero is
6885 returned and retlen is set, if possible, to -1.
6887 UV utf8_to_uvchr(const U8 *s, STRLEN *retlen)
6890 Found in file utf8.c
6895 Returns the Unicode code point of the first character in the string C<s>
6896 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6897 length, in bytes, of that character.
6899 This function should only be used when returned UV is considered
6900 an index into the Unicode semantic tables (e.g. swashes).
6902 If C<s> does not point to a well-formed UTF-8 character, zero is
6903 returned and retlen is set, if possible, to -1.
6905 UV utf8_to_uvuni(const U8 *s, STRLEN *retlen)
6908 Found in file utf8.c
6913 Adds the UTF-8 representation of the Native codepoint C<uv> to the end
6914 of the string C<d>; C<d> should be have at least C<UTF8_MAXBYTES+1> free
6915 bytes available. The return value is the pointer to the byte after the
6916 end of the new character. In other words,
6918 d = uvchr_to_utf8(d, uv);
6920 is the recommended wide native character-aware way of saying
6924 U8* uvchr_to_utf8(U8 *d, UV uv)
6927 Found in file utf8.c
6929 =item uvuni_to_utf8_flags
6930 X<uvuni_to_utf8_flags>
6932 Adds the UTF-8 representation of the Unicode codepoint C<uv> to the end
6933 of the string C<d>; C<d> should be have at least C<UTF8_MAXBYTES+1> free
6934 bytes available. The return value is the pointer to the byte after the
6935 end of the new character. In other words,
6937 d = uvuni_to_utf8_flags(d, uv, flags);
6941 d = uvuni_to_utf8(d, uv);
6943 (which is equivalent to)
6945 d = uvuni_to_utf8_flags(d, uv, 0);
6947 is the recommended Unicode-aware way of saying
6951 U8* uvuni_to_utf8_flags(U8 *d, UV uv, UV flags)
6954 Found in file utf8.c
6959 =head1 Variables created by C<xsubpp> and C<xsubpp> internal functions
6966 Variable which is setup by C<xsubpp> to indicate the stack base offset,
6967 used by the C<ST>, C<XSprePUSH> and C<XSRETURN> macros. The C<dMARK> macro
6968 must be called prior to setup the C<MARK> variable.
6973 Found in file XSUB.h
6978 Variable which is setup by C<xsubpp> to indicate the
6979 class name for a C++ XS constructor. This is always a C<char*>. See C<THIS>.
6984 Found in file XSUB.h
6989 Sets up the C<ax> variable.
6990 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
6995 Found in file XSUB.h
7000 Sets up the C<ax> variable and stack marker variable C<mark>.
7001 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
7006 Found in file XSUB.h
7011 Sets up the C<items> variable.
7012 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
7017 Found in file XSUB.h
7022 Sets up the C<padoff_du> variable for an XSUB that wishes to use
7028 Found in file XSUB.h
7033 Sets up stack and mark pointers for an XSUB, calling dSP and dMARK.
7034 Sets up the C<ax> and C<items> variables by calling C<dAX> and C<dITEMS>.
7035 This is usually handled automatically by C<xsubpp>.
7040 Found in file XSUB.h
7045 Sets up the C<ix> variable for an XSUB which has aliases. This is usually
7046 handled automatically by C<xsubpp>.
7051 Found in file XSUB.h
7056 Variable which is setup by C<xsubpp> to indicate the number of
7057 items on the stack. See L<perlxs/"Variable-length Parameter Lists">.
7062 Found in file XSUB.h
7067 Variable which is setup by C<xsubpp> to indicate which of an
7068 XSUB's aliases was used to invoke it. See L<perlxs/"The ALIAS: Keyword">.
7073 Found in file XSUB.h
7078 Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
7082 Found in file XSUB.h
7087 Variable which is setup by C<xsubpp> to hold the return value for an
7088 XSUB. This is always the proper type for the XSUB. See
7089 L<perlxs/"The RETVAL Variable">.
7094 Found in file XSUB.h
7099 Used to access elements on the XSUB's stack.
7104 Found in file XSUB.h
7109 Variable which is setup by C<xsubpp> to designate the object in a C++
7110 XSUB. This is always the proper type for the C++ object. See C<CLASS> and
7111 L<perlxs/"Using XS With C++">.
7116 Found in file XSUB.h
7121 The SV* corresponding to the $_ variable. Works even if there
7122 is a lexical $_ in scope.
7125 Found in file XSUB.h
7130 Macro to declare an XSUB and its C parameter list. This is handled by
7134 Found in file XSUB.h
7139 The version identifier for an XS module. This is usually
7140 handled automatically by C<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>.
7143 Found in file XSUB.h
7145 =item XS_VERSION_BOOTCHECK
7146 X<XS_VERSION_BOOTCHECK>
7148 Macro to verify that a PM module's $VERSION variable matches the XS
7149 module's C<XS_VERSION> variable. This is usually handled automatically by
7150 C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">.
7152 XS_VERSION_BOOTCHECK;
7155 Found in file XSUB.h
7160 =head1 Warning and Dieing
7167 This is the XSUB-writer's interface to Perl's C<die> function.
7168 Normally call this function the same way you call the C C<printf>
7169 function. Calling C<croak> returns control directly to Perl,
7170 sidestepping the normal C order of execution. See C<warn>.
7172 If you want to throw an exception object, assign the object to
7173 C<$@> and then pass C<NULL> to croak():
7175 errsv = get_sv("@", TRUE);
7176 sv_setsv(errsv, exception_object);
7179 void croak(const char* pat, ...)
7182 Found in file util.c
7187 This is the XSUB-writer's interface to Perl's C<warn> function. Call this
7188 function the same way you call the C C<printf> function. See C<croak>.
7190 void warn(const char* pat, ...)
7193 Found in file util.c
7200 Until May 1997, this document was maintained by Jeff Okamoto
7201 <okamoto@corp.hp.com>. It is now maintained as part of Perl itself.
7203 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
7204 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
7205 Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
7206 Stephen McCamant, and Gurusamy Sarathy.
7208 API Listing originally by Dean Roehrich <roehrich@cray.com>.
7210 Updated to be autogenerated from comments in the source by Benjamin Stuhl.
7214 perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
projects / p5sagit/p5-mst-13.2.git / blob