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.
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 Escapes at most the first "count" chars of pv and puts the results into
840 dsv such that the size of the escaped string will not exceed "max" chars
841 and will not contain any incomplete escape sequences.
843 If flags contains PERL_PV_ESCAPE_QUOTE then any double quotes in the string
844 will also be escaped.
846 Normally the SV will be cleared before the escaped string is prepared,
847 but when PERL_PV_ESCAPE_NOCLEAR is set this will not occur.
849 If PERL_PV_ESCAPE_UNI is set then the input string is treated as Unicode,
850 if PERL_PV_ESCAPE_UNI_DETECT is set then the input string is scanned
851 using C<is_utf8_string()> to determine if it is Unicode.
853 If PERL_PV_ESCAPE_ALL is set then all input chars will be output
854 using C<\x01F1> style escapes, otherwise only chars above 255 will be
855 escaped using this style, other non printable chars will use octal or
856 common escaped patterns like C<\n>. If PERL_PV_ESCAPE_NOBACKSLASH
857 then all chars below 255 will be treated as printable and
858 will be output as literals.
860 If PERL_PV_ESCAPE_FIRSTCHAR is set then only the first char of the
861 string will be escaped, regardles of max. If the string is utf8 and
862 the chars value is >255 then it will be returned as a plain hex
863 sequence. Thus the output will either be a single char,
864 an octal escape sequence, a special escape like C<\n> or a 3 or
865 more digit hex value.
867 If PERL_PV_ESCAPE_RE is set then the escape char used will be a '%' and
868 not a '\\'. This is because regexes very often contain backslashed
869 sequences, whereas '%' is not a particularly common character in patterns.
871 Returns a pointer to the escaped text as held by dsv.
873 char* pv_escape(SV *dsv, char const * const str, const STRLEN count, const STRLEN max, STRLEN * const escaped, const U32 flags)
881 Converts a string into something presentable, handling escaping via
882 pv_escape() and supporting quoting and ellipses.
884 If the PERL_PV_PRETTY_QUOTE flag is set then the result will be
885 double quoted with any double quotes in the string escaped. Otherwise
886 if the PERL_PV_PRETTY_LTGT flag is set then the result be wrapped in
889 If the PERL_PV_PRETTY_ELLIPSES flag is set and not all characters in
890 string were output then an ellipsis C<...> will be appended to the
891 string. Note that this happens AFTER it has been quoted.
893 If start_color is non-null then it will be inserted after the opening
894 quote (if there is one) but before the escaped text. If end_color
895 is non-null then it will be inserted after the escaped text but before
896 any quotes or ellipses.
898 Returns a pointer to the prettified text as held by dsv.
900 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)
908 =head1 Functions in file mathoms.c
916 See L<gv_fetchmethod_autoload>.
918 GV* gv_fetchmethod(HV* stash, const char* name)
921 Found in file mathoms.c
926 The engine implementing pack() Perl function. Note: parameters next_in_list and
927 flags are not used. This call should not be used; use packlist instead.
929 void pack_cat(SV *cat, const char *pat, const char *patend, SV **beglist, SV **endlist, SV ***next_in_list, U32 flags)
932 Found in file mathoms.c
934 =item sv_2pvbyte_nolen
937 Return a pointer to the byte-encoded representation of the SV.
938 May cause the SV to be downgraded from UTF-8 as a side-effect.
940 Usually accessed via the C<SvPVbyte_nolen> macro.
942 char* sv_2pvbyte_nolen(SV* sv)
945 Found in file mathoms.c
947 =item sv_2pvutf8_nolen
950 Return a pointer to the UTF-8-encoded representation of the SV.
951 May cause the SV to be upgraded to UTF-8 as a side-effect.
953 Usually accessed via the C<SvPVutf8_nolen> macro.
955 char* sv_2pvutf8_nolen(SV* sv)
958 Found in file mathoms.c
963 Like C<sv_2pv()>, but doesn't return the length too. You should usually
964 use the macro wrapper C<SvPV_nolen(sv)> instead.
965 char* sv_2pv_nolen(SV* sv)
968 Found in file mathoms.c
973 Like C<sv_catpvn>, but also handles 'set' magic.
975 void sv_catpvn_mg(SV *sv, const char *ptr, STRLEN len)
978 Found in file mathoms.c
983 Like C<sv_catsv>, but also handles 'set' magic.
985 void sv_catsv_mg(SV *dsv, SV *ssv)
988 Found in file mathoms.c
990 =item sv_force_normal
993 Undo various types of fakery on an SV: if the PV is a shared string, make
994 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
995 an xpvmg. See also C<sv_force_normal_flags>.
997 void sv_force_normal(SV *sv)
1000 Found in file mathoms.c
1005 A private implementation of the C<SvIVx> macro for compilers which can't
1006 cope with complex macro expressions. Always use the macro instead.
1011 Found in file mathoms.c
1016 Dummy routine which "locks" an SV when there is no locking module present.
1017 Exists to avoid test for a NULL function pointer and because it could
1018 potentially warn under some level of strict-ness.
1020 "Superseded" by sv_nosharing().
1022 void sv_nolocking(SV *sv)
1025 Found in file mathoms.c
1027 =item sv_nounlocking
1030 Dummy routine which "unlocks" an SV when there is no locking module present.
1031 Exists to avoid test for a NULL function pointer and because it could
1032 potentially warn under some level of strict-ness.
1034 "Superseded" by sv_nosharing().
1036 void sv_nounlocking(SV *sv)
1039 Found in file mathoms.c
1044 A private implementation of the C<SvNVx> macro for compilers which can't
1045 cope with complex macro expressions. Always use the macro instead.
1050 Found in file mathoms.c
1055 Use the C<SvPV_nolen> macro instead
1060 Found in file mathoms.c
1065 Use C<SvPVbyte_nolen> instead.
1067 char* sv_pvbyte(SV *sv)
1070 Found in file mathoms.c
1075 A private implementation of the C<SvPVbyte> macro for compilers
1076 which can't cope with complex macro expressions. Always use the macro
1079 char* sv_pvbyten(SV *sv, STRLEN *lp)
1082 Found in file mathoms.c
1087 A private implementation of the C<SvPV> macro for compilers which can't
1088 cope with complex macro expressions. Always use the macro instead.
1090 char* sv_pvn(SV *sv, STRLEN *lp)
1093 Found in file mathoms.c
1098 Use the C<SvPVutf8_nolen> macro instead
1100 char* sv_pvutf8(SV *sv)
1103 Found in file mathoms.c
1108 A private implementation of the C<SvPVutf8> macro for compilers
1109 which can't cope with complex macro expressions. Always use the macro
1112 char* sv_pvutf8n(SV *sv, STRLEN *lp)
1115 Found in file mathoms.c
1120 Taint an SV. Use C<SvTAINTED_on> instead.
1121 void sv_taint(SV* sv)
1124 Found in file mathoms.c
1129 Unsets the RV status of the SV, and decrements the reference count of
1130 whatever was being referenced by the RV. This can almost be thought of
1131 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
1132 being zero. See C<SvROK_off>.
1134 void sv_unref(SV* sv)
1137 Found in file mathoms.c
1142 Tells an SV to use C<ptr> to find its string value. Implemented by
1143 calling C<sv_usepvn_flags> with C<flags> of 0, hence does not handle 'set'
1144 magic. See C<sv_usepvn_flags>.
1146 void sv_usepvn(SV* sv, char* ptr, STRLEN len)
1149 Found in file mathoms.c
1154 Like C<sv_usepvn>, but also handles 'set' magic.
1156 void sv_usepvn_mg(SV *sv, char *ptr, STRLEN len)
1159 Found in file mathoms.c
1164 A private implementation of the C<SvUVx> macro for compilers which can't
1165 cope with complex macro expressions. Always use the macro instead.
1170 Found in file mathoms.c
1175 The engine implementing unpack() Perl function. Note: parameters strbeg, new_s
1176 and ocnt are not used. This call should not be used, use unpackstring instead.
1178 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)
1181 Found in file mathoms.c
1186 =head1 Functions in file pp_ctl.c
1194 Locate the CV corresponding to the currently executing sub or eval.
1195 If db_seqp is non_null, skip CVs that are in the DB package and populate
1196 *db_seqp with the cop sequence number at the point that the DB:: code was
1197 entered. (allows debuggers to eval in the scope of the breakpoint rather
1198 than in the scope of the debugger itself).
1200 CV* find_runcv(U32 *db_seqp)
1203 Found in file pp_ctl.c
1208 =head1 Functions in file pp_pack.c
1216 The engine implementing pack() Perl function.
1218 void packlist(SV *cat, const char *pat, const char *patend, SV **beglist, SV **endlist)
1221 Found in file pp_pack.c
1226 The engine implementing unpack() Perl function. C<unpackstring> puts the
1227 extracted list items on the stack and returns the number of elements.
1228 Issue C<PUTBACK> before and C<SPAGAIN> after the call to this function.
1230 I32 unpackstring(const char *pat, const char *patend, const char *s, const char *strend, U32 flags)
1233 Found in file pp_pack.c
1245 Return the SV from the GV.
1255 If C<gv> is a typeglob whose subroutine entry is a constant sub eligible for
1256 inlining, or C<gv> is a placeholder reference that would be promoted to such
1257 a typeglob, then returns the value returned by the sub. Otherwise, returns
1260 SV* gv_const_sv(GV* gv)
1268 Returns the glob with the given C<name> and a defined subroutine or
1269 C<NULL>. The glob lives in the given C<stash>, or in the stashes
1270 accessible via @ISA and UNIVERSAL::.
1272 The argument C<level> should be either 0 or -1. If C<level==0>, as a
1273 side-effect creates a glob with the given C<name> in the given C<stash>
1274 which in the case of success contains an alias for the subroutine, and sets
1275 up caching info for this glob.
1277 This function grants C<"SUPER"> token as a postfix of the stash name. The
1278 GV returned from C<gv_fetchmeth> may be a method cache entry, which is not
1279 visible to Perl code. So when calling C<call_sv>, you should not use
1280 the GV directly; instead, you should use the method's CV, which can be
1281 obtained from the GV with the C<GvCV> macro.
1283 GV* gv_fetchmeth(HV* stash, const char* name, STRLEN len, I32 level)
1288 =item gv_fetchmethod_autoload
1289 X<gv_fetchmethod_autoload>
1291 Returns the glob which contains the subroutine to call to invoke the method
1292 on the C<stash>. In fact in the presence of autoloading this may be the
1293 glob for "AUTOLOAD". In this case the corresponding variable $AUTOLOAD is
1296 The third parameter of C<gv_fetchmethod_autoload> determines whether
1297 AUTOLOAD lookup is performed if the given method is not present: non-zero
1298 means yes, look for AUTOLOAD; zero means no, don't look for AUTOLOAD.
1299 Calling C<gv_fetchmethod> is equivalent to calling C<gv_fetchmethod_autoload>
1300 with a non-zero C<autoload> parameter.
1302 These functions grant C<"SUPER"> token as a prefix of the method name. Note
1303 that if you want to keep the returned glob for a long time, you need to
1304 check for it being "AUTOLOAD", since at the later time the call may load a
1305 different subroutine due to $AUTOLOAD changing its value. Use the glob
1306 created via a side effect to do this.
1308 These functions have the same side-effects and as C<gv_fetchmeth> with
1309 C<level==0>. C<name> should be writable if contains C<':'> or C<'
1310 ''>. The warning against passing the GV returned by C<gv_fetchmeth> to
1311 C<call_sv> apply equally to these functions.
1313 GV* gv_fetchmethod_autoload(HV* stash, const char* name, I32 autoload)
1318 =item gv_fetchmeth_autoload
1319 X<gv_fetchmeth_autoload>
1321 Same as gv_fetchmeth(), but looks for autoloaded subroutines too.
1322 Returns a glob for the subroutine.
1324 For an autoloaded subroutine without a GV, will create a GV even
1325 if C<level < 0>. For an autoloaded subroutine without a stub, GvCV()
1326 of the result may be zero.
1328 GV* gv_fetchmeth_autoload(HV* stash, const char* name, STRLEN len, I32 level)
1336 Returns a pointer to the stash for a specified package. Uses C<strlen> to
1337 determine the length of C<name>, then calls C<gv_stashpvn()>.
1339 HV* gv_stashpv(const char* name, I32 flags)
1347 Returns a pointer to the stash for a specified package. The C<namelen>
1348 parameter indicates the length of the C<name>, in bytes. C<flags> is passed
1349 to C<gv_fetchpvn_flags()>, so if set to C<GV_ADD> then the package will be
1350 created if it does not already exist. If the package does not exist and
1351 C<flags> is 0 (or any other setting that does not create packages) then NULL
1355 HV* gv_stashpvn(const char* name, U32 namelen, I32 flags)
1363 Like C<gv_stashpvn>, but takes a literal string instead of a string/length pair.
1365 HV* gv_stashpvs(const char* name, I32 create)
1368 Found in file handy.h
1373 Returns a pointer to the stash for a specified package. See C<gv_stashpvn>.
1375 HV* gv_stashsv(SV* sv, I32 flags)
1392 (deprecated - use C<(AV *)NULL> instead)
1400 Null character pointer. (No longer available when C<PERL_CORE> is defined.)
1403 Found in file handy.h
1410 (deprecated - use C<(CV *)NULL> instead)
1420 (deprecated - use C<(HV *)NULL> instead)
1428 Null SV pointer. (No longer available when C<PERL_CORE> is defined.)
1431 Found in file handy.h
1436 =head1 Hash Manipulation Functions
1443 Returns the HV of the specified Perl hash. If C<create> is set and the
1444 Perl variable does not exist then it will be created. If C<create> is not
1445 set and the variable does not exist then NULL is returned.
1447 NOTE: the perl_ form of this function is deprecated.
1449 HV* get_hv(const char* name, I32 create)
1452 Found in file perl.c
1457 This flag, used in the length slot of hash entries and magic structures,
1458 specifies the structure contains an C<SV*> pointer where a C<char*> pointer
1459 is to be expected. (For information only--not to be used).
1467 Returns the computed hash stored in the hash entry.
1477 Returns the actual pointer stored in the key slot of the hash entry. The
1478 pointer may be either C<char*> or C<SV*>, depending on the value of
1479 C<HeKLEN()>. Can be assigned to. The C<HePV()> or C<HeSVKEY()> macros are
1480 usually preferable for finding the value of a key.
1490 If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry
1491 holds an C<SV*> key. Otherwise, holds the actual length of the key. Can
1492 be assigned to. The C<HePV()> macro is usually preferable for finding key
1495 STRLEN HeKLEN(HE* he)
1503 Returns the key slot of the hash entry as a C<char*> value, doing any
1504 necessary dereferencing of possibly C<SV*> keys. The length of the string
1505 is placed in C<len> (this is a macro, so do I<not> use C<&len>). If you do
1506 not care about what the length of the key is, you may use the global
1507 variable C<PL_na>, though this is rather less efficient than using a local
1508 variable. Remember though, that hash keys in perl are free to contain
1509 embedded nulls, so using C<strlen()> or similar is not a good way to find
1510 the length of hash keys. This is very similar to the C<SvPV()> macro
1511 described elsewhere in this document. See also C<HeUTF8>.
1513 If you are using C<HePV> to get values to pass to C<newSVpvn()> to create a
1514 new SV, you should consider using C<newSVhek(HeKEY_hek(he))> as it is more
1517 char* HePV(HE* he, STRLEN len)
1525 Returns the key as an C<SV*>, or C<NULL> if the hash entry does not
1526 contain an C<SV*> key.
1536 Returns the key as an C<SV*>. Will create and return a temporary mortal
1537 C<SV*> if the hash entry contains only a C<char*> key.
1539 SV* HeSVKEY_force(HE* he)
1547 Sets the key to a given C<SV*>, taking care to set the appropriate flags to
1548 indicate the presence of an C<SV*> key, and returns the same
1551 SV* HeSVKEY_set(HE* he, SV* sv)
1559 Returns whether the C<char *> value returned by C<HePV> is encoded in UTF-8,
1560 doing any necessary dereferencing of possibly C<SV*> keys. The value returned
1561 will be 0 or non-0, not necessarily 1 (or even a value with any low bits set),
1562 so B<do not> blindly assign this to a C<bool> variable, as C<bool> may be a
1563 typedef for C<char>.
1565 char* HeUTF8(HE* he, STRLEN len)
1573 Returns the value slot (type C<SV*>) stored in the hash entry.
1583 Returns the package name of a stash, or NULL if C<stash> isn't a stash.
1584 See C<SvSTASH>, C<CvSTASH>.
1586 char* HvNAME(HV* stash)
1594 Check that a hash is in an internally consistent state.
1596 void hv_assert(HV *hv)
1604 Clears a hash, making it empty.
1606 void hv_clear(HV *hv)
1611 =item hv_clear_placeholders
1612 X<hv_clear_placeholders>
1614 Clears any placeholders from a hash. If a restricted hash has any of its keys
1615 marked as readonly and the key is subsequently deleted, the key is not actually
1616 deleted but is marked by assigning it a value of &PL_sv_placeholder. This tags
1617 it so it will be ignored by future operations such as iterating over the hash,
1618 but will still allow the hash to have a value reassigned to the key at some
1619 future point. This function clears any such placeholder keys from the hash.
1620 See Hash::Util::lock_keys() for an example of its use.
1622 void hv_clear_placeholders(HV *hv)
1630 Deletes a key/value pair in the hash. The value SV is removed from the
1631 hash and returned to the caller. The C<klen> is the length of the key.
1632 The C<flags> value will normally be zero; if set to G_DISCARD then NULL
1635 SV* hv_delete(HV *hv, const char *key, I32 klen, I32 flags)
1643 Deletes a key/value pair in the hash. The value SV is removed from the
1644 hash and returned to the caller. The C<flags> value will normally be zero;
1645 if set to G_DISCARD then NULL will be returned. C<hash> can be a valid
1646 precomputed hash value, or 0 to ask for it to be computed.
1648 SV* hv_delete_ent(HV *hv, SV *keysv, I32 flags, U32 hash)
1656 Returns a boolean indicating whether the specified hash key exists. The
1657 C<klen> is the length of the key.
1659 bool hv_exists(HV *hv, const char *key, I32 klen)
1667 Returns a boolean indicating whether the specified hash key exists. C<hash>
1668 can be a valid precomputed hash value, or 0 to ask for it to be
1671 bool hv_exists_ent(HV *hv, SV *keysv, U32 hash)
1679 Returns the SV which corresponds to the specified key in the hash. The
1680 C<klen> is the length of the key. If C<lval> is set then the fetch will be
1681 part of a store. Check that the return value is non-null before
1682 dereferencing it to an C<SV*>.
1684 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1685 information on how to use this function on tied hashes.
1687 SV** hv_fetch(HV *hv, const char *key, I32 klen, I32 lval)
1695 Like C<hv_fetch>, but takes a literal string instead of a string/length pair.
1697 SV** hv_fetchs(HV* tb, const char* key, I32 lval)
1700 Found in file handy.h
1705 Returns the hash entry which corresponds to the specified key in the hash.
1706 C<hash> must be a valid precomputed hash number for the given C<key>, or 0
1707 if you want the function to compute it. IF C<lval> is set then the fetch
1708 will be part of a store. Make sure the return value is non-null before
1709 accessing it. The return value when C<tb> is a tied hash is a pointer to a
1710 static location, so be sure to make a copy of the structure if you need to
1713 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1714 information on how to use this function on tied hashes.
1716 HE* hv_fetch_ent(HV *hv, SV *keysv, I32 lval, U32 hash)
1724 Prepares a starting point to traverse a hash table. Returns the number of
1725 keys in the hash (i.e. the same as C<HvKEYS(tb)>). The return value is
1726 currently only meaningful for hashes without tie magic.
1728 NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
1729 hash buckets that happen to be in use. If you still need that esoteric
1730 value, you can get it through the macro C<HvFILL(tb)>.
1733 I32 hv_iterinit(HV *hv)
1741 Returns the key from the current position of the hash iterator. See
1744 char* hv_iterkey(HE* entry, I32* retlen)
1752 Returns the key as an C<SV*> from the current position of the hash
1753 iterator. The return value will always be a mortal copy of the key. Also
1756 SV* hv_iterkeysv(HE* entry)
1764 Returns entries from a hash iterator. See C<hv_iterinit>.
1766 You may call C<hv_delete> or C<hv_delete_ent> on the hash entry that the
1767 iterator currently points to, without losing your place or invalidating your
1768 iterator. Note that in this case the current entry is deleted from the hash
1769 with your iterator holding the last reference to it. Your iterator is flagged
1770 to free the entry on the next call to C<hv_iternext>, so you must not discard
1771 your iterator immediately else the entry will leak - call C<hv_iternext> to
1772 trigger the resource deallocation.
1774 HE* hv_iternext(HV *hv)
1782 Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
1785 SV* hv_iternextsv(HV *hv, char **key, I32 *retlen)
1790 =item hv_iternext_flags
1791 X<hv_iternext_flags>
1793 Returns entries from a hash iterator. See C<hv_iterinit> and C<hv_iternext>.
1794 The C<flags> value will normally be zero; if HV_ITERNEXT_WANTPLACEHOLDERS is
1795 set the placeholders keys (for restricted hashes) will be returned in addition
1796 to normal keys. By default placeholders are automatically skipped over.
1797 Currently a placeholder is implemented with a value that is
1798 C<&Perl_sv_placeholder>. Note that the implementation of placeholders and
1799 restricted hashes may change, and the implementation currently is
1800 insufficiently abstracted for any change to be tidy.
1802 NOTE: this function is experimental and may change or be
1803 removed without notice.
1805 HE* hv_iternext_flags(HV *hv, I32 flags)
1813 Returns the value from the current position of the hash iterator. See
1816 SV* hv_iterval(HV *hv, HE *entry)
1824 Adds magic to a hash. See C<sv_magic>.
1826 void hv_magic(HV *hv, GV *gv, int how)
1834 Evaluates the hash in scalar context and returns the result. Handles magic when the hash is tied.
1836 SV* hv_scalar(HV *hv)
1844 Stores an SV in a hash. The hash key is specified as C<key> and C<klen> is
1845 the length of the key. The C<hash> parameter is the precomputed hash
1846 value; if it is zero then Perl will compute it. The return value will be
1847 NULL if the operation failed or if the value did not need to be actually
1848 stored within the hash (as in the case of tied hashes). Otherwise it can
1849 be dereferenced to get the original C<SV*>. Note that the caller is
1850 responsible for suitably incrementing the reference count of C<val> before
1851 the call, and decrementing it if the function returned NULL. Effectively
1852 a successful hv_store takes ownership of one reference to C<val>. This is
1853 usually what you want; a newly created SV has a reference count of one, so
1854 if all your code does is create SVs then store them in a hash, hv_store
1855 will own the only reference to the new SV, and your code doesn't need to do
1856 anything further to tidy up. hv_store is not implemented as a call to
1857 hv_store_ent, and does not create a temporary SV for the key, so if your
1858 key data is not already in SV form then use hv_store in preference to
1861 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1862 information on how to use this function on tied hashes.
1864 SV** hv_store(HV *hv, const char *key, I32 klen, SV *val, U32 hash)
1872 Like C<hv_store>, but takes a literal string instead of a string/length pair
1873 and omits the hash parameter.
1875 SV** hv_stores(HV* tb, const char* key, NULLOK SV* val)
1878 Found in file handy.h
1883 Stores C<val> in a hash. The hash key is specified as C<key>. The C<hash>
1884 parameter is the precomputed hash value; if it is zero then Perl will
1885 compute it. The return value is the new hash entry so created. It will be
1886 NULL if the operation failed or if the value did not need to be actually
1887 stored within the hash (as in the case of tied hashes). Otherwise the
1888 contents of the return value can be accessed using the C<He?> macros
1889 described here. Note that the caller is responsible for suitably
1890 incrementing the reference count of C<val> before the call, and
1891 decrementing it if the function returned NULL. Effectively a successful
1892 hv_store_ent takes ownership of one reference to C<val>. This is
1893 usually what you want; a newly created SV has a reference count of one, so
1894 if all your code does is create SVs then store them in a hash, hv_store
1895 will own the only reference to the new SV, and your code doesn't need to do
1896 anything further to tidy up. Note that hv_store_ent only reads the C<key>;
1897 unlike C<val> it does not take ownership of it, so maintaining the correct
1898 reference count on C<key> is entirely the caller's responsibility. hv_store
1899 is not implemented as a call to hv_store_ent, and does not create a temporary
1900 SV for the key, so if your key data is not already in SV form then use
1901 hv_store in preference to hv_store_ent.
1903 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1904 information on how to use this function on tied hashes.
1906 HE* hv_store_ent(HV *hv, SV *key, SV *val, U32 hash)
1916 void hv_undef(HV *hv)
1924 Creates a new HV. The reference count is set to 1.
1934 =head1 Magical Functions
1941 Clear something magical that the SV represents. See C<sv_magic>.
1943 int mg_clear(SV* sv)
1951 Copies the magic from one SV to another. See C<sv_magic>.
1953 int mg_copy(SV *sv, SV *nsv, const char *key, I32 klen)
1961 Finds the magic pointer for type matching the SV. See C<sv_magic>.
1963 MAGIC* mg_find(const SV* sv, int type)
1971 Free any magic storage used by the SV. See C<sv_magic>.
1981 Do magic after a value is retrieved from the SV. See C<sv_magic>.
1991 Report on the SV's length. See C<sv_magic>.
1993 U32 mg_length(SV* sv)
2001 Turns on the magical status of an SV. See C<sv_magic>.
2003 void mg_magical(SV* sv)
2011 Do magic after a value is assigned to the SV. See C<sv_magic>.
2021 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
2022 argument more than once.
2024 void SvGETMAGIC(SV* sv)
2032 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
2043 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
2044 argument more than once.
2046 void SvSETMAGIC(SV* sv)
2054 Like C<SvSetSV>, but does any set magic required afterwards.
2056 void SvSetMagicSV(SV* dsb, SV* ssv)
2061 =item SvSetMagicSV_nosteal
2062 X<SvSetMagicSV_nosteal>
2064 Like C<SvSetSV_nosteal>, but does any set magic required afterwards.
2066 void SvSetMagicSV_nosteal(SV* dsv, SV* ssv)
2074 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
2077 void SvSetSV(SV* dsb, SV* ssv)
2082 =item SvSetSV_nosteal
2085 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
2086 ssv. May evaluate arguments more than once.
2088 void SvSetSV_nosteal(SV* dsv, SV* ssv)
2096 Arranges for sv to be shared between threads if a suitable module
2099 void SvSHARE(SV* sv)
2107 Releases a mutual exclusion lock on sv if a suitable module
2110 void SvUNLOCK(SV* sv)
2118 =head1 Memory Management
2125 The XSUB-writer's interface to the C C<memcpy> function. The C<src> is the
2126 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
2127 the type. May fail on overlapping copies. See also C<Move>.
2129 void Copy(void* src, void* dest, int nitems, type)
2132 Found in file handy.h
2137 Like C<Copy> but returns dest. Useful for encouraging compilers to tail-call
2140 void * CopyD(void* src, void* dest, int nitems, type)
2143 Found in file handy.h
2148 The XSUB-writer's interface to the C C<memmove> function. The C<src> is the
2149 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
2150 the type. Can do overlapping moves. See also C<Copy>.
2152 void Move(void* src, void* dest, int nitems, type)
2155 Found in file handy.h
2160 Like C<Move> but returns dest. Useful for encouraging compilers to tail-call
2163 void * MoveD(void* src, void* dest, int nitems, type)
2166 Found in file handy.h
2171 The XSUB-writer's interface to the C C<malloc> function.
2173 In 5.9.3, Newx() and friends replace the older New() API, and drops
2174 the first parameter, I<x>, a debug aid which allowed callers to identify
2175 themselves. This aid has been superseded by a new build option,
2176 PERL_MEM_LOG (see L<perlhack/PERL_MEM_LOG>). The older API is still
2177 there for use in XS modules supporting older perls.
2179 void Newx(void* ptr, int nitems, type)
2182 Found in file handy.h
2187 The XSUB-writer's interface to the C C<malloc> function, with
2188 cast. See also C<Newx>.
2190 void Newxc(void* ptr, int nitems, type, cast)
2193 Found in file handy.h
2198 The XSUB-writer's interface to the C C<malloc> function. The allocated
2199 memory is zeroed with C<memzero>. See also C<Newx>.
2201 void Newxz(void* ptr, int nitems, type)
2204 Found in file handy.h
2209 PoisonWith(0xEF) for catching access to freed memory.
2211 void Poison(void* dest, int nitems, type)
2214 Found in file handy.h
2219 PoisonWith(0xEF) for catching access to freed memory.
2221 void PoisonFree(void* dest, int nitems, type)
2224 Found in file handy.h
2229 PoisonWith(0xAB) for catching access to allocated but uninitialized memory.
2231 void PoisonNew(void* dest, int nitems, type)
2234 Found in file handy.h
2239 Fill up memory with a byte pattern (a byte repeated over and over
2240 again) that hopefully catches attempts to access uninitialized memory.
2242 void PoisonWith(void* dest, int nitems, type, U8 byte)
2245 Found in file handy.h
2250 The XSUB-writer's interface to the C C<realloc> function.
2252 void Renew(void* ptr, int nitems, type)
2255 Found in file handy.h
2260 The XSUB-writer's interface to the C C<realloc> function, with
2263 void Renewc(void* ptr, int nitems, type, cast)
2266 Found in file handy.h
2271 The XSUB-writer's interface to the C C<free> function.
2273 void Safefree(void* ptr)
2276 Found in file handy.h
2281 Perl's version of C<strdup()>. Returns a pointer to a newly allocated
2282 string which is a duplicate of C<pv>. The size of the string is
2283 determined by C<strlen()>. The memory allocated for the new string can
2284 be freed with the C<Safefree()> function.
2286 char* savepv(const char* pv)
2289 Found in file util.c
2294 Perl's version of what C<strndup()> would be if it existed. Returns a
2295 pointer to a newly allocated string which is a duplicate of the first
2296 C<len> bytes from C<pv>, plus a trailing NUL byte. The memory allocated for
2297 the new string can be freed with the C<Safefree()> function.
2299 char* savepvn(const char* pv, I32 len)
2302 Found in file util.c
2307 Like C<savepvn>, but takes a literal string instead of a string/length pair.
2309 char* savepvs(const char* s)
2312 Found in file handy.h
2317 A version of C<savepv()> which allocates the duplicate string in memory
2318 which is shared between threads.
2320 char* savesharedpv(const char* pv)
2323 Found in file util.c
2328 A version of C<savepvn()> which allocates the duplicate string in memory
2329 which is shared between threads. (With the specific difference that a NULL
2330 pointer is not acceptable)
2332 char* savesharedpvn(const char *const pv, const STRLEN len)
2335 Found in file util.c
2340 A version of C<savepv()>/C<savepvn()> which gets the string to duplicate from
2341 the passed in SV using C<SvPV()>
2343 char* savesvpv(SV* sv)
2346 Found in file util.c
2351 This is an architecture-independent macro to copy one structure to another.
2353 void StructCopy(type src, type dest, type)
2356 Found in file handy.h
2361 The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the
2362 destination, C<nitems> is the number of items, and C<type> is the type.
2364 void Zero(void* dest, int nitems, type)
2367 Found in file handy.h
2372 Like C<Zero> but returns dest. Useful for encouraging compilers to tail-call
2375 void * ZeroD(void* dest, int nitems, type)
2378 Found in file handy.h
2383 =head1 Miscellaneous Functions
2390 Analyses the string in order to make fast searches on it using fbm_instr()
2391 -- the Boyer-Moore algorithm.
2393 void fbm_compile(SV* sv, U32 flags)
2396 Found in file util.c
2401 Returns the location of the SV in the string delimited by C<str> and
2402 C<strend>. It returns C<NULL> if the string can't be found. The C<sv>
2403 does not have to be fbm_compiled, but the search will not be as fast
2406 char* fbm_instr(unsigned char* big, unsigned char* bigend, SV* littlestr, U32 flags)
2409 Found in file util.c
2414 Takes a sprintf-style format pattern and conventional
2415 (non-SV) arguments and returns the formatted string.
2417 (char *) Perl_form(pTHX_ const char* pat, ...)
2419 can be used any place a string (char *) is required:
2421 char * s = Perl_form("%d.%d",major,minor);
2423 Uses a single private buffer so if you want to format several strings you
2424 must explicitly copy the earlier strings away (and free the copies when you
2427 char* form(const char* pat, ...)
2430 Found in file util.c
2435 Fill the sv with current working directory
2437 int getcwd_sv(SV* sv)
2440 Found in file util.c
2445 The C library C<snprintf> functionality, if available and
2446 standards-compliant (uses C<vsnprintf>, actually). However, if the
2447 C<vsnprintf> is not available, will unfortunately use the unsafe
2448 C<vsprintf> which can overrun the buffer (there is an overrun check,
2449 but that may be too late). Consider using C<sv_vcatpvf> instead, or
2450 getting C<vsnprintf>.
2452 int my_snprintf(char *buffer, const Size_t len, const char *format, ...)
2455 Found in file util.c
2460 The C library C<sprintf>, wrapped if necessary, to ensure that it will return
2461 the length of the string written to the buffer. Only rare pre-ANSI systems
2462 need the wrapper function - usually this is a direct call to C<sprintf>.
2464 int my_sprintf(char *buffer, const char *pat, ...)
2467 Found in file util.c
2472 The C library C<vsnprintf> if available and standards-compliant.
2473 However, if if the C<vsnprintf> is not available, will unfortunately
2474 use the unsafe C<vsprintf> which can overrun the buffer (there is an
2475 overrun check, but that may be too late). Consider using
2476 C<sv_vcatpvf> instead, or getting C<vsnprintf>.
2478 int my_vsnprintf(char *buffer, const Size_t len, const char *format, va_list ap)
2481 Found in file util.c
2486 Returns a new version object based on the passed in SV:
2488 SV *sv = new_version(SV *ver);
2490 Does not alter the passed in ver SV. See "upg_version" if you
2491 want to upgrade the SV.
2493 SV* new_version(SV *ver)
2496 Found in file util.c
2501 Returns a pointer to the next character after the parsed
2502 version string, as well as upgrading the passed in SV to
2505 Function must be called with an already existing SV like
2508 s = scan_version(s, SV *sv, bool qv);
2510 Performs some preprocessing to the string to ensure that
2511 it has the correct characteristics of a version. Flags the
2512 object if it contains an underscore (which denotes this
2513 is an alpha version). The boolean qv denotes that the version
2514 should be interpreted as if it had multiple decimals, even if
2517 const char* scan_version(const char *s, SV *rv, bool qv)
2520 Found in file util.c
2525 Test two strings to see if they are equal. Returns true or false.
2527 bool strEQ(char* s1, char* s2)
2530 Found in file handy.h
2535 Test two strings to see if the first, C<s1>, is greater than or equal to
2536 the second, C<s2>. Returns true or false.
2538 bool strGE(char* s1, char* s2)
2541 Found in file handy.h
2546 Test two strings to see if the first, C<s1>, is greater than the second,
2547 C<s2>. Returns true or false.
2549 bool strGT(char* s1, char* s2)
2552 Found in file handy.h
2557 Test two strings to see if the first, C<s1>, is less than or equal to the
2558 second, C<s2>. Returns true or false.
2560 bool strLE(char* s1, char* s2)
2563 Found in file handy.h
2568 Test two strings to see if the first, C<s1>, is less than the second,
2569 C<s2>. Returns true or false.
2571 bool strLT(char* s1, char* s2)
2574 Found in file handy.h
2579 Test two strings to see if they are different. Returns true or
2582 bool strNE(char* s1, char* s2)
2585 Found in file handy.h
2590 Test two strings to see if they are equal. The C<len> parameter indicates
2591 the number of bytes to compare. Returns true or false. (A wrapper for
2594 bool strnEQ(char* s1, char* s2, STRLEN len)
2597 Found in file handy.h
2602 Test two strings to see if they are different. The C<len> parameter
2603 indicates the number of bytes to compare. Returns true or false. (A
2604 wrapper for C<strncmp>).
2606 bool strnNE(char* s1, char* s2, STRLEN len)
2609 Found in file handy.h
2611 =item sv_destroyable
2614 Dummy routine which reports that object can be destroyed when there is no
2615 sharing module present. It ignores its single SV argument, and returns
2616 'true'. Exists to avoid test for a NULL function pointer and because it
2617 could potentially warn under some level of strict-ness.
2619 bool sv_destroyable(SV *sv)
2622 Found in file util.c
2627 Dummy routine which "shares" an SV when there is no sharing module present.
2628 Or "locks" it. Or "unlocks" it. In other words, ignores its single SV argument.
2629 Exists to avoid test for a NULL function pointer and because it could
2630 potentially warn under some level of strict-ness.
2632 void sv_nosharing(SV *sv)
2635 Found in file util.c
2640 In-place upgrade of the supplied SV to a version object.
2642 SV *sv = upg_version(SV *sv, bool qv);
2644 Returns a pointer to the upgraded SV. Set the boolean qv if you want
2645 to force this SV to be interpreted as an "extended" version.
2647 SV* upg_version(SV *ver, bool qv)
2650 Found in file util.c
2655 Version object aware cmp. Both operands must already have been
2656 converted into version objects.
2658 int vcmp(SV *lhv, SV *rhv)
2661 Found in file util.c
2666 Accepts a version object and returns the normalized string
2667 representation. Call like:
2671 NOTE: you can pass either the object directly or the SV
2672 contained within the RV.
2677 Found in file util.c
2682 Accepts a version object and returns the normalized floating
2683 point representation. Call like:
2687 NOTE: you can pass either the object directly or the SV
2688 contained within the RV.
2693 Found in file util.c
2698 In order to maintain maximum compatibility with earlier versions
2699 of Perl, this function will return either the floating point
2700 notation or the multiple dotted notation, depending on whether
2701 the original version contained 1 or more dots, respectively
2703 SV* vstringify(SV *vs)
2706 Found in file util.c
2711 Validates that the SV contains a valid version object.
2713 bool vverify(SV *vobj);
2715 Note that it only confirms the bare minimum structure (so as not to get
2716 confused by derived classes which may contain additional hash entries):
2718 bool vverify(SV *vs)
2721 Found in file util.c
2726 =head1 MRO Functions
2730 =item mro_get_linear_isa
2731 X<mro_get_linear_isa>
2733 Returns either C<mro_get_linear_isa_c3> or
2734 C<mro_get_linear_isa_dfs> for the given stash,
2735 dependant upon which MRO is in effect
2736 for that stash. The return value is a
2739 You are responsible for C<SvREFCNT_inc()> on the
2740 return value if you plan to store it anywhere
2741 semi-permanently (otherwise it might be deleted
2742 out from under you the next time the cache is
2745 AV* mro_get_linear_isa(HV* stash)
2750 =item mro_method_changed_in
2751 X<mro_method_changed_in>
2753 Invalidates method caching on any child classes
2754 of the given stash, so that they might notice
2755 the changes in this one.
2757 Ideally, all instances of C<PL_sub_generation++> in
2758 perl source outside of C<mro.c> should be
2759 replaced by calls to this.
2761 Perl automatically handles most of the common
2762 ways a method might be redefined. However, there
2763 are a few ways you could change a method in a stash
2764 without the cache code noticing, in which case you
2765 need to call this method afterwards:
2767 1) Directly manipulating the stash HV entries from
2770 2) Assigning a reference to a readonly scalar
2771 constant into a stash entry in order to create
2772 a constant subroutine (like constant.pm
2775 This same method is available from pure perl
2776 via, C<mro::method_changed_in(classname)>.
2778 void mro_method_changed_in(HV* stash)
2786 =head1 Multicall Functions
2793 Declare local variables for a multicall. See L<perlcall/Lightweight Callbacks>.
2803 Make a lightweight callback. See L<perlcall/Lightweight Callbacks>.
2813 Closing bracket for a lightweight callback.
2814 See L<perlcall/Lightweight Callbacks>.
2821 =item PUSH_MULTICALL
2824 Opening bracket for a lightweight callback.
2825 See L<perlcall/Lightweight Callbacks>.
2835 =head1 Numeric functions
2842 converts a string representing a binary number to numeric form.
2844 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2845 conversion flags, and I<result> should be NULL or a pointer to an NV.
2846 The scan stops at the end of the string, or the first invalid character.
2847 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2848 invalid character will also trigger a warning.
2849 On return I<*len> is set to the length of the scanned string,
2850 and I<*flags> gives output flags.
2852 If the value is <= C<UV_MAX> it is returned as a UV, the output flags are clear,
2853 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_bin>
2854 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2855 and writes the value to I<*result> (or the value is discarded if I<result>
2858 The binary number may optionally be prefixed with "0b" or "b" unless
2859 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
2860 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the binary
2861 number may use '_' characters to separate digits.
2863 UV grok_bin(const char* start, STRLEN* len_p, I32* flags, NV *result)
2866 Found in file numeric.c
2871 converts a string representing a hex number to numeric form.
2873 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2874 conversion flags, and I<result> should be NULL or a pointer to an NV.
2875 The scan stops at the end of the string, or the first invalid character.
2876 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2877 invalid character will also trigger a warning.
2878 On return I<*len> is set to the length of the scanned string,
2879 and I<*flags> gives output flags.
2881 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2882 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_hex>
2883 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2884 and writes the value to I<*result> (or the value is discarded if I<result>
2887 The hex number may optionally be prefixed with "0x" or "x" unless
2888 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
2889 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the hex
2890 number may use '_' characters to separate digits.
2892 UV grok_hex(const char* start, STRLEN* len_p, I32* flags, NV *result)
2895 Found in file numeric.c
2900 Recognise (or not) a number. The type of the number is returned
2901 (0 if unrecognised), otherwise it is a bit-ORed combination of
2902 IS_NUMBER_IN_UV, IS_NUMBER_GREATER_THAN_UV_MAX, IS_NUMBER_NOT_INT,
2903 IS_NUMBER_NEG, IS_NUMBER_INFINITY, IS_NUMBER_NAN (defined in perl.h).
2905 If the value of the number can fit an in UV, it is returned in the *valuep
2906 IS_NUMBER_IN_UV will be set to indicate that *valuep is valid, IS_NUMBER_IN_UV
2907 will never be set unless *valuep is valid, but *valuep may have been assigned
2908 to during processing even though IS_NUMBER_IN_UV is not set on return.
2909 If valuep is NULL, IS_NUMBER_IN_UV will be set for the same cases as when
2910 valuep is non-NULL, but no actual assignment (or SEGV) will occur.
2912 IS_NUMBER_NOT_INT will be set with IS_NUMBER_IN_UV if trailing decimals were
2913 seen (in which case *valuep gives the true value truncated to an integer), and
2914 IS_NUMBER_NEG if the number is negative (in which case *valuep holds the
2915 absolute value). IS_NUMBER_IN_UV is not set if e notation was used or the
2916 number is larger than a UV.
2918 int grok_number(const char *pv, STRLEN len, UV *valuep)
2921 Found in file numeric.c
2923 =item grok_numeric_radix
2924 X<grok_numeric_radix>
2926 Scan and skip for a numeric decimal separator (radix).
2928 bool grok_numeric_radix(const char **sp, const char *send)
2931 Found in file numeric.c
2936 converts a string representing an octal number to numeric form.
2938 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2939 conversion flags, and I<result> should be NULL or a pointer to an NV.
2940 The scan stops at the end of the string, or the first invalid character.
2941 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2942 invalid character will also trigger a warning.
2943 On return I<*len> is set to the length of the scanned string,
2944 and I<*flags> gives output flags.
2946 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2947 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_oct>
2948 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2949 and writes the value to I<*result> (or the value is discarded if I<result>
2952 If C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the octal
2953 number may use '_' characters to separate digits.
2955 UV grok_oct(const char* start, STRLEN* len_p, I32* flags, NV *result)
2958 Found in file numeric.c
2963 Return a non-zero integer if the sign bit on an NV is set, and 0 if
2966 If Configure detects this system has a signbit() that will work with
2967 our NVs, then we just use it via the #define in perl.h. Otherwise,
2968 fall back on this implementation. As a first pass, this gets everything
2969 right except -0.0. Alas, catching -0.0 is the main use for this function,
2970 so this is not too helpful yet. Still, at least we have the scaffolding
2971 in place to support other systems, should that prove useful.
2974 Configure notes: This function is called 'Perl_signbit' instead of a
2975 plain 'signbit' because it is easy to imagine a system having a signbit()
2976 function or macro that doesn't happen to work with our particular choice
2977 of NVs. We shouldn't just re-#define signbit as Perl_signbit and expect
2978 the standard system headers to be happy. Also, this is a no-context
2979 function (no pTHX_) because Perl_signbit() is usually re-#defined in
2980 perl.h as a simple macro call to the system's signbit().
2981 Users should just always call Perl_signbit().
2983 NOTE: this function is experimental and may change or be
2984 removed without notice.
2986 int Perl_signbit(NV f)
2989 Found in file numeric.c
2994 For backwards compatibility. Use C<grok_bin> instead.
2996 NV scan_bin(const char* start, STRLEN len, STRLEN* retlen)
2999 Found in file numeric.c
3004 For backwards compatibility. Use C<grok_hex> instead.
3006 NV scan_hex(const char* start, STRLEN len, STRLEN* retlen)
3009 Found in file numeric.c
3014 For backwards compatibility. Use C<grok_oct> instead.
3016 NV scan_oct(const char* start, STRLEN len, STRLEN* retlen)
3019 Found in file numeric.c
3024 =head1 Optree Manipulation Functions
3031 If C<cv> is a constant sub eligible for inlining. returns the constant
3032 value returned by the sub. Otherwise, returns NULL.
3034 Constant subs can be created with C<newCONSTSUB> or as described in
3035 L<perlsub/"Constant Functions">.
3037 SV* cv_const_sv(CV* cv)
3045 Creates a constant sub equivalent to Perl C<sub FOO () { 123 }> which is
3046 eligible for inlining at compile-time.
3048 CV* newCONSTSUB(HV* stash, const char* name, SV* sv)
3056 Used by C<xsubpp> to hook up XSUBs as Perl subs. I<filename> needs to be
3057 static storage, as it is used directly as CvFILE(), without a copy being made.
3065 =head1 Pad Data Structures
3072 Get the value at offset po in the current pad.
3073 Use macro PAD_SV instead of calling this function directly.
3075 SV* pad_sv(PADOFFSET po)
3083 =head1 Per-Interpreter Variables
3090 C<PL_modglobal> is a general purpose, interpreter global HV for use by
3091 extensions that need to keep information on a per-interpreter basis.
3092 In a pinch, it can also be used as a symbol table for extensions
3093 to share data among each other. It is a good idea to use keys
3094 prefixed by the package name of the extension that owns the data.
3099 Found in file intrpvar.h
3104 A convenience variable which is typically used with C<SvPV> when one
3105 doesn't care about the length of the string. It is usually more efficient
3106 to either declare a local variable and use that instead or to use the
3107 C<SvPV_nolen> macro.
3112 Found in file intrpvar.h
3117 This is the C<false> SV. See C<PL_sv_yes>. Always refer to this as
3123 Found in file intrpvar.h
3128 This is the C<undef> SV. Always refer to this as C<&PL_sv_undef>.
3133 Found in file intrpvar.h
3138 This is the C<true> SV. See C<PL_sv_no>. Always refer to this as
3144 Found in file intrpvar.h
3149 =head1 REGEXP Functions
3156 Convenience macro to get the REGEXP from a SV. This is approximately
3157 equivalent to the following snippet:
3162 (tmpsv = (SV*)SvRV(sv)) &&
3163 SvTYPE(tmpsv) == SVt_PVMG &&
3164 (tmpmg = mg_find(tmpsv, PERL_MAGIC_qr)))
3166 return (REGEXP *)tmpmg->mg_obj;
3169 NULL will be returned if a REGEXP* is not found.
3171 REGEXP * SvRX(SV *sv)
3174 Found in file regexp.h
3179 Returns a boolean indicating whether the SV contains qr magic
3182 If you want to do something with the REGEXP* later use SvRX instead
3188 Found in file regexp.h
3193 =head1 Simple Exception Handling Macros
3200 Set up necessary local variables for exception handling.
3201 See L<perlguts/"Exception Handling">.
3206 Found in file XSUB.h
3211 Introduces a catch block. See L<perlguts/"Exception Handling">.
3214 Found in file XSUB.h
3219 Rethrows a previously caught exception. See L<perlguts/"Exception Handling">.
3224 Found in file XSUB.h
3229 Ends a try block. See L<perlguts/"Exception Handling">.
3232 Found in file XSUB.h
3234 =item XCPT_TRY_START
3237 Starts a try block. See L<perlguts/"Exception Handling">.
3240 Found in file XSUB.h
3245 =head1 Stack Manipulation Macros
3252 Declare a stack marker variable, C<mark>, for the XSUB. See C<MARK> and
3263 Saves the original stack mark for the XSUB. See C<ORIGMARK>.
3273 Declares a local copy of perl's stack pointer for the XSUB, available via
3274 the C<SP> macro. See C<SP>.
3284 Used to extend the argument stack for an XSUB's return values. Once
3285 used, guarantees that there is room for at least C<nitems> to be pushed
3288 void EXTEND(SP, int nitems)
3296 Stack marker variable for the XSUB. See C<dMARK>.
3304 Push an integer onto the stack. The stack must have room for this element.
3305 Does not use C<TARG>. See also C<PUSHi>, C<mXPUSHi> and C<XPUSHi>.
3315 Push a double onto the stack. The stack must have room for this element.
3316 Does not use C<TARG>. See also C<PUSHn>, C<mXPUSHn> and C<XPUSHn>.
3326 Push a string onto the stack. The stack must have room for this element.
3327 The C<len> indicates the length of the string. Does not use C<TARG>.
3328 See also C<PUSHp>, C<mXPUSHp> and C<XPUSHp>.
3330 void mPUSHp(char* str, STRLEN len)
3338 Push an SV onto the stack and mortalizes the SV. The stack must have room
3339 for this element. Does not use C<TARG>. See also C<PUSHs> and C<mXPUSHs>.
3349 Push an unsigned integer onto the stack. The stack must have room for this
3350 element. Does not use C<TARG>. See also C<PUSHu>, C<mXPUSHu> and C<XPUSHu>.
3360 Push an integer onto the stack, extending the stack if necessary.
3361 Does not use C<TARG>. See also C<XPUSHi>, C<mPUSHi> and C<PUSHi>.
3371 Push a double onto the stack, extending the stack if necessary.
3372 Does not use C<TARG>. See also C<XPUSHn>, C<mPUSHn> and C<PUSHn>.
3382 Push a string onto the stack, extending the stack if necessary. The C<len>
3383 indicates the length of the string. Does not use C<TARG>. See also C<XPUSHp>,
3384 C<mPUSHp> and C<PUSHp>.
3386 void mXPUSHp(char* str, STRLEN len)
3394 Push an SV onto the stack, extending the stack if necessary and mortalizes
3395 the SV. Does not use C<TARG>. See also C<XPUSHs> and C<mPUSHs>.
3397 void mXPUSHs(SV* sv)
3405 Push an unsigned integer onto the stack, extending the stack if necessary.
3406 Does not use C<TARG>. See also C<XPUSHu>, C<mPUSHu> and C<PUSHu>.
3416 The original stack mark for the XSUB. See C<dORIGMARK>.
3424 Pops an integer off the stack.
3434 Pops a long off the stack.
3444 Pops a double off the stack.
3454 Pops a string off the stack. Deprecated. New code should use POPpx.
3464 Pops a string off the stack which must consist of bytes i.e. characters < 256.
3474 Pops a string off the stack.
3484 Pops an SV off the stack.
3494 Push an integer onto the stack. The stack must have room for this element.
3495 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3496 called to declare it. Do not call multiple C<TARG>-oriented macros to
3497 return lists from XSUB's - see C<mPUSHi> instead. See also C<XPUSHi> and
3508 Opening bracket for arguments on a callback. See C<PUTBACK> and
3519 Push a new mortal SV onto the stack. The stack must have room for this
3520 element. Does not use C<TARG>. See also C<PUSHs>, C<XPUSHmortal> and C<XPUSHs>.
3530 Push a double onto the stack. The stack must have room for this element.
3531 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3532 called to declare it. Do not call multiple C<TARG>-oriented macros to
3533 return lists from XSUB's - see C<mPUSHn> instead. See also C<XPUSHn> and
3544 Push a string onto the stack. The stack must have room for this element.
3545 The C<len> indicates the length of the string. Handles 'set' magic. Uses
3546 C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to declare it. Do not
3547 call multiple C<TARG>-oriented macros to return lists from XSUB's - see
3548 C<mPUSHp> instead. See also C<XPUSHp> and C<mXPUSHp>.
3550 void PUSHp(char* str, STRLEN len)
3558 Push an SV onto the stack. The stack must have room for this element.
3559 Does not handle 'set' magic. Does not use C<TARG>. See also C<PUSHmortal>,
3560 C<XPUSHs> and C<XPUSHmortal>.
3570 Push an unsigned integer onto the stack. The stack must have room for this
3571 element. Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG>
3572 should be called to declare it. Do not call multiple C<TARG>-oriented
3573 macros to return lists from XSUB's - see C<mPUSHu> instead. See also
3574 C<XPUSHu> and C<mXPUSHu>.
3584 Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
3585 See C<PUSHMARK> and L<perlcall> for other uses.
3595 Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and
3604 Refetch the stack pointer. Used after a callback. See L<perlcall>.
3614 Push an integer onto the stack, extending the stack if necessary. Handles
3615 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
3616 declare it. Do not call multiple C<TARG>-oriented macros to return lists
3617 from XSUB's - see C<mXPUSHi> instead. See also C<PUSHi> and C<mPUSHi>.
3627 Push a new mortal SV onto the stack, extending the stack if necessary.
3628 Does not use C<TARG>. See also C<XPUSHs>, C<PUSHmortal> and C<PUSHs>.
3638 Push a double onto the stack, extending the stack if necessary. Handles
3639 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
3640 declare it. Do not call multiple C<TARG>-oriented macros to return lists
3641 from XSUB's - see C<mXPUSHn> instead. See also C<PUSHn> and C<mPUSHn>.
3651 Push a string onto the stack, extending the stack if necessary. The C<len>
3652 indicates the length of the string. Handles 'set' magic. Uses C<TARG>, so
3653 C<dTARGET> or C<dXSTARG> should be called to declare it. Do not call
3654 multiple C<TARG>-oriented macros to return lists from XSUB's - see
3655 C<mXPUSHp> instead. See also C<PUSHp> and C<mPUSHp>.
3657 void XPUSHp(char* str, STRLEN len)
3665 Push an SV onto the stack, extending the stack if necessary. Does not
3666 handle 'set' magic. Does not use C<TARG>. See also C<XPUSHmortal>,
3667 C<PUSHs> and C<PUSHmortal>.
3677 Push an unsigned integer onto the stack, extending the stack if necessary.
3678 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3679 called to declare it. Do not call multiple C<TARG>-oriented macros to
3680 return lists from XSUB's - see C<mXPUSHu> instead. See also C<PUSHu> and
3691 Return from XSUB, indicating number of items on the stack. This is usually
3692 handled by C<xsubpp>.
3694 void XSRETURN(int nitems)
3697 Found in file XSUB.h
3699 =item XSRETURN_EMPTY
3702 Return an empty list from an XSUB immediately.
3707 Found in file XSUB.h
3712 Return an integer from an XSUB immediately. Uses C<XST_mIV>.
3714 void XSRETURN_IV(IV iv)
3717 Found in file XSUB.h
3722 Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
3727 Found in file XSUB.h
3732 Return a double from an XSUB immediately. Uses C<XST_mNV>.
3734 void XSRETURN_NV(NV nv)
3737 Found in file XSUB.h
3742 Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
3744 void XSRETURN_PV(char* str)
3747 Found in file XSUB.h
3749 =item XSRETURN_UNDEF
3752 Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
3757 Found in file XSUB.h
3762 Return an integer from an XSUB immediately. Uses C<XST_mUV>.
3764 void XSRETURN_UV(IV uv)
3767 Found in file XSUB.h
3772 Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
3777 Found in file XSUB.h
3782 Place an integer into the specified position C<pos> on the stack. The
3783 value is stored in a new mortal SV.
3785 void XST_mIV(int pos, IV iv)
3788 Found in file XSUB.h
3793 Place C<&PL_sv_no> into the specified position C<pos> on the
3796 void XST_mNO(int pos)
3799 Found in file XSUB.h
3804 Place a double into the specified position C<pos> on the stack. The value
3805 is stored in a new mortal SV.
3807 void XST_mNV(int pos, NV nv)
3810 Found in file XSUB.h
3815 Place a copy of a string into the specified position C<pos> on the stack.
3816 The value is stored in a new mortal SV.
3818 void XST_mPV(int pos, char* str)
3821 Found in file XSUB.h
3826 Place C<&PL_sv_undef> into the specified position C<pos> on the
3829 void XST_mUNDEF(int pos)
3832 Found in file XSUB.h
3837 Place C<&PL_sv_yes> into the specified position C<pos> on the
3840 void XST_mYES(int pos)
3843 Found in file XSUB.h
3855 An enum of flags for Perl types. These are found in the file B<sv.h>
3856 in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
3864 Integer type flag for scalars. See C<svtype>.
3872 Double type flag for scalars. See C<svtype>.
3880 Pointer type flag for scalars. See C<svtype>.
3888 Type flag for arrays. See C<svtype>.
3896 Type flag for code refs. See C<svtype>.
3904 Type flag for hashes. See C<svtype>.
3912 Type flag for blessed scalars. See C<svtype>.
3920 =head1 SV Manipulation Functions
3924 =item croak_xs_usage
3927 A specialised variant of C<croak()> for emitting the usage message for xsubs
3929 croak_xs_usage(cv, "eee_yow");
3931 works out the package name and subroutine name from C<cv>, and then calls
3932 C<croak()>. Hence if C<cv> is C<&ouch::awk>, it would call C<croak> as:
3934 Perl_croak(aTHX_ "Usage %s::%s(%s)", "ouch" "awk", "eee_yow");
3936 void croak_xs_usage(const CV *const cv, const char *const params)
3939 Found in file universal.c
3944 Returns the SV of the specified Perl scalar. If C<create> is set and the
3945 Perl variable does not exist then it will be created. If C<create> is not
3946 set and the variable does not exist then NULL is returned.
3948 NOTE: the perl_ form of this function is deprecated.
3950 SV* get_sv(const char* name, I32 create)
3953 Found in file perl.c
3958 Creates an RV wrapper for an SV. The reference count for the original SV is
3961 SV* newRV_inc(SV* sv)
3969 Creates a new SV and copies a string into it. If utf8 is true, calls
3970 C<SvUTF8_on> on the new SV. Implemented as a wrapper around C<newSVpvn_flags>.
3972 SV* newSVpvn_utf8(NULLOK const char* s, STRLEN len, U32 utf8)
3980 Returns the length of the string which is in the SV. See C<SvLEN>.
3982 STRLEN SvCUR(SV* sv)
3990 Set the current length of the string which is in the SV. See C<SvCUR>
3993 void SvCUR_set(SV* sv, STRLEN len)
4001 Returns a pointer to the last character in the string which is in the SV.
4002 See C<SvCUR>. Access the character as *(SvEND(sv)).
4012 Returns true if the SV has get magic or overloading. If either is true then
4013 the scalar is active data, and has the potential to return a new value every
4014 time it is accessed. Hence you must be careful to only read it once per user
4015 logical operation and work with that returned value. If neither is true then
4016 the scalar's value cannot change unless written to.
4018 char* SvGAMAGIC(SV* sv)
4026 Expands the character buffer in the SV so that it has room for the
4027 indicated number of bytes (remember to reserve space for an extra trailing
4028 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
4029 Returns a pointer to the character buffer.
4031 char * SvGROW(SV* sv, STRLEN len)
4039 Returns a U32 value indicating whether the SV contains an integer.
4049 Returns a U32 value indicating whether the SV contains an integer. Checks
4050 the B<private> setting. Use C<SvIOK>.
4060 Returns a boolean indicating whether the SV contains a signed integer.
4062 bool SvIOK_notUV(SV* sv)
4070 Unsets the IV status of an SV.
4072 void SvIOK_off(SV* sv)
4080 Tells an SV that it is an integer.
4082 void SvIOK_on(SV* sv)
4090 Tells an SV that it is an integer and disables all other OK bits.
4092 void SvIOK_only(SV* sv)
4100 Tells and SV that it is an unsigned integer and disables all other OK bits.
4102 void SvIOK_only_UV(SV* sv)
4110 Returns a boolean indicating whether the SV contains an unsigned integer.
4112 bool SvIOK_UV(SV* sv)
4120 Returns a boolean indicating whether the SV is Copy-On-Write. (either shared
4121 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
4124 bool SvIsCOW(SV* sv)
4129 =item SvIsCOW_shared_hash
4130 X<SvIsCOW_shared_hash>
4132 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
4135 bool SvIsCOW_shared_hash(SV* sv)
4143 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
4144 version which guarantees to evaluate sv only once.
4154 Returns the raw value in the SV's IV slot, without checks or conversions.
4155 Only use when you are sure SvIOK is true. See also C<SvIV()>.
4165 Coerces the given SV to an integer and returns it. Guarantees to evaluate
4166 C<sv> only once. Only use this if C<sv> is an expression with side effects,
4167 otherwise use the more efficient C<SvIV>.
4177 Like C<SvIV> but doesn't process magic.
4179 IV SvIV_nomg(SV* sv)
4187 Set the value of the IV pointer in sv to val. It is possible to perform
4188 the same function of this macro with an lvalue assignment to C<SvIVX>.
4189 With future Perls, however, it will be more efficient to use
4190 C<SvIV_set> instead of the lvalue assignment to C<SvIVX>.
4192 void SvIV_set(SV* sv, IV val)
4200 Returns the size of the string buffer in the SV, not including any part
4201 attributable to C<SvOOK>. See C<SvCUR>.
4203 STRLEN SvLEN(SV* sv)
4211 Set the actual length of the string which is in the SV. See C<SvIV_set>.
4213 void SvLEN_set(SV* sv, STRLEN len)
4221 Set the value of the MAGIC pointer in sv to val. See C<SvIV_set>.
4223 void SvMAGIC_set(SV* sv, MAGIC* val)
4231 Returns a U32 value indicating whether the SV contains a number, integer or
4242 Returns a U32 value indicating whether the SV contains a number, integer or
4243 double. Checks the B<private> setting. Use C<SvNIOK>.
4253 Unsets the NV/IV status of an SV.
4255 void SvNIOK_off(SV* sv)
4263 Returns a U32 value indicating whether the SV contains a double.
4273 Returns a U32 value indicating whether the SV contains a double. Checks the
4274 B<private> setting. Use C<SvNOK>.
4284 Unsets the NV status of an SV.
4286 void SvNOK_off(SV* sv)
4294 Tells an SV that it is a double.
4296 void SvNOK_on(SV* sv)
4304 Tells an SV that it is a double and disables all other OK bits.
4306 void SvNOK_only(SV* sv)
4314 Coerce the given SV to a double and return it. See C<SvNVx> for a version
4315 which guarantees to evaluate sv only once.
4325 Returns the raw value in the SV's NV slot, without checks or conversions.
4326 Only use when you are sure SvNOK is true. See also C<SvNV()>.
4336 Coerces the given SV to a double and returns it. Guarantees to evaluate
4337 C<sv> only once. Only use this if C<sv> is an expression with side effects,
4338 otherwise use the more efficient C<SvNV>.
4348 Set the value of the NV pointer in sv to val. See C<SvIV_set>.
4350 void SvNV_set(SV* sv, NV val)
4358 Returns a U32 value indicating whether the value is an SV. It also tells
4359 whether the value is defined or not.
4369 Returns a U32 indicating whether the pointer to the string buffer is offset.
4370 This hack is used internally to speed up removal of characters from the
4371 beginning of a SvPV. When SvOOK is true, then the start of the
4372 allocated string buffer is actually C<SvOOK_offset()> bytes before SvPVX.
4373 This offset used to be stored in SvIVX, but is now stored within the spare
4384 Reads into I<len> the offset from SvPVX back to the true start of the
4385 allocated buffer, which will be non-zero if C<sv_chop> has been used to
4386 efficiently remove characters from start of the buffer. Implemented as a
4387 macro, which takes the address of I<len>, which must be of type C<STRLEN>.
4388 Evaluates I<sv> more than once. Sets I<len> to 0 if C<SvOOK(sv)> is false.
4390 void SvOOK_offset(NN SV*sv, STRLEN len)
4398 Returns a U32 value indicating whether the SV contains a character
4409 Returns a U32 value indicating whether the SV contains a character string.
4410 Checks the B<private> setting. Use C<SvPOK>.
4420 Unsets the PV status of an SV.
4422 void SvPOK_off(SV* sv)
4430 Tells an SV that it is a string.
4432 void SvPOK_on(SV* sv)
4440 Tells an SV that it is a string and disables all other OK bits.
4441 Will also turn off the UTF-8 status.
4443 void SvPOK_only(SV* sv)
4448 =item SvPOK_only_UTF8
4451 Tells an SV that it is a string and disables all other OK bits,
4452 and leaves the UTF-8 status as it was.
4454 void SvPOK_only_UTF8(SV* sv)
4462 Returns a pointer to the string in the SV, or a stringified form of
4463 the SV if the SV does not contain a string. The SV may cache the
4464 stringified version becoming C<SvPOK>. Handles 'get' magic. See also
4465 C<SvPVx> for a version which guarantees to evaluate sv only once.
4467 char* SvPV(SV* sv, STRLEN len)
4475 Like C<SvPV>, but converts sv to byte representation first if necessary.
4477 char* SvPVbyte(SV* sv, STRLEN len)
4485 Like C<SvPV>, but converts sv to byte representation first if necessary.
4486 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
4489 char* SvPVbytex(SV* sv, STRLEN len)
4494 =item SvPVbytex_force
4497 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
4498 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
4501 char* SvPVbytex_force(SV* sv, STRLEN len)
4506 =item SvPVbyte_force
4509 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
4511 char* SvPVbyte_force(SV* sv, STRLEN len)
4516 =item SvPVbyte_nolen
4519 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
4521 char* SvPVbyte_nolen(SV* sv)
4529 Like C<SvPV>, but converts sv to utf8 first if necessary.
4531 char* SvPVutf8(SV* sv, STRLEN len)
4539 Like C<SvPV>, but converts sv to utf8 first if necessary.
4540 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
4543 char* SvPVutf8x(SV* sv, STRLEN len)
4548 =item SvPVutf8x_force
4551 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
4552 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
4555 char* SvPVutf8x_force(SV* sv, STRLEN len)
4560 =item SvPVutf8_force
4563 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
4565 char* SvPVutf8_force(SV* sv, STRLEN len)
4570 =item SvPVutf8_nolen
4573 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
4575 char* SvPVutf8_nolen(SV* sv)
4583 Returns a pointer to the physical string in the SV. The SV must contain a
4594 A version of C<SvPV> which guarantees to evaluate C<sv> only once.
4595 Only use this if C<sv> is an expression with side effects, otherwise use the
4596 more efficient C<SvPVX>.
4598 char* SvPVx(SV* sv, STRLEN len)
4606 Like C<SvPV> but will force the SV into containing just a string
4607 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
4610 char* SvPV_force(SV* sv, STRLEN len)
4615 =item SvPV_force_nomg
4618 Like C<SvPV> but will force the SV into containing just a string
4619 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
4620 directly. Doesn't process magic.
4622 char* SvPV_force_nomg(SV* sv, STRLEN len)
4630 Returns a pointer to the string in the SV, or a stringified form of
4631 the SV if the SV does not contain a string. The SV may cache the
4632 stringified form becoming C<SvPOK>. Handles 'get' magic.
4634 char* SvPV_nolen(SV* sv)
4642 Like C<SvPV> but doesn't process magic.
4644 char* SvPV_nomg(SV* sv, STRLEN len)
4652 Set the value of the PV pointer in sv to val. See C<SvIV_set>.
4654 void SvPV_set(SV* sv, char* val)
4662 Returns the value of the object's reference count.
4664 U32 SvREFCNT(SV* sv)
4672 Decrements the reference count of the given SV.
4674 void SvREFCNT_dec(SV* sv)
4682 Increments the reference count of the given SV.
4684 All of the following SvREFCNT_inc* macros are optimized versions of
4685 SvREFCNT_inc, and can be replaced with SvREFCNT_inc.
4687 SV* SvREFCNT_inc(SV* sv)
4692 =item SvREFCNT_inc_NN
4695 Same as SvREFCNT_inc, but can only be used if you know I<sv>
4696 is not NULL. Since we don't have to check the NULLness, it's faster
4699 SV* SvREFCNT_inc_NN(SV* sv)
4704 =item SvREFCNT_inc_simple
4705 X<SvREFCNT_inc_simple>
4707 Same as SvREFCNT_inc, but can only be used with expressions without side
4708 effects. Since we don't have to store a temporary value, it's faster.
4710 SV* SvREFCNT_inc_simple(SV* sv)
4715 =item SvREFCNT_inc_simple_NN
4716 X<SvREFCNT_inc_simple_NN>
4718 Same as SvREFCNT_inc_simple, but can only be used if you know I<sv>
4719 is not NULL. Since we don't have to check the NULLness, it's faster
4722 SV* SvREFCNT_inc_simple_NN(SV* sv)
4727 =item SvREFCNT_inc_simple_void
4728 X<SvREFCNT_inc_simple_void>
4730 Same as SvREFCNT_inc_simple, but can only be used if you don't need the
4731 return value. The macro doesn't need to return a meaningful value.
4733 void SvREFCNT_inc_simple_void(SV* sv)
4738 =item SvREFCNT_inc_simple_void_NN
4739 X<SvREFCNT_inc_simple_void_NN>
4741 Same as SvREFCNT_inc, but can only be used if you don't need the return
4742 value, and you know that I<sv> is not NULL. The macro doesn't need
4743 to return a meaningful value, or check for NULLness, so it's smaller
4746 void SvREFCNT_inc_simple_void_NN(SV* sv)
4751 =item SvREFCNT_inc_void
4752 X<SvREFCNT_inc_void>
4754 Same as SvREFCNT_inc, but can only be used if you don't need the
4755 return value. The macro doesn't need to return a meaningful value.
4757 void SvREFCNT_inc_void(SV* sv)
4762 =item SvREFCNT_inc_void_NN
4763 X<SvREFCNT_inc_void_NN>
4765 Same as SvREFCNT_inc, but can only be used if you don't need the return
4766 value, and you know that I<sv> is not NULL. The macro doesn't need
4767 to return a meaningful value, or check for NULLness, so it's smaller
4770 void SvREFCNT_inc_void_NN(SV* sv)
4778 Tests if the SV is an RV.
4788 Unsets the RV status of an SV.
4790 void SvROK_off(SV* sv)
4798 Tells an SV that it is an RV.
4800 void SvROK_on(SV* sv)
4808 Dereferences an RV to return the SV.
4818 Set the value of the RV pointer in sv to val. See C<SvIV_set>.
4820 void SvRV_set(SV* sv, SV* val)
4828 Returns the stash of the SV.
4838 Set the value of the STASH pointer in sv to val. See C<SvIV_set>.
4840 void SvSTASH_set(SV* sv, HV* val)
4848 Taints an SV if tainting is enabled.
4850 void SvTAINT(SV* sv)
4858 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
4861 bool SvTAINTED(SV* sv)
4869 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
4870 some of Perl's fundamental security features. XS module authors should not
4871 use this function unless they fully understand all the implications of
4872 unconditionally untainting the value. Untainting should be done in the
4873 standard perl fashion, via a carefully crafted regexp, rather than directly
4874 untainting variables.
4876 void SvTAINTED_off(SV* sv)
4884 Marks an SV as tainted if tainting is enabled.
4886 void SvTAINTED_on(SV* sv)
4894 Returns a boolean indicating whether Perl would evaluate the SV as true or
4895 false, defined or undefined. Does not handle 'get' magic.
4905 Returns the type of the SV. See C<svtype>.
4907 svtype SvTYPE(SV* sv)
4915 Returns a boolean indicating whether the SV contains an unsigned integer.
4925 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
4926 perform the upgrade if necessary. See C<svtype>.
4928 void SvUPGRADE(SV* sv, svtype type)
4936 Returns a U32 value indicating whether the SV contains UTF-8 encoded data.
4937 Call this after SvPV() in case any call to string overloading updates the
4948 Unsets the UTF-8 status of an SV.
4950 void SvUTF8_off(SV *sv)
4958 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
4959 Do not use frivolously.
4961 void SvUTF8_on(SV *sv)
4969 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
4970 for a version which guarantees to evaluate sv only once.
4980 Returns the raw value in the SV's UV slot, without checks or conversions.
4981 Only use when you are sure SvIOK is true. See also C<SvUV()>.
4991 Coerces the given SV to an unsigned integer and returns it. Guarantees to
4992 C<sv> only once. Only use this if C<sv> is an expression with side effects,
4993 otherwise use the more efficient C<SvUV>.
5003 Like C<SvUV> but doesn't process magic.
5005 UV SvUV_nomg(SV* sv)
5013 Set the value of the UV pointer in sv to val. See C<SvIV_set>.
5015 void SvUV_set(SV* sv, UV val)
5023 Returns a boolean indicating whether the SV contains a v-string.
5030 =item sv_catpvn_nomg
5033 Like C<sv_catpvn> but doesn't process magic.
5035 void sv_catpvn_nomg(SV* sv, const char* ptr, STRLEN len)
5043 Like C<sv_catsv> but doesn't process magic.
5045 void sv_catsv_nomg(SV* dsv, SV* ssv)
5050 =item sv_derived_from
5053 Returns a boolean indicating whether the SV is derived from the specified class
5054 I<at the C level>. To check derivation at the Perl level, call C<isa()> as a
5057 bool sv_derived_from(SV* sv, const char *const name)
5060 Found in file universal.c
5065 Returns a boolean indicating whether the SV performs a specific, named role.
5066 The SV can be a Perl object or the name of a Perl class.
5068 bool sv_does(SV* sv, const char *const name)
5071 Found in file universal.c
5073 =item sv_report_used
5076 Dump the contents of all SVs not yet freed. (Debugging aid).
5078 void sv_report_used()
5086 Like C<sv_setsv> but doesn't process magic.
5088 void sv_setsv_nomg(SV* dsv, SV* ssv)
5096 =head1 SV-Body Allocation
5100 =item looks_like_number
5101 X<looks_like_number>
5103 Test if the content of an SV looks like a number (or is a number).
5104 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
5105 non-numeric warning), even if your atof() doesn't grok them.
5107 I32 looks_like_number(SV *const sv)
5115 Creates an RV wrapper for an SV. The reference count for the original
5116 SV is B<not> incremented.
5118 SV* newRV_noinc(SV *const sv)
5126 Creates a new SV. A non-zero C<len> parameter indicates the number of
5127 bytes of preallocated string space the SV should have. An extra byte for a
5128 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
5129 space is allocated.) The reference count for the new SV is set to 1.
5131 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
5132 parameter, I<x>, a debug aid which allowed callers to identify themselves.
5133 This aid has been superseded by a new build option, PERL_MEM_LOG (see
5134 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
5135 modules supporting older perls.
5137 SV* newSV(const STRLEN len)
5145 Creates a new SV from the hash key structure. It will generate scalars that
5146 point to the shared string table where possible. Returns a new (undefined)
5147 SV if the hek is NULL.
5149 SV* newSVhek(const HEK *const hek)
5157 Creates a new SV and copies an integer into it. The reference count for the
5160 SV* newSViv(const IV i)
5168 Creates a new SV and copies a floating point value into it.
5169 The reference count for the SV is set to 1.
5171 SV* newSVnv(const NV n)
5179 Creates a new SV and copies a string into it. The reference count for the
5180 SV is set to 1. If C<len> is zero, Perl will compute the length using
5181 strlen(). For efficiency, consider using C<newSVpvn> instead.
5183 SV* newSVpv(const char *const s, const STRLEN len)
5191 Creates a new SV and initializes it with the string formatted like
5194 SV* newSVpvf(const char *const pat, ...)
5202 Creates a new SV and copies a string into it. The reference count for the
5203 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
5204 string. You are responsible for ensuring that the source string is at least
5205 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
5207 SV* newSVpvn(const char *const s, const STRLEN len)
5212 =item newSVpvn_flags
5215 Creates a new SV and copies a string into it. The reference count for the
5216 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
5217 string. You are responsible for ensuring that the source string is at least
5218 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
5219 Currently the only flag bits accepted are C<SVf_UTF8> and C<SVs_TEMP>.
5220 If C<SVs_TEMP> is set, then C<sv2mortal()> is called on the result before
5221 returning. If C<SVf_UTF8> is set, then it will be set on the new SV.
5222 C<newSVpvn_utf8()> is a convenience wrapper for this function, defined as
5224 #define newSVpvn_utf8(s, len, u) \
5225 newSVpvn_flags((s), (len), (u) ? SVf_UTF8 : 0)
5227 SV* newSVpvn_flags(const char *const s, const STRLEN len, const U32 flags)
5232 =item newSVpvn_share
5235 Creates a new SV with its SvPVX_const pointing to a shared string in the string
5236 table. If the string does not already exist in the table, it is created
5237 first. Turns on READONLY and FAKE. If the C<hash> parameter is non-zero, that
5238 value is used; otherwise the hash is computed. The string's hash can be later
5239 be retrieved from the SV with the C<SvSHARED_HASH()> macro. The idea here is
5240 that as the string table is used for shared hash keys these strings will have
5241 SvPVX_const == HeKEY and hash lookup will avoid string compare.
5243 SV* newSVpvn_share(const char* s, I32 len, U32 hash)
5251 Like C<newSVpvn>, but takes a literal string instead of a string/length pair.
5253 SV* newSVpvs(const char* s)
5256 Found in file handy.h
5258 =item newSVpvs_flags
5261 Like C<newSVpvn_flags>, but takes a literal string instead of a string/length
5264 SV* newSVpvs_flags(const char* s, U32 flags)
5267 Found in file handy.h
5269 =item newSVpvs_share
5272 Like C<newSVpvn_share>, but takes a literal string instead of a string/length
5273 pair and omits the hash parameter.
5275 SV* newSVpvs_share(const char* s)
5278 Found in file handy.h
5283 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
5284 it will be upgraded to one. If C<classname> is non-null then the new SV will
5285 be blessed in the specified package. The new SV is returned and its
5286 reference count is 1.
5288 SV* newSVrv(SV *const rv, const char *const classname)
5296 Creates a new SV which is an exact duplicate of the original SV.
5299 SV* newSVsv(SV *const old)
5307 Creates a new SV and copies an unsigned integer into it.
5308 The reference count for the SV is set to 1.
5310 SV* newSVuv(const UV u)
5318 Creates a new SV, of the type specified. The reference count for the new SV
5321 SV* newSV_type(const svtype type)
5329 This function is only called on magical items, and is only used by
5330 sv_true() or its macro equivalent.
5332 bool sv_2bool(SV *const sv)
5340 Using various gambits, try to get a CV from an SV; in addition, try if
5341 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
5342 The flags in C<lref> are passed to sv_fetchsv.
5344 CV* sv_2cv(SV* sv, HV **const st, GV **const gvp, const I32 lref)
5352 Using various gambits, try to get an IO from an SV: the IO slot if its a
5353 GV; or the recursive result if we're an RV; or the IO slot of the symbol
5354 named after the PV if we're a string.
5356 IO* sv_2io(SV *const sv)
5364 Return the integer value of an SV, doing any necessary string
5365 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
5366 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
5368 IV sv_2iv_flags(SV *const sv, const I32 flags)
5376 Marks an existing SV as mortal. The SV will be destroyed "soon", either
5377 by an explicit call to FREETMPS, or by an implicit call at places such as
5378 statement boundaries. SvTEMP() is turned on which means that the SV's
5379 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
5380 and C<sv_mortalcopy>.
5382 SV* sv_2mortal(SV *const sv)
5390 Return the num value of an SV, doing any necessary string or integer
5391 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
5394 NV sv_2nv(SV *const sv)
5402 Return a pointer to the byte-encoded representation of the SV, and set *lp
5403 to its length. May cause the SV to be downgraded from UTF-8 as a
5406 Usually accessed via the C<SvPVbyte> macro.
5408 char* sv_2pvbyte(SV *const sv, STRLEN *const lp)
5416 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
5417 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
5419 Usually accessed via the C<SvPVutf8> macro.
5421 char* sv_2pvutf8(SV *const sv, STRLEN *const lp)
5429 Returns a pointer to the string value of an SV, and sets *lp to its length.
5430 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
5432 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
5433 usually end up here too.
5435 char* sv_2pv_flags(SV *const sv, STRLEN *const lp, const I32 flags)
5443 Return the unsigned integer value of an SV, doing any necessary string
5444 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
5445 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
5447 UV sv_2uv_flags(SV *const sv, const I32 flags)
5455 Remove any string offset. You should normally use the C<SvOOK_off> macro
5458 int sv_backoff(SV *const sv)
5466 Blesses an SV into a specified package. The SV must be an RV. The package
5467 must be designated by its stash (see C<gv_stashpv()>). The reference count
5468 of the SV is unaffected.
5470 SV* sv_bless(SV *const sv, HV *const stash)
5478 Concatenates the string onto the end of the string which is in the SV.
5479 If the SV has the UTF-8 status set, then the bytes appended should be
5480 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
5482 void sv_catpv(SV *const sv, const char* ptr)
5490 Processes its arguments like C<sprintf> and appends the formatted
5491 output to an SV. If the appended data contains "wide" characters
5492 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
5493 and characters >255 formatted with %c), the original SV might get
5494 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
5495 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
5496 valid UTF-8; if the original SV was bytes, the pattern should be too.
5498 void sv_catpvf(SV *const sv, const char *const pat, ...)
5506 Like C<sv_catpvf>, but also handles 'set' magic.
5508 void sv_catpvf_mg(SV *const sv, const char *const pat, ...)
5516 Concatenates the string onto the end of the string which is in the SV. The
5517 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5518 status set, then the bytes appended should be valid UTF-8.
5519 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
5521 void sv_catpvn(SV *dsv, const char *sstr, STRLEN len)
5526 =item sv_catpvn_flags
5529 Concatenates the string onto the end of the string which is in the SV. The
5530 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5531 status set, then the bytes appended should be valid UTF-8.
5532 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
5533 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
5534 in terms of this function.
5536 void sv_catpvn_flags(SV *const dstr, const char *sstr, const STRLEN len, const I32 flags)
5544 Like C<sv_catpvn>, but takes a literal string instead of a string/length pair.
5546 void sv_catpvs(SV* sv, const char* s)
5549 Found in file handy.h
5554 Like C<sv_catpv>, but also handles 'set' magic.
5556 void sv_catpv_mg(SV *const sv, const char *const ptr)
5564 Concatenates the string from SV C<ssv> onto the end of the string in
5565 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
5566 not 'set' magic. See C<sv_catsv_mg>.
5568 void sv_catsv(SV *dstr, SV *sstr)
5573 =item sv_catsv_flags
5576 Concatenates the string from SV C<ssv> onto the end of the string in
5577 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
5578 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
5579 and C<sv_catsv_nomg> are implemented in terms of this function.
5581 void sv_catsv_flags(SV *const dsv, SV *const ssv, const I32 flags)
5589 Efficient removal of characters from the beginning of the string buffer.
5590 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
5591 the string buffer. The C<ptr> becomes the first character of the adjusted
5592 string. Uses the "OOK hack".
5593 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
5594 refer to the same chunk of data.
5596 void sv_chop(SV *const sv, const char *const ptr)
5604 Clear an SV: call any destructors, free up any memory used by the body,
5605 and free the body itself. The SV's head is I<not> freed, although
5606 its type is set to all 1's so that it won't inadvertently be assumed
5607 to be live during global destruction etc.
5608 This function should only be called when REFCNT is zero. Most of the time
5609 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5612 void sv_clear(SV *const sv)
5620 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5621 string in C<sv1> is less than, equal to, or greater than the string in
5622 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5623 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
5625 I32 sv_cmp(SV *const sv1, SV *const sv2)
5633 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
5634 'use bytes' aware, handles get magic, and will coerce its args to strings
5635 if necessary. See also C<sv_cmp>.
5637 I32 sv_cmp_locale(SV *const sv1, SV *const sv2)
5645 Add Collate Transform magic to an SV if it doesn't already have it.
5647 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
5648 scalar data of the variable, but transformed to such a format that a normal
5649 memory comparison can be used to compare the data according to the locale
5652 char* sv_collxfrm(SV *const sv, STRLEN *const nxp)
5660 Copies a stringified representation of the source SV into the
5661 destination SV. Automatically performs any necessary mg_get and
5662 coercion of numeric values into strings. Guaranteed to preserve
5663 UTF8 flag even from overloaded objects. Similar in nature to
5664 sv_2pv[_flags] but operates directly on an SV instead of just the
5665 string. Mostly uses sv_2pv_flags to do its work, except when that
5666 would lose the UTF-8'ness of the PV.
5668 void sv_copypv(SV *const dsv, SV *const ssv)
5676 Auto-decrement of the value in the SV, doing string to numeric conversion
5677 if necessary. Handles 'get' magic.
5679 void sv_dec(SV *const sv)
5687 Returns a boolean indicating whether the strings in the two SVs are
5688 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5689 coerce its args to strings if necessary.
5691 I32 sv_eq(SV* sv1, SV* sv2)
5696 =item sv_force_normal_flags
5697 X<sv_force_normal_flags>
5699 Undo various types of fakery on an SV: if the PV is a shared string, make
5700 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
5701 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
5702 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
5703 then a copy-on-write scalar drops its PV buffer (if any) and becomes
5704 SvPOK_off rather than making a copy. (Used where this scalar is about to be
5705 set to some other value.) In addition, the C<flags> parameter gets passed to
5706 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
5707 with flags set to 0.
5709 void sv_force_normal_flags(SV *const sv, const U32 flags)
5717 Decrement an SV's reference count, and if it drops to zero, call
5718 C<sv_clear> to invoke destructors and free up any memory used by
5719 the body; finally, deallocate the SV's head itself.
5720 Normally called via a wrapper macro C<SvREFCNT_dec>.
5722 void sv_free(SV *const sv)
5730 Get a line from the filehandle and store it into the SV, optionally
5731 appending to the currently-stored string.
5733 char* sv_gets(SV *const sv, PerlIO *const fp, I32 append)
5741 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
5742 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
5743 Use the C<SvGROW> wrapper instead.
5745 char* sv_grow(SV *const sv, STRLEN newlen)
5753 Auto-increment of the value in the SV, doing string to numeric conversion
5754 if necessary. Handles 'get' magic.
5756 void sv_inc(SV *const sv)
5764 Inserts a string at the specified offset/length within the SV. Similar to
5765 the Perl substr() function. Handles get magic.
5767 void sv_insert(SV *const bigstr, const STRLEN offset, const STRLEN len, const char *const little, const STRLEN littlelen)
5772 =item sv_insert_flags
5775 Same as C<sv_insert>, but the extra C<flags> are passed the C<SvPV_force_flags> that applies to C<bigstr>.
5777 void sv_insert_flags(SV *const bigstr, const STRLEN offset, const STRLEN len, const char *const little, const STRLEN littlelen, const U32 flags)
5785 Returns a boolean indicating whether the SV is blessed into the specified
5786 class. This does not check for subtypes; use C<sv_derived_from> to verify
5787 an inheritance relationship.
5789 int sv_isa(SV* sv, const char *const name)
5797 Returns a boolean indicating whether the SV is an RV pointing to a blessed
5798 object. If the SV is not an RV, or if the object is not blessed, then this
5801 int sv_isobject(SV* sv)
5809 Returns the length of the string in the SV. Handles magic and type
5810 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5812 STRLEN sv_len(SV *const sv)
5820 Returns the number of characters in the string in an SV, counting wide
5821 UTF-8 bytes as a single character. Handles magic and type coercion.
5823 STRLEN sv_len_utf8(SV *const sv)
5831 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
5832 then adds a new magic item of type C<how> to the head of the magic list.
5834 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
5835 handling of the C<name> and C<namlen> arguments.
5837 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
5838 to add more than one instance of the same 'how'.
5840 void sv_magic(SV *const sv, SV *const obj, const int how, const char *const name, const I32 namlen)
5848 Adds magic to an SV, upgrading it if necessary. Applies the
5849 supplied vtable and returns a pointer to the magic added.
5851 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
5852 In particular, you can add magic to SvREADONLY SVs, and add more than
5853 one instance of the same 'how'.
5855 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
5856 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
5857 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
5858 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
5860 (This is now used as a subroutine by C<sv_magic>.)
5862 MAGIC * sv_magicext(SV *const sv, SV *const obj, const int how, const MGVTBL *const vtbl, const char *const name, const I32 namlen)
5870 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
5871 The new SV is marked as mortal. It will be destroyed "soon", either by an
5872 explicit call to FREETMPS, or by an implicit call at places such as
5873 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
5875 SV* sv_mortalcopy(SV *const oldsv)
5883 Creates a new null SV which is mortal. The reference count of the SV is
5884 set to 1. It will be destroyed "soon", either by an explicit call to
5885 FREETMPS, or by an implicit call at places such as statement boundaries.
5886 See also C<sv_mortalcopy> and C<sv_2mortal>.
5896 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5899 SV* sv_newref(SV *const sv)
5907 Converts the value pointed to by offsetp from a count of bytes from the
5908 start of the string, to a count of the equivalent number of UTF-8 chars.
5909 Handles magic and type coercion.
5911 void sv_pos_b2u(SV *const sv, I32 *const offsetp)
5919 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5920 the start of the string, to a count of the equivalent number of bytes; if
5921 lenp is non-zero, it does the same to lenp, but this time starting from
5922 the offset, rather than from the start of the string. Handles magic and
5925 void sv_pos_u2b(SV *const sv, I32 *const offsetp, I32 *const lenp)
5930 =item sv_pvbyten_force
5933 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
5935 char* sv_pvbyten_force(SV *const sv, STRLEN *const lp)
5943 Get a sensible string out of the SV somehow.
5944 A private implementation of the C<SvPV_force> macro for compilers which
5945 can't cope with complex macro expressions. Always use the macro instead.
5947 char* sv_pvn_force(SV* sv, STRLEN* lp)
5952 =item sv_pvn_force_flags
5953 X<sv_pvn_force_flags>
5955 Get a sensible string out of the SV somehow.
5956 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
5957 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
5958 implemented in terms of this function.
5959 You normally want to use the various wrapper macros instead: see
5960 C<SvPV_force> and C<SvPV_force_nomg>
5962 char* sv_pvn_force_flags(SV *const sv, STRLEN *const lp, const I32 flags)
5967 =item sv_pvutf8n_force
5970 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
5972 char* sv_pvutf8n_force(SV *const sv, STRLEN *const lp)
5980 Returns a string describing what the SV is a reference to.
5982 const char* sv_reftype(const SV *const sv, const int ob)
5990 Make the first argument a copy of the second, then delete the original.
5991 The target SV physically takes over ownership of the body of the source SV
5992 and inherits its flags; however, the target keeps any magic it owns,
5993 and any magic in the source is discarded.
5994 Note that this is a rather specialist SV copying operation; most of the
5995 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5997 void sv_replace(SV *const sv, SV *const nsv)
6005 Underlying implementation for the C<reset> Perl function.
6006 Note that the perl-level function is vaguely deprecated.
6008 void sv_reset(const char* s, HV *const stash)
6016 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
6017 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
6018 push a back-reference to this RV onto the array of backreferences
6019 associated with that magic. If the RV is magical, set magic will be
6020 called after the RV is cleared.
6022 SV* sv_rvweaken(SV *const sv)
6030 Copies an integer into the given SV, upgrading first if necessary.
6031 Does not handle 'set' magic. See also C<sv_setiv_mg>.
6033 void sv_setiv(SV *const sv, const IV num)
6041 Like C<sv_setiv>, but also handles 'set' magic.
6043 void sv_setiv_mg(SV *const sv, const IV i)
6051 Copies a double into the given SV, upgrading first if necessary.
6052 Does not handle 'set' magic. See also C<sv_setnv_mg>.
6054 void sv_setnv(SV *const sv, const NV num)
6062 Like C<sv_setnv>, but also handles 'set' magic.
6064 void sv_setnv_mg(SV *const sv, const NV num)
6072 Copies a string into an SV. The string must be null-terminated. Does not
6073 handle 'set' magic. See C<sv_setpv_mg>.
6075 void sv_setpv(SV *const sv, const char *const ptr)
6083 Works like C<sv_catpvf> but copies the text into the SV instead of
6084 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
6086 void sv_setpvf(SV *const sv, const char *const pat, ...)
6094 Like C<sv_setpvf>, but also handles 'set' magic.
6096 void sv_setpvf_mg(SV *const sv, const char *const pat, ...)
6104 Copies an integer into the given SV, also updating its string value.
6105 Does not handle 'set' magic. See C<sv_setpviv_mg>.
6107 void sv_setpviv(SV *const sv, const IV num)
6115 Like C<sv_setpviv>, but also handles 'set' magic.
6117 void sv_setpviv_mg(SV *const sv, const IV iv)
6125 Copies a string into an SV. The C<len> parameter indicates the number of
6126 bytes to be copied. If the C<ptr> argument is NULL the SV will become
6127 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
6129 void sv_setpvn(SV *const sv, const char *const ptr, const STRLEN len)
6137 Like C<sv_setpvn>, but also handles 'set' magic.
6139 void sv_setpvn_mg(SV *const sv, const char *const ptr, const STRLEN len)
6147 Like C<sv_setpvn>, but takes a literal string instead of a string/length pair.
6149 void sv_setpvs(SV* sv, const char* s)
6152 Found in file handy.h
6157 Like C<sv_setpv>, but also handles 'set' magic.
6159 void sv_setpv_mg(SV *const sv, const char *const ptr)
6167 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
6168 argument will be upgraded to an RV. That RV will be modified to point to
6169 the new SV. The C<classname> argument indicates the package for the
6170 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
6171 will have a reference count of 1, and the RV will be returned.
6173 SV* sv_setref_iv(SV *const rv, const char *const classname, const IV iv)
6181 Copies a double into a new SV, optionally blessing the SV. The C<rv>
6182 argument will be upgraded to an RV. That RV will be modified to point to
6183 the new SV. The C<classname> argument indicates the package for the
6184 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
6185 will have a reference count of 1, and the RV will be returned.
6187 SV* sv_setref_nv(SV *const rv, const char *const classname, const NV nv)
6195 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
6196 argument will be upgraded to an RV. That RV will be modified to point to
6197 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
6198 into the SV. The C<classname> argument indicates the package for the
6199 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
6200 will have a reference count of 1, and the RV will be returned.
6202 Do not use with other Perl types such as HV, AV, SV, CV, because those
6203 objects will become corrupted by the pointer copy process.
6205 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
6207 SV* sv_setref_pv(SV *const rv, const char *const classname, void *const pv)
6215 Copies a string into a new SV, optionally blessing the SV. The length of the
6216 string must be specified with C<n>. The C<rv> argument will be upgraded to
6217 an RV. That RV will be modified to point to the new SV. The C<classname>
6218 argument indicates the package for the blessing. Set C<classname> to
6219 C<NULL> to avoid the blessing. The new SV will have a reference count
6220 of 1, and the RV will be returned.
6222 Note that C<sv_setref_pv> copies the pointer while this copies the string.
6224 SV* sv_setref_pvn(SV *const rv, const char *const classname, const char *const pv, const STRLEN n)
6232 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
6233 argument will be upgraded to an RV. That RV will be modified to point to
6234 the new SV. The C<classname> argument indicates the package for the
6235 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
6236 will have a reference count of 1, and the RV will be returned.
6238 SV* sv_setref_uv(SV *const rv, const char *const classname, const UV uv)
6246 Copies the contents of the source SV C<ssv> into the destination SV
6247 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
6248 function if the source SV needs to be reused. Does not handle 'set' magic.
6249 Loosely speaking, it performs a copy-by-value, obliterating any previous
6250 content of the destination.
6252 You probably want to use one of the assortment of wrappers, such as
6253 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
6254 C<SvSetMagicSV_nosteal>.
6256 void sv_setsv(SV *dstr, SV *sstr)
6261 =item sv_setsv_flags
6264 Copies the contents of the source SV C<ssv> into the destination SV
6265 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
6266 function if the source SV needs to be reused. Does not handle 'set' magic.
6267 Loosely speaking, it performs a copy-by-value, obliterating any previous
6268 content of the destination.
6269 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
6270 C<ssv> if appropriate, else not. If the C<flags> parameter has the
6271 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
6272 and C<sv_setsv_nomg> are implemented in terms of this function.
6274 You probably want to use one of the assortment of wrappers, such as
6275 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
6276 C<SvSetMagicSV_nosteal>.
6278 This is the primary function for copying scalars, and most other
6279 copy-ish functions and macros use this underneath.
6281 void sv_setsv_flags(SV *dstr, SV *sstr, const I32 flags)
6289 Like C<sv_setsv>, but also handles 'set' magic.
6291 void sv_setsv_mg(SV *const dstr, SV *const sstr)
6299 Copies an unsigned integer into the given SV, upgrading first if necessary.
6300 Does not handle 'set' magic. See also C<sv_setuv_mg>.
6302 void sv_setuv(SV *const sv, const UV num)
6310 Like C<sv_setuv>, but also handles 'set' magic.
6312 void sv_setuv_mg(SV *const sv, const UV u)
6320 Test an SV for taintedness. Use C<SvTAINTED> instead.
6321 bool sv_tainted(SV *const sv)
6329 Returns true if the SV has a true value by Perl's rules.
6330 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
6331 instead use an in-line version.
6333 I32 sv_true(SV *const sv)
6341 Removes all magic of type C<type> from an SV.
6343 int sv_unmagic(SV *const sv, const int type)
6348 =item sv_unref_flags
6351 Unsets the RV status of the SV, and decrements the reference count of
6352 whatever was being referenced by the RV. This can almost be thought of
6353 as a reversal of C<newSVrv>. The C<cflags> argument can contain
6354 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
6355 (otherwise the decrementing is conditional on the reference count being
6356 different from one or the reference being a readonly SV).
6359 void sv_unref_flags(SV *const ref, const U32 flags)
6367 Untaint an SV. Use C<SvTAINTED_off> instead.
6368 void sv_untaint(SV *const sv)
6376 Upgrade an SV to a more complex form. Generally adds a new body type to the
6377 SV, then copies across as much information as possible from the old body.
6378 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
6380 void sv_upgrade(SV *const sv, svtype new_type)
6385 =item sv_usepvn_flags
6388 Tells an SV to use C<ptr> to find its string value. Normally the
6389 string is stored inside the SV but sv_usepvn allows the SV to use an
6390 outside string. The C<ptr> should point to memory that was allocated
6391 by C<malloc>. The string length, C<len>, must be supplied. By default
6392 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
6393 so that pointer should not be freed or used by the programmer after
6394 giving it to sv_usepvn, and neither should any pointers from "behind"
6395 that pointer (e.g. ptr + 1) be used.
6397 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
6398 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
6399 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
6400 C<len>, and already meets the requirements for storing in C<SvPVX>)
6402 void sv_usepvn_flags(SV *const sv, char* ptr, const STRLEN len, const U32 flags)
6407 =item sv_utf8_decode
6410 If the PV of the SV is an octet sequence in UTF-8
6411 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
6412 so that it looks like a character. If the PV contains only single-byte
6413 characters, the C<SvUTF8> flag stays being off.
6414 Scans PV for validity and returns false if the PV is invalid UTF-8.
6416 NOTE: this function is experimental and may change or be
6417 removed without notice.
6419 bool sv_utf8_decode(SV *const sv)
6424 =item sv_utf8_downgrade
6425 X<sv_utf8_downgrade>
6427 Attempts to convert the PV of an SV from characters to bytes.
6428 If the PV contains a character beyond byte, this conversion will fail;
6429 in this case, either returns false or, if C<fail_ok> is not
6432 This is not as a general purpose Unicode to byte encoding interface:
6433 use the Encode extension for that.
6435 NOTE: this function is experimental and may change or be
6436 removed without notice.
6438 bool sv_utf8_downgrade(SV *const sv, const bool fail_ok)
6443 =item sv_utf8_encode
6446 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
6447 flag off so that it looks like octets again.
6449 void sv_utf8_encode(SV *const sv)
6454 =item sv_utf8_upgrade
6457 Converts the PV of an SV to its UTF-8-encoded form.
6458 Forces the SV to string form if it is not already.
6459 Always sets the SvUTF8 flag to avoid future validity checks even
6460 if all the bytes have hibit clear.
6462 This is not as a general purpose byte encoding to Unicode interface:
6463 use the Encode extension for that.
6465 STRLEN sv_utf8_upgrade(SV *sv)
6470 =item sv_utf8_upgrade_flags
6471 X<sv_utf8_upgrade_flags>
6473 Converts the PV of an SV to its UTF-8-encoded form.
6474 Forces the SV to string form if it is not already.
6475 Always sets the SvUTF8 flag to avoid future validity checks even
6476 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
6477 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
6478 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
6480 This is not as a general purpose byte encoding to Unicode interface:
6481 use the Encode extension for that.
6483 STRLEN sv_utf8_upgrade_flags(SV *const sv, const I32 flags)
6491 Processes its arguments like C<vsprintf> and appends the formatted output
6492 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
6494 Usually used via its frontend C<sv_catpvf>.
6496 void sv_vcatpvf(SV *const sv, const char *const pat, va_list *const args)
6504 Processes its arguments like C<vsprintf> and appends the formatted output
6505 to an SV. Uses an array of SVs if the C style variable argument list is
6506 missing (NULL). When running with taint checks enabled, indicates via
6507 C<maybe_tainted> if results are untrustworthy (often due to the use of
6510 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
6512 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)
6520 Like C<sv_vcatpvf>, but also handles 'set' magic.
6522 Usually used via its frontend C<sv_catpvf_mg>.
6524 void sv_vcatpvf_mg(SV *const sv, const char *const pat, va_list *const args)
6532 Works like C<sv_vcatpvf> but copies the text into the SV instead of
6533 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
6535 Usually used via its frontend C<sv_setpvf>.
6537 void sv_vsetpvf(SV *const sv, const char *const pat, va_list *const args)
6545 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
6548 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
6550 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)
6558 Like C<sv_vsetpvf>, but also handles 'set' magic.
6560 Usually used via its frontend C<sv_setpvf_mg>.
6562 void sv_vsetpvf_mg(SV *const sv, const char *const pat, va_list *const args)
6570 =head1 Unicode Support
6574 =item bytes_from_utf8
6577 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
6578 Unlike C<utf8_to_bytes> but like C<bytes_to_utf8>, returns a pointer to
6579 the newly-created string, and updates C<len> to contain the new
6580 length. Returns the original string if no conversion occurs, C<len>
6581 is unchanged. Do nothing if C<is_utf8> points to 0. Sets C<is_utf8> to
6582 0 if C<s> is converted or contains all 7bit characters.
6584 NOTE: this function is experimental and may change or be
6585 removed without notice.
6587 U8* bytes_from_utf8(const U8 *s, STRLEN *len, bool *is_utf8)
6590 Found in file utf8.c
6595 Converts a string C<s> of length C<len> from ASCII into UTF-8 encoding.
6596 Returns a pointer to the newly-created string, and sets C<len> to
6597 reflect the new length.
6599 If you want to convert to UTF-8 from other encodings than ASCII,
6600 see sv_recode_to_utf8().
6602 NOTE: this function is experimental and may change or be
6603 removed without notice.
6605 U8* bytes_to_utf8(const U8 *s, STRLEN *len)
6608 Found in file utf8.c
6613 Return true if the strings s1 and s2 differ case-insensitively, false
6614 if not (if they are equal case-insensitively). If u1 is true, the
6615 string s1 is assumed to be in UTF-8-encoded Unicode. If u2 is true,
6616 the string s2 is assumed to be in UTF-8-encoded Unicode. If u1 or u2
6617 are false, the respective string is assumed to be in native 8-bit
6620 If the pe1 and pe2 are non-NULL, the scanning pointers will be copied
6621 in there (they will point at the beginning of the I<next> character).
6622 If the pointers behind pe1 or pe2 are non-NULL, they are the end
6623 pointers beyond which scanning will not continue under any
6624 circumstances. If the byte lengths l1 and l2 are non-zero, s1+l1 and
6625 s2+l2 will be used as goal end pointers that will also stop the scan,
6626 and which qualify towards defining a successful match: all the scans
6627 that define an explicit length must reach their goal pointers for
6628 a match to succeed).
6630 For case-insensitiveness, the "casefolding" of Unicode is used
6631 instead of upper/lowercasing both the characters, see
6632 http://www.unicode.org/unicode/reports/tr21/ (Case Mappings).
6634 I32 ibcmp_utf8(const char *s1, char **pe1, UV l1, bool u1, const char *s2, char **pe2, UV l2, bool u2)
6637 Found in file utf8.c
6642 Tests if some arbitrary number of bytes begins in a valid UTF-8
6643 character. Note that an INVARIANT (i.e. ASCII) character is a valid
6644 UTF-8 character. The actual number of bytes in the UTF-8 character
6645 will be returned if it is valid, otherwise 0.
6647 STRLEN is_utf8_char(const U8 *s)
6650 Found in file utf8.c
6652 =item is_utf8_string
6655 Returns true if first C<len> bytes of the given string form a valid
6656 UTF-8 string, false otherwise. Note that 'a valid UTF-8 string' does
6657 not mean 'a string that contains code points above 0x7F encoded in UTF-8'
6658 because a valid ASCII string is a valid UTF-8 string.
6660 See also is_utf8_string_loclen() and is_utf8_string_loc().
6662 bool is_utf8_string(const U8 *s, STRLEN len)
6665 Found in file utf8.c
6667 =item is_utf8_string_loc
6668 X<is_utf8_string_loc>
6670 Like is_utf8_string() but stores the location of the failure (in the
6671 case of "utf8ness failure") or the location s+len (in the case of
6672 "utf8ness success") in the C<ep>.
6674 See also is_utf8_string_loclen() and is_utf8_string().
6676 bool is_utf8_string_loc(const U8 *s, STRLEN len, const U8 **p)
6679 Found in file utf8.c
6681 =item is_utf8_string_loclen
6682 X<is_utf8_string_loclen>
6684 Like is_utf8_string() but stores the location of the failure (in the
6685 case of "utf8ness failure") or the location s+len (in the case of
6686 "utf8ness success") in the C<ep>, and the number of UTF-8
6687 encoded characters in the C<el>.
6689 See also is_utf8_string_loc() and is_utf8_string().
6691 bool is_utf8_string_loclen(const U8 *s, STRLEN len, const U8 **ep, STRLEN *el)
6694 Found in file utf8.c
6696 =item pv_uni_display
6699 Build to the scalar dsv a displayable version of the string spv,
6700 length len, the displayable version being at most pvlim bytes long
6701 (if longer, the rest is truncated and "..." will be appended).
6703 The flags argument can have UNI_DISPLAY_ISPRINT set to display
6704 isPRINT()able characters as themselves, UNI_DISPLAY_BACKSLASH
6705 to display the \\[nrfta\\] as the backslashed versions (like '\n')
6706 (UNI_DISPLAY_BACKSLASH is preferred over UNI_DISPLAY_ISPRINT for \\).
6707 UNI_DISPLAY_QQ (and its alias UNI_DISPLAY_REGEX) have both
6708 UNI_DISPLAY_BACKSLASH and UNI_DISPLAY_ISPRINT turned on.
6710 The pointer to the PV of the dsv is returned.
6712 char* pv_uni_display(SV *dsv, const U8 *spv, STRLEN len, STRLEN pvlim, UV flags)
6715 Found in file utf8.c
6720 The encoding is assumed to be an Encode object, the PV of the ssv is
6721 assumed to be octets in that encoding and decoding the input starts
6722 from the position which (PV + *offset) pointed to. The dsv will be
6723 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
6724 when the string tstr appears in decoding output or the input ends on
6725 the PV of the ssv. The value which the offset points will be modified
6726 to the last input position on the ssv.
6728 Returns TRUE if the terminator was found, else returns FALSE.
6730 bool sv_cat_decode(SV* dsv, SV *encoding, SV *ssv, int *offset, char* tstr, int tlen)
6735 =item sv_recode_to_utf8
6736 X<sv_recode_to_utf8>
6738 The encoding is assumed to be an Encode object, on entry the PV
6739 of the sv is assumed to be octets in that encoding, and the sv
6740 will be converted into Unicode (and UTF-8).
6742 If the sv already is UTF-8 (or if it is not POK), or if the encoding
6743 is not a reference, nothing is done to the sv. If the encoding is not
6744 an C<Encode::XS> Encoding object, bad things will happen.
6745 (See F<lib/encoding.pm> and L<Encode>).
6747 The PV of the sv is returned.
6749 char* sv_recode_to_utf8(SV* sv, SV *encoding)
6754 =item sv_uni_display
6757 Build to the scalar dsv a displayable version of the scalar sv,
6758 the displayable version being at most pvlim bytes long
6759 (if longer, the rest is truncated and "..." will be appended).
6761 The flags argument is as in pv_uni_display().
6763 The pointer to the PV of the dsv is returned.
6765 char* sv_uni_display(SV *dsv, SV *ssv, STRLEN pvlim, UV flags)
6768 Found in file utf8.c
6773 The "p" contains the pointer to the UTF-8 string encoding
6774 the character that is being converted.
6776 The "ustrp" is a pointer to the character buffer to put the
6777 conversion result to. The "lenp" is a pointer to the length
6780 The "swashp" is a pointer to the swash to use.
6782 Both the special and normal mappings are stored lib/unicore/To/Foo.pl,
6783 and loaded by SWASHNEW, using lib/utf8_heavy.pl. The special (usually,
6784 but not always, a multicharacter mapping), is tried first.
6786 The "special" is a string like "utf8::ToSpecLower", which means the
6787 hash %utf8::ToSpecLower. The access to the hash is through
6788 Perl_to_utf8_case().
6790 The "normal" is a string like "ToLower" which means the swash
6793 UV to_utf8_case(const U8 *p, U8* ustrp, STRLEN *lenp, SV **swashp, const char *normal, const char *special)
6796 Found in file utf8.c
6801 Convert the UTF-8 encoded character at p to its foldcase version and
6802 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6803 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6804 foldcase version may be longer than the original character (up to
6807 The first character of the foldcased version is returned
6808 (but note, as explained above, that there may be more.)
6810 UV to_utf8_fold(const U8 *p, U8* ustrp, STRLEN *lenp)
6813 Found in file utf8.c
6818 Convert the UTF-8 encoded character at p to its lowercase version and
6819 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6820 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6821 lowercase version may be longer than the original character.
6823 The first character of the lowercased version is returned
6824 (but note, as explained above, that there may be more.)
6826 UV to_utf8_lower(const U8 *p, U8* ustrp, STRLEN *lenp)
6829 Found in file utf8.c
6834 Convert the UTF-8 encoded character at p to its titlecase version and
6835 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6836 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6837 titlecase version may be longer than the original character.
6839 The first character of the titlecased version is returned
6840 (but note, as explained above, that there may be more.)
6842 UV to_utf8_title(const U8 *p, U8* ustrp, STRLEN *lenp)
6845 Found in file utf8.c
6850 Convert the UTF-8 encoded character at p to its uppercase version and
6851 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6852 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since
6853 the uppercase version may be longer than the original character.
6855 The first character of the uppercased version is returned
6856 (but note, as explained above, that there may be more.)
6858 UV to_utf8_upper(const U8 *p, U8* ustrp, STRLEN *lenp)
6861 Found in file utf8.c
6863 =item utf8n_to_uvchr
6868 Returns the native character value of the first character in the string
6870 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6871 length, in bytes, of that character.
6873 Allows length and flags to be passed to low level routine.
6875 UV utf8n_to_uvchr(const U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags)
6878 Found in file utf8.c
6880 =item utf8n_to_uvuni
6883 Bottom level UTF-8 decode routine.
6884 Returns the Unicode code point value of the first character in the string C<s>
6885 which is assumed to be in UTF-8 encoding and no longer than C<curlen>;
6886 C<retlen> will be set to the length, in bytes, of that character.
6888 If C<s> does not point to a well-formed UTF-8 character, the behaviour
6889 is dependent on the value of C<flags>: if it contains UTF8_CHECK_ONLY,
6890 it is assumed that the caller will raise a warning, and this function
6891 will silently just set C<retlen> to C<-1> and return zero. If the
6892 C<flags> does not contain UTF8_CHECK_ONLY, warnings about
6893 malformations will be given, C<retlen> will be set to the expected
6894 length of the UTF-8 character in bytes, and zero will be returned.
6896 The C<flags> can also contain various flags to allow deviations from
6897 the strict UTF-8 encoding (see F<utf8.h>).
6899 Most code should use utf8_to_uvchr() rather than call this directly.
6901 UV utf8n_to_uvuni(const U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags)
6904 Found in file utf8.c
6909 Returns the number of UTF-8 characters between the UTF-8 pointers C<a>
6912 WARNING: use only if you *know* that the pointers point inside the
6915 IV utf8_distance(const U8 *a, const U8 *b)
6918 Found in file utf8.c
6923 Return the UTF-8 pointer C<s> displaced by C<off> characters, either
6924 forward or backward.
6926 WARNING: do not use the following unless you *know* C<off> is within
6927 the UTF-8 data pointed to by C<s> *and* that on entry C<s> is aligned
6928 on the first byte of character or just after the last byte of a character.
6930 U8* utf8_hop(const U8 *s, I32 off)
6933 Found in file utf8.c
6938 Return the length of the UTF-8 char encoded string C<s> in characters.
6939 Stops at C<e> (inclusive). If C<e E<lt> s> or if the scan would end
6940 up past C<e>, croaks.
6942 STRLEN utf8_length(const U8* s, const U8 *e)
6945 Found in file utf8.c
6950 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
6951 Unlike C<bytes_to_utf8>, this over-writes the original string, and
6952 updates len to contain the new length.
6953 Returns zero on failure, setting C<len> to -1.
6955 If you need a copy of the string, see C<bytes_from_utf8>.
6957 NOTE: this function is experimental and may change or be
6958 removed without notice.
6960 U8* utf8_to_bytes(U8 *s, STRLEN *len)
6963 Found in file utf8.c
6968 Returns the native character value of the first character in the string C<s>
6969 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6970 length, in bytes, of that character.
6972 If C<s> does not point to a well-formed UTF-8 character, zero is
6973 returned and retlen is set, if possible, to -1.
6975 UV utf8_to_uvchr(const U8 *s, STRLEN *retlen)
6978 Found in file utf8.c
6983 Returns the Unicode code point of the first character in the string C<s>
6984 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6985 length, in bytes, of that character.
6987 This function should only be used when returned UV is considered
6988 an index into the Unicode semantic tables (e.g. swashes).
6990 If C<s> does not point to a well-formed UTF-8 character, zero is
6991 returned and retlen is set, if possible, to -1.
6993 UV utf8_to_uvuni(const U8 *s, STRLEN *retlen)
6996 Found in file utf8.c
7001 Adds the UTF-8 representation of the Native codepoint C<uv> to the end
7002 of the string C<d>; C<d> should be have at least C<UTF8_MAXBYTES+1> free
7003 bytes available. The return value is the pointer to the byte after the
7004 end of the new character. In other words,
7006 d = uvchr_to_utf8(d, uv);
7008 is the recommended wide native character-aware way of saying
7012 U8* uvchr_to_utf8(U8 *d, UV uv)
7015 Found in file utf8.c
7017 =item uvuni_to_utf8_flags
7018 X<uvuni_to_utf8_flags>
7020 Adds the UTF-8 representation of the Unicode codepoint C<uv> to the end
7021 of the string C<d>; C<d> should be have at least C<UTF8_MAXBYTES+1> free
7022 bytes available. The return value is the pointer to the byte after the
7023 end of the new character. In other words,
7025 d = uvuni_to_utf8_flags(d, uv, flags);
7029 d = uvuni_to_utf8(d, uv);
7031 (which is equivalent to)
7033 d = uvuni_to_utf8_flags(d, uv, 0);
7035 is the recommended Unicode-aware way of saying
7039 U8* uvuni_to_utf8_flags(U8 *d, UV uv, UV flags)
7042 Found in file utf8.c
7047 =head1 Variables created by C<xsubpp> and C<xsubpp> internal functions
7054 Variable which is setup by C<xsubpp> to indicate the stack base offset,
7055 used by the C<ST>, C<XSprePUSH> and C<XSRETURN> macros. The C<dMARK> macro
7056 must be called prior to setup the C<MARK> variable.
7061 Found in file XSUB.h
7066 Variable which is setup by C<xsubpp> to indicate the
7067 class name for a C++ XS constructor. This is always a C<char*>. See C<THIS>.
7072 Found in file XSUB.h
7077 Sets up the C<ax> variable.
7078 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
7083 Found in file XSUB.h
7088 Sets up the C<ax> variable and stack marker variable C<mark>.
7089 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
7094 Found in file XSUB.h
7099 Sets up the C<items> variable.
7100 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
7105 Found in file XSUB.h
7110 Sets up the C<padoff_du> variable for an XSUB that wishes to use
7116 Found in file XSUB.h
7121 Sets up stack and mark pointers for an XSUB, calling dSP and dMARK.
7122 Sets up the C<ax> and C<items> variables by calling C<dAX> and C<dITEMS>.
7123 This is usually handled automatically by C<xsubpp>.
7128 Found in file XSUB.h
7133 Sets up the C<ix> variable for an XSUB which has aliases. This is usually
7134 handled automatically by C<xsubpp>.
7139 Found in file XSUB.h
7144 Variable which is setup by C<xsubpp> to indicate the number of
7145 items on the stack. See L<perlxs/"Variable-length Parameter Lists">.
7150 Found in file XSUB.h
7155 Variable which is setup by C<xsubpp> to indicate which of an
7156 XSUB's aliases was used to invoke it. See L<perlxs/"The ALIAS: Keyword">.
7161 Found in file XSUB.h
7166 Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
7170 Found in file XSUB.h
7175 Variable which is setup by C<xsubpp> to hold the return value for an
7176 XSUB. This is always the proper type for the XSUB. See
7177 L<perlxs/"The RETVAL Variable">.
7182 Found in file XSUB.h
7187 Used to access elements on the XSUB's stack.
7192 Found in file XSUB.h
7197 Variable which is setup by C<xsubpp> to designate the object in a C++
7198 XSUB. This is always the proper type for the C++ object. See C<CLASS> and
7199 L<perlxs/"Using XS With C++">.
7204 Found in file XSUB.h
7209 The SV* corresponding to the $_ variable. Works even if there
7210 is a lexical $_ in scope.
7213 Found in file XSUB.h
7218 Macro to declare an XSUB and its C parameter list. This is handled by
7222 Found in file XSUB.h
7227 The version identifier for an XS module. This is usually
7228 handled automatically by C<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>.
7231 Found in file XSUB.h
7233 =item XS_VERSION_BOOTCHECK
7234 X<XS_VERSION_BOOTCHECK>
7236 Macro to verify that a PM module's $VERSION variable matches the XS
7237 module's C<XS_VERSION> variable. This is usually handled automatically by
7238 C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">.
7240 XS_VERSION_BOOTCHECK;
7243 Found in file XSUB.h
7248 =head1 Warning and Dieing
7255 This is the XSUB-writer's interface to Perl's C<die> function.
7256 Normally call this function the same way you call the C C<printf>
7257 function. Calling C<croak> returns control directly to Perl,
7258 sidestepping the normal C order of execution. See C<warn>.
7260 If you want to throw an exception object, assign the object to
7261 C<$@> and then pass C<NULL> to croak():
7263 errsv = get_sv("@", TRUE);
7264 sv_setsv(errsv, exception_object);
7267 void croak(const char* pat, ...)
7270 Found in file util.c
7275 This is the XSUB-writer's interface to Perl's C<warn> function. Call this
7276 function the same way you call the C C<printf> function. See C<croak>.
7278 void warn(const char* pat, ...)
7281 Found in file util.c
7288 Until May 1997, this document was maintained by Jeff Okamoto
7289 <okamoto@corp.hp.com>. It is now maintained as part of Perl itself.
7291 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
7292 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
7293 Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
7294 Stephen McCamant, and Gurusamy Sarathy.
7296 API Listing originally by Dean Roehrich <roehrich@cray.com>.
7298 Updated to be autogenerated from comments in the source by Benjamin Stuhl.
7302 perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
projects / p5sagit/p5-mst-13.2.git / blob