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 If C<gv> is a typeglob whose subroutine entry is a constant sub eligible for
1126 inlining, or C<gv> is a placeholder reference that would be promoted to such
1127 a typeglob, then returns the value returned by the sub. Otherwise, returns
1130 SV* gv_const_sv(GV* gv)
1138 Returns the glob with the given C<name> and a defined subroutine or
1139 C<NULL>. The glob lives in the given C<stash>, or in the stashes
1140 accessible via @ISA and UNIVERSAL::.
1142 The argument C<level> should be either 0 or -1. If C<level==0>, as a
1143 side-effect creates a glob with the given C<name> in the given C<stash>
1144 which in the case of success contains an alias for the subroutine, and sets
1145 up caching info for this glob. Similarly for all the searched stashes.
1147 This function grants C<"SUPER"> token as a postfix of the stash name. The
1148 GV returned from C<gv_fetchmeth> may be a method cache entry, which is not
1149 visible to Perl code. So when calling C<call_sv>, you should not use
1150 the GV directly; instead, you should use the method's CV, which can be
1151 obtained from the GV with the C<GvCV> macro.
1153 GV* gv_fetchmeth(HV* stash, const char* name, STRLEN len, I32 level)
1158 =item gv_fetchmethod_autoload
1159 X<gv_fetchmethod_autoload>
1161 Returns the glob which contains the subroutine to call to invoke the method
1162 on the C<stash>. In fact in the presence of autoloading this may be the
1163 glob for "AUTOLOAD". In this case the corresponding variable $AUTOLOAD is
1166 The third parameter of C<gv_fetchmethod_autoload> determines whether
1167 AUTOLOAD lookup is performed if the given method is not present: non-zero
1168 means yes, look for AUTOLOAD; zero means no, don't look for AUTOLOAD.
1169 Calling C<gv_fetchmethod> is equivalent to calling C<gv_fetchmethod_autoload>
1170 with a non-zero C<autoload> parameter.
1172 These functions grant C<"SUPER"> token as a prefix of the method name. Note
1173 that if you want to keep the returned glob for a long time, you need to
1174 check for it being "AUTOLOAD", since at the later time the call may load a
1175 different subroutine due to $AUTOLOAD changing its value. Use the glob
1176 created via a side effect to do this.
1178 These functions have the same side-effects and as C<gv_fetchmeth> with
1179 C<level==0>. C<name> should be writable if contains C<':'> or C<'
1180 ''>. The warning against passing the GV returned by C<gv_fetchmeth> to
1181 C<call_sv> apply equally to these functions.
1183 GV* gv_fetchmethod_autoload(HV* stash, const char* name, I32 autoload)
1188 =item gv_fetchmeth_autoload
1189 X<gv_fetchmeth_autoload>
1191 Same as gv_fetchmeth(), but looks for autoloaded subroutines too.
1192 Returns a glob for the subroutine.
1194 For an autoloaded subroutine without a GV, will create a GV even
1195 if C<level < 0>. For an autoloaded subroutine without a stub, GvCV()
1196 of the result may be zero.
1198 GV* gv_fetchmeth_autoload(HV* stash, const char* name, STRLEN len, I32 level)
1206 Returns a pointer to the stash for a specified package. C<name> should
1207 be a valid UTF-8 string and must be null-terminated. If C<create> is set
1208 then the package will be created if it does not already exist. If C<create>
1209 is not set and the package does not exist then NULL is returned.
1211 HV* gv_stashpv(const char* name, I32 create)
1219 Returns a pointer to the stash for a specified package. C<name> should
1220 be a valid UTF-8 string. The C<namelen> parameter indicates the length of
1221 the C<name>, in bytes. If C<create> is set then the package will be
1222 created if it does not already exist. If C<create> is not set and the
1223 package does not exist then NULL is returned.
1225 HV* gv_stashpvn(const char* name, U32 namelen, I32 create)
1233 Returns a pointer to the stash for a specified package, which must be a
1234 valid UTF-8 string. See C<gv_stashpv>.
1236 HV* gv_stashsv(SV* sv, I32 create)
1259 Null character pointer.
1262 Found in file handy.h
1286 Found in file handy.h
1291 =head1 Hash Manipulation Functions
1298 Returns the HV of the specified Perl hash. If C<create> is set and the
1299 Perl variable does not exist then it will be created. If C<create> is not
1300 set and the variable does not exist then NULL is returned.
1302 NOTE: the perl_ form of this function is deprecated.
1304 HV* get_hv(const char* name, I32 create)
1307 Found in file perl.c
1312 This flag, used in the length slot of hash entries and magic structures,
1313 specifies the structure contains an C<SV*> pointer where a C<char*> pointer
1314 is to be expected. (For information only--not to be used).
1322 Returns the computed hash stored in the hash entry.
1332 Returns the actual pointer stored in the key slot of the hash entry. The
1333 pointer may be either C<char*> or C<SV*>, depending on the value of
1334 C<HeKLEN()>. Can be assigned to. The C<HePV()> or C<HeSVKEY()> macros are
1335 usually preferable for finding the value of a key.
1345 If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry
1346 holds an C<SV*> key. Otherwise, holds the actual length of the key. Can
1347 be assigned to. The C<HePV()> macro is usually preferable for finding key
1350 STRLEN HeKLEN(HE* he)
1358 Returns the key slot of the hash entry as a C<char*> value, doing any
1359 necessary dereferencing of possibly C<SV*> keys. The length of the string
1360 is placed in C<len> (this is a macro, so do I<not> use C<&len>). If you do
1361 not care about what the length of the key is, you may use the global
1362 variable C<PL_na>, though this is rather less efficient than using a local
1363 variable. Remember though, that hash keys in perl are free to contain
1364 embedded nulls, so using C<strlen()> or similar is not a good way to find
1365 the length of hash keys. This is very similar to the C<SvPV()> macro
1366 described elsewhere in this document.
1368 char* HePV(HE* he, STRLEN len)
1376 Returns the key as an C<SV*>, or C<Nullsv> if the hash entry does not
1377 contain an C<SV*> key.
1387 Returns the key as an C<SV*>. Will create and return a temporary mortal
1388 C<SV*> if the hash entry contains only a C<char*> key.
1390 SV* HeSVKEY_force(HE* he)
1398 Sets the key to a given C<SV*>, taking care to set the appropriate flags to
1399 indicate the presence of an C<SV*> key, and returns the same
1402 SV* HeSVKEY_set(HE* he, SV* sv)
1410 Returns the value slot (type C<SV*>) stored in the hash entry.
1420 Returns the package name of a stash, or NULL if C<stash> isn't a stash.
1421 See C<SvSTASH>, C<CvSTASH>.
1423 char* HvNAME(HV* stash)
1431 Check that a hash is in an internally consistent state.
1433 void hv_assert(HV* tb)
1441 Clears a hash, making it empty.
1443 void hv_clear(HV* tb)
1448 =item hv_clear_placeholders
1449 X<hv_clear_placeholders>
1451 Clears any placeholders from a hash. If a restricted hash has any of its keys
1452 marked as readonly and the key is subsequently deleted, the key is not actually
1453 deleted but is marked by assigning it a value of &PL_sv_placeholder. This tags
1454 it so it will be ignored by future operations such as iterating over the hash,
1455 but will still allow the hash to have a value reassigned to the key at some
1456 future point. This function clears any such placeholder keys from the hash.
1457 See Hash::Util::lock_keys() for an example of its use.
1459 void hv_clear_placeholders(HV* hb)
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<klen> is the length of the key.
1469 The C<flags> value will normally be zero; if set to G_DISCARD then NULL
1472 SV* hv_delete(HV* tb, const char* key, I32 klen, I32 flags)
1480 Deletes a key/value pair in the hash. The value SV is removed from the
1481 hash and returned to the caller. The C<flags> value will normally be zero;
1482 if set to G_DISCARD then NULL will be returned. C<hash> can be a valid
1483 precomputed hash value, or 0 to ask for it to be computed.
1485 SV* hv_delete_ent(HV* tb, SV* key, I32 flags, U32 hash)
1493 Returns a boolean indicating whether the specified hash key exists. The
1494 C<klen> is the length of the key.
1496 bool hv_exists(HV* tb, const char* key, I32 klen)
1504 Returns a boolean indicating whether the specified hash key exists. C<hash>
1505 can be a valid precomputed hash value, or 0 to ask for it to be
1508 bool hv_exists_ent(HV* tb, SV* key, U32 hash)
1516 Returns the SV which corresponds to the specified key in the hash. The
1517 C<klen> is the length of the key. If C<lval> is set then the fetch will be
1518 part of a store. Check that the return value is non-null before
1519 dereferencing it to an C<SV*>.
1521 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1522 information on how to use this function on tied hashes.
1524 SV** hv_fetch(HV* tb, const char* key, I32 klen, I32 lval)
1532 Returns the hash entry which corresponds to the specified key in the hash.
1533 C<hash> must be a valid precomputed hash number for the given C<key>, or 0
1534 if you want the function to compute it. IF C<lval> is set then the fetch
1535 will be part of a store. Make sure the return value is non-null before
1536 accessing it. The return value when C<tb> is a tied hash is a pointer to a
1537 static location, so be sure to make a copy of the structure if you need to
1540 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1541 information on how to use this function on tied hashes.
1543 HE* hv_fetch_ent(HV* tb, SV* key, I32 lval, U32 hash)
1551 Prepares a starting point to traverse a hash table. Returns the number of
1552 keys in the hash (i.e. the same as C<HvKEYS(tb)>). The return value is
1553 currently only meaningful for hashes without tie magic.
1555 NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
1556 hash buckets that happen to be in use. If you still need that esoteric
1557 value, you can get it through the macro C<HvFILL(tb)>.
1560 I32 hv_iterinit(HV* tb)
1568 Returns the key from the current position of the hash iterator. See
1571 char* hv_iterkey(HE* entry, I32* retlen)
1579 Returns the key as an C<SV*> from the current position of the hash
1580 iterator. The return value will always be a mortal copy of the key. Also
1583 SV* hv_iterkeysv(HE* entry)
1591 Returns entries from a hash iterator. See C<hv_iterinit>.
1593 You may call C<hv_delete> or C<hv_delete_ent> on the hash entry that the
1594 iterator currently points to, without losing your place or invalidating your
1595 iterator. Note that in this case the current entry is deleted from the hash
1596 with your iterator holding the last reference to it. Your iterator is flagged
1597 to free the entry on the next call to C<hv_iternext>, so you must not discard
1598 your iterator immediately else the entry will leak - call C<hv_iternext> to
1599 trigger the resource deallocation.
1601 HE* hv_iternext(HV* tb)
1609 Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
1612 SV* hv_iternextsv(HV* hv, char** key, I32* retlen)
1617 =item hv_iternext_flags
1618 X<hv_iternext_flags>
1620 Returns entries from a hash iterator. See C<hv_iterinit> and C<hv_iternext>.
1621 The C<flags> value will normally be zero; if HV_ITERNEXT_WANTPLACEHOLDERS is
1622 set the placeholders keys (for restricted hashes) will be returned in addition
1623 to normal keys. By default placeholders are automatically skipped over.
1624 Currently a placeholder is implemented with a value that is
1625 C<&Perl_sv_placeholder>. Note that the implementation of placeholders and
1626 restricted hashes may change, and the implementation currently is
1627 insufficiently abstracted for any change to be tidy.
1629 NOTE: this function is experimental and may change or be
1630 removed without notice.
1632 HE* hv_iternext_flags(HV* tb, I32 flags)
1640 Returns the value from the current position of the hash iterator. See
1643 SV* hv_iterval(HV* tb, HE* entry)
1651 Adds magic to a hash. See C<sv_magic>.
1653 void hv_magic(HV* hv, GV* gv, int how)
1661 Evaluates the hash in scalar context and returns the result. Handles magic when the hash is tied.
1663 SV* hv_scalar(HV* hv)
1671 Stores an SV in a hash. The hash key is specified as C<key> and C<klen> is
1672 the length of the key. The C<hash> parameter is the precomputed hash
1673 value; if it is zero then Perl will compute it. The return value will be
1674 NULL if the operation failed or if the value did not need to be actually
1675 stored within the hash (as in the case of tied hashes). Otherwise it can
1676 be dereferenced to get the original C<SV*>. Note that the caller is
1677 responsible for suitably incrementing the reference count of C<val> before
1678 the call, and decrementing it if the function returned NULL. Effectively
1679 a successful hv_store takes ownership of one reference to C<val>. This is
1680 usually what you want; a newly created SV has a reference count of one, so
1681 if all your code does is create SVs then store them in a hash, hv_store
1682 will own the only reference to the new SV, and your code doesn't need to do
1683 anything further to tidy up. hv_store is not implemented as a call to
1684 hv_store_ent, and does not create a temporary SV for the key, so if your
1685 key data is not already in SV form then use hv_store in preference to
1688 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1689 information on how to use this function on tied hashes.
1691 SV** hv_store(HV* tb, const char* key, I32 klen, SV* val, U32 hash)
1699 Stores C<val> in a hash. The hash key is specified as C<key>. The C<hash>
1700 parameter is the precomputed hash value; if it is zero then Perl will
1701 compute it. The return value is the new hash entry so created. It will be
1702 NULL if the operation failed or if the value did not need to be actually
1703 stored within the hash (as in the case of tied hashes). Otherwise the
1704 contents of the return value can be accessed using the C<He?> macros
1705 described here. Note that the caller is responsible for suitably
1706 incrementing the reference count of C<val> before the call, and
1707 decrementing it if the function returned NULL. Effectively a successful
1708 hv_store_ent takes ownership of one reference to C<val>. This is
1709 usually what you want; a newly created SV has a reference count of one, so
1710 if all your code does is create SVs then store them in a hash, hv_store
1711 will own the only reference to the new SV, and your code doesn't need to do
1712 anything further to tidy up. Note that hv_store_ent only reads the C<key>;
1713 unlike C<val> it does not take ownership of it, so maintaining the correct
1714 reference count on C<key> is entirely the caller's responsibility. hv_store
1715 is not implemented as a call to hv_store_ent, and does not create a temporary
1716 SV for the key, so if your key data is not already in SV form then use
1717 hv_store in preference to hv_store_ent.
1719 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1720 information on how to use this function on tied hashes.
1722 HE* hv_store_ent(HV* tb, SV* key, SV* val, U32 hash)
1732 void hv_undef(HV* tb)
1740 Creates a new HV. The reference count is set to 1.
1750 =head1 Magical Functions
1757 Clear something magical that the SV represents. See C<sv_magic>.
1759 int mg_clear(SV* sv)
1767 Copies the magic from one SV to another. See C<sv_magic>.
1769 int mg_copy(SV* sv, SV* nsv, const char* key, I32 klen)
1777 Finds the magic pointer for type matching the SV. See C<sv_magic>.
1779 MAGIC* mg_find(const SV* sv, int type)
1787 Free any magic storage used by the SV. See C<sv_magic>.
1797 Do magic after a value is retrieved from the SV. See C<sv_magic>.
1807 Report on the SV's length. See C<sv_magic>.
1809 U32 mg_length(SV* sv)
1817 Turns on the magical status of an SV. See C<sv_magic>.
1819 void mg_magical(SV* sv)
1827 Do magic after a value is assigned to the SV. See C<sv_magic>.
1837 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
1838 argument more than once.
1840 void SvGETMAGIC(SV* sv)
1848 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
1859 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
1860 argument more than once.
1862 void SvSETMAGIC(SV* sv)
1870 Like C<SvSetSV>, but does any set magic required afterwards.
1872 void SvSetMagicSV(SV* dsb, SV* ssv)
1877 =item SvSetMagicSV_nosteal
1878 X<SvSetMagicSV_nosteal>
1880 Like C<SvSetSV_nosteal>, but does any set magic required afterwards.
1882 void SvSetMagicSV_nosteal(SV* dsv, SV* ssv)
1890 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
1893 void SvSetSV(SV* dsb, SV* ssv)
1898 =item SvSetSV_nosteal
1901 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
1902 ssv. May evaluate arguments more than once.
1904 void SvSetSV_nosteal(SV* dsv, SV* ssv)
1912 Arranges for sv to be shared between threads if a suitable module
1915 void SvSHARE(SV* sv)
1923 Releases a mutual exclusion lock on sv if a suitable module
1926 void SvUNLOCK(SV* sv)
1934 =head1 Memory Management
1941 The XSUB-writer's interface to the C C<memcpy> function. The C<src> is the
1942 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1943 the type. May fail on overlapping copies. See also C<Move>.
1945 void Copy(void* src, void* dest, int nitems, type)
1948 Found in file handy.h
1953 Like C<Copy> but returns dest. Useful for encouraging compilers to tail-call
1956 void * CopyD(void* src, void* dest, int nitems, type)
1959 Found in file handy.h
1964 The XSUB-writer's interface to the C C<memmove> function. The C<src> is the
1965 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1966 the type. Can do overlapping moves. See also C<Copy>.
1968 void Move(void* src, void* dest, int nitems, type)
1971 Found in file handy.h
1976 Like C<Move> but returns dest. Useful for encouraging compilers to tail-call
1979 void * MoveD(void* src, void* dest, int nitems, type)
1982 Found in file handy.h
1987 The XSUB-writer's interface to the C C<malloc> function.
1989 In 5.9.3, Newx() and friends replace the older New() API, and drops
1990 the first parameter, I<x>, a debug aid which allowed callers to identify
1991 themselves. This aid has been superceded by a new build option,
1992 PERL_MEM_LOG (see L<perlhack/PERL_MEM_LOG>). The older API is still
1993 there for use in XS modules supporting older perls.
1995 void Newx(void* ptr, int nitems, type)
1998 Found in file handy.h
2003 The XSUB-writer's interface to the C C<malloc> function, with
2004 cast. See also C<Newx>.
2006 void Newxc(void* ptr, int nitems, type, cast)
2009 Found in file handy.h
2014 The XSUB-writer's interface to the C C<malloc> function. The allocated
2015 memory is zeroed with C<memzero>. See also C<Newx>.
2017 void Newxz(void* ptr, int nitems, type)
2020 Found in file handy.h
2025 Fill up memory with a pattern (byte 0xAB over and over again) that
2026 hopefully catches attempts to access uninitialized memory.
2028 void Poison(void* dest, int nitems, type)
2031 Found in file handy.h
2036 The XSUB-writer's interface to the C C<realloc> function.
2038 void Renew(void* ptr, int nitems, type)
2041 Found in file handy.h
2046 The XSUB-writer's interface to the C C<realloc> function, with
2049 void Renewc(void* ptr, int nitems, type, cast)
2052 Found in file handy.h
2057 The XSUB-writer's interface to the C C<free> function.
2059 void Safefree(void* ptr)
2062 Found in file handy.h
2067 Perl's version of C<strdup()>. Returns a pointer to a newly allocated
2068 string which is a duplicate of C<pv>. The size of the string is
2069 determined by C<strlen()>. The memory allocated for the new string can
2070 be freed with the C<Safefree()> function.
2072 char* savepv(const char* pv)
2075 Found in file util.c
2080 Perl's version of what C<strndup()> would be if it existed. Returns a
2081 pointer to a newly allocated string which is a duplicate of the first
2082 C<len> bytes from C<pv>. The memory allocated for the new string can be
2083 freed with the C<Safefree()> function.
2085 char* savepvn(const char* pv, I32 len)
2088 Found in file util.c
2093 A version of C<savepv()> which allocates the duplicate string in memory
2094 which is shared between threads.
2096 char* savesharedpv(const char* pv)
2099 Found in file util.c
2104 A version of C<savepv()>/C<savepvn()> which gets the string to duplicate from
2105 the passed in SV using C<SvPV()>
2107 char* savesvpv(SV* sv)
2110 Found in file util.c
2115 This is an architecture-independent macro to copy one structure to another.
2117 void StructCopy(type src, type dest, type)
2120 Found in file handy.h
2125 The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the
2126 destination, C<nitems> is the number of items, and C<type> is the type.
2128 void Zero(void* dest, int nitems, type)
2131 Found in file handy.h
2136 Like C<Zero> but returns dest. Useful for encouraging compilers to tail-call
2139 void * ZeroD(void* dest, int nitems, type)
2142 Found in file handy.h
2147 =head1 Miscellaneous Functions
2154 Analyses the string in order to make fast searches on it using fbm_instr()
2155 -- the Boyer-Moore algorithm.
2157 void fbm_compile(SV* sv, U32 flags)
2160 Found in file util.c
2165 Returns the location of the SV in the string delimited by C<str> and
2166 C<strend>. It returns C<Nullch> if the string can't be found. The C<sv>
2167 does not have to be fbm_compiled, but the search will not be as fast
2170 char* fbm_instr(unsigned char* big, unsigned char* bigend, SV* littlesv, U32 flags)
2173 Found in file util.c
2178 Takes a sprintf-style format pattern and conventional
2179 (non-SV) arguments and returns the formatted string.
2181 (char *) Perl_form(pTHX_ const char* pat, ...)
2183 can be used any place a string (char *) is required:
2185 char * s = Perl_form("%d.%d",major,minor);
2187 Uses a single private buffer so if you want to format several strings you
2188 must explicitly copy the earlier strings away (and free the copies when you
2191 char* form(const char* pat, ...)
2194 Found in file util.c
2199 Fill the sv with current working directory
2201 int getcwd_sv(SV* sv)
2204 Found in file util.c
2209 The C library C<sprintf>, wrapped if necessary, to ensure that it will return
2210 the length of the string written to the buffer. Only rare pre-ANSI systems
2211 need the wrapper function - usually this is a direct call to C<sprintf>.
2213 int my_sprintf(char *buffer, const char *pat, ...)
2216 Found in file util.c
2221 Returns a new version object based on the passed in SV:
2223 SV *sv = new_version(SV *ver);
2225 Does not alter the passed in ver SV. See "upg_version" if you
2226 want to upgrade the SV.
2228 SV* new_version(SV *ver)
2231 Found in file util.c
2236 Returns a pointer to the next character after the parsed
2237 version string, as well as upgrading the passed in SV to
2240 Function must be called with an already existing SV like
2243 s = scan_version(s,SV *sv, bool qv);
2245 Performs some preprocessing to the string to ensure that
2246 it has the correct characteristics of a version. Flags the
2247 object if it contains an underscore (which denotes this
2248 is a alpha version). The boolean qv denotes that the version
2249 should be interpreted as if it had multiple decimals, even if
2252 const char* scan_version(const char *vstr, SV *sv, bool qv)
2255 Found in file util.c
2260 Test two strings to see if they are equal. Returns true or false.
2262 bool strEQ(char* s1, char* s2)
2265 Found in file handy.h
2270 Test two strings to see if the first, C<s1>, is greater than or equal to
2271 the second, C<s2>. Returns true or false.
2273 bool strGE(char* s1, char* s2)
2276 Found in file handy.h
2281 Test two strings to see if the first, C<s1>, is greater than the second,
2282 C<s2>. Returns true or false.
2284 bool strGT(char* s1, char* s2)
2287 Found in file handy.h
2292 Test two strings to see if the first, C<s1>, is less than or equal to the
2293 second, C<s2>. Returns true or false.
2295 bool strLE(char* s1, char* s2)
2298 Found in file handy.h
2303 Test two strings to see if the first, C<s1>, is less than the second,
2304 C<s2>. Returns true or false.
2306 bool strLT(char* s1, char* s2)
2309 Found in file handy.h
2314 Test two strings to see if they are different. Returns true or
2317 bool strNE(char* s1, char* s2)
2320 Found in file handy.h
2325 Test two strings to see if they are equal. The C<len> parameter indicates
2326 the number of bytes to compare. Returns true or false. (A wrapper for
2329 bool strnEQ(char* s1, char* s2, STRLEN len)
2332 Found in file handy.h
2337 Test two strings to see if they are different. The C<len> parameter
2338 indicates the number of bytes to compare. Returns true or false. (A
2339 wrapper for C<strncmp>).
2341 bool strnNE(char* s1, char* s2, STRLEN len)
2344 Found in file handy.h
2349 Dummy routine which "shares" an SV when there is no sharing module present.
2350 Or "locks" it. Or "unlocks" it. In other words, ignores its single SV argument.
2351 Exists to avoid test for a NULL function pointer and because it could
2352 potentially warn under some level of strict-ness.
2354 void sv_nosharing(SV *sv)
2357 Found in file util.c
2362 In-place upgrade of the supplied SV to a version object.
2364 SV *sv = upg_version(SV *sv);
2366 Returns a pointer to the upgraded SV.
2368 SV* upg_version(SV *ver)
2371 Found in file util.c
2376 Version object aware cmp. Both operands must already have been
2377 converted into version objects.
2379 int vcmp(SV *lvs, SV *rvs)
2382 Found in file util.c
2387 Accepts a version object and returns the normalized string
2388 representation. Call like:
2392 NOTE: you can pass either the object directly or the SV
2393 contained within the RV.
2398 Found in file util.c
2403 Accepts a version object and returns the normalized floating
2404 point representation. Call like:
2408 NOTE: you can pass either the object directly or the SV
2409 contained within the RV.
2414 Found in file util.c
2419 In order to maintain maximum compatibility with earlier versions
2420 of Perl, this function will return either the floating point
2421 notation or the multiple dotted notation, depending on whether
2422 the original version contained 1 or more dots, respectively
2424 SV* vstringify(SV *vs)
2427 Found in file util.c
2432 Validates that the SV contains a valid version object.
2434 bool vverify(SV *vobj);
2436 Note that it only confirms the bare minimum structure (so as not to get
2437 confused by derived classes which may contain additional hash entries):
2439 bool vverify(SV *vs)
2442 Found in file util.c
2447 =head1 Multicall Functions
2454 Declare local variables for a multicall. See L<perlcall/Lightweight Callbacks>.
2464 Make a lightweight callback. See L<perlcall/Lightweight Callbacks>.
2474 Closing bracket for a lightweight callback.
2475 See L<perlcall/Lightweight Callbacks>.
2482 =item PUSH_MULTICALL
2485 Opening bracket for a lightweight callback.
2486 See L<perlcall/Lightweight Callbacks>.
2496 =head1 Numeric functions
2503 converts a string representing a binary number to numeric form.
2505 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2506 conversion flags, and I<result> should be NULL or a pointer to an NV.
2507 The scan stops at the end of the string, or the first invalid character.
2508 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2509 invalid character will also trigger a warning.
2510 On return I<*len> is set to the length of the scanned string,
2511 and I<*flags> gives output flags.
2513 If the value is <= C<UV_MAX> it is returned as a UV, the output flags are clear,
2514 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_bin>
2515 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2516 and writes the value to I<*result> (or the value is discarded if I<result>
2519 The binary number may optionally be prefixed with "0b" or "b" unless
2520 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
2521 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the binary
2522 number may use '_' characters to separate digits.
2524 UV grok_bin(const char* start, STRLEN* len_p, I32* flags, NV *result)
2527 Found in file numeric.c
2532 converts a string representing a hex number to numeric form.
2534 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2535 conversion flags, and I<result> should be NULL or a pointer to an NV.
2536 The scan stops at the end of the string, or the first invalid character.
2537 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2538 invalid character will also trigger a warning.
2539 On return I<*len> is set to the length of the scanned string,
2540 and I<*flags> gives output flags.
2542 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2543 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_hex>
2544 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2545 and writes the value to I<*result> (or the value is discarded if I<result>
2548 The hex number may optionally be prefixed with "0x" or "x" unless
2549 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
2550 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the hex
2551 number may use '_' characters to separate digits.
2553 UV grok_hex(const char* start, STRLEN* len_p, I32* flags, NV *result)
2556 Found in file numeric.c
2561 Recognise (or not) a number. The type of the number is returned
2562 (0 if unrecognised), otherwise it is a bit-ORed combination of
2563 IS_NUMBER_IN_UV, IS_NUMBER_GREATER_THAN_UV_MAX, IS_NUMBER_NOT_INT,
2564 IS_NUMBER_NEG, IS_NUMBER_INFINITY, IS_NUMBER_NAN (defined in perl.h).
2566 If the value of the number can fit an in UV, it is returned in the *valuep
2567 IS_NUMBER_IN_UV will be set to indicate that *valuep is valid, IS_NUMBER_IN_UV
2568 will never be set unless *valuep is valid, but *valuep may have been assigned
2569 to during processing even though IS_NUMBER_IN_UV is not set on return.
2570 If valuep is NULL, IS_NUMBER_IN_UV will be set for the same cases as when
2571 valuep is non-NULL, but no actual assignment (or SEGV) will occur.
2573 IS_NUMBER_NOT_INT will be set with IS_NUMBER_IN_UV if trailing decimals were
2574 seen (in which case *valuep gives the true value truncated to an integer), and
2575 IS_NUMBER_NEG if the number is negative (in which case *valuep holds the
2576 absolute value). IS_NUMBER_IN_UV is not set if e notation was used or the
2577 number is larger than a UV.
2579 int grok_number(const char *pv, STRLEN len, UV *valuep)
2582 Found in file numeric.c
2584 =item grok_numeric_radix
2585 X<grok_numeric_radix>
2587 Scan and skip for a numeric decimal separator (radix).
2589 bool grok_numeric_radix(const char **sp, const char *send)
2592 Found in file numeric.c
2597 converts a string representing an octal number to numeric form.
2599 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2600 conversion flags, and I<result> should be NULL or a pointer to an NV.
2601 The scan stops at the end of the string, or the first invalid character.
2602 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2603 invalid character will also trigger a warning.
2604 On return I<*len> is set to the length of the scanned string,
2605 and I<*flags> gives output flags.
2607 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2608 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_oct>
2609 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2610 and writes the value to I<*result> (or the value is discarded if I<result>
2613 If C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the octal
2614 number may use '_' characters to separate digits.
2616 UV grok_oct(const char* start, STRLEN* len_p, I32* flags, NV *result)
2619 Found in file numeric.c
2624 For backwards compatibility. Use C<grok_bin> instead.
2626 NV scan_bin(const char* start, STRLEN len, STRLEN* retlen)
2629 Found in file numeric.c
2634 For backwards compatibility. Use C<grok_hex> instead.
2636 NV scan_hex(const char* start, STRLEN len, STRLEN* retlen)
2639 Found in file numeric.c
2644 For backwards compatibility. Use C<grok_oct> instead.
2646 NV scan_oct(const char* start, STRLEN len, STRLEN* retlen)
2649 Found in file numeric.c
2654 =head1 Optree Manipulation Functions
2661 If C<cv> is a constant sub eligible for inlining. returns the constant
2662 value returned by the sub. Otherwise, returns NULL.
2664 Constant subs can be created with C<newCONSTSUB> or as described in
2665 L<perlsub/"Constant Functions">.
2667 SV* cv_const_sv(CV* cv)
2675 Creates a constant sub equivalent to Perl C<sub FOO () { 123 }> which is
2676 eligible for inlining at compile-time.
2678 CV* newCONSTSUB(HV* stash, const char* name, SV* sv)
2686 Used by C<xsubpp> to hook up XSUBs as Perl subs.
2694 =head1 Pad Data Structures
2701 Get the value at offset po in the current pad.
2702 Use macro PAD_SV instead of calling this function directly.
2704 SV* pad_sv(PADOFFSET po)
2712 =head1 Simple Exception Handling Macros
2719 Set up necessary local variables for exception handling.
2720 See L<perlguts/"Exception Handling">.
2725 Found in file XSUB.h
2730 Introduces a catch block. See L<perlguts/"Exception Handling">.
2733 Found in file XSUB.h
2738 Rethrows a previously caught exception. See L<perlguts/"Exception Handling">.
2743 Found in file XSUB.h
2748 Ends a try block. See L<perlguts/"Exception Handling">.
2751 Found in file XSUB.h
2753 =item XCPT_TRY_START
2756 Starts a try block. See L<perlguts/"Exception Handling">.
2759 Found in file XSUB.h
2764 =head1 Stack Manipulation Macros
2771 Declare a stack marker variable, C<mark>, for the XSUB. See C<MARK> and
2782 Saves the original stack mark for the XSUB. See C<ORIGMARK>.
2792 Declares a local copy of perl's stack pointer for the XSUB, available via
2793 the C<SP> macro. See C<SP>.
2803 Used to extend the argument stack for an XSUB's return values. Once
2804 used, guarantees that there is room for at least C<nitems> to be pushed
2807 void EXTEND(SP, int nitems)
2815 Stack marker variable for the XSUB. See C<dMARK>.
2823 Push an integer onto the stack. The stack must have room for this element.
2824 Handles 'set' magic. Does not use C<TARG>. See also C<PUSHi>, C<mXPUSHi>
2835 Push a double onto the stack. The stack must have room for this element.
2836 Handles 'set' magic. Does not use C<TARG>. See also C<PUSHn>, C<mXPUSHn>
2847 Push a string onto the stack. The stack must have room for this element.
2848 The C<len> indicates the length of the string. Handles 'set' magic. Does
2849 not use C<TARG>. See also C<PUSHp>, C<mXPUSHp> and C<XPUSHp>.
2851 void mPUSHp(char* str, STRLEN len)
2859 Push an unsigned integer onto the stack. The stack must have room for this
2860 element. Handles 'set' magic. Does not use C<TARG>. See also C<PUSHu>,
2861 C<mXPUSHu> and C<XPUSHu>.
2871 Push an integer onto the stack, extending the stack if necessary. Handles
2872 'set' magic. Does not use C<TARG>. See also C<XPUSHi>, C<mPUSHi> and
2883 Push a double onto the stack, extending the stack if necessary. Handles
2884 'set' magic. Does not use C<TARG>. See also C<XPUSHn>, C<mPUSHn> and
2895 Push a string onto the stack, extending the stack if necessary. The C<len>
2896 indicates the length of the string. Handles 'set' magic. Does not use
2897 C<TARG>. See also C<XPUSHp>, C<mPUSHp> and C<PUSHp>.
2899 void mXPUSHp(char* str, STRLEN len)
2907 Push an unsigned integer onto the stack, extending the stack if necessary.
2908 Handles 'set' magic. Does not use C<TARG>. See also C<XPUSHu>, C<mPUSHu>
2919 The original stack mark for the XSUB. See C<dORIGMARK>.
2927 Pops an integer off the stack.
2937 Pops a long off the stack.
2947 Pops a double off the stack.
2957 Pops a string off the stack. Deprecated. New code should use POPpx.
2967 Pops a string off the stack which must consist of bytes i.e. characters < 256.
2977 Pops a string off the stack.
2987 Pops an SV off the stack.
2997 Push an integer onto the stack. The stack must have room for this element.
2998 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
2999 called to declare it. Do not call multiple C<TARG>-oriented macros to
3000 return lists from XSUB's - see C<mPUSHi> instead. See also C<XPUSHi> and
3011 Opening bracket for arguments on a callback. See C<PUTBACK> and
3022 Push a new mortal SV onto the stack. The stack must have room for this
3023 element. Does not handle 'set' magic. Does not use C<TARG>. See also
3024 C<PUSHs>, C<XPUSHmortal> and C<XPUSHs>.
3034 Push a double onto the stack. The stack must have room for this element.
3035 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3036 called to declare it. Do not call multiple C<TARG>-oriented macros to
3037 return lists from XSUB's - see C<mPUSHn> instead. See also C<XPUSHn> and
3048 Push a string onto the stack. The stack must have room for this element.
3049 The C<len> indicates the length of the string. Handles 'set' magic. Uses
3050 C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to declare it. Do not
3051 call multiple C<TARG>-oriented macros to return lists from XSUB's - see
3052 C<mPUSHp> instead. See also C<XPUSHp> and C<mXPUSHp>.
3054 void PUSHp(char* str, STRLEN len)
3062 Push an SV onto the stack. The stack must have room for this element.
3063 Does not handle 'set' magic. Does not use C<TARG>. See also C<PUSHmortal>,
3064 C<XPUSHs> and C<XPUSHmortal>.
3074 Push an unsigned integer onto the stack. The stack must have room for this
3075 element. Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG>
3076 should be called to declare it. Do not call multiple C<TARG>-oriented
3077 macros to return lists from XSUB's - see C<mPUSHu> instead. See also
3078 C<XPUSHu> and C<mXPUSHu>.
3088 Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
3089 See C<PUSHMARK> and L<perlcall> for other uses.
3099 Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and
3108 Refetch the stack pointer. Used after a callback. See L<perlcall>.
3118 Push an integer onto the stack, extending the stack if necessary. Handles
3119 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
3120 declare it. Do not call multiple C<TARG>-oriented macros to return lists
3121 from XSUB's - see C<mXPUSHi> instead. See also C<PUSHi> and C<mPUSHi>.
3131 Push a new mortal SV onto the stack, extending the stack if necessary. Does
3132 not handle 'set' magic. Does not use C<TARG>. See also C<XPUSHs>,
3133 C<PUSHmortal> and C<PUSHs>.
3143 Push a double onto the stack, extending the stack if necessary. Handles
3144 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
3145 declare it. Do not call multiple C<TARG>-oriented macros to return lists
3146 from XSUB's - see C<mXPUSHn> instead. See also C<PUSHn> and C<mPUSHn>.
3156 Push a string onto the stack, extending the stack if necessary. The C<len>
3157 indicates the length of the string. Handles 'set' magic. Uses C<TARG>, so
3158 C<dTARGET> or C<dXSTARG> should be called to declare it. Do not call
3159 multiple C<TARG>-oriented macros to return lists from XSUB's - see
3160 C<mXPUSHp> instead. See also C<PUSHp> and C<mPUSHp>.
3162 void XPUSHp(char* str, STRLEN len)
3170 Push an SV onto the stack, extending the stack if necessary. Does not
3171 handle 'set' magic. Does not use C<TARG>. See also C<XPUSHmortal>,
3172 C<PUSHs> and C<PUSHmortal>.
3182 Push an unsigned integer onto the stack, extending the stack if necessary.
3183 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3184 called to declare it. Do not call multiple C<TARG>-oriented macros to
3185 return lists from XSUB's - see C<mXPUSHu> instead. See also C<PUSHu> and
3196 Return from XSUB, indicating number of items on the stack. This is usually
3197 handled by C<xsubpp>.
3199 void XSRETURN(int nitems)
3202 Found in file XSUB.h
3204 =item XSRETURN_EMPTY
3207 Return an empty list from an XSUB immediately.
3212 Found in file XSUB.h
3217 Return an integer from an XSUB immediately. Uses C<XST_mIV>.
3219 void XSRETURN_IV(IV iv)
3222 Found in file XSUB.h
3227 Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
3232 Found in file XSUB.h
3237 Return a double from an XSUB immediately. Uses C<XST_mNV>.
3239 void XSRETURN_NV(NV nv)
3242 Found in file XSUB.h
3247 Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
3249 void XSRETURN_PV(char* str)
3252 Found in file XSUB.h
3254 =item XSRETURN_UNDEF
3257 Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
3262 Found in file XSUB.h
3267 Return an integer from an XSUB immediately. Uses C<XST_mUV>.
3269 void XSRETURN_UV(IV uv)
3272 Found in file XSUB.h
3277 Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
3282 Found in file XSUB.h
3287 Place an integer into the specified position C<pos> on the stack. The
3288 value is stored in a new mortal SV.
3290 void XST_mIV(int pos, IV iv)
3293 Found in file XSUB.h
3298 Place C<&PL_sv_no> into the specified position C<pos> on the
3301 void XST_mNO(int pos)
3304 Found in file XSUB.h
3309 Place a double into the specified position C<pos> on the stack. The value
3310 is stored in a new mortal SV.
3312 void XST_mNV(int pos, NV nv)
3315 Found in file XSUB.h
3320 Place a copy of a string into the specified position C<pos> on the stack.
3321 The value is stored in a new mortal SV.
3323 void XST_mPV(int pos, char* str)
3326 Found in file XSUB.h
3331 Place C<&PL_sv_undef> into the specified position C<pos> on the
3334 void XST_mUNDEF(int pos)
3337 Found in file XSUB.h
3342 Place C<&PL_sv_yes> into the specified position C<pos> on the
3345 void XST_mYES(int pos)
3348 Found in file XSUB.h
3360 An enum of flags for Perl types. These are found in the file B<sv.h>
3361 in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
3369 Integer type flag for scalars. See C<svtype>.
3377 Double type flag for scalars. See C<svtype>.
3385 Pointer type flag for scalars. See C<svtype>.
3393 Type flag for arrays. See C<svtype>.
3401 Type flag for code refs. See C<svtype>.
3409 Type flag for hashes. See C<svtype>.
3417 Type flag for blessed scalars. See C<svtype>.
3425 =head1 SV Manipulation Functions
3432 Returns the SV of the specified Perl scalar. If C<create> is set and the
3433 Perl variable does not exist then it will be created. If C<create> is not
3434 set and the variable does not exist then NULL is returned.
3436 NOTE: the perl_ form of this function is deprecated.
3438 SV* get_sv(const char* name, I32 create)
3441 Found in file perl.c
3443 =item looks_like_number
3444 X<looks_like_number>
3446 Test if the content of an SV looks like a number (or is a number).
3447 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
3448 non-numeric warning), even if your atof() doesn't grok them.
3450 I32 looks_like_number(SV* sv)
3458 Creates an RV wrapper for an SV. The reference count for the original SV is
3461 SV* newRV_inc(SV* sv)
3469 Creates an RV wrapper for an SV. The reference count for the original
3470 SV is B<not> incremented.
3472 SV* newRV_noinc(SV *sv)
3480 Creates a new SV. A non-zero C<len> parameter indicates the number of
3481 bytes of preallocated string space the SV should have. An extra byte for a
3482 tailing NUL is also reserved. (SvPOK is not set for the SV even if string
3483 space is allocated.) The reference count for the new SV is set to 1.
3484 C<id> is an integer id between 0 and 1299 (used to identify leaks).
3486 SV* NEWSV(int id, STRLEN len)
3489 Found in file handy.h
3494 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
3495 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
3498 SV* newSV(STRLEN len)
3506 Creates a new SV from the hash key structure. It will generate scalars that
3507 point to the shared string table where possible. Returns a new (undefined)
3508 SV if the hek is NULL.
3510 SV* newSVhek(const HEK *hek)
3518 Creates a new SV and copies an integer into it. The reference count for the
3529 Creates a new SV and copies a floating point value into it.
3530 The reference count for the SV is set to 1.
3540 Creates a new SV and copies a string into it. The reference count for the
3541 SV is set to 1. If C<len> is zero, Perl will compute the length using
3542 strlen(). For efficiency, consider using C<newSVpvn> instead.
3544 SV* newSVpv(const char* s, STRLEN len)
3552 Creates a new SV and initializes it with the string formatted like
3555 SV* newSVpvf(const char* pat, ...)
3563 Creates a new SV and copies a string into it. The reference count for the
3564 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
3565 string. You are responsible for ensuring that the source string is at least
3566 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
3568 SV* newSVpvn(const char* s, STRLEN len)
3573 =item newSVpvn_share
3576 Creates a new SV with its SvPVX_const pointing to a shared string in the string
3577 table. If the string does not already exist in the table, it is created
3578 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
3579 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
3580 otherwise the hash is computed. The idea here is that as the string table
3581 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
3582 hash lookup will avoid string compare.
3584 SV* newSVpvn_share(const char* s, I32 len, U32 hash)
3592 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
3593 it will be upgraded to one. If C<classname> is non-null then the new SV will
3594 be blessed in the specified package. The new SV is returned and its
3595 reference count is 1.
3597 SV* newSVrv(SV* rv, const char* classname)
3605 Creates a new SV which is an exact duplicate of the original SV.
3608 SV* newSVsv(SV* old)
3616 Creates a new SV and copies an unsigned integer into it.
3617 The reference count for the SV is set to 1.
3627 Returns the length of the string which is in the SV. See C<SvLEN>.
3629 STRLEN SvCUR(SV* sv)
3637 Set the current length of the string which is in the SV. See C<SvCUR>
3640 void SvCUR_set(SV* sv, STRLEN len)
3648 Returns a pointer to the last character in the string which is in the SV.
3649 See C<SvCUR>. Access the character as *(SvEND(sv)).
3659 Expands the character buffer in the SV so that it has room for the
3660 indicated number of bytes (remember to reserve space for an extra trailing
3661 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
3662 Returns a pointer to the character buffer.
3664 char * SvGROW(SV* sv, STRLEN len)
3672 Returns a boolean indicating whether the SV contains an integer.
3682 Returns a boolean indicating whether the SV contains an integer. Checks
3683 the B<private> setting. Use C<SvIOK>.
3693 Returns a boolean indicating whether the SV contains a signed integer.
3695 bool SvIOK_notUV(SV* sv)
3703 Unsets the IV status of an SV.
3705 void SvIOK_off(SV* sv)
3713 Tells an SV that it is an integer.
3715 void SvIOK_on(SV* sv)
3723 Tells an SV that it is an integer and disables all other OK bits.
3725 void SvIOK_only(SV* sv)
3733 Tells and SV that it is an unsigned integer and disables all other OK bits.
3735 void SvIOK_only_UV(SV* sv)
3743 Returns a boolean indicating whether the SV contains an unsigned integer.
3745 bool SvIOK_UV(SV* sv)
3753 Returns a boolean indicating whether the SV is Copy-On-Write. (either shared
3754 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
3757 bool SvIsCOW(SV* sv)
3762 =item SvIsCOW_shared_hash
3763 X<SvIsCOW_shared_hash>
3765 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
3768 bool SvIsCOW_shared_hash(SV* sv)
3776 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
3777 version which guarantees to evaluate sv only once.
3787 Returns the raw value in the SV's IV slot, without checks or conversions.
3788 Only use when you are sure SvIOK is true. See also C<SvIV()>.
3798 Coerces the given SV to an integer and returns it. Guarantees to evaluate
3799 sv only once. Use the more efficient C<SvIV> otherwise.
3809 Like C<SvIV> but doesn't process magic.
3811 IV SvIV_nomg(SV* sv)
3819 Set the value of the IV pointer in sv to val. It is possible to perform
3820 the same function of this macro with an lvalue assignment to C<SvIVX>.
3821 With future Perls, however, it will be more efficient to use
3822 C<SvIV_set> instead of the lvalue assignment to C<SvIVX>.
3824 void SvIV_set(SV* sv, IV val)
3832 Returns the size of the string buffer in the SV, not including any part
3833 attributable to C<SvOOK>. See C<SvCUR>.
3835 STRLEN SvLEN(SV* sv)
3843 Set the actual length of the string which is in the SV. See C<SvIV_set>.
3845 void SvLEN_set(SV* sv, STRLEN len)
3853 Set the value of the MAGIC pointer in sv to val. See C<SvIV_set>.
3855 void SvMAGIC_set(SV* sv, MAGIC* val)
3863 Returns a boolean indicating whether the SV contains a number, integer or
3874 Returns a boolean indicating whether the SV contains a number, integer or
3875 double. Checks the B<private> setting. Use C<SvNIOK>.
3877 bool SvNIOKp(SV* sv)
3885 Unsets the NV/IV status of an SV.
3887 void SvNIOK_off(SV* sv)
3895 Returns a boolean indicating whether the SV contains a double.
3905 Returns a boolean indicating whether the SV contains a double. Checks the
3906 B<private> setting. Use C<SvNOK>.
3916 Unsets the NV status of an SV.
3918 void SvNOK_off(SV* sv)
3926 Tells an SV that it is a double.
3928 void SvNOK_on(SV* sv)
3936 Tells an SV that it is a double and disables all other OK bits.
3938 void SvNOK_only(SV* sv)
3946 Coerce the given SV to a double and return it. See C<SvNVx> for a version
3947 which guarantees to evaluate sv only once.
3957 Returns the raw value in the SV's NV slot, without checks or conversions.
3958 Only use when you are sure SvNOK is true. See also C<SvNV()>.
3968 Coerces the given SV to a double and returns it. Guarantees to evaluate
3969 sv only once. Use the more efficient C<SvNV> otherwise.
3979 Set the value of the NV pointer in sv to val. See C<SvIV_set>.
3981 void SvNV_set(SV* sv, NV val)
3989 Returns a boolean indicating whether the value is an SV. It also tells
3990 whether the value is defined or not.
4000 Returns a boolean indicating whether the SvIVX is a valid offset value for
4001 the SvPVX. This hack is used internally to speed up removal of characters
4002 from the beginning of a SvPV. When SvOOK is true, then the start of the
4003 allocated string buffer is really (SvPVX - SvIVX).
4013 Returns a boolean indicating whether the SV contains a character
4024 Returns a boolean indicating whether the SV contains a character string.
4025 Checks the B<private> setting. Use C<SvPOK>.
4035 Unsets the PV status of an SV.
4037 void SvPOK_off(SV* sv)
4045 Tells an SV that it is a string.
4047 void SvPOK_on(SV* sv)
4055 Tells an SV that it is a string and disables all other OK bits.
4056 Will also turn off the UTF-8 status.
4058 void SvPOK_only(SV* sv)
4063 =item SvPOK_only_UTF8
4066 Tells an SV that it is a string and disables all other OK bits,
4067 and leaves the UTF-8 status as it was.
4069 void SvPOK_only_UTF8(SV* sv)
4077 Returns a pointer to the string in the SV, or a stringified form of
4078 the SV if the SV does not contain a string. The SV may cache the
4079 stringified version becoming C<SvPOK>. Handles 'get' magic. See also
4080 C<SvPVx> for a version which guarantees to evaluate sv only once.
4082 char* SvPV(SV* sv, STRLEN len)
4090 Like C<SvPV>, but converts sv to byte representation first if necessary.
4092 char* SvPVbyte(SV* sv, STRLEN len)
4100 Like C<SvPV>, but converts sv to byte representation first if necessary.
4101 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
4104 char* SvPVbytex(SV* sv, STRLEN len)
4109 =item SvPVbytex_force
4112 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
4113 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
4116 char* SvPVbytex_force(SV* sv, STRLEN len)
4121 =item SvPVbyte_force
4124 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
4126 char* SvPVbyte_force(SV* sv, STRLEN len)
4131 =item SvPVbyte_nolen
4134 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
4136 char* SvPVbyte_nolen(SV* sv)
4144 Like C<SvPV>, but converts sv to utf8 first if necessary.
4146 char* SvPVutf8(SV* sv, STRLEN len)
4154 Like C<SvPV>, but converts sv to utf8 first if necessary.
4155 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
4158 char* SvPVutf8x(SV* sv, STRLEN len)
4163 =item SvPVutf8x_force
4166 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
4167 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
4170 char* SvPVutf8x_force(SV* sv, STRLEN len)
4175 =item SvPVutf8_force
4178 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
4180 char* SvPVutf8_force(SV* sv, STRLEN len)
4185 =item SvPVutf8_nolen
4188 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
4190 char* SvPVutf8_nolen(SV* sv)
4198 Returns a pointer to the physical string in the SV. The SV must contain a
4209 A version of C<SvPV> which guarantees to evaluate sv only once.
4211 char* SvPVx(SV* sv, STRLEN len)
4219 Like C<SvPV> but will force the SV into containing just a string
4220 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
4223 char* SvPV_force(SV* sv, STRLEN len)
4228 =item SvPV_force_nomg
4231 Like C<SvPV> but will force the SV into containing just a string
4232 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
4233 directly. Doesn't process magic.
4235 char* SvPV_force_nomg(SV* sv, STRLEN len)
4243 Returns a pointer to the string in the SV, or a stringified form of
4244 the SV if the SV does not contain a string. The SV may cache the
4245 stringified form becoming C<SvPOK>. Handles 'get' magic.
4247 char* SvPV_nolen(SV* sv)
4255 Like C<SvPV> but doesn't process magic.
4257 char* SvPV_nomg(SV* sv, STRLEN len)
4265 Set the value of the PV pointer in sv to val. See C<SvIV_set>.
4267 void SvPV_set(SV* sv, char* val)
4275 Returns the value of the object's reference count.
4277 U32 SvREFCNT(SV* sv)
4285 Decrements the reference count of the given SV.
4287 void SvREFCNT_dec(SV* sv)
4295 Increments the reference count of the given SV.
4297 SV* SvREFCNT_inc(SV* sv)
4305 Tests if the SV is an RV.
4315 Unsets the RV status of an SV.
4317 void SvROK_off(SV* sv)
4325 Tells an SV that it is an RV.
4327 void SvROK_on(SV* sv)
4335 Dereferences an RV to return the SV.
4345 Set the value of the RV pointer in sv to val. See C<SvIV_set>.
4347 void SvRV_set(SV* sv, SV* val)
4355 Returns the stash of the SV.
4365 Set the value of the STASH pointer in sv to val. See C<SvIV_set>.
4367 void SvSTASH_set(SV* sv, STASH* val)
4375 Taints an SV if tainting is enabled.
4377 void SvTAINT(SV* sv)
4385 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
4388 bool SvTAINTED(SV* sv)
4396 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
4397 some of Perl's fundamental security features. XS module authors should not
4398 use this function unless they fully understand all the implications of
4399 unconditionally untainting the value. Untainting should be done in the
4400 standard perl fashion, via a carefully crafted regexp, rather than directly
4401 untainting variables.
4403 void SvTAINTED_off(SV* sv)
4411 Marks an SV as tainted if tainting is enabled.
4413 void SvTAINTED_on(SV* sv)
4421 Returns a boolean indicating whether Perl would evaluate the SV as true or
4422 false, defined or undefined. Does not handle 'get' magic.
4432 Returns the type of the SV. See C<svtype>.
4434 svtype SvTYPE(SV* sv)
4442 Returns a boolean indicating whether the SV contains an unsigned integer.
4452 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
4453 perform the upgrade if necessary. See C<svtype>.
4455 void SvUPGRADE(SV* sv, svtype type)
4463 Returns a boolean indicating whether the SV contains UTF-8 encoded data.
4473 Unsets the UTF-8 status of an SV.
4475 void SvUTF8_off(SV *sv)
4483 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
4484 Do not use frivolously.
4486 void SvUTF8_on(SV *sv)
4494 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
4495 for a version which guarantees to evaluate sv only once.
4505 Returns the raw value in the SV's UV slot, without checks or conversions.
4506 Only use when you are sure SvIOK is true. See also C<SvUV()>.
4516 Coerces the given SV to an unsigned integer and returns it. Guarantees to
4517 evaluate sv only once. Use the more efficient C<SvUV> otherwise.
4527 Like C<SvUV> but doesn't process magic.
4529 UV SvUV_nomg(SV* sv)
4537 Set the value of the UV pointer in sv to val. See C<SvIV_set>.
4539 void SvUV_set(SV* sv, UV val)
4547 Returns a boolean indicating whether the SV contains a v-string.
4557 This function is only called on magical items, and is only used by
4558 sv_true() or its macro equivalent.
4560 bool sv_2bool(SV* sv)
4568 Using various gambits, try to get a CV from an SV; in addition, try if
4569 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
4570 The flags in C<lref> are passed to sv_fetchsv.
4572 CV* sv_2cv(SV* sv, HV** st, GV** gvp, I32 lref)
4580 Using various gambits, try to get an IO from an SV: the IO slot if its a
4581 GV; or the recursive result if we're an RV; or the IO slot of the symbol
4582 named after the PV if we're a string.
4592 Return the integer value of an SV, doing any necessary string
4593 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
4594 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
4596 IV sv_2iv_flags(SV* sv, I32 flags)
4604 Marks an existing SV as mortal. The SV will be destroyed "soon", either
4605 by an explicit call to FREETMPS, or by an implicit call at places such as
4606 statement boundaries. SvTEMP() is turned on which means that the SV's
4607 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
4608 and C<sv_mortalcopy>.
4610 SV* sv_2mortal(SV* sv)
4618 Return the num value of an SV, doing any necessary string or integer
4619 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
4630 Return a pointer to the byte-encoded representation of the SV, and set *lp
4631 to its length. May cause the SV to be downgraded from UTF-8 as a
4634 Usually accessed via the C<SvPVbyte> macro.
4636 char* sv_2pvbyte(SV* sv, STRLEN* lp)
4644 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
4645 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
4647 Usually accessed via the C<SvPVutf8> macro.
4649 char* sv_2pvutf8(SV* sv, STRLEN* lp)
4657 Returns a pointer to the string value of an SV, and sets *lp to its length.
4658 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
4660 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
4661 usually end up here too.
4663 char* sv_2pv_flags(SV* sv, STRLEN* lp, I32 flags)
4671 Return the unsigned integer value of an SV, doing any necessary string
4672 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
4673 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
4675 UV sv_2uv_flags(SV* sv, I32 flags)
4683 Remove any string offset. You should normally use the C<SvOOK_off> macro
4686 int sv_backoff(SV* sv)
4694 Blesses an SV into a specified package. The SV must be an RV. The package
4695 must be designated by its stash (see C<gv_stashpv()>). The reference count
4696 of the SV is unaffected.
4698 SV* sv_bless(SV* sv, HV* stash)
4706 Concatenates the string onto the end of the string which is in the SV.
4707 If the SV has the UTF-8 status set, then the bytes appended should be
4708 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4710 void sv_catpv(SV* sv, const char* ptr)
4718 Processes its arguments like C<sprintf> and appends the formatted
4719 output to an SV. If the appended data contains "wide" characters
4720 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
4721 and characters >255 formatted with %c), the original SV might get
4722 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
4723 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
4724 valid UTF-8; if the original SV was bytes, the pattern should be too.
4726 void sv_catpvf(SV* sv, const char* pat, ...)
4734 Like C<sv_catpvf>, but also handles 'set' magic.
4736 void sv_catpvf_mg(SV *sv, const char* pat, ...)
4744 Concatenates the string onto the end of the string which is in the SV. The
4745 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4746 status set, then the bytes appended should be valid UTF-8.
4747 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4749 void sv_catpvn(SV* sv, const char* ptr, STRLEN len)
4754 =item sv_catpvn_flags
4757 Concatenates the string onto the end of the string which is in the SV. The
4758 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4759 status set, then the bytes appended should be valid UTF-8.
4760 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4761 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4762 in terms of this function.
4764 void sv_catpvn_flags(SV* sv, const char* ptr, STRLEN len, I32 flags)
4769 =item sv_catpvn_nomg
4772 Like C<sv_catpvn> but doesn't process magic.
4774 void sv_catpvn_nomg(SV* sv, const char* ptr, STRLEN len)
4782 Like C<sv_catpv>, but also handles 'set' magic.
4784 void sv_catpv_mg(SV *sv, const char *ptr)
4792 Concatenates the string from SV C<ssv> onto the end of the string in
4793 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4794 not 'set' magic. See C<sv_catsv_mg>.
4796 void sv_catsv(SV* dsv, SV* ssv)
4801 =item sv_catsv_flags
4804 Concatenates the string from SV C<ssv> onto the end of the string in
4805 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4806 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4807 and C<sv_catsv_nomg> are implemented in terms of this function.
4809 void sv_catsv_flags(SV* dsv, SV* ssv, I32 flags)
4817 Like C<sv_catsv> but doesn't process magic.
4819 void sv_catsv_nomg(SV* dsv, SV* ssv)
4827 Efficient removal of characters from the beginning of the string buffer.
4828 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4829 the string buffer. The C<ptr> becomes the first character of the adjusted
4830 string. Uses the "OOK hack".
4831 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4832 refer to the same chunk of data.
4834 void sv_chop(SV* sv, const char* ptr)
4842 Clear an SV: call any destructors, free up any memory used by the body,
4843 and free the body itself. The SV's head is I<not> freed, although
4844 its type is set to all 1's so that it won't inadvertently be assumed
4845 to be live during global destruction etc.
4846 This function should only be called when REFCNT is zero. Most of the time
4847 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
4850 void sv_clear(SV* sv)
4858 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
4859 string in C<sv1> is less than, equal to, or greater than the string in
4860 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
4861 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
4863 I32 sv_cmp(SV* sv1, SV* sv2)
4871 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
4872 'use bytes' aware, handles get magic, and will coerce its args to strings
4873 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
4875 I32 sv_cmp_locale(SV* sv1, SV* sv2)
4883 Add Collate Transform magic to an SV if it doesn't already have it.
4885 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
4886 scalar data of the variable, but transformed to such a format that a normal
4887 memory comparison can be used to compare the data according to the locale
4890 char* sv_collxfrm(SV* sv, STRLEN* nxp)
4898 Copies a stringified representation of the source SV into the
4899 destination SV. Automatically performs any necessary mg_get and
4900 coercion of numeric values into strings. Guaranteed to preserve
4901 UTF-8 flag even from overloaded objects. Similar in nature to
4902 sv_2pv[_flags] but operates directly on an SV instead of just the
4903 string. Mostly uses sv_2pv_flags to do its work, except when that
4904 would lose the UTF-8'ness of the PV.
4906 void sv_copypv(SV* dsv, SV* ssv)
4914 Auto-decrement of the value in the SV, doing string to numeric conversion
4915 if necessary. Handles 'get' magic.
4922 =item sv_derived_from
4925 Returns a boolean indicating whether the SV is derived from the specified
4926 class. This is the function that implements C<UNIVERSAL::isa>. It works
4927 for class names as well as for objects.
4929 bool sv_derived_from(SV* sv, const char* name)
4932 Found in file universal.c
4937 Returns a boolean indicating whether the strings in the two SVs are
4938 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
4939 coerce its args to strings if necessary.
4941 I32 sv_eq(SV* sv1, SV* sv2)
4946 =item sv_force_normal_flags
4947 X<sv_force_normal_flags>
4949 Undo various types of fakery on an SV: if the PV is a shared string, make
4950 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4951 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4952 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4953 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4954 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4955 set to some other value.) In addition, the C<flags> parameter gets passed to
4956 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4957 with flags set to 0.
4959 void sv_force_normal_flags(SV *sv, U32 flags)
4967 Decrement an SV's reference count, and if it drops to zero, call
4968 C<sv_clear> to invoke destructors and free up any memory used by
4969 the body; finally, deallocate the SV's head itself.
4970 Normally called via a wrapper macro C<SvREFCNT_dec>.
4972 void sv_free(SV* sv)
4980 Get a line from the filehandle and store it into the SV, optionally
4981 appending to the currently-stored string.
4983 char* sv_gets(SV* sv, PerlIO* fp, I32 append)
4991 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
4992 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
4993 Use the C<SvGROW> wrapper instead.
4995 char* sv_grow(SV* sv, STRLEN newlen)
5003 Auto-increment of the value in the SV, doing string to numeric conversion
5004 if necessary. Handles 'get' magic.
5014 Inserts a string at the specified offset/length within the SV. Similar to
5015 the Perl substr() function.
5017 void sv_insert(SV* bigsv, STRLEN offset, STRLEN len, const char* little, STRLEN littlelen)
5025 Returns a boolean indicating whether the SV is blessed into the specified
5026 class. This does not check for subtypes; use C<sv_derived_from> to verify
5027 an inheritance relationship.
5029 int sv_isa(SV* sv, const char* name)
5037 Returns a boolean indicating whether the SV is an RV pointing to a blessed
5038 object. If the SV is not an RV, or if the object is not blessed, then this
5041 int sv_isobject(SV* sv)
5049 Returns the length of the string in the SV. Handles magic and type
5050 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5052 STRLEN sv_len(SV* sv)
5060 Returns the number of characters in the string in an SV, counting wide
5061 UTF-8 bytes as a single character. Handles magic and type coercion.
5063 STRLEN sv_len_utf8(SV* sv)
5071 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
5072 then adds a new magic item of type C<how> to the head of the magic list.
5074 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
5075 handling of the C<name> and C<namlen> arguments.
5077 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
5078 to add more than one instance of the same 'how'.
5080 void sv_magic(SV* sv, SV* obj, int how, const char* name, I32 namlen)
5088 Adds magic to an SV, upgrading it if necessary. Applies the
5089 supplied vtable and returns a pointer to the magic added.
5091 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
5092 In particular, you can add magic to SvREADONLY SVs, and add more than
5093 one instance of the same 'how'.
5095 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
5096 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
5097 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
5098 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
5100 (This is now used as a subroutine by C<sv_magic>.)
5102 MAGIC * sv_magicext(SV* sv, SV* obj, int how, const MGVTBL *vtbl, const char* name, I32 namlen)
5110 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
5111 The new SV is marked as mortal. It will be destroyed "soon", either by an
5112 explicit call to FREETMPS, or by an implicit call at places such as
5113 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
5115 SV* sv_mortalcopy(SV* oldsv)
5123 Creates a new null SV which is mortal. The reference count of the SV is
5124 set to 1. It will be destroyed "soon", either by an explicit call to
5125 FREETMPS, or by an implicit call at places such as statement boundaries.
5126 See also C<sv_mortalcopy> and C<sv_2mortal>.
5136 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5139 SV* sv_newref(SV* sv)
5147 Converts the value pointed to by offsetp from a count of bytes from the
5148 start of the string, to a count of the equivalent number of UTF-8 chars.
5149 Handles magic and type coercion.
5151 void sv_pos_b2u(SV* sv, I32* offsetp)
5159 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5160 the start of the string, to a count of the equivalent number of bytes; if
5161 lenp is non-zero, it does the same to lenp, but this time starting from
5162 the offset, rather than from the start of the string. Handles magic and
5165 void sv_pos_u2b(SV* sv, I32* offsetp, I32* lenp)
5170 =item sv_pvbyten_force
5173 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
5175 char* sv_pvbyten_force(SV* sv, STRLEN* lp)
5183 Get a sensible string out of the SV somehow.
5184 A private implementation of the C<SvPV_force> macro for compilers which
5185 can't cope with complex macro expressions. Always use the macro instead.
5187 char* sv_pvn_force(SV* sv, STRLEN* lp)
5192 =item sv_pvn_force_flags
5193 X<sv_pvn_force_flags>
5195 Get a sensible string out of the SV somehow.
5196 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
5197 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
5198 implemented in terms of this function.
5199 You normally want to use the various wrapper macros instead: see
5200 C<SvPV_force> and C<SvPV_force_nomg>
5202 char* sv_pvn_force_flags(SV* sv, STRLEN* lp, I32 flags)
5207 =item sv_pvutf8n_force
5210 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
5212 char* sv_pvutf8n_force(SV* sv, STRLEN* lp)
5220 Returns a string describing what the SV is a reference to.
5222 char* sv_reftype(const SV* sv, int ob)
5230 Make the first argument a copy of the second, then delete the original.
5231 The target SV physically takes over ownership of the body of the source SV
5232 and inherits its flags; however, the target keeps any magic it owns,
5233 and any magic in the source is discarded.
5234 Note that this is a rather specialist SV copying operation; most of the
5235 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5237 void sv_replace(SV* sv, SV* nsv)
5242 =item sv_report_used
5245 Dump the contents of all SVs not yet freed. (Debugging aid).
5247 void sv_report_used()
5255 Underlying implementation for the C<reset> Perl function.
5256 Note that the perl-level function is vaguely deprecated.
5258 void sv_reset(const char* s, HV* stash)
5266 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
5267 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
5268 push a back-reference to this RV onto the array of backreferences
5269 associated with that magic.
5271 SV* sv_rvweaken(SV *sv)
5279 Copies an integer into the given SV, upgrading first if necessary.
5280 Does not handle 'set' magic. See also C<sv_setiv_mg>.
5282 void sv_setiv(SV* sv, IV num)
5290 Like C<sv_setiv>, but also handles 'set' magic.
5292 void sv_setiv_mg(SV *sv, IV i)
5300 Copies a double into the given SV, upgrading first if necessary.
5301 Does not handle 'set' magic. See also C<sv_setnv_mg>.
5303 void sv_setnv(SV* sv, NV num)
5311 Like C<sv_setnv>, but also handles 'set' magic.
5313 void sv_setnv_mg(SV *sv, NV num)
5321 Copies a string into an SV. The string must be null-terminated. Does not
5322 handle 'set' magic. See C<sv_setpv_mg>.
5324 void sv_setpv(SV* sv, const char* ptr)
5332 Works like C<sv_catpvf> but copies the text into the SV instead of
5333 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
5335 void sv_setpvf(SV* sv, const char* pat, ...)
5343 Like C<sv_setpvf>, but also handles 'set' magic.
5345 void sv_setpvf_mg(SV *sv, const char* pat, ...)
5353 Copies an integer into the given SV, also updating its string value.
5354 Does not handle 'set' magic. See C<sv_setpviv_mg>.
5356 void sv_setpviv(SV* sv, IV num)
5364 Like C<sv_setpviv>, but also handles 'set' magic.
5366 void sv_setpviv_mg(SV *sv, IV iv)
5374 Copies a string into an SV. The C<len> parameter indicates the number of
5375 bytes to be copied. If the C<ptr> argument is NULL the SV will become
5376 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
5378 void sv_setpvn(SV* sv, const char* ptr, STRLEN len)
5386 Like C<sv_setpvn>, but also handles 'set' magic.
5388 void sv_setpvn_mg(SV *sv, const char *ptr, STRLEN len)
5396 Like C<sv_setpv>, but also handles 'set' magic.
5398 void sv_setpv_mg(SV *sv, const char *ptr)
5406 Copies an integer 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_iv(SV* rv, const char* classname, IV iv)
5420 Copies a double into a new SV, optionally blessing the SV. The C<rv>
5421 argument will be upgraded to an RV. That RV will be modified to point to
5422 the new SV. The C<classname> argument indicates the package for the
5423 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
5424 will have a reference count of 1, and the RV will be returned.
5426 SV* sv_setref_nv(SV* rv, const char* classname, NV nv)
5434 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
5435 argument will be upgraded to an RV. That RV will be modified to point to
5436 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
5437 into the SV. The C<classname> argument indicates the package for the
5438 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
5439 will have a reference count of 1, and the RV will be returned.
5441 Do not use with other Perl types such as HV, AV, SV, CV, because those
5442 objects will become corrupted by the pointer copy process.
5444 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
5446 SV* sv_setref_pv(SV* rv, const char* classname, void* pv)
5454 Copies a string into a new SV, optionally blessing the SV. The length of the
5455 string must be specified with C<n>. The C<rv> argument will be upgraded to
5456 an RV. That RV will be modified to point to the new SV. The C<classname>
5457 argument indicates the package for the blessing. Set C<classname> to
5458 C<Nullch> to avoid the blessing. The new SV will have a reference count
5459 of 1, and the RV will be returned.
5461 Note that C<sv_setref_pv> copies the pointer while this copies the string.
5463 SV* sv_setref_pvn(SV* rv, const char* classname, const char* pv, STRLEN n)
5471 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
5472 argument will be upgraded to an RV. That RV will be modified to point to
5473 the new SV. The C<classname> argument indicates the package for the
5474 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
5475 will have a reference count of 1, and the RV will be returned.
5477 SV* sv_setref_uv(SV* rv, const char* classname, UV uv)
5485 Copies the contents of the source SV C<ssv> into the destination SV
5486 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
5487 function if the source SV needs to be reused. Does not handle 'set' magic.
5488 Loosely speaking, it performs a copy-by-value, obliterating any previous
5489 content of the destination.
5491 You probably want to use one of the assortment of wrappers, such as
5492 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
5493 C<SvSetMagicSV_nosteal>.
5495 void sv_setsv(SV* dsv, SV* ssv)
5500 =item sv_setsv_flags
5503 Copies the contents of the source SV C<ssv> into the destination SV
5504 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
5505 function if the source SV needs to be reused. Does not handle 'set' magic.
5506 Loosely speaking, it performs a copy-by-value, obliterating any previous
5507 content of the destination.
5508 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
5509 C<ssv> if appropriate, else not. If the C<flags> parameter has the
5510 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
5511 and C<sv_setsv_nomg> are implemented in terms of this function.
5513 You probably want to use one of the assortment of wrappers, such as
5514 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
5515 C<SvSetMagicSV_nosteal>.
5517 This is the primary function for copying scalars, and most other
5518 copy-ish functions and macros use this underneath.
5520 void sv_setsv_flags(SV* dsv, SV* ssv, I32 flags)
5528 Like C<sv_setsv>, but also handles 'set' magic.
5530 void sv_setsv_mg(SV *dstr, SV *sstr)
5538 Like C<sv_setsv> but doesn't process magic.
5540 void sv_setsv_nomg(SV* dsv, SV* ssv)
5548 Copies an unsigned integer into the given SV, upgrading first if necessary.
5549 Does not handle 'set' magic. See also C<sv_setuv_mg>.
5551 void sv_setuv(SV* sv, UV num)
5559 Like C<sv_setuv>, but also handles 'set' magic.
5561 void sv_setuv_mg(SV *sv, UV u)
5569 Test an SV for taintedness. Use C<SvTAINTED> instead.
5570 bool sv_tainted(SV* sv)
5578 Returns true if the SV has a true value by Perl's rules.
5579 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
5580 instead use an in-line version.
5590 Removes all magic of type C<type> from an SV.
5592 int sv_unmagic(SV* sv, int type)
5597 =item sv_unref_flags
5600 Unsets the RV status of the SV, and decrements the reference count of
5601 whatever was being referenced by the RV. This can almost be thought of
5602 as a reversal of C<newSVrv>. The C<cflags> argument can contain
5603 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
5604 (otherwise the decrementing is conditional on the reference count being
5605 different from one or the reference being a readonly SV).
5608 void sv_unref_flags(SV* sv, U32 flags)
5616 Untaint an SV. Use C<SvTAINTED_off> instead.
5617 void sv_untaint(SV* sv)
5625 Upgrade an SV to a more complex form. Generally adds a new body type to the
5626 SV, then copies across as much information as possible from the old body.
5627 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
5629 void sv_upgrade(SV* sv, U32 mt)
5637 Tells an SV to use C<ptr> to find its string value. Normally the string is
5638 stored inside the SV but sv_usepvn allows the SV to use an outside string.
5639 The C<ptr> should point to memory that was allocated by C<malloc>. The
5640 string length, C<len>, must be supplied. This function will realloc the
5641 memory pointed to by C<ptr>, so that pointer should not be freed or used by
5642 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
5643 See C<sv_usepvn_mg>.
5645 void sv_usepvn(SV* sv, char* ptr, STRLEN len)
5653 Like C<sv_usepvn>, but also handles 'set' magic.
5655 void sv_usepvn_mg(SV *sv, char *ptr, STRLEN len)
5660 =item sv_utf8_decode
5663 If the PV of the SV is an octet sequence in UTF-8
5664 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
5665 so that it looks like a character. If the PV contains only single-byte
5666 characters, the C<SvUTF8> flag stays being off.
5667 Scans PV for validity and returns false if the PV is invalid UTF-8.
5669 NOTE: this function is experimental and may change or be
5670 removed without notice.
5672 bool sv_utf8_decode(SV *sv)
5677 =item sv_utf8_downgrade
5678 X<sv_utf8_downgrade>
5680 Attempts to convert the PV of an SV from characters to bytes.
5681 If the PV contains a character beyond byte, this conversion will fail;
5682 in this case, either returns false or, if C<fail_ok> is not
5685 This is not as a general purpose Unicode to byte encoding interface:
5686 use the Encode extension for that.
5688 NOTE: this function is experimental and may change or be
5689 removed without notice.
5691 bool sv_utf8_downgrade(SV *sv, bool fail_ok)
5696 =item sv_utf8_encode
5699 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
5700 flag off so that it looks like octets again.
5702 void sv_utf8_encode(SV *sv)
5707 =item sv_utf8_upgrade
5710 Converts the PV of an SV to its UTF-8-encoded form.
5711 Forces the SV to string form if it is not already.
5712 Always sets the SvUTF8 flag to avoid future validity checks even
5713 if all the bytes have hibit clear.
5715 This is not as a general purpose byte encoding to Unicode interface:
5716 use the Encode extension for that.
5718 STRLEN sv_utf8_upgrade(SV *sv)
5723 =item sv_utf8_upgrade_flags
5724 X<sv_utf8_upgrade_flags>
5726 Converts the PV of an SV to its UTF-8-encoded form.
5727 Forces the SV to string form if it is not already.
5728 Always sets the SvUTF8 flag to avoid future validity checks even
5729 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
5730 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
5731 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
5733 This is not as a general purpose byte encoding to Unicode interface:
5734 use the Encode extension for that.
5736 STRLEN sv_utf8_upgrade_flags(SV *sv, I32 flags)
5744 Processes its arguments like C<vsprintf> and appends the formatted output
5745 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
5747 Usually used via its frontend C<sv_catpvf>.
5749 void sv_vcatpvf(SV* sv, const char* pat, va_list* args)
5757 Processes its arguments like C<vsprintf> and appends the formatted output
5758 to an SV. Uses an array of SVs if the C style variable argument list is
5759 missing (NULL). When running with taint checks enabled, indicates via
5760 C<maybe_tainted> if results are untrustworthy (often due to the use of
5763 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
5765 void sv_vcatpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
5773 Like C<sv_vcatpvf>, but also handles 'set' magic.
5775 Usually used via its frontend C<sv_catpvf_mg>.
5777 void sv_vcatpvf_mg(SV* sv, const char* pat, va_list* args)
5785 Works like C<sv_vcatpvf> but copies the text into the SV instead of
5786 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
5788 Usually used via its frontend C<sv_setpvf>.
5790 void sv_vsetpvf(SV* sv, const char* pat, va_list* args)
5798 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
5801 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
5803 void sv_vsetpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
5811 Like C<sv_vsetpvf>, but also handles 'set' magic.
5813 Usually used via its frontend C<sv_setpvf_mg>.
5815 void sv_vsetpvf_mg(SV* sv, const char* pat, va_list* args)
5823 =head1 Unicode Support
5827 =item bytes_from_utf8
5830 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
5831 Unlike C<utf8_to_bytes> but like C<bytes_to_utf8>, returns a pointer to
5832 the newly-created string, and updates C<len> to contain the new
5833 length. Returns the original string if no conversion occurs, C<len>
5834 is unchanged. Do nothing if C<is_utf8> points to 0. Sets C<is_utf8> to
5835 0 if C<s> is converted or contains all 7bit characters.
5837 NOTE: this function is experimental and may change or be
5838 removed without notice.
5840 U8* bytes_from_utf8(const U8 *s, STRLEN *len, bool *is_utf8)
5843 Found in file utf8.c
5848 Converts a string C<s> of length C<len> from ASCII into UTF-8 encoding.
5849 Returns a pointer to the newly-created string, and sets C<len> to
5850 reflect the new length.
5852 If you want to convert to UTF-8 from other encodings than ASCII,
5853 see sv_recode_to_utf8().
5855 NOTE: this function is experimental and may change or be
5856 removed without notice.
5858 U8* bytes_to_utf8(const U8 *s, STRLEN *len)
5861 Found in file utf8.c
5866 Return true if the strings s1 and s2 differ case-insensitively, false
5867 if not (if they are equal case-insensitively). If u1 is true, the
5868 string s1 is assumed to be in UTF-8-encoded Unicode. If u2 is true,
5869 the string s2 is assumed to be in UTF-8-encoded Unicode. If u1 or u2
5870 are false, the respective string is assumed to be in native 8-bit
5873 If the pe1 and pe2 are non-NULL, the scanning pointers will be copied
5874 in there (they will point at the beginning of the I<next> character).
5875 If the pointers behind pe1 or pe2 are non-NULL, they are the end
5876 pointers beyond which scanning will not continue under any
5877 circumstances. If the byte lengths l1 and l2 are non-zero, s1+l1 and
5878 s2+l2 will be used as goal end pointers that will also stop the scan,
5879 and which qualify towards defining a successful match: all the scans
5880 that define an explicit length must reach their goal pointers for
5881 a match to succeed).
5883 For case-insensitiveness, the "casefolding" of Unicode is used
5884 instead of upper/lowercasing both the characters, see
5885 http://www.unicode.org/unicode/reports/tr21/ (Case Mappings).
5887 I32 ibcmp_utf8(const char* a, char **pe1, UV l1, bool u1, const char* b, char **pe2, UV l2, bool u2)
5890 Found in file utf8.c
5895 Tests if some arbitrary number of bytes begins in a valid UTF-8
5896 character. Note that an INVARIANT (i.e. ASCII) character is a valid
5897 UTF-8 character. The actual number of bytes in the UTF-8 character
5898 will be returned if it is valid, otherwise 0.
5900 STRLEN is_utf8_char(const U8 *p)
5903 Found in file utf8.c
5905 =item is_utf8_string
5908 Returns true if first C<len> bytes of the given string form a valid
5909 UTF-8 string, false otherwise. Note that 'a valid UTF-8 string' does
5910 not mean 'a string that contains code points above 0x7F encoded in UTF-8'
5911 because a valid ASCII string is a valid UTF-8 string.
5913 See also is_utf8_string_loclen() and is_utf8_string_loc().
5915 bool is_utf8_string(const U8 *s, STRLEN len)
5918 Found in file utf8.c
5920 =item is_utf8_string_loc
5921 X<is_utf8_string_loc>
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>.
5927 See also is_utf8_string_loclen() and is_utf8_string().
5929 bool is_utf8_string_loc(const U8 *s, STRLEN len, const U8 **p)
5932 Found in file utf8.c
5934 =item is_utf8_string_loclen
5935 X<is_utf8_string_loclen>
5937 Like is_utf8_string() but stores the location of the failure (in the
5938 case of "utf8ness failure") or the location s+len (in the case of
5939 "utf8ness success") in the C<ep>, and the number of UTF-8
5940 encoded characters in the C<el>.
5942 See also is_utf8_string_loc() and is_utf8_string().
5944 bool is_utf8_string_loclen(const U8 *s, STRLEN len, const U8 **ep, STRLEN *el)
5947 Found in file utf8.c
5949 =item pv_uni_display
5952 Build to the scalar dsv a displayable version of the string spv,
5953 length len, the displayable version being at most pvlim bytes long
5954 (if longer, the rest is truncated and "..." will be appended).
5956 The flags argument can have UNI_DISPLAY_ISPRINT set to display
5957 isPRINT()able characters as themselves, UNI_DISPLAY_BACKSLASH
5958 to display the \\[nrfta\\] as the backslashed versions (like '\n')
5959 (UNI_DISPLAY_BACKSLASH is preferred over UNI_DISPLAY_ISPRINT for \\).
5960 UNI_DISPLAY_QQ (and its alias UNI_DISPLAY_REGEX) have both
5961 UNI_DISPLAY_BACKSLASH and UNI_DISPLAY_ISPRINT turned on.
5963 The pointer to the PV of the dsv is returned.
5965 char* pv_uni_display(SV *dsv, const U8 *spv, STRLEN len, STRLEN pvlim, UV flags)
5968 Found in file utf8.c
5973 The encoding is assumed to be an Encode object, the PV of the ssv is
5974 assumed to be octets in that encoding and decoding the input starts
5975 from the position which (PV + *offset) pointed to. The dsv will be
5976 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
5977 when the string tstr appears in decoding output or the input ends on
5978 the PV of the ssv. The value which the offset points will be modified
5979 to the last input position on the ssv.
5981 Returns TRUE if the terminator was found, else returns FALSE.
5983 bool sv_cat_decode(SV* dsv, SV *encoding, SV *ssv, int *offset, char* tstr, int tlen)
5988 =item sv_recode_to_utf8
5989 X<sv_recode_to_utf8>
5991 The encoding is assumed to be an Encode object, on entry the PV
5992 of the sv is assumed to be octets in that encoding, and the sv
5993 will be converted into Unicode (and UTF-8).
5995 If the sv already is UTF-8 (or if it is not POK), or if the encoding
5996 is not a reference, nothing is done to the sv. If the encoding is not
5997 an C<Encode::XS> Encoding object, bad things will happen.
5998 (See F<lib/encoding.pm> and L<Encode>).
6000 The PV of the sv is returned.
6002 char* sv_recode_to_utf8(SV* sv, SV *encoding)
6007 =item sv_uni_display
6010 Build to the scalar dsv a displayable version of the scalar sv,
6011 the displayable version being at most pvlim bytes long
6012 (if longer, the rest is truncated and "..." will be appended).
6014 The flags argument is as in pv_uni_display().
6016 The pointer to the PV of the dsv is returned.
6018 char* sv_uni_display(SV *dsv, SV *ssv, STRLEN pvlim, UV flags)
6021 Found in file utf8.c
6026 The "p" contains the pointer to the UTF-8 string encoding
6027 the character that is being converted.
6029 The "ustrp" is a pointer to the character buffer to put the
6030 conversion result to. The "lenp" is a pointer to the length
6033 The "swashp" is a pointer to the swash to use.
6035 Both the special and normal mappings are stored lib/unicore/To/Foo.pl,
6036 and loaded by SWASHNEW, using lib/utf8_heavy.pl. The special (usually,
6037 but not always, a multicharacter mapping), is tried first.
6039 The "special" is a string like "utf8::ToSpecLower", which means the
6040 hash %utf8::ToSpecLower. The access to the hash is through
6041 Perl_to_utf8_case().
6043 The "normal" is a string like "ToLower" which means the swash
6046 UV to_utf8_case(const U8 *p, U8* ustrp, STRLEN *lenp, SV **swashp, const char *normal, const char *special)
6049 Found in file utf8.c
6054 Convert the UTF-8 encoded character at p to its foldcase version and
6055 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6056 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6057 foldcase version may be longer than the original character (up to
6060 The first character of the foldcased version is returned
6061 (but note, as explained above, that there may be more.)
6063 UV to_utf8_fold(const U8 *p, U8* ustrp, STRLEN *lenp)
6066 Found in file utf8.c
6071 Convert the UTF-8 encoded character at p to its lowercase version and
6072 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6073 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6074 lowercase version may be longer than the original character.
6076 The first character of the lowercased version is returned
6077 (but note, as explained above, that there may be more.)
6079 UV to_utf8_lower(const U8 *p, U8* ustrp, STRLEN *lenp)
6082 Found in file utf8.c
6087 Convert the UTF-8 encoded character at p to its titlecase version and
6088 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6089 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6090 titlecase version may be longer than the original character.
6092 The first character of the titlecased version is returned
6093 (but note, as explained above, that there may be more.)
6095 UV to_utf8_title(const U8 *p, U8* ustrp, STRLEN *lenp)
6098 Found in file utf8.c
6103 Convert the UTF-8 encoded character at p to its uppercase version and
6104 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6105 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since
6106 the uppercase version may be longer than the original character.
6108 The first character of the uppercased version is returned
6109 (but note, as explained above, that there may be more.)
6111 UV to_utf8_upper(const U8 *p, U8* ustrp, STRLEN *lenp)
6114 Found in file utf8.c
6116 =item utf8n_to_uvchr
6121 Returns the native character value of the first character in the string
6123 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6124 length, in bytes, of that character.
6126 Allows length and flags to be passed to low level routine.
6128 UV utf8n_to_uvchr(const U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags)
6131 Found in file utf8.c
6133 =item utf8n_to_uvuni
6136 Bottom level UTF-8 decode routine.
6137 Returns the unicode code point value of the first character in the string C<s>
6138 which is assumed to be in UTF-8 encoding and no longer than C<curlen>;
6139 C<retlen> will be set to the length, in bytes, of that character.
6141 If C<s> does not point to a well-formed UTF-8 character, the behaviour
6142 is dependent on the value of C<flags>: if it contains UTF8_CHECK_ONLY,
6143 it is assumed that the caller will raise a warning, and this function
6144 will silently just set C<retlen> to C<-1> and return zero. If the
6145 C<flags> does not contain UTF8_CHECK_ONLY, warnings about
6146 malformations will be given, C<retlen> will be set to the expected
6147 length of the UTF-8 character in bytes, and zero will be returned.
6149 The C<flags> can also contain various flags to allow deviations from
6150 the strict UTF-8 encoding (see F<utf8.h>).
6152 Most code should use utf8_to_uvchr() rather than call this directly.
6154 UV utf8n_to_uvuni(const U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags)
6157 Found in file utf8.c
6162 Returns the number of UTF-8 characters between the UTF-8 pointers C<a>
6165 WARNING: use only if you *know* that the pointers point inside the
6168 IV utf8_distance(const U8 *a, const U8 *b)
6171 Found in file utf8.c
6176 Return the UTF-8 pointer C<s> displaced by C<off> characters, either
6177 forward or backward.
6179 WARNING: do not use the following unless you *know* C<off> is within
6180 the UTF-8 data pointed to by C<s> *and* that on entry C<s> is aligned
6181 on the first byte of character or just after the last byte of a character.
6183 U8* utf8_hop(const U8 *s, I32 off)
6186 Found in file utf8.c
6191 Return the length of the UTF-8 char encoded string C<s> in characters.
6192 Stops at C<e> (inclusive). If C<e E<lt> s> or if the scan would end
6193 up past C<e>, croaks.
6195 STRLEN utf8_length(const U8* s, const U8 *e)
6198 Found in file utf8.c
6203 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
6204 Unlike C<bytes_to_utf8>, this over-writes the original string, and
6205 updates len to contain the new length.
6206 Returns zero on failure, setting C<len> to -1.
6208 NOTE: this function is experimental and may change or be
6209 removed without notice.
6211 U8* utf8_to_bytes(U8 *s, STRLEN *len)
6214 Found in file utf8.c
6219 Returns the native character value of the first character in the string C<s>
6220 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6221 length, in bytes, of that character.
6223 If C<s> does not point to a well-formed UTF-8 character, zero is
6224 returned and retlen is set, if possible, to -1.
6226 UV utf8_to_uvchr(const U8 *s, STRLEN *retlen)
6229 Found in file utf8.c
6234 Returns the Unicode code point of the first character in the string C<s>
6235 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6236 length, in bytes, of that character.
6238 This function should only be used when returned UV is considered
6239 an index into the Unicode semantic tables (e.g. swashes).
6241 If C<s> does not point to a well-formed UTF-8 character, zero is
6242 returned and retlen is set, if possible, to -1.
6244 UV utf8_to_uvuni(const U8 *s, STRLEN *retlen)
6247 Found in file utf8.c
6252 Adds the UTF-8 representation of the Native codepoint C<uv> to the end
6253 of the string C<d>; C<d> should be have at least C<UTF8_MAXBYTES+1> free
6254 bytes available. The return value is the pointer to the byte after the
6255 end of the new character. In other words,
6257 d = uvchr_to_utf8(d, uv);
6259 is the recommended wide native character-aware way of saying
6263 U8* uvchr_to_utf8(U8 *d, UV uv)
6266 Found in file utf8.c
6268 =item uvuni_to_utf8_flags
6269 X<uvuni_to_utf8_flags>
6271 Adds the UTF-8 representation of the Unicode codepoint C<uv> to the end
6272 of the string C<d>; C<d> should be have at least C<UTF8_MAXBYTES+1> free
6273 bytes available. The return value is the pointer to the byte after the
6274 end of the new character. In other words,
6276 d = uvuni_to_utf8_flags(d, uv, flags);
6280 d = uvuni_to_utf8(d, uv);
6282 (which is equivalent to)
6284 d = uvuni_to_utf8_flags(d, uv, 0);
6286 is the recommended Unicode-aware way of saying
6290 U8* uvuni_to_utf8_flags(U8 *d, UV uv, UV flags)
6293 Found in file utf8.c
6298 =head1 Variables created by C<xsubpp> and C<xsubpp> internal functions
6305 Variable which is setup by C<xsubpp> to indicate the stack base offset,
6306 used by the C<ST>, C<XSprePUSH> and C<XSRETURN> macros. The C<dMARK> macro
6307 must be called prior to setup the C<MARK> variable.
6312 Found in file XSUB.h
6317 Variable which is setup by C<xsubpp> to indicate the
6318 class name for a C++ XS constructor. This is always a C<char*>. See C<THIS>.
6323 Found in file XSUB.h
6328 Sets up the C<ax> variable.
6329 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
6334 Found in file XSUB.h
6339 Sets up the C<ax> variable and stack marker variable C<mark>.
6340 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
6345 Found in file XSUB.h
6350 Sets up the C<items> variable.
6351 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
6356 Found in file XSUB.h
6361 Sets up the C<padoff_du> variable for an XSUB that wishes to use
6367 Found in file XSUB.h
6372 Sets up stack and mark pointers for an XSUB, calling dSP and dMARK.
6373 Sets up the C<ax> and C<items> variables by calling C<dAX> and C<dITEMS>.
6374 This is usually handled automatically by C<xsubpp>.
6379 Found in file XSUB.h
6384 Sets up the C<ix> variable for an XSUB which has aliases. This is usually
6385 handled automatically by C<xsubpp>.
6390 Found in file XSUB.h
6395 Variable which is setup by C<xsubpp> to indicate the number of
6396 items on the stack. See L<perlxs/"Variable-length Parameter Lists">.
6401 Found in file XSUB.h
6406 Variable which is setup by C<xsubpp> to indicate which of an
6407 XSUB's aliases was used to invoke it. See L<perlxs/"The ALIAS: Keyword">.
6412 Found in file XSUB.h
6417 Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
6421 Found in file XSUB.h
6426 Variable which is setup by C<xsubpp> to hold the return value for an
6427 XSUB. This is always the proper type for the XSUB. See
6428 L<perlxs/"The RETVAL Variable">.
6433 Found in file XSUB.h
6438 Used to access elements on the XSUB's stack.
6443 Found in file XSUB.h
6448 Variable which is setup by C<xsubpp> to designate the object in a C++
6449 XSUB. This is always the proper type for the C++ object. See C<CLASS> and
6450 L<perlxs/"Using XS With C++">.
6455 Found in file XSUB.h
6460 The SV* corresponding to the $_ variable. Works even if there
6461 is a lexical $_ in scope.
6464 Found in file XSUB.h
6469 Macro to declare an XSUB and its C parameter list. This is handled by
6473 Found in file XSUB.h
6478 The version identifier for an XS module. This is usually
6479 handled automatically by C<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>.
6482 Found in file XSUB.h
6484 =item XS_VERSION_BOOTCHECK
6485 X<XS_VERSION_BOOTCHECK>
6487 Macro to verify that a PM module's $VERSION variable matches the XS
6488 module's C<XS_VERSION> variable. This is usually handled automatically by
6489 C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">.
6491 XS_VERSION_BOOTCHECK;
6494 Found in file XSUB.h
6499 =head1 Warning and Dieing
6506 This is the XSUB-writer's interface to Perl's C<die> function.
6507 Normally call this function the same way you call the C C<printf>
6508 function. Calling C<croak> returns control directly to Perl,
6509 sidestepping the normal C order of execution. See C<warn>.
6511 If you want to throw an exception object, assign the object to
6512 C<$@> and then pass C<Nullch> to croak():
6514 errsv = get_sv("@", TRUE);
6515 sv_setsv(errsv, exception_object);
6518 void croak(const char* pat, ...)
6521 Found in file util.c
6526 This is the XSUB-writer's interface to Perl's C<warn> function. Call this
6527 function the same way you call the C C<printf> function. See C<croak>.
6529 void warn(const char* pat, ...)
6532 Found in file util.c
6539 Until May 1997, this document was maintained by Jeff Okamoto
6540 <okamoto@corp.hp.com>. It is now maintained as part of Perl itself.
6542 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
6543 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
6544 Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
6545 Stephen McCamant, and Gurusamy Sarathy.
6547 API Listing originally by Dean Roehrich <roehrich@cray.com>.
6549 Updated to be autogenerated from comments in the source by Benjamin Stuhl.
6553 perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
https://perl5.git.perl.org / perl5.git / blob