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 *av)
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 *av, 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 *av, I32 key)
194 Pre-extend an array. The C<key> is the index to which the array should be
197 void av_extend(AV *av, 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 *av, 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 *av, 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 *av)
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 **strp)
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 *av, SV *val)
282 Shifts an SV off the beginning of the array. Returns C<&PL_sv_undef> if the
293 Stores an SV in an array. The array index is specified as C<key>. The
294 return value will be NULL if the operation failed or if the value did not
295 need to be actually stored within the array (as in the case of tied
296 arrays). Otherwise it can be dereferenced to get the original C<SV*>. Note
297 that the caller is responsible for suitably incrementing the reference
298 count of C<val> before the call, and decrementing it if the function
301 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for
302 more information on how to use this function on tied arrays.
304 SV** av_store(AV *av, I32 key, SV *val)
312 Undefines the array. Frees the memory used by the array itself.
314 void av_undef(AV *av)
322 Unshift the given number of C<undef> values onto the beginning of the
323 array. The array will grow automatically to accommodate the addition. You
324 must then use C<av_store> to assign values to these new elements.
326 void av_unshift(AV *av, I32 num)
334 Returns the AV of the specified Perl array. If C<create> is set and the
335 Perl variable does not exist then it will be created. If C<create> is not
336 set and the variable does not exist then NULL is returned.
338 NOTE: the perl_ form of this function is deprecated.
340 AV* get_av(const char* name, I32 create)
348 Creates a new AV. The reference count is set to 1.
358 Sort an array. Here is an example:
360 sortsv(AvARRAY(av), av_len(av)+1, Perl_sv_cmp_locale);
362 Currently this always uses mergesort. See sortsv_flags for a more
365 void sortsv(SV** array, size_t num_elts, SVCOMPARE_t cmp)
368 Found in file pp_sort.c
373 Sort an array, with various options.
375 void sortsv_flags(SV** array, size_t num_elts, SVCOMPARE_t cmp, U32 flags)
378 Found in file pp_sort.c
383 =head1 Callback Functions
390 Performs a callback to the specified Perl sub. See L<perlcall>.
392 NOTE: the perl_ form of this function is deprecated.
394 I32 call_argv(const char* sub_name, I32 flags, char** argv)
402 Performs a callback to the specified Perl method. The blessed object must
403 be on the stack. See L<perlcall>.
405 NOTE: the perl_ form of this function is deprecated.
407 I32 call_method(const char* methname, I32 flags)
415 Performs a callback to the specified Perl sub. See L<perlcall>.
417 NOTE: the perl_ form of this function is deprecated.
419 I32 call_pv(const char* sub_name, I32 flags)
427 Performs a callback to the Perl sub whose name is in the SV. See
430 NOTE: the perl_ form of this function is deprecated.
432 I32 call_sv(SV* sv, VOL I32 flags)
440 Opening bracket on a callback. See C<LEAVE> and L<perlcall>.
445 Found in file scope.h
450 Tells Perl to C<eval> the given string and return an SV* result.
452 NOTE: the perl_ form of this function is deprecated.
454 SV* eval_pv(const char* p, I32 croak_on_error)
462 Tells Perl to C<eval> the string in the SV.
464 NOTE: the perl_ form of this function is deprecated.
466 I32 eval_sv(SV* sv, I32 flags)
474 Closing bracket for temporaries on a callback. See C<SAVETMPS> and
480 Found in file scope.h
485 Closing bracket on a callback. See C<ENTER> and L<perlcall>.
490 Found in file scope.h
495 Opening bracket for temporaries on a callback. See C<FREETMPS> and
501 Found in file scope.h
506 =head1 Character classes
513 Returns a boolean indicating whether the C C<char> is an ASCII alphanumeric
514 character (including underscore) or digit.
516 bool isALNUM(char ch)
519 Found in file handy.h
524 Returns a boolean indicating whether the C C<char> is an ASCII alphabetic
527 bool isALPHA(char ch)
530 Found in file handy.h
535 Returns a boolean indicating whether the C C<char> is an ASCII
538 bool isDIGIT(char ch)
541 Found in file handy.h
546 Returns a boolean indicating whether the C C<char> is a lowercase
549 bool isLOWER(char ch)
552 Found in file handy.h
557 Returns a boolean indicating whether the C C<char> is whitespace.
559 bool isSPACE(char ch)
562 Found in file handy.h
567 Returns a boolean indicating whether the C C<char> is an uppercase
570 bool isUPPER(char ch)
573 Found in file handy.h
578 Converts the specified character to lowercase.
580 char toLOWER(char ch)
583 Found in file handy.h
588 Converts the specified character to uppercase.
590 char toUPPER(char ch)
593 Found in file handy.h
598 =head1 Cloning an interpreter
605 Create and return a new interpreter by cloning the current one.
607 perl_clone takes these flags as parameters:
609 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
610 without it we only clone the data and zero the stacks,
611 with it we copy the stacks and the new perl interpreter is
612 ready to run at the exact same point as the previous one.
613 The pseudo-fork code uses COPY_STACKS while the
614 threads->create doesn't.
616 CLONEf_KEEP_PTR_TABLE
617 perl_clone keeps a ptr_table with the pointer of the old
618 variable as a key and the new variable as a value,
619 this allows it to check if something has been cloned and not
620 clone it again but rather just use the value and increase the
621 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
622 the ptr_table using the function
623 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
624 reason to keep it around is if you want to dup some of your own
625 variable who are outside the graph perl scans, example of this
626 code is in threads.xs create
629 This is a win32 thing, it is ignored on unix, it tells perls
630 win32host code (which is c++) to clone itself, this is needed on
631 win32 if you want to run two threads at the same time,
632 if you just want to do some stuff in a separate perl interpreter
633 and then throw it away and return to the original one,
634 you don't need to do anything.
636 PerlInterpreter* perl_clone(PerlInterpreter *proto_perl, UV flags)
644 =head1 CV Manipulation Functions
651 Returns the stash of the CV.
661 Uses C<strlen> to get the length of C<name>, then calls C<get_cvn_flags>.
663 NOTE: the perl_ form of this function is deprecated.
665 CV* get_cv(const char* name, I32 flags)
673 Returns the CV of the specified Perl subroutine. C<flags> are passed to
674 C<gv_fetchpvn_flags>. If C<GV_ADD> is set and the Perl subroutine does not
675 exist then it will be declared (which has the same effect as saying
676 C<sub name;>). If C<GV_ADD> is not set and the subroutine does not exist
677 then NULL is returned.
679 NOTE: the perl_ form of this function is deprecated.
681 CV* get_cvn_flags(const char* name, STRLEN len, I32 flags)
689 =head1 Embedding Functions
696 Clear out all the active components of a CV. This can happen either
697 by an explicit C<undef &foo>, or by the reference count going to zero.
698 In the former case, we keep the CvOUTSIDE pointer, so that any anonymous
699 children can still follow the full lexical scope chain.
701 void cv_undef(CV* cv)
709 Loads the module whose name is pointed to by the string part of name.
710 Note that the actual module name, not its filename, should be given.
711 Eg, "Foo::Bar" instead of "Foo/Bar.pm". flags can be any of
712 PERL_LOADMOD_DENY, PERL_LOADMOD_NOIMPORT, or PERL_LOADMOD_IMPORT_OPS
713 (or 0 for no flags). ver, if specified, provides version semantics
714 similar to C<use Foo::Bar VERSION>. The optional trailing SV*
715 arguments can be used to specify arguments to the module's import()
716 method, similar to C<use Foo::Bar VERSION LIST>.
718 void load_module(U32 flags, SV* name, SV* ver, ...)
726 Stub that provides thread hook for perl_destruct when there are
737 Allocates a new Perl interpreter. See L<perlembed>.
739 PerlInterpreter* perl_alloc()
747 Initializes a new Perl interpreter. See L<perlembed>.
749 void perl_construct(PerlInterpreter *my_perl)
757 Shuts down a Perl interpreter. See L<perlembed>.
759 int perl_destruct(PerlInterpreter *my_perl)
767 Releases a Perl interpreter. See L<perlembed>.
769 void perl_free(PerlInterpreter *my_perl)
777 Tells a Perl interpreter to parse a Perl script. See L<perlembed>.
779 int perl_parse(PerlInterpreter *my_perl, XSINIT_t xsinit, int argc, char** argv, char** env)
787 Tells a Perl interpreter to run. See L<perlembed>.
789 int perl_run(PerlInterpreter *my_perl)
797 Tells Perl to C<require> the file named by the string argument. It is
798 analogous to the Perl code C<eval "require '$file'">. It's even
799 implemented that way; consider using load_module instead.
801 NOTE: the perl_ form of this function is deprecated.
803 void require_pv(const char* pv)
811 =head1 Functions in file dump.c
819 char *pv_display(SV *dsv, const char *pv, STRLEN cur, STRLEN len,
820 STRLEN pvlim, U32 flags)
824 pv_escape(dsv,pv,cur,pvlim,PERL_PV_ESCAPE_QUOTE);
826 except that an additional "\0" will be appended to the string when
827 len > cur and pv[cur] is "\0".
829 Note that the final string may be up to 7 chars longer than pvlim.
831 char* pv_display(SV *dsv, const char *pv, STRLEN cur, STRLEN len, STRLEN pvlim)
839 |const STRLEN count|const STRLEN max
840 |STRLEN const *escaped, const U32 flags
842 Escapes at most the first "count" chars of pv and puts the results into
843 dsv such that the size of the escaped string will not exceed "max" chars
844 and will not contain any incomplete escape sequences.
846 If flags contains PERL_PV_ESCAPE_QUOTE then any double quotes in the string
847 will also be escaped.
849 Normally the SV will be cleared before the escaped string is prepared,
850 but when PERL_PV_ESCAPE_NOCLEAR is set this will not occur.
852 If PERL_PV_ESCAPE_UNI is set then the input string is treated as Unicode,
853 if PERL_PV_ESCAPE_UNI_DETECT is set then the input string is scanned
854 using C<is_utf8_string()> to determine if it is Unicode.
856 If PERL_PV_ESCAPE_ALL is set then all input chars will be output
857 using C<\x01F1> style escapes, otherwise only chars above 255 will be
858 escaped using this style, other non printable chars will use octal or
859 common escaped patterns like C<\n>. If PERL_PV_ESCAPE_NOBACKSLASH
860 then all chars below 255 will be treated as printable and
861 will be output as literals.
863 If PERL_PV_ESCAPE_FIRSTCHAR is set then only the first char of the
864 string will be escaped, regardles of max. If the string is utf8 and
865 the chars value is >255 then it will be returned as a plain hex
866 sequence. Thus the output will either be a single char,
867 an octal escape sequence, a special escape like C<\n> or a 3 or
868 more digit hex value.
870 If PERL_PV_ESCAPE_RE is set then the escape char used will be a '%' and
871 not a '\\'. This is because regexes very often contain backslashed
872 sequences, whereas '%' is not a particularly common character in patterns.
874 Returns a pointer to the escaped text as held by dsv.
876 NOTE: the perl_ form of this function is deprecated.
878 char* pv_escape(SV *dsv, char const * const str, const STRLEN count, const STRLEN max, STRLEN * const escaped, const U32 flags)
886 |const STRLEN count|const STRLEN max\
887 |const char const *start_color| const char const *end_color\
890 Converts a string into something presentable, handling escaping via
891 pv_escape() and supporting quoting and ellipses.
893 If the PERL_PV_PRETTY_QUOTE flag is set then the result will be
894 double quoted with any double quotes in the string escaped. Otherwise
895 if the PERL_PV_PRETTY_LTGT flag is set then the result be wrapped in
898 If the PERL_PV_PRETTY_ELLIPSES flag is set and not all characters in
899 string were output then an ellipsis C<...> will be appended to the
900 string. Note that this happens AFTER it has been quoted.
902 If start_color is non-null then it will be inserted after the opening
903 quote (if there is one) but before the escaped text. If end_color
904 is non-null then it will be inserted after the escaped text but before
905 any quotes or ellipses.
907 Returns a pointer to the prettified text as held by dsv.
909 NOTE: the perl_ form of this function is deprecated.
911 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)
919 =head1 Functions in file mathoms.c
927 See L<gv_fetchmethod_autoload>.
929 GV* gv_fetchmethod(HV* stash, const char* name)
932 Found in file mathoms.c
937 The engine implementing pack() Perl function. Note: parameters next_in_list and
938 flags are not used. This call should not be used; use packlist instead.
940 void pack_cat(SV *cat, const char *pat, const char *patend, SV **beglist, SV **endlist, SV ***next_in_list, U32 flags)
943 Found in file mathoms.c
945 =item sv_2pvbyte_nolen
948 Return a pointer to the byte-encoded representation of the SV.
949 May cause the SV to be downgraded from UTF-8 as a side-effect.
951 Usually accessed via the C<SvPVbyte_nolen> macro.
953 char* sv_2pvbyte_nolen(SV* sv)
956 Found in file mathoms.c
958 =item sv_2pvutf8_nolen
961 Return a pointer to the UTF-8-encoded representation of the SV.
962 May cause the SV to be upgraded to UTF-8 as a side-effect.
964 Usually accessed via the C<SvPVutf8_nolen> macro.
966 char* sv_2pvutf8_nolen(SV* sv)
969 Found in file mathoms.c
974 Like C<sv_2pv()>, but doesn't return the length too. You should usually
975 use the macro wrapper C<SvPV_nolen(sv)> instead.
976 char* sv_2pv_nolen(SV* sv)
979 Found in file mathoms.c
984 Like C<sv_catpvn>, but also handles 'set' magic.
986 void sv_catpvn_mg(SV *sv, const char *ptr, STRLEN len)
989 Found in file mathoms.c
994 Like C<sv_catsv>, but also handles 'set' magic.
996 void sv_catsv_mg(SV *dsv, SV *ssv)
999 Found in file mathoms.c
1001 =item sv_force_normal
1004 Undo various types of fakery on an SV: if the PV is a shared string, make
1005 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
1006 an xpvmg. See also C<sv_force_normal_flags>.
1008 void sv_force_normal(SV *sv)
1011 Found in file mathoms.c
1016 A private implementation of the C<SvIVx> macro for compilers which can't
1017 cope with complex macro expressions. Always use the macro instead.
1022 Found in file mathoms.c
1027 Dummy routine which "locks" an SV when there is no locking module present.
1028 Exists to avoid test for a NULL function pointer and because it could
1029 potentially warn under some level of strict-ness.
1031 "Superseded" by sv_nosharing().
1033 void sv_nolocking(SV *sv)
1036 Found in file mathoms.c
1038 =item sv_nounlocking
1041 Dummy routine which "unlocks" an SV when there is no locking module present.
1042 Exists to avoid test for a NULL function pointer and because it could
1043 potentially warn under some level of strict-ness.
1045 "Superseded" by sv_nosharing().
1047 void sv_nounlocking(SV *sv)
1050 Found in file mathoms.c
1055 A private implementation of the C<SvNVx> macro for compilers which can't
1056 cope with complex macro expressions. Always use the macro instead.
1061 Found in file mathoms.c
1066 Use the C<SvPV_nolen> macro instead
1071 Found in file mathoms.c
1076 Use C<SvPVbyte_nolen> instead.
1078 char* sv_pvbyte(SV *sv)
1081 Found in file mathoms.c
1086 A private implementation of the C<SvPVbyte> macro for compilers
1087 which can't cope with complex macro expressions. Always use the macro
1090 char* sv_pvbyten(SV *sv, STRLEN *lp)
1093 Found in file mathoms.c
1098 A private implementation of the C<SvPV> macro for compilers which can't
1099 cope with complex macro expressions. Always use the macro instead.
1101 char* sv_pvn(SV *sv, STRLEN *lp)
1104 Found in file mathoms.c
1109 Use the C<SvPVutf8_nolen> macro instead
1111 char* sv_pvutf8(SV *sv)
1114 Found in file mathoms.c
1119 A private implementation of the C<SvPVutf8> macro for compilers
1120 which can't cope with complex macro expressions. Always use the macro
1123 char* sv_pvutf8n(SV *sv, STRLEN *lp)
1126 Found in file mathoms.c
1131 Taint an SV. Use C<SvTAINTED_on> instead.
1132 void sv_taint(SV* sv)
1135 Found in file mathoms.c
1140 Unsets the RV status of the SV, and decrements the reference count of
1141 whatever was being referenced by the RV. This can almost be thought of
1142 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
1143 being zero. See C<SvROK_off>.
1145 void sv_unref(SV* sv)
1148 Found in file mathoms.c
1153 Tells an SV to use C<ptr> to find its string value. Implemented by
1154 calling C<sv_usepvn_flags> with C<flags> of 0, hence does not handle 'set'
1155 magic. See C<sv_usepvn_flags>.
1157 void sv_usepvn(SV* sv, char* ptr, STRLEN len)
1160 Found in file mathoms.c
1165 Like C<sv_usepvn>, but also handles 'set' magic.
1167 void sv_usepvn_mg(SV *sv, char *ptr, STRLEN len)
1170 Found in file mathoms.c
1175 A private implementation of the C<SvUVx> macro for compilers which can't
1176 cope with complex macro expressions. Always use the macro instead.
1181 Found in file mathoms.c
1186 The engine implementing unpack() Perl function. Note: parameters strbeg, new_s
1187 and ocnt are not used. This call should not be used, use unpackstring instead.
1189 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)
1192 Found in file mathoms.c
1197 =head1 Functions in file pp_ctl.c
1205 Locate the CV corresponding to the currently executing sub or eval.
1206 If db_seqp is non_null, skip CVs that are in the DB package and populate
1207 *db_seqp with the cop sequence number at the point that the DB:: code was
1208 entered. (allows debuggers to eval in the scope of the breakpoint rather
1209 than in the scope of the debugger itself).
1211 CV* find_runcv(U32 *db_seqp)
1214 Found in file pp_ctl.c
1219 =head1 Functions in file pp_pack.c
1227 The engine implementing pack() Perl function.
1229 void packlist(SV *cat, const char *pat, const char *patend, SV **beglist, SV **endlist)
1232 Found in file pp_pack.c
1237 The engine implementing unpack() Perl function. C<unpackstring> puts the
1238 extracted list items on the stack and returns the number of elements.
1239 Issue C<PUTBACK> before and C<SPAGAIN> after the call to this function.
1241 I32 unpackstring(const char *pat, const char *patend, const char *s, const char *strend, U32 flags)
1244 Found in file pp_pack.c
1256 Return the SV from the GV.
1266 If C<gv> is a typeglob whose subroutine entry is a constant sub eligible for
1267 inlining, or C<gv> is a placeholder reference that would be promoted to such
1268 a typeglob, then returns the value returned by the sub. Otherwise, returns
1271 SV* gv_const_sv(GV* gv)
1279 Returns the glob with the given C<name> and a defined subroutine or
1280 C<NULL>. The glob lives in the given C<stash>, or in the stashes
1281 accessible via @ISA and UNIVERSAL::.
1283 The argument C<level> should be either 0 or -1. If C<level==0>, as a
1284 side-effect creates a glob with the given C<name> in the given C<stash>
1285 which in the case of success contains an alias for the subroutine, and sets
1286 up caching info for this glob.
1288 This function grants C<"SUPER"> token as a postfix of the stash name. The
1289 GV returned from C<gv_fetchmeth> may be a method cache entry, which is not
1290 visible to Perl code. So when calling C<call_sv>, you should not use
1291 the GV directly; instead, you should use the method's CV, which can be
1292 obtained from the GV with the C<GvCV> macro.
1294 GV* gv_fetchmeth(HV* stash, const char* name, STRLEN len, I32 level)
1299 =item gv_fetchmethod_autoload
1300 X<gv_fetchmethod_autoload>
1302 Returns the glob which contains the subroutine to call to invoke the method
1303 on the C<stash>. In fact in the presence of autoloading this may be the
1304 glob for "AUTOLOAD". In this case the corresponding variable $AUTOLOAD is
1307 The third parameter of C<gv_fetchmethod_autoload> determines whether
1308 AUTOLOAD lookup is performed if the given method is not present: non-zero
1309 means yes, look for AUTOLOAD; zero means no, don't look for AUTOLOAD.
1310 Calling C<gv_fetchmethod> is equivalent to calling C<gv_fetchmethod_autoload>
1311 with a non-zero C<autoload> parameter.
1313 These functions grant C<"SUPER"> token as a prefix of the method name. Note
1314 that if you want to keep the returned glob for a long time, you need to
1315 check for it being "AUTOLOAD", since at the later time the call may load a
1316 different subroutine due to $AUTOLOAD changing its value. Use the glob
1317 created via a side effect to do this.
1319 These functions have the same side-effects and as C<gv_fetchmeth> with
1320 C<level==0>. C<name> should be writable if contains C<':'> or C<'
1321 ''>. The warning against passing the GV returned by C<gv_fetchmeth> to
1322 C<call_sv> apply equally to these functions.
1324 GV* gv_fetchmethod_autoload(HV* stash, const char* name, I32 autoload)
1329 =item gv_fetchmeth_autoload
1330 X<gv_fetchmeth_autoload>
1332 Same as gv_fetchmeth(), but looks for autoloaded subroutines too.
1333 Returns a glob for the subroutine.
1335 For an autoloaded subroutine without a GV, will create a GV even
1336 if C<level < 0>. For an autoloaded subroutine without a stub, GvCV()
1337 of the result may be zero.
1339 GV* gv_fetchmeth_autoload(HV* stash, const char* name, STRLEN len, I32 level)
1347 Returns a pointer to the stash for a specified package. Uses C<strlen> to
1348 determine the length of C<name>, then calls C<gv_stashpvn()>.
1350 HV* gv_stashpv(const char* name, I32 flags)
1358 Returns a pointer to the stash for a specified package. The C<namelen>
1359 parameter indicates the length of the C<name>, in bytes. C<flags> is passed
1360 to C<gv_fetchpvn_flags()>, so if set to C<GV_ADD> then the package will be
1361 created if it does not already exist. If the package does not exist and
1362 C<flags> is 0 (or any other setting that does not create packages) then NULL
1366 HV* gv_stashpvn(const char* name, U32 namelen, I32 flags)
1374 Like C<gv_stashpvn>, but takes a literal string instead of a string/length pair.
1376 HV* gv_stashpvs(const char* name, I32 create)
1379 Found in file handy.h
1384 Returns a pointer to the stash for a specified package. See C<gv_stashpvn>.
1386 HV* gv_stashsv(SV* sv, I32 flags)
1403 (deprecated - use C<(AV *)NULL> instead)
1411 Null character pointer. (No longer available when C<PERL_CORE> is defined.)
1414 Found in file handy.h
1421 (deprecated - use C<(CV *)NULL> instead)
1431 (deprecated - use C<(HV *)NULL> instead)
1439 Null SV pointer. (No longer available when C<PERL_CORE> is defined.)
1442 Found in file handy.h
1447 =head1 Hash Manipulation Functions
1454 Returns the HV of the specified Perl hash. If C<create> is set and the
1455 Perl variable does not exist then it will be created. If C<create> is not
1456 set and the variable does not exist then NULL is returned.
1458 NOTE: the perl_ form of this function is deprecated.
1460 HV* get_hv(const char* name, I32 create)
1463 Found in file perl.c
1468 This flag, used in the length slot of hash entries and magic structures,
1469 specifies the structure contains an C<SV*> pointer where a C<char*> pointer
1470 is to be expected. (For information only--not to be used).
1478 Returns the computed hash stored in the hash entry.
1488 Returns the actual pointer stored in the key slot of the hash entry. The
1489 pointer may be either C<char*> or C<SV*>, depending on the value of
1490 C<HeKLEN()>. Can be assigned to. The C<HePV()> or C<HeSVKEY()> macros are
1491 usually preferable for finding the value of a key.
1501 If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry
1502 holds an C<SV*> key. Otherwise, holds the actual length of the key. Can
1503 be assigned to. The C<HePV()> macro is usually preferable for finding key
1506 STRLEN HeKLEN(HE* he)
1514 Returns the key slot of the hash entry as a C<char*> value, doing any
1515 necessary dereferencing of possibly C<SV*> keys. The length of the string
1516 is placed in C<len> (this is a macro, so do I<not> use C<&len>). If you do
1517 not care about what the length of the key is, you may use the global
1518 variable C<PL_na>, though this is rather less efficient than using a local
1519 variable. Remember though, that hash keys in perl are free to contain
1520 embedded nulls, so using C<strlen()> or similar is not a good way to find
1521 the length of hash keys. This is very similar to the C<SvPV()> macro
1522 described elsewhere in this document. See also C<HeUTF8>.
1524 If you are using C<HePV> to get values to pass to C<newSVpvn()> to create a
1525 new SV, you should consider using C<newSVhek(HeKEY_hek(he))> as it is more
1528 char* HePV(HE* he, STRLEN len)
1536 Returns the key as an C<SV*>, or C<NULL> if the hash entry does not
1537 contain an C<SV*> key.
1547 Returns the key as an C<SV*>. Will create and return a temporary mortal
1548 C<SV*> if the hash entry contains only a C<char*> key.
1550 SV* HeSVKEY_force(HE* he)
1558 Sets the key to a given C<SV*>, taking care to set the appropriate flags to
1559 indicate the presence of an C<SV*> key, and returns the same
1562 SV* HeSVKEY_set(HE* he, SV* sv)
1570 Returns whether the C<char *> value returned by C<HePV> is encoded in UTF-8,
1571 doing any necessary dereferencing of possibly C<SV*> keys. The value returned
1572 will be 0 or non-0, not necessarily 1 (or even a value with any low bits set),
1573 so B<do not> blindly assign this to a C<bool> variable, as C<bool> may be a
1574 typedef for C<char>.
1576 char* HeUTF8(HE* he, STRLEN len)
1584 Returns the value slot (type C<SV*>) stored in the hash entry.
1594 Returns the package name of a stash, or NULL if C<stash> isn't a stash.
1595 See C<SvSTASH>, C<CvSTASH>.
1597 char* HvNAME(HV* stash)
1605 Check that a hash is in an internally consistent state.
1607 void hv_assert(HV *hv)
1615 Clears a hash, making it empty.
1617 void hv_clear(HV *hv)
1622 =item hv_clear_placeholders
1623 X<hv_clear_placeholders>
1625 Clears any placeholders from a hash. If a restricted hash has any of its keys
1626 marked as readonly and the key is subsequently deleted, the key is not actually
1627 deleted but is marked by assigning it a value of &PL_sv_placeholder. This tags
1628 it so it will be ignored by future operations such as iterating over the hash,
1629 but will still allow the hash to have a value reassigned to the key at some
1630 future point. This function clears any such placeholder keys from the hash.
1631 See Hash::Util::lock_keys() for an example of its use.
1633 void hv_clear_placeholders(HV *hv)
1641 Deletes a key/value pair in the hash. The value SV is removed from the
1642 hash and returned to the caller. The C<klen> is the length of the key.
1643 The C<flags> value will normally be zero; if set to G_DISCARD then NULL
1646 SV* hv_delete(HV *hv, const char *key, I32 klen, I32 flags)
1654 Deletes a key/value pair in the hash. The value SV is removed from the
1655 hash and returned to the caller. The C<flags> value will normally be zero;
1656 if set to G_DISCARD then NULL will be returned. C<hash> can be a valid
1657 precomputed hash value, or 0 to ask for it to be computed.
1659 SV* hv_delete_ent(HV *hv, SV *keysv, I32 flags, U32 hash)
1667 Returns a boolean indicating whether the specified hash key exists. The
1668 C<klen> is the length of the key.
1670 bool hv_exists(HV *hv, const char *key, I32 klen)
1678 Returns a boolean indicating whether the specified hash key exists. C<hash>
1679 can be a valid precomputed hash value, or 0 to ask for it to be
1682 bool hv_exists_ent(HV *hv, SV *keysv, U32 hash)
1690 Returns the SV which corresponds to the specified key in the hash. The
1691 C<klen> is the length of the key. If C<lval> is set then the fetch will be
1692 part of a store. Check that the return value is non-null before
1693 dereferencing it to an C<SV*>.
1695 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1696 information on how to use this function on tied hashes.
1698 SV** hv_fetch(HV *hv, const char *key, I32 klen, I32 lval)
1706 Like C<hv_fetch>, but takes a literal string instead of a string/length pair.
1708 SV** hv_fetchs(HV* tb, const char* key, I32 lval)
1711 Found in file handy.h
1716 Returns the hash entry which corresponds to the specified key in the hash.
1717 C<hash> must be a valid precomputed hash number for the given C<key>, or 0
1718 if you want the function to compute it. IF C<lval> is set then the fetch
1719 will be part of a store. Make sure the return value is non-null before
1720 accessing it. The return value when C<tb> is a tied hash is a pointer to a
1721 static location, so be sure to make a copy of the structure if you need to
1724 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1725 information on how to use this function on tied hashes.
1727 HE* hv_fetch_ent(HV *hv, SV *keysv, I32 lval, U32 hash)
1735 Prepares a starting point to traverse a hash table. Returns the number of
1736 keys in the hash (i.e. the same as C<HvKEYS(tb)>). The return value is
1737 currently only meaningful for hashes without tie magic.
1739 NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
1740 hash buckets that happen to be in use. If you still need that esoteric
1741 value, you can get it through the macro C<HvFILL(tb)>.
1744 I32 hv_iterinit(HV *hv)
1752 Returns the key from the current position of the hash iterator. See
1755 char* hv_iterkey(HE* entry, I32* retlen)
1763 Returns the key as an C<SV*> from the current position of the hash
1764 iterator. The return value will always be a mortal copy of the key. Also
1767 SV* hv_iterkeysv(HE* entry)
1775 Returns entries from a hash iterator. See C<hv_iterinit>.
1777 You may call C<hv_delete> or C<hv_delete_ent> on the hash entry that the
1778 iterator currently points to, without losing your place or invalidating your
1779 iterator. Note that in this case the current entry is deleted from the hash
1780 with your iterator holding the last reference to it. Your iterator is flagged
1781 to free the entry on the next call to C<hv_iternext>, so you must not discard
1782 your iterator immediately else the entry will leak - call C<hv_iternext> to
1783 trigger the resource deallocation.
1785 HE* hv_iternext(HV *hv)
1793 Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
1796 SV* hv_iternextsv(HV *hv, char **key, I32 *retlen)
1801 =item hv_iternext_flags
1802 X<hv_iternext_flags>
1804 Returns entries from a hash iterator. See C<hv_iterinit> and C<hv_iternext>.
1805 The C<flags> value will normally be zero; if HV_ITERNEXT_WANTPLACEHOLDERS is
1806 set the placeholders keys (for restricted hashes) will be returned in addition
1807 to normal keys. By default placeholders are automatically skipped over.
1808 Currently a placeholder is implemented with a value that is
1809 C<&Perl_sv_placeholder>. Note that the implementation of placeholders and
1810 restricted hashes may change, and the implementation currently is
1811 insufficiently abstracted for any change to be tidy.
1813 NOTE: this function is experimental and may change or be
1814 removed without notice.
1816 HE* hv_iternext_flags(HV *hv, I32 flags)
1824 Returns the value from the current position of the hash iterator. See
1827 SV* hv_iterval(HV *hv, HE *entry)
1835 Adds magic to a hash. See C<sv_magic>.
1837 void hv_magic(HV *hv, GV *gv, int how)
1845 Evaluates the hash in scalar context and returns the result. Handles magic when the hash is tied.
1847 SV* hv_scalar(HV *hv)
1855 Stores an SV in a hash. The hash key is specified as C<key> and C<klen> is
1856 the length of the key. The C<hash> parameter is the precomputed hash
1857 value; if it is zero then Perl will compute it. The return value will be
1858 NULL if the operation failed or if the value did not need to be actually
1859 stored within the hash (as in the case of tied hashes). Otherwise it can
1860 be dereferenced to get the original C<SV*>. Note that the caller is
1861 responsible for suitably incrementing the reference count of C<val> before
1862 the call, and decrementing it if the function returned NULL. Effectively
1863 a successful hv_store takes ownership of one reference to C<val>. This is
1864 usually what you want; a newly created SV has a reference count of one, so
1865 if all your code does is create SVs then store them in a hash, hv_store
1866 will own the only reference to the new SV, and your code doesn't need to do
1867 anything further to tidy up. hv_store is not implemented as a call to
1868 hv_store_ent, and does not create a temporary SV for the key, so if your
1869 key data is not already in SV form then use hv_store in preference to
1872 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1873 information on how to use this function on tied hashes.
1875 SV** hv_store(HV *hv, const char *key, I32 klen, SV *val, U32 hash)
1883 Like C<hv_store>, but takes a literal string instead of a string/length pair
1884 and omits the hash parameter.
1886 SV** hv_stores(HV* tb, const char* key, NULLOK SV* val)
1889 Found in file handy.h
1894 Stores C<val> in a hash. The hash key is specified as C<key>. The C<hash>
1895 parameter is the precomputed hash value; if it is zero then Perl will
1896 compute it. The return value is the new hash entry so created. It will be
1897 NULL if the operation failed or if the value did not need to be actually
1898 stored within the hash (as in the case of tied hashes). Otherwise the
1899 contents of the return value can be accessed using the C<He?> macros
1900 described here. Note that the caller is responsible for suitably
1901 incrementing the reference count of C<val> before the call, and
1902 decrementing it if the function returned NULL. Effectively a successful
1903 hv_store_ent takes ownership of one reference to C<val>. This is
1904 usually what you want; a newly created SV has a reference count of one, so
1905 if all your code does is create SVs then store them in a hash, hv_store
1906 will own the only reference to the new SV, and your code doesn't need to do
1907 anything further to tidy up. Note that hv_store_ent only reads the C<key>;
1908 unlike C<val> it does not take ownership of it, so maintaining the correct
1909 reference count on C<key> is entirely the caller's responsibility. hv_store
1910 is not implemented as a call to hv_store_ent, and does not create a temporary
1911 SV for the key, so if your key data is not already in SV form then use
1912 hv_store in preference to hv_store_ent.
1914 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1915 information on how to use this function on tied hashes.
1917 HE* hv_store_ent(HV *hv, SV *key, SV *val, U32 hash)
1927 void hv_undef(HV *hv)
1935 Creates a new HV. The reference count is set to 1.
1945 =head1 Magical Functions
1952 Clear something magical that the SV represents. See C<sv_magic>.
1954 int mg_clear(SV* sv)
1962 Copies the magic from one SV to another. See C<sv_magic>.
1964 int mg_copy(SV *sv, SV *nsv, const char *key, I32 klen)
1972 Finds the magic pointer for type matching the SV. See C<sv_magic>.
1974 MAGIC* mg_find(const SV* sv, int type)
1982 Free any magic storage used by the SV. See C<sv_magic>.
1992 Do magic after a value is retrieved from the SV. See C<sv_magic>.
2002 Report on the SV's length. See C<sv_magic>.
2004 U32 mg_length(SV* sv)
2012 Turns on the magical status of an SV. See C<sv_magic>.
2014 void mg_magical(SV* sv)
2022 Do magic after a value is assigned to the SV. See C<sv_magic>.
2032 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
2033 argument more than once.
2035 void SvGETMAGIC(SV* sv)
2043 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
2054 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
2055 argument more than once.
2057 void SvSETMAGIC(SV* sv)
2065 Like C<SvSetSV>, but does any set magic required afterwards.
2067 void SvSetMagicSV(SV* dsb, SV* ssv)
2072 =item SvSetMagicSV_nosteal
2073 X<SvSetMagicSV_nosteal>
2075 Like C<SvSetSV_nosteal>, but does any set magic required afterwards.
2077 void SvSetMagicSV_nosteal(SV* dsv, SV* ssv)
2085 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
2088 void SvSetSV(SV* dsb, SV* ssv)
2093 =item SvSetSV_nosteal
2096 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
2097 ssv. May evaluate arguments more than once.
2099 void SvSetSV_nosteal(SV* dsv, SV* ssv)
2107 Arranges for sv to be shared between threads if a suitable module
2110 void SvSHARE(SV* sv)
2118 Releases a mutual exclusion lock on sv if a suitable module
2121 void SvUNLOCK(SV* sv)
2129 =head1 Memory Management
2136 The XSUB-writer's interface to the C C<memcpy> function. The C<src> is the
2137 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
2138 the type. May fail on overlapping copies. See also C<Move>.
2140 void Copy(void* src, void* dest, int nitems, type)
2143 Found in file handy.h
2148 Like C<Copy> but returns dest. Useful for encouraging compilers to tail-call
2151 void * CopyD(void* src, void* dest, int nitems, type)
2154 Found in file handy.h
2159 The XSUB-writer's interface to the C C<memmove> function. The C<src> is the
2160 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
2161 the type. Can do overlapping moves. See also C<Copy>.
2163 void Move(void* src, void* dest, int nitems, type)
2166 Found in file handy.h
2171 Like C<Move> but returns dest. Useful for encouraging compilers to tail-call
2174 void * MoveD(void* src, void* dest, int nitems, type)
2177 Found in file handy.h
2182 The XSUB-writer's interface to the C C<malloc> function.
2184 In 5.9.3, Newx() and friends replace the older New() API, and drops
2185 the first parameter, I<x>, a debug aid which allowed callers to identify
2186 themselves. This aid has been superseded by a new build option,
2187 PERL_MEM_LOG (see L<perlhack/PERL_MEM_LOG>). The older API is still
2188 there for use in XS modules supporting older perls.
2190 void Newx(void* ptr, int nitems, type)
2193 Found in file handy.h
2198 The XSUB-writer's interface to the C C<malloc> function, with
2199 cast. See also C<Newx>.
2201 void Newxc(void* ptr, int nitems, type, cast)
2204 Found in file handy.h
2209 The XSUB-writer's interface to the C C<malloc> function. The allocated
2210 memory is zeroed with C<memzero>. See also C<Newx>.
2212 void Newxz(void* ptr, int nitems, type)
2215 Found in file handy.h
2220 PoisonWith(0xEF) for catching access to freed memory.
2222 void Poison(void* dest, int nitems, type)
2225 Found in file handy.h
2230 PoisonWith(0xEF) for catching access to freed memory.
2232 void PoisonFree(void* dest, int nitems, type)
2235 Found in file handy.h
2240 PoisonWith(0xAB) for catching access to allocated but uninitialized memory.
2242 void PoisonNew(void* dest, int nitems, type)
2245 Found in file handy.h
2250 Fill up memory with a byte pattern (a byte repeated over and over
2251 again) that hopefully catches attempts to access uninitialized memory.
2253 void PoisonWith(void* dest, int nitems, type, U8 byte)
2256 Found in file handy.h
2261 The XSUB-writer's interface to the C C<realloc> function.
2263 void Renew(void* ptr, int nitems, type)
2266 Found in file handy.h
2271 The XSUB-writer's interface to the C C<realloc> function, with
2274 void Renewc(void* ptr, int nitems, type, cast)
2277 Found in file handy.h
2282 The XSUB-writer's interface to the C C<free> function.
2284 void Safefree(void* ptr)
2287 Found in file handy.h
2292 Perl's version of C<strdup()>. Returns a pointer to a newly allocated
2293 string which is a duplicate of C<pv>. The size of the string is
2294 determined by C<strlen()>. The memory allocated for the new string can
2295 be freed with the C<Safefree()> function.
2297 char* savepv(const char* pv)
2300 Found in file util.c
2305 Perl's version of what C<strndup()> would be if it existed. Returns a
2306 pointer to a newly allocated string which is a duplicate of the first
2307 C<len> bytes from C<pv>, plus a trailing NUL byte. The memory allocated for
2308 the new string can be freed with the C<Safefree()> function.
2310 char* savepvn(const char* pv, I32 len)
2313 Found in file util.c
2318 Like C<savepvn>, but takes a literal string instead of a string/length pair.
2320 char* savepvs(const char* s)
2323 Found in file handy.h
2328 A version of C<savepv()> which allocates the duplicate string in memory
2329 which is shared between threads.
2331 char* savesharedpv(const char* pv)
2334 Found in file util.c
2339 A version of C<savepvn()> which allocates the duplicate string in memory
2340 which is shared between threads. (With the specific difference that a NULL
2341 pointer is not acceptable)
2343 char* savesharedpvn(const char *const pv, const STRLEN len)
2346 Found in file util.c
2351 A version of C<savepv()>/C<savepvn()> which gets the string to duplicate from
2352 the passed in SV using C<SvPV()>
2354 char* savesvpv(SV* sv)
2357 Found in file util.c
2362 This is an architecture-independent macro to copy one structure to another.
2364 void StructCopy(type src, type dest, type)
2367 Found in file handy.h
2372 The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the
2373 destination, C<nitems> is the number of items, and C<type> is the type.
2375 void Zero(void* dest, int nitems, type)
2378 Found in file handy.h
2383 Like C<Zero> but returns dest. Useful for encouraging compilers to tail-call
2386 void * ZeroD(void* dest, int nitems, type)
2389 Found in file handy.h
2394 =head1 Miscellaneous Functions
2401 Analyses the string in order to make fast searches on it using fbm_instr()
2402 -- the Boyer-Moore algorithm.
2404 void fbm_compile(SV* sv, U32 flags)
2407 Found in file util.c
2412 Returns the location of the SV in the string delimited by C<str> and
2413 C<strend>. It returns C<NULL> if the string can't be found. The C<sv>
2414 does not have to be fbm_compiled, but the search will not be as fast
2417 char* fbm_instr(unsigned char* big, unsigned char* bigend, SV* littlestr, U32 flags)
2420 Found in file util.c
2425 Takes a sprintf-style format pattern and conventional
2426 (non-SV) arguments and returns the formatted string.
2428 (char *) Perl_form(pTHX_ const char* pat, ...)
2430 can be used any place a string (char *) is required:
2432 char * s = Perl_form("%d.%d",major,minor);
2434 Uses a single private buffer so if you want to format several strings you
2435 must explicitly copy the earlier strings away (and free the copies when you
2438 char* form(const char* pat, ...)
2441 Found in file util.c
2446 Fill the sv with current working directory
2448 int getcwd_sv(SV* sv)
2451 Found in file util.c
2456 The C library C<snprintf> functionality, if available and
2457 standards-compliant (uses C<vsnprintf>, actually). However, if the
2458 C<vsnprintf> is not available, will unfortunately use the unsafe
2459 C<vsprintf> which can overrun the buffer (there is an overrun check,
2460 but that may be too late). Consider using C<sv_vcatpvf> instead, or
2461 getting C<vsnprintf>.
2463 int my_snprintf(char *buffer, const Size_t len, const char *format, ...)
2466 Found in file util.c
2471 The C library C<sprintf>, wrapped if necessary, to ensure that it will return
2472 the length of the string written to the buffer. Only rare pre-ANSI systems
2473 need the wrapper function - usually this is a direct call to C<sprintf>.
2475 int my_sprintf(char *buffer, const char *pat, ...)
2478 Found in file util.c
2483 The C library C<vsnprintf> if available and standards-compliant.
2484 However, if if the C<vsnprintf> is not available, will unfortunately
2485 use the unsafe C<vsprintf> which can overrun the buffer (there is an
2486 overrun check, but that may be too late). Consider using
2487 C<sv_vcatpvf> instead, or getting C<vsnprintf>.
2489 int my_vsnprintf(char *buffer, const Size_t len, const char *format, va_list ap)
2492 Found in file util.c
2497 Returns a new version object based on the passed in SV:
2499 SV *sv = new_version(SV *ver);
2501 Does not alter the passed in ver SV. See "upg_version" if you
2502 want to upgrade the SV.
2504 SV* new_version(SV *ver)
2507 Found in file util.c
2512 Returns a pointer to the next character after the parsed
2513 version string, as well as upgrading the passed in SV to
2516 Function must be called with an already existing SV like
2519 s = scan_version(s, SV *sv, bool qv);
2521 Performs some preprocessing to the string to ensure that
2522 it has the correct characteristics of a version. Flags the
2523 object if it contains an underscore (which denotes this
2524 is an alpha version). The boolean qv denotes that the version
2525 should be interpreted as if it had multiple decimals, even if
2528 const char* scan_version(const char *s, SV *rv, bool qv)
2531 Found in file util.c
2536 Test two strings to see if they are equal. Returns true or false.
2538 bool strEQ(char* s1, char* s2)
2541 Found in file handy.h
2546 Test two strings to see if the first, C<s1>, is greater than or equal to
2547 the second, C<s2>. Returns true or false.
2549 bool strGE(char* s1, char* s2)
2552 Found in file handy.h
2557 Test two strings to see if the first, C<s1>, is greater than the second,
2558 C<s2>. Returns true or false.
2560 bool strGT(char* s1, char* s2)
2563 Found in file handy.h
2568 Test two strings to see if the first, C<s1>, is less than or equal to the
2569 second, C<s2>. Returns true or false.
2571 bool strLE(char* s1, char* s2)
2574 Found in file handy.h
2579 Test two strings to see if the first, C<s1>, is less than the second,
2580 C<s2>. Returns true or false.
2582 bool strLT(char* s1, char* s2)
2585 Found in file handy.h
2590 Test two strings to see if they are different. Returns true or
2593 bool strNE(char* s1, char* s2)
2596 Found in file handy.h
2601 Test two strings to see if they are equal. The C<len> parameter indicates
2602 the number of bytes to compare. Returns true or false. (A wrapper for
2605 bool strnEQ(char* s1, char* s2, STRLEN len)
2608 Found in file handy.h
2613 Test two strings to see if they are different. The C<len> parameter
2614 indicates the number of bytes to compare. Returns true or false. (A
2615 wrapper for C<strncmp>).
2617 bool strnNE(char* s1, char* s2, STRLEN len)
2620 Found in file handy.h
2622 =item sv_destroyable
2625 Dummy routine which reports that object can be destroyed when there is no
2626 sharing module present. It ignores its single SV argument, and returns
2627 'true'. Exists to avoid test for a NULL function pointer and because it
2628 could potentially warn under some level of strict-ness.
2630 bool sv_destroyable(SV *sv)
2633 Found in file util.c
2638 Dummy routine which "shares" an SV when there is no sharing module present.
2639 Or "locks" it. Or "unlocks" it. In other words, ignores its single SV argument.
2640 Exists to avoid test for a NULL function pointer and because it could
2641 potentially warn under some level of strict-ness.
2643 void sv_nosharing(SV *sv)
2646 Found in file util.c
2651 In-place upgrade of the supplied SV to a version object.
2653 SV *sv = upg_version(SV *sv, bool qv);
2655 Returns a pointer to the upgraded SV. Set the boolean qv if you want
2656 to force this SV to be interpreted as an "extended" version.
2658 SV* upg_version(SV *ver, bool qv)
2661 Found in file util.c
2666 Version object aware cmp. Both operands must already have been
2667 converted into version objects.
2669 int vcmp(SV *lhv, SV *rhv)
2672 Found in file util.c
2677 Accepts a version object and returns the normalized string
2678 representation. Call like:
2682 NOTE: you can pass either the object directly or the SV
2683 contained within the RV.
2688 Found in file util.c
2693 Accepts a version object and returns the normalized floating
2694 point representation. Call like:
2698 NOTE: you can pass either the object directly or the SV
2699 contained within the RV.
2704 Found in file util.c
2709 In order to maintain maximum compatibility with earlier versions
2710 of Perl, this function will return either the floating point
2711 notation or the multiple dotted notation, depending on whether
2712 the original version contained 1 or more dots, respectively
2714 SV* vstringify(SV *vs)
2717 Found in file util.c
2722 Validates that the SV contains a valid version object.
2724 bool vverify(SV *vobj);
2726 Note that it only confirms the bare minimum structure (so as not to get
2727 confused by derived classes which may contain additional hash entries):
2729 bool vverify(SV *vs)
2732 Found in file util.c
2737 =head1 MRO Functions
2741 =item mro_get_linear_isa
2742 X<mro_get_linear_isa>
2744 Returns either C<mro_get_linear_isa_c3> or
2745 C<mro_get_linear_isa_dfs> for the given stash,
2746 dependant upon which MRO is in effect
2747 for that stash. The return value is a
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(HV* stash)
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 Does not use C<TARG>. See also C<PUSHi>, C<mXPUSHi> and C<XPUSHi>.
3326 Push a double onto the stack. The stack must have room for this element.
3327 Does not use C<TARG>. See also C<PUSHn>, C<mXPUSHn> and C<XPUSHn>.
3337 Push a string onto the stack. The stack must have room for this element.
3338 The C<len> indicates the length of the string. Does not use C<TARG>.
3339 See also C<PUSHp>, C<mXPUSHp> and C<XPUSHp>.
3341 void mPUSHp(char* str, STRLEN len)
3349 Push an SV onto the stack and mortalizes the SV. The stack must have room
3350 for this element. Does not use C<TARG>. See also C<PUSHs> and C<mXPUSHs>.
3360 Push an unsigned integer onto the stack. The stack must have room for this
3361 element. Does not use C<TARG>. See also C<PUSHu>, C<mXPUSHu> and C<XPUSHu>.
3371 Push an integer onto the stack, extending the stack if necessary.
3372 Does not use C<TARG>. See also C<XPUSHi>, C<mPUSHi> and C<PUSHi>.
3382 Push a double onto the stack, extending the stack if necessary.
3383 Does not use C<TARG>. See also C<XPUSHn>, C<mPUSHn> and C<PUSHn>.
3393 Push a string onto the stack, extending the stack if necessary. The C<len>
3394 indicates the length of the string. Does not use C<TARG>. See also C<XPUSHp>,
3395 C<mPUSHp> and C<PUSHp>.
3397 void mXPUSHp(char* str, STRLEN len)
3405 Push an SV onto the stack, extending the stack if necessary and mortalizes
3406 the SV. Does not use C<TARG>. See also C<XPUSHs> and C<mPUSHs>.
3408 void mXPUSHs(SV* sv)
3416 Push an unsigned integer onto the stack, extending the stack if necessary.
3417 Does not use C<TARG>. See also C<XPUSHu>, C<mPUSHu> and C<PUSHu>.
3427 The original stack mark for the XSUB. See C<dORIGMARK>.
3435 Pops an integer off the stack.
3445 Pops a long off the stack.
3455 Pops a double off the stack.
3465 Pops a string off the stack. Deprecated. New code should use POPpx.
3475 Pops a string off the stack which must consist of bytes i.e. characters < 256.
3485 Pops a string off the stack.
3495 Pops an SV off the stack.
3505 Push an integer onto the stack. The stack must have room for this element.
3506 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3507 called to declare it. Do not call multiple C<TARG>-oriented macros to
3508 return lists from XSUB's - see C<mPUSHi> instead. See also C<XPUSHi> and
3519 Opening bracket for arguments on a callback. See C<PUTBACK> and
3530 Push a new mortal SV onto the stack. The stack must have room for this
3531 element. Does not use C<TARG>. See also C<PUSHs>, C<XPUSHmortal> and C<XPUSHs>.
3541 Push a double onto the stack. The stack must have room for this element.
3542 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3543 called to declare it. Do not call multiple C<TARG>-oriented macros to
3544 return lists from XSUB's - see C<mPUSHn> instead. See also C<XPUSHn> and
3555 Push a string onto the stack. The stack must have room for this element.
3556 The C<len> indicates the length of the string. Handles 'set' magic. Uses
3557 C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to declare it. Do not
3558 call multiple C<TARG>-oriented macros to return lists from XSUB's - see
3559 C<mPUSHp> instead. See also C<XPUSHp> and C<mXPUSHp>.
3561 void PUSHp(char* str, STRLEN len)
3569 Push an SV onto the stack. The stack must have room for this element.
3570 Does not handle 'set' magic. Does not use C<TARG>. See also C<PUSHmortal>,
3571 C<XPUSHs> and C<XPUSHmortal>.
3581 Push an unsigned integer onto the stack. The stack must have room for this
3582 element. Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG>
3583 should be called to declare it. Do not call multiple C<TARG>-oriented
3584 macros to return lists from XSUB's - see C<mPUSHu> instead. See also
3585 C<XPUSHu> and C<mXPUSHu>.
3595 Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
3596 See C<PUSHMARK> and L<perlcall> for other uses.
3606 Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and
3615 Refetch the stack pointer. Used after a callback. See L<perlcall>.
3625 Push an integer onto the stack, extending the stack if necessary. Handles
3626 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
3627 declare it. Do not call multiple C<TARG>-oriented macros to return lists
3628 from XSUB's - see C<mXPUSHi> instead. See also C<PUSHi> and C<mPUSHi>.
3638 Push a new mortal SV onto the stack, extending the stack if necessary.
3639 Does not use C<TARG>. See also C<XPUSHs>, C<PUSHmortal> and C<PUSHs>.
3649 Push a double onto the stack, extending the stack if necessary. Handles
3650 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
3651 declare it. Do not call multiple C<TARG>-oriented macros to return lists
3652 from XSUB's - see C<mXPUSHn> instead. See also C<PUSHn> and C<mPUSHn>.
3662 Push a string onto the stack, extending the stack if necessary. The C<len>
3663 indicates the length of the string. Handles 'set' magic. Uses C<TARG>, so
3664 C<dTARGET> or C<dXSTARG> should be called to declare it. Do not call
3665 multiple C<TARG>-oriented macros to return lists from XSUB's - see
3666 C<mXPUSHp> instead. See also C<PUSHp> and C<mPUSHp>.
3668 void XPUSHp(char* str, STRLEN len)
3676 Push an SV onto the stack, extending the stack if necessary. Does not
3677 handle 'set' magic. Does not use C<TARG>. See also C<XPUSHmortal>,
3678 C<PUSHs> and C<PUSHmortal>.
3688 Push an unsigned integer onto the stack, extending the stack if necessary.
3689 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3690 called to declare it. Do not call multiple C<TARG>-oriented macros to
3691 return lists from XSUB's - see C<mXPUSHu> instead. See also C<PUSHu> and
3702 Return from XSUB, indicating number of items on the stack. This is usually
3703 handled by C<xsubpp>.
3705 void XSRETURN(int nitems)
3708 Found in file XSUB.h
3710 =item XSRETURN_EMPTY
3713 Return an empty list from an XSUB immediately.
3718 Found in file XSUB.h
3723 Return an integer from an XSUB immediately. Uses C<XST_mIV>.
3725 void XSRETURN_IV(IV iv)
3728 Found in file XSUB.h
3733 Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
3738 Found in file XSUB.h
3743 Return a double from an XSUB immediately. Uses C<XST_mNV>.
3745 void XSRETURN_NV(NV nv)
3748 Found in file XSUB.h
3753 Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
3755 void XSRETURN_PV(char* str)
3758 Found in file XSUB.h
3760 =item XSRETURN_UNDEF
3763 Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
3768 Found in file XSUB.h
3773 Return an integer from an XSUB immediately. Uses C<XST_mUV>.
3775 void XSRETURN_UV(IV uv)
3778 Found in file XSUB.h
3783 Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
3788 Found in file XSUB.h
3793 Place an integer into the specified position C<pos> on the stack. The
3794 value is stored in a new mortal SV.
3796 void XST_mIV(int pos, IV iv)
3799 Found in file XSUB.h
3804 Place C<&PL_sv_no> into the specified position C<pos> on the
3807 void XST_mNO(int pos)
3810 Found in file XSUB.h
3815 Place a double into the specified position C<pos> on the stack. The value
3816 is stored in a new mortal SV.
3818 void XST_mNV(int pos, NV nv)
3821 Found in file XSUB.h
3826 Place a copy of a string into the specified position C<pos> on the stack.
3827 The value is stored in a new mortal SV.
3829 void XST_mPV(int pos, char* str)
3832 Found in file XSUB.h
3837 Place C<&PL_sv_undef> into the specified position C<pos> on the
3840 void XST_mUNDEF(int pos)
3843 Found in file XSUB.h
3848 Place C<&PL_sv_yes> into the specified position C<pos> on the
3851 void XST_mYES(int pos)
3854 Found in file XSUB.h
3866 An enum of flags for Perl types. These are found in the file B<sv.h>
3867 in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
3875 Integer type flag for scalars. See C<svtype>.
3883 Double type flag for scalars. See C<svtype>.
3891 Pointer type flag for scalars. See C<svtype>.
3899 Type flag for arrays. See C<svtype>.
3907 Type flag for code refs. See C<svtype>.
3915 Type flag for hashes. See C<svtype>.
3923 Type flag for blessed scalars. See C<svtype>.
3931 =head1 SV Manipulation Functions
3935 =item croak_xs_usage
3938 A specialised variant of C<croak()> for emitting the usage message for xsubs
3940 croak_xs_usage(cv, "eee_yow");
3942 works out the package name and subroutine name from C<cv>, and then calls
3943 C<croak()>. Hence if C<cv> is C<&ouch::awk>, it would call C<croak> as:
3945 Perl_croak(aTHX_ "Usage %s::%s(%s)", "ouch" "awk", "eee_yow");
3947 void croak_xs_usage(const CV *const cv, const char *const params)
3950 Found in file universal.c
3955 Returns the SV of the specified Perl scalar. If C<create> is set and the
3956 Perl variable does not exist then it will be created. If C<create> is not
3957 set and the variable does not exist then NULL is returned.
3959 NOTE: the perl_ form of this function is deprecated.
3961 SV* get_sv(const char* name, I32 create)
3964 Found in file perl.c
3969 Creates an RV wrapper for an SV. The reference count for the original SV is
3972 SV* newRV_inc(SV* sv)
3980 Creates a new SV and copies a string into it. If utf8 is true, calls
3981 C<SvUTF8_on> on the new SV. Implemented as a wrapper around C<newSVpvn_flags>.
3983 SV* newSVpvn_utf8(NULLOK const char* s, STRLEN len, U32 utf8)
3991 Returns the length of the string which is in the SV. See C<SvLEN>.
3993 STRLEN SvCUR(SV* sv)
4001 Set the current length of the string which is in the SV. See C<SvCUR>
4004 void SvCUR_set(SV* sv, STRLEN len)
4012 Returns a pointer to the last character in the string which is in the SV.
4013 See C<SvCUR>. Access the character as *(SvEND(sv)).
4023 Returns true if the SV has get magic or overloading. If either is true then
4024 the scalar is active data, and has the potential to return a new value every
4025 time it is accessed. Hence you must be careful to only read it once per user
4026 logical operation and work with that returned value. If neither is true then
4027 the scalar's value cannot change unless written to.
4029 char* SvGAMAGIC(SV* sv)
4037 Expands the character buffer in the SV so that it has room for the
4038 indicated number of bytes (remember to reserve space for an extra trailing
4039 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
4040 Returns a pointer to the character buffer.
4042 char * SvGROW(SV* sv, STRLEN len)
4050 Returns a U32 value indicating whether the SV contains an integer.
4060 Returns a U32 value indicating whether the SV contains an integer. Checks
4061 the B<private> setting. Use C<SvIOK>.
4071 Returns a boolean indicating whether the SV contains a signed integer.
4073 bool SvIOK_notUV(SV* sv)
4081 Unsets the IV status of an SV.
4083 void SvIOK_off(SV* sv)
4091 Tells an SV that it is an integer.
4093 void SvIOK_on(SV* sv)
4101 Tells an SV that it is an integer and disables all other OK bits.
4103 void SvIOK_only(SV* sv)
4111 Tells and SV that it is an unsigned integer and disables all other OK bits.
4113 void SvIOK_only_UV(SV* sv)
4121 Returns a boolean indicating whether the SV contains an unsigned integer.
4123 bool SvIOK_UV(SV* sv)
4131 Returns a boolean indicating whether the SV is Copy-On-Write. (either shared
4132 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
4135 bool SvIsCOW(SV* sv)
4140 =item SvIsCOW_shared_hash
4141 X<SvIsCOW_shared_hash>
4143 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
4146 bool SvIsCOW_shared_hash(SV* sv)
4154 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
4155 version which guarantees to evaluate sv only once.
4165 Returns the raw value in the SV's IV slot, without checks or conversions.
4166 Only use when you are sure SvIOK is true. See also C<SvIV()>.
4176 Coerces the given SV to an integer and returns it. Guarantees to evaluate
4177 C<sv> only once. Only use this if C<sv> is an expression with side effects,
4178 otherwise use the more efficient C<SvIV>.
4188 Like C<SvIV> but doesn't process magic.
4190 IV SvIV_nomg(SV* sv)
4198 Set the value of the IV pointer in sv to val. It is possible to perform
4199 the same function of this macro with an lvalue assignment to C<SvIVX>.
4200 With future Perls, however, it will be more efficient to use
4201 C<SvIV_set> instead of the lvalue assignment to C<SvIVX>.
4203 void SvIV_set(SV* sv, IV val)
4211 Returns the size of the string buffer in the SV, not including any part
4212 attributable to C<SvOOK>. See C<SvCUR>.
4214 STRLEN SvLEN(SV* sv)
4222 Set the actual length of the string which is in the SV. See C<SvIV_set>.
4224 void SvLEN_set(SV* sv, STRLEN len)
4232 Set the value of the MAGIC pointer in sv to val. See C<SvIV_set>.
4234 void SvMAGIC_set(SV* sv, MAGIC* val)
4242 Returns a U32 value indicating whether the SV contains a number, integer or
4253 Returns a U32 value indicating whether the SV contains a number, integer or
4254 double. Checks the B<private> setting. Use C<SvNIOK>.
4264 Unsets the NV/IV status of an SV.
4266 void SvNIOK_off(SV* sv)
4274 Returns a U32 value indicating whether the SV contains a double.
4284 Returns a U32 value indicating whether the SV contains a double. Checks the
4285 B<private> setting. Use C<SvNOK>.
4295 Unsets the NV status of an SV.
4297 void SvNOK_off(SV* sv)
4305 Tells an SV that it is a double.
4307 void SvNOK_on(SV* sv)
4315 Tells an SV that it is a double and disables all other OK bits.
4317 void SvNOK_only(SV* sv)
4325 Coerce the given SV to a double and return it. See C<SvNVx> for a version
4326 which guarantees to evaluate sv only once.
4336 Returns the raw value in the SV's NV slot, without checks or conversions.
4337 Only use when you are sure SvNOK is true. See also C<SvNV()>.
4347 Coerces the given SV to a double and returns it. Guarantees to evaluate
4348 C<sv> only once. Only use this if C<sv> is an expression with side effects,
4349 otherwise use the more efficient C<SvNV>.
4359 Set the value of the NV pointer in sv to val. See C<SvIV_set>.
4361 void SvNV_set(SV* sv, NV val)
4369 Returns a U32 value indicating whether the value is an SV. It also tells
4370 whether the value is defined or not.
4380 Returns a U32 indicating whether the pointer to the string buffer is offset.
4381 This hack is used internally to speed up removal of characters from the
4382 beginning of a SvPV. When SvOOK is true, then the start of the
4383 allocated string buffer is actually C<SvOOK_offset()> bytes before SvPVX.
4384 This offset used to be stored in SvIVX, but is now stored within the spare
4395 Reads into I<len> the offset from SvPVX back to the true start of the
4396 allocated buffer, which will be non-zero if C<sv_chop> has been used to
4397 efficiently remove characters from start of the buffer. Implemented as a
4398 macro, which takes the address of I<len>, which must be of type C<STRLEN>.
4399 Evaluates I<sv> more than once. Sets I<len> to 0 if C<SvOOK(sv)> is false.
4401 void SvOOK_offset(NN SV*sv, STRLEN len)
4409 Returns a U32 value indicating whether the SV contains a character
4420 Returns a U32 value indicating whether the SV contains a character string.
4421 Checks the B<private> setting. Use C<SvPOK>.
4431 Unsets the PV status of an SV.
4433 void SvPOK_off(SV* sv)
4441 Tells an SV that it is a string.
4443 void SvPOK_on(SV* sv)
4451 Tells an SV that it is a string and disables all other OK bits.
4452 Will also turn off the UTF-8 status.
4454 void SvPOK_only(SV* sv)
4459 =item SvPOK_only_UTF8
4462 Tells an SV that it is a string and disables all other OK bits,
4463 and leaves the UTF-8 status as it was.
4465 void SvPOK_only_UTF8(SV* sv)
4473 Returns a pointer to the string in the SV, or a stringified form of
4474 the SV if the SV does not contain a string. The SV may cache the
4475 stringified version becoming C<SvPOK>. Handles 'get' magic. See also
4476 C<SvPVx> for a version which guarantees to evaluate sv only once.
4478 char* SvPV(SV* sv, STRLEN len)
4486 Like C<SvPV>, but converts sv to byte representation first if necessary.
4488 char* SvPVbyte(SV* sv, STRLEN len)
4496 Like C<SvPV>, but converts sv to byte representation first if necessary.
4497 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
4500 char* SvPVbytex(SV* sv, STRLEN len)
4505 =item SvPVbytex_force
4508 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
4509 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
4512 char* SvPVbytex_force(SV* sv, STRLEN len)
4517 =item SvPVbyte_force
4520 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
4522 char* SvPVbyte_force(SV* sv, STRLEN len)
4527 =item SvPVbyte_nolen
4530 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
4532 char* SvPVbyte_nolen(SV* sv)
4540 Like C<SvPV>, but converts sv to utf8 first if necessary.
4542 char* SvPVutf8(SV* sv, STRLEN len)
4550 Like C<SvPV>, but converts sv to utf8 first if necessary.
4551 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
4554 char* SvPVutf8x(SV* sv, STRLEN len)
4559 =item SvPVutf8x_force
4562 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
4563 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
4566 char* SvPVutf8x_force(SV* sv, STRLEN len)
4571 =item SvPVutf8_force
4574 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
4576 char* SvPVutf8_force(SV* sv, STRLEN len)
4581 =item SvPVutf8_nolen
4584 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
4586 char* SvPVutf8_nolen(SV* sv)
4594 Returns a pointer to the physical string in the SV. The SV must contain a
4605 A version of C<SvPV> which guarantees to evaluate C<sv> only once.
4606 Only use this if C<sv> is an expression with side effects, otherwise use the
4607 more efficient C<SvPVX>.
4609 char* SvPVx(SV* sv, STRLEN len)
4617 Like C<SvPV> but will force the SV into containing just a string
4618 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
4621 char* SvPV_force(SV* sv, STRLEN len)
4626 =item SvPV_force_nomg
4629 Like C<SvPV> but will force the SV into containing just a string
4630 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
4631 directly. Doesn't process magic.
4633 char* SvPV_force_nomg(SV* sv, STRLEN len)
4641 Returns a pointer to the string in the SV, or a stringified form of
4642 the SV if the SV does not contain a string. The SV may cache the
4643 stringified form becoming C<SvPOK>. Handles 'get' magic.
4645 char* SvPV_nolen(SV* sv)
4653 Like C<SvPV> but doesn't process magic.
4655 char* SvPV_nomg(SV* sv, STRLEN len)
4663 Set the value of the PV pointer in sv to val. See C<SvIV_set>.
4665 void SvPV_set(SV* sv, char* val)
4673 Returns the value of the object's reference count.
4675 U32 SvREFCNT(SV* sv)
4683 Decrements the reference count of the given SV.
4685 void SvREFCNT_dec(SV* sv)
4693 Increments the reference count of the given SV.
4695 All of the following SvREFCNT_inc* macros are optimized versions of
4696 SvREFCNT_inc, and can be replaced with SvREFCNT_inc.
4698 SV* SvREFCNT_inc(SV* sv)
4703 =item SvREFCNT_inc_NN
4706 Same as SvREFCNT_inc, but can only be used if you know I<sv>
4707 is not NULL. Since we don't have to check the NULLness, it's faster
4710 SV* SvREFCNT_inc_NN(SV* sv)
4715 =item SvREFCNT_inc_simple
4716 X<SvREFCNT_inc_simple>
4718 Same as SvREFCNT_inc, but can only be used with expressions without side
4719 effects. Since we don't have to store a temporary value, it's faster.
4721 SV* SvREFCNT_inc_simple(SV* sv)
4726 =item SvREFCNT_inc_simple_NN
4727 X<SvREFCNT_inc_simple_NN>
4729 Same as SvREFCNT_inc_simple, but can only be used if you know I<sv>
4730 is not NULL. Since we don't have to check the NULLness, it's faster
4733 SV* SvREFCNT_inc_simple_NN(SV* sv)
4738 =item SvREFCNT_inc_simple_void
4739 X<SvREFCNT_inc_simple_void>
4741 Same as SvREFCNT_inc_simple, but can only be used if you don't need the
4742 return value. The macro doesn't need to return a meaningful value.
4744 void SvREFCNT_inc_simple_void(SV* sv)
4749 =item SvREFCNT_inc_simple_void_NN
4750 X<SvREFCNT_inc_simple_void_NN>
4752 Same as SvREFCNT_inc, but can only be used if you don't need the return
4753 value, and you know that I<sv> is not NULL. The macro doesn't need
4754 to return a meaningful value, or check for NULLness, so it's smaller
4757 void SvREFCNT_inc_simple_void_NN(SV* sv)
4762 =item SvREFCNT_inc_void
4763 X<SvREFCNT_inc_void>
4765 Same as SvREFCNT_inc, but can only be used if you don't need the
4766 return value. The macro doesn't need to return a meaningful value.
4768 void SvREFCNT_inc_void(SV* sv)
4773 =item SvREFCNT_inc_void_NN
4774 X<SvREFCNT_inc_void_NN>
4776 Same as SvREFCNT_inc, but can only be used if you don't need the return
4777 value, and you know that I<sv> is not NULL. The macro doesn't need
4778 to return a meaningful value, or check for NULLness, so it's smaller
4781 void SvREFCNT_inc_void_NN(SV* sv)
4789 Tests if the SV is an RV.
4799 Unsets the RV status of an SV.
4801 void SvROK_off(SV* sv)
4809 Tells an SV that it is an RV.
4811 void SvROK_on(SV* sv)
4819 Dereferences an RV to return the SV.
4829 Set the value of the RV pointer in sv to val. See C<SvIV_set>.
4831 void SvRV_set(SV* sv, SV* val)
4839 Returns the stash of the SV.
4849 Set the value of the STASH pointer in sv to val. See C<SvIV_set>.
4851 void SvSTASH_set(SV* sv, HV* val)
4859 Taints an SV if tainting is enabled.
4861 void SvTAINT(SV* sv)
4869 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
4872 bool SvTAINTED(SV* sv)
4880 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
4881 some of Perl's fundamental security features. XS module authors should not
4882 use this function unless they fully understand all the implications of
4883 unconditionally untainting the value. Untainting should be done in the
4884 standard perl fashion, via a carefully crafted regexp, rather than directly
4885 untainting variables.
4887 void SvTAINTED_off(SV* sv)
4895 Marks an SV as tainted if tainting is enabled.
4897 void SvTAINTED_on(SV* sv)
4905 Returns a boolean indicating whether Perl would evaluate the SV as true or
4906 false, defined or undefined. Does not handle 'get' magic.
4916 Returns the type of the SV. See C<svtype>.
4918 svtype SvTYPE(SV* sv)
4926 Returns a boolean indicating whether the SV contains an unsigned integer.
4936 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
4937 perform the upgrade if necessary. See C<svtype>.
4939 void SvUPGRADE(SV* sv, svtype type)
4947 Returns a U32 value indicating whether the SV contains UTF-8 encoded data.
4948 Call this after SvPV() in case any call to string overloading updates the
4959 Unsets the UTF-8 status of an SV.
4961 void SvUTF8_off(SV *sv)
4969 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
4970 Do not use frivolously.
4972 void SvUTF8_on(SV *sv)
4980 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
4981 for a version which guarantees to evaluate sv only once.
4991 Returns the raw value in the SV's UV slot, without checks or conversions.
4992 Only use when you are sure SvIOK is true. See also C<SvUV()>.
5002 Coerces the given SV to an unsigned integer and returns it. Guarantees to
5003 C<sv> only once. Only use this if C<sv> is an expression with side effects,
5004 otherwise use the more efficient C<SvUV>.
5014 Like C<SvUV> but doesn't process magic.
5016 UV SvUV_nomg(SV* sv)
5024 Set the value of the UV pointer in sv to val. See C<SvIV_set>.
5026 void SvUV_set(SV* sv, UV val)
5034 Returns a boolean indicating whether the SV contains a v-string.
5041 =item sv_catpvn_nomg
5044 Like C<sv_catpvn> but doesn't process magic.
5046 void sv_catpvn_nomg(SV* sv, const char* ptr, STRLEN len)
5054 Like C<sv_catsv> but doesn't process magic.
5056 void sv_catsv_nomg(SV* dsv, SV* ssv)
5061 =item sv_derived_from
5064 Returns a boolean indicating whether the SV is derived from the specified class
5065 I<at the C level>. To check derivation at the Perl level, call C<isa()> as a
5068 bool sv_derived_from(SV* sv, const char *const name)
5071 Found in file universal.c
5076 Returns a boolean indicating whether the SV performs a specific, named role.
5077 The SV can be a Perl object or the name of a Perl class.
5079 bool sv_does(SV* sv, const char *const name)
5082 Found in file universal.c
5084 =item sv_report_used
5087 Dump the contents of all SVs not yet freed. (Debugging aid).
5089 void sv_report_used()
5097 Like C<sv_setsv> but doesn't process magic.
5099 void sv_setsv_nomg(SV* dsv, SV* ssv)
5107 =head1 SV-Body Allocation
5111 =item looks_like_number
5112 X<looks_like_number>
5114 Test if the content of an SV looks like a number (or is a number).
5115 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
5116 non-numeric warning), even if your atof() doesn't grok them.
5118 I32 looks_like_number(SV *const sv)
5126 Creates an RV wrapper for an SV. The reference count for the original
5127 SV is B<not> incremented.
5129 SV* newRV_noinc(SV *const sv)
5137 Creates a new SV. A non-zero C<len> parameter indicates the number of
5138 bytes of preallocated string space the SV should have. An extra byte for a
5139 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
5140 space is allocated.) The reference count for the new SV is set to 1.
5142 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
5143 parameter, I<x>, a debug aid which allowed callers to identify themselves.
5144 This aid has been superseded by a new build option, PERL_MEM_LOG (see
5145 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
5146 modules supporting older perls.
5148 SV* newSV(const STRLEN len)
5156 Creates a new SV from the hash key structure. It will generate scalars that
5157 point to the shared string table where possible. Returns a new (undefined)
5158 SV if the hek is NULL.
5160 SV* newSVhek(const HEK *const hek)
5168 Creates a new SV and copies an integer into it. The reference count for the
5171 SV* newSViv(const IV i)
5179 Creates a new SV and copies a floating point value into it.
5180 The reference count for the SV is set to 1.
5182 SV* newSVnv(const NV n)
5190 Creates a new SV and copies a string into it. The reference count for the
5191 SV is set to 1. If C<len> is zero, Perl will compute the length using
5192 strlen(). For efficiency, consider using C<newSVpvn> instead.
5194 SV* newSVpv(const char *const s, const STRLEN len)
5202 Creates a new SV and initializes it with the string formatted like
5205 SV* newSVpvf(const char *const pat, ...)
5213 Creates a new SV and copies a string into it. The reference count for the
5214 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
5215 string. You are responsible for ensuring that the source string is at least
5216 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
5218 SV* newSVpvn(const char *const s, const STRLEN len)
5223 =item newSVpvn_flags
5226 Creates a new SV and copies a string into it. The reference count for the
5227 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
5228 string. You are responsible for ensuring that the source string is at least
5229 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
5230 Currently the only flag bits accepted are C<SVf_UTF8> and C<SVs_TEMP>.
5231 If C<SVs_TEMP> is set, then C<sv2mortal()> is called on the result before
5232 returning. If C<SVf_UTF8> is set, then it will be set on the new SV.
5233 C<newSVpvn_utf8()> is a convenience wrapper for this function, defined as
5235 #define newSVpvn_utf8(s, len, u) \
5236 newSVpvn_flags((s), (len), (u) ? SVf_UTF8 : 0)
5238 SV* newSVpvn_flags(const char *const s, const STRLEN len, const U32 flags)
5243 =item newSVpvn_share
5246 Creates a new SV with its SvPVX_const pointing to a shared string in the string
5247 table. If the string does not already exist in the table, it is created
5248 first. Turns on READONLY and FAKE. If the C<hash> parameter is non-zero, that
5249 value is used; otherwise the hash is computed. The string's hash can be later
5250 be retrieved from the SV with the C<SvSHARED_HASH()> macro. The idea here is
5251 that as the string table is used for shared hash keys these strings will have
5252 SvPVX_const == HeKEY and hash lookup will avoid string compare.
5254 SV* newSVpvn_share(const char* s, I32 len, U32 hash)
5262 Like C<newSVpvn>, but takes a literal string instead of a string/length pair.
5264 SV* newSVpvs(const char* s)
5267 Found in file handy.h
5269 =item newSVpvs_flags
5272 Like C<newSVpvn_flags>, but takes a literal string instead of a string/length
5275 SV* newSVpvs_flags(const char* s, U32 flags)
5278 Found in file handy.h
5280 =item newSVpvs_share
5283 Like C<newSVpvn_share>, but takes a literal string instead of a string/length
5284 pair and omits the hash parameter.
5286 SV* newSVpvs_share(const char* s)
5289 Found in file handy.h
5294 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
5295 it will be upgraded to one. If C<classname> is non-null then the new SV will
5296 be blessed in the specified package. The new SV is returned and its
5297 reference count is 1.
5299 SV* newSVrv(SV *const rv, const char *const classname)
5307 Creates a new SV which is an exact duplicate of the original SV.
5310 SV* newSVsv(SV *const old)
5318 Creates a new SV and copies an unsigned integer into it.
5319 The reference count for the SV is set to 1.
5321 SV* newSVuv(const UV u)
5329 Creates a new SV, of the type specified. The reference count for the new SV
5332 SV* newSV_type(const svtype type)
5340 This function is only called on magical items, and is only used by
5341 sv_true() or its macro equivalent.
5343 bool sv_2bool(SV *const sv)
5351 Using various gambits, try to get a CV from an SV; in addition, try if
5352 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
5353 The flags in C<lref> are passed to sv_fetchsv.
5355 CV* sv_2cv(SV* sv, HV **const st, GV **const gvp, const I32 lref)
5363 Using various gambits, try to get an IO from an SV: the IO slot if its a
5364 GV; or the recursive result if we're an RV; or the IO slot of the symbol
5365 named after the PV if we're a string.
5367 IO* sv_2io(SV *const sv)
5375 Return the integer value of an SV, doing any necessary string
5376 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
5377 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
5379 IV sv_2iv_flags(SV *const sv, const I32 flags)
5387 Marks an existing SV as mortal. The SV will be destroyed "soon", either
5388 by an explicit call to FREETMPS, or by an implicit call at places such as
5389 statement boundaries. SvTEMP() is turned on which means that the SV's
5390 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
5391 and C<sv_mortalcopy>.
5393 SV* sv_2mortal(SV *const sv)
5401 Return the num value of an SV, doing any necessary string or integer
5402 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
5405 NV sv_2nv(SV *const sv)
5413 Return a pointer to the byte-encoded representation of the SV, and set *lp
5414 to its length. May cause the SV to be downgraded from UTF-8 as a
5417 Usually accessed via the C<SvPVbyte> macro.
5419 char* sv_2pvbyte(SV *const sv, STRLEN *const lp)
5427 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
5428 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
5430 Usually accessed via the C<SvPVutf8> macro.
5432 char* sv_2pvutf8(SV *const sv, STRLEN *const lp)
5440 Returns a pointer to the string value of an SV, and sets *lp to its length.
5441 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
5443 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
5444 usually end up here too.
5446 char* sv_2pv_flags(SV *const sv, STRLEN *const lp, const I32 flags)
5454 Return the unsigned integer value of an SV, doing any necessary string
5455 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
5456 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
5458 UV sv_2uv_flags(SV *const sv, const I32 flags)
5466 Remove any string offset. You should normally use the C<SvOOK_off> macro
5469 int sv_backoff(SV *const sv)
5477 Blesses an SV into a specified package. The SV must be an RV. The package
5478 must be designated by its stash (see C<gv_stashpv()>). The reference count
5479 of the SV is unaffected.
5481 SV* sv_bless(SV *const sv, HV *const stash)
5489 Concatenates the string onto the end of the string which is in the SV.
5490 If the SV has the UTF-8 status set, then the bytes appended should be
5491 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
5493 void sv_catpv(SV *const sv, const char* ptr)
5501 Processes its arguments like C<sprintf> and appends the formatted
5502 output to an SV. If the appended data contains "wide" characters
5503 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
5504 and characters >255 formatted with %c), the original SV might get
5505 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
5506 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
5507 valid UTF-8; if the original SV was bytes, the pattern should be too.
5509 void sv_catpvf(SV *const sv, const char *const pat, ...)
5517 Like C<sv_catpvf>, but also handles 'set' magic.
5519 void sv_catpvf_mg(SV *const sv, const char *const pat, ...)
5527 Concatenates the string onto the end of the string which is in the SV. The
5528 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5529 status set, then the bytes appended should be valid UTF-8.
5530 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
5532 void sv_catpvn(SV *dsv, const char *sstr, STRLEN len)
5537 =item sv_catpvn_flags
5540 Concatenates the string onto the end of the string which is in the SV. The
5541 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5542 status set, then the bytes appended should be valid UTF-8.
5543 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
5544 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
5545 in terms of this function.
5547 void sv_catpvn_flags(SV *const dstr, const char *sstr, const STRLEN len, const I32 flags)
5555 Like C<sv_catpvn>, but takes a literal string instead of a string/length pair.
5557 void sv_catpvs(SV* sv, const char* s)
5560 Found in file handy.h
5565 Like C<sv_catpv>, but also handles 'set' magic.
5567 void sv_catpv_mg(SV *const sv, const char *const ptr)
5575 Concatenates the string from SV C<ssv> onto the end of the string in
5576 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
5577 not 'set' magic. See C<sv_catsv_mg>.
5579 void sv_catsv(SV *dstr, SV *sstr)
5584 =item sv_catsv_flags
5587 Concatenates the string from SV C<ssv> onto the end of the string in
5588 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
5589 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
5590 and C<sv_catsv_nomg> are implemented in terms of this function.
5592 void sv_catsv_flags(SV *const dsv, SV *const ssv, const I32 flags)
5600 Efficient removal of characters from the beginning of the string buffer.
5601 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
5602 the string buffer. The C<ptr> becomes the first character of the adjusted
5603 string. Uses the "OOK hack".
5604 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
5605 refer to the same chunk of data.
5607 void sv_chop(SV *const sv, const char *const ptr)
5615 Clear an SV: call any destructors, free up any memory used by the body,
5616 and free the body itself. The SV's head is I<not> freed, although
5617 its type is set to all 1's so that it won't inadvertently be assumed
5618 to be live during global destruction etc.
5619 This function should only be called when REFCNT is zero. Most of the time
5620 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5623 void sv_clear(SV *const sv)
5631 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5632 string in C<sv1> is less than, equal to, or greater than the string in
5633 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5634 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
5636 I32 sv_cmp(SV *const sv1, SV *const sv2)
5644 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
5645 'use bytes' aware, handles get magic, and will coerce its args to strings
5646 if necessary. See also C<sv_cmp>.
5648 I32 sv_cmp_locale(SV *const sv1, SV *const sv2)
5656 Add Collate Transform magic to an SV if it doesn't already have it.
5658 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
5659 scalar data of the variable, but transformed to such a format that a normal
5660 memory comparison can be used to compare the data according to the locale
5663 char* sv_collxfrm(SV *const sv, STRLEN *const nxp)
5671 Copies a stringified representation of the source SV into the
5672 destination SV. Automatically performs any necessary mg_get and
5673 coercion of numeric values into strings. Guaranteed to preserve
5674 UTF8 flag even from overloaded objects. Similar in nature to
5675 sv_2pv[_flags] but operates directly on an SV instead of just the
5676 string. Mostly uses sv_2pv_flags to do its work, except when that
5677 would lose the UTF-8'ness of the PV.
5679 void sv_copypv(SV *const dsv, SV *const ssv)
5687 Auto-decrement of the value in the SV, doing string to numeric conversion
5688 if necessary. Handles 'get' magic.
5690 void sv_dec(SV *const sv)
5698 Returns a boolean indicating whether the strings in the two SVs are
5699 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5700 coerce its args to strings if necessary.
5702 I32 sv_eq(SV* sv1, SV* sv2)
5707 =item sv_force_normal_flags
5708 X<sv_force_normal_flags>
5710 Undo various types of fakery on an SV: if the PV is a shared string, make
5711 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
5712 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
5713 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
5714 then a copy-on-write scalar drops its PV buffer (if any) and becomes
5715 SvPOK_off rather than making a copy. (Used where this scalar is about to be
5716 set to some other value.) In addition, the C<flags> parameter gets passed to
5717 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
5718 with flags set to 0.
5720 void sv_force_normal_flags(SV *const sv, const U32 flags)
5728 Decrement an SV's reference count, and if it drops to zero, call
5729 C<sv_clear> to invoke destructors and free up any memory used by
5730 the body; finally, deallocate the SV's head itself.
5731 Normally called via a wrapper macro C<SvREFCNT_dec>.
5733 void sv_free(SV *const sv)
5741 Get a line from the filehandle and store it into the SV, optionally
5742 appending to the currently-stored string.
5744 char* sv_gets(SV *const sv, PerlIO *const fp, I32 append)
5752 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
5753 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
5754 Use the C<SvGROW> wrapper instead.
5756 char* sv_grow(SV *const sv, STRLEN newlen)
5764 Auto-increment of the value in the SV, doing string to numeric conversion
5765 if necessary. Handles 'get' magic.
5767 void sv_inc(SV *const sv)
5775 Inserts a string at the specified offset/length within the SV. Similar to
5776 the Perl substr() function. Handles get magic.
5778 void sv_insert(SV *const bigstr, const STRLEN offset, const STRLEN len, const char *const little, const STRLEN littlelen)
5783 =item sv_insert_flags
5786 Same as C<sv_insert>, but the extra C<flags> are passed the C<SvPV_force_flags> that applies to C<bigstr>.
5788 void sv_insert_flags(SV *const bigstr, const STRLEN offset, const STRLEN len, const char *const little, const STRLEN littlelen, const U32 flags)
5796 Returns a boolean indicating whether the SV is blessed into the specified
5797 class. This does not check for subtypes; use C<sv_derived_from> to verify
5798 an inheritance relationship.
5800 int sv_isa(SV* sv, const char *const name)
5808 Returns a boolean indicating whether the SV is an RV pointing to a blessed
5809 object. If the SV is not an RV, or if the object is not blessed, then this
5812 int sv_isobject(SV* sv)
5820 Returns the length of the string in the SV. Handles magic and type
5821 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5823 STRLEN sv_len(SV *const sv)
5831 Returns the number of characters in the string in an SV, counting wide
5832 UTF-8 bytes as a single character. Handles magic and type coercion.
5834 STRLEN sv_len_utf8(SV *const sv)
5842 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
5843 then adds a new magic item of type C<how> to the head of the magic list.
5845 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
5846 handling of the C<name> and C<namlen> arguments.
5848 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
5849 to add more than one instance of the same 'how'.
5851 void sv_magic(SV *const sv, SV *const obj, const int how, const char *const name, const I32 namlen)
5859 Adds magic to an SV, upgrading it if necessary. Applies the
5860 supplied vtable and returns a pointer to the magic added.
5862 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
5863 In particular, you can add magic to SvREADONLY SVs, and add more than
5864 one instance of the same 'how'.
5866 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
5867 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
5868 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
5869 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
5871 (This is now used as a subroutine by C<sv_magic>.)
5873 MAGIC * sv_magicext(SV *const sv, SV *const obj, const int how, const MGVTBL *const vtbl, const char *const name, const I32 namlen)
5881 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
5882 The new SV is marked as mortal. It will be destroyed "soon", either by an
5883 explicit call to FREETMPS, or by an implicit call at places such as
5884 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
5886 SV* sv_mortalcopy(SV *const oldsv)
5894 Creates a new null SV which is mortal. The reference count of the SV is
5895 set to 1. It will be destroyed "soon", either by an explicit call to
5896 FREETMPS, or by an implicit call at places such as statement boundaries.
5897 See also C<sv_mortalcopy> and C<sv_2mortal>.
5907 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5910 SV* sv_newref(SV *const sv)
5918 Converts the value pointed to by offsetp from a count of bytes from the
5919 start of the string, to a count of the equivalent number of UTF-8 chars.
5920 Handles magic and type coercion.
5922 void sv_pos_b2u(SV *const sv, I32 *const offsetp)
5930 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5931 the start of the string, to a count of the equivalent number of bytes; if
5932 lenp is non-zero, it does the same to lenp, but this time starting from
5933 the offset, rather than from the start of the string. Handles magic and
5936 void sv_pos_u2b(SV *const sv, I32 *const offsetp, I32 *const lenp)
5941 =item sv_pvbyten_force
5944 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
5946 char* sv_pvbyten_force(SV *const sv, STRLEN *const lp)
5954 Get a sensible string out of the SV somehow.
5955 A private implementation of the C<SvPV_force> macro for compilers which
5956 can't cope with complex macro expressions. Always use the macro instead.
5958 char* sv_pvn_force(SV* sv, STRLEN* lp)
5963 =item sv_pvn_force_flags
5964 X<sv_pvn_force_flags>
5966 Get a sensible string out of the SV somehow.
5967 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
5968 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
5969 implemented in terms of this function.
5970 You normally want to use the various wrapper macros instead: see
5971 C<SvPV_force> and C<SvPV_force_nomg>
5973 char* sv_pvn_force_flags(SV *const sv, STRLEN *const lp, const I32 flags)
5978 =item sv_pvutf8n_force
5981 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
5983 char* sv_pvutf8n_force(SV *const sv, STRLEN *const lp)
5991 Returns a string describing what the SV is a reference to.
5993 const char* sv_reftype(const SV *const sv, const int ob)
6001 Make the first argument a copy of the second, then delete the original.
6002 The target SV physically takes over ownership of the body of the source SV
6003 and inherits its flags; however, the target keeps any magic it owns,
6004 and any magic in the source is discarded.
6005 Note that this is a rather specialist SV copying operation; most of the
6006 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
6008 void sv_replace(SV *const sv, SV *const nsv)
6016 Underlying implementation for the C<reset> Perl function.
6017 Note that the perl-level function is vaguely deprecated.
6019 void sv_reset(const char* s, HV *const stash)
6027 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
6028 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
6029 push a back-reference to this RV onto the array of backreferences
6030 associated with that magic. If the RV is magical, set magic will be
6031 called after the RV is cleared.
6033 SV* sv_rvweaken(SV *const sv)
6041 Copies an integer into the given SV, upgrading first if necessary.
6042 Does not handle 'set' magic. See also C<sv_setiv_mg>.
6044 void sv_setiv(SV *const sv, const IV num)
6052 Like C<sv_setiv>, but also handles 'set' magic.
6054 void sv_setiv_mg(SV *const sv, const IV i)
6062 Copies a double into the given SV, upgrading first if necessary.
6063 Does not handle 'set' magic. See also C<sv_setnv_mg>.
6065 void sv_setnv(SV *const sv, const NV num)
6073 Like C<sv_setnv>, but also handles 'set' magic.
6075 void sv_setnv_mg(SV *const sv, const NV num)
6083 Copies a string into an SV. The string must be null-terminated. Does not
6084 handle 'set' magic. See C<sv_setpv_mg>.
6086 void sv_setpv(SV *const sv, const char *const ptr)
6094 Works like C<sv_catpvf> but copies the text into the SV instead of
6095 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
6097 void sv_setpvf(SV *const sv, const char *const pat, ...)
6105 Like C<sv_setpvf>, but also handles 'set' magic.
6107 void sv_setpvf_mg(SV *const sv, const char *const pat, ...)
6115 Copies an integer into the given SV, also updating its string value.
6116 Does not handle 'set' magic. See C<sv_setpviv_mg>.
6118 void sv_setpviv(SV *const sv, const IV num)
6126 Like C<sv_setpviv>, but also handles 'set' magic.
6128 void sv_setpviv_mg(SV *const sv, const IV iv)
6136 Copies a string into an SV. The C<len> parameter indicates the number of
6137 bytes to be copied. If the C<ptr> argument is NULL the SV will become
6138 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
6140 void sv_setpvn(SV *const sv, const char *const ptr, const STRLEN len)
6148 Like C<sv_setpvn>, but also handles 'set' magic.
6150 void sv_setpvn_mg(SV *const sv, const char *const ptr, const STRLEN len)
6158 Like C<sv_setpvn>, but takes a literal string instead of a string/length pair.
6160 void sv_setpvs(SV* sv, const char* s)
6163 Found in file handy.h
6168 Like C<sv_setpv>, but also handles 'set' magic.
6170 void sv_setpv_mg(SV *const sv, const char *const ptr)
6178 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
6179 argument will be upgraded to an RV. That RV will be modified to point to
6180 the new SV. The C<classname> argument indicates the package for the
6181 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
6182 will have a reference count of 1, and the RV will be returned.
6184 SV* sv_setref_iv(SV *const rv, const char *const classname, const IV iv)
6192 Copies a double into a new SV, optionally blessing the SV. The C<rv>
6193 argument will be upgraded to an RV. That RV will be modified to point to
6194 the new SV. The C<classname> argument indicates the package for the
6195 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
6196 will have a reference count of 1, and the RV will be returned.
6198 SV* sv_setref_nv(SV *const rv, const char *const classname, const NV nv)
6206 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
6207 argument will be upgraded to an RV. That RV will be modified to point to
6208 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
6209 into the SV. The C<classname> argument indicates the package for the
6210 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
6211 will have a reference count of 1, and the RV will be returned.
6213 Do not use with other Perl types such as HV, AV, SV, CV, because those
6214 objects will become corrupted by the pointer copy process.
6216 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
6218 SV* sv_setref_pv(SV *const rv, const char *const classname, void *const pv)
6226 Copies a string into a new SV, optionally blessing the SV. The length of the
6227 string must be specified with C<n>. The C<rv> argument will be upgraded to
6228 an RV. That RV will be modified to point to the new SV. The C<classname>
6229 argument indicates the package for the blessing. Set C<classname> to
6230 C<NULL> to avoid the blessing. The new SV will have a reference count
6231 of 1, and the RV will be returned.
6233 Note that C<sv_setref_pv> copies the pointer while this copies the string.
6235 SV* sv_setref_pvn(SV *const rv, const char *const classname, const char *const pv, const STRLEN n)
6243 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
6244 argument will be upgraded to an RV. That RV will be modified to point to
6245 the new SV. The C<classname> argument indicates the package for the
6246 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
6247 will have a reference count of 1, and the RV will be returned.
6249 SV* sv_setref_uv(SV *const rv, const char *const classname, const UV uv)
6257 Copies the contents of the source SV C<ssv> into the destination SV
6258 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
6259 function if the source SV needs to be reused. Does not handle 'set' magic.
6260 Loosely speaking, it performs a copy-by-value, obliterating any previous
6261 content of the destination.
6263 You probably want to use one of the assortment of wrappers, such as
6264 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
6265 C<SvSetMagicSV_nosteal>.
6267 void sv_setsv(SV *dstr, SV *sstr)
6272 =item sv_setsv_flags
6275 Copies the contents of the source SV C<ssv> into the destination SV
6276 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
6277 function if the source SV needs to be reused. Does not handle 'set' magic.
6278 Loosely speaking, it performs a copy-by-value, obliterating any previous
6279 content of the destination.
6280 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
6281 C<ssv> if appropriate, else not. If the C<flags> parameter has the
6282 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
6283 and C<sv_setsv_nomg> are implemented in terms of this function.
6285 You probably want to use one of the assortment of wrappers, such as
6286 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
6287 C<SvSetMagicSV_nosteal>.
6289 This is the primary function for copying scalars, and most other
6290 copy-ish functions and macros use this underneath.
6292 void sv_setsv_flags(SV *dstr, SV *sstr, const I32 flags)
6300 Like C<sv_setsv>, but also handles 'set' magic.
6302 void sv_setsv_mg(SV *const dstr, SV *const sstr)
6310 Copies an unsigned integer into the given SV, upgrading first if necessary.
6311 Does not handle 'set' magic. See also C<sv_setuv_mg>.
6313 void sv_setuv(SV *const sv, const UV num)
6321 Like C<sv_setuv>, but also handles 'set' magic.
6323 void sv_setuv_mg(SV *const sv, const UV u)
6331 Test an SV for taintedness. Use C<SvTAINTED> instead.
6332 bool sv_tainted(SV *const sv)
6340 Returns true if the SV has a true value by Perl's rules.
6341 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
6342 instead use an in-line version.
6344 I32 sv_true(SV *const sv)
6352 Removes all magic of type C<type> from an SV.
6354 int sv_unmagic(SV *const sv, const int type)
6359 =item sv_unref_flags
6362 Unsets the RV status of the SV, and decrements the reference count of
6363 whatever was being referenced by the RV. This can almost be thought of
6364 as a reversal of C<newSVrv>. The C<cflags> argument can contain
6365 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
6366 (otherwise the decrementing is conditional on the reference count being
6367 different from one or the reference being a readonly SV).
6370 void sv_unref_flags(SV *const ref, const U32 flags)
6378 Untaint an SV. Use C<SvTAINTED_off> instead.
6379 void sv_untaint(SV *const sv)
6387 Upgrade an SV to a more complex form. Generally adds a new body type to the
6388 SV, then copies across as much information as possible from the old body.
6389 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
6391 void sv_upgrade(SV *const sv, svtype new_type)
6396 =item sv_usepvn_flags
6399 Tells an SV to use C<ptr> to find its string value. Normally the
6400 string is stored inside the SV but sv_usepvn allows the SV to use an
6401 outside string. The C<ptr> should point to memory that was allocated
6402 by C<malloc>. The string length, C<len>, must be supplied. By default
6403 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
6404 so that pointer should not be freed or used by the programmer after
6405 giving it to sv_usepvn, and neither should any pointers from "behind"
6406 that pointer (e.g. ptr + 1) be used.
6408 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
6409 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
6410 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
6411 C<len>, and already meets the requirements for storing in C<SvPVX>)
6413 void sv_usepvn_flags(SV *const sv, char* ptr, const STRLEN len, const U32 flags)
6418 =item sv_utf8_decode
6421 If the PV of the SV is an octet sequence in UTF-8
6422 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
6423 so that it looks like a character. If the PV contains only single-byte
6424 characters, the C<SvUTF8> flag stays being off.
6425 Scans PV for validity and returns false if the PV is invalid UTF-8.
6427 NOTE: this function is experimental and may change or be
6428 removed without notice.
6430 bool sv_utf8_decode(SV *const sv)
6435 =item sv_utf8_downgrade
6436 X<sv_utf8_downgrade>
6438 Attempts to convert the PV of an SV from characters to bytes.
6439 If the PV contains a character beyond byte, this conversion will fail;
6440 in this case, either returns false or, if C<fail_ok> is not
6443 This is not as a general purpose Unicode to byte encoding interface:
6444 use the Encode extension for that.
6446 NOTE: this function is experimental and may change or be
6447 removed without notice.
6449 bool sv_utf8_downgrade(SV *const sv, const bool fail_ok)
6454 =item sv_utf8_encode
6457 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
6458 flag off so that it looks like octets again.
6460 void sv_utf8_encode(SV *const sv)
6465 =item sv_utf8_upgrade
6468 Converts the PV of an SV to its UTF-8-encoded form.
6469 Forces the SV to string form if it is not already.
6470 Always sets the SvUTF8 flag to avoid future validity checks even
6471 if all the bytes have hibit clear.
6473 This is not as a general purpose byte encoding to Unicode interface:
6474 use the Encode extension for that.
6476 STRLEN sv_utf8_upgrade(SV *sv)
6481 =item sv_utf8_upgrade_flags
6482 X<sv_utf8_upgrade_flags>
6484 Converts the PV of an SV to its UTF-8-encoded form.
6485 Forces the SV to string form if it is not already.
6486 Always sets the SvUTF8 flag to avoid future validity checks even
6487 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
6488 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
6489 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
6491 This is not as a general purpose byte encoding to Unicode interface:
6492 use the Encode extension for that.
6494 STRLEN sv_utf8_upgrade_flags(SV *const sv, const I32 flags)
6502 Processes its arguments like C<vsprintf> and appends the formatted output
6503 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
6505 Usually used via its frontend C<sv_catpvf>.
6507 void sv_vcatpvf(SV *const sv, const char *const pat, va_list *const args)
6515 Processes its arguments like C<vsprintf> and appends the formatted output
6516 to an SV. Uses an array of SVs if the C style variable argument list is
6517 missing (NULL). When running with taint checks enabled, indicates via
6518 C<maybe_tainted> if results are untrustworthy (often due to the use of
6521 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
6523 void sv_vcatpvfn(SV *const sv, const char *const pat, const STRLEN patlen, va_list *const args, SV **const svargs, const I32 svmax, bool *const maybe_tainted)
6531 Like C<sv_vcatpvf>, but also handles 'set' magic.
6533 Usually used via its frontend C<sv_catpvf_mg>.
6535 void sv_vcatpvf_mg(SV *const sv, const char *const pat, va_list *const args)
6543 Works like C<sv_vcatpvf> but copies the text into the SV instead of
6544 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
6546 Usually used via its frontend C<sv_setpvf>.
6548 void sv_vsetpvf(SV *const sv, const char *const pat, va_list *const args)
6556 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
6559 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
6561 void sv_vsetpvfn(SV *const sv, const char *const pat, const STRLEN patlen, va_list *const args, SV **const svargs, const I32 svmax, bool *const maybe_tainted)
6569 Like C<sv_vsetpvf>, but also handles 'set' magic.
6571 Usually used via its frontend C<sv_setpvf_mg>.
6573 void sv_vsetpvf_mg(SV *const sv, const char *const pat, va_list *const args)
6581 =head1 Unicode Support
6585 =item bytes_from_utf8
6588 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
6589 Unlike C<utf8_to_bytes> but like C<bytes_to_utf8>, returns a pointer to
6590 the newly-created string, and updates C<len> to contain the new
6591 length. Returns the original string if no conversion occurs, C<len>
6592 is unchanged. Do nothing if C<is_utf8> points to 0. Sets C<is_utf8> to
6593 0 if C<s> is converted or contains all 7bit characters.
6595 NOTE: this function is experimental and may change or be
6596 removed without notice.
6598 U8* bytes_from_utf8(const U8 *s, STRLEN *len, bool *is_utf8)
6601 Found in file utf8.c
6606 Converts a string C<s> of length C<len> from ASCII into UTF-8 encoding.
6607 Returns a pointer to the newly-created string, and sets C<len> to
6608 reflect the new length.
6610 If you want to convert to UTF-8 from other encodings than ASCII,
6611 see sv_recode_to_utf8().
6613 NOTE: this function is experimental and may change or be
6614 removed without notice.
6616 U8* bytes_to_utf8(const U8 *s, STRLEN *len)
6619 Found in file utf8.c
6624 Return true if the strings s1 and s2 differ case-insensitively, false
6625 if not (if they are equal case-insensitively). If u1 is true, the
6626 string s1 is assumed to be in UTF-8-encoded Unicode. If u2 is true,
6627 the string s2 is assumed to be in UTF-8-encoded Unicode. If u1 or u2
6628 are false, the respective string is assumed to be in native 8-bit
6631 If the pe1 and pe2 are non-NULL, the scanning pointers will be copied
6632 in there (they will point at the beginning of the I<next> character).
6633 If the pointers behind pe1 or pe2 are non-NULL, they are the end
6634 pointers beyond which scanning will not continue under any
6635 circumstances. If the byte lengths l1 and l2 are non-zero, s1+l1 and
6636 s2+l2 will be used as goal end pointers that will also stop the scan,
6637 and which qualify towards defining a successful match: all the scans
6638 that define an explicit length must reach their goal pointers for
6639 a match to succeed).
6641 For case-insensitiveness, the "casefolding" of Unicode is used
6642 instead of upper/lowercasing both the characters, see
6643 http://www.unicode.org/unicode/reports/tr21/ (Case Mappings).
6645 I32 ibcmp_utf8(const char *s1, char **pe1, UV l1, bool u1, const char *s2, char **pe2, UV l2, bool u2)
6648 Found in file utf8.c
6653 Tests if some arbitrary number of bytes begins in a valid UTF-8
6654 character. Note that an INVARIANT (i.e. ASCII) character is a valid
6655 UTF-8 character. The actual number of bytes in the UTF-8 character
6656 will be returned if it is valid, otherwise 0.
6658 STRLEN is_utf8_char(const U8 *s)
6661 Found in file utf8.c
6663 =item is_utf8_string
6666 Returns true if first C<len> bytes of the given string form a valid
6667 UTF-8 string, false otherwise. Note that 'a valid UTF-8 string' does
6668 not mean 'a string that contains code points above 0x7F encoded in UTF-8'
6669 because a valid ASCII string is a valid UTF-8 string.
6671 See also is_utf8_string_loclen() and is_utf8_string_loc().
6673 bool is_utf8_string(const U8 *s, STRLEN len)
6676 Found in file utf8.c
6678 =item is_utf8_string_loc
6679 X<is_utf8_string_loc>
6681 Like is_utf8_string() but stores the location of the failure (in the
6682 case of "utf8ness failure") or the location s+len (in the case of
6683 "utf8ness success") in the C<ep>.
6685 See also is_utf8_string_loclen() and is_utf8_string().
6687 bool is_utf8_string_loc(const U8 *s, STRLEN len, const U8 **p)
6690 Found in file utf8.c
6692 =item is_utf8_string_loclen
6693 X<is_utf8_string_loclen>
6695 Like is_utf8_string() but stores the location of the failure (in the
6696 case of "utf8ness failure") or the location s+len (in the case of
6697 "utf8ness success") in the C<ep>, and the number of UTF-8
6698 encoded characters in the C<el>.
6700 See also is_utf8_string_loc() and is_utf8_string().
6702 bool is_utf8_string_loclen(const U8 *s, STRLEN len, const U8 **ep, STRLEN *el)
6705 Found in file utf8.c
6707 =item pv_uni_display
6710 Build to the scalar dsv a displayable version of the string spv,
6711 length len, the displayable version being at most pvlim bytes long
6712 (if longer, the rest is truncated and "..." will be appended).
6714 The flags argument can have UNI_DISPLAY_ISPRINT set to display
6715 isPRINT()able characters as themselves, UNI_DISPLAY_BACKSLASH
6716 to display the \\[nrfta\\] as the backslashed versions (like '\n')
6717 (UNI_DISPLAY_BACKSLASH is preferred over UNI_DISPLAY_ISPRINT for \\).
6718 UNI_DISPLAY_QQ (and its alias UNI_DISPLAY_REGEX) have both
6719 UNI_DISPLAY_BACKSLASH and UNI_DISPLAY_ISPRINT turned on.
6721 The pointer to the PV of the dsv is returned.
6723 char* pv_uni_display(SV *dsv, const U8 *spv, STRLEN len, STRLEN pvlim, UV flags)
6726 Found in file utf8.c
6731 The encoding is assumed to be an Encode object, the PV of the ssv is
6732 assumed to be octets in that encoding and decoding the input starts
6733 from the position which (PV + *offset) pointed to. The dsv will be
6734 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
6735 when the string tstr appears in decoding output or the input ends on
6736 the PV of the ssv. The value which the offset points will be modified
6737 to the last input position on the ssv.
6739 Returns TRUE if the terminator was found, else returns FALSE.
6741 bool sv_cat_decode(SV* dsv, SV *encoding, SV *ssv, int *offset, char* tstr, int tlen)
6746 =item sv_recode_to_utf8
6747 X<sv_recode_to_utf8>
6749 The encoding is assumed to be an Encode object, on entry the PV
6750 of the sv is assumed to be octets in that encoding, and the sv
6751 will be converted into Unicode (and UTF-8).
6753 If the sv already is UTF-8 (or if it is not POK), or if the encoding
6754 is not a reference, nothing is done to the sv. If the encoding is not
6755 an C<Encode::XS> Encoding object, bad things will happen.
6756 (See F<lib/encoding.pm> and L<Encode>).
6758 The PV of the sv is returned.
6760 char* sv_recode_to_utf8(SV* sv, SV *encoding)
6765 =item sv_uni_display
6768 Build to the scalar dsv a displayable version of the scalar sv,
6769 the displayable version being at most pvlim bytes long
6770 (if longer, the rest is truncated and "..." will be appended).
6772 The flags argument is as in pv_uni_display().
6774 The pointer to the PV of the dsv is returned.
6776 char* sv_uni_display(SV *dsv, SV *ssv, STRLEN pvlim, UV flags)
6779 Found in file utf8.c
6784 The "p" contains the pointer to the UTF-8 string encoding
6785 the character that is being converted.
6787 The "ustrp" is a pointer to the character buffer to put the
6788 conversion result to. The "lenp" is a pointer to the length
6791 The "swashp" is a pointer to the swash to use.
6793 Both the special and normal mappings are stored lib/unicore/To/Foo.pl,
6794 and loaded by SWASHNEW, using lib/utf8_heavy.pl. The special (usually,
6795 but not always, a multicharacter mapping), is tried first.
6797 The "special" is a string like "utf8::ToSpecLower", which means the
6798 hash %utf8::ToSpecLower. The access to the hash is through
6799 Perl_to_utf8_case().
6801 The "normal" is a string like "ToLower" which means the swash
6804 UV to_utf8_case(const U8 *p, U8* ustrp, STRLEN *lenp, SV **swashp, const char *normal, const char *special)
6807 Found in file utf8.c
6812 Convert the UTF-8 encoded character at p to its foldcase version and
6813 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6814 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6815 foldcase version may be longer than the original character (up to
6818 The first character of the foldcased version is returned
6819 (but note, as explained above, that there may be more.)
6821 UV to_utf8_fold(const U8 *p, U8* ustrp, STRLEN *lenp)
6824 Found in file utf8.c
6829 Convert the UTF-8 encoded character at p to its lowercase version and
6830 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6831 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6832 lowercase version may be longer than the original character.
6834 The first character of the lowercased version is returned
6835 (but note, as explained above, that there may be more.)
6837 UV to_utf8_lower(const U8 *p, U8* ustrp, STRLEN *lenp)
6840 Found in file utf8.c
6845 Convert the UTF-8 encoded character at p to its titlecase version and
6846 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6847 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6848 titlecase version may be longer than the original character.
6850 The first character of the titlecased version is returned
6851 (but note, as explained above, that there may be more.)
6853 UV to_utf8_title(const U8 *p, U8* ustrp, STRLEN *lenp)
6856 Found in file utf8.c
6861 Convert the UTF-8 encoded character at p to its uppercase version and
6862 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6863 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since
6864 the uppercase version may be longer than the original character.
6866 The first character of the uppercased version is returned
6867 (but note, as explained above, that there may be more.)
6869 UV to_utf8_upper(const U8 *p, U8* ustrp, STRLEN *lenp)
6872 Found in file utf8.c
6874 =item utf8n_to_uvchr
6879 Returns the native character value of the first character in the string
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 Allows length and flags to be passed to low level routine.
6886 UV utf8n_to_uvchr(const U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags)
6889 Found in file utf8.c
6891 =item utf8n_to_uvuni
6894 Bottom level UTF-8 decode routine.
6895 Returns the Unicode code point value of the first character in the string C<s>
6896 which is assumed to be in UTF-8 encoding and no longer than C<curlen>;
6897 C<retlen> will be set to the length, in bytes, of that character.
6899 If C<s> does not point to a well-formed UTF-8 character, the behaviour
6900 is dependent on the value of C<flags>: if it contains UTF8_CHECK_ONLY,
6901 it is assumed that the caller will raise a warning, and this function
6902 will silently just set C<retlen> to C<-1> and return zero. If the
6903 C<flags> does not contain UTF8_CHECK_ONLY, warnings about
6904 malformations will be given, C<retlen> will be set to the expected
6905 length of the UTF-8 character in bytes, and zero will be returned.
6907 The C<flags> can also contain various flags to allow deviations from
6908 the strict UTF-8 encoding (see F<utf8.h>).
6910 Most code should use utf8_to_uvchr() rather than call this directly.
6912 UV utf8n_to_uvuni(const U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags)
6915 Found in file utf8.c
6920 Returns the number of UTF-8 characters between the UTF-8 pointers C<a>
6923 WARNING: use only if you *know* that the pointers point inside the
6926 IV utf8_distance(const U8 *a, const U8 *b)
6929 Found in file utf8.c
6934 Return the UTF-8 pointer C<s> displaced by C<off> characters, either
6935 forward or backward.
6937 WARNING: do not use the following unless you *know* C<off> is within
6938 the UTF-8 data pointed to by C<s> *and* that on entry C<s> is aligned
6939 on the first byte of character or just after the last byte of a character.
6941 U8* utf8_hop(const U8 *s, I32 off)
6944 Found in file utf8.c
6949 Return the length of the UTF-8 char encoded string C<s> in characters.
6950 Stops at C<e> (inclusive). If C<e E<lt> s> or if the scan would end
6951 up past C<e>, croaks.
6953 STRLEN utf8_length(const U8* s, const U8 *e)
6956 Found in file utf8.c
6961 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
6962 Unlike C<bytes_to_utf8>, this over-writes the original string, and
6963 updates len to contain the new length.
6964 Returns zero on failure, setting C<len> to -1.
6966 If you need a copy of the string, see C<bytes_from_utf8>.
6968 NOTE: this function is experimental and may change or be
6969 removed without notice.
6971 U8* utf8_to_bytes(U8 *s, STRLEN *len)
6974 Found in file utf8.c
6979 Returns the native character value of the first character in the string C<s>
6980 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6981 length, in bytes, of that character.
6983 If C<s> does not point to a well-formed UTF-8 character, zero is
6984 returned and retlen is set, if possible, to -1.
6986 UV utf8_to_uvchr(const U8 *s, STRLEN *retlen)
6989 Found in file utf8.c
6994 Returns the Unicode code point of the first character in the string C<s>
6995 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6996 length, in bytes, of that character.
6998 This function should only be used when returned UV is considered
6999 an index into the Unicode semantic tables (e.g. swashes).
7001 If C<s> does not point to a well-formed UTF-8 character, zero is
7002 returned and retlen is set, if possible, to -1.
7004 UV utf8_to_uvuni(const U8 *s, STRLEN *retlen)
7007 Found in file utf8.c
7012 Adds the UTF-8 representation of the Native codepoint C<uv> to the end
7013 of the string C<d>; C<d> should be have at least C<UTF8_MAXBYTES+1> free
7014 bytes available. The return value is the pointer to the byte after the
7015 end of the new character. In other words,
7017 d = uvchr_to_utf8(d, uv);
7019 is the recommended wide native character-aware way of saying
7023 U8* uvchr_to_utf8(U8 *d, UV uv)
7026 Found in file utf8.c
7028 =item uvuni_to_utf8_flags
7029 X<uvuni_to_utf8_flags>
7031 Adds the UTF-8 representation of the Unicode codepoint C<uv> to the end
7032 of the string C<d>; C<d> should be have at least C<UTF8_MAXBYTES+1> free
7033 bytes available. The return value is the pointer to the byte after the
7034 end of the new character. In other words,
7036 d = uvuni_to_utf8_flags(d, uv, flags);
7040 d = uvuni_to_utf8(d, uv);
7042 (which is equivalent to)
7044 d = uvuni_to_utf8_flags(d, uv, 0);
7046 is the recommended Unicode-aware way of saying
7050 U8* uvuni_to_utf8_flags(U8 *d, UV uv, UV flags)
7053 Found in file utf8.c
7058 =head1 Variables created by C<xsubpp> and C<xsubpp> internal functions
7065 Variable which is setup by C<xsubpp> to indicate the stack base offset,
7066 used by the C<ST>, C<XSprePUSH> and C<XSRETURN> macros. The C<dMARK> macro
7067 must be called prior to setup the C<MARK> variable.
7072 Found in file XSUB.h
7077 Variable which is setup by C<xsubpp> to indicate the
7078 class name for a C++ XS constructor. This is always a C<char*>. See C<THIS>.
7083 Found in file XSUB.h
7088 Sets up the C<ax> variable.
7089 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
7094 Found in file XSUB.h
7099 Sets up the C<ax> variable and stack marker variable C<mark>.
7100 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
7105 Found in file XSUB.h
7110 Sets up the C<items> variable.
7111 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
7116 Found in file XSUB.h
7121 Sets up the C<padoff_du> variable for an XSUB that wishes to use
7127 Found in file XSUB.h
7132 Sets up stack and mark pointers for an XSUB, calling dSP and dMARK.
7133 Sets up the C<ax> and C<items> variables by calling C<dAX> and C<dITEMS>.
7134 This is usually handled automatically by C<xsubpp>.
7139 Found in file XSUB.h
7144 Sets up the C<ix> variable for an XSUB which has aliases. This is usually
7145 handled automatically by C<xsubpp>.
7150 Found in file XSUB.h
7155 Variable which is setup by C<xsubpp> to indicate the number of
7156 items on the stack. See L<perlxs/"Variable-length Parameter Lists">.
7161 Found in file XSUB.h
7166 Variable which is setup by C<xsubpp> to indicate which of an
7167 XSUB's aliases was used to invoke it. See L<perlxs/"The ALIAS: Keyword">.
7172 Found in file XSUB.h
7177 Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
7181 Found in file XSUB.h
7186 Variable which is setup by C<xsubpp> to hold the return value for an
7187 XSUB. This is always the proper type for the XSUB. See
7188 L<perlxs/"The RETVAL Variable">.
7193 Found in file XSUB.h
7198 Used to access elements on the XSUB's stack.
7203 Found in file XSUB.h
7208 Variable which is setup by C<xsubpp> to designate the object in a C++
7209 XSUB. This is always the proper type for the C++ object. See C<CLASS> and
7210 L<perlxs/"Using XS With C++">.
7215 Found in file XSUB.h
7220 The SV* corresponding to the $_ variable. Works even if there
7221 is a lexical $_ in scope.
7224 Found in file XSUB.h
7229 Macro to declare an XSUB and its C parameter list. This is handled by
7233 Found in file XSUB.h
7238 The version identifier for an XS module. This is usually
7239 handled automatically by C<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>.
7242 Found in file XSUB.h
7244 =item XS_VERSION_BOOTCHECK
7245 X<XS_VERSION_BOOTCHECK>
7247 Macro to verify that a PM module's $VERSION variable matches the XS
7248 module's C<XS_VERSION> variable. This is usually handled automatically by
7249 C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">.
7251 XS_VERSION_BOOTCHECK;
7254 Found in file XSUB.h
7259 =head1 Warning and Dieing
7266 This is the XSUB-writer's interface to Perl's C<die> function.
7267 Normally call this function the same way you call the C C<printf>
7268 function. Calling C<croak> returns control directly to Perl,
7269 sidestepping the normal C order of execution. See C<warn>.
7271 If you want to throw an exception object, assign the object to
7272 C<$@> and then pass C<NULL> to croak():
7274 errsv = get_sv("@", TRUE);
7275 sv_setsv(errsv, exception_object);
7278 void croak(const char* pat, ...)
7281 Found in file util.c
7286 This is the XSUB-writer's interface to Perl's C<warn> function. Call this
7287 function the same way you call the C C<printf> function. See C<croak>.
7289 void warn(const char* pat, ...)
7292 Found in file util.c
7299 Until May 1997, this document was maintained by Jeff Okamoto
7300 <okamoto@corp.hp.com>. It is now maintained as part of Perl itself.
7302 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
7303 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
7304 Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
7305 Stephen McCamant, and Gurusamy Sarathy.
7307 API Listing originally by Dean Roehrich <roehrich@cray.com>.
7309 Updated to be autogenerated from comments in the source by Benjamin Stuhl.
7313 perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
projects / p5sagit/p5-mst-13.2.git / blob