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 Tells an SV to use C<ptr> to find its string value. Implemented by
980 calling C<sv_usepvn_flags> with C<flags> of 0, hence does not handle 'set'
981 magic. See C<sv_usepvn_flags>.
983 void sv_usepvn(SV* sv, char* ptr, STRLEN len)
986 Found in file mathoms.c
991 Like C<sv_usepvn>, but also handles 'set' magic.
993 void sv_usepvn_mg(SV *sv, char *ptr, STRLEN len)
996 Found in file mathoms.c
1001 A private implementation of the C<SvUVx> macro for compilers which can't
1002 cope with complex macro expressions. Always use the macro instead.
1007 Found in file mathoms.c
1012 The engine implementing unpack() Perl function. Note: parameters strbeg, new_s
1013 and ocnt are not used. This call should not be used, use unpackstring instead.
1015 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)
1018 Found in file mathoms.c
1023 =head1 Functions in file pp_pack.c
1031 The engine implementing pack() Perl function.
1033 void packlist(SV *cat, const char *pat, const char *patend, SV **beglist, SV **endlist)
1036 Found in file pp_pack.c
1041 The engine implementing pack() Perl function. Note: parameters next_in_list and
1042 flags are not used. This call should not be used; use packlist instead.
1044 void pack_cat(SV *cat, const char *pat, const char *patend, SV **beglist, SV **endlist, SV ***next_in_list, U32 flags)
1047 Found in file pp_pack.c
1052 The engine implementing unpack() Perl function. C<unpackstring> puts the
1053 extracted list items on the stack and returns the number of elements.
1054 Issue C<PUTBACK> before and C<SPAGAIN> after the call to this function.
1056 I32 unpackstring(const char *pat, const char *patend, const char *s, const char *strend, U32 flags)
1059 Found in file pp_pack.c
1064 =head1 Global Variables
1071 C<PL_modglobal> is a general purpose, interpreter global HV for use by
1072 extensions that need to keep information on a per-interpreter basis.
1073 In a pinch, it can also be used as a symbol table for extensions
1074 to share data among each other. It is a good idea to use keys
1075 prefixed by the package name of the extension that owns the data.
1080 Found in file intrpvar.h
1085 A convenience variable which is typically used with C<SvPV> when one
1086 doesn't care about the length of the string. It is usually more efficient
1087 to either declare a local variable and use that instead or to use the
1088 C<SvPV_nolen> macro.
1093 Found in file thrdvar.h
1098 This is the C<false> SV. See C<PL_sv_yes>. Always refer to this as
1104 Found in file intrpvar.h
1109 This is the C<undef> SV. Always refer to this as C<&PL_sv_undef>.
1114 Found in file intrpvar.h
1119 This is the C<true> SV. See C<PL_sv_no>. Always refer to this as
1125 Found in file intrpvar.h
1137 Return the SV from the GV.
1147 If C<gv> is a typeglob whose subroutine entry is a constant sub eligible for
1148 inlining, or C<gv> is a placeholder reference that would be promoted to such
1149 a typeglob, then returns the value returned by the sub. Otherwise, returns
1152 SV* gv_const_sv(GV* gv)
1160 Returns the glob with the given C<name> and a defined subroutine or
1161 C<NULL>. The glob lives in the given C<stash>, or in the stashes
1162 accessible via @ISA and UNIVERSAL::.
1164 The argument C<level> should be either 0 or -1. If C<level==0>, as a
1165 side-effect creates a glob with the given C<name> in the given C<stash>
1166 which in the case of success contains an alias for the subroutine, and sets
1167 up caching info for this glob. Similarly for all the searched stashes.
1169 This function grants C<"SUPER"> token as a postfix of the stash name. The
1170 GV returned from C<gv_fetchmeth> may be a method cache entry, which is not
1171 visible to Perl code. So when calling C<call_sv>, you should not use
1172 the GV directly; instead, you should use the method's CV, which can be
1173 obtained from the GV with the C<GvCV> macro.
1175 GV* gv_fetchmeth(HV* stash, const char* name, STRLEN len, I32 level)
1180 =item gv_fetchmethod_autoload
1181 X<gv_fetchmethod_autoload>
1183 Returns the glob which contains the subroutine to call to invoke the method
1184 on the C<stash>. In fact in the presence of autoloading this may be the
1185 glob for "AUTOLOAD". In this case the corresponding variable $AUTOLOAD is
1188 The third parameter of C<gv_fetchmethod_autoload> determines whether
1189 AUTOLOAD lookup is performed if the given method is not present: non-zero
1190 means yes, look for AUTOLOAD; zero means no, don't look for AUTOLOAD.
1191 Calling C<gv_fetchmethod> is equivalent to calling C<gv_fetchmethod_autoload>
1192 with a non-zero C<autoload> parameter.
1194 These functions grant C<"SUPER"> token as a prefix of the method name. Note
1195 that if you want to keep the returned glob for a long time, you need to
1196 check for it being "AUTOLOAD", since at the later time the call may load a
1197 different subroutine due to $AUTOLOAD changing its value. Use the glob
1198 created via a side effect to do this.
1200 These functions have the same side-effects and as C<gv_fetchmeth> with
1201 C<level==0>. C<name> should be writable if contains C<':'> or C<'
1202 ''>. The warning against passing the GV returned by C<gv_fetchmeth> to
1203 C<call_sv> apply equally to these functions.
1205 GV* gv_fetchmethod_autoload(HV* stash, const char* name, I32 autoload)
1210 =item gv_fetchmeth_autoload
1211 X<gv_fetchmeth_autoload>
1213 Same as gv_fetchmeth(), but looks for autoloaded subroutines too.
1214 Returns a glob for the subroutine.
1216 For an autoloaded subroutine without a GV, will create a GV even
1217 if C<level < 0>. For an autoloaded subroutine without a stub, GvCV()
1218 of the result may be zero.
1220 GV* gv_fetchmeth_autoload(HV* stash, const char* name, STRLEN len, I32 level)
1228 Returns a pointer to the stash for a specified package. C<name> should
1229 be a valid UTF-8 string and must be null-terminated. If C<create> is set
1230 then the package will be created if it does not already exist. If C<create>
1231 is not set and the package does not exist then NULL is returned.
1233 HV* gv_stashpv(const char* name, I32 create)
1241 Returns a pointer to the stash for a specified package. C<name> should
1242 be a valid UTF-8 string. The C<namelen> parameter indicates the length of
1243 the C<name>, in bytes. If C<create> is set then the package will be
1244 created if it does not already exist. If C<create> is not set and the
1245 package does not exist then NULL is returned.
1247 HV* gv_stashpvn(const char* name, U32 namelen, I32 create)
1255 Returns a pointer to the stash for a specified package, which must be a
1256 valid UTF-8 string. See C<gv_stashpv>.
1258 HV* gv_stashsv(SV* sv, I32 create)
1281 Null character pointer.
1284 Found in file handy.h
1308 Found in file handy.h
1313 =head1 Hash Manipulation Functions
1320 Returns the HV of the specified Perl hash. If C<create> is set and the
1321 Perl variable does not exist then it will be created. If C<create> is not
1322 set and the variable does not exist then NULL is returned.
1324 NOTE: the perl_ form of this function is deprecated.
1326 HV* get_hv(const char* name, I32 create)
1329 Found in file perl.c
1334 This flag, used in the length slot of hash entries and magic structures,
1335 specifies the structure contains an C<SV*> pointer where a C<char*> pointer
1336 is to be expected. (For information only--not to be used).
1344 Returns the computed hash stored in the hash entry.
1354 Returns the actual pointer stored in the key slot of the hash entry. The
1355 pointer may be either C<char*> or C<SV*>, depending on the value of
1356 C<HeKLEN()>. Can be assigned to. The C<HePV()> or C<HeSVKEY()> macros are
1357 usually preferable for finding the value of a key.
1367 If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry
1368 holds an C<SV*> key. Otherwise, holds the actual length of the key. Can
1369 be assigned to. The C<HePV()> macro is usually preferable for finding key
1372 STRLEN HeKLEN(HE* he)
1380 Returns the key slot of the hash entry as a C<char*> value, doing any
1381 necessary dereferencing of possibly C<SV*> keys. The length of the string
1382 is placed in C<len> (this is a macro, so do I<not> use C<&len>). If you do
1383 not care about what the length of the key is, you may use the global
1384 variable C<PL_na>, though this is rather less efficient than using a local
1385 variable. Remember though, that hash keys in perl are free to contain
1386 embedded nulls, so using C<strlen()> or similar is not a good way to find
1387 the length of hash keys. This is very similar to the C<SvPV()> macro
1388 described elsewhere in this document.
1390 char* HePV(HE* he, STRLEN len)
1398 Returns the key as an C<SV*>, or C<NULL> if the hash entry does not
1399 contain an C<SV*> key.
1409 Returns the key as an C<SV*>. Will create and return a temporary mortal
1410 C<SV*> if the hash entry contains only a C<char*> key.
1412 SV* HeSVKEY_force(HE* he)
1420 Sets the key to a given C<SV*>, taking care to set the appropriate flags to
1421 indicate the presence of an C<SV*> key, and returns the same
1424 SV* HeSVKEY_set(HE* he, SV* sv)
1432 Returns the value slot (type C<SV*>) stored in the hash entry.
1442 Returns the package name of a stash, or NULL if C<stash> isn't a stash.
1443 See C<SvSTASH>, C<CvSTASH>.
1445 char* HvNAME(HV* stash)
1453 Check that a hash is in an internally consistent state.
1455 void hv_assert(HV* tb)
1463 Clears a hash, making it empty.
1465 void hv_clear(HV* tb)
1470 =item hv_clear_placeholders
1471 X<hv_clear_placeholders>
1473 Clears any placeholders from a hash. If a restricted hash has any of its keys
1474 marked as readonly and the key is subsequently deleted, the key is not actually
1475 deleted but is marked by assigning it a value of &PL_sv_placeholder. This tags
1476 it so it will be ignored by future operations such as iterating over the hash,
1477 but will still allow the hash to have a value reassigned to the key at some
1478 future point. This function clears any such placeholder keys from the hash.
1479 See Hash::Util::lock_keys() for an example of its use.
1481 void hv_clear_placeholders(HV* hb)
1489 Deletes a key/value pair in the hash. The value SV is removed from the
1490 hash and returned to the caller. The C<klen> is the length of the key.
1491 The C<flags> value will normally be zero; if set to G_DISCARD then NULL
1494 SV* hv_delete(HV* tb, const char* key, I32 klen, I32 flags)
1502 Deletes a key/value pair in the hash. The value SV is removed from the
1503 hash and returned to the caller. The C<flags> value will normally be zero;
1504 if set to G_DISCARD then NULL will be returned. C<hash> can be a valid
1505 precomputed hash value, or 0 to ask for it to be computed.
1507 SV* hv_delete_ent(HV* tb, SV* key, I32 flags, U32 hash)
1515 Returns a boolean indicating whether the specified hash key exists. The
1516 C<klen> is the length of the key.
1518 bool hv_exists(HV* tb, const char* key, I32 klen)
1526 Returns a boolean indicating whether the specified hash key exists. C<hash>
1527 can be a valid precomputed hash value, or 0 to ask for it to be
1530 bool hv_exists_ent(HV* tb, SV* key, U32 hash)
1538 Returns the SV which corresponds to the specified key in the hash. The
1539 C<klen> is the length of the key. If C<lval> is set then the fetch will be
1540 part of a store. Check that the return value is non-null before
1541 dereferencing it to an C<SV*>.
1543 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1544 information on how to use this function on tied hashes.
1546 SV** hv_fetch(HV* tb, const char* key, I32 klen, I32 lval)
1554 Returns the hash entry which corresponds to the specified key in the hash.
1555 C<hash> must be a valid precomputed hash number for the given C<key>, or 0
1556 if you want the function to compute it. IF C<lval> is set then the fetch
1557 will be part of a store. Make sure the return value is non-null before
1558 accessing it. The return value when C<tb> is a tied hash is a pointer to a
1559 static location, so be sure to make a copy of the structure if you need to
1562 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1563 information on how to use this function on tied hashes.
1565 HE* hv_fetch_ent(HV* tb, SV* key, I32 lval, U32 hash)
1573 Prepares a starting point to traverse a hash table. Returns the number of
1574 keys in the hash (i.e. the same as C<HvKEYS(tb)>). The return value is
1575 currently only meaningful for hashes without tie magic.
1577 NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
1578 hash buckets that happen to be in use. If you still need that esoteric
1579 value, you can get it through the macro C<HvFILL(tb)>.
1582 I32 hv_iterinit(HV* tb)
1590 Returns the key from the current position of the hash iterator. See
1593 char* hv_iterkey(HE* entry, I32* retlen)
1601 Returns the key as an C<SV*> from the current position of the hash
1602 iterator. The return value will always be a mortal copy of the key. Also
1605 SV* hv_iterkeysv(HE* entry)
1613 Returns entries from a hash iterator. See C<hv_iterinit>.
1615 You may call C<hv_delete> or C<hv_delete_ent> on the hash entry that the
1616 iterator currently points to, without losing your place or invalidating your
1617 iterator. Note that in this case the current entry is deleted from the hash
1618 with your iterator holding the last reference to it. Your iterator is flagged
1619 to free the entry on the next call to C<hv_iternext>, so you must not discard
1620 your iterator immediately else the entry will leak - call C<hv_iternext> to
1621 trigger the resource deallocation.
1623 HE* hv_iternext(HV* tb)
1631 Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
1634 SV* hv_iternextsv(HV* hv, char** key, I32* retlen)
1639 =item hv_iternext_flags
1640 X<hv_iternext_flags>
1642 Returns entries from a hash iterator. See C<hv_iterinit> and C<hv_iternext>.
1643 The C<flags> value will normally be zero; if HV_ITERNEXT_WANTPLACEHOLDERS is
1644 set the placeholders keys (for restricted hashes) will be returned in addition
1645 to normal keys. By default placeholders are automatically skipped over.
1646 Currently a placeholder is implemented with a value that is
1647 C<&Perl_sv_placeholder>. Note that the implementation of placeholders and
1648 restricted hashes may change, and the implementation currently is
1649 insufficiently abstracted for any change to be tidy.
1651 NOTE: this function is experimental and may change or be
1652 removed without notice.
1654 HE* hv_iternext_flags(HV* tb, I32 flags)
1662 Returns the value from the current position of the hash iterator. See
1665 SV* hv_iterval(HV* tb, HE* entry)
1673 Adds magic to a hash. See C<sv_magic>.
1675 void hv_magic(HV* hv, GV* gv, int how)
1683 Evaluates the hash in scalar context and returns the result. Handles magic when the hash is tied.
1685 SV* hv_scalar(HV* hv)
1693 Stores an SV in a hash. The hash key is specified as C<key> and C<klen> is
1694 the length of the key. The C<hash> parameter is the precomputed hash
1695 value; if it is zero then Perl will compute it. The return value will be
1696 NULL if the operation failed or if the value did not need to be actually
1697 stored within the hash (as in the case of tied hashes). Otherwise it can
1698 be dereferenced to get the original C<SV*>. Note that the caller is
1699 responsible for suitably incrementing the reference count of C<val> before
1700 the call, and decrementing it if the function returned NULL. Effectively
1701 a successful hv_store takes ownership of one reference to C<val>. This is
1702 usually what you want; a newly created SV has a reference count of one, so
1703 if all your code does is create SVs then store them in a hash, hv_store
1704 will own the only reference to the new SV, and your code doesn't need to do
1705 anything further to tidy up. hv_store is not implemented as a call to
1706 hv_store_ent, and does not create a temporary SV for the key, so if your
1707 key data is not already in SV form then use hv_store in preference to
1710 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1711 information on how to use this function on tied hashes.
1713 SV** hv_store(HV* tb, const char* key, I32 klen, SV* val, U32 hash)
1721 Stores C<val> in a hash. The hash key is specified as C<key>. The C<hash>
1722 parameter is the precomputed hash value; if it is zero then Perl will
1723 compute it. The return value is the new hash entry so created. It will be
1724 NULL if the operation failed or if the value did not need to be actually
1725 stored within the hash (as in the case of tied hashes). Otherwise the
1726 contents of the return value can be accessed using the C<He?> macros
1727 described here. Note that the caller is responsible for suitably
1728 incrementing the reference count of C<val> before the call, and
1729 decrementing it if the function returned NULL. Effectively a successful
1730 hv_store_ent takes ownership of one reference to C<val>. This is
1731 usually what you want; a newly created SV has a reference count of one, so
1732 if all your code does is create SVs then store them in a hash, hv_store
1733 will own the only reference to the new SV, and your code doesn't need to do
1734 anything further to tidy up. Note that hv_store_ent only reads the C<key>;
1735 unlike C<val> it does not take ownership of it, so maintaining the correct
1736 reference count on C<key> is entirely the caller's responsibility. hv_store
1737 is not implemented as a call to hv_store_ent, and does not create a temporary
1738 SV for the key, so if your key data is not already in SV form then use
1739 hv_store in preference to hv_store_ent.
1741 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1742 information on how to use this function on tied hashes.
1744 HE* hv_store_ent(HV* tb, SV* key, SV* val, U32 hash)
1754 void hv_undef(HV* tb)
1762 Creates a new HV. The reference count is set to 1.
1772 =head1 Magical Functions
1779 Clear something magical that the SV represents. See C<sv_magic>.
1781 int mg_clear(SV* sv)
1789 Copies the magic from one SV to another. See C<sv_magic>.
1791 int mg_copy(SV* sv, SV* nsv, const char* key, I32 klen)
1799 Finds the magic pointer for type matching the SV. See C<sv_magic>.
1801 MAGIC* mg_find(const SV* sv, int type)
1809 Free any magic storage used by the SV. See C<sv_magic>.
1819 Do magic after a value is retrieved from the SV. See C<sv_magic>.
1829 Report on the SV's length. See C<sv_magic>.
1831 U32 mg_length(SV* sv)
1839 Turns on the magical status of an SV. See C<sv_magic>.
1841 void mg_magical(SV* sv)
1849 Do magic after a value is assigned to the SV. See C<sv_magic>.
1859 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
1860 argument more than once.
1862 void SvGETMAGIC(SV* sv)
1870 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
1881 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
1882 argument more than once.
1884 void SvSETMAGIC(SV* sv)
1892 Like C<SvSetSV>, but does any set magic required afterwards.
1894 void SvSetMagicSV(SV* dsb, SV* ssv)
1899 =item SvSetMagicSV_nosteal
1900 X<SvSetMagicSV_nosteal>
1902 Like C<SvSetSV_nosteal>, but does any set magic required afterwards.
1904 void SvSetMagicSV_nosteal(SV* dsv, SV* ssv)
1912 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
1915 void SvSetSV(SV* dsb, SV* ssv)
1920 =item SvSetSV_nosteal
1923 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
1924 ssv. May evaluate arguments more than once.
1926 void SvSetSV_nosteal(SV* dsv, SV* ssv)
1934 Arranges for sv to be shared between threads if a suitable module
1937 void SvSHARE(SV* sv)
1945 Releases a mutual exclusion lock on sv if a suitable module
1948 void SvUNLOCK(SV* sv)
1956 =head1 Memory Management
1963 The XSUB-writer's interface to the C C<memcpy> function. The C<src> is the
1964 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1965 the type. May fail on overlapping copies. See also C<Move>.
1967 void Copy(void* src, void* dest, int nitems, type)
1970 Found in file handy.h
1975 Like C<Copy> but returns dest. Useful for encouraging compilers to tail-call
1978 void * CopyD(void* src, void* dest, int nitems, type)
1981 Found in file handy.h
1986 The XSUB-writer's interface to the C C<memmove> function. The C<src> is the
1987 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1988 the type. Can do overlapping moves. See also C<Copy>.
1990 void Move(void* src, void* dest, int nitems, type)
1993 Found in file handy.h
1998 Like C<Move> but returns dest. Useful for encouraging compilers to tail-call
2001 void * MoveD(void* src, void* dest, int nitems, type)
2004 Found in file handy.h
2009 The XSUB-writer's interface to the C C<malloc> function.
2011 In 5.9.3, Newx() and friends replace the older New() API, and drops
2012 the first parameter, I<x>, a debug aid which allowed callers to identify
2013 themselves. This aid has been superseded by a new build option,
2014 PERL_MEM_LOG (see L<perlhack/PERL_MEM_LOG>). The older API is still
2015 there for use in XS modules supporting older perls.
2017 void Newx(void* ptr, int nitems, type)
2020 Found in file handy.h
2025 The XSUB-writer's interface to the C C<malloc> function, with
2026 cast. See also C<Newx>.
2028 void Newxc(void* ptr, int nitems, type, cast)
2031 Found in file handy.h
2036 The XSUB-writer's interface to the C C<malloc> function. The allocated
2037 memory is zeroed with C<memzero>. See also C<Newx>.
2039 void Newxz(void* ptr, int nitems, type)
2042 Found in file handy.h
2047 PoisonWith(0xEF) for catching access to freed memory.
2049 void Poison(void* dest, int nitems, type)
2052 Found in file handy.h
2057 PoisonWith(0xAB) for catching access to allocated but uninitialized memory.
2059 void PoisonNew(void* dest, int nitems, type)
2062 Found in file handy.h
2067 Fill up memory with a byte pattern (a byte repeated over and over
2068 again) that hopefully catches attempts to access uninitialized memory.
2070 void PoisonWith(void* dest, int nitems, type, U8 byte)
2073 Found in file handy.h
2078 The XSUB-writer's interface to the C C<realloc> function.
2080 void Renew(void* ptr, int nitems, type)
2083 Found in file handy.h
2088 The XSUB-writer's interface to the C C<realloc> function, with
2091 void Renewc(void* ptr, int nitems, type, cast)
2094 Found in file handy.h
2099 The XSUB-writer's interface to the C C<free> function.
2101 void Safefree(void* ptr)
2104 Found in file handy.h
2109 Perl's version of C<strdup()>. Returns a pointer to a newly allocated
2110 string which is a duplicate of C<pv>. The size of the string is
2111 determined by C<strlen()>. The memory allocated for the new string can
2112 be freed with the C<Safefree()> function.
2114 char* savepv(const char* pv)
2117 Found in file util.c
2122 Perl's version of what C<strndup()> would be if it existed. Returns a
2123 pointer to a newly allocated string which is a duplicate of the first
2124 C<len> bytes from C<pv>, plus a trailing NUL byte. The memory allocated for
2125 the new string can be freed with the C<Safefree()> function.
2127 char* savepvn(const char* pv, I32 len)
2130 Found in file util.c
2135 A version of C<savepv()> which allocates the duplicate string in memory
2136 which is shared between threads.
2138 char* savesharedpv(const char* pv)
2141 Found in file util.c
2146 A version of C<savepv()>/C<savepvn()> which gets the string to duplicate from
2147 the passed in SV using C<SvPV()>
2149 char* savesvpv(SV* sv)
2152 Found in file util.c
2157 This is an architecture-independent macro to copy one structure to another.
2159 void StructCopy(type src, type dest, type)
2162 Found in file handy.h
2167 The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the
2168 destination, C<nitems> is the number of items, and C<type> is the type.
2170 void Zero(void* dest, int nitems, type)
2173 Found in file handy.h
2178 Like C<Zero> but returns dest. Useful for encouraging compilers to tail-call
2181 void * ZeroD(void* dest, int nitems, type)
2184 Found in file handy.h
2189 =head1 Miscellaneous Functions
2196 Analyses the string in order to make fast searches on it using fbm_instr()
2197 -- the Boyer-Moore algorithm.
2199 void fbm_compile(SV* sv, U32 flags)
2202 Found in file util.c
2207 Returns the location of the SV in the string delimited by C<str> and
2208 C<strend>. It returns C<NULL> if the string can't be found. The C<sv>
2209 does not have to be fbm_compiled, but the search will not be as fast
2212 char* fbm_instr(unsigned char* big, unsigned char* bigend, SV* littlesv, U32 flags)
2215 Found in file util.c
2220 Takes a sprintf-style format pattern and conventional
2221 (non-SV) arguments and returns the formatted string.
2223 (char *) Perl_form(pTHX_ const char* pat, ...)
2225 can be used any place a string (char *) is required:
2227 char * s = Perl_form("%d.%d",major,minor);
2229 Uses a single private buffer so if you want to format several strings you
2230 must explicitly copy the earlier strings away (and free the copies when you
2233 char* form(const char* pat, ...)
2236 Found in file util.c
2241 Fill the sv with current working directory
2243 int getcwd_sv(SV* sv)
2246 Found in file util.c
2251 The C library C<sprintf>, wrapped if necessary, to ensure that it will return
2252 the length of the string written to the buffer. Only rare pre-ANSI systems
2253 need the wrapper function - usually this is a direct call to C<sprintf>.
2255 int my_sprintf(char *buffer, const char *pat, ...)
2258 Found in file util.c
2263 Returns a new version object based on the passed in SV:
2265 SV *sv = new_version(SV *ver);
2267 Does not alter the passed in ver SV. See "upg_version" if you
2268 want to upgrade the SV.
2270 SV* new_version(SV *ver)
2273 Found in file util.c
2278 Returns a pointer to the next character after the parsed
2279 version string, as well as upgrading the passed in SV to
2282 Function must be called with an already existing SV like
2285 s = scan_version(s,SV *sv, bool qv);
2287 Performs some preprocessing to the string to ensure that
2288 it has the correct characteristics of a version. Flags the
2289 object if it contains an underscore (which denotes this
2290 is a alpha version). The boolean qv denotes that the version
2291 should be interpreted as if it had multiple decimals, even if
2294 const char* scan_version(const char *vstr, SV *sv, bool qv)
2297 Found in file util.c
2302 Test two strings to see if they are equal. Returns true or false.
2304 bool strEQ(char* s1, char* s2)
2307 Found in file handy.h
2312 Test two strings to see if the first, C<s1>, is greater than or equal to
2313 the second, C<s2>. Returns true or false.
2315 bool strGE(char* s1, char* s2)
2318 Found in file handy.h
2323 Test two strings to see if the first, C<s1>, is greater than the second,
2324 C<s2>. Returns true or false.
2326 bool strGT(char* s1, char* s2)
2329 Found in file handy.h
2334 Test two strings to see if the first, C<s1>, is less than or equal to the
2335 second, C<s2>. Returns true or false.
2337 bool strLE(char* s1, char* s2)
2340 Found in file handy.h
2345 Test two strings to see if the first, C<s1>, is less than the second,
2346 C<s2>. Returns true or false.
2348 bool strLT(char* s1, char* s2)
2351 Found in file handy.h
2356 Test two strings to see if they are different. Returns true or
2359 bool strNE(char* s1, char* s2)
2362 Found in file handy.h
2367 Test two strings to see if they are equal. The C<len> parameter indicates
2368 the number of bytes to compare. Returns true or false. (A wrapper for
2371 bool strnEQ(char* s1, char* s2, STRLEN len)
2374 Found in file handy.h
2379 Test two strings to see if they are different. The C<len> parameter
2380 indicates the number of bytes to compare. Returns true or false. (A
2381 wrapper for C<strncmp>).
2383 bool strnNE(char* s1, char* s2, STRLEN len)
2386 Found in file handy.h
2391 Dummy routine which "shares" an SV when there is no sharing module present.
2392 Or "locks" it. Or "unlocks" it. In other words, ignores its single SV argument.
2393 Exists to avoid test for a NULL function pointer and because it could
2394 potentially warn under some level of strict-ness.
2396 void sv_nosharing(SV *sv)
2399 Found in file util.c
2404 In-place upgrade of the supplied SV to a version object.
2406 SV *sv = upg_version(SV *sv);
2408 Returns a pointer to the upgraded SV.
2410 SV* upg_version(SV *ver)
2413 Found in file util.c
2418 Version object aware cmp. Both operands must already have been
2419 converted into version objects.
2421 int vcmp(SV *lvs, SV *rvs)
2424 Found in file util.c
2429 Accepts a version object and returns the normalized string
2430 representation. Call like:
2434 NOTE: you can pass either the object directly or the SV
2435 contained within the RV.
2440 Found in file util.c
2445 Accepts a version object and returns the normalized floating
2446 point representation. Call like:
2450 NOTE: you can pass either the object directly or the SV
2451 contained within the RV.
2456 Found in file util.c
2461 In order to maintain maximum compatibility with earlier versions
2462 of Perl, this function will return either the floating point
2463 notation or the multiple dotted notation, depending on whether
2464 the original version contained 1 or more dots, respectively
2466 SV* vstringify(SV *vs)
2469 Found in file util.c
2474 Validates that the SV contains a valid version object.
2476 bool vverify(SV *vobj);
2478 Note that it only confirms the bare minimum structure (so as not to get
2479 confused by derived classes which may contain additional hash entries):
2481 bool vverify(SV *vs)
2484 Found in file util.c
2489 =head1 Multicall Functions
2496 Declare local variables for a multicall. See L<perlcall/Lightweight Callbacks>.
2506 Make a lightweight callback. See L<perlcall/Lightweight Callbacks>.
2516 Closing bracket for a lightweight callback.
2517 See L<perlcall/Lightweight Callbacks>.
2524 =item PUSH_MULTICALL
2527 Opening bracket for a lightweight callback.
2528 See L<perlcall/Lightweight Callbacks>.
2538 =head1 Numeric functions
2545 converts a string representing a binary number to numeric form.
2547 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2548 conversion flags, and I<result> should be NULL or a pointer to an NV.
2549 The scan stops at the end of the string, or the first invalid character.
2550 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2551 invalid character will also trigger a warning.
2552 On return I<*len> is set to the length of the scanned string,
2553 and I<*flags> gives output flags.
2555 If the value is <= C<UV_MAX> it is returned as a UV, the output flags are clear,
2556 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_bin>
2557 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2558 and writes the value to I<*result> (or the value is discarded if I<result>
2561 The binary number may optionally be prefixed with "0b" or "b" unless
2562 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
2563 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the binary
2564 number may use '_' characters to separate digits.
2566 UV grok_bin(const char* start, STRLEN* len_p, I32* flags, NV *result)
2569 Found in file numeric.c
2574 converts a string representing a hex number to numeric form.
2576 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2577 conversion flags, and I<result> should be NULL or a pointer to an NV.
2578 The scan stops at the end of the string, or the first invalid character.
2579 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2580 invalid character will also trigger a warning.
2581 On return I<*len> is set to the length of the scanned string,
2582 and I<*flags> gives output flags.
2584 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2585 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_hex>
2586 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2587 and writes the value to I<*result> (or the value is discarded if I<result>
2590 The hex number may optionally be prefixed with "0x" or "x" unless
2591 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
2592 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the hex
2593 number may use '_' characters to separate digits.
2595 UV grok_hex(const char* start, STRLEN* len_p, I32* flags, NV *result)
2598 Found in file numeric.c
2603 Recognise (or not) a number. The type of the number is returned
2604 (0 if unrecognised), otherwise it is a bit-ORed combination of
2605 IS_NUMBER_IN_UV, IS_NUMBER_GREATER_THAN_UV_MAX, IS_NUMBER_NOT_INT,
2606 IS_NUMBER_NEG, IS_NUMBER_INFINITY, IS_NUMBER_NAN (defined in perl.h).
2608 If the value of the number can fit an in UV, it is returned in the *valuep
2609 IS_NUMBER_IN_UV will be set to indicate that *valuep is valid, IS_NUMBER_IN_UV
2610 will never be set unless *valuep is valid, but *valuep may have been assigned
2611 to during processing even though IS_NUMBER_IN_UV is not set on return.
2612 If valuep is NULL, IS_NUMBER_IN_UV will be set for the same cases as when
2613 valuep is non-NULL, but no actual assignment (or SEGV) will occur.
2615 IS_NUMBER_NOT_INT will be set with IS_NUMBER_IN_UV if trailing decimals were
2616 seen (in which case *valuep gives the true value truncated to an integer), and
2617 IS_NUMBER_NEG if the number is negative (in which case *valuep holds the
2618 absolute value). IS_NUMBER_IN_UV is not set if e notation was used or the
2619 number is larger than a UV.
2621 int grok_number(const char *pv, STRLEN len, UV *valuep)
2624 Found in file numeric.c
2626 =item grok_numeric_radix
2627 X<grok_numeric_radix>
2629 Scan and skip for a numeric decimal separator (radix).
2631 bool grok_numeric_radix(const char **sp, const char *send)
2634 Found in file numeric.c
2639 converts a string representing an octal number to numeric form.
2641 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2642 conversion flags, and I<result> should be NULL or a pointer to an NV.
2643 The scan stops at the end of the string, or the first invalid character.
2644 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2645 invalid character will also trigger a warning.
2646 On return I<*len> is set to the length of the scanned string,
2647 and I<*flags> gives output flags.
2649 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2650 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_oct>
2651 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2652 and writes the value to I<*result> (or the value is discarded if I<result>
2655 If C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the octal
2656 number may use '_' characters to separate digits.
2658 UV grok_oct(const char* start, STRLEN* len_p, I32* flags, NV *result)
2661 Found in file numeric.c
2666 For backwards compatibility. Use C<grok_bin> instead.
2668 NV scan_bin(const char* start, STRLEN len, STRLEN* retlen)
2671 Found in file numeric.c
2676 For backwards compatibility. Use C<grok_hex> instead.
2678 NV scan_hex(const char* start, STRLEN len, STRLEN* retlen)
2681 Found in file numeric.c
2686 For backwards compatibility. Use C<grok_oct> instead.
2688 NV scan_oct(const char* start, STRLEN len, STRLEN* retlen)
2691 Found in file numeric.c
2696 =head1 Optree Manipulation Functions
2703 If C<cv> is a constant sub eligible for inlining. returns the constant
2704 value returned by the sub. Otherwise, returns NULL.
2706 Constant subs can be created with C<newCONSTSUB> or as described in
2707 L<perlsub/"Constant Functions">.
2709 SV* cv_const_sv(CV* cv)
2717 Creates a constant sub equivalent to Perl C<sub FOO () { 123 }> which is
2718 eligible for inlining at compile-time.
2720 CV* newCONSTSUB(HV* stash, const char* name, SV* sv)
2728 Used by C<xsubpp> to hook up XSUBs as Perl subs.
2736 =head1 Pad Data Structures
2743 Get the value at offset po in the current pad.
2744 Use macro PAD_SV instead of calling this function directly.
2746 SV* pad_sv(PADOFFSET po)
2754 =head1 Simple Exception Handling Macros
2761 Set up necessary local variables for exception handling.
2762 See L<perlguts/"Exception Handling">.
2767 Found in file XSUB.h
2772 Introduces a catch block. See L<perlguts/"Exception Handling">.
2775 Found in file XSUB.h
2780 Rethrows a previously caught exception. See L<perlguts/"Exception Handling">.
2785 Found in file XSUB.h
2790 Ends a try block. See L<perlguts/"Exception Handling">.
2793 Found in file XSUB.h
2795 =item XCPT_TRY_START
2798 Starts a try block. See L<perlguts/"Exception Handling">.
2801 Found in file XSUB.h
2806 =head1 Stack Manipulation Macros
2813 Declare a stack marker variable, C<mark>, for the XSUB. See C<MARK> and
2824 Saves the original stack mark for the XSUB. See C<ORIGMARK>.
2834 Declares a local copy of perl's stack pointer for the XSUB, available via
2835 the C<SP> macro. See C<SP>.
2845 Used to extend the argument stack for an XSUB's return values. Once
2846 used, guarantees that there is room for at least C<nitems> to be pushed
2849 void EXTEND(SP, int nitems)
2857 Stack marker variable for the XSUB. See C<dMARK>.
2865 Push an integer onto the stack. The stack must have room for this element.
2866 Handles 'set' magic. Does not use C<TARG>. See also C<PUSHi>, C<mXPUSHi>
2877 Push a double onto the stack. The stack must have room for this element.
2878 Handles 'set' magic. Does not use C<TARG>. See also C<PUSHn>, C<mXPUSHn>
2889 Push a string onto the stack. The stack must have room for this element.
2890 The C<len> indicates the length of the string. Handles 'set' magic. Does
2891 not use C<TARG>. See also C<PUSHp>, C<mXPUSHp> and C<XPUSHp>.
2893 void mPUSHp(char* str, STRLEN len)
2901 Push an unsigned integer onto the stack. The stack must have room for this
2902 element. Handles 'set' magic. Does not use C<TARG>. See also C<PUSHu>,
2903 C<mXPUSHu> and C<XPUSHu>.
2913 Push an integer onto the stack, extending the stack if necessary. Handles
2914 'set' magic. Does not use C<TARG>. See also C<XPUSHi>, C<mPUSHi> and
2925 Push a double onto the stack, extending the stack if necessary. Handles
2926 'set' magic. Does not use C<TARG>. See also C<XPUSHn>, C<mPUSHn> and
2937 Push a string onto the stack, extending the stack if necessary. The C<len>
2938 indicates the length of the string. Handles 'set' magic. Does not use
2939 C<TARG>. See also C<XPUSHp>, C<mPUSHp> and C<PUSHp>.
2941 void mXPUSHp(char* str, STRLEN len)
2949 Push an unsigned integer onto the stack, extending the stack if necessary.
2950 Handles 'set' magic. Does not use C<TARG>. See also C<XPUSHu>, C<mPUSHu>
2961 The original stack mark for the XSUB. See C<dORIGMARK>.
2969 Pops an integer off the stack.
2979 Pops a long off the stack.
2989 Pops a double off the stack.
2999 Pops a string off the stack. Deprecated. New code should use POPpx.
3009 Pops a string off the stack which must consist of bytes i.e. characters < 256.
3019 Pops a string off the stack.
3029 Pops an SV off the stack.
3039 Push an integer onto the stack. The stack must have room for this element.
3040 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3041 called to declare it. Do not call multiple C<TARG>-oriented macros to
3042 return lists from XSUB's - see C<mPUSHi> instead. See also C<XPUSHi> and
3053 Opening bracket for arguments on a callback. See C<PUTBACK> and
3064 Push a new mortal SV onto the stack. The stack must have room for this
3065 element. Does not handle 'set' magic. Does not use C<TARG>. See also
3066 C<PUSHs>, C<XPUSHmortal> and C<XPUSHs>.
3076 Push a double onto the stack. The stack must have room for this element.
3077 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3078 called to declare it. Do not call multiple C<TARG>-oriented macros to
3079 return lists from XSUB's - see C<mPUSHn> instead. See also C<XPUSHn> and
3090 Push a string onto the stack. The stack must have room for this element.
3091 The C<len> indicates the length of the string. Handles 'set' magic. Uses
3092 C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to declare it. Do not
3093 call multiple C<TARG>-oriented macros to return lists from XSUB's - see
3094 C<mPUSHp> instead. See also C<XPUSHp> and C<mXPUSHp>.
3096 void PUSHp(char* str, STRLEN len)
3104 Push an SV onto the stack. The stack must have room for this element.
3105 Does not handle 'set' magic. Does not use C<TARG>. See also C<PUSHmortal>,
3106 C<XPUSHs> and C<XPUSHmortal>.
3116 Push an unsigned integer onto the stack. The stack must have room for this
3117 element. Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG>
3118 should be called to declare it. Do not call multiple C<TARG>-oriented
3119 macros to return lists from XSUB's - see C<mPUSHu> instead. See also
3120 C<XPUSHu> and C<mXPUSHu>.
3130 Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
3131 See C<PUSHMARK> and L<perlcall> for other uses.
3141 Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and
3150 Refetch the stack pointer. Used after a callback. See L<perlcall>.
3160 Push an integer onto the stack, extending the stack if necessary. Handles
3161 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
3162 declare it. Do not call multiple C<TARG>-oriented macros to return lists
3163 from XSUB's - see C<mXPUSHi> instead. See also C<PUSHi> and C<mPUSHi>.
3173 Push a new mortal SV onto the stack, extending the stack if necessary. Does
3174 not handle 'set' magic. Does not use C<TARG>. See also C<XPUSHs>,
3175 C<PUSHmortal> and C<PUSHs>.
3185 Push a double onto the stack, extending the stack if necessary. Handles
3186 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
3187 declare it. Do not call multiple C<TARG>-oriented macros to return lists
3188 from XSUB's - see C<mXPUSHn> instead. See also C<PUSHn> and C<mPUSHn>.
3198 Push a string onto the stack, extending the stack if necessary. The C<len>
3199 indicates the length of the string. Handles 'set' magic. Uses C<TARG>, so
3200 C<dTARGET> or C<dXSTARG> should be called to declare it. Do not call
3201 multiple C<TARG>-oriented macros to return lists from XSUB's - see
3202 C<mXPUSHp> instead. See also C<PUSHp> and C<mPUSHp>.
3204 void XPUSHp(char* str, STRLEN len)
3212 Push an SV onto the stack, extending the stack if necessary. Does not
3213 handle 'set' magic. Does not use C<TARG>. See also C<XPUSHmortal>,
3214 C<PUSHs> and C<PUSHmortal>.
3224 Push an unsigned integer onto the stack, extending the stack if necessary.
3225 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3226 called to declare it. Do not call multiple C<TARG>-oriented macros to
3227 return lists from XSUB's - see C<mXPUSHu> instead. See also C<PUSHu> and
3238 Return from XSUB, indicating number of items on the stack. This is usually
3239 handled by C<xsubpp>.
3241 void XSRETURN(int nitems)
3244 Found in file XSUB.h
3246 =item XSRETURN_EMPTY
3249 Return an empty list from an XSUB immediately.
3254 Found in file XSUB.h
3259 Return an integer from an XSUB immediately. Uses C<XST_mIV>.
3261 void XSRETURN_IV(IV iv)
3264 Found in file XSUB.h
3269 Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
3274 Found in file XSUB.h
3279 Return a double from an XSUB immediately. Uses C<XST_mNV>.
3281 void XSRETURN_NV(NV nv)
3284 Found in file XSUB.h
3289 Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
3291 void XSRETURN_PV(char* str)
3294 Found in file XSUB.h
3296 =item XSRETURN_UNDEF
3299 Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
3304 Found in file XSUB.h
3309 Return an integer from an XSUB immediately. Uses C<XST_mUV>.
3311 void XSRETURN_UV(IV uv)
3314 Found in file XSUB.h
3319 Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
3324 Found in file XSUB.h
3329 Place an integer into the specified position C<pos> on the stack. The
3330 value is stored in a new mortal SV.
3332 void XST_mIV(int pos, IV iv)
3335 Found in file XSUB.h
3340 Place C<&PL_sv_no> into the specified position C<pos> on the
3343 void XST_mNO(int pos)
3346 Found in file XSUB.h
3351 Place a double into the specified position C<pos> on the stack. The value
3352 is stored in a new mortal SV.
3354 void XST_mNV(int pos, NV nv)
3357 Found in file XSUB.h
3362 Place a copy of a string into the specified position C<pos> on the stack.
3363 The value is stored in a new mortal SV.
3365 void XST_mPV(int pos, char* str)
3368 Found in file XSUB.h
3373 Place C<&PL_sv_undef> into the specified position C<pos> on the
3376 void XST_mUNDEF(int pos)
3379 Found in file XSUB.h
3384 Place C<&PL_sv_yes> into the specified position C<pos> on the
3387 void XST_mYES(int pos)
3390 Found in file XSUB.h
3402 An enum of flags for Perl types. These are found in the file B<sv.h>
3403 in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
3411 Integer type flag for scalars. See C<svtype>.
3419 Double type flag for scalars. See C<svtype>.
3427 Pointer type flag for scalars. See C<svtype>.
3435 Type flag for arrays. See C<svtype>.
3443 Type flag for code refs. See C<svtype>.
3451 Type flag for hashes. See C<svtype>.
3459 Type flag for blessed scalars. See C<svtype>.
3467 =head1 SV Manipulation Functions
3474 Returns the SV of the specified Perl scalar. If C<create> is set and the
3475 Perl variable does not exist then it will be created. If C<create> is not
3476 set and the variable does not exist then NULL is returned.
3478 NOTE: the perl_ form of this function is deprecated.
3480 SV* get_sv(const char* name, I32 create)
3483 Found in file perl.c
3488 Creates an RV wrapper for an SV. The reference count for the original SV is
3491 SV* newRV_inc(SV* sv)
3499 Returns the length of the string which is in the SV. See C<SvLEN>.
3501 STRLEN SvCUR(SV* sv)
3509 Set the current length of the string which is in the SV. See C<SvCUR>
3512 void SvCUR_set(SV* sv, STRLEN len)
3520 Returns a pointer to the last character in the string which is in the SV.
3521 See C<SvCUR>. Access the character as *(SvEND(sv)).
3531 Returns true if the SV has get magic or overloading. If either is true then
3532 the scalar is active data, and has the potential to return a new value every
3533 time it is accessed. Hence you must be careful to only read it once per user
3534 logical operation and work with that returned value. If neither is true then
3535 the scalar's value cannot change unless written to.
3537 char* SvGAMAGIC(SV* sv)
3545 Expands the character buffer in the SV so that it has room for the
3546 indicated number of bytes (remember to reserve space for an extra trailing
3547 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
3548 Returns a pointer to the character buffer.
3550 char * SvGROW(SV* sv, STRLEN len)
3558 Returns a boolean indicating whether the SV contains an integer.
3568 Returns a boolean indicating whether the SV contains an integer. Checks
3569 the B<private> setting. Use C<SvIOK>.
3579 Returns a boolean indicating whether the SV contains a signed integer.
3581 bool SvIOK_notUV(SV* sv)
3589 Unsets the IV status of an SV.
3591 void SvIOK_off(SV* sv)
3599 Tells an SV that it is an integer.
3601 void SvIOK_on(SV* sv)
3609 Tells an SV that it is an integer and disables all other OK bits.
3611 void SvIOK_only(SV* sv)
3619 Tells and SV that it is an unsigned integer and disables all other OK bits.
3621 void SvIOK_only_UV(SV* sv)
3629 Returns a boolean indicating whether the SV contains an unsigned integer.
3631 bool SvIOK_UV(SV* sv)
3639 Returns a boolean indicating whether the SV is Copy-On-Write. (either shared
3640 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
3643 bool SvIsCOW(SV* sv)
3648 =item SvIsCOW_shared_hash
3649 X<SvIsCOW_shared_hash>
3651 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
3654 bool SvIsCOW_shared_hash(SV* sv)
3662 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
3663 version which guarantees to evaluate sv only once.
3673 Returns the raw value in the SV's IV slot, without checks or conversions.
3674 Only use when you are sure SvIOK is true. See also C<SvIV()>.
3684 Coerces the given SV to an integer and returns it. Guarantees to evaluate
3685 sv only once. Use the more efficient C<SvIV> otherwise.
3695 Like C<SvIV> but doesn't process magic.
3697 IV SvIV_nomg(SV* sv)
3705 Set the value of the IV pointer in sv to val. It is possible to perform
3706 the same function of this macro with an lvalue assignment to C<SvIVX>.
3707 With future Perls, however, it will be more efficient to use
3708 C<SvIV_set> instead of the lvalue assignment to C<SvIVX>.
3710 void SvIV_set(SV* sv, IV val)
3718 Returns the size of the string buffer in the SV, not including any part
3719 attributable to C<SvOOK>. See C<SvCUR>.
3721 STRLEN SvLEN(SV* sv)
3729 Set the actual length of the string which is in the SV. See C<SvIV_set>.
3731 void SvLEN_set(SV* sv, STRLEN len)
3739 Set the value of the MAGIC pointer in sv to val. See C<SvIV_set>.
3741 void SvMAGIC_set(SV* sv, MAGIC* val)
3749 Returns a boolean indicating whether the SV contains a number, integer or
3760 Returns a boolean indicating whether the SV contains a number, integer or
3761 double. Checks the B<private> setting. Use C<SvNIOK>.
3763 bool SvNIOKp(SV* sv)
3771 Unsets the NV/IV status of an SV.
3773 void SvNIOK_off(SV* sv)
3781 Returns a boolean indicating whether the SV contains a double.
3791 Returns a boolean indicating whether the SV contains a double. Checks the
3792 B<private> setting. Use C<SvNOK>.
3802 Unsets the NV status of an SV.
3804 void SvNOK_off(SV* sv)
3812 Tells an SV that it is a double.
3814 void SvNOK_on(SV* sv)
3822 Tells an SV that it is a double and disables all other OK bits.
3824 void SvNOK_only(SV* sv)
3832 Coerce the given SV to a double and return it. See C<SvNVx> for a version
3833 which guarantees to evaluate sv only once.
3843 Returns the raw value in the SV's NV slot, without checks or conversions.
3844 Only use when you are sure SvNOK is true. See also C<SvNV()>.
3854 Coerces the given SV to a double and returns it. Guarantees to evaluate
3855 sv only once. Use the more efficient C<SvNV> otherwise.
3865 Set the value of the NV pointer in sv to val. See C<SvIV_set>.
3867 void SvNV_set(SV* sv, NV val)
3875 Returns a boolean indicating whether the value is an SV. It also tells
3876 whether the value is defined or not.
3886 Returns a boolean indicating whether the SvIVX is a valid offset value for
3887 the SvPVX. This hack is used internally to speed up removal of characters
3888 from the beginning of a SvPV. When SvOOK is true, then the start of the
3889 allocated string buffer is really (SvPVX - SvIVX).
3899 Returns a boolean indicating whether the SV contains a character
3910 Returns a boolean indicating whether the SV contains a character string.
3911 Checks the B<private> setting. Use C<SvPOK>.
3921 Unsets the PV status of an SV.
3923 void SvPOK_off(SV* sv)
3931 Tells an SV that it is a string.
3933 void SvPOK_on(SV* sv)
3941 Tells an SV that it is a string and disables all other OK bits.
3942 Will also turn off the UTF-8 status.
3944 void SvPOK_only(SV* sv)
3949 =item SvPOK_only_UTF8
3952 Tells an SV that it is a string and disables all other OK bits,
3953 and leaves the UTF-8 status as it was.
3955 void SvPOK_only_UTF8(SV* sv)
3963 Returns a pointer to the string in the SV, or a stringified form of
3964 the SV if the SV does not contain a string. The SV may cache the
3965 stringified version becoming C<SvPOK>. Handles 'get' magic. See also
3966 C<SvPVx> for a version which guarantees to evaluate sv only once.
3968 char* SvPV(SV* sv, STRLEN len)
3976 Like C<SvPV>, but converts sv to byte representation first if necessary.
3978 char* SvPVbyte(SV* sv, STRLEN len)
3986 Like C<SvPV>, but converts sv to byte representation first if necessary.
3987 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
3990 char* SvPVbytex(SV* sv, STRLEN len)
3995 =item SvPVbytex_force
3998 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
3999 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
4002 char* SvPVbytex_force(SV* sv, STRLEN len)
4007 =item SvPVbyte_force
4010 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
4012 char* SvPVbyte_force(SV* sv, STRLEN len)
4017 =item SvPVbyte_nolen
4020 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
4022 char* SvPVbyte_nolen(SV* sv)
4030 Like C<SvPV>, but converts sv to utf8 first if necessary.
4032 char* SvPVutf8(SV* sv, STRLEN len)
4040 Like C<SvPV>, but converts sv to utf8 first if necessary.
4041 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
4044 char* SvPVutf8x(SV* sv, STRLEN len)
4049 =item SvPVutf8x_force
4052 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
4053 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
4056 char* SvPVutf8x_force(SV* sv, STRLEN len)
4061 =item SvPVutf8_force
4064 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
4066 char* SvPVutf8_force(SV* sv, STRLEN len)
4071 =item SvPVutf8_nolen
4074 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
4076 char* SvPVutf8_nolen(SV* sv)
4084 Returns a pointer to the physical string in the SV. The SV must contain a
4095 A version of C<SvPV> which guarantees to evaluate sv only once.
4097 char* SvPVx(SV* sv, STRLEN len)
4105 Like C<SvPV> but will force the SV into containing just a string
4106 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
4109 char* SvPV_force(SV* sv, STRLEN len)
4114 =item SvPV_force_nomg
4117 Like C<SvPV> but will force the SV into containing just a string
4118 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
4119 directly. Doesn't process magic.
4121 char* SvPV_force_nomg(SV* sv, STRLEN len)
4129 Returns a pointer to the string in the SV, or a stringified form of
4130 the SV if the SV does not contain a string. The SV may cache the
4131 stringified form becoming C<SvPOK>. Handles 'get' magic.
4133 char* SvPV_nolen(SV* sv)
4141 Like C<SvPV> but doesn't process magic.
4143 char* SvPV_nomg(SV* sv, STRLEN len)
4151 Set the value of the PV pointer in sv to val. See C<SvIV_set>.
4153 void SvPV_set(SV* sv, char* val)
4161 Returns the value of the object's reference count.
4163 U32 SvREFCNT(SV* sv)
4171 Decrements the reference count of the given SV.
4173 void SvREFCNT_dec(SV* sv)
4181 Increments the reference count of the given SV.
4183 SV* SvREFCNT_inc(SV* sv)
4188 =item SvREFCNT_inc_NN
4191 Same as SvREFCNT_inc, but can only be used if you know I<sv>
4192 is not NULL. Since we don't have to check the NULLness, it's faster
4195 SV* SvREFCNT_inc_NN(SV* sv)
4200 =item SvREFCNT_inc_simple
4201 X<SvREFCNT_inc_simple>
4203 Same as SvREFCNT_inc, but can only be used with simple variables, not
4204 expressions or pointer dereferences. Since we don't have to store a
4205 temporary value, it's faster.
4207 SV* SvREFCNT_inc_simple(SV* sv)
4212 =item SvREFCNT_inc_simple_NN
4213 X<SvREFCNT_inc_simple_NN>
4215 Same as SvREFCNT_inc_simple, but can only be used if you know I<sv>
4216 is not NULL. Since we don't have to check the NULLness, it's faster
4219 SV* SvREFCNT_inc_simple_NN(SV* sv)
4224 =item SvREFCNT_inc_simple_void
4225 X<SvREFCNT_inc_simple_void>
4227 Same as SvREFCNT_inc_simple, but can only be used if you don't need the
4228 return value. The macro doesn't need to return a meaningful value.
4230 SV* SvREFCNT_inc_simple_void(SV* sv)
4235 =item SvREFCNT_inc_void
4236 X<SvREFCNT_inc_void>
4238 Same as SvREFCNT_inc, but can only be used if you don't need the
4239 return value. The macro doesn't need to return a meaningful value.
4241 SV* SvREFCNT_inc_void(SV* sv)
4246 =item SvREFCNT_inc_void_NN
4247 X<SvREFCNT_inc_void_NN>
4249 Same as SvREFCNT_inc, but can only be used if you don't need the return
4250 value, and you know that I<sv> is not NULL. The macro doesn't need
4251 to return a meaningful value, or check for NULLness, so it's smaller
4254 SV* SvREFCNT_inc_void_NN(SV* sv)
4262 Tests if the SV is an RV.
4272 Unsets the RV status of an SV.
4274 void SvROK_off(SV* sv)
4282 Tells an SV that it is an RV.
4284 void SvROK_on(SV* sv)
4292 Dereferences an RV to return the SV.
4302 Set the value of the RV pointer in sv to val. See C<SvIV_set>.
4304 void SvRV_set(SV* sv, SV* val)
4312 Returns the stash of the SV.
4322 Set the value of the STASH pointer in sv to val. See C<SvIV_set>.
4324 void SvSTASH_set(SV* sv, STASH* val)
4332 Taints an SV if tainting is enabled.
4334 void SvTAINT(SV* sv)
4342 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
4345 bool SvTAINTED(SV* sv)
4353 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
4354 some of Perl's fundamental security features. XS module authors should not
4355 use this function unless they fully understand all the implications of
4356 unconditionally untainting the value. Untainting should be done in the
4357 standard perl fashion, via a carefully crafted regexp, rather than directly
4358 untainting variables.
4360 void SvTAINTED_off(SV* sv)
4368 Marks an SV as tainted if tainting is enabled.
4370 void SvTAINTED_on(SV* sv)
4378 Returns a boolean indicating whether Perl would evaluate the SV as true or
4379 false, defined or undefined. Does not handle 'get' magic.
4389 Returns the type of the SV. See C<svtype>.
4391 svtype SvTYPE(SV* sv)
4399 Returns a boolean indicating whether the SV contains an unsigned integer.
4409 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
4410 perform the upgrade if necessary. See C<svtype>.
4412 void SvUPGRADE(SV* sv, svtype type)
4420 Returns a boolean indicating whether the SV contains UTF-8 encoded data.
4430 Unsets the UTF-8 status of an SV.
4432 void SvUTF8_off(SV *sv)
4440 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
4441 Do not use frivolously.
4443 void SvUTF8_on(SV *sv)
4451 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
4452 for a version which guarantees to evaluate sv only once.
4462 Returns the raw value in the SV's UV slot, without checks or conversions.
4463 Only use when you are sure SvIOK is true. See also C<SvUV()>.
4473 Coerces the given SV to an unsigned integer and returns it. Guarantees to
4474 evaluate sv only once. Use the more efficient C<SvUV> otherwise.
4484 Like C<SvUV> but doesn't process magic.
4486 UV SvUV_nomg(SV* sv)
4494 Set the value of the UV pointer in sv to val. See C<SvIV_set>.
4496 void SvUV_set(SV* sv, UV val)
4504 Returns a boolean indicating whether the SV contains a v-string.
4511 =item sv_catpvn_nomg
4514 Like C<sv_catpvn> but doesn't process magic.
4516 void sv_catpvn_nomg(SV* sv, const char* ptr, STRLEN len)
4524 Like C<sv_catsv> but doesn't process magic.
4526 void sv_catsv_nomg(SV* dsv, SV* ssv)
4531 =item sv_derived_from
4534 Returns a boolean indicating whether the SV is derived from the specified
4535 class. This is the function that implements C<UNIVERSAL::isa>. It works
4536 for class names as well as for objects.
4538 bool sv_derived_from(SV* sv, const char* name)
4541 Found in file universal.c
4543 =item sv_report_used
4546 Dump the contents of all SVs not yet freed. (Debugging aid).
4548 void sv_report_used()
4556 Like C<sv_setsv> but doesn't process magic.
4558 void sv_setsv_nomg(SV* dsv, SV* ssv)
4566 =head1 SV-Body Allocation
4570 =item looks_like_number
4571 X<looks_like_number>
4573 Test if the content of an SV looks like a number (or is a number).
4574 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
4575 non-numeric warning), even if your atof() doesn't grok them.
4577 I32 looks_like_number(SV* sv)
4585 Creates an RV wrapper for an SV. The reference count for the original
4586 SV is B<not> incremented.
4588 SV* newRV_noinc(SV* sv)
4596 Creates a new SV. A non-zero C<len> parameter indicates the number of
4597 bytes of preallocated string space the SV should have. An extra byte for a
4598 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4599 space is allocated.) The reference count for the new SV is set to 1.
4601 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4602 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4603 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4604 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4605 modules supporting older perls.
4607 SV* newSV(STRLEN len)
4615 Creates a new SV from the hash key structure. It will generate scalars that
4616 point to the shared string table where possible. Returns a new (undefined)
4617 SV if the hek is NULL.
4619 SV* newSVhek(const HEK *hek)
4627 Creates a new SV and copies an integer into it. The reference count for the
4638 Creates a new SV and copies a floating point value into it.
4639 The reference count for the SV is set to 1.
4649 Creates a new SV and copies a string into it. The reference count for the
4650 SV is set to 1. If C<len> is zero, Perl will compute the length using
4651 strlen(). For efficiency, consider using C<newSVpvn> instead.
4653 SV* newSVpv(const char* s, STRLEN len)
4661 Creates a new SV and initializes it with the string formatted like
4664 SV* newSVpvf(const char* pat, ...)
4672 Creates a new SV and copies a string into it. The reference count for the
4673 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
4674 string. You are responsible for ensuring that the source string is at least
4675 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
4677 SV* newSVpvn(const char* s, STRLEN len)
4682 =item newSVpvn_share
4685 Creates a new SV with its SvPVX_const pointing to a shared string in the string
4686 table. If the string does not already exist in the table, it is created
4687 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
4688 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
4689 otherwise the hash is computed. The idea here is that as the string table
4690 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
4691 hash lookup will avoid string compare.
4693 SV* newSVpvn_share(const char* s, I32 len, U32 hash)
4701 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
4702 it will be upgraded to one. If C<classname> is non-null then the new SV will
4703 be blessed in the specified package. The new SV is returned and its
4704 reference count is 1.
4706 SV* newSVrv(SV* rv, const char* classname)
4714 Creates a new SV which is an exact duplicate of the original SV.
4717 SV* newSVsv(SV* old)
4725 Creates a new SV and copies an unsigned integer into it.
4726 The reference count for the SV is set to 1.
4736 This function is only called on magical items, and is only used by
4737 sv_true() or its macro equivalent.
4739 bool sv_2bool(SV* sv)
4747 Using various gambits, try to get a CV from an SV; in addition, try if
4748 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
4749 The flags in C<lref> are passed to sv_fetchsv.
4751 CV* sv_2cv(SV* sv, HV** st, GV** gvp, I32 lref)
4759 Using various gambits, try to get an IO from an SV: the IO slot if its a
4760 GV; or the recursive result if we're an RV; or the IO slot of the symbol
4761 named after the PV if we're a string.
4771 Return the integer value of an SV, doing any necessary string
4772 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
4773 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
4775 IV sv_2iv_flags(SV* sv, I32 flags)
4783 Marks an existing SV as mortal. The SV will be destroyed "soon", either
4784 by an explicit call to FREETMPS, or by an implicit call at places such as
4785 statement boundaries. SvTEMP() is turned on which means that the SV's
4786 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
4787 and C<sv_mortalcopy>.
4789 SV* sv_2mortal(SV* sv)
4797 Return the num value of an SV, doing any necessary string or integer
4798 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
4809 Return a pointer to the byte-encoded representation of the SV, and set *lp
4810 to its length. May cause the SV to be downgraded from UTF-8 as a
4813 Usually accessed via the C<SvPVbyte> macro.
4815 char* sv_2pvbyte(SV* sv, STRLEN* lp)
4823 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
4824 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
4826 Usually accessed via the C<SvPVutf8> macro.
4828 char* sv_2pvutf8(SV* sv, STRLEN* lp)
4836 Returns a pointer to the string value of an SV, and sets *lp to its length.
4837 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
4839 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
4840 usually end up here too.
4842 char* sv_2pv_flags(SV* sv, STRLEN* lp, I32 flags)
4850 Return the unsigned integer value of an SV, doing any necessary string
4851 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
4852 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
4854 UV sv_2uv_flags(SV* sv, I32 flags)
4862 Remove any string offset. You should normally use the C<SvOOK_off> macro
4865 int sv_backoff(SV* sv)
4873 Blesses an SV into a specified package. The SV must be an RV. The package
4874 must be designated by its stash (see C<gv_stashpv()>). The reference count
4875 of the SV is unaffected.
4877 SV* sv_bless(SV* sv, HV* stash)
4885 Concatenates the string onto the end of the string which is in the SV.
4886 If the SV has the UTF-8 status set, then the bytes appended should be
4887 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4889 void sv_catpv(SV* sv, const char* ptr)
4897 Processes its arguments like C<sprintf> and appends the formatted
4898 output to an SV. If the appended data contains "wide" characters
4899 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
4900 and characters >255 formatted with %c), the original SV might get
4901 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
4902 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
4903 valid UTF-8; if the original SV was bytes, the pattern should be too.
4905 void sv_catpvf(SV* sv, const char* pat, ...)
4913 Like C<sv_catpvf>, but also handles 'set' magic.
4915 void sv_catpvf_mg(SV *sv, const char* pat, ...)
4923 Concatenates the string onto the end of the string which is in the SV. The
4924 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4925 status set, then the bytes appended should be valid UTF-8.
4926 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4928 void sv_catpvn(SV* sv, const char* ptr, STRLEN len)
4933 =item sv_catpvn_flags
4936 Concatenates the string onto the end of the string which is in the SV. The
4937 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4938 status set, then the bytes appended should be valid UTF-8.
4939 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4940 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4941 in terms of this function.
4943 void sv_catpvn_flags(SV* sv, const char* ptr, STRLEN len, I32 flags)
4951 Like C<sv_catpv>, but also handles 'set' magic.
4953 void sv_catpv_mg(SV *sv, const char *ptr)
4961 Concatenates the string from SV C<ssv> onto the end of the string in
4962 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4963 not 'set' magic. See C<sv_catsv_mg>.
4965 void sv_catsv(SV* dsv, SV* ssv)
4970 =item sv_catsv_flags
4973 Concatenates the string from SV C<ssv> onto the end of the string in
4974 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4975 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4976 and C<sv_catsv_nomg> are implemented in terms of this function.
4978 void sv_catsv_flags(SV* dsv, SV* ssv, I32 flags)
4986 Efficient removal of characters from the beginning of the string buffer.
4987 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4988 the string buffer. The C<ptr> becomes the first character of the adjusted
4989 string. Uses the "OOK hack".
4990 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4991 refer to the same chunk of data.
4993 void sv_chop(SV* sv, const char* ptr)
5001 Clear an SV: call any destructors, free up any memory used by the body,
5002 and free the body itself. The SV's head is I<not> freed, although
5003 its type is set to all 1's so that it won't inadvertently be assumed
5004 to be live during global destruction etc.
5005 This function should only be called when REFCNT is zero. Most of the time
5006 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5009 void sv_clear(SV* sv)
5017 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5018 string in C<sv1> is less than, equal to, or greater than the string in
5019 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5020 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
5022 I32 sv_cmp(SV* sv1, SV* sv2)
5030 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
5031 'use bytes' aware, handles get magic, and will coerce its args to strings
5032 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
5034 I32 sv_cmp_locale(SV* sv1, SV* sv2)
5042 Add Collate Transform magic to an SV if it doesn't already have it.
5044 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
5045 scalar data of the variable, but transformed to such a format that a normal
5046 memory comparison can be used to compare the data according to the locale
5049 char* sv_collxfrm(SV* sv, STRLEN* nxp)
5057 Copies a stringified representation of the source SV into the
5058 destination SV. Automatically performs any necessary mg_get and
5059 coercion of numeric values into strings. Guaranteed to preserve
5060 UTF-8 flag even from overloaded objects. Similar in nature to
5061 sv_2pv[_flags] but operates directly on an SV instead of just the
5062 string. Mostly uses sv_2pv_flags to do its work, except when that
5063 would lose the UTF-8'ness of the PV.
5065 void sv_copypv(SV* dsv, SV* ssv)
5073 Auto-decrement of the value in the SV, doing string to numeric conversion
5074 if necessary. Handles 'get' magic.
5084 Returns a boolean indicating whether the strings in the two SVs are
5085 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5086 coerce its args to strings if necessary.
5088 I32 sv_eq(SV* sv1, SV* sv2)
5093 =item sv_force_normal_flags
5094 X<sv_force_normal_flags>
5096 Undo various types of fakery on an SV: if the PV is a shared string, make
5097 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
5098 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
5099 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
5100 then a copy-on-write scalar drops its PV buffer (if any) and becomes
5101 SvPOK_off rather than making a copy. (Used where this scalar is about to be
5102 set to some other value.) In addition, the C<flags> parameter gets passed to
5103 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
5104 with flags set to 0.
5106 void sv_force_normal_flags(SV *sv, U32 flags)
5114 Decrement an SV's reference count, and if it drops to zero, call
5115 C<sv_clear> to invoke destructors and free up any memory used by
5116 the body; finally, deallocate the SV's head itself.
5117 Normally called via a wrapper macro C<SvREFCNT_dec>.
5119 void sv_free(SV* sv)
5127 Get a line from the filehandle and store it into the SV, optionally
5128 appending to the currently-stored string.
5130 char* sv_gets(SV* sv, PerlIO* fp, I32 append)
5138 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
5139 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
5140 Use the C<SvGROW> wrapper instead.
5142 char* sv_grow(SV* sv, STRLEN newlen)
5150 Auto-increment of the value in the SV, doing string to numeric conversion
5151 if necessary. Handles 'get' magic.
5161 Inserts a string at the specified offset/length within the SV. Similar to
5162 the Perl substr() function.
5164 void sv_insert(SV* bigsv, STRLEN offset, STRLEN len, const char* little, STRLEN littlelen)
5172 Returns a boolean indicating whether the SV is blessed into the specified
5173 class. This does not check for subtypes; use C<sv_derived_from> to verify
5174 an inheritance relationship.
5176 int sv_isa(SV* sv, const char* name)
5184 Returns a boolean indicating whether the SV is an RV pointing to a blessed
5185 object. If the SV is not an RV, or if the object is not blessed, then this
5188 int sv_isobject(SV* sv)
5196 Returns the length of the string in the SV. Handles magic and type
5197 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5199 STRLEN sv_len(SV* sv)
5207 Returns the number of characters in the string in an SV, counting wide
5208 UTF-8 bytes as a single character. Handles magic and type coercion.
5210 STRLEN sv_len_utf8(SV* sv)
5218 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
5219 then adds a new magic item of type C<how> to the head of the magic list.
5221 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
5222 handling of the C<name> and C<namlen> arguments.
5224 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
5225 to add more than one instance of the same 'how'.
5227 void sv_magic(SV* sv, SV* obj, int how, const char* name, I32 namlen)
5235 Adds magic to an SV, upgrading it if necessary. Applies the
5236 supplied vtable and returns a pointer to the magic added.
5238 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
5239 In particular, you can add magic to SvREADONLY SVs, and add more than
5240 one instance of the same 'how'.
5242 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
5243 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
5244 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
5245 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
5247 (This is now used as a subroutine by C<sv_magic>.)
5249 MAGIC * sv_magicext(SV* sv, SV* obj, int how, MGVTBL *vtbl, const char* name, I32 namlen)
5257 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
5258 The new SV is marked as mortal. It will be destroyed "soon", either by an
5259 explicit call to FREETMPS, or by an implicit call at places such as
5260 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
5262 SV* sv_mortalcopy(SV* oldsv)
5270 Creates a new null SV which is mortal. The reference count of the SV is
5271 set to 1. It will be destroyed "soon", either by an explicit call to
5272 FREETMPS, or by an implicit call at places such as statement boundaries.
5273 See also C<sv_mortalcopy> and C<sv_2mortal>.
5283 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5286 SV* sv_newref(SV* sv)
5294 Converts the value pointed to by offsetp from a count of bytes from the
5295 start of the string, to a count of the equivalent number of UTF-8 chars.
5296 Handles magic and type coercion.
5298 void sv_pos_b2u(SV* sv, I32* offsetp)
5306 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5307 the start of the string, to a count of the equivalent number of bytes; if
5308 lenp is non-zero, it does the same to lenp, but this time starting from
5309 the offset, rather than from the start of the string. Handles magic and
5312 void sv_pos_u2b(SV* sv, I32* offsetp, I32* lenp)
5317 =item sv_pvbyten_force
5320 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
5322 char* sv_pvbyten_force(SV* sv, STRLEN* lp)
5330 Get a sensible string out of the SV somehow.
5331 A private implementation of the C<SvPV_force> macro for compilers which
5332 can't cope with complex macro expressions. Always use the macro instead.
5334 char* sv_pvn_force(SV* sv, STRLEN* lp)
5339 =item sv_pvn_force_flags
5340 X<sv_pvn_force_flags>
5342 Get a sensible string out of the SV somehow.
5343 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
5344 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
5345 implemented in terms of this function.
5346 You normally want to use the various wrapper macros instead: see
5347 C<SvPV_force> and C<SvPV_force_nomg>
5349 char* sv_pvn_force_flags(SV* sv, STRLEN* lp, I32 flags)
5354 =item sv_pvutf8n_force
5357 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
5359 char* sv_pvutf8n_force(SV* sv, STRLEN* lp)
5367 Returns a string describing what the SV is a reference to.
5369 char* sv_reftype(const SV* sv, int ob)
5377 Make the first argument a copy of the second, then delete the original.
5378 The target SV physically takes over ownership of the body of the source SV
5379 and inherits its flags; however, the target keeps any magic it owns,
5380 and any magic in the source is discarded.
5381 Note that this is a rather specialist SV copying operation; most of the
5382 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5384 void sv_replace(SV* sv, SV* nsv)
5392 Underlying implementation for the C<reset> Perl function.
5393 Note that the perl-level function is vaguely deprecated.
5395 void sv_reset(const char* s, HV* stash)
5403 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
5404 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
5405 push a back-reference to this RV onto the array of backreferences
5406 associated with that magic.
5408 SV* sv_rvweaken(SV *sv)
5416 Copies an integer into the given SV, upgrading first if necessary.
5417 Does not handle 'set' magic. See also C<sv_setiv_mg>.
5419 void sv_setiv(SV* sv, IV num)
5427 Like C<sv_setiv>, but also handles 'set' magic.
5429 void sv_setiv_mg(SV *sv, IV i)
5437 Copies a double into the given SV, upgrading first if necessary.
5438 Does not handle 'set' magic. See also C<sv_setnv_mg>.
5440 void sv_setnv(SV* sv, NV num)
5448 Like C<sv_setnv>, but also handles 'set' magic.
5450 void sv_setnv_mg(SV *sv, NV num)
5458 Copies a string into an SV. The string must be null-terminated. Does not
5459 handle 'set' magic. See C<sv_setpv_mg>.
5461 void sv_setpv(SV* sv, const char* ptr)
5469 Works like C<sv_catpvf> but copies the text into the SV instead of
5470 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
5472 void sv_setpvf(SV* sv, const char* pat, ...)
5480 Like C<sv_setpvf>, but also handles 'set' magic.
5482 void sv_setpvf_mg(SV *sv, const char* pat, ...)
5490 Copies an integer into the given SV, also updating its string value.
5491 Does not handle 'set' magic. See C<sv_setpviv_mg>.
5493 void sv_setpviv(SV* sv, IV num)
5501 Like C<sv_setpviv>, but also handles 'set' magic.
5503 void sv_setpviv_mg(SV *sv, IV iv)
5511 Copies a string into an SV. The C<len> parameter indicates the number of
5512 bytes to be copied. If the C<ptr> argument is NULL the SV will become
5513 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
5515 void sv_setpvn(SV* sv, const char* ptr, STRLEN len)
5523 Like C<sv_setpvn>, but also handles 'set' magic.
5525 void sv_setpvn_mg(SV *sv, const char *ptr, STRLEN len)
5533 Like C<sv_setpv>, but also handles 'set' magic.
5535 void sv_setpv_mg(SV *sv, const char *ptr)
5543 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
5544 argument will be upgraded to an RV. That RV will be modified to point to
5545 the new SV. The C<classname> argument indicates the package for the
5546 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
5547 will have a reference count of 1, and the RV will be returned.
5549 SV* sv_setref_iv(SV* rv, const char* classname, IV iv)
5557 Copies a double into a new SV, optionally blessing the SV. The C<rv>
5558 argument will be upgraded to an RV. That RV will be modified to point to
5559 the new SV. The C<classname> argument indicates the package for the
5560 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
5561 will have a reference count of 1, and the RV will be returned.
5563 SV* sv_setref_nv(SV* rv, const char* classname, NV nv)
5571 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
5572 argument will be upgraded to an RV. That RV will be modified to point to
5573 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
5574 into the SV. The C<classname> argument indicates the package for the
5575 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
5576 will have a reference count of 1, and the RV will be returned.
5578 Do not use with other Perl types such as HV, AV, SV, CV, because those
5579 objects will become corrupted by the pointer copy process.
5581 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
5583 SV* sv_setref_pv(SV* rv, const char* classname, void* pv)
5591 Copies a string into a new SV, optionally blessing the SV. The length of the
5592 string must be specified with C<n>. The C<rv> argument will be upgraded to
5593 an RV. That RV will be modified to point to the new SV. The C<classname>
5594 argument indicates the package for the blessing. Set C<classname> to
5595 C<NULL> to avoid the blessing. The new SV will have a reference count
5596 of 1, and the RV will be returned.
5598 Note that C<sv_setref_pv> copies the pointer while this copies the string.
5600 SV* sv_setref_pvn(SV* rv, const char* classname, const char* pv, STRLEN n)
5608 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
5609 argument will be upgraded to an RV. That RV will be modified to point to
5610 the new SV. The C<classname> argument indicates the package for the
5611 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
5612 will have a reference count of 1, and the RV will be returned.
5614 SV* sv_setref_uv(SV* rv, const char* classname, UV uv)
5622 Copies the contents of the source SV C<ssv> into the destination SV
5623 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
5624 function if the source SV needs to be reused. Does not handle 'set' magic.
5625 Loosely speaking, it performs a copy-by-value, obliterating any previous
5626 content of the destination.
5628 You probably want to use one of the assortment of wrappers, such as
5629 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
5630 C<SvSetMagicSV_nosteal>.
5632 void sv_setsv(SV* dsv, SV* ssv)
5637 =item sv_setsv_flags
5640 Copies the contents of the source SV C<ssv> into the destination SV
5641 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
5642 function if the source SV needs to be reused. Does not handle 'set' magic.
5643 Loosely speaking, it performs a copy-by-value, obliterating any previous
5644 content of the destination.
5645 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
5646 C<ssv> if appropriate, else not. If the C<flags> parameter has the
5647 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
5648 and C<sv_setsv_nomg> are implemented in terms of this function.
5650 You probably want to use one of the assortment of wrappers, such as
5651 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
5652 C<SvSetMagicSV_nosteal>.
5654 This is the primary function for copying scalars, and most other
5655 copy-ish functions and macros use this underneath.
5657 void sv_setsv_flags(SV* dsv, SV* ssv, I32 flags)
5665 Like C<sv_setsv>, but also handles 'set' magic.
5667 void sv_setsv_mg(SV *dstr, SV *sstr)
5675 Copies an unsigned integer into the given SV, upgrading first if necessary.
5676 Does not handle 'set' magic. See also C<sv_setuv_mg>.
5678 void sv_setuv(SV* sv, UV num)
5686 Like C<sv_setuv>, but also handles 'set' magic.
5688 void sv_setuv_mg(SV *sv, UV u)
5696 Test an SV for taintedness. Use C<SvTAINTED> instead.
5697 bool sv_tainted(SV* sv)
5705 Returns true if the SV has a true value by Perl's rules.
5706 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
5707 instead use an in-line version.
5717 Removes all magic of type C<type> from an SV.
5719 int sv_unmagic(SV* sv, int type)
5724 =item sv_unref_flags
5727 Unsets the RV status of the SV, and decrements the reference count of
5728 whatever was being referenced by the RV. This can almost be thought of
5729 as a reversal of C<newSVrv>. The C<cflags> argument can contain
5730 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
5731 (otherwise the decrementing is conditional on the reference count being
5732 different from one or the reference being a readonly SV).
5735 void sv_unref_flags(SV* sv, U32 flags)
5743 Untaint an SV. Use C<SvTAINTED_off> instead.
5744 void sv_untaint(SV* sv)
5752 Upgrade an SV to a more complex form. Generally adds a new body type to the
5753 SV, then copies across as much information as possible from the old body.
5754 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
5756 void sv_upgrade(SV* sv, U32 mt)
5761 =item sv_usepvn_flags
5764 Tells an SV to use C<ptr> to find its string value. Normally the
5765 string is stored inside the SV but sv_usepvn allows the SV to use an
5766 outside string. The C<ptr> should point to memory that was allocated
5767 by C<malloc>. The string length, C<len>, must be supplied. By default
5768 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
5769 so that pointer should not be freed or used by the programmer after
5770 giving it to sv_usepvn, and neither should any pointers from "behind"
5771 that pointer (e.g. ptr + 1) be used.
5773 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
5774 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
5775 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
5776 C<len>, and already meets the requirements for storing in C<SvPVX>)
5778 void sv_usepvn_flags(SV* sv, char* ptr, STRLEN len, U32 flags)
5783 =item sv_utf8_decode
5786 If the PV of the SV is an octet sequence in UTF-8
5787 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
5788 so that it looks like a character. If the PV contains only single-byte
5789 characters, the C<SvUTF8> flag stays being off.
5790 Scans PV for validity and returns false if the PV is invalid UTF-8.
5792 NOTE: this function is experimental and may change or be
5793 removed without notice.
5795 bool sv_utf8_decode(SV *sv)
5800 =item sv_utf8_downgrade
5801 X<sv_utf8_downgrade>
5803 Attempts to convert the PV of an SV from characters to bytes.
5804 If the PV contains a character beyond byte, this conversion will fail;
5805 in this case, either returns false or, if C<fail_ok> is not
5808 This is not as a general purpose Unicode to byte encoding interface:
5809 use the Encode extension for that.
5811 NOTE: this function is experimental and may change or be
5812 removed without notice.
5814 bool sv_utf8_downgrade(SV *sv, bool fail_ok)
5819 =item sv_utf8_encode
5822 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
5823 flag off so that it looks like octets again.
5825 void sv_utf8_encode(SV *sv)
5830 =item sv_utf8_upgrade
5833 Converts the PV of an SV to its UTF-8-encoded form.
5834 Forces the SV to string form if it is not already.
5835 Always sets the SvUTF8 flag to avoid future validity checks even
5836 if all the bytes have hibit clear.
5838 This is not as a general purpose byte encoding to Unicode interface:
5839 use the Encode extension for that.
5841 STRLEN sv_utf8_upgrade(SV *sv)
5846 =item sv_utf8_upgrade_flags
5847 X<sv_utf8_upgrade_flags>
5849 Converts the PV of an SV to its UTF-8-encoded form.
5850 Forces the SV to string form if it is not already.
5851 Always sets the SvUTF8 flag to avoid future validity checks even
5852 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
5853 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
5854 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
5856 This is not as a general purpose byte encoding to Unicode interface:
5857 use the Encode extension for that.
5859 STRLEN sv_utf8_upgrade_flags(SV *sv, I32 flags)
5867 Processes its arguments like C<vsprintf> and appends the formatted output
5868 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
5870 Usually used via its frontend C<sv_catpvf>.
5872 void sv_vcatpvf(SV* sv, const char* pat, va_list* args)
5880 Processes its arguments like C<vsprintf> and appends the formatted output
5881 to an SV. Uses an array of SVs if the C style variable argument list is
5882 missing (NULL). When running with taint checks enabled, indicates via
5883 C<maybe_tainted> if results are untrustworthy (often due to the use of
5886 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
5888 void sv_vcatpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
5896 Like C<sv_vcatpvf>, but also handles 'set' magic.
5898 Usually used via its frontend C<sv_catpvf_mg>.
5900 void sv_vcatpvf_mg(SV* sv, const char* pat, va_list* args)
5908 Works like C<sv_vcatpvf> but copies the text into the SV instead of
5909 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
5911 Usually used via its frontend C<sv_setpvf>.
5913 void sv_vsetpvf(SV* sv, const char* pat, va_list* args)
5921 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
5924 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
5926 void sv_vsetpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
5934 Like C<sv_vsetpvf>, but also handles 'set' magic.
5936 Usually used via its frontend C<sv_setpvf_mg>.
5938 void sv_vsetpvf_mg(SV* sv, const char* pat, va_list* args)
5946 =head1 Unicode Support
5950 =item bytes_from_utf8
5953 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
5954 Unlike C<utf8_to_bytes> but like C<bytes_to_utf8>, returns a pointer to
5955 the newly-created string, and updates C<len> to contain the new
5956 length. Returns the original string if no conversion occurs, C<len>
5957 is unchanged. Do nothing if C<is_utf8> points to 0. Sets C<is_utf8> to
5958 0 if C<s> is converted or contains all 7bit characters.
5960 NOTE: this function is experimental and may change or be
5961 removed without notice.
5963 U8* bytes_from_utf8(const U8 *s, STRLEN *len, bool *is_utf8)
5966 Found in file utf8.c
5971 Converts a string C<s> of length C<len> from ASCII into UTF-8 encoding.
5972 Returns a pointer to the newly-created string, and sets C<len> to
5973 reflect the new length.
5975 If you want to convert to UTF-8 from other encodings than ASCII,
5976 see sv_recode_to_utf8().
5978 NOTE: this function is experimental and may change or be
5979 removed without notice.
5981 U8* bytes_to_utf8(const U8 *s, STRLEN *len)
5984 Found in file utf8.c
5989 Return true if the strings s1 and s2 differ case-insensitively, false
5990 if not (if they are equal case-insensitively). If u1 is true, the
5991 string s1 is assumed to be in UTF-8-encoded Unicode. If u2 is true,
5992 the string s2 is assumed to be in UTF-8-encoded Unicode. If u1 or u2
5993 are false, the respective string is assumed to be in native 8-bit
5996 If the pe1 and pe2 are non-NULL, the scanning pointers will be copied
5997 in there (they will point at the beginning of the I<next> character).
5998 If the pointers behind pe1 or pe2 are non-NULL, they are the end
5999 pointers beyond which scanning will not continue under any
6000 circumstances. If the byte lengths l1 and l2 are non-zero, s1+l1 and
6001 s2+l2 will be used as goal end pointers that will also stop the scan,
6002 and which qualify towards defining a successful match: all the scans
6003 that define an explicit length must reach their goal pointers for
6004 a match to succeed).
6006 For case-insensitiveness, the "casefolding" of Unicode is used
6007 instead of upper/lowercasing both the characters, see
6008 http://www.unicode.org/unicode/reports/tr21/ (Case Mappings).
6010 I32 ibcmp_utf8(const char* a, char **pe1, UV l1, bool u1, const char* b, char **pe2, UV l2, bool u2)
6013 Found in file utf8.c
6018 Tests if some arbitrary number of bytes begins in a valid UTF-8
6019 character. Note that an INVARIANT (i.e. ASCII) character is a valid
6020 UTF-8 character. The actual number of bytes in the UTF-8 character
6021 will be returned if it is valid, otherwise 0.
6023 STRLEN is_utf8_char(const U8 *p)
6026 Found in file utf8.c
6028 =item is_utf8_string
6031 Returns true if first C<len> bytes of the given string form a valid
6032 UTF-8 string, false otherwise. Note that 'a valid UTF-8 string' does
6033 not mean 'a string that contains code points above 0x7F encoded in UTF-8'
6034 because a valid ASCII string is a valid UTF-8 string.
6036 See also is_utf8_string_loclen() and is_utf8_string_loc().
6038 bool is_utf8_string(const U8 *s, STRLEN len)
6041 Found in file utf8.c
6043 =item is_utf8_string_loc
6044 X<is_utf8_string_loc>
6046 Like is_utf8_string() but stores the location of the failure (in the
6047 case of "utf8ness failure") or the location s+len (in the case of
6048 "utf8ness success") in the C<ep>.
6050 See also is_utf8_string_loclen() and is_utf8_string().
6052 bool is_utf8_string_loc(const U8 *s, STRLEN len, const U8 **p)
6055 Found in file utf8.c
6057 =item is_utf8_string_loclen
6058 X<is_utf8_string_loclen>
6060 Like is_utf8_string() but stores the location of the failure (in the
6061 case of "utf8ness failure") or the location s+len (in the case of
6062 "utf8ness success") in the C<ep>, and the number of UTF-8
6063 encoded characters in the C<el>.
6065 See also is_utf8_string_loc() and is_utf8_string().
6067 bool is_utf8_string_loclen(const U8 *s, STRLEN len, const U8 **ep, STRLEN *el)
6070 Found in file utf8.c
6072 =item pv_uni_display
6075 Build to the scalar dsv a displayable version of the string spv,
6076 length len, the displayable version being at most pvlim bytes long
6077 (if longer, the rest is truncated and "..." will be appended).
6079 The flags argument can have UNI_DISPLAY_ISPRINT set to display
6080 isPRINT()able characters as themselves, UNI_DISPLAY_BACKSLASH
6081 to display the \\[nrfta\\] as the backslashed versions (like '\n')
6082 (UNI_DISPLAY_BACKSLASH is preferred over UNI_DISPLAY_ISPRINT for \\).
6083 UNI_DISPLAY_QQ (and its alias UNI_DISPLAY_REGEX) have both
6084 UNI_DISPLAY_BACKSLASH and UNI_DISPLAY_ISPRINT turned on.
6086 The pointer to the PV of the dsv is returned.
6088 char* pv_uni_display(SV *dsv, const U8 *spv, STRLEN len, STRLEN pvlim, UV flags)
6091 Found in file utf8.c
6096 The encoding is assumed to be an Encode object, the PV of the ssv is
6097 assumed to be octets in that encoding and decoding the input starts
6098 from the position which (PV + *offset) pointed to. The dsv will be
6099 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
6100 when the string tstr appears in decoding output or the input ends on
6101 the PV of the ssv. The value which the offset points will be modified
6102 to the last input position on the ssv.
6104 Returns TRUE if the terminator was found, else returns FALSE.
6106 bool sv_cat_decode(SV* dsv, SV *encoding, SV *ssv, int *offset, char* tstr, int tlen)
6111 =item sv_recode_to_utf8
6112 X<sv_recode_to_utf8>
6114 The encoding is assumed to be an Encode object, on entry the PV
6115 of the sv is assumed to be octets in that encoding, and the sv
6116 will be converted into Unicode (and UTF-8).
6118 If the sv already is UTF-8 (or if it is not POK), or if the encoding
6119 is not a reference, nothing is done to the sv. If the encoding is not
6120 an C<Encode::XS> Encoding object, bad things will happen.
6121 (See F<lib/encoding.pm> and L<Encode>).
6123 The PV of the sv is returned.
6125 char* sv_recode_to_utf8(SV* sv, SV *encoding)
6130 =item sv_uni_display
6133 Build to the scalar dsv a displayable version of the scalar sv,
6134 the displayable version being at most pvlim bytes long
6135 (if longer, the rest is truncated and "..." will be appended).
6137 The flags argument is as in pv_uni_display().
6139 The pointer to the PV of the dsv is returned.
6141 char* sv_uni_display(SV *dsv, SV *ssv, STRLEN pvlim, UV flags)
6144 Found in file utf8.c
6149 The "p" contains the pointer to the UTF-8 string encoding
6150 the character that is being converted.
6152 The "ustrp" is a pointer to the character buffer to put the
6153 conversion result to. The "lenp" is a pointer to the length
6156 The "swashp" is a pointer to the swash to use.
6158 Both the special and normal mappings are stored lib/unicore/To/Foo.pl,
6159 and loaded by SWASHNEW, using lib/utf8_heavy.pl. The special (usually,
6160 but not always, a multicharacter mapping), is tried first.
6162 The "special" is a string like "utf8::ToSpecLower", which means the
6163 hash %utf8::ToSpecLower. The access to the hash is through
6164 Perl_to_utf8_case().
6166 The "normal" is a string like "ToLower" which means the swash
6169 UV to_utf8_case(const U8 *p, U8* ustrp, STRLEN *lenp, SV **swashp, const char *normal, const char *special)
6172 Found in file utf8.c
6177 Convert the UTF-8 encoded character at p to its foldcase version and
6178 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6179 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6180 foldcase version may be longer than the original character (up to
6183 The first character of the foldcased version is returned
6184 (but note, as explained above, that there may be more.)
6186 UV to_utf8_fold(const U8 *p, U8* ustrp, STRLEN *lenp)
6189 Found in file utf8.c
6194 Convert the UTF-8 encoded character at p to its lowercase version and
6195 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6196 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6197 lowercase version may be longer than the original character.
6199 The first character of the lowercased version is returned
6200 (but note, as explained above, that there may be more.)
6202 UV to_utf8_lower(const U8 *p, U8* ustrp, STRLEN *lenp)
6205 Found in file utf8.c
6210 Convert the UTF-8 encoded character at p to its titlecase version and
6211 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6212 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6213 titlecase version may be longer than the original character.
6215 The first character of the titlecased version is returned
6216 (but note, as explained above, that there may be more.)
6218 UV to_utf8_title(const U8 *p, U8* ustrp, STRLEN *lenp)
6221 Found in file utf8.c
6226 Convert the UTF-8 encoded character at p to its uppercase version and
6227 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6228 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since
6229 the uppercase version may be longer than the original character.
6231 The first character of the uppercased version is returned
6232 (but note, as explained above, that there may be more.)
6234 UV to_utf8_upper(const U8 *p, U8* ustrp, STRLEN *lenp)
6237 Found in file utf8.c
6239 =item utf8n_to_uvchr
6244 Returns the native character value of the first character in the string
6246 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6247 length, in bytes, of that character.
6249 Allows length and flags to be passed to low level routine.
6251 UV utf8n_to_uvchr(const U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags)
6254 Found in file utf8.c
6256 =item utf8n_to_uvuni
6259 Bottom level UTF-8 decode routine.
6260 Returns the unicode code point value of the first character in the string C<s>
6261 which is assumed to be in UTF-8 encoding and no longer than C<curlen>;
6262 C<retlen> will be set to the length, in bytes, of that character.
6264 If C<s> does not point to a well-formed UTF-8 character, the behaviour
6265 is dependent on the value of C<flags>: if it contains UTF8_CHECK_ONLY,
6266 it is assumed that the caller will raise a warning, and this function
6267 will silently just set C<retlen> to C<-1> and return zero. If the
6268 C<flags> does not contain UTF8_CHECK_ONLY, warnings about
6269 malformations will be given, C<retlen> will be set to the expected
6270 length of the UTF-8 character in bytes, and zero will be returned.
6272 The C<flags> can also contain various flags to allow deviations from
6273 the strict UTF-8 encoding (see F<utf8.h>).
6275 Most code should use utf8_to_uvchr() rather than call this directly.
6277 UV utf8n_to_uvuni(const U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags)
6280 Found in file utf8.c
6285 Returns the number of UTF-8 characters between the UTF-8 pointers C<a>
6288 WARNING: use only if you *know* that the pointers point inside the
6291 IV utf8_distance(const U8 *a, const U8 *b)
6294 Found in file utf8.c
6299 Return the UTF-8 pointer C<s> displaced by C<off> characters, either
6300 forward or backward.
6302 WARNING: do not use the following unless you *know* C<off> is within
6303 the UTF-8 data pointed to by C<s> *and* that on entry C<s> is aligned
6304 on the first byte of character or just after the last byte of a character.
6306 U8* utf8_hop(const U8 *s, I32 off)
6309 Found in file utf8.c
6314 Return the length of the UTF-8 char encoded string C<s> in characters.
6315 Stops at C<e> (inclusive). If C<e E<lt> s> or if the scan would end
6316 up past C<e>, croaks.
6318 STRLEN utf8_length(const U8* s, const U8 *e)
6321 Found in file utf8.c
6326 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
6327 Unlike C<bytes_to_utf8>, this over-writes the original string, and
6328 updates len to contain the new length.
6329 Returns zero on failure, setting C<len> to -1.
6331 If you need a copy of the string, see C<bytes_from_utf8>.
6333 NOTE: this function is experimental and may change or be
6334 removed without notice.
6336 U8* utf8_to_bytes(U8 *s, STRLEN *len)
6339 Found in file utf8.c
6344 Returns the native character value of the first character in the string C<s>
6345 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6346 length, in bytes, of that character.
6348 If C<s> does not point to a well-formed UTF-8 character, zero is
6349 returned and retlen is set, if possible, to -1.
6351 UV utf8_to_uvchr(const U8 *s, STRLEN *retlen)
6354 Found in file utf8.c
6359 Returns the Unicode code point of the first character in the string C<s>
6360 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6361 length, in bytes, of that character.
6363 This function should only be used when returned UV is considered
6364 an index into the Unicode semantic tables (e.g. swashes).
6366 If C<s> does not point to a well-formed UTF-8 character, zero is
6367 returned and retlen is set, if possible, to -1.
6369 UV utf8_to_uvuni(const U8 *s, STRLEN *retlen)
6372 Found in file utf8.c
6377 Adds the UTF-8 representation of the Native codepoint C<uv> to the end
6378 of the string C<d>; C<d> should be have at least C<UTF8_MAXBYTES+1> free
6379 bytes available. The return value is the pointer to the byte after the
6380 end of the new character. In other words,
6382 d = uvchr_to_utf8(d, uv);
6384 is the recommended wide native character-aware way of saying
6388 U8* uvchr_to_utf8(U8 *d, UV uv)
6391 Found in file utf8.c
6393 =item uvuni_to_utf8_flags
6394 X<uvuni_to_utf8_flags>
6396 Adds the UTF-8 representation of the Unicode codepoint C<uv> to the end
6397 of the string C<d>; C<d> should be have at least C<UTF8_MAXBYTES+1> free
6398 bytes available. The return value is the pointer to the byte after the
6399 end of the new character. In other words,
6401 d = uvuni_to_utf8_flags(d, uv, flags);
6405 d = uvuni_to_utf8(d, uv);
6407 (which is equivalent to)
6409 d = uvuni_to_utf8_flags(d, uv, 0);
6411 is the recommended Unicode-aware way of saying
6415 U8* uvuni_to_utf8_flags(U8 *d, UV uv, UV flags)
6418 Found in file utf8.c
6423 =head1 Variables created by C<xsubpp> and C<xsubpp> internal functions
6430 Variable which is setup by C<xsubpp> to indicate the stack base offset,
6431 used by the C<ST>, C<XSprePUSH> and C<XSRETURN> macros. The C<dMARK> macro
6432 must be called prior to setup the C<MARK> variable.
6437 Found in file XSUB.h
6442 Variable which is setup by C<xsubpp> to indicate the
6443 class name for a C++ XS constructor. This is always a C<char*>. See C<THIS>.
6448 Found in file XSUB.h
6453 Sets up the C<ax> variable.
6454 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
6459 Found in file XSUB.h
6464 Sets up the C<ax> variable and stack marker variable C<mark>.
6465 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
6470 Found in file XSUB.h
6475 Sets up the C<items> variable.
6476 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
6481 Found in file XSUB.h
6486 Sets up the C<padoff_du> variable for an XSUB that wishes to use
6492 Found in file XSUB.h
6497 Sets up stack and mark pointers for an XSUB, calling dSP and dMARK.
6498 Sets up the C<ax> and C<items> variables by calling C<dAX> and C<dITEMS>.
6499 This is usually handled automatically by C<xsubpp>.
6504 Found in file XSUB.h
6509 Sets up the C<ix> variable for an XSUB which has aliases. This is usually
6510 handled automatically by C<xsubpp>.
6515 Found in file XSUB.h
6520 Variable which is setup by C<xsubpp> to indicate the number of
6521 items on the stack. See L<perlxs/"Variable-length Parameter Lists">.
6526 Found in file XSUB.h
6531 Variable which is setup by C<xsubpp> to indicate which of an
6532 XSUB's aliases was used to invoke it. See L<perlxs/"The ALIAS: Keyword">.
6537 Found in file XSUB.h
6542 Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
6546 Found in file XSUB.h
6551 Variable which is setup by C<xsubpp> to hold the return value for an
6552 XSUB. This is always the proper type for the XSUB. See
6553 L<perlxs/"The RETVAL Variable">.
6558 Found in file XSUB.h
6563 Used to access elements on the XSUB's stack.
6568 Found in file XSUB.h
6573 Variable which is setup by C<xsubpp> to designate the object in a C++
6574 XSUB. This is always the proper type for the C++ object. See C<CLASS> and
6575 L<perlxs/"Using XS With C++">.
6580 Found in file XSUB.h
6585 The SV* corresponding to the $_ variable. Works even if there
6586 is a lexical $_ in scope.
6589 Found in file XSUB.h
6594 Macro to declare an XSUB and its C parameter list. This is handled by
6598 Found in file XSUB.h
6603 The version identifier for an XS module. This is usually
6604 handled automatically by C<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>.
6607 Found in file XSUB.h
6609 =item XS_VERSION_BOOTCHECK
6610 X<XS_VERSION_BOOTCHECK>
6612 Macro to verify that a PM module's $VERSION variable matches the XS
6613 module's C<XS_VERSION> variable. This is usually handled automatically by
6614 C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">.
6616 XS_VERSION_BOOTCHECK;
6619 Found in file XSUB.h
6624 =head1 Warning and Dieing
6631 This is the XSUB-writer's interface to Perl's C<die> function.
6632 Normally call this function the same way you call the C C<printf>
6633 function. Calling C<croak> returns control directly to Perl,
6634 sidestepping the normal C order of execution. See C<warn>.
6636 If you want to throw an exception object, assign the object to
6637 C<$@> and then pass C<NULL> to croak():
6639 errsv = get_sv("@", TRUE);
6640 sv_setsv(errsv, exception_object);
6643 void croak(const char* pat, ...)
6646 Found in file util.c
6651 This is the XSUB-writer's interface to Perl's C<warn> function. Call this
6652 function the same way you call the C C<printf> function. See C<croak>.
6654 void warn(const char* pat, ...)
6657 Found in file util.c
6664 Until May 1997, this document was maintained by Jeff Okamoto
6665 <okamoto@corp.hp.com>. It is now maintained as part of Perl itself.
6667 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
6668 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
6669 Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
6670 Stephen McCamant, and Gurusamy Sarathy.
6672 API Listing originally by Dean Roehrich <roehrich@cray.com>.
6674 Updated to be autogenerated from comments in the source by Benjamin Stuhl.
6678 perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
projects / p5sagit/p5-mst-13.2.git / blob