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 Currently this always uses mergesort. See sortsv_flags for a more
323 void sortsv(SV** array, size_t num_elts, SVCOMPARE_t cmp)
326 Found in file pp_sort.c
331 Sort an array, with various options.
333 void sortsv_flags(SV** array, size_t num_elts, SVCOMPARE_t cmp, U32 flags)
336 Found in file pp_sort.c
341 =head1 Callback Functions
348 Performs a callback to the specified Perl sub. See L<perlcall>.
350 NOTE: the perl_ form of this function is deprecated.
352 I32 call_argv(const char* sub_name, I32 flags, char** argv)
360 Performs a callback to the specified Perl method. The blessed object must
361 be on the stack. See L<perlcall>.
363 NOTE: the perl_ form of this function is deprecated.
365 I32 call_method(const char* methname, I32 flags)
373 Performs a callback to the specified Perl sub. See L<perlcall>.
375 NOTE: the perl_ form of this function is deprecated.
377 I32 call_pv(const char* sub_name, I32 flags)
385 Performs a callback to the Perl sub whose name is in the SV. See
388 NOTE: the perl_ form of this function is deprecated.
390 I32 call_sv(SV* sv, I32 flags)
398 Opening bracket on a callback. See C<LEAVE> and L<perlcall>.
403 Found in file scope.h
408 Tells Perl to C<eval> the given string and return an SV* result.
410 NOTE: the perl_ form of this function is deprecated.
412 SV* eval_pv(const char* p, I32 croak_on_error)
420 Tells Perl to C<eval> the string in the SV.
422 NOTE: the perl_ form of this function is deprecated.
424 I32 eval_sv(SV* sv, I32 flags)
432 Closing bracket for temporaries on a callback. See C<SAVETMPS> and
438 Found in file scope.h
443 Closing bracket on a callback. See C<ENTER> and L<perlcall>.
448 Found in file scope.h
453 Opening bracket for temporaries on a callback. See C<FREETMPS> and
459 Found in file scope.h
464 =head1 Character classes
471 Returns a boolean indicating whether the C C<char> is an ASCII alphanumeric
472 character (including underscore) or digit.
474 bool isALNUM(char ch)
477 Found in file handy.h
482 Returns a boolean indicating whether the C C<char> is an ASCII alphabetic
485 bool isALPHA(char ch)
488 Found in file handy.h
493 Returns a boolean indicating whether the C C<char> is an ASCII
496 bool isDIGIT(char ch)
499 Found in file handy.h
504 Returns a boolean indicating whether the C C<char> is a lowercase
507 bool isLOWER(char ch)
510 Found in file handy.h
515 Returns a boolean indicating whether the C C<char> is whitespace.
517 bool isSPACE(char ch)
520 Found in file handy.h
525 Returns a boolean indicating whether the C C<char> is an uppercase
528 bool isUPPER(char ch)
531 Found in file handy.h
536 Converts the specified character to lowercase.
538 char toLOWER(char ch)
541 Found in file handy.h
546 Converts the specified character to uppercase.
548 char toUPPER(char ch)
551 Found in file handy.h
556 =head1 Cloning an interpreter
563 Create and return a new interpreter by cloning the current one.
565 perl_clone takes these flags as parameters:
567 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
568 without it we only clone the data and zero the stacks,
569 with it we copy the stacks and the new perl interpreter is
570 ready to run at the exact same point as the previous one.
571 The pseudo-fork code uses COPY_STACKS while the
572 threads->new doesn't.
574 CLONEf_KEEP_PTR_TABLE
575 perl_clone keeps a ptr_table with the pointer of the old
576 variable as a key and the new variable as a value,
577 this allows it to check if something has been cloned and not
578 clone it again but rather just use the value and increase the
579 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
580 the ptr_table using the function
581 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
582 reason to keep it around is if you want to dup some of your own
583 variable who are outside the graph perl scans, example of this
584 code is in threads.xs create
587 This is a win32 thing, it is ignored on unix, it tells perls
588 win32host code (which is c++) to clone itself, this is needed on
589 win32 if you want to run two threads at the same time,
590 if you just want to do some stuff in a separate perl interpreter
591 and then throw it away and return to the original one,
592 you don't need to do anything.
594 PerlInterpreter* perl_clone(PerlInterpreter* interp, UV flags)
602 =head1 CV Manipulation Functions
609 Returns the stash of the CV.
619 Returns the CV of the specified Perl subroutine. If C<create> is set and
620 the Perl subroutine does not exist then it will be declared (which has the
621 same effect as saying C<sub name;>). If C<create> is not set and the
622 subroutine does not exist then NULL is returned.
624 NOTE: the perl_ form of this function is deprecated.
626 CV* get_cv(const char* name, I32 create)
634 =head1 Embedding Functions
641 Clear out all the active components of a CV. This can happen either
642 by an explicit C<undef &foo>, or by the reference count going to zero.
643 In the former case, we keep the CvOUTSIDE pointer, so that any anonymous
644 children can still follow the full lexical scope chain.
646 void cv_undef(CV* cv)
654 Loads the module whose name is pointed to by the string part of name.
655 Note that the actual module name, not its filename, should be given.
656 Eg, "Foo::Bar" instead of "Foo/Bar.pm". flags can be any of
657 PERL_LOADMOD_DENY, PERL_LOADMOD_NOIMPORT, or PERL_LOADMOD_IMPORT_OPS
658 (or 0 for no flags). ver, if specified, provides version semantics
659 similar to C<use Foo::Bar VERSION>. The optional trailing SV*
660 arguments can be used to specify arguments to the module's import()
661 method, similar to C<use Foo::Bar VERSION LIST>.
663 void load_module(U32 flags, SV* name, SV* ver, ...)
671 Stub that provides thread hook for perl_destruct when there are
682 Allocates a new Perl interpreter. See L<perlembed>.
684 PerlInterpreter* perl_alloc()
692 Initializes a new Perl interpreter. See L<perlembed>.
694 void perl_construct(PerlInterpreter* interp)
702 Shuts down a Perl interpreter. See L<perlembed>.
704 int perl_destruct(PerlInterpreter* interp)
712 Releases a Perl interpreter. See L<perlembed>.
714 void perl_free(PerlInterpreter* interp)
722 Tells a Perl interpreter to parse a Perl script. See L<perlembed>.
724 int perl_parse(PerlInterpreter* interp, XSINIT_t xsinit, int argc, char** argv, char** env)
732 Tells a Perl interpreter to run. See L<perlembed>.
734 int perl_run(PerlInterpreter* interp)
742 Tells Perl to C<require> the file named by the string argument. It is
743 analogous to the Perl code C<eval "require '$file'">. It's even
744 implemented that way; consider using load_module instead.
746 NOTE: the perl_ form of this function is deprecated.
748 void require_pv(const char* pv)
756 =head1 Functions in file mathoms.c
764 See L<gv_fetchmethod_autoload>.
766 GV* gv_fetchmethod(HV* stash, const char* name)
769 Found in file mathoms.c
771 =item sv_2pvbyte_nolen
774 Return a pointer to the byte-encoded representation of the SV.
775 May cause the SV to be downgraded from UTF-8 as a side-effect.
777 Usually accessed via the C<SvPVbyte_nolen> macro.
779 char* sv_2pvbyte_nolen(SV* sv)
782 Found in file mathoms.c
784 =item sv_2pvutf8_nolen
787 Return a pointer to the UTF-8-encoded representation of the SV.
788 May cause the SV to be upgraded to UTF-8 as a side-effect.
790 Usually accessed via the C<SvPVutf8_nolen> macro.
792 char* sv_2pvutf8_nolen(SV* sv)
795 Found in file mathoms.c
800 Like C<sv_2pv()>, but doesn't return the length too. You should usually
801 use the macro wrapper C<SvPV_nolen(sv)> instead.
802 char* sv_2pv_nolen(SV* sv)
805 Found in file mathoms.c
810 Like C<sv_catpvn>, but also handles 'set' magic.
812 void sv_catpvn_mg(SV *sv, const char *ptr, STRLEN len)
815 Found in file mathoms.c
820 Like C<sv_catsv>, but also handles 'set' magic.
822 void sv_catsv_mg(SV *dstr, SV *sstr)
825 Found in file mathoms.c
827 =item sv_force_normal
830 Undo various types of fakery on an SV: if the PV is a shared string, make
831 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
832 an xpvmg. See also C<sv_force_normal_flags>.
834 void sv_force_normal(SV *sv)
837 Found in file mathoms.c
842 A private implementation of the C<SvIVx> macro for compilers which can't
843 cope with complex macro expressions. Always use the macro instead.
848 Found in file mathoms.c
853 Dummy routine which "locks" an SV when there is no locking module present.
854 Exists to avoid test for a NULL function pointer and because it could
855 potentially warn under some level of strict-ness.
857 "Superseded" by sv_nosharing().
859 void sv_nolocking(SV *sv)
862 Found in file mathoms.c
867 Dummy routine which "unlocks" an SV when there is no locking module present.
868 Exists to avoid test for a NULL function pointer and because it could
869 potentially warn under some level of strict-ness.
871 "Superseded" by sv_nosharing().
873 void sv_nounlocking(SV *sv)
876 Found in file mathoms.c
881 A private implementation of the C<SvNVx> macro for compilers which can't
882 cope with complex macro expressions. Always use the macro instead.
887 Found in file mathoms.c
892 Use the C<SvPV_nolen> macro instead
897 Found in file mathoms.c
902 Use C<SvPVbyte_nolen> instead.
904 char* sv_pvbyte(SV *sv)
907 Found in file mathoms.c
912 A private implementation of the C<SvPVbyte> macro for compilers
913 which can't cope with complex macro expressions. Always use the macro
916 char* sv_pvbyten(SV *sv, STRLEN *len)
919 Found in file mathoms.c
924 A private implementation of the C<SvPV> macro for compilers which can't
925 cope with complex macro expressions. Always use the macro instead.
927 char* sv_pvn(SV *sv, STRLEN *len)
930 Found in file mathoms.c
935 Use the C<SvPVutf8_nolen> macro instead
937 char* sv_pvutf8(SV *sv)
940 Found in file mathoms.c
945 A private implementation of the C<SvPVutf8> macro for compilers
946 which can't cope with complex macro expressions. Always use the macro
949 char* sv_pvutf8n(SV *sv, STRLEN *len)
952 Found in file mathoms.c
957 Taint an SV. Use C<SvTAINTED_on> instead.
958 void sv_taint(SV* sv)
961 Found in file mathoms.c
966 Unsets the RV status of the SV, and decrements the reference count of
967 whatever was being referenced by the RV. This can almost be thought of
968 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
969 being zero. See C<SvROK_off>.
971 void sv_unref(SV* sv)
974 Found in file mathoms.c
979 A private implementation of the C<SvUVx> macro for compilers which can't
980 cope with complex macro expressions. Always use the macro instead.
985 Found in file mathoms.c
990 =head1 Functions in file pp_pack.c
998 The engine implementing pack() Perl function.
1000 void packlist(SV *cat, const char *pat, const char *patend, SV **beglist, SV **endlist)
1003 Found in file pp_pack.c
1008 The engine implementing pack() Perl function. Note: parameters next_in_list and
1009 flags are not used. This call should not be used; use packlist instead.
1011 void pack_cat(SV *cat, const char *pat, const char *patend, SV **beglist, SV **endlist, SV ***next_in_list, U32 flags)
1014 Found in file pp_pack.c
1019 The engine implementing unpack() Perl function. C<unpackstring> puts the
1020 extracted list items on the stack and returns the number of elements.
1021 Issue C<PUTBACK> before and C<SPAGAIN> after the call to this function.
1023 I32 unpackstring(const char *pat, const char *patend, const char *s, const char *strend, U32 flags)
1026 Found in file pp_pack.c
1031 The engine implementing unpack() Perl function. Note: parameters strbeg, new_s
1032 and ocnt are not used. This call should not be used, use unpackstring instead.
1034 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)
1037 Found in file pp_pack.c
1042 =head1 Global Variables
1049 C<PL_modglobal> is a general purpose, interpreter global HV for use by
1050 extensions that need to keep information on a per-interpreter basis.
1051 In a pinch, it can also be used as a symbol table for extensions
1052 to share data among each other. It is a good idea to use keys
1053 prefixed by the package name of the extension that owns the data.
1058 Found in file intrpvar.h
1063 A convenience variable which is typically used with C<SvPV> when one
1064 doesn't care about the length of the string. It is usually more efficient
1065 to either declare a local variable and use that instead or to use the
1066 C<SvPV_nolen> macro.
1071 Found in file thrdvar.h
1076 This is the C<false> SV. See C<PL_sv_yes>. Always refer to this as
1082 Found in file intrpvar.h
1087 This is the C<undef> SV. Always refer to this as C<&PL_sv_undef>.
1092 Found in file intrpvar.h
1097 This is the C<true> SV. See C<PL_sv_no>. Always refer to this as
1103 Found in file intrpvar.h
1115 Return the SV from the GV.
1125 Returns the glob with the given C<name> and a defined subroutine or
1126 C<NULL>. The glob lives in the given C<stash>, or in the stashes
1127 accessible via @ISA and UNIVERSAL::.
1129 The argument C<level> should be either 0 or -1. If C<level==0>, as a
1130 side-effect creates a glob with the given C<name> in the given C<stash>
1131 which in the case of success contains an alias for the subroutine, and sets
1132 up caching info for this glob. Similarly for all the searched stashes.
1134 This function grants C<"SUPER"> token as a postfix of the stash name. The
1135 GV returned from C<gv_fetchmeth> may be a method cache entry, which is not
1136 visible to Perl code. So when calling C<call_sv>, you should not use
1137 the GV directly; instead, you should use the method's CV, which can be
1138 obtained from the GV with the C<GvCV> macro.
1140 GV* gv_fetchmeth(HV* stash, const char* name, STRLEN len, I32 level)
1145 =item gv_fetchmethod_autoload
1146 X<gv_fetchmethod_autoload>
1148 Returns the glob which contains the subroutine to call to invoke the method
1149 on the C<stash>. In fact in the presence of autoloading this may be the
1150 glob for "AUTOLOAD". In this case the corresponding variable $AUTOLOAD is
1153 The third parameter of C<gv_fetchmethod_autoload> determines whether
1154 AUTOLOAD lookup is performed if the given method is not present: non-zero
1155 means yes, look for AUTOLOAD; zero means no, don't look for AUTOLOAD.
1156 Calling C<gv_fetchmethod> is equivalent to calling C<gv_fetchmethod_autoload>
1157 with a non-zero C<autoload> parameter.
1159 These functions grant C<"SUPER"> token as a prefix of the method name. Note
1160 that if you want to keep the returned glob for a long time, you need to
1161 check for it being "AUTOLOAD", since at the later time the call may load a
1162 different subroutine due to $AUTOLOAD changing its value. Use the glob
1163 created via a side effect to do this.
1165 These functions have the same side-effects and as C<gv_fetchmeth> with
1166 C<level==0>. C<name> should be writable if contains C<':'> or C<'
1167 ''>. The warning against passing the GV returned by C<gv_fetchmeth> to
1168 C<call_sv> apply equally to these functions.
1170 GV* gv_fetchmethod_autoload(HV* stash, const char* name, I32 autoload)
1175 =item gv_fetchmeth_autoload
1176 X<gv_fetchmeth_autoload>
1178 Same as gv_fetchmeth(), but looks for autoloaded subroutines too.
1179 Returns a glob for the subroutine.
1181 For an autoloaded subroutine without a GV, will create a GV even
1182 if C<level < 0>. For an autoloaded subroutine without a stub, GvCV()
1183 of the result may be zero.
1185 GV* gv_fetchmeth_autoload(HV* stash, const char* name, STRLEN len, I32 level)
1193 Returns a pointer to the stash for a specified package. C<name> should
1194 be a valid UTF-8 string and must be null-terminated. If C<create> is set
1195 then the package will be created if it does not already exist. If C<create>
1196 is not set and the package does not exist then NULL is returned.
1198 HV* gv_stashpv(const char* name, I32 create)
1206 Returns a pointer to the stash for a specified package. C<name> should
1207 be a valid UTF-8 string. The C<namelen> parameter indicates the length of
1208 the C<name>, in bytes. If C<create> is set then the package will be
1209 created if it does not already exist. If C<create> is not set and the
1210 package does not exist then NULL is returned.
1212 HV* gv_stashpvn(const char* name, U32 namelen, I32 create)
1220 Returns a pointer to the stash for a specified package, which must be a
1221 valid UTF-8 string. See C<gv_stashpv>.
1223 HV* gv_stashsv(SV* sv, I32 create)
1246 Null character pointer.
1249 Found in file handy.h
1273 Found in file handy.h
1278 =head1 Hash Manipulation Functions
1285 Returns the HV of the specified Perl hash. If C<create> is set and the
1286 Perl variable does not exist then it will be created. If C<create> is not
1287 set and the variable does not exist then NULL is returned.
1289 NOTE: the perl_ form of this function is deprecated.
1291 HV* get_hv(const char* name, I32 create)
1294 Found in file perl.c
1299 This flag, used in the length slot of hash entries and magic structures,
1300 specifies the structure contains an C<SV*> pointer where a C<char*> pointer
1301 is to be expected. (For information only--not to be used).
1309 Returns the computed hash stored in the hash entry.
1319 Returns the actual pointer stored in the key slot of the hash entry. The
1320 pointer may be either C<char*> or C<SV*>, depending on the value of
1321 C<HeKLEN()>. Can be assigned to. The C<HePV()> or C<HeSVKEY()> macros are
1322 usually preferable for finding the value of a key.
1332 If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry
1333 holds an C<SV*> key. Otherwise, holds the actual length of the key. Can
1334 be assigned to. The C<HePV()> macro is usually preferable for finding key
1337 STRLEN HeKLEN(HE* he)
1345 Returns the key slot of the hash entry as a C<char*> value, doing any
1346 necessary dereferencing of possibly C<SV*> keys. The length of the string
1347 is placed in C<len> (this is a macro, so do I<not> use C<&len>). If you do
1348 not care about what the length of the key is, you may use the global
1349 variable C<PL_na>, though this is rather less efficient than using a local
1350 variable. Remember though, that hash keys in perl are free to contain
1351 embedded nulls, so using C<strlen()> or similar is not a good way to find
1352 the length of hash keys. This is very similar to the C<SvPV()> macro
1353 described elsewhere in this document.
1355 char* HePV(HE* he, STRLEN len)
1363 Returns the key as an C<SV*>, or C<Nullsv> if the hash entry does not
1364 contain an C<SV*> key.
1374 Returns the key as an C<SV*>. Will create and return a temporary mortal
1375 C<SV*> if the hash entry contains only a C<char*> key.
1377 SV* HeSVKEY_force(HE* he)
1385 Sets the key to a given C<SV*>, taking care to set the appropriate flags to
1386 indicate the presence of an C<SV*> key, and returns the same
1389 SV* HeSVKEY_set(HE* he, SV* sv)
1397 Returns the value slot (type C<SV*>) stored in the hash entry.
1407 Returns the package name of a stash, or NULL if C<stash> isn't a stash.
1408 See C<SvSTASH>, C<CvSTASH>.
1410 char* HvNAME(HV* stash)
1418 Check that a hash is in an internally consistent state.
1420 void hv_assert(HV* tb)
1428 Clears a hash, making it empty.
1430 void hv_clear(HV* tb)
1435 =item hv_clear_placeholders
1436 X<hv_clear_placeholders>
1438 Clears any placeholders from a hash. If a restricted hash has any of its keys
1439 marked as readonly and the key is subsequently deleted, the key is not actually
1440 deleted but is marked by assigning it a value of &PL_sv_placeholder. This tags
1441 it so it will be ignored by future operations such as iterating over the hash,
1442 but will still allow the hash to have a value reassigned to the key at some
1443 future point. This function clears any such placeholder keys from the hash.
1444 See Hash::Util::lock_keys() for an example of its use.
1446 void hv_clear_placeholders(HV* hb)
1454 Deletes a key/value pair in the hash. The value SV is removed from the
1455 hash and returned to the caller. The C<klen> is the length of the key.
1456 The C<flags> value will normally be zero; if set to G_DISCARD then NULL
1459 SV* hv_delete(HV* tb, const char* key, I32 klen, I32 flags)
1467 Deletes a key/value pair in the hash. The value SV is removed from the
1468 hash and returned to the caller. The C<flags> value will normally be zero;
1469 if set to G_DISCARD then NULL will be returned. C<hash> can be a valid
1470 precomputed hash value, or 0 to ask for it to be computed.
1472 SV* hv_delete_ent(HV* tb, SV* key, I32 flags, U32 hash)
1480 Returns a boolean indicating whether the specified hash key exists. The
1481 C<klen> is the length of the key.
1483 bool hv_exists(HV* tb, const char* key, I32 klen)
1491 Returns a boolean indicating whether the specified hash key exists. C<hash>
1492 can be a valid precomputed hash value, or 0 to ask for it to be
1495 bool hv_exists_ent(HV* tb, SV* key, U32 hash)
1503 Returns the SV which corresponds to the specified key in the hash. The
1504 C<klen> is the length of the key. If C<lval> is set then the fetch will be
1505 part of a store. Check that the return value is non-null before
1506 dereferencing it to an C<SV*>.
1508 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1509 information on how to use this function on tied hashes.
1511 SV** hv_fetch(HV* tb, const char* key, I32 klen, I32 lval)
1519 Returns the hash entry which corresponds to the specified key in the hash.
1520 C<hash> must be a valid precomputed hash number for the given C<key>, or 0
1521 if you want the function to compute it. IF C<lval> is set then the fetch
1522 will be part of a store. Make sure the return value is non-null before
1523 accessing it. The return value when C<tb> is a tied hash is a pointer to a
1524 static location, so be sure to make a copy of the structure if you need to
1527 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1528 information on how to use this function on tied hashes.
1530 HE* hv_fetch_ent(HV* tb, SV* key, I32 lval, U32 hash)
1538 Prepares a starting point to traverse a hash table. Returns the number of
1539 keys in the hash (i.e. the same as C<HvKEYS(tb)>). The return value is
1540 currently only meaningful for hashes without tie magic.
1542 NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
1543 hash buckets that happen to be in use. If you still need that esoteric
1544 value, you can get it through the macro C<HvFILL(tb)>.
1547 I32 hv_iterinit(HV* tb)
1555 Returns the key from the current position of the hash iterator. See
1558 char* hv_iterkey(HE* entry, I32* retlen)
1566 Returns the key as an C<SV*> from the current position of the hash
1567 iterator. The return value will always be a mortal copy of the key. Also
1570 SV* hv_iterkeysv(HE* entry)
1578 Returns entries from a hash iterator. See C<hv_iterinit>.
1580 You may call C<hv_delete> or C<hv_delete_ent> on the hash entry that the
1581 iterator currently points to, without losing your place or invalidating your
1582 iterator. Note that in this case the current entry is deleted from the hash
1583 with your iterator holding the last reference to it. Your iterator is flagged
1584 to free the entry on the next call to C<hv_iternext>, so you must not discard
1585 your iterator immediately else the entry will leak - call C<hv_iternext> to
1586 trigger the resource deallocation.
1588 HE* hv_iternext(HV* tb)
1596 Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
1599 SV* hv_iternextsv(HV* hv, char** key, I32* retlen)
1604 =item hv_iternext_flags
1605 X<hv_iternext_flags>
1607 Returns entries from a hash iterator. See C<hv_iterinit> and C<hv_iternext>.
1608 The C<flags> value will normally be zero; if HV_ITERNEXT_WANTPLACEHOLDERS is
1609 set the placeholders keys (for restricted hashes) will be returned in addition
1610 to normal keys. By default placeholders are automatically skipped over.
1611 Currently a placeholder is implemented with a value that is
1612 C<&Perl_sv_placeholder>. Note that the implementation of placeholders and
1613 restricted hashes may change, and the implementation currently is
1614 insufficiently abstracted for any change to be tidy.
1616 NOTE: this function is experimental and may change or be
1617 removed without notice.
1619 HE* hv_iternext_flags(HV* tb, I32 flags)
1627 Returns the value from the current position of the hash iterator. See
1630 SV* hv_iterval(HV* tb, HE* entry)
1638 Adds magic to a hash. See C<sv_magic>.
1640 void hv_magic(HV* hv, GV* gv, int how)
1648 Evaluates the hash in scalar context and returns the result. Handles magic when the hash is tied.
1650 SV* hv_scalar(HV* hv)
1658 Stores an SV in a hash. The hash key is specified as C<key> and C<klen> is
1659 the length of the key. The C<hash> parameter is the precomputed hash
1660 value; if it is zero then Perl will compute it. The return value will be
1661 NULL if the operation failed or if the value did not need to be actually
1662 stored within the hash (as in the case of tied hashes). Otherwise it can
1663 be dereferenced to get the original C<SV*>. Note that the caller is
1664 responsible for suitably incrementing the reference count of C<val> before
1665 the call, and decrementing it if the function returned NULL. Effectively
1666 a successful hv_store takes ownership of one reference to C<val>. This is
1667 usually what you want; a newly created SV has a reference count of one, so
1668 if all your code does is create SVs then store them in a hash, hv_store
1669 will own the only reference to the new SV, and your code doesn't need to do
1670 anything further to tidy up. hv_store is not implemented as a call to
1671 hv_store_ent, and does not create a temporary SV for the key, so if your
1672 key data is not already in SV form then use hv_store in preference to
1675 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1676 information on how to use this function on tied hashes.
1678 SV** hv_store(HV* tb, const char* key, I32 klen, SV* val, U32 hash)
1686 Stores C<val> in a hash. The hash key is specified as C<key>. The C<hash>
1687 parameter is the precomputed hash value; if it is zero then Perl will
1688 compute it. The return value is the new hash entry so created. It will be
1689 NULL if the operation failed or if the value did not need to be actually
1690 stored within the hash (as in the case of tied hashes). Otherwise the
1691 contents of the return value can be accessed using the C<He?> macros
1692 described here. Note that the caller is responsible for suitably
1693 incrementing the reference count of C<val> before the call, and
1694 decrementing it if the function returned NULL. Effectively a successful
1695 hv_store_ent takes ownership of one reference to C<val>. This is
1696 usually what you want; a newly created SV has a reference count of one, so
1697 if all your code does is create SVs then store them in a hash, hv_store
1698 will own the only reference to the new SV, and your code doesn't need to do
1699 anything further to tidy up. Note that hv_store_ent only reads the C<key>;
1700 unlike C<val> it does not take ownership of it, so maintaining the correct
1701 reference count on C<key> is entirely the caller's responsibility. hv_store
1702 is not implemented as a call to hv_store_ent, and does not create a temporary
1703 SV for the key, so if your key data is not already in SV form then use
1704 hv_store in preference to hv_store_ent.
1706 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1707 information on how to use this function on tied hashes.
1709 HE* hv_store_ent(HV* tb, SV* key, SV* val, U32 hash)
1719 void hv_undef(HV* tb)
1727 Creates a new HV. The reference count is set to 1.
1737 =head1 Magical Functions
1744 Clear something magical that the SV represents. See C<sv_magic>.
1746 int mg_clear(SV* sv)
1754 Copies the magic from one SV to another. See C<sv_magic>.
1756 int mg_copy(SV* sv, SV* nsv, const char* key, I32 klen)
1764 Finds the magic pointer for type matching the SV. See C<sv_magic>.
1766 MAGIC* mg_find(const SV* sv, int type)
1774 Free any magic storage used by the SV. See C<sv_magic>.
1784 Do magic after a value is retrieved from the SV. See C<sv_magic>.
1794 Report on the SV's length. See C<sv_magic>.
1796 U32 mg_length(SV* sv)
1804 Turns on the magical status of an SV. See C<sv_magic>.
1806 void mg_magical(SV* sv)
1814 Do magic after a value is assigned to the SV. See C<sv_magic>.
1824 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
1825 argument more than once.
1827 void SvGETMAGIC(SV* sv)
1835 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
1846 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
1847 argument more than once.
1849 void SvSETMAGIC(SV* sv)
1857 Like C<SvSetSV>, but does any set magic required afterwards.
1859 void SvSetMagicSV(SV* dsb, SV* ssv)
1864 =item SvSetMagicSV_nosteal
1865 X<SvSetMagicSV_nosteal>
1867 Like C<SvSetSV_nosteal>, but does any set magic required afterwards.
1869 void SvSetMagicSV_nosteal(SV* dsv, SV* ssv)
1877 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
1880 void SvSetSV(SV* dsb, SV* ssv)
1885 =item SvSetSV_nosteal
1888 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
1889 ssv. May evaluate arguments more than once.
1891 void SvSetSV_nosteal(SV* dsv, SV* ssv)
1899 Arranges for sv to be shared between threads if a suitable module
1902 void SvSHARE(SV* sv)
1910 Releases a mutual exclusion lock on sv if a suitable module
1913 void SvUNLOCK(SV* sv)
1921 =head1 Memory Management
1928 The XSUB-writer's interface to the C C<memcpy> function. The C<src> is the
1929 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1930 the type. May fail on overlapping copies. See also C<Move>.
1932 void Copy(void* src, void* dest, int nitems, type)
1935 Found in file handy.h
1940 Like C<Copy> but returns dest. Useful for encouraging compilers to tail-call
1943 void * CopyD(void* src, void* dest, int nitems, type)
1946 Found in file handy.h
1951 The XSUB-writer's interface to the C C<memmove> function. The C<src> is the
1952 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1953 the type. Can do overlapping moves. See also C<Copy>.
1955 void Move(void* src, void* dest, int nitems, type)
1958 Found in file handy.h
1963 Like C<Move> but returns dest. Useful for encouraging compilers to tail-call
1966 void * MoveD(void* src, void* dest, int nitems, type)
1969 Found in file handy.h
1974 The XSUB-writer's interface to the C C<malloc> function.
1976 In 5.9.3, Newx() and friends replace the older New() API, and drops
1977 the first parameter, I<x>, a debug aid which allowed callers to identify
1978 themselves. This aid has been superceded by a new build option,
1979 PERL_MEM_LOG (see L<perlhack/PERL_MEM_LOG>). The older API is still
1980 there for use in XS modules supporting older perls.
1982 void Newx(void* ptr, int nitems, type)
1985 Found in file handy.h
1990 The XSUB-writer's interface to the C C<malloc> function, with
1991 cast. See also C<Newx>.
1993 void Newxc(void* ptr, int nitems, type, cast)
1996 Found in file handy.h
2001 The XSUB-writer's interface to the C C<malloc> function. The allocated
2002 memory is zeroed with C<memzero>. See also C<Newx>.
2004 void Newxz(void* ptr, int nitems, type)
2007 Found in file handy.h
2012 Fill up memory with a pattern (byte 0xAB over and over again) that
2013 hopefully catches attempts to access uninitialized memory.
2015 void Poison(void* dest, int nitems, type)
2018 Found in file handy.h
2023 The XSUB-writer's interface to the C C<realloc> function.
2025 void Renew(void* ptr, int nitems, type)
2028 Found in file handy.h
2033 The XSUB-writer's interface to the C C<realloc> function, with
2036 void Renewc(void* ptr, int nitems, type, cast)
2039 Found in file handy.h
2044 The XSUB-writer's interface to the C C<free> function.
2046 void Safefree(void* ptr)
2049 Found in file handy.h
2054 Perl's version of C<strdup()>. Returns a pointer to a newly allocated
2055 string which is a duplicate of C<pv>. The size of the string is
2056 determined by C<strlen()>. The memory allocated for the new string can
2057 be freed with the C<Safefree()> function.
2059 char* savepv(const char* pv)
2062 Found in file util.c
2067 Perl's version of what C<strndup()> would be if it existed. Returns a
2068 pointer to a newly allocated string which is a duplicate of the first
2069 C<len> bytes from C<pv>. The memory allocated for the new string can be
2070 freed with the C<Safefree()> function.
2072 char* savepvn(const char* pv, I32 len)
2075 Found in file util.c
2080 A version of C<savepv()> which allocates the duplicate string in memory
2081 which is shared between threads.
2083 char* savesharedpv(const char* pv)
2086 Found in file util.c
2091 A version of C<savepv()>/C<savepvn()> which gets the string to duplicate from
2092 the passed in SV using C<SvPV()>
2094 char* savesvpv(SV* sv)
2097 Found in file util.c
2102 This is an architecture-independent macro to copy one structure to another.
2104 void StructCopy(type src, type dest, type)
2107 Found in file handy.h
2112 The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the
2113 destination, C<nitems> is the number of items, and C<type> is the type.
2115 void Zero(void* dest, int nitems, type)
2118 Found in file handy.h
2123 Like C<Zero> but returns dest. Useful for encouraging compilers to tail-call
2126 void * ZeroD(void* dest, int nitems, type)
2129 Found in file handy.h
2134 =head1 Miscellaneous Functions
2141 Analyses the string in order to make fast searches on it using fbm_instr()
2142 -- the Boyer-Moore algorithm.
2144 void fbm_compile(SV* sv, U32 flags)
2147 Found in file util.c
2152 Returns the location of the SV in the string delimited by C<str> and
2153 C<strend>. It returns C<Nullch> if the string can't be found. The C<sv>
2154 does not have to be fbm_compiled, but the search will not be as fast
2157 char* fbm_instr(unsigned char* big, unsigned char* bigend, SV* littlesv, U32 flags)
2160 Found in file util.c
2165 Takes a sprintf-style format pattern and conventional
2166 (non-SV) arguments and returns the formatted string.
2168 (char *) Perl_form(pTHX_ const char* pat, ...)
2170 can be used any place a string (char *) is required:
2172 char * s = Perl_form("%d.%d",major,minor);
2174 Uses a single private buffer so if you want to format several strings you
2175 must explicitly copy the earlier strings away (and free the copies when you
2178 char* form(const char* pat, ...)
2181 Found in file util.c
2186 Fill the sv with current working directory
2188 int getcwd_sv(SV* sv)
2191 Found in file util.c
2196 The C library C<sprintf>, wrapped if necessary, to ensure that it will return
2197 the length of the string written to the buffer. Only rare pre-ANSI systems
2198 need the wrapper function - usually this is a direct call to C<sprintf>.
2200 int my_sprintf(char *buffer, const char *pat, ...)
2203 Found in file util.c
2208 Returns a new version object based on the passed in SV:
2210 SV *sv = new_version(SV *ver);
2212 Does not alter the passed in ver SV. See "upg_version" if you
2213 want to upgrade the SV.
2215 SV* new_version(SV *ver)
2218 Found in file util.c
2223 Returns a pointer to the next character after the parsed
2224 version string, as well as upgrading the passed in SV to
2227 Function must be called with an already existing SV like
2230 s = scan_version(s,SV *sv, bool qv);
2232 Performs some preprocessing to the string to ensure that
2233 it has the correct characteristics of a version. Flags the
2234 object if it contains an underscore (which denotes this
2235 is a alpha version). The boolean qv denotes that the version
2236 should be interpreted as if it had multiple decimals, even if
2239 const char* scan_version(const char *vstr, SV *sv, bool qv)
2242 Found in file util.c
2247 Test two strings to see if they are equal. Returns true or false.
2249 bool strEQ(char* s1, char* s2)
2252 Found in file handy.h
2257 Test two strings to see if the first, C<s1>, is greater than or equal to
2258 the second, C<s2>. Returns true or false.
2260 bool strGE(char* s1, char* s2)
2263 Found in file handy.h
2268 Test two strings to see if the first, C<s1>, is greater than the second,
2269 C<s2>. Returns true or false.
2271 bool strGT(char* s1, char* s2)
2274 Found in file handy.h
2279 Test two strings to see if the first, C<s1>, is less than or equal to the
2280 second, C<s2>. Returns true or false.
2282 bool strLE(char* s1, char* s2)
2285 Found in file handy.h
2290 Test two strings to see if the first, C<s1>, is less than the second,
2291 C<s2>. Returns true or false.
2293 bool strLT(char* s1, char* s2)
2296 Found in file handy.h
2301 Test two strings to see if they are different. Returns true or
2304 bool strNE(char* s1, char* s2)
2307 Found in file handy.h
2312 Test two strings to see if they are equal. The C<len> parameter indicates
2313 the number of bytes to compare. Returns true or false. (A wrapper for
2316 bool strnEQ(char* s1, char* s2, STRLEN len)
2319 Found in file handy.h
2324 Test two strings to see if they are different. The C<len> parameter
2325 indicates the number of bytes to compare. Returns true or false. (A
2326 wrapper for C<strncmp>).
2328 bool strnNE(char* s1, char* s2, STRLEN len)
2331 Found in file handy.h
2336 Dummy routine which "shares" an SV when there is no sharing module present.
2337 Or "locks" it. Or "unlocks" it. In other words, ignores its single SV argument.
2338 Exists to avoid test for a NULL function pointer and because it could
2339 potentially warn under some level of strict-ness.
2341 void sv_nosharing(SV *sv)
2344 Found in file util.c
2349 In-place upgrade of the supplied SV to a version object.
2351 SV *sv = upg_version(SV *sv);
2353 Returns a pointer to the upgraded SV.
2355 SV* upg_version(SV *ver)
2358 Found in file util.c
2363 Version object aware cmp. Both operands must already have been
2364 converted into version objects.
2366 int vcmp(SV *lvs, SV *rvs)
2369 Found in file util.c
2374 Accepts a version object and returns the normalized string
2375 representation. Call like:
2379 NOTE: you can pass either the object directly or the SV
2380 contained within the RV.
2385 Found in file util.c
2390 Accepts a version object and returns the normalized floating
2391 point representation. Call like:
2395 NOTE: you can pass either the object directly or the SV
2396 contained within the RV.
2401 Found in file util.c
2406 In order to maintain maximum compatibility with earlier versions
2407 of Perl, this function will return either the floating point
2408 notation or the multiple dotted notation, depending on whether
2409 the original version contained 1 or more dots, respectively
2411 SV* vstringify(SV *vs)
2414 Found in file util.c
2419 Validates that the SV contains a valid version object.
2421 bool vverify(SV *vobj);
2423 Note that it only confirms the bare minimum structure (so as not to get
2424 confused by derived classes which may contain additional hash entries):
2426 bool vverify(SV *vs)
2429 Found in file util.c
2434 =head1 Multicall Functions
2441 Declare local variables for a multicall. See L<perlcall/Lightweight Callbacks>.
2451 Make a lightweight callback. See L<perlcall/Lightweight Callbacks>.
2461 Closing bracket for a lightweight callback.
2462 See L<perlcall/Lightweight Callbacks>.
2469 =item PUSH_MULTICALL
2472 Opening bracket for a lightweight callback.
2473 See L<perlcall/Lightweight Callbacks>.
2483 =head1 Numeric functions
2490 converts a string representing a binary number to numeric form.
2492 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2493 conversion flags, and I<result> should be NULL or a pointer to an NV.
2494 The scan stops at the end of the string, or the first invalid character.
2495 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2496 invalid character will also trigger a warning.
2497 On return I<*len> is set to the length of the scanned string,
2498 and I<*flags> gives output flags.
2500 If the value is <= C<UV_MAX> it is returned as a UV, the output flags are clear,
2501 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_bin>
2502 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2503 and writes the value to I<*result> (or the value is discarded if I<result>
2506 The binary number may optionally be prefixed with "0b" or "b" unless
2507 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
2508 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the binary
2509 number may use '_' characters to separate digits.
2511 UV grok_bin(const char* start, STRLEN* len_p, I32* flags, NV *result)
2514 Found in file numeric.c
2519 converts a string representing a hex number to numeric form.
2521 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2522 conversion flags, and I<result> should be NULL or a pointer to an NV.
2523 The scan stops at the end of the string, or the first invalid character.
2524 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2525 invalid character will also trigger a warning.
2526 On return I<*len> is set to the length of the scanned string,
2527 and I<*flags> gives output flags.
2529 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2530 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_hex>
2531 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2532 and writes the value to I<*result> (or the value is discarded if I<result>
2535 The hex number may optionally be prefixed with "0x" or "x" unless
2536 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
2537 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the hex
2538 number may use '_' characters to separate digits.
2540 UV grok_hex(const char* start, STRLEN* len_p, I32* flags, NV *result)
2543 Found in file numeric.c
2548 Recognise (or not) a number. The type of the number is returned
2549 (0 if unrecognised), otherwise it is a bit-ORed combination of
2550 IS_NUMBER_IN_UV, IS_NUMBER_GREATER_THAN_UV_MAX, IS_NUMBER_NOT_INT,
2551 IS_NUMBER_NEG, IS_NUMBER_INFINITY, IS_NUMBER_NAN (defined in perl.h).
2553 If the value of the number can fit an in UV, it is returned in the *valuep
2554 IS_NUMBER_IN_UV will be set to indicate that *valuep is valid, IS_NUMBER_IN_UV
2555 will never be set unless *valuep is valid, but *valuep may have been assigned
2556 to during processing even though IS_NUMBER_IN_UV is not set on return.
2557 If valuep is NULL, IS_NUMBER_IN_UV will be set for the same cases as when
2558 valuep is non-NULL, but no actual assignment (or SEGV) will occur.
2560 IS_NUMBER_NOT_INT will be set with IS_NUMBER_IN_UV if trailing decimals were
2561 seen (in which case *valuep gives the true value truncated to an integer), and
2562 IS_NUMBER_NEG if the number is negative (in which case *valuep holds the
2563 absolute value). IS_NUMBER_IN_UV is not set if e notation was used or the
2564 number is larger than a UV.
2566 int grok_number(const char *pv, STRLEN len, UV *valuep)
2569 Found in file numeric.c
2571 =item grok_numeric_radix
2572 X<grok_numeric_radix>
2574 Scan and skip for a numeric decimal separator (radix).
2576 bool grok_numeric_radix(const char **sp, const char *send)
2579 Found in file numeric.c
2584 converts a string representing an octal number to numeric form.
2586 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2587 conversion flags, and I<result> should be NULL or a pointer to an NV.
2588 The scan stops at the end of the string, or the first invalid character.
2589 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2590 invalid character will also trigger a warning.
2591 On return I<*len> is set to the length of the scanned string,
2592 and I<*flags> gives output flags.
2594 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2595 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_oct>
2596 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2597 and writes the value to I<*result> (or the value is discarded if I<result>
2600 If C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the octal
2601 number may use '_' characters to separate digits.
2603 UV grok_oct(const char* start, STRLEN* len_p, I32* flags, NV *result)
2606 Found in file numeric.c
2611 For backwards compatibility. Use C<grok_bin> instead.
2613 NV scan_bin(const char* start, STRLEN len, STRLEN* retlen)
2616 Found in file numeric.c
2621 For backwards compatibility. Use C<grok_hex> instead.
2623 NV scan_hex(const char* start, STRLEN len, STRLEN* retlen)
2626 Found in file numeric.c
2631 For backwards compatibility. Use C<grok_oct> instead.
2633 NV scan_oct(const char* start, STRLEN len, STRLEN* retlen)
2636 Found in file numeric.c
2641 =head1 Optree Manipulation Functions
2648 If C<cv> is a constant sub eligible for inlining. returns the constant
2649 value returned by the sub. Otherwise, returns NULL.
2651 Constant subs can be created with C<newCONSTSUB> or as described in
2652 L<perlsub/"Constant Functions">.
2654 SV* cv_const_sv(CV* cv)
2662 Creates a constant sub equivalent to Perl C<sub FOO () { 123 }> which is
2663 eligible for inlining at compile-time.
2665 CV* newCONSTSUB(HV* stash, const char* name, SV* sv)
2673 Used by C<xsubpp> to hook up XSUBs as Perl subs.
2681 =head1 Pad Data Structures
2688 Get the value at offset po in the current pad.
2689 Use macro PAD_SV instead of calling this function directly.
2691 SV* pad_sv(PADOFFSET po)
2699 =head1 Simple Exception Handling Macros
2706 Set up necessary local variables for exception handling.
2707 See L<perlguts/"Exception Handling">.
2712 Found in file XSUB.h
2717 Introduces a catch block. See L<perlguts/"Exception Handling">.
2720 Found in file XSUB.h
2725 Rethrows a previously caught exception. See L<perlguts/"Exception Handling">.
2730 Found in file XSUB.h
2735 Ends a try block. See L<perlguts/"Exception Handling">.
2738 Found in file XSUB.h
2740 =item XCPT_TRY_START
2743 Starts a try block. See L<perlguts/"Exception Handling">.
2746 Found in file XSUB.h
2751 =head1 Stack Manipulation Macros
2758 Declare a stack marker variable, C<mark>, for the XSUB. See C<MARK> and
2769 Saves the original stack mark for the XSUB. See C<ORIGMARK>.
2779 Declares a local copy of perl's stack pointer for the XSUB, available via
2780 the C<SP> macro. See C<SP>.
2790 Used to extend the argument stack for an XSUB's return values. Once
2791 used, guarantees that there is room for at least C<nitems> to be pushed
2794 void EXTEND(SP, int nitems)
2802 Stack marker variable for the XSUB. See C<dMARK>.
2810 Push an integer onto the stack. The stack must have room for this element.
2811 Handles 'set' magic. Does not use C<TARG>. See also C<PUSHi>, C<mXPUSHi>
2822 Push a double onto the stack. The stack must have room for this element.
2823 Handles 'set' magic. Does not use C<TARG>. See also C<PUSHn>, C<mXPUSHn>
2834 Push a string onto the stack. The stack must have room for this element.
2835 The C<len> indicates the length of the string. Handles 'set' magic. Does
2836 not use C<TARG>. See also C<PUSHp>, C<mXPUSHp> and C<XPUSHp>.
2838 void mPUSHp(char* str, STRLEN len)
2846 Push an unsigned integer onto the stack. The stack must have room for this
2847 element. Handles 'set' magic. Does not use C<TARG>. See also C<PUSHu>,
2848 C<mXPUSHu> and C<XPUSHu>.
2858 Push an integer onto the stack, extending the stack if necessary. Handles
2859 'set' magic. Does not use C<TARG>. See also C<XPUSHi>, C<mPUSHi> and
2870 Push a double onto the stack, extending the stack if necessary. Handles
2871 'set' magic. Does not use C<TARG>. See also C<XPUSHn>, C<mPUSHn> and
2882 Push a string onto the stack, extending the stack if necessary. The C<len>
2883 indicates the length of the string. Handles 'set' magic. Does not use
2884 C<TARG>. See also C<XPUSHp>, C<mPUSHp> and C<PUSHp>.
2886 void mXPUSHp(char* str, STRLEN len)
2894 Push an unsigned integer onto the stack, extending the stack if necessary.
2895 Handles 'set' magic. Does not use C<TARG>. See also C<XPUSHu>, C<mPUSHu>
2906 The original stack mark for the XSUB. See C<dORIGMARK>.
2914 Pops an integer off the stack.
2924 Pops a long off the stack.
2934 Pops a double off the stack.
2944 Pops a string off the stack. Deprecated. New code should use POPpx.
2954 Pops a string off the stack which must consist of bytes i.e. characters < 256.
2964 Pops a string off the stack.
2974 Pops an SV off the stack.
2984 Push an integer onto the stack. The stack must have room for this element.
2985 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
2986 called to declare it. Do not call multiple C<TARG>-oriented macros to
2987 return lists from XSUB's - see C<mPUSHi> instead. See also C<XPUSHi> and
2998 Opening bracket for arguments on a callback. See C<PUTBACK> and
3009 Push a new mortal SV onto the stack. The stack must have room for this
3010 element. Does not handle 'set' magic. Does not use C<TARG>. See also
3011 C<PUSHs>, C<XPUSHmortal> and C<XPUSHs>.
3021 Push a double onto the stack. The stack must have room for this element.
3022 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3023 called to declare it. Do not call multiple C<TARG>-oriented macros to
3024 return lists from XSUB's - see C<mPUSHn> instead. See also C<XPUSHn> and
3035 Push a string onto the stack. The stack must have room for this element.
3036 The C<len> indicates the length of the string. Handles 'set' magic. Uses
3037 C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to declare it. Do not
3038 call multiple C<TARG>-oriented macros to return lists from XSUB's - see
3039 C<mPUSHp> instead. See also C<XPUSHp> and C<mXPUSHp>.
3041 void PUSHp(char* str, STRLEN len)
3049 Push an SV onto the stack. The stack must have room for this element.
3050 Does not handle 'set' magic. Does not use C<TARG>. See also C<PUSHmortal>,
3051 C<XPUSHs> and C<XPUSHmortal>.
3061 Push an unsigned integer onto the stack. The stack must have room for this
3062 element. Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG>
3063 should be called to declare it. Do not call multiple C<TARG>-oriented
3064 macros to return lists from XSUB's - see C<mPUSHu> instead. See also
3065 C<XPUSHu> and C<mXPUSHu>.
3075 Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
3076 See C<PUSHMARK> and L<perlcall> for other uses.
3086 Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and
3095 Refetch the stack pointer. Used after a callback. See L<perlcall>.
3105 Push an integer onto the stack, extending the stack if necessary. Handles
3106 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
3107 declare it. Do not call multiple C<TARG>-oriented macros to return lists
3108 from XSUB's - see C<mXPUSHi> instead. See also C<PUSHi> and C<mPUSHi>.
3118 Push a new mortal SV onto the stack, extending the stack if necessary. Does
3119 not handle 'set' magic. Does not use C<TARG>. See also C<XPUSHs>,
3120 C<PUSHmortal> and C<PUSHs>.
3130 Push a double onto the stack, extending the stack if necessary. Handles
3131 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
3132 declare it. Do not call multiple C<TARG>-oriented macros to return lists
3133 from XSUB's - see C<mXPUSHn> instead. See also C<PUSHn> and C<mPUSHn>.
3143 Push a string onto the stack, extending the stack if necessary. The C<len>
3144 indicates the length of the string. Handles 'set' magic. Uses C<TARG>, so
3145 C<dTARGET> or C<dXSTARG> should be called to declare it. Do not call
3146 multiple C<TARG>-oriented macros to return lists from XSUB's - see
3147 C<mXPUSHp> instead. See also C<PUSHp> and C<mPUSHp>.
3149 void XPUSHp(char* str, STRLEN len)
3157 Push an SV onto the stack, extending the stack if necessary. Does not
3158 handle 'set' magic. Does not use C<TARG>. See also C<XPUSHmortal>,
3159 C<PUSHs> and C<PUSHmortal>.
3169 Push an unsigned integer onto the stack, extending the stack if necessary.
3170 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3171 called to declare it. Do not call multiple C<TARG>-oriented macros to
3172 return lists from XSUB's - see C<mXPUSHu> instead. See also C<PUSHu> and
3183 Return from XSUB, indicating number of items on the stack. This is usually
3184 handled by C<xsubpp>.
3186 void XSRETURN(int nitems)
3189 Found in file XSUB.h
3191 =item XSRETURN_EMPTY
3194 Return an empty list from an XSUB immediately.
3199 Found in file XSUB.h
3204 Return an integer from an XSUB immediately. Uses C<XST_mIV>.
3206 void XSRETURN_IV(IV iv)
3209 Found in file XSUB.h
3214 Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
3219 Found in file XSUB.h
3224 Return a double from an XSUB immediately. Uses C<XST_mNV>.
3226 void XSRETURN_NV(NV nv)
3229 Found in file XSUB.h
3234 Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
3236 void XSRETURN_PV(char* str)
3239 Found in file XSUB.h
3241 =item XSRETURN_UNDEF
3244 Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
3249 Found in file XSUB.h
3254 Return an integer from an XSUB immediately. Uses C<XST_mUV>.
3256 void XSRETURN_UV(IV uv)
3259 Found in file XSUB.h
3264 Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
3269 Found in file XSUB.h
3274 Place an integer into the specified position C<pos> on the stack. The
3275 value is stored in a new mortal SV.
3277 void XST_mIV(int pos, IV iv)
3280 Found in file XSUB.h
3285 Place C<&PL_sv_no> into the specified position C<pos> on the
3288 void XST_mNO(int pos)
3291 Found in file XSUB.h
3296 Place a double into the specified position C<pos> on the stack. The value
3297 is stored in a new mortal SV.
3299 void XST_mNV(int pos, NV nv)
3302 Found in file XSUB.h
3307 Place a copy of a string into the specified position C<pos> on the stack.
3308 The value is stored in a new mortal SV.
3310 void XST_mPV(int pos, char* str)
3313 Found in file XSUB.h
3318 Place C<&PL_sv_undef> into the specified position C<pos> on the
3321 void XST_mUNDEF(int pos)
3324 Found in file XSUB.h
3329 Place C<&PL_sv_yes> into the specified position C<pos> on the
3332 void XST_mYES(int pos)
3335 Found in file XSUB.h
3347 An enum of flags for Perl types. These are found in the file B<sv.h>
3348 in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
3356 Integer type flag for scalars. See C<svtype>.
3364 Double type flag for scalars. See C<svtype>.
3372 Pointer type flag for scalars. See C<svtype>.
3380 Type flag for arrays. See C<svtype>.
3388 Type flag for code refs. See C<svtype>.
3396 Type flag for hashes. See C<svtype>.
3404 Type flag for blessed scalars. See C<svtype>.
3412 =head1 SV Manipulation Functions
3419 Returns the SV of the specified Perl scalar. If C<create> is set and the
3420 Perl variable does not exist then it will be created. If C<create> is not
3421 set and the variable does not exist then NULL is returned.
3423 NOTE: the perl_ form of this function is deprecated.
3425 SV* get_sv(const char* name, I32 create)
3428 Found in file perl.c
3430 =item looks_like_number
3431 X<looks_like_number>
3433 Test if the content of an SV looks like a number (or is a number).
3434 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
3435 non-numeric warning), even if your atof() doesn't grok them.
3437 I32 looks_like_number(SV* sv)
3445 Creates an RV wrapper for an SV. The reference count for the original SV is
3448 SV* newRV_inc(SV* sv)
3456 Creates an RV wrapper for an SV. The reference count for the original
3457 SV is B<not> incremented.
3459 SV* newRV_noinc(SV *sv)
3467 Creates a new SV. A non-zero C<len> parameter indicates the number of
3468 bytes of preallocated string space the SV should have. An extra byte for a
3469 tailing NUL is also reserved. (SvPOK is not set for the SV even if string
3470 space is allocated.) The reference count for the new SV is set to 1.
3471 C<id> is an integer id between 0 and 1299 (used to identify leaks).
3473 SV* NEWSV(int id, STRLEN len)
3476 Found in file handy.h
3481 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
3482 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
3485 SV* newSV(STRLEN len)
3493 Creates a new SV from the hash key structure. It will generate scalars that
3494 point to the shared string table where possible. Returns a new (undefined)
3495 SV if the hek is NULL.
3497 SV* newSVhek(const HEK *hek)
3505 Creates a new SV and copies an integer into it. The reference count for the
3516 Creates a new SV and copies a floating point value into it.
3517 The reference count for the SV is set to 1.
3527 Creates a new SV and copies a string into it. The reference count for the
3528 SV is set to 1. If C<len> is zero, Perl will compute the length using
3529 strlen(). For efficiency, consider using C<newSVpvn> instead.
3531 SV* newSVpv(const char* s, STRLEN len)
3539 Creates a new SV and initializes it with the string formatted like
3542 SV* newSVpvf(const char* pat, ...)
3550 Creates a new SV and copies a string into it. The reference count for the
3551 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
3552 string. You are responsible for ensuring that the source string is at least
3553 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
3555 SV* newSVpvn(const char* s, STRLEN len)
3560 =item newSVpvn_share
3563 Creates a new SV with its SvPVX_const pointing to a shared string in the string
3564 table. If the string does not already exist in the table, it is created
3565 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
3566 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
3567 otherwise the hash is computed. The idea here is that as the string table
3568 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
3569 hash lookup will avoid string compare.
3571 SV* newSVpvn_share(const char* s, I32 len, U32 hash)
3579 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
3580 it will be upgraded to one. If C<classname> is non-null then the new SV will
3581 be blessed in the specified package. The new SV is returned and its
3582 reference count is 1.
3584 SV* newSVrv(SV* rv, const char* classname)
3592 Creates a new SV which is an exact duplicate of the original SV.
3595 SV* newSVsv(SV* old)
3603 Creates a new SV and copies an unsigned integer into it.
3604 The reference count for the SV is set to 1.
3614 Returns the length of the string which is in the SV. See C<SvLEN>.
3616 STRLEN SvCUR(SV* sv)
3624 Set the current length of the string which is in the SV. See C<SvCUR>
3627 void SvCUR_set(SV* sv, STRLEN len)
3635 Returns a pointer to the last character in the string which is in the SV.
3636 See C<SvCUR>. Access the character as *(SvEND(sv)).
3646 Expands the character buffer in the SV so that it has room for the
3647 indicated number of bytes (remember to reserve space for an extra trailing
3648 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
3649 Returns a pointer to the character buffer.
3651 char * SvGROW(SV* sv, STRLEN len)
3659 Returns a boolean indicating whether the SV contains an integer.
3669 Returns a boolean indicating whether the SV contains an integer. Checks
3670 the B<private> setting. Use C<SvIOK>.
3680 Returns a boolean indicating whether the SV contains a signed integer.
3682 bool SvIOK_notUV(SV* sv)
3690 Unsets the IV status of an SV.
3692 void SvIOK_off(SV* sv)
3700 Tells an SV that it is an integer.
3702 void SvIOK_on(SV* sv)
3710 Tells an SV that it is an integer and disables all other OK bits.
3712 void SvIOK_only(SV* sv)
3720 Tells and SV that it is an unsigned integer and disables all other OK bits.
3722 void SvIOK_only_UV(SV* sv)
3730 Returns a boolean indicating whether the SV contains an unsigned integer.
3732 bool SvIOK_UV(SV* sv)
3740 Returns a boolean indicating whether the SV is Copy-On-Write. (either shared
3741 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
3744 bool SvIsCOW(SV* sv)
3749 =item SvIsCOW_shared_hash
3750 X<SvIsCOW_shared_hash>
3752 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
3755 bool SvIsCOW_shared_hash(SV* sv)
3763 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
3764 version which guarantees to evaluate sv only once.
3774 Returns the raw value in the SV's IV slot, without checks or conversions.
3775 Only use when you are sure SvIOK is true. See also C<SvIV()>.
3785 Coerces the given SV to an integer and returns it. Guarantees to evaluate
3786 sv only once. Use the more efficient C<SvIV> otherwise.
3796 Like C<SvIV> but doesn't process magic.
3798 IV SvIV_nomg(SV* sv)
3806 Set the value of the IV pointer in sv to val. It is possible to perform
3807 the same function of this macro with an lvalue assignment to C<SvIVX>.
3808 With future Perls, however, it will be more efficient to use
3809 C<SvIV_set> instead of the lvalue assignment to C<SvIVX>.
3811 void SvIV_set(SV* sv, IV val)
3819 Returns the size of the string buffer in the SV, not including any part
3820 attributable to C<SvOOK>. See C<SvCUR>.
3822 STRLEN SvLEN(SV* sv)
3830 Set the actual length of the string which is in the SV. See C<SvIV_set>.
3832 void SvLEN_set(SV* sv, STRLEN len)
3840 Set the value of the MAGIC pointer in sv to val. See C<SvIV_set>.
3842 void SvMAGIC_set(SV* sv, MAGIC* val)
3850 Returns a boolean indicating whether the SV contains a number, integer or
3861 Returns a boolean indicating whether the SV contains a number, integer or
3862 double. Checks the B<private> setting. Use C<SvNIOK>.
3864 bool SvNIOKp(SV* sv)
3872 Unsets the NV/IV status of an SV.
3874 void SvNIOK_off(SV* sv)
3882 Returns a boolean indicating whether the SV contains a double.
3892 Returns a boolean indicating whether the SV contains a double. Checks the
3893 B<private> setting. Use C<SvNOK>.
3903 Unsets the NV status of an SV.
3905 void SvNOK_off(SV* sv)
3913 Tells an SV that it is a double.
3915 void SvNOK_on(SV* sv)
3923 Tells an SV that it is a double and disables all other OK bits.
3925 void SvNOK_only(SV* sv)
3933 Coerce the given SV to a double and return it. See C<SvNVx> for a version
3934 which guarantees to evaluate sv only once.
3944 Returns the raw value in the SV's NV slot, without checks or conversions.
3945 Only use when you are sure SvNOK is true. See also C<SvNV()>.
3955 Coerces the given SV to a double and returns it. Guarantees to evaluate
3956 sv only once. Use the more efficient C<SvNV> otherwise.
3966 Set the value of the NV pointer in sv to val. See C<SvIV_set>.
3968 void SvNV_set(SV* sv, NV val)
3976 Returns a boolean indicating whether the value is an SV. It also tells
3977 whether the value is defined or not.
3987 Returns a boolean indicating whether the SvIVX is a valid offset value for
3988 the SvPVX. This hack is used internally to speed up removal of characters
3989 from the beginning of a SvPV. When SvOOK is true, then the start of the
3990 allocated string buffer is really (SvPVX - SvIVX).
4000 Returns a boolean indicating whether the SV contains a character
4011 Returns a boolean indicating whether the SV contains a character string.
4012 Checks the B<private> setting. Use C<SvPOK>.
4022 Unsets the PV status of an SV.
4024 void SvPOK_off(SV* sv)
4032 Tells an SV that it is a string.
4034 void SvPOK_on(SV* sv)
4042 Tells an SV that it is a string and disables all other OK bits.
4043 Will also turn off the UTF-8 status.
4045 void SvPOK_only(SV* sv)
4050 =item SvPOK_only_UTF8
4053 Tells an SV that it is a string and disables all other OK bits,
4054 and leaves the UTF-8 status as it was.
4056 void SvPOK_only_UTF8(SV* sv)
4064 Returns a pointer to the string in the SV, or a stringified form of
4065 the SV if the SV does not contain a string. The SV may cache the
4066 stringified version becoming C<SvPOK>. Handles 'get' magic. See also
4067 C<SvPVx> for a version which guarantees to evaluate sv only once.
4069 char* SvPV(SV* sv, STRLEN len)
4077 Like C<SvPV>, but converts sv to byte representation first if necessary.
4079 char* SvPVbyte(SV* sv, STRLEN len)
4087 Like C<SvPV>, but converts sv to byte representation first if necessary.
4088 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
4091 char* SvPVbytex(SV* sv, STRLEN len)
4096 =item SvPVbytex_force
4099 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
4100 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
4103 char* SvPVbytex_force(SV* sv, STRLEN len)
4108 =item SvPVbyte_force
4111 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
4113 char* SvPVbyte_force(SV* sv, STRLEN len)
4118 =item SvPVbyte_nolen
4121 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
4123 char* SvPVbyte_nolen(SV* sv)
4131 Like C<SvPV>, but converts sv to utf8 first if necessary.
4133 char* SvPVutf8(SV* sv, STRLEN len)
4141 Like C<SvPV>, but converts sv to utf8 first if necessary.
4142 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
4145 char* SvPVutf8x(SV* sv, STRLEN len)
4150 =item SvPVutf8x_force
4153 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
4154 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
4157 char* SvPVutf8x_force(SV* sv, STRLEN len)
4162 =item SvPVutf8_force
4165 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
4167 char* SvPVutf8_force(SV* sv, STRLEN len)
4172 =item SvPVutf8_nolen
4175 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
4177 char* SvPVutf8_nolen(SV* sv)
4185 Returns a pointer to the physical string in the SV. The SV must contain a
4196 A version of C<SvPV> which guarantees to evaluate sv only once.
4198 char* SvPVx(SV* sv, STRLEN len)
4206 Like C<SvPV> but will force the SV into containing just a string
4207 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
4210 char* SvPV_force(SV* sv, STRLEN len)
4215 =item SvPV_force_nomg
4218 Like C<SvPV> but will force the SV into containing just a string
4219 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
4220 directly. Doesn't process magic.
4222 char* SvPV_force_nomg(SV* sv, STRLEN len)
4230 Returns a pointer to the string in the SV, or a stringified form of
4231 the SV if the SV does not contain a string. The SV may cache the
4232 stringified form becoming C<SvPOK>. Handles 'get' magic.
4234 char* SvPV_nolen(SV* sv)
4242 Like C<SvPV> but doesn't process magic.
4244 char* SvPV_nomg(SV* sv, STRLEN len)
4252 Set the value of the PV pointer in sv to val. See C<SvIV_set>.
4254 void SvPV_set(SV* sv, char* val)
4262 Returns the value of the object's reference count.
4264 U32 SvREFCNT(SV* sv)
4272 Decrements the reference count of the given SV.
4274 void SvREFCNT_dec(SV* sv)
4282 Increments the reference count of the given SV.
4284 SV* SvREFCNT_inc(SV* sv)
4292 Tests if the SV is an RV.
4302 Unsets the RV status of an SV.
4304 void SvROK_off(SV* sv)
4312 Tells an SV that it is an RV.
4314 void SvROK_on(SV* sv)
4322 Dereferences an RV to return the SV.
4332 Set the value of the RV pointer in sv to val. See C<SvIV_set>.
4334 void SvRV_set(SV* sv, SV* val)
4342 Returns the stash of the SV.
4352 Set the value of the STASH pointer in sv to val. See C<SvIV_set>.
4354 void SvSTASH_set(SV* sv, STASH* val)
4362 Taints an SV if tainting is enabled.
4364 void SvTAINT(SV* sv)
4372 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
4375 bool SvTAINTED(SV* sv)
4383 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
4384 some of Perl's fundamental security features. XS module authors should not
4385 use this function unless they fully understand all the implications of
4386 unconditionally untainting the value. Untainting should be done in the
4387 standard perl fashion, via a carefully crafted regexp, rather than directly
4388 untainting variables.
4390 void SvTAINTED_off(SV* sv)
4398 Marks an SV as tainted if tainting is enabled.
4400 void SvTAINTED_on(SV* sv)
4408 Returns a boolean indicating whether Perl would evaluate the SV as true or
4409 false, defined or undefined. Does not handle 'get' magic.
4419 Returns the type of the SV. See C<svtype>.
4421 svtype SvTYPE(SV* sv)
4429 Returns a boolean indicating whether the SV contains an unsigned integer.
4439 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
4440 perform the upgrade if necessary. See C<svtype>.
4442 void SvUPGRADE(SV* sv, svtype type)
4450 Returns a boolean indicating whether the SV contains UTF-8 encoded data.
4460 Unsets the UTF-8 status of an SV.
4462 void SvUTF8_off(SV *sv)
4470 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
4471 Do not use frivolously.
4473 void SvUTF8_on(SV *sv)
4481 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
4482 for a version which guarantees to evaluate sv only once.
4492 Returns the raw value in the SV's UV slot, without checks or conversions.
4493 Only use when you are sure SvIOK is true. See also C<SvUV()>.
4503 Coerces the given SV to an unsigned integer and returns it. Guarantees to
4504 evaluate sv only once. Use the more efficient C<SvUV> otherwise.
4514 Like C<SvUV> but doesn't process magic.
4516 UV SvUV_nomg(SV* sv)
4524 Set the value of the UV pointer in sv to val. See C<SvIV_set>.
4526 void SvUV_set(SV* sv, UV val)
4534 Returns a boolean indicating whether the SV contains a v-string.
4544 This function is only called on magical items, and is only used by
4545 sv_true() or its macro equivalent.
4547 bool sv_2bool(SV* sv)
4555 Using various gambits, try to get a CV from an SV; in addition, try if
4556 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
4558 CV* sv_2cv(SV* sv, HV** st, GV** gvp, I32 lref)
4566 Using various gambits, try to get an IO from an SV: the IO slot if its a
4567 GV; or the recursive result if we're an RV; or the IO slot of the symbol
4568 named after the PV if we're a string.
4578 Return the integer value of an SV, doing any necessary string
4579 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
4580 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
4582 IV sv_2iv_flags(SV* sv, I32 flags)
4590 Marks an existing SV as mortal. The SV will be destroyed "soon", either
4591 by an explicit call to FREETMPS, or by an implicit call at places such as
4592 statement boundaries. SvTEMP() is turned on which means that the SV's
4593 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
4594 and C<sv_mortalcopy>.
4596 SV* sv_2mortal(SV* sv)
4604 Return the num value of an SV, doing any necessary string or integer
4605 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
4616 Return a pointer to the byte-encoded representation of the SV, and set *lp
4617 to its length. May cause the SV to be downgraded from UTF-8 as a
4620 Usually accessed via the C<SvPVbyte> macro.
4622 char* sv_2pvbyte(SV* sv, STRLEN* lp)
4630 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
4631 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
4633 Usually accessed via the C<SvPVutf8> macro.
4635 char* sv_2pvutf8(SV* sv, STRLEN* lp)
4643 Returns a pointer to the string value of an SV, and sets *lp to its length.
4644 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
4646 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
4647 usually end up here too.
4649 char* sv_2pv_flags(SV* sv, STRLEN* lp, I32 flags)
4657 Return the unsigned integer value of an SV, doing any necessary string
4658 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
4659 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
4661 UV sv_2uv_flags(SV* sv, I32 flags)
4669 Remove any string offset. You should normally use the C<SvOOK_off> macro
4672 int sv_backoff(SV* sv)
4680 Blesses an SV into a specified package. The SV must be an RV. The package
4681 must be designated by its stash (see C<gv_stashpv()>). The reference count
4682 of the SV is unaffected.
4684 SV* sv_bless(SV* sv, HV* stash)
4692 Concatenates the string onto the end of the string which is in the SV.
4693 If the SV has the UTF-8 status set, then the bytes appended should be
4694 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4696 void sv_catpv(SV* sv, const char* ptr)
4704 Processes its arguments like C<sprintf> and appends the formatted
4705 output to an SV. If the appended data contains "wide" characters
4706 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
4707 and characters >255 formatted with %c), the original SV might get
4708 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
4709 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
4710 valid UTF-8; if the original SV was bytes, the pattern should be too.
4712 void sv_catpvf(SV* sv, const char* pat, ...)
4720 Like C<sv_catpvf>, but also handles 'set' magic.
4722 void sv_catpvf_mg(SV *sv, const char* pat, ...)
4730 Concatenates the string onto the end of the string which is in the SV. The
4731 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4732 status set, then the bytes appended should be valid UTF-8.
4733 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4735 void sv_catpvn(SV* sv, const char* ptr, STRLEN len)
4740 =item sv_catpvn_flags
4743 Concatenates the string onto the end of the string which is in the SV. The
4744 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4745 status set, then the bytes appended should be valid UTF-8.
4746 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4747 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4748 in terms of this function.
4750 void sv_catpvn_flags(SV* sv, const char* ptr, STRLEN len, I32 flags)
4755 =item sv_catpvn_nomg
4758 Like C<sv_catpvn> but doesn't process magic.
4760 void sv_catpvn_nomg(SV* sv, const char* ptr, STRLEN len)
4768 Like C<sv_catpv>, but also handles 'set' magic.
4770 void sv_catpv_mg(SV *sv, const char *ptr)
4778 Concatenates the string from SV C<ssv> onto the end of the string in
4779 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4780 not 'set' magic. See C<sv_catsv_mg>.
4782 void sv_catsv(SV* dsv, SV* ssv)
4787 =item sv_catsv_flags
4790 Concatenates the string from SV C<ssv> onto the end of the string in
4791 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4792 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4793 and C<sv_catsv_nomg> are implemented in terms of this function.
4795 void sv_catsv_flags(SV* dsv, SV* ssv, I32 flags)
4803 Like C<sv_catsv> but doesn't process magic.
4805 void sv_catsv_nomg(SV* dsv, SV* ssv)
4813 Efficient removal of characters from the beginning of the string buffer.
4814 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4815 the string buffer. The C<ptr> becomes the first character of the adjusted
4816 string. Uses the "OOK hack".
4817 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4818 refer to the same chunk of data.
4820 void sv_chop(SV* sv, const char* ptr)
4828 Clear an SV: call any destructors, free up any memory used by the body,
4829 and free the body itself. The SV's head is I<not> freed, although
4830 its type is set to all 1's so that it won't inadvertently be assumed
4831 to be live during global destruction etc.
4832 This function should only be called when REFCNT is zero. Most of the time
4833 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
4836 void sv_clear(SV* sv)
4844 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
4845 string in C<sv1> is less than, equal to, or greater than the string in
4846 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
4847 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
4849 I32 sv_cmp(SV* sv1, SV* sv2)
4857 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
4858 'use bytes' aware, handles get magic, and will coerce its args to strings
4859 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
4861 I32 sv_cmp_locale(SV* sv1, SV* sv2)
4869 Add Collate Transform magic to an SV if it doesn't already have it.
4871 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
4872 scalar data of the variable, but transformed to such a format that a normal
4873 memory comparison can be used to compare the data according to the locale
4876 char* sv_collxfrm(SV* sv, STRLEN* nxp)
4884 Copies a stringified representation of the source SV into the
4885 destination SV. Automatically performs any necessary mg_get and
4886 coercion of numeric values into strings. Guaranteed to preserve
4887 UTF-8 flag even from overloaded objects. Similar in nature to
4888 sv_2pv[_flags] but operates directly on an SV instead of just the
4889 string. Mostly uses sv_2pv_flags to do its work, except when that
4890 would lose the UTF-8'ness of the PV.
4892 void sv_copypv(SV* dsv, SV* ssv)
4900 Auto-decrement of the value in the SV, doing string to numeric conversion
4901 if necessary. Handles 'get' magic.
4908 =item sv_derived_from
4911 Returns a boolean indicating whether the SV is derived from the specified
4912 class. This is the function that implements C<UNIVERSAL::isa>. It works
4913 for class names as well as for objects.
4915 bool sv_derived_from(SV* sv, const char* name)
4918 Found in file universal.c
4923 Returns a boolean indicating whether the strings in the two SVs are
4924 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
4925 coerce its args to strings if necessary.
4927 I32 sv_eq(SV* sv1, SV* sv2)
4932 =item sv_force_normal_flags
4933 X<sv_force_normal_flags>
4935 Undo various types of fakery on an SV: if the PV is a shared string, make
4936 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4937 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4938 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4939 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4940 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4941 set to some other value.) In addition, the C<flags> parameter gets passed to
4942 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4943 with flags set to 0.
4945 void sv_force_normal_flags(SV *sv, U32 flags)
4953 Decrement an SV's reference count, and if it drops to zero, call
4954 C<sv_clear> to invoke destructors and free up any memory used by
4955 the body; finally, deallocate the SV's head itself.
4956 Normally called via a wrapper macro C<SvREFCNT_dec>.
4958 void sv_free(SV* sv)
4966 Get a line from the filehandle and store it into the SV, optionally
4967 appending to the currently-stored string.
4969 char* sv_gets(SV* sv, PerlIO* fp, I32 append)
4977 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
4978 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
4979 Use the C<SvGROW> wrapper instead.
4981 char* sv_grow(SV* sv, STRLEN newlen)
4989 Auto-increment of the value in the SV, doing string to numeric conversion
4990 if necessary. Handles 'get' magic.
5000 Inserts a string at the specified offset/length within the SV. Similar to
5001 the Perl substr() function.
5003 void sv_insert(SV* bigsv, STRLEN offset, STRLEN len, const char* little, STRLEN littlelen)
5011 Returns a boolean indicating whether the SV is blessed into the specified
5012 class. This does not check for subtypes; use C<sv_derived_from> to verify
5013 an inheritance relationship.
5015 int sv_isa(SV* sv, const char* name)
5023 Returns a boolean indicating whether the SV is an RV pointing to a blessed
5024 object. If the SV is not an RV, or if the object is not blessed, then this
5027 int sv_isobject(SV* sv)
5035 Returns the length of the string in the SV. Handles magic and type
5036 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5038 STRLEN sv_len(SV* sv)
5046 Returns the number of characters in the string in an SV, counting wide
5047 UTF-8 bytes as a single character. Handles magic and type coercion.
5049 STRLEN sv_len_utf8(SV* sv)
5057 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
5058 then adds a new magic item of type C<how> to the head of the magic list.
5060 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
5061 handling of the C<name> and C<namlen> arguments.
5063 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
5064 to add more than one instance of the same 'how'.
5066 void sv_magic(SV* sv, SV* obj, int how, const char* name, I32 namlen)
5074 Adds magic to an SV, upgrading it if necessary. Applies the
5075 supplied vtable and returns a pointer to the magic added.
5077 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
5078 In particular, you can add magic to SvREADONLY SVs, and add more than
5079 one instance of the same 'how'.
5081 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
5082 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
5083 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
5084 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
5086 (This is now used as a subroutine by C<sv_magic>.)
5088 MAGIC * sv_magicext(SV* sv, SV* obj, int how, const MGVTBL *vtbl, const char* name, I32 namlen)
5096 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
5097 The new SV is marked as mortal. It will be destroyed "soon", either by an
5098 explicit call to FREETMPS, or by an implicit call at places such as
5099 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
5101 SV* sv_mortalcopy(SV* oldsv)
5109 Creates a new null SV which is mortal. The reference count of the SV is
5110 set to 1. It will be destroyed "soon", either by an explicit call to
5111 FREETMPS, or by an implicit call at places such as statement boundaries.
5112 See also C<sv_mortalcopy> and C<sv_2mortal>.
5122 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5125 SV* sv_newref(SV* sv)
5133 Converts the value pointed to by offsetp from a count of bytes from the
5134 start of the string, to a count of the equivalent number of UTF-8 chars.
5135 Handles magic and type coercion.
5137 void sv_pos_b2u(SV* sv, I32* offsetp)
5145 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5146 the start of the string, to a count of the equivalent number of bytes; if
5147 lenp is non-zero, it does the same to lenp, but this time starting from
5148 the offset, rather than from the start of the string. Handles magic and
5151 void sv_pos_u2b(SV* sv, I32* offsetp, I32* lenp)
5156 =item sv_pvbyten_force
5159 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
5161 char* sv_pvbyten_force(SV* sv, STRLEN* lp)
5169 Get a sensible string out of the SV somehow.
5170 A private implementation of the C<SvPV_force> macro for compilers which
5171 can't cope with complex macro expressions. Always use the macro instead.
5173 char* sv_pvn_force(SV* sv, STRLEN* lp)
5178 =item sv_pvn_force_flags
5179 X<sv_pvn_force_flags>
5181 Get a sensible string out of the SV somehow.
5182 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
5183 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
5184 implemented in terms of this function.
5185 You normally want to use the various wrapper macros instead: see
5186 C<SvPV_force> and C<SvPV_force_nomg>
5188 char* sv_pvn_force_flags(SV* sv, STRLEN* lp, I32 flags)
5193 =item sv_pvutf8n_force
5196 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
5198 char* sv_pvutf8n_force(SV* sv, STRLEN* lp)
5206 Returns a string describing what the SV is a reference to.
5208 char* sv_reftype(const SV* sv, int ob)
5216 Make the first argument a copy of the second, then delete the original.
5217 The target SV physically takes over ownership of the body of the source SV
5218 and inherits its flags; however, the target keeps any magic it owns,
5219 and any magic in the source is discarded.
5220 Note that this is a rather specialist SV copying operation; most of the
5221 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5223 void sv_replace(SV* sv, SV* nsv)
5228 =item sv_report_used
5231 Dump the contents of all SVs not yet freed. (Debugging aid).
5233 void sv_report_used()
5241 Underlying implementation for the C<reset> Perl function.
5242 Note that the perl-level function is vaguely deprecated.
5244 void sv_reset(const char* s, HV* stash)
5252 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
5253 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
5254 push a back-reference to this RV onto the array of backreferences
5255 associated with that magic.
5257 SV* sv_rvweaken(SV *sv)
5265 Copies an integer into the given SV, upgrading first if necessary.
5266 Does not handle 'set' magic. See also C<sv_setiv_mg>.
5268 void sv_setiv(SV* sv, IV num)
5276 Like C<sv_setiv>, but also handles 'set' magic.
5278 void sv_setiv_mg(SV *sv, IV i)
5286 Copies a double into the given SV, upgrading first if necessary.
5287 Does not handle 'set' magic. See also C<sv_setnv_mg>.
5289 void sv_setnv(SV* sv, NV num)
5297 Like C<sv_setnv>, but also handles 'set' magic.
5299 void sv_setnv_mg(SV *sv, NV num)
5307 Copies a string into an SV. The string must be null-terminated. Does not
5308 handle 'set' magic. See C<sv_setpv_mg>.
5310 void sv_setpv(SV* sv, const char* ptr)
5318 Works like C<sv_catpvf> but copies the text into the SV instead of
5319 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
5321 void sv_setpvf(SV* sv, const char* pat, ...)
5329 Like C<sv_setpvf>, but also handles 'set' magic.
5331 void sv_setpvf_mg(SV *sv, const char* pat, ...)
5339 Copies an integer into the given SV, also updating its string value.
5340 Does not handle 'set' magic. See C<sv_setpviv_mg>.
5342 void sv_setpviv(SV* sv, IV num)
5350 Like C<sv_setpviv>, but also handles 'set' magic.
5352 void sv_setpviv_mg(SV *sv, IV iv)
5360 Copies a string into an SV. The C<len> parameter indicates the number of
5361 bytes to be copied. If the C<ptr> argument is NULL the SV will become
5362 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
5364 void sv_setpvn(SV* sv, const char* ptr, STRLEN len)
5372 Like C<sv_setpvn>, but also handles 'set' magic.
5374 void sv_setpvn_mg(SV *sv, const char *ptr, STRLEN len)
5382 Like C<sv_setpv>, but also handles 'set' magic.
5384 void sv_setpv_mg(SV *sv, const char *ptr)
5392 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
5393 argument will be upgraded to an RV. That RV will be modified to point to
5394 the new SV. The C<classname> argument indicates the package for the
5395 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
5396 will have a reference count of 1, and the RV will be returned.
5398 SV* sv_setref_iv(SV* rv, const char* classname, IV iv)
5406 Copies a double into a new SV, optionally blessing the SV. The C<rv>
5407 argument will be upgraded to an RV. That RV will be modified to point to
5408 the new SV. The C<classname> argument indicates the package for the
5409 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
5410 will have a reference count of 1, and the RV will be returned.
5412 SV* sv_setref_nv(SV* rv, const char* classname, NV nv)
5420 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
5421 argument will be upgraded to an RV. That RV will be modified to point to
5422 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
5423 into the SV. The C<classname> argument indicates the package for the
5424 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
5425 will have a reference count of 1, and the RV will be returned.
5427 Do not use with other Perl types such as HV, AV, SV, CV, because those
5428 objects will become corrupted by the pointer copy process.
5430 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
5432 SV* sv_setref_pv(SV* rv, const char* classname, void* pv)
5440 Copies a string into a new SV, optionally blessing the SV. The length of the
5441 string must be specified with C<n>. The C<rv> argument will be upgraded to
5442 an RV. That RV will be modified to point to the new SV. The C<classname>
5443 argument indicates the package for the blessing. Set C<classname> to
5444 C<Nullch> to avoid the blessing. The new SV will have a reference count
5445 of 1, and the RV will be returned.
5447 Note that C<sv_setref_pv> copies the pointer while this copies the string.
5449 SV* sv_setref_pvn(SV* rv, const char* classname, const char* pv, STRLEN n)
5457 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
5458 argument will be upgraded to an RV. That RV will be modified to point to
5459 the new SV. The C<classname> argument indicates the package for the
5460 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
5461 will have a reference count of 1, and the RV will be returned.
5463 SV* sv_setref_uv(SV* rv, const char* classname, UV uv)
5471 Copies the contents of the source SV C<ssv> into the destination SV
5472 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
5473 function if the source SV needs to be reused. Does not handle 'set' magic.
5474 Loosely speaking, it performs a copy-by-value, obliterating any previous
5475 content of the destination.
5477 You probably want to use one of the assortment of wrappers, such as
5478 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
5479 C<SvSetMagicSV_nosteal>.
5481 void sv_setsv(SV* dsv, SV* ssv)
5486 =item sv_setsv_flags
5489 Copies the contents of the source SV C<ssv> into the destination SV
5490 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
5491 function if the source SV needs to be reused. Does not handle 'set' magic.
5492 Loosely speaking, it performs a copy-by-value, obliterating any previous
5493 content of the destination.
5494 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
5495 C<ssv> if appropriate, else not. If the C<flags> parameter has the
5496 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
5497 and C<sv_setsv_nomg> are implemented in terms of this function.
5499 You probably want to use one of the assortment of wrappers, such as
5500 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
5501 C<SvSetMagicSV_nosteal>.
5503 This is the primary function for copying scalars, and most other
5504 copy-ish functions and macros use this underneath.
5506 void sv_setsv_flags(SV* dsv, SV* ssv, I32 flags)
5514 Like C<sv_setsv>, but also handles 'set' magic.
5516 void sv_setsv_mg(SV *dstr, SV *sstr)
5524 Like C<sv_setsv> but doesn't process magic.
5526 void sv_setsv_nomg(SV* dsv, SV* ssv)
5534 Copies an unsigned integer into the given SV, upgrading first if necessary.
5535 Does not handle 'set' magic. See also C<sv_setuv_mg>.
5537 void sv_setuv(SV* sv, UV num)
5545 Like C<sv_setuv>, but also handles 'set' magic.
5547 void sv_setuv_mg(SV *sv, UV u)
5555 Test an SV for taintedness. Use C<SvTAINTED> instead.
5556 bool sv_tainted(SV* sv)
5564 Returns true if the SV has a true value by Perl's rules.
5565 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
5566 instead use an in-line version.
5576 Removes all magic of type C<type> from an SV.
5578 int sv_unmagic(SV* sv, int type)
5583 =item sv_unref_flags
5586 Unsets the RV status of the SV, and decrements the reference count of
5587 whatever was being referenced by the RV. This can almost be thought of
5588 as a reversal of C<newSVrv>. The C<cflags> argument can contain
5589 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
5590 (otherwise the decrementing is conditional on the reference count being
5591 different from one or the reference being a readonly SV).
5594 void sv_unref_flags(SV* sv, U32 flags)
5602 Untaint an SV. Use C<SvTAINTED_off> instead.
5603 void sv_untaint(SV* sv)
5611 Upgrade an SV to a more complex form. Generally adds a new body type to the
5612 SV, then copies across as much information as possible from the old body.
5613 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
5615 void sv_upgrade(SV* sv, U32 mt)
5623 Tells an SV to use C<ptr> to find its string value. Normally the string is
5624 stored inside the SV but sv_usepvn allows the SV to use an outside string.
5625 The C<ptr> should point to memory that was allocated by C<malloc>. The
5626 string length, C<len>, must be supplied. This function will realloc the
5627 memory pointed to by C<ptr>, so that pointer should not be freed or used by
5628 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
5629 See C<sv_usepvn_mg>.
5631 void sv_usepvn(SV* sv, char* ptr, STRLEN len)
5639 Like C<sv_usepvn>, but also handles 'set' magic.
5641 void sv_usepvn_mg(SV *sv, char *ptr, STRLEN len)
5646 =item sv_utf8_decode
5649 If the PV of the SV is an octet sequence in UTF-8
5650 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
5651 so that it looks like a character. If the PV contains only single-byte
5652 characters, the C<SvUTF8> flag stays being off.
5653 Scans PV for validity and returns false if the PV is invalid UTF-8.
5655 NOTE: this function is experimental and may change or be
5656 removed without notice.
5658 bool sv_utf8_decode(SV *sv)
5663 =item sv_utf8_downgrade
5664 X<sv_utf8_downgrade>
5666 Attempts to convert the PV of an SV from characters to bytes.
5667 If the PV contains a character beyond byte, this conversion will fail;
5668 in this case, either returns false or, if C<fail_ok> is not
5671 This is not as a general purpose Unicode to byte encoding interface:
5672 use the Encode extension for that.
5674 NOTE: this function is experimental and may change or be
5675 removed without notice.
5677 bool sv_utf8_downgrade(SV *sv, bool fail_ok)
5682 =item sv_utf8_encode
5685 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
5686 flag off so that it looks like octets again.
5688 void sv_utf8_encode(SV *sv)
5693 =item sv_utf8_upgrade
5696 Converts the PV of an SV to its UTF-8-encoded form.
5697 Forces the SV to string form if it is not already.
5698 Always sets the SvUTF8 flag to avoid future validity checks even
5699 if all the bytes have hibit clear.
5701 This is not as a general purpose byte encoding to Unicode interface:
5702 use the Encode extension for that.
5704 STRLEN sv_utf8_upgrade(SV *sv)
5709 =item sv_utf8_upgrade_flags
5710 X<sv_utf8_upgrade_flags>
5712 Converts the PV of an SV to its UTF-8-encoded form.
5713 Forces the SV to string form if it is not already.
5714 Always sets the SvUTF8 flag to avoid future validity checks even
5715 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
5716 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
5717 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
5719 This is not as a general purpose byte encoding to Unicode interface:
5720 use the Encode extension for that.
5722 STRLEN sv_utf8_upgrade_flags(SV *sv, I32 flags)
5730 Processes its arguments like C<vsprintf> and appends the formatted output
5731 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
5733 Usually used via its frontend C<sv_catpvf>.
5735 void sv_vcatpvf(SV* sv, const char* pat, va_list* args)
5743 Processes its arguments like C<vsprintf> and appends the formatted output
5744 to an SV. Uses an array of SVs if the C style variable argument list is
5745 missing (NULL). When running with taint checks enabled, indicates via
5746 C<maybe_tainted> if results are untrustworthy (often due to the use of
5749 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
5751 void sv_vcatpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
5759 Like C<sv_vcatpvf>, but also handles 'set' magic.
5761 Usually used via its frontend C<sv_catpvf_mg>.
5763 void sv_vcatpvf_mg(SV* sv, const char* pat, va_list* args)
5771 Works like C<sv_vcatpvf> but copies the text into the SV instead of
5772 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
5774 Usually used via its frontend C<sv_setpvf>.
5776 void sv_vsetpvf(SV* sv, const char* pat, va_list* args)
5784 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
5787 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
5789 void sv_vsetpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
5797 Like C<sv_vsetpvf>, but also handles 'set' magic.
5799 Usually used via its frontend C<sv_setpvf_mg>.
5801 void sv_vsetpvf_mg(SV* sv, const char* pat, va_list* args)
5809 =head1 Unicode Support
5813 =item bytes_from_utf8
5816 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
5817 Unlike C<utf8_to_bytes> but like C<bytes_to_utf8>, returns a pointer to
5818 the newly-created string, and updates C<len> to contain the new
5819 length. Returns the original string if no conversion occurs, C<len>
5820 is unchanged. Do nothing if C<is_utf8> points to 0. Sets C<is_utf8> to
5821 0 if C<s> is converted or contains all 7bit characters.
5823 NOTE: this function is experimental and may change or be
5824 removed without notice.
5826 U8* bytes_from_utf8(const U8 *s, STRLEN *len, bool *is_utf8)
5829 Found in file utf8.c
5834 Converts a string C<s> of length C<len> from ASCII into UTF-8 encoding.
5835 Returns a pointer to the newly-created string, and sets C<len> to
5836 reflect the new length.
5838 If you want to convert to UTF-8 from other encodings than ASCII,
5839 see sv_recode_to_utf8().
5841 NOTE: this function is experimental and may change or be
5842 removed without notice.
5844 U8* bytes_to_utf8(const U8 *s, STRLEN *len)
5847 Found in file utf8.c
5852 Return true if the strings s1 and s2 differ case-insensitively, false
5853 if not (if they are equal case-insensitively). If u1 is true, the
5854 string s1 is assumed to be in UTF-8-encoded Unicode. If u2 is true,
5855 the string s2 is assumed to be in UTF-8-encoded Unicode. If u1 or u2
5856 are false, the respective string is assumed to be in native 8-bit
5859 If the pe1 and pe2 are non-NULL, the scanning pointers will be copied
5860 in there (they will point at the beginning of the I<next> character).
5861 If the pointers behind pe1 or pe2 are non-NULL, they are the end
5862 pointers beyond which scanning will not continue under any
5863 circumstances. If the byte lengths l1 and l2 are non-zero, s1+l1 and
5864 s2+l2 will be used as goal end pointers that will also stop the scan,
5865 and which qualify towards defining a successful match: all the scans
5866 that define an explicit length must reach their goal pointers for
5867 a match to succeed).
5869 For case-insensitiveness, the "casefolding" of Unicode is used
5870 instead of upper/lowercasing both the characters, see
5871 http://www.unicode.org/unicode/reports/tr21/ (Case Mappings).
5873 I32 ibcmp_utf8(const char* a, char **pe1, UV l1, bool u1, const char* b, char **pe2, UV l2, bool u2)
5876 Found in file utf8.c
5881 Tests if some arbitrary number of bytes begins in a valid UTF-8
5882 character. Note that an INVARIANT (i.e. ASCII) character is a valid
5883 UTF-8 character. The actual number of bytes in the UTF-8 character
5884 will be returned if it is valid, otherwise 0.
5886 STRLEN is_utf8_char(const U8 *p)
5889 Found in file utf8.c
5891 =item is_utf8_string
5894 Returns true if first C<len> bytes of the given string form a valid
5895 UTF-8 string, false otherwise. Note that 'a valid UTF-8 string' does
5896 not mean 'a string that contains code points above 0x7F encoded in UTF-8'
5897 because a valid ASCII string is a valid UTF-8 string.
5899 See also is_utf8_string_loclen() and is_utf8_string_loc().
5901 bool is_utf8_string(const U8 *s, STRLEN len)
5904 Found in file utf8.c
5906 =item is_utf8_string_loc
5907 X<is_utf8_string_loc>
5909 Like is_utf8_string() but stores the location of the failure (in the
5910 case of "utf8ness failure") or the location s+len (in the case of
5911 "utf8ness success") in the C<ep>.
5913 See also is_utf8_string_loclen() and is_utf8_string().
5915 bool is_utf8_string_loc(const U8 *s, STRLEN len, const U8 **p)
5918 Found in file utf8.c
5920 =item is_utf8_string_loclen
5921 X<is_utf8_string_loclen>
5923 Like is_utf8_string() but stores the location of the failure (in the
5924 case of "utf8ness failure") or the location s+len (in the case of
5925 "utf8ness success") in the C<ep>, and the number of UTF-8
5926 encoded characters in the C<el>.
5928 See also is_utf8_string_loc() and is_utf8_string().
5930 bool is_utf8_string_loclen(const U8 *s, STRLEN len, const U8 **ep, STRLEN *el)
5933 Found in file utf8.c
5935 =item pv_uni_display
5938 Build to the scalar dsv a displayable version of the string spv,
5939 length len, the displayable version being at most pvlim bytes long
5940 (if longer, the rest is truncated and "..." will be appended).
5942 The flags argument can have UNI_DISPLAY_ISPRINT set to display
5943 isPRINT()able characters as themselves, UNI_DISPLAY_BACKSLASH
5944 to display the \\[nrfta\\] as the backslashed versions (like '\n')
5945 (UNI_DISPLAY_BACKSLASH is preferred over UNI_DISPLAY_ISPRINT for \\).
5946 UNI_DISPLAY_QQ (and its alias UNI_DISPLAY_REGEX) have both
5947 UNI_DISPLAY_BACKSLASH and UNI_DISPLAY_ISPRINT turned on.
5949 The pointer to the PV of the dsv is returned.
5951 char* pv_uni_display(SV *dsv, const U8 *spv, STRLEN len, STRLEN pvlim, UV flags)
5954 Found in file utf8.c
5959 The encoding is assumed to be an Encode object, the PV of the ssv is
5960 assumed to be octets in that encoding and decoding the input starts
5961 from the position which (PV + *offset) pointed to. The dsv will be
5962 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
5963 when the string tstr appears in decoding output or the input ends on
5964 the PV of the ssv. The value which the offset points will be modified
5965 to the last input position on the ssv.
5967 Returns TRUE if the terminator was found, else returns FALSE.
5969 bool sv_cat_decode(SV* dsv, SV *encoding, SV *ssv, int *offset, char* tstr, int tlen)
5974 =item sv_recode_to_utf8
5975 X<sv_recode_to_utf8>
5977 The encoding is assumed to be an Encode object, on entry the PV
5978 of the sv is assumed to be octets in that encoding, and the sv
5979 will be converted into Unicode (and UTF-8).
5981 If the sv already is UTF-8 (or if it is not POK), or if the encoding
5982 is not a reference, nothing is done to the sv. If the encoding is not
5983 an C<Encode::XS> Encoding object, bad things will happen.
5984 (See F<lib/encoding.pm> and L<Encode>).
5986 The PV of the sv is returned.
5988 char* sv_recode_to_utf8(SV* sv, SV *encoding)
5993 =item sv_uni_display
5996 Build to the scalar dsv a displayable version of the scalar sv,
5997 the displayable version being at most pvlim bytes long
5998 (if longer, the rest is truncated and "..." will be appended).
6000 The flags argument is as in pv_uni_display().
6002 The pointer to the PV of the dsv is returned.
6004 char* sv_uni_display(SV *dsv, SV *ssv, STRLEN pvlim, UV flags)
6007 Found in file utf8.c
6012 The "p" contains the pointer to the UTF-8 string encoding
6013 the character that is being converted.
6015 The "ustrp" is a pointer to the character buffer to put the
6016 conversion result to. The "lenp" is a pointer to the length
6019 The "swashp" is a pointer to the swash to use.
6021 Both the special and normal mappings are stored lib/unicore/To/Foo.pl,
6022 and loaded by SWASHNEW, using lib/utf8_heavy.pl. The special (usually,
6023 but not always, a multicharacter mapping), is tried first.
6025 The "special" is a string like "utf8::ToSpecLower", which means the
6026 hash %utf8::ToSpecLower. The access to the hash is through
6027 Perl_to_utf8_case().
6029 The "normal" is a string like "ToLower" which means the swash
6032 UV to_utf8_case(const U8 *p, U8* ustrp, STRLEN *lenp, SV **swashp, const char *normal, const char *special)
6035 Found in file utf8.c
6040 Convert the UTF-8 encoded character at p to its foldcase version and
6041 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6042 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6043 foldcase version may be longer than the original character (up to
6046 The first character of the foldcased version is returned
6047 (but note, as explained above, that there may be more.)
6049 UV to_utf8_fold(const U8 *p, U8* ustrp, STRLEN *lenp)
6052 Found in file utf8.c
6057 Convert the UTF-8 encoded character at p to its lowercase version and
6058 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6059 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6060 lowercase version may be longer than the original character.
6062 The first character of the lowercased version is returned
6063 (but note, as explained above, that there may be more.)
6065 UV to_utf8_lower(const U8 *p, U8* ustrp, STRLEN *lenp)
6068 Found in file utf8.c
6073 Convert the UTF-8 encoded character at p to its titlecase version and
6074 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6075 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6076 titlecase version may be longer than the original character.
6078 The first character of the titlecased version is returned
6079 (but note, as explained above, that there may be more.)
6081 UV to_utf8_title(const U8 *p, U8* ustrp, STRLEN *lenp)
6084 Found in file utf8.c
6089 Convert the UTF-8 encoded character at p to its uppercase version and
6090 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6091 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since
6092 the uppercase version may be longer than the original character.
6094 The first character of the uppercased version is returned
6095 (but note, as explained above, that there may be more.)
6097 UV to_utf8_upper(const U8 *p, U8* ustrp, STRLEN *lenp)
6100 Found in file utf8.c
6102 =item utf8n_to_uvchr
6107 Returns the native character value of the first character in the string
6109 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6110 length, in bytes, of that character.
6112 Allows length and flags to be passed to low level routine.
6114 UV utf8n_to_uvchr(const U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags)
6117 Found in file utf8.c
6119 =item utf8n_to_uvuni
6122 Bottom level UTF-8 decode routine.
6123 Returns the unicode code point value of the first character in the string C<s>
6124 which is assumed to be in UTF-8 encoding and no longer than C<curlen>;
6125 C<retlen> will be set to the length, in bytes, of that character.
6127 If C<s> does not point to a well-formed UTF-8 character, the behaviour
6128 is dependent on the value of C<flags>: if it contains UTF8_CHECK_ONLY,
6129 it is assumed that the caller will raise a warning, and this function
6130 will silently just set C<retlen> to C<-1> and return zero. If the
6131 C<flags> does not contain UTF8_CHECK_ONLY, warnings about
6132 malformations will be given, C<retlen> will be set to the expected
6133 length of the UTF-8 character in bytes, and zero will be returned.
6135 The C<flags> can also contain various flags to allow deviations from
6136 the strict UTF-8 encoding (see F<utf8.h>).
6138 Most code should use utf8_to_uvchr() rather than call this directly.
6140 UV utf8n_to_uvuni(const U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags)
6143 Found in file utf8.c
6148 Returns the number of UTF-8 characters between the UTF-8 pointers C<a>
6151 WARNING: use only if you *know* that the pointers point inside the
6154 IV utf8_distance(const U8 *a, const U8 *b)
6157 Found in file utf8.c
6162 Return the UTF-8 pointer C<s> displaced by C<off> characters, either
6163 forward or backward.
6165 WARNING: do not use the following unless you *know* C<off> is within
6166 the UTF-8 data pointed to by C<s> *and* that on entry C<s> is aligned
6167 on the first byte of character or just after the last byte of a character.
6169 U8* utf8_hop(const U8 *s, I32 off)
6172 Found in file utf8.c
6177 Return the length of the UTF-8 char encoded string C<s> in characters.
6178 Stops at C<e> (inclusive). If C<e E<lt> s> or if the scan would end
6179 up past C<e>, croaks.
6181 STRLEN utf8_length(const U8* s, const U8 *e)
6184 Found in file utf8.c
6189 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
6190 Unlike C<bytes_to_utf8>, this over-writes the original string, and
6191 updates len to contain the new length.
6192 Returns zero on failure, setting C<len> to -1.
6194 NOTE: this function is experimental and may change or be
6195 removed without notice.
6197 U8* utf8_to_bytes(U8 *s, STRLEN *len)
6200 Found in file utf8.c
6205 Returns the native character value of the first character in the string C<s>
6206 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6207 length, in bytes, of that character.
6209 If C<s> does not point to a well-formed UTF-8 character, zero is
6210 returned and retlen is set, if possible, to -1.
6212 UV utf8_to_uvchr(const U8 *s, STRLEN *retlen)
6215 Found in file utf8.c
6220 Returns the Unicode code point of the first character in the string C<s>
6221 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6222 length, in bytes, of that character.
6224 This function should only be used when returned UV is considered
6225 an index into the Unicode semantic tables (e.g. swashes).
6227 If C<s> does not point to a well-formed UTF-8 character, zero is
6228 returned and retlen is set, if possible, to -1.
6230 UV utf8_to_uvuni(const U8 *s, STRLEN *retlen)
6233 Found in file utf8.c
6238 Adds the UTF-8 representation of the Native codepoint C<uv> to the end
6239 of the string C<d>; C<d> should be have at least C<UTF8_MAXBYTES+1> free
6240 bytes available. The return value is the pointer to the byte after the
6241 end of the new character. In other words,
6243 d = uvchr_to_utf8(d, uv);
6245 is the recommended wide native character-aware way of saying
6249 U8* uvchr_to_utf8(U8 *d, UV uv)
6252 Found in file utf8.c
6254 =item uvuni_to_utf8_flags
6255 X<uvuni_to_utf8_flags>
6257 Adds the UTF-8 representation of the Unicode codepoint C<uv> to the end
6258 of the string C<d>; C<d> should be have at least C<UTF8_MAXBYTES+1> free
6259 bytes available. The return value is the pointer to the byte after the
6260 end of the new character. In other words,
6262 d = uvuni_to_utf8_flags(d, uv, flags);
6266 d = uvuni_to_utf8(d, uv);
6268 (which is equivalent to)
6270 d = uvuni_to_utf8_flags(d, uv, 0);
6272 is the recommended Unicode-aware way of saying
6276 U8* uvuni_to_utf8_flags(U8 *d, UV uv, UV flags)
6279 Found in file utf8.c
6284 =head1 Variables created by C<xsubpp> and C<xsubpp> internal functions
6291 Variable which is setup by C<xsubpp> to indicate the stack base offset,
6292 used by the C<ST>, C<XSprePUSH> and C<XSRETURN> macros. The C<dMARK> macro
6293 must be called prior to setup the C<MARK> variable.
6298 Found in file XSUB.h
6303 Variable which is setup by C<xsubpp> to indicate the
6304 class name for a C++ XS constructor. This is always a C<char*>. See C<THIS>.
6309 Found in file XSUB.h
6314 Sets up the C<ax> variable.
6315 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
6320 Found in file XSUB.h
6325 Sets up the C<ax> variable and stack marker variable C<mark>.
6326 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
6331 Found in file XSUB.h
6336 Sets up the C<items> variable.
6337 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
6342 Found in file XSUB.h
6347 Sets up the C<padoff_du> variable for an XSUB that wishes to use
6353 Found in file XSUB.h
6358 Sets up stack and mark pointers for an XSUB, calling dSP and dMARK.
6359 Sets up the C<ax> and C<items> variables by calling C<dAX> and C<dITEMS>.
6360 This is usually handled automatically by C<xsubpp>.
6365 Found in file XSUB.h
6370 Sets up the C<ix> variable for an XSUB which has aliases. This is usually
6371 handled automatically by C<xsubpp>.
6376 Found in file XSUB.h
6381 Variable which is setup by C<xsubpp> to indicate the number of
6382 items on the stack. See L<perlxs/"Variable-length Parameter Lists">.
6387 Found in file XSUB.h
6392 Variable which is setup by C<xsubpp> to indicate which of an
6393 XSUB's aliases was used to invoke it. See L<perlxs/"The ALIAS: Keyword">.
6398 Found in file XSUB.h
6403 Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
6407 Found in file XSUB.h
6412 Variable which is setup by C<xsubpp> to hold the return value for an
6413 XSUB. This is always the proper type for the XSUB. See
6414 L<perlxs/"The RETVAL Variable">.
6419 Found in file XSUB.h
6424 Used to access elements on the XSUB's stack.
6429 Found in file XSUB.h
6434 Variable which is setup by C<xsubpp> to designate the object in a C++
6435 XSUB. This is always the proper type for the C++ object. See C<CLASS> and
6436 L<perlxs/"Using XS With C++">.
6441 Found in file XSUB.h
6446 The SV* corresponding to the $_ variable. Works even if there
6447 is a lexical $_ in scope.
6450 Found in file XSUB.h
6455 Macro to declare an XSUB and its C parameter list. This is handled by
6459 Found in file XSUB.h
6464 The version identifier for an XS module. This is usually
6465 handled automatically by C<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>.
6468 Found in file XSUB.h
6470 =item XS_VERSION_BOOTCHECK
6471 X<XS_VERSION_BOOTCHECK>
6473 Macro to verify that a PM module's $VERSION variable matches the XS
6474 module's C<XS_VERSION> variable. This is usually handled automatically by
6475 C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">.
6477 XS_VERSION_BOOTCHECK;
6480 Found in file XSUB.h
6485 =head1 Warning and Dieing
6492 This is the XSUB-writer's interface to Perl's C<die> function.
6493 Normally call this function the same way you call the C C<printf>
6494 function. Calling C<croak> returns control directly to Perl,
6495 sidestepping the normal C order of execution. See C<warn>.
6497 If you want to throw an exception object, assign the object to
6498 C<$@> and then pass C<Nullch> to croak():
6500 errsv = get_sv("@", TRUE);
6501 sv_setsv(errsv, exception_object);
6504 void croak(const char* pat, ...)
6507 Found in file util.c
6512 This is the XSUB-writer's interface to Perl's C<warn> function. Call this
6513 function the same way you call the C C<printf> function. See C<croak>.
6515 void warn(const char* pat, ...)
6518 Found in file util.c
6525 Until May 1997, this document was maintained by Jeff Okamoto
6526 <okamoto@corp.hp.com>. It is now maintained as part of Perl itself.
6528 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
6529 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
6530 Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
6531 Stephen McCamant, and Gurusamy Sarathy.
6533 API Listing originally by Dean Roehrich <roehrich@cray.com>.
6535 Updated to be autogenerated from comments in the source by Benjamin Stuhl.
6539 perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
projects / p5sagit/p5-mst-13.2.git / blob