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 Perl was originally written to handle US-ASCII only (that is characters
26 whose ordinal numbers are in the range 0 - 127).
27 And documentation and comments may still use the term ASCII, when
28 sometimes in fact the entire range from 0 - 255 is meant.
30 Note that Perl can be compiled and run under EBCDIC (See L<perlebcdic>)
31 or ASCII. Most of the documentation (and even comments in the code)
32 ignore the EBCDIC possibility.
33 For almost all purposes the differences are transparent.
34 As an example, under EBCDIC,
35 instead of UTF-8, UTF-EBCDIC is used to encode Unicode strings, and so
36 whenever this documentation refers to C<utf8>
37 (and variants of that name, including in function names),
38 it also (essentially transparently) means C<UTF-EBCDIC>.
39 But the ordinals of characters differ between ASCII, EBCDIC, and
40 the UTF- encodings, and a string encoded in UTF-EBCDIC may occupy more bytes
43 Also, on some EBCDIC machines, functions that are documented as operating on
44 US-ASCII (or Basic Latin in Unicode terminology) may in fact operate on all
45 256 characters in the EBCDIC range, not just the subset corresponding to
48 The listing below is alphabetical, case insensitive.
58 A backward-compatible version of C<GIMME_V> which can only return
59 C<G_SCALAR> or C<G_ARRAY>; in a void context, it returns C<G_SCALAR>.
60 Deprecated. Use C<GIMME_V> instead.
70 The XSUB-writer's equivalent to Perl's C<wantarray>. Returns C<G_VOID>,
71 C<G_SCALAR> or C<G_ARRAY> for void, scalar or list context,
82 Used to indicate list context. See C<GIMME_V>, C<GIMME> and
91 Indicates that arguments returned from a callback should be discarded. See
100 Used to force a Perl C<eval> wrapper around a callback. See
109 Indicates that no arguments are being sent to a callback. See
118 Used to indicate scalar context. See C<GIMME_V>, C<GIMME>, and
127 Used to indicate void context. See C<GIMME_V> and L<perlcall>.
135 =head1 Array Manipulation Functions
142 Same as C<av_len()>. Deprecated, use C<av_len()> instead.
152 Clears an array, making it empty. Does not free the memory used by the
155 void av_clear(AV *av)
160 =item av_create_and_push
161 X<av_create_and_push>
163 Push an SV onto the end of the array, creating the array if necessary.
164 A small internal helper function to remove a commonly duplicated idiom.
166 NOTE: this function is experimental and may change or be
167 removed without notice.
169 void av_create_and_push(AV **const avp, SV *const val)
174 =item av_create_and_unshift_one
175 X<av_create_and_unshift_one>
177 Unshifts an SV onto the beginning of the array, creating the array if
179 A small internal helper function to remove a commonly duplicated idiom.
181 NOTE: this function is experimental and may change or be
182 removed without notice.
184 SV** av_create_and_unshift_one(AV **const avp, SV *const val)
192 Deletes the element indexed by C<key> from the array. Returns the
193 deleted element. If C<flags> equals C<G_DISCARD>, the element is freed
194 and null is returned.
196 SV* av_delete(AV *av, I32 key, I32 flags)
204 Returns true if the element indexed by C<key> has been initialized.
206 This relies on the fact that uninitialized array elements are set to
209 bool av_exists(AV *av, I32 key)
217 Pre-extend an array. The C<key> is the index to which the array should be
220 void av_extend(AV *av, I32 key)
228 Returns the SV at the specified index in the array. The C<key> is the
229 index. If C<lval> is set then the fetch will be part of a store. Check
230 that the return value is non-null before dereferencing it to a C<SV*>.
232 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for
233 more information on how to use this function on tied arrays.
235 SV** av_fetch(AV *av, I32 key, I32 lval)
243 Set the highest index in the array to the given number, equivalent to
244 Perl's C<$#array = $fill;>.
246 The number of elements in the an array will be C<fill + 1> after
247 av_fill() returns. If the array was previously shorter then the
248 additional elements appended are set to C<PL_sv_undef>. If the array
249 was longer, then the excess elements are freed. C<av_fill(av, -1)> is
250 the same as C<av_clear(av)>.
252 void av_fill(AV *av, I32 fill)
260 Returns the highest index in the array. The number of elements in the
261 array is C<av_len(av) + 1>. Returns -1 if the array is empty.
271 Creates a new AV and populates it with a list of SVs. The SVs are copied
272 into the array, so they may be freed after the call to av_make. The new AV
273 will have a reference count of 1.
275 AV* av_make(I32 size, SV **strp)
283 Pops an SV off the end of the array. Returns C<&PL_sv_undef> if the array
294 Pushes an SV onto the end of the array. The array will grow automatically
295 to accommodate the addition.
297 void av_push(AV *av, SV *val)
305 Shifts an SV off the beginning of the array. Returns C<&PL_sv_undef> if the
316 Stores an SV in an array. The array index is specified as C<key>. The
317 return value will be NULL if the operation failed or if the value did not
318 need to be actually stored within the array (as in the case of tied
319 arrays). Otherwise it can be dereferenced to get the original C<SV*>. Note
320 that the caller is responsible for suitably incrementing the reference
321 count of C<val> before the call, and decrementing it if the function
324 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for
325 more information on how to use this function on tied arrays.
327 SV** av_store(AV *av, I32 key, SV *val)
335 Undefines the array. Frees the memory used by the array itself.
337 void av_undef(AV *av)
345 Unshift the given number of C<undef> values onto the beginning of the
346 array. The array will grow automatically to accommodate the addition. You
347 must then use C<av_store> to assign values to these new elements.
349 void av_unshift(AV *av, I32 num)
357 Returns the AV of the specified Perl array. C<flags> are passed to
358 C<gv_fetchpv>. If C<GV_ADD> is set and the
359 Perl variable does not exist then it will be created. If C<flags> is zero
360 and the variable does not exist then NULL is returned.
362 NOTE: the perl_ form of this function is deprecated.
364 AV* get_av(const char *name, I32 flags)
372 Creates a new AV. The reference count is set to 1.
382 Sort an array. Here is an example:
384 sortsv(AvARRAY(av), av_len(av)+1, Perl_sv_cmp_locale);
386 Currently this always uses mergesort. See sortsv_flags for a more
389 void sortsv(SV** array, size_t num_elts, SVCOMPARE_t cmp)
392 Found in file pp_sort.c
397 Sort an array, with various options.
399 void sortsv_flags(SV** array, size_t num_elts, SVCOMPARE_t cmp, U32 flags)
402 Found in file pp_sort.c
407 =head1 Callback Functions
414 Performs a callback to the specified Perl sub. See L<perlcall>.
416 NOTE: the perl_ form of this function is deprecated.
418 I32 call_argv(const char* sub_name, I32 flags, char** argv)
426 Performs a callback to the specified Perl method. The blessed object must
427 be on the stack. See L<perlcall>.
429 NOTE: the perl_ form of this function is deprecated.
431 I32 call_method(const char* methname, I32 flags)
439 Performs a callback to the specified Perl sub. See L<perlcall>.
441 NOTE: the perl_ form of this function is deprecated.
443 I32 call_pv(const char* sub_name, I32 flags)
451 Performs a callback to the Perl sub whose name is in the SV. See
454 NOTE: the perl_ form of this function is deprecated.
456 I32 call_sv(SV* sv, VOL I32 flags)
464 Opening bracket on a callback. See C<LEAVE> and L<perlcall>.
469 Found in file scope.h
474 Tells Perl to C<eval> the given string and return an SV* result.
476 NOTE: the perl_ form of this function is deprecated.
478 SV* eval_pv(const char* p, I32 croak_on_error)
486 Tells Perl to C<eval> the string in the SV.
488 NOTE: the perl_ form of this function is deprecated.
490 I32 eval_sv(SV* sv, I32 flags)
498 Closing bracket for temporaries on a callback. See C<SAVETMPS> and
504 Found in file scope.h
509 Closing bracket on a callback. See C<ENTER> and L<perlcall>.
514 Found in file scope.h
519 Opening bracket for temporaries on a callback. See C<FREETMPS> and
525 Found in file scope.h
530 =head1 Character classes
537 Returns a boolean indicating whether the C C<char> is a US-ASCII (Basic Latin)
538 alphanumeric character (including underscore) or digit.
540 bool isALNUM(char ch)
543 Found in file handy.h
548 Returns a boolean indicating whether the C C<char> is a US-ASCII (Basic Latin)
549 alphabetic character.
551 bool isALPHA(char ch)
554 Found in file handy.h
559 Returns a boolean indicating whether the C C<char> is a US-ASCII (Basic Latin)
562 bool isDIGIT(char ch)
565 Found in file handy.h
570 Returns a boolean indicating whether the C C<char> is a US-ASCII (Basic Latin)
573 bool isLOWER(char ch)
576 Found in file handy.h
581 Returns a boolean indicating whether the C C<char> is a US-ASCII (Basic Latin)
584 bool isSPACE(char ch)
587 Found in file handy.h
592 Returns a boolean indicating whether the C C<char> is a US-ASCII (Basic Latin)
595 bool isUPPER(char ch)
598 Found in file handy.h
603 Converts the specified character to lowercase. Characters outside the
604 US-ASCII (Basic Latin) range are viewed as not having any case.
606 char toLOWER(char ch)
609 Found in file handy.h
614 Converts the specified character to uppercase. Characters outside the
615 US-ASCII (Basic Latin) range are viewed as not having any case.
617 char toUPPER(char ch)
620 Found in file handy.h
625 =head1 Cloning an interpreter
632 Create and return a new interpreter by cloning the current one.
634 perl_clone takes these flags as parameters:
636 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
637 without it we only clone the data and zero the stacks,
638 with it we copy the stacks and the new perl interpreter is
639 ready to run at the exact same point as the previous one.
640 The pseudo-fork code uses COPY_STACKS while the
641 threads->create doesn't.
643 CLONEf_KEEP_PTR_TABLE
644 perl_clone keeps a ptr_table with the pointer of the old
645 variable as a key and the new variable as a value,
646 this allows it to check if something has been cloned and not
647 clone it again but rather just use the value and increase the
648 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
649 the ptr_table using the function
650 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
651 reason to keep it around is if you want to dup some of your own
652 variable who are outside the graph perl scans, example of this
653 code is in threads.xs create
656 This is a win32 thing, it is ignored on unix, it tells perls
657 win32host code (which is c++) to clone itself, this is needed on
658 win32 if you want to run two threads at the same time,
659 if you just want to do some stuff in a separate perl interpreter
660 and then throw it away and return to the original one,
661 you don't need to do anything.
663 PerlInterpreter* perl_clone(PerlInterpreter *proto_perl, UV flags)
671 =head1 CV Manipulation Functions
678 Returns the stash of the CV.
688 Uses C<strlen> to get the length of C<name>, then calls C<get_cvn_flags>.
690 NOTE: the perl_ form of this function is deprecated.
692 CV* get_cv(const char* name, I32 flags)
700 Returns the CV of the specified Perl subroutine. C<flags> are passed to
701 C<gv_fetchpvn_flags>. If C<GV_ADD> is set and the Perl subroutine does not
702 exist then it will be declared (which has the same effect as saying
703 C<sub name;>). If C<GV_ADD> is not set and the subroutine does not exist
704 then NULL is returned.
706 NOTE: the perl_ form of this function is deprecated.
708 CV* get_cvn_flags(const char* name, STRLEN len, I32 flags)
716 =head1 Embedding Functions
723 Clear out all the active components of a CV. This can happen either
724 by an explicit C<undef &foo>, or by the reference count going to zero.
725 In the former case, we keep the CvOUTSIDE pointer, so that any anonymous
726 children can still follow the full lexical scope chain.
728 void cv_undef(CV* cv)
736 Loads the module whose name is pointed to by the string part of name.
737 Note that the actual module name, not its filename, should be given.
738 Eg, "Foo::Bar" instead of "Foo/Bar.pm". flags can be any of
739 PERL_LOADMOD_DENY, PERL_LOADMOD_NOIMPORT, or PERL_LOADMOD_IMPORT_OPS
740 (or 0 for no flags). ver, if specified, provides version semantics
741 similar to C<use Foo::Bar VERSION>. The optional trailing SV*
742 arguments can be used to specify arguments to the module's import()
743 method, similar to C<use Foo::Bar VERSION LIST>.
745 void load_module(U32 flags, SV* name, SV* ver, ...)
753 Stub that provides thread hook for perl_destruct when there are
764 Allocates a new Perl interpreter. See L<perlembed>.
766 PerlInterpreter* perl_alloc()
774 Initializes a new Perl interpreter. See L<perlembed>.
776 void perl_construct(PerlInterpreter *my_perl)
784 Shuts down a Perl interpreter. See L<perlembed>.
786 int perl_destruct(PerlInterpreter *my_perl)
794 Releases a Perl interpreter. See L<perlembed>.
796 void perl_free(PerlInterpreter *my_perl)
804 Tells a Perl interpreter to parse a Perl script. See L<perlembed>.
806 int perl_parse(PerlInterpreter *my_perl, XSINIT_t xsinit, int argc, char** argv, char** env)
814 Tells a Perl interpreter to run. See L<perlembed>.
816 int perl_run(PerlInterpreter *my_perl)
824 Tells Perl to C<require> the file named by the string argument. It is
825 analogous to the Perl code C<eval "require '$file'">. It's even
826 implemented that way; consider using load_module instead.
828 NOTE: the perl_ form of this function is deprecated.
830 void require_pv(const char* pv)
838 =head1 Functions in file dump.c
848 pv_escape(dsv,pv,cur,pvlim,PERL_PV_ESCAPE_QUOTE);
850 except that an additional "\0" will be appended to the string when
851 len > cur and pv[cur] is "\0".
853 Note that the final string may be up to 7 chars longer than pvlim.
855 char* pv_display(SV *dsv, const char *pv, STRLEN cur, STRLEN len, STRLEN pvlim)
863 Escapes at most the first "count" chars of pv and puts the results into
864 dsv such that the size of the escaped string will not exceed "max" chars
865 and will not contain any incomplete escape sequences.
867 If flags contains PERL_PV_ESCAPE_QUOTE then any double quotes in the string
868 will also be escaped.
870 Normally the SV will be cleared before the escaped string is prepared,
871 but when PERL_PV_ESCAPE_NOCLEAR is set this will not occur.
873 If PERL_PV_ESCAPE_UNI is set then the input string is treated as Unicode,
874 if PERL_PV_ESCAPE_UNI_DETECT is set then the input string is scanned
875 using C<is_utf8_string()> to determine if it is Unicode.
877 If PERL_PV_ESCAPE_ALL is set then all input chars will be output
878 using C<\x01F1> style escapes, otherwise only chars above 255 will be
879 escaped using this style, other non printable chars will use octal or
880 common escaped patterns like C<\n>. If PERL_PV_ESCAPE_NOBACKSLASH
881 then all chars below 255 will be treated as printable and
882 will be output as literals.
884 If PERL_PV_ESCAPE_FIRSTCHAR is set then only the first char of the
885 string will be escaped, regardles of max. If the string is utf8 and
886 the chars value is >255 then it will be returned as a plain hex
887 sequence. Thus the output will either be a single char,
888 an octal escape sequence, a special escape like C<\n> or a 3 or
889 more digit hex value.
891 If PERL_PV_ESCAPE_RE is set then the escape char used will be a '%' and
892 not a '\\'. This is because regexes very often contain backslashed
893 sequences, whereas '%' is not a particularly common character in patterns.
895 Returns a pointer to the escaped text as held by dsv.
897 char* pv_escape(SV *dsv, char const * const str, const STRLEN count, const STRLEN max, STRLEN * const escaped, const U32 flags)
905 Converts a string into something presentable, handling escaping via
906 pv_escape() and supporting quoting and ellipses.
908 If the PERL_PV_PRETTY_QUOTE flag is set then the result will be
909 double quoted with any double quotes in the string escaped. Otherwise
910 if the PERL_PV_PRETTY_LTGT flag is set then the result be wrapped in
913 If the PERL_PV_PRETTY_ELLIPSES flag is set and not all characters in
914 string were output then an ellipsis C<...> will be appended to the
915 string. Note that this happens AFTER it has been quoted.
917 If start_color is non-null then it will be inserted after the opening
918 quote (if there is one) but before the escaped text. If end_color
919 is non-null then it will be inserted after the escaped text but before
920 any quotes or ellipses.
922 Returns a pointer to the prettified text as held by dsv.
924 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)
932 =head1 Functions in file mathoms.c
940 See L<gv_fetchmethod_autoload>.
942 GV* gv_fetchmethod(HV* stash, const char* name)
945 Found in file mathoms.c
950 The engine implementing pack() Perl function. Note: parameters next_in_list and
951 flags are not used. This call should not be used; use packlist instead.
953 void pack_cat(SV *cat, const char *pat, const char *patend, SV **beglist, SV **endlist, SV ***next_in_list, U32 flags)
956 Found in file mathoms.c
958 =item sv_2pvbyte_nolen
961 Return a pointer to the byte-encoded representation of the SV.
962 May cause the SV to be downgraded from UTF-8 as a side-effect.
964 Usually accessed via the C<SvPVbyte_nolen> macro.
966 char* sv_2pvbyte_nolen(SV* sv)
969 Found in file mathoms.c
971 =item sv_2pvutf8_nolen
974 Return a pointer to the UTF-8-encoded representation of the SV.
975 May cause the SV to be upgraded to UTF-8 as a side-effect.
977 Usually accessed via the C<SvPVutf8_nolen> macro.
979 char* sv_2pvutf8_nolen(SV* sv)
982 Found in file mathoms.c
987 Like C<sv_2pv()>, but doesn't return the length too. You should usually
988 use the macro wrapper C<SvPV_nolen(sv)> instead.
989 char* sv_2pv_nolen(SV* sv)
992 Found in file mathoms.c
997 Like C<sv_catpvn>, but also handles 'set' magic.
999 void sv_catpvn_mg(SV *sv, const char *ptr, STRLEN len)
1002 Found in file mathoms.c
1007 Like C<sv_catsv>, but also handles 'set' magic.
1009 void sv_catsv_mg(SV *dsv, SV *ssv)
1012 Found in file mathoms.c
1014 =item sv_force_normal
1017 Undo various types of fakery on an SV: if the PV is a shared string, make
1018 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
1019 an xpvmg. See also C<sv_force_normal_flags>.
1021 void sv_force_normal(SV *sv)
1024 Found in file mathoms.c
1029 A private implementation of the C<SvIVx> macro for compilers which can't
1030 cope with complex macro expressions. Always use the macro instead.
1035 Found in file mathoms.c
1040 Dummy routine which "locks" an SV when there is no locking module present.
1041 Exists to avoid test for a NULL function pointer and because it could
1042 potentially warn under some level of strict-ness.
1044 "Superseded" by sv_nosharing().
1046 void sv_nolocking(SV *sv)
1049 Found in file mathoms.c
1051 =item sv_nounlocking
1054 Dummy routine which "unlocks" an SV when there is no locking module present.
1055 Exists to avoid test for a NULL function pointer and because it could
1056 potentially warn under some level of strict-ness.
1058 "Superseded" by sv_nosharing().
1060 void sv_nounlocking(SV *sv)
1063 Found in file mathoms.c
1068 A private implementation of the C<SvNVx> macro for compilers which can't
1069 cope with complex macro expressions. Always use the macro instead.
1074 Found in file mathoms.c
1079 Use the C<SvPV_nolen> macro instead
1084 Found in file mathoms.c
1089 Use C<SvPVbyte_nolen> instead.
1091 char* sv_pvbyte(SV *sv)
1094 Found in file mathoms.c
1099 A private implementation of the C<SvPVbyte> macro for compilers
1100 which can't cope with complex macro expressions. Always use the macro
1103 char* sv_pvbyten(SV *sv, STRLEN *lp)
1106 Found in file mathoms.c
1111 A private implementation of the C<SvPV> macro for compilers which can't
1112 cope with complex macro expressions. Always use the macro instead.
1114 char* sv_pvn(SV *sv, STRLEN *lp)
1117 Found in file mathoms.c
1122 Use the C<SvPVutf8_nolen> macro instead
1124 char* sv_pvutf8(SV *sv)
1127 Found in file mathoms.c
1132 A private implementation of the C<SvPVutf8> macro for compilers
1133 which can't cope with complex macro expressions. Always use the macro
1136 char* sv_pvutf8n(SV *sv, STRLEN *lp)
1139 Found in file mathoms.c
1144 Taint an SV. Use C<SvTAINTED_on> instead.
1145 void sv_taint(SV* sv)
1148 Found in file mathoms.c
1153 Unsets the RV status of the SV, and decrements the reference count of
1154 whatever was being referenced by the RV. This can almost be thought of
1155 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
1156 being zero. See C<SvROK_off>.
1158 void sv_unref(SV* sv)
1161 Found in file mathoms.c
1166 Tells an SV to use C<ptr> to find its string value. Implemented by
1167 calling C<sv_usepvn_flags> with C<flags> of 0, hence does not handle 'set'
1168 magic. See C<sv_usepvn_flags>.
1170 void sv_usepvn(SV* sv, char* ptr, STRLEN len)
1173 Found in file mathoms.c
1178 Like C<sv_usepvn>, but also handles 'set' magic.
1180 void sv_usepvn_mg(SV *sv, char *ptr, STRLEN len)
1183 Found in file mathoms.c
1188 A private implementation of the C<SvUVx> macro for compilers which can't
1189 cope with complex macro expressions. Always use the macro instead.
1194 Found in file mathoms.c
1199 The engine implementing unpack() Perl function. Note: parameters strbeg, new_s
1200 and ocnt are not used. This call should not be used, use unpackstring instead.
1202 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)
1205 Found in file mathoms.c
1210 =head1 Functions in file pp_ctl.c
1218 Locate the CV corresponding to the currently executing sub or eval.
1219 If db_seqp is non_null, skip CVs that are in the DB package and populate
1220 *db_seqp with the cop sequence number at the point that the DB:: code was
1221 entered. (allows debuggers to eval in the scope of the breakpoint rather
1222 than in the scope of the debugger itself).
1224 CV* find_runcv(U32 *db_seqp)
1227 Found in file pp_ctl.c
1232 =head1 Functions in file pp_pack.c
1240 The engine implementing pack() Perl function.
1242 void packlist(SV *cat, const char *pat, const char *patend, SV **beglist, SV **endlist)
1245 Found in file pp_pack.c
1250 The engine implementing unpack() Perl function. C<unpackstring> puts the
1251 extracted list items on the stack and returns the number of elements.
1252 Issue C<PUTBACK> before and C<SPAGAIN> after the call to this function.
1254 I32 unpackstring(const char *pat, const char *patend, const char *s, const char *strend, U32 flags)
1257 Found in file pp_pack.c
1262 =head1 Functions in file pp_sys.c
1270 Sets PL_defoutgv, the default file handle for output, to the passed in
1271 typeglob. As PL_defoutgv "owns" a reference on its typeglob, the reference
1272 count of the passed in typeglob is increased by one, and the reference count
1273 of the typeglob that PL_defoutgv points to is decreased by one.
1275 void setdefout(GV* gv)
1278 Found in file pp_sys.c
1290 Return the SV from the GV.
1300 If C<gv> is a typeglob whose subroutine entry is a constant sub eligible for
1301 inlining, or C<gv> is a placeholder reference that would be promoted to such
1302 a typeglob, then returns the value returned by the sub. Otherwise, returns
1305 SV* gv_const_sv(GV* gv)
1313 Returns the glob with the given C<name> and a defined subroutine or
1314 C<NULL>. The glob lives in the given C<stash>, or in the stashes
1315 accessible via @ISA and UNIVERSAL::.
1317 The argument C<level> should be either 0 or -1. If C<level==0>, as a
1318 side-effect creates a glob with the given C<name> in the given C<stash>
1319 which in the case of success contains an alias for the subroutine, and sets
1320 up caching info for this glob.
1322 This function grants C<"SUPER"> token as a postfix of the stash name. The
1323 GV returned from C<gv_fetchmeth> may be a method cache entry, which is not
1324 visible to Perl code. So when calling C<call_sv>, you should not use
1325 the GV directly; instead, you should use the method's CV, which can be
1326 obtained from the GV with the C<GvCV> macro.
1328 GV* gv_fetchmeth(HV* stash, const char* name, STRLEN len, I32 level)
1333 =item gv_fetchmethod_autoload
1334 X<gv_fetchmethod_autoload>
1336 Returns the glob which contains the subroutine to call to invoke the method
1337 on the C<stash>. In fact in the presence of autoloading this may be the
1338 glob for "AUTOLOAD". In this case the corresponding variable $AUTOLOAD is
1341 The third parameter of C<gv_fetchmethod_autoload> determines whether
1342 AUTOLOAD lookup is performed if the given method is not present: non-zero
1343 means yes, look for AUTOLOAD; zero means no, don't look for AUTOLOAD.
1344 Calling C<gv_fetchmethod> is equivalent to calling C<gv_fetchmethod_autoload>
1345 with a non-zero C<autoload> parameter.
1347 These functions grant C<"SUPER"> token as a prefix of the method name. Note
1348 that if you want to keep the returned glob for a long time, you need to
1349 check for it being "AUTOLOAD", since at the later time the call may load a
1350 different subroutine due to $AUTOLOAD changing its value. Use the glob
1351 created via a side effect to do this.
1353 These functions have the same side-effects and as C<gv_fetchmeth> with
1354 C<level==0>. C<name> should be writable if contains C<':'> or C<'
1355 ''>. The warning against passing the GV returned by C<gv_fetchmeth> to
1356 C<call_sv> apply equally to these functions.
1358 GV* gv_fetchmethod_autoload(HV* stash, const char* name, I32 autoload)
1363 =item gv_fetchmeth_autoload
1364 X<gv_fetchmeth_autoload>
1366 Same as gv_fetchmeth(), but looks for autoloaded subroutines too.
1367 Returns a glob for the subroutine.
1369 For an autoloaded subroutine without a GV, will create a GV even
1370 if C<level < 0>. For an autoloaded subroutine without a stub, GvCV()
1371 of the result may be zero.
1373 GV* gv_fetchmeth_autoload(HV* stash, const char* name, STRLEN len, I32 level)
1381 Returns a pointer to the stash for a specified package. Uses C<strlen> to
1382 determine the length of C<name>, then calls C<gv_stashpvn()>.
1384 HV* gv_stashpv(const char* name, I32 flags)
1392 Returns a pointer to the stash for a specified package. The C<namelen>
1393 parameter indicates the length of the C<name>, in bytes. C<flags> is passed
1394 to C<gv_fetchpvn_flags()>, so if set to C<GV_ADD> then the package will be
1395 created if it does not already exist. If the package does not exist and
1396 C<flags> is 0 (or any other setting that does not create packages) then NULL
1400 HV* gv_stashpvn(const char* name, U32 namelen, I32 flags)
1408 Like C<gv_stashpvn>, but takes a literal string instead of a string/length pair.
1410 HV* gv_stashpvs(const char* name, I32 create)
1413 Found in file handy.h
1418 Returns a pointer to the stash for a specified package. See C<gv_stashpvn>.
1420 HV* gv_stashsv(SV* sv, I32 flags)
1437 (deprecated - use C<(AV *)NULL> instead)
1445 Null character pointer. (No longer available when C<PERL_CORE> is defined.)
1448 Found in file handy.h
1455 (deprecated - use C<(CV *)NULL> instead)
1465 (deprecated - use C<(HV *)NULL> instead)
1473 Null SV pointer. (No longer available when C<PERL_CORE> is defined.)
1476 Found in file handy.h
1481 =head1 Hash Manipulation Functions
1488 Returns the HV of the specified Perl hash. C<flags> are passed to
1489 C<gv_fetchpv>. If C<GV_ADD> is set and the
1490 Perl variable does not exist then it will be created. If C<flags> is zero
1491 and the variable does not exist then NULL is returned.
1493 NOTE: the perl_ form of this function is deprecated.
1495 HV* get_hv(const char *name, I32 flags)
1498 Found in file perl.c
1503 This flag, used in the length slot of hash entries and magic structures,
1504 specifies the structure contains an C<SV*> pointer where a C<char*> pointer
1505 is to be expected. (For information only--not to be used).
1513 Returns the computed hash stored in the hash entry.
1523 Returns the actual pointer stored in the key slot of the hash entry. The
1524 pointer may be either C<char*> or C<SV*>, depending on the value of
1525 C<HeKLEN()>. Can be assigned to. The C<HePV()> or C<HeSVKEY()> macros are
1526 usually preferable for finding the value of a key.
1536 If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry
1537 holds an C<SV*> key. Otherwise, holds the actual length of the key. Can
1538 be assigned to. The C<HePV()> macro is usually preferable for finding key
1541 STRLEN HeKLEN(HE* he)
1549 Returns the key slot of the hash entry as a C<char*> value, doing any
1550 necessary dereferencing of possibly C<SV*> keys. The length of the string
1551 is placed in C<len> (this is a macro, so do I<not> use C<&len>). If you do
1552 not care about what the length of the key is, you may use the global
1553 variable C<PL_na>, though this is rather less efficient than using a local
1554 variable. Remember though, that hash keys in perl are free to contain
1555 embedded nulls, so using C<strlen()> or similar is not a good way to find
1556 the length of hash keys. This is very similar to the C<SvPV()> macro
1557 described elsewhere in this document. See also C<HeUTF8>.
1559 If you are using C<HePV> to get values to pass to C<newSVpvn()> to create a
1560 new SV, you should consider using C<newSVhek(HeKEY_hek(he))> as it is more
1563 char* HePV(HE* he, STRLEN len)
1571 Returns the key as an C<SV*>, or C<NULL> if the hash entry does not
1572 contain an C<SV*> key.
1582 Returns the key as an C<SV*>. Will create and return a temporary mortal
1583 C<SV*> if the hash entry contains only a C<char*> key.
1585 SV* HeSVKEY_force(HE* he)
1593 Sets the key to a given C<SV*>, taking care to set the appropriate flags to
1594 indicate the presence of an C<SV*> key, and returns the same
1597 SV* HeSVKEY_set(HE* he, SV* sv)
1605 Returns whether the C<char *> value returned by C<HePV> is encoded in UTF-8,
1606 doing any necessary dereferencing of possibly C<SV*> keys. The value returned
1607 will be 0 or non-0, not necessarily 1 (or even a value with any low bits set),
1608 so B<do not> blindly assign this to a C<bool> variable, as C<bool> may be a
1609 typedef for C<char>.
1611 char* HeUTF8(HE* he, STRLEN len)
1619 Returns the value slot (type C<SV*>) stored in the hash entry.
1629 Returns the package name of a stash, or NULL if C<stash> isn't a stash.
1630 See C<SvSTASH>, C<CvSTASH>.
1632 char* HvNAME(HV* stash)
1640 Check that a hash is in an internally consistent state.
1642 void hv_assert(HV *hv)
1650 Clears a hash, making it empty.
1652 void hv_clear(HV *hv)
1657 =item hv_clear_placeholders
1658 X<hv_clear_placeholders>
1660 Clears any placeholders from a hash. If a restricted hash has any of its keys
1661 marked as readonly and the key is subsequently deleted, the key is not actually
1662 deleted but is marked by assigning it a value of &PL_sv_placeholder. This tags
1663 it so it will be ignored by future operations such as iterating over the hash,
1664 but will still allow the hash to have a value reassigned to the key at some
1665 future point. This function clears any such placeholder keys from the hash.
1666 See Hash::Util::lock_keys() for an example of its use.
1668 void hv_clear_placeholders(HV *hv)
1676 Deletes a key/value pair in the hash. The value SV is removed from the
1677 hash and returned to the caller. The C<klen> is the length of the key.
1678 The C<flags> value will normally be zero; if set to G_DISCARD then NULL
1681 SV* hv_delete(HV *hv, const char *key, I32 klen, I32 flags)
1689 Deletes a key/value pair in the hash. The value SV is removed from the
1690 hash and returned to the caller. The C<flags> value will normally be zero;
1691 if set to G_DISCARD then NULL will be returned. C<hash> can be a valid
1692 precomputed hash value, or 0 to ask for it to be computed.
1694 SV* hv_delete_ent(HV *hv, SV *keysv, I32 flags, U32 hash)
1702 Returns a boolean indicating whether the specified hash key exists. The
1703 C<klen> is the length of the key.
1705 bool hv_exists(HV *hv, const char *key, I32 klen)
1713 Returns a boolean indicating whether the specified hash key exists. C<hash>
1714 can be a valid precomputed hash value, or 0 to ask for it to be
1717 bool hv_exists_ent(HV *hv, SV *keysv, U32 hash)
1725 Returns the SV which corresponds to the specified key in the hash. The
1726 C<klen> is the length of the key. If C<lval> is set then the fetch will be
1727 part of a store. Check that the return value is non-null before
1728 dereferencing it to an C<SV*>.
1730 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1731 information on how to use this function on tied hashes.
1733 SV** hv_fetch(HV *hv, const char *key, I32 klen, I32 lval)
1741 Like C<hv_fetch>, but takes a literal string instead of a string/length pair.
1743 SV** hv_fetchs(HV* tb, const char* key, I32 lval)
1746 Found in file handy.h
1751 Returns the hash entry which corresponds to the specified key in the hash.
1752 C<hash> must be a valid precomputed hash number for the given C<key>, or 0
1753 if you want the function to compute it. IF C<lval> is set then the fetch
1754 will be part of a store. Make sure the return value is non-null before
1755 accessing it. The return value when C<tb> is a tied hash is a pointer to a
1756 static location, so be sure to make a copy of the structure if you need to
1759 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1760 information on how to use this function on tied hashes.
1762 HE* hv_fetch_ent(HV *hv, SV *keysv, I32 lval, U32 hash)
1770 Prepares a starting point to traverse a hash table. Returns the number of
1771 keys in the hash (i.e. the same as C<HvKEYS(tb)>). The return value is
1772 currently only meaningful for hashes without tie magic.
1774 NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
1775 hash buckets that happen to be in use. If you still need that esoteric
1776 value, you can get it through the macro C<HvFILL(tb)>.
1779 I32 hv_iterinit(HV *hv)
1787 Returns the key from the current position of the hash iterator. See
1790 char* hv_iterkey(HE* entry, I32* retlen)
1798 Returns the key as an C<SV*> from the current position of the hash
1799 iterator. The return value will always be a mortal copy of the key. Also
1802 SV* hv_iterkeysv(HE* entry)
1810 Returns entries from a hash iterator. See C<hv_iterinit>.
1812 You may call C<hv_delete> or C<hv_delete_ent> on the hash entry that the
1813 iterator currently points to, without losing your place or invalidating your
1814 iterator. Note that in this case the current entry is deleted from the hash
1815 with your iterator holding the last reference to it. Your iterator is flagged
1816 to free the entry on the next call to C<hv_iternext>, so you must not discard
1817 your iterator immediately else the entry will leak - call C<hv_iternext> to
1818 trigger the resource deallocation.
1820 HE* hv_iternext(HV *hv)
1828 Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
1831 SV* hv_iternextsv(HV *hv, char **key, I32 *retlen)
1836 =item hv_iternext_flags
1837 X<hv_iternext_flags>
1839 Returns entries from a hash iterator. See C<hv_iterinit> and C<hv_iternext>.
1840 The C<flags> value will normally be zero; if HV_ITERNEXT_WANTPLACEHOLDERS is
1841 set the placeholders keys (for restricted hashes) will be returned in addition
1842 to normal keys. By default placeholders are automatically skipped over.
1843 Currently a placeholder is implemented with a value that is
1844 C<&Perl_sv_placeholder>. Note that the implementation of placeholders and
1845 restricted hashes may change, and the implementation currently is
1846 insufficiently abstracted for any change to be tidy.
1848 NOTE: this function is experimental and may change or be
1849 removed without notice.
1851 HE* hv_iternext_flags(HV *hv, I32 flags)
1859 Returns the value from the current position of the hash iterator. See
1862 SV* hv_iterval(HV *hv, HE *entry)
1870 Adds magic to a hash. See C<sv_magic>.
1872 void hv_magic(HV *hv, GV *gv, int how)
1880 Evaluates the hash in scalar context and returns the result. Handles magic when the hash is tied.
1882 SV* hv_scalar(HV *hv)
1890 Stores an SV in a hash. The hash key is specified as C<key> and C<klen> is
1891 the length of the key. The C<hash> parameter is the precomputed hash
1892 value; if it is zero then Perl will compute it. The return value will be
1893 NULL if the operation failed or if the value did not need to be actually
1894 stored within the hash (as in the case of tied hashes). Otherwise it can
1895 be dereferenced to get the original C<SV*>. Note that the caller is
1896 responsible for suitably incrementing the reference count of C<val> before
1897 the call, and decrementing it if the function returned NULL. Effectively
1898 a successful hv_store takes ownership of one reference to C<val>. This is
1899 usually what you want; a newly created SV has a reference count of one, so
1900 if all your code does is create SVs then store them in a hash, hv_store
1901 will own the only reference to the new SV, and your code doesn't need to do
1902 anything further to tidy up. hv_store is not implemented as a call to
1903 hv_store_ent, and does not create a temporary SV for the key, so if your
1904 key data is not already in SV form then use hv_store in preference to
1907 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1908 information on how to use this function on tied hashes.
1910 SV** hv_store(HV *hv, const char *key, I32 klen, SV *val, U32 hash)
1918 Like C<hv_store>, but takes a literal string instead of a string/length pair
1919 and omits the hash parameter.
1921 SV** hv_stores(HV* tb, const char* key, NULLOK SV* val)
1924 Found in file handy.h
1929 Stores C<val> in a hash. The hash key is specified as C<key>. The C<hash>
1930 parameter is the precomputed hash value; if it is zero then Perl will
1931 compute it. The return value is the new hash entry so created. It will be
1932 NULL if the operation failed or if the value did not need to be actually
1933 stored within the hash (as in the case of tied hashes). Otherwise the
1934 contents of the return value can be accessed using the C<He?> macros
1935 described here. Note that the caller is responsible for suitably
1936 incrementing the reference count of C<val> before the call, and
1937 decrementing it if the function returned NULL. Effectively a successful
1938 hv_store_ent takes ownership of one reference to C<val>. This is
1939 usually what you want; a newly created SV has a reference count of one, so
1940 if all your code does is create SVs then store them in a hash, hv_store
1941 will own the only reference to the new SV, and your code doesn't need to do
1942 anything further to tidy up. Note that hv_store_ent only reads the C<key>;
1943 unlike C<val> it does not take ownership of it, so maintaining the correct
1944 reference count on C<key> is entirely the caller's responsibility. hv_store
1945 is not implemented as a call to hv_store_ent, and does not create a temporary
1946 SV for the key, so if your key data is not already in SV form then use
1947 hv_store in preference to hv_store_ent.
1949 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1950 information on how to use this function on tied hashes.
1952 HE* hv_store_ent(HV *hv, SV *key, SV *val, U32 hash)
1962 void hv_undef(HV *hv)
1970 Creates a new HV. The reference count is set to 1.
1980 =head1 Magical Functions
1987 Clear something magical that the SV represents. See C<sv_magic>.
1989 int mg_clear(SV* sv)
1997 Copies the magic from one SV to another. See C<sv_magic>.
1999 int mg_copy(SV *sv, SV *nsv, const char *key, I32 klen)
2007 Finds the magic pointer for type matching the SV. See C<sv_magic>.
2009 MAGIC* mg_find(const SV* sv, int type)
2017 Free any magic storage used by the SV. See C<sv_magic>.
2027 Do magic after a value is retrieved from the SV. See C<sv_magic>.
2037 Report on the SV's length. See C<sv_magic>.
2039 U32 mg_length(SV* sv)
2047 Turns on the magical status of an SV. See C<sv_magic>.
2049 void mg_magical(SV* sv)
2057 Do magic after a value is assigned to the SV. See C<sv_magic>.
2067 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
2068 argument more than once.
2070 void SvGETMAGIC(SV* sv)
2078 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
2089 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
2090 argument more than once.
2092 void SvSETMAGIC(SV* sv)
2100 Like C<SvSetSV>, but does any set magic required afterwards.
2102 void SvSetMagicSV(SV* dsb, SV* ssv)
2107 =item SvSetMagicSV_nosteal
2108 X<SvSetMagicSV_nosteal>
2110 Like C<SvSetSV_nosteal>, but does any set magic required afterwards.
2112 void SvSetMagicSV_nosteal(SV* dsv, SV* ssv)
2120 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
2123 void SvSetSV(SV* dsb, SV* ssv)
2128 =item SvSetSV_nosteal
2131 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
2132 ssv. May evaluate arguments more than once.
2134 void SvSetSV_nosteal(SV* dsv, SV* ssv)
2142 Arranges for sv to be shared between threads if a suitable module
2145 void SvSHARE(SV* sv)
2153 Releases a mutual exclusion lock on sv if a suitable module
2156 void SvUNLOCK(SV* sv)
2164 =head1 Memory Management
2171 The XSUB-writer's interface to the C C<memcpy> function. The C<src> is the
2172 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
2173 the type. May fail on overlapping copies. See also C<Move>.
2175 void Copy(void* src, void* dest, int nitems, type)
2178 Found in file handy.h
2183 Like C<Copy> but returns dest. Useful for encouraging compilers to tail-call
2186 void * CopyD(void* src, void* dest, int nitems, type)
2189 Found in file handy.h
2194 The XSUB-writer's interface to the C C<memmove> function. The C<src> is the
2195 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
2196 the type. Can do overlapping moves. See also C<Copy>.
2198 void Move(void* src, void* dest, int nitems, type)
2201 Found in file handy.h
2206 Like C<Move> but returns dest. Useful for encouraging compilers to tail-call
2209 void * MoveD(void* src, void* dest, int nitems, type)
2212 Found in file handy.h
2217 The XSUB-writer's interface to the C C<malloc> function.
2219 In 5.9.3, Newx() and friends replace the older New() API, and drops
2220 the first parameter, I<x>, a debug aid which allowed callers to identify
2221 themselves. This aid has been superseded by a new build option,
2222 PERL_MEM_LOG (see L<perlhack/PERL_MEM_LOG>). The older API is still
2223 there for use in XS modules supporting older perls.
2225 void Newx(void* ptr, int nitems, type)
2228 Found in file handy.h
2233 The XSUB-writer's interface to the C C<malloc> function, with
2234 cast. See also C<Newx>.
2236 void Newxc(void* ptr, int nitems, type, cast)
2239 Found in file handy.h
2244 The XSUB-writer's interface to the C C<malloc> function. The allocated
2245 memory is zeroed with C<memzero>. See also C<Newx>.
2247 void Newxz(void* ptr, int nitems, type)
2250 Found in file handy.h
2255 PoisonWith(0xEF) for catching access to freed memory.
2257 void Poison(void* dest, int nitems, type)
2260 Found in file handy.h
2265 PoisonWith(0xEF) for catching access to freed memory.
2267 void PoisonFree(void* dest, int nitems, type)
2270 Found in file handy.h
2275 PoisonWith(0xAB) for catching access to allocated but uninitialized memory.
2277 void PoisonNew(void* dest, int nitems, type)
2280 Found in file handy.h
2285 Fill up memory with a byte pattern (a byte repeated over and over
2286 again) that hopefully catches attempts to access uninitialized memory.
2288 void PoisonWith(void* dest, int nitems, type, U8 byte)
2291 Found in file handy.h
2296 The XSUB-writer's interface to the C C<realloc> function.
2298 void Renew(void* ptr, int nitems, type)
2301 Found in file handy.h
2306 The XSUB-writer's interface to the C C<realloc> function, with
2309 void Renewc(void* ptr, int nitems, type, cast)
2312 Found in file handy.h
2317 The XSUB-writer's interface to the C C<free> function.
2319 void Safefree(void* ptr)
2322 Found in file handy.h
2327 Perl's version of C<strdup()>. Returns a pointer to a newly allocated
2328 string which is a duplicate of C<pv>. The size of the string is
2329 determined by C<strlen()>. The memory allocated for the new string can
2330 be freed with the C<Safefree()> function.
2332 char* savepv(const char* pv)
2335 Found in file util.c
2340 Perl's version of what C<strndup()> would be if it existed. Returns a
2341 pointer to a newly allocated string which is a duplicate of the first
2342 C<len> bytes from C<pv>, plus a trailing NUL byte. The memory allocated for
2343 the new string can be freed with the C<Safefree()> function.
2345 char* savepvn(const char* pv, I32 len)
2348 Found in file util.c
2353 Like C<savepvn>, but takes a literal string instead of a string/length pair.
2355 char* savepvs(const char* s)
2358 Found in file handy.h
2363 A version of C<savepv()> which allocates the duplicate string in memory
2364 which is shared between threads.
2366 char* savesharedpv(const char* pv)
2369 Found in file util.c
2374 A version of C<savepvn()> which allocates the duplicate string in memory
2375 which is shared between threads. (With the specific difference that a NULL
2376 pointer is not acceptable)
2378 char* savesharedpvn(const char *const pv, const STRLEN len)
2381 Found in file util.c
2386 A version of C<savepv()>/C<savepvn()> which gets the string to duplicate from
2387 the passed in SV using C<SvPV()>
2389 char* savesvpv(SV* sv)
2392 Found in file util.c
2397 This is an architecture-independent macro to copy one structure to another.
2399 void StructCopy(type src, type dest, type)
2402 Found in file handy.h
2407 The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the
2408 destination, C<nitems> is the number of items, and C<type> is the type.
2410 void Zero(void* dest, int nitems, type)
2413 Found in file handy.h
2418 Like C<Zero> but returns dest. Useful for encouraging compilers to tail-call
2421 void * ZeroD(void* dest, int nitems, type)
2424 Found in file handy.h
2429 =head1 Miscellaneous Functions
2436 Analyses the string in order to make fast searches on it using fbm_instr()
2437 -- the Boyer-Moore algorithm.
2439 void fbm_compile(SV* sv, U32 flags)
2442 Found in file util.c
2447 Returns the location of the SV in the string delimited by C<str> and
2448 C<strend>. It returns C<NULL> if the string can't be found. The C<sv>
2449 does not have to be fbm_compiled, but the search will not be as fast
2452 char* fbm_instr(unsigned char* big, unsigned char* bigend, SV* littlestr, U32 flags)
2455 Found in file util.c
2460 Takes a sprintf-style format pattern and conventional
2461 (non-SV) arguments and returns the formatted string.
2463 (char *) Perl_form(pTHX_ const char* pat, ...)
2465 can be used any place a string (char *) is required:
2467 char * s = Perl_form("%d.%d",major,minor);
2469 Uses a single private buffer so if you want to format several strings you
2470 must explicitly copy the earlier strings away (and free the copies when you
2473 char* form(const char* pat, ...)
2476 Found in file util.c
2481 Fill the sv with current working directory
2483 int getcwd_sv(SV* sv)
2486 Found in file util.c
2491 The C library C<snprintf> functionality, if available and
2492 standards-compliant (uses C<vsnprintf>, actually). However, if the
2493 C<vsnprintf> is not available, will unfortunately use the unsafe
2494 C<vsprintf> which can overrun the buffer (there is an overrun check,
2495 but that may be too late). Consider using C<sv_vcatpvf> instead, or
2496 getting C<vsnprintf>.
2498 int my_snprintf(char *buffer, const Size_t len, const char *format, ...)
2501 Found in file util.c
2506 The C library C<sprintf>, wrapped if necessary, to ensure that it will return
2507 the length of the string written to the buffer. Only rare pre-ANSI systems
2508 need the wrapper function - usually this is a direct call to C<sprintf>.
2510 int my_sprintf(char *buffer, const char *pat, ...)
2513 Found in file util.c
2518 The C library C<vsnprintf> if available and standards-compliant.
2519 However, if if the C<vsnprintf> is not available, will unfortunately
2520 use the unsafe C<vsprintf> which can overrun the buffer (there is an
2521 overrun check, but that may be too late). Consider using
2522 C<sv_vcatpvf> instead, or getting C<vsnprintf>.
2524 int my_vsnprintf(char *buffer, const Size_t len, const char *format, va_list ap)
2527 Found in file util.c
2532 Returns a new version object based on the passed in SV:
2534 SV *sv = new_version(SV *ver);
2536 Does not alter the passed in ver SV. See "upg_version" if you
2537 want to upgrade the SV.
2539 SV* new_version(SV *ver)
2542 Found in file util.c
2547 Returns a pointer to the next character after the parsed
2548 version string, as well as upgrading the passed in SV to
2551 Function must be called with an already existing SV like
2554 s = scan_version(s, SV *sv, bool qv);
2556 Performs some preprocessing to the string to ensure that
2557 it has the correct characteristics of a version. Flags the
2558 object if it contains an underscore (which denotes this
2559 is an alpha version). The boolean qv denotes that the version
2560 should be interpreted as if it had multiple decimals, even if
2563 const char* scan_version(const char *s, SV *rv, bool qv)
2566 Found in file util.c
2571 Test two strings to see if they are equal. Returns true or false.
2573 bool strEQ(char* s1, char* s2)
2576 Found in file handy.h
2581 Test two strings to see if the first, C<s1>, is greater than or equal to
2582 the second, C<s2>. Returns true or false.
2584 bool strGE(char* s1, char* s2)
2587 Found in file handy.h
2592 Test two strings to see if the first, C<s1>, is greater than the second,
2593 C<s2>. Returns true or false.
2595 bool strGT(char* s1, char* s2)
2598 Found in file handy.h
2603 Test two strings to see if the first, C<s1>, is less than or equal to the
2604 second, C<s2>. Returns true or false.
2606 bool strLE(char* s1, char* s2)
2609 Found in file handy.h
2614 Test two strings to see if the first, C<s1>, is less than the second,
2615 C<s2>. Returns true or false.
2617 bool strLT(char* s1, char* s2)
2620 Found in file handy.h
2625 Test two strings to see if they are different. Returns true or
2628 bool strNE(char* s1, char* s2)
2631 Found in file handy.h
2636 Test two strings to see if they are equal. The C<len> parameter indicates
2637 the number of bytes to compare. Returns true or false. (A wrapper for
2640 bool strnEQ(char* s1, char* s2, STRLEN len)
2643 Found in file handy.h
2648 Test two strings to see if they are different. The C<len> parameter
2649 indicates the number of bytes to compare. Returns true or false. (A
2650 wrapper for C<strncmp>).
2652 bool strnNE(char* s1, char* s2, STRLEN len)
2655 Found in file handy.h
2657 =item sv_destroyable
2660 Dummy routine which reports that object can be destroyed when there is no
2661 sharing module present. It ignores its single SV argument, and returns
2662 'true'. Exists to avoid test for a NULL function pointer and because it
2663 could potentially warn under some level of strict-ness.
2665 bool sv_destroyable(SV *sv)
2668 Found in file util.c
2673 Dummy routine which "shares" an SV when there is no sharing module present.
2674 Or "locks" it. Or "unlocks" it. In other words, ignores its single SV argument.
2675 Exists to avoid test for a NULL function pointer and because it could
2676 potentially warn under some level of strict-ness.
2678 void sv_nosharing(SV *sv)
2681 Found in file util.c
2686 In-place upgrade of the supplied SV to a version object.
2688 SV *sv = upg_version(SV *sv, bool qv);
2690 Returns a pointer to the upgraded SV. Set the boolean qv if you want
2691 to force this SV to be interpreted as an "extended" version.
2693 SV* upg_version(SV *ver, bool qv)
2696 Found in file util.c
2701 Version object aware cmp. Both operands must already have been
2702 converted into version objects.
2704 int vcmp(SV *lhv, SV *rhv)
2707 Found in file util.c
2712 Accepts a version object and returns the normalized string
2713 representation. Call like:
2717 NOTE: you can pass either the object directly or the SV
2718 contained within the RV.
2723 Found in file util.c
2728 Accepts a version object and returns the normalized floating
2729 point representation. Call like:
2733 NOTE: you can pass either the object directly or the SV
2734 contained within the RV.
2739 Found in file util.c
2744 In order to maintain maximum compatibility with earlier versions
2745 of Perl, this function will return either the floating point
2746 notation or the multiple dotted notation, depending on whether
2747 the original version contained 1 or more dots, respectively
2749 SV* vstringify(SV *vs)
2752 Found in file util.c
2757 Validates that the SV contains a valid version object.
2759 bool vverify(SV *vobj);
2761 Note that it only confirms the bare minimum structure (so as not to get
2762 confused by derived classes which may contain additional hash entries):
2764 bool vverify(SV *vs)
2767 Found in file util.c
2772 =head1 MRO Functions
2776 =item mro_get_linear_isa
2777 X<mro_get_linear_isa>
2779 Returns either C<mro_get_linear_isa_c3> or
2780 C<mro_get_linear_isa_dfs> for the given stash,
2781 dependant upon which MRO is in effect
2782 for that stash. The return value is a
2785 You are responsible for C<SvREFCNT_inc()> on the
2786 return value if you plan to store it anywhere
2787 semi-permanently (otherwise it might be deleted
2788 out from under you the next time the cache is
2791 AV* mro_get_linear_isa(HV* stash)
2796 =item mro_method_changed_in
2797 X<mro_method_changed_in>
2799 Invalidates method caching on any child classes
2800 of the given stash, so that they might notice
2801 the changes in this one.
2803 Ideally, all instances of C<PL_sub_generation++> in
2804 perl source outside of C<mro.c> should be
2805 replaced by calls to this.
2807 Perl automatically handles most of the common
2808 ways a method might be redefined. However, there
2809 are a few ways you could change a method in a stash
2810 without the cache code noticing, in which case you
2811 need to call this method afterwards:
2813 1) Directly manipulating the stash HV entries from
2816 2) Assigning a reference to a readonly scalar
2817 constant into a stash entry in order to create
2818 a constant subroutine (like constant.pm
2821 This same method is available from pure perl
2822 via, C<mro::method_changed_in(classname)>.
2824 void mro_method_changed_in(HV* stash)
2832 =head1 Multicall Functions
2839 Declare local variables for a multicall. See L<perlcall/Lightweight Callbacks>.
2849 Make a lightweight callback. See L<perlcall/Lightweight Callbacks>.
2859 Closing bracket for a lightweight callback.
2860 See L<perlcall/Lightweight Callbacks>.
2867 =item PUSH_MULTICALL
2870 Opening bracket for a lightweight callback.
2871 See L<perlcall/Lightweight Callbacks>.
2881 =head1 Numeric functions
2888 converts a string representing a binary number to numeric form.
2890 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2891 conversion flags, and I<result> should be NULL or a pointer to an NV.
2892 The scan stops at the end of the string, or the first invalid character.
2893 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2894 invalid character will also trigger a warning.
2895 On return I<*len> is set to the length of the scanned string,
2896 and I<*flags> gives output flags.
2898 If the value is <= C<UV_MAX> it is returned as a UV, the output flags are clear,
2899 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_bin>
2900 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2901 and writes the value to I<*result> (or the value is discarded if I<result>
2904 The binary number may optionally be prefixed with "0b" or "b" unless
2905 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
2906 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the binary
2907 number may use '_' characters to separate digits.
2909 UV grok_bin(const char* start, STRLEN* len_p, I32* flags, NV *result)
2912 Found in file numeric.c
2917 converts a string representing a hex number to numeric form.
2919 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2920 conversion flags, and I<result> should be NULL or a pointer to an NV.
2921 The scan stops at the end of the string, or the first invalid character.
2922 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2923 invalid character will also trigger a warning.
2924 On return I<*len> is set to the length of the scanned string,
2925 and I<*flags> gives output flags.
2927 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2928 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_hex>
2929 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2930 and writes the value to I<*result> (or the value is discarded if I<result>
2933 The hex number may optionally be prefixed with "0x" or "x" unless
2934 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
2935 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the hex
2936 number may use '_' characters to separate digits.
2938 UV grok_hex(const char* start, STRLEN* len_p, I32* flags, NV *result)
2941 Found in file numeric.c
2946 Recognise (or not) a number. The type of the number is returned
2947 (0 if unrecognised), otherwise it is a bit-ORed combination of
2948 IS_NUMBER_IN_UV, IS_NUMBER_GREATER_THAN_UV_MAX, IS_NUMBER_NOT_INT,
2949 IS_NUMBER_NEG, IS_NUMBER_INFINITY, IS_NUMBER_NAN (defined in perl.h).
2951 If the value of the number can fit an in UV, it is returned in the *valuep
2952 IS_NUMBER_IN_UV will be set to indicate that *valuep is valid, IS_NUMBER_IN_UV
2953 will never be set unless *valuep is valid, but *valuep may have been assigned
2954 to during processing even though IS_NUMBER_IN_UV is not set on return.
2955 If valuep is NULL, IS_NUMBER_IN_UV will be set for the same cases as when
2956 valuep is non-NULL, but no actual assignment (or SEGV) will occur.
2958 IS_NUMBER_NOT_INT will be set with IS_NUMBER_IN_UV if trailing decimals were
2959 seen (in which case *valuep gives the true value truncated to an integer), and
2960 IS_NUMBER_NEG if the number is negative (in which case *valuep holds the
2961 absolute value). IS_NUMBER_IN_UV is not set if e notation was used or the
2962 number is larger than a UV.
2964 int grok_number(const char *pv, STRLEN len, UV *valuep)
2967 Found in file numeric.c
2969 =item grok_numeric_radix
2970 X<grok_numeric_radix>
2972 Scan and skip for a numeric decimal separator (radix).
2974 bool grok_numeric_radix(const char **sp, const char *send)
2977 Found in file numeric.c
2982 converts a string representing an octal number to numeric form.
2984 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2985 conversion flags, and I<result> should be NULL or a pointer to an NV.
2986 The scan stops at the end of the string, or the first invalid character.
2987 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2988 invalid character will also trigger a warning.
2989 On return I<*len> is set to the length of the scanned string,
2990 and I<*flags> gives output flags.
2992 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2993 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_oct>
2994 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2995 and writes the value to I<*result> (or the value is discarded if I<result>
2998 If C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the octal
2999 number may use '_' characters to separate digits.
3001 UV grok_oct(const char* start, STRLEN* len_p, I32* flags, NV *result)
3004 Found in file numeric.c
3009 Return a non-zero integer if the sign bit on an NV is set, and 0 if
3012 If Configure detects this system has a signbit() that will work with
3013 our NVs, then we just use it via the #define in perl.h. Otherwise,
3014 fall back on this implementation. As a first pass, this gets everything
3015 right except -0.0. Alas, catching -0.0 is the main use for this function,
3016 so this is not too helpful yet. Still, at least we have the scaffolding
3017 in place to support other systems, should that prove useful.
3020 Configure notes: This function is called 'Perl_signbit' instead of a
3021 plain 'signbit' because it is easy to imagine a system having a signbit()
3022 function or macro that doesn't happen to work with our particular choice
3023 of NVs. We shouldn't just re-#define signbit as Perl_signbit and expect
3024 the standard system headers to be happy. Also, this is a no-context
3025 function (no pTHX_) because Perl_signbit() is usually re-#defined in
3026 perl.h as a simple macro call to the system's signbit().
3027 Users should just always call Perl_signbit().
3029 NOTE: this function is experimental and may change or be
3030 removed without notice.
3032 int Perl_signbit(NV f)
3035 Found in file numeric.c
3040 For backwards compatibility. Use C<grok_bin> instead.
3042 NV scan_bin(const char* start, STRLEN len, STRLEN* retlen)
3045 Found in file numeric.c
3050 For backwards compatibility. Use C<grok_hex> instead.
3052 NV scan_hex(const char* start, STRLEN len, STRLEN* retlen)
3055 Found in file numeric.c
3060 For backwards compatibility. Use C<grok_oct> instead.
3062 NV scan_oct(const char* start, STRLEN len, STRLEN* retlen)
3065 Found in file numeric.c
3070 =head1 Optree Manipulation Functions
3077 If C<cv> is a constant sub eligible for inlining. returns the constant
3078 value returned by the sub. Otherwise, returns NULL.
3080 Constant subs can be created with C<newCONSTSUB> or as described in
3081 L<perlsub/"Constant Functions">.
3083 SV* cv_const_sv(const CV *const cv)
3091 Creates a constant sub equivalent to Perl C<sub FOO () { 123 }> which is
3092 eligible for inlining at compile-time.
3094 CV* newCONSTSUB(HV* stash, const char* name, SV* sv)
3102 Used by C<xsubpp> to hook up XSUBs as Perl subs. I<filename> needs to be
3103 static storage, as it is used directly as CvFILE(), without a copy being made.
3111 =head1 Pad Data Structures
3118 Get the value at offset po in the current pad.
3119 Use macro PAD_SV instead of calling this function directly.
3121 SV* pad_sv(PADOFFSET po)
3129 =head1 Per-Interpreter Variables
3136 C<PL_modglobal> is a general purpose, interpreter global HV for use by
3137 extensions that need to keep information on a per-interpreter basis.
3138 In a pinch, it can also be used as a symbol table for extensions
3139 to share data among each other. It is a good idea to use keys
3140 prefixed by the package name of the extension that owns the data.
3145 Found in file intrpvar.h
3150 A convenience variable which is typically used with C<SvPV> when one
3151 doesn't care about the length of the string. It is usually more efficient
3152 to either declare a local variable and use that instead or to use the
3153 C<SvPV_nolen> macro.
3158 Found in file intrpvar.h
3163 This is the C<false> SV. See C<PL_sv_yes>. Always refer to this as
3169 Found in file intrpvar.h
3174 This is the C<undef> SV. Always refer to this as C<&PL_sv_undef>.
3179 Found in file intrpvar.h
3184 This is the C<true> SV. See C<PL_sv_no>. Always refer to this as
3190 Found in file intrpvar.h
3195 =head1 REGEXP Functions
3202 Convenience macro to get the REGEXP from a SV. This is approximately
3203 equivalent to the following snippet:
3208 (tmpsv = (SV*)SvRV(sv)) &&
3209 SvTYPE(tmpsv) == SVt_PVMG &&
3210 (tmpmg = mg_find(tmpsv, PERL_MAGIC_qr)))
3212 return (REGEXP *)tmpmg->mg_obj;
3215 NULL will be returned if a REGEXP* is not found.
3217 REGEXP * SvRX(SV *sv)
3220 Found in file regexp.h
3225 Returns a boolean indicating whether the SV contains qr magic
3228 If you want to do something with the REGEXP* later use SvRX instead
3234 Found in file regexp.h
3239 =head1 Simple Exception Handling Macros
3246 Set up necessary local variables for exception handling.
3247 See L<perlguts/"Exception Handling">.
3252 Found in file XSUB.h
3257 Introduces a catch block. See L<perlguts/"Exception Handling">.
3260 Found in file XSUB.h
3265 Rethrows a previously caught exception. See L<perlguts/"Exception Handling">.
3270 Found in file XSUB.h
3275 Ends a try block. See L<perlguts/"Exception Handling">.
3278 Found in file XSUB.h
3280 =item XCPT_TRY_START
3283 Starts a try block. See L<perlguts/"Exception Handling">.
3286 Found in file XSUB.h
3291 =head1 Stack Manipulation Macros
3298 Declare a stack marker variable, C<mark>, for the XSUB. See C<MARK> and
3309 Saves the original stack mark for the XSUB. See C<ORIGMARK>.
3319 Declares a local copy of perl's stack pointer for the XSUB, available via
3320 the C<SP> macro. See C<SP>.
3330 Used to extend the argument stack for an XSUB's return values. Once
3331 used, guarantees that there is room for at least C<nitems> to be pushed
3334 void EXTEND(SP, int nitems)
3342 Stack marker variable for the XSUB. See C<dMARK>.
3350 Push an integer onto the stack. The stack must have room for this element.
3351 Does not use C<TARG>. See also C<PUSHi>, C<mXPUSHi> and C<XPUSHi>.
3361 Push a double onto the stack. The stack must have room for this element.
3362 Does not use C<TARG>. See also C<PUSHn>, C<mXPUSHn> and C<XPUSHn>.
3372 Push a string onto the stack. The stack must have room for this element.
3373 The C<len> indicates the length of the string. Does not use C<TARG>.
3374 See also C<PUSHp>, C<mXPUSHp> and C<XPUSHp>.
3376 void mPUSHp(char* str, STRLEN len)
3384 Push an SV onto the stack and mortalizes the SV. The stack must have room
3385 for this element. Does not use C<TARG>. See also C<PUSHs> and C<mXPUSHs>.
3395 Push an unsigned integer onto the stack. The stack must have room for this
3396 element. Does not use C<TARG>. See also C<PUSHu>, C<mXPUSHu> and C<XPUSHu>.
3406 Push an integer onto the stack, extending the stack if necessary.
3407 Does not use C<TARG>. See also C<XPUSHi>, C<mPUSHi> and C<PUSHi>.
3417 Push a double onto the stack, extending the stack if necessary.
3418 Does not use C<TARG>. See also C<XPUSHn>, C<mPUSHn> and C<PUSHn>.
3428 Push a string onto the stack, extending the stack if necessary. The C<len>
3429 indicates the length of the string. Does not use C<TARG>. See also C<XPUSHp>,
3430 C<mPUSHp> and C<PUSHp>.
3432 void mXPUSHp(char* str, STRLEN len)
3440 Push an SV onto the stack, extending the stack if necessary and mortalizes
3441 the SV. Does not use C<TARG>. See also C<XPUSHs> and C<mPUSHs>.
3443 void mXPUSHs(SV* sv)
3451 Push an unsigned integer onto the stack, extending the stack if necessary.
3452 Does not use C<TARG>. See also C<XPUSHu>, C<mPUSHu> and C<PUSHu>.
3462 The original stack mark for the XSUB. See C<dORIGMARK>.
3470 Pops an integer off the stack.
3480 Pops a long off the stack.
3490 Pops a double off the stack.
3500 Pops a string off the stack. Deprecated. New code should use POPpx.
3510 Pops a string off the stack which must consist of bytes i.e. characters < 256.
3520 Pops a string off the stack.
3530 Pops an SV off the stack.
3540 Push an integer onto the stack. The stack must have room for this element.
3541 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3542 called to declare it. Do not call multiple C<TARG>-oriented macros to
3543 return lists from XSUB's - see C<mPUSHi> instead. See also C<XPUSHi> and
3554 Opening bracket for arguments on a callback. See C<PUTBACK> and
3565 Push a new mortal SV onto the stack. The stack must have room for this
3566 element. Does not use C<TARG>. See also C<PUSHs>, C<XPUSHmortal> and C<XPUSHs>.
3576 Push a double onto the stack. The stack must have room for this element.
3577 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3578 called to declare it. Do not call multiple C<TARG>-oriented macros to
3579 return lists from XSUB's - see C<mPUSHn> instead. See also C<XPUSHn> and
3590 Push a string onto the stack. The stack must have room for this element.
3591 The C<len> indicates the length of the string. Handles 'set' magic. Uses
3592 C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to declare it. Do not
3593 call multiple C<TARG>-oriented macros to return lists from XSUB's - see
3594 C<mPUSHp> instead. See also C<XPUSHp> and C<mXPUSHp>.
3596 void PUSHp(char* str, STRLEN len)
3604 Push an SV onto the stack. The stack must have room for this element.
3605 Does not handle 'set' magic. Does not use C<TARG>. See also C<PUSHmortal>,
3606 C<XPUSHs> and C<XPUSHmortal>.
3616 Push an unsigned integer onto the stack. The stack must have room for this
3617 element. Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG>
3618 should be called to declare it. Do not call multiple C<TARG>-oriented
3619 macros to return lists from XSUB's - see C<mPUSHu> instead. See also
3620 C<XPUSHu> and C<mXPUSHu>.
3630 Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
3631 See C<PUSHMARK> and L<perlcall> for other uses.
3641 Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and
3650 Refetch the stack pointer. Used after a callback. See L<perlcall>.
3660 Push an integer onto the stack, extending the stack if necessary. Handles
3661 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
3662 declare it. Do not call multiple C<TARG>-oriented macros to return lists
3663 from XSUB's - see C<mXPUSHi> instead. See also C<PUSHi> and C<mPUSHi>.
3673 Push a new mortal SV onto the stack, extending the stack if necessary.
3674 Does not use C<TARG>. See also C<XPUSHs>, C<PUSHmortal> and C<PUSHs>.
3684 Push a double onto the stack, extending the stack if necessary. Handles
3685 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
3686 declare it. Do not call multiple C<TARG>-oriented macros to return lists
3687 from XSUB's - see C<mXPUSHn> instead. See also C<PUSHn> and C<mPUSHn>.
3697 Push a string onto the stack, extending the stack if necessary. The C<len>
3698 indicates the length of the string. Handles 'set' magic. Uses C<TARG>, so
3699 C<dTARGET> or C<dXSTARG> should be called to declare it. Do not call
3700 multiple C<TARG>-oriented macros to return lists from XSUB's - see
3701 C<mXPUSHp> instead. See also C<PUSHp> and C<mPUSHp>.
3703 void XPUSHp(char* str, STRLEN len)
3711 Push an SV onto the stack, extending the stack if necessary. Does not
3712 handle 'set' magic. Does not use C<TARG>. See also C<XPUSHmortal>,
3713 C<PUSHs> and C<PUSHmortal>.
3723 Push an unsigned integer onto the stack, extending the stack if necessary.
3724 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3725 called to declare it. Do not call multiple C<TARG>-oriented macros to
3726 return lists from XSUB's - see C<mXPUSHu> instead. See also C<PUSHu> and
3737 Return from XSUB, indicating number of items on the stack. This is usually
3738 handled by C<xsubpp>.
3740 void XSRETURN(int nitems)
3743 Found in file XSUB.h
3745 =item XSRETURN_EMPTY
3748 Return an empty list from an XSUB immediately.
3753 Found in file XSUB.h
3758 Return an integer from an XSUB immediately. Uses C<XST_mIV>.
3760 void XSRETURN_IV(IV iv)
3763 Found in file XSUB.h
3768 Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
3773 Found in file XSUB.h
3778 Return a double from an XSUB immediately. Uses C<XST_mNV>.
3780 void XSRETURN_NV(NV nv)
3783 Found in file XSUB.h
3788 Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
3790 void XSRETURN_PV(char* str)
3793 Found in file XSUB.h
3795 =item XSRETURN_UNDEF
3798 Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
3803 Found in file XSUB.h
3808 Return an integer from an XSUB immediately. Uses C<XST_mUV>.
3810 void XSRETURN_UV(IV uv)
3813 Found in file XSUB.h
3818 Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
3823 Found in file XSUB.h
3828 Place an integer into the specified position C<pos> on the stack. The
3829 value is stored in a new mortal SV.
3831 void XST_mIV(int pos, IV iv)
3834 Found in file XSUB.h
3839 Place C<&PL_sv_no> into the specified position C<pos> on the
3842 void XST_mNO(int pos)
3845 Found in file XSUB.h
3850 Place a double into the specified position C<pos> on the stack. The value
3851 is stored in a new mortal SV.
3853 void XST_mNV(int pos, NV nv)
3856 Found in file XSUB.h
3861 Place a copy of a string into the specified position C<pos> on the stack.
3862 The value is stored in a new mortal SV.
3864 void XST_mPV(int pos, char* str)
3867 Found in file XSUB.h
3872 Place C<&PL_sv_undef> into the specified position C<pos> on the
3875 void XST_mUNDEF(int pos)
3878 Found in file XSUB.h
3883 Place C<&PL_sv_yes> into the specified position C<pos> on the
3886 void XST_mYES(int pos)
3889 Found in file XSUB.h
3901 An enum of flags for Perl types. These are found in the file B<sv.h>
3902 in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
3910 Integer type flag for scalars. See C<svtype>.
3918 Double type flag for scalars. See C<svtype>.
3926 Pointer type flag for scalars. See C<svtype>.
3934 Type flag for arrays. See C<svtype>.
3942 Type flag for code refs. See C<svtype>.
3950 Type flag for hashes. See C<svtype>.
3958 Type flag for blessed scalars. See C<svtype>.
3966 =head1 SV Manipulation Functions
3970 =item croak_xs_usage
3973 A specialised variant of C<croak()> for emitting the usage message for xsubs
3975 croak_xs_usage(cv, "eee_yow");
3977 works out the package name and subroutine name from C<cv>, and then calls
3978 C<croak()>. Hence if C<cv> is C<&ouch::awk>, it would call C<croak> as:
3980 Perl_croak(aTHX_ "Usage %s::%s(%s)", "ouch" "awk", "eee_yow");
3982 void croak_xs_usage(const CV *const cv, const char *const params)
3985 Found in file universal.c
3990 Returns the SV of the specified Perl scalar. C<flags> are passed to
3991 C<gv_fetchpv>. If C<GV_ADD> is set and the
3992 Perl variable does not exist then it will be created. If C<flags> is zero
3993 and the variable does not exist then NULL is returned.
3995 NOTE: the perl_ form of this function is deprecated.
3997 SV* get_sv(const char *name, I32 flags)
4000 Found in file perl.c
4005 Creates an RV wrapper for an SV. The reference count for the original SV is
4008 SV* newRV_inc(SV* sv)
4016 Creates a new SV and copies a string into it. If utf8 is true, calls
4017 C<SvUTF8_on> on the new SV. Implemented as a wrapper around C<newSVpvn_flags>.
4019 SV* newSVpvn_utf8(NULLOK const char* s, STRLEN len, U32 utf8)
4027 Returns the length of the string which is in the SV. See C<SvLEN>.
4029 STRLEN SvCUR(SV* sv)
4037 Set the current length of the string which is in the SV. See C<SvCUR>
4040 void SvCUR_set(SV* sv, STRLEN len)
4048 Returns a pointer to the last character in the string which is in the SV.
4049 See C<SvCUR>. Access the character as *(SvEND(sv)).
4059 Returns true if the SV has get magic or overloading. If either is true then
4060 the scalar is active data, and has the potential to return a new value every
4061 time it is accessed. Hence you must be careful to only read it once per user
4062 logical operation and work with that returned value. If neither is true then
4063 the scalar's value cannot change unless written to.
4065 char* SvGAMAGIC(SV* sv)
4073 Expands the character buffer in the SV so that it has room for the
4074 indicated number of bytes (remember to reserve space for an extra trailing
4075 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
4076 Returns a pointer to the character buffer.
4078 char * SvGROW(SV* sv, STRLEN len)
4086 Returns a U32 value indicating whether the SV contains an integer.
4096 Returns a U32 value indicating whether the SV contains an integer. Checks
4097 the B<private> setting. Use C<SvIOK> instead.
4107 Returns a boolean indicating whether the SV contains a signed integer.
4109 bool SvIOK_notUV(SV* sv)
4117 Unsets the IV status of an SV.
4119 void SvIOK_off(SV* sv)
4127 Tells an SV that it is an integer.
4129 void SvIOK_on(SV* sv)
4137 Tells an SV that it is an integer and disables all other OK bits.
4139 void SvIOK_only(SV* sv)
4147 Tells and SV that it is an unsigned integer and disables all other OK bits.
4149 void SvIOK_only_UV(SV* sv)
4157 Returns a boolean indicating whether the SV contains an unsigned integer.
4159 bool SvIOK_UV(SV* sv)
4167 Returns a boolean indicating whether the SV is Copy-On-Write. (either shared
4168 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
4171 bool SvIsCOW(SV* sv)
4176 =item SvIsCOW_shared_hash
4177 X<SvIsCOW_shared_hash>
4179 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
4182 bool SvIsCOW_shared_hash(SV* sv)
4190 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
4191 version which guarantees to evaluate sv only once.
4201 Returns the raw value in the SV's IV slot, without checks or conversions.
4202 Only use when you are sure SvIOK is true. See also C<SvIV()>.
4212 Coerces the given SV to an integer and returns it. Guarantees to evaluate
4213 C<sv> only once. Only use this if C<sv> is an expression with side effects,
4214 otherwise use the more efficient C<SvIV>.
4224 Like C<SvIV> but doesn't process magic.
4226 IV SvIV_nomg(SV* sv)
4234 Set the value of the IV pointer in sv to val. It is possible to perform
4235 the same function of this macro with an lvalue assignment to C<SvIVX>.
4236 With future Perls, however, it will be more efficient to use
4237 C<SvIV_set> instead of the lvalue assignment to C<SvIVX>.
4239 void SvIV_set(SV* sv, IV val)
4247 Returns the size of the string buffer in the SV, not including any part
4248 attributable to C<SvOOK>. See C<SvCUR>.
4250 STRLEN SvLEN(SV* sv)
4258 Set the actual length of the string which is in the SV. See C<SvIV_set>.
4260 void SvLEN_set(SV* sv, STRLEN len)
4268 Set the value of the MAGIC pointer in sv to val. See C<SvIV_set>.
4270 void SvMAGIC_set(SV* sv, MAGIC* val)
4278 Returns a U32 value indicating whether the SV contains a number, integer or
4289 Returns a U32 value indicating whether the SV contains a number, integer or
4290 double. Checks the B<private> setting. Use C<SvNIOK> instead.
4300 Unsets the NV/IV status of an SV.
4302 void SvNIOK_off(SV* sv)
4310 Returns a U32 value indicating whether the SV contains a double.
4320 Returns a U32 value indicating whether the SV contains a double. Checks the
4321 B<private> setting. Use C<SvNOK> instead.
4331 Unsets the NV status of an SV.
4333 void SvNOK_off(SV* sv)
4341 Tells an SV that it is a double.
4343 void SvNOK_on(SV* sv)
4351 Tells an SV that it is a double and disables all other OK bits.
4353 void SvNOK_only(SV* sv)
4361 Coerce the given SV to a double and return it. See C<SvNVx> for a version
4362 which guarantees to evaluate sv only once.
4372 Returns the raw value in the SV's NV slot, without checks or conversions.
4373 Only use when you are sure SvNOK is true. See also C<SvNV()>.
4383 Coerces the given SV to a double and returns it. Guarantees to evaluate
4384 C<sv> only once. Only use this if C<sv> is an expression with side effects,
4385 otherwise use the more efficient C<SvNV>.
4395 Set the value of the NV pointer in sv to val. See C<SvIV_set>.
4397 void SvNV_set(SV* sv, NV val)
4405 Returns a U32 value indicating whether the value is an SV. It also tells
4406 whether the value is defined or not.
4416 Returns a U32 indicating whether the pointer to the string buffer is offset.
4417 This hack is used internally to speed up removal of characters from the
4418 beginning of a SvPV. When SvOOK is true, then the start of the
4419 allocated string buffer is actually C<SvOOK_offset()> bytes before SvPVX.
4420 This offset used to be stored in SvIVX, but is now stored within the spare
4431 Reads into I<len> the offset from SvPVX back to the true start of the
4432 allocated buffer, which will be non-zero if C<sv_chop> has been used to
4433 efficiently remove characters from start of the buffer. Implemented as a
4434 macro, which takes the address of I<len>, which must be of type C<STRLEN>.
4435 Evaluates I<sv> more than once. Sets I<len> to 0 if C<SvOOK(sv)> is false.
4437 void SvOOK_offset(NN SV*sv, STRLEN len)
4445 Returns a U32 value indicating whether the SV contains a character
4456 Returns a U32 value indicating whether the SV contains a character string.
4457 Checks the B<private> setting. Use C<SvPOK> instead.
4467 Unsets the PV status of an SV.
4469 void SvPOK_off(SV* sv)
4477 Tells an SV that it is a string.
4479 void SvPOK_on(SV* sv)
4487 Tells an SV that it is a string and disables all other OK bits.
4488 Will also turn off the UTF-8 status.
4490 void SvPOK_only(SV* sv)
4495 =item SvPOK_only_UTF8
4498 Tells an SV that it is a string and disables all other OK bits,
4499 and leaves the UTF-8 status as it was.
4501 void SvPOK_only_UTF8(SV* sv)
4509 Returns a pointer to the string in the SV, or a stringified form of
4510 the SV if the SV does not contain a string. The SV may cache the
4511 stringified version becoming C<SvPOK>. Handles 'get' magic. See also
4512 C<SvPVx> for a version which guarantees to evaluate sv only once.
4514 char* SvPV(SV* sv, STRLEN len)
4522 Like C<SvPV>, but converts sv to byte representation first if necessary.
4524 char* SvPVbyte(SV* sv, STRLEN len)
4532 Like C<SvPV>, but converts sv to byte representation first if necessary.
4533 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
4536 char* SvPVbytex(SV* sv, STRLEN len)
4541 =item SvPVbytex_force
4544 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
4545 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
4548 char* SvPVbytex_force(SV* sv, STRLEN len)
4553 =item SvPVbyte_force
4556 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
4558 char* SvPVbyte_force(SV* sv, STRLEN len)
4563 =item SvPVbyte_nolen
4566 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
4568 char* SvPVbyte_nolen(SV* sv)
4576 Like C<SvPV>, but converts sv to utf8 first if necessary.
4578 char* SvPVutf8(SV* sv, STRLEN len)
4586 Like C<SvPV>, but converts sv to utf8 first if necessary.
4587 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
4590 char* SvPVutf8x(SV* sv, STRLEN len)
4595 =item SvPVutf8x_force
4598 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
4599 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
4602 char* SvPVutf8x_force(SV* sv, STRLEN len)
4607 =item SvPVutf8_force
4610 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
4612 char* SvPVutf8_force(SV* sv, STRLEN len)
4617 =item SvPVutf8_nolen
4620 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
4622 char* SvPVutf8_nolen(SV* sv)
4630 Returns a pointer to the physical string in the SV. The SV must contain a
4641 A version of C<SvPV> which guarantees to evaluate C<sv> only once.
4642 Only use this if C<sv> is an expression with side effects, otherwise use the
4643 more efficient C<SvPVX>.
4645 char* SvPVx(SV* sv, STRLEN len)
4653 Like C<SvPV> but will force the SV into containing just a string
4654 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
4657 char* SvPV_force(SV* sv, STRLEN len)
4662 =item SvPV_force_nomg
4665 Like C<SvPV> but will force the SV into containing just a string
4666 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
4667 directly. Doesn't process magic.
4669 char* SvPV_force_nomg(SV* sv, STRLEN len)
4677 Returns a pointer to the string in the SV, or a stringified form of
4678 the SV if the SV does not contain a string. The SV may cache the
4679 stringified form becoming C<SvPOK>. Handles 'get' magic.
4681 char* SvPV_nolen(SV* sv)
4689 Like C<SvPV> but doesn't process magic.
4691 char* SvPV_nomg(SV* sv, STRLEN len)
4699 Set the value of the PV pointer in sv to val. See C<SvIV_set>.
4701 void SvPV_set(SV* sv, char* val)
4709 Returns the value of the object's reference count.
4711 U32 SvREFCNT(SV* sv)
4719 Decrements the reference count of the given SV.
4721 void SvREFCNT_dec(SV* sv)
4729 Increments the reference count of the given SV.
4731 All of the following SvREFCNT_inc* macros are optimized versions of
4732 SvREFCNT_inc, and can be replaced with SvREFCNT_inc.
4734 SV* SvREFCNT_inc(SV* sv)
4739 =item SvREFCNT_inc_NN
4742 Same as SvREFCNT_inc, but can only be used if you know I<sv>
4743 is not NULL. Since we don't have to check the NULLness, it's faster
4746 SV* SvREFCNT_inc_NN(SV* sv)
4751 =item SvREFCNT_inc_simple
4752 X<SvREFCNT_inc_simple>
4754 Same as SvREFCNT_inc, but can only be used with expressions without side
4755 effects. Since we don't have to store a temporary value, it's faster.
4757 SV* SvREFCNT_inc_simple(SV* sv)
4762 =item SvREFCNT_inc_simple_NN
4763 X<SvREFCNT_inc_simple_NN>
4765 Same as SvREFCNT_inc_simple, but can only be used if you know I<sv>
4766 is not NULL. Since we don't have to check the NULLness, it's faster
4769 SV* SvREFCNT_inc_simple_NN(SV* sv)
4774 =item SvREFCNT_inc_simple_void
4775 X<SvREFCNT_inc_simple_void>
4777 Same as SvREFCNT_inc_simple, but can only be used if you don't need the
4778 return value. The macro doesn't need to return a meaningful value.
4780 void SvREFCNT_inc_simple_void(SV* sv)
4785 =item SvREFCNT_inc_simple_void_NN
4786 X<SvREFCNT_inc_simple_void_NN>
4788 Same as SvREFCNT_inc, but can only be used if you don't need the return
4789 value, and you know that I<sv> is not NULL. The macro doesn't need
4790 to return a meaningful value, or check for NULLness, so it's smaller
4793 void SvREFCNT_inc_simple_void_NN(SV* sv)
4798 =item SvREFCNT_inc_void
4799 X<SvREFCNT_inc_void>
4801 Same as SvREFCNT_inc, but can only be used if you don't need the
4802 return value. The macro doesn't need to return a meaningful value.
4804 void SvREFCNT_inc_void(SV* sv)
4809 =item SvREFCNT_inc_void_NN
4810 X<SvREFCNT_inc_void_NN>
4812 Same as SvREFCNT_inc, but can only be used if you don't need the return
4813 value, and you know that I<sv> is not NULL. The macro doesn't need
4814 to return a meaningful value, or check for NULLness, so it's smaller
4817 void SvREFCNT_inc_void_NN(SV* sv)
4825 Tests if the SV is an RV.
4835 Unsets the RV status of an SV.
4837 void SvROK_off(SV* sv)
4845 Tells an SV that it is an RV.
4847 void SvROK_on(SV* sv)
4855 Dereferences an RV to return the SV.
4865 Set the value of the RV pointer in sv to val. See C<SvIV_set>.
4867 void SvRV_set(SV* sv, SV* val)
4875 Returns the stash of the SV.
4885 Set the value of the STASH pointer in sv to val. See C<SvIV_set>.
4887 void SvSTASH_set(SV* sv, HV* val)
4895 Taints an SV if tainting is enabled.
4897 void SvTAINT(SV* sv)
4905 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
4908 bool SvTAINTED(SV* sv)
4916 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
4917 some of Perl's fundamental security features. XS module authors should not
4918 use this function unless they fully understand all the implications of
4919 unconditionally untainting the value. Untainting should be done in the
4920 standard perl fashion, via a carefully crafted regexp, rather than directly
4921 untainting variables.
4923 void SvTAINTED_off(SV* sv)
4931 Marks an SV as tainted if tainting is enabled.
4933 void SvTAINTED_on(SV* sv)
4941 Returns a boolean indicating whether Perl would evaluate the SV as true or
4942 false, defined or undefined. Does not handle 'get' magic.
4952 Returns the type of the SV. See C<svtype>.
4954 svtype SvTYPE(SV* sv)
4962 Returns a boolean indicating whether the SV contains an unsigned integer.
4972 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
4973 perform the upgrade if necessary. See C<svtype>.
4975 void SvUPGRADE(SV* sv, svtype type)
4983 Returns a U32 value indicating whether the SV contains UTF-8 encoded data.
4984 Call this after SvPV() in case any call to string overloading updates the
4995 Unsets the UTF-8 status of an SV.
4997 void SvUTF8_off(SV *sv)
5005 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
5006 Do not use frivolously.
5008 void SvUTF8_on(SV *sv)
5016 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
5017 for a version which guarantees to evaluate sv only once.
5027 Returns the raw value in the SV's UV slot, without checks or conversions.
5028 Only use when you are sure SvIOK is true. See also C<SvUV()>.
5038 Coerces the given SV to an unsigned integer and returns it. Guarantees to
5039 C<sv> only once. Only use this if C<sv> is an expression with side effects,
5040 otherwise use the more efficient C<SvUV>.
5050 Like C<SvUV> but doesn't process magic.
5052 UV SvUV_nomg(SV* sv)
5060 Set the value of the UV pointer in sv to val. See C<SvIV_set>.
5062 void SvUV_set(SV* sv, UV val)
5070 Returns a boolean indicating whether the SV contains a v-string.
5077 =item sv_catpvn_nomg
5080 Like C<sv_catpvn> but doesn't process magic.
5082 void sv_catpvn_nomg(SV* sv, const char* ptr, STRLEN len)
5090 Like C<sv_catsv> but doesn't process magic.
5092 void sv_catsv_nomg(SV* dsv, SV* ssv)
5097 =item sv_derived_from
5100 Returns a boolean indicating whether the SV is derived from the specified class
5101 I<at the C level>. To check derivation at the Perl level, call C<isa()> as a
5104 bool sv_derived_from(SV* sv, const char *const name)
5107 Found in file universal.c
5112 Returns a boolean indicating whether the SV performs a specific, named role.
5113 The SV can be a Perl object or the name of a Perl class.
5115 bool sv_does(SV* sv, const char *const name)
5118 Found in file universal.c
5120 =item sv_report_used
5123 Dump the contents of all SVs not yet freed. (Debugging aid).
5125 void sv_report_used()
5133 Like C<sv_setsv> but doesn't process magic.
5135 void sv_setsv_nomg(SV* dsv, SV* ssv)
5140 =item sv_utf8_upgrade_nomg
5141 X<sv_utf8_upgrade_nomg>
5143 Like sv_utf8_upgrade, but doesn't do magic on C<sv>
5145 STRLEN sv_utf8_upgrade_nomg(NN SV *sv)
5153 =head1 SV-Body Allocation
5157 =item looks_like_number
5158 X<looks_like_number>
5160 Test if the content of an SV looks like a number (or is a number).
5161 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
5162 non-numeric warning), even if your atof() doesn't grok them.
5164 I32 looks_like_number(SV *const sv)
5172 Creates an RV wrapper for an SV. The reference count for the original
5173 SV is B<not> incremented.
5175 SV* newRV_noinc(SV *const sv)
5183 Creates a new SV. A non-zero C<len> parameter indicates the number of
5184 bytes of preallocated string space the SV should have. An extra byte for a
5185 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
5186 space is allocated.) The reference count for the new SV is set to 1.
5188 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
5189 parameter, I<x>, a debug aid which allowed callers to identify themselves.
5190 This aid has been superseded by a new build option, PERL_MEM_LOG (see
5191 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
5192 modules supporting older perls.
5194 SV* newSV(const STRLEN len)
5202 Creates a new SV from the hash key structure. It will generate scalars that
5203 point to the shared string table where possible. Returns a new (undefined)
5204 SV if the hek is NULL.
5206 SV* newSVhek(const HEK *const hek)
5214 Creates a new SV and copies an integer into it. The reference count for the
5217 SV* newSViv(const IV i)
5225 Creates a new SV and copies a floating point value into it.
5226 The reference count for the SV is set to 1.
5228 SV* newSVnv(const NV n)
5236 Creates a new SV and copies a string into it. The reference count for the
5237 SV is set to 1. If C<len> is zero, Perl will compute the length using
5238 strlen(). For efficiency, consider using C<newSVpvn> instead.
5240 SV* newSVpv(const char *const s, const STRLEN len)
5248 Creates a new SV and initializes it with the string formatted like
5251 SV* newSVpvf(const char *const pat, ...)
5259 Creates a new SV and copies a string into it. The reference count for the
5260 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
5261 string. You are responsible for ensuring that the source string is at least
5262 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
5264 SV* newSVpvn(const char *const s, const STRLEN len)
5269 =item newSVpvn_flags
5272 Creates a new SV and copies a string into it. The reference count for the
5273 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
5274 string. You are responsible for ensuring that the source string is at least
5275 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
5276 Currently the only flag bits accepted are C<SVf_UTF8> and C<SVs_TEMP>.
5277 If C<SVs_TEMP> is set, then C<sv2mortal()> is called on the result before
5278 returning. If C<SVf_UTF8> is set, then it will be set on the new SV.
5279 C<newSVpvn_utf8()> is a convenience wrapper for this function, defined as
5281 #define newSVpvn_utf8(s, len, u) \
5282 newSVpvn_flags((s), (len), (u) ? SVf_UTF8 : 0)
5284 SV* newSVpvn_flags(const char *const s, const STRLEN len, const U32 flags)
5289 =item newSVpvn_share
5292 Creates a new SV with its SvPVX_const pointing to a shared string in the string
5293 table. If the string does not already exist in the table, it is created
5294 first. Turns on READONLY and FAKE. If the C<hash> parameter is non-zero, that
5295 value is used; otherwise the hash is computed. The string's hash can be later
5296 be retrieved from the SV with the C<SvSHARED_HASH()> macro. The idea here is
5297 that as the string table is used for shared hash keys these strings will have
5298 SvPVX_const == HeKEY and hash lookup will avoid string compare.
5300 SV* newSVpvn_share(const char* s, I32 len, U32 hash)
5308 Like C<newSVpvn>, but takes a literal string instead of a string/length pair.
5310 SV* newSVpvs(const char* s)
5313 Found in file handy.h
5315 =item newSVpvs_flags
5318 Like C<newSVpvn_flags>, but takes a literal string instead of a string/length
5321 SV* newSVpvs_flags(const char* s, U32 flags)
5324 Found in file handy.h
5326 =item newSVpvs_share
5329 Like C<newSVpvn_share>, but takes a literal string instead of a string/length
5330 pair and omits the hash parameter.
5332 SV* newSVpvs_share(const char* s)
5335 Found in file handy.h
5340 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
5341 it will be upgraded to one. If C<classname> is non-null then the new SV will
5342 be blessed in the specified package. The new SV is returned and its
5343 reference count is 1.
5345 SV* newSVrv(SV *const rv, const char *const classname)
5353 Creates a new SV which is an exact duplicate of the original SV.
5356 SV* newSVsv(SV *const old)
5364 Creates a new SV and copies an unsigned integer into it.
5365 The reference count for the SV is set to 1.
5367 SV* newSVuv(const UV u)
5375 Creates a new SV, of the type specified. The reference count for the new SV
5378 SV* newSV_type(const svtype type)
5386 This function is only called on magical items, and is only used by
5387 sv_true() or its macro equivalent.
5389 bool sv_2bool(SV *const sv)
5397 Using various gambits, try to get a CV from an SV; in addition, try if
5398 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
5399 The flags in C<lref> are passed to sv_fetchsv.
5401 CV* sv_2cv(SV* sv, HV **const st, GV **const gvp, const I32 lref)
5409 Using various gambits, try to get an IO from an SV: the IO slot if its a
5410 GV; or the recursive result if we're an RV; or the IO slot of the symbol
5411 named after the PV if we're a string.
5413 IO* sv_2io(SV *const sv)
5421 Return the integer value of an SV, doing any necessary string
5422 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
5423 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
5425 IV sv_2iv_flags(SV *const sv, const I32 flags)
5433 Marks an existing SV as mortal. The SV will be destroyed "soon", either
5434 by an explicit call to FREETMPS, or by an implicit call at places such as
5435 statement boundaries. SvTEMP() is turned on which means that the SV's
5436 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
5437 and C<sv_mortalcopy>.
5439 SV* sv_2mortal(SV *const sv)
5447 Return the num value of an SV, doing any necessary string or integer
5448 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
5451 NV sv_2nv(SV *const sv)
5459 Return a pointer to the byte-encoded representation of the SV, and set *lp
5460 to its length. May cause the SV to be downgraded from UTF-8 as a
5463 Usually accessed via the C<SvPVbyte> macro.
5465 char* sv_2pvbyte(SV *const sv, STRLEN *const lp)
5473 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
5474 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
5476 Usually accessed via the C<SvPVutf8> macro.
5478 char* sv_2pvutf8(SV *const sv, STRLEN *const lp)
5486 Returns a pointer to the string value of an SV, and sets *lp to its length.
5487 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
5489 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
5490 usually end up here too.
5492 char* sv_2pv_flags(SV *const sv, STRLEN *const lp, const I32 flags)
5500 Return the unsigned integer value of an SV, doing any necessary string
5501 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
5502 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
5504 UV sv_2uv_flags(SV *const sv, const I32 flags)
5512 Remove any string offset. You should normally use the C<SvOOK_off> macro
5515 int sv_backoff(SV *const sv)
5523 Blesses an SV into a specified package. The SV must be an RV. The package
5524 must be designated by its stash (see C<gv_stashpv()>). The reference count
5525 of the SV is unaffected.
5527 SV* sv_bless(SV *const sv, HV *const stash)
5535 Concatenates the string onto the end of the string which is in the SV.
5536 If the SV has the UTF-8 status set, then the bytes appended should be
5537 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
5539 void sv_catpv(SV *const sv, const char* ptr)
5547 Processes its arguments like C<sprintf> and appends the formatted
5548 output to an SV. If the appended data contains "wide" characters
5549 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
5550 and characters >255 formatted with %c), the original SV might get
5551 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
5552 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
5553 valid UTF-8; if the original SV was bytes, the pattern should be too.
5555 void sv_catpvf(SV *const sv, const char *const pat, ...)
5563 Like C<sv_catpvf>, but also handles 'set' magic.
5565 void sv_catpvf_mg(SV *const sv, const char *const pat, ...)
5573 Concatenates the string onto the end of the string which is in the SV. The
5574 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5575 status set, then the bytes appended should be valid UTF-8.
5576 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
5578 void sv_catpvn(SV *dsv, const char *sstr, STRLEN len)
5583 =item sv_catpvn_flags
5586 Concatenates the string onto the end of the string which is in the SV. The
5587 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5588 status set, then the bytes appended should be valid UTF-8.
5589 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
5590 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
5591 in terms of this function.
5593 void sv_catpvn_flags(SV *const dstr, const char *sstr, const STRLEN len, const I32 flags)
5601 Like C<sv_catpvn>, but takes a literal string instead of a string/length pair.
5603 void sv_catpvs(SV* sv, const char* s)
5606 Found in file handy.h
5611 Like C<sv_catpv>, but also handles 'set' magic.
5613 void sv_catpv_mg(SV *const sv, const char *const ptr)
5621 Concatenates the string from SV C<ssv> onto the end of the string in
5622 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
5623 not 'set' magic. See C<sv_catsv_mg>.
5625 void sv_catsv(SV *dstr, SV *sstr)
5630 =item sv_catsv_flags
5633 Concatenates the string from SV C<ssv> onto the end of the string in
5634 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
5635 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
5636 and C<sv_catsv_nomg> are implemented in terms of this function.
5638 void sv_catsv_flags(SV *const dsv, SV *const ssv, const I32 flags)
5646 Efficient removal of characters from the beginning of the string buffer.
5647 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
5648 the string buffer. The C<ptr> becomes the first character of the adjusted
5649 string. Uses the "OOK hack".
5650 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
5651 refer to the same chunk of data.
5653 void sv_chop(SV *const sv, const char *const ptr)
5661 Clear an SV: call any destructors, free up any memory used by the body,
5662 and free the body itself. The SV's head is I<not> freed, although
5663 its type is set to all 1's so that it won't inadvertently be assumed
5664 to be live during global destruction etc.
5665 This function should only be called when REFCNT is zero. Most of the time
5666 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5669 void sv_clear(SV *const sv)
5677 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5678 string in C<sv1> is less than, equal to, or greater than the string in
5679 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5680 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
5682 I32 sv_cmp(SV *const sv1, SV *const sv2)
5690 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
5691 'use bytes' aware, handles get magic, and will coerce its args to strings
5692 if necessary. See also C<sv_cmp>.
5694 I32 sv_cmp_locale(SV *const sv1, SV *const sv2)
5702 Add Collate Transform magic to an SV if it doesn't already have it.
5704 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
5705 scalar data of the variable, but transformed to such a format that a normal
5706 memory comparison can be used to compare the data according to the locale
5709 char* sv_collxfrm(SV *const sv, STRLEN *const nxp)
5717 Copies a stringified representation of the source SV into the
5718 destination SV. Automatically performs any necessary mg_get and
5719 coercion of numeric values into strings. Guaranteed to preserve
5720 UTF8 flag even from overloaded objects. Similar in nature to
5721 sv_2pv[_flags] but operates directly on an SV instead of just the
5722 string. Mostly uses sv_2pv_flags to do its work, except when that
5723 would lose the UTF-8'ness of the PV.
5725 void sv_copypv(SV *const dsv, SV *const ssv)
5733 Auto-decrement of the value in the SV, doing string to numeric conversion
5734 if necessary. Handles 'get' magic.
5736 void sv_dec(SV *const sv)
5744 Returns a boolean indicating whether the strings in the two SVs are
5745 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5746 coerce its args to strings if necessary.
5748 I32 sv_eq(SV* sv1, SV* sv2)
5753 =item sv_force_normal_flags
5754 X<sv_force_normal_flags>
5756 Undo various types of fakery on an SV: if the PV is a shared string, make
5757 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
5758 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
5759 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
5760 then a copy-on-write scalar drops its PV buffer (if any) and becomes
5761 SvPOK_off rather than making a copy. (Used where this scalar is about to be
5762 set to some other value.) In addition, the C<flags> parameter gets passed to
5763 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
5764 with flags set to 0.
5766 void sv_force_normal_flags(SV *const sv, const U32 flags)
5774 Decrement an SV's reference count, and if it drops to zero, call
5775 C<sv_clear> to invoke destructors and free up any memory used by
5776 the body; finally, deallocate the SV's head itself.
5777 Normally called via a wrapper macro C<SvREFCNT_dec>.
5779 void sv_free(SV *const sv)
5787 Get a line from the filehandle and store it into the SV, optionally
5788 appending to the currently-stored string.
5790 char* sv_gets(SV *const sv, PerlIO *const fp, I32 append)
5798 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
5799 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
5800 Use the C<SvGROW> wrapper instead.
5802 char* sv_grow(SV *const sv, STRLEN newlen)
5810 Auto-increment of the value in the SV, doing string to numeric conversion
5811 if necessary. Handles 'get' magic.
5813 void sv_inc(SV *const sv)
5821 Inserts a string at the specified offset/length within the SV. Similar to
5822 the Perl substr() function. Handles get magic.
5824 void sv_insert(SV *const bigstr, const STRLEN offset, const STRLEN len, const char *const little, const STRLEN littlelen)
5829 =item sv_insert_flags
5832 Same as C<sv_insert>, but the extra C<flags> are passed the C<SvPV_force_flags> that applies to C<bigstr>.
5834 void sv_insert_flags(SV *const bigstr, const STRLEN offset, const STRLEN len, const char *const little, const STRLEN littlelen, const U32 flags)
5842 Returns a boolean indicating whether the SV is blessed into the specified
5843 class. This does not check for subtypes; use C<sv_derived_from> to verify
5844 an inheritance relationship.
5846 int sv_isa(SV* sv, const char *const name)
5854 Returns a boolean indicating whether the SV is an RV pointing to a blessed
5855 object. If the SV is not an RV, or if the object is not blessed, then this
5858 int sv_isobject(SV* sv)
5866 Returns the length of the string in the SV. Handles magic and type
5867 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5869 STRLEN sv_len(SV *const sv)
5877 Returns the number of characters in the string in an SV, counting wide
5878 UTF-8 bytes as a single character. Handles magic and type coercion.
5880 STRLEN sv_len_utf8(SV *const sv)
5888 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
5889 then adds a new magic item of type C<how> to the head of the magic list.
5891 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
5892 handling of the C<name> and C<namlen> arguments.
5894 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
5895 to add more than one instance of the same 'how'.
5897 void sv_magic(SV *const sv, SV *const obj, const int how, const char *const name, const I32 namlen)
5905 Adds magic to an SV, upgrading it if necessary. Applies the
5906 supplied vtable and returns a pointer to the magic added.
5908 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
5909 In particular, you can add magic to SvREADONLY SVs, and add more than
5910 one instance of the same 'how'.
5912 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
5913 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
5914 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
5915 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
5917 (This is now used as a subroutine by C<sv_magic>.)
5919 MAGIC * sv_magicext(SV *const sv, SV *const obj, const int how, const MGVTBL *const vtbl, const char *const name, const I32 namlen)
5927 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
5928 The new SV is marked as mortal. It will be destroyed "soon", either by an
5929 explicit call to FREETMPS, or by an implicit call at places such as
5930 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
5932 SV* sv_mortalcopy(SV *const oldsv)
5940 Creates a new null SV which is mortal. The reference count of the SV is
5941 set to 1. It will be destroyed "soon", either by an explicit call to
5942 FREETMPS, or by an implicit call at places such as statement boundaries.
5943 See also C<sv_mortalcopy> and C<sv_2mortal>.
5953 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5956 SV* sv_newref(SV *const sv)
5964 Converts the value pointed to by offsetp from a count of bytes from the
5965 start of the string, to a count of the equivalent number of UTF-8 chars.
5966 Handles magic and type coercion.
5968 void sv_pos_b2u(SV *const sv, I32 *const offsetp)
5976 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5977 the start of the string, to a count of the equivalent number of bytes; if
5978 lenp is non-zero, it does the same to lenp, but this time starting from
5979 the offset, rather than from the start of the string. Handles magic and
5982 void sv_pos_u2b(SV *const sv, I32 *const offsetp, I32 *const lenp)
5987 =item sv_pvbyten_force
5990 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
5992 char* sv_pvbyten_force(SV *const sv, STRLEN *const lp)
6000 Get a sensible string out of the SV somehow.
6001 A private implementation of the C<SvPV_force> macro for compilers which
6002 can't cope with complex macro expressions. Always use the macro instead.
6004 char* sv_pvn_force(SV* sv, STRLEN* lp)
6009 =item sv_pvn_force_flags
6010 X<sv_pvn_force_flags>
6012 Get a sensible string out of the SV somehow.
6013 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
6014 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
6015 implemented in terms of this function.
6016 You normally want to use the various wrapper macros instead: see
6017 C<SvPV_force> and C<SvPV_force_nomg>
6019 char* sv_pvn_force_flags(SV *const sv, STRLEN *const lp, const I32 flags)
6024 =item sv_pvutf8n_force
6027 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
6029 char* sv_pvutf8n_force(SV *const sv, STRLEN *const lp)
6037 Returns a string describing what the SV is a reference to.
6039 const char* sv_reftype(const SV *const sv, const int ob)
6047 Make the first argument a copy of the second, then delete the original.
6048 The target SV physically takes over ownership of the body of the source SV
6049 and inherits its flags; however, the target keeps any magic it owns,
6050 and any magic in the source is discarded.
6051 Note that this is a rather specialist SV copying operation; most of the
6052 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
6054 void sv_replace(SV *const sv, SV *const nsv)
6062 Underlying implementation for the C<reset> Perl function.
6063 Note that the perl-level function is vaguely deprecated.
6065 void sv_reset(const char* s, HV *const stash)
6073 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
6074 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
6075 push a back-reference to this RV onto the array of backreferences
6076 associated with that magic. If the RV is magical, set magic will be
6077 called after the RV is cleared.
6079 SV* sv_rvweaken(SV *const sv)
6087 Copies an integer into the given SV, upgrading first if necessary.
6088 Does not handle 'set' magic. See also C<sv_setiv_mg>.
6090 void sv_setiv(SV *const sv, const IV num)
6098 Like C<sv_setiv>, but also handles 'set' magic.
6100 void sv_setiv_mg(SV *const sv, const IV i)
6108 Copies a double into the given SV, upgrading first if necessary.
6109 Does not handle 'set' magic. See also C<sv_setnv_mg>.
6111 void sv_setnv(SV *const sv, const NV num)
6119 Like C<sv_setnv>, but also handles 'set' magic.
6121 void sv_setnv_mg(SV *const sv, const NV num)
6129 Copies a string into an SV. The string must be null-terminated. Does not
6130 handle 'set' magic. See C<sv_setpv_mg>.
6132 void sv_setpv(SV *const sv, const char *const ptr)
6140 Works like C<sv_catpvf> but copies the text into the SV instead of
6141 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
6143 void sv_setpvf(SV *const sv, const char *const pat, ...)
6151 Like C<sv_setpvf>, but also handles 'set' magic.
6153 void sv_setpvf_mg(SV *const sv, const char *const pat, ...)
6161 Copies an integer into the given SV, also updating its string value.
6162 Does not handle 'set' magic. See C<sv_setpviv_mg>.
6164 void sv_setpviv(SV *const sv, const IV num)
6172 Like C<sv_setpviv>, but also handles 'set' magic.
6174 void sv_setpviv_mg(SV *const sv, const IV iv)
6182 Copies a string into an SV. The C<len> parameter indicates the number of
6183 bytes to be copied. If the C<ptr> argument is NULL the SV will become
6184 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
6186 void sv_setpvn(SV *const sv, const char *const ptr, const STRLEN len)
6194 Like C<sv_setpvn>, but also handles 'set' magic.
6196 void sv_setpvn_mg(SV *const sv, const char *const ptr, const STRLEN len)
6204 Like C<sv_setpvn>, but takes a literal string instead of a string/length pair.
6206 void sv_setpvs(SV* sv, const char* s)
6209 Found in file handy.h
6214 Like C<sv_setpv>, but also handles 'set' magic.
6216 void sv_setpv_mg(SV *const sv, const char *const ptr)
6224 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
6225 argument will be upgraded to an RV. That RV will be modified to point to
6226 the new SV. The C<classname> argument indicates the package for the
6227 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
6228 will have a reference count of 1, and the RV will be returned.
6230 SV* sv_setref_iv(SV *const rv, const char *const classname, const IV iv)
6238 Copies a double into a new SV, optionally blessing the SV. The C<rv>
6239 argument will be upgraded to an RV. That RV will be modified to point to
6240 the new SV. The C<classname> argument indicates the package for the
6241 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
6242 will have a reference count of 1, and the RV will be returned.
6244 SV* sv_setref_nv(SV *const rv, const char *const classname, const NV nv)
6252 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
6253 argument will be upgraded to an RV. That RV will be modified to point to
6254 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
6255 into the SV. The C<classname> argument indicates the package for the
6256 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
6257 will have a reference count of 1, and the RV will be returned.
6259 Do not use with other Perl types such as HV, AV, SV, CV, because those
6260 objects will become corrupted by the pointer copy process.
6262 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
6264 SV* sv_setref_pv(SV *const rv, const char *const classname, void *const pv)
6272 Copies a string into a new SV, optionally blessing the SV. The length of the
6273 string must be specified with C<n>. The C<rv> argument will be upgraded to
6274 an RV. That RV will be modified to point to the new SV. The C<classname>
6275 argument indicates the package for the blessing. Set C<classname> to
6276 C<NULL> to avoid the blessing. The new SV will have a reference count
6277 of 1, and the RV will be returned.
6279 Note that C<sv_setref_pv> copies the pointer while this copies the string.
6281 SV* sv_setref_pvn(SV *const rv, const char *const classname, const char *const pv, const STRLEN n)
6289 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
6290 argument will be upgraded to an RV. That RV will be modified to point to
6291 the new SV. The C<classname> argument indicates the package for the
6292 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
6293 will have a reference count of 1, and the RV will be returned.
6295 SV* sv_setref_uv(SV *const rv, const char *const classname, const UV uv)
6303 Copies the contents of the source SV C<ssv> into the destination SV
6304 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
6305 function if the source SV needs to be reused. Does not handle 'set' magic.
6306 Loosely speaking, it performs a copy-by-value, obliterating any previous
6307 content of the destination.
6309 You probably want to use one of the assortment of wrappers, such as
6310 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
6311 C<SvSetMagicSV_nosteal>.
6313 void sv_setsv(SV *dstr, SV *sstr)
6318 =item sv_setsv_flags
6321 Copies the contents of the source SV C<ssv> into the destination SV
6322 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
6323 function if the source SV needs to be reused. Does not handle 'set' magic.
6324 Loosely speaking, it performs a copy-by-value, obliterating any previous
6325 content of the destination.
6326 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
6327 C<ssv> if appropriate, else not. If the C<flags> parameter has the
6328 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
6329 and C<sv_setsv_nomg> are implemented in terms of this function.
6331 You probably want to use one of the assortment of wrappers, such as
6332 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
6333 C<SvSetMagicSV_nosteal>.
6335 This is the primary function for copying scalars, and most other
6336 copy-ish functions and macros use this underneath.
6338 void sv_setsv_flags(SV *dstr, SV *sstr, const I32 flags)
6346 Like C<sv_setsv>, but also handles 'set' magic.
6348 void sv_setsv_mg(SV *const dstr, SV *const sstr)
6356 Copies an unsigned integer into the given SV, upgrading first if necessary.
6357 Does not handle 'set' magic. See also C<sv_setuv_mg>.
6359 void sv_setuv(SV *const sv, const UV num)
6367 Like C<sv_setuv>, but also handles 'set' magic.
6369 void sv_setuv_mg(SV *const sv, const UV u)
6377 Test an SV for taintedness. Use C<SvTAINTED> instead.
6378 bool sv_tainted(SV *const sv)
6386 Returns true if the SV has a true value by Perl's rules.
6387 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
6388 instead use an in-line version.
6390 I32 sv_true(SV *const sv)
6398 Removes all magic of type C<type> from an SV.
6400 int sv_unmagic(SV *const sv, const int type)
6405 =item sv_unref_flags
6408 Unsets the RV status of the SV, and decrements the reference count of
6409 whatever was being referenced by the RV. This can almost be thought of
6410 as a reversal of C<newSVrv>. The C<cflags> argument can contain
6411 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
6412 (otherwise the decrementing is conditional on the reference count being
6413 different from one or the reference being a readonly SV).
6416 void sv_unref_flags(SV *const ref, const U32 flags)
6424 Untaint an SV. Use C<SvTAINTED_off> instead.
6425 void sv_untaint(SV *const sv)
6433 Upgrade an SV to a more complex form. Generally adds a new body type to the
6434 SV, then copies across as much information as possible from the old body.
6435 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
6437 void sv_upgrade(SV *const sv, svtype new_type)
6442 =item sv_usepvn_flags
6445 Tells an SV to use C<ptr> to find its string value. Normally the
6446 string is stored inside the SV but sv_usepvn allows the SV to use an
6447 outside string. The C<ptr> should point to memory that was allocated
6448 by C<malloc>. The string length, C<len>, must be supplied. By default
6449 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
6450 so that pointer should not be freed or used by the programmer after
6451 giving it to sv_usepvn, and neither should any pointers from "behind"
6452 that pointer (e.g. ptr + 1) be used.
6454 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
6455 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
6456 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
6457 C<len>, and already meets the requirements for storing in C<SvPVX>)
6459 void sv_usepvn_flags(SV *const sv, char* ptr, const STRLEN len, const U32 flags)
6464 =item sv_utf8_decode
6467 If the PV of the SV is an octet sequence in UTF-8
6468 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
6469 so that it looks like a character. If the PV contains only single-byte
6470 characters, the C<SvUTF8> flag stays being off.
6471 Scans PV for validity and returns false if the PV is invalid UTF-8.
6473 NOTE: this function is experimental and may change or be
6474 removed without notice.
6476 bool sv_utf8_decode(SV *const sv)
6481 =item sv_utf8_downgrade
6482 X<sv_utf8_downgrade>
6484 Attempts to convert the PV of an SV from characters to bytes.
6485 If the PV contains a character that cannot fit
6486 in a byte, this conversion will fail;
6487 in this case, either returns false or, if C<fail_ok> is not
6490 This is not as a general purpose Unicode to byte encoding interface:
6491 use the Encode extension for that.
6493 NOTE: this function is experimental and may change or be
6494 removed without notice.
6496 bool sv_utf8_downgrade(SV *const sv, const bool fail_ok)
6501 =item sv_utf8_encode
6504 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
6505 flag off so that it looks like octets again.
6507 void sv_utf8_encode(SV *const sv)
6512 =item sv_utf8_upgrade
6515 Converts the PV of an SV to its UTF-8-encoded form.
6516 Forces the SV to string form if it is not already.
6517 Will C<mg_get> on C<sv> if appropriate.
6518 Always sets the SvUTF8 flag to avoid future validity checks even
6519 if the whole string is the same in UTF-8 as not.
6520 Returns the number of bytes in the converted string
6522 This is not as a general purpose byte encoding to Unicode interface:
6523 use the Encode extension for that.
6525 STRLEN sv_utf8_upgrade(SV *sv)
6530 =item sv_utf8_upgrade_flags
6531 X<sv_utf8_upgrade_flags>
6533 Converts the PV of an SV to its UTF-8-encoded form.
6534 Forces the SV to string form if it is not already.
6535 Always sets the SvUTF8 flag to avoid future validity checks even
6536 if all the bytes are invariant in UTF-8. If C<flags> has C<SV_GMAGIC> bit set,
6537 will C<mg_get> on C<sv> if appropriate, else not.
6538 Returns the number of bytes in the converted string
6539 C<sv_utf8_upgrade> and
6540 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
6542 This is not as a general purpose byte encoding to Unicode interface:
6543 use the Encode extension for that.
6545 STRLEN sv_utf8_upgrade_flags(SV *const sv, const I32 flags)
6550 =item sv_utf8_upgrade_nomg
6551 X<sv_utf8_upgrade_nomg>
6553 Like sv_utf8_upgrade, but doesn't do magic on C<sv>
6555 STRLEN sv_utf8_upgrade_nomg(SV *sv)
6563 Processes its arguments like C<vsprintf> and appends the formatted output
6564 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
6566 Usually used via its frontend C<sv_catpvf>.
6568 void sv_vcatpvf(SV *const sv, const char *const pat, va_list *const args)
6576 Processes its arguments like C<vsprintf> and appends the formatted output
6577 to an SV. Uses an array of SVs if the C style variable argument list is
6578 missing (NULL). When running with taint checks enabled, indicates via
6579 C<maybe_tainted> if results are untrustworthy (often due to the use of
6582 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
6584 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)
6592 Like C<sv_vcatpvf>, but also handles 'set' magic.
6594 Usually used via its frontend C<sv_catpvf_mg>.
6596 void sv_vcatpvf_mg(SV *const sv, const char *const pat, va_list *const args)
6604 Works like C<sv_vcatpvf> but copies the text into the SV instead of
6605 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
6607 Usually used via its frontend C<sv_setpvf>.
6609 void sv_vsetpvf(SV *const sv, const char *const pat, va_list *const args)
6617 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
6620 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
6622 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)
6630 Like C<sv_vsetpvf>, but also handles 'set' magic.
6632 Usually used via its frontend C<sv_setpvf_mg>.
6634 void sv_vsetpvf_mg(SV *const sv, const char *const pat, va_list *const args)
6642 =head1 Unicode Support
6646 =item bytes_from_utf8
6649 Converts a string C<s> of length C<len> from UTF-8 into native byte encoding.
6650 Unlike C<utf8_to_bytes> but like C<bytes_to_utf8>, returns a pointer to
6651 the newly-created string, and updates C<len> to contain the new
6652 length. Returns the original string if no conversion occurs, C<len>
6653 is unchanged. Do nothing if C<is_utf8> points to 0. Sets C<is_utf8> to
6654 0 if C<s> is converted or consisted entirely of characters that are invariant
6655 in utf8 (i.e., US-ASCII on non-EBCDIC machines).
6657 NOTE: this function is experimental and may change or be
6658 removed without notice.
6660 U8* bytes_from_utf8(const U8 *s, STRLEN *len, bool *is_utf8)
6663 Found in file utf8.c
6668 Converts a string C<s> of length C<len> from the native encoding into UTF-8.
6669 Returns a pointer to the newly-created string, and sets C<len> to
6670 reflect the new length.
6672 A NUL character will be written after the end of the string.
6674 If you want to convert to UTF-8 from encodings other than
6675 the native (Latin1 or EBCDIC),
6676 see sv_recode_to_utf8().
6678 NOTE: this function is experimental and may change or be
6679 removed without notice.
6681 U8* bytes_to_utf8(const U8 *s, STRLEN *len)
6684 Found in file utf8.c
6689 Return true if the strings s1 and s2 differ case-insensitively, false
6690 if not (if they are equal case-insensitively). If u1 is true, the
6691 string s1 is assumed to be in UTF-8-encoded Unicode. If u2 is true,
6692 the string s2 is assumed to be in UTF-8-encoded Unicode. If u1 or u2
6693 are false, the respective string is assumed to be in native 8-bit
6696 If the pe1 and pe2 are non-NULL, the scanning pointers will be copied
6697 in there (they will point at the beginning of the I<next> character).
6698 If the pointers behind pe1 or pe2 are non-NULL, they are the end
6699 pointers beyond which scanning will not continue under any
6700 circumstances. If the byte lengths l1 and l2 are non-zero, s1+l1 and
6701 s2+l2 will be used as goal end pointers that will also stop the scan,
6702 and which qualify towards defining a successful match: all the scans
6703 that define an explicit length must reach their goal pointers for
6704 a match to succeed).
6706 For case-insensitiveness, the "casefolding" of Unicode is used
6707 instead of upper/lowercasing both the characters, see
6708 http://www.unicode.org/unicode/reports/tr21/ (Case Mappings).
6710 I32 ibcmp_utf8(const char *s1, char **pe1, UV l1, bool u1, const char *s2, char **pe2, UV l2, bool u2)
6713 Found in file utf8.c
6718 Tests if some arbitrary number of bytes begins in a valid UTF-8
6719 character. Note that an INVARIANT (i.e. ASCII on non-EBCDIC machines)
6720 character is a valid UTF-8 character. The actual number of bytes in the UTF-8
6721 character will be returned if it is valid, otherwise 0.
6723 STRLEN is_utf8_char(const U8 *s)
6726 Found in file utf8.c
6728 =item is_utf8_string
6731 Returns true if first C<len> bytes of the given string form a valid
6732 UTF-8 string, false otherwise. Note that 'a valid UTF-8 string' does
6733 not mean 'a string that contains code points above 0x7F encoded in UTF-8'
6734 because a valid ASCII string is a valid UTF-8 string.
6736 See also is_utf8_string_loclen() and is_utf8_string_loc().
6738 bool is_utf8_string(const U8 *s, STRLEN len)
6741 Found in file utf8.c
6743 =item is_utf8_string_loc
6744 X<is_utf8_string_loc>
6746 Like is_utf8_string() but stores the location of the failure (in the
6747 case of "utf8ness failure") or the location s+len (in the case of
6748 "utf8ness success") in the C<ep>.
6750 See also is_utf8_string_loclen() and is_utf8_string().
6752 bool is_utf8_string_loc(const U8 *s, STRLEN len, const U8 **p)
6755 Found in file utf8.c
6757 =item is_utf8_string_loclen
6758 X<is_utf8_string_loclen>
6760 Like is_utf8_string() but stores the location of the failure (in the
6761 case of "utf8ness failure") or the location s+len (in the case of
6762 "utf8ness success") in the C<ep>, and the number of UTF-8
6763 encoded characters in the C<el>.
6765 See also is_utf8_string_loc() and is_utf8_string().
6767 bool is_utf8_string_loclen(const U8 *s, STRLEN len, const U8 **ep, STRLEN *el)
6770 Found in file utf8.c
6772 =item pv_uni_display
6775 Build to the scalar dsv a displayable version of the string spv,
6776 length len, the displayable version being at most pvlim bytes long
6777 (if longer, the rest is truncated and "..." will be appended).
6779 The flags argument can have UNI_DISPLAY_ISPRINT set to display
6780 isPRINT()able characters as themselves, UNI_DISPLAY_BACKSLASH
6781 to display the \\[nrfta\\] as the backslashed versions (like '\n')
6782 (UNI_DISPLAY_BACKSLASH is preferred over UNI_DISPLAY_ISPRINT for \\).
6783 UNI_DISPLAY_QQ (and its alias UNI_DISPLAY_REGEX) have both
6784 UNI_DISPLAY_BACKSLASH and UNI_DISPLAY_ISPRINT turned on.
6786 The pointer to the PV of the dsv is returned.
6788 char* pv_uni_display(SV *dsv, const U8 *spv, STRLEN len, STRLEN pvlim, UV flags)
6791 Found in file utf8.c
6796 The encoding is assumed to be an Encode object, the PV of the ssv is
6797 assumed to be octets in that encoding and decoding the input starts
6798 from the position which (PV + *offset) pointed to. The dsv will be
6799 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
6800 when the string tstr appears in decoding output or the input ends on
6801 the PV of the ssv. The value which the offset points will be modified
6802 to the last input position on the ssv.
6804 Returns TRUE if the terminator was found, else returns FALSE.
6806 bool sv_cat_decode(SV* dsv, SV *encoding, SV *ssv, int *offset, char* tstr, int tlen)
6811 =item sv_recode_to_utf8
6812 X<sv_recode_to_utf8>
6814 The encoding is assumed to be an Encode object, on entry the PV
6815 of the sv is assumed to be octets in that encoding, and the sv
6816 will be converted into Unicode (and UTF-8).
6818 If the sv already is UTF-8 (or if it is not POK), or if the encoding
6819 is not a reference, nothing is done to the sv. If the encoding is not
6820 an C<Encode::XS> Encoding object, bad things will happen.
6821 (See F<lib/encoding.pm> and L<Encode>).
6823 The PV of the sv is returned.
6825 char* sv_recode_to_utf8(SV* sv, SV *encoding)
6830 =item sv_uni_display
6833 Build to the scalar dsv a displayable version of the scalar sv,
6834 the displayable version being at most pvlim bytes long
6835 (if longer, the rest is truncated and "..." will be appended).
6837 The flags argument is as in pv_uni_display().
6839 The pointer to the PV of the dsv is returned.
6841 char* sv_uni_display(SV *dsv, SV *ssv, STRLEN pvlim, UV flags)
6844 Found in file utf8.c
6849 The "p" contains the pointer to the UTF-8 string encoding
6850 the character that is being converted.
6852 The "ustrp" is a pointer to the character buffer to put the
6853 conversion result to. The "lenp" is a pointer to the length
6856 The "swashp" is a pointer to the swash to use.
6858 Both the special and normal mappings are stored lib/unicore/To/Foo.pl,
6859 and loaded by SWASHNEW, using lib/utf8_heavy.pl. The special (usually,
6860 but not always, a multicharacter mapping), is tried first.
6862 The "special" is a string like "utf8::ToSpecLower", which means the
6863 hash %utf8::ToSpecLower. The access to the hash is through
6864 Perl_to_utf8_case().
6866 The "normal" is a string like "ToLower" which means the swash
6869 UV to_utf8_case(const U8 *p, U8* ustrp, STRLEN *lenp, SV **swashp, const char *normal, const char *special)
6872 Found in file utf8.c
6877 Convert the UTF-8 encoded character at p to its foldcase version and
6878 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6879 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6880 foldcase version may be longer than the original character (up to
6883 The first character of the foldcased version is returned
6884 (but note, as explained above, that there may be more.)
6886 UV to_utf8_fold(const U8 *p, U8* ustrp, STRLEN *lenp)
6889 Found in file utf8.c
6894 Convert the UTF-8 encoded character at p to its lowercase version and
6895 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6896 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6897 lowercase version may be longer than the original character.
6899 The first character of the lowercased version is returned
6900 (but note, as explained above, that there may be more.)
6902 UV to_utf8_lower(const U8 *p, U8* ustrp, STRLEN *lenp)
6905 Found in file utf8.c
6910 Convert the UTF-8 encoded character at p to its titlecase version and
6911 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6912 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6913 titlecase version may be longer than the original character.
6915 The first character of the titlecased version is returned
6916 (but note, as explained above, that there may be more.)
6918 UV to_utf8_title(const U8 *p, U8* ustrp, STRLEN *lenp)
6921 Found in file utf8.c
6926 Convert the UTF-8 encoded character at p to its uppercase version and
6927 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6928 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since
6929 the uppercase version may be longer than the original character.
6931 The first character of the uppercased version is returned
6932 (but note, as explained above, that there may be more.)
6934 UV to_utf8_upper(const U8 *p, U8* ustrp, STRLEN *lenp)
6937 Found in file utf8.c
6939 =item utf8n_to_uvchr
6944 Returns the native character value of the first character in the string
6946 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6947 length, in bytes, of that character.
6949 Allows length and flags to be passed to low level routine.
6951 UV utf8n_to_uvchr(const U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags)
6954 Found in file utf8.c
6956 =item utf8n_to_uvuni
6959 Bottom level UTF-8 decode routine.
6960 Returns the Unicode code point value of the first character in the string C<s>
6961 which is assumed to be in UTF-8 encoding and no longer than C<curlen>;
6962 C<retlen> will be set to the length, in bytes, of that character.
6964 If C<s> does not point to a well-formed UTF-8 character, the behaviour
6965 is dependent on the value of C<flags>: if it contains UTF8_CHECK_ONLY,
6966 it is assumed that the caller will raise a warning, and this function
6967 will silently just set C<retlen> to C<-1> and return zero. If the
6968 C<flags> does not contain UTF8_CHECK_ONLY, warnings about
6969 malformations will be given, C<retlen> will be set to the expected
6970 length of the UTF-8 character in bytes, and zero will be returned.
6972 The C<flags> can also contain various flags to allow deviations from
6973 the strict UTF-8 encoding (see F<utf8.h>).
6975 Most code should use utf8_to_uvchr() rather than call this directly.
6977 UV utf8n_to_uvuni(const U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags)
6980 Found in file utf8.c
6985 Returns the number of UTF-8 characters between the UTF-8 pointers C<a>
6988 WARNING: use only if you *know* that the pointers point inside the
6991 IV utf8_distance(const U8 *a, const U8 *b)
6994 Found in file utf8.c
6999 Return the UTF-8 pointer C<s> displaced by C<off> characters, either
7000 forward or backward.
7002 WARNING: do not use the following unless you *know* C<off> is within
7003 the UTF-8 data pointed to by C<s> *and* that on entry C<s> is aligned
7004 on the first byte of character or just after the last byte of a character.
7006 U8* utf8_hop(const U8 *s, I32 off)
7009 Found in file utf8.c
7014 Return the length of the UTF-8 char encoded string C<s> in characters.
7015 Stops at C<e> (inclusive). If C<e E<lt> s> or if the scan would end
7016 up past C<e>, croaks.
7018 STRLEN utf8_length(const U8* s, const U8 *e)
7021 Found in file utf8.c
7026 Converts a string C<s> of length C<len> from UTF-8 into native byte encoding.
7027 Unlike C<bytes_to_utf8>, this over-writes the original string, and
7028 updates len to contain the new length.
7029 Returns zero on failure, setting C<len> to -1.
7031 If you need a copy of the string, see C<bytes_from_utf8>.
7033 NOTE: this function is experimental and may change or be
7034 removed without notice.
7036 U8* utf8_to_bytes(U8 *s, STRLEN *len)
7039 Found in file utf8.c
7044 Returns the native character value of the first character in the string C<s>
7045 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
7046 length, in bytes, of that character.
7048 If C<s> does not point to a well-formed UTF-8 character, zero is
7049 returned and retlen is set, if possible, to -1.
7051 UV utf8_to_uvchr(const U8 *s, STRLEN *retlen)
7054 Found in file utf8.c
7059 Returns the Unicode code point of the first character in the string C<s>
7060 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
7061 length, in bytes, of that character.
7063 This function should only be used when the returned UV is considered
7064 an index into the Unicode semantic tables (e.g. swashes).
7066 If C<s> does not point to a well-formed UTF-8 character, zero is
7067 returned and retlen is set, if possible, to -1.
7069 UV utf8_to_uvuni(const U8 *s, STRLEN *retlen)
7072 Found in file utf8.c
7077 Adds the UTF-8 representation of the Native codepoint C<uv> to the end
7078 of the string C<d>; C<d> should be have at least C<UTF8_MAXBYTES+1> free
7079 bytes available. The return value is the pointer to the byte after the
7080 end of the new character. In other words,
7082 d = uvchr_to_utf8(d, uv);
7084 is the recommended wide native character-aware way of saying
7088 U8* uvchr_to_utf8(U8 *d, UV uv)
7091 Found in file utf8.c
7093 =item uvuni_to_utf8_flags
7094 X<uvuni_to_utf8_flags>
7096 Adds the UTF-8 representation of the Unicode codepoint C<uv> to the end
7097 of the string C<d>; C<d> should be have at least C<UTF8_MAXBYTES+1> free
7098 bytes available. The return value is the pointer to the byte after the
7099 end of the new character. In other words,
7101 d = uvuni_to_utf8_flags(d, uv, flags);
7105 d = uvuni_to_utf8(d, uv);
7107 (which is equivalent to)
7109 d = uvuni_to_utf8_flags(d, uv, 0);
7111 is the recommended Unicode-aware way of saying
7115 U8* uvuni_to_utf8_flags(U8 *d, UV uv, UV flags)
7118 Found in file utf8.c
7123 =head1 Variables created by C<xsubpp> and C<xsubpp> internal functions
7130 Variable which is setup by C<xsubpp> to indicate the stack base offset,
7131 used by the C<ST>, C<XSprePUSH> and C<XSRETURN> macros. The C<dMARK> macro
7132 must be called prior to setup the C<MARK> variable.
7137 Found in file XSUB.h
7142 Variable which is setup by C<xsubpp> to indicate the
7143 class name for a C++ XS constructor. This is always a C<char*>. See C<THIS>.
7148 Found in file XSUB.h
7153 Sets up the C<ax> variable.
7154 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
7159 Found in file XSUB.h
7164 Sets up the C<ax> variable and stack marker variable C<mark>.
7165 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
7170 Found in file XSUB.h
7175 Sets up the C<items> variable.
7176 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
7181 Found in file XSUB.h
7186 Sets up the C<padoff_du> variable for an XSUB that wishes to use
7192 Found in file XSUB.h
7197 Sets up stack and mark pointers for an XSUB, calling dSP and dMARK.
7198 Sets up the C<ax> and C<items> variables by calling C<dAX> and C<dITEMS>.
7199 This is usually handled automatically by C<xsubpp>.
7204 Found in file XSUB.h
7209 Sets up the C<ix> variable for an XSUB which has aliases. This is usually
7210 handled automatically by C<xsubpp>.
7215 Found in file XSUB.h
7220 Variable which is setup by C<xsubpp> to indicate the number of
7221 items on the stack. See L<perlxs/"Variable-length Parameter Lists">.
7226 Found in file XSUB.h
7231 Variable which is setup by C<xsubpp> to indicate which of an
7232 XSUB's aliases was used to invoke it. See L<perlxs/"The ALIAS: Keyword">.
7237 Found in file XSUB.h
7242 Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
7246 Found in file XSUB.h
7251 Variable which is setup by C<xsubpp> to hold the return value for an
7252 XSUB. This is always the proper type for the XSUB. See
7253 L<perlxs/"The RETVAL Variable">.
7258 Found in file XSUB.h
7263 Used to access elements on the XSUB's stack.
7268 Found in file XSUB.h
7273 Variable which is setup by C<xsubpp> to designate the object in a C++
7274 XSUB. This is always the proper type for the C++ object. See C<CLASS> and
7275 L<perlxs/"Using XS With C++">.
7280 Found in file XSUB.h
7285 The SV* corresponding to the $_ variable. Works even if there
7286 is a lexical $_ in scope.
7289 Found in file XSUB.h
7294 Macro to declare an XSUB and its C parameter list. This is handled by
7298 Found in file XSUB.h
7303 The version identifier for an XS module. This is usually
7304 handled automatically by C<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>.
7307 Found in file XSUB.h
7309 =item XS_VERSION_BOOTCHECK
7310 X<XS_VERSION_BOOTCHECK>
7312 Macro to verify that a PM module's $VERSION variable matches the XS
7313 module's C<XS_VERSION> variable. This is usually handled automatically by
7314 C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">.
7316 XS_VERSION_BOOTCHECK;
7319 Found in file XSUB.h
7324 =head1 Warning and Dieing
7331 This is the XSUB-writer's interface to Perl's C<die> function.
7332 Normally call this function the same way you call the C C<printf>
7333 function. Calling C<croak> returns control directly to Perl,
7334 sidestepping the normal C order of execution. See C<warn>.
7336 If you want to throw an exception object, assign the object to
7337 C<$@> and then pass C<NULL> to croak():
7339 errsv = get_sv("@", GV_ADD);
7340 sv_setsv(errsv, exception_object);
7343 void croak(const char* pat, ...)
7346 Found in file util.c
7351 This is the XSUB-writer's interface to Perl's C<warn> function. Call this
7352 function the same way you call the C C<printf> function. See C<croak>.
7354 void warn(const char* pat, ...)
7357 Found in file util.c
7364 Until May 1997, this document was maintained by Jeff Okamoto
7365 <okamoto@corp.hp.com>. It is now maintained as part of Perl itself.
7367 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
7368 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
7369 Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
7370 Stephen McCamant, and Gurusamy Sarathy.
7372 API Listing originally by Dean Roehrich <roehrich@cray.com>.
7374 Updated to be autogenerated from comments in the source by Benjamin Stuhl.
7378 perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
projects / p5sagit/p5-mst-13.2.git / blob