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
1235 =head1 Functions in file pp_sys.c
1243 Sets PL_defoutgv, the default file handle for output, to the passed in
1244 typeglob. As PL_defoutgv "owns" a reference on its typeglob, the reference
1245 count of the passed in typeglob is increased by one, and the reference count
1246 of the typeglob that PL_defoutgv points to is decreased by one.
1248 void setdefout(GV* gv)
1251 Found in file pp_sys.c
1263 Return the SV from the GV.
1273 If C<gv> is a typeglob whose subroutine entry is a constant sub eligible for
1274 inlining, or C<gv> is a placeholder reference that would be promoted to such
1275 a typeglob, then returns the value returned by the sub. Otherwise, returns
1278 SV* gv_const_sv(GV* gv)
1286 Returns the glob with the given C<name> and a defined subroutine or
1287 C<NULL>. The glob lives in the given C<stash>, or in the stashes
1288 accessible via @ISA and UNIVERSAL::.
1290 The argument C<level> should be either 0 or -1. If C<level==0>, as a
1291 side-effect creates a glob with the given C<name> in the given C<stash>
1292 which in the case of success contains an alias for the subroutine, and sets
1293 up caching info for this glob.
1295 This function grants C<"SUPER"> token as a postfix of the stash name. The
1296 GV returned from C<gv_fetchmeth> may be a method cache entry, which is not
1297 visible to Perl code. So when calling C<call_sv>, you should not use
1298 the GV directly; instead, you should use the method's CV, which can be
1299 obtained from the GV with the C<GvCV> macro.
1301 GV* gv_fetchmeth(HV* stash, const char* name, STRLEN len, I32 level)
1306 =item gv_fetchmethod_autoload
1307 X<gv_fetchmethod_autoload>
1309 Returns the glob which contains the subroutine to call to invoke the method
1310 on the C<stash>. In fact in the presence of autoloading this may be the
1311 glob for "AUTOLOAD". In this case the corresponding variable $AUTOLOAD is
1314 The third parameter of C<gv_fetchmethod_autoload> determines whether
1315 AUTOLOAD lookup is performed if the given method is not present: non-zero
1316 means yes, look for AUTOLOAD; zero means no, don't look for AUTOLOAD.
1317 Calling C<gv_fetchmethod> is equivalent to calling C<gv_fetchmethod_autoload>
1318 with a non-zero C<autoload> parameter.
1320 These functions grant C<"SUPER"> token as a prefix of the method name. Note
1321 that if you want to keep the returned glob for a long time, you need to
1322 check for it being "AUTOLOAD", since at the later time the call may load a
1323 different subroutine due to $AUTOLOAD changing its value. Use the glob
1324 created via a side effect to do this.
1326 These functions have the same side-effects and as C<gv_fetchmeth> with
1327 C<level==0>. C<name> should be writable if contains C<':'> or C<'
1328 ''>. The warning against passing the GV returned by C<gv_fetchmeth> to
1329 C<call_sv> apply equally to these functions.
1331 GV* gv_fetchmethod_autoload(HV* stash, const char* name, I32 autoload)
1336 =item gv_fetchmeth_autoload
1337 X<gv_fetchmeth_autoload>
1339 Same as gv_fetchmeth(), but looks for autoloaded subroutines too.
1340 Returns a glob for the subroutine.
1342 For an autoloaded subroutine without a GV, will create a GV even
1343 if C<level < 0>. For an autoloaded subroutine without a stub, GvCV()
1344 of the result may be zero.
1346 GV* gv_fetchmeth_autoload(HV* stash, const char* name, STRLEN len, I32 level)
1354 Returns a pointer to the stash for a specified package. Uses C<strlen> to
1355 determine the length of C<name>, then calls C<gv_stashpvn()>.
1357 HV* gv_stashpv(const char* name, I32 flags)
1365 Returns a pointer to the stash for a specified package. The C<namelen>
1366 parameter indicates the length of the C<name>, in bytes. C<flags> is passed
1367 to C<gv_fetchpvn_flags()>, so if set to C<GV_ADD> then the package will be
1368 created if it does not already exist. If the package does not exist and
1369 C<flags> is 0 (or any other setting that does not create packages) then NULL
1373 HV* gv_stashpvn(const char* name, U32 namelen, I32 flags)
1381 Like C<gv_stashpvn>, but takes a literal string instead of a string/length pair.
1383 HV* gv_stashpvs(const char* name, I32 create)
1386 Found in file handy.h
1391 Returns a pointer to the stash for a specified package. See C<gv_stashpvn>.
1393 HV* gv_stashsv(SV* sv, I32 flags)
1410 (deprecated - use C<(AV *)NULL> instead)
1418 Null character pointer. (No longer available when C<PERL_CORE> is defined.)
1421 Found in file handy.h
1428 (deprecated - use C<(CV *)NULL> instead)
1438 (deprecated - use C<(HV *)NULL> instead)
1446 Null SV pointer. (No longer available when C<PERL_CORE> is defined.)
1449 Found in file handy.h
1454 =head1 Hash Manipulation Functions
1461 Returns the HV of the specified Perl hash. If C<create> is set and the
1462 Perl variable does not exist then it will be created. If C<create> is not
1463 set and the variable does not exist then NULL is returned.
1465 NOTE: the perl_ form of this function is deprecated.
1467 HV* get_hv(const char* name, I32 create)
1470 Found in file perl.c
1475 This flag, used in the length slot of hash entries and magic structures,
1476 specifies the structure contains an C<SV*> pointer where a C<char*> pointer
1477 is to be expected. (For information only--not to be used).
1485 Returns the computed hash stored in the hash entry.
1495 Returns the actual pointer stored in the key slot of the hash entry. The
1496 pointer may be either C<char*> or C<SV*>, depending on the value of
1497 C<HeKLEN()>. Can be assigned to. The C<HePV()> or C<HeSVKEY()> macros are
1498 usually preferable for finding the value of a key.
1508 If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry
1509 holds an C<SV*> key. Otherwise, holds the actual length of the key. Can
1510 be assigned to. The C<HePV()> macro is usually preferable for finding key
1513 STRLEN HeKLEN(HE* he)
1521 Returns the key slot of the hash entry as a C<char*> value, doing any
1522 necessary dereferencing of possibly C<SV*> keys. The length of the string
1523 is placed in C<len> (this is a macro, so do I<not> use C<&len>). If you do
1524 not care about what the length of the key is, you may use the global
1525 variable C<PL_na>, though this is rather less efficient than using a local
1526 variable. Remember though, that hash keys in perl are free to contain
1527 embedded nulls, so using C<strlen()> or similar is not a good way to find
1528 the length of hash keys. This is very similar to the C<SvPV()> macro
1529 described elsewhere in this document. See also C<HeUTF8>.
1531 If you are using C<HePV> to get values to pass to C<newSVpvn()> to create a
1532 new SV, you should consider using C<newSVhek(HeKEY_hek(he))> as it is more
1535 char* HePV(HE* he, STRLEN len)
1543 Returns the key as an C<SV*>, or C<NULL> if the hash entry does not
1544 contain an C<SV*> key.
1554 Returns the key as an C<SV*>. Will create and return a temporary mortal
1555 C<SV*> if the hash entry contains only a C<char*> key.
1557 SV* HeSVKEY_force(HE* he)
1565 Sets the key to a given C<SV*>, taking care to set the appropriate flags to
1566 indicate the presence of an C<SV*> key, and returns the same
1569 SV* HeSVKEY_set(HE* he, SV* sv)
1577 Returns whether the C<char *> value returned by C<HePV> is encoded in UTF-8,
1578 doing any necessary dereferencing of possibly C<SV*> keys. The value returned
1579 will be 0 or non-0, not necessarily 1 (or even a value with any low bits set),
1580 so B<do not> blindly assign this to a C<bool> variable, as C<bool> may be a
1581 typedef for C<char>.
1583 char* HeUTF8(HE* he, STRLEN len)
1591 Returns the value slot (type C<SV*>) stored in the hash entry.
1601 Returns the package name of a stash, or NULL if C<stash> isn't a stash.
1602 See C<SvSTASH>, C<CvSTASH>.
1604 char* HvNAME(HV* stash)
1612 Check that a hash is in an internally consistent state.
1614 void hv_assert(HV *hv)
1622 Clears a hash, making it empty.
1624 void hv_clear(HV *hv)
1629 =item hv_clear_placeholders
1630 X<hv_clear_placeholders>
1632 Clears any placeholders from a hash. If a restricted hash has any of its keys
1633 marked as readonly and the key is subsequently deleted, the key is not actually
1634 deleted but is marked by assigning it a value of &PL_sv_placeholder. This tags
1635 it so it will be ignored by future operations such as iterating over the hash,
1636 but will still allow the hash to have a value reassigned to the key at some
1637 future point. This function clears any such placeholder keys from the hash.
1638 See Hash::Util::lock_keys() for an example of its use.
1640 void hv_clear_placeholders(HV *hv)
1648 Deletes a key/value pair in the hash. The value SV is removed from the
1649 hash and returned to the caller. The C<klen> is the length of the key.
1650 The C<flags> value will normally be zero; if set to G_DISCARD then NULL
1653 SV* hv_delete(HV *hv, const char *key, I32 klen, I32 flags)
1661 Deletes a key/value pair in the hash. The value SV is removed from the
1662 hash and returned to the caller. The C<flags> value will normally be zero;
1663 if set to G_DISCARD then NULL will be returned. C<hash> can be a valid
1664 precomputed hash value, or 0 to ask for it to be computed.
1666 SV* hv_delete_ent(HV *hv, SV *keysv, I32 flags, U32 hash)
1674 Returns a boolean indicating whether the specified hash key exists. The
1675 C<klen> is the length of the key.
1677 bool hv_exists(HV *hv, const char *key, I32 klen)
1685 Returns a boolean indicating whether the specified hash key exists. C<hash>
1686 can be a valid precomputed hash value, or 0 to ask for it to be
1689 bool hv_exists_ent(HV *hv, SV *keysv, U32 hash)
1697 Returns the SV which corresponds to the specified key in the hash. The
1698 C<klen> is the length of the key. If C<lval> is set then the fetch will be
1699 part of a store. Check that the return value is non-null before
1700 dereferencing it to an C<SV*>.
1702 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1703 information on how to use this function on tied hashes.
1705 SV** hv_fetch(HV *hv, const char *key, I32 klen, I32 lval)
1713 Like C<hv_fetch>, but takes a literal string instead of a string/length pair.
1715 SV** hv_fetchs(HV* tb, const char* key, I32 lval)
1718 Found in file handy.h
1723 Returns the hash entry which corresponds to the specified key in the hash.
1724 C<hash> must be a valid precomputed hash number for the given C<key>, or 0
1725 if you want the function to compute it. IF C<lval> is set then the fetch
1726 will be part of a store. Make sure the return value is non-null before
1727 accessing it. The return value when C<tb> is a tied hash is a pointer to a
1728 static location, so be sure to make a copy of the structure if you need to
1731 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1732 information on how to use this function on tied hashes.
1734 HE* hv_fetch_ent(HV *hv, SV *keysv, I32 lval, U32 hash)
1742 Prepares a starting point to traverse a hash table. Returns the number of
1743 keys in the hash (i.e. the same as C<HvKEYS(tb)>). The return value is
1744 currently only meaningful for hashes without tie magic.
1746 NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
1747 hash buckets that happen to be in use. If you still need that esoteric
1748 value, you can get it through the macro C<HvFILL(tb)>.
1751 I32 hv_iterinit(HV *hv)
1759 Returns the key from the current position of the hash iterator. See
1762 char* hv_iterkey(HE* entry, I32* retlen)
1770 Returns the key as an C<SV*> from the current position of the hash
1771 iterator. The return value will always be a mortal copy of the key. Also
1774 SV* hv_iterkeysv(HE* entry)
1782 Returns entries from a hash iterator. See C<hv_iterinit>.
1784 You may call C<hv_delete> or C<hv_delete_ent> on the hash entry that the
1785 iterator currently points to, without losing your place or invalidating your
1786 iterator. Note that in this case the current entry is deleted from the hash
1787 with your iterator holding the last reference to it. Your iterator is flagged
1788 to free the entry on the next call to C<hv_iternext>, so you must not discard
1789 your iterator immediately else the entry will leak - call C<hv_iternext> to
1790 trigger the resource deallocation.
1792 HE* hv_iternext(HV *hv)
1800 Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
1803 SV* hv_iternextsv(HV *hv, char **key, I32 *retlen)
1808 =item hv_iternext_flags
1809 X<hv_iternext_flags>
1811 Returns entries from a hash iterator. See C<hv_iterinit> and C<hv_iternext>.
1812 The C<flags> value will normally be zero; if HV_ITERNEXT_WANTPLACEHOLDERS is
1813 set the placeholders keys (for restricted hashes) will be returned in addition
1814 to normal keys. By default placeholders are automatically skipped over.
1815 Currently a placeholder is implemented with a value that is
1816 C<&Perl_sv_placeholder>. Note that the implementation of placeholders and
1817 restricted hashes may change, and the implementation currently is
1818 insufficiently abstracted for any change to be tidy.
1820 NOTE: this function is experimental and may change or be
1821 removed without notice.
1823 HE* hv_iternext_flags(HV *hv, I32 flags)
1831 Returns the value from the current position of the hash iterator. See
1834 SV* hv_iterval(HV *hv, HE *entry)
1842 Adds magic to a hash. See C<sv_magic>.
1844 void hv_magic(HV *hv, GV *gv, int how)
1852 Evaluates the hash in scalar context and returns the result. Handles magic when the hash is tied.
1854 SV* hv_scalar(HV *hv)
1862 Stores an SV in a hash. The hash key is specified as C<key> and C<klen> is
1863 the length of the key. The C<hash> parameter is the precomputed hash
1864 value; if it is zero then Perl will compute it. The return value will be
1865 NULL if the operation failed or if the value did not need to be actually
1866 stored within the hash (as in the case of tied hashes). Otherwise it can
1867 be dereferenced to get the original C<SV*>. Note that the caller is
1868 responsible for suitably incrementing the reference count of C<val> before
1869 the call, and decrementing it if the function returned NULL. Effectively
1870 a successful hv_store takes ownership of one reference to C<val>. This is
1871 usually what you want; a newly created SV has a reference count of one, so
1872 if all your code does is create SVs then store them in a hash, hv_store
1873 will own the only reference to the new SV, and your code doesn't need to do
1874 anything further to tidy up. hv_store is not implemented as a call to
1875 hv_store_ent, and does not create a temporary SV for the key, so if your
1876 key data is not already in SV form then use hv_store in preference to
1879 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1880 information on how to use this function on tied hashes.
1882 SV** hv_store(HV *hv, const char *key, I32 klen, SV *val, U32 hash)
1890 Like C<hv_store>, but takes a literal string instead of a string/length pair
1891 and omits the hash parameter.
1893 SV** hv_stores(HV* tb, const char* key, NULLOK SV* val)
1896 Found in file handy.h
1901 Stores C<val> in a hash. The hash key is specified as C<key>. The C<hash>
1902 parameter is the precomputed hash value; if it is zero then Perl will
1903 compute it. The return value is the new hash entry so created. It will be
1904 NULL if the operation failed or if the value did not need to be actually
1905 stored within the hash (as in the case of tied hashes). Otherwise the
1906 contents of the return value can be accessed using the C<He?> macros
1907 described here. Note that the caller is responsible for suitably
1908 incrementing the reference count of C<val> before the call, and
1909 decrementing it if the function returned NULL. Effectively a successful
1910 hv_store_ent takes ownership of one reference to C<val>. This is
1911 usually what you want; a newly created SV has a reference count of one, so
1912 if all your code does is create SVs then store them in a hash, hv_store
1913 will own the only reference to the new SV, and your code doesn't need to do
1914 anything further to tidy up. Note that hv_store_ent only reads the C<key>;
1915 unlike C<val> it does not take ownership of it, so maintaining the correct
1916 reference count on C<key> is entirely the caller's responsibility. hv_store
1917 is not implemented as a call to hv_store_ent, and does not create a temporary
1918 SV for the key, so if your key data is not already in SV form then use
1919 hv_store in preference to hv_store_ent.
1921 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1922 information on how to use this function on tied hashes.
1924 HE* hv_store_ent(HV *hv, SV *key, SV *val, U32 hash)
1934 void hv_undef(HV *hv)
1942 Creates a new HV. The reference count is set to 1.
1952 =head1 Magical Functions
1959 Clear something magical that the SV represents. See C<sv_magic>.
1961 int mg_clear(SV* sv)
1969 Copies the magic from one SV to another. See C<sv_magic>.
1971 int mg_copy(SV *sv, SV *nsv, const char *key, I32 klen)
1979 Finds the magic pointer for type matching the SV. See C<sv_magic>.
1981 MAGIC* mg_find(const SV* sv, int type)
1989 Free any magic storage used by the SV. See C<sv_magic>.
1999 Do magic after a value is retrieved from the SV. See C<sv_magic>.
2009 Report on the SV's length. See C<sv_magic>.
2011 U32 mg_length(SV* sv)
2019 Turns on the magical status of an SV. See C<sv_magic>.
2021 void mg_magical(SV* sv)
2029 Do magic after a value is assigned to the SV. See C<sv_magic>.
2039 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
2040 argument more than once.
2042 void SvGETMAGIC(SV* sv)
2050 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
2061 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
2062 argument more than once.
2064 void SvSETMAGIC(SV* sv)
2072 Like C<SvSetSV>, but does any set magic required afterwards.
2074 void SvSetMagicSV(SV* dsb, SV* ssv)
2079 =item SvSetMagicSV_nosteal
2080 X<SvSetMagicSV_nosteal>
2082 Like C<SvSetSV_nosteal>, but does any set magic required afterwards.
2084 void SvSetMagicSV_nosteal(SV* dsv, SV* ssv)
2092 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
2095 void SvSetSV(SV* dsb, SV* ssv)
2100 =item SvSetSV_nosteal
2103 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
2104 ssv. May evaluate arguments more than once.
2106 void SvSetSV_nosteal(SV* dsv, SV* ssv)
2114 Arranges for sv to be shared between threads if a suitable module
2117 void SvSHARE(SV* sv)
2125 Releases a mutual exclusion lock on sv if a suitable module
2128 void SvUNLOCK(SV* sv)
2136 =head1 Memory Management
2143 The XSUB-writer's interface to the C C<memcpy> function. The C<src> is the
2144 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
2145 the type. May fail on overlapping copies. See also C<Move>.
2147 void Copy(void* src, void* dest, int nitems, type)
2150 Found in file handy.h
2155 Like C<Copy> but returns dest. Useful for encouraging compilers to tail-call
2158 void * CopyD(void* src, void* dest, int nitems, type)
2161 Found in file handy.h
2166 The XSUB-writer's interface to the C C<memmove> function. The C<src> is the
2167 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
2168 the type. Can do overlapping moves. See also C<Copy>.
2170 void Move(void* src, void* dest, int nitems, type)
2173 Found in file handy.h
2178 Like C<Move> but returns dest. Useful for encouraging compilers to tail-call
2181 void * MoveD(void* src, void* dest, int nitems, type)
2184 Found in file handy.h
2189 The XSUB-writer's interface to the C C<malloc> function.
2191 In 5.9.3, Newx() and friends replace the older New() API, and drops
2192 the first parameter, I<x>, a debug aid which allowed callers to identify
2193 themselves. This aid has been superseded by a new build option,
2194 PERL_MEM_LOG (see L<perlhack/PERL_MEM_LOG>). The older API is still
2195 there for use in XS modules supporting older perls.
2197 void Newx(void* ptr, int nitems, type)
2200 Found in file handy.h
2205 The XSUB-writer's interface to the C C<malloc> function, with
2206 cast. See also C<Newx>.
2208 void Newxc(void* ptr, int nitems, type, cast)
2211 Found in file handy.h
2216 The XSUB-writer's interface to the C C<malloc> function. The allocated
2217 memory is zeroed with C<memzero>. See also C<Newx>.
2219 void Newxz(void* ptr, int nitems, type)
2222 Found in file handy.h
2227 PoisonWith(0xEF) for catching access to freed memory.
2229 void Poison(void* dest, int nitems, type)
2232 Found in file handy.h
2237 PoisonWith(0xEF) for catching access to freed memory.
2239 void PoisonFree(void* dest, int nitems, type)
2242 Found in file handy.h
2247 PoisonWith(0xAB) for catching access to allocated but uninitialized memory.
2249 void PoisonNew(void* dest, int nitems, type)
2252 Found in file handy.h
2257 Fill up memory with a byte pattern (a byte repeated over and over
2258 again) that hopefully catches attempts to access uninitialized memory.
2260 void PoisonWith(void* dest, int nitems, type, U8 byte)
2263 Found in file handy.h
2268 The XSUB-writer's interface to the C C<realloc> function.
2270 void Renew(void* ptr, int nitems, type)
2273 Found in file handy.h
2278 The XSUB-writer's interface to the C C<realloc> function, with
2281 void Renewc(void* ptr, int nitems, type, cast)
2284 Found in file handy.h
2289 The XSUB-writer's interface to the C C<free> function.
2291 void Safefree(void* ptr)
2294 Found in file handy.h
2299 Perl's version of C<strdup()>. Returns a pointer to a newly allocated
2300 string which is a duplicate of C<pv>. The size of the string is
2301 determined by C<strlen()>. The memory allocated for the new string can
2302 be freed with the C<Safefree()> function.
2304 char* savepv(const char* pv)
2307 Found in file util.c
2312 Perl's version of what C<strndup()> would be if it existed. Returns a
2313 pointer to a newly allocated string which is a duplicate of the first
2314 C<len> bytes from C<pv>, plus a trailing NUL byte. The memory allocated for
2315 the new string can be freed with the C<Safefree()> function.
2317 char* savepvn(const char* pv, I32 len)
2320 Found in file util.c
2325 Like C<savepvn>, but takes a literal string instead of a string/length pair.
2327 char* savepvs(const char* s)
2330 Found in file handy.h
2335 A version of C<savepv()> which allocates the duplicate string in memory
2336 which is shared between threads.
2338 char* savesharedpv(const char* pv)
2341 Found in file util.c
2346 A version of C<savepvn()> which allocates the duplicate string in memory
2347 which is shared between threads. (With the specific difference that a NULL
2348 pointer is not acceptable)
2350 char* savesharedpvn(const char *const pv, const STRLEN len)
2353 Found in file util.c
2358 A version of C<savepv()>/C<savepvn()> which gets the string to duplicate from
2359 the passed in SV using C<SvPV()>
2361 char* savesvpv(SV* sv)
2364 Found in file util.c
2369 This is an architecture-independent macro to copy one structure to another.
2371 void StructCopy(type src, type dest, type)
2374 Found in file handy.h
2379 The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the
2380 destination, C<nitems> is the number of items, and C<type> is the type.
2382 void Zero(void* dest, int nitems, type)
2385 Found in file handy.h
2390 Like C<Zero> but returns dest. Useful for encouraging compilers to tail-call
2393 void * ZeroD(void* dest, int nitems, type)
2396 Found in file handy.h
2401 =head1 Miscellaneous Functions
2408 Analyses the string in order to make fast searches on it using fbm_instr()
2409 -- the Boyer-Moore algorithm.
2411 void fbm_compile(SV* sv, U32 flags)
2414 Found in file util.c
2419 Returns the location of the SV in the string delimited by C<str> and
2420 C<strend>. It returns C<NULL> if the string can't be found. The C<sv>
2421 does not have to be fbm_compiled, but the search will not be as fast
2424 char* fbm_instr(unsigned char* big, unsigned char* bigend, SV* littlestr, U32 flags)
2427 Found in file util.c
2432 Takes a sprintf-style format pattern and conventional
2433 (non-SV) arguments and returns the formatted string.
2435 (char *) Perl_form(pTHX_ const char* pat, ...)
2437 can be used any place a string (char *) is required:
2439 char * s = Perl_form("%d.%d",major,minor);
2441 Uses a single private buffer so if you want to format several strings you
2442 must explicitly copy the earlier strings away (and free the copies when you
2445 char* form(const char* pat, ...)
2448 Found in file util.c
2453 Fill the sv with current working directory
2455 int getcwd_sv(SV* sv)
2458 Found in file util.c
2463 The C library C<snprintf> functionality, if available and
2464 standards-compliant (uses C<vsnprintf>, actually). However, if the
2465 C<vsnprintf> is not available, will unfortunately use the unsafe
2466 C<vsprintf> which can overrun the buffer (there is an overrun check,
2467 but that may be too late). Consider using C<sv_vcatpvf> instead, or
2468 getting C<vsnprintf>.
2470 int my_snprintf(char *buffer, const Size_t len, const char *format, ...)
2473 Found in file util.c
2478 The C library C<sprintf>, wrapped if necessary, to ensure that it will return
2479 the length of the string written to the buffer. Only rare pre-ANSI systems
2480 need the wrapper function - usually this is a direct call to C<sprintf>.
2482 int my_sprintf(char *buffer, const char *pat, ...)
2485 Found in file util.c
2490 The C library C<vsnprintf> if available and standards-compliant.
2491 However, if if the C<vsnprintf> is not available, will unfortunately
2492 use the unsafe C<vsprintf> which can overrun the buffer (there is an
2493 overrun check, but that may be too late). Consider using
2494 C<sv_vcatpvf> instead, or getting C<vsnprintf>.
2496 int my_vsnprintf(char *buffer, const Size_t len, const char *format, va_list ap)
2499 Found in file util.c
2504 Returns a new version object based on the passed in SV:
2506 SV *sv = new_version(SV *ver);
2508 Does not alter the passed in ver SV. See "upg_version" if you
2509 want to upgrade the SV.
2511 SV* new_version(SV *ver)
2514 Found in file util.c
2519 Returns a pointer to the next character after the parsed
2520 version string, as well as upgrading the passed in SV to
2523 Function must be called with an already existing SV like
2526 s = scan_version(s, SV *sv, bool qv);
2528 Performs some preprocessing to the string to ensure that
2529 it has the correct characteristics of a version. Flags the
2530 object if it contains an underscore (which denotes this
2531 is an alpha version). The boolean qv denotes that the version
2532 should be interpreted as if it had multiple decimals, even if
2535 const char* scan_version(const char *s, SV *rv, bool qv)
2538 Found in file util.c
2543 Test two strings to see if they are equal. Returns true or false.
2545 bool strEQ(char* s1, char* s2)
2548 Found in file handy.h
2553 Test two strings to see if the first, C<s1>, is greater than or equal to
2554 the second, C<s2>. Returns true or false.
2556 bool strGE(char* s1, char* s2)
2559 Found in file handy.h
2564 Test two strings to see if the first, C<s1>, is greater than the second,
2565 C<s2>. Returns true or false.
2567 bool strGT(char* s1, char* s2)
2570 Found in file handy.h
2575 Test two strings to see if the first, C<s1>, is less than or equal to the
2576 second, C<s2>. Returns true or false.
2578 bool strLE(char* s1, char* s2)
2581 Found in file handy.h
2586 Test two strings to see if the first, C<s1>, is less than the second,
2587 C<s2>. Returns true or false.
2589 bool strLT(char* s1, char* s2)
2592 Found in file handy.h
2597 Test two strings to see if they are different. Returns true or
2600 bool strNE(char* s1, char* s2)
2603 Found in file handy.h
2608 Test two strings to see if they are equal. The C<len> parameter indicates
2609 the number of bytes to compare. Returns true or false. (A wrapper for
2612 bool strnEQ(char* s1, char* s2, STRLEN len)
2615 Found in file handy.h
2620 Test two strings to see if they are different. The C<len> parameter
2621 indicates the number of bytes to compare. Returns true or false. (A
2622 wrapper for C<strncmp>).
2624 bool strnNE(char* s1, char* s2, STRLEN len)
2627 Found in file handy.h
2629 =item sv_destroyable
2632 Dummy routine which reports that object can be destroyed when there is no
2633 sharing module present. It ignores its single SV argument, and returns
2634 'true'. Exists to avoid test for a NULL function pointer and because it
2635 could potentially warn under some level of strict-ness.
2637 bool sv_destroyable(SV *sv)
2640 Found in file util.c
2645 Dummy routine which "shares" an SV when there is no sharing module present.
2646 Or "locks" it. Or "unlocks" it. In other words, ignores its single SV argument.
2647 Exists to avoid test for a NULL function pointer and because it could
2648 potentially warn under some level of strict-ness.
2650 void sv_nosharing(SV *sv)
2653 Found in file util.c
2658 In-place upgrade of the supplied SV to a version object.
2660 SV *sv = upg_version(SV *sv, bool qv);
2662 Returns a pointer to the upgraded SV. Set the boolean qv if you want
2663 to force this SV to be interpreted as an "extended" version.
2665 SV* upg_version(SV *ver, bool qv)
2668 Found in file util.c
2673 Version object aware cmp. Both operands must already have been
2674 converted into version objects.
2676 int vcmp(SV *lhv, SV *rhv)
2679 Found in file util.c
2684 Accepts a version object and returns the normalized string
2685 representation. Call like:
2689 NOTE: you can pass either the object directly or the SV
2690 contained within the RV.
2695 Found in file util.c
2700 Accepts a version object and returns the normalized floating
2701 point representation. Call like:
2705 NOTE: you can pass either the object directly or the SV
2706 contained within the RV.
2711 Found in file util.c
2716 In order to maintain maximum compatibility with earlier versions
2717 of Perl, this function will return either the floating point
2718 notation or the multiple dotted notation, depending on whether
2719 the original version contained 1 or more dots, respectively
2721 SV* vstringify(SV *vs)
2724 Found in file util.c
2729 Validates that the SV contains a valid version object.
2731 bool vverify(SV *vobj);
2733 Note that it only confirms the bare minimum structure (so as not to get
2734 confused by derived classes which may contain additional hash entries):
2736 bool vverify(SV *vs)
2739 Found in file util.c
2744 =head1 MRO Functions
2748 =item mro_get_linear_isa
2749 X<mro_get_linear_isa>
2751 Returns either C<mro_get_linear_isa_c3> or
2752 C<mro_get_linear_isa_dfs> for the given stash,
2753 dependant upon which MRO is in effect
2754 for that stash. The return value is a
2757 You are responsible for C<SvREFCNT_inc()> on the
2758 return value if you plan to store it anywhere
2759 semi-permanently (otherwise it might be deleted
2760 out from under you the next time the cache is
2763 AV* mro_get_linear_isa(HV* stash)
2768 =item mro_method_changed_in
2769 X<mro_method_changed_in>
2771 Invalidates method caching on any child classes
2772 of the given stash, so that they might notice
2773 the changes in this one.
2775 Ideally, all instances of C<PL_sub_generation++> in
2776 perl source outside of C<mro.c> should be
2777 replaced by calls to this.
2779 Perl automatically handles most of the common
2780 ways a method might be redefined. However, there
2781 are a few ways you could change a method in a stash
2782 without the cache code noticing, in which case you
2783 need to call this method afterwards:
2785 1) Directly manipulating the stash HV entries from
2788 2) Assigning a reference to a readonly scalar
2789 constant into a stash entry in order to create
2790 a constant subroutine (like constant.pm
2793 This same method is available from pure perl
2794 via, C<mro::method_changed_in(classname)>.
2796 void mro_method_changed_in(HV* stash)
2804 =head1 Multicall Functions
2811 Declare local variables for a multicall. See L<perlcall/Lightweight Callbacks>.
2821 Make a lightweight callback. See L<perlcall/Lightweight Callbacks>.
2831 Closing bracket for a lightweight callback.
2832 See L<perlcall/Lightweight Callbacks>.
2839 =item PUSH_MULTICALL
2842 Opening bracket for a lightweight callback.
2843 See L<perlcall/Lightweight Callbacks>.
2853 =head1 Numeric functions
2860 converts a string representing a binary number to numeric form.
2862 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2863 conversion flags, and I<result> should be NULL or a pointer to an NV.
2864 The scan stops at the end of the string, or the first invalid character.
2865 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2866 invalid character will also trigger a warning.
2867 On return I<*len> is set to the length of the scanned string,
2868 and I<*flags> gives output flags.
2870 If the value is <= C<UV_MAX> it is returned as a UV, the output flags are clear,
2871 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_bin>
2872 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2873 and writes the value to I<*result> (or the value is discarded if I<result>
2876 The binary number may optionally be prefixed with "0b" or "b" unless
2877 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
2878 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the binary
2879 number may use '_' characters to separate digits.
2881 UV grok_bin(const char* start, STRLEN* len_p, I32* flags, NV *result)
2884 Found in file numeric.c
2889 converts a string representing a hex number to numeric form.
2891 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2892 conversion flags, and I<result> should be NULL or a pointer to an NV.
2893 The scan stops at the end of the string, or the first invalid character.
2894 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2895 invalid character will also trigger a warning.
2896 On return I<*len> is set to the length of the scanned string,
2897 and I<*flags> gives output flags.
2899 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2900 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_hex>
2901 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2902 and writes the value to I<*result> (or the value is discarded if I<result>
2905 The hex number may optionally be prefixed with "0x" or "x" unless
2906 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
2907 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the hex
2908 number may use '_' characters to separate digits.
2910 UV grok_hex(const char* start, STRLEN* len_p, I32* flags, NV *result)
2913 Found in file numeric.c
2918 Recognise (or not) a number. The type of the number is returned
2919 (0 if unrecognised), otherwise it is a bit-ORed combination of
2920 IS_NUMBER_IN_UV, IS_NUMBER_GREATER_THAN_UV_MAX, IS_NUMBER_NOT_INT,
2921 IS_NUMBER_NEG, IS_NUMBER_INFINITY, IS_NUMBER_NAN (defined in perl.h).
2923 If the value of the number can fit an in UV, it is returned in the *valuep
2924 IS_NUMBER_IN_UV will be set to indicate that *valuep is valid, IS_NUMBER_IN_UV
2925 will never be set unless *valuep is valid, but *valuep may have been assigned
2926 to during processing even though IS_NUMBER_IN_UV is not set on return.
2927 If valuep is NULL, IS_NUMBER_IN_UV will be set for the same cases as when
2928 valuep is non-NULL, but no actual assignment (or SEGV) will occur.
2930 IS_NUMBER_NOT_INT will be set with IS_NUMBER_IN_UV if trailing decimals were
2931 seen (in which case *valuep gives the true value truncated to an integer), and
2932 IS_NUMBER_NEG if the number is negative (in which case *valuep holds the
2933 absolute value). IS_NUMBER_IN_UV is not set if e notation was used or the
2934 number is larger than a UV.
2936 int grok_number(const char *pv, STRLEN len, UV *valuep)
2939 Found in file numeric.c
2941 =item grok_numeric_radix
2942 X<grok_numeric_radix>
2944 Scan and skip for a numeric decimal separator (radix).
2946 bool grok_numeric_radix(const char **sp, const char *send)
2949 Found in file numeric.c
2954 converts a string representing an octal number to numeric form.
2956 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2957 conversion flags, and I<result> should be NULL or a pointer to an NV.
2958 The scan stops at the end of the string, or the first invalid character.
2959 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2960 invalid character will also trigger a warning.
2961 On return I<*len> is set to the length of the scanned string,
2962 and I<*flags> gives output flags.
2964 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2965 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_oct>
2966 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2967 and writes the value to I<*result> (or the value is discarded if I<result>
2970 If C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the octal
2971 number may use '_' characters to separate digits.
2973 UV grok_oct(const char* start, STRLEN* len_p, I32* flags, NV *result)
2976 Found in file numeric.c
2981 Return a non-zero integer if the sign bit on an NV is set, and 0 if
2984 If Configure detects this system has a signbit() that will work with
2985 our NVs, then we just use it via the #define in perl.h. Otherwise,
2986 fall back on this implementation. As a first pass, this gets everything
2987 right except -0.0. Alas, catching -0.0 is the main use for this function,
2988 so this is not too helpful yet. Still, at least we have the scaffolding
2989 in place to support other systems, should that prove useful.
2992 Configure notes: This function is called 'Perl_signbit' instead of a
2993 plain 'signbit' because it is easy to imagine a system having a signbit()
2994 function or macro that doesn't happen to work with our particular choice
2995 of NVs. We shouldn't just re-#define signbit as Perl_signbit and expect
2996 the standard system headers to be happy. Also, this is a no-context
2997 function (no pTHX_) because Perl_signbit() is usually re-#defined in
2998 perl.h as a simple macro call to the system's signbit().
2999 Users should just always call Perl_signbit().
3001 NOTE: this function is experimental and may change or be
3002 removed without notice.
3004 int Perl_signbit(NV f)
3007 Found in file numeric.c
3012 For backwards compatibility. Use C<grok_bin> instead.
3014 NV scan_bin(const char* start, STRLEN len, STRLEN* retlen)
3017 Found in file numeric.c
3022 For backwards compatibility. Use C<grok_hex> instead.
3024 NV scan_hex(const char* start, STRLEN len, STRLEN* retlen)
3027 Found in file numeric.c
3032 For backwards compatibility. Use C<grok_oct> instead.
3034 NV scan_oct(const char* start, STRLEN len, STRLEN* retlen)
3037 Found in file numeric.c
3042 =head1 Optree Manipulation Functions
3049 If C<cv> is a constant sub eligible for inlining. returns the constant
3050 value returned by the sub. Otherwise, returns NULL.
3052 Constant subs can be created with C<newCONSTSUB> or as described in
3053 L<perlsub/"Constant Functions">.
3055 SV* cv_const_sv(const CV *const cv)
3063 Creates a constant sub equivalent to Perl C<sub FOO () { 123 }> which is
3064 eligible for inlining at compile-time.
3066 CV* newCONSTSUB(HV* stash, const char* name, SV* sv)
3074 Used by C<xsubpp> to hook up XSUBs as Perl subs. I<filename> needs to be
3075 static storage, as it is used directly as CvFILE(), without a copy being made.
3083 =head1 Pad Data Structures
3090 Get the value at offset po in the current pad.
3091 Use macro PAD_SV instead of calling this function directly.
3093 SV* pad_sv(PADOFFSET po)
3101 =head1 Per-Interpreter Variables
3108 C<PL_modglobal> is a general purpose, interpreter global HV for use by
3109 extensions that need to keep information on a per-interpreter basis.
3110 In a pinch, it can also be used as a symbol table for extensions
3111 to share data among each other. It is a good idea to use keys
3112 prefixed by the package name of the extension that owns the data.
3117 Found in file intrpvar.h
3122 A convenience variable which is typically used with C<SvPV> when one
3123 doesn't care about the length of the string. It is usually more efficient
3124 to either declare a local variable and use that instead or to use the
3125 C<SvPV_nolen> macro.
3130 Found in file intrpvar.h
3135 This is the C<false> SV. See C<PL_sv_yes>. Always refer to this as
3141 Found in file intrpvar.h
3146 This is the C<undef> SV. Always refer to this as C<&PL_sv_undef>.
3151 Found in file intrpvar.h
3156 This is the C<true> SV. See C<PL_sv_no>. Always refer to this as
3162 Found in file intrpvar.h
3167 =head1 REGEXP Functions
3174 Convenience macro to get the REGEXP from a SV. This is approximately
3175 equivalent to the following snippet:
3180 (tmpsv = (SV*)SvRV(sv)) &&
3181 SvTYPE(tmpsv) == SVt_PVMG &&
3182 (tmpmg = mg_find(tmpsv, PERL_MAGIC_qr)))
3184 return (REGEXP *)tmpmg->mg_obj;
3187 NULL will be returned if a REGEXP* is not found.
3189 REGEXP * SvRX(SV *sv)
3192 Found in file regexp.h
3197 Returns a boolean indicating whether the SV contains qr magic
3200 If you want to do something with the REGEXP* later use SvRX instead
3206 Found in file regexp.h
3211 =head1 Simple Exception Handling Macros
3218 Set up necessary local variables for exception handling.
3219 See L<perlguts/"Exception Handling">.
3224 Found in file XSUB.h
3229 Introduces a catch block. See L<perlguts/"Exception Handling">.
3232 Found in file XSUB.h
3237 Rethrows a previously caught exception. See L<perlguts/"Exception Handling">.
3242 Found in file XSUB.h
3247 Ends a try block. See L<perlguts/"Exception Handling">.
3250 Found in file XSUB.h
3252 =item XCPT_TRY_START
3255 Starts a try block. See L<perlguts/"Exception Handling">.
3258 Found in file XSUB.h
3263 =head1 Stack Manipulation Macros
3270 Declare a stack marker variable, C<mark>, for the XSUB. See C<MARK> and
3281 Saves the original stack mark for the XSUB. See C<ORIGMARK>.
3291 Declares a local copy of perl's stack pointer for the XSUB, available via
3292 the C<SP> macro. See C<SP>.
3302 Used to extend the argument stack for an XSUB's return values. Once
3303 used, guarantees that there is room for at least C<nitems> to be pushed
3306 void EXTEND(SP, int nitems)
3314 Stack marker variable for the XSUB. See C<dMARK>.
3322 Push an integer onto the stack. The stack must have room for this element.
3323 Does not use C<TARG>. See also C<PUSHi>, C<mXPUSHi> and C<XPUSHi>.
3333 Push a double onto the stack. The stack must have room for this element.
3334 Does not use C<TARG>. See also C<PUSHn>, C<mXPUSHn> and C<XPUSHn>.
3344 Push a string onto the stack. The stack must have room for this element.
3345 The C<len> indicates the length of the string. Does not use C<TARG>.
3346 See also C<PUSHp>, C<mXPUSHp> and C<XPUSHp>.
3348 void mPUSHp(char* str, STRLEN len)
3356 Push an SV onto the stack and mortalizes the SV. The stack must have room
3357 for this element. Does not use C<TARG>. See also C<PUSHs> and C<mXPUSHs>.
3367 Push an unsigned integer onto the stack. The stack must have room for this
3368 element. Does not use C<TARG>. See also C<PUSHu>, C<mXPUSHu> and C<XPUSHu>.
3378 Push an integer onto the stack, extending the stack if necessary.
3379 Does not use C<TARG>. See also C<XPUSHi>, C<mPUSHi> and C<PUSHi>.
3389 Push a double onto the stack, extending the stack if necessary.
3390 Does not use C<TARG>. See also C<XPUSHn>, C<mPUSHn> and C<PUSHn>.
3400 Push a string onto the stack, extending the stack if necessary. The C<len>
3401 indicates the length of the string. Does not use C<TARG>. See also C<XPUSHp>,
3402 C<mPUSHp> and C<PUSHp>.
3404 void mXPUSHp(char* str, STRLEN len)
3412 Push an SV onto the stack, extending the stack if necessary and mortalizes
3413 the SV. Does not use C<TARG>. See also C<XPUSHs> and C<mPUSHs>.
3415 void mXPUSHs(SV* sv)
3423 Push an unsigned integer onto the stack, extending the stack if necessary.
3424 Does not use C<TARG>. See also C<XPUSHu>, C<mPUSHu> and C<PUSHu>.
3434 The original stack mark for the XSUB. See C<dORIGMARK>.
3442 Pops an integer off the stack.
3452 Pops a long off the stack.
3462 Pops a double off the stack.
3472 Pops a string off the stack. Deprecated. New code should use POPpx.
3482 Pops a string off the stack which must consist of bytes i.e. characters < 256.
3492 Pops a string off the stack.
3502 Pops an SV off the stack.
3512 Push an integer onto the stack. The stack must have room for this element.
3513 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3514 called to declare it. Do not call multiple C<TARG>-oriented macros to
3515 return lists from XSUB's - see C<mPUSHi> instead. See also C<XPUSHi> and
3526 Opening bracket for arguments on a callback. See C<PUTBACK> and
3537 Push a new mortal SV onto the stack. The stack must have room for this
3538 element. Does not use C<TARG>. See also C<PUSHs>, C<XPUSHmortal> and C<XPUSHs>.
3548 Push a double onto the stack. The stack must have room for this element.
3549 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3550 called to declare it. Do not call multiple C<TARG>-oriented macros to
3551 return lists from XSUB's - see C<mPUSHn> instead. See also C<XPUSHn> and
3562 Push a string onto the stack. The stack must have room for this element.
3563 The C<len> indicates the length of the string. Handles 'set' magic. Uses
3564 C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to declare it. Do not
3565 call multiple C<TARG>-oriented macros to return lists from XSUB's - see
3566 C<mPUSHp> instead. See also C<XPUSHp> and C<mXPUSHp>.
3568 void PUSHp(char* str, STRLEN len)
3576 Push an SV onto the stack. The stack must have room for this element.
3577 Does not handle 'set' magic. Does not use C<TARG>. See also C<PUSHmortal>,
3578 C<XPUSHs> and C<XPUSHmortal>.
3588 Push an unsigned integer onto the stack. The stack must have room for this
3589 element. Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG>
3590 should be called to declare it. Do not call multiple C<TARG>-oriented
3591 macros to return lists from XSUB's - see C<mPUSHu> instead. See also
3592 C<XPUSHu> and C<mXPUSHu>.
3602 Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
3603 See C<PUSHMARK> and L<perlcall> for other uses.
3613 Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and
3622 Refetch the stack pointer. Used after a callback. See L<perlcall>.
3632 Push an integer onto the stack, extending the stack if necessary. Handles
3633 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
3634 declare it. Do not call multiple C<TARG>-oriented macros to return lists
3635 from XSUB's - see C<mXPUSHi> instead. See also C<PUSHi> and C<mPUSHi>.
3645 Push a new mortal SV onto the stack, extending the stack if necessary.
3646 Does not use C<TARG>. See also C<XPUSHs>, C<PUSHmortal> and C<PUSHs>.
3656 Push a double onto the stack, extending the stack if necessary. Handles
3657 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
3658 declare it. Do not call multiple C<TARG>-oriented macros to return lists
3659 from XSUB's - see C<mXPUSHn> instead. See also C<PUSHn> and C<mPUSHn>.
3669 Push a string onto the stack, extending the stack if necessary. The C<len>
3670 indicates the length of the string. Handles 'set' magic. Uses C<TARG>, so
3671 C<dTARGET> or C<dXSTARG> should be called to declare it. Do not call
3672 multiple C<TARG>-oriented macros to return lists from XSUB's - see
3673 C<mXPUSHp> instead. See also C<PUSHp> and C<mPUSHp>.
3675 void XPUSHp(char* str, STRLEN len)
3683 Push an SV onto the stack, extending the stack if necessary. Does not
3684 handle 'set' magic. Does not use C<TARG>. See also C<XPUSHmortal>,
3685 C<PUSHs> and C<PUSHmortal>.
3695 Push an unsigned integer onto the stack, extending the stack if necessary.
3696 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3697 called to declare it. Do not call multiple C<TARG>-oriented macros to
3698 return lists from XSUB's - see C<mXPUSHu> instead. See also C<PUSHu> and
3709 Return from XSUB, indicating number of items on the stack. This is usually
3710 handled by C<xsubpp>.
3712 void XSRETURN(int nitems)
3715 Found in file XSUB.h
3717 =item XSRETURN_EMPTY
3720 Return an empty list from an XSUB immediately.
3725 Found in file XSUB.h
3730 Return an integer from an XSUB immediately. Uses C<XST_mIV>.
3732 void XSRETURN_IV(IV iv)
3735 Found in file XSUB.h
3740 Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
3745 Found in file XSUB.h
3750 Return a double from an XSUB immediately. Uses C<XST_mNV>.
3752 void XSRETURN_NV(NV nv)
3755 Found in file XSUB.h
3760 Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
3762 void XSRETURN_PV(char* str)
3765 Found in file XSUB.h
3767 =item XSRETURN_UNDEF
3770 Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
3775 Found in file XSUB.h
3780 Return an integer from an XSUB immediately. Uses C<XST_mUV>.
3782 void XSRETURN_UV(IV uv)
3785 Found in file XSUB.h
3790 Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
3795 Found in file XSUB.h
3800 Place an integer into the specified position C<pos> on the stack. The
3801 value is stored in a new mortal SV.
3803 void XST_mIV(int pos, IV iv)
3806 Found in file XSUB.h
3811 Place C<&PL_sv_no> into the specified position C<pos> on the
3814 void XST_mNO(int pos)
3817 Found in file XSUB.h
3822 Place a double into the specified position C<pos> on the stack. The value
3823 is stored in a new mortal SV.
3825 void XST_mNV(int pos, NV nv)
3828 Found in file XSUB.h
3833 Place a copy of a string into the specified position C<pos> on the stack.
3834 The value is stored in a new mortal SV.
3836 void XST_mPV(int pos, char* str)
3839 Found in file XSUB.h
3844 Place C<&PL_sv_undef> into the specified position C<pos> on the
3847 void XST_mUNDEF(int pos)
3850 Found in file XSUB.h
3855 Place C<&PL_sv_yes> into the specified position C<pos> on the
3858 void XST_mYES(int pos)
3861 Found in file XSUB.h
3873 An enum of flags for Perl types. These are found in the file B<sv.h>
3874 in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
3882 Integer type flag for scalars. See C<svtype>.
3890 Double type flag for scalars. See C<svtype>.
3898 Pointer type flag for scalars. See C<svtype>.
3906 Type flag for arrays. See C<svtype>.
3914 Type flag for code refs. See C<svtype>.
3922 Type flag for hashes. See C<svtype>.
3930 Type flag for blessed scalars. See C<svtype>.
3938 =head1 SV Manipulation Functions
3942 =item croak_xs_usage
3945 A specialised variant of C<croak()> for emitting the usage message for xsubs
3947 croak_xs_usage(cv, "eee_yow");
3949 works out the package name and subroutine name from C<cv>, and then calls
3950 C<croak()>. Hence if C<cv> is C<&ouch::awk>, it would call C<croak> as:
3952 Perl_croak(aTHX_ "Usage %s::%s(%s)", "ouch" "awk", "eee_yow");
3954 void croak_xs_usage(const CV *const cv, const char *const params)
3957 Found in file universal.c
3962 Returns the SV of the specified Perl scalar. If C<create> is set and the
3963 Perl variable does not exist then it will be created. If C<create> is not
3964 set and the variable does not exist then NULL is returned.
3966 NOTE: the perl_ form of this function is deprecated.
3968 SV* get_sv(const char* name, I32 create)
3971 Found in file perl.c
3976 Creates an RV wrapper for an SV. The reference count for the original SV is
3979 SV* newRV_inc(SV* sv)
3987 Creates a new SV and copies a string into it. If utf8 is true, calls
3988 C<SvUTF8_on> on the new SV. Implemented as a wrapper around C<newSVpvn_flags>.
3990 SV* newSVpvn_utf8(NULLOK const char* s, STRLEN len, U32 utf8)
3998 Returns the length of the string which is in the SV. See C<SvLEN>.
4000 STRLEN SvCUR(SV* sv)
4008 Set the current length of the string which is in the SV. See C<SvCUR>
4011 void SvCUR_set(SV* sv, STRLEN len)
4019 Returns a pointer to the last character in the string which is in the SV.
4020 See C<SvCUR>. Access the character as *(SvEND(sv)).
4030 Returns true if the SV has get magic or overloading. If either is true then
4031 the scalar is active data, and has the potential to return a new value every
4032 time it is accessed. Hence you must be careful to only read it once per user
4033 logical operation and work with that returned value. If neither is true then
4034 the scalar's value cannot change unless written to.
4036 char* SvGAMAGIC(SV* sv)
4044 Expands the character buffer in the SV so that it has room for the
4045 indicated number of bytes (remember to reserve space for an extra trailing
4046 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
4047 Returns a pointer to the character buffer.
4049 char * SvGROW(SV* sv, STRLEN len)
4057 Returns a U32 value indicating whether the SV contains an integer.
4067 Returns a U32 value indicating whether the SV contains an integer. Checks
4068 the B<private> setting. Use C<SvIOK>.
4078 Returns a boolean indicating whether the SV contains a signed integer.
4080 bool SvIOK_notUV(SV* sv)
4088 Unsets the IV status of an SV.
4090 void SvIOK_off(SV* sv)
4098 Tells an SV that it is an integer.
4100 void SvIOK_on(SV* sv)
4108 Tells an SV that it is an integer and disables all other OK bits.
4110 void SvIOK_only(SV* sv)
4118 Tells and SV that it is an unsigned integer and disables all other OK bits.
4120 void SvIOK_only_UV(SV* sv)
4128 Returns a boolean indicating whether the SV contains an unsigned integer.
4130 bool SvIOK_UV(SV* sv)
4138 Returns a boolean indicating whether the SV is Copy-On-Write. (either shared
4139 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
4142 bool SvIsCOW(SV* sv)
4147 =item SvIsCOW_shared_hash
4148 X<SvIsCOW_shared_hash>
4150 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
4153 bool SvIsCOW_shared_hash(SV* sv)
4161 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
4162 version which guarantees to evaluate sv only once.
4172 Returns the raw value in the SV's IV slot, without checks or conversions.
4173 Only use when you are sure SvIOK is true. See also C<SvIV()>.
4183 Coerces the given SV to an integer and returns it. Guarantees to evaluate
4184 C<sv> only once. Only use this if C<sv> is an expression with side effects,
4185 otherwise use the more efficient C<SvIV>.
4195 Like C<SvIV> but doesn't process magic.
4197 IV SvIV_nomg(SV* sv)
4205 Set the value of the IV pointer in sv to val. It is possible to perform
4206 the same function of this macro with an lvalue assignment to C<SvIVX>.
4207 With future Perls, however, it will be more efficient to use
4208 C<SvIV_set> instead of the lvalue assignment to C<SvIVX>.
4210 void SvIV_set(SV* sv, IV val)
4218 Returns the size of the string buffer in the SV, not including any part
4219 attributable to C<SvOOK>. See C<SvCUR>.
4221 STRLEN SvLEN(SV* sv)
4229 Set the actual length of the string which is in the SV. See C<SvIV_set>.
4231 void SvLEN_set(SV* sv, STRLEN len)
4239 Set the value of the MAGIC pointer in sv to val. See C<SvIV_set>.
4241 void SvMAGIC_set(SV* sv, MAGIC* val)
4249 Returns a U32 value indicating whether the SV contains a number, integer or
4260 Returns a U32 value indicating whether the SV contains a number, integer or
4261 double. Checks the B<private> setting. Use C<SvNIOK>.
4271 Unsets the NV/IV status of an SV.
4273 void SvNIOK_off(SV* sv)
4281 Returns a U32 value indicating whether the SV contains a double.
4291 Returns a U32 value indicating whether the SV contains a double. Checks the
4292 B<private> setting. Use C<SvNOK>.
4302 Unsets the NV status of an SV.
4304 void SvNOK_off(SV* sv)
4312 Tells an SV that it is a double.
4314 void SvNOK_on(SV* sv)
4322 Tells an SV that it is a double and disables all other OK bits.
4324 void SvNOK_only(SV* sv)
4332 Coerce the given SV to a double and return it. See C<SvNVx> for a version
4333 which guarantees to evaluate sv only once.
4343 Returns the raw value in the SV's NV slot, without checks or conversions.
4344 Only use when you are sure SvNOK is true. See also C<SvNV()>.
4354 Coerces the given SV to a double and returns it. Guarantees to evaluate
4355 C<sv> only once. Only use this if C<sv> is an expression with side effects,
4356 otherwise use the more efficient C<SvNV>.
4366 Set the value of the NV pointer in sv to val. See C<SvIV_set>.
4368 void SvNV_set(SV* sv, NV val)
4376 Returns a U32 value indicating whether the value is an SV. It also tells
4377 whether the value is defined or not.
4387 Returns a U32 indicating whether the pointer to the string buffer is offset.
4388 This hack is used internally to speed up removal of characters from the
4389 beginning of a SvPV. When SvOOK is true, then the start of the
4390 allocated string buffer is actually C<SvOOK_offset()> bytes before SvPVX.
4391 This offset used to be stored in SvIVX, but is now stored within the spare
4402 Reads into I<len> the offset from SvPVX back to the true start of the
4403 allocated buffer, which will be non-zero if C<sv_chop> has been used to
4404 efficiently remove characters from start of the buffer. Implemented as a
4405 macro, which takes the address of I<len>, which must be of type C<STRLEN>.
4406 Evaluates I<sv> more than once. Sets I<len> to 0 if C<SvOOK(sv)> is false.
4408 void SvOOK_offset(NN SV*sv, STRLEN len)
4416 Returns a U32 value indicating whether the SV contains a character
4427 Returns a U32 value indicating whether the SV contains a character string.
4428 Checks the B<private> setting. Use C<SvPOK>.
4438 Unsets the PV status of an SV.
4440 void SvPOK_off(SV* sv)
4448 Tells an SV that it is a string.
4450 void SvPOK_on(SV* sv)
4458 Tells an SV that it is a string and disables all other OK bits.
4459 Will also turn off the UTF-8 status.
4461 void SvPOK_only(SV* sv)
4466 =item SvPOK_only_UTF8
4469 Tells an SV that it is a string and disables all other OK bits,
4470 and leaves the UTF-8 status as it was.
4472 void SvPOK_only_UTF8(SV* sv)
4480 Returns a pointer to the string in the SV, or a stringified form of
4481 the SV if the SV does not contain a string. The SV may cache the
4482 stringified version becoming C<SvPOK>. Handles 'get' magic. See also
4483 C<SvPVx> for a version which guarantees to evaluate sv only once.
4485 char* SvPV(SV* sv, STRLEN len)
4493 Like C<SvPV>, but converts sv to byte representation first if necessary.
4495 char* SvPVbyte(SV* sv, STRLEN len)
4503 Like C<SvPV>, but converts sv to byte representation first if necessary.
4504 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
4507 char* SvPVbytex(SV* sv, STRLEN len)
4512 =item SvPVbytex_force
4515 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
4516 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
4519 char* SvPVbytex_force(SV* sv, STRLEN len)
4524 =item SvPVbyte_force
4527 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
4529 char* SvPVbyte_force(SV* sv, STRLEN len)
4534 =item SvPVbyte_nolen
4537 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
4539 char* SvPVbyte_nolen(SV* sv)
4547 Like C<SvPV>, but converts sv to utf8 first if necessary.
4549 char* SvPVutf8(SV* sv, STRLEN len)
4557 Like C<SvPV>, but converts sv to utf8 first if necessary.
4558 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
4561 char* SvPVutf8x(SV* sv, STRLEN len)
4566 =item SvPVutf8x_force
4569 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
4570 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
4573 char* SvPVutf8x_force(SV* sv, STRLEN len)
4578 =item SvPVutf8_force
4581 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
4583 char* SvPVutf8_force(SV* sv, STRLEN len)
4588 =item SvPVutf8_nolen
4591 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
4593 char* SvPVutf8_nolen(SV* sv)
4601 Returns a pointer to the physical string in the SV. The SV must contain a
4612 A version of C<SvPV> which guarantees to evaluate C<sv> only once.
4613 Only use this if C<sv> is an expression with side effects, otherwise use the
4614 more efficient C<SvPVX>.
4616 char* SvPVx(SV* sv, STRLEN len)
4624 Like C<SvPV> but will force the SV into containing just a string
4625 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
4628 char* SvPV_force(SV* sv, STRLEN len)
4633 =item SvPV_force_nomg
4636 Like C<SvPV> but will force the SV into containing just a string
4637 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
4638 directly. Doesn't process magic.
4640 char* SvPV_force_nomg(SV* sv, STRLEN len)
4648 Returns a pointer to the string in the SV, or a stringified form of
4649 the SV if the SV does not contain a string. The SV may cache the
4650 stringified form becoming C<SvPOK>. Handles 'get' magic.
4652 char* SvPV_nolen(SV* sv)
4660 Like C<SvPV> but doesn't process magic.
4662 char* SvPV_nomg(SV* sv, STRLEN len)
4670 Set the value of the PV pointer in sv to val. See C<SvIV_set>.
4672 void SvPV_set(SV* sv, char* val)
4680 Returns the value of the object's reference count.
4682 U32 SvREFCNT(SV* sv)
4690 Decrements the reference count of the given SV.
4692 void SvREFCNT_dec(SV* sv)
4700 Increments the reference count of the given SV.
4702 All of the following SvREFCNT_inc* macros are optimized versions of
4703 SvREFCNT_inc, and can be replaced with SvREFCNT_inc.
4705 SV* SvREFCNT_inc(SV* sv)
4710 =item SvREFCNT_inc_NN
4713 Same as SvREFCNT_inc, but can only be used if you know I<sv>
4714 is not NULL. Since we don't have to check the NULLness, it's faster
4717 SV* SvREFCNT_inc_NN(SV* sv)
4722 =item SvREFCNT_inc_simple
4723 X<SvREFCNT_inc_simple>
4725 Same as SvREFCNT_inc, but can only be used with expressions without side
4726 effects. Since we don't have to store a temporary value, it's faster.
4728 SV* SvREFCNT_inc_simple(SV* sv)
4733 =item SvREFCNT_inc_simple_NN
4734 X<SvREFCNT_inc_simple_NN>
4736 Same as SvREFCNT_inc_simple, but can only be used if you know I<sv>
4737 is not NULL. Since we don't have to check the NULLness, it's faster
4740 SV* SvREFCNT_inc_simple_NN(SV* sv)
4745 =item SvREFCNT_inc_simple_void
4746 X<SvREFCNT_inc_simple_void>
4748 Same as SvREFCNT_inc_simple, but can only be used if you don't need the
4749 return value. The macro doesn't need to return a meaningful value.
4751 void SvREFCNT_inc_simple_void(SV* sv)
4756 =item SvREFCNT_inc_simple_void_NN
4757 X<SvREFCNT_inc_simple_void_NN>
4759 Same as SvREFCNT_inc, but can only be used if you don't need the return
4760 value, and you know that I<sv> is not NULL. The macro doesn't need
4761 to return a meaningful value, or check for NULLness, so it's smaller
4764 void SvREFCNT_inc_simple_void_NN(SV* sv)
4769 =item SvREFCNT_inc_void
4770 X<SvREFCNT_inc_void>
4772 Same as SvREFCNT_inc, but can only be used if you don't need the
4773 return value. The macro doesn't need to return a meaningful value.
4775 void SvREFCNT_inc_void(SV* sv)
4780 =item SvREFCNT_inc_void_NN
4781 X<SvREFCNT_inc_void_NN>
4783 Same as SvREFCNT_inc, but can only be used if you don't need the return
4784 value, and you know that I<sv> is not NULL. The macro doesn't need
4785 to return a meaningful value, or check for NULLness, so it's smaller
4788 void SvREFCNT_inc_void_NN(SV* sv)
4796 Tests if the SV is an RV.
4806 Unsets the RV status of an SV.
4808 void SvROK_off(SV* sv)
4816 Tells an SV that it is an RV.
4818 void SvROK_on(SV* sv)
4826 Dereferences an RV to return the SV.
4836 Set the value of the RV pointer in sv to val. See C<SvIV_set>.
4838 void SvRV_set(SV* sv, SV* val)
4846 Returns the stash of the SV.
4856 Set the value of the STASH pointer in sv to val. See C<SvIV_set>.
4858 void SvSTASH_set(SV* sv, HV* val)
4866 Taints an SV if tainting is enabled.
4868 void SvTAINT(SV* sv)
4876 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
4879 bool SvTAINTED(SV* sv)
4887 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
4888 some of Perl's fundamental security features. XS module authors should not
4889 use this function unless they fully understand all the implications of
4890 unconditionally untainting the value. Untainting should be done in the
4891 standard perl fashion, via a carefully crafted regexp, rather than directly
4892 untainting variables.
4894 void SvTAINTED_off(SV* sv)
4902 Marks an SV as tainted if tainting is enabled.
4904 void SvTAINTED_on(SV* sv)
4912 Returns a boolean indicating whether Perl would evaluate the SV as true or
4913 false, defined or undefined. Does not handle 'get' magic.
4923 Returns the type of the SV. See C<svtype>.
4925 svtype SvTYPE(SV* sv)
4933 Returns a boolean indicating whether the SV contains an unsigned integer.
4943 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
4944 perform the upgrade if necessary. See C<svtype>.
4946 void SvUPGRADE(SV* sv, svtype type)
4954 Returns a U32 value indicating whether the SV contains UTF-8 encoded data.
4955 Call this after SvPV() in case any call to string overloading updates the
4966 Unsets the UTF-8 status of an SV.
4968 void SvUTF8_off(SV *sv)
4976 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
4977 Do not use frivolously.
4979 void SvUTF8_on(SV *sv)
4987 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
4988 for a version which guarantees to evaluate sv only once.
4998 Returns the raw value in the SV's UV slot, without checks or conversions.
4999 Only use when you are sure SvIOK is true. See also C<SvUV()>.
5009 Coerces the given SV to an unsigned integer and returns it. Guarantees to
5010 C<sv> only once. Only use this if C<sv> is an expression with side effects,
5011 otherwise use the more efficient C<SvUV>.
5021 Like C<SvUV> but doesn't process magic.
5023 UV SvUV_nomg(SV* sv)
5031 Set the value of the UV pointer in sv to val. See C<SvIV_set>.
5033 void SvUV_set(SV* sv, UV val)
5041 Returns a boolean indicating whether the SV contains a v-string.
5048 =item sv_catpvn_nomg
5051 Like C<sv_catpvn> but doesn't process magic.
5053 void sv_catpvn_nomg(SV* sv, const char* ptr, STRLEN len)
5061 Like C<sv_catsv> but doesn't process magic.
5063 void sv_catsv_nomg(SV* dsv, SV* ssv)
5068 =item sv_derived_from
5071 Returns a boolean indicating whether the SV is derived from the specified class
5072 I<at the C level>. To check derivation at the Perl level, call C<isa()> as a
5075 bool sv_derived_from(SV* sv, const char *const name)
5078 Found in file universal.c
5083 Returns a boolean indicating whether the SV performs a specific, named role.
5084 The SV can be a Perl object or the name of a Perl class.
5086 bool sv_does(SV* sv, const char *const name)
5089 Found in file universal.c
5091 =item sv_report_used
5094 Dump the contents of all SVs not yet freed. (Debugging aid).
5096 void sv_report_used()
5104 Like C<sv_setsv> but doesn't process magic.
5106 void sv_setsv_nomg(SV* dsv, SV* ssv)
5114 =head1 SV-Body Allocation
5118 =item looks_like_number
5119 X<looks_like_number>
5121 Test if the content of an SV looks like a number (or is a number).
5122 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
5123 non-numeric warning), even if your atof() doesn't grok them.
5125 I32 looks_like_number(SV *const sv)
5133 Creates an RV wrapper for an SV. The reference count for the original
5134 SV is B<not> incremented.
5136 SV* newRV_noinc(SV *const sv)
5144 Creates a new SV. A non-zero C<len> parameter indicates the number of
5145 bytes of preallocated string space the SV should have. An extra byte for a
5146 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
5147 space is allocated.) The reference count for the new SV is set to 1.
5149 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
5150 parameter, I<x>, a debug aid which allowed callers to identify themselves.
5151 This aid has been superseded by a new build option, PERL_MEM_LOG (see
5152 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
5153 modules supporting older perls.
5155 SV* newSV(const STRLEN len)
5163 Creates a new SV from the hash key structure. It will generate scalars that
5164 point to the shared string table where possible. Returns a new (undefined)
5165 SV if the hek is NULL.
5167 SV* newSVhek(const HEK *const hek)
5175 Creates a new SV and copies an integer into it. The reference count for the
5178 SV* newSViv(const IV i)
5186 Creates a new SV and copies a floating point value into it.
5187 The reference count for the SV is set to 1.
5189 SV* newSVnv(const NV n)
5197 Creates a new SV and copies a string into it. The reference count for the
5198 SV is set to 1. If C<len> is zero, Perl will compute the length using
5199 strlen(). For efficiency, consider using C<newSVpvn> instead.
5201 SV* newSVpv(const char *const s, const STRLEN len)
5209 Creates a new SV and initializes it with the string formatted like
5212 SV* newSVpvf(const char *const pat, ...)
5220 Creates a new SV and copies a string into it. The reference count for the
5221 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
5222 string. You are responsible for ensuring that the source string is at least
5223 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
5225 SV* newSVpvn(const char *const s, const STRLEN len)
5230 =item newSVpvn_flags
5233 Creates a new SV and copies a string into it. The reference count for the
5234 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
5235 string. You are responsible for ensuring that the source string is at least
5236 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
5237 Currently the only flag bits accepted are C<SVf_UTF8> and C<SVs_TEMP>.
5238 If C<SVs_TEMP> is set, then C<sv2mortal()> is called on the result before
5239 returning. If C<SVf_UTF8> is set, then it will be set on the new SV.
5240 C<newSVpvn_utf8()> is a convenience wrapper for this function, defined as
5242 #define newSVpvn_utf8(s, len, u) \
5243 newSVpvn_flags((s), (len), (u) ? SVf_UTF8 : 0)
5245 SV* newSVpvn_flags(const char *const s, const STRLEN len, const U32 flags)
5250 =item newSVpvn_share
5253 Creates a new SV with its SvPVX_const pointing to a shared string in the string
5254 table. If the string does not already exist in the table, it is created
5255 first. Turns on READONLY and FAKE. If the C<hash> parameter is non-zero, that
5256 value is used; otherwise the hash is computed. The string's hash can be later
5257 be retrieved from the SV with the C<SvSHARED_HASH()> macro. The idea here is
5258 that as the string table is used for shared hash keys these strings will have
5259 SvPVX_const == HeKEY and hash lookup will avoid string compare.
5261 SV* newSVpvn_share(const char* s, I32 len, U32 hash)
5269 Like C<newSVpvn>, but takes a literal string instead of a string/length pair.
5271 SV* newSVpvs(const char* s)
5274 Found in file handy.h
5276 =item newSVpvs_flags
5279 Like C<newSVpvn_flags>, but takes a literal string instead of a string/length
5282 SV* newSVpvs_flags(const char* s, U32 flags)
5285 Found in file handy.h
5287 =item newSVpvs_share
5290 Like C<newSVpvn_share>, but takes a literal string instead of a string/length
5291 pair and omits the hash parameter.
5293 SV* newSVpvs_share(const char* s)
5296 Found in file handy.h
5301 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
5302 it will be upgraded to one. If C<classname> is non-null then the new SV will
5303 be blessed in the specified package. The new SV is returned and its
5304 reference count is 1.
5306 SV* newSVrv(SV *const rv, const char *const classname)
5314 Creates a new SV which is an exact duplicate of the original SV.
5317 SV* newSVsv(SV *const old)
5325 Creates a new SV and copies an unsigned integer into it.
5326 The reference count for the SV is set to 1.
5328 SV* newSVuv(const UV u)
5336 Creates a new SV, of the type specified. The reference count for the new SV
5339 SV* newSV_type(const svtype type)
5347 This function is only called on magical items, and is only used by
5348 sv_true() or its macro equivalent.
5350 bool sv_2bool(SV *const sv)
5358 Using various gambits, try to get a CV from an SV; in addition, try if
5359 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
5360 The flags in C<lref> are passed to sv_fetchsv.
5362 CV* sv_2cv(SV* sv, HV **const st, GV **const gvp, const I32 lref)
5370 Using various gambits, try to get an IO from an SV: the IO slot if its a
5371 GV; or the recursive result if we're an RV; or the IO slot of the symbol
5372 named after the PV if we're a string.
5374 IO* sv_2io(SV *const sv)
5382 Return the integer value of an SV, doing any necessary string
5383 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
5384 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
5386 IV sv_2iv_flags(SV *const sv, const I32 flags)
5394 Marks an existing SV as mortal. The SV will be destroyed "soon", either
5395 by an explicit call to FREETMPS, or by an implicit call at places such as
5396 statement boundaries. SvTEMP() is turned on which means that the SV's
5397 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
5398 and C<sv_mortalcopy>.
5400 SV* sv_2mortal(SV *const sv)
5408 Return the num value of an SV, doing any necessary string or integer
5409 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
5412 NV sv_2nv(SV *const sv)
5420 Return a pointer to the byte-encoded representation of the SV, and set *lp
5421 to its length. May cause the SV to be downgraded from UTF-8 as a
5424 Usually accessed via the C<SvPVbyte> macro.
5426 char* sv_2pvbyte(SV *const sv, STRLEN *const lp)
5434 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
5435 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
5437 Usually accessed via the C<SvPVutf8> macro.
5439 char* sv_2pvutf8(SV *const sv, STRLEN *const lp)
5447 Returns a pointer to the string value of an SV, and sets *lp to its length.
5448 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
5450 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
5451 usually end up here too.
5453 char* sv_2pv_flags(SV *const sv, STRLEN *const lp, const I32 flags)
5461 Return the unsigned integer value of an SV, doing any necessary string
5462 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
5463 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
5465 UV sv_2uv_flags(SV *const sv, const I32 flags)
5473 Remove any string offset. You should normally use the C<SvOOK_off> macro
5476 int sv_backoff(SV *const sv)
5484 Blesses an SV into a specified package. The SV must be an RV. The package
5485 must be designated by its stash (see C<gv_stashpv()>). The reference count
5486 of the SV is unaffected.
5488 SV* sv_bless(SV *const sv, HV *const stash)
5496 Concatenates the string onto the end of the string which is in the SV.
5497 If the SV has the UTF-8 status set, then the bytes appended should be
5498 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
5500 void sv_catpv(SV *const sv, const char* ptr)
5508 Processes its arguments like C<sprintf> and appends the formatted
5509 output to an SV. If the appended data contains "wide" characters
5510 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
5511 and characters >255 formatted with %c), the original SV might get
5512 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
5513 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
5514 valid UTF-8; if the original SV was bytes, the pattern should be too.
5516 void sv_catpvf(SV *const sv, const char *const pat, ...)
5524 Like C<sv_catpvf>, but also handles 'set' magic.
5526 void sv_catpvf_mg(SV *const sv, const char *const pat, ...)
5534 Concatenates the string onto the end of the string which is in the SV. The
5535 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5536 status set, then the bytes appended should be valid UTF-8.
5537 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
5539 void sv_catpvn(SV *dsv, const char *sstr, STRLEN len)
5544 =item sv_catpvn_flags
5547 Concatenates the string onto the end of the string which is in the SV. The
5548 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5549 status set, then the bytes appended should be valid UTF-8.
5550 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
5551 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
5552 in terms of this function.
5554 void sv_catpvn_flags(SV *const dstr, const char *sstr, const STRLEN len, const I32 flags)
5562 Like C<sv_catpvn>, but takes a literal string instead of a string/length pair.
5564 void sv_catpvs(SV* sv, const char* s)
5567 Found in file handy.h
5572 Like C<sv_catpv>, but also handles 'set' magic.
5574 void sv_catpv_mg(SV *const sv, const char *const ptr)
5582 Concatenates the string from SV C<ssv> onto the end of the string in
5583 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
5584 not 'set' magic. See C<sv_catsv_mg>.
5586 void sv_catsv(SV *dstr, SV *sstr)
5591 =item sv_catsv_flags
5594 Concatenates the string from SV C<ssv> onto the end of the string in
5595 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
5596 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
5597 and C<sv_catsv_nomg> are implemented in terms of this function.
5599 void sv_catsv_flags(SV *const dsv, SV *const ssv, const I32 flags)
5607 Efficient removal of characters from the beginning of the string buffer.
5608 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
5609 the string buffer. The C<ptr> becomes the first character of the adjusted
5610 string. Uses the "OOK hack".
5611 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
5612 refer to the same chunk of data.
5614 void sv_chop(SV *const sv, const char *const ptr)
5622 Clear an SV: call any destructors, free up any memory used by the body,
5623 and free the body itself. The SV's head is I<not> freed, although
5624 its type is set to all 1's so that it won't inadvertently be assumed
5625 to be live during global destruction etc.
5626 This function should only be called when REFCNT is zero. Most of the time
5627 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5630 void sv_clear(SV *const sv)
5638 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5639 string in C<sv1> is less than, equal to, or greater than the string in
5640 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5641 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
5643 I32 sv_cmp(SV *const sv1, SV *const sv2)
5651 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
5652 'use bytes' aware, handles get magic, and will coerce its args to strings
5653 if necessary. See also C<sv_cmp>.
5655 I32 sv_cmp_locale(SV *const sv1, SV *const sv2)
5663 Add Collate Transform magic to an SV if it doesn't already have it.
5665 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
5666 scalar data of the variable, but transformed to such a format that a normal
5667 memory comparison can be used to compare the data according to the locale
5670 char* sv_collxfrm(SV *const sv, STRLEN *const nxp)
5678 Copies a stringified representation of the source SV into the
5679 destination SV. Automatically performs any necessary mg_get and
5680 coercion of numeric values into strings. Guaranteed to preserve
5681 UTF8 flag even from overloaded objects. Similar in nature to
5682 sv_2pv[_flags] but operates directly on an SV instead of just the
5683 string. Mostly uses sv_2pv_flags to do its work, except when that
5684 would lose the UTF-8'ness of the PV.
5686 void sv_copypv(SV *const dsv, SV *const ssv)
5694 Auto-decrement of the value in the SV, doing string to numeric conversion
5695 if necessary. Handles 'get' magic.
5697 void sv_dec(SV *const sv)
5705 Returns a boolean indicating whether the strings in the two SVs are
5706 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5707 coerce its args to strings if necessary.
5709 I32 sv_eq(SV* sv1, SV* sv2)
5714 =item sv_force_normal_flags
5715 X<sv_force_normal_flags>
5717 Undo various types of fakery on an SV: if the PV is a shared string, make
5718 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
5719 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
5720 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
5721 then a copy-on-write scalar drops its PV buffer (if any) and becomes
5722 SvPOK_off rather than making a copy. (Used where this scalar is about to be
5723 set to some other value.) In addition, the C<flags> parameter gets passed to
5724 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
5725 with flags set to 0.
5727 void sv_force_normal_flags(SV *const sv, const U32 flags)
5735 Decrement an SV's reference count, and if it drops to zero, call
5736 C<sv_clear> to invoke destructors and free up any memory used by
5737 the body; finally, deallocate the SV's head itself.
5738 Normally called via a wrapper macro C<SvREFCNT_dec>.
5740 void sv_free(SV *const sv)
5748 Get a line from the filehandle and store it into the SV, optionally
5749 appending to the currently-stored string.
5751 char* sv_gets(SV *const sv, PerlIO *const fp, I32 append)
5759 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
5760 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
5761 Use the C<SvGROW> wrapper instead.
5763 char* sv_grow(SV *const sv, STRLEN newlen)
5771 Auto-increment of the value in the SV, doing string to numeric conversion
5772 if necessary. Handles 'get' magic.
5774 void sv_inc(SV *const sv)
5782 Inserts a string at the specified offset/length within the SV. Similar to
5783 the Perl substr() function. Handles get magic.
5785 void sv_insert(SV *const bigstr, const STRLEN offset, const STRLEN len, const char *const little, const STRLEN littlelen)
5790 =item sv_insert_flags
5793 Same as C<sv_insert>, but the extra C<flags> are passed the C<SvPV_force_flags> that applies to C<bigstr>.
5795 void sv_insert_flags(SV *const bigstr, const STRLEN offset, const STRLEN len, const char *const little, const STRLEN littlelen, const U32 flags)
5803 Returns a boolean indicating whether the SV is blessed into the specified
5804 class. This does not check for subtypes; use C<sv_derived_from> to verify
5805 an inheritance relationship.
5807 int sv_isa(SV* sv, const char *const name)
5815 Returns a boolean indicating whether the SV is an RV pointing to a blessed
5816 object. If the SV is not an RV, or if the object is not blessed, then this
5819 int sv_isobject(SV* sv)
5827 Returns the length of the string in the SV. Handles magic and type
5828 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5830 STRLEN sv_len(SV *const sv)
5838 Returns the number of characters in the string in an SV, counting wide
5839 UTF-8 bytes as a single character. Handles magic and type coercion.
5841 STRLEN sv_len_utf8(SV *const sv)
5849 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
5850 then adds a new magic item of type C<how> to the head of the magic list.
5852 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
5853 handling of the C<name> and C<namlen> arguments.
5855 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
5856 to add more than one instance of the same 'how'.
5858 void sv_magic(SV *const sv, SV *const obj, const int how, const char *const name, const I32 namlen)
5866 Adds magic to an SV, upgrading it if necessary. Applies the
5867 supplied vtable and returns a pointer to the magic added.
5869 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
5870 In particular, you can add magic to SvREADONLY SVs, and add more than
5871 one instance of the same 'how'.
5873 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
5874 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
5875 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
5876 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
5878 (This is now used as a subroutine by C<sv_magic>.)
5880 MAGIC * sv_magicext(SV *const sv, SV *const obj, const int how, const MGVTBL *const vtbl, const char *const name, const I32 namlen)
5888 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
5889 The new SV is marked as mortal. It will be destroyed "soon", either by an
5890 explicit call to FREETMPS, or by an implicit call at places such as
5891 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
5893 SV* sv_mortalcopy(SV *const oldsv)
5901 Creates a new null SV which is mortal. The reference count of the SV is
5902 set to 1. It will be destroyed "soon", either by an explicit call to
5903 FREETMPS, or by an implicit call at places such as statement boundaries.
5904 See also C<sv_mortalcopy> and C<sv_2mortal>.
5914 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5917 SV* sv_newref(SV *const sv)
5925 Converts the value pointed to by offsetp from a count of bytes from the
5926 start of the string, to a count of the equivalent number of UTF-8 chars.
5927 Handles magic and type coercion.
5929 void sv_pos_b2u(SV *const sv, I32 *const offsetp)
5937 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5938 the start of the string, to a count of the equivalent number of bytes; if
5939 lenp is non-zero, it does the same to lenp, but this time starting from
5940 the offset, rather than from the start of the string. Handles magic and
5943 void sv_pos_u2b(SV *const sv, I32 *const offsetp, I32 *const lenp)
5948 =item sv_pvbyten_force
5951 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
5953 char* sv_pvbyten_force(SV *const sv, STRLEN *const lp)
5961 Get a sensible string out of the SV somehow.
5962 A private implementation of the C<SvPV_force> macro for compilers which
5963 can't cope with complex macro expressions. Always use the macro instead.
5965 char* sv_pvn_force(SV* sv, STRLEN* lp)
5970 =item sv_pvn_force_flags
5971 X<sv_pvn_force_flags>
5973 Get a sensible string out of the SV somehow.
5974 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
5975 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
5976 implemented in terms of this function.
5977 You normally want to use the various wrapper macros instead: see
5978 C<SvPV_force> and C<SvPV_force_nomg>
5980 char* sv_pvn_force_flags(SV *const sv, STRLEN *const lp, const I32 flags)
5985 =item sv_pvutf8n_force
5988 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
5990 char* sv_pvutf8n_force(SV *const sv, STRLEN *const lp)
5998 Returns a string describing what the SV is a reference to.
6000 const char* sv_reftype(const SV *const sv, const int ob)
6008 Make the first argument a copy of the second, then delete the original.
6009 The target SV physically takes over ownership of the body of the source SV
6010 and inherits its flags; however, the target keeps any magic it owns,
6011 and any magic in the source is discarded.
6012 Note that this is a rather specialist SV copying operation; most of the
6013 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
6015 void sv_replace(SV *const sv, SV *const nsv)
6023 Underlying implementation for the C<reset> Perl function.
6024 Note that the perl-level function is vaguely deprecated.
6026 void sv_reset(const char* s, HV *const stash)
6034 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
6035 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
6036 push a back-reference to this RV onto the array of backreferences
6037 associated with that magic. If the RV is magical, set magic will be
6038 called after the RV is cleared.
6040 SV* sv_rvweaken(SV *const sv)
6048 Copies an integer into the given SV, upgrading first if necessary.
6049 Does not handle 'set' magic. See also C<sv_setiv_mg>.
6051 void sv_setiv(SV *const sv, const IV num)
6059 Like C<sv_setiv>, but also handles 'set' magic.
6061 void sv_setiv_mg(SV *const sv, const IV i)
6069 Copies a double into the given SV, upgrading first if necessary.
6070 Does not handle 'set' magic. See also C<sv_setnv_mg>.
6072 void sv_setnv(SV *const sv, const NV num)
6080 Like C<sv_setnv>, but also handles 'set' magic.
6082 void sv_setnv_mg(SV *const sv, const NV num)
6090 Copies a string into an SV. The string must be null-terminated. Does not
6091 handle 'set' magic. See C<sv_setpv_mg>.
6093 void sv_setpv(SV *const sv, const char *const ptr)
6101 Works like C<sv_catpvf> but copies the text into the SV instead of
6102 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
6104 void sv_setpvf(SV *const sv, const char *const pat, ...)
6112 Like C<sv_setpvf>, but also handles 'set' magic.
6114 void sv_setpvf_mg(SV *const sv, const char *const pat, ...)
6122 Copies an integer into the given SV, also updating its string value.
6123 Does not handle 'set' magic. See C<sv_setpviv_mg>.
6125 void sv_setpviv(SV *const sv, const IV num)
6133 Like C<sv_setpviv>, but also handles 'set' magic.
6135 void sv_setpviv_mg(SV *const sv, const IV iv)
6143 Copies a string into an SV. The C<len> parameter indicates the number of
6144 bytes to be copied. If the C<ptr> argument is NULL the SV will become
6145 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
6147 void sv_setpvn(SV *const sv, const char *const ptr, const STRLEN len)
6155 Like C<sv_setpvn>, but also handles 'set' magic.
6157 void sv_setpvn_mg(SV *const sv, const char *const ptr, const STRLEN len)
6165 Like C<sv_setpvn>, but takes a literal string instead of a string/length pair.
6167 void sv_setpvs(SV* sv, const char* s)
6170 Found in file handy.h
6175 Like C<sv_setpv>, but also handles 'set' magic.
6177 void sv_setpv_mg(SV *const sv, const char *const ptr)
6185 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
6186 argument will be upgraded to an RV. That RV will be modified to point to
6187 the new SV. The C<classname> argument indicates the package for the
6188 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
6189 will have a reference count of 1, and the RV will be returned.
6191 SV* sv_setref_iv(SV *const rv, const char *const classname, const IV iv)
6199 Copies a double into a new SV, optionally blessing the SV. The C<rv>
6200 argument will be upgraded to an RV. That RV will be modified to point to
6201 the new SV. The C<classname> argument indicates the package for the
6202 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
6203 will have a reference count of 1, and the RV will be returned.
6205 SV* sv_setref_nv(SV *const rv, const char *const classname, const NV nv)
6213 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
6214 argument will be upgraded to an RV. That RV will be modified to point to
6215 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
6216 into the SV. The C<classname> argument indicates the package for the
6217 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
6218 will have a reference count of 1, and the RV will be returned.
6220 Do not use with other Perl types such as HV, AV, SV, CV, because those
6221 objects will become corrupted by the pointer copy process.
6223 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
6225 SV* sv_setref_pv(SV *const rv, const char *const classname, void *const pv)
6233 Copies a string into a new SV, optionally blessing the SV. The length of the
6234 string must be specified with C<n>. The C<rv> argument will be upgraded to
6235 an RV. That RV will be modified to point to the new SV. The C<classname>
6236 argument indicates the package for the blessing. Set C<classname> to
6237 C<NULL> to avoid the blessing. The new SV will have a reference count
6238 of 1, and the RV will be returned.
6240 Note that C<sv_setref_pv> copies the pointer while this copies the string.
6242 SV* sv_setref_pvn(SV *const rv, const char *const classname, const char *const pv, const STRLEN n)
6250 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
6251 argument will be upgraded to an RV. That RV will be modified to point to
6252 the new SV. The C<classname> argument indicates the package for the
6253 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
6254 will have a reference count of 1, and the RV will be returned.
6256 SV* sv_setref_uv(SV *const rv, const char *const classname, const UV uv)
6264 Copies the contents of the source SV C<ssv> into the destination SV
6265 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
6266 function if the source SV needs to be reused. Does not handle 'set' magic.
6267 Loosely speaking, it performs a copy-by-value, obliterating any previous
6268 content of the destination.
6270 You probably want to use one of the assortment of wrappers, such as
6271 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
6272 C<SvSetMagicSV_nosteal>.
6274 void sv_setsv(SV *dstr, SV *sstr)
6279 =item sv_setsv_flags
6282 Copies the contents of the source SV C<ssv> into the destination SV
6283 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
6284 function if the source SV needs to be reused. Does not handle 'set' magic.
6285 Loosely speaking, it performs a copy-by-value, obliterating any previous
6286 content of the destination.
6287 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
6288 C<ssv> if appropriate, else not. If the C<flags> parameter has the
6289 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
6290 and C<sv_setsv_nomg> are implemented in terms of this function.
6292 You probably want to use one of the assortment of wrappers, such as
6293 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
6294 C<SvSetMagicSV_nosteal>.
6296 This is the primary function for copying scalars, and most other
6297 copy-ish functions and macros use this underneath.
6299 void sv_setsv_flags(SV *dstr, SV *sstr, const I32 flags)
6307 Like C<sv_setsv>, but also handles 'set' magic.
6309 void sv_setsv_mg(SV *const dstr, SV *const sstr)
6317 Copies an unsigned integer into the given SV, upgrading first if necessary.
6318 Does not handle 'set' magic. See also C<sv_setuv_mg>.
6320 void sv_setuv(SV *const sv, const UV num)
6328 Like C<sv_setuv>, but also handles 'set' magic.
6330 void sv_setuv_mg(SV *const sv, const UV u)
6338 Test an SV for taintedness. Use C<SvTAINTED> instead.
6339 bool sv_tainted(SV *const sv)
6347 Returns true if the SV has a true value by Perl's rules.
6348 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
6349 instead use an in-line version.
6351 I32 sv_true(SV *const sv)
6359 Removes all magic of type C<type> from an SV.
6361 int sv_unmagic(SV *const sv, const int type)
6366 =item sv_unref_flags
6369 Unsets the RV status of the SV, and decrements the reference count of
6370 whatever was being referenced by the RV. This can almost be thought of
6371 as a reversal of C<newSVrv>. The C<cflags> argument can contain
6372 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
6373 (otherwise the decrementing is conditional on the reference count being
6374 different from one or the reference being a readonly SV).
6377 void sv_unref_flags(SV *const ref, const U32 flags)
6385 Untaint an SV. Use C<SvTAINTED_off> instead.
6386 void sv_untaint(SV *const sv)
6394 Upgrade an SV to a more complex form. Generally adds a new body type to the
6395 SV, then copies across as much information as possible from the old body.
6396 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
6398 void sv_upgrade(SV *const sv, svtype new_type)
6403 =item sv_usepvn_flags
6406 Tells an SV to use C<ptr> to find its string value. Normally the
6407 string is stored inside the SV but sv_usepvn allows the SV to use an
6408 outside string. The C<ptr> should point to memory that was allocated
6409 by C<malloc>. The string length, C<len>, must be supplied. By default
6410 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
6411 so that pointer should not be freed or used by the programmer after
6412 giving it to sv_usepvn, and neither should any pointers from "behind"
6413 that pointer (e.g. ptr + 1) be used.
6415 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
6416 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
6417 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
6418 C<len>, and already meets the requirements for storing in C<SvPVX>)
6420 void sv_usepvn_flags(SV *const sv, char* ptr, const STRLEN len, const U32 flags)
6425 =item sv_utf8_decode
6428 If the PV of the SV is an octet sequence in UTF-8
6429 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
6430 so that it looks like a character. If the PV contains only single-byte
6431 characters, the C<SvUTF8> flag stays being off.
6432 Scans PV for validity and returns false if the PV is invalid UTF-8.
6434 NOTE: this function is experimental and may change or be
6435 removed without notice.
6437 bool sv_utf8_decode(SV *const sv)
6442 =item sv_utf8_downgrade
6443 X<sv_utf8_downgrade>
6445 Attempts to convert the PV of an SV from characters to bytes.
6446 If the PV contains a character beyond byte, this conversion will fail;
6447 in this case, either returns false or, if C<fail_ok> is not
6450 This is not as a general purpose Unicode to byte encoding interface:
6451 use the Encode extension for that.
6453 NOTE: this function is experimental and may change or be
6454 removed without notice.
6456 bool sv_utf8_downgrade(SV *const sv, const bool fail_ok)
6461 =item sv_utf8_encode
6464 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
6465 flag off so that it looks like octets again.
6467 void sv_utf8_encode(SV *const sv)
6472 =item sv_utf8_upgrade
6475 Converts the PV of an SV to its UTF-8-encoded form.
6476 Forces the SV to string form if it is not already.
6477 Always sets the SvUTF8 flag to avoid future validity checks even
6478 if all the bytes have hibit clear.
6480 This is not as a general purpose byte encoding to Unicode interface:
6481 use the Encode extension for that.
6483 STRLEN sv_utf8_upgrade(SV *sv)
6488 =item sv_utf8_upgrade_flags
6489 X<sv_utf8_upgrade_flags>
6491 Converts the PV of an SV to its UTF-8-encoded form.
6492 Forces the SV to string form if it is not already.
6493 Always sets the SvUTF8 flag to avoid future validity checks even
6494 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
6495 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
6496 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
6498 This is not as a general purpose byte encoding to Unicode interface:
6499 use the Encode extension for that.
6501 STRLEN sv_utf8_upgrade_flags(SV *const sv, const I32 flags)
6509 Processes its arguments like C<vsprintf> and appends the formatted output
6510 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
6512 Usually used via its frontend C<sv_catpvf>.
6514 void sv_vcatpvf(SV *const sv, const char *const pat, va_list *const args)
6522 Processes its arguments like C<vsprintf> and appends the formatted output
6523 to an SV. Uses an array of SVs if the C style variable argument list is
6524 missing (NULL). When running with taint checks enabled, indicates via
6525 C<maybe_tainted> if results are untrustworthy (often due to the use of
6528 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
6530 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)
6538 Like C<sv_vcatpvf>, but also handles 'set' magic.
6540 Usually used via its frontend C<sv_catpvf_mg>.
6542 void sv_vcatpvf_mg(SV *const sv, const char *const pat, va_list *const args)
6550 Works like C<sv_vcatpvf> but copies the text into the SV instead of
6551 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
6553 Usually used via its frontend C<sv_setpvf>.
6555 void sv_vsetpvf(SV *const sv, const char *const pat, va_list *const args)
6563 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
6566 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
6568 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)
6576 Like C<sv_vsetpvf>, but also handles 'set' magic.
6578 Usually used via its frontend C<sv_setpvf_mg>.
6580 void sv_vsetpvf_mg(SV *const sv, const char *const pat, va_list *const args)
6588 =head1 Unicode Support
6592 =item bytes_from_utf8
6595 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
6596 Unlike C<utf8_to_bytes> but like C<bytes_to_utf8>, returns a pointer to
6597 the newly-created string, and updates C<len> to contain the new
6598 length. Returns the original string if no conversion occurs, C<len>
6599 is unchanged. Do nothing if C<is_utf8> points to 0. Sets C<is_utf8> to
6600 0 if C<s> is converted or contains all 7bit characters.
6602 NOTE: this function is experimental and may change or be
6603 removed without notice.
6605 U8* bytes_from_utf8(const U8 *s, STRLEN *len, bool *is_utf8)
6608 Found in file utf8.c
6613 Converts a string C<s> of length C<len> from ASCII into UTF-8 encoding.
6614 Returns a pointer to the newly-created string, and sets C<len> to
6615 reflect the new length.
6617 If you want to convert to UTF-8 from other encodings than ASCII,
6618 see sv_recode_to_utf8().
6620 NOTE: this function is experimental and may change or be
6621 removed without notice.
6623 U8* bytes_to_utf8(const U8 *s, STRLEN *len)
6626 Found in file utf8.c
6631 Return true if the strings s1 and s2 differ case-insensitively, false
6632 if not (if they are equal case-insensitively). If u1 is true, the
6633 string s1 is assumed to be in UTF-8-encoded Unicode. If u2 is true,
6634 the string s2 is assumed to be in UTF-8-encoded Unicode. If u1 or u2
6635 are false, the respective string is assumed to be in native 8-bit
6638 If the pe1 and pe2 are non-NULL, the scanning pointers will be copied
6639 in there (they will point at the beginning of the I<next> character).
6640 If the pointers behind pe1 or pe2 are non-NULL, they are the end
6641 pointers beyond which scanning will not continue under any
6642 circumstances. If the byte lengths l1 and l2 are non-zero, s1+l1 and
6643 s2+l2 will be used as goal end pointers that will also stop the scan,
6644 and which qualify towards defining a successful match: all the scans
6645 that define an explicit length must reach their goal pointers for
6646 a match to succeed).
6648 For case-insensitiveness, the "casefolding" of Unicode is used
6649 instead of upper/lowercasing both the characters, see
6650 http://www.unicode.org/unicode/reports/tr21/ (Case Mappings).
6652 I32 ibcmp_utf8(const char *s1, char **pe1, UV l1, bool u1, const char *s2, char **pe2, UV l2, bool u2)
6655 Found in file utf8.c
6660 Tests if some arbitrary number of bytes begins in a valid UTF-8
6661 character. Note that an INVARIANT (i.e. ASCII) character is a valid
6662 UTF-8 character. The actual number of bytes in the UTF-8 character
6663 will be returned if it is valid, otherwise 0.
6665 STRLEN is_utf8_char(const U8 *s)
6668 Found in file utf8.c
6670 =item is_utf8_string
6673 Returns true if first C<len> bytes of the given string form a valid
6674 UTF-8 string, false otherwise. Note that 'a valid UTF-8 string' does
6675 not mean 'a string that contains code points above 0x7F encoded in UTF-8'
6676 because a valid ASCII string is a valid UTF-8 string.
6678 See also is_utf8_string_loclen() and is_utf8_string_loc().
6680 bool is_utf8_string(const U8 *s, STRLEN len)
6683 Found in file utf8.c
6685 =item is_utf8_string_loc
6686 X<is_utf8_string_loc>
6688 Like is_utf8_string() but stores the location of the failure (in the
6689 case of "utf8ness failure") or the location s+len (in the case of
6690 "utf8ness success") in the C<ep>.
6692 See also is_utf8_string_loclen() and is_utf8_string().
6694 bool is_utf8_string_loc(const U8 *s, STRLEN len, const U8 **p)
6697 Found in file utf8.c
6699 =item is_utf8_string_loclen
6700 X<is_utf8_string_loclen>
6702 Like is_utf8_string() but stores the location of the failure (in the
6703 case of "utf8ness failure") or the location s+len (in the case of
6704 "utf8ness success") in the C<ep>, and the number of UTF-8
6705 encoded characters in the C<el>.
6707 See also is_utf8_string_loc() and is_utf8_string().
6709 bool is_utf8_string_loclen(const U8 *s, STRLEN len, const U8 **ep, STRLEN *el)
6712 Found in file utf8.c
6714 =item pv_uni_display
6717 Build to the scalar dsv a displayable version of the string spv,
6718 length len, the displayable version being at most pvlim bytes long
6719 (if longer, the rest is truncated and "..." will be appended).
6721 The flags argument can have UNI_DISPLAY_ISPRINT set to display
6722 isPRINT()able characters as themselves, UNI_DISPLAY_BACKSLASH
6723 to display the \\[nrfta\\] as the backslashed versions (like '\n')
6724 (UNI_DISPLAY_BACKSLASH is preferred over UNI_DISPLAY_ISPRINT for \\).
6725 UNI_DISPLAY_QQ (and its alias UNI_DISPLAY_REGEX) have both
6726 UNI_DISPLAY_BACKSLASH and UNI_DISPLAY_ISPRINT turned on.
6728 The pointer to the PV of the dsv is returned.
6730 char* pv_uni_display(SV *dsv, const U8 *spv, STRLEN len, STRLEN pvlim, UV flags)
6733 Found in file utf8.c
6738 The encoding is assumed to be an Encode object, the PV of the ssv is
6739 assumed to be octets in that encoding and decoding the input starts
6740 from the position which (PV + *offset) pointed to. The dsv will be
6741 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
6742 when the string tstr appears in decoding output or the input ends on
6743 the PV of the ssv. The value which the offset points will be modified
6744 to the last input position on the ssv.
6746 Returns TRUE if the terminator was found, else returns FALSE.
6748 bool sv_cat_decode(SV* dsv, SV *encoding, SV *ssv, int *offset, char* tstr, int tlen)
6753 =item sv_recode_to_utf8
6754 X<sv_recode_to_utf8>
6756 The encoding is assumed to be an Encode object, on entry the PV
6757 of the sv is assumed to be octets in that encoding, and the sv
6758 will be converted into Unicode (and UTF-8).
6760 If the sv already is UTF-8 (or if it is not POK), or if the encoding
6761 is not a reference, nothing is done to the sv. If the encoding is not
6762 an C<Encode::XS> Encoding object, bad things will happen.
6763 (See F<lib/encoding.pm> and L<Encode>).
6765 The PV of the sv is returned.
6767 char* sv_recode_to_utf8(SV* sv, SV *encoding)
6772 =item sv_uni_display
6775 Build to the scalar dsv a displayable version of the scalar sv,
6776 the displayable version being at most pvlim bytes long
6777 (if longer, the rest is truncated and "..." will be appended).
6779 The flags argument is as in pv_uni_display().
6781 The pointer to the PV of the dsv is returned.
6783 char* sv_uni_display(SV *dsv, SV *ssv, STRLEN pvlim, UV flags)
6786 Found in file utf8.c
6791 The "p" contains the pointer to the UTF-8 string encoding
6792 the character that is being converted.
6794 The "ustrp" is a pointer to the character buffer to put the
6795 conversion result to. The "lenp" is a pointer to the length
6798 The "swashp" is a pointer to the swash to use.
6800 Both the special and normal mappings are stored lib/unicore/To/Foo.pl,
6801 and loaded by SWASHNEW, using lib/utf8_heavy.pl. The special (usually,
6802 but not always, a multicharacter mapping), is tried first.
6804 The "special" is a string like "utf8::ToSpecLower", which means the
6805 hash %utf8::ToSpecLower. The access to the hash is through
6806 Perl_to_utf8_case().
6808 The "normal" is a string like "ToLower" which means the swash
6811 UV to_utf8_case(const U8 *p, U8* ustrp, STRLEN *lenp, SV **swashp, const char *normal, const char *special)
6814 Found in file utf8.c
6819 Convert the UTF-8 encoded character at p to its foldcase version and
6820 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6821 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6822 foldcase version may be longer than the original character (up to
6825 The first character of the foldcased version is returned
6826 (but note, as explained above, that there may be more.)
6828 UV to_utf8_fold(const U8 *p, U8* ustrp, STRLEN *lenp)
6831 Found in file utf8.c
6836 Convert the UTF-8 encoded character at p to its lowercase version and
6837 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6838 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6839 lowercase version may be longer than the original character.
6841 The first character of the lowercased version is returned
6842 (but note, as explained above, that there may be more.)
6844 UV to_utf8_lower(const U8 *p, U8* ustrp, STRLEN *lenp)
6847 Found in file utf8.c
6852 Convert the UTF-8 encoded character at p to its titlecase version and
6853 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6854 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6855 titlecase version may be longer than the original character.
6857 The first character of the titlecased version is returned
6858 (but note, as explained above, that there may be more.)
6860 UV to_utf8_title(const U8 *p, U8* ustrp, STRLEN *lenp)
6863 Found in file utf8.c
6868 Convert the UTF-8 encoded character at p to its uppercase version and
6869 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6870 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since
6871 the uppercase version may be longer than the original character.
6873 The first character of the uppercased version is returned
6874 (but note, as explained above, that there may be more.)
6876 UV to_utf8_upper(const U8 *p, U8* ustrp, STRLEN *lenp)
6879 Found in file utf8.c
6881 =item utf8n_to_uvchr
6886 Returns the native character value of the first character in the string
6888 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6889 length, in bytes, of that character.
6891 Allows length and flags to be passed to low level routine.
6893 UV utf8n_to_uvchr(const U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags)
6896 Found in file utf8.c
6898 =item utf8n_to_uvuni
6901 Bottom level UTF-8 decode routine.
6902 Returns the Unicode code point value of the first character in the string C<s>
6903 which is assumed to be in UTF-8 encoding and no longer than C<curlen>;
6904 C<retlen> will be set to the length, in bytes, of that character.
6906 If C<s> does not point to a well-formed UTF-8 character, the behaviour
6907 is dependent on the value of C<flags>: if it contains UTF8_CHECK_ONLY,
6908 it is assumed that the caller will raise a warning, and this function
6909 will silently just set C<retlen> to C<-1> and return zero. If the
6910 C<flags> does not contain UTF8_CHECK_ONLY, warnings about
6911 malformations will be given, C<retlen> will be set to the expected
6912 length of the UTF-8 character in bytes, and zero will be returned.
6914 The C<flags> can also contain various flags to allow deviations from
6915 the strict UTF-8 encoding (see F<utf8.h>).
6917 Most code should use utf8_to_uvchr() rather than call this directly.
6919 UV utf8n_to_uvuni(const U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags)
6922 Found in file utf8.c
6927 Returns the number of UTF-8 characters between the UTF-8 pointers C<a>
6930 WARNING: use only if you *know* that the pointers point inside the
6933 IV utf8_distance(const U8 *a, const U8 *b)
6936 Found in file utf8.c
6941 Return the UTF-8 pointer C<s> displaced by C<off> characters, either
6942 forward or backward.
6944 WARNING: do not use the following unless you *know* C<off> is within
6945 the UTF-8 data pointed to by C<s> *and* that on entry C<s> is aligned
6946 on the first byte of character or just after the last byte of a character.
6948 U8* utf8_hop(const U8 *s, I32 off)
6951 Found in file utf8.c
6956 Return the length of the UTF-8 char encoded string C<s> in characters.
6957 Stops at C<e> (inclusive). If C<e E<lt> s> or if the scan would end
6958 up past C<e>, croaks.
6960 STRLEN utf8_length(const U8* s, const U8 *e)
6963 Found in file utf8.c
6968 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
6969 Unlike C<bytes_to_utf8>, this over-writes the original string, and
6970 updates len to contain the new length.
6971 Returns zero on failure, setting C<len> to -1.
6973 If you need a copy of the string, see C<bytes_from_utf8>.
6975 NOTE: this function is experimental and may change or be
6976 removed without notice.
6978 U8* utf8_to_bytes(U8 *s, STRLEN *len)
6981 Found in file utf8.c
6986 Returns the native character value of the first character in the string C<s>
6987 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6988 length, in bytes, of that character.
6990 If C<s> does not point to a well-formed UTF-8 character, zero is
6991 returned and retlen is set, if possible, to -1.
6993 UV utf8_to_uvchr(const U8 *s, STRLEN *retlen)
6996 Found in file utf8.c
7001 Returns the Unicode code point of the first character in the string C<s>
7002 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
7003 length, in bytes, of that character.
7005 This function should only be used when returned UV is considered
7006 an index into the Unicode semantic tables (e.g. swashes).
7008 If C<s> does not point to a well-formed UTF-8 character, zero is
7009 returned and retlen is set, if possible, to -1.
7011 UV utf8_to_uvuni(const U8 *s, STRLEN *retlen)
7014 Found in file utf8.c
7019 Adds the UTF-8 representation of the Native codepoint C<uv> to the end
7020 of the string C<d>; C<d> should be have at least C<UTF8_MAXBYTES+1> free
7021 bytes available. The return value is the pointer to the byte after the
7022 end of the new character. In other words,
7024 d = uvchr_to_utf8(d, uv);
7026 is the recommended wide native character-aware way of saying
7030 U8* uvchr_to_utf8(U8 *d, UV uv)
7033 Found in file utf8.c
7035 =item uvuni_to_utf8_flags
7036 X<uvuni_to_utf8_flags>
7038 Adds the UTF-8 representation of the Unicode codepoint C<uv> to the end
7039 of the string C<d>; C<d> should be have at least C<UTF8_MAXBYTES+1> free
7040 bytes available. The return value is the pointer to the byte after the
7041 end of the new character. In other words,
7043 d = uvuni_to_utf8_flags(d, uv, flags);
7047 d = uvuni_to_utf8(d, uv);
7049 (which is equivalent to)
7051 d = uvuni_to_utf8_flags(d, uv, 0);
7053 is the recommended Unicode-aware way of saying
7057 U8* uvuni_to_utf8_flags(U8 *d, UV uv, UV flags)
7060 Found in file utf8.c
7065 =head1 Variables created by C<xsubpp> and C<xsubpp> internal functions
7072 Variable which is setup by C<xsubpp> to indicate the stack base offset,
7073 used by the C<ST>, C<XSprePUSH> and C<XSRETURN> macros. The C<dMARK> macro
7074 must be called prior to setup the C<MARK> variable.
7079 Found in file XSUB.h
7084 Variable which is setup by C<xsubpp> to indicate the
7085 class name for a C++ XS constructor. This is always a C<char*>. See C<THIS>.
7090 Found in file XSUB.h
7095 Sets up the C<ax> variable.
7096 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
7101 Found in file XSUB.h
7106 Sets up the C<ax> variable and stack marker variable C<mark>.
7107 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
7112 Found in file XSUB.h
7117 Sets up the C<items> variable.
7118 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
7123 Found in file XSUB.h
7128 Sets up the C<padoff_du> variable for an XSUB that wishes to use
7134 Found in file XSUB.h
7139 Sets up stack and mark pointers for an XSUB, calling dSP and dMARK.
7140 Sets up the C<ax> and C<items> variables by calling C<dAX> and C<dITEMS>.
7141 This is usually handled automatically by C<xsubpp>.
7146 Found in file XSUB.h
7151 Sets up the C<ix> variable for an XSUB which has aliases. This is usually
7152 handled automatically by C<xsubpp>.
7157 Found in file XSUB.h
7162 Variable which is setup by C<xsubpp> to indicate the number of
7163 items on the stack. See L<perlxs/"Variable-length Parameter Lists">.
7168 Found in file XSUB.h
7173 Variable which is setup by C<xsubpp> to indicate which of an
7174 XSUB's aliases was used to invoke it. See L<perlxs/"The ALIAS: Keyword">.
7179 Found in file XSUB.h
7184 Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
7188 Found in file XSUB.h
7193 Variable which is setup by C<xsubpp> to hold the return value for an
7194 XSUB. This is always the proper type for the XSUB. See
7195 L<perlxs/"The RETVAL Variable">.
7200 Found in file XSUB.h
7205 Used to access elements on the XSUB's stack.
7210 Found in file XSUB.h
7215 Variable which is setup by C<xsubpp> to designate the object in a C++
7216 XSUB. This is always the proper type for the C++ object. See C<CLASS> and
7217 L<perlxs/"Using XS With C++">.
7222 Found in file XSUB.h
7227 The SV* corresponding to the $_ variable. Works even if there
7228 is a lexical $_ in scope.
7231 Found in file XSUB.h
7236 Macro to declare an XSUB and its C parameter list. This is handled by
7240 Found in file XSUB.h
7245 The version identifier for an XS module. This is usually
7246 handled automatically by C<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>.
7249 Found in file XSUB.h
7251 =item XS_VERSION_BOOTCHECK
7252 X<XS_VERSION_BOOTCHECK>
7254 Macro to verify that a PM module's $VERSION variable matches the XS
7255 module's C<XS_VERSION> variable. This is usually handled automatically by
7256 C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">.
7258 XS_VERSION_BOOTCHECK;
7261 Found in file XSUB.h
7266 =head1 Warning and Dieing
7273 This is the XSUB-writer's interface to Perl's C<die> function.
7274 Normally call this function the same way you call the C C<printf>
7275 function. Calling C<croak> returns control directly to Perl,
7276 sidestepping the normal C order of execution. See C<warn>.
7278 If you want to throw an exception object, assign the object to
7279 C<$@> and then pass C<NULL> to croak():
7281 errsv = get_sv("@", TRUE);
7282 sv_setsv(errsv, exception_object);
7285 void croak(const char* pat, ...)
7288 Found in file util.c
7293 This is the XSUB-writer's interface to Perl's C<warn> function. Call this
7294 function the same way you call the C C<printf> function. See C<croak>.
7296 void warn(const char* pat, ...)
7299 Found in file util.c
7306 Until May 1997, this document was maintained by Jeff Okamoto
7307 <okamoto@corp.hp.com>. It is now maintained as part of Perl itself.
7309 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
7310 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
7311 Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
7312 Stephen McCamant, and Gurusamy Sarathy.
7314 API Listing originally by Dean Roehrich <roehrich@cray.com>.
7316 Updated to be autogenerated from comments in the source by Benjamin Stuhl.
7320 perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
projects / p5sagit/p5-mst-13.2.git / blob