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
979 =head1 Functions in file pp_pack.c
987 The engine implementing pack() Perl function.
989 void packlist(SV *cat, const char *pat, const char *patend, SV **beglist, SV **endlist)
992 Found in file pp_pack.c
997 The engine implementing pack() Perl function. Note: parameters next_in_list and
998 flags are not used. This call should not be used; use packlist instead.
1000 void pack_cat(SV *cat, const char *pat, const char *patend, SV **beglist, SV **endlist, SV ***next_in_list, U32 flags)
1003 Found in file pp_pack.c
1008 The engine implementing unpack() Perl function. C<unpackstring> puts the
1009 extracted list items on the stack and returns the number of elements.
1010 Issue C<PUTBACK> before and C<SPAGAIN> after the call to this function.
1012 I32 unpackstring(const char *pat, const char *patend, const char *s, const char *strend, U32 flags)
1015 Found in file pp_pack.c
1020 The engine implementing unpack() Perl function. Note: parameters strbeg, new_s
1021 and ocnt are not used. This call should not be used, use unpackstring instead.
1023 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)
1026 Found in file pp_pack.c
1031 =head1 Global Variables
1038 C<PL_modglobal> is a general purpose, interpreter global HV for use by
1039 extensions that need to keep information on a per-interpreter basis.
1040 In a pinch, it can also be used as a symbol table for extensions
1041 to share data among each other. It is a good idea to use keys
1042 prefixed by the package name of the extension that owns the data.
1047 Found in file intrpvar.h
1052 A convenience variable which is typically used with C<SvPV> when one
1053 doesn't care about the length of the string. It is usually more efficient
1054 to either declare a local variable and use that instead or to use the
1055 C<SvPV_nolen> macro.
1060 Found in file thrdvar.h
1065 This is the C<false> SV. See C<PL_sv_yes>. Always refer to this as
1071 Found in file intrpvar.h
1076 This is the C<undef> SV. Always refer to this as C<&PL_sv_undef>.
1081 Found in file intrpvar.h
1086 This is the C<true> SV. See C<PL_sv_no>. Always refer to this as
1092 Found in file intrpvar.h
1104 Return the SV from the GV.
1114 Returns the glob with the given C<name> and a defined subroutine or
1115 C<NULL>. The glob lives in the given C<stash>, or in the stashes
1116 accessible via @ISA and UNIVERSAL::.
1118 The argument C<level> should be either 0 or -1. If C<level==0>, as a
1119 side-effect creates a glob with the given C<name> in the given C<stash>
1120 which in the case of success contains an alias for the subroutine, and sets
1121 up caching info for this glob. Similarly for all the searched stashes.
1123 This function grants C<"SUPER"> token as a postfix of the stash name. The
1124 GV returned from C<gv_fetchmeth> may be a method cache entry, which is not
1125 visible to Perl code. So when calling C<call_sv>, you should not use
1126 the GV directly; instead, you should use the method's CV, which can be
1127 obtained from the GV with the C<GvCV> macro.
1129 GV* gv_fetchmeth(HV* stash, const char* name, STRLEN len, I32 level)
1134 =item gv_fetchmethod_autoload
1135 X<gv_fetchmethod_autoload>
1137 Returns the glob which contains the subroutine to call to invoke the method
1138 on the C<stash>. In fact in the presence of autoloading this may be the
1139 glob for "AUTOLOAD". In this case the corresponding variable $AUTOLOAD is
1142 The third parameter of C<gv_fetchmethod_autoload> determines whether
1143 AUTOLOAD lookup is performed if the given method is not present: non-zero
1144 means yes, look for AUTOLOAD; zero means no, don't look for AUTOLOAD.
1145 Calling C<gv_fetchmethod> is equivalent to calling C<gv_fetchmethod_autoload>
1146 with a non-zero C<autoload> parameter.
1148 These functions grant C<"SUPER"> token as a prefix of the method name. Note
1149 that if you want to keep the returned glob for a long time, you need to
1150 check for it being "AUTOLOAD", since at the later time the call may load a
1151 different subroutine due to $AUTOLOAD changing its value. Use the glob
1152 created via a side effect to do this.
1154 These functions have the same side-effects and as C<gv_fetchmeth> with
1155 C<level==0>. C<name> should be writable if contains C<':'> or C<'
1156 ''>. The warning against passing the GV returned by C<gv_fetchmeth> to
1157 C<call_sv> apply equally to these functions.
1159 GV* gv_fetchmethod_autoload(HV* stash, const char* name, I32 autoload)
1164 =item gv_fetchmeth_autoload
1165 X<gv_fetchmeth_autoload>
1167 Same as gv_fetchmeth(), but looks for autoloaded subroutines too.
1168 Returns a glob for the subroutine.
1170 For an autoloaded subroutine without a GV, will create a GV even
1171 if C<level < 0>. For an autoloaded subroutine without a stub, GvCV()
1172 of the result may be zero.
1174 GV* gv_fetchmeth_autoload(HV* stash, const char* name, STRLEN len, I32 level)
1182 Returns a pointer to the stash for a specified package. C<name> should
1183 be a valid UTF-8 string and must be null-terminated. If C<create> is set
1184 then the package will be created if it does not already exist. If C<create>
1185 is not set and the package does not exist then NULL is returned.
1187 HV* gv_stashpv(const char* name, I32 create)
1195 Returns a pointer to the stash for a specified package. C<name> should
1196 be a valid UTF-8 string. The C<namelen> parameter indicates the length of
1197 the C<name>, in bytes. If C<create> is set then the package will be
1198 created if it does not already exist. If C<create> is not set and the
1199 package does not exist then NULL is returned.
1201 HV* gv_stashpvn(const char* name, U32 namelen, I32 create)
1209 Returns a pointer to the stash for a specified package, which must be a
1210 valid UTF-8 string. See C<gv_stashpv>.
1212 HV* gv_stashsv(SV* sv, I32 create)
1235 Null character pointer.
1238 Found in file handy.h
1262 Found in file handy.h
1267 =head1 Hash Manipulation Functions
1274 Returns the HV of the specified Perl hash. If C<create> is set and the
1275 Perl variable does not exist then it will be created. If C<create> is not
1276 set and the variable does not exist then NULL is returned.
1278 NOTE: the perl_ form of this function is deprecated.
1280 HV* get_hv(const char* name, I32 create)
1283 Found in file perl.c
1288 This flag, used in the length slot of hash entries and magic structures,
1289 specifies the structure contains an C<SV*> pointer where a C<char*> pointer
1290 is to be expected. (For information only--not to be used).
1298 Returns the computed hash stored in the hash entry.
1308 Returns the actual pointer stored in the key slot of the hash entry. The
1309 pointer may be either C<char*> or C<SV*>, depending on the value of
1310 C<HeKLEN()>. Can be assigned to. The C<HePV()> or C<HeSVKEY()> macros are
1311 usually preferable for finding the value of a key.
1321 If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry
1322 holds an C<SV*> key. Otherwise, holds the actual length of the key. Can
1323 be assigned to. The C<HePV()> macro is usually preferable for finding key
1326 STRLEN HeKLEN(HE* he)
1334 Returns the key slot of the hash entry as a C<char*> value, doing any
1335 necessary dereferencing of possibly C<SV*> keys. The length of the string
1336 is placed in C<len> (this is a macro, so do I<not> use C<&len>). If you do
1337 not care about what the length of the key is, you may use the global
1338 variable C<PL_na>, though this is rather less efficient than using a local
1339 variable. Remember though, that hash keys in perl are free to contain
1340 embedded nulls, so using C<strlen()> or similar is not a good way to find
1341 the length of hash keys. This is very similar to the C<SvPV()> macro
1342 described elsewhere in this document.
1344 char* HePV(HE* he, STRLEN len)
1352 Returns the key as an C<SV*>, or C<Nullsv> if the hash entry does not
1353 contain an C<SV*> key.
1363 Returns the key as an C<SV*>. Will create and return a temporary mortal
1364 C<SV*> if the hash entry contains only a C<char*> key.
1366 SV* HeSVKEY_force(HE* he)
1374 Sets the key to a given C<SV*>, taking care to set the appropriate flags to
1375 indicate the presence of an C<SV*> key, and returns the same
1378 SV* HeSVKEY_set(HE* he, SV* sv)
1386 Returns the value slot (type C<SV*>) stored in the hash entry.
1396 Returns the package name of a stash, or NULL if C<stash> isn't a stash.
1397 See C<SvSTASH>, C<CvSTASH>.
1399 char* HvNAME(HV* stash)
1407 Check that a hash is in an internally consistent state.
1409 void hv_assert(HV* tb)
1417 Clears a hash, making it empty.
1419 void hv_clear(HV* tb)
1424 =item hv_clear_placeholders
1425 X<hv_clear_placeholders>
1427 Clears any placeholders from a hash. If a restricted hash has any of its keys
1428 marked as readonly and the key is subsequently deleted, the key is not actually
1429 deleted but is marked by assigning it a value of &PL_sv_placeholder. This tags
1430 it so it will be ignored by future operations such as iterating over the hash,
1431 but will still allow the hash to have a value reassigned to the key at some
1432 future point. This function clears any such placeholder keys from the hash.
1433 See Hash::Util::lock_keys() for an example of its use.
1435 void hv_clear_placeholders(HV* hb)
1443 Deletes a key/value pair in the hash. The value SV is removed from the
1444 hash and returned to the caller. The C<klen> is the length of the key.
1445 The C<flags> value will normally be zero; if set to G_DISCARD then NULL
1448 SV* hv_delete(HV* tb, const char* key, I32 klen, I32 flags)
1456 Deletes a key/value pair in the hash. The value SV is removed from the
1457 hash and returned to the caller. The C<flags> value will normally be zero;
1458 if set to G_DISCARD then NULL will be returned. C<hash> can be a valid
1459 precomputed hash value, or 0 to ask for it to be computed.
1461 SV* hv_delete_ent(HV* tb, SV* key, I32 flags, U32 hash)
1469 Returns a boolean indicating whether the specified hash key exists. The
1470 C<klen> is the length of the key.
1472 bool hv_exists(HV* tb, const char* key, I32 klen)
1480 Returns a boolean indicating whether the specified hash key exists. C<hash>
1481 can be a valid precomputed hash value, or 0 to ask for it to be
1484 bool hv_exists_ent(HV* tb, SV* key, U32 hash)
1492 Returns the SV which corresponds to the specified key in the hash. The
1493 C<klen> is the length of the key. If C<lval> is set then the fetch will be
1494 part of a store. Check that the return value is non-null before
1495 dereferencing it to an C<SV*>.
1497 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1498 information on how to use this function on tied hashes.
1500 SV** hv_fetch(HV* tb, const char* key, I32 klen, I32 lval)
1508 Returns the hash entry which corresponds to the specified key in the hash.
1509 C<hash> must be a valid precomputed hash number for the given C<key>, or 0
1510 if you want the function to compute it. IF C<lval> is set then the fetch
1511 will be part of a store. Make sure the return value is non-null before
1512 accessing it. The return value when C<tb> is a tied hash is a pointer to a
1513 static location, so be sure to make a copy of the structure if you need to
1516 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1517 information on how to use this function on tied hashes.
1519 HE* hv_fetch_ent(HV* tb, SV* key, I32 lval, U32 hash)
1527 Prepares a starting point to traverse a hash table. Returns the number of
1528 keys in the hash (i.e. the same as C<HvKEYS(tb)>). The return value is
1529 currently only meaningful for hashes without tie magic.
1531 NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
1532 hash buckets that happen to be in use. If you still need that esoteric
1533 value, you can get it through the macro C<HvFILL(tb)>.
1536 I32 hv_iterinit(HV* tb)
1544 Returns the key from the current position of the hash iterator. See
1547 char* hv_iterkey(HE* entry, I32* retlen)
1555 Returns the key as an C<SV*> from the current position of the hash
1556 iterator. The return value will always be a mortal copy of the key. Also
1559 SV* hv_iterkeysv(HE* entry)
1567 Returns entries from a hash iterator. See C<hv_iterinit>.
1569 You may call C<hv_delete> or C<hv_delete_ent> on the hash entry that the
1570 iterator currently points to, without losing your place or invalidating your
1571 iterator. Note that in this case the current entry is deleted from the hash
1572 with your iterator holding the last reference to it. Your iterator is flagged
1573 to free the entry on the next call to C<hv_iternext>, so you must not discard
1574 your iterator immediately else the entry will leak - call C<hv_iternext> to
1575 trigger the resource deallocation.
1577 HE* hv_iternext(HV* tb)
1585 Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
1588 SV* hv_iternextsv(HV* hv, char** key, I32* retlen)
1593 =item hv_iternext_flags
1594 X<hv_iternext_flags>
1596 Returns entries from a hash iterator. See C<hv_iterinit> and C<hv_iternext>.
1597 The C<flags> value will normally be zero; if HV_ITERNEXT_WANTPLACEHOLDERS is
1598 set the placeholders keys (for restricted hashes) will be returned in addition
1599 to normal keys. By default placeholders are automatically skipped over.
1600 Currently a placeholder is implemented with a value that is
1601 C<&Perl_sv_placeholder>. Note that the implementation of placeholders and
1602 restricted hashes may change, and the implementation currently is
1603 insufficiently abstracted for any change to be tidy.
1605 NOTE: this function is experimental and may change or be
1606 removed without notice.
1608 HE* hv_iternext_flags(HV* tb, I32 flags)
1616 Returns the value from the current position of the hash iterator. See
1619 SV* hv_iterval(HV* tb, HE* entry)
1627 Adds magic to a hash. See C<sv_magic>.
1629 void hv_magic(HV* hv, GV* gv, int how)
1637 Evaluates the hash in scalar context and returns the result. Handles magic when the hash is tied.
1639 SV* hv_scalar(HV* hv)
1647 Stores an SV in a hash. The hash key is specified as C<key> and C<klen> is
1648 the length of the key. The C<hash> parameter is the precomputed hash
1649 value; if it is zero then Perl will compute it. The return value will be
1650 NULL if the operation failed or if the value did not need to be actually
1651 stored within the hash (as in the case of tied hashes). Otherwise it can
1652 be dereferenced to get the original C<SV*>. Note that the caller is
1653 responsible for suitably incrementing the reference count of C<val> before
1654 the call, and decrementing it if the function returned NULL. Effectively
1655 a successful hv_store takes ownership of one reference to C<val>. This is
1656 usually what you want; a newly created SV has a reference count of one, so
1657 if all your code does is create SVs then store them in a hash, hv_store
1658 will own the only reference to the new SV, and your code doesn't need to do
1659 anything further to tidy up. hv_store is not implemented as a call to
1660 hv_store_ent, and does not create a temporary SV for the key, so if your
1661 key data is not already in SV form then use hv_store in preference to
1664 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1665 information on how to use this function on tied hashes.
1667 SV** hv_store(HV* tb, const char* key, I32 klen, SV* val, U32 hash)
1675 Stores C<val> in a hash. The hash key is specified as C<key>. The C<hash>
1676 parameter is the precomputed hash value; if it is zero then Perl will
1677 compute it. The return value is the new hash entry so created. It will be
1678 NULL if the operation failed or if the value did not need to be actually
1679 stored within the hash (as in the case of tied hashes). Otherwise the
1680 contents of the return value can be accessed using the C<He?> macros
1681 described here. Note that the caller is responsible for suitably
1682 incrementing the reference count of C<val> before the call, and
1683 decrementing it if the function returned NULL. Effectively a successful
1684 hv_store_ent takes ownership of one reference to C<val>. This is
1685 usually what you want; a newly created SV has a reference count of one, so
1686 if all your code does is create SVs then store them in a hash, hv_store
1687 will own the only reference to the new SV, and your code doesn't need to do
1688 anything further to tidy up. Note that hv_store_ent only reads the C<key>;
1689 unlike C<val> it does not take ownership of it, so maintaining the correct
1690 reference count on C<key> is entirely the caller's responsibility. hv_store
1691 is not implemented as a call to hv_store_ent, and does not create a temporary
1692 SV for the key, so if your key data is not already in SV form then use
1693 hv_store in preference to hv_store_ent.
1695 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1696 information on how to use this function on tied hashes.
1698 HE* hv_store_ent(HV* tb, SV* key, SV* val, U32 hash)
1708 void hv_undef(HV* tb)
1716 Creates a new HV. The reference count is set to 1.
1726 =head1 Magical Functions
1733 Clear something magical that the SV represents. See C<sv_magic>.
1735 int mg_clear(SV* sv)
1743 Copies the magic from one SV to another. See C<sv_magic>.
1745 int mg_copy(SV* sv, SV* nsv, const char* key, I32 klen)
1753 Finds the magic pointer for type matching the SV. See C<sv_magic>.
1755 MAGIC* mg_find(const SV* sv, int type)
1763 Free any magic storage used by the SV. See C<sv_magic>.
1773 Do magic after a value is retrieved from the SV. See C<sv_magic>.
1783 Report on the SV's length. See C<sv_magic>.
1785 U32 mg_length(SV* sv)
1793 Turns on the magical status of an SV. See C<sv_magic>.
1795 void mg_magical(SV* sv)
1803 Do magic after a value is assigned to the SV. See C<sv_magic>.
1813 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
1814 argument more than once.
1816 void SvGETMAGIC(SV* sv)
1824 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
1835 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
1836 argument more than once.
1838 void SvSETMAGIC(SV* sv)
1846 Like C<SvSetSV>, but does any set magic required afterwards.
1848 void SvSetMagicSV(SV* dsb, SV* ssv)
1853 =item SvSetMagicSV_nosteal
1854 X<SvSetMagicSV_nosteal>
1856 Like C<SvSetSV_nosteal>, but does any set magic required afterwards.
1858 void SvSetMagicSV_nosteal(SV* dsv, SV* ssv)
1866 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
1869 void SvSetSV(SV* dsb, SV* ssv)
1874 =item SvSetSV_nosteal
1877 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
1878 ssv. May evaluate arguments more than once.
1880 void SvSetSV_nosteal(SV* dsv, SV* ssv)
1888 Arranges for sv to be shared between threads if a suitable module
1891 void SvSHARE(SV* sv)
1899 Releases a mutual exclusion lock on sv if a suitable module
1902 void SvUNLOCK(SV* sv)
1910 =head1 Memory Management
1917 The XSUB-writer's interface to the C C<memcpy> function. The C<src> is the
1918 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1919 the type. May fail on overlapping copies. See also C<Move>.
1921 void Copy(void* src, void* dest, int nitems, type)
1924 Found in file handy.h
1929 Like C<Copy> but returns dest. Useful for encouraging compilers to tail-call
1932 void * CopyD(void* src, void* dest, int nitems, type)
1935 Found in file handy.h
1940 The XSUB-writer's interface to the C C<memmove> function. The C<src> is the
1941 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1942 the type. Can do overlapping moves. See also C<Copy>.
1944 void Move(void* src, void* dest, int nitems, type)
1947 Found in file handy.h
1952 Like C<Move> but returns dest. Useful for encouraging compilers to tail-call
1955 void * MoveD(void* src, void* dest, int nitems, type)
1958 Found in file handy.h
1963 The XSUB-writer's interface to the C C<malloc> function.
1965 In 5.9.3, Newx() and friends replace the older New() API, and drops
1966 the first parameter, I<x>, a debug aid which allowed callers to identify
1967 themselves. This aid has been superceded by a new build option,
1968 PERL_MEM_LOG (see L<perlhack/PERL_MEM_LOG>). The older API is still
1969 there for use in XS modules supporting older perls.
1971 void Newx(void* ptr, int nitems, type)
1974 Found in file handy.h
1979 The XSUB-writer's interface to the C C<malloc> function, with
1980 cast. See also C<Newx>.
1982 void Newxc(void* ptr, int nitems, type, cast)
1985 Found in file handy.h
1990 The XSUB-writer's interface to the C C<malloc> function. The allocated
1991 memory is zeroed with C<memzero>. See also C<Newx>.
1993 void Newxz(void* ptr, int nitems, type)
1996 Found in file handy.h
2001 Fill up memory with a pattern (byte 0xAB over and over again) that
2002 hopefully catches attempts to access uninitialized memory.
2004 void Poison(void* dest, int nitems, type)
2007 Found in file handy.h
2012 The XSUB-writer's interface to the C C<realloc> function.
2014 void Renew(void* ptr, int nitems, type)
2017 Found in file handy.h
2022 The XSUB-writer's interface to the C C<realloc> function, with
2025 void Renewc(void* ptr, int nitems, type, cast)
2028 Found in file handy.h
2033 The XSUB-writer's interface to the C C<free> function.
2035 void Safefree(void* ptr)
2038 Found in file handy.h
2043 Perl's version of C<strdup()>. Returns a pointer to a newly allocated
2044 string which is a duplicate of C<pv>. The size of the string is
2045 determined by C<strlen()>. The memory allocated for the new string can
2046 be freed with the C<Safefree()> function.
2048 char* savepv(const char* pv)
2051 Found in file util.c
2056 Perl's version of what C<strndup()> would be if it existed. Returns a
2057 pointer to a newly allocated string which is a duplicate of the first
2058 C<len> bytes from C<pv>. The memory allocated for the new string can be
2059 freed with the C<Safefree()> function.
2061 char* savepvn(const char* pv, I32 len)
2064 Found in file util.c
2069 A version of C<savepv()> which allocates the duplicate string in memory
2070 which is shared between threads.
2072 char* savesharedpv(const char* pv)
2075 Found in file util.c
2080 A version of C<savepv()>/C<savepvn()> which gets the string to duplicate from
2081 the passed in SV using C<SvPV()>
2083 char* savesvpv(SV* sv)
2086 Found in file util.c
2091 This is an architecture-independent macro to copy one structure to another.
2093 void StructCopy(type src, type dest, type)
2096 Found in file handy.h
2101 The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the
2102 destination, C<nitems> is the number of items, and C<type> is the type.
2104 void Zero(void* dest, int nitems, type)
2107 Found in file handy.h
2112 Like C<Zero> but returns dest. Useful for encouraging compilers to tail-call
2115 void * ZeroD(void* dest, int nitems, type)
2118 Found in file handy.h
2123 =head1 Miscellaneous Functions
2130 Analyses the string in order to make fast searches on it using fbm_instr()
2131 -- the Boyer-Moore algorithm.
2133 void fbm_compile(SV* sv, U32 flags)
2136 Found in file util.c
2141 Returns the location of the SV in the string delimited by C<str> and
2142 C<strend>. It returns C<Nullch> if the string can't be found. The C<sv>
2143 does not have to be fbm_compiled, but the search will not be as fast
2146 char* fbm_instr(unsigned char* big, unsigned char* bigend, SV* littlesv, U32 flags)
2149 Found in file util.c
2154 Takes a sprintf-style format pattern and conventional
2155 (non-SV) arguments and returns the formatted string.
2157 (char *) Perl_form(pTHX_ const char* pat, ...)
2159 can be used any place a string (char *) is required:
2161 char * s = Perl_form("%d.%d",major,minor);
2163 Uses a single private buffer so if you want to format several strings you
2164 must explicitly copy the earlier strings away (and free the copies when you
2167 char* form(const char* pat, ...)
2170 Found in file util.c
2175 Fill the sv with current working directory
2177 int getcwd_sv(SV* sv)
2180 Found in file util.c
2185 The C library C<sprintf>, wrapped if necessary, to ensure that it will return
2186 the length of the string written to the buffer. Only rare pre-ANSI systems
2187 need the wrapper function - usually this is a direct call to C<sprintf>.
2189 int my_sprintf(char *buffer, const char *pat, ...)
2192 Found in file util.c
2197 Returns a new version object based on the passed in SV:
2199 SV *sv = new_version(SV *ver);
2201 Does not alter the passed in ver SV. See "upg_version" if you
2202 want to upgrade the SV.
2204 SV* new_version(SV *ver)
2207 Found in file util.c
2212 Returns a pointer to the next character after the parsed
2213 version string, as well as upgrading the passed in SV to
2216 Function must be called with an already existing SV like
2219 s = scan_version(s,SV *sv, bool qv);
2221 Performs some preprocessing to the string to ensure that
2222 it has the correct characteristics of a version. Flags the
2223 object if it contains an underscore (which denotes this
2224 is a alpha version). The boolean qv denotes that the version
2225 should be interpreted as if it had multiple decimals, even if
2228 const char* scan_version(const char *vstr, SV *sv, bool qv)
2231 Found in file util.c
2236 Test two strings to see if they are equal. Returns true or false.
2238 bool strEQ(char* s1, char* s2)
2241 Found in file handy.h
2246 Test two strings to see if the first, C<s1>, is greater than or equal to
2247 the second, C<s2>. Returns true or false.
2249 bool strGE(char* s1, char* s2)
2252 Found in file handy.h
2257 Test two strings to see if the first, C<s1>, is greater than the second,
2258 C<s2>. Returns true or false.
2260 bool strGT(char* s1, char* s2)
2263 Found in file handy.h
2268 Test two strings to see if the first, C<s1>, is less than or equal to the
2269 second, C<s2>. Returns true or false.
2271 bool strLE(char* s1, char* s2)
2274 Found in file handy.h
2279 Test two strings to see if the first, C<s1>, is less than the second,
2280 C<s2>. Returns true or false.
2282 bool strLT(char* s1, char* s2)
2285 Found in file handy.h
2290 Test two strings to see if they are different. Returns true or
2293 bool strNE(char* s1, char* s2)
2296 Found in file handy.h
2301 Test two strings to see if they are equal. The C<len> parameter indicates
2302 the number of bytes to compare. Returns true or false. (A wrapper for
2305 bool strnEQ(char* s1, char* s2, STRLEN len)
2308 Found in file handy.h
2313 Test two strings to see if they are different. The C<len> parameter
2314 indicates the number of bytes to compare. Returns true or false. (A
2315 wrapper for C<strncmp>).
2317 bool strnNE(char* s1, char* s2, STRLEN len)
2320 Found in file handy.h
2325 Dummy routine which "shares" an SV when there is no sharing module present.
2326 Or "locks" it. Or "unlocks" it. In other words, ignores its single SV argument.
2327 Exists to avoid test for a NULL function pointer and because it could
2328 potentially warn under some level of strict-ness.
2330 void sv_nosharing(SV *)
2333 Found in file util.c
2338 In-place upgrade of the supplied SV to a version object.
2340 SV *sv = upg_version(SV *sv);
2342 Returns a pointer to the upgraded SV.
2344 SV* upg_version(SV *ver)
2347 Found in file util.c
2352 Version object aware cmp. Both operands must already have been
2353 converted into version objects.
2355 int vcmp(SV *lvs, SV *rvs)
2358 Found in file util.c
2363 Accepts a version object and returns the normalized string
2364 representation. Call like:
2368 NOTE: you can pass either the object directly or the SV
2369 contained within the RV.
2374 Found in file util.c
2379 Accepts a version object and returns the normalized floating
2380 point representation. Call like:
2384 NOTE: you can pass either the object directly or the SV
2385 contained within the RV.
2390 Found in file util.c
2395 In order to maintain maximum compatibility with earlier versions
2396 of Perl, this function will return either the floating point
2397 notation or the multiple dotted notation, depending on whether
2398 the original version contained 1 or more dots, respectively
2400 SV* vstringify(SV *vs)
2403 Found in file util.c
2408 Validates that the SV contains a valid version object.
2410 bool vverify(SV *vobj);
2412 Note that it only confirms the bare minimum structure (so as not to get
2413 confused by derived classes which may contain additional hash entries):
2415 bool vverify(SV *vs)
2418 Found in file util.c
2423 =head1 Multicall Functions
2430 Declare local variables for a multicall. See L<perlcall/Lightweight Callbacks>.
2440 Make a lightweight callback. See L<perlcall/Lightweight Callbacks>.
2450 Closing bracket for a lightweight callback.
2451 See L<perlcall/Lightweight Callbacks>.
2458 =item PUSH_MULTICALL
2461 Opening bracket for a lightweight callback.
2462 See L<perlcall/Lightweight Callbacks>.
2472 =head1 Numeric functions
2479 converts a string representing a binary number to numeric form.
2481 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2482 conversion flags, and I<result> should be NULL or a pointer to an NV.
2483 The scan stops at the end of the string, or the first invalid character.
2484 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2485 invalid character will also trigger a warning.
2486 On return I<*len> is set to the length of the scanned string,
2487 and I<*flags> gives output flags.
2489 If the value is <= C<UV_MAX> it is returned as a UV, the output flags are clear,
2490 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_bin>
2491 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2492 and writes the value to I<*result> (or the value is discarded if I<result>
2495 The binary number may optionally be prefixed with "0b" or "b" unless
2496 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
2497 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the binary
2498 number may use '_' characters to separate digits.
2500 UV grok_bin(const char* start, STRLEN* len_p, I32* flags, NV *result)
2503 Found in file numeric.c
2508 converts a string representing a hex number to numeric form.
2510 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2511 conversion flags, and I<result> should be NULL or a pointer to an NV.
2512 The scan stops at the end of the string, or the first invalid character.
2513 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2514 invalid character will also trigger a warning.
2515 On return I<*len> is set to the length of the scanned string,
2516 and I<*flags> gives output flags.
2518 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2519 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_hex>
2520 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2521 and writes the value to I<*result> (or the value is discarded if I<result>
2524 The hex number may optionally be prefixed with "0x" or "x" unless
2525 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
2526 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the hex
2527 number may use '_' characters to separate digits.
2529 UV grok_hex(const char* start, STRLEN* len_p, I32* flags, NV *result)
2532 Found in file numeric.c
2537 Recognise (or not) a number. The type of the number is returned
2538 (0 if unrecognised), otherwise it is a bit-ORed combination of
2539 IS_NUMBER_IN_UV, IS_NUMBER_GREATER_THAN_UV_MAX, IS_NUMBER_NOT_INT,
2540 IS_NUMBER_NEG, IS_NUMBER_INFINITY, IS_NUMBER_NAN (defined in perl.h).
2542 If the value of the number can fit an in UV, it is returned in the *valuep
2543 IS_NUMBER_IN_UV will be set to indicate that *valuep is valid, IS_NUMBER_IN_UV
2544 will never be set unless *valuep is valid, but *valuep may have been assigned
2545 to during processing even though IS_NUMBER_IN_UV is not set on return.
2546 If valuep is NULL, IS_NUMBER_IN_UV will be set for the same cases as when
2547 valuep is non-NULL, but no actual assignment (or SEGV) will occur.
2549 IS_NUMBER_NOT_INT will be set with IS_NUMBER_IN_UV if trailing decimals were
2550 seen (in which case *valuep gives the true value truncated to an integer), and
2551 IS_NUMBER_NEG if the number is negative (in which case *valuep holds the
2552 absolute value). IS_NUMBER_IN_UV is not set if e notation was used or the
2553 number is larger than a UV.
2555 int grok_number(const char *pv, STRLEN len, UV *valuep)
2558 Found in file numeric.c
2560 =item grok_numeric_radix
2561 X<grok_numeric_radix>
2563 Scan and skip for a numeric decimal separator (radix).
2565 bool grok_numeric_radix(const char **sp, const char *send)
2568 Found in file numeric.c
2573 converts a string representing an octal number to numeric form.
2575 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2576 conversion flags, and I<result> should be NULL or a pointer to an NV.
2577 The scan stops at the end of the string, or the first invalid character.
2578 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2579 invalid character will also trigger a warning.
2580 On return I<*len> is set to the length of the scanned string,
2581 and I<*flags> gives output flags.
2583 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2584 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_oct>
2585 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2586 and writes the value to I<*result> (or the value is discarded if I<result>
2589 If C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the octal
2590 number may use '_' characters to separate digits.
2592 UV grok_oct(const char* start, STRLEN* len_p, I32* flags, NV *result)
2595 Found in file numeric.c
2600 For backwards compatibility. Use C<grok_bin> instead.
2602 NV scan_bin(const char* start, STRLEN len, STRLEN* retlen)
2605 Found in file numeric.c
2610 For backwards compatibility. Use C<grok_hex> instead.
2612 NV scan_hex(const char* start, STRLEN len, STRLEN* retlen)
2615 Found in file numeric.c
2620 For backwards compatibility. Use C<grok_oct> instead.
2622 NV scan_oct(const char* start, STRLEN len, STRLEN* retlen)
2625 Found in file numeric.c
2630 =head1 Optree Manipulation Functions
2637 If C<cv> is a constant sub eligible for inlining. returns the constant
2638 value returned by the sub. Otherwise, returns NULL.
2640 Constant subs can be created with C<newCONSTSUB> or as described in
2641 L<perlsub/"Constant Functions">.
2643 SV* cv_const_sv(CV* cv)
2651 Creates a constant sub equivalent to Perl C<sub FOO () { 123 }> which is
2652 eligible for inlining at compile-time.
2654 CV* newCONSTSUB(HV* stash, const char* name, SV* sv)
2662 Used by C<xsubpp> to hook up XSUBs as Perl subs.
2670 =head1 Pad Data Structures
2677 Get the value at offset po in the current pad.
2678 Use macro PAD_SV instead of calling this function directly.
2680 SV* pad_sv(PADOFFSET po)
2688 =head1 Simple Exception Handling Macros
2695 Set up necessary local variables for exception handling.
2696 See L<perlguts/"Exception Handling">.
2701 Found in file XSUB.h
2706 Introduces a catch block. See L<perlguts/"Exception Handling">.
2709 Found in file XSUB.h
2714 Rethrows a previously caught exception. See L<perlguts/"Exception Handling">.
2719 Found in file XSUB.h
2724 Ends a try block. See L<perlguts/"Exception Handling">.
2727 Found in file XSUB.h
2729 =item XCPT_TRY_START
2732 Starts a try block. See L<perlguts/"Exception Handling">.
2735 Found in file XSUB.h
2740 =head1 Stack Manipulation Macros
2747 Declare a stack marker variable, C<mark>, for the XSUB. See C<MARK> and
2758 Saves the original stack mark for the XSUB. See C<ORIGMARK>.
2768 Declares a local copy of perl's stack pointer for the XSUB, available via
2769 the C<SP> macro. See C<SP>.
2779 Used to extend the argument stack for an XSUB's return values. Once
2780 used, guarantees that there is room for at least C<nitems> to be pushed
2783 void EXTEND(SP, int nitems)
2791 Stack marker variable for the XSUB. See C<dMARK>.
2799 Push an integer onto the stack. The stack must have room for this element.
2800 Handles 'set' magic. Does not use C<TARG>. See also C<PUSHi>, C<mXPUSHi>
2811 Push a double onto the stack. The stack must have room for this element.
2812 Handles 'set' magic. Does not use C<TARG>. See also C<PUSHn>, C<mXPUSHn>
2823 Push a string onto the stack. The stack must have room for this element.
2824 The C<len> indicates the length of the string. Handles 'set' magic. Does
2825 not use C<TARG>. See also C<PUSHp>, C<mXPUSHp> and C<XPUSHp>.
2827 void mPUSHp(char* str, STRLEN len)
2835 Push an unsigned integer onto the stack. The stack must have room for this
2836 element. Handles 'set' magic. Does not use C<TARG>. See also C<PUSHu>,
2837 C<mXPUSHu> and C<XPUSHu>.
2847 Push an integer onto the stack, extending the stack if necessary. Handles
2848 'set' magic. Does not use C<TARG>. See also C<XPUSHi>, C<mPUSHi> and
2859 Push a double onto the stack, extending the stack if necessary. Handles
2860 'set' magic. Does not use C<TARG>. See also C<XPUSHn>, C<mPUSHn> and
2871 Push a string onto the stack, extending the stack if necessary. The C<len>
2872 indicates the length of the string. Handles 'set' magic. Does not use
2873 C<TARG>. See also C<XPUSHp>, C<mPUSHp> and C<PUSHp>.
2875 void mXPUSHp(char* str, STRLEN len)
2883 Push an unsigned integer onto the stack, extending the stack if necessary.
2884 Handles 'set' magic. Does not use C<TARG>. See also C<XPUSHu>, C<mPUSHu>
2895 The original stack mark for the XSUB. See C<dORIGMARK>.
2903 Pops an integer off the stack.
2913 Pops a long off the stack.
2923 Pops a double off the stack.
2933 Pops a string off the stack. Deprecated. New code should use POPpx.
2943 Pops a string off the stack which must consist of bytes i.e. characters < 256.
2953 Pops a string off the stack.
2963 Pops an SV off the stack.
2973 Push an integer onto the stack. The stack must have room for this element.
2974 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
2975 called to declare it. Do not call multiple C<TARG>-oriented macros to
2976 return lists from XSUB's - see C<mPUSHi> instead. See also C<XPUSHi> and
2987 Opening bracket for arguments on a callback. See C<PUTBACK> and
2998 Push a new mortal SV onto the stack. The stack must have room for this
2999 element. Does not handle 'set' magic. Does not use C<TARG>. See also
3000 C<PUSHs>, C<XPUSHmortal> and C<XPUSHs>.
3010 Push a double onto the stack. The stack must have room for this element.
3011 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3012 called to declare it. Do not call multiple C<TARG>-oriented macros to
3013 return lists from XSUB's - see C<mPUSHn> instead. See also C<XPUSHn> and
3024 Push a string onto the stack. The stack must have room for this element.
3025 The C<len> indicates the length of the string. Handles 'set' magic. Uses
3026 C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to declare it. Do not
3027 call multiple C<TARG>-oriented macros to return lists from XSUB's - see
3028 C<mPUSHp> instead. See also C<XPUSHp> and C<mXPUSHp>.
3030 void PUSHp(char* str, STRLEN len)
3038 Push an SV onto the stack. The stack must have room for this element.
3039 Does not handle 'set' magic. Does not use C<TARG>. See also C<PUSHmortal>,
3040 C<XPUSHs> and C<XPUSHmortal>.
3050 Push an unsigned integer onto the stack. The stack must have room for this
3051 element. Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG>
3052 should be called to declare it. Do not call multiple C<TARG>-oriented
3053 macros to return lists from XSUB's - see C<mPUSHu> instead. See also
3054 C<XPUSHu> and C<mXPUSHu>.
3064 Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
3065 See C<PUSHMARK> and L<perlcall> for other uses.
3075 Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and
3084 Refetch the stack pointer. Used after a callback. See L<perlcall>.
3094 Push an integer onto the stack, extending the stack if necessary. Handles
3095 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
3096 declare it. Do not call multiple C<TARG>-oriented macros to return lists
3097 from XSUB's - see C<mXPUSHi> instead. See also C<PUSHi> and C<mPUSHi>.
3107 Push a new mortal SV onto the stack, extending the stack if necessary. Does
3108 not handle 'set' magic. Does not use C<TARG>. See also C<XPUSHs>,
3109 C<PUSHmortal> and C<PUSHs>.
3119 Push a double onto the stack, extending the stack if necessary. Handles
3120 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
3121 declare it. Do not call multiple C<TARG>-oriented macros to return lists
3122 from XSUB's - see C<mXPUSHn> instead. See also C<PUSHn> and C<mPUSHn>.
3132 Push a string onto the stack, extending the stack if necessary. The C<len>
3133 indicates the length of the string. Handles 'set' magic. Uses C<TARG>, so
3134 C<dTARGET> or C<dXSTARG> should be called to declare it. Do not call
3135 multiple C<TARG>-oriented macros to return lists from XSUB's - see
3136 C<mXPUSHp> instead. See also C<PUSHp> and C<mPUSHp>.
3138 void XPUSHp(char* str, STRLEN len)
3146 Push an SV onto the stack, extending the stack if necessary. Does not
3147 handle 'set' magic. Does not use C<TARG>. See also C<XPUSHmortal>,
3148 C<PUSHs> and C<PUSHmortal>.
3158 Push an unsigned integer onto the stack, extending the stack if necessary.
3159 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3160 called to declare it. Do not call multiple C<TARG>-oriented macros to
3161 return lists from XSUB's - see C<mXPUSHu> instead. See also C<PUSHu> and
3172 Return from XSUB, indicating number of items on the stack. This is usually
3173 handled by C<xsubpp>.
3175 void XSRETURN(int nitems)
3178 Found in file XSUB.h
3180 =item XSRETURN_EMPTY
3183 Return an empty list from an XSUB immediately.
3188 Found in file XSUB.h
3193 Return an integer from an XSUB immediately. Uses C<XST_mIV>.
3195 void XSRETURN_IV(IV iv)
3198 Found in file XSUB.h
3203 Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
3208 Found in file XSUB.h
3213 Return a double from an XSUB immediately. Uses C<XST_mNV>.
3215 void XSRETURN_NV(NV nv)
3218 Found in file XSUB.h
3223 Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
3225 void XSRETURN_PV(char* str)
3228 Found in file XSUB.h
3230 =item XSRETURN_UNDEF
3233 Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
3238 Found in file XSUB.h
3243 Return an integer from an XSUB immediately. Uses C<XST_mUV>.
3245 void XSRETURN_UV(IV uv)
3248 Found in file XSUB.h
3253 Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
3258 Found in file XSUB.h
3263 Place an integer into the specified position C<pos> on the stack. The
3264 value is stored in a new mortal SV.
3266 void XST_mIV(int pos, IV iv)
3269 Found in file XSUB.h
3274 Place C<&PL_sv_no> into the specified position C<pos> on the
3277 void XST_mNO(int pos)
3280 Found in file XSUB.h
3285 Place a double into the specified position C<pos> on the stack. The value
3286 is stored in a new mortal SV.
3288 void XST_mNV(int pos, NV nv)
3291 Found in file XSUB.h
3296 Place a copy of a string into the specified position C<pos> on the stack.
3297 The value is stored in a new mortal SV.
3299 void XST_mPV(int pos, char* str)
3302 Found in file XSUB.h
3307 Place C<&PL_sv_undef> into the specified position C<pos> on the
3310 void XST_mUNDEF(int pos)
3313 Found in file XSUB.h
3318 Place C<&PL_sv_yes> into the specified position C<pos> on the
3321 void XST_mYES(int pos)
3324 Found in file XSUB.h
3336 An enum of flags for Perl types. These are found in the file B<sv.h>
3337 in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
3345 Integer type flag for scalars. See C<svtype>.
3353 Double type flag for scalars. See C<svtype>.
3361 Pointer type flag for scalars. See C<svtype>.
3369 Type flag for arrays. See C<svtype>.
3377 Type flag for code refs. See C<svtype>.
3385 Type flag for hashes. See C<svtype>.
3393 Type flag for blessed scalars. See C<svtype>.
3401 =head1 SV Manipulation Functions
3408 Returns the SV of the specified Perl scalar. If C<create> is set and the
3409 Perl variable does not exist then it will be created. If C<create> is not
3410 set and the variable does not exist then NULL is returned.
3412 NOTE: the perl_ form of this function is deprecated.
3414 SV* get_sv(const char* name, I32 create)
3417 Found in file perl.c
3419 =item looks_like_number
3420 X<looks_like_number>
3422 Test if the content of an SV looks like a number (or is a number).
3423 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
3424 non-numeric warning), even if your atof() doesn't grok them.
3426 I32 looks_like_number(SV* sv)
3434 Creates an RV wrapper for an SV. The reference count for the original SV is
3437 SV* newRV_inc(SV* sv)
3445 Creates an RV wrapper for an SV. The reference count for the original
3446 SV is B<not> incremented.
3448 SV* newRV_noinc(SV *sv)
3456 Creates a new SV. A non-zero C<len> parameter indicates the number of
3457 bytes of preallocated string space the SV should have. An extra byte for a
3458 tailing NUL is also reserved. (SvPOK is not set for the SV even if string
3459 space is allocated.) The reference count for the new SV is set to 1.
3460 C<id> is an integer id between 0 and 1299 (used to identify leaks).
3462 SV* NEWSV(int id, STRLEN len)
3465 Found in file handy.h
3470 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
3471 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
3474 SV* newSV(STRLEN len)
3482 Creates a new SV from the hash key structure. It will generate scalars that
3483 point to the shared string table where possible. Returns a new (undefined)
3484 SV if the hek is NULL.
3486 SV* newSVhek(const HEK *hek)
3494 Creates a new SV and copies an integer into it. The reference count for the
3505 Creates a new SV and copies a floating point value into it.
3506 The reference count for the SV is set to 1.
3516 Creates a new SV and copies a string into it. The reference count for the
3517 SV is set to 1. If C<len> is zero, Perl will compute the length using
3518 strlen(). For efficiency, consider using C<newSVpvn> instead.
3520 SV* newSVpv(const char* s, STRLEN len)
3528 Creates a new SV and initializes it with the string formatted like
3531 SV* newSVpvf(const char* pat, ...)
3539 Creates a new SV and copies a string into it. The reference count for the
3540 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
3541 string. You are responsible for ensuring that the source string is at least
3542 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
3544 SV* newSVpvn(const char* s, STRLEN len)
3549 =item newSVpvn_share
3552 Creates a new SV with its SvPVX_const pointing to a shared string in the string
3553 table. If the string does not already exist in the table, it is created
3554 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
3555 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
3556 otherwise the hash is computed. The idea here is that as the string table
3557 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
3558 hash lookup will avoid string compare.
3560 SV* newSVpvn_share(const char* s, I32 len, U32 hash)
3568 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
3569 it will be upgraded to one. If C<classname> is non-null then the new SV will
3570 be blessed in the specified package. The new SV is returned and its
3571 reference count is 1.
3573 SV* newSVrv(SV* rv, const char* classname)
3581 Creates a new SV which is an exact duplicate of the original SV.
3584 SV* newSVsv(SV* old)
3592 Creates a new SV and copies an unsigned integer into it.
3593 The reference count for the SV is set to 1.
3603 Returns the length of the string which is in the SV. See C<SvLEN>.
3605 STRLEN SvCUR(SV* sv)
3613 Set the current length of the string which is in the SV. See C<SvCUR>
3616 void SvCUR_set(SV* sv, STRLEN len)
3624 Returns a pointer to the last character in the string which is in the SV.
3625 See C<SvCUR>. Access the character as *(SvEND(sv)).
3635 Expands the character buffer in the SV so that it has room for the
3636 indicated number of bytes (remember to reserve space for an extra trailing
3637 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
3638 Returns a pointer to the character buffer.
3640 char * SvGROW(SV* sv, STRLEN len)
3648 Returns a boolean indicating whether the SV contains an integer.
3658 Returns a boolean indicating whether the SV contains an integer. Checks
3659 the B<private> setting. Use C<SvIOK>.
3669 Returns a boolean indicating whether the SV contains a signed integer.
3671 bool SvIOK_notUV(SV* sv)
3679 Unsets the IV status of an SV.
3681 void SvIOK_off(SV* sv)
3689 Tells an SV that it is an integer.
3691 void SvIOK_on(SV* sv)
3699 Tells an SV that it is an integer and disables all other OK bits.
3701 void SvIOK_only(SV* sv)
3709 Tells and SV that it is an unsigned integer and disables all other OK bits.
3711 void SvIOK_only_UV(SV* sv)
3719 Returns a boolean indicating whether the SV contains an unsigned integer.
3721 bool SvIOK_UV(SV* sv)
3729 Returns a boolean indicating whether the SV is Copy-On-Write. (either shared
3730 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
3733 bool SvIsCOW(SV* sv)
3738 =item SvIsCOW_shared_hash
3739 X<SvIsCOW_shared_hash>
3741 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
3744 bool SvIsCOW_shared_hash(SV* sv)
3752 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
3753 version which guarantees to evaluate sv only once.
3763 Returns the raw value in the SV's IV slot, without checks or conversions.
3764 Only use when you are sure SvIOK is true. See also C<SvIV()>.
3774 Coerces the given SV to an integer and returns it. Guarantees to evaluate
3775 sv only once. Use the more efficient C<SvIV> otherwise.
3785 Like C<SvIV> but doesn't process magic.
3787 IV SvIV_nomg(SV* sv)
3795 Set the value of the IV pointer in sv to val. It is possible to perform
3796 the same function of this macro with an lvalue assignment to C<SvIVX>.
3797 With future Perls, however, it will be more efficient to use
3798 C<SvIV_set> instead of the lvalue assignment to C<SvIVX>.
3800 void SvIV_set(SV* sv, IV val)
3808 Returns the size of the string buffer in the SV, not including any part
3809 attributable to C<SvOOK>. See C<SvCUR>.
3811 STRLEN SvLEN(SV* sv)
3819 Set the actual length of the string which is in the SV. See C<SvIV_set>.
3821 void SvLEN_set(SV* sv, STRLEN len)
3829 Set the value of the MAGIC pointer in sv to val. See C<SvIV_set>.
3831 void SvMAGIC_set(SV* sv, MAGIC* val)
3839 Returns a boolean indicating whether the SV contains a number, integer or
3850 Returns a boolean indicating whether the SV contains a number, integer or
3851 double. Checks the B<private> setting. Use C<SvNIOK>.
3853 bool SvNIOKp(SV* sv)
3861 Unsets the NV/IV status of an SV.
3863 void SvNIOK_off(SV* sv)
3871 Returns a boolean indicating whether the SV contains a double.
3881 Returns a boolean indicating whether the SV contains a double. Checks the
3882 B<private> setting. Use C<SvNOK>.
3892 Unsets the NV status of an SV.
3894 void SvNOK_off(SV* sv)
3902 Tells an SV that it is a double.
3904 void SvNOK_on(SV* sv)
3912 Tells an SV that it is a double and disables all other OK bits.
3914 void SvNOK_only(SV* sv)
3922 Coerce the given SV to a double and return it. See C<SvNVx> for a version
3923 which guarantees to evaluate sv only once.
3933 Returns the raw value in the SV's NV slot, without checks or conversions.
3934 Only use when you are sure SvNOK is true. See also C<SvNV()>.
3944 Coerces the given SV to a double and returns it. Guarantees to evaluate
3945 sv only once. Use the more efficient C<SvNV> otherwise.
3955 Set the value of the NV pointer in sv to val. See C<SvIV_set>.
3957 void SvNV_set(SV* sv, NV val)
3965 Returns a boolean indicating whether the value is an SV. It also tells
3966 whether the value is defined or not.
3976 Returns a boolean indicating whether the SvIVX is a valid offset value for
3977 the SvPVX. This hack is used internally to speed up removal of characters
3978 from the beginning of a SvPV. When SvOOK is true, then the start of the
3979 allocated string buffer is really (SvPVX - SvIVX).
3989 Returns a boolean indicating whether the SV contains a character
4000 Returns a boolean indicating whether the SV contains a character string.
4001 Checks the B<private> setting. Use C<SvPOK>.
4011 Unsets the PV status of an SV.
4013 void SvPOK_off(SV* sv)
4021 Tells an SV that it is a string.
4023 void SvPOK_on(SV* sv)
4031 Tells an SV that it is a string and disables all other OK bits.
4032 Will also turn off the UTF-8 status.
4034 void SvPOK_only(SV* sv)
4039 =item SvPOK_only_UTF8
4042 Tells an SV that it is a string and disables all other OK bits,
4043 and leaves the UTF-8 status as it was.
4045 void SvPOK_only_UTF8(SV* sv)
4053 Returns a pointer to the string in the SV, or a stringified form of
4054 the SV if the SV does not contain a string. The SV may cache the
4055 stringified version becoming C<SvPOK>. Handles 'get' magic. See also
4056 C<SvPVx> for a version which guarantees to evaluate sv only once.
4058 char* SvPV(SV* sv, STRLEN len)
4066 Like C<SvPV>, but converts sv to byte representation first if necessary.
4068 char* SvPVbyte(SV* sv, STRLEN len)
4076 Like C<SvPV>, but converts sv to byte representation first if necessary.
4077 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
4080 char* SvPVbytex(SV* sv, STRLEN len)
4085 =item SvPVbytex_force
4088 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
4089 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
4092 char* SvPVbytex_force(SV* sv, STRLEN len)
4097 =item SvPVbyte_force
4100 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
4102 char* SvPVbyte_force(SV* sv, STRLEN len)
4107 =item SvPVbyte_nolen
4110 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
4112 char* SvPVbyte_nolen(SV* sv)
4120 Like C<SvPV>, but converts sv to utf8 first if necessary.
4122 char* SvPVutf8(SV* sv, STRLEN len)
4130 Like C<SvPV>, but converts sv to utf8 first if necessary.
4131 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
4134 char* SvPVutf8x(SV* sv, STRLEN len)
4139 =item SvPVutf8x_force
4142 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
4143 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
4146 char* SvPVutf8x_force(SV* sv, STRLEN len)
4151 =item SvPVutf8_force
4154 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
4156 char* SvPVutf8_force(SV* sv, STRLEN len)
4161 =item SvPVutf8_nolen
4164 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
4166 char* SvPVutf8_nolen(SV* sv)
4174 Returns a pointer to the physical string in the SV. The SV must contain a
4185 A version of C<SvPV> which guarantees to evaluate sv only once.
4187 char* SvPVx(SV* sv, STRLEN len)
4195 Like C<SvPV> but will force the SV into containing just a string
4196 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
4199 char* SvPV_force(SV* sv, STRLEN len)
4204 =item SvPV_force_nomg
4207 Like C<SvPV> but will force the SV into containing just a string
4208 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
4209 directly. Doesn't process magic.
4211 char* SvPV_force_nomg(SV* sv, STRLEN len)
4219 Returns a pointer to the string in the SV, or a stringified form of
4220 the SV if the SV does not contain a string. The SV may cache the
4221 stringified form becoming C<SvPOK>. Handles 'get' magic.
4223 char* SvPV_nolen(SV* sv)
4231 Like C<SvPV> but doesn't process magic.
4233 char* SvPV_nomg(SV* sv, STRLEN len)
4241 Set the value of the PV pointer in sv to val. See C<SvIV_set>.
4243 void SvPV_set(SV* sv, char* val)
4251 Returns the value of the object's reference count.
4253 U32 SvREFCNT(SV* sv)
4261 Decrements the reference count of the given SV.
4263 void SvREFCNT_dec(SV* sv)
4271 Increments the reference count of the given SV.
4273 SV* SvREFCNT_inc(SV* sv)
4281 Tests if the SV is an RV.
4291 Unsets the RV status of an SV.
4293 void SvROK_off(SV* sv)
4301 Tells an SV that it is an RV.
4303 void SvROK_on(SV* sv)
4311 Dereferences an RV to return the SV.
4321 Set the value of the RV pointer in sv to val. See C<SvIV_set>.
4323 void SvRV_set(SV* sv, SV* val)
4331 Returns the stash of the SV.
4341 Set the value of the STASH pointer in sv to val. See C<SvIV_set>.
4343 void SvSTASH_set(SV* sv, STASH* val)
4351 Taints an SV if tainting is enabled.
4353 void SvTAINT(SV* sv)
4361 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
4364 bool SvTAINTED(SV* sv)
4372 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
4373 some of Perl's fundamental security features. XS module authors should not
4374 use this function unless they fully understand all the implications of
4375 unconditionally untainting the value. Untainting should be done in the
4376 standard perl fashion, via a carefully crafted regexp, rather than directly
4377 untainting variables.
4379 void SvTAINTED_off(SV* sv)
4387 Marks an SV as tainted if tainting is enabled.
4389 void SvTAINTED_on(SV* sv)
4397 Returns a boolean indicating whether Perl would evaluate the SV as true or
4398 false, defined or undefined. Does not handle 'get' magic.
4408 Returns the type of the SV. See C<svtype>.
4410 svtype SvTYPE(SV* sv)
4418 Returns a boolean indicating whether the SV contains an unsigned integer.
4428 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
4429 perform the upgrade if necessary. See C<svtype>.
4431 void SvUPGRADE(SV* sv, svtype type)
4439 Returns a boolean indicating whether the SV contains UTF-8 encoded data.
4449 Unsets the UTF-8 status of an SV.
4451 void SvUTF8_off(SV *sv)
4459 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
4460 Do not use frivolously.
4462 void SvUTF8_on(SV *sv)
4470 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
4471 for a version which guarantees to evaluate sv only once.
4481 Returns the raw value in the SV's UV slot, without checks or conversions.
4482 Only use when you are sure SvIOK is true. See also C<SvUV()>.
4492 Coerces the given SV to an unsigned integer and returns it. Guarantees to
4493 evaluate sv only once. Use the more efficient C<SvUV> otherwise.
4503 Like C<SvUV> but doesn't process magic.
4505 UV SvUV_nomg(SV* sv)
4513 Set the value of the UV pointer in sv to val. See C<SvIV_set>.
4515 void SvUV_set(SV* sv, UV val)
4523 Returns a boolean indicating whether the SV contains a v-string.
4533 This function is only called on magical items, and is only used by
4534 sv_true() or its macro equivalent.
4536 bool sv_2bool(SV* sv)
4544 Using various gambits, try to get a CV from an SV; in addition, try if
4545 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
4547 CV* sv_2cv(SV* sv, HV** st, GV** gvp, I32 lref)
4555 Using various gambits, try to get an IO from an SV: the IO slot if its a
4556 GV; or the recursive result if we're an RV; or the IO slot of the symbol
4557 named after the PV if we're a string.
4567 Return the integer value of an SV, doing any necessary string
4568 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
4569 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
4571 IV sv_2iv_flags(SV* sv, I32 flags)
4579 Marks an existing SV as mortal. The SV will be destroyed "soon", either
4580 by an explicit call to FREETMPS, or by an implicit call at places such as
4581 statement boundaries. SvTEMP() is turned on which means that the SV's
4582 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
4583 and C<sv_mortalcopy>.
4585 SV* sv_2mortal(SV* sv)
4593 Return the num value of an SV, doing any necessary string or integer
4594 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
4605 Return a pointer to the byte-encoded representation of the SV, and set *lp
4606 to its length. May cause the SV to be downgraded from UTF-8 as a
4609 Usually accessed via the C<SvPVbyte> macro.
4611 char* sv_2pvbyte(SV* sv, STRLEN* lp)
4619 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
4620 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
4622 Usually accessed via the C<SvPVutf8> macro.
4624 char* sv_2pvutf8(SV* sv, STRLEN* lp)
4632 Returns a pointer to the string value of an SV, and sets *lp to its length.
4633 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
4635 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
4636 usually end up here too.
4638 char* sv_2pv_flags(SV* sv, STRLEN* lp, I32 flags)
4646 Return the unsigned integer value of an SV, doing any necessary string
4647 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
4648 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
4650 UV sv_2uv_flags(SV* sv, I32 flags)
4658 Remove any string offset. You should normally use the C<SvOOK_off> macro
4661 int sv_backoff(SV* sv)
4669 Blesses an SV into a specified package. The SV must be an RV. The package
4670 must be designated by its stash (see C<gv_stashpv()>). The reference count
4671 of the SV is unaffected.
4673 SV* sv_bless(SV* sv, HV* stash)
4681 Concatenates the string onto the end of the string which is in the SV.
4682 If the SV has the UTF-8 status set, then the bytes appended should be
4683 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4685 void sv_catpv(SV* sv, const char* ptr)
4693 Processes its arguments like C<sprintf> and appends the formatted
4694 output to an SV. If the appended data contains "wide" characters
4695 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
4696 and characters >255 formatted with %c), the original SV might get
4697 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
4698 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
4699 valid UTF-8; if the original SV was bytes, the pattern should be too.
4701 void sv_catpvf(SV* sv, const char* pat, ...)
4709 Like C<sv_catpvf>, but also handles 'set' magic.
4711 void sv_catpvf_mg(SV *sv, const char* pat, ...)
4719 Concatenates the string onto the end of the string which is in the SV. The
4720 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4721 status set, then the bytes appended should be valid UTF-8.
4722 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4724 void sv_catpvn(SV* sv, const char* ptr, STRLEN len)
4729 =item sv_catpvn_flags
4732 Concatenates the string onto the end of the string which is in the SV. The
4733 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4734 status set, then the bytes appended should be valid UTF-8.
4735 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4736 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4737 in terms of this function.
4739 void sv_catpvn_flags(SV* sv, const char* ptr, STRLEN len, I32 flags)
4744 =item sv_catpvn_nomg
4747 Like C<sv_catpvn> but doesn't process magic.
4749 void sv_catpvn_nomg(SV* sv, const char* ptr, STRLEN len)
4757 Like C<sv_catpv>, but also handles 'set' magic.
4759 void sv_catpv_mg(SV *sv, const char *ptr)
4767 Concatenates the string from SV C<ssv> onto the end of the string in
4768 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4769 not 'set' magic. See C<sv_catsv_mg>.
4771 void sv_catsv(SV* dsv, SV* ssv)
4776 =item sv_catsv_flags
4779 Concatenates the string from SV C<ssv> onto the end of the string in
4780 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4781 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4782 and C<sv_catsv_nomg> are implemented in terms of this function.
4784 void sv_catsv_flags(SV* dsv, SV* ssv, I32 flags)
4792 Like C<sv_catsv> but doesn't process magic.
4794 void sv_catsv_nomg(SV* dsv, SV* ssv)
4802 Efficient removal of characters from the beginning of the string buffer.
4803 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4804 the string buffer. The C<ptr> becomes the first character of the adjusted
4805 string. Uses the "OOK hack".
4806 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4807 refer to the same chunk of data.
4809 void sv_chop(SV* sv, const char* ptr)
4817 Clear an SV: call any destructors, free up any memory used by the body,
4818 and free the body itself. The SV's head is I<not> freed, although
4819 its type is set to all 1's so that it won't inadvertently be assumed
4820 to be live during global destruction etc.
4821 This function should only be called when REFCNT is zero. Most of the time
4822 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
4825 void sv_clear(SV* sv)
4833 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
4834 string in C<sv1> is less than, equal to, or greater than the string in
4835 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
4836 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
4838 I32 sv_cmp(SV* sv1, SV* sv2)
4846 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
4847 'use bytes' aware, handles get magic, and will coerce its args to strings
4848 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
4850 I32 sv_cmp_locale(SV* sv1, SV* sv2)
4858 Add Collate Transform magic to an SV if it doesn't already have it.
4860 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
4861 scalar data of the variable, but transformed to such a format that a normal
4862 memory comparison can be used to compare the data according to the locale
4865 char* sv_collxfrm(SV* sv, STRLEN* nxp)
4873 Copies a stringified representation of the source SV into the
4874 destination SV. Automatically performs any necessary mg_get and
4875 coercion of numeric values into strings. Guaranteed to preserve
4876 UTF-8 flag even from overloaded objects. Similar in nature to
4877 sv_2pv[_flags] but operates directly on an SV instead of just the
4878 string. Mostly uses sv_2pv_flags to do its work, except when that
4879 would lose the UTF-8'ness of the PV.
4881 void sv_copypv(SV* dsv, SV* ssv)
4889 Auto-decrement of the value in the SV, doing string to numeric conversion
4890 if necessary. Handles 'get' magic.
4897 =item sv_derived_from
4900 Returns a boolean indicating whether the SV is derived from the specified
4901 class. This is the function that implements C<UNIVERSAL::isa>. It works
4902 for class names as well as for objects.
4904 bool sv_derived_from(SV* sv, const char* name)
4907 Found in file universal.c
4912 Returns a boolean indicating whether the strings in the two SVs are
4913 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
4914 coerce its args to strings if necessary.
4916 I32 sv_eq(SV* sv1, SV* sv2)
4921 =item sv_force_normal_flags
4922 X<sv_force_normal_flags>
4924 Undo various types of fakery on an SV: if the PV is a shared string, make
4925 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4926 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4927 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4928 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4929 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4930 set to some other value.) In addition, the C<flags> parameter gets passed to
4931 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4932 with flags set to 0.
4934 void sv_force_normal_flags(SV *sv, U32 flags)
4942 Decrement an SV's reference count, and if it drops to zero, call
4943 C<sv_clear> to invoke destructors and free up any memory used by
4944 the body; finally, deallocate the SV's head itself.
4945 Normally called via a wrapper macro C<SvREFCNT_dec>.
4947 void sv_free(SV* sv)
4955 Get a line from the filehandle and store it into the SV, optionally
4956 appending to the currently-stored string.
4958 char* sv_gets(SV* sv, PerlIO* fp, I32 append)
4966 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
4967 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
4968 Use the C<SvGROW> wrapper instead.
4970 char* sv_grow(SV* sv, STRLEN newlen)
4978 Auto-increment of the value in the SV, doing string to numeric conversion
4979 if necessary. Handles 'get' magic.
4989 Inserts a string at the specified offset/length within the SV. Similar to
4990 the Perl substr() function.
4992 void sv_insert(SV* bigsv, STRLEN offset, STRLEN len, const char* little, STRLEN littlelen)
5000 Returns a boolean indicating whether the SV is blessed into the specified
5001 class. This does not check for subtypes; use C<sv_derived_from> to verify
5002 an inheritance relationship.
5004 int sv_isa(SV* sv, const char* name)
5012 Returns a boolean indicating whether the SV is an RV pointing to a blessed
5013 object. If the SV is not an RV, or if the object is not blessed, then this
5016 int sv_isobject(SV* sv)
5024 Returns the length of the string in the SV. Handles magic and type
5025 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5027 STRLEN sv_len(SV* sv)
5035 Returns the number of characters in the string in an SV, counting wide
5036 UTF-8 bytes as a single character. Handles magic and type coercion.
5038 STRLEN sv_len_utf8(SV* sv)
5046 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
5047 then adds a new magic item of type C<how> to the head of the magic list.
5049 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
5050 handling of the C<name> and C<namlen> arguments.
5052 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
5053 to add more than one instance of the same 'how'.
5055 void sv_magic(SV* sv, SV* obj, int how, const char* name, I32 namlen)
5063 Adds magic to an SV, upgrading it if necessary. Applies the
5064 supplied vtable and returns a pointer to the magic added.
5066 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
5067 In particular, you can add magic to SvREADONLY SVs, and add more than
5068 one instance of the same 'how'.
5070 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
5071 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
5072 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
5073 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
5075 (This is now used as a subroutine by C<sv_magic>.)
5077 MAGIC * sv_magicext(SV* sv, SV* obj, int how, const MGVTBL *vtbl, const char* name, I32 namlen)
5085 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
5086 The new SV is marked as mortal. It will be destroyed "soon", either by an
5087 explicit call to FREETMPS, or by an implicit call at places such as
5088 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
5090 SV* sv_mortalcopy(SV* oldsv)
5098 Creates a new null SV which is mortal. The reference count of the SV is
5099 set to 1. It will be destroyed "soon", either by an explicit call to
5100 FREETMPS, or by an implicit call at places such as statement boundaries.
5101 See also C<sv_mortalcopy> and C<sv_2mortal>.
5111 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5114 SV* sv_newref(SV* sv)
5122 Converts the value pointed to by offsetp from a count of bytes from the
5123 start of the string, to a count of the equivalent number of UTF-8 chars.
5124 Handles magic and type coercion.
5126 void sv_pos_b2u(SV* sv, I32* offsetp)
5134 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5135 the start of the string, to a count of the equivalent number of bytes; if
5136 lenp is non-zero, it does the same to lenp, but this time starting from
5137 the offset, rather than from the start of the string. Handles magic and
5140 void sv_pos_u2b(SV* sv, I32* offsetp, I32* lenp)
5145 =item sv_pvbyten_force
5148 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
5150 char* sv_pvbyten_force(SV* sv, STRLEN* lp)
5158 Get a sensible string out of the SV somehow.
5159 A private implementation of the C<SvPV_force> macro for compilers which
5160 can't cope with complex macro expressions. Always use the macro instead.
5162 char* sv_pvn_force(SV* sv, STRLEN* lp)
5167 =item sv_pvn_force_flags
5168 X<sv_pvn_force_flags>
5170 Get a sensible string out of the SV somehow.
5171 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
5172 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
5173 implemented in terms of this function.
5174 You normally want to use the various wrapper macros instead: see
5175 C<SvPV_force> and C<SvPV_force_nomg>
5177 char* sv_pvn_force_flags(SV* sv, STRLEN* lp, I32 flags)
5182 =item sv_pvutf8n_force
5185 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
5187 char* sv_pvutf8n_force(SV* sv, STRLEN* lp)
5195 Returns a string describing what the SV is a reference to.
5197 char* sv_reftype(const SV* sv, int ob)
5205 Make the first argument a copy of the second, then delete the original.
5206 The target SV physically takes over ownership of the body of the source SV
5207 and inherits its flags; however, the target keeps any magic it owns,
5208 and any magic in the source is discarded.
5209 Note that this is a rather specialist SV copying operation; most of the
5210 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5212 void sv_replace(SV* sv, SV* nsv)
5217 =item sv_report_used
5220 Dump the contents of all SVs not yet freed. (Debugging aid).
5222 void sv_report_used()
5230 Underlying implementation for the C<reset> Perl function.
5231 Note that the perl-level function is vaguely deprecated.
5233 void sv_reset(const char* s, HV* stash)
5241 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
5242 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
5243 push a back-reference to this RV onto the array of backreferences
5244 associated with that magic.
5246 SV* sv_rvweaken(SV *sv)
5254 Copies an integer into the given SV, upgrading first if necessary.
5255 Does not handle 'set' magic. See also C<sv_setiv_mg>.
5257 void sv_setiv(SV* sv, IV num)
5265 Like C<sv_setiv>, but also handles 'set' magic.
5267 void sv_setiv_mg(SV *sv, IV i)
5275 Copies a double into the given SV, upgrading first if necessary.
5276 Does not handle 'set' magic. See also C<sv_setnv_mg>.
5278 void sv_setnv(SV* sv, NV num)
5286 Like C<sv_setnv>, but also handles 'set' magic.
5288 void sv_setnv_mg(SV *sv, NV num)
5296 Copies a string into an SV. The string must be null-terminated. Does not
5297 handle 'set' magic. See C<sv_setpv_mg>.
5299 void sv_setpv(SV* sv, const char* ptr)
5307 Works like C<sv_catpvf> but copies the text into the SV instead of
5308 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
5310 void sv_setpvf(SV* sv, const char* pat, ...)
5318 Like C<sv_setpvf>, but also handles 'set' magic.
5320 void sv_setpvf_mg(SV *sv, const char* pat, ...)
5328 Copies an integer into the given SV, also updating its string value.
5329 Does not handle 'set' magic. See C<sv_setpviv_mg>.
5331 void sv_setpviv(SV* sv, IV num)
5339 Like C<sv_setpviv>, but also handles 'set' magic.
5341 void sv_setpviv_mg(SV *sv, IV iv)
5349 Copies a string into an SV. The C<len> parameter indicates the number of
5350 bytes to be copied. If the C<ptr> argument is NULL the SV will become
5351 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
5353 void sv_setpvn(SV* sv, const char* ptr, STRLEN len)
5361 Like C<sv_setpvn>, but also handles 'set' magic.
5363 void sv_setpvn_mg(SV *sv, const char *ptr, STRLEN len)
5371 Like C<sv_setpv>, but also handles 'set' magic.
5373 void sv_setpv_mg(SV *sv, const char *ptr)
5381 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
5382 argument will be upgraded to an RV. That RV will be modified to point to
5383 the new SV. The C<classname> argument indicates the package for the
5384 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
5385 will have a reference count of 1, and the RV will be returned.
5387 SV* sv_setref_iv(SV* rv, const char* classname, IV iv)
5395 Copies a double into a new SV, optionally blessing the SV. The C<rv>
5396 argument will be upgraded to an RV. That RV will be modified to point to
5397 the new SV. The C<classname> argument indicates the package for the
5398 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
5399 will have a reference count of 1, and the RV will be returned.
5401 SV* sv_setref_nv(SV* rv, const char* classname, NV nv)
5409 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
5410 argument will be upgraded to an RV. That RV will be modified to point to
5411 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
5412 into the SV. The C<classname> argument indicates the package for the
5413 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
5414 will have a reference count of 1, and the RV will be returned.
5416 Do not use with other Perl types such as HV, AV, SV, CV, because those
5417 objects will become corrupted by the pointer copy process.
5419 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
5421 SV* sv_setref_pv(SV* rv, const char* classname, void* pv)
5429 Copies a string into a new SV, optionally blessing the SV. The length of the
5430 string must be specified with C<n>. The C<rv> argument will be upgraded to
5431 an RV. That RV will be modified to point to the new SV. The C<classname>
5432 argument indicates the package for the blessing. Set C<classname> to
5433 C<Nullch> to avoid the blessing. The new SV will have a reference count
5434 of 1, and the RV will be returned.
5436 Note that C<sv_setref_pv> copies the pointer while this copies the string.
5438 SV* sv_setref_pvn(SV* rv, const char* classname, const char* pv, STRLEN n)
5446 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
5447 argument will be upgraded to an RV. That RV will be modified to point to
5448 the new SV. The C<classname> argument indicates the package for the
5449 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
5450 will have a reference count of 1, and the RV will be returned.
5452 SV* sv_setref_uv(SV* rv, const char* classname, UV uv)
5460 Copies the contents of the source SV C<ssv> into the destination SV
5461 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
5462 function if the source SV needs to be reused. Does not handle 'set' magic.
5463 Loosely speaking, it performs a copy-by-value, obliterating any previous
5464 content of the destination.
5466 You probably want to use one of the assortment of wrappers, such as
5467 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
5468 C<SvSetMagicSV_nosteal>.
5470 void sv_setsv(SV* dsv, SV* ssv)
5475 =item sv_setsv_flags
5478 Copies the contents of the source SV C<ssv> into the destination SV
5479 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
5480 function if the source SV needs to be reused. Does not handle 'set' magic.
5481 Loosely speaking, it performs a copy-by-value, obliterating any previous
5482 content of the destination.
5483 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
5484 C<ssv> if appropriate, else not. If the C<flags> parameter has the
5485 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
5486 and C<sv_setsv_nomg> are implemented in terms of this function.
5488 You probably want to use one of the assortment of wrappers, such as
5489 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
5490 C<SvSetMagicSV_nosteal>.
5492 This is the primary function for copying scalars, and most other
5493 copy-ish functions and macros use this underneath.
5495 void sv_setsv_flags(SV* dsv, SV* ssv, I32 flags)
5503 Like C<sv_setsv>, but also handles 'set' magic.
5505 void sv_setsv_mg(SV *dstr, SV *sstr)
5513 Like C<sv_setsv> but doesn't process magic.
5515 void sv_setsv_nomg(SV* dsv, SV* ssv)
5523 Copies an unsigned integer into the given SV, upgrading first if necessary.
5524 Does not handle 'set' magic. See also C<sv_setuv_mg>.
5526 void sv_setuv(SV* sv, UV num)
5534 Like C<sv_setuv>, but also handles 'set' magic.
5536 void sv_setuv_mg(SV *sv, UV u)
5544 Test an SV for taintedness. Use C<SvTAINTED> instead.
5545 bool sv_tainted(SV* sv)
5553 Returns true if the SV has a true value by Perl's rules.
5554 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
5555 instead use an in-line version.
5565 Removes all magic of type C<type> from an SV.
5567 int sv_unmagic(SV* sv, int type)
5572 =item sv_unref_flags
5575 Unsets the RV status of the SV, and decrements the reference count of
5576 whatever was being referenced by the RV. This can almost be thought of
5577 as a reversal of C<newSVrv>. The C<cflags> argument can contain
5578 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
5579 (otherwise the decrementing is conditional on the reference count being
5580 different from one or the reference being a readonly SV).
5583 void sv_unref_flags(SV* sv, U32 flags)
5591 Untaint an SV. Use C<SvTAINTED_off> instead.
5592 void sv_untaint(SV* sv)
5600 Upgrade an SV to a more complex form. Generally adds a new body type to the
5601 SV, then copies across as much information as possible from the old body.
5602 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
5604 void sv_upgrade(SV* sv, U32 mt)
5612 Tells an SV to use C<ptr> to find its string value. Normally the string is
5613 stored inside the SV but sv_usepvn allows the SV to use an outside string.
5614 The C<ptr> should point to memory that was allocated by C<malloc>. The
5615 string length, C<len>, must be supplied. This function will realloc the
5616 memory pointed to by C<ptr>, so that pointer should not be freed or used by
5617 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
5618 See C<sv_usepvn_mg>.
5620 void sv_usepvn(SV* sv, char* ptr, STRLEN len)
5628 Like C<sv_usepvn>, but also handles 'set' magic.
5630 void sv_usepvn_mg(SV *sv, char *ptr, STRLEN len)
5635 =item sv_utf8_decode
5638 If the PV of the SV is an octet sequence in UTF-8
5639 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
5640 so that it looks like a character. If the PV contains only single-byte
5641 characters, the C<SvUTF8> flag stays being off.
5642 Scans PV for validity and returns false if the PV is invalid UTF-8.
5644 NOTE: this function is experimental and may change or be
5645 removed without notice.
5647 bool sv_utf8_decode(SV *sv)
5652 =item sv_utf8_downgrade
5653 X<sv_utf8_downgrade>
5655 Attempts to convert the PV of an SV from characters to bytes.
5656 If the PV contains a character beyond byte, this conversion will fail;
5657 in this case, either returns false or, if C<fail_ok> is not
5660 This is not as a general purpose Unicode to byte encoding interface:
5661 use the Encode extension for that.
5663 NOTE: this function is experimental and may change or be
5664 removed without notice.
5666 bool sv_utf8_downgrade(SV *sv, bool fail_ok)
5671 =item sv_utf8_encode
5674 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
5675 flag off so that it looks like octets again.
5677 void sv_utf8_encode(SV *sv)
5682 =item sv_utf8_upgrade
5685 Converts the PV of an SV to its UTF-8-encoded form.
5686 Forces the SV to string form if it is not already.
5687 Always sets the SvUTF8 flag to avoid future validity checks even
5688 if all the bytes have hibit clear.
5690 This is not as a general purpose byte encoding to Unicode interface:
5691 use the Encode extension for that.
5693 STRLEN sv_utf8_upgrade(SV *sv)
5698 =item sv_utf8_upgrade_flags
5699 X<sv_utf8_upgrade_flags>
5701 Converts the PV of an SV to its UTF-8-encoded form.
5702 Forces the SV to string form if it is not already.
5703 Always sets the SvUTF8 flag to avoid future validity checks even
5704 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
5705 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
5706 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
5708 This is not as a general purpose byte encoding to Unicode interface:
5709 use the Encode extension for that.
5711 STRLEN sv_utf8_upgrade_flags(SV *sv, I32 flags)
5719 Processes its arguments like C<vsprintf> and appends the formatted output
5720 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
5722 Usually used via its frontend C<sv_catpvf>.
5724 void sv_vcatpvf(SV* sv, const char* pat, va_list* args)
5732 Processes its arguments like C<vsprintf> and appends the formatted output
5733 to an SV. Uses an array of SVs if the C style variable argument list is
5734 missing (NULL). When running with taint checks enabled, indicates via
5735 C<maybe_tainted> if results are untrustworthy (often due to the use of
5738 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
5740 void sv_vcatpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
5748 Like C<sv_vcatpvf>, but also handles 'set' magic.
5750 Usually used via its frontend C<sv_catpvf_mg>.
5752 void sv_vcatpvf_mg(SV* sv, const char* pat, va_list* args)
5760 Works like C<sv_vcatpvf> but copies the text into the SV instead of
5761 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
5763 Usually used via its frontend C<sv_setpvf>.
5765 void sv_vsetpvf(SV* sv, const char* pat, va_list* args)
5773 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
5776 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
5778 void sv_vsetpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
5786 Like C<sv_vsetpvf>, but also handles 'set' magic.
5788 Usually used via its frontend C<sv_setpvf_mg>.
5790 void sv_vsetpvf_mg(SV* sv, const char* pat, va_list* args)
5798 =head1 Unicode Support
5802 =item bytes_from_utf8
5805 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
5806 Unlike C<utf8_to_bytes> but like C<bytes_to_utf8>, returns a pointer to
5807 the newly-created string, and updates C<len> to contain the new
5808 length. Returns the original string if no conversion occurs, C<len>
5809 is unchanged. Do nothing if C<is_utf8> points to 0. Sets C<is_utf8> to
5810 0 if C<s> is converted or contains all 7bit characters.
5812 NOTE: this function is experimental and may change or be
5813 removed without notice.
5815 U8* bytes_from_utf8(const U8 *s, STRLEN *len, bool *is_utf8)
5818 Found in file utf8.c
5823 Converts a string C<s> of length C<len> from ASCII into UTF-8 encoding.
5824 Returns a pointer to the newly-created string, and sets C<len> to
5825 reflect the new length.
5827 If you want to convert to UTF-8 from other encodings than ASCII,
5828 see sv_recode_to_utf8().
5830 NOTE: this function is experimental and may change or be
5831 removed without notice.
5833 U8* bytes_to_utf8(const U8 *s, STRLEN *len)
5836 Found in file utf8.c
5841 Return true if the strings s1 and s2 differ case-insensitively, false
5842 if not (if they are equal case-insensitively). If u1 is true, the
5843 string s1 is assumed to be in UTF-8-encoded Unicode. If u2 is true,
5844 the string s2 is assumed to be in UTF-8-encoded Unicode. If u1 or u2
5845 are false, the respective string is assumed to be in native 8-bit
5848 If the pe1 and pe2 are non-NULL, the scanning pointers will be copied
5849 in there (they will point at the beginning of the I<next> character).
5850 If the pointers behind pe1 or pe2 are non-NULL, they are the end
5851 pointers beyond which scanning will not continue under any
5852 circumstances. If the byte lengths l1 and l2 are non-zero, s1+l1 and
5853 s2+l2 will be used as goal end pointers that will also stop the scan,
5854 and which qualify towards defining a successful match: all the scans
5855 that define an explicit length must reach their goal pointers for
5856 a match to succeed).
5858 For case-insensitiveness, the "casefolding" of Unicode is used
5859 instead of upper/lowercasing both the characters, see
5860 http://www.unicode.org/unicode/reports/tr21/ (Case Mappings).
5862 I32 ibcmp_utf8(const char* a, char **pe1, UV l1, bool u1, const char* b, char **pe2, UV l2, bool u2)
5865 Found in file utf8.c
5870 Tests if some arbitrary number of bytes begins in a valid UTF-8
5871 character. Note that an INVARIANT (i.e. ASCII) character is a valid
5872 UTF-8 character. The actual number of bytes in the UTF-8 character
5873 will be returned if it is valid, otherwise 0.
5875 STRLEN is_utf8_char(const U8 *p)
5878 Found in file utf8.c
5880 =item is_utf8_string
5883 Returns true if first C<len> bytes of the given string form a valid
5884 UTF-8 string, false otherwise. Note that 'a valid UTF-8 string' does
5885 not mean 'a string that contains code points above 0x7F encoded in UTF-8'
5886 because a valid ASCII string is a valid UTF-8 string.
5888 See also is_utf8_string_loclen() and is_utf8_string_loc().
5890 bool is_utf8_string(const U8 *s, STRLEN len)
5893 Found in file utf8.c
5895 =item is_utf8_string_loc
5896 X<is_utf8_string_loc>
5898 Like is_utf8_string() but stores the location of the failure (in the
5899 case of "utf8ness failure") or the location s+len (in the case of
5900 "utf8ness success") in the C<ep>.
5902 See also is_utf8_string_loclen() and is_utf8_string().
5904 bool is_utf8_string_loc(const U8 *s, STRLEN len, const U8 **p)
5907 Found in file utf8.c
5909 =item is_utf8_string_loclen
5910 X<is_utf8_string_loclen>
5912 Like is_utf8_string() but stores the location of the failure (in the
5913 case of "utf8ness failure") or the location s+len (in the case of
5914 "utf8ness success") in the C<ep>, and the number of UTF-8
5915 encoded characters in the C<el>.
5917 See also is_utf8_string_loc() and is_utf8_string().
5919 bool is_utf8_string_loclen(const U8 *s, STRLEN len, const U8 **ep, STRLEN *el)
5922 Found in file utf8.c
5924 =item pv_uni_display
5927 Build to the scalar dsv a displayable version of the string spv,
5928 length len, the displayable version being at most pvlim bytes long
5929 (if longer, the rest is truncated and "..." will be appended).
5931 The flags argument can have UNI_DISPLAY_ISPRINT set to display
5932 isPRINT()able characters as themselves, UNI_DISPLAY_BACKSLASH
5933 to display the \\[nrfta\\] as the backslashed versions (like '\n')
5934 (UNI_DISPLAY_BACKSLASH is preferred over UNI_DISPLAY_ISPRINT for \\).
5935 UNI_DISPLAY_QQ (and its alias UNI_DISPLAY_REGEX) have both
5936 UNI_DISPLAY_BACKSLASH and UNI_DISPLAY_ISPRINT turned on.
5938 The pointer to the PV of the dsv is returned.
5940 char* pv_uni_display(SV *dsv, const U8 *spv, STRLEN len, STRLEN pvlim, UV flags)
5943 Found in file utf8.c
5948 The encoding is assumed to be an Encode object, the PV of the ssv is
5949 assumed to be octets in that encoding and decoding the input starts
5950 from the position which (PV + *offset) pointed to. The dsv will be
5951 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
5952 when the string tstr appears in decoding output or the input ends on
5953 the PV of the ssv. The value which the offset points will be modified
5954 to the last input position on the ssv.
5956 Returns TRUE if the terminator was found, else returns FALSE.
5958 bool sv_cat_decode(SV* dsv, SV *encoding, SV *ssv, int *offset, char* tstr, int tlen)
5963 =item sv_recode_to_utf8
5964 X<sv_recode_to_utf8>
5966 The encoding is assumed to be an Encode object, on entry the PV
5967 of the sv is assumed to be octets in that encoding, and the sv
5968 will be converted into Unicode (and UTF-8).
5970 If the sv already is UTF-8 (or if it is not POK), or if the encoding
5971 is not a reference, nothing is done to the sv. If the encoding is not
5972 an C<Encode::XS> Encoding object, bad things will happen.
5973 (See F<lib/encoding.pm> and L<Encode>).
5975 The PV of the sv is returned.
5977 char* sv_recode_to_utf8(SV* sv, SV *encoding)
5982 =item sv_uni_display
5985 Build to the scalar dsv a displayable version of the scalar sv,
5986 the displayable version being at most pvlim bytes long
5987 (if longer, the rest is truncated and "..." will be appended).
5989 The flags argument is as in pv_uni_display().
5991 The pointer to the PV of the dsv is returned.
5993 char* sv_uni_display(SV *dsv, SV *ssv, STRLEN pvlim, UV flags)
5996 Found in file utf8.c
6001 The "p" contains the pointer to the UTF-8 string encoding
6002 the character that is being converted.
6004 The "ustrp" is a pointer to the character buffer to put the
6005 conversion result to. The "lenp" is a pointer to the length
6008 The "swashp" is a pointer to the swash to use.
6010 Both the special and normal mappings are stored lib/unicore/To/Foo.pl,
6011 and loaded by SWASHGET, using lib/utf8_heavy.pl. The special (usually,
6012 but not always, a multicharacter mapping), is tried first.
6014 The "special" is a string like "utf8::ToSpecLower", which means the
6015 hash %utf8::ToSpecLower. The access to the hash is through
6016 Perl_to_utf8_case().
6018 The "normal" is a string like "ToLower" which means the swash
6021 UV to_utf8_case(const U8 *p, U8* ustrp, STRLEN *lenp, SV **swashp, const char *normal, const char *special)
6024 Found in file utf8.c
6029 Convert the UTF-8 encoded character at p to its foldcase version and
6030 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6031 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6032 foldcase version may be longer than the original character (up to
6035 The first character of the foldcased version is returned
6036 (but note, as explained above, that there may be more.)
6038 UV to_utf8_fold(const U8 *p, U8* ustrp, STRLEN *lenp)
6041 Found in file utf8.c
6046 Convert the UTF-8 encoded character at p to its lowercase version and
6047 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6048 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6049 lowercase version may be longer than the original character.
6051 The first character of the lowercased version is returned
6052 (but note, as explained above, that there may be more.)
6054 UV to_utf8_lower(const U8 *p, U8* ustrp, STRLEN *lenp)
6057 Found in file utf8.c
6062 Convert the UTF-8 encoded character at p to its titlecase version and
6063 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6064 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6065 titlecase version may be longer than the original character.
6067 The first character of the titlecased version is returned
6068 (but note, as explained above, that there may be more.)
6070 UV to_utf8_title(const U8 *p, U8* ustrp, STRLEN *lenp)
6073 Found in file utf8.c
6078 Convert the UTF-8 encoded character at p to its uppercase version and
6079 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6080 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since
6081 the uppercase version may be longer than the original character.
6083 The first character of the uppercased version is returned
6084 (but note, as explained above, that there may be more.)
6086 UV to_utf8_upper(const U8 *p, U8* ustrp, STRLEN *lenp)
6089 Found in file utf8.c
6091 =item utf8n_to_uvchr
6096 Returns the native character value of the first character in the string
6098 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6099 length, in bytes, of that character.
6101 Allows length and flags to be passed to low level routine.
6103 UV utf8n_to_uvchr(const U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags)
6106 Found in file utf8.c
6108 =item utf8n_to_uvuni
6111 Bottom level UTF-8 decode routine.
6112 Returns the unicode code point value of the first character in the string C<s>
6113 which is assumed to be in UTF-8 encoding and no longer than C<curlen>;
6114 C<retlen> will be set to the length, in bytes, of that character.
6116 If C<s> does not point to a well-formed UTF-8 character, the behaviour
6117 is dependent on the value of C<flags>: if it contains UTF8_CHECK_ONLY,
6118 it is assumed that the caller will raise a warning, and this function
6119 will silently just set C<retlen> to C<-1> and return zero. If the
6120 C<flags> does not contain UTF8_CHECK_ONLY, warnings about
6121 malformations will be given, C<retlen> will be set to the expected
6122 length of the UTF-8 character in bytes, and zero will be returned.
6124 The C<flags> can also contain various flags to allow deviations from
6125 the strict UTF-8 encoding (see F<utf8.h>).
6127 Most code should use utf8_to_uvchr() rather than call this directly.
6129 UV utf8n_to_uvuni(const U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags)
6132 Found in file utf8.c
6137 Returns the number of UTF-8 characters between the UTF-8 pointers C<a>
6140 WARNING: use only if you *know* that the pointers point inside the
6143 IV utf8_distance(const U8 *a, const U8 *b)
6146 Found in file utf8.c
6151 Return the UTF-8 pointer C<s> displaced by C<off> characters, either
6152 forward or backward.
6154 WARNING: do not use the following unless you *know* C<off> is within
6155 the UTF-8 data pointed to by C<s> *and* that on entry C<s> is aligned
6156 on the first byte of character or just after the last byte of a character.
6158 U8* utf8_hop(const U8 *s, I32 off)
6161 Found in file utf8.c
6166 Return the length of the UTF-8 char encoded string C<s> in characters.
6167 Stops at C<e> (inclusive). If C<e E<lt> s> or if the scan would end
6168 up past C<e>, croaks.
6170 STRLEN utf8_length(const U8* s, const U8 *e)
6173 Found in file utf8.c
6178 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
6179 Unlike C<bytes_to_utf8>, this over-writes the original string, and
6180 updates len to contain the new length.
6181 Returns zero on failure, setting C<len> to -1.
6183 NOTE: this function is experimental and may change or be
6184 removed without notice.
6186 U8* utf8_to_bytes(U8 *s, STRLEN *len)
6189 Found in file utf8.c
6194 Returns the native character value of the first character in the string C<s>
6195 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6196 length, in bytes, of that character.
6198 If C<s> does not point to a well-formed UTF-8 character, zero is
6199 returned and retlen is set, if possible, to -1.
6201 UV utf8_to_uvchr(const U8 *s, STRLEN *retlen)
6204 Found in file utf8.c
6209 Returns the Unicode code point of the first character in the string C<s>
6210 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6211 length, in bytes, of that character.
6213 This function should only be used when returned UV is considered
6214 an index into the Unicode semantic tables (e.g. swashes).
6216 If C<s> does not point to a well-formed UTF-8 character, zero is
6217 returned and retlen is set, if possible, to -1.
6219 UV utf8_to_uvuni(const U8 *s, STRLEN *retlen)
6222 Found in file utf8.c
6227 Adds the UTF-8 representation of the Native codepoint C<uv> to the end
6228 of the string C<d>; C<d> should be have at least C<UTF8_MAXBYTES+1> free
6229 bytes available. The return value is the pointer to the byte after the
6230 end of the new character. In other words,
6232 d = uvchr_to_utf8(d, uv);
6234 is the recommended wide native character-aware way of saying
6238 U8* uvchr_to_utf8(U8 *d, UV uv)
6241 Found in file utf8.c
6243 =item uvuni_to_utf8_flags
6244 X<uvuni_to_utf8_flags>
6246 Adds the UTF-8 representation of the Unicode codepoint C<uv> to the end
6247 of the string C<d>; C<d> should be have at least C<UTF8_MAXBYTES+1> free
6248 bytes available. The return value is the pointer to the byte after the
6249 end of the new character. In other words,
6251 d = uvuni_to_utf8_flags(d, uv, flags);
6255 d = uvuni_to_utf8(d, uv);
6257 (which is equivalent to)
6259 d = uvuni_to_utf8_flags(d, uv, 0);
6261 is the recommended Unicode-aware way of saying
6265 U8* uvuni_to_utf8_flags(U8 *d, UV uv, UV flags)
6268 Found in file utf8.c
6273 =head1 Variables created by C<xsubpp> and C<xsubpp> internal functions
6280 Variable which is setup by C<xsubpp> to indicate the stack base offset,
6281 used by the C<ST>, C<XSprePUSH> and C<XSRETURN> macros. The C<dMARK> macro
6282 must be called prior to setup the C<MARK> variable.
6287 Found in file XSUB.h
6292 Variable which is setup by C<xsubpp> to indicate the
6293 class name for a C++ XS constructor. This is always a C<char*>. See C<THIS>.
6298 Found in file XSUB.h
6303 Sets up the C<ax> variable.
6304 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
6309 Found in file XSUB.h
6314 Sets up the C<ax> variable and stack marker variable C<mark>.
6315 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
6320 Found in file XSUB.h
6325 Sets up the C<items> variable.
6326 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
6331 Found in file XSUB.h
6336 Sets up the C<padoff_du> variable for an XSUB that wishes to use
6342 Found in file XSUB.h
6347 Sets up stack and mark pointers for an XSUB, calling dSP and dMARK.
6348 Sets up the C<ax> and C<items> variables by calling C<dAX> and C<dITEMS>.
6349 This is usually handled automatically by C<xsubpp>.
6354 Found in file XSUB.h
6359 Sets up the C<ix> variable for an XSUB which has aliases. This is usually
6360 handled automatically by C<xsubpp>.
6365 Found in file XSUB.h
6370 Variable which is setup by C<xsubpp> to indicate the number of
6371 items on the stack. See L<perlxs/"Variable-length Parameter Lists">.
6376 Found in file XSUB.h
6381 Variable which is setup by C<xsubpp> to indicate which of an
6382 XSUB's aliases was used to invoke it. See L<perlxs/"The ALIAS: Keyword">.
6387 Found in file XSUB.h
6392 Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
6396 Found in file XSUB.h
6401 Variable which is setup by C<xsubpp> to hold the return value for an
6402 XSUB. This is always the proper type for the XSUB. See
6403 L<perlxs/"The RETVAL Variable">.
6408 Found in file XSUB.h
6413 Used to access elements on the XSUB's stack.
6418 Found in file XSUB.h
6423 Variable which is setup by C<xsubpp> to designate the object in a C++
6424 XSUB. This is always the proper type for the C++ object. See C<CLASS> and
6425 L<perlxs/"Using XS With C++">.
6430 Found in file XSUB.h
6435 The SV* corresponding to the $_ variable. Works even if there
6436 is a lexical $_ in scope.
6439 Found in file XSUB.h
6444 Macro to declare an XSUB and its C parameter list. This is handled by
6448 Found in file XSUB.h
6453 The version identifier for an XS module. This is usually
6454 handled automatically by C<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>.
6457 Found in file XSUB.h
6459 =item XS_VERSION_BOOTCHECK
6460 X<XS_VERSION_BOOTCHECK>
6462 Macro to verify that a PM module's $VERSION variable matches the XS
6463 module's C<XS_VERSION> variable. This is usually handled automatically by
6464 C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">.
6466 XS_VERSION_BOOTCHECK;
6469 Found in file XSUB.h
6474 =head1 Warning and Dieing
6481 This is the XSUB-writer's interface to Perl's C<die> function.
6482 Normally call this function the same way you call the C C<printf>
6483 function. Calling C<croak> returns control directly to Perl,
6484 sidestepping the normal C order of execution. See C<warn>.
6486 If you want to throw an exception object, assign the object to
6487 C<$@> and then pass C<Nullch> to croak():
6489 errsv = get_sv("@", TRUE);
6490 sv_setsv(errsv, exception_object);
6493 void croak(const char* pat, ...)
6496 Found in file util.c
6501 This is the XSUB-writer's interface to Perl's C<warn> function. Call this
6502 function the same way you call the C C<printf> function. See C<croak>.
6504 void warn(const char* pat, ...)
6507 Found in file util.c
6514 Until May 1997, this document was maintained by Jeff Okamoto
6515 <okamoto@corp.hp.com>. It is now maintained as part of Perl itself.
6517 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
6518 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
6519 Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
6520 Stephen McCamant, and Gurusamy Sarathy.
6522 API Listing originally by Dean Roehrich <roehrich@cray.com>.
6524 Updated to be autogenerated from comments in the source by Benjamin Stuhl.
6528 perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
projects / p5sagit/p5-mst-13.2.git / blob