3 perlapi - autogenerated documentation for the perl public API
6 X<Perl API> X<API> X<api>
8 This file contains the documentation of the perl public API generated by
9 embed.pl, specifically a listing of functions, macros, flags, and variables
10 that may be used by extension writers. The interfaces of any functions that
11 are not listed here are subject to change without notice. For this reason,
12 blindly using functions listed in proto.h is to be avoided when writing
15 Note that all Perl API global variables must be referenced with the C<PL_>
16 prefix. Some macros are provided for compatibility with the older,
17 unadorned names, but this support may be disabled in a future release.
19 The listing is alphabetical, case insensitive.
29 A backward-compatible version of C<GIMME_V> which can only return
30 C<G_SCALAR> or C<G_ARRAY>; in a void context, it returns C<G_SCALAR>.
31 Deprecated. Use C<GIMME_V> instead.
41 The XSUB-writer's equivalent to Perl's C<wantarray>. Returns C<G_VOID>,
42 C<G_SCALAR> or C<G_ARRAY> for void, scalar or list context,
53 Used to indicate list context. See C<GIMME_V>, C<GIMME> and
62 Indicates that arguments returned from a callback should be discarded. See
71 Used to force a Perl C<eval> wrapper around a callback. See
80 Indicates that no arguments are being sent to a callback. See
89 Used to indicate scalar context. See C<GIMME_V>, C<GIMME>, and
98 Used to indicate void context. See C<GIMME_V> and L<perlcall>.
106 =head1 Array Manipulation Functions
113 Same as C<av_len()>. Deprecated, use C<av_len()> instead.
123 Clears an array, making it empty. Does not free the memory used by the
126 void av_clear(AV* ar)
134 Deletes the element indexed by C<key> from the array. Returns the
135 deleted element. If C<flags> equals C<G_DISCARD>, the element is freed
136 and null is returned.
138 SV* av_delete(AV* ar, I32 key, I32 flags)
146 Returns true if the element indexed by C<key> has been initialized.
148 This relies on the fact that uninitialized array elements are set to
151 bool av_exists(AV* ar, I32 key)
159 Pre-extend an array. The C<key> is the index to which the array should be
162 void av_extend(AV* ar, I32 key)
170 Returns the SV at the specified index in the array. The C<key> is the
171 index. If C<lval> is set then the fetch will be part of a store. Check
172 that the return value is non-null before dereferencing it to a C<SV*>.
174 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for
175 more information on how to use this function on tied arrays.
177 SV** av_fetch(AV* ar, I32 key, I32 lval)
185 Ensure than an array has a given number of elements, equivalent to
186 Perl's C<$#array = $fill;>.
188 void av_fill(AV* ar, I32 fill)
196 Returns the highest index in the array. Returns -1 if the array is
199 I32 av_len(const AV* ar)
207 Creates a new AV and populates it with a list of SVs. The SVs are copied
208 into the array, so they may be freed after the call to av_make. The new AV
209 will have a reference count of 1.
211 AV* av_make(I32 size, SV** svp)
219 Pops an SV off the end of the array. Returns C<&PL_sv_undef> if the array
230 Pushes an SV onto the end of the array. The array will grow automatically
231 to accommodate the addition.
233 void av_push(AV* ar, SV* val)
241 Shifts an SV off the beginning of the array.
251 Stores an SV in an array. The array index is specified as C<key>. The
252 return value will be NULL if the operation failed or if the value did not
253 need to be actually stored within the array (as in the case of tied
254 arrays). Otherwise it can be dereferenced to get the original C<SV*>. Note
255 that the caller is responsible for suitably incrementing the reference
256 count of C<val> before the call, and decrementing it if the function
259 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for
260 more information on how to use this function on tied arrays.
262 SV** av_store(AV* ar, I32 key, SV* val)
270 Undefines the array. Frees the memory used by the array itself.
272 void av_undef(AV* ar)
280 Unshift the given number of C<undef> values onto the beginning of the
281 array. The array will grow automatically to accommodate the addition. You
282 must then use C<av_store> to assign values to these new elements.
284 void av_unshift(AV* ar, I32 num)
292 Returns the AV of the specified Perl array. If C<create> is set and the
293 Perl variable does not exist then it will be created. If C<create> is not
294 set and the variable does not exist then NULL is returned.
296 NOTE: the perl_ form of this function is deprecated.
298 AV* get_av(const char* name, I32 create)
306 Creates a new AV. The reference count is set to 1.
316 Sort an array. Here is an example:
318 sortsv(AvARRAY(av), av_len(av)+1, Perl_sv_cmp_locale);
320 See lib/sort.pm for details about controlling the sorting algorithm.
322 void sortsv(SV** array, size_t num_elts, SVCOMPARE_t cmp)
325 Found in file pp_sort.c
330 =head1 Callback Functions
337 Performs a callback to the specified Perl sub. See L<perlcall>.
339 NOTE: the perl_ form of this function is deprecated.
341 I32 call_argv(const char* sub_name, I32 flags, char** argv)
349 Performs a callback to the specified Perl method. The blessed object must
350 be on the stack. See L<perlcall>.
352 NOTE: the perl_ form of this function is deprecated.
354 I32 call_method(const char* methname, I32 flags)
362 Performs a callback to the specified Perl sub. See L<perlcall>.
364 NOTE: the perl_ form of this function is deprecated.
366 I32 call_pv(const char* sub_name, I32 flags)
374 Performs a callback to the Perl sub whose name is in the SV. See
377 NOTE: the perl_ form of this function is deprecated.
379 I32 call_sv(SV* sv, I32 flags)
387 Opening bracket on a callback. See C<LEAVE> and L<perlcall>.
392 Found in file scope.h
397 Tells Perl to C<eval> the given string and return an SV* result.
399 NOTE: the perl_ form of this function is deprecated.
401 SV* eval_pv(const char* p, I32 croak_on_error)
409 Tells Perl to C<eval> the string in the SV.
411 NOTE: the perl_ form of this function is deprecated.
413 I32 eval_sv(SV* sv, I32 flags)
421 Closing bracket for temporaries on a callback. See C<SAVETMPS> and
427 Found in file scope.h
432 Closing bracket on a callback. See C<ENTER> and L<perlcall>.
437 Found in file scope.h
442 Opening bracket for temporaries on a callback. See C<FREETMPS> and
448 Found in file scope.h
453 =head1 Character classes
460 Returns a boolean indicating whether the C C<char> is an ASCII alphanumeric
461 character (including underscore) or digit.
463 bool isALNUM(char ch)
466 Found in file handy.h
471 Returns a boolean indicating whether the C C<char> is an ASCII alphabetic
474 bool isALPHA(char ch)
477 Found in file handy.h
482 Returns a boolean indicating whether the C C<char> is an ASCII
485 bool isDIGIT(char ch)
488 Found in file handy.h
493 Returns a boolean indicating whether the C C<char> is a lowercase
496 bool isLOWER(char ch)
499 Found in file handy.h
504 Returns a boolean indicating whether the C C<char> is whitespace.
506 bool isSPACE(char ch)
509 Found in file handy.h
514 Returns a boolean indicating whether the C C<char> is an uppercase
517 bool isUPPER(char ch)
520 Found in file handy.h
525 Converts the specified character to lowercase.
527 char toLOWER(char ch)
530 Found in file handy.h
535 Converts the specified character to uppercase.
537 char toUPPER(char ch)
540 Found in file handy.h
545 =head1 Cloning an interpreter
552 Create and return a new interpreter by cloning the current one.
554 perl_clone takes these flags as parameters:
556 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
557 without it we only clone the data and zero the stacks,
558 with it we copy the stacks and the new perl interpreter is
559 ready to run at the exact same point as the previous one.
560 The pseudo-fork code uses COPY_STACKS while the
561 threads->new doesn't.
563 CLONEf_KEEP_PTR_TABLE
564 perl_clone keeps a ptr_table with the pointer of the old
565 variable as a key and the new variable as a value,
566 this allows it to check if something has been cloned and not
567 clone it again but rather just use the value and increase the
568 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
569 the ptr_table using the function
570 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
571 reason to keep it around is if you want to dup some of your own
572 variable who are outside the graph perl scans, example of this
573 code is in threads.xs create
576 This is a win32 thing, it is ignored on unix, it tells perls
577 win32host code (which is c++) to clone itself, this is needed on
578 win32 if you want to run two threads at the same time,
579 if you just want to do some stuff in a separate perl interpreter
580 and then throw it away and return to the original one,
581 you don't need to do anything.
583 PerlInterpreter* perl_clone(PerlInterpreter* interp, UV flags)
591 =head1 CV Manipulation Functions
598 Returns the stash of the CV.
608 Returns the CV of the specified Perl subroutine. If C<create> is set and
609 the Perl subroutine does not exist then it will be declared (which has the
610 same effect as saying C<sub name;>). If C<create> is not set and the
611 subroutine does not exist then NULL is returned.
613 NOTE: the perl_ form of this function is deprecated.
615 CV* get_cv(const char* name, I32 create)
623 =head1 Embedding Functions
630 Clear out all the active components of a CV. This can happen either
631 by an explicit C<undef &foo>, or by the reference count going to zero.
632 In the former case, we keep the CvOUTSIDE pointer, so that any anonymous
633 children can still follow the full lexical scope chain.
635 void cv_undef(CV* cv)
643 Loads the module whose name is pointed to by the string part of name.
644 Note that the actual module name, not its filename, should be given.
645 Eg, "Foo::Bar" instead of "Foo/Bar.pm". flags can be any of
646 PERL_LOADMOD_DENY, PERL_LOADMOD_NOIMPORT, or PERL_LOADMOD_IMPORT_OPS
647 (or 0 for no flags). ver, if specified, provides version semantics
648 similar to C<use Foo::Bar VERSION>. The optional trailing SV*
649 arguments can be used to specify arguments to the module's import()
650 method, similar to C<use Foo::Bar VERSION LIST>.
652 void load_module(U32 flags, SV* name, SV* ver, ...)
660 Stub that provides thread hook for perl_destruct when there are
671 Allocates a new Perl interpreter. See L<perlembed>.
673 PerlInterpreter* perl_alloc()
681 Initializes a new Perl interpreter. See L<perlembed>.
683 void perl_construct(PerlInterpreter* interp)
691 Shuts down a Perl interpreter. See L<perlembed>.
693 int perl_destruct(PerlInterpreter* interp)
701 Releases a Perl interpreter. See L<perlembed>.
703 void perl_free(PerlInterpreter* interp)
711 Tells a Perl interpreter to parse a Perl script. See L<perlembed>.
713 int perl_parse(PerlInterpreter* interp, XSINIT_t xsinit, int argc, char** argv, char** env)
721 Tells a Perl interpreter to run. See L<perlembed>.
723 int perl_run(PerlInterpreter* interp)
731 Tells Perl to C<require> the file named by the string argument. It is
732 analogous to the Perl code C<eval "require '$file'">. It's even
733 implemented that way; consider using load_module instead.
735 NOTE: the perl_ form of this function is deprecated.
737 void require_pv(const char* pv)
745 =head1 Functions in file mathoms.c
753 See L<gv_fetchmethod_autoload>.
755 GV* gv_fetchmethod(HV* stash, const char* name)
758 Found in file mathoms.c
760 =item sv_2pvbyte_nolen
763 Return a pointer to the byte-encoded representation of the SV.
764 May cause the SV to be downgraded from UTF-8 as a side-effect.
766 Usually accessed via the C<SvPVbyte_nolen> macro.
768 char* sv_2pvbyte_nolen(SV* sv)
771 Found in file mathoms.c
773 =item sv_2pvutf8_nolen
776 Return a pointer to the UTF-8-encoded representation of the SV.
777 May cause the SV to be upgraded to UTF-8 as a side-effect.
779 Usually accessed via the C<SvPVutf8_nolen> macro.
781 char* sv_2pvutf8_nolen(SV* sv)
784 Found in file mathoms.c
789 Like C<sv_2pv()>, but doesn't return the length too. You should usually
790 use the macro wrapper C<SvPV_nolen(sv)> instead.
791 char* sv_2pv_nolen(SV* sv)
794 Found in file mathoms.c
799 Like C<sv_catpvn>, but also handles 'set' magic.
801 void sv_catpvn_mg(SV *sv, const char *ptr, STRLEN len)
804 Found in file mathoms.c
809 Like C<sv_catsv>, but also handles 'set' magic.
811 void sv_catsv_mg(SV *dstr, SV *sstr)
814 Found in file mathoms.c
816 =item sv_force_normal
819 Undo various types of fakery on an SV: if the PV is a shared string, make
820 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
821 an xpvmg. See also C<sv_force_normal_flags>.
823 void sv_force_normal(SV *sv)
826 Found in file mathoms.c
831 A private implementation of the C<SvIVx> macro for compilers which can't
832 cope with complex macro expressions. Always use the macro instead.
837 Found in file mathoms.c
842 Dummy routine which "locks" an SV when there is no locking module present.
843 Exists to avoid test for a NULL function pointer and because it could
844 potentially warn under some level of strict-ness.
846 "Superseded" by sv_nosharing().
848 void sv_nolocking(SV *)
851 Found in file mathoms.c
856 Dummy routine which "unlocks" an SV when there is no locking module present.
857 Exists to avoid test for a NULL function pointer and because it could
858 potentially warn under some level of strict-ness.
860 "Superseded" by sv_nosharing().
862 void sv_nounlocking(SV *)
865 Found in file mathoms.c
870 A private implementation of the C<SvNVx> macro for compilers which can't
871 cope with complex macro expressions. Always use the macro instead.
876 Found in file mathoms.c
881 Use the C<SvPV_nolen> macro instead
886 Found in file mathoms.c
891 Use C<SvPVbyte_nolen> instead.
893 char* sv_pvbyte(SV *sv)
896 Found in file mathoms.c
901 A private implementation of the C<SvPVbyte> macro for compilers
902 which can't cope with complex macro expressions. Always use the macro
905 char* sv_pvbyten(SV *sv, STRLEN *len)
908 Found in file mathoms.c
913 A private implementation of the C<SvPV> macro for compilers which can't
914 cope with complex macro expressions. Always use the macro instead.
916 char* sv_pvn(SV *sv, STRLEN *len)
919 Found in file mathoms.c
924 Use the C<SvPVutf8_nolen> macro instead
926 char* sv_pvutf8(SV *sv)
929 Found in file mathoms.c
934 A private implementation of the C<SvPVutf8> macro for compilers
935 which can't cope with complex macro expressions. Always use the macro
938 char* sv_pvutf8n(SV *sv, STRLEN *len)
941 Found in file mathoms.c
946 Taint an SV. Use C<SvTAINTED_on> instead.
947 void sv_taint(SV* sv)
950 Found in file mathoms.c
955 Unsets the RV status of the SV, and decrements the reference count of
956 whatever was being referenced by the RV. This can almost be thought of
957 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
958 being zero. See C<SvROK_off>.
960 void sv_unref(SV* sv)
963 Found in file mathoms.c
968 A private implementation of the C<SvUVx> macro for compilers which can't
969 cope with complex macro expressions. Always use the macro instead.
974 Found in file mathoms.c
981 Returns the native character value of the first character in the string
983 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
984 length, in bytes, of that character.
986 Allows length and flags to be passed to low level routine.
988 UV utf8n_to_uvchr(const U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags)
991 Found in file mathoms.c
996 Adds the UTF-8 representation of the Native codepoint C<uv> to the end
997 of the string C<d>; C<d> should be have at least C<UTF8_MAXBYTES+1> free
998 bytes available. The return value is the pointer to the byte after the
999 end of the new character. In other words,
1001 d = uvchr_to_utf8(d, uv);
1003 is the recommended wide native character-aware way of saying
1007 U8* uvchr_to_utf8(U8 *d, UV uv)
1010 Found in file mathoms.c
1015 =head1 Functions in file pp_pack.c
1023 The engine implementing pack() Perl function.
1025 void packlist(SV *cat, const char *pat, const char *patend, SV **beglist, SV **endlist)
1028 Found in file pp_pack.c
1033 The engine implementing pack() Perl function. Note: parameters next_in_list and
1034 flags are not used. This call should not be used; use packlist instead.
1036 void pack_cat(SV *cat, const char *pat, const char *patend, SV **beglist, SV **endlist, SV ***next_in_list, U32 flags)
1039 Found in file pp_pack.c
1044 The engine implementing unpack() Perl function. C<unpackstring> puts the
1045 extracted list items on the stack and returns the number of elements.
1046 Issue C<PUTBACK> before and C<SPAGAIN> after the call to this function.
1048 I32 unpackstring(const char *pat, const char *patend, const char *s, const char *strend, U32 flags)
1051 Found in file pp_pack.c
1056 The engine implementing unpack() Perl function. Note: parameters strbeg, new_s
1057 and ocnt are not used. This call should not be used, use unpackstring instead.
1059 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)
1062 Found in file pp_pack.c
1067 =head1 Global Variables
1074 C<PL_modglobal> is a general purpose, interpreter global HV for use by
1075 extensions that need to keep information on a per-interpreter basis.
1076 In a pinch, it can also be used as a symbol table for extensions
1077 to share data among each other. It is a good idea to use keys
1078 prefixed by the package name of the extension that owns the data.
1083 Found in file intrpvar.h
1088 A convenience variable which is typically used with C<SvPV> when one
1089 doesn't care about the length of the string. It is usually more efficient
1090 to either declare a local variable and use that instead or to use the
1091 C<SvPV_nolen> macro.
1096 Found in file thrdvar.h
1101 This is the C<false> SV. See C<PL_sv_yes>. Always refer to this as
1107 Found in file intrpvar.h
1112 This is the C<undef> SV. Always refer to this as C<&PL_sv_undef>.
1117 Found in file intrpvar.h
1122 This is the C<true> SV. See C<PL_sv_no>. Always refer to this as
1128 Found in file intrpvar.h
1140 Return the SV from the GV.
1150 Returns the glob with the given C<name> and a defined subroutine or
1151 C<NULL>. The glob lives in the given C<stash>, or in the stashes
1152 accessible via @ISA and UNIVERSAL::.
1154 The argument C<level> should be either 0 or -1. If C<level==0>, as a
1155 side-effect creates a glob with the given C<name> in the given C<stash>
1156 which in the case of success contains an alias for the subroutine, and sets
1157 up caching info for this glob. Similarly for all the searched stashes.
1159 This function grants C<"SUPER"> token as a postfix of the stash name. The
1160 GV returned from C<gv_fetchmeth> may be a method cache entry, which is not
1161 visible to Perl code. So when calling C<call_sv>, you should not use
1162 the GV directly; instead, you should use the method's CV, which can be
1163 obtained from the GV with the C<GvCV> macro.
1165 GV* gv_fetchmeth(HV* stash, const char* name, STRLEN len, I32 level)
1170 =item gv_fetchmethod_autoload
1171 X<gv_fetchmethod_autoload>
1173 Returns the glob which contains the subroutine to call to invoke the method
1174 on the C<stash>. In fact in the presence of autoloading this may be the
1175 glob for "AUTOLOAD". In this case the corresponding variable $AUTOLOAD is
1178 The third parameter of C<gv_fetchmethod_autoload> determines whether
1179 AUTOLOAD lookup is performed if the given method is not present: non-zero
1180 means yes, look for AUTOLOAD; zero means no, don't look for AUTOLOAD.
1181 Calling C<gv_fetchmethod> is equivalent to calling C<gv_fetchmethod_autoload>
1182 with a non-zero C<autoload> parameter.
1184 These functions grant C<"SUPER"> token as a prefix of the method name. Note
1185 that if you want to keep the returned glob for a long time, you need to
1186 check for it being "AUTOLOAD", since at the later time the call may load a
1187 different subroutine due to $AUTOLOAD changing its value. Use the glob
1188 created via a side effect to do this.
1190 These functions have the same side-effects and as C<gv_fetchmeth> with
1191 C<level==0>. C<name> should be writable if contains C<':'> or C<'
1192 ''>. The warning against passing the GV returned by C<gv_fetchmeth> to
1193 C<call_sv> apply equally to these functions.
1195 GV* gv_fetchmethod_autoload(HV* stash, const char* name, I32 autoload)
1200 =item gv_fetchmeth_autoload
1201 X<gv_fetchmeth_autoload>
1203 Same as gv_fetchmeth(), but looks for autoloaded subroutines too.
1204 Returns a glob for the subroutine.
1206 For an autoloaded subroutine without a GV, will create a GV even
1207 if C<level < 0>. For an autoloaded subroutine without a stub, GvCV()
1208 of the result may be zero.
1210 GV* gv_fetchmeth_autoload(HV* stash, const char* name, STRLEN len, I32 level)
1218 Returns a pointer to the stash for a specified package. C<name> should
1219 be a valid UTF-8 string and must be null-terminated. If C<create> is set
1220 then the package will be created if it does not already exist. If C<create>
1221 is not set and the package does not exist then NULL is returned.
1223 HV* gv_stashpv(const char* name, I32 create)
1231 Returns a pointer to the stash for a specified package. C<name> should
1232 be a valid UTF-8 string. The C<namelen> parameter indicates the length of
1233 the C<name>, in bytes. If C<create> is set then the package will be
1234 created if it does not already exist. If C<create> is not set and the
1235 package does not exist then NULL is returned.
1237 HV* gv_stashpvn(const char* name, U32 namelen, I32 create)
1245 Returns a pointer to the stash for a specified package, which must be a
1246 valid UTF-8 string. See C<gv_stashpv>.
1248 HV* gv_stashsv(SV* sv, I32 create)
1271 Null character pointer.
1274 Found in file handy.h
1298 Found in file handy.h
1303 =head1 Hash Manipulation Functions
1310 Returns the HV of the specified Perl hash. If C<create> is set and the
1311 Perl variable does not exist then it will be created. If C<create> is not
1312 set and the variable does not exist then NULL is returned.
1314 NOTE: the perl_ form of this function is deprecated.
1316 HV* get_hv(const char* name, I32 create)
1319 Found in file perl.c
1324 This flag, used in the length slot of hash entries and magic structures,
1325 specifies the structure contains an C<SV*> pointer where a C<char*> pointer
1326 is to be expected. (For information only--not to be used).
1334 Returns the computed hash stored in the hash entry.
1344 Returns the actual pointer stored in the key slot of the hash entry. The
1345 pointer may be either C<char*> or C<SV*>, depending on the value of
1346 C<HeKLEN()>. Can be assigned to. The C<HePV()> or C<HeSVKEY()> macros are
1347 usually preferable for finding the value of a key.
1357 If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry
1358 holds an C<SV*> key. Otherwise, holds the actual length of the key. Can
1359 be assigned to. The C<HePV()> macro is usually preferable for finding key
1362 STRLEN HeKLEN(HE* he)
1370 Returns the key slot of the hash entry as a C<char*> value, doing any
1371 necessary dereferencing of possibly C<SV*> keys. The length of the string
1372 is placed in C<len> (this is a macro, so do I<not> use C<&len>). If you do
1373 not care about what the length of the key is, you may use the global
1374 variable C<PL_na>, though this is rather less efficient than using a local
1375 variable. Remember though, that hash keys in perl are free to contain
1376 embedded nulls, so using C<strlen()> or similar is not a good way to find
1377 the length of hash keys. This is very similar to the C<SvPV()> macro
1378 described elsewhere in this document.
1380 char* HePV(HE* he, STRLEN len)
1388 Returns the key as an C<SV*>, or C<Nullsv> if the hash entry does not
1389 contain an C<SV*> key.
1399 Returns the key as an C<SV*>. Will create and return a temporary mortal
1400 C<SV*> if the hash entry contains only a C<char*> key.
1402 SV* HeSVKEY_force(HE* he)
1410 Sets the key to a given C<SV*>, taking care to set the appropriate flags to
1411 indicate the presence of an C<SV*> key, and returns the same
1414 SV* HeSVKEY_set(HE* he, SV* sv)
1422 Returns the value slot (type C<SV*>) stored in the hash entry.
1432 Returns the package name of a stash, or NULL if C<stash> isn't a stash.
1433 See C<SvSTASH>, C<CvSTASH>.
1435 char* HvNAME(HV* stash)
1443 Check that a hash is in an internally consistent state.
1445 void hv_assert(HV* tb)
1453 Clears a hash, making it empty.
1455 void hv_clear(HV* tb)
1460 =item hv_clear_placeholders
1461 X<hv_clear_placeholders>
1463 Clears any placeholders from a hash. If a restricted hash has any of its keys
1464 marked as readonly and the key is subsequently deleted, the key is not actually
1465 deleted but is marked by assigning it a value of &PL_sv_placeholder. This tags
1466 it so it will be ignored by future operations such as iterating over the hash,
1467 but will still allow the hash to have a value reassigned to the key at some
1468 future point. This function clears any such placeholder keys from the hash.
1469 See Hash::Util::lock_keys() for an example of its use.
1471 void hv_clear_placeholders(HV* hb)
1479 Deletes a key/value pair in the hash. The value SV is removed from the
1480 hash and returned to the caller. The C<klen> is the length of the key.
1481 The C<flags> value will normally be zero; if set to G_DISCARD then NULL
1484 SV* hv_delete(HV* tb, const char* key, I32 klen, I32 flags)
1492 Deletes a key/value pair in the hash. The value SV is removed from the
1493 hash and returned to the caller. The C<flags> value will normally be zero;
1494 if set to G_DISCARD then NULL will be returned. C<hash> can be a valid
1495 precomputed hash value, or 0 to ask for it to be computed.
1497 SV* hv_delete_ent(HV* tb, SV* key, I32 flags, U32 hash)
1505 Returns a boolean indicating whether the specified hash key exists. The
1506 C<klen> is the length of the key.
1508 bool hv_exists(HV* tb, const char* key, I32 klen)
1516 Returns a boolean indicating whether the specified hash key exists. C<hash>
1517 can be a valid precomputed hash value, or 0 to ask for it to be
1520 bool hv_exists_ent(HV* tb, SV* key, U32 hash)
1528 Returns the SV which corresponds to the specified key in the hash. The
1529 C<klen> is the length of the key. If C<lval> is set then the fetch will be
1530 part of a store. Check that the return value is non-null before
1531 dereferencing it to an C<SV*>.
1533 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1534 information on how to use this function on tied hashes.
1536 SV** hv_fetch(HV* tb, const char* key, I32 klen, I32 lval)
1544 Returns the hash entry which corresponds to the specified key in the hash.
1545 C<hash> must be a valid precomputed hash number for the given C<key>, or 0
1546 if you want the function to compute it. IF C<lval> is set then the fetch
1547 will be part of a store. Make sure the return value is non-null before
1548 accessing it. The return value when C<tb> is a tied hash is a pointer to a
1549 static location, so be sure to make a copy of the structure if you need to
1552 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1553 information on how to use this function on tied hashes.
1555 HE* hv_fetch_ent(HV* tb, SV* key, I32 lval, U32 hash)
1563 Prepares a starting point to traverse a hash table. Returns the number of
1564 keys in the hash (i.e. the same as C<HvKEYS(tb)>). The return value is
1565 currently only meaningful for hashes without tie magic.
1567 NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
1568 hash buckets that happen to be in use. If you still need that esoteric
1569 value, you can get it through the macro C<HvFILL(tb)>.
1572 I32 hv_iterinit(HV* tb)
1580 Returns the key from the current position of the hash iterator. See
1583 char* hv_iterkey(HE* entry, I32* retlen)
1591 Returns the key as an C<SV*> from the current position of the hash
1592 iterator. The return value will always be a mortal copy of the key. Also
1595 SV* hv_iterkeysv(HE* entry)
1603 Returns entries from a hash iterator. See C<hv_iterinit>.
1605 You may call C<hv_delete> or C<hv_delete_ent> on the hash entry that the
1606 iterator currently points to, without losing your place or invalidating your
1607 iterator. Note that in this case the current entry is deleted from the hash
1608 with your iterator holding the last reference to it. Your iterator is flagged
1609 to free the entry on the next call to C<hv_iternext>, so you must not discard
1610 your iterator immediately else the entry will leak - call C<hv_iternext> to
1611 trigger the resource deallocation.
1613 HE* hv_iternext(HV* tb)
1621 Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
1624 SV* hv_iternextsv(HV* hv, char** key, I32* retlen)
1629 =item hv_iternext_flags
1630 X<hv_iternext_flags>
1632 Returns entries from a hash iterator. See C<hv_iterinit> and C<hv_iternext>.
1633 The C<flags> value will normally be zero; if HV_ITERNEXT_WANTPLACEHOLDERS is
1634 set the placeholders keys (for restricted hashes) will be returned in addition
1635 to normal keys. By default placeholders are automatically skipped over.
1636 Currently a placeholder is implemented with a value that is
1637 C<&Perl_sv_placeholder>. Note that the implementation of placeholders and
1638 restricted hashes may change, and the implementation currently is
1639 insufficiently abstracted for any change to be tidy.
1641 NOTE: this function is experimental and may change or be
1642 removed without notice.
1644 HE* hv_iternext_flags(HV* tb, I32 flags)
1652 Returns the value from the current position of the hash iterator. See
1655 SV* hv_iterval(HV* tb, HE* entry)
1663 Adds magic to a hash. See C<sv_magic>.
1665 void hv_magic(HV* hv, GV* gv, int how)
1673 Evaluates the hash in scalar context and returns the result. Handles magic when the hash is tied.
1675 SV* hv_scalar(HV* hv)
1683 Stores an SV in a hash. The hash key is specified as C<key> and C<klen> is
1684 the length of the key. The C<hash> parameter is the precomputed hash
1685 value; if it is zero then Perl will compute it. The return value will be
1686 NULL if the operation failed or if the value did not need to be actually
1687 stored within the hash (as in the case of tied hashes). Otherwise it can
1688 be dereferenced to get the original C<SV*>. Note that the caller is
1689 responsible for suitably incrementing the reference count of C<val> before
1690 the call, and decrementing it if the function returned NULL. Effectively
1691 a successful hv_store takes ownership of one reference to C<val>. This is
1692 usually what you want; a newly created SV has a reference count of one, so
1693 if all your code does is create SVs then store them in a hash, hv_store
1694 will own the only reference to the new SV, and your code doesn't need to do
1695 anything further to tidy up. hv_store is not implemented as a call to
1696 hv_store_ent, and does not create a temporary SV for the key, so if your
1697 key data is not already in SV form then use hv_store in preference to
1700 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1701 information on how to use this function on tied hashes.
1703 SV** hv_store(HV* tb, const char* key, I32 klen, SV* val, U32 hash)
1711 Stores C<val> in a hash. The hash key is specified as C<key>. The C<hash>
1712 parameter is the precomputed hash value; if it is zero then Perl will
1713 compute it. The return value is the new hash entry so created. It will be
1714 NULL if the operation failed or if the value did not need to be actually
1715 stored within the hash (as in the case of tied hashes). Otherwise the
1716 contents of the return value can be accessed using the C<He?> macros
1717 described here. Note that the caller is responsible for suitably
1718 incrementing the reference count of C<val> before the call, and
1719 decrementing it if the function returned NULL. Effectively a successful
1720 hv_store_ent takes ownership of one reference to C<val>. This is
1721 usually what you want; a newly created SV has a reference count of one, so
1722 if all your code does is create SVs then store them in a hash, hv_store
1723 will own the only reference to the new SV, and your code doesn't need to do
1724 anything further to tidy up. Note that hv_store_ent only reads the C<key>;
1725 unlike C<val> it does not take ownership of it, so maintaining the correct
1726 reference count on C<key> is entirely the caller's responsibility. hv_store
1727 is not implemented as a call to hv_store_ent, and does not create a temporary
1728 SV for the key, so if your key data is not already in SV form then use
1729 hv_store in preference to hv_store_ent.
1731 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1732 information on how to use this function on tied hashes.
1734 HE* hv_store_ent(HV* tb, SV* key, SV* val, U32 hash)
1744 void hv_undef(HV* tb)
1752 Creates a new HV. The reference count is set to 1.
1762 =head1 Magical Functions
1769 Clear something magical that the SV represents. See C<sv_magic>.
1771 int mg_clear(SV* sv)
1779 Copies the magic from one SV to another. See C<sv_magic>.
1781 int mg_copy(SV* sv, SV* nsv, const char* key, I32 klen)
1789 Finds the magic pointer for type matching the SV. See C<sv_magic>.
1791 MAGIC* mg_find(const SV* sv, int type)
1799 Free any magic storage used by the SV. See C<sv_magic>.
1809 Do magic after a value is retrieved from the SV. See C<sv_magic>.
1819 Report on the SV's length. See C<sv_magic>.
1821 U32 mg_length(SV* sv)
1829 Turns on the magical status of an SV. See C<sv_magic>.
1831 void mg_magical(SV* sv)
1839 Do magic after a value is assigned to the SV. See C<sv_magic>.
1849 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
1850 argument more than once.
1852 void SvGETMAGIC(SV* sv)
1860 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
1871 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
1872 argument more than once.
1874 void SvSETMAGIC(SV* sv)
1882 Like C<SvSetSV>, but does any set magic required afterwards.
1884 void SvSetMagicSV(SV* dsb, SV* ssv)
1889 =item SvSetMagicSV_nosteal
1890 X<SvSetMagicSV_nosteal>
1892 Like C<SvSetSV_nosteal>, but does any set magic required afterwards.
1894 void SvSetMagicSV_nosteal(SV* dsv, SV* ssv)
1902 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
1905 void SvSetSV(SV* dsb, SV* ssv)
1910 =item SvSetSV_nosteal
1913 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
1914 ssv. May evaluate arguments more than once.
1916 void SvSetSV_nosteal(SV* dsv, SV* ssv)
1924 Arranges for sv to be shared between threads if a suitable module
1927 void SvSHARE(SV* sv)
1935 Releases a mutual exclusion lock on sv if a suitable module
1938 void SvUNLOCK(SV* sv)
1946 =head1 Memory Management
1953 The XSUB-writer's interface to the C C<memcpy> function. The C<src> is the
1954 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1955 the type. May fail on overlapping copies. See also C<Move>.
1957 void Copy(void* src, void* dest, int nitems, type)
1960 Found in file handy.h
1965 Like C<Copy> but returns dest. Useful for encouraging compilers to tail-call
1968 void * CopyD(void* src, void* dest, int nitems, type)
1971 Found in file handy.h
1976 The XSUB-writer's interface to the C C<memmove> function. The C<src> is the
1977 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1978 the type. Can do overlapping moves. See also C<Copy>.
1980 void Move(void* src, void* dest, int nitems, type)
1983 Found in file handy.h
1988 Like C<Move> but returns dest. Useful for encouraging compilers to tail-call
1991 void * MoveD(void* src, void* dest, int nitems, type)
1994 Found in file handy.h
1999 The XSUB-writer's interface to the C C<malloc> function.
2001 In 5.9.3, Newx() and friends replace the older New() API, and drops
2002 the first parameter, I<x>, a debug aid which allowed callers to identify
2003 themselves. This aid has been superceded by a new build option,
2004 PERL_MEM_LOG (see L<perlhack/PERL_MEM_LOG>). The older API is still
2005 there for use in XS modules supporting older perls.
2007 void Newx(void* ptr, int nitems, type)
2010 Found in file handy.h
2015 The XSUB-writer's interface to the C C<malloc> function, with
2016 cast. See also C<Newx>.
2018 void Newxc(void* ptr, int nitems, type, cast)
2021 Found in file handy.h
2026 The XSUB-writer's interface to the C C<malloc> function. The allocated
2027 memory is zeroed with C<memzero>. See also C<Newx>.
2029 void Newxz(void* ptr, int nitems, type)
2032 Found in file handy.h
2037 Fill up memory with a pattern (byte 0xAB over and over again) that
2038 hopefully catches attempts to access uninitialized memory.
2040 void Poison(void* dest, int nitems, type)
2043 Found in file handy.h
2048 The XSUB-writer's interface to the C C<realloc> function.
2050 void Renew(void* ptr, int nitems, type)
2053 Found in file handy.h
2058 The XSUB-writer's interface to the C C<realloc> function, with
2061 void Renewc(void* ptr, int nitems, type, cast)
2064 Found in file handy.h
2069 The XSUB-writer's interface to the C C<free> function.
2071 void Safefree(void* ptr)
2074 Found in file handy.h
2079 Perl's version of C<strdup()>. Returns a pointer to a newly allocated
2080 string which is a duplicate of C<pv>. The size of the string is
2081 determined by C<strlen()>. The memory allocated for the new string can
2082 be freed with the C<Safefree()> function.
2084 char* savepv(const char* pv)
2087 Found in file util.c
2092 Perl's version of what C<strndup()> would be if it existed. Returns a
2093 pointer to a newly allocated string which is a duplicate of the first
2094 C<len> bytes from C<pv>. The memory allocated for the new string can be
2095 freed with the C<Safefree()> function.
2097 char* savepvn(const char* pv, I32 len)
2100 Found in file util.c
2105 A version of C<savepv()> which allocates the duplicate string in memory
2106 which is shared between threads.
2108 char* savesharedpv(const char* pv)
2111 Found in file util.c
2116 A version of C<savepv()>/C<savepvn()> which gets the string to duplicate from
2117 the passed in SV using C<SvPV()>
2119 char* savesvpv(SV* sv)
2122 Found in file util.c
2127 This is an architecture-independent macro to copy one structure to another.
2129 void StructCopy(type src, type dest, type)
2132 Found in file handy.h
2137 The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the
2138 destination, C<nitems> is the number of items, and C<type> is the type.
2140 void Zero(void* dest, int nitems, type)
2143 Found in file handy.h
2148 Like C<Zero> but returns dest. Useful for encouraging compilers to tail-call
2151 void * ZeroD(void* dest, int nitems, type)
2154 Found in file handy.h
2159 =head1 Miscellaneous Functions
2166 Analyses the string in order to make fast searches on it using fbm_instr()
2167 -- the Boyer-Moore algorithm.
2169 void fbm_compile(SV* sv, U32 flags)
2172 Found in file util.c
2177 Returns the location of the SV in the string delimited by C<str> and
2178 C<strend>. It returns C<Nullch> if the string can't be found. The C<sv>
2179 does not have to be fbm_compiled, but the search will not be as fast
2182 char* fbm_instr(unsigned char* big, unsigned char* bigend, SV* littlesv, U32 flags)
2185 Found in file util.c
2190 Takes a sprintf-style format pattern and conventional
2191 (non-SV) arguments and returns the formatted string.
2193 (char *) Perl_form(pTHX_ const char* pat, ...)
2195 can be used any place a string (char *) is required:
2197 char * s = Perl_form("%d.%d",major,minor);
2199 Uses a single private buffer so if you want to format several strings you
2200 must explicitly copy the earlier strings away (and free the copies when you
2203 char* form(const char* pat, ...)
2206 Found in file util.c
2211 Fill the sv with current working directory
2213 int getcwd_sv(SV* sv)
2216 Found in file util.c
2221 The C library C<sprintf>, wrapped if necessary, to ensure that it will return
2222 the length of the string written to the buffer. Only rare pre-ANSI systems
2223 need the wrapper function - usually this is a direct call to C<sprintf>.
2225 int my_sprintf(char *buffer, const char *pat, ...)
2228 Found in file util.c
2233 Returns a new version object based on the passed in SV:
2235 SV *sv = new_version(SV *ver);
2237 Does not alter the passed in ver SV. See "upg_version" if you
2238 want to upgrade the SV.
2240 SV* new_version(SV *ver)
2243 Found in file util.c
2248 Returns a pointer to the next character after the parsed
2249 version string, as well as upgrading the passed in SV to
2252 Function must be called with an already existing SV like
2255 s = scan_version(s,SV *sv, bool qv);
2257 Performs some preprocessing to the string to ensure that
2258 it has the correct characteristics of a version. Flags the
2259 object if it contains an underscore (which denotes this
2260 is a alpha version). The boolean qv denotes that the version
2261 should be interpreted as if it had multiple decimals, even if
2264 const char* scan_version(const char *vstr, SV *sv, bool qv)
2267 Found in file util.c
2272 Test two strings to see if they are equal. Returns true or false.
2274 bool strEQ(char* s1, char* s2)
2277 Found in file handy.h
2282 Test two strings to see if the first, C<s1>, is greater than or equal to
2283 the second, C<s2>. Returns true or false.
2285 bool strGE(char* s1, char* s2)
2288 Found in file handy.h
2293 Test two strings to see if the first, C<s1>, is greater than the second,
2294 C<s2>. Returns true or false.
2296 bool strGT(char* s1, char* s2)
2299 Found in file handy.h
2304 Test two strings to see if the first, C<s1>, is less than or equal to the
2305 second, C<s2>. Returns true or false.
2307 bool strLE(char* s1, char* s2)
2310 Found in file handy.h
2315 Test two strings to see if the first, C<s1>, is less than the second,
2316 C<s2>. Returns true or false.
2318 bool strLT(char* s1, char* s2)
2321 Found in file handy.h
2326 Test two strings to see if they are different. Returns true or
2329 bool strNE(char* s1, char* s2)
2332 Found in file handy.h
2337 Test two strings to see if they are equal. The C<len> parameter indicates
2338 the number of bytes to compare. Returns true or false. (A wrapper for
2341 bool strnEQ(char* s1, char* s2, STRLEN len)
2344 Found in file handy.h
2349 Test two strings to see if they are different. The C<len> parameter
2350 indicates the number of bytes to compare. Returns true or false. (A
2351 wrapper for C<strncmp>).
2353 bool strnNE(char* s1, char* s2, STRLEN len)
2356 Found in file handy.h
2361 Dummy routine which "shares" an SV when there is no sharing module present.
2362 Or "locks" it. Or "unlocks" it. In other words, ignores its single SV argument.
2363 Exists to avoid test for a NULL function pointer and because it could
2364 potentially warn under some level of strict-ness.
2366 void sv_nosharing(SV *)
2369 Found in file util.c
2374 In-place upgrade of the supplied SV to a version object.
2376 SV *sv = upg_version(SV *sv);
2378 Returns a pointer to the upgraded SV.
2380 SV* upg_version(SV *ver)
2383 Found in file util.c
2388 Version object aware cmp. Both operands must already have been
2389 converted into version objects.
2391 int vcmp(SV *lvs, SV *rvs)
2394 Found in file util.c
2399 Accepts a version object and returns the normalized string
2400 representation. Call like:
2404 NOTE: you can pass either the object directly or the SV
2405 contained within the RV.
2410 Found in file util.c
2415 Accepts a version object and returns the normalized floating
2416 point representation. Call like:
2420 NOTE: you can pass either the object directly or the SV
2421 contained within the RV.
2426 Found in file util.c
2431 In order to maintain maximum compatibility with earlier versions
2432 of Perl, this function will return either the floating point
2433 notation or the multiple dotted notation, depending on whether
2434 the original version contained 1 or more dots, respectively
2436 SV* vstringify(SV *vs)
2439 Found in file util.c
2444 Validates that the SV contains a valid version object.
2446 bool vverify(SV *vobj);
2448 Note that it only confirms the bare minimum structure (so as not to get
2449 confused by derived classes which may contain additional hash entries):
2451 bool vverify(SV *vs)
2454 Found in file util.c
2459 =head1 Numeric functions
2466 converts a string representing a binary number to numeric form.
2468 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2469 conversion flags, and I<result> should be NULL or a pointer to an NV.
2470 The scan stops at the end of the string, or the first invalid character.
2471 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2472 invalid character will also trigger a warning.
2473 On return I<*len> is set to the length of the scanned string,
2474 and I<*flags> gives output flags.
2476 If the value is <= C<UV_MAX> it is returned as a UV, the output flags are clear,
2477 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_bin>
2478 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2479 and writes the value to I<*result> (or the value is discarded if I<result>
2482 The binary number may optionally be prefixed with "0b" or "b" unless
2483 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
2484 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the binary
2485 number may use '_' characters to separate digits.
2487 UV grok_bin(const char* start, STRLEN* len_p, I32* flags, NV *result)
2490 Found in file numeric.c
2495 converts a string representing a hex number to numeric form.
2497 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2498 conversion flags, and I<result> should be NULL or a pointer to an NV.
2499 The scan stops at the end of the string, or the first invalid character.
2500 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2501 invalid character will also trigger a warning.
2502 On return I<*len> is set to the length of the scanned string,
2503 and I<*flags> gives output flags.
2505 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2506 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_hex>
2507 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2508 and writes the value to I<*result> (or the value is discarded if I<result>
2511 The hex number may optionally be prefixed with "0x" or "x" unless
2512 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
2513 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the hex
2514 number may use '_' characters to separate digits.
2516 UV grok_hex(const char* start, STRLEN* len_p, I32* flags, NV *result)
2519 Found in file numeric.c
2524 Recognise (or not) a number. The type of the number is returned
2525 (0 if unrecognised), otherwise it is a bit-ORed combination of
2526 IS_NUMBER_IN_UV, IS_NUMBER_GREATER_THAN_UV_MAX, IS_NUMBER_NOT_INT,
2527 IS_NUMBER_NEG, IS_NUMBER_INFINITY, IS_NUMBER_NAN (defined in perl.h).
2529 If the value of the number can fit an in UV, it is returned in the *valuep
2530 IS_NUMBER_IN_UV will be set to indicate that *valuep is valid, IS_NUMBER_IN_UV
2531 will never be set unless *valuep is valid, but *valuep may have been assigned
2532 to during processing even though IS_NUMBER_IN_UV is not set on return.
2533 If valuep is NULL, IS_NUMBER_IN_UV will be set for the same cases as when
2534 valuep is non-NULL, but no actual assignment (or SEGV) will occur.
2536 IS_NUMBER_NOT_INT will be set with IS_NUMBER_IN_UV if trailing decimals were
2537 seen (in which case *valuep gives the true value truncated to an integer), and
2538 IS_NUMBER_NEG if the number is negative (in which case *valuep holds the
2539 absolute value). IS_NUMBER_IN_UV is not set if e notation was used or the
2540 number is larger than a UV.
2542 int grok_number(const char *pv, STRLEN len, UV *valuep)
2545 Found in file numeric.c
2547 =item grok_numeric_radix
2548 X<grok_numeric_radix>
2550 Scan and skip for a numeric decimal separator (radix).
2552 bool grok_numeric_radix(const char **sp, const char *send)
2555 Found in file numeric.c
2560 converts a string representing an octal number to numeric form.
2562 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2563 conversion flags, and I<result> should be NULL or a pointer to an NV.
2564 The scan stops at the end of the string, or the first invalid character.
2565 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2566 invalid character will also trigger a warning.
2567 On return I<*len> is set to the length of the scanned string,
2568 and I<*flags> gives output flags.
2570 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2571 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_oct>
2572 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2573 and writes the value to I<*result> (or the value is discarded if I<result>
2576 If C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the octal
2577 number may use '_' characters to separate digits.
2579 UV grok_oct(const char* start, STRLEN* len_p, I32* flags, NV *result)
2582 Found in file numeric.c
2587 For backwards compatibility. Use C<grok_bin> instead.
2589 NV scan_bin(const char* start, STRLEN len, STRLEN* retlen)
2592 Found in file numeric.c
2597 For backwards compatibility. Use C<grok_hex> instead.
2599 NV scan_hex(const char* start, STRLEN len, STRLEN* retlen)
2602 Found in file numeric.c
2607 For backwards compatibility. Use C<grok_oct> instead.
2609 NV scan_oct(const char* start, STRLEN len, STRLEN* retlen)
2612 Found in file numeric.c
2617 =head1 Optree Manipulation Functions
2624 If C<cv> is a constant sub eligible for inlining. returns the constant
2625 value returned by the sub. Otherwise, returns NULL.
2627 Constant subs can be created with C<newCONSTSUB> or as described in
2628 L<perlsub/"Constant Functions">.
2630 SV* cv_const_sv(CV* cv)
2638 Creates a constant sub equivalent to Perl C<sub FOO () { 123 }> which is
2639 eligible for inlining at compile-time.
2641 CV* newCONSTSUB(HV* stash, const char* name, SV* sv)
2649 Used by C<xsubpp> to hook up XSUBs as Perl subs.
2657 =head1 Pad Data Structures
2664 Get the value at offset po in the current pad.
2665 Use macro PAD_SV instead of calling this function directly.
2667 SV* pad_sv(PADOFFSET po)
2675 =head1 Simple Exception Handling Macros
2682 Set up necessary local variables for exception handling.
2683 See L<perlguts/"Exception Handling">.
2688 Found in file XSUB.h
2693 Introduces a catch block. See L<perlguts/"Exception Handling">.
2696 Found in file XSUB.h
2701 Rethrows a previously caught exception. See L<perlguts/"Exception Handling">.
2706 Found in file XSUB.h
2711 Ends a try block. See L<perlguts/"Exception Handling">.
2714 Found in file XSUB.h
2716 =item XCPT_TRY_START
2719 Starts a try block. See L<perlguts/"Exception Handling">.
2722 Found in file XSUB.h
2727 =head1 Stack Manipulation Macros
2734 Declare a stack marker variable, C<mark>, for the XSUB. See C<MARK> and
2745 Saves the original stack mark for the XSUB. See C<ORIGMARK>.
2755 Declares a local copy of perl's stack pointer for the XSUB, available via
2756 the C<SP> macro. See C<SP>.
2766 Used to extend the argument stack for an XSUB's return values. Once
2767 used, guarantees that there is room for at least C<nitems> to be pushed
2770 void EXTEND(SP, int nitems)
2778 Stack marker variable for the XSUB. See C<dMARK>.
2786 Push an integer onto the stack. The stack must have room for this element.
2787 Handles 'set' magic. Does not use C<TARG>. See also C<PUSHi>, C<mXPUSHi>
2798 Push a double onto the stack. The stack must have room for this element.
2799 Handles 'set' magic. Does not use C<TARG>. See also C<PUSHn>, C<mXPUSHn>
2810 Push a string onto the stack. The stack must have room for this element.
2811 The C<len> indicates the length of the string. Handles 'set' magic. Does
2812 not use C<TARG>. See also C<PUSHp>, C<mXPUSHp> and C<XPUSHp>.
2814 void mPUSHp(char* str, STRLEN len)
2822 Push an unsigned integer onto the stack. The stack must have room for this
2823 element. Handles 'set' magic. Does not use C<TARG>. See also C<PUSHu>,
2824 C<mXPUSHu> and C<XPUSHu>.
2834 Push an integer onto the stack, extending the stack if necessary. Handles
2835 'set' magic. Does not use C<TARG>. See also C<XPUSHi>, C<mPUSHi> and
2846 Push a double onto the stack, extending the stack if necessary. Handles
2847 'set' magic. Does not use C<TARG>. See also C<XPUSHn>, C<mPUSHn> and
2858 Push a string onto the stack, extending the stack if necessary. The C<len>
2859 indicates the length of the string. Handles 'set' magic. Does not use
2860 C<TARG>. See also C<XPUSHp>, C<mPUSHp> and C<PUSHp>.
2862 void mXPUSHp(char* str, STRLEN len)
2870 Push an unsigned integer onto the stack, extending the stack if necessary.
2871 Handles 'set' magic. Does not use C<TARG>. See also C<XPUSHu>, C<mPUSHu>
2882 The original stack mark for the XSUB. See C<dORIGMARK>.
2890 Pops an integer off the stack.
2900 Pops a long off the stack.
2910 Pops a double off the stack.
2920 Pops a string off the stack. Deprecated. New code should use POPpx.
2930 Pops a string off the stack which must consist of bytes i.e. characters < 256.
2940 Pops a string off the stack.
2950 Pops an SV off the stack.
2960 Push an integer onto the stack. The stack must have room for this element.
2961 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
2962 called to declare it. Do not call multiple C<TARG>-oriented macros to
2963 return lists from XSUB's - see C<mPUSHi> instead. See also C<XPUSHi> and
2974 Opening bracket for arguments on a callback. See C<PUTBACK> and
2985 Push a new mortal SV onto the stack. The stack must have room for this
2986 element. Does not handle 'set' magic. Does not use C<TARG>. See also
2987 C<PUSHs>, C<XPUSHmortal> and C<XPUSHs>.
2997 Push a double onto the stack. The stack must have room for this element.
2998 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
2999 called to declare it. Do not call multiple C<TARG>-oriented macros to
3000 return lists from XSUB's - see C<mPUSHn> instead. See also C<XPUSHn> and
3011 Push a string onto the stack. The stack must have room for this element.
3012 The C<len> indicates the length of the string. Handles 'set' magic. Uses
3013 C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to declare it. Do not
3014 call multiple C<TARG>-oriented macros to return lists from XSUB's - see
3015 C<mPUSHp> instead. See also C<XPUSHp> and C<mXPUSHp>.
3017 void PUSHp(char* str, STRLEN len)
3025 Push an SV onto the stack. The stack must have room for this element.
3026 Does not handle 'set' magic. Does not use C<TARG>. See also C<PUSHmortal>,
3027 C<XPUSHs> and C<XPUSHmortal>.
3037 Push an unsigned integer onto the stack. The stack must have room for this
3038 element. Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG>
3039 should be called to declare it. Do not call multiple C<TARG>-oriented
3040 macros to return lists from XSUB's - see C<mPUSHu> instead. See also
3041 C<XPUSHu> and C<mXPUSHu>.
3051 Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
3052 See C<PUSHMARK> and L<perlcall> for other uses.
3062 Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and
3071 Refetch the stack pointer. Used after a callback. See L<perlcall>.
3081 Push an integer onto the stack, extending the stack if necessary. Handles
3082 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
3083 declare it. Do not call multiple C<TARG>-oriented macros to return lists
3084 from XSUB's - see C<mXPUSHi> instead. See also C<PUSHi> and C<mPUSHi>.
3094 Push a new mortal SV onto the stack, extending the stack if necessary. Does
3095 not handle 'set' magic. Does not use C<TARG>. See also C<XPUSHs>,
3096 C<PUSHmortal> and C<PUSHs>.
3106 Push a double onto the stack, extending the stack if necessary. Handles
3107 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
3108 declare it. Do not call multiple C<TARG>-oriented macros to return lists
3109 from XSUB's - see C<mXPUSHn> instead. See also C<PUSHn> and C<mPUSHn>.
3119 Push a string onto the stack, extending the stack if necessary. The C<len>
3120 indicates the length of the string. Handles 'set' magic. Uses C<TARG>, so
3121 C<dTARGET> or C<dXSTARG> should be called to declare it. Do not call
3122 multiple C<TARG>-oriented macros to return lists from XSUB's - see
3123 C<mXPUSHp> instead. See also C<PUSHp> and C<mPUSHp>.
3125 void XPUSHp(char* str, STRLEN len)
3133 Push an SV onto the stack, extending the stack if necessary. Does not
3134 handle 'set' magic. Does not use C<TARG>. See also C<XPUSHmortal>,
3135 C<PUSHs> and C<PUSHmortal>.
3145 Push an unsigned integer onto the stack, extending the stack if necessary.
3146 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3147 called to declare it. Do not call multiple C<TARG>-oriented macros to
3148 return lists from XSUB's - see C<mXPUSHu> instead. See also C<PUSHu> and
3159 Return from XSUB, indicating number of items on the stack. This is usually
3160 handled by C<xsubpp>.
3162 void XSRETURN(int nitems)
3165 Found in file XSUB.h
3167 =item XSRETURN_EMPTY
3170 Return an empty list from an XSUB immediately.
3175 Found in file XSUB.h
3180 Return an integer from an XSUB immediately. Uses C<XST_mIV>.
3182 void XSRETURN_IV(IV iv)
3185 Found in file XSUB.h
3190 Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
3195 Found in file XSUB.h
3200 Return a double from an XSUB immediately. Uses C<XST_mNV>.
3202 void XSRETURN_NV(NV nv)
3205 Found in file XSUB.h
3210 Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
3212 void XSRETURN_PV(char* str)
3215 Found in file XSUB.h
3217 =item XSRETURN_UNDEF
3220 Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
3225 Found in file XSUB.h
3230 Return an integer from an XSUB immediately. Uses C<XST_mUV>.
3232 void XSRETURN_UV(IV uv)
3235 Found in file XSUB.h
3240 Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
3245 Found in file XSUB.h
3250 Place an integer into the specified position C<pos> on the stack. The
3251 value is stored in a new mortal SV.
3253 void XST_mIV(int pos, IV iv)
3256 Found in file XSUB.h
3261 Place C<&PL_sv_no> into the specified position C<pos> on the
3264 void XST_mNO(int pos)
3267 Found in file XSUB.h
3272 Place a double into the specified position C<pos> on the stack. The value
3273 is stored in a new mortal SV.
3275 void XST_mNV(int pos, NV nv)
3278 Found in file XSUB.h
3283 Place a copy of a string into the specified position C<pos> on the stack.
3284 The value is stored in a new mortal SV.
3286 void XST_mPV(int pos, char* str)
3289 Found in file XSUB.h
3294 Place C<&PL_sv_undef> into the specified position C<pos> on the
3297 void XST_mUNDEF(int pos)
3300 Found in file XSUB.h
3305 Place C<&PL_sv_yes> into the specified position C<pos> on the
3308 void XST_mYES(int pos)
3311 Found in file XSUB.h
3323 An enum of flags for Perl types. These are found in the file B<sv.h>
3324 in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
3332 Integer type flag for scalars. See C<svtype>.
3340 Double type flag for scalars. See C<svtype>.
3348 Pointer type flag for scalars. See C<svtype>.
3356 Type flag for arrays. See C<svtype>.
3364 Type flag for code refs. See C<svtype>.
3372 Type flag for hashes. See C<svtype>.
3380 Type flag for blessed scalars. See C<svtype>.
3388 =head1 SV Manipulation Functions
3395 Returns the SV of the specified Perl scalar. If C<create> is set and the
3396 Perl variable does not exist then it will be created. If C<create> is not
3397 set and the variable does not exist then NULL is returned.
3399 NOTE: the perl_ form of this function is deprecated.
3401 SV* get_sv(const char* name, I32 create)
3404 Found in file perl.c
3406 =item looks_like_number
3407 X<looks_like_number>
3409 Test if the content of an SV looks like a number (or is a number).
3410 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
3411 non-numeric warning), even if your atof() doesn't grok them.
3413 I32 looks_like_number(SV* sv)
3421 Creates an RV wrapper for an SV. The reference count for the original SV is
3424 SV* newRV_inc(SV* sv)
3432 Creates an RV wrapper for an SV. The reference count for the original
3433 SV is B<not> incremented.
3435 SV* newRV_noinc(SV *sv)
3443 Creates a new SV. A non-zero C<len> parameter indicates the number of
3444 bytes of preallocated string space the SV should have. An extra byte for a
3445 tailing NUL is also reserved. (SvPOK is not set for the SV even if string
3446 space is allocated.) The reference count for the new SV is set to 1.
3447 C<id> is an integer id between 0 and 1299 (used to identify leaks).
3449 SV* NEWSV(int id, STRLEN len)
3452 Found in file handy.h
3457 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
3458 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
3461 SV* newSV(STRLEN len)
3469 Creates a new SV from the hash key structure. It will generate scalars that
3470 point to the shared string table where possible. Returns a new (undefined)
3471 SV if the hek is NULL.
3473 SV* newSVhek(const HEK *hek)
3481 Creates a new SV and copies an integer into it. The reference count for the
3492 Creates a new SV and copies a floating point value into it.
3493 The reference count for the SV is set to 1.
3503 Creates a new SV and copies a string into it. The reference count for the
3504 SV is set to 1. If C<len> is zero, Perl will compute the length using
3505 strlen(). For efficiency, consider using C<newSVpvn> instead.
3507 SV* newSVpv(const char* s, STRLEN len)
3515 Creates a new SV and initializes it with the string formatted like
3518 SV* newSVpvf(const char* pat, ...)
3526 Creates a new SV and copies a string into it. The reference count for the
3527 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
3528 string. You are responsible for ensuring that the source string is at least
3529 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
3531 SV* newSVpvn(const char* s, STRLEN len)
3536 =item newSVpvn_share
3539 Creates a new SV with its SvPVX_const pointing to a shared string in the string
3540 table. If the string does not already exist in the table, it is created
3541 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
3542 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
3543 otherwise the hash is computed. The idea here is that as the string table
3544 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
3545 hash lookup will avoid string compare.
3547 SV* newSVpvn_share(const char* s, I32 len, U32 hash)
3555 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
3556 it will be upgraded to one. If C<classname> is non-null then the new SV will
3557 be blessed in the specified package. The new SV is returned and its
3558 reference count is 1.
3560 SV* newSVrv(SV* rv, const char* classname)
3568 Creates a new SV which is an exact duplicate of the original SV.
3571 SV* newSVsv(SV* old)
3579 Creates a new SV and copies an unsigned integer into it.
3580 The reference count for the SV is set to 1.
3590 Returns the length of the string which is in the SV. See C<SvLEN>.
3592 STRLEN SvCUR(SV* sv)
3600 Set the current length of the string which is in the SV. See C<SvCUR>
3603 void SvCUR_set(SV* sv, STRLEN len)
3611 Returns a pointer to the last character in the string which is in the SV.
3612 See C<SvCUR>. Access the character as *(SvEND(sv)).
3622 Expands the character buffer in the SV so that it has room for the
3623 indicated number of bytes (remember to reserve space for an extra trailing
3624 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
3625 Returns a pointer to the character buffer.
3627 char * SvGROW(SV* sv, STRLEN len)
3635 Returns a boolean indicating whether the SV contains an integer.
3645 Returns a boolean indicating whether the SV contains an integer. Checks
3646 the B<private> setting. Use C<SvIOK>.
3656 Returns a boolean indicating whether the SV contains a signed integer.
3658 bool SvIOK_notUV(SV* sv)
3666 Unsets the IV status of an SV.
3668 void SvIOK_off(SV* sv)
3676 Tells an SV that it is an integer.
3678 void SvIOK_on(SV* sv)
3686 Tells an SV that it is an integer and disables all other OK bits.
3688 void SvIOK_only(SV* sv)
3696 Tells and SV that it is an unsigned integer and disables all other OK bits.
3698 void SvIOK_only_UV(SV* sv)
3706 Returns a boolean indicating whether the SV contains an unsigned integer.
3708 bool SvIOK_UV(SV* sv)
3716 Returns a boolean indicating whether the SV is Copy-On-Write. (either shared
3717 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
3720 bool SvIsCOW(SV* sv)
3725 =item SvIsCOW_shared_hash
3726 X<SvIsCOW_shared_hash>
3728 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
3731 bool SvIsCOW_shared_hash(SV* sv)
3739 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
3740 version which guarantees to evaluate sv only once.
3750 Returns the raw value in the SV's IV slot, without checks or conversions.
3751 Only use when you are sure SvIOK is true. See also C<SvIV()>.
3761 Coerces the given SV to an integer and returns it. Guarantees to evaluate
3762 sv only once. Use the more efficient C<SvIV> otherwise.
3772 Like C<SvIV> but doesn't process magic.
3774 IV SvIV_nomg(SV* sv)
3782 Set the value of the IV pointer in sv to val. It is possible to perform
3783 the same function of this macro with an lvalue assignment to C<SvIVX>.
3784 With future Perls, however, it will be more efficient to use
3785 C<SvIV_set> instead of the lvalue assignment to C<SvIVX>.
3787 void SvIV_set(SV* sv, IV val)
3795 Returns the size of the string buffer in the SV, not including any part
3796 attributable to C<SvOOK>. See C<SvCUR>.
3798 STRLEN SvLEN(SV* sv)
3806 Set the actual length of the string which is in the SV. See C<SvIV_set>.
3808 void SvLEN_set(SV* sv, STRLEN len)
3816 Set the value of the MAGIC pointer in sv to val. See C<SvIV_set>.
3818 void SvMAGIC_set(SV* sv, MAGIC* val)
3826 Returns a boolean indicating whether the SV contains a number, integer or
3837 Returns a boolean indicating whether the SV contains a number, integer or
3838 double. Checks the B<private> setting. Use C<SvNIOK>.
3840 bool SvNIOKp(SV* sv)
3848 Unsets the NV/IV status of an SV.
3850 void SvNIOK_off(SV* sv)
3858 Returns a boolean indicating whether the SV contains a double.
3868 Returns a boolean indicating whether the SV contains a double. Checks the
3869 B<private> setting. Use C<SvNOK>.
3879 Unsets the NV status of an SV.
3881 void SvNOK_off(SV* sv)
3889 Tells an SV that it is a double.
3891 void SvNOK_on(SV* sv)
3899 Tells an SV that it is a double and disables all other OK bits.
3901 void SvNOK_only(SV* sv)
3909 Coerce the given SV to a double and return it. See C<SvNVx> for a version
3910 which guarantees to evaluate sv only once.
3920 Returns the raw value in the SV's NV slot, without checks or conversions.
3921 Only use when you are sure SvNOK is true. See also C<SvNV()>.
3931 Coerces the given SV to a double and returns it. Guarantees to evaluate
3932 sv only once. Use the more efficient C<SvNV> otherwise.
3942 Set the value of the NV pointer in sv to val. See C<SvIV_set>.
3944 void SvNV_set(SV* sv, NV val)
3952 Returns a boolean indicating whether the value is an SV. It also tells
3953 whether the value is defined or not.
3963 Returns a boolean indicating whether the SvIVX is a valid offset value for
3964 the SvPVX. This hack is used internally to speed up removal of characters
3965 from the beginning of a SvPV. When SvOOK is true, then the start of the
3966 allocated string buffer is really (SvPVX - SvIVX).
3976 Returns a boolean indicating whether the SV contains a character
3987 Returns a boolean indicating whether the SV contains a character string.
3988 Checks the B<private> setting. Use C<SvPOK>.
3998 Unsets the PV status of an SV.
4000 void SvPOK_off(SV* sv)
4008 Tells an SV that it is a string.
4010 void SvPOK_on(SV* sv)
4018 Tells an SV that it is a string and disables all other OK bits.
4019 Will also turn off the UTF-8 status.
4021 void SvPOK_only(SV* sv)
4026 =item SvPOK_only_UTF8
4029 Tells an SV that it is a string and disables all other OK bits,
4030 and leaves the UTF-8 status as it was.
4032 void SvPOK_only_UTF8(SV* sv)
4040 Returns a pointer to the string in the SV, or a stringified form of
4041 the SV if the SV does not contain a string. The SV may cache the
4042 stringified version becoming C<SvPOK>. Handles 'get' magic. See also
4043 C<SvPVx> for a version which guarantees to evaluate sv only once.
4045 char* SvPV(SV* sv, STRLEN len)
4053 Like C<SvPV>, but converts sv to byte representation first if necessary.
4055 char* SvPVbyte(SV* sv, STRLEN len)
4063 Like C<SvPV>, but converts sv to byte representation first if necessary.
4064 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
4067 char* SvPVbytex(SV* sv, STRLEN len)
4072 =item SvPVbytex_force
4075 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
4076 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
4079 char* SvPVbytex_force(SV* sv, STRLEN len)
4084 =item SvPVbyte_force
4087 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
4089 char* SvPVbyte_force(SV* sv, STRLEN len)
4094 =item SvPVbyte_nolen
4097 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
4099 char* SvPVbyte_nolen(SV* sv)
4107 Like C<SvPV>, but converts sv to utf8 first if necessary.
4109 char* SvPVutf8(SV* sv, STRLEN len)
4117 Like C<SvPV>, but converts sv to utf8 first if necessary.
4118 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
4121 char* SvPVutf8x(SV* sv, STRLEN len)
4126 =item SvPVutf8x_force
4129 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
4130 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
4133 char* SvPVutf8x_force(SV* sv, STRLEN len)
4138 =item SvPVutf8_force
4141 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
4143 char* SvPVutf8_force(SV* sv, STRLEN len)
4148 =item SvPVutf8_nolen
4151 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
4153 char* SvPVutf8_nolen(SV* sv)
4161 Returns a pointer to the physical string in the SV. The SV must contain a
4172 A version of C<SvPV> which guarantees to evaluate sv only once.
4174 char* SvPVx(SV* sv, STRLEN len)
4182 Like C<SvPV> but will force the SV into containing just a string
4183 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
4186 char* SvPV_force(SV* sv, STRLEN len)
4191 =item SvPV_force_nomg
4194 Like C<SvPV> but will force the SV into containing just a string
4195 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
4196 directly. Doesn't process magic.
4198 char* SvPV_force_nomg(SV* sv, STRLEN len)
4206 Returns a pointer to the string in the SV, or a stringified form of
4207 the SV if the SV does not contain a string. The SV may cache the
4208 stringified form becoming C<SvPOK>. Handles 'get' magic.
4210 char* SvPV_nolen(SV* sv)
4218 Like C<SvPV> but doesn't process magic.
4220 char* SvPV_nomg(SV* sv, STRLEN len)
4228 Set the value of the PV pointer in sv to val. See C<SvIV_set>.
4230 void SvPV_set(SV* sv, char* val)
4238 Returns the value of the object's reference count.
4240 U32 SvREFCNT(SV* sv)
4248 Decrements the reference count of the given SV.
4250 void SvREFCNT_dec(SV* sv)
4258 Increments the reference count of the given SV.
4260 SV* SvREFCNT_inc(SV* sv)
4268 Tests if the SV is an RV.
4278 Unsets the RV status of an SV.
4280 void SvROK_off(SV* sv)
4288 Tells an SV that it is an RV.
4290 void SvROK_on(SV* sv)
4298 Dereferences an RV to return the SV.
4308 Set the value of the RV pointer in sv to val. See C<SvIV_set>.
4310 void SvRV_set(SV* sv, SV* val)
4318 Returns the stash of the SV.
4328 Set the value of the STASH pointer in sv to val. See C<SvIV_set>.
4330 void SvSTASH_set(SV* sv, STASH* val)
4338 Taints an SV if tainting is enabled.
4340 void SvTAINT(SV* sv)
4348 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
4351 bool SvTAINTED(SV* sv)
4359 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
4360 some of Perl's fundamental security features. XS module authors should not
4361 use this function unless they fully understand all the implications of
4362 unconditionally untainting the value. Untainting should be done in the
4363 standard perl fashion, via a carefully crafted regexp, rather than directly
4364 untainting variables.
4366 void SvTAINTED_off(SV* sv)
4374 Marks an SV as tainted if tainting is enabled.
4376 void SvTAINTED_on(SV* sv)
4384 Returns a boolean indicating whether Perl would evaluate the SV as true or
4385 false, defined or undefined. Does not handle 'get' magic.
4395 Returns the type of the SV. See C<svtype>.
4397 svtype SvTYPE(SV* sv)
4405 Returns a boolean indicating whether the SV contains an unsigned integer.
4415 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
4416 perform the upgrade if necessary. See C<svtype>.
4418 void SvUPGRADE(SV* sv, svtype type)
4426 Returns a boolean indicating whether the SV contains UTF-8 encoded data.
4436 Unsets the UTF-8 status of an SV.
4438 void SvUTF8_off(SV *sv)
4446 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
4447 Do not use frivolously.
4449 void SvUTF8_on(SV *sv)
4457 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
4458 for a version which guarantees to evaluate sv only once.
4468 Returns the raw value in the SV's UV slot, without checks or conversions.
4469 Only use when you are sure SvIOK is true. See also C<SvUV()>.
4479 Coerces the given SV to an unsigned integer and returns it. Guarantees to
4480 evaluate sv only once. Use the more efficient C<SvUV> otherwise.
4490 Like C<SvUV> but doesn't process magic.
4492 UV SvUV_nomg(SV* sv)
4500 Set the value of the UV pointer in sv to val. See C<SvIV_set>.
4502 void SvUV_set(SV* sv, UV val)
4510 Returns a boolean indicating whether the SV contains a v-string.
4520 This function is only called on magical items, and is only used by
4521 sv_true() or its macro equivalent.
4523 bool sv_2bool(SV* sv)
4531 Using various gambits, try to get a CV from an SV; in addition, try if
4532 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
4534 CV* sv_2cv(SV* sv, HV** st, GV** gvp, I32 lref)
4542 Using various gambits, try to get an IO from an SV: the IO slot if its a
4543 GV; or the recursive result if we're an RV; or the IO slot of the symbol
4544 named after the PV if we're a string.
4554 Return the integer value of an SV, doing any necessary string
4555 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
4556 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
4558 IV sv_2iv_flags(SV* sv, I32 flags)
4566 Marks an existing SV as mortal. The SV will be destroyed "soon", either
4567 by an explicit call to FREETMPS, or by an implicit call at places such as
4568 statement boundaries. SvTEMP() is turned on which means that the SV's
4569 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
4570 and C<sv_mortalcopy>.
4572 SV* sv_2mortal(SV* sv)
4580 Return the num value of an SV, doing any necessary string or integer
4581 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
4592 Return a pointer to the byte-encoded representation of the SV, and set *lp
4593 to its length. May cause the SV to be downgraded from UTF-8 as a
4596 Usually accessed via the C<SvPVbyte> macro.
4598 char* sv_2pvbyte(SV* sv, STRLEN* lp)
4606 Returns a pointer to the string value of an SV, and sets *lp to its length.
4607 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
4609 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
4610 usually end up here too.
4612 char* sv_2pv_flags(SV* sv, STRLEN* lp, I32 flags)
4620 Return the unsigned integer value of an SV, doing any necessary string
4621 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
4622 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
4624 UV sv_2uv_flags(SV* sv, I32 flags)
4632 Remove any string offset. You should normally use the C<SvOOK_off> macro
4635 int sv_backoff(SV* sv)
4643 Blesses an SV into a specified package. The SV must be an RV. The package
4644 must be designated by its stash (see C<gv_stashpv()>). The reference count
4645 of the SV is unaffected.
4647 SV* sv_bless(SV* sv, HV* stash)
4655 Concatenates the string onto the end of the string which is in the SV.
4656 If the SV has the UTF-8 status set, then the bytes appended should be
4657 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4659 void sv_catpv(SV* sv, const char* ptr)
4667 Processes its arguments like C<sprintf> and appends the formatted
4668 output to an SV. If the appended data contains "wide" characters
4669 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
4670 and characters >255 formatted with %c), the original SV might get
4671 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
4672 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
4673 valid UTF-8; if the original SV was bytes, the pattern should be too.
4675 void sv_catpvf(SV* sv, const char* pat, ...)
4683 Like C<sv_catpvf>, but also handles 'set' magic.
4685 void sv_catpvf_mg(SV *sv, const char* pat, ...)
4693 Concatenates the string onto the end of the string which is in the SV. The
4694 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4695 status set, then the bytes appended should be valid UTF-8.
4696 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4698 void sv_catpvn(SV* sv, const char* ptr, STRLEN len)
4703 =item sv_catpvn_flags
4706 Concatenates the string onto the end of the string which is in the SV. The
4707 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4708 status set, then the bytes appended should be valid UTF-8.
4709 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4710 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4711 in terms of this function.
4713 void sv_catpvn_flags(SV* sv, const char* ptr, STRLEN len, I32 flags)
4718 =item sv_catpvn_nomg
4721 Like C<sv_catpvn> but doesn't process magic.
4723 void sv_catpvn_nomg(SV* sv, const char* ptr, STRLEN len)
4731 Like C<sv_catpv>, but also handles 'set' magic.
4733 void sv_catpv_mg(SV *sv, const char *ptr)
4741 Concatenates the string from SV C<ssv> onto the end of the string in
4742 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4743 not 'set' magic. See C<sv_catsv_mg>.
4745 void sv_catsv(SV* dsv, SV* ssv)
4750 =item sv_catsv_flags
4753 Concatenates the string from SV C<ssv> onto the end of the string in
4754 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4755 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4756 and C<sv_catsv_nomg> are implemented in terms of this function.
4758 void sv_catsv_flags(SV* dsv, SV* ssv, I32 flags)
4766 Like C<sv_catsv> but doesn't process magic.
4768 void sv_catsv_nomg(SV* dsv, SV* ssv)
4776 Efficient removal of characters from the beginning of the string buffer.
4777 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4778 the string buffer. The C<ptr> becomes the first character of the adjusted
4779 string. Uses the "OOK hack".
4780 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4781 refer to the same chunk of data.
4783 void sv_chop(SV* sv, const char* ptr)
4791 Clear an SV: call any destructors, free up any memory used by the body,
4792 and free the body itself. The SV's head is I<not> freed, although
4793 its type is set to all 1's so that it won't inadvertently be assumed
4794 to be live during global destruction etc.
4795 This function should only be called when REFCNT is zero. Most of the time
4796 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
4799 void sv_clear(SV* sv)
4807 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
4808 string in C<sv1> is less than, equal to, or greater than the string in
4809 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
4810 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
4812 I32 sv_cmp(SV* sv1, SV* sv2)
4820 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
4821 'use bytes' aware, handles get magic, and will coerce its args to strings
4822 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
4824 I32 sv_cmp_locale(SV* sv1, SV* sv2)
4832 Add Collate Transform magic to an SV if it doesn't already have it.
4834 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
4835 scalar data of the variable, but transformed to such a format that a normal
4836 memory comparison can be used to compare the data according to the locale
4839 char* sv_collxfrm(SV* sv, STRLEN* nxp)
4847 Copies a stringified representation of the source SV into the
4848 destination SV. Automatically performs any necessary mg_get and
4849 coercion of numeric values into strings. Guaranteed to preserve
4850 UTF-8 flag even from overloaded objects. Similar in nature to
4851 sv_2pv[_flags] but operates directly on an SV instead of just the
4852 string. Mostly uses sv_2pv_flags to do its work, except when that
4853 would lose the UTF-8'ness of the PV.
4855 void sv_copypv(SV* dsv, SV* ssv)
4863 Auto-decrement of the value in the SV, doing string to numeric conversion
4864 if necessary. Handles 'get' magic.
4871 =item sv_derived_from
4874 Returns a boolean indicating whether the SV is derived from the specified
4875 class. This is the function that implements C<UNIVERSAL::isa>. It works
4876 for class names as well as for objects.
4878 bool sv_derived_from(SV* sv, const char* name)
4881 Found in file universal.c
4886 Returns a boolean indicating whether the strings in the two SVs are
4887 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
4888 coerce its args to strings if necessary.
4890 I32 sv_eq(SV* sv1, SV* sv2)
4895 =item sv_force_normal_flags
4896 X<sv_force_normal_flags>
4898 Undo various types of fakery on an SV: if the PV is a shared string, make
4899 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4900 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4901 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4902 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4903 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4904 set to some other value.) In addition, the C<flags> parameter gets passed to
4905 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4906 with flags set to 0.
4908 void sv_force_normal_flags(SV *sv, U32 flags)
4916 Decrement an SV's reference count, and if it drops to zero, call
4917 C<sv_clear> to invoke destructors and free up any memory used by
4918 the body; finally, deallocate the SV's head itself.
4919 Normally called via a wrapper macro C<SvREFCNT_dec>.
4921 void sv_free(SV* sv)
4929 Get a line from the filehandle and store it into the SV, optionally
4930 appending to the currently-stored string.
4932 char* sv_gets(SV* sv, PerlIO* fp, I32 append)
4940 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
4941 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
4942 Use the C<SvGROW> wrapper instead.
4944 char* sv_grow(SV* sv, STRLEN newlen)
4952 Auto-increment of the value in the SV, doing string to numeric conversion
4953 if necessary. Handles 'get' magic.
4963 Inserts a string at the specified offset/length within the SV. Similar to
4964 the Perl substr() function.
4966 void sv_insert(SV* bigsv, STRLEN offset, STRLEN len, const char* little, STRLEN littlelen)
4974 Returns a boolean indicating whether the SV is blessed into the specified
4975 class. This does not check for subtypes; use C<sv_derived_from> to verify
4976 an inheritance relationship.
4978 int sv_isa(SV* sv, const char* name)
4986 Returns a boolean indicating whether the SV is an RV pointing to a blessed
4987 object. If the SV is not an RV, or if the object is not blessed, then this
4990 int sv_isobject(SV* sv)
4998 Returns the length of the string in the SV. Handles magic and type
4999 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5001 STRLEN sv_len(SV* sv)
5009 Returns the number of characters in the string in an SV, counting wide
5010 UTF-8 bytes as a single character. Handles magic and type coercion.
5012 STRLEN sv_len_utf8(SV* sv)
5020 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
5021 then adds a new magic item of type C<how> to the head of the magic list.
5023 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
5024 handling of the C<name> and C<namlen> arguments.
5026 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
5027 to add more than one instance of the same 'how'.
5029 void sv_magic(SV* sv, SV* obj, int how, const char* name, I32 namlen)
5037 Adds magic to an SV, upgrading it if necessary. Applies the
5038 supplied vtable and returns a pointer to the magic added.
5040 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
5041 In particular, you can add magic to SvREADONLY SVs, and add more than
5042 one instance of the same 'how'.
5044 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
5045 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
5046 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
5047 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
5049 (This is now used as a subroutine by C<sv_magic>.)
5051 MAGIC * sv_magicext(SV* sv, SV* obj, int how, const MGVTBL *vtbl, const char* name, I32 namlen)
5059 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
5060 The new SV is marked as mortal. It will be destroyed "soon", either by an
5061 explicit call to FREETMPS, or by an implicit call at places such as
5062 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
5064 SV* sv_mortalcopy(SV* oldsv)
5072 Creates a new null SV which is mortal. The reference count of the SV is
5073 set to 1. It will be destroyed "soon", either by an explicit call to
5074 FREETMPS, or by an implicit call at places such as statement boundaries.
5075 See also C<sv_mortalcopy> and C<sv_2mortal>.
5085 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5088 SV* sv_newref(SV* sv)
5096 Converts the value pointed to by offsetp from a count of bytes from the
5097 start of the string, to a count of the equivalent number of UTF-8 chars.
5098 Handles magic and type coercion.
5100 void sv_pos_b2u(SV* sv, I32* offsetp)
5108 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5109 the start of the string, to a count of the equivalent number of bytes; if
5110 lenp is non-zero, it does the same to lenp, but this time starting from
5111 the offset, rather than from the start of the string. Handles magic and
5114 void sv_pos_u2b(SV* sv, I32* offsetp, I32* lenp)
5119 =item sv_pvbyten_force
5122 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
5124 char* sv_pvbyten_force(SV* sv, STRLEN* lp)
5132 Get a sensible string out of the SV somehow.
5133 A private implementation of the C<SvPV_force> macro for compilers which
5134 can't cope with complex macro expressions. Always use the macro instead.
5136 char* sv_pvn_force(SV* sv, STRLEN* lp)
5141 =item sv_pvn_force_flags
5142 X<sv_pvn_force_flags>
5144 Get a sensible string out of the SV somehow.
5145 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
5146 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
5147 implemented in terms of this function.
5148 You normally want to use the various wrapper macros instead: see
5149 C<SvPV_force> and C<SvPV_force_nomg>
5151 char* sv_pvn_force_flags(SV* sv, STRLEN* lp, I32 flags)
5156 =item sv_pvutf8n_force
5159 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
5161 char* sv_pvutf8n_force(SV* sv, STRLEN* lp)
5169 Returns a string describing what the SV is a reference to.
5171 char* sv_reftype(const SV* sv, int ob)
5179 Make the first argument a copy of the second, then delete the original.
5180 The target SV physically takes over ownership of the body of the source SV
5181 and inherits its flags; however, the target keeps any magic it owns,
5182 and any magic in the source is discarded.
5183 Note that this is a rather specialist SV copying operation; most of the
5184 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5186 void sv_replace(SV* sv, SV* nsv)
5191 =item sv_report_used
5194 Dump the contents of all SVs not yet freed. (Debugging aid).
5196 void sv_report_used()
5204 Underlying implementation for the C<reset> Perl function.
5205 Note that the perl-level function is vaguely deprecated.
5207 void sv_reset(const char* s, HV* stash)
5215 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
5216 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
5217 push a back-reference to this RV onto the array of backreferences
5218 associated with that magic.
5220 SV* sv_rvweaken(SV *sv)
5228 Copies an integer into the given SV, upgrading first if necessary.
5229 Does not handle 'set' magic. See also C<sv_setiv_mg>.
5231 void sv_setiv(SV* sv, IV num)
5239 Like C<sv_setiv>, but also handles 'set' magic.
5241 void sv_setiv_mg(SV *sv, IV i)
5249 Copies a double into the given SV, upgrading first if necessary.
5250 Does not handle 'set' magic. See also C<sv_setnv_mg>.
5252 void sv_setnv(SV* sv, NV num)
5260 Like C<sv_setnv>, but also handles 'set' magic.
5262 void sv_setnv_mg(SV *sv, NV num)
5270 Copies a string into an SV. The string must be null-terminated. Does not
5271 handle 'set' magic. See C<sv_setpv_mg>.
5273 void sv_setpv(SV* sv, const char* ptr)
5281 Works like C<sv_catpvf> but copies the text into the SV instead of
5282 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
5284 void sv_setpvf(SV* sv, const char* pat, ...)
5292 Like C<sv_setpvf>, but also handles 'set' magic.
5294 void sv_setpvf_mg(SV *sv, const char* pat, ...)
5302 Copies an integer into the given SV, also updating its string value.
5303 Does not handle 'set' magic. See C<sv_setpviv_mg>.
5305 void sv_setpviv(SV* sv, IV num)
5313 Like C<sv_setpviv>, but also handles 'set' magic.
5315 void sv_setpviv_mg(SV *sv, IV iv)
5323 Copies a string into an SV. The C<len> parameter indicates the number of
5324 bytes to be copied. If the C<ptr> argument is NULL the SV will become
5325 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
5327 void sv_setpvn(SV* sv, const char* ptr, STRLEN len)
5335 Like C<sv_setpvn>, but also handles 'set' magic.
5337 void sv_setpvn_mg(SV *sv, const char *ptr, STRLEN len)
5345 Like C<sv_setpv>, but also handles 'set' magic.
5347 void sv_setpv_mg(SV *sv, const char *ptr)
5355 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
5356 argument will be upgraded to an RV. That RV will be modified to point to
5357 the new SV. The C<classname> argument indicates the package for the
5358 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
5359 will have a reference count of 1, and the RV will be returned.
5361 SV* sv_setref_iv(SV* rv, const char* classname, IV iv)
5369 Copies a double into a new SV, optionally blessing the SV. The C<rv>
5370 argument will be upgraded to an RV. That RV will be modified to point to
5371 the new SV. The C<classname> argument indicates the package for the
5372 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
5373 will have a reference count of 1, and the RV will be returned.
5375 SV* sv_setref_nv(SV* rv, const char* classname, NV nv)
5383 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
5384 argument will be upgraded to an RV. That RV will be modified to point to
5385 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
5386 into the SV. The C<classname> argument indicates the package for the
5387 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
5388 will have a reference count of 1, and the RV will be returned.
5390 Do not use with other Perl types such as HV, AV, SV, CV, because those
5391 objects will become corrupted by the pointer copy process.
5393 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
5395 SV* sv_setref_pv(SV* rv, const char* classname, void* pv)
5403 Copies a string into a new SV, optionally blessing the SV. The length of the
5404 string must be specified with C<n>. The C<rv> argument will be upgraded to
5405 an RV. That RV will be modified to point to the new SV. The C<classname>
5406 argument indicates the package for the blessing. Set C<classname> to
5407 C<Nullch> to avoid the blessing. The new SV will have a reference count
5408 of 1, and the RV will be returned.
5410 Note that C<sv_setref_pv> copies the pointer while this copies the string.
5412 SV* sv_setref_pvn(SV* rv, const char* classname, const char* pv, STRLEN n)
5420 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
5421 argument will be upgraded to an RV. That RV will be modified to point to
5422 the new SV. The C<classname> argument indicates the package for the
5423 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
5424 will have a reference count of 1, and the RV will be returned.
5426 SV* sv_setref_uv(SV* rv, const char* classname, UV uv)
5434 Copies the contents of the source SV C<ssv> into the destination SV
5435 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
5436 function if the source SV needs to be reused. Does not handle 'set' magic.
5437 Loosely speaking, it performs a copy-by-value, obliterating any previous
5438 content of the destination.
5440 You probably want to use one of the assortment of wrappers, such as
5441 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
5442 C<SvSetMagicSV_nosteal>.
5444 void sv_setsv(SV* dsv, SV* ssv)
5449 =item sv_setsv_flags
5452 Copies the contents of the source SV C<ssv> into the destination SV
5453 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
5454 function if the source SV needs to be reused. Does not handle 'set' magic.
5455 Loosely speaking, it performs a copy-by-value, obliterating any previous
5456 content of the destination.
5457 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
5458 C<ssv> if appropriate, else not. If the C<flags> parameter has the
5459 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
5460 and C<sv_setsv_nomg> are implemented in terms of this function.
5462 You probably want to use one of the assortment of wrappers, such as
5463 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
5464 C<SvSetMagicSV_nosteal>.
5466 This is the primary function for copying scalars, and most other
5467 copy-ish functions and macros use this underneath.
5469 void sv_setsv_flags(SV* dsv, SV* ssv, I32 flags)
5477 Like C<sv_setsv>, but also handles 'set' magic.
5479 void sv_setsv_mg(SV *dstr, SV *sstr)
5487 Like C<sv_setsv> but doesn't process magic.
5489 void sv_setsv_nomg(SV* dsv, SV* ssv)
5497 Copies an unsigned integer into the given SV, upgrading first if necessary.
5498 Does not handle 'set' magic. See also C<sv_setuv_mg>.
5500 void sv_setuv(SV* sv, UV num)
5508 Like C<sv_setuv>, but also handles 'set' magic.
5510 void sv_setuv_mg(SV *sv, UV u)
5518 Test an SV for taintedness. Use C<SvTAINTED> instead.
5519 bool sv_tainted(SV* sv)
5527 Returns true if the SV has a true value by Perl's rules.
5528 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
5529 instead use an in-line version.
5539 Removes all magic of type C<type> from an SV.
5541 int sv_unmagic(SV* sv, int type)
5546 =item sv_unref_flags
5549 Unsets the RV status of the SV, and decrements the reference count of
5550 whatever was being referenced by the RV. This can almost be thought of
5551 as a reversal of C<newSVrv>. The C<cflags> argument can contain
5552 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
5553 (otherwise the decrementing is conditional on the reference count being
5554 different from one or the reference being a readonly SV).
5557 void sv_unref_flags(SV* sv, U32 flags)
5565 Untaint an SV. Use C<SvTAINTED_off> instead.
5566 void sv_untaint(SV* sv)
5574 Upgrade an SV to a more complex form. Generally adds a new body type to the
5575 SV, then copies across as much information as possible from the old body.
5576 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
5578 void sv_upgrade(SV* sv, U32 mt)
5586 Tells an SV to use C<ptr> to find its string value. Normally the string is
5587 stored inside the SV but sv_usepvn allows the SV to use an outside string.
5588 The C<ptr> should point to memory that was allocated by C<malloc>. The
5589 string length, C<len>, must be supplied. This function will realloc the
5590 memory pointed to by C<ptr>, so that pointer should not be freed or used by
5591 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
5592 See C<sv_usepvn_mg>.
5594 void sv_usepvn(SV* sv, char* ptr, STRLEN len)
5602 Like C<sv_usepvn>, but also handles 'set' magic.
5604 void sv_usepvn_mg(SV *sv, char *ptr, STRLEN len)
5609 =item sv_utf8_decode
5612 If the PV of the SV is an octet sequence in UTF-8
5613 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
5614 so that it looks like a character. If the PV contains only single-byte
5615 characters, the C<SvUTF8> flag stays being off.
5616 Scans PV for validity and returns false if the PV is invalid UTF-8.
5618 NOTE: this function is experimental and may change or be
5619 removed without notice.
5621 bool sv_utf8_decode(SV *sv)
5626 =item sv_utf8_downgrade
5627 X<sv_utf8_downgrade>
5629 Attempts to convert the PV of an SV from characters to bytes.
5630 If the PV contains a character beyond byte, this conversion will fail;
5631 in this case, either returns false or, if C<fail_ok> is not
5634 This is not as a general purpose Unicode to byte encoding interface:
5635 use the Encode extension for that.
5637 NOTE: this function is experimental and may change or be
5638 removed without notice.
5640 bool sv_utf8_downgrade(SV *sv, bool fail_ok)
5645 =item sv_utf8_encode
5648 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
5649 flag off so that it looks like octets again.
5651 void sv_utf8_encode(SV *sv)
5656 =item sv_utf8_upgrade
5659 Converts the PV of an SV to its UTF-8-encoded form.
5660 Forces the SV to string form if it is not already.
5661 Always sets the SvUTF8 flag to avoid future validity checks even
5662 if all the bytes have hibit clear.
5664 This is not as a general purpose byte encoding to Unicode interface:
5665 use the Encode extension for that.
5667 STRLEN sv_utf8_upgrade(SV *sv)
5672 =item sv_utf8_upgrade_flags
5673 X<sv_utf8_upgrade_flags>
5675 Converts the PV of an SV to its UTF-8-encoded form.
5676 Forces the SV to string form if it is not already.
5677 Always sets the SvUTF8 flag to avoid future validity checks even
5678 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
5679 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
5680 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
5682 This is not as a general purpose byte encoding to Unicode interface:
5683 use the Encode extension for that.
5685 STRLEN sv_utf8_upgrade_flags(SV *sv, I32 flags)
5693 Processes its arguments like C<vsprintf> and appends the formatted output
5694 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
5696 Usually used via its frontend C<sv_catpvf>.
5698 void sv_vcatpvf(SV* sv, const char* pat, va_list* args)
5706 Processes its arguments like C<vsprintf> and appends the formatted output
5707 to an SV. Uses an array of SVs if the C style variable argument list is
5708 missing (NULL). When running with taint checks enabled, indicates via
5709 C<maybe_tainted> if results are untrustworthy (often due to the use of
5712 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
5714 void sv_vcatpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
5722 Like C<sv_vcatpvf>, but also handles 'set' magic.
5724 Usually used via its frontend C<sv_catpvf_mg>.
5726 void sv_vcatpvf_mg(SV* sv, const char* pat, va_list* args)
5734 Works like C<sv_vcatpvf> but copies the text into the SV instead of
5735 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
5737 Usually used via its frontend C<sv_setpvf>.
5739 void sv_vsetpvf(SV* sv, const char* pat, va_list* args)
5747 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
5750 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
5752 void sv_vsetpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
5760 Like C<sv_vsetpvf>, but also handles 'set' magic.
5762 Usually used via its frontend C<sv_setpvf_mg>.
5764 void sv_vsetpvf_mg(SV* sv, const char* pat, va_list* args)
5772 =head1 Unicode Support
5776 =item bytes_from_utf8
5779 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
5780 Unlike C<utf8_to_bytes> but like C<bytes_to_utf8>, returns a pointer to
5781 the newly-created string, and updates C<len> to contain the new
5782 length. Returns the original string if no conversion occurs, C<len>
5783 is unchanged. Do nothing if C<is_utf8> points to 0. Sets C<is_utf8> to
5784 0 if C<s> is converted or contains all 7bit characters.
5786 NOTE: this function is experimental and may change or be
5787 removed without notice.
5789 U8* bytes_from_utf8(const U8 *s, STRLEN *len, bool *is_utf8)
5792 Found in file utf8.c
5797 Converts a string C<s> of length C<len> from ASCII into UTF-8 encoding.
5798 Returns a pointer to the newly-created string, and sets C<len> to
5799 reflect the new length.
5801 If you want to convert to UTF-8 from other encodings than ASCII,
5802 see sv_recode_to_utf8().
5804 NOTE: this function is experimental and may change or be
5805 removed without notice.
5807 U8* bytes_to_utf8(const U8 *s, STRLEN *len)
5810 Found in file utf8.c
5815 Return true if the strings s1 and s2 differ case-insensitively, false
5816 if not (if they are equal case-insensitively). If u1 is true, the
5817 string s1 is assumed to be in UTF-8-encoded Unicode. If u2 is true,
5818 the string s2 is assumed to be in UTF-8-encoded Unicode. If u1 or u2
5819 are false, the respective string is assumed to be in native 8-bit
5822 If the pe1 and pe2 are non-NULL, the scanning pointers will be copied
5823 in there (they will point at the beginning of the I<next> character).
5824 If the pointers behind pe1 or pe2 are non-NULL, they are the end
5825 pointers beyond which scanning will not continue under any
5826 circumstances. If the byte lengths l1 and l2 are non-zero, s1+l1 and
5827 s2+l2 will be used as goal end pointers that will also stop the scan,
5828 and which qualify towards defining a successful match: all the scans
5829 that define an explicit length must reach their goal pointers for
5830 a match to succeed).
5832 For case-insensitiveness, the "casefolding" of Unicode is used
5833 instead of upper/lowercasing both the characters, see
5834 http://www.unicode.org/unicode/reports/tr21/ (Case Mappings).
5836 I32 ibcmp_utf8(const char* a, char **pe1, UV l1, bool u1, const char* b, char **pe2, UV l2, bool u2)
5839 Found in file utf8.c
5844 Tests if some arbitrary number of bytes begins in a valid UTF-8
5845 character. Note that an INVARIANT (i.e. ASCII) character is a valid
5846 UTF-8 character. The actual number of bytes in the UTF-8 character
5847 will be returned if it is valid, otherwise 0.
5849 STRLEN is_utf8_char(const U8 *p)
5852 Found in file utf8.c
5854 =item is_utf8_string
5857 Returns true if first C<len> bytes of the given string form a valid
5858 UTF-8 string, false otherwise. Note that 'a valid UTF-8 string' does
5859 not mean 'a string that contains code points above 0x7F encoded in UTF-8'
5860 because a valid ASCII string is a valid UTF-8 string.
5862 See also is_utf8_string_loclen() and is_utf8_string_loc().
5864 bool is_utf8_string(const U8 *s, STRLEN len)
5867 Found in file utf8.c
5869 =item is_utf8_string_loc
5870 X<is_utf8_string_loc>
5872 Like is_utf8_string() but stores the location of the failure (in the
5873 case of "utf8ness failure") or the location s+len (in the case of
5874 "utf8ness success") in the C<ep>.
5876 See also is_utf8_string_loclen() and is_utf8_string().
5878 bool is_utf8_string_loc(const U8 *s, STRLEN len, const U8 **p)
5881 Found in file utf8.c
5883 =item is_utf8_string_loclen
5884 X<is_utf8_string_loclen>
5886 Like is_utf8_string() but stores the location of the failure (in the
5887 case of "utf8ness failure") or the location s+len (in the case of
5888 "utf8ness success") in the C<ep>, and the number of UTF-8
5889 encoded characters in the C<el>.
5891 See also is_utf8_string_loc() and is_utf8_string().
5893 bool is_utf8_string_loclen(const U8 *s, STRLEN len, const U8 **ep, STRLEN *el)
5896 Found in file utf8.c
5898 =item pv_uni_display
5901 Build to the scalar dsv a displayable version of the string spv,
5902 length len, the displayable version being at most pvlim bytes long
5903 (if longer, the rest is truncated and "..." will be appended).
5905 The flags argument can have UNI_DISPLAY_ISPRINT set to display
5906 isPRINT()able characters as themselves, UNI_DISPLAY_BACKSLASH
5907 to display the \\[nrfta\\] as the backslashed versions (like '\n')
5908 (UNI_DISPLAY_BACKSLASH is preferred over UNI_DISPLAY_ISPRINT for \\).
5909 UNI_DISPLAY_QQ (and its alias UNI_DISPLAY_REGEX) have both
5910 UNI_DISPLAY_BACKSLASH and UNI_DISPLAY_ISPRINT turned on.
5912 The pointer to the PV of the dsv is returned.
5914 char* pv_uni_display(SV *dsv, const U8 *spv, STRLEN len, STRLEN pvlim, UV flags)
5917 Found in file utf8.c
5922 The encoding is assumed to be an Encode object, the PV of the ssv is
5923 assumed to be octets in that encoding and decoding the input starts
5924 from the position which (PV + *offset) pointed to. The dsv will be
5925 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
5926 when the string tstr appears in decoding output or the input ends on
5927 the PV of the ssv. The value which the offset points will be modified
5928 to the last input position on the ssv.
5930 Returns TRUE if the terminator was found, else returns FALSE.
5932 bool sv_cat_decode(SV* dsv, SV *encoding, SV *ssv, int *offset, char* tstr, int tlen)
5937 =item sv_recode_to_utf8
5938 X<sv_recode_to_utf8>
5940 The encoding is assumed to be an Encode object, on entry the PV
5941 of the sv is assumed to be octets in that encoding, and the sv
5942 will be converted into Unicode (and UTF-8).
5944 If the sv already is UTF-8 (or if it is not POK), or if the encoding
5945 is not a reference, nothing is done to the sv. If the encoding is not
5946 an C<Encode::XS> Encoding object, bad things will happen.
5947 (See F<lib/encoding.pm> and L<Encode>).
5949 The PV of the sv is returned.
5951 char* sv_recode_to_utf8(SV* sv, SV *encoding)
5956 =item sv_uni_display
5959 Build to the scalar dsv a displayable version of the scalar sv,
5960 the displayable version being at most pvlim bytes long
5961 (if longer, the rest is truncated and "..." will be appended).
5963 The flags argument is as in pv_uni_display().
5965 The pointer to the PV of the dsv is returned.
5967 char* sv_uni_display(SV *dsv, SV *ssv, STRLEN pvlim, UV flags)
5970 Found in file utf8.c
5975 The "p" contains the pointer to the UTF-8 string encoding
5976 the character that is being converted.
5978 The "ustrp" is a pointer to the character buffer to put the
5979 conversion result to. The "lenp" is a pointer to the length
5982 The "swashp" is a pointer to the swash to use.
5984 Both the special and normal mappings are stored lib/unicore/To/Foo.pl,
5985 and loaded by SWASHGET, using lib/utf8_heavy.pl. The special (usually,
5986 but not always, a multicharacter mapping), is tried first.
5988 The "special" is a string like "utf8::ToSpecLower", which means the
5989 hash %utf8::ToSpecLower. The access to the hash is through
5990 Perl_to_utf8_case().
5992 The "normal" is a string like "ToLower" which means the swash
5995 UV to_utf8_case(const U8 *p, U8* ustrp, STRLEN *lenp, SV **swashp, const char *normal, const char *special)
5998 Found in file utf8.c
6003 Convert the UTF-8 encoded character at p to its foldcase version and
6004 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6005 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6006 foldcase version may be longer than the original character (up to
6009 The first character of the foldcased version is returned
6010 (but note, as explained above, that there may be more.)
6012 UV to_utf8_fold(const U8 *p, U8* ustrp, STRLEN *lenp)
6015 Found in file utf8.c
6020 Convert the UTF-8 encoded character at p to its lowercase version and
6021 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6022 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6023 lowercase version may be longer than the original character.
6025 The first character of the lowercased version is returned
6026 (but note, as explained above, that there may be more.)
6028 UV to_utf8_lower(const U8 *p, U8* ustrp, STRLEN *lenp)
6031 Found in file utf8.c
6036 Convert the UTF-8 encoded character at p to its titlecase version and
6037 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6038 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6039 titlecase version may be longer than the original character.
6041 The first character of the titlecased version is returned
6042 (but note, as explained above, that there may be more.)
6044 UV to_utf8_title(const U8 *p, U8* ustrp, STRLEN *lenp)
6047 Found in file utf8.c
6052 Convert the UTF-8 encoded character at p to its uppercase version and
6053 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6054 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since
6055 the uppercase version may be longer than the original character.
6057 The first character of the uppercased version is returned
6058 (but note, as explained above, that there may be more.)
6060 UV to_utf8_upper(const U8 *p, U8* ustrp, STRLEN *lenp)
6063 Found in file utf8.c
6065 =item utf8n_to_uvuni
6068 Bottom level UTF-8 decode routine.
6069 Returns the unicode code point value of the first character in the string C<s>
6070 which is assumed to be in UTF-8 encoding and no longer than C<curlen>;
6071 C<retlen> will be set to the length, in bytes, of that character.
6073 If C<s> does not point to a well-formed UTF-8 character, the behaviour
6074 is dependent on the value of C<flags>: if it contains UTF8_CHECK_ONLY,
6075 it is assumed that the caller will raise a warning, and this function
6076 will silently just set C<retlen> to C<-1> and return zero. If the
6077 C<flags> does not contain UTF8_CHECK_ONLY, warnings about
6078 malformations will be given, C<retlen> will be set to the expected
6079 length of the UTF-8 character in bytes, and zero will be returned.
6081 The C<flags> can also contain various flags to allow deviations from
6082 the strict UTF-8 encoding (see F<utf8.h>).
6084 Most code should use utf8_to_uvchr() rather than call this directly.
6086 UV utf8n_to_uvuni(const U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags)
6089 Found in file utf8.c
6094 Returns the number of UTF-8 characters between the UTF-8 pointers C<a>
6097 WARNING: use only if you *know* that the pointers point inside the
6100 IV utf8_distance(const U8 *a, const U8 *b)
6103 Found in file utf8.c
6108 Return the UTF-8 pointer C<s> displaced by C<off> characters, either
6109 forward or backward.
6111 WARNING: do not use the following unless you *know* C<off> is within
6112 the UTF-8 data pointed to by C<s> *and* that on entry C<s> is aligned
6113 on the first byte of character or just after the last byte of a character.
6115 U8* utf8_hop(const U8 *s, I32 off)
6118 Found in file utf8.c
6123 Return the length of the UTF-8 char encoded string C<s> in characters.
6124 Stops at C<e> (inclusive). If C<e E<lt> s> or if the scan would end
6125 up past C<e>, croaks.
6127 STRLEN utf8_length(const U8* s, const U8 *e)
6130 Found in file utf8.c
6135 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
6136 Unlike C<bytes_to_utf8>, this over-writes the original string, and
6137 updates len to contain the new length.
6138 Returns zero on failure, setting C<len> to -1.
6140 NOTE: this function is experimental and may change or be
6141 removed without notice.
6143 U8* utf8_to_bytes(U8 *s, STRLEN *len)
6146 Found in file utf8.c
6151 Returns the native character value of the first character in the string C<s>
6152 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6153 length, in bytes, of that character.
6155 If C<s> does not point to a well-formed UTF-8 character, zero is
6156 returned and retlen is set, if possible, to -1.
6158 UV utf8_to_uvchr(const U8 *s, STRLEN *retlen)
6161 Found in file utf8.c
6166 Returns the Unicode code point of the first character in the string C<s>
6167 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6168 length, in bytes, of that character.
6170 This function should only be used when returned UV is considered
6171 an index into the Unicode semantic tables (e.g. swashes).
6173 If C<s> does not point to a well-formed UTF-8 character, zero is
6174 returned and retlen is set, if possible, to -1.
6176 UV utf8_to_uvuni(const U8 *s, STRLEN *retlen)
6179 Found in file utf8.c
6181 =item uvuni_to_utf8_flags
6182 X<uvuni_to_utf8_flags>
6184 Adds the UTF-8 representation of the Unicode codepoint C<uv> to the end
6185 of the string C<d>; C<d> should be have at least C<UTF8_MAXBYTES+1> free
6186 bytes available. The return value is the pointer to the byte after the
6187 end of the new character. In other words,
6189 d = uvuni_to_utf8_flags(d, uv, flags);
6193 d = uvuni_to_utf8(d, uv);
6195 (which is equivalent to)
6197 d = uvuni_to_utf8_flags(d, uv, 0);
6199 is the recommended Unicode-aware way of saying
6203 U8* uvuni_to_utf8_flags(U8 *d, UV uv, UV flags)
6206 Found in file utf8.c
6211 =head1 Variables created by C<xsubpp> and C<xsubpp> internal functions
6218 Variable which is setup by C<xsubpp> to indicate the stack base offset,
6219 used by the C<ST>, C<XSprePUSH> and C<XSRETURN> macros. The C<dMARK> macro
6220 must be called prior to setup the C<MARK> variable.
6225 Found in file XSUB.h
6230 Variable which is setup by C<xsubpp> to indicate the
6231 class name for a C++ XS constructor. This is always a C<char*>. See C<THIS>.
6236 Found in file XSUB.h
6241 Sets up the C<ax> variable.
6242 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
6247 Found in file XSUB.h
6252 Sets up the C<ax> variable and stack marker variable C<mark>.
6253 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
6258 Found in file XSUB.h
6263 Sets up the C<items> variable.
6264 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
6269 Found in file XSUB.h
6274 Sets up the C<padoff_du> variable for an XSUB that wishes to use
6280 Found in file XSUB.h
6285 Sets up stack and mark pointers for an XSUB, calling dSP and dMARK.
6286 Sets up the C<ax> and C<items> variables by calling C<dAX> and C<dITEMS>.
6287 This is usually handled automatically by C<xsubpp>.
6292 Found in file XSUB.h
6297 Sets up the C<ix> variable for an XSUB which has aliases. This is usually
6298 handled automatically by C<xsubpp>.
6303 Found in file XSUB.h
6308 Variable which is setup by C<xsubpp> to indicate the number of
6309 items on the stack. See L<perlxs/"Variable-length Parameter Lists">.
6314 Found in file XSUB.h
6319 Variable which is setup by C<xsubpp> to indicate which of an
6320 XSUB's aliases was used to invoke it. See L<perlxs/"The ALIAS: Keyword">.
6325 Found in file XSUB.h
6330 Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
6334 Found in file XSUB.h
6339 Variable which is setup by C<xsubpp> to hold the return value for an
6340 XSUB. This is always the proper type for the XSUB. See
6341 L<perlxs/"The RETVAL Variable">.
6346 Found in file XSUB.h
6351 Used to access elements on the XSUB's stack.
6356 Found in file XSUB.h
6361 Variable which is setup by C<xsubpp> to designate the object in a C++
6362 XSUB. This is always the proper type for the C++ object. See C<CLASS> and
6363 L<perlxs/"Using XS With C++">.
6368 Found in file XSUB.h
6373 The SV* corresponding to the $_ variable. Works even if there
6374 is a lexical $_ in scope.
6377 Found in file XSUB.h
6382 Macro to declare an XSUB and its C parameter list. This is handled by
6386 Found in file XSUB.h
6391 The version identifier for an XS module. This is usually
6392 handled automatically by C<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>.
6395 Found in file XSUB.h
6397 =item XS_VERSION_BOOTCHECK
6398 X<XS_VERSION_BOOTCHECK>
6400 Macro to verify that a PM module's $VERSION variable matches the XS
6401 module's C<XS_VERSION> variable. This is usually handled automatically by
6402 C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">.
6404 XS_VERSION_BOOTCHECK;
6407 Found in file XSUB.h
6412 =head1 Warning and Dieing
6419 This is the XSUB-writer's interface to Perl's C<die> function.
6420 Normally call this function the same way you call the C C<printf>
6421 function. Calling C<croak> returns control directly to Perl,
6422 sidestepping the normal C order of execution. See C<warn>.
6424 If you want to throw an exception object, assign the object to
6425 C<$@> and then pass C<Nullch> to croak():
6427 errsv = get_sv("@", TRUE);
6428 sv_setsv(errsv, exception_object);
6431 void croak(const char* pat, ...)
6434 Found in file util.c
6439 This is the XSUB-writer's interface to Perl's C<warn> function. Call this
6440 function the same way you call the C C<printf> function. See C<croak>.
6442 void warn(const char* pat, ...)
6445 Found in file util.c
6452 Until May 1997, this document was maintained by Jeff Okamoto
6453 <okamoto@corp.hp.com>. It is now maintained as part of Perl itself.
6455 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
6456 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
6457 Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
6458 Stephen McCamant, and Gurusamy Sarathy.
6460 API Listing originally by Dean Roehrich <roehrich@cray.com>.
6462 Updated to be autogenerated from comments in the source by Benjamin Stuhl.
6466 perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
projects / p5sagit/p5-mst-13.2.git / blob