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. If C<create> is set and the
358 Perl variable does not exist then it will be created. If C<create> is not
359 set and the variable does not exist then NULL is returned.
361 NOTE: the perl_ form of this function is deprecated.
363 AV* get_av(const char* name, I32 create)
371 Creates a new AV. The reference count is set to 1.
381 Sort an array. Here is an example:
383 sortsv(AvARRAY(av), av_len(av)+1, Perl_sv_cmp_locale);
385 Currently this always uses mergesort. See sortsv_flags for a more
388 void sortsv(SV** array, size_t num_elts, SVCOMPARE_t cmp)
391 Found in file pp_sort.c
396 Sort an array, with various options.
398 void sortsv_flags(SV** array, size_t num_elts, SVCOMPARE_t cmp, U32 flags)
401 Found in file pp_sort.c
406 =head1 Callback Functions
413 Performs a callback to the specified Perl sub. See L<perlcall>.
415 NOTE: the perl_ form of this function is deprecated.
417 I32 call_argv(const char* sub_name, I32 flags, char** argv)
425 Performs a callback to the specified Perl method. The blessed object must
426 be on the stack. See L<perlcall>.
428 NOTE: the perl_ form of this function is deprecated.
430 I32 call_method(const char* methname, I32 flags)
438 Performs a callback to the specified Perl sub. See L<perlcall>.
440 NOTE: the perl_ form of this function is deprecated.
442 I32 call_pv(const char* sub_name, I32 flags)
450 Performs a callback to the Perl sub whose name is in the SV. See
453 NOTE: the perl_ form of this function is deprecated.
455 I32 call_sv(SV* sv, VOL I32 flags)
463 Opening bracket on a callback. See C<LEAVE> and L<perlcall>.
468 Found in file scope.h
473 Tells Perl to C<eval> the given string and return an SV* result.
475 NOTE: the perl_ form of this function is deprecated.
477 SV* eval_pv(const char* p, I32 croak_on_error)
485 Tells Perl to C<eval> the string in the SV.
487 NOTE: the perl_ form of this function is deprecated.
489 I32 eval_sv(SV* sv, I32 flags)
497 Closing bracket for temporaries on a callback. See C<SAVETMPS> and
503 Found in file scope.h
508 Closing bracket on a callback. See C<ENTER> and L<perlcall>.
513 Found in file scope.h
518 Opening bracket for temporaries on a callback. See C<FREETMPS> and
524 Found in file scope.h
529 =head1 Character classes
536 Returns a boolean indicating whether the C C<char> is a US-ASCII (Basic Latin)
537 alphanumeric character (including underscore) or digit.
539 bool isALNUM(char ch)
542 Found in file handy.h
547 Returns a boolean indicating whether the C C<char> is a US-ASCII (Basic Latin)
548 alphabetic character.
550 bool isALPHA(char ch)
553 Found in file handy.h
558 Returns a boolean indicating whether the C C<char> is a US-ASCII (Basic Latin)
561 bool isDIGIT(char ch)
564 Found in file handy.h
569 Returns a boolean indicating whether the C C<char> is a US-ASCII (Basic Latin)
572 bool isLOWER(char ch)
575 Found in file handy.h
580 Returns a boolean indicating whether the C C<char> is a US-ASCII (Basic Latin)
583 bool isSPACE(char ch)
586 Found in file handy.h
591 Returns a boolean indicating whether the C C<char> is a US-ASCII (Basic Latin)
594 bool isUPPER(char ch)
597 Found in file handy.h
602 Converts the specified character to lowercase. Characters outside the
603 US-ASCII (Basic Latin) range are viewed as not having any case.
605 char toLOWER(char ch)
608 Found in file handy.h
613 Converts the specified character to uppercase. Characters outside the
614 US-ASCII (Basic Latin) range are viewed as not having any case.
616 char toUPPER(char ch)
619 Found in file handy.h
624 =head1 Cloning an interpreter
631 Create and return a new interpreter by cloning the current one.
633 perl_clone takes these flags as parameters:
635 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
636 without it we only clone the data and zero the stacks,
637 with it we copy the stacks and the new perl interpreter is
638 ready to run at the exact same point as the previous one.
639 The pseudo-fork code uses COPY_STACKS while the
640 threads->create doesn't.
642 CLONEf_KEEP_PTR_TABLE
643 perl_clone keeps a ptr_table with the pointer of the old
644 variable as a key and the new variable as a value,
645 this allows it to check if something has been cloned and not
646 clone it again but rather just use the value and increase the
647 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
648 the ptr_table using the function
649 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
650 reason to keep it around is if you want to dup some of your own
651 variable who are outside the graph perl scans, example of this
652 code is in threads.xs create
655 This is a win32 thing, it is ignored on unix, it tells perls
656 win32host code (which is c++) to clone itself, this is needed on
657 win32 if you want to run two threads at the same time,
658 if you just want to do some stuff in a separate perl interpreter
659 and then throw it away and return to the original one,
660 you don't need to do anything.
662 PerlInterpreter* perl_clone(PerlInterpreter *proto_perl, UV flags)
670 =head1 CV Manipulation Functions
677 Returns the stash of the CV.
687 Uses C<strlen> to get the length of C<name>, then calls C<get_cvn_flags>.
689 NOTE: the perl_ form of this function is deprecated.
691 CV* get_cv(const char* name, I32 flags)
699 Returns the CV of the specified Perl subroutine. C<flags> are passed to
700 C<gv_fetchpvn_flags>. If C<GV_ADD> is set and the Perl subroutine does not
701 exist then it will be declared (which has the same effect as saying
702 C<sub name;>). If C<GV_ADD> is not set and the subroutine does not exist
703 then NULL is returned.
705 NOTE: the perl_ form of this function is deprecated.
707 CV* get_cvn_flags(const char* name, STRLEN len, I32 flags)
715 =head1 Embedding Functions
722 Clear out all the active components of a CV. This can happen either
723 by an explicit C<undef &foo>, or by the reference count going to zero.
724 In the former case, we keep the CvOUTSIDE pointer, so that any anonymous
725 children can still follow the full lexical scope chain.
727 void cv_undef(CV* cv)
735 Loads the module whose name is pointed to by the string part of name.
736 Note that the actual module name, not its filename, should be given.
737 Eg, "Foo::Bar" instead of "Foo/Bar.pm". flags can be any of
738 PERL_LOADMOD_DENY, PERL_LOADMOD_NOIMPORT, or PERL_LOADMOD_IMPORT_OPS
739 (or 0 for no flags). ver, if specified, provides version semantics
740 similar to C<use Foo::Bar VERSION>. The optional trailing SV*
741 arguments can be used to specify arguments to the module's import()
742 method, similar to C<use Foo::Bar VERSION LIST>.
744 void load_module(U32 flags, SV* name, SV* ver, ...)
752 Stub that provides thread hook for perl_destruct when there are
763 Allocates a new Perl interpreter. See L<perlembed>.
765 PerlInterpreter* perl_alloc()
773 Initializes a new Perl interpreter. See L<perlembed>.
775 void perl_construct(PerlInterpreter *my_perl)
783 Shuts down a Perl interpreter. See L<perlembed>.
785 int perl_destruct(PerlInterpreter *my_perl)
793 Releases a Perl interpreter. See L<perlembed>.
795 void perl_free(PerlInterpreter *my_perl)
803 Tells a Perl interpreter to parse a Perl script. See L<perlembed>.
805 int perl_parse(PerlInterpreter *my_perl, XSINIT_t xsinit, int argc, char** argv, char** env)
813 Tells a Perl interpreter to run. See L<perlembed>.
815 int perl_run(PerlInterpreter *my_perl)
823 Tells Perl to C<require> the file named by the string argument. It is
824 analogous to the Perl code C<eval "require '$file'">. It's even
825 implemented that way; consider using load_module instead.
827 NOTE: the perl_ form of this function is deprecated.
829 void require_pv(const char* pv)
837 =head1 Functions in file dump.c
847 pv_escape(dsv,pv,cur,pvlim,PERL_PV_ESCAPE_QUOTE);
849 except that an additional "\0" will be appended to the string when
850 len > cur and pv[cur] is "\0".
852 Note that the final string may be up to 7 chars longer than pvlim.
854 char* pv_display(SV *dsv, const char *pv, STRLEN cur, STRLEN len, STRLEN pvlim)
862 Escapes at most the first "count" chars of pv and puts the results into
863 dsv such that the size of the escaped string will not exceed "max" chars
864 and will not contain any incomplete escape sequences.
866 If flags contains PERL_PV_ESCAPE_QUOTE then any double quotes in the string
867 will also be escaped.
869 Normally the SV will be cleared before the escaped string is prepared,
870 but when PERL_PV_ESCAPE_NOCLEAR is set this will not occur.
872 If PERL_PV_ESCAPE_UNI is set then the input string is treated as Unicode,
873 if PERL_PV_ESCAPE_UNI_DETECT is set then the input string is scanned
874 using C<is_utf8_string()> to determine if it is Unicode.
876 If PERL_PV_ESCAPE_ALL is set then all input chars will be output
877 using C<\x01F1> style escapes, otherwise only chars above 255 will be
878 escaped using this style, other non printable chars will use octal or
879 common escaped patterns like C<\n>. If PERL_PV_ESCAPE_NOBACKSLASH
880 then all chars below 255 will be treated as printable and
881 will be output as literals.
883 If PERL_PV_ESCAPE_FIRSTCHAR is set then only the first char of the
884 string will be escaped, regardles of max. If the string is utf8 and
885 the chars value is >255 then it will be returned as a plain hex
886 sequence. Thus the output will either be a single char,
887 an octal escape sequence, a special escape like C<\n> or a 3 or
888 more digit hex value.
890 If PERL_PV_ESCAPE_RE is set then the escape char used will be a '%' and
891 not a '\\'. This is because regexes very often contain backslashed
892 sequences, whereas '%' is not a particularly common character in patterns.
894 Returns a pointer to the escaped text as held by dsv.
896 char* pv_escape(SV *dsv, char const * const str, const STRLEN count, const STRLEN max, STRLEN * const escaped, const U32 flags)
904 Converts a string into something presentable, handling escaping via
905 pv_escape() and supporting quoting and ellipses.
907 If the PERL_PV_PRETTY_QUOTE flag is set then the result will be
908 double quoted with any double quotes in the string escaped. Otherwise
909 if the PERL_PV_PRETTY_LTGT flag is set then the result be wrapped in
912 If the PERL_PV_PRETTY_ELLIPSES flag is set and not all characters in
913 string were output then an ellipsis C<...> will be appended to the
914 string. Note that this happens AFTER it has been quoted.
916 If start_color is non-null then it will be inserted after the opening
917 quote (if there is one) but before the escaped text. If end_color
918 is non-null then it will be inserted after the escaped text but before
919 any quotes or ellipses.
921 Returns a pointer to the prettified text as held by dsv.
923 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)
931 =head1 Functions in file mathoms.c
939 See L<gv_fetchmethod_autoload>.
941 GV* gv_fetchmethod(HV* stash, const char* name)
944 Found in file mathoms.c
949 The engine implementing pack() Perl function. Note: parameters next_in_list and
950 flags are not used. This call should not be used; use packlist instead.
952 void pack_cat(SV *cat, const char *pat, const char *patend, SV **beglist, SV **endlist, SV ***next_in_list, U32 flags)
955 Found in file mathoms.c
957 =item sv_2pvbyte_nolen
960 Return a pointer to the byte-encoded representation of the SV.
961 May cause the SV to be downgraded from UTF-8 as a side-effect.
963 Usually accessed via the C<SvPVbyte_nolen> macro.
965 char* sv_2pvbyte_nolen(SV* sv)
968 Found in file mathoms.c
970 =item sv_2pvutf8_nolen
973 Return a pointer to the UTF-8-encoded representation of the SV.
974 May cause the SV to be upgraded to UTF-8 as a side-effect.
976 Usually accessed via the C<SvPVutf8_nolen> macro.
978 char* sv_2pvutf8_nolen(SV* sv)
981 Found in file mathoms.c
986 Like C<sv_2pv()>, but doesn't return the length too. You should usually
987 use the macro wrapper C<SvPV_nolen(sv)> instead.
988 char* sv_2pv_nolen(SV* sv)
991 Found in file mathoms.c
996 Like C<sv_catpvn>, but also handles 'set' magic.
998 void sv_catpvn_mg(SV *sv, const char *ptr, STRLEN len)
1001 Found in file mathoms.c
1006 Like C<sv_catsv>, but also handles 'set' magic.
1008 void sv_catsv_mg(SV *dsv, SV *ssv)
1011 Found in file mathoms.c
1013 =item sv_force_normal
1016 Undo various types of fakery on an SV: if the PV is a shared string, make
1017 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
1018 an xpvmg. See also C<sv_force_normal_flags>.
1020 void sv_force_normal(SV *sv)
1023 Found in file mathoms.c
1028 A private implementation of the C<SvIVx> macro for compilers which can't
1029 cope with complex macro expressions. Always use the macro instead.
1034 Found in file mathoms.c
1039 Dummy routine which "locks" an SV when there is no locking module present.
1040 Exists to avoid test for a NULL function pointer and because it could
1041 potentially warn under some level of strict-ness.
1043 "Superseded" by sv_nosharing().
1045 void sv_nolocking(SV *sv)
1048 Found in file mathoms.c
1050 =item sv_nounlocking
1053 Dummy routine which "unlocks" an SV when there is no locking module present.
1054 Exists to avoid test for a NULL function pointer and because it could
1055 potentially warn under some level of strict-ness.
1057 "Superseded" by sv_nosharing().
1059 void sv_nounlocking(SV *sv)
1062 Found in file mathoms.c
1067 A private implementation of the C<SvNVx> macro for compilers which can't
1068 cope with complex macro expressions. Always use the macro instead.
1073 Found in file mathoms.c
1078 Use the C<SvPV_nolen> macro instead
1083 Found in file mathoms.c
1088 Use C<SvPVbyte_nolen> instead.
1090 char* sv_pvbyte(SV *sv)
1093 Found in file mathoms.c
1098 A private implementation of the C<SvPVbyte> macro for compilers
1099 which can't cope with complex macro expressions. Always use the macro
1102 char* sv_pvbyten(SV *sv, STRLEN *lp)
1105 Found in file mathoms.c
1110 A private implementation of the C<SvPV> macro for compilers which can't
1111 cope with complex macro expressions. Always use the macro instead.
1113 char* sv_pvn(SV *sv, STRLEN *lp)
1116 Found in file mathoms.c
1121 Use the C<SvPVutf8_nolen> macro instead
1123 char* sv_pvutf8(SV *sv)
1126 Found in file mathoms.c
1131 A private implementation of the C<SvPVutf8> macro for compilers
1132 which can't cope with complex macro expressions. Always use the macro
1135 char* sv_pvutf8n(SV *sv, STRLEN *lp)
1138 Found in file mathoms.c
1143 Taint an SV. Use C<SvTAINTED_on> instead.
1144 void sv_taint(SV* sv)
1147 Found in file mathoms.c
1152 Unsets the RV status of the SV, and decrements the reference count of
1153 whatever was being referenced by the RV. This can almost be thought of
1154 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
1155 being zero. See C<SvROK_off>.
1157 void sv_unref(SV* sv)
1160 Found in file mathoms.c
1165 Tells an SV to use C<ptr> to find its string value. Implemented by
1166 calling C<sv_usepvn_flags> with C<flags> of 0, hence does not handle 'set'
1167 magic. See C<sv_usepvn_flags>.
1169 void sv_usepvn(SV* sv, char* ptr, STRLEN len)
1172 Found in file mathoms.c
1177 Like C<sv_usepvn>, but also handles 'set' magic.
1179 void sv_usepvn_mg(SV *sv, char *ptr, STRLEN len)
1182 Found in file mathoms.c
1187 A private implementation of the C<SvUVx> macro for compilers which can't
1188 cope with complex macro expressions. Always use the macro instead.
1193 Found in file mathoms.c
1198 The engine implementing unpack() Perl function. Note: parameters strbeg, new_s
1199 and ocnt are not used. This call should not be used, use unpackstring instead.
1201 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)
1204 Found in file mathoms.c
1209 =head1 Functions in file pp_ctl.c
1217 Locate the CV corresponding to the currently executing sub or eval.
1218 If db_seqp is non_null, skip CVs that are in the DB package and populate
1219 *db_seqp with the cop sequence number at the point that the DB:: code was
1220 entered. (allows debuggers to eval in the scope of the breakpoint rather
1221 than in the scope of the debugger itself).
1223 CV* find_runcv(U32 *db_seqp)
1226 Found in file pp_ctl.c
1231 =head1 Functions in file pp_pack.c
1239 The engine implementing pack() Perl function.
1241 void packlist(SV *cat, const char *pat, const char *patend, SV **beglist, SV **endlist)
1244 Found in file pp_pack.c
1249 The engine implementing unpack() Perl function. C<unpackstring> puts the
1250 extracted list items on the stack and returns the number of elements.
1251 Issue C<PUTBACK> before and C<SPAGAIN> after the call to this function.
1253 I32 unpackstring(const char *pat, const char *patend, const char *s, const char *strend, U32 flags)
1256 Found in file pp_pack.c
1261 =head1 Functions in file pp_sys.c
1269 Sets PL_defoutgv, the default file handle for output, to the passed in
1270 typeglob. As PL_defoutgv "owns" a reference on its typeglob, the reference
1271 count of the passed in typeglob is increased by one, and the reference count
1272 of the typeglob that PL_defoutgv points to is decreased by one.
1274 void setdefout(GV* gv)
1277 Found in file pp_sys.c
1289 Return the SV from the GV.
1299 If C<gv> is a typeglob whose subroutine entry is a constant sub eligible for
1300 inlining, or C<gv> is a placeholder reference that would be promoted to such
1301 a typeglob, then returns the value returned by the sub. Otherwise, returns
1304 SV* gv_const_sv(GV* gv)
1312 Returns the glob with the given C<name> and a defined subroutine or
1313 C<NULL>. The glob lives in the given C<stash>, or in the stashes
1314 accessible via @ISA and UNIVERSAL::.
1316 The argument C<level> should be either 0 or -1. If C<level==0>, as a
1317 side-effect creates a glob with the given C<name> in the given C<stash>
1318 which in the case of success contains an alias for the subroutine, and sets
1319 up caching info for this glob.
1321 This function grants C<"SUPER"> token as a postfix of the stash name. The
1322 GV returned from C<gv_fetchmeth> may be a method cache entry, which is not
1323 visible to Perl code. So when calling C<call_sv>, you should not use
1324 the GV directly; instead, you should use the method's CV, which can be
1325 obtained from the GV with the C<GvCV> macro.
1327 GV* gv_fetchmeth(HV* stash, const char* name, STRLEN len, I32 level)
1332 =item gv_fetchmethod_autoload
1333 X<gv_fetchmethod_autoload>
1335 Returns the glob which contains the subroutine to call to invoke the method
1336 on the C<stash>. In fact in the presence of autoloading this may be the
1337 glob for "AUTOLOAD". In this case the corresponding variable $AUTOLOAD is
1340 The third parameter of C<gv_fetchmethod_autoload> determines whether
1341 AUTOLOAD lookup is performed if the given method is not present: non-zero
1342 means yes, look for AUTOLOAD; zero means no, don't look for AUTOLOAD.
1343 Calling C<gv_fetchmethod> is equivalent to calling C<gv_fetchmethod_autoload>
1344 with a non-zero C<autoload> parameter.
1346 These functions grant C<"SUPER"> token as a prefix of the method name. Note
1347 that if you want to keep the returned glob for a long time, you need to
1348 check for it being "AUTOLOAD", since at the later time the call may load a
1349 different subroutine due to $AUTOLOAD changing its value. Use the glob
1350 created via a side effect to do this.
1352 These functions have the same side-effects and as C<gv_fetchmeth> with
1353 C<level==0>. C<name> should be writable if contains C<':'> or C<'
1354 ''>. The warning against passing the GV returned by C<gv_fetchmeth> to
1355 C<call_sv> apply equally to these functions.
1357 GV* gv_fetchmethod_autoload(HV* stash, const char* name, I32 autoload)
1362 =item gv_fetchmeth_autoload
1363 X<gv_fetchmeth_autoload>
1365 Same as gv_fetchmeth(), but looks for autoloaded subroutines too.
1366 Returns a glob for the subroutine.
1368 For an autoloaded subroutine without a GV, will create a GV even
1369 if C<level < 0>. For an autoloaded subroutine without a stub, GvCV()
1370 of the result may be zero.
1372 GV* gv_fetchmeth_autoload(HV* stash, const char* name, STRLEN len, I32 level)
1380 Returns a pointer to the stash for a specified package. Uses C<strlen> to
1381 determine the length of C<name>, then calls C<gv_stashpvn()>.
1383 HV* gv_stashpv(const char* name, I32 flags)
1391 Returns a pointer to the stash for a specified package. The C<namelen>
1392 parameter indicates the length of the C<name>, in bytes. C<flags> is passed
1393 to C<gv_fetchpvn_flags()>, so if set to C<GV_ADD> then the package will be
1394 created if it does not already exist. If the package does not exist and
1395 C<flags> is 0 (or any other setting that does not create packages) then NULL
1399 HV* gv_stashpvn(const char* name, U32 namelen, I32 flags)
1407 Like C<gv_stashpvn>, but takes a literal string instead of a string/length pair.
1409 HV* gv_stashpvs(const char* name, I32 create)
1412 Found in file handy.h
1417 Returns a pointer to the stash for a specified package. See C<gv_stashpvn>.
1419 HV* gv_stashsv(SV* sv, I32 flags)
1436 (deprecated - use C<(AV *)NULL> instead)
1444 Null character pointer. (No longer available when C<PERL_CORE> is defined.)
1447 Found in file handy.h
1454 (deprecated - use C<(CV *)NULL> instead)
1464 (deprecated - use C<(HV *)NULL> instead)
1472 Null SV pointer. (No longer available when C<PERL_CORE> is defined.)
1475 Found in file handy.h
1480 =head1 Hash Manipulation Functions
1487 Returns the HV of the specified Perl hash. If C<create> is set and the
1488 Perl variable does not exist then it will be created. If C<create> is not
1489 set and the variable does not exist then NULL is returned.
1491 NOTE: the perl_ form of this function is deprecated.
1493 HV* get_hv(const char* name, I32 create)
1496 Found in file perl.c
1501 This flag, used in the length slot of hash entries and magic structures,
1502 specifies the structure contains an C<SV*> pointer where a C<char*> pointer
1503 is to be expected. (For information only--not to be used).
1511 Returns the computed hash stored in the hash entry.
1521 Returns the actual pointer stored in the key slot of the hash entry. The
1522 pointer may be either C<char*> or C<SV*>, depending on the value of
1523 C<HeKLEN()>. Can be assigned to. The C<HePV()> or C<HeSVKEY()> macros are
1524 usually preferable for finding the value of a key.
1534 If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry
1535 holds an C<SV*> key. Otherwise, holds the actual length of the key. Can
1536 be assigned to. The C<HePV()> macro is usually preferable for finding key
1539 STRLEN HeKLEN(HE* he)
1547 Returns the key slot of the hash entry as a C<char*> value, doing any
1548 necessary dereferencing of possibly C<SV*> keys. The length of the string
1549 is placed in C<len> (this is a macro, so do I<not> use C<&len>). If you do
1550 not care about what the length of the key is, you may use the global
1551 variable C<PL_na>, though this is rather less efficient than using a local
1552 variable. Remember though, that hash keys in perl are free to contain
1553 embedded nulls, so using C<strlen()> or similar is not a good way to find
1554 the length of hash keys. This is very similar to the C<SvPV()> macro
1555 described elsewhere in this document. See also C<HeUTF8>.
1557 If you are using C<HePV> to get values to pass to C<newSVpvn()> to create a
1558 new SV, you should consider using C<newSVhek(HeKEY_hek(he))> as it is more
1561 char* HePV(HE* he, STRLEN len)
1569 Returns the key as an C<SV*>, or C<NULL> if the hash entry does not
1570 contain an C<SV*> key.
1580 Returns the key as an C<SV*>. Will create and return a temporary mortal
1581 C<SV*> if the hash entry contains only a C<char*> key.
1583 SV* HeSVKEY_force(HE* he)
1591 Sets the key to a given C<SV*>, taking care to set the appropriate flags to
1592 indicate the presence of an C<SV*> key, and returns the same
1595 SV* HeSVKEY_set(HE* he, SV* sv)
1603 Returns whether the C<char *> value returned by C<HePV> is encoded in UTF-8,
1604 doing any necessary dereferencing of possibly C<SV*> keys. The value returned
1605 will be 0 or non-0, not necessarily 1 (or even a value with any low bits set),
1606 so B<do not> blindly assign this to a C<bool> variable, as C<bool> may be a
1607 typedef for C<char>.
1609 char* HeUTF8(HE* he, STRLEN len)
1617 Returns the value slot (type C<SV*>) stored in the hash entry.
1627 Returns the package name of a stash, or NULL if C<stash> isn't a stash.
1628 See C<SvSTASH>, C<CvSTASH>.
1630 char* HvNAME(HV* stash)
1638 Check that a hash is in an internally consistent state.
1640 void hv_assert(HV *hv)
1648 Clears a hash, making it empty.
1650 void hv_clear(HV *hv)
1655 =item hv_clear_placeholders
1656 X<hv_clear_placeholders>
1658 Clears any placeholders from a hash. If a restricted hash has any of its keys
1659 marked as readonly and the key is subsequently deleted, the key is not actually
1660 deleted but is marked by assigning it a value of &PL_sv_placeholder. This tags
1661 it so it will be ignored by future operations such as iterating over the hash,
1662 but will still allow the hash to have a value reassigned to the key at some
1663 future point. This function clears any such placeholder keys from the hash.
1664 See Hash::Util::lock_keys() for an example of its use.
1666 void hv_clear_placeholders(HV *hv)
1674 Deletes a key/value pair in the hash. The value SV is removed from the
1675 hash and returned to the caller. The C<klen> is the length of the key.
1676 The C<flags> value will normally be zero; if set to G_DISCARD then NULL
1679 SV* hv_delete(HV *hv, const char *key, I32 klen, I32 flags)
1687 Deletes a key/value pair in the hash. The value SV is removed from the
1688 hash and returned to the caller. The C<flags> value will normally be zero;
1689 if set to G_DISCARD then NULL will be returned. C<hash> can be a valid
1690 precomputed hash value, or 0 to ask for it to be computed.
1692 SV* hv_delete_ent(HV *hv, SV *keysv, I32 flags, U32 hash)
1700 Returns a boolean indicating whether the specified hash key exists. The
1701 C<klen> is the length of the key.
1703 bool hv_exists(HV *hv, const char *key, I32 klen)
1711 Returns a boolean indicating whether the specified hash key exists. C<hash>
1712 can be a valid precomputed hash value, or 0 to ask for it to be
1715 bool hv_exists_ent(HV *hv, SV *keysv, U32 hash)
1723 Returns the SV which corresponds to the specified key in the hash. The
1724 C<klen> is the length of the key. If C<lval> is set then the fetch will be
1725 part of a store. Check that the return value is non-null before
1726 dereferencing it to an C<SV*>.
1728 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1729 information on how to use this function on tied hashes.
1731 SV** hv_fetch(HV *hv, const char *key, I32 klen, I32 lval)
1739 Like C<hv_fetch>, but takes a literal string instead of a string/length pair.
1741 SV** hv_fetchs(HV* tb, const char* key, I32 lval)
1744 Found in file handy.h
1749 Returns the hash entry which corresponds to the specified key in the hash.
1750 C<hash> must be a valid precomputed hash number for the given C<key>, or 0
1751 if you want the function to compute it. IF C<lval> is set then the fetch
1752 will be part of a store. Make sure the return value is non-null before
1753 accessing it. The return value when C<tb> is a tied hash is a pointer to a
1754 static location, so be sure to make a copy of the structure if you need to
1757 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1758 information on how to use this function on tied hashes.
1760 HE* hv_fetch_ent(HV *hv, SV *keysv, I32 lval, U32 hash)
1768 Prepares a starting point to traverse a hash table. Returns the number of
1769 keys in the hash (i.e. the same as C<HvKEYS(tb)>). The return value is
1770 currently only meaningful for hashes without tie magic.
1772 NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
1773 hash buckets that happen to be in use. If you still need that esoteric
1774 value, you can get it through the macro C<HvFILL(tb)>.
1777 I32 hv_iterinit(HV *hv)
1785 Returns the key from the current position of the hash iterator. See
1788 char* hv_iterkey(HE* entry, I32* retlen)
1796 Returns the key as an C<SV*> from the current position of the hash
1797 iterator. The return value will always be a mortal copy of the key. Also
1800 SV* hv_iterkeysv(HE* entry)
1808 Returns entries from a hash iterator. See C<hv_iterinit>.
1810 You may call C<hv_delete> or C<hv_delete_ent> on the hash entry that the
1811 iterator currently points to, without losing your place or invalidating your
1812 iterator. Note that in this case the current entry is deleted from the hash
1813 with your iterator holding the last reference to it. Your iterator is flagged
1814 to free the entry on the next call to C<hv_iternext>, so you must not discard
1815 your iterator immediately else the entry will leak - call C<hv_iternext> to
1816 trigger the resource deallocation.
1818 HE* hv_iternext(HV *hv)
1826 Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
1829 SV* hv_iternextsv(HV *hv, char **key, I32 *retlen)
1834 =item hv_iternext_flags
1835 X<hv_iternext_flags>
1837 Returns entries from a hash iterator. See C<hv_iterinit> and C<hv_iternext>.
1838 The C<flags> value will normally be zero; if HV_ITERNEXT_WANTPLACEHOLDERS is
1839 set the placeholders keys (for restricted hashes) will be returned in addition
1840 to normal keys. By default placeholders are automatically skipped over.
1841 Currently a placeholder is implemented with a value that is
1842 C<&Perl_sv_placeholder>. Note that the implementation of placeholders and
1843 restricted hashes may change, and the implementation currently is
1844 insufficiently abstracted for any change to be tidy.
1846 NOTE: this function is experimental and may change or be
1847 removed without notice.
1849 HE* hv_iternext_flags(HV *hv, I32 flags)
1857 Returns the value from the current position of the hash iterator. See
1860 SV* hv_iterval(HV *hv, HE *entry)
1868 Adds magic to a hash. See C<sv_magic>.
1870 void hv_magic(HV *hv, GV *gv, int how)
1878 Evaluates the hash in scalar context and returns the result. Handles magic when the hash is tied.
1880 SV* hv_scalar(HV *hv)
1888 Stores an SV in a hash. The hash key is specified as C<key> and C<klen> is
1889 the length of the key. The C<hash> parameter is the precomputed hash
1890 value; if it is zero then Perl will compute it. The return value will be
1891 NULL if the operation failed or if the value did not need to be actually
1892 stored within the hash (as in the case of tied hashes). Otherwise it can
1893 be dereferenced to get the original C<SV*>. Note that the caller is
1894 responsible for suitably incrementing the reference count of C<val> before
1895 the call, and decrementing it if the function returned NULL. Effectively
1896 a successful hv_store takes ownership of one reference to C<val>. This is
1897 usually what you want; a newly created SV has a reference count of one, so
1898 if all your code does is create SVs then store them in a hash, hv_store
1899 will own the only reference to the new SV, and your code doesn't need to do
1900 anything further to tidy up. hv_store is not implemented as a call to
1901 hv_store_ent, and does not create a temporary SV for the key, so if your
1902 key data is not already in SV form then use hv_store in preference to
1905 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1906 information on how to use this function on tied hashes.
1908 SV** hv_store(HV *hv, const char *key, I32 klen, SV *val, U32 hash)
1916 Like C<hv_store>, but takes a literal string instead of a string/length pair
1917 and omits the hash parameter.
1919 SV** hv_stores(HV* tb, const char* key, NULLOK SV* val)
1922 Found in file handy.h
1927 Stores C<val> in a hash. The hash key is specified as C<key>. The C<hash>
1928 parameter is the precomputed hash value; if it is zero then Perl will
1929 compute it. The return value is the new hash entry so created. It will be
1930 NULL if the operation failed or if the value did not need to be actually
1931 stored within the hash (as in the case of tied hashes). Otherwise the
1932 contents of the return value can be accessed using the C<He?> macros
1933 described here. Note that the caller is responsible for suitably
1934 incrementing the reference count of C<val> before the call, and
1935 decrementing it if the function returned NULL. Effectively a successful
1936 hv_store_ent takes ownership of one reference to C<val>. This is
1937 usually what you want; a newly created SV has a reference count of one, so
1938 if all your code does is create SVs then store them in a hash, hv_store
1939 will own the only reference to the new SV, and your code doesn't need to do
1940 anything further to tidy up. Note that hv_store_ent only reads the C<key>;
1941 unlike C<val> it does not take ownership of it, so maintaining the correct
1942 reference count on C<key> is entirely the caller's responsibility. hv_store
1943 is not implemented as a call to hv_store_ent, and does not create a temporary
1944 SV for the key, so if your key data is not already in SV form then use
1945 hv_store in preference to hv_store_ent.
1947 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1948 information on how to use this function on tied hashes.
1950 HE* hv_store_ent(HV *hv, SV *key, SV *val, U32 hash)
1960 void hv_undef(HV *hv)
1968 Creates a new HV. The reference count is set to 1.
1978 =head1 Magical Functions
1985 Clear something magical that the SV represents. See C<sv_magic>.
1987 int mg_clear(SV* sv)
1995 Copies the magic from one SV to another. See C<sv_magic>.
1997 int mg_copy(SV *sv, SV *nsv, const char *key, I32 klen)
2005 Finds the magic pointer for type matching the SV. See C<sv_magic>.
2007 MAGIC* mg_find(const SV* sv, int type)
2015 Free any magic storage used by the SV. See C<sv_magic>.
2025 Do magic after a value is retrieved from the SV. See C<sv_magic>.
2035 Report on the SV's length. See C<sv_magic>.
2037 U32 mg_length(SV* sv)
2045 Turns on the magical status of an SV. See C<sv_magic>.
2047 void mg_magical(SV* sv)
2055 Do magic after a value is assigned to the SV. See C<sv_magic>.
2065 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
2066 argument more than once.
2068 void SvGETMAGIC(SV* sv)
2076 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
2087 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
2088 argument more than once.
2090 void SvSETMAGIC(SV* sv)
2098 Like C<SvSetSV>, but does any set magic required afterwards.
2100 void SvSetMagicSV(SV* dsb, SV* ssv)
2105 =item SvSetMagicSV_nosteal
2106 X<SvSetMagicSV_nosteal>
2108 Like C<SvSetSV_nosteal>, but does any set magic required afterwards.
2110 void SvSetMagicSV_nosteal(SV* dsv, SV* ssv)
2118 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
2121 void SvSetSV(SV* dsb, SV* ssv)
2126 =item SvSetSV_nosteal
2129 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
2130 ssv. May evaluate arguments more than once.
2132 void SvSetSV_nosteal(SV* dsv, SV* ssv)
2140 Arranges for sv to be shared between threads if a suitable module
2143 void SvSHARE(SV* sv)
2151 Releases a mutual exclusion lock on sv if a suitable module
2154 void SvUNLOCK(SV* sv)
2162 =head1 Memory Management
2169 The XSUB-writer's interface to the C C<memcpy> function. The C<src> is the
2170 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
2171 the type. May fail on overlapping copies. See also C<Move>.
2173 void Copy(void* src, void* dest, int nitems, type)
2176 Found in file handy.h
2181 Like C<Copy> but returns dest. Useful for encouraging compilers to tail-call
2184 void * CopyD(void* src, void* dest, int nitems, type)
2187 Found in file handy.h
2192 The XSUB-writer's interface to the C C<memmove> function. The C<src> is the
2193 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
2194 the type. Can do overlapping moves. See also C<Copy>.
2196 void Move(void* src, void* dest, int nitems, type)
2199 Found in file handy.h
2204 Like C<Move> but returns dest. Useful for encouraging compilers to tail-call
2207 void * MoveD(void* src, void* dest, int nitems, type)
2210 Found in file handy.h
2215 The XSUB-writer's interface to the C C<malloc> function.
2217 In 5.9.3, Newx() and friends replace the older New() API, and drops
2218 the first parameter, I<x>, a debug aid which allowed callers to identify
2219 themselves. This aid has been superseded by a new build option,
2220 PERL_MEM_LOG (see L<perlhack/PERL_MEM_LOG>). The older API is still
2221 there for use in XS modules supporting older perls.
2223 void Newx(void* ptr, int nitems, type)
2226 Found in file handy.h
2231 The XSUB-writer's interface to the C C<malloc> function, with
2232 cast. See also C<Newx>.
2234 void Newxc(void* ptr, int nitems, type, cast)
2237 Found in file handy.h
2242 The XSUB-writer's interface to the C C<malloc> function. The allocated
2243 memory is zeroed with C<memzero>. See also C<Newx>.
2245 void Newxz(void* ptr, int nitems, type)
2248 Found in file handy.h
2253 PoisonWith(0xEF) for catching access to freed memory.
2255 void Poison(void* dest, int nitems, type)
2258 Found in file handy.h
2263 PoisonWith(0xEF) for catching access to freed memory.
2265 void PoisonFree(void* dest, int nitems, type)
2268 Found in file handy.h
2273 PoisonWith(0xAB) for catching access to allocated but uninitialized memory.
2275 void PoisonNew(void* dest, int nitems, type)
2278 Found in file handy.h
2283 Fill up memory with a byte pattern (a byte repeated over and over
2284 again) that hopefully catches attempts to access uninitialized memory.
2286 void PoisonWith(void* dest, int nitems, type, U8 byte)
2289 Found in file handy.h
2294 The XSUB-writer's interface to the C C<realloc> function.
2296 void Renew(void* ptr, int nitems, type)
2299 Found in file handy.h
2304 The XSUB-writer's interface to the C C<realloc> function, with
2307 void Renewc(void* ptr, int nitems, type, cast)
2310 Found in file handy.h
2315 The XSUB-writer's interface to the C C<free> function.
2317 void Safefree(void* ptr)
2320 Found in file handy.h
2325 Perl's version of C<strdup()>. Returns a pointer to a newly allocated
2326 string which is a duplicate of C<pv>. The size of the string is
2327 determined by C<strlen()>. The memory allocated for the new string can
2328 be freed with the C<Safefree()> function.
2330 char* savepv(const char* pv)
2333 Found in file util.c
2338 Perl's version of what C<strndup()> would be if it existed. Returns a
2339 pointer to a newly allocated string which is a duplicate of the first
2340 C<len> bytes from C<pv>, plus a trailing NUL byte. The memory allocated for
2341 the new string can be freed with the C<Safefree()> function.
2343 char* savepvn(const char* pv, I32 len)
2346 Found in file util.c
2351 Like C<savepvn>, but takes a literal string instead of a string/length pair.
2353 char* savepvs(const char* s)
2356 Found in file handy.h
2361 A version of C<savepv()> which allocates the duplicate string in memory
2362 which is shared between threads.
2364 char* savesharedpv(const char* pv)
2367 Found in file util.c
2372 A version of C<savepvn()> which allocates the duplicate string in memory
2373 which is shared between threads. (With the specific difference that a NULL
2374 pointer is not acceptable)
2376 char* savesharedpvn(const char *const pv, const STRLEN len)
2379 Found in file util.c
2384 A version of C<savepv()>/C<savepvn()> which gets the string to duplicate from
2385 the passed in SV using C<SvPV()>
2387 char* savesvpv(SV* sv)
2390 Found in file util.c
2395 This is an architecture-independent macro to copy one structure to another.
2397 void StructCopy(type src, type dest, type)
2400 Found in file handy.h
2405 The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the
2406 destination, C<nitems> is the number of items, and C<type> is the type.
2408 void Zero(void* dest, int nitems, type)
2411 Found in file handy.h
2416 Like C<Zero> but returns dest. Useful for encouraging compilers to tail-call
2419 void * ZeroD(void* dest, int nitems, type)
2422 Found in file handy.h
2427 =head1 Miscellaneous Functions
2434 Analyses the string in order to make fast searches on it using fbm_instr()
2435 -- the Boyer-Moore algorithm.
2437 void fbm_compile(SV* sv, U32 flags)
2440 Found in file util.c
2445 Returns the location of the SV in the string delimited by C<str> and
2446 C<strend>. It returns C<NULL> if the string can't be found. The C<sv>
2447 does not have to be fbm_compiled, but the search will not be as fast
2450 char* fbm_instr(unsigned char* big, unsigned char* bigend, SV* littlestr, U32 flags)
2453 Found in file util.c
2458 Takes a sprintf-style format pattern and conventional
2459 (non-SV) arguments and returns the formatted string.
2461 (char *) Perl_form(pTHX_ const char* pat, ...)
2463 can be used any place a string (char *) is required:
2465 char * s = Perl_form("%d.%d",major,minor);
2467 Uses a single private buffer so if you want to format several strings you
2468 must explicitly copy the earlier strings away (and free the copies when you
2471 char* form(const char* pat, ...)
2474 Found in file util.c
2479 Fill the sv with current working directory
2481 int getcwd_sv(SV* sv)
2484 Found in file util.c
2489 The C library C<snprintf> functionality, if available and
2490 standards-compliant (uses C<vsnprintf>, actually). However, if the
2491 C<vsnprintf> is not available, will unfortunately use the unsafe
2492 C<vsprintf> which can overrun the buffer (there is an overrun check,
2493 but that may be too late). Consider using C<sv_vcatpvf> instead, or
2494 getting C<vsnprintf>.
2496 int my_snprintf(char *buffer, const Size_t len, const char *format, ...)
2499 Found in file util.c
2504 The C library C<sprintf>, wrapped if necessary, to ensure that it will return
2505 the length of the string written to the buffer. Only rare pre-ANSI systems
2506 need the wrapper function - usually this is a direct call to C<sprintf>.
2508 int my_sprintf(char *buffer, const char *pat, ...)
2511 Found in file util.c
2516 The C library C<vsnprintf> if available and standards-compliant.
2517 However, if if the C<vsnprintf> is not available, will unfortunately
2518 use the unsafe C<vsprintf> which can overrun the buffer (there is an
2519 overrun check, but that may be too late). Consider using
2520 C<sv_vcatpvf> instead, or getting C<vsnprintf>.
2522 int my_vsnprintf(char *buffer, const Size_t len, const char *format, va_list ap)
2525 Found in file util.c
2530 Returns a new version object based on the passed in SV:
2532 SV *sv = new_version(SV *ver);
2534 Does not alter the passed in ver SV. See "upg_version" if you
2535 want to upgrade the SV.
2537 SV* new_version(SV *ver)
2540 Found in file util.c
2545 Returns a pointer to the next character after the parsed
2546 version string, as well as upgrading the passed in SV to
2549 Function must be called with an already existing SV like
2552 s = scan_version(s, SV *sv, bool qv);
2554 Performs some preprocessing to the string to ensure that
2555 it has the correct characteristics of a version. Flags the
2556 object if it contains an underscore (which denotes this
2557 is an alpha version). The boolean qv denotes that the version
2558 should be interpreted as if it had multiple decimals, even if
2561 const char* scan_version(const char *s, SV *rv, bool qv)
2564 Found in file util.c
2569 Test two strings to see if they are equal. Returns true or false.
2571 bool strEQ(char* s1, char* s2)
2574 Found in file handy.h
2579 Test two strings to see if the first, C<s1>, is greater than or equal to
2580 the second, C<s2>. Returns true or false.
2582 bool strGE(char* s1, char* s2)
2585 Found in file handy.h
2590 Test two strings to see if the first, C<s1>, is greater than the second,
2591 C<s2>. Returns true or false.
2593 bool strGT(char* s1, char* s2)
2596 Found in file handy.h
2601 Test two strings to see if the first, C<s1>, is less than or equal to the
2602 second, C<s2>. Returns true or false.
2604 bool strLE(char* s1, char* s2)
2607 Found in file handy.h
2612 Test two strings to see if the first, C<s1>, is less than the second,
2613 C<s2>. Returns true or false.
2615 bool strLT(char* s1, char* s2)
2618 Found in file handy.h
2623 Test two strings to see if they are different. Returns true or
2626 bool strNE(char* s1, char* s2)
2629 Found in file handy.h
2634 Test two strings to see if they are equal. The C<len> parameter indicates
2635 the number of bytes to compare. Returns true or false. (A wrapper for
2638 bool strnEQ(char* s1, char* s2, STRLEN len)
2641 Found in file handy.h
2646 Test two strings to see if they are different. The C<len> parameter
2647 indicates the number of bytes to compare. Returns true or false. (A
2648 wrapper for C<strncmp>).
2650 bool strnNE(char* s1, char* s2, STRLEN len)
2653 Found in file handy.h
2655 =item sv_destroyable
2658 Dummy routine which reports that object can be destroyed when there is no
2659 sharing module present. It ignores its single SV argument, and returns
2660 'true'. Exists to avoid test for a NULL function pointer and because it
2661 could potentially warn under some level of strict-ness.
2663 bool sv_destroyable(SV *sv)
2666 Found in file util.c
2671 Dummy routine which "shares" an SV when there is no sharing module present.
2672 Or "locks" it. Or "unlocks" it. In other words, ignores its single SV argument.
2673 Exists to avoid test for a NULL function pointer and because it could
2674 potentially warn under some level of strict-ness.
2676 void sv_nosharing(SV *sv)
2679 Found in file util.c
2684 In-place upgrade of the supplied SV to a version object.
2686 SV *sv = upg_version(SV *sv, bool qv);
2688 Returns a pointer to the upgraded SV. Set the boolean qv if you want
2689 to force this SV to be interpreted as an "extended" version.
2691 SV* upg_version(SV *ver, bool qv)
2694 Found in file util.c
2699 Version object aware cmp. Both operands must already have been
2700 converted into version objects.
2702 int vcmp(SV *lhv, SV *rhv)
2705 Found in file util.c
2710 Accepts a version object and returns the normalized string
2711 representation. Call like:
2715 NOTE: you can pass either the object directly or the SV
2716 contained within the RV.
2721 Found in file util.c
2726 Accepts a version object and returns the normalized floating
2727 point representation. Call like:
2731 NOTE: you can pass either the object directly or the SV
2732 contained within the RV.
2737 Found in file util.c
2742 In order to maintain maximum compatibility with earlier versions
2743 of Perl, this function will return either the floating point
2744 notation or the multiple dotted notation, depending on whether
2745 the original version contained 1 or more dots, respectively
2747 SV* vstringify(SV *vs)
2750 Found in file util.c
2755 Validates that the SV contains a valid version object.
2757 bool vverify(SV *vobj);
2759 Note that it only confirms the bare minimum structure (so as not to get
2760 confused by derived classes which may contain additional hash entries):
2762 bool vverify(SV *vs)
2765 Found in file util.c
2770 =head1 MRO Functions
2774 =item mro_get_linear_isa
2775 X<mro_get_linear_isa>
2777 Returns either C<mro_get_linear_isa_c3> or
2778 C<mro_get_linear_isa_dfs> for the given stash,
2779 dependant upon which MRO is in effect
2780 for that stash. The return value is a
2783 You are responsible for C<SvREFCNT_inc()> on the
2784 return value if you plan to store it anywhere
2785 semi-permanently (otherwise it might be deleted
2786 out from under you the next time the cache is
2789 AV* mro_get_linear_isa(HV* stash)
2794 =item mro_method_changed_in
2795 X<mro_method_changed_in>
2797 Invalidates method caching on any child classes
2798 of the given stash, so that they might notice
2799 the changes in this one.
2801 Ideally, all instances of C<PL_sub_generation++> in
2802 perl source outside of C<mro.c> should be
2803 replaced by calls to this.
2805 Perl automatically handles most of the common
2806 ways a method might be redefined. However, there
2807 are a few ways you could change a method in a stash
2808 without the cache code noticing, in which case you
2809 need to call this method afterwards:
2811 1) Directly manipulating the stash HV entries from
2814 2) Assigning a reference to a readonly scalar
2815 constant into a stash entry in order to create
2816 a constant subroutine (like constant.pm
2819 This same method is available from pure perl
2820 via, C<mro::method_changed_in(classname)>.
2822 void mro_method_changed_in(HV* stash)
2830 =head1 Multicall Functions
2837 Declare local variables for a multicall. See L<perlcall/Lightweight Callbacks>.
2847 Make a lightweight callback. See L<perlcall/Lightweight Callbacks>.
2857 Closing bracket for a lightweight callback.
2858 See L<perlcall/Lightweight Callbacks>.
2865 =item PUSH_MULTICALL
2868 Opening bracket for a lightweight callback.
2869 See L<perlcall/Lightweight Callbacks>.
2879 =head1 Numeric functions
2886 converts a string representing a binary number to numeric form.
2888 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2889 conversion flags, and I<result> should be NULL or a pointer to an NV.
2890 The scan stops at the end of the string, or the first invalid character.
2891 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2892 invalid character will also trigger a warning.
2893 On return I<*len> is set to the length of the scanned string,
2894 and I<*flags> gives output flags.
2896 If the value is <= C<UV_MAX> it is returned as a UV, the output flags are clear,
2897 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_bin>
2898 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2899 and writes the value to I<*result> (or the value is discarded if I<result>
2902 The binary number may optionally be prefixed with "0b" or "b" unless
2903 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
2904 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the binary
2905 number may use '_' characters to separate digits.
2907 UV grok_bin(const char* start, STRLEN* len_p, I32* flags, NV *result)
2910 Found in file numeric.c
2915 converts a string representing a hex number to numeric form.
2917 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2918 conversion flags, and I<result> should be NULL or a pointer to an NV.
2919 The scan stops at the end of the string, or the first invalid character.
2920 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2921 invalid character will also trigger a warning.
2922 On return I<*len> is set to the length of the scanned string,
2923 and I<*flags> gives output flags.
2925 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2926 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_hex>
2927 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2928 and writes the value to I<*result> (or the value is discarded if I<result>
2931 The hex number may optionally be prefixed with "0x" or "x" unless
2932 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
2933 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the hex
2934 number may use '_' characters to separate digits.
2936 UV grok_hex(const char* start, STRLEN* len_p, I32* flags, NV *result)
2939 Found in file numeric.c
2944 Recognise (or not) a number. The type of the number is returned
2945 (0 if unrecognised), otherwise it is a bit-ORed combination of
2946 IS_NUMBER_IN_UV, IS_NUMBER_GREATER_THAN_UV_MAX, IS_NUMBER_NOT_INT,
2947 IS_NUMBER_NEG, IS_NUMBER_INFINITY, IS_NUMBER_NAN (defined in perl.h).
2949 If the value of the number can fit an in UV, it is returned in the *valuep
2950 IS_NUMBER_IN_UV will be set to indicate that *valuep is valid, IS_NUMBER_IN_UV
2951 will never be set unless *valuep is valid, but *valuep may have been assigned
2952 to during processing even though IS_NUMBER_IN_UV is not set on return.
2953 If valuep is NULL, IS_NUMBER_IN_UV will be set for the same cases as when
2954 valuep is non-NULL, but no actual assignment (or SEGV) will occur.
2956 IS_NUMBER_NOT_INT will be set with IS_NUMBER_IN_UV if trailing decimals were
2957 seen (in which case *valuep gives the true value truncated to an integer), and
2958 IS_NUMBER_NEG if the number is negative (in which case *valuep holds the
2959 absolute value). IS_NUMBER_IN_UV is not set if e notation was used or the
2960 number is larger than a UV.
2962 int grok_number(const char *pv, STRLEN len, UV *valuep)
2965 Found in file numeric.c
2967 =item grok_numeric_radix
2968 X<grok_numeric_radix>
2970 Scan and skip for a numeric decimal separator (radix).
2972 bool grok_numeric_radix(const char **sp, const char *send)
2975 Found in file numeric.c
2980 converts a string representing an octal number to numeric form.
2982 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2983 conversion flags, and I<result> should be NULL or a pointer to an NV.
2984 The scan stops at the end of the string, or the first invalid character.
2985 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2986 invalid character will also trigger a warning.
2987 On return I<*len> is set to the length of the scanned string,
2988 and I<*flags> gives output flags.
2990 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2991 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_oct>
2992 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2993 and writes the value to I<*result> (or the value is discarded if I<result>
2996 If C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the octal
2997 number may use '_' characters to separate digits.
2999 UV grok_oct(const char* start, STRLEN* len_p, I32* flags, NV *result)
3002 Found in file numeric.c
3007 Return a non-zero integer if the sign bit on an NV is set, and 0 if
3010 If Configure detects this system has a signbit() that will work with
3011 our NVs, then we just use it via the #define in perl.h. Otherwise,
3012 fall back on this implementation. As a first pass, this gets everything
3013 right except -0.0. Alas, catching -0.0 is the main use for this function,
3014 so this is not too helpful yet. Still, at least we have the scaffolding
3015 in place to support other systems, should that prove useful.
3018 Configure notes: This function is called 'Perl_signbit' instead of a
3019 plain 'signbit' because it is easy to imagine a system having a signbit()
3020 function or macro that doesn't happen to work with our particular choice
3021 of NVs. We shouldn't just re-#define signbit as Perl_signbit and expect
3022 the standard system headers to be happy. Also, this is a no-context
3023 function (no pTHX_) because Perl_signbit() is usually re-#defined in
3024 perl.h as a simple macro call to the system's signbit().
3025 Users should just always call Perl_signbit().
3027 NOTE: this function is experimental and may change or be
3028 removed without notice.
3030 int Perl_signbit(NV f)
3033 Found in file numeric.c
3038 For backwards compatibility. Use C<grok_bin> instead.
3040 NV scan_bin(const char* start, STRLEN len, STRLEN* retlen)
3043 Found in file numeric.c
3048 For backwards compatibility. Use C<grok_hex> instead.
3050 NV scan_hex(const char* start, STRLEN len, STRLEN* retlen)
3053 Found in file numeric.c
3058 For backwards compatibility. Use C<grok_oct> instead.
3060 NV scan_oct(const char* start, STRLEN len, STRLEN* retlen)
3063 Found in file numeric.c
3068 =head1 Optree Manipulation Functions
3075 If C<cv> is a constant sub eligible for inlining. returns the constant
3076 value returned by the sub. Otherwise, returns NULL.
3078 Constant subs can be created with C<newCONSTSUB> or as described in
3079 L<perlsub/"Constant Functions">.
3081 SV* cv_const_sv(const CV *const cv)
3089 Creates a constant sub equivalent to Perl C<sub FOO () { 123 }> which is
3090 eligible for inlining at compile-time.
3092 CV* newCONSTSUB(HV* stash, const char* name, SV* sv)
3100 Used by C<xsubpp> to hook up XSUBs as Perl subs. I<filename> needs to be
3101 static storage, as it is used directly as CvFILE(), without a copy being made.
3109 =head1 Pad Data Structures
3116 Get the value at offset po in the current pad.
3117 Use macro PAD_SV instead of calling this function directly.
3119 SV* pad_sv(PADOFFSET po)
3127 =head1 Per-Interpreter Variables
3134 C<PL_modglobal> is a general purpose, interpreter global HV for use by
3135 extensions that need to keep information on a per-interpreter basis.
3136 In a pinch, it can also be used as a symbol table for extensions
3137 to share data among each other. It is a good idea to use keys
3138 prefixed by the package name of the extension that owns the data.
3143 Found in file intrpvar.h
3148 A convenience variable which is typically used with C<SvPV> when one
3149 doesn't care about the length of the string. It is usually more efficient
3150 to either declare a local variable and use that instead or to use the
3151 C<SvPV_nolen> macro.
3156 Found in file intrpvar.h
3161 This is the C<false> SV. See C<PL_sv_yes>. Always refer to this as
3167 Found in file intrpvar.h
3172 This is the C<undef> SV. Always refer to this as C<&PL_sv_undef>.
3177 Found in file intrpvar.h
3182 This is the C<true> SV. See C<PL_sv_no>. Always refer to this as
3188 Found in file intrpvar.h
3193 =head1 REGEXP Functions
3200 Convenience macro to get the REGEXP from a SV. This is approximately
3201 equivalent to the following snippet:
3206 (tmpsv = (SV*)SvRV(sv)) &&
3207 SvTYPE(tmpsv) == SVt_PVMG &&
3208 (tmpmg = mg_find(tmpsv, PERL_MAGIC_qr)))
3210 return (REGEXP *)tmpmg->mg_obj;
3213 NULL will be returned if a REGEXP* is not found.
3215 REGEXP * SvRX(SV *sv)
3218 Found in file regexp.h
3223 Returns a boolean indicating whether the SV contains qr magic
3226 If you want to do something with the REGEXP* later use SvRX instead
3232 Found in file regexp.h
3237 =head1 Simple Exception Handling Macros
3244 Set up necessary local variables for exception handling.
3245 See L<perlguts/"Exception Handling">.
3250 Found in file XSUB.h
3255 Introduces a catch block. See L<perlguts/"Exception Handling">.
3258 Found in file XSUB.h
3263 Rethrows a previously caught exception. See L<perlguts/"Exception Handling">.
3268 Found in file XSUB.h
3273 Ends a try block. See L<perlguts/"Exception Handling">.
3276 Found in file XSUB.h
3278 =item XCPT_TRY_START
3281 Starts a try block. See L<perlguts/"Exception Handling">.
3284 Found in file XSUB.h
3289 =head1 Stack Manipulation Macros
3296 Declare a stack marker variable, C<mark>, for the XSUB. See C<MARK> and
3307 Saves the original stack mark for the XSUB. See C<ORIGMARK>.
3317 Declares a local copy of perl's stack pointer for the XSUB, available via
3318 the C<SP> macro. See C<SP>.
3328 Used to extend the argument stack for an XSUB's return values. Once
3329 used, guarantees that there is room for at least C<nitems> to be pushed
3332 void EXTEND(SP, int nitems)
3340 Stack marker variable for the XSUB. See C<dMARK>.
3348 Push an integer onto the stack. The stack must have room for this element.
3349 Does not use C<TARG>. See also C<PUSHi>, C<mXPUSHi> and C<XPUSHi>.
3359 Push a double onto the stack. The stack must have room for this element.
3360 Does not use C<TARG>. See also C<PUSHn>, C<mXPUSHn> and C<XPUSHn>.
3370 Push a string onto the stack. The stack must have room for this element.
3371 The C<len> indicates the length of the string. Does not use C<TARG>.
3372 See also C<PUSHp>, C<mXPUSHp> and C<XPUSHp>.
3374 void mPUSHp(char* str, STRLEN len)
3382 Push an SV onto the stack and mortalizes the SV. The stack must have room
3383 for this element. Does not use C<TARG>. See also C<PUSHs> and C<mXPUSHs>.
3393 Push an unsigned integer onto the stack. The stack must have room for this
3394 element. Does not use C<TARG>. See also C<PUSHu>, C<mXPUSHu> and C<XPUSHu>.
3404 Push an integer onto the stack, extending the stack if necessary.
3405 Does not use C<TARG>. See also C<XPUSHi>, C<mPUSHi> and C<PUSHi>.
3415 Push a double onto the stack, extending the stack if necessary.
3416 Does not use C<TARG>. See also C<XPUSHn>, C<mPUSHn> and C<PUSHn>.
3426 Push a string onto the stack, extending the stack if necessary. The C<len>
3427 indicates the length of the string. Does not use C<TARG>. See also C<XPUSHp>,
3428 C<mPUSHp> and C<PUSHp>.
3430 void mXPUSHp(char* str, STRLEN len)
3438 Push an SV onto the stack, extending the stack if necessary and mortalizes
3439 the SV. Does not use C<TARG>. See also C<XPUSHs> and C<mPUSHs>.
3441 void mXPUSHs(SV* sv)
3449 Push an unsigned integer onto the stack, extending the stack if necessary.
3450 Does not use C<TARG>. See also C<XPUSHu>, C<mPUSHu> and C<PUSHu>.
3460 The original stack mark for the XSUB. See C<dORIGMARK>.
3468 Pops an integer off the stack.
3478 Pops a long off the stack.
3488 Pops a double off the stack.
3498 Pops a string off the stack. Deprecated. New code should use POPpx.
3508 Pops a string off the stack which must consist of bytes i.e. characters < 256.
3518 Pops a string off the stack.
3528 Pops an SV off the stack.
3538 Push an integer onto the stack. The stack must have room for this element.
3539 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3540 called to declare it. Do not call multiple C<TARG>-oriented macros to
3541 return lists from XSUB's - see C<mPUSHi> instead. See also C<XPUSHi> and
3552 Opening bracket for arguments on a callback. See C<PUTBACK> and
3563 Push a new mortal SV onto the stack. The stack must have room for this
3564 element. Does not use C<TARG>. See also C<PUSHs>, C<XPUSHmortal> and C<XPUSHs>.
3574 Push a double onto the stack. The stack must have room for this element.
3575 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3576 called to declare it. Do not call multiple C<TARG>-oriented macros to
3577 return lists from XSUB's - see C<mPUSHn> instead. See also C<XPUSHn> and
3588 Push a string onto the stack. The stack must have room for this element.
3589 The C<len> indicates the length of the string. Handles 'set' magic. Uses
3590 C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to declare it. Do not
3591 call multiple C<TARG>-oriented macros to return lists from XSUB's - see
3592 C<mPUSHp> instead. See also C<XPUSHp> and C<mXPUSHp>.
3594 void PUSHp(char* str, STRLEN len)
3602 Push an SV onto the stack. The stack must have room for this element.
3603 Does not handle 'set' magic. Does not use C<TARG>. See also C<PUSHmortal>,
3604 C<XPUSHs> and C<XPUSHmortal>.
3614 Push an unsigned integer onto the stack. The stack must have room for this
3615 element. Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG>
3616 should be called to declare it. Do not call multiple C<TARG>-oriented
3617 macros to return lists from XSUB's - see C<mPUSHu> instead. See also
3618 C<XPUSHu> and C<mXPUSHu>.
3628 Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
3629 See C<PUSHMARK> and L<perlcall> for other uses.
3639 Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and
3648 Refetch the stack pointer. Used after a callback. See L<perlcall>.
3658 Push an integer onto the stack, extending the stack if necessary. Handles
3659 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
3660 declare it. Do not call multiple C<TARG>-oriented macros to return lists
3661 from XSUB's - see C<mXPUSHi> instead. See also C<PUSHi> and C<mPUSHi>.
3671 Push a new mortal SV onto the stack, extending the stack if necessary.
3672 Does not use C<TARG>. See also C<XPUSHs>, C<PUSHmortal> and C<PUSHs>.
3682 Push a double onto the stack, extending the stack if necessary. Handles
3683 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
3684 declare it. Do not call multiple C<TARG>-oriented macros to return lists
3685 from XSUB's - see C<mXPUSHn> instead. See also C<PUSHn> and C<mPUSHn>.
3695 Push a string onto the stack, extending the stack if necessary. The C<len>
3696 indicates the length of the string. Handles 'set' magic. Uses C<TARG>, so
3697 C<dTARGET> or C<dXSTARG> should be called to declare it. Do not call
3698 multiple C<TARG>-oriented macros to return lists from XSUB's - see
3699 C<mXPUSHp> instead. See also C<PUSHp> and C<mPUSHp>.
3701 void XPUSHp(char* str, STRLEN len)
3709 Push an SV onto the stack, extending the stack if necessary. Does not
3710 handle 'set' magic. Does not use C<TARG>. See also C<XPUSHmortal>,
3711 C<PUSHs> and C<PUSHmortal>.
3721 Push an unsigned integer onto the stack, extending the stack if necessary.
3722 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3723 called to declare it. Do not call multiple C<TARG>-oriented macros to
3724 return lists from XSUB's - see C<mXPUSHu> instead. See also C<PUSHu> and
3735 Return from XSUB, indicating number of items on the stack. This is usually
3736 handled by C<xsubpp>.
3738 void XSRETURN(int nitems)
3741 Found in file XSUB.h
3743 =item XSRETURN_EMPTY
3746 Return an empty list from an XSUB immediately.
3751 Found in file XSUB.h
3756 Return an integer from an XSUB immediately. Uses C<XST_mIV>.
3758 void XSRETURN_IV(IV iv)
3761 Found in file XSUB.h
3766 Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
3771 Found in file XSUB.h
3776 Return a double from an XSUB immediately. Uses C<XST_mNV>.
3778 void XSRETURN_NV(NV nv)
3781 Found in file XSUB.h
3786 Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
3788 void XSRETURN_PV(char* str)
3791 Found in file XSUB.h
3793 =item XSRETURN_UNDEF
3796 Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
3801 Found in file XSUB.h
3806 Return an integer from an XSUB immediately. Uses C<XST_mUV>.
3808 void XSRETURN_UV(IV uv)
3811 Found in file XSUB.h
3816 Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
3821 Found in file XSUB.h
3826 Place an integer into the specified position C<pos> on the stack. The
3827 value is stored in a new mortal SV.
3829 void XST_mIV(int pos, IV iv)
3832 Found in file XSUB.h
3837 Place C<&PL_sv_no> into the specified position C<pos> on the
3840 void XST_mNO(int pos)
3843 Found in file XSUB.h
3848 Place a double into the specified position C<pos> on the stack. The value
3849 is stored in a new mortal SV.
3851 void XST_mNV(int pos, NV nv)
3854 Found in file XSUB.h
3859 Place a copy of a string into the specified position C<pos> on the stack.
3860 The value is stored in a new mortal SV.
3862 void XST_mPV(int pos, char* str)
3865 Found in file XSUB.h
3870 Place C<&PL_sv_undef> into the specified position C<pos> on the
3873 void XST_mUNDEF(int pos)
3876 Found in file XSUB.h
3881 Place C<&PL_sv_yes> into the specified position C<pos> on the
3884 void XST_mYES(int pos)
3887 Found in file XSUB.h
3899 An enum of flags for Perl types. These are found in the file B<sv.h>
3900 in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
3908 Integer type flag for scalars. See C<svtype>.
3916 Double type flag for scalars. See C<svtype>.
3924 Pointer type flag for scalars. See C<svtype>.
3932 Type flag for arrays. See C<svtype>.
3940 Type flag for code refs. See C<svtype>.
3948 Type flag for hashes. See C<svtype>.
3956 Type flag for blessed scalars. See C<svtype>.
3964 =head1 SV Manipulation Functions
3968 =item croak_xs_usage
3971 A specialised variant of C<croak()> for emitting the usage message for xsubs
3973 croak_xs_usage(cv, "eee_yow");
3975 works out the package name and subroutine name from C<cv>, and then calls
3976 C<croak()>. Hence if C<cv> is C<&ouch::awk>, it would call C<croak> as:
3978 Perl_croak(aTHX_ "Usage %s::%s(%s)", "ouch" "awk", "eee_yow");
3980 void croak_xs_usage(const CV *const cv, const char *const params)
3983 Found in file universal.c
3988 Returns the SV of the specified Perl scalar. If C<create> is set and the
3989 Perl variable does not exist then it will be created. If C<create> is not
3990 set and the variable does not exist then NULL is returned.
3992 NOTE: the perl_ form of this function is deprecated.
3994 SV* get_sv(const char* name, I32 create)
3997 Found in file perl.c
4002 Creates an RV wrapper for an SV. The reference count for the original SV is
4005 SV* newRV_inc(SV* sv)
4013 Creates a new SV and copies a string into it. If utf8 is true, calls
4014 C<SvUTF8_on> on the new SV. Implemented as a wrapper around C<newSVpvn_flags>.
4016 SV* newSVpvn_utf8(NULLOK const char* s, STRLEN len, U32 utf8)
4024 Returns the length of the string which is in the SV. See C<SvLEN>.
4026 STRLEN SvCUR(SV* sv)
4034 Set the current length of the string which is in the SV. See C<SvCUR>
4037 void SvCUR_set(SV* sv, STRLEN len)
4045 Returns a pointer to the last character in the string which is in the SV.
4046 See C<SvCUR>. Access the character as *(SvEND(sv)).
4056 Returns true if the SV has get magic or overloading. If either is true then
4057 the scalar is active data, and has the potential to return a new value every
4058 time it is accessed. Hence you must be careful to only read it once per user
4059 logical operation and work with that returned value. If neither is true then
4060 the scalar's value cannot change unless written to.
4062 char* SvGAMAGIC(SV* sv)
4070 Expands the character buffer in the SV so that it has room for the
4071 indicated number of bytes (remember to reserve space for an extra trailing
4072 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
4073 Returns a pointer to the character buffer.
4075 char * SvGROW(SV* sv, STRLEN len)
4083 Returns a U32 value indicating whether the SV contains an integer.
4093 Returns a U32 value indicating whether the SV contains an integer. Checks
4094 the B<private> setting. Use C<SvIOK> instead.
4104 Returns a boolean indicating whether the SV contains a signed integer.
4106 bool SvIOK_notUV(SV* sv)
4114 Unsets the IV status of an SV.
4116 void SvIOK_off(SV* sv)
4124 Tells an SV that it is an integer.
4126 void SvIOK_on(SV* sv)
4134 Tells an SV that it is an integer and disables all other OK bits.
4136 void SvIOK_only(SV* sv)
4144 Tells and SV that it is an unsigned integer and disables all other OK bits.
4146 void SvIOK_only_UV(SV* sv)
4154 Returns a boolean indicating whether the SV contains an unsigned integer.
4156 bool SvIOK_UV(SV* sv)
4164 Returns a boolean indicating whether the SV is Copy-On-Write. (either shared
4165 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
4168 bool SvIsCOW(SV* sv)
4173 =item SvIsCOW_shared_hash
4174 X<SvIsCOW_shared_hash>
4176 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
4179 bool SvIsCOW_shared_hash(SV* sv)
4187 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
4188 version which guarantees to evaluate sv only once.
4198 Returns the raw value in the SV's IV slot, without checks or conversions.
4199 Only use when you are sure SvIOK is true. See also C<SvIV()>.
4209 Coerces the given SV to an integer and returns it. Guarantees to evaluate
4210 C<sv> only once. Only use this if C<sv> is an expression with side effects,
4211 otherwise use the more efficient C<SvIV>.
4221 Like C<SvIV> but doesn't process magic.
4223 IV SvIV_nomg(SV* sv)
4231 Set the value of the IV pointer in sv to val. It is possible to perform
4232 the same function of this macro with an lvalue assignment to C<SvIVX>.
4233 With future Perls, however, it will be more efficient to use
4234 C<SvIV_set> instead of the lvalue assignment to C<SvIVX>.
4236 void SvIV_set(SV* sv, IV val)
4244 Returns the size of the string buffer in the SV, not including any part
4245 attributable to C<SvOOK>. See C<SvCUR>.
4247 STRLEN SvLEN(SV* sv)
4255 Set the actual length of the string which is in the SV. See C<SvIV_set>.
4257 void SvLEN_set(SV* sv, STRLEN len)
4265 Set the value of the MAGIC pointer in sv to val. See C<SvIV_set>.
4267 void SvMAGIC_set(SV* sv, MAGIC* val)
4275 Returns a U32 value indicating whether the SV contains a number, integer or
4286 Returns a U32 value indicating whether the SV contains a number, integer or
4287 double. Checks the B<private> setting. Use C<SvNIOK> instead.
4297 Unsets the NV/IV status of an SV.
4299 void SvNIOK_off(SV* sv)
4307 Returns a U32 value indicating whether the SV contains a double.
4317 Returns a U32 value indicating whether the SV contains a double. Checks the
4318 B<private> setting. Use C<SvNOK> instead.
4328 Unsets the NV status of an SV.
4330 void SvNOK_off(SV* sv)
4338 Tells an SV that it is a double.
4340 void SvNOK_on(SV* sv)
4348 Tells an SV that it is a double and disables all other OK bits.
4350 void SvNOK_only(SV* sv)
4358 Coerce the given SV to a double and return it. See C<SvNVx> for a version
4359 which guarantees to evaluate sv only once.
4369 Returns the raw value in the SV's NV slot, without checks or conversions.
4370 Only use when you are sure SvNOK is true. See also C<SvNV()>.
4380 Coerces the given SV to a double and returns it. Guarantees to evaluate
4381 C<sv> only once. Only use this if C<sv> is an expression with side effects,
4382 otherwise use the more efficient C<SvNV>.
4392 Set the value of the NV pointer in sv to val. See C<SvIV_set>.
4394 void SvNV_set(SV* sv, NV val)
4402 Returns a U32 value indicating whether the value is an SV. It also tells
4403 whether the value is defined or not.
4413 Returns a U32 indicating whether the pointer to the string buffer is offset.
4414 This hack is used internally to speed up removal of characters from the
4415 beginning of a SvPV. When SvOOK is true, then the start of the
4416 allocated string buffer is actually C<SvOOK_offset()> bytes before SvPVX.
4417 This offset used to be stored in SvIVX, but is now stored within the spare
4428 Reads into I<len> the offset from SvPVX back to the true start of the
4429 allocated buffer, which will be non-zero if C<sv_chop> has been used to
4430 efficiently remove characters from start of the buffer. Implemented as a
4431 macro, which takes the address of I<len>, which must be of type C<STRLEN>.
4432 Evaluates I<sv> more than once. Sets I<len> to 0 if C<SvOOK(sv)> is false.
4434 void SvOOK_offset(NN SV*sv, STRLEN len)
4442 Returns a U32 value indicating whether the SV contains a character
4453 Returns a U32 value indicating whether the SV contains a character string.
4454 Checks the B<private> setting. Use C<SvPOK> instead.
4464 Unsets the PV status of an SV.
4466 void SvPOK_off(SV* sv)
4474 Tells an SV that it is a string.
4476 void SvPOK_on(SV* sv)
4484 Tells an SV that it is a string and disables all other OK bits.
4485 Will also turn off the UTF-8 status.
4487 void SvPOK_only(SV* sv)
4492 =item SvPOK_only_UTF8
4495 Tells an SV that it is a string and disables all other OK bits,
4496 and leaves the UTF-8 status as it was.
4498 void SvPOK_only_UTF8(SV* sv)
4506 Returns a pointer to the string in the SV, or a stringified form of
4507 the SV if the SV does not contain a string. The SV may cache the
4508 stringified version becoming C<SvPOK>. Handles 'get' magic. See also
4509 C<SvPVx> for a version which guarantees to evaluate sv only once.
4511 char* SvPV(SV* sv, STRLEN len)
4519 Like C<SvPV>, but converts sv to byte representation first if necessary.
4521 char* SvPVbyte(SV* sv, STRLEN len)
4529 Like C<SvPV>, but converts sv to byte representation first if necessary.
4530 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
4533 char* SvPVbytex(SV* sv, STRLEN len)
4538 =item SvPVbytex_force
4541 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
4542 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
4545 char* SvPVbytex_force(SV* sv, STRLEN len)
4550 =item SvPVbyte_force
4553 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
4555 char* SvPVbyte_force(SV* sv, STRLEN len)
4560 =item SvPVbyte_nolen
4563 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
4565 char* SvPVbyte_nolen(SV* sv)
4573 Like C<SvPV>, but converts sv to utf8 first if necessary.
4575 char* SvPVutf8(SV* sv, STRLEN len)
4583 Like C<SvPV>, but converts sv to utf8 first if necessary.
4584 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
4587 char* SvPVutf8x(SV* sv, STRLEN len)
4592 =item SvPVutf8x_force
4595 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
4596 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
4599 char* SvPVutf8x_force(SV* sv, STRLEN len)
4604 =item SvPVutf8_force
4607 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
4609 char* SvPVutf8_force(SV* sv, STRLEN len)
4614 =item SvPVutf8_nolen
4617 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
4619 char* SvPVutf8_nolen(SV* sv)
4627 Returns a pointer to the physical string in the SV. The SV must contain a
4638 A version of C<SvPV> which guarantees to evaluate C<sv> only once.
4639 Only use this if C<sv> is an expression with side effects, otherwise use the
4640 more efficient C<SvPVX>.
4642 char* SvPVx(SV* sv, STRLEN len)
4650 Like C<SvPV> but will force the SV into containing just a string
4651 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
4654 char* SvPV_force(SV* sv, STRLEN len)
4659 =item SvPV_force_nomg
4662 Like C<SvPV> but will force the SV into containing just a string
4663 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
4664 directly. Doesn't process magic.
4666 char* SvPV_force_nomg(SV* sv, STRLEN len)
4674 Returns a pointer to the string in the SV, or a stringified form of
4675 the SV if the SV does not contain a string. The SV may cache the
4676 stringified form becoming C<SvPOK>. Handles 'get' magic.
4678 char* SvPV_nolen(SV* sv)
4686 Like C<SvPV> but doesn't process magic.
4688 char* SvPV_nomg(SV* sv, STRLEN len)
4696 Set the value of the PV pointer in sv to val. See C<SvIV_set>.
4698 void SvPV_set(SV* sv, char* val)
4706 Returns the value of the object's reference count.
4708 U32 SvREFCNT(SV* sv)
4716 Decrements the reference count of the given SV.
4718 void SvREFCNT_dec(SV* sv)
4726 Increments the reference count of the given SV.
4728 All of the following SvREFCNT_inc* macros are optimized versions of
4729 SvREFCNT_inc, and can be replaced with SvREFCNT_inc.
4731 SV* SvREFCNT_inc(SV* sv)
4736 =item SvREFCNT_inc_NN
4739 Same as SvREFCNT_inc, but can only be used if you know I<sv>
4740 is not NULL. Since we don't have to check the NULLness, it's faster
4743 SV* SvREFCNT_inc_NN(SV* sv)
4748 =item SvREFCNT_inc_simple
4749 X<SvREFCNT_inc_simple>
4751 Same as SvREFCNT_inc, but can only be used with expressions without side
4752 effects. Since we don't have to store a temporary value, it's faster.
4754 SV* SvREFCNT_inc_simple(SV* sv)
4759 =item SvREFCNT_inc_simple_NN
4760 X<SvREFCNT_inc_simple_NN>
4762 Same as SvREFCNT_inc_simple, but can only be used if you know I<sv>
4763 is not NULL. Since we don't have to check the NULLness, it's faster
4766 SV* SvREFCNT_inc_simple_NN(SV* sv)
4771 =item SvREFCNT_inc_simple_void
4772 X<SvREFCNT_inc_simple_void>
4774 Same as SvREFCNT_inc_simple, but can only be used if you don't need the
4775 return value. The macro doesn't need to return a meaningful value.
4777 void SvREFCNT_inc_simple_void(SV* sv)
4782 =item SvREFCNT_inc_simple_void_NN
4783 X<SvREFCNT_inc_simple_void_NN>
4785 Same as SvREFCNT_inc, but can only be used if you don't need the return
4786 value, and you know that I<sv> is not NULL. The macro doesn't need
4787 to return a meaningful value, or check for NULLness, so it's smaller
4790 void SvREFCNT_inc_simple_void_NN(SV* sv)
4795 =item SvREFCNT_inc_void
4796 X<SvREFCNT_inc_void>
4798 Same as SvREFCNT_inc, but can only be used if you don't need the
4799 return value. The macro doesn't need to return a meaningful value.
4801 void SvREFCNT_inc_void(SV* sv)
4806 =item SvREFCNT_inc_void_NN
4807 X<SvREFCNT_inc_void_NN>
4809 Same as SvREFCNT_inc, but can only be used if you don't need the return
4810 value, and you know that I<sv> is not NULL. The macro doesn't need
4811 to return a meaningful value, or check for NULLness, so it's smaller
4814 void SvREFCNT_inc_void_NN(SV* sv)
4822 Tests if the SV is an RV.
4832 Unsets the RV status of an SV.
4834 void SvROK_off(SV* sv)
4842 Tells an SV that it is an RV.
4844 void SvROK_on(SV* sv)
4852 Dereferences an RV to return the SV.
4862 Set the value of the RV pointer in sv to val. See C<SvIV_set>.
4864 void SvRV_set(SV* sv, SV* val)
4872 Returns the stash of the SV.
4882 Set the value of the STASH pointer in sv to val. See C<SvIV_set>.
4884 void SvSTASH_set(SV* sv, HV* val)
4892 Taints an SV if tainting is enabled.
4894 void SvTAINT(SV* sv)
4902 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
4905 bool SvTAINTED(SV* sv)
4913 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
4914 some of Perl's fundamental security features. XS module authors should not
4915 use this function unless they fully understand all the implications of
4916 unconditionally untainting the value. Untainting should be done in the
4917 standard perl fashion, via a carefully crafted regexp, rather than directly
4918 untainting variables.
4920 void SvTAINTED_off(SV* sv)
4928 Marks an SV as tainted if tainting is enabled.
4930 void SvTAINTED_on(SV* sv)
4938 Returns a boolean indicating whether Perl would evaluate the SV as true or
4939 false, defined or undefined. Does not handle 'get' magic.
4949 Returns the type of the SV. See C<svtype>.
4951 svtype SvTYPE(SV* sv)
4959 Returns a boolean indicating whether the SV contains an unsigned integer.
4969 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
4970 perform the upgrade if necessary. See C<svtype>.
4972 void SvUPGRADE(SV* sv, svtype type)
4980 Returns a U32 value indicating whether the SV contains UTF-8 encoded data.
4981 Call this after SvPV() in case any call to string overloading updates the
4992 Unsets the UTF-8 status of an SV.
4994 void SvUTF8_off(SV *sv)
5002 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
5003 Do not use frivolously.
5005 void SvUTF8_on(SV *sv)
5013 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
5014 for a version which guarantees to evaluate sv only once.
5024 Returns the raw value in the SV's UV slot, without checks or conversions.
5025 Only use when you are sure SvIOK is true. See also C<SvUV()>.
5035 Coerces the given SV to an unsigned integer and returns it. Guarantees to
5036 C<sv> only once. Only use this if C<sv> is an expression with side effects,
5037 otherwise use the more efficient C<SvUV>.
5047 Like C<SvUV> but doesn't process magic.
5049 UV SvUV_nomg(SV* sv)
5057 Set the value of the UV pointer in sv to val. See C<SvIV_set>.
5059 void SvUV_set(SV* sv, UV val)
5067 Returns a boolean indicating whether the SV contains a v-string.
5074 =item sv_catpvn_nomg
5077 Like C<sv_catpvn> but doesn't process magic.
5079 void sv_catpvn_nomg(SV* sv, const char* ptr, STRLEN len)
5087 Like C<sv_catsv> but doesn't process magic.
5089 void sv_catsv_nomg(SV* dsv, SV* ssv)
5094 =item sv_derived_from
5097 Returns a boolean indicating whether the SV is derived from the specified class
5098 I<at the C level>. To check derivation at the Perl level, call C<isa()> as a
5101 bool sv_derived_from(SV* sv, const char *const name)
5104 Found in file universal.c
5109 Returns a boolean indicating whether the SV performs a specific, named role.
5110 The SV can be a Perl object or the name of a Perl class.
5112 bool sv_does(SV* sv, const char *const name)
5115 Found in file universal.c
5117 =item sv_report_used
5120 Dump the contents of all SVs not yet freed. (Debugging aid).
5122 void sv_report_used()
5130 Like C<sv_setsv> but doesn't process magic.
5132 void sv_setsv_nomg(SV* dsv, SV* ssv)
5137 =item sv_utf8_upgrade_nomg
5138 X<sv_utf8_upgrade_nomg>
5140 Like sv_utf8_upgrade, but doesn't do magic on C<sv>
5142 STRLEN sv_utf8_upgrade_nomg(NN SV *sv)
5150 =head1 SV-Body Allocation
5154 =item looks_like_number
5155 X<looks_like_number>
5157 Test if the content of an SV looks like a number (or is a number).
5158 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
5159 non-numeric warning), even if your atof() doesn't grok them.
5161 I32 looks_like_number(SV *const sv)
5169 Creates an RV wrapper for an SV. The reference count for the original
5170 SV is B<not> incremented.
5172 SV* newRV_noinc(SV *const sv)
5180 Creates a new SV. A non-zero C<len> parameter indicates the number of
5181 bytes of preallocated string space the SV should have. An extra byte for a
5182 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
5183 space is allocated.) The reference count for the new SV is set to 1.
5185 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
5186 parameter, I<x>, a debug aid which allowed callers to identify themselves.
5187 This aid has been superseded by a new build option, PERL_MEM_LOG (see
5188 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
5189 modules supporting older perls.
5191 SV* newSV(const STRLEN len)
5199 Creates a new SV from the hash key structure. It will generate scalars that
5200 point to the shared string table where possible. Returns a new (undefined)
5201 SV if the hek is NULL.
5203 SV* newSVhek(const HEK *const hek)
5211 Creates a new SV and copies an integer into it. The reference count for the
5214 SV* newSViv(const IV i)
5222 Creates a new SV and copies a floating point value into it.
5223 The reference count for the SV is set to 1.
5225 SV* newSVnv(const NV n)
5233 Creates a new SV and copies a string into it. The reference count for the
5234 SV is set to 1. If C<len> is zero, Perl will compute the length using
5235 strlen(). For efficiency, consider using C<newSVpvn> instead.
5237 SV* newSVpv(const char *const s, const STRLEN len)
5245 Creates a new SV and initializes it with the string formatted like
5248 SV* newSVpvf(const char *const pat, ...)
5256 Creates a new SV and copies a string into it. The reference count for the
5257 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
5258 string. You are responsible for ensuring that the source string is at least
5259 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
5261 SV* newSVpvn(const char *const s, const STRLEN len)
5266 =item newSVpvn_flags
5269 Creates a new SV and copies a string into it. The reference count for the
5270 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
5271 string. You are responsible for ensuring that the source string is at least
5272 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
5273 Currently the only flag bits accepted are C<SVf_UTF8> and C<SVs_TEMP>.
5274 If C<SVs_TEMP> is set, then C<sv2mortal()> is called on the result before
5275 returning. If C<SVf_UTF8> is set, then it will be set on the new SV.
5276 C<newSVpvn_utf8()> is a convenience wrapper for this function, defined as
5278 #define newSVpvn_utf8(s, len, u) \
5279 newSVpvn_flags((s), (len), (u) ? SVf_UTF8 : 0)
5281 SV* newSVpvn_flags(const char *const s, const STRLEN len, const U32 flags)
5286 =item newSVpvn_share
5289 Creates a new SV with its SvPVX_const pointing to a shared string in the string
5290 table. If the string does not already exist in the table, it is created
5291 first. Turns on READONLY and FAKE. If the C<hash> parameter is non-zero, that
5292 value is used; otherwise the hash is computed. The string's hash can be later
5293 be retrieved from the SV with the C<SvSHARED_HASH()> macro. The idea here is
5294 that as the string table is used for shared hash keys these strings will have
5295 SvPVX_const == HeKEY and hash lookup will avoid string compare.
5297 SV* newSVpvn_share(const char* s, I32 len, U32 hash)
5305 Like C<newSVpvn>, but takes a literal string instead of a string/length pair.
5307 SV* newSVpvs(const char* s)
5310 Found in file handy.h
5312 =item newSVpvs_flags
5315 Like C<newSVpvn_flags>, but takes a literal string instead of a string/length
5318 SV* newSVpvs_flags(const char* s, U32 flags)
5321 Found in file handy.h
5323 =item newSVpvs_share
5326 Like C<newSVpvn_share>, but takes a literal string instead of a string/length
5327 pair and omits the hash parameter.
5329 SV* newSVpvs_share(const char* s)
5332 Found in file handy.h
5337 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
5338 it will be upgraded to one. If C<classname> is non-null then the new SV will
5339 be blessed in the specified package. The new SV is returned and its
5340 reference count is 1.
5342 SV* newSVrv(SV *const rv, const char *const classname)
5350 Creates a new SV which is an exact duplicate of the original SV.
5353 SV* newSVsv(SV *const old)
5361 Creates a new SV and copies an unsigned integer into it.
5362 The reference count for the SV is set to 1.
5364 SV* newSVuv(const UV u)
5372 Creates a new SV, of the type specified. The reference count for the new SV
5375 SV* newSV_type(const svtype type)
5383 This function is only called on magical items, and is only used by
5384 sv_true() or its macro equivalent.
5386 bool sv_2bool(SV *const sv)
5394 Using various gambits, try to get a CV from an SV; in addition, try if
5395 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
5396 The flags in C<lref> are passed to sv_fetchsv.
5398 CV* sv_2cv(SV* sv, HV **const st, GV **const gvp, const I32 lref)
5406 Using various gambits, try to get an IO from an SV: the IO slot if its a
5407 GV; or the recursive result if we're an RV; or the IO slot of the symbol
5408 named after the PV if we're a string.
5410 IO* sv_2io(SV *const sv)
5418 Return the integer value of an SV, doing any necessary string
5419 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
5420 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
5422 IV sv_2iv_flags(SV *const sv, const I32 flags)
5430 Marks an existing SV as mortal. The SV will be destroyed "soon", either
5431 by an explicit call to FREETMPS, or by an implicit call at places such as
5432 statement boundaries. SvTEMP() is turned on which means that the SV's
5433 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
5434 and C<sv_mortalcopy>.
5436 SV* sv_2mortal(SV *const sv)
5444 Return the num value of an SV, doing any necessary string or integer
5445 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
5448 NV sv_2nv(SV *const sv)
5456 Return a pointer to the byte-encoded representation of the SV, and set *lp
5457 to its length. May cause the SV to be downgraded from UTF-8 as a
5460 Usually accessed via the C<SvPVbyte> macro.
5462 char* sv_2pvbyte(SV *const sv, STRLEN *const lp)
5470 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
5471 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
5473 Usually accessed via the C<SvPVutf8> macro.
5475 char* sv_2pvutf8(SV *const sv, STRLEN *const lp)
5483 Returns a pointer to the string value of an SV, and sets *lp to its length.
5484 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
5486 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
5487 usually end up here too.
5489 char* sv_2pv_flags(SV *const sv, STRLEN *const lp, const I32 flags)
5497 Return the unsigned integer value of an SV, doing any necessary string
5498 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
5499 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
5501 UV sv_2uv_flags(SV *const sv, const I32 flags)
5509 Remove any string offset. You should normally use the C<SvOOK_off> macro
5512 int sv_backoff(SV *const sv)
5520 Blesses an SV into a specified package. The SV must be an RV. The package
5521 must be designated by its stash (see C<gv_stashpv()>). The reference count
5522 of the SV is unaffected.
5524 SV* sv_bless(SV *const sv, HV *const stash)
5532 Concatenates the string onto the end of the string which is in the SV.
5533 If the SV has the UTF-8 status set, then the bytes appended should be
5534 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
5536 void sv_catpv(SV *const sv, const char* ptr)
5544 Processes its arguments like C<sprintf> and appends the formatted
5545 output to an SV. If the appended data contains "wide" characters
5546 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
5547 and characters >255 formatted with %c), the original SV might get
5548 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
5549 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
5550 valid UTF-8; if the original SV was bytes, the pattern should be too.
5552 void sv_catpvf(SV *const sv, const char *const pat, ...)
5560 Like C<sv_catpvf>, but also handles 'set' magic.
5562 void sv_catpvf_mg(SV *const sv, const char *const pat, ...)
5570 Concatenates the string onto the end of the string which is in the SV. The
5571 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5572 status set, then the bytes appended should be valid UTF-8.
5573 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
5575 void sv_catpvn(SV *dsv, const char *sstr, STRLEN len)
5580 =item sv_catpvn_flags
5583 Concatenates the string onto the end of the string which is in the SV. The
5584 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5585 status set, then the bytes appended should be valid UTF-8.
5586 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
5587 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
5588 in terms of this function.
5590 void sv_catpvn_flags(SV *const dstr, const char *sstr, const STRLEN len, const I32 flags)
5598 Like C<sv_catpvn>, but takes a literal string instead of a string/length pair.
5600 void sv_catpvs(SV* sv, const char* s)
5603 Found in file handy.h
5608 Like C<sv_catpv>, but also handles 'set' magic.
5610 void sv_catpv_mg(SV *const sv, const char *const ptr)
5618 Concatenates the string from SV C<ssv> onto the end of the string in
5619 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
5620 not 'set' magic. See C<sv_catsv_mg>.
5622 void sv_catsv(SV *dstr, SV *sstr)
5627 =item sv_catsv_flags
5630 Concatenates the string from SV C<ssv> onto the end of the string in
5631 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
5632 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
5633 and C<sv_catsv_nomg> are implemented in terms of this function.
5635 void sv_catsv_flags(SV *const dsv, SV *const ssv, const I32 flags)
5643 Efficient removal of characters from the beginning of the string buffer.
5644 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
5645 the string buffer. The C<ptr> becomes the first character of the adjusted
5646 string. Uses the "OOK hack".
5647 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
5648 refer to the same chunk of data.
5650 void sv_chop(SV *const sv, const char *const ptr)
5658 Clear an SV: call any destructors, free up any memory used by the body,
5659 and free the body itself. The SV's head is I<not> freed, although
5660 its type is set to all 1's so that it won't inadvertently be assumed
5661 to be live during global destruction etc.
5662 This function should only be called when REFCNT is zero. Most of the time
5663 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5666 void sv_clear(SV *const sv)
5674 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5675 string in C<sv1> is less than, equal to, or greater than the string in
5676 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5677 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
5679 I32 sv_cmp(SV *const sv1, SV *const sv2)
5687 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
5688 'use bytes' aware, handles get magic, and will coerce its args to strings
5689 if necessary. See also C<sv_cmp>.
5691 I32 sv_cmp_locale(SV *const sv1, SV *const sv2)
5699 Add Collate Transform magic to an SV if it doesn't already have it.
5701 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
5702 scalar data of the variable, but transformed to such a format that a normal
5703 memory comparison can be used to compare the data according to the locale
5706 char* sv_collxfrm(SV *const sv, STRLEN *const nxp)
5714 Copies a stringified representation of the source SV into the
5715 destination SV. Automatically performs any necessary mg_get and
5716 coercion of numeric values into strings. Guaranteed to preserve
5717 UTF8 flag even from overloaded objects. Similar in nature to
5718 sv_2pv[_flags] but operates directly on an SV instead of just the
5719 string. Mostly uses sv_2pv_flags to do its work, except when that
5720 would lose the UTF-8'ness of the PV.
5722 void sv_copypv(SV *const dsv, SV *const ssv)
5730 Auto-decrement of the value in the SV, doing string to numeric conversion
5731 if necessary. Handles 'get' magic.
5733 void sv_dec(SV *const sv)
5741 Returns a boolean indicating whether the strings in the two SVs are
5742 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5743 coerce its args to strings if necessary.
5745 I32 sv_eq(SV* sv1, SV* sv2)
5750 =item sv_force_normal_flags
5751 X<sv_force_normal_flags>
5753 Undo various types of fakery on an SV: if the PV is a shared string, make
5754 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
5755 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
5756 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
5757 then a copy-on-write scalar drops its PV buffer (if any) and becomes
5758 SvPOK_off rather than making a copy. (Used where this scalar is about to be
5759 set to some other value.) In addition, the C<flags> parameter gets passed to
5760 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
5761 with flags set to 0.
5763 void sv_force_normal_flags(SV *const sv, const U32 flags)
5771 Decrement an SV's reference count, and if it drops to zero, call
5772 C<sv_clear> to invoke destructors and free up any memory used by
5773 the body; finally, deallocate the SV's head itself.
5774 Normally called via a wrapper macro C<SvREFCNT_dec>.
5776 void sv_free(SV *const sv)
5784 Get a line from the filehandle and store it into the SV, optionally
5785 appending to the currently-stored string.
5787 char* sv_gets(SV *const sv, PerlIO *const fp, I32 append)
5795 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
5796 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
5797 Use the C<SvGROW> wrapper instead.
5799 char* sv_grow(SV *const sv, STRLEN newlen)
5807 Auto-increment of the value in the SV, doing string to numeric conversion
5808 if necessary. Handles 'get' magic.
5810 void sv_inc(SV *const sv)
5818 Inserts a string at the specified offset/length within the SV. Similar to
5819 the Perl substr() function. Handles get magic.
5821 void sv_insert(SV *const bigstr, const STRLEN offset, const STRLEN len, const char *const little, const STRLEN littlelen)
5826 =item sv_insert_flags
5829 Same as C<sv_insert>, but the extra C<flags> are passed the C<SvPV_force_flags> that applies to C<bigstr>.
5831 void sv_insert_flags(SV *const bigstr, const STRLEN offset, const STRLEN len, const char *const little, const STRLEN littlelen, const U32 flags)
5839 Returns a boolean indicating whether the SV is blessed into the specified
5840 class. This does not check for subtypes; use C<sv_derived_from> to verify
5841 an inheritance relationship.
5843 int sv_isa(SV* sv, const char *const name)
5851 Returns a boolean indicating whether the SV is an RV pointing to a blessed
5852 object. If the SV is not an RV, or if the object is not blessed, then this
5855 int sv_isobject(SV* sv)
5863 Returns the length of the string in the SV. Handles magic and type
5864 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5866 STRLEN sv_len(SV *const sv)
5874 Returns the number of characters in the string in an SV, counting wide
5875 UTF-8 bytes as a single character. Handles magic and type coercion.
5877 STRLEN sv_len_utf8(SV *const sv)
5885 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
5886 then adds a new magic item of type C<how> to the head of the magic list.
5888 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
5889 handling of the C<name> and C<namlen> arguments.
5891 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
5892 to add more than one instance of the same 'how'.
5894 void sv_magic(SV *const sv, SV *const obj, const int how, const char *const name, const I32 namlen)
5902 Adds magic to an SV, upgrading it if necessary. Applies the
5903 supplied vtable and returns a pointer to the magic added.
5905 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
5906 In particular, you can add magic to SvREADONLY SVs, and add more than
5907 one instance of the same 'how'.
5909 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
5910 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
5911 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
5912 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
5914 (This is now used as a subroutine by C<sv_magic>.)
5916 MAGIC * sv_magicext(SV *const sv, SV *const obj, const int how, const MGVTBL *const vtbl, const char *const name, const I32 namlen)
5924 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
5925 The new SV is marked as mortal. It will be destroyed "soon", either by an
5926 explicit call to FREETMPS, or by an implicit call at places such as
5927 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
5929 SV* sv_mortalcopy(SV *const oldsv)
5937 Creates a new null SV which is mortal. The reference count of the SV is
5938 set to 1. It will be destroyed "soon", either by an explicit call to
5939 FREETMPS, or by an implicit call at places such as statement boundaries.
5940 See also C<sv_mortalcopy> and C<sv_2mortal>.
5950 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5953 SV* sv_newref(SV *const sv)
5961 Converts the value pointed to by offsetp from a count of bytes from the
5962 start of the string, to a count of the equivalent number of UTF-8 chars.
5963 Handles magic and type coercion.
5965 void sv_pos_b2u(SV *const sv, I32 *const offsetp)
5973 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5974 the start of the string, to a count of the equivalent number of bytes; if
5975 lenp is non-zero, it does the same to lenp, but this time starting from
5976 the offset, rather than from the start of the string. Handles magic and
5979 void sv_pos_u2b(SV *const sv, I32 *const offsetp, I32 *const lenp)
5984 =item sv_pvbyten_force
5987 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
5989 char* sv_pvbyten_force(SV *const sv, STRLEN *const lp)
5997 Get a sensible string out of the SV somehow.
5998 A private implementation of the C<SvPV_force> macro for compilers which
5999 can't cope with complex macro expressions. Always use the macro instead.
6001 char* sv_pvn_force(SV* sv, STRLEN* lp)
6006 =item sv_pvn_force_flags
6007 X<sv_pvn_force_flags>
6009 Get a sensible string out of the SV somehow.
6010 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
6011 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
6012 implemented in terms of this function.
6013 You normally want to use the various wrapper macros instead: see
6014 C<SvPV_force> and C<SvPV_force_nomg>
6016 char* sv_pvn_force_flags(SV *const sv, STRLEN *const lp, const I32 flags)
6021 =item sv_pvutf8n_force
6024 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
6026 char* sv_pvutf8n_force(SV *const sv, STRLEN *const lp)
6034 Returns a string describing what the SV is a reference to.
6036 const char* sv_reftype(const SV *const sv, const int ob)
6044 Make the first argument a copy of the second, then delete the original.
6045 The target SV physically takes over ownership of the body of the source SV
6046 and inherits its flags; however, the target keeps any magic it owns,
6047 and any magic in the source is discarded.
6048 Note that this is a rather specialist SV copying operation; most of the
6049 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
6051 void sv_replace(SV *const sv, SV *const nsv)
6059 Underlying implementation for the C<reset> Perl function.
6060 Note that the perl-level function is vaguely deprecated.
6062 void sv_reset(const char* s, HV *const stash)
6070 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
6071 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
6072 push a back-reference to this RV onto the array of backreferences
6073 associated with that magic. If the RV is magical, set magic will be
6074 called after the RV is cleared.
6076 SV* sv_rvweaken(SV *const sv)
6084 Copies an integer into the given SV, upgrading first if necessary.
6085 Does not handle 'set' magic. See also C<sv_setiv_mg>.
6087 void sv_setiv(SV *const sv, const IV num)
6095 Like C<sv_setiv>, but also handles 'set' magic.
6097 void sv_setiv_mg(SV *const sv, const IV i)
6105 Copies a double into the given SV, upgrading first if necessary.
6106 Does not handle 'set' magic. See also C<sv_setnv_mg>.
6108 void sv_setnv(SV *const sv, const NV num)
6116 Like C<sv_setnv>, but also handles 'set' magic.
6118 void sv_setnv_mg(SV *const sv, const NV num)
6126 Copies a string into an SV. The string must be null-terminated. Does not
6127 handle 'set' magic. See C<sv_setpv_mg>.
6129 void sv_setpv(SV *const sv, const char *const ptr)
6137 Works like C<sv_catpvf> but copies the text into the SV instead of
6138 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
6140 void sv_setpvf(SV *const sv, const char *const pat, ...)
6148 Like C<sv_setpvf>, but also handles 'set' magic.
6150 void sv_setpvf_mg(SV *const sv, const char *const pat, ...)
6158 Copies an integer into the given SV, also updating its string value.
6159 Does not handle 'set' magic. See C<sv_setpviv_mg>.
6161 void sv_setpviv(SV *const sv, const IV num)
6169 Like C<sv_setpviv>, but also handles 'set' magic.
6171 void sv_setpviv_mg(SV *const sv, const IV iv)
6179 Copies a string into an SV. The C<len> parameter indicates the number of
6180 bytes to be copied. If the C<ptr> argument is NULL the SV will become
6181 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
6183 void sv_setpvn(SV *const sv, const char *const ptr, const STRLEN len)
6191 Like C<sv_setpvn>, but also handles 'set' magic.
6193 void sv_setpvn_mg(SV *const sv, const char *const ptr, const STRLEN len)
6201 Like C<sv_setpvn>, but takes a literal string instead of a string/length pair.
6203 void sv_setpvs(SV* sv, const char* s)
6206 Found in file handy.h
6211 Like C<sv_setpv>, but also handles 'set' magic.
6213 void sv_setpv_mg(SV *const sv, const char *const ptr)
6221 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
6222 argument will be upgraded to an RV. That RV will be modified to point to
6223 the new SV. The C<classname> argument indicates the package for the
6224 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
6225 will have a reference count of 1, and the RV will be returned.
6227 SV* sv_setref_iv(SV *const rv, const char *const classname, const IV iv)
6235 Copies a double into a new SV, optionally blessing the SV. The C<rv>
6236 argument will be upgraded to an RV. That RV will be modified to point to
6237 the new SV. The C<classname> argument indicates the package for the
6238 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
6239 will have a reference count of 1, and the RV will be returned.
6241 SV* sv_setref_nv(SV *const rv, const char *const classname, const NV nv)
6249 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
6250 argument will be upgraded to an RV. That RV will be modified to point to
6251 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
6252 into the SV. The C<classname> argument indicates the package for the
6253 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
6254 will have a reference count of 1, and the RV will be returned.
6256 Do not use with other Perl types such as HV, AV, SV, CV, because those
6257 objects will become corrupted by the pointer copy process.
6259 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
6261 SV* sv_setref_pv(SV *const rv, const char *const classname, void *const pv)
6269 Copies a string into a new SV, optionally blessing the SV. The length of the
6270 string must be specified with C<n>. The C<rv> argument will be upgraded to
6271 an RV. That RV will be modified to point to the new SV. The C<classname>
6272 argument indicates the package for the blessing. Set C<classname> to
6273 C<NULL> to avoid the blessing. The new SV will have a reference count
6274 of 1, and the RV will be returned.
6276 Note that C<sv_setref_pv> copies the pointer while this copies the string.
6278 SV* sv_setref_pvn(SV *const rv, const char *const classname, const char *const pv, const STRLEN n)
6286 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
6287 argument will be upgraded to an RV. That RV will be modified to point to
6288 the new SV. The C<classname> argument indicates the package for the
6289 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
6290 will have a reference count of 1, and the RV will be returned.
6292 SV* sv_setref_uv(SV *const rv, const char *const classname, const UV uv)
6300 Copies the contents of the source SV C<ssv> into the destination SV
6301 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
6302 function if the source SV needs to be reused. Does not handle 'set' magic.
6303 Loosely speaking, it performs a copy-by-value, obliterating any previous
6304 content of the destination.
6306 You probably want to use one of the assortment of wrappers, such as
6307 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
6308 C<SvSetMagicSV_nosteal>.
6310 void sv_setsv(SV *dstr, SV *sstr)
6315 =item sv_setsv_flags
6318 Copies the contents of the source SV C<ssv> into the destination SV
6319 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
6320 function if the source SV needs to be reused. Does not handle 'set' magic.
6321 Loosely speaking, it performs a copy-by-value, obliterating any previous
6322 content of the destination.
6323 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
6324 C<ssv> if appropriate, else not. If the C<flags> parameter has the
6325 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
6326 and C<sv_setsv_nomg> are implemented in terms of this function.
6328 You probably want to use one of the assortment of wrappers, such as
6329 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
6330 C<SvSetMagicSV_nosteal>.
6332 This is the primary function for copying scalars, and most other
6333 copy-ish functions and macros use this underneath.
6335 void sv_setsv_flags(SV *dstr, SV *sstr, const I32 flags)
6343 Like C<sv_setsv>, but also handles 'set' magic.
6345 void sv_setsv_mg(SV *const dstr, SV *const sstr)
6353 Copies an unsigned integer into the given SV, upgrading first if necessary.
6354 Does not handle 'set' magic. See also C<sv_setuv_mg>.
6356 void sv_setuv(SV *const sv, const UV num)
6364 Like C<sv_setuv>, but also handles 'set' magic.
6366 void sv_setuv_mg(SV *const sv, const UV u)
6374 Test an SV for taintedness. Use C<SvTAINTED> instead.
6375 bool sv_tainted(SV *const sv)
6383 Returns true if the SV has a true value by Perl's rules.
6384 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
6385 instead use an in-line version.
6387 I32 sv_true(SV *const sv)
6395 Removes all magic of type C<type> from an SV.
6397 int sv_unmagic(SV *const sv, const int type)
6402 =item sv_unref_flags
6405 Unsets the RV status of the SV, and decrements the reference count of
6406 whatever was being referenced by the RV. This can almost be thought of
6407 as a reversal of C<newSVrv>. The C<cflags> argument can contain
6408 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
6409 (otherwise the decrementing is conditional on the reference count being
6410 different from one or the reference being a readonly SV).
6413 void sv_unref_flags(SV *const ref, const U32 flags)
6421 Untaint an SV. Use C<SvTAINTED_off> instead.
6422 void sv_untaint(SV *const sv)
6430 Upgrade an SV to a more complex form. Generally adds a new body type to the
6431 SV, then copies across as much information as possible from the old body.
6432 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
6434 void sv_upgrade(SV *const sv, svtype new_type)
6439 =item sv_usepvn_flags
6442 Tells an SV to use C<ptr> to find its string value. Normally the
6443 string is stored inside the SV but sv_usepvn allows the SV to use an
6444 outside string. The C<ptr> should point to memory that was allocated
6445 by C<malloc>. The string length, C<len>, must be supplied. By default
6446 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
6447 so that pointer should not be freed or used by the programmer after
6448 giving it to sv_usepvn, and neither should any pointers from "behind"
6449 that pointer (e.g. ptr + 1) be used.
6451 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
6452 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
6453 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
6454 C<len>, and already meets the requirements for storing in C<SvPVX>)
6456 void sv_usepvn_flags(SV *const sv, char* ptr, const STRLEN len, const U32 flags)
6461 =item sv_utf8_decode
6464 If the PV of the SV is an octet sequence in UTF-8
6465 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
6466 so that it looks like a character. If the PV contains only single-byte
6467 characters, the C<SvUTF8> flag stays being off.
6468 Scans PV for validity and returns false if the PV is invalid UTF-8.
6470 NOTE: this function is experimental and may change or be
6471 removed without notice.
6473 bool sv_utf8_decode(SV *const sv)
6478 =item sv_utf8_downgrade
6479 X<sv_utf8_downgrade>
6481 Attempts to convert the PV of an SV from characters to bytes.
6482 If the PV contains a character that cannot fit
6483 in a byte, this conversion will fail;
6484 in this case, either returns false or, if C<fail_ok> is not
6487 This is not as a general purpose Unicode to byte encoding interface:
6488 use the Encode extension for that.
6490 NOTE: this function is experimental and may change or be
6491 removed without notice.
6493 bool sv_utf8_downgrade(SV *const sv, const bool fail_ok)
6498 =item sv_utf8_encode
6501 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
6502 flag off so that it looks like octets again.
6504 void sv_utf8_encode(SV *const sv)
6509 =item sv_utf8_upgrade
6512 Converts the PV of an SV to its UTF-8-encoded form.
6513 Forces the SV to string form if it is not already.
6514 Will C<mg_get> on C<sv> if appropriate.
6515 Always sets the SvUTF8 flag to avoid future validity checks even
6516 if the whole string is the same in UTF-8 as not.
6517 Returns the number of bytes in the converted string
6519 This is not as a general purpose byte encoding to Unicode interface:
6520 use the Encode extension for that.
6522 STRLEN sv_utf8_upgrade(SV *sv)
6527 =item sv_utf8_upgrade_flags
6528 X<sv_utf8_upgrade_flags>
6530 Converts the PV of an SV to its UTF-8-encoded form.
6531 Forces the SV to string form if it is not already.
6532 Always sets the SvUTF8 flag to avoid future validity checks even
6533 if all the bytes are invariant in UTF-8. If C<flags> has C<SV_GMAGIC> bit set,
6534 will C<mg_get> on C<sv> if appropriate, else not.
6535 Returns the number of bytes in the converted string
6536 C<sv_utf8_upgrade> and
6537 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
6539 This is not as a general purpose byte encoding to Unicode interface:
6540 use the Encode extension for that.
6542 STRLEN sv_utf8_upgrade_flags(SV *const sv, const I32 flags)
6547 =item sv_utf8_upgrade_nomg
6548 X<sv_utf8_upgrade_nomg>
6550 Like sv_utf8_upgrade, but doesn't do magic on C<sv>
6552 STRLEN sv_utf8_upgrade_nomg(SV *sv)
6560 Processes its arguments like C<vsprintf> and appends the formatted output
6561 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
6563 Usually used via its frontend C<sv_catpvf>.
6565 void sv_vcatpvf(SV *const sv, const char *const pat, va_list *const args)
6573 Processes its arguments like C<vsprintf> and appends the formatted output
6574 to an SV. Uses an array of SVs if the C style variable argument list is
6575 missing (NULL). When running with taint checks enabled, indicates via
6576 C<maybe_tainted> if results are untrustworthy (often due to the use of
6579 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
6581 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)
6589 Like C<sv_vcatpvf>, but also handles 'set' magic.
6591 Usually used via its frontend C<sv_catpvf_mg>.
6593 void sv_vcatpvf_mg(SV *const sv, const char *const pat, va_list *const args)
6601 Works like C<sv_vcatpvf> but copies the text into the SV instead of
6602 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
6604 Usually used via its frontend C<sv_setpvf>.
6606 void sv_vsetpvf(SV *const sv, const char *const pat, va_list *const args)
6614 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
6617 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
6619 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)
6627 Like C<sv_vsetpvf>, but also handles 'set' magic.
6629 Usually used via its frontend C<sv_setpvf_mg>.
6631 void sv_vsetpvf_mg(SV *const sv, const char *const pat, va_list *const args)
6639 =head1 Unicode Support
6643 =item bytes_from_utf8
6646 Converts a string C<s> of length C<len> from UTF-8 into native byte encoding.
6647 Unlike C<utf8_to_bytes> but like C<bytes_to_utf8>, returns a pointer to
6648 the newly-created string, and updates C<len> to contain the new
6649 length. Returns the original string if no conversion occurs, C<len>
6650 is unchanged. Do nothing if C<is_utf8> points to 0. Sets C<is_utf8> to
6651 0 if C<s> is converted or consisted entirely of characters that are invariant
6652 in utf8 (i.e., US-ASCII on non-EBCDIC machines).
6654 NOTE: this function is experimental and may change or be
6655 removed without notice.
6657 U8* bytes_from_utf8(const U8 *s, STRLEN *len, bool *is_utf8)
6660 Found in file utf8.c
6665 Converts a string C<s> of length C<len> from the native encoding into UTF-8.
6666 Returns a pointer to the newly-created string, and sets C<len> to
6667 reflect the new length.
6669 A NUL character will be written after the end of the string.
6671 If you want to convert to UTF-8 from encodings other than
6672 the native (Latin1 or EBCDIC),
6673 see sv_recode_to_utf8().
6675 NOTE: this function is experimental and may change or be
6676 removed without notice.
6678 U8* bytes_to_utf8(const U8 *s, STRLEN *len)
6681 Found in file utf8.c
6686 Return true if the strings s1 and s2 differ case-insensitively, false
6687 if not (if they are equal case-insensitively). If u1 is true, the
6688 string s1 is assumed to be in UTF-8-encoded Unicode. If u2 is true,
6689 the string s2 is assumed to be in UTF-8-encoded Unicode. If u1 or u2
6690 are false, the respective string is assumed to be in native 8-bit
6693 If the pe1 and pe2 are non-NULL, the scanning pointers will be copied
6694 in there (they will point at the beginning of the I<next> character).
6695 If the pointers behind pe1 or pe2 are non-NULL, they are the end
6696 pointers beyond which scanning will not continue under any
6697 circumstances. If the byte lengths l1 and l2 are non-zero, s1+l1 and
6698 s2+l2 will be used as goal end pointers that will also stop the scan,
6699 and which qualify towards defining a successful match: all the scans
6700 that define an explicit length must reach their goal pointers for
6701 a match to succeed).
6703 For case-insensitiveness, the "casefolding" of Unicode is used
6704 instead of upper/lowercasing both the characters, see
6705 http://www.unicode.org/unicode/reports/tr21/ (Case Mappings).
6707 I32 ibcmp_utf8(const char *s1, char **pe1, UV l1, bool u1, const char *s2, char **pe2, UV l2, bool u2)
6710 Found in file utf8.c
6715 Tests if some arbitrary number of bytes begins in a valid UTF-8
6716 character. Note that an INVARIANT (i.e. ASCII on non-EBCDIC machines)
6717 character is a valid UTF-8 character. The actual number of bytes in the UTF-8
6718 character will be returned if it is valid, otherwise 0.
6720 STRLEN is_utf8_char(const U8 *s)
6723 Found in file utf8.c
6725 =item is_utf8_string
6728 Returns true if first C<len> bytes of the given string form a valid
6729 UTF-8 string, false otherwise. Note that 'a valid UTF-8 string' does
6730 not mean 'a string that contains code points above 0x7F encoded in UTF-8'
6731 because a valid ASCII string is a valid UTF-8 string.
6733 See also is_utf8_string_loclen() and is_utf8_string_loc().
6735 bool is_utf8_string(const U8 *s, STRLEN len)
6738 Found in file utf8.c
6740 =item is_utf8_string_loc
6741 X<is_utf8_string_loc>
6743 Like is_utf8_string() but stores the location of the failure (in the
6744 case of "utf8ness failure") or the location s+len (in the case of
6745 "utf8ness success") in the C<ep>.
6747 See also is_utf8_string_loclen() and is_utf8_string().
6749 bool is_utf8_string_loc(const U8 *s, STRLEN len, const U8 **p)
6752 Found in file utf8.c
6754 =item is_utf8_string_loclen
6755 X<is_utf8_string_loclen>
6757 Like is_utf8_string() but stores the location of the failure (in the
6758 case of "utf8ness failure") or the location s+len (in the case of
6759 "utf8ness success") in the C<ep>, and the number of UTF-8
6760 encoded characters in the C<el>.
6762 See also is_utf8_string_loc() and is_utf8_string().
6764 bool is_utf8_string_loclen(const U8 *s, STRLEN len, const U8 **ep, STRLEN *el)
6767 Found in file utf8.c
6769 =item pv_uni_display
6772 Build to the scalar dsv a displayable version of the string spv,
6773 length len, the displayable version being at most pvlim bytes long
6774 (if longer, the rest is truncated and "..." will be appended).
6776 The flags argument can have UNI_DISPLAY_ISPRINT set to display
6777 isPRINT()able characters as themselves, UNI_DISPLAY_BACKSLASH
6778 to display the \\[nrfta\\] as the backslashed versions (like '\n')
6779 (UNI_DISPLAY_BACKSLASH is preferred over UNI_DISPLAY_ISPRINT for \\).
6780 UNI_DISPLAY_QQ (and its alias UNI_DISPLAY_REGEX) have both
6781 UNI_DISPLAY_BACKSLASH and UNI_DISPLAY_ISPRINT turned on.
6783 The pointer to the PV of the dsv is returned.
6785 char* pv_uni_display(SV *dsv, const U8 *spv, STRLEN len, STRLEN pvlim, UV flags)
6788 Found in file utf8.c
6793 The encoding is assumed to be an Encode object, the PV of the ssv is
6794 assumed to be octets in that encoding and decoding the input starts
6795 from the position which (PV + *offset) pointed to. The dsv will be
6796 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
6797 when the string tstr appears in decoding output or the input ends on
6798 the PV of the ssv. The value which the offset points will be modified
6799 to the last input position on the ssv.
6801 Returns TRUE if the terminator was found, else returns FALSE.
6803 bool sv_cat_decode(SV* dsv, SV *encoding, SV *ssv, int *offset, char* tstr, int tlen)
6808 =item sv_recode_to_utf8
6809 X<sv_recode_to_utf8>
6811 The encoding is assumed to be an Encode object, on entry the PV
6812 of the sv is assumed to be octets in that encoding, and the sv
6813 will be converted into Unicode (and UTF-8).
6815 If the sv already is UTF-8 (or if it is not POK), or if the encoding
6816 is not a reference, nothing is done to the sv. If the encoding is not
6817 an C<Encode::XS> Encoding object, bad things will happen.
6818 (See F<lib/encoding.pm> and L<Encode>).
6820 The PV of the sv is returned.
6822 char* sv_recode_to_utf8(SV* sv, SV *encoding)
6827 =item sv_uni_display
6830 Build to the scalar dsv a displayable version of the scalar sv,
6831 the displayable version being at most pvlim bytes long
6832 (if longer, the rest is truncated and "..." will be appended).
6834 The flags argument is as in pv_uni_display().
6836 The pointer to the PV of the dsv is returned.
6838 char* sv_uni_display(SV *dsv, SV *ssv, STRLEN pvlim, UV flags)
6841 Found in file utf8.c
6846 The "p" contains the pointer to the UTF-8 string encoding
6847 the character that is being converted.
6849 The "ustrp" is a pointer to the character buffer to put the
6850 conversion result to. The "lenp" is a pointer to the length
6853 The "swashp" is a pointer to the swash to use.
6855 Both the special and normal mappings are stored lib/unicore/To/Foo.pl,
6856 and loaded by SWASHNEW, using lib/utf8_heavy.pl. The special (usually,
6857 but not always, a multicharacter mapping), is tried first.
6859 The "special" is a string like "utf8::ToSpecLower", which means the
6860 hash %utf8::ToSpecLower. The access to the hash is through
6861 Perl_to_utf8_case().
6863 The "normal" is a string like "ToLower" which means the swash
6866 UV to_utf8_case(const U8 *p, U8* ustrp, STRLEN *lenp, SV **swashp, const char *normal, const char *special)
6869 Found in file utf8.c
6874 Convert the UTF-8 encoded character at p to its foldcase version and
6875 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6876 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6877 foldcase version may be longer than the original character (up to
6880 The first character of the foldcased version is returned
6881 (but note, as explained above, that there may be more.)
6883 UV to_utf8_fold(const U8 *p, U8* ustrp, STRLEN *lenp)
6886 Found in file utf8.c
6891 Convert the UTF-8 encoded character at p to its lowercase version and
6892 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6893 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6894 lowercase version may be longer than the original character.
6896 The first character of the lowercased version is returned
6897 (but note, as explained above, that there may be more.)
6899 UV to_utf8_lower(const U8 *p, U8* ustrp, STRLEN *lenp)
6902 Found in file utf8.c
6907 Convert the UTF-8 encoded character at p to its titlecase version and
6908 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6909 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6910 titlecase version may be longer than the original character.
6912 The first character of the titlecased version is returned
6913 (but note, as explained above, that there may be more.)
6915 UV to_utf8_title(const U8 *p, U8* ustrp, STRLEN *lenp)
6918 Found in file utf8.c
6923 Convert the UTF-8 encoded character at p to its uppercase version and
6924 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6925 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since
6926 the uppercase version may be longer than the original character.
6928 The first character of the uppercased version is returned
6929 (but note, as explained above, that there may be more.)
6931 UV to_utf8_upper(const U8 *p, U8* ustrp, STRLEN *lenp)
6934 Found in file utf8.c
6936 =item utf8n_to_uvchr
6941 Returns the native character value of the first character in the string
6943 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6944 length, in bytes, of that character.
6946 Allows length and flags to be passed to low level routine.
6948 UV utf8n_to_uvchr(const U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags)
6951 Found in file utf8.c
6953 =item utf8n_to_uvuni
6956 Bottom level UTF-8 decode routine.
6957 Returns the Unicode code point value of the first character in the string C<s>
6958 which is assumed to be in UTF-8 encoding and no longer than C<curlen>;
6959 C<retlen> will be set to the length, in bytes, of that character.
6961 If C<s> does not point to a well-formed UTF-8 character, the behaviour
6962 is dependent on the value of C<flags>: if it contains UTF8_CHECK_ONLY,
6963 it is assumed that the caller will raise a warning, and this function
6964 will silently just set C<retlen> to C<-1> and return zero. If the
6965 C<flags> does not contain UTF8_CHECK_ONLY, warnings about
6966 malformations will be given, C<retlen> will be set to the expected
6967 length of the UTF-8 character in bytes, and zero will be returned.
6969 The C<flags> can also contain various flags to allow deviations from
6970 the strict UTF-8 encoding (see F<utf8.h>).
6972 Most code should use utf8_to_uvchr() rather than call this directly.
6974 UV utf8n_to_uvuni(const U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags)
6977 Found in file utf8.c
6982 Returns the number of UTF-8 characters between the UTF-8 pointers C<a>
6985 WARNING: use only if you *know* that the pointers point inside the
6988 IV utf8_distance(const U8 *a, const U8 *b)
6991 Found in file utf8.c
6996 Return the UTF-8 pointer C<s> displaced by C<off> characters, either
6997 forward or backward.
6999 WARNING: do not use the following unless you *know* C<off> is within
7000 the UTF-8 data pointed to by C<s> *and* that on entry C<s> is aligned
7001 on the first byte of character or just after the last byte of a character.
7003 U8* utf8_hop(const U8 *s, I32 off)
7006 Found in file utf8.c
7011 Return the length of the UTF-8 char encoded string C<s> in characters.
7012 Stops at C<e> (inclusive). If C<e E<lt> s> or if the scan would end
7013 up past C<e>, croaks.
7015 STRLEN utf8_length(const U8* s, const U8 *e)
7018 Found in file utf8.c
7023 Converts a string C<s> of length C<len> from UTF-8 into native byte encoding.
7024 Unlike C<bytes_to_utf8>, this over-writes the original string, and
7025 updates len to contain the new length.
7026 Returns zero on failure, setting C<len> to -1.
7028 If you need a copy of the string, see C<bytes_from_utf8>.
7030 NOTE: this function is experimental and may change or be
7031 removed without notice.
7033 U8* utf8_to_bytes(U8 *s, STRLEN *len)
7036 Found in file utf8.c
7041 Returns the native character value of the first character in the string C<s>
7042 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
7043 length, in bytes, of that character.
7045 If C<s> does not point to a well-formed UTF-8 character, zero is
7046 returned and retlen is set, if possible, to -1.
7048 UV utf8_to_uvchr(const U8 *s, STRLEN *retlen)
7051 Found in file utf8.c
7056 Returns the Unicode code point of the first character in the string C<s>
7057 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
7058 length, in bytes, of that character.
7060 This function should only be used when the returned UV is considered
7061 an index into the Unicode semantic tables (e.g. swashes).
7063 If C<s> does not point to a well-formed UTF-8 character, zero is
7064 returned and retlen is set, if possible, to -1.
7066 UV utf8_to_uvuni(const U8 *s, STRLEN *retlen)
7069 Found in file utf8.c
7074 Adds the UTF-8 representation of the Native codepoint C<uv> to the end
7075 of the string C<d>; C<d> should be have at least C<UTF8_MAXBYTES+1> free
7076 bytes available. The return value is the pointer to the byte after the
7077 end of the new character. In other words,
7079 d = uvchr_to_utf8(d, uv);
7081 is the recommended wide native character-aware way of saying
7085 U8* uvchr_to_utf8(U8 *d, UV uv)
7088 Found in file utf8.c
7090 =item uvuni_to_utf8_flags
7091 X<uvuni_to_utf8_flags>
7093 Adds the UTF-8 representation of the Unicode codepoint C<uv> to the end
7094 of the string C<d>; C<d> should be have at least C<UTF8_MAXBYTES+1> free
7095 bytes available. The return value is the pointer to the byte after the
7096 end of the new character. In other words,
7098 d = uvuni_to_utf8_flags(d, uv, flags);
7102 d = uvuni_to_utf8(d, uv);
7104 (which is equivalent to)
7106 d = uvuni_to_utf8_flags(d, uv, 0);
7108 is the recommended Unicode-aware way of saying
7112 U8* uvuni_to_utf8_flags(U8 *d, UV uv, UV flags)
7115 Found in file utf8.c
7120 =head1 Variables created by C<xsubpp> and C<xsubpp> internal functions
7127 Variable which is setup by C<xsubpp> to indicate the stack base offset,
7128 used by the C<ST>, C<XSprePUSH> and C<XSRETURN> macros. The C<dMARK> macro
7129 must be called prior to setup the C<MARK> variable.
7134 Found in file XSUB.h
7139 Variable which is setup by C<xsubpp> to indicate the
7140 class name for a C++ XS constructor. This is always a C<char*>. See C<THIS>.
7145 Found in file XSUB.h
7150 Sets up the C<ax> variable.
7151 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
7156 Found in file XSUB.h
7161 Sets up the C<ax> variable and stack marker variable C<mark>.
7162 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
7167 Found in file XSUB.h
7172 Sets up the C<items> variable.
7173 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
7178 Found in file XSUB.h
7183 Sets up the C<padoff_du> variable for an XSUB that wishes to use
7189 Found in file XSUB.h
7194 Sets up stack and mark pointers for an XSUB, calling dSP and dMARK.
7195 Sets up the C<ax> and C<items> variables by calling C<dAX> and C<dITEMS>.
7196 This is usually handled automatically by C<xsubpp>.
7201 Found in file XSUB.h
7206 Sets up the C<ix> variable for an XSUB which has aliases. This is usually
7207 handled automatically by C<xsubpp>.
7212 Found in file XSUB.h
7217 Variable which is setup by C<xsubpp> to indicate the number of
7218 items on the stack. See L<perlxs/"Variable-length Parameter Lists">.
7223 Found in file XSUB.h
7228 Variable which is setup by C<xsubpp> to indicate which of an
7229 XSUB's aliases was used to invoke it. See L<perlxs/"The ALIAS: Keyword">.
7234 Found in file XSUB.h
7239 Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
7243 Found in file XSUB.h
7248 Variable which is setup by C<xsubpp> to hold the return value for an
7249 XSUB. This is always the proper type for the XSUB. See
7250 L<perlxs/"The RETVAL Variable">.
7255 Found in file XSUB.h
7260 Used to access elements on the XSUB's stack.
7265 Found in file XSUB.h
7270 Variable which is setup by C<xsubpp> to designate the object in a C++
7271 XSUB. This is always the proper type for the C++ object. See C<CLASS> and
7272 L<perlxs/"Using XS With C++">.
7277 Found in file XSUB.h
7282 The SV* corresponding to the $_ variable. Works even if there
7283 is a lexical $_ in scope.
7286 Found in file XSUB.h
7291 Macro to declare an XSUB and its C parameter list. This is handled by
7295 Found in file XSUB.h
7300 The version identifier for an XS module. This is usually
7301 handled automatically by C<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>.
7304 Found in file XSUB.h
7306 =item XS_VERSION_BOOTCHECK
7307 X<XS_VERSION_BOOTCHECK>
7309 Macro to verify that a PM module's $VERSION variable matches the XS
7310 module's C<XS_VERSION> variable. This is usually handled automatically by
7311 C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">.
7313 XS_VERSION_BOOTCHECK;
7316 Found in file XSUB.h
7321 =head1 Warning and Dieing
7328 This is the XSUB-writer's interface to Perl's C<die> function.
7329 Normally call this function the same way you call the C C<printf>
7330 function. Calling C<croak> returns control directly to Perl,
7331 sidestepping the normal C order of execution. See C<warn>.
7333 If you want to throw an exception object, assign the object to
7334 C<$@> and then pass C<NULL> to croak():
7336 errsv = get_sv("@", TRUE);
7337 sv_setsv(errsv, exception_object);
7340 void croak(const char* pat, ...)
7343 Found in file util.c
7348 This is the XSUB-writer's interface to Perl's C<warn> function. Call this
7349 function the same way you call the C C<printf> function. See C<croak>.
7351 void warn(const char* pat, ...)
7354 Found in file util.c
7361 Until May 1997, this document was maintained by Jeff Okamoto
7362 <okamoto@corp.hp.com>. It is now maintained as part of Perl itself.
7364 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
7365 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
7366 Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
7367 Stephen McCamant, and Gurusamy Sarathy.
7369 API Listing originally by Dean Roehrich <roehrich@cray.com>.
7371 Updated to be autogenerated from comments in the source by Benjamin Stuhl.
7375 perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
projects / p5sagit/p5-mst-13.2.git / blob