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
821 pv_escape(dsv,pv,cur,pvlim,PERL_PV_ESCAPE_QUOTE);
823 except that an additional "\0" will be appended to the string when
824 len > cur and pv[cur] is "\0".
826 Note that the final string may be up to 7 chars longer than pvlim.
828 char* pv_display(SV *dsv, const char *pv, STRLEN cur, STRLEN len, STRLEN pvlim)
836 Escapes at most the first "count" chars of pv and puts the results into
837 dsv such that the size of the escaped string will not exceed "max" chars
838 and will not contain any incomplete escape sequences.
840 If flags contains PERL_PV_ESCAPE_QUOTE then any double quotes in the string
841 will also be escaped.
843 Normally the SV will be cleared before the escaped string is prepared,
844 but when PERL_PV_ESCAPE_NOCLEAR is set this will not occur.
846 If PERL_PV_ESCAPE_UNI is set then the input string is treated as Unicode,
847 if PERL_PV_ESCAPE_UNI_DETECT is set then the input string is scanned
848 using C<is_utf8_string()> to determine if it is Unicode.
850 If PERL_PV_ESCAPE_ALL is set then all input chars will be output
851 using C<\x01F1> style escapes, otherwise only chars above 255 will be
852 escaped using this style, other non printable chars will use octal or
853 common escaped patterns like C<\n>. If PERL_PV_ESCAPE_NOBACKSLASH
854 then all chars below 255 will be treated as printable and
855 will be output as literals.
857 If PERL_PV_ESCAPE_FIRSTCHAR is set then only the first char of the
858 string will be escaped, regardles of max. If the string is utf8 and
859 the chars value is >255 then it will be returned as a plain hex
860 sequence. Thus the output will either be a single char,
861 an octal escape sequence, a special escape like C<\n> or a 3 or
862 more digit hex value.
864 If PERL_PV_ESCAPE_RE is set then the escape char used will be a '%' and
865 not a '\\'. This is because regexes very often contain backslashed
866 sequences, whereas '%' is not a particularly common character in patterns.
868 Returns a pointer to the escaped text as held by dsv.
870 char* pv_escape(SV *dsv, char const * const str, const STRLEN count, const STRLEN max, STRLEN * const escaped, const U32 flags)
878 Converts a string into something presentable, handling escaping via
879 pv_escape() and supporting quoting and ellipses.
881 If the PERL_PV_PRETTY_QUOTE flag is set then the result will be
882 double quoted with any double quotes in the string escaped. Otherwise
883 if the PERL_PV_PRETTY_LTGT flag is set then the result be wrapped in
886 If the PERL_PV_PRETTY_ELLIPSES flag is set and not all characters in
887 string were output then an ellipsis C<...> will be appended to the
888 string. Note that this happens AFTER it has been quoted.
890 If start_color is non-null then it will be inserted after the opening
891 quote (if there is one) but before the escaped text. If end_color
892 is non-null then it will be inserted after the escaped text but before
893 any quotes or ellipses.
895 Returns a pointer to the prettified text as held by dsv.
897 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)
905 =head1 Functions in file mathoms.c
913 See L<gv_fetchmethod_autoload>.
915 GV* gv_fetchmethod(HV* stash, const char* name)
918 Found in file mathoms.c
923 The engine implementing pack() Perl function. Note: parameters next_in_list and
924 flags are not used. This call should not be used; use packlist instead.
926 void pack_cat(SV *cat, const char *pat, const char *patend, SV **beglist, SV **endlist, SV ***next_in_list, U32 flags)
929 Found in file mathoms.c
931 =item sv_2pvbyte_nolen
934 Return a pointer to the byte-encoded representation of the SV.
935 May cause the SV to be downgraded from UTF-8 as a side-effect.
937 Usually accessed via the C<SvPVbyte_nolen> macro.
939 char* sv_2pvbyte_nolen(SV* sv)
942 Found in file mathoms.c
944 =item sv_2pvutf8_nolen
947 Return a pointer to the UTF-8-encoded representation of the SV.
948 May cause the SV to be upgraded to UTF-8 as a side-effect.
950 Usually accessed via the C<SvPVutf8_nolen> macro.
952 char* sv_2pvutf8_nolen(SV* sv)
955 Found in file mathoms.c
960 Like C<sv_2pv()>, but doesn't return the length too. You should usually
961 use the macro wrapper C<SvPV_nolen(sv)> instead.
962 char* sv_2pv_nolen(SV* sv)
965 Found in file mathoms.c
970 Like C<sv_catpvn>, but also handles 'set' magic.
972 void sv_catpvn_mg(SV *sv, const char *ptr, STRLEN len)
975 Found in file mathoms.c
980 Like C<sv_catsv>, but also handles 'set' magic.
982 void sv_catsv_mg(SV *dsv, SV *ssv)
985 Found in file mathoms.c
987 =item sv_force_normal
990 Undo various types of fakery on an SV: if the PV is a shared string, make
991 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
992 an xpvmg. See also C<sv_force_normal_flags>.
994 void sv_force_normal(SV *sv)
997 Found in file mathoms.c
1002 A private implementation of the C<SvIVx> macro for compilers which can't
1003 cope with complex macro expressions. Always use the macro instead.
1008 Found in file mathoms.c
1013 Dummy routine which "locks" an SV when there is no locking module present.
1014 Exists to avoid test for a NULL function pointer and because it could
1015 potentially warn under some level of strict-ness.
1017 "Superseded" by sv_nosharing().
1019 void sv_nolocking(SV *sv)
1022 Found in file mathoms.c
1024 =item sv_nounlocking
1027 Dummy routine which "unlocks" an SV when there is no locking module present.
1028 Exists to avoid test for a NULL function pointer and because it could
1029 potentially warn under some level of strict-ness.
1031 "Superseded" by sv_nosharing().
1033 void sv_nounlocking(SV *sv)
1036 Found in file mathoms.c
1041 A private implementation of the C<SvNVx> macro for compilers which can't
1042 cope with complex macro expressions. Always use the macro instead.
1047 Found in file mathoms.c
1052 Use the C<SvPV_nolen> macro instead
1057 Found in file mathoms.c
1062 Use C<SvPVbyte_nolen> instead.
1064 char* sv_pvbyte(SV *sv)
1067 Found in file mathoms.c
1072 A private implementation of the C<SvPVbyte> macro for compilers
1073 which can't cope with complex macro expressions. Always use the macro
1076 char* sv_pvbyten(SV *sv, STRLEN *lp)
1079 Found in file mathoms.c
1084 A private implementation of the C<SvPV> macro for compilers which can't
1085 cope with complex macro expressions. Always use the macro instead.
1087 char* sv_pvn(SV *sv, STRLEN *lp)
1090 Found in file mathoms.c
1095 Use the C<SvPVutf8_nolen> macro instead
1097 char* sv_pvutf8(SV *sv)
1100 Found in file mathoms.c
1105 A private implementation of the C<SvPVutf8> macro for compilers
1106 which can't cope with complex macro expressions. Always use the macro
1109 char* sv_pvutf8n(SV *sv, STRLEN *lp)
1112 Found in file mathoms.c
1117 Taint an SV. Use C<SvTAINTED_on> instead.
1118 void sv_taint(SV* sv)
1121 Found in file mathoms.c
1126 Unsets the RV status of the SV, and decrements the reference count of
1127 whatever was being referenced by the RV. This can almost be thought of
1128 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
1129 being zero. See C<SvROK_off>.
1131 void sv_unref(SV* sv)
1134 Found in file mathoms.c
1139 Tells an SV to use C<ptr> to find its string value. Implemented by
1140 calling C<sv_usepvn_flags> with C<flags> of 0, hence does not handle 'set'
1141 magic. See C<sv_usepvn_flags>.
1143 void sv_usepvn(SV* sv, char* ptr, STRLEN len)
1146 Found in file mathoms.c
1151 Like C<sv_usepvn>, but also handles 'set' magic.
1153 void sv_usepvn_mg(SV *sv, char *ptr, STRLEN len)
1156 Found in file mathoms.c
1161 A private implementation of the C<SvUVx> macro for compilers which can't
1162 cope with complex macro expressions. Always use the macro instead.
1167 Found in file mathoms.c
1172 The engine implementing unpack() Perl function. Note: parameters strbeg, new_s
1173 and ocnt are not used. This call should not be used, use unpackstring instead.
1175 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)
1178 Found in file mathoms.c
1183 =head1 Functions in file pp_ctl.c
1191 Locate the CV corresponding to the currently executing sub or eval.
1192 If db_seqp is non_null, skip CVs that are in the DB package and populate
1193 *db_seqp with the cop sequence number at the point that the DB:: code was
1194 entered. (allows debuggers to eval in the scope of the breakpoint rather
1195 than in the scope of the debugger itself).
1197 CV* find_runcv(U32 *db_seqp)
1200 Found in file pp_ctl.c
1205 =head1 Functions in file pp_pack.c
1213 The engine implementing pack() Perl function.
1215 void packlist(SV *cat, const char *pat, const char *patend, SV **beglist, SV **endlist)
1218 Found in file pp_pack.c
1223 The engine implementing unpack() Perl function. C<unpackstring> puts the
1224 extracted list items on the stack and returns the number of elements.
1225 Issue C<PUTBACK> before and C<SPAGAIN> after the call to this function.
1227 I32 unpackstring(const char *pat, const char *patend, const char *s, const char *strend, U32 flags)
1230 Found in file pp_pack.c
1242 Return the SV from the GV.
1252 If C<gv> is a typeglob whose subroutine entry is a constant sub eligible for
1253 inlining, or C<gv> is a placeholder reference that would be promoted to such
1254 a typeglob, then returns the value returned by the sub. Otherwise, returns
1257 SV* gv_const_sv(GV* gv)
1265 Returns the glob with the given C<name> and a defined subroutine or
1266 C<NULL>. The glob lives in the given C<stash>, or in the stashes
1267 accessible via @ISA and UNIVERSAL::.
1269 The argument C<level> should be either 0 or -1. If C<level==0>, as a
1270 side-effect creates a glob with the given C<name> in the given C<stash>
1271 which in the case of success contains an alias for the subroutine, and sets
1272 up caching info for this glob.
1274 This function grants C<"SUPER"> token as a postfix of the stash name. The
1275 GV returned from C<gv_fetchmeth> may be a method cache entry, which is not
1276 visible to Perl code. So when calling C<call_sv>, you should not use
1277 the GV directly; instead, you should use the method's CV, which can be
1278 obtained from the GV with the C<GvCV> macro.
1280 GV* gv_fetchmeth(HV* stash, const char* name, STRLEN len, I32 level)
1285 =item gv_fetchmethod_autoload
1286 X<gv_fetchmethod_autoload>
1288 Returns the glob which contains the subroutine to call to invoke the method
1289 on the C<stash>. In fact in the presence of autoloading this may be the
1290 glob for "AUTOLOAD". In this case the corresponding variable $AUTOLOAD is
1293 The third parameter of C<gv_fetchmethod_autoload> determines whether
1294 AUTOLOAD lookup is performed if the given method is not present: non-zero
1295 means yes, look for AUTOLOAD; zero means no, don't look for AUTOLOAD.
1296 Calling C<gv_fetchmethod> is equivalent to calling C<gv_fetchmethod_autoload>
1297 with a non-zero C<autoload> parameter.
1299 These functions grant C<"SUPER"> token as a prefix of the method name. Note
1300 that if you want to keep the returned glob for a long time, you need to
1301 check for it being "AUTOLOAD", since at the later time the call may load a
1302 different subroutine due to $AUTOLOAD changing its value. Use the glob
1303 created via a side effect to do this.
1305 These functions have the same side-effects and as C<gv_fetchmeth> with
1306 C<level==0>. C<name> should be writable if contains C<':'> or C<'
1307 ''>. The warning against passing the GV returned by C<gv_fetchmeth> to
1308 C<call_sv> apply equally to these functions.
1310 GV* gv_fetchmethod_autoload(HV* stash, const char* name, I32 autoload)
1315 =item gv_fetchmeth_autoload
1316 X<gv_fetchmeth_autoload>
1318 Same as gv_fetchmeth(), but looks for autoloaded subroutines too.
1319 Returns a glob for the subroutine.
1321 For an autoloaded subroutine without a GV, will create a GV even
1322 if C<level < 0>. For an autoloaded subroutine without a stub, GvCV()
1323 of the result may be zero.
1325 GV* gv_fetchmeth_autoload(HV* stash, const char* name, STRLEN len, I32 level)
1333 Returns a pointer to the stash for a specified package. Uses C<strlen> to
1334 determine the length of C<name>, then calls C<gv_stashpvn()>.
1336 HV* gv_stashpv(const char* name, I32 flags)
1344 Returns a pointer to the stash for a specified package. The C<namelen>
1345 parameter indicates the length of the C<name>, in bytes. C<flags> is passed
1346 to C<gv_fetchpvn_flags()>, so if set to C<GV_ADD> then the package will be
1347 created if it does not already exist. If the package does not exist and
1348 C<flags> is 0 (or any other setting that does not create packages) then NULL
1352 HV* gv_stashpvn(const char* name, U32 namelen, I32 flags)
1360 Like C<gv_stashpvn>, but takes a literal string instead of a string/length pair.
1362 HV* gv_stashpvs(const char* name, I32 create)
1365 Found in file handy.h
1370 Returns a pointer to the stash for a specified package. See C<gv_stashpvn>.
1372 HV* gv_stashsv(SV* sv, I32 flags)
1389 (deprecated - use C<(AV *)NULL> instead)
1397 Null character pointer. (No longer available when C<PERL_CORE> is defined.)
1400 Found in file handy.h
1407 (deprecated - use C<(CV *)NULL> instead)
1417 (deprecated - use C<(HV *)NULL> instead)
1425 Null SV pointer. (No longer available when C<PERL_CORE> is defined.)
1428 Found in file handy.h
1433 =head1 Hash Manipulation Functions
1440 Returns the HV of the specified Perl hash. If C<create> is set and the
1441 Perl variable does not exist then it will be created. If C<create> is not
1442 set and the variable does not exist then NULL is returned.
1444 NOTE: the perl_ form of this function is deprecated.
1446 HV* get_hv(const char* name, I32 create)
1449 Found in file perl.c
1454 This flag, used in the length slot of hash entries and magic structures,
1455 specifies the structure contains an C<SV*> pointer where a C<char*> pointer
1456 is to be expected. (For information only--not to be used).
1464 Returns the computed hash stored in the hash entry.
1474 Returns the actual pointer stored in the key slot of the hash entry. The
1475 pointer may be either C<char*> or C<SV*>, depending on the value of
1476 C<HeKLEN()>. Can be assigned to. The C<HePV()> or C<HeSVKEY()> macros are
1477 usually preferable for finding the value of a key.
1487 If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry
1488 holds an C<SV*> key. Otherwise, holds the actual length of the key. Can
1489 be assigned to. The C<HePV()> macro is usually preferable for finding key
1492 STRLEN HeKLEN(HE* he)
1500 Returns the key slot of the hash entry as a C<char*> value, doing any
1501 necessary dereferencing of possibly C<SV*> keys. The length of the string
1502 is placed in C<len> (this is a macro, so do I<not> use C<&len>). If you do
1503 not care about what the length of the key is, you may use the global
1504 variable C<PL_na>, though this is rather less efficient than using a local
1505 variable. Remember though, that hash keys in perl are free to contain
1506 embedded nulls, so using C<strlen()> or similar is not a good way to find
1507 the length of hash keys. This is very similar to the C<SvPV()> macro
1508 described elsewhere in this document. See also C<HeUTF8>.
1510 If you are using C<HePV> to get values to pass to C<newSVpvn()> to create a
1511 new SV, you should consider using C<newSVhek(HeKEY_hek(he))> as it is more
1514 char* HePV(HE* he, STRLEN len)
1522 Returns the key as an C<SV*>, or C<NULL> if the hash entry does not
1523 contain an C<SV*> key.
1533 Returns the key as an C<SV*>. Will create and return a temporary mortal
1534 C<SV*> if the hash entry contains only a C<char*> key.
1536 SV* HeSVKEY_force(HE* he)
1544 Sets the key to a given C<SV*>, taking care to set the appropriate flags to
1545 indicate the presence of an C<SV*> key, and returns the same
1548 SV* HeSVKEY_set(HE* he, SV* sv)
1556 Returns whether the C<char *> value returned by C<HePV> is encoded in UTF-8,
1557 doing any necessary dereferencing of possibly C<SV*> keys. The value returned
1558 will be 0 or non-0, not necessarily 1 (or even a value with any low bits set),
1559 so B<do not> blindly assign this to a C<bool> variable, as C<bool> may be a
1560 typedef for C<char>.
1562 char* HeUTF8(HE* he, STRLEN len)
1570 Returns the value slot (type C<SV*>) stored in the hash entry.
1580 Returns the package name of a stash, or NULL if C<stash> isn't a stash.
1581 See C<SvSTASH>, C<CvSTASH>.
1583 char* HvNAME(HV* stash)
1591 Check that a hash is in an internally consistent state.
1593 void hv_assert(HV *hv)
1601 Clears a hash, making it empty.
1603 void hv_clear(HV *hv)
1608 =item hv_clear_placeholders
1609 X<hv_clear_placeholders>
1611 Clears any placeholders from a hash. If a restricted hash has any of its keys
1612 marked as readonly and the key is subsequently deleted, the key is not actually
1613 deleted but is marked by assigning it a value of &PL_sv_placeholder. This tags
1614 it so it will be ignored by future operations such as iterating over the hash,
1615 but will still allow the hash to have a value reassigned to the key at some
1616 future point. This function clears any such placeholder keys from the hash.
1617 See Hash::Util::lock_keys() for an example of its use.
1619 void hv_clear_placeholders(HV *hv)
1627 Deletes a key/value pair in the hash. The value SV is removed from the
1628 hash and returned to the caller. The C<klen> is the length of the key.
1629 The C<flags> value will normally be zero; if set to G_DISCARD then NULL
1632 SV* hv_delete(HV *hv, const char *key, I32 klen, I32 flags)
1640 Deletes a key/value pair in the hash. The value SV is removed from the
1641 hash and returned to the caller. The C<flags> value will normally be zero;
1642 if set to G_DISCARD then NULL will be returned. C<hash> can be a valid
1643 precomputed hash value, or 0 to ask for it to be computed.
1645 SV* hv_delete_ent(HV *hv, SV *keysv, I32 flags, U32 hash)
1653 Returns a boolean indicating whether the specified hash key exists. The
1654 C<klen> is the length of the key.
1656 bool hv_exists(HV *hv, const char *key, I32 klen)
1664 Returns a boolean indicating whether the specified hash key exists. C<hash>
1665 can be a valid precomputed hash value, or 0 to ask for it to be
1668 bool hv_exists_ent(HV *hv, SV *keysv, U32 hash)
1676 Returns the SV which corresponds to the specified key in the hash. The
1677 C<klen> is the length of the key. If C<lval> is set then the fetch will be
1678 part of a store. Check that the return value is non-null before
1679 dereferencing it to an C<SV*>.
1681 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1682 information on how to use this function on tied hashes.
1684 SV** hv_fetch(HV *hv, const char *key, I32 klen, I32 lval)
1692 Like C<hv_fetch>, but takes a literal string instead of a string/length pair.
1694 SV** hv_fetchs(HV* tb, const char* key, I32 lval)
1697 Found in file handy.h
1702 Returns the hash entry which corresponds to the specified key in the hash.
1703 C<hash> must be a valid precomputed hash number for the given C<key>, or 0
1704 if you want the function to compute it. IF C<lval> is set then the fetch
1705 will be part of a store. Make sure the return value is non-null before
1706 accessing it. The return value when C<tb> is a tied hash is a pointer to a
1707 static location, so be sure to make a copy of the structure if you need to
1710 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1711 information on how to use this function on tied hashes.
1713 HE* hv_fetch_ent(HV *hv, SV *keysv, I32 lval, U32 hash)
1721 Prepares a starting point to traverse a hash table. Returns the number of
1722 keys in the hash (i.e. the same as C<HvKEYS(tb)>). The return value is
1723 currently only meaningful for hashes without tie magic.
1725 NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
1726 hash buckets that happen to be in use. If you still need that esoteric
1727 value, you can get it through the macro C<HvFILL(tb)>.
1730 I32 hv_iterinit(HV *hv)
1738 Returns the key from the current position of the hash iterator. See
1741 char* hv_iterkey(HE* entry, I32* retlen)
1749 Returns the key as an C<SV*> from the current position of the hash
1750 iterator. The return value will always be a mortal copy of the key. Also
1753 SV* hv_iterkeysv(HE* entry)
1761 Returns entries from a hash iterator. See C<hv_iterinit>.
1763 You may call C<hv_delete> or C<hv_delete_ent> on the hash entry that the
1764 iterator currently points to, without losing your place or invalidating your
1765 iterator. Note that in this case the current entry is deleted from the hash
1766 with your iterator holding the last reference to it. Your iterator is flagged
1767 to free the entry on the next call to C<hv_iternext>, so you must not discard
1768 your iterator immediately else the entry will leak - call C<hv_iternext> to
1769 trigger the resource deallocation.
1771 HE* hv_iternext(HV *hv)
1779 Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
1782 SV* hv_iternextsv(HV *hv, char **key, I32 *retlen)
1787 =item hv_iternext_flags
1788 X<hv_iternext_flags>
1790 Returns entries from a hash iterator. See C<hv_iterinit> and C<hv_iternext>.
1791 The C<flags> value will normally be zero; if HV_ITERNEXT_WANTPLACEHOLDERS is
1792 set the placeholders keys (for restricted hashes) will be returned in addition
1793 to normal keys. By default placeholders are automatically skipped over.
1794 Currently a placeholder is implemented with a value that is
1795 C<&Perl_sv_placeholder>. Note that the implementation of placeholders and
1796 restricted hashes may change, and the implementation currently is
1797 insufficiently abstracted for any change to be tidy.
1799 NOTE: this function is experimental and may change or be
1800 removed without notice.
1802 HE* hv_iternext_flags(HV *hv, I32 flags)
1810 Returns the value from the current position of the hash iterator. See
1813 SV* hv_iterval(HV *hv, HE *entry)
1821 Adds magic to a hash. See C<sv_magic>.
1823 void hv_magic(HV *hv, GV *gv, int how)
1831 Evaluates the hash in scalar context and returns the result. Handles magic when the hash is tied.
1833 SV* hv_scalar(HV *hv)
1841 Stores an SV in a hash. The hash key is specified as C<key> and C<klen> is
1842 the length of the key. The C<hash> parameter is the precomputed hash
1843 value; if it is zero then Perl will compute it. The return value will be
1844 NULL if the operation failed or if the value did not need to be actually
1845 stored within the hash (as in the case of tied hashes). Otherwise it can
1846 be dereferenced to get the original C<SV*>. Note that the caller is
1847 responsible for suitably incrementing the reference count of C<val> before
1848 the call, and decrementing it if the function returned NULL. Effectively
1849 a successful hv_store takes ownership of one reference to C<val>. This is
1850 usually what you want; a newly created SV has a reference count of one, so
1851 if all your code does is create SVs then store them in a hash, hv_store
1852 will own the only reference to the new SV, and your code doesn't need to do
1853 anything further to tidy up. hv_store is not implemented as a call to
1854 hv_store_ent, and does not create a temporary SV for the key, so if your
1855 key data is not already in SV form then use hv_store in preference to
1858 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1859 information on how to use this function on tied hashes.
1861 SV** hv_store(HV *hv, const char *key, I32 klen, SV *val, U32 hash)
1869 Like C<hv_store>, but takes a literal string instead of a string/length pair
1870 and omits the hash parameter.
1872 SV** hv_stores(HV* tb, const char* key, NULLOK SV* val)
1875 Found in file handy.h
1880 Stores C<val> in a hash. The hash key is specified as C<key>. The C<hash>
1881 parameter is the precomputed hash value; if it is zero then Perl will
1882 compute it. The return value is the new hash entry so created. It will be
1883 NULL if the operation failed or if the value did not need to be actually
1884 stored within the hash (as in the case of tied hashes). Otherwise the
1885 contents of the return value can be accessed using the C<He?> macros
1886 described here. Note that the caller is responsible for suitably
1887 incrementing the reference count of C<val> before the call, and
1888 decrementing it if the function returned NULL. Effectively a successful
1889 hv_store_ent takes ownership of one reference to C<val>. This is
1890 usually what you want; a newly created SV has a reference count of one, so
1891 if all your code does is create SVs then store them in a hash, hv_store
1892 will own the only reference to the new SV, and your code doesn't need to do
1893 anything further to tidy up. Note that hv_store_ent only reads the C<key>;
1894 unlike C<val> it does not take ownership of it, so maintaining the correct
1895 reference count on C<key> is entirely the caller's responsibility. hv_store
1896 is not implemented as a call to hv_store_ent, and does not create a temporary
1897 SV for the key, so if your key data is not already in SV form then use
1898 hv_store in preference to hv_store_ent.
1900 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1901 information on how to use this function on tied hashes.
1903 HE* hv_store_ent(HV *hv, SV *key, SV *val, U32 hash)
1913 void hv_undef(HV *hv)
1921 Creates a new HV. The reference count is set to 1.
1931 =head1 Magical Functions
1938 Clear something magical that the SV represents. See C<sv_magic>.
1940 int mg_clear(SV* sv)
1948 Copies the magic from one SV to another. See C<sv_magic>.
1950 int mg_copy(SV *sv, SV *nsv, const char *key, I32 klen)
1958 Finds the magic pointer for type matching the SV. See C<sv_magic>.
1960 MAGIC* mg_find(const SV* sv, int type)
1968 Free any magic storage used by the SV. See C<sv_magic>.
1978 Do magic after a value is retrieved from the SV. See C<sv_magic>.
1988 Report on the SV's length. See C<sv_magic>.
1990 U32 mg_length(SV* sv)
1998 Turns on the magical status of an SV. See C<sv_magic>.
2000 void mg_magical(SV* sv)
2008 Do magic after a value is assigned to the SV. See C<sv_magic>.
2018 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
2019 argument more than once.
2021 void SvGETMAGIC(SV* sv)
2029 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
2040 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
2041 argument more than once.
2043 void SvSETMAGIC(SV* sv)
2051 Like C<SvSetSV>, but does any set magic required afterwards.
2053 void SvSetMagicSV(SV* dsb, SV* ssv)
2058 =item SvSetMagicSV_nosteal
2059 X<SvSetMagicSV_nosteal>
2061 Like C<SvSetSV_nosteal>, but does any set magic required afterwards.
2063 void SvSetMagicSV_nosteal(SV* dsv, SV* ssv)
2071 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
2074 void SvSetSV(SV* dsb, SV* ssv)
2079 =item SvSetSV_nosteal
2082 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
2083 ssv. May evaluate arguments more than once.
2085 void SvSetSV_nosteal(SV* dsv, SV* ssv)
2093 Arranges for sv to be shared between threads if a suitable module
2096 void SvSHARE(SV* sv)
2104 Releases a mutual exclusion lock on sv if a suitable module
2107 void SvUNLOCK(SV* sv)
2115 =head1 Memory Management
2122 The XSUB-writer's interface to the C C<memcpy> function. The C<src> is the
2123 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
2124 the type. May fail on overlapping copies. See also C<Move>.
2126 void Copy(void* src, void* dest, int nitems, type)
2129 Found in file handy.h
2134 Like C<Copy> but returns dest. Useful for encouraging compilers to tail-call
2137 void * CopyD(void* src, void* dest, int nitems, type)
2140 Found in file handy.h
2145 The XSUB-writer's interface to the C C<memmove> function. The C<src> is the
2146 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
2147 the type. Can do overlapping moves. See also C<Copy>.
2149 void Move(void* src, void* dest, int nitems, type)
2152 Found in file handy.h
2157 Like C<Move> but returns dest. Useful for encouraging compilers to tail-call
2160 void * MoveD(void* src, void* dest, int nitems, type)
2163 Found in file handy.h
2168 The XSUB-writer's interface to the C C<malloc> function.
2170 In 5.9.3, Newx() and friends replace the older New() API, and drops
2171 the first parameter, I<x>, a debug aid which allowed callers to identify
2172 themselves. This aid has been superseded by a new build option,
2173 PERL_MEM_LOG (see L<perlhack/PERL_MEM_LOG>). The older API is still
2174 there for use in XS modules supporting older perls.
2176 void Newx(void* ptr, int nitems, type)
2179 Found in file handy.h
2184 The XSUB-writer's interface to the C C<malloc> function, with
2185 cast. See also C<Newx>.
2187 void Newxc(void* ptr, int nitems, type, cast)
2190 Found in file handy.h
2195 The XSUB-writer's interface to the C C<malloc> function. The allocated
2196 memory is zeroed with C<memzero>. See also C<Newx>.
2198 void Newxz(void* ptr, int nitems, type)
2201 Found in file handy.h
2206 PoisonWith(0xEF) for catching access to freed memory.
2208 void Poison(void* dest, int nitems, type)
2211 Found in file handy.h
2216 PoisonWith(0xEF) for catching access to freed memory.
2218 void PoisonFree(void* dest, int nitems, type)
2221 Found in file handy.h
2226 PoisonWith(0xAB) for catching access to allocated but uninitialized memory.
2228 void PoisonNew(void* dest, int nitems, type)
2231 Found in file handy.h
2236 Fill up memory with a byte pattern (a byte repeated over and over
2237 again) that hopefully catches attempts to access uninitialized memory.
2239 void PoisonWith(void* dest, int nitems, type, U8 byte)
2242 Found in file handy.h
2247 The XSUB-writer's interface to the C C<realloc> function.
2249 void Renew(void* ptr, int nitems, type)
2252 Found in file handy.h
2257 The XSUB-writer's interface to the C C<realloc> function, with
2260 void Renewc(void* ptr, int nitems, type, cast)
2263 Found in file handy.h
2268 The XSUB-writer's interface to the C C<free> function.
2270 void Safefree(void* ptr)
2273 Found in file handy.h
2278 Perl's version of C<strdup()>. Returns a pointer to a newly allocated
2279 string which is a duplicate of C<pv>. The size of the string is
2280 determined by C<strlen()>. The memory allocated for the new string can
2281 be freed with the C<Safefree()> function.
2283 char* savepv(const char* pv)
2286 Found in file util.c
2291 Perl's version of what C<strndup()> would be if it existed. Returns a
2292 pointer to a newly allocated string which is a duplicate of the first
2293 C<len> bytes from C<pv>, plus a trailing NUL byte. The memory allocated for
2294 the new string can be freed with the C<Safefree()> function.
2296 char* savepvn(const char* pv, I32 len)
2299 Found in file util.c
2304 Like C<savepvn>, but takes a literal string instead of a string/length pair.
2306 char* savepvs(const char* s)
2309 Found in file handy.h
2314 A version of C<savepv()> which allocates the duplicate string in memory
2315 which is shared between threads.
2317 char* savesharedpv(const char* pv)
2320 Found in file util.c
2325 A version of C<savepvn()> which allocates the duplicate string in memory
2326 which is shared between threads. (With the specific difference that a NULL
2327 pointer is not acceptable)
2329 char* savesharedpvn(const char *const pv, const STRLEN len)
2332 Found in file util.c
2337 A version of C<savepv()>/C<savepvn()> which gets the string to duplicate from
2338 the passed in SV using C<SvPV()>
2340 char* savesvpv(SV* sv)
2343 Found in file util.c
2348 This is an architecture-independent macro to copy one structure to another.
2350 void StructCopy(type src, type dest, type)
2353 Found in file handy.h
2358 The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the
2359 destination, C<nitems> is the number of items, and C<type> is the type.
2361 void Zero(void* dest, int nitems, type)
2364 Found in file handy.h
2369 Like C<Zero> but returns dest. Useful for encouraging compilers to tail-call
2372 void * ZeroD(void* dest, int nitems, type)
2375 Found in file handy.h
2380 =head1 Miscellaneous Functions
2387 Analyses the string in order to make fast searches on it using fbm_instr()
2388 -- the Boyer-Moore algorithm.
2390 void fbm_compile(SV* sv, U32 flags)
2393 Found in file util.c
2398 Returns the location of the SV in the string delimited by C<str> and
2399 C<strend>. It returns C<NULL> if the string can't be found. The C<sv>
2400 does not have to be fbm_compiled, but the search will not be as fast
2403 char* fbm_instr(unsigned char* big, unsigned char* bigend, SV* littlestr, U32 flags)
2406 Found in file util.c
2411 Takes a sprintf-style format pattern and conventional
2412 (non-SV) arguments and returns the formatted string.
2414 (char *) Perl_form(pTHX_ const char* pat, ...)
2416 can be used any place a string (char *) is required:
2418 char * s = Perl_form("%d.%d",major,minor);
2420 Uses a single private buffer so if you want to format several strings you
2421 must explicitly copy the earlier strings away (and free the copies when you
2424 char* form(const char* pat, ...)
2427 Found in file util.c
2432 Fill the sv with current working directory
2434 int getcwd_sv(SV* sv)
2437 Found in file util.c
2442 The C library C<snprintf> functionality, if available and
2443 standards-compliant (uses C<vsnprintf>, actually). However, if the
2444 C<vsnprintf> is not available, will unfortunately use the unsafe
2445 C<vsprintf> which can overrun the buffer (there is an overrun check,
2446 but that may be too late). Consider using C<sv_vcatpvf> instead, or
2447 getting C<vsnprintf>.
2449 int my_snprintf(char *buffer, const Size_t len, const char *format, ...)
2452 Found in file util.c
2457 The C library C<sprintf>, wrapped if necessary, to ensure that it will return
2458 the length of the string written to the buffer. Only rare pre-ANSI systems
2459 need the wrapper function - usually this is a direct call to C<sprintf>.
2461 int my_sprintf(char *buffer, const char *pat, ...)
2464 Found in file util.c
2469 The C library C<vsnprintf> if available and standards-compliant.
2470 However, if if the C<vsnprintf> is not available, will unfortunately
2471 use the unsafe C<vsprintf> which can overrun the buffer (there is an
2472 overrun check, but that may be too late). Consider using
2473 C<sv_vcatpvf> instead, or getting C<vsnprintf>.
2475 int my_vsnprintf(char *buffer, const Size_t len, const char *format, va_list ap)
2478 Found in file util.c
2483 Returns a new version object based on the passed in SV:
2485 SV *sv = new_version(SV *ver);
2487 Does not alter the passed in ver SV. See "upg_version" if you
2488 want to upgrade the SV.
2490 SV* new_version(SV *ver)
2493 Found in file util.c
2498 Returns a pointer to the next character after the parsed
2499 version string, as well as upgrading the passed in SV to
2502 Function must be called with an already existing SV like
2505 s = scan_version(s, SV *sv, bool qv);
2507 Performs some preprocessing to the string to ensure that
2508 it has the correct characteristics of a version. Flags the
2509 object if it contains an underscore (which denotes this
2510 is an alpha version). The boolean qv denotes that the version
2511 should be interpreted as if it had multiple decimals, even if
2514 const char* scan_version(const char *s, SV *rv, bool qv)
2517 Found in file util.c
2522 Test two strings to see if they are equal. Returns true or false.
2524 bool strEQ(char* s1, char* s2)
2527 Found in file handy.h
2532 Test two strings to see if the first, C<s1>, is greater than or equal to
2533 the second, C<s2>. Returns true or false.
2535 bool strGE(char* s1, char* s2)
2538 Found in file handy.h
2543 Test two strings to see if the first, C<s1>, is greater than the second,
2544 C<s2>. Returns true or false.
2546 bool strGT(char* s1, char* s2)
2549 Found in file handy.h
2554 Test two strings to see if the first, C<s1>, is less than or equal to the
2555 second, C<s2>. Returns true or false.
2557 bool strLE(char* s1, char* s2)
2560 Found in file handy.h
2565 Test two strings to see if the first, C<s1>, is less than the second,
2566 C<s2>. Returns true or false.
2568 bool strLT(char* s1, char* s2)
2571 Found in file handy.h
2576 Test two strings to see if they are different. Returns true or
2579 bool strNE(char* s1, char* s2)
2582 Found in file handy.h
2587 Test two strings to see if they are equal. The C<len> parameter indicates
2588 the number of bytes to compare. Returns true or false. (A wrapper for
2591 bool strnEQ(char* s1, char* s2, STRLEN len)
2594 Found in file handy.h
2599 Test two strings to see if they are different. The C<len> parameter
2600 indicates the number of bytes to compare. Returns true or false. (A
2601 wrapper for C<strncmp>).
2603 bool strnNE(char* s1, char* s2, STRLEN len)
2606 Found in file handy.h
2608 =item sv_destroyable
2611 Dummy routine which reports that object can be destroyed when there is no
2612 sharing module present. It ignores its single SV argument, and returns
2613 'true'. Exists to avoid test for a NULL function pointer and because it
2614 could potentially warn under some level of strict-ness.
2616 bool sv_destroyable(SV *sv)
2619 Found in file util.c
2624 Dummy routine which "shares" an SV when there is no sharing module present.
2625 Or "locks" it. Or "unlocks" it. In other words, ignores its single SV argument.
2626 Exists to avoid test for a NULL function pointer and because it could
2627 potentially warn under some level of strict-ness.
2629 void sv_nosharing(SV *sv)
2632 Found in file util.c
2637 In-place upgrade of the supplied SV to a version object.
2639 SV *sv = upg_version(SV *sv, bool qv);
2641 Returns a pointer to the upgraded SV. Set the boolean qv if you want
2642 to force this SV to be interpreted as an "extended" version.
2644 SV* upg_version(SV *ver, bool qv)
2647 Found in file util.c
2652 Version object aware cmp. Both operands must already have been
2653 converted into version objects.
2655 int vcmp(SV *lhv, SV *rhv)
2658 Found in file util.c
2663 Accepts a version object and returns the normalized string
2664 representation. Call like:
2668 NOTE: you can pass either the object directly or the SV
2669 contained within the RV.
2674 Found in file util.c
2679 Accepts a version object and returns the normalized floating
2680 point representation. Call like:
2684 NOTE: you can pass either the object directly or the SV
2685 contained within the RV.
2690 Found in file util.c
2695 In order to maintain maximum compatibility with earlier versions
2696 of Perl, this function will return either the floating point
2697 notation or the multiple dotted notation, depending on whether
2698 the original version contained 1 or more dots, respectively
2700 SV* vstringify(SV *vs)
2703 Found in file util.c
2708 Validates that the SV contains a valid version object.
2710 bool vverify(SV *vobj);
2712 Note that it only confirms the bare minimum structure (so as not to get
2713 confused by derived classes which may contain additional hash entries):
2715 bool vverify(SV *vs)
2718 Found in file util.c
2723 =head1 MRO Functions
2727 =item mro_get_linear_isa
2728 X<mro_get_linear_isa>
2730 Returns either C<mro_get_linear_isa_c3> or
2731 C<mro_get_linear_isa_dfs> for the given stash,
2732 dependant upon which MRO is in effect
2733 for that stash. The return value is a
2736 You are responsible for C<SvREFCNT_inc()> on the
2737 return value if you plan to store it anywhere
2738 semi-permanently (otherwise it might be deleted
2739 out from under you the next time the cache is
2742 AV* mro_get_linear_isa(HV* stash)
2747 =item mro_method_changed_in
2748 X<mro_method_changed_in>
2750 Invalidates method caching on any child classes
2751 of the given stash, so that they might notice
2752 the changes in this one.
2754 Ideally, all instances of C<PL_sub_generation++> in
2755 perl source outside of C<mro.c> should be
2756 replaced by calls to this.
2758 Perl automatically handles most of the common
2759 ways a method might be redefined. However, there
2760 are a few ways you could change a method in a stash
2761 without the cache code noticing, in which case you
2762 need to call this method afterwards:
2764 1) Directly manipulating the stash HV entries from
2767 2) Assigning a reference to a readonly scalar
2768 constant into a stash entry in order to create
2769 a constant subroutine (like constant.pm
2772 This same method is available from pure perl
2773 via, C<mro::method_changed_in(classname)>.
2775 void mro_method_changed_in(HV* stash)
2783 =head1 Multicall Functions
2790 Declare local variables for a multicall. See L<perlcall/Lightweight Callbacks>.
2800 Make a lightweight callback. See L<perlcall/Lightweight Callbacks>.
2810 Closing bracket for a lightweight callback.
2811 See L<perlcall/Lightweight Callbacks>.
2818 =item PUSH_MULTICALL
2821 Opening bracket for a lightweight callback.
2822 See L<perlcall/Lightweight Callbacks>.
2832 =head1 Numeric functions
2839 converts a string representing a binary number to numeric form.
2841 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2842 conversion flags, and I<result> should be NULL or a pointer to an NV.
2843 The scan stops at the end of the string, or the first invalid character.
2844 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2845 invalid character will also trigger a warning.
2846 On return I<*len> is set to the length of the scanned string,
2847 and I<*flags> gives output flags.
2849 If the value is <= C<UV_MAX> it is returned as a UV, the output flags are clear,
2850 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_bin>
2851 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2852 and writes the value to I<*result> (or the value is discarded if I<result>
2855 The binary number may optionally be prefixed with "0b" or "b" unless
2856 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
2857 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the binary
2858 number may use '_' characters to separate digits.
2860 UV grok_bin(const char* start, STRLEN* len_p, I32* flags, NV *result)
2863 Found in file numeric.c
2868 converts a string representing a hex number to numeric form.
2870 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2871 conversion flags, and I<result> should be NULL or a pointer to an NV.
2872 The scan stops at the end of the string, or the first invalid character.
2873 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2874 invalid character will also trigger a warning.
2875 On return I<*len> is set to the length of the scanned string,
2876 and I<*flags> gives output flags.
2878 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2879 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_hex>
2880 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2881 and writes the value to I<*result> (or the value is discarded if I<result>
2884 The hex number may optionally be prefixed with "0x" or "x" unless
2885 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
2886 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the hex
2887 number may use '_' characters to separate digits.
2889 UV grok_hex(const char* start, STRLEN* len_p, I32* flags, NV *result)
2892 Found in file numeric.c
2897 Recognise (or not) a number. The type of the number is returned
2898 (0 if unrecognised), otherwise it is a bit-ORed combination of
2899 IS_NUMBER_IN_UV, IS_NUMBER_GREATER_THAN_UV_MAX, IS_NUMBER_NOT_INT,
2900 IS_NUMBER_NEG, IS_NUMBER_INFINITY, IS_NUMBER_NAN (defined in perl.h).
2902 If the value of the number can fit an in UV, it is returned in the *valuep
2903 IS_NUMBER_IN_UV will be set to indicate that *valuep is valid, IS_NUMBER_IN_UV
2904 will never be set unless *valuep is valid, but *valuep may have been assigned
2905 to during processing even though IS_NUMBER_IN_UV is not set on return.
2906 If valuep is NULL, IS_NUMBER_IN_UV will be set for the same cases as when
2907 valuep is non-NULL, but no actual assignment (or SEGV) will occur.
2909 IS_NUMBER_NOT_INT will be set with IS_NUMBER_IN_UV if trailing decimals were
2910 seen (in which case *valuep gives the true value truncated to an integer), and
2911 IS_NUMBER_NEG if the number is negative (in which case *valuep holds the
2912 absolute value). IS_NUMBER_IN_UV is not set if e notation was used or the
2913 number is larger than a UV.
2915 int grok_number(const char *pv, STRLEN len, UV *valuep)
2918 Found in file numeric.c
2920 =item grok_numeric_radix
2921 X<grok_numeric_radix>
2923 Scan and skip for a numeric decimal separator (radix).
2925 bool grok_numeric_radix(const char **sp, const char *send)
2928 Found in file numeric.c
2933 converts a string representing an octal number to numeric form.
2935 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2936 conversion flags, and I<result> should be NULL or a pointer to an NV.
2937 The scan stops at the end of the string, or the first invalid character.
2938 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2939 invalid character will also trigger a warning.
2940 On return I<*len> is set to the length of the scanned string,
2941 and I<*flags> gives output flags.
2943 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2944 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_oct>
2945 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2946 and writes the value to I<*result> (or the value is discarded if I<result>
2949 If C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the octal
2950 number may use '_' characters to separate digits.
2952 UV grok_oct(const char* start, STRLEN* len_p, I32* flags, NV *result)
2955 Found in file numeric.c
2960 Return a non-zero integer if the sign bit on an NV is set, and 0 if
2963 If Configure detects this system has a signbit() that will work with
2964 our NVs, then we just use it via the #define in perl.h. Otherwise,
2965 fall back on this implementation. As a first pass, this gets everything
2966 right except -0.0. Alas, catching -0.0 is the main use for this function,
2967 so this is not too helpful yet. Still, at least we have the scaffolding
2968 in place to support other systems, should that prove useful.
2971 Configure notes: This function is called 'Perl_signbit' instead of a
2972 plain 'signbit' because it is easy to imagine a system having a signbit()
2973 function or macro that doesn't happen to work with our particular choice
2974 of NVs. We shouldn't just re-#define signbit as Perl_signbit and expect
2975 the standard system headers to be happy. Also, this is a no-context
2976 function (no pTHX_) because Perl_signbit() is usually re-#defined in
2977 perl.h as a simple macro call to the system's signbit().
2978 Users should just always call Perl_signbit().
2980 NOTE: this function is experimental and may change or be
2981 removed without notice.
2983 int Perl_signbit(NV f)
2986 Found in file numeric.c
2991 For backwards compatibility. Use C<grok_bin> instead.
2993 NV scan_bin(const char* start, STRLEN len, STRLEN* retlen)
2996 Found in file numeric.c
3001 For backwards compatibility. Use C<grok_hex> instead.
3003 NV scan_hex(const char* start, STRLEN len, STRLEN* retlen)
3006 Found in file numeric.c
3011 For backwards compatibility. Use C<grok_oct> instead.
3013 NV scan_oct(const char* start, STRLEN len, STRLEN* retlen)
3016 Found in file numeric.c
3021 =head1 Optree Manipulation Functions
3028 If C<cv> is a constant sub eligible for inlining. returns the constant
3029 value returned by the sub. Otherwise, returns NULL.
3031 Constant subs can be created with C<newCONSTSUB> or as described in
3032 L<perlsub/"Constant Functions">.
3034 SV* cv_const_sv(const CV *const cv)
3042 Creates a constant sub equivalent to Perl C<sub FOO () { 123 }> which is
3043 eligible for inlining at compile-time.
3045 CV* newCONSTSUB(HV* stash, const char* name, SV* sv)
3053 Used by C<xsubpp> to hook up XSUBs as Perl subs. I<filename> needs to be
3054 static storage, as it is used directly as CvFILE(), without a copy being made.
3062 =head1 Pad Data Structures
3069 Get the value at offset po in the current pad.
3070 Use macro PAD_SV instead of calling this function directly.
3072 SV* pad_sv(PADOFFSET po)
3080 =head1 Per-Interpreter Variables
3087 C<PL_modglobal> is a general purpose, interpreter global HV for use by
3088 extensions that need to keep information on a per-interpreter basis.
3089 In a pinch, it can also be used as a symbol table for extensions
3090 to share data among each other. It is a good idea to use keys
3091 prefixed by the package name of the extension that owns the data.
3096 Found in file intrpvar.h
3101 A convenience variable which is typically used with C<SvPV> when one
3102 doesn't care about the length of the string. It is usually more efficient
3103 to either declare a local variable and use that instead or to use the
3104 C<SvPV_nolen> macro.
3109 Found in file intrpvar.h
3114 This is the C<false> SV. See C<PL_sv_yes>. Always refer to this as
3120 Found in file intrpvar.h
3125 This is the C<undef> SV. Always refer to this as C<&PL_sv_undef>.
3130 Found in file intrpvar.h
3135 This is the C<true> SV. See C<PL_sv_no>. Always refer to this as
3141 Found in file intrpvar.h
3146 =head1 REGEXP Functions
3153 Convenience macro to get the REGEXP from a SV. This is approximately
3154 equivalent to the following snippet:
3159 (tmpsv = (SV*)SvRV(sv)) &&
3160 SvTYPE(tmpsv) == SVt_PVMG &&
3161 (tmpmg = mg_find(tmpsv, PERL_MAGIC_qr)))
3163 return (REGEXP *)tmpmg->mg_obj;
3166 NULL will be returned if a REGEXP* is not found.
3168 REGEXP * SvRX(SV *sv)
3171 Found in file regexp.h
3176 Returns a boolean indicating whether the SV contains qr magic
3179 If you want to do something with the REGEXP* later use SvRX instead
3185 Found in file regexp.h
3190 =head1 Simple Exception Handling Macros
3197 Set up necessary local variables for exception handling.
3198 See L<perlguts/"Exception Handling">.
3203 Found in file XSUB.h
3208 Introduces a catch block. See L<perlguts/"Exception Handling">.
3211 Found in file XSUB.h
3216 Rethrows a previously caught exception. See L<perlguts/"Exception Handling">.
3221 Found in file XSUB.h
3226 Ends a try block. See L<perlguts/"Exception Handling">.
3229 Found in file XSUB.h
3231 =item XCPT_TRY_START
3234 Starts a try block. See L<perlguts/"Exception Handling">.
3237 Found in file XSUB.h
3242 =head1 Stack Manipulation Macros
3249 Declare a stack marker variable, C<mark>, for the XSUB. See C<MARK> and
3260 Saves the original stack mark for the XSUB. See C<ORIGMARK>.
3270 Declares a local copy of perl's stack pointer for the XSUB, available via
3271 the C<SP> macro. See C<SP>.
3281 Used to extend the argument stack for an XSUB's return values. Once
3282 used, guarantees that there is room for at least C<nitems> to be pushed
3285 void EXTEND(SP, int nitems)
3293 Stack marker variable for the XSUB. See C<dMARK>.
3301 Push an integer onto the stack. The stack must have room for this element.
3302 Does not use C<TARG>. See also C<PUSHi>, C<mXPUSHi> and C<XPUSHi>.
3312 Push a double onto the stack. The stack must have room for this element.
3313 Does not use C<TARG>. See also C<PUSHn>, C<mXPUSHn> and C<XPUSHn>.
3323 Push a string onto the stack. The stack must have room for this element.
3324 The C<len> indicates the length of the string. Does not use C<TARG>.
3325 See also C<PUSHp>, C<mXPUSHp> and C<XPUSHp>.
3327 void mPUSHp(char* str, STRLEN len)
3335 Push an SV onto the stack and mortalizes the SV. The stack must have room
3336 for this element. Does not use C<TARG>. See also C<PUSHs> and C<mXPUSHs>.
3346 Push an unsigned integer onto the stack. The stack must have room for this
3347 element. Does not use C<TARG>. See also C<PUSHu>, C<mXPUSHu> and C<XPUSHu>.
3357 Push an integer onto the stack, extending the stack if necessary.
3358 Does not use C<TARG>. See also C<XPUSHi>, C<mPUSHi> and C<PUSHi>.
3368 Push a double onto the stack, extending the stack if necessary.
3369 Does not use C<TARG>. See also C<XPUSHn>, C<mPUSHn> and C<PUSHn>.
3379 Push a string onto the stack, extending the stack if necessary. The C<len>
3380 indicates the length of the string. Does not use C<TARG>. See also C<XPUSHp>,
3381 C<mPUSHp> and C<PUSHp>.
3383 void mXPUSHp(char* str, STRLEN len)
3391 Push an SV onto the stack, extending the stack if necessary and mortalizes
3392 the SV. Does not use C<TARG>. See also C<XPUSHs> and C<mPUSHs>.
3394 void mXPUSHs(SV* sv)
3402 Push an unsigned integer onto the stack, extending the stack if necessary.
3403 Does not use C<TARG>. See also C<XPUSHu>, C<mPUSHu> and C<PUSHu>.
3413 The original stack mark for the XSUB. See C<dORIGMARK>.
3421 Pops an integer off the stack.
3431 Pops a long off the stack.
3441 Pops a double off the stack.
3451 Pops a string off the stack. Deprecated. New code should use POPpx.
3461 Pops a string off the stack which must consist of bytes i.e. characters < 256.
3471 Pops a string off the stack.
3481 Pops an SV off the stack.
3491 Push an integer onto the stack. The stack must have room for this element.
3492 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3493 called to declare it. Do not call multiple C<TARG>-oriented macros to
3494 return lists from XSUB's - see C<mPUSHi> instead. See also C<XPUSHi> and
3505 Opening bracket for arguments on a callback. See C<PUTBACK> and
3516 Push a new mortal SV onto the stack. The stack must have room for this
3517 element. Does not use C<TARG>. See also C<PUSHs>, C<XPUSHmortal> and C<XPUSHs>.
3527 Push a double onto the stack. The stack must have room for this element.
3528 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3529 called to declare it. Do not call multiple C<TARG>-oriented macros to
3530 return lists from XSUB's - see C<mPUSHn> instead. See also C<XPUSHn> and
3541 Push a string onto the stack. The stack must have room for this element.
3542 The C<len> indicates the length of the string. Handles 'set' magic. Uses
3543 C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to declare it. Do not
3544 call multiple C<TARG>-oriented macros to return lists from XSUB's - see
3545 C<mPUSHp> instead. See also C<XPUSHp> and C<mXPUSHp>.
3547 void PUSHp(char* str, STRLEN len)
3555 Push an SV onto the stack. The stack must have room for this element.
3556 Does not handle 'set' magic. Does not use C<TARG>. See also C<PUSHmortal>,
3557 C<XPUSHs> and C<XPUSHmortal>.
3567 Push an unsigned integer onto the stack. The stack must have room for this
3568 element. Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG>
3569 should be called to declare it. Do not call multiple C<TARG>-oriented
3570 macros to return lists from XSUB's - see C<mPUSHu> instead. See also
3571 C<XPUSHu> and C<mXPUSHu>.
3581 Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
3582 See C<PUSHMARK> and L<perlcall> for other uses.
3592 Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and
3601 Refetch the stack pointer. Used after a callback. See L<perlcall>.
3611 Push an integer onto the stack, extending the stack if necessary. Handles
3612 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
3613 declare it. Do not call multiple C<TARG>-oriented macros to return lists
3614 from XSUB's - see C<mXPUSHi> instead. See also C<PUSHi> and C<mPUSHi>.
3624 Push a new mortal SV onto the stack, extending the stack if necessary.
3625 Does not use C<TARG>. See also C<XPUSHs>, C<PUSHmortal> and C<PUSHs>.
3635 Push a double onto the stack, extending the stack if necessary. Handles
3636 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
3637 declare it. Do not call multiple C<TARG>-oriented macros to return lists
3638 from XSUB's - see C<mXPUSHn> instead. See also C<PUSHn> and C<mPUSHn>.
3648 Push a string onto the stack, extending the stack if necessary. The C<len>
3649 indicates the length of the string. Handles 'set' magic. Uses C<TARG>, so
3650 C<dTARGET> or C<dXSTARG> should be called to declare it. Do not call
3651 multiple C<TARG>-oriented macros to return lists from XSUB's - see
3652 C<mXPUSHp> instead. See also C<PUSHp> and C<mPUSHp>.
3654 void XPUSHp(char* str, STRLEN len)
3662 Push an SV onto the stack, extending the stack if necessary. Does not
3663 handle 'set' magic. Does not use C<TARG>. See also C<XPUSHmortal>,
3664 C<PUSHs> and C<PUSHmortal>.
3674 Push an unsigned integer onto the stack, extending the stack if necessary.
3675 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3676 called to declare it. Do not call multiple C<TARG>-oriented macros to
3677 return lists from XSUB's - see C<mXPUSHu> instead. See also C<PUSHu> and
3688 Return from XSUB, indicating number of items on the stack. This is usually
3689 handled by C<xsubpp>.
3691 void XSRETURN(int nitems)
3694 Found in file XSUB.h
3696 =item XSRETURN_EMPTY
3699 Return an empty list from an XSUB immediately.
3704 Found in file XSUB.h
3709 Return an integer from an XSUB immediately. Uses C<XST_mIV>.
3711 void XSRETURN_IV(IV iv)
3714 Found in file XSUB.h
3719 Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
3724 Found in file XSUB.h
3729 Return a double from an XSUB immediately. Uses C<XST_mNV>.
3731 void XSRETURN_NV(NV nv)
3734 Found in file XSUB.h
3739 Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
3741 void XSRETURN_PV(char* str)
3744 Found in file XSUB.h
3746 =item XSRETURN_UNDEF
3749 Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
3754 Found in file XSUB.h
3759 Return an integer from an XSUB immediately. Uses C<XST_mUV>.
3761 void XSRETURN_UV(IV uv)
3764 Found in file XSUB.h
3769 Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
3774 Found in file XSUB.h
3779 Place an integer into the specified position C<pos> on the stack. The
3780 value is stored in a new mortal SV.
3782 void XST_mIV(int pos, IV iv)
3785 Found in file XSUB.h
3790 Place C<&PL_sv_no> into the specified position C<pos> on the
3793 void XST_mNO(int pos)
3796 Found in file XSUB.h
3801 Place a double into the specified position C<pos> on the stack. The value
3802 is stored in a new mortal SV.
3804 void XST_mNV(int pos, NV nv)
3807 Found in file XSUB.h
3812 Place a copy of a string into the specified position C<pos> on the stack.
3813 The value is stored in a new mortal SV.
3815 void XST_mPV(int pos, char* str)
3818 Found in file XSUB.h
3823 Place C<&PL_sv_undef> into the specified position C<pos> on the
3826 void XST_mUNDEF(int pos)
3829 Found in file XSUB.h
3834 Place C<&PL_sv_yes> into the specified position C<pos> on the
3837 void XST_mYES(int pos)
3840 Found in file XSUB.h
3852 An enum of flags for Perl types. These are found in the file B<sv.h>
3853 in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
3861 Integer type flag for scalars. See C<svtype>.
3869 Double type flag for scalars. See C<svtype>.
3877 Pointer type flag for scalars. See C<svtype>.
3885 Type flag for arrays. See C<svtype>.
3893 Type flag for code refs. See C<svtype>.
3901 Type flag for hashes. See C<svtype>.
3909 Type flag for blessed scalars. See C<svtype>.
3917 =head1 SV Manipulation Functions
3921 =item croak_xs_usage
3924 A specialised variant of C<croak()> for emitting the usage message for xsubs
3926 croak_xs_usage(cv, "eee_yow");
3928 works out the package name and subroutine name from C<cv>, and then calls
3929 C<croak()>. Hence if C<cv> is C<&ouch::awk>, it would call C<croak> as:
3931 Perl_croak(aTHX_ "Usage %s::%s(%s)", "ouch" "awk", "eee_yow");
3933 void croak_xs_usage(const CV *const cv, const char *const params)
3936 Found in file universal.c
3941 Returns the SV of the specified Perl scalar. If C<create> is set and the
3942 Perl variable does not exist then it will be created. If C<create> is not
3943 set and the variable does not exist then NULL is returned.
3945 NOTE: the perl_ form of this function is deprecated.
3947 SV* get_sv(const char* name, I32 create)
3950 Found in file perl.c
3955 Creates an RV wrapper for an SV. The reference count for the original SV is
3958 SV* newRV_inc(SV* sv)
3966 Creates a new SV and copies a string into it. If utf8 is true, calls
3967 C<SvUTF8_on> on the new SV. Implemented as a wrapper around C<newSVpvn_flags>.
3969 SV* newSVpvn_utf8(NULLOK const char* s, STRLEN len, U32 utf8)
3977 Returns the length of the string which is in the SV. See C<SvLEN>.
3979 STRLEN SvCUR(SV* sv)
3987 Set the current length of the string which is in the SV. See C<SvCUR>
3990 void SvCUR_set(SV* sv, STRLEN len)
3998 Returns a pointer to the last character in the string which is in the SV.
3999 See C<SvCUR>. Access the character as *(SvEND(sv)).
4009 Returns true if the SV has get magic or overloading. If either is true then
4010 the scalar is active data, and has the potential to return a new value every
4011 time it is accessed. Hence you must be careful to only read it once per user
4012 logical operation and work with that returned value. If neither is true then
4013 the scalar's value cannot change unless written to.
4015 char* SvGAMAGIC(SV* sv)
4023 Expands the character buffer in the SV so that it has room for the
4024 indicated number of bytes (remember to reserve space for an extra trailing
4025 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
4026 Returns a pointer to the character buffer.
4028 char * SvGROW(SV* sv, STRLEN len)
4036 Returns a U32 value indicating whether the SV contains an integer.
4046 Returns a U32 value indicating whether the SV contains an integer. Checks
4047 the B<private> setting. Use C<SvIOK>.
4057 Returns a boolean indicating whether the SV contains a signed integer.
4059 bool SvIOK_notUV(SV* sv)
4067 Unsets the IV status of an SV.
4069 void SvIOK_off(SV* sv)
4077 Tells an SV that it is an integer.
4079 void SvIOK_on(SV* sv)
4087 Tells an SV that it is an integer and disables all other OK bits.
4089 void SvIOK_only(SV* sv)
4097 Tells and SV that it is an unsigned integer and disables all other OK bits.
4099 void SvIOK_only_UV(SV* sv)
4107 Returns a boolean indicating whether the SV contains an unsigned integer.
4109 bool SvIOK_UV(SV* sv)
4117 Returns a boolean indicating whether the SV is Copy-On-Write. (either shared
4118 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
4121 bool SvIsCOW(SV* sv)
4126 =item SvIsCOW_shared_hash
4127 X<SvIsCOW_shared_hash>
4129 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
4132 bool SvIsCOW_shared_hash(SV* sv)
4140 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
4141 version which guarantees to evaluate sv only once.
4151 Returns the raw value in the SV's IV slot, without checks or conversions.
4152 Only use when you are sure SvIOK is true. See also C<SvIV()>.
4162 Coerces the given SV to an integer and returns it. Guarantees to evaluate
4163 C<sv> only once. Only use this if C<sv> is an expression with side effects,
4164 otherwise use the more efficient C<SvIV>.
4174 Like C<SvIV> but doesn't process magic.
4176 IV SvIV_nomg(SV* sv)
4184 Set the value of the IV pointer in sv to val. It is possible to perform
4185 the same function of this macro with an lvalue assignment to C<SvIVX>.
4186 With future Perls, however, it will be more efficient to use
4187 C<SvIV_set> instead of the lvalue assignment to C<SvIVX>.
4189 void SvIV_set(SV* sv, IV val)
4197 Returns the size of the string buffer in the SV, not including any part
4198 attributable to C<SvOOK>. See C<SvCUR>.
4200 STRLEN SvLEN(SV* sv)
4208 Set the actual length of the string which is in the SV. See C<SvIV_set>.
4210 void SvLEN_set(SV* sv, STRLEN len)
4218 Set the value of the MAGIC pointer in sv to val. See C<SvIV_set>.
4220 void SvMAGIC_set(SV* sv, MAGIC* val)
4228 Returns a U32 value indicating whether the SV contains a number, integer or
4239 Returns a U32 value indicating whether the SV contains a number, integer or
4240 double. Checks the B<private> setting. Use C<SvNIOK>.
4250 Unsets the NV/IV status of an SV.
4252 void SvNIOK_off(SV* sv)
4260 Returns a U32 value indicating whether the SV contains a double.
4270 Returns a U32 value indicating whether the SV contains a double. Checks the
4271 B<private> setting. Use C<SvNOK>.
4281 Unsets the NV status of an SV.
4283 void SvNOK_off(SV* sv)
4291 Tells an SV that it is a double.
4293 void SvNOK_on(SV* sv)
4301 Tells an SV that it is a double and disables all other OK bits.
4303 void SvNOK_only(SV* sv)
4311 Coerce the given SV to a double and return it. See C<SvNVx> for a version
4312 which guarantees to evaluate sv only once.
4322 Returns the raw value in the SV's NV slot, without checks or conversions.
4323 Only use when you are sure SvNOK is true. See also C<SvNV()>.
4333 Coerces the given SV to a double and returns it. Guarantees to evaluate
4334 C<sv> only once. Only use this if C<sv> is an expression with side effects,
4335 otherwise use the more efficient C<SvNV>.
4345 Set the value of the NV pointer in sv to val. See C<SvIV_set>.
4347 void SvNV_set(SV* sv, NV val)
4355 Returns a U32 value indicating whether the value is an SV. It also tells
4356 whether the value is defined or not.
4366 Returns a U32 indicating whether the pointer to the string buffer is offset.
4367 This hack is used internally to speed up removal of characters from the
4368 beginning of a SvPV. When SvOOK is true, then the start of the
4369 allocated string buffer is actually C<SvOOK_offset()> bytes before SvPVX.
4370 This offset used to be stored in SvIVX, but is now stored within the spare
4381 Reads into I<len> the offset from SvPVX back to the true start of the
4382 allocated buffer, which will be non-zero if C<sv_chop> has been used to
4383 efficiently remove characters from start of the buffer. Implemented as a
4384 macro, which takes the address of I<len>, which must be of type C<STRLEN>.
4385 Evaluates I<sv> more than once. Sets I<len> to 0 if C<SvOOK(sv)> is false.
4387 void SvOOK_offset(NN SV*sv, STRLEN len)
4395 Returns a U32 value indicating whether the SV contains a character
4406 Returns a U32 value indicating whether the SV contains a character string.
4407 Checks the B<private> setting. Use C<SvPOK>.
4417 Unsets the PV status of an SV.
4419 void SvPOK_off(SV* sv)
4427 Tells an SV that it is a string.
4429 void SvPOK_on(SV* sv)
4437 Tells an SV that it is a string and disables all other OK bits.
4438 Will also turn off the UTF-8 status.
4440 void SvPOK_only(SV* sv)
4445 =item SvPOK_only_UTF8
4448 Tells an SV that it is a string and disables all other OK bits,
4449 and leaves the UTF-8 status as it was.
4451 void SvPOK_only_UTF8(SV* sv)
4459 Returns a pointer to the string in the SV, or a stringified form of
4460 the SV if the SV does not contain a string. The SV may cache the
4461 stringified version becoming C<SvPOK>. Handles 'get' magic. See also
4462 C<SvPVx> for a version which guarantees to evaluate sv only once.
4464 char* SvPV(SV* sv, STRLEN len)
4472 Like C<SvPV>, but converts sv to byte representation first if necessary.
4474 char* SvPVbyte(SV* sv, STRLEN len)
4482 Like C<SvPV>, but converts sv to byte representation first if necessary.
4483 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
4486 char* SvPVbytex(SV* sv, STRLEN len)
4491 =item SvPVbytex_force
4494 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
4495 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
4498 char* SvPVbytex_force(SV* sv, STRLEN len)
4503 =item SvPVbyte_force
4506 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
4508 char* SvPVbyte_force(SV* sv, STRLEN len)
4513 =item SvPVbyte_nolen
4516 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
4518 char* SvPVbyte_nolen(SV* sv)
4526 Like C<SvPV>, but converts sv to utf8 first if necessary.
4528 char* SvPVutf8(SV* sv, STRLEN len)
4536 Like C<SvPV>, but converts sv to utf8 first if necessary.
4537 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
4540 char* SvPVutf8x(SV* sv, STRLEN len)
4545 =item SvPVutf8x_force
4548 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
4549 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
4552 char* SvPVutf8x_force(SV* sv, STRLEN len)
4557 =item SvPVutf8_force
4560 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
4562 char* SvPVutf8_force(SV* sv, STRLEN len)
4567 =item SvPVutf8_nolen
4570 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
4572 char* SvPVutf8_nolen(SV* sv)
4580 Returns a pointer to the physical string in the SV. The SV must contain a
4591 A version of C<SvPV> which guarantees to evaluate C<sv> only once.
4592 Only use this if C<sv> is an expression with side effects, otherwise use the
4593 more efficient C<SvPVX>.
4595 char* SvPVx(SV* sv, STRLEN len)
4603 Like C<SvPV> but will force the SV into containing just a string
4604 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
4607 char* SvPV_force(SV* sv, STRLEN len)
4612 =item SvPV_force_nomg
4615 Like C<SvPV> but will force the SV into containing just a string
4616 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
4617 directly. Doesn't process magic.
4619 char* SvPV_force_nomg(SV* sv, STRLEN len)
4627 Returns a pointer to the string in the SV, or a stringified form of
4628 the SV if the SV does not contain a string. The SV may cache the
4629 stringified form becoming C<SvPOK>. Handles 'get' magic.
4631 char* SvPV_nolen(SV* sv)
4639 Like C<SvPV> but doesn't process magic.
4641 char* SvPV_nomg(SV* sv, STRLEN len)
4649 Set the value of the PV pointer in sv to val. See C<SvIV_set>.
4651 void SvPV_set(SV* sv, char* val)
4659 Returns the value of the object's reference count.
4661 U32 SvREFCNT(SV* sv)
4669 Decrements the reference count of the given SV.
4671 void SvREFCNT_dec(SV* sv)
4679 Increments the reference count of the given SV.
4681 All of the following SvREFCNT_inc* macros are optimized versions of
4682 SvREFCNT_inc, and can be replaced with SvREFCNT_inc.
4684 SV* SvREFCNT_inc(SV* sv)
4689 =item SvREFCNT_inc_NN
4692 Same as SvREFCNT_inc, but can only be used if you know I<sv>
4693 is not NULL. Since we don't have to check the NULLness, it's faster
4696 SV* SvREFCNT_inc_NN(SV* sv)
4701 =item SvREFCNT_inc_simple
4702 X<SvREFCNT_inc_simple>
4704 Same as SvREFCNT_inc, but can only be used with expressions without side
4705 effects. Since we don't have to store a temporary value, it's faster.
4707 SV* SvREFCNT_inc_simple(SV* sv)
4712 =item SvREFCNT_inc_simple_NN
4713 X<SvREFCNT_inc_simple_NN>
4715 Same as SvREFCNT_inc_simple, but can only be used if you know I<sv>
4716 is not NULL. Since we don't have to check the NULLness, it's faster
4719 SV* SvREFCNT_inc_simple_NN(SV* sv)
4724 =item SvREFCNT_inc_simple_void
4725 X<SvREFCNT_inc_simple_void>
4727 Same as SvREFCNT_inc_simple, but can only be used if you don't need the
4728 return value. The macro doesn't need to return a meaningful value.
4730 void SvREFCNT_inc_simple_void(SV* sv)
4735 =item SvREFCNT_inc_simple_void_NN
4736 X<SvREFCNT_inc_simple_void_NN>
4738 Same as SvREFCNT_inc, but can only be used if you don't need the return
4739 value, and you know that I<sv> is not NULL. The macro doesn't need
4740 to return a meaningful value, or check for NULLness, so it's smaller
4743 void SvREFCNT_inc_simple_void_NN(SV* sv)
4748 =item SvREFCNT_inc_void
4749 X<SvREFCNT_inc_void>
4751 Same as SvREFCNT_inc, but can only be used if you don't need the
4752 return value. The macro doesn't need to return a meaningful value.
4754 void SvREFCNT_inc_void(SV* sv)
4759 =item SvREFCNT_inc_void_NN
4760 X<SvREFCNT_inc_void_NN>
4762 Same as SvREFCNT_inc, but can only be used if you don't need the return
4763 value, and you know that I<sv> is not NULL. The macro doesn't need
4764 to return a meaningful value, or check for NULLness, so it's smaller
4767 void SvREFCNT_inc_void_NN(SV* sv)
4775 Tests if the SV is an RV.
4785 Unsets the RV status of an SV.
4787 void SvROK_off(SV* sv)
4795 Tells an SV that it is an RV.
4797 void SvROK_on(SV* sv)
4805 Dereferences an RV to return the SV.
4815 Set the value of the RV pointer in sv to val. See C<SvIV_set>.
4817 void SvRV_set(SV* sv, SV* val)
4825 Returns the stash of the SV.
4835 Set the value of the STASH pointer in sv to val. See C<SvIV_set>.
4837 void SvSTASH_set(SV* sv, HV* val)
4845 Taints an SV if tainting is enabled.
4847 void SvTAINT(SV* sv)
4855 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
4858 bool SvTAINTED(SV* sv)
4866 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
4867 some of Perl's fundamental security features. XS module authors should not
4868 use this function unless they fully understand all the implications of
4869 unconditionally untainting the value. Untainting should be done in the
4870 standard perl fashion, via a carefully crafted regexp, rather than directly
4871 untainting variables.
4873 void SvTAINTED_off(SV* sv)
4881 Marks an SV as tainted if tainting is enabled.
4883 void SvTAINTED_on(SV* sv)
4891 Returns a boolean indicating whether Perl would evaluate the SV as true or
4892 false, defined or undefined. Does not handle 'get' magic.
4902 Returns the type of the SV. See C<svtype>.
4904 svtype SvTYPE(SV* sv)
4912 Returns a boolean indicating whether the SV contains an unsigned integer.
4922 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
4923 perform the upgrade if necessary. See C<svtype>.
4925 void SvUPGRADE(SV* sv, svtype type)
4933 Returns a U32 value indicating whether the SV contains UTF-8 encoded data.
4934 Call this after SvPV() in case any call to string overloading updates the
4945 Unsets the UTF-8 status of an SV.
4947 void SvUTF8_off(SV *sv)
4955 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
4956 Do not use frivolously.
4958 void SvUTF8_on(SV *sv)
4966 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
4967 for a version which guarantees to evaluate sv only once.
4977 Returns the raw value in the SV's UV slot, without checks or conversions.
4978 Only use when you are sure SvIOK is true. See also C<SvUV()>.
4988 Coerces the given SV to an unsigned integer and returns it. Guarantees to
4989 C<sv> only once. Only use this if C<sv> is an expression with side effects,
4990 otherwise use the more efficient C<SvUV>.
5000 Like C<SvUV> but doesn't process magic.
5002 UV SvUV_nomg(SV* sv)
5010 Set the value of the UV pointer in sv to val. See C<SvIV_set>.
5012 void SvUV_set(SV* sv, UV val)
5020 Returns a boolean indicating whether the SV contains a v-string.
5027 =item sv_catpvn_nomg
5030 Like C<sv_catpvn> but doesn't process magic.
5032 void sv_catpvn_nomg(SV* sv, const char* ptr, STRLEN len)
5040 Like C<sv_catsv> but doesn't process magic.
5042 void sv_catsv_nomg(SV* dsv, SV* ssv)
5047 =item sv_derived_from
5050 Returns a boolean indicating whether the SV is derived from the specified class
5051 I<at the C level>. To check derivation at the Perl level, call C<isa()> as a
5054 bool sv_derived_from(SV* sv, const char *const name)
5057 Found in file universal.c
5062 Returns a boolean indicating whether the SV performs a specific, named role.
5063 The SV can be a Perl object or the name of a Perl class.
5065 bool sv_does(SV* sv, const char *const name)
5068 Found in file universal.c
5070 =item sv_report_used
5073 Dump the contents of all SVs not yet freed. (Debugging aid).
5075 void sv_report_used()
5083 Like C<sv_setsv> but doesn't process magic.
5085 void sv_setsv_nomg(SV* dsv, SV* ssv)
5093 =head1 SV-Body Allocation
5097 =item looks_like_number
5098 X<looks_like_number>
5100 Test if the content of an SV looks like a number (or is a number).
5101 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
5102 non-numeric warning), even if your atof() doesn't grok them.
5104 I32 looks_like_number(SV *const sv)
5112 Creates an RV wrapper for an SV. The reference count for the original
5113 SV is B<not> incremented.
5115 SV* newRV_noinc(SV *const sv)
5123 Creates a new SV. A non-zero C<len> parameter indicates the number of
5124 bytes of preallocated string space the SV should have. An extra byte for a
5125 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
5126 space is allocated.) The reference count for the new SV is set to 1.
5128 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
5129 parameter, I<x>, a debug aid which allowed callers to identify themselves.
5130 This aid has been superseded by a new build option, PERL_MEM_LOG (see
5131 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
5132 modules supporting older perls.
5134 SV* newSV(const STRLEN len)
5142 Creates a new SV from the hash key structure. It will generate scalars that
5143 point to the shared string table where possible. Returns a new (undefined)
5144 SV if the hek is NULL.
5146 SV* newSVhek(const HEK *const hek)
5154 Creates a new SV and copies an integer into it. The reference count for the
5157 SV* newSViv(const IV i)
5165 Creates a new SV and copies a floating point value into it.
5166 The reference count for the SV is set to 1.
5168 SV* newSVnv(const NV n)
5176 Creates a new SV and copies a string into it. The reference count for the
5177 SV is set to 1. If C<len> is zero, Perl will compute the length using
5178 strlen(). For efficiency, consider using C<newSVpvn> instead.
5180 SV* newSVpv(const char *const s, const STRLEN len)
5188 Creates a new SV and initializes it with the string formatted like
5191 SV* newSVpvf(const char *const pat, ...)
5199 Creates a new SV and copies a string into it. The reference count for the
5200 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
5201 string. You are responsible for ensuring that the source string is at least
5202 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
5204 SV* newSVpvn(const char *const s, const STRLEN len)
5209 =item newSVpvn_flags
5212 Creates a new SV and copies a string into it. The reference count for the
5213 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
5214 string. You are responsible for ensuring that the source string is at least
5215 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
5216 Currently the only flag bits accepted are C<SVf_UTF8> and C<SVs_TEMP>.
5217 If C<SVs_TEMP> is set, then C<sv2mortal()> is called on the result before
5218 returning. If C<SVf_UTF8> is set, then it will be set on the new SV.
5219 C<newSVpvn_utf8()> is a convenience wrapper for this function, defined as
5221 #define newSVpvn_utf8(s, len, u) \
5222 newSVpvn_flags((s), (len), (u) ? SVf_UTF8 : 0)
5224 SV* newSVpvn_flags(const char *const s, const STRLEN len, const U32 flags)
5229 =item newSVpvn_share
5232 Creates a new SV with its SvPVX_const pointing to a shared string in the string
5233 table. If the string does not already exist in the table, it is created
5234 first. Turns on READONLY and FAKE. If the C<hash> parameter is non-zero, that
5235 value is used; otherwise the hash is computed. The string's hash can be later
5236 be retrieved from the SV with the C<SvSHARED_HASH()> macro. The idea here is
5237 that as the string table is used for shared hash keys these strings will have
5238 SvPVX_const == HeKEY and hash lookup will avoid string compare.
5240 SV* newSVpvn_share(const char* s, I32 len, U32 hash)
5248 Like C<newSVpvn>, but takes a literal string instead of a string/length pair.
5250 SV* newSVpvs(const char* s)
5253 Found in file handy.h
5255 =item newSVpvs_flags
5258 Like C<newSVpvn_flags>, but takes a literal string instead of a string/length
5261 SV* newSVpvs_flags(const char* s, U32 flags)
5264 Found in file handy.h
5266 =item newSVpvs_share
5269 Like C<newSVpvn_share>, but takes a literal string instead of a string/length
5270 pair and omits the hash parameter.
5272 SV* newSVpvs_share(const char* s)
5275 Found in file handy.h
5280 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
5281 it will be upgraded to one. If C<classname> is non-null then the new SV will
5282 be blessed in the specified package. The new SV is returned and its
5283 reference count is 1.
5285 SV* newSVrv(SV *const rv, const char *const classname)
5293 Creates a new SV which is an exact duplicate of the original SV.
5296 SV* newSVsv(SV *const old)
5304 Creates a new SV and copies an unsigned integer into it.
5305 The reference count for the SV is set to 1.
5307 SV* newSVuv(const UV u)
5315 Creates a new SV, of the type specified. The reference count for the new SV
5318 SV* newSV_type(const svtype type)
5326 This function is only called on magical items, and is only used by
5327 sv_true() or its macro equivalent.
5329 bool sv_2bool(SV *const sv)
5337 Using various gambits, try to get a CV from an SV; in addition, try if
5338 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
5339 The flags in C<lref> are passed to sv_fetchsv.
5341 CV* sv_2cv(SV* sv, HV **const st, GV **const gvp, const I32 lref)
5349 Using various gambits, try to get an IO from an SV: the IO slot if its a
5350 GV; or the recursive result if we're an RV; or the IO slot of the symbol
5351 named after the PV if we're a string.
5353 IO* sv_2io(SV *const sv)
5361 Return the integer value of an SV, doing any necessary string
5362 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
5363 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
5365 IV sv_2iv_flags(SV *const sv, const I32 flags)
5373 Marks an existing SV as mortal. The SV will be destroyed "soon", either
5374 by an explicit call to FREETMPS, or by an implicit call at places such as
5375 statement boundaries. SvTEMP() is turned on which means that the SV's
5376 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
5377 and C<sv_mortalcopy>.
5379 SV* sv_2mortal(SV *const sv)
5387 Return the num value of an SV, doing any necessary string or integer
5388 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
5391 NV sv_2nv(SV *const sv)
5399 Return a pointer to the byte-encoded representation of the SV, and set *lp
5400 to its length. May cause the SV to be downgraded from UTF-8 as a
5403 Usually accessed via the C<SvPVbyte> macro.
5405 char* sv_2pvbyte(SV *const sv, STRLEN *const lp)
5413 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
5414 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
5416 Usually accessed via the C<SvPVutf8> macro.
5418 char* sv_2pvutf8(SV *const sv, STRLEN *const lp)
5426 Returns a pointer to the string value of an SV, and sets *lp to its length.
5427 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
5429 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
5430 usually end up here too.
5432 char* sv_2pv_flags(SV *const sv, STRLEN *const lp, const I32 flags)
5440 Return the unsigned integer value of an SV, doing any necessary string
5441 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
5442 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
5444 UV sv_2uv_flags(SV *const sv, const I32 flags)
5452 Remove any string offset. You should normally use the C<SvOOK_off> macro
5455 int sv_backoff(SV *const sv)
5463 Blesses an SV into a specified package. The SV must be an RV. The package
5464 must be designated by its stash (see C<gv_stashpv()>). The reference count
5465 of the SV is unaffected.
5467 SV* sv_bless(SV *const sv, HV *const stash)
5475 Concatenates the string onto the end of the string which is in the SV.
5476 If the SV has the UTF-8 status set, then the bytes appended should be
5477 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
5479 void sv_catpv(SV *const sv, const char* ptr)
5487 Processes its arguments like C<sprintf> and appends the formatted
5488 output to an SV. If the appended data contains "wide" characters
5489 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
5490 and characters >255 formatted with %c), the original SV might get
5491 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
5492 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
5493 valid UTF-8; if the original SV was bytes, the pattern should be too.
5495 void sv_catpvf(SV *const sv, const char *const pat, ...)
5503 Like C<sv_catpvf>, but also handles 'set' magic.
5505 void sv_catpvf_mg(SV *const sv, const char *const pat, ...)
5513 Concatenates the string onto the end of the string which is in the SV. The
5514 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5515 status set, then the bytes appended should be valid UTF-8.
5516 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
5518 void sv_catpvn(SV *dsv, const char *sstr, STRLEN len)
5523 =item sv_catpvn_flags
5526 Concatenates the string onto the end of the string which is in the SV. The
5527 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5528 status set, then the bytes appended should be valid UTF-8.
5529 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
5530 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
5531 in terms of this function.
5533 void sv_catpvn_flags(SV *const dstr, const char *sstr, const STRLEN len, const I32 flags)
5541 Like C<sv_catpvn>, but takes a literal string instead of a string/length pair.
5543 void sv_catpvs(SV* sv, const char* s)
5546 Found in file handy.h
5551 Like C<sv_catpv>, but also handles 'set' magic.
5553 void sv_catpv_mg(SV *const sv, const char *const ptr)
5561 Concatenates the string from SV C<ssv> onto the end of the string in
5562 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
5563 not 'set' magic. See C<sv_catsv_mg>.
5565 void sv_catsv(SV *dstr, SV *sstr)
5570 =item sv_catsv_flags
5573 Concatenates the string from SV C<ssv> onto the end of the string in
5574 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
5575 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
5576 and C<sv_catsv_nomg> are implemented in terms of this function.
5578 void sv_catsv_flags(SV *const dsv, SV *const ssv, const I32 flags)
5586 Efficient removal of characters from the beginning of the string buffer.
5587 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
5588 the string buffer. The C<ptr> becomes the first character of the adjusted
5589 string. Uses the "OOK hack".
5590 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
5591 refer to the same chunk of data.
5593 void sv_chop(SV *const sv, const char *const ptr)
5601 Clear an SV: call any destructors, free up any memory used by the body,
5602 and free the body itself. The SV's head is I<not> freed, although
5603 its type is set to all 1's so that it won't inadvertently be assumed
5604 to be live during global destruction etc.
5605 This function should only be called when REFCNT is zero. Most of the time
5606 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5609 void sv_clear(SV *const sv)
5617 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5618 string in C<sv1> is less than, equal to, or greater than the string in
5619 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5620 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
5622 I32 sv_cmp(SV *const sv1, SV *const sv2)
5630 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
5631 'use bytes' aware, handles get magic, and will coerce its args to strings
5632 if necessary. See also C<sv_cmp>.
5634 I32 sv_cmp_locale(SV *const sv1, SV *const sv2)
5642 Add Collate Transform magic to an SV if it doesn't already have it.
5644 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
5645 scalar data of the variable, but transformed to such a format that a normal
5646 memory comparison can be used to compare the data according to the locale
5649 char* sv_collxfrm(SV *const sv, STRLEN *const nxp)
5657 Copies a stringified representation of the source SV into the
5658 destination SV. Automatically performs any necessary mg_get and
5659 coercion of numeric values into strings. Guaranteed to preserve
5660 UTF8 flag even from overloaded objects. Similar in nature to
5661 sv_2pv[_flags] but operates directly on an SV instead of just the
5662 string. Mostly uses sv_2pv_flags to do its work, except when that
5663 would lose the UTF-8'ness of the PV.
5665 void sv_copypv(SV *const dsv, SV *const ssv)
5673 Auto-decrement of the value in the SV, doing string to numeric conversion
5674 if necessary. Handles 'get' magic.
5676 void sv_dec(SV *const sv)
5684 Returns a boolean indicating whether the strings in the two SVs are
5685 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5686 coerce its args to strings if necessary.
5688 I32 sv_eq(SV* sv1, SV* sv2)
5693 =item sv_force_normal_flags
5694 X<sv_force_normal_flags>
5696 Undo various types of fakery on an SV: if the PV is a shared string, make
5697 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
5698 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
5699 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
5700 then a copy-on-write scalar drops its PV buffer (if any) and becomes
5701 SvPOK_off rather than making a copy. (Used where this scalar is about to be
5702 set to some other value.) In addition, the C<flags> parameter gets passed to
5703 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
5704 with flags set to 0.
5706 void sv_force_normal_flags(SV *const sv, const U32 flags)
5714 Decrement an SV's reference count, and if it drops to zero, call
5715 C<sv_clear> to invoke destructors and free up any memory used by
5716 the body; finally, deallocate the SV's head itself.
5717 Normally called via a wrapper macro C<SvREFCNT_dec>.
5719 void sv_free(SV *const sv)
5727 Get a line from the filehandle and store it into the SV, optionally
5728 appending to the currently-stored string.
5730 char* sv_gets(SV *const sv, PerlIO *const fp, I32 append)
5738 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
5739 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
5740 Use the C<SvGROW> wrapper instead.
5742 char* sv_grow(SV *const sv, STRLEN newlen)
5750 Auto-increment of the value in the SV, doing string to numeric conversion
5751 if necessary. Handles 'get' magic.
5753 void sv_inc(SV *const sv)
5761 Inserts a string at the specified offset/length within the SV. Similar to
5762 the Perl substr() function. Handles get magic.
5764 void sv_insert(SV *const bigstr, const STRLEN offset, const STRLEN len, const char *const little, const STRLEN littlelen)
5769 =item sv_insert_flags
5772 Same as C<sv_insert>, but the extra C<flags> are passed the C<SvPV_force_flags> that applies to C<bigstr>.
5774 void sv_insert_flags(SV *const bigstr, const STRLEN offset, const STRLEN len, const char *const little, const STRLEN littlelen, const U32 flags)
5782 Returns a boolean indicating whether the SV is blessed into the specified
5783 class. This does not check for subtypes; use C<sv_derived_from> to verify
5784 an inheritance relationship.
5786 int sv_isa(SV* sv, const char *const name)
5794 Returns a boolean indicating whether the SV is an RV pointing to a blessed
5795 object. If the SV is not an RV, or if the object is not blessed, then this
5798 int sv_isobject(SV* sv)
5806 Returns the length of the string in the SV. Handles magic and type
5807 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5809 STRLEN sv_len(SV *const sv)
5817 Returns the number of characters in the string in an SV, counting wide
5818 UTF-8 bytes as a single character. Handles magic and type coercion.
5820 STRLEN sv_len_utf8(SV *const sv)
5828 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
5829 then adds a new magic item of type C<how> to the head of the magic list.
5831 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
5832 handling of the C<name> and C<namlen> arguments.
5834 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
5835 to add more than one instance of the same 'how'.
5837 void sv_magic(SV *const sv, SV *const obj, const int how, const char *const name, const I32 namlen)
5845 Adds magic to an SV, upgrading it if necessary. Applies the
5846 supplied vtable and returns a pointer to the magic added.
5848 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
5849 In particular, you can add magic to SvREADONLY SVs, and add more than
5850 one instance of the same 'how'.
5852 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
5853 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
5854 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
5855 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
5857 (This is now used as a subroutine by C<sv_magic>.)
5859 MAGIC * sv_magicext(SV *const sv, SV *const obj, const int how, const MGVTBL *const vtbl, const char *const name, const I32 namlen)
5867 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
5868 The new SV is marked as mortal. It will be destroyed "soon", either by an
5869 explicit call to FREETMPS, or by an implicit call at places such as
5870 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
5872 SV* sv_mortalcopy(SV *const oldsv)
5880 Creates a new null SV which is mortal. The reference count of the SV is
5881 set to 1. It will be destroyed "soon", either by an explicit call to
5882 FREETMPS, or by an implicit call at places such as statement boundaries.
5883 See also C<sv_mortalcopy> and C<sv_2mortal>.
5893 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5896 SV* sv_newref(SV *const sv)
5904 Converts the value pointed to by offsetp from a count of bytes from the
5905 start of the string, to a count of the equivalent number of UTF-8 chars.
5906 Handles magic and type coercion.
5908 void sv_pos_b2u(SV *const sv, I32 *const offsetp)
5916 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5917 the start of the string, to a count of the equivalent number of bytes; if
5918 lenp is non-zero, it does the same to lenp, but this time starting from
5919 the offset, rather than from the start of the string. Handles magic and
5922 void sv_pos_u2b(SV *const sv, I32 *const offsetp, I32 *const lenp)
5927 =item sv_pvbyten_force
5930 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
5932 char* sv_pvbyten_force(SV *const sv, STRLEN *const lp)
5940 Get a sensible string out of the SV somehow.
5941 A private implementation of the C<SvPV_force> macro for compilers which
5942 can't cope with complex macro expressions. Always use the macro instead.
5944 char* sv_pvn_force(SV* sv, STRLEN* lp)
5949 =item sv_pvn_force_flags
5950 X<sv_pvn_force_flags>
5952 Get a sensible string out of the SV somehow.
5953 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
5954 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
5955 implemented in terms of this function.
5956 You normally want to use the various wrapper macros instead: see
5957 C<SvPV_force> and C<SvPV_force_nomg>
5959 char* sv_pvn_force_flags(SV *const sv, STRLEN *const lp, const I32 flags)
5964 =item sv_pvutf8n_force
5967 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
5969 char* sv_pvutf8n_force(SV *const sv, STRLEN *const lp)
5977 Returns a string describing what the SV is a reference to.
5979 const char* sv_reftype(const SV *const sv, const int ob)
5987 Make the first argument a copy of the second, then delete the original.
5988 The target SV physically takes over ownership of the body of the source SV
5989 and inherits its flags; however, the target keeps any magic it owns,
5990 and any magic in the source is discarded.
5991 Note that this is a rather specialist SV copying operation; most of the
5992 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5994 void sv_replace(SV *const sv, SV *const nsv)
6002 Underlying implementation for the C<reset> Perl function.
6003 Note that the perl-level function is vaguely deprecated.
6005 void sv_reset(const char* s, HV *const stash)
6013 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
6014 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
6015 push a back-reference to this RV onto the array of backreferences
6016 associated with that magic. If the RV is magical, set magic will be
6017 called after the RV is cleared.
6019 SV* sv_rvweaken(SV *const sv)
6027 Copies an integer into the given SV, upgrading first if necessary.
6028 Does not handle 'set' magic. See also C<sv_setiv_mg>.
6030 void sv_setiv(SV *const sv, const IV num)
6038 Like C<sv_setiv>, but also handles 'set' magic.
6040 void sv_setiv_mg(SV *const sv, const IV i)
6048 Copies a double into the given SV, upgrading first if necessary.
6049 Does not handle 'set' magic. See also C<sv_setnv_mg>.
6051 void sv_setnv(SV *const sv, const NV num)
6059 Like C<sv_setnv>, but also handles 'set' magic.
6061 void sv_setnv_mg(SV *const sv, const NV num)
6069 Copies a string into an SV. The string must be null-terminated. Does not
6070 handle 'set' magic. See C<sv_setpv_mg>.
6072 void sv_setpv(SV *const sv, const char *const ptr)
6080 Works like C<sv_catpvf> but copies the text into the SV instead of
6081 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
6083 void sv_setpvf(SV *const sv, const char *const pat, ...)
6091 Like C<sv_setpvf>, but also handles 'set' magic.
6093 void sv_setpvf_mg(SV *const sv, const char *const pat, ...)
6101 Copies an integer into the given SV, also updating its string value.
6102 Does not handle 'set' magic. See C<sv_setpviv_mg>.
6104 void sv_setpviv(SV *const sv, const IV num)
6112 Like C<sv_setpviv>, but also handles 'set' magic.
6114 void sv_setpviv_mg(SV *const sv, const IV iv)
6122 Copies a string into an SV. The C<len> parameter indicates the number of
6123 bytes to be copied. If the C<ptr> argument is NULL the SV will become
6124 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
6126 void sv_setpvn(SV *const sv, const char *const ptr, const STRLEN len)
6134 Like C<sv_setpvn>, but also handles 'set' magic.
6136 void sv_setpvn_mg(SV *const sv, const char *const ptr, const STRLEN len)
6144 Like C<sv_setpvn>, but takes a literal string instead of a string/length pair.
6146 void sv_setpvs(SV* sv, const char* s)
6149 Found in file handy.h
6154 Like C<sv_setpv>, but also handles 'set' magic.
6156 void sv_setpv_mg(SV *const sv, const char *const ptr)
6164 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
6165 argument will be upgraded to an RV. That RV will be modified to point to
6166 the new SV. The C<classname> argument indicates the package for the
6167 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
6168 will have a reference count of 1, and the RV will be returned.
6170 SV* sv_setref_iv(SV *const rv, const char *const classname, const IV iv)
6178 Copies a double into a new SV, optionally blessing the SV. The C<rv>
6179 argument will be upgraded to an RV. That RV will be modified to point to
6180 the new SV. The C<classname> argument indicates the package for the
6181 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
6182 will have a reference count of 1, and the RV will be returned.
6184 SV* sv_setref_nv(SV *const rv, const char *const classname, const NV nv)
6192 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
6193 argument will be upgraded to an RV. That RV will be modified to point to
6194 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
6195 into the SV. The C<classname> argument indicates the package for the
6196 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
6197 will have a reference count of 1, and the RV will be returned.
6199 Do not use with other Perl types such as HV, AV, SV, CV, because those
6200 objects will become corrupted by the pointer copy process.
6202 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
6204 SV* sv_setref_pv(SV *const rv, const char *const classname, void *const pv)
6212 Copies a string into a new SV, optionally blessing the SV. The length of the
6213 string must be specified with C<n>. The C<rv> argument will be upgraded to
6214 an RV. That RV will be modified to point to the new SV. The C<classname>
6215 argument indicates the package for the blessing. Set C<classname> to
6216 C<NULL> to avoid the blessing. The new SV will have a reference count
6217 of 1, and the RV will be returned.
6219 Note that C<sv_setref_pv> copies the pointer while this copies the string.
6221 SV* sv_setref_pvn(SV *const rv, const char *const classname, const char *const pv, const STRLEN n)
6229 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
6230 argument will be upgraded to an RV. That RV will be modified to point to
6231 the new SV. The C<classname> argument indicates the package for the
6232 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
6233 will have a reference count of 1, and the RV will be returned.
6235 SV* sv_setref_uv(SV *const rv, const char *const classname, const UV uv)
6243 Copies the contents of the source SV C<ssv> into the destination SV
6244 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
6245 function if the source SV needs to be reused. Does not handle 'set' magic.
6246 Loosely speaking, it performs a copy-by-value, obliterating any previous
6247 content of the destination.
6249 You probably want to use one of the assortment of wrappers, such as
6250 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
6251 C<SvSetMagicSV_nosteal>.
6253 void sv_setsv(SV *dstr, SV *sstr)
6258 =item sv_setsv_flags
6261 Copies the contents of the source SV C<ssv> into the destination SV
6262 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
6263 function if the source SV needs to be reused. Does not handle 'set' magic.
6264 Loosely speaking, it performs a copy-by-value, obliterating any previous
6265 content of the destination.
6266 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
6267 C<ssv> if appropriate, else not. If the C<flags> parameter has the
6268 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
6269 and C<sv_setsv_nomg> are implemented in terms of this function.
6271 You probably want to use one of the assortment of wrappers, such as
6272 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
6273 C<SvSetMagicSV_nosteal>.
6275 This is the primary function for copying scalars, and most other
6276 copy-ish functions and macros use this underneath.
6278 void sv_setsv_flags(SV *dstr, SV *sstr, const I32 flags)
6286 Like C<sv_setsv>, but also handles 'set' magic.
6288 void sv_setsv_mg(SV *const dstr, SV *const sstr)
6296 Copies an unsigned integer into the given SV, upgrading first if necessary.
6297 Does not handle 'set' magic. See also C<sv_setuv_mg>.
6299 void sv_setuv(SV *const sv, const UV num)
6307 Like C<sv_setuv>, but also handles 'set' magic.
6309 void sv_setuv_mg(SV *const sv, const UV u)
6317 Test an SV for taintedness. Use C<SvTAINTED> instead.
6318 bool sv_tainted(SV *const sv)
6326 Returns true if the SV has a true value by Perl's rules.
6327 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
6328 instead use an in-line version.
6330 I32 sv_true(SV *const sv)
6338 Removes all magic of type C<type> from an SV.
6340 int sv_unmagic(SV *const sv, const int type)
6345 =item sv_unref_flags
6348 Unsets the RV status of the SV, and decrements the reference count of
6349 whatever was being referenced by the RV. This can almost be thought of
6350 as a reversal of C<newSVrv>. The C<cflags> argument can contain
6351 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
6352 (otherwise the decrementing is conditional on the reference count being
6353 different from one or the reference being a readonly SV).
6356 void sv_unref_flags(SV *const ref, const U32 flags)
6364 Untaint an SV. Use C<SvTAINTED_off> instead.
6365 void sv_untaint(SV *const sv)
6373 Upgrade an SV to a more complex form. Generally adds a new body type to the
6374 SV, then copies across as much information as possible from the old body.
6375 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
6377 void sv_upgrade(SV *const sv, svtype new_type)
6382 =item sv_usepvn_flags
6385 Tells an SV to use C<ptr> to find its string value. Normally the
6386 string is stored inside the SV but sv_usepvn allows the SV to use an
6387 outside string. The C<ptr> should point to memory that was allocated
6388 by C<malloc>. The string length, C<len>, must be supplied. By default
6389 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
6390 so that pointer should not be freed or used by the programmer after
6391 giving it to sv_usepvn, and neither should any pointers from "behind"
6392 that pointer (e.g. ptr + 1) be used.
6394 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
6395 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
6396 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
6397 C<len>, and already meets the requirements for storing in C<SvPVX>)
6399 void sv_usepvn_flags(SV *const sv, char* ptr, const STRLEN len, const U32 flags)
6404 =item sv_utf8_decode
6407 If the PV of the SV is an octet sequence in UTF-8
6408 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
6409 so that it looks like a character. If the PV contains only single-byte
6410 characters, the C<SvUTF8> flag stays being off.
6411 Scans PV for validity and returns false if the PV is invalid UTF-8.
6413 NOTE: this function is experimental and may change or be
6414 removed without notice.
6416 bool sv_utf8_decode(SV *const sv)
6421 =item sv_utf8_downgrade
6422 X<sv_utf8_downgrade>
6424 Attempts to convert the PV of an SV from characters to bytes.
6425 If the PV contains a character beyond byte, this conversion will fail;
6426 in this case, either returns false or, if C<fail_ok> is not
6429 This is not as a general purpose Unicode to byte encoding interface:
6430 use the Encode extension for that.
6432 NOTE: this function is experimental and may change or be
6433 removed without notice.
6435 bool sv_utf8_downgrade(SV *const sv, const bool fail_ok)
6440 =item sv_utf8_encode
6443 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
6444 flag off so that it looks like octets again.
6446 void sv_utf8_encode(SV *const sv)
6451 =item sv_utf8_upgrade
6454 Converts the PV of an SV to its UTF-8-encoded form.
6455 Forces the SV to string form if it is not already.
6456 Always sets the SvUTF8 flag to avoid future validity checks even
6457 if all the bytes have hibit clear.
6459 This is not as a general purpose byte encoding to Unicode interface:
6460 use the Encode extension for that.
6462 STRLEN sv_utf8_upgrade(SV *sv)
6467 =item sv_utf8_upgrade_flags
6468 X<sv_utf8_upgrade_flags>
6470 Converts the PV of an SV to its UTF-8-encoded form.
6471 Forces the SV to string form if it is not already.
6472 Always sets the SvUTF8 flag to avoid future validity checks even
6473 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
6474 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
6475 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
6477 This is not as a general purpose byte encoding to Unicode interface:
6478 use the Encode extension for that.
6480 STRLEN sv_utf8_upgrade_flags(SV *const sv, const I32 flags)
6488 Processes its arguments like C<vsprintf> and appends the formatted output
6489 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
6491 Usually used via its frontend C<sv_catpvf>.
6493 void sv_vcatpvf(SV *const sv, const char *const pat, va_list *const args)
6501 Processes its arguments like C<vsprintf> and appends the formatted output
6502 to an SV. Uses an array of SVs if the C style variable argument list is
6503 missing (NULL). When running with taint checks enabled, indicates via
6504 C<maybe_tainted> if results are untrustworthy (often due to the use of
6507 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
6509 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)
6517 Like C<sv_vcatpvf>, but also handles 'set' magic.
6519 Usually used via its frontend C<sv_catpvf_mg>.
6521 void sv_vcatpvf_mg(SV *const sv, const char *const pat, va_list *const args)
6529 Works like C<sv_vcatpvf> but copies the text into the SV instead of
6530 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
6532 Usually used via its frontend C<sv_setpvf>.
6534 void sv_vsetpvf(SV *const sv, const char *const pat, va_list *const args)
6542 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
6545 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
6547 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)
6555 Like C<sv_vsetpvf>, but also handles 'set' magic.
6557 Usually used via its frontend C<sv_setpvf_mg>.
6559 void sv_vsetpvf_mg(SV *const sv, const char *const pat, va_list *const args)
6567 =head1 Unicode Support
6571 =item bytes_from_utf8
6574 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
6575 Unlike C<utf8_to_bytes> but like C<bytes_to_utf8>, returns a pointer to
6576 the newly-created string, and updates C<len> to contain the new
6577 length. Returns the original string if no conversion occurs, C<len>
6578 is unchanged. Do nothing if C<is_utf8> points to 0. Sets C<is_utf8> to
6579 0 if C<s> is converted or contains all 7bit characters.
6581 NOTE: this function is experimental and may change or be
6582 removed without notice.
6584 U8* bytes_from_utf8(const U8 *s, STRLEN *len, bool *is_utf8)
6587 Found in file utf8.c
6592 Converts a string C<s> of length C<len> from ASCII into UTF-8 encoding.
6593 Returns a pointer to the newly-created string, and sets C<len> to
6594 reflect the new length.
6596 If you want to convert to UTF-8 from other encodings than ASCII,
6597 see sv_recode_to_utf8().
6599 NOTE: this function is experimental and may change or be
6600 removed without notice.
6602 U8* bytes_to_utf8(const U8 *s, STRLEN *len)
6605 Found in file utf8.c
6610 Return true if the strings s1 and s2 differ case-insensitively, false
6611 if not (if they are equal case-insensitively). If u1 is true, the
6612 string s1 is assumed to be in UTF-8-encoded Unicode. If u2 is true,
6613 the string s2 is assumed to be in UTF-8-encoded Unicode. If u1 or u2
6614 are false, the respective string is assumed to be in native 8-bit
6617 If the pe1 and pe2 are non-NULL, the scanning pointers will be copied
6618 in there (they will point at the beginning of the I<next> character).
6619 If the pointers behind pe1 or pe2 are non-NULL, they are the end
6620 pointers beyond which scanning will not continue under any
6621 circumstances. If the byte lengths l1 and l2 are non-zero, s1+l1 and
6622 s2+l2 will be used as goal end pointers that will also stop the scan,
6623 and which qualify towards defining a successful match: all the scans
6624 that define an explicit length must reach their goal pointers for
6625 a match to succeed).
6627 For case-insensitiveness, the "casefolding" of Unicode is used
6628 instead of upper/lowercasing both the characters, see
6629 http://www.unicode.org/unicode/reports/tr21/ (Case Mappings).
6631 I32 ibcmp_utf8(const char *s1, char **pe1, UV l1, bool u1, const char *s2, char **pe2, UV l2, bool u2)
6634 Found in file utf8.c
6639 Tests if some arbitrary number of bytes begins in a valid UTF-8
6640 character. Note that an INVARIANT (i.e. ASCII) character is a valid
6641 UTF-8 character. The actual number of bytes in the UTF-8 character
6642 will be returned if it is valid, otherwise 0.
6644 STRLEN is_utf8_char(const U8 *s)
6647 Found in file utf8.c
6649 =item is_utf8_string
6652 Returns true if first C<len> bytes of the given string form a valid
6653 UTF-8 string, false otherwise. Note that 'a valid UTF-8 string' does
6654 not mean 'a string that contains code points above 0x7F encoded in UTF-8'
6655 because a valid ASCII string is a valid UTF-8 string.
6657 See also is_utf8_string_loclen() and is_utf8_string_loc().
6659 bool is_utf8_string(const U8 *s, STRLEN len)
6662 Found in file utf8.c
6664 =item is_utf8_string_loc
6665 X<is_utf8_string_loc>
6667 Like is_utf8_string() but stores the location of the failure (in the
6668 case of "utf8ness failure") or the location s+len (in the case of
6669 "utf8ness success") in the C<ep>.
6671 See also is_utf8_string_loclen() and is_utf8_string().
6673 bool is_utf8_string_loc(const U8 *s, STRLEN len, const U8 **p)
6676 Found in file utf8.c
6678 =item is_utf8_string_loclen
6679 X<is_utf8_string_loclen>
6681 Like is_utf8_string() but stores the location of the failure (in the
6682 case of "utf8ness failure") or the location s+len (in the case of
6683 "utf8ness success") in the C<ep>, and the number of UTF-8
6684 encoded characters in the C<el>.
6686 See also is_utf8_string_loc() and is_utf8_string().
6688 bool is_utf8_string_loclen(const U8 *s, STRLEN len, const U8 **ep, STRLEN *el)
6691 Found in file utf8.c
6693 =item pv_uni_display
6696 Build to the scalar dsv a displayable version of the string spv,
6697 length len, the displayable version being at most pvlim bytes long
6698 (if longer, the rest is truncated and "..." will be appended).
6700 The flags argument can have UNI_DISPLAY_ISPRINT set to display
6701 isPRINT()able characters as themselves, UNI_DISPLAY_BACKSLASH
6702 to display the \\[nrfta\\] as the backslashed versions (like '\n')
6703 (UNI_DISPLAY_BACKSLASH is preferred over UNI_DISPLAY_ISPRINT for \\).
6704 UNI_DISPLAY_QQ (and its alias UNI_DISPLAY_REGEX) have both
6705 UNI_DISPLAY_BACKSLASH and UNI_DISPLAY_ISPRINT turned on.
6707 The pointer to the PV of the dsv is returned.
6709 char* pv_uni_display(SV *dsv, const U8 *spv, STRLEN len, STRLEN pvlim, UV flags)
6712 Found in file utf8.c
6717 The encoding is assumed to be an Encode object, the PV of the ssv is
6718 assumed to be octets in that encoding and decoding the input starts
6719 from the position which (PV + *offset) pointed to. The dsv will be
6720 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
6721 when the string tstr appears in decoding output or the input ends on
6722 the PV of the ssv. The value which the offset points will be modified
6723 to the last input position on the ssv.
6725 Returns TRUE if the terminator was found, else returns FALSE.
6727 bool sv_cat_decode(SV* dsv, SV *encoding, SV *ssv, int *offset, char* tstr, int tlen)
6732 =item sv_recode_to_utf8
6733 X<sv_recode_to_utf8>
6735 The encoding is assumed to be an Encode object, on entry the PV
6736 of the sv is assumed to be octets in that encoding, and the sv
6737 will be converted into Unicode (and UTF-8).
6739 If the sv already is UTF-8 (or if it is not POK), or if the encoding
6740 is not a reference, nothing is done to the sv. If the encoding is not
6741 an C<Encode::XS> Encoding object, bad things will happen.
6742 (See F<lib/encoding.pm> and L<Encode>).
6744 The PV of the sv is returned.
6746 char* sv_recode_to_utf8(SV* sv, SV *encoding)
6751 =item sv_uni_display
6754 Build to the scalar dsv a displayable version of the scalar sv,
6755 the displayable version being at most pvlim bytes long
6756 (if longer, the rest is truncated and "..." will be appended).
6758 The flags argument is as in pv_uni_display().
6760 The pointer to the PV of the dsv is returned.
6762 char* sv_uni_display(SV *dsv, SV *ssv, STRLEN pvlim, UV flags)
6765 Found in file utf8.c
6770 The "p" contains the pointer to the UTF-8 string encoding
6771 the character that is being converted.
6773 The "ustrp" is a pointer to the character buffer to put the
6774 conversion result to. The "lenp" is a pointer to the length
6777 The "swashp" is a pointer to the swash to use.
6779 Both the special and normal mappings are stored lib/unicore/To/Foo.pl,
6780 and loaded by SWASHNEW, using lib/utf8_heavy.pl. The special (usually,
6781 but not always, a multicharacter mapping), is tried first.
6783 The "special" is a string like "utf8::ToSpecLower", which means the
6784 hash %utf8::ToSpecLower. The access to the hash is through
6785 Perl_to_utf8_case().
6787 The "normal" is a string like "ToLower" which means the swash
6790 UV to_utf8_case(const U8 *p, U8* ustrp, STRLEN *lenp, SV **swashp, const char *normal, const char *special)
6793 Found in file utf8.c
6798 Convert the UTF-8 encoded character at p to its foldcase version and
6799 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6800 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6801 foldcase version may be longer than the original character (up to
6804 The first character of the foldcased version is returned
6805 (but note, as explained above, that there may be more.)
6807 UV to_utf8_fold(const U8 *p, U8* ustrp, STRLEN *lenp)
6810 Found in file utf8.c
6815 Convert the UTF-8 encoded character at p to its lowercase version and
6816 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6817 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6818 lowercase version may be longer than the original character.
6820 The first character of the lowercased version is returned
6821 (but note, as explained above, that there may be more.)
6823 UV to_utf8_lower(const U8 *p, U8* ustrp, STRLEN *lenp)
6826 Found in file utf8.c
6831 Convert the UTF-8 encoded character at p to its titlecase version and
6832 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6833 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6834 titlecase version may be longer than the original character.
6836 The first character of the titlecased version is returned
6837 (but note, as explained above, that there may be more.)
6839 UV to_utf8_title(const U8 *p, U8* ustrp, STRLEN *lenp)
6842 Found in file utf8.c
6847 Convert the UTF-8 encoded character at p to its uppercase version and
6848 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6849 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since
6850 the uppercase version may be longer than the original character.
6852 The first character of the uppercased version is returned
6853 (but note, as explained above, that there may be more.)
6855 UV to_utf8_upper(const U8 *p, U8* ustrp, STRLEN *lenp)
6858 Found in file utf8.c
6860 =item utf8n_to_uvchr
6865 Returns the native character value of the first character in the string
6867 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6868 length, in bytes, of that character.
6870 Allows length and flags to be passed to low level routine.
6872 UV utf8n_to_uvchr(const U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags)
6875 Found in file utf8.c
6877 =item utf8n_to_uvuni
6880 Bottom level UTF-8 decode routine.
6881 Returns the Unicode code point value of the first character in the string C<s>
6882 which is assumed to be in UTF-8 encoding and no longer than C<curlen>;
6883 C<retlen> will be set to the length, in bytes, of that character.
6885 If C<s> does not point to a well-formed UTF-8 character, the behaviour
6886 is dependent on the value of C<flags>: if it contains UTF8_CHECK_ONLY,
6887 it is assumed that the caller will raise a warning, and this function
6888 will silently just set C<retlen> to C<-1> and return zero. If the
6889 C<flags> does not contain UTF8_CHECK_ONLY, warnings about
6890 malformations will be given, C<retlen> will be set to the expected
6891 length of the UTF-8 character in bytes, and zero will be returned.
6893 The C<flags> can also contain various flags to allow deviations from
6894 the strict UTF-8 encoding (see F<utf8.h>).
6896 Most code should use utf8_to_uvchr() rather than call this directly.
6898 UV utf8n_to_uvuni(const U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags)
6901 Found in file utf8.c
6906 Returns the number of UTF-8 characters between the UTF-8 pointers C<a>
6909 WARNING: use only if you *know* that the pointers point inside the
6912 IV utf8_distance(const U8 *a, const U8 *b)
6915 Found in file utf8.c
6920 Return the UTF-8 pointer C<s> displaced by C<off> characters, either
6921 forward or backward.
6923 WARNING: do not use the following unless you *know* C<off> is within
6924 the UTF-8 data pointed to by C<s> *and* that on entry C<s> is aligned
6925 on the first byte of character or just after the last byte of a character.
6927 U8* utf8_hop(const U8 *s, I32 off)
6930 Found in file utf8.c
6935 Return the length of the UTF-8 char encoded string C<s> in characters.
6936 Stops at C<e> (inclusive). If C<e E<lt> s> or if the scan would end
6937 up past C<e>, croaks.
6939 STRLEN utf8_length(const U8* s, const U8 *e)
6942 Found in file utf8.c
6947 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
6948 Unlike C<bytes_to_utf8>, this over-writes the original string, and
6949 updates len to contain the new length.
6950 Returns zero on failure, setting C<len> to -1.
6952 If you need a copy of the string, see C<bytes_from_utf8>.
6954 NOTE: this function is experimental and may change or be
6955 removed without notice.
6957 U8* utf8_to_bytes(U8 *s, STRLEN *len)
6960 Found in file utf8.c
6965 Returns the native character value of the first character in the string C<s>
6966 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6967 length, in bytes, of that character.
6969 If C<s> does not point to a well-formed UTF-8 character, zero is
6970 returned and retlen is set, if possible, to -1.
6972 UV utf8_to_uvchr(const U8 *s, STRLEN *retlen)
6975 Found in file utf8.c
6980 Returns the Unicode code point of the first character in the string C<s>
6981 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6982 length, in bytes, of that character.
6984 This function should only be used when returned UV is considered
6985 an index into the Unicode semantic tables (e.g. swashes).
6987 If C<s> does not point to a well-formed UTF-8 character, zero is
6988 returned and retlen is set, if possible, to -1.
6990 UV utf8_to_uvuni(const U8 *s, STRLEN *retlen)
6993 Found in file utf8.c
6998 Adds the UTF-8 representation of the Native codepoint C<uv> to the end
6999 of the string C<d>; C<d> should be have at least C<UTF8_MAXBYTES+1> free
7000 bytes available. The return value is the pointer to the byte after the
7001 end of the new character. In other words,
7003 d = uvchr_to_utf8(d, uv);
7005 is the recommended wide native character-aware way of saying
7009 U8* uvchr_to_utf8(U8 *d, UV uv)
7012 Found in file utf8.c
7014 =item uvuni_to_utf8_flags
7015 X<uvuni_to_utf8_flags>
7017 Adds the UTF-8 representation of the Unicode codepoint C<uv> to the end
7018 of the string C<d>; C<d> should be have at least C<UTF8_MAXBYTES+1> free
7019 bytes available. The return value is the pointer to the byte after the
7020 end of the new character. In other words,
7022 d = uvuni_to_utf8_flags(d, uv, flags);
7026 d = uvuni_to_utf8(d, uv);
7028 (which is equivalent to)
7030 d = uvuni_to_utf8_flags(d, uv, 0);
7032 is the recommended Unicode-aware way of saying
7036 U8* uvuni_to_utf8_flags(U8 *d, UV uv, UV flags)
7039 Found in file utf8.c
7044 =head1 Variables created by C<xsubpp> and C<xsubpp> internal functions
7051 Variable which is setup by C<xsubpp> to indicate the stack base offset,
7052 used by the C<ST>, C<XSprePUSH> and C<XSRETURN> macros. The C<dMARK> macro
7053 must be called prior to setup the C<MARK> variable.
7058 Found in file XSUB.h
7063 Variable which is setup by C<xsubpp> to indicate the
7064 class name for a C++ XS constructor. This is always a C<char*>. See C<THIS>.
7069 Found in file XSUB.h
7074 Sets up the C<ax> variable.
7075 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
7080 Found in file XSUB.h
7085 Sets up the C<ax> variable and stack marker variable C<mark>.
7086 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
7091 Found in file XSUB.h
7096 Sets up the C<items> variable.
7097 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
7102 Found in file XSUB.h
7107 Sets up the C<padoff_du> variable for an XSUB that wishes to use
7113 Found in file XSUB.h
7118 Sets up stack and mark pointers for an XSUB, calling dSP and dMARK.
7119 Sets up the C<ax> and C<items> variables by calling C<dAX> and C<dITEMS>.
7120 This is usually handled automatically by C<xsubpp>.
7125 Found in file XSUB.h
7130 Sets up the C<ix> variable for an XSUB which has aliases. This is usually
7131 handled automatically by C<xsubpp>.
7136 Found in file XSUB.h
7141 Variable which is setup by C<xsubpp> to indicate the number of
7142 items on the stack. See L<perlxs/"Variable-length Parameter Lists">.
7147 Found in file XSUB.h
7152 Variable which is setup by C<xsubpp> to indicate which of an
7153 XSUB's aliases was used to invoke it. See L<perlxs/"The ALIAS: Keyword">.
7158 Found in file XSUB.h
7163 Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
7167 Found in file XSUB.h
7172 Variable which is setup by C<xsubpp> to hold the return value for an
7173 XSUB. This is always the proper type for the XSUB. See
7174 L<perlxs/"The RETVAL Variable">.
7179 Found in file XSUB.h
7184 Used to access elements on the XSUB's stack.
7189 Found in file XSUB.h
7194 Variable which is setup by C<xsubpp> to designate the object in a C++
7195 XSUB. This is always the proper type for the C++ object. See C<CLASS> and
7196 L<perlxs/"Using XS With C++">.
7201 Found in file XSUB.h
7206 The SV* corresponding to the $_ variable. Works even if there
7207 is a lexical $_ in scope.
7210 Found in file XSUB.h
7215 Macro to declare an XSUB and its C parameter list. This is handled by
7219 Found in file XSUB.h
7224 The version identifier for an XS module. This is usually
7225 handled automatically by C<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>.
7228 Found in file XSUB.h
7230 =item XS_VERSION_BOOTCHECK
7231 X<XS_VERSION_BOOTCHECK>
7233 Macro to verify that a PM module's $VERSION variable matches the XS
7234 module's C<XS_VERSION> variable. This is usually handled automatically by
7235 C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">.
7237 XS_VERSION_BOOTCHECK;
7240 Found in file XSUB.h
7245 =head1 Warning and Dieing
7252 This is the XSUB-writer's interface to Perl's C<die> function.
7253 Normally call this function the same way you call the C C<printf>
7254 function. Calling C<croak> returns control directly to Perl,
7255 sidestepping the normal C order of execution. See C<warn>.
7257 If you want to throw an exception object, assign the object to
7258 C<$@> and then pass C<NULL> to croak():
7260 errsv = get_sv("@", TRUE);
7261 sv_setsv(errsv, exception_object);
7264 void croak(const char* pat, ...)
7267 Found in file util.c
7272 This is the XSUB-writer's interface to Perl's C<warn> function. Call this
7273 function the same way you call the C C<printf> function. See C<croak>.
7275 void warn(const char* pat, ...)
7278 Found in file util.c
7285 Until May 1997, this document was maintained by Jeff Okamoto
7286 <okamoto@corp.hp.com>. It is now maintained as part of Perl itself.
7288 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
7289 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
7290 Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
7291 Stephen McCamant, and Gurusamy Sarathy.
7293 API Listing originally by Dean Roehrich <roehrich@cray.com>.
7295 Updated to be autogenerated from comments in the source by Benjamin Stuhl.
7299 perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
projects / p5sagit/p5-mst-13.2.git / blob