3 perlapi - autogenerated documentation for the perl public API
6 X<Perl API> X<API> X<api>
8 This file contains the documentation of the perl public API generated by
9 embed.pl, specifically a listing of functions, macros, flags, and variables
10 that may be used by extension writers. The interfaces of any functions that
11 are not listed here are subject to change without notice. For this reason,
12 blindly using functions listed in proto.h is to be avoided when writing
15 Note that all Perl API global variables must be referenced with the C<PL_>
16 prefix. Some macros are provided for compatibility with the older,
17 unadorned names, but this support may be disabled in a future release.
19 The listing is alphabetical, case insensitive.
29 A backward-compatible version of C<GIMME_V> which can only return
30 C<G_SCALAR> or C<G_ARRAY>; in a void context, it returns C<G_SCALAR>.
31 Deprecated. Use C<GIMME_V> instead.
41 The XSUB-writer's equivalent to Perl's C<wantarray>. Returns C<G_VOID>,
42 C<G_SCALAR> or C<G_ARRAY> for void, scalar or list context,
53 Used to indicate list context. See C<GIMME_V>, C<GIMME> and
62 Indicates that arguments returned from a callback should be discarded. See
71 Used to force a Perl C<eval> wrapper around a callback. See
80 Indicates that no arguments are being sent to a callback. See
89 Used to indicate scalar context. See C<GIMME_V>, C<GIMME>, and
98 Used to indicate void context. See C<GIMME_V> and L<perlcall>.
106 =head1 Array Manipulation Functions
113 Same as C<av_len()>. Deprecated, use C<av_len()> instead.
123 Clears an array, making it empty. Does not free the memory used by the
126 void av_clear(AV* ar)
134 Deletes the element indexed by C<key> from the array. Returns the
135 deleted element. If C<flags> equals C<G_DISCARD>, the element is freed
136 and null is returned.
138 SV* av_delete(AV* ar, I32 key, I32 flags)
146 Returns true if the element indexed by C<key> has been initialized.
148 This relies on the fact that uninitialized array elements are set to
151 bool av_exists(AV* ar, I32 key)
159 Pre-extend an array. The C<key> is the index to which the array should be
162 void av_extend(AV* ar, I32 key)
170 Returns the SV at the specified index in the array. The C<key> is the
171 index. If C<lval> is set then the fetch will be part of a store. Check
172 that the return value is non-null before dereferencing it to a C<SV*>.
174 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for
175 more information on how to use this function on tied arrays.
177 SV** av_fetch(AV* ar, I32 key, I32 lval)
185 Ensure than an array has a given number of elements, equivalent to
186 Perl's C<$#array = $fill;>.
188 void av_fill(AV* ar, I32 fill)
196 Returns the highest index in the array. Returns -1 if the array is
199 I32 av_len(const AV* ar)
207 Creates a new AV and populates it with a list of SVs. The SVs are copied
208 into the array, so they may be freed after the call to av_make. The new AV
209 will have a reference count of 1.
211 AV* av_make(I32 size, SV** svp)
219 Pops an SV off the end of the array. Returns C<&PL_sv_undef> if the array
230 Pushes an SV onto the end of the array. The array will grow automatically
231 to accommodate the addition.
233 void av_push(AV* ar, SV* val)
241 Shifts an SV off the beginning of the array.
251 Stores an SV in an array. The array index is specified as C<key>. The
252 return value will be NULL if the operation failed or if the value did not
253 need to be actually stored within the array (as in the case of tied
254 arrays). Otherwise it can be dereferenced to get the original C<SV*>. Note
255 that the caller is responsible for suitably incrementing the reference
256 count of C<val> before the call, and decrementing it if the function
259 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for
260 more information on how to use this function on tied arrays.
262 SV** av_store(AV* ar, I32 key, SV* val)
270 Undefines the array. Frees the memory used by the array itself.
272 void av_undef(AV* ar)
280 Unshift the given number of C<undef> values onto the beginning of the
281 array. The array will grow automatically to accommodate the addition. You
282 must then use C<av_store> to assign values to these new elements.
284 void av_unshift(AV* ar, I32 num)
292 Returns the AV of the specified Perl array. If C<create> is set and the
293 Perl variable does not exist then it will be created. If C<create> is not
294 set and the variable does not exist then NULL is returned.
296 NOTE: the perl_ form of this function is deprecated.
298 AV* get_av(const char* name, I32 create)
306 Creates a new AV. The reference count is set to 1.
316 Sort an array. Here is an example:
318 sortsv(AvARRAY(av), av_len(av)+1, Perl_sv_cmp_locale);
320 Currently this always uses mergesort. See sortsv_flags for a more
323 void sortsv(SV** array, size_t num_elts, SVCOMPARE_t cmp)
326 Found in file pp_sort.c
331 Sort an array, with various options.
333 void sortsv_flags(SV** array, size_t num_elts, SVCOMPARE_t cmp, U32 flags)
336 Found in file pp_sort.c
341 =head1 Callback Functions
348 Performs a callback to the specified Perl sub. See L<perlcall>.
350 NOTE: the perl_ form of this function is deprecated.
352 I32 call_argv(const char* sub_name, I32 flags, char** argv)
360 Performs a callback to the specified Perl method. The blessed object must
361 be on the stack. See L<perlcall>.
363 NOTE: the perl_ form of this function is deprecated.
365 I32 call_method(const char* methname, I32 flags)
373 Performs a callback to the specified Perl sub. See L<perlcall>.
375 NOTE: the perl_ form of this function is deprecated.
377 I32 call_pv(const char* sub_name, I32 flags)
385 Performs a callback to the Perl sub whose name is in the SV. See
388 NOTE: the perl_ form of this function is deprecated.
390 I32 call_sv(SV* sv, I32 flags)
398 Opening bracket on a callback. See C<LEAVE> and L<perlcall>.
403 Found in file scope.h
408 Tells Perl to C<eval> the given string and return an SV* result.
410 NOTE: the perl_ form of this function is deprecated.
412 SV* eval_pv(const char* p, I32 croak_on_error)
420 Tells Perl to C<eval> the string in the SV.
422 NOTE: the perl_ form of this function is deprecated.
424 I32 eval_sv(SV* sv, I32 flags)
432 Closing bracket for temporaries on a callback. See C<SAVETMPS> and
438 Found in file scope.h
443 Closing bracket on a callback. See C<ENTER> and L<perlcall>.
448 Found in file scope.h
453 Opening bracket for temporaries on a callback. See C<FREETMPS> and
459 Found in file scope.h
464 =head1 Character classes
471 Returns a boolean indicating whether the C C<char> is an ASCII alphanumeric
472 character (including underscore) or digit.
474 bool isALNUM(char ch)
477 Found in file handy.h
482 Returns a boolean indicating whether the C C<char> is an ASCII alphabetic
485 bool isALPHA(char ch)
488 Found in file handy.h
493 Returns a boolean indicating whether the C C<char> is an ASCII
496 bool isDIGIT(char ch)
499 Found in file handy.h
504 Returns a boolean indicating whether the C C<char> is a lowercase
507 bool isLOWER(char ch)
510 Found in file handy.h
515 Returns a boolean indicating whether the C C<char> is whitespace.
517 bool isSPACE(char ch)
520 Found in file handy.h
525 Returns a boolean indicating whether the C C<char> is an uppercase
528 bool isUPPER(char ch)
531 Found in file handy.h
536 Converts the specified character to lowercase.
538 char toLOWER(char ch)
541 Found in file handy.h
546 Converts the specified character to uppercase.
548 char toUPPER(char ch)
551 Found in file handy.h
556 =head1 Cloning an interpreter
563 Create and return a new interpreter by cloning the current one.
565 perl_clone takes these flags as parameters:
567 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
568 without it we only clone the data and zero the stacks,
569 with it we copy the stacks and the new perl interpreter is
570 ready to run at the exact same point as the previous one.
571 The pseudo-fork code uses COPY_STACKS while the
572 threads->new doesn't.
574 CLONEf_KEEP_PTR_TABLE
575 perl_clone keeps a ptr_table with the pointer of the old
576 variable as a key and the new variable as a value,
577 this allows it to check if something has been cloned and not
578 clone it again but rather just use the value and increase the
579 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
580 the ptr_table using the function
581 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
582 reason to keep it around is if you want to dup some of your own
583 variable who are outside the graph perl scans, example of this
584 code is in threads.xs create
587 This is a win32 thing, it is ignored on unix, it tells perls
588 win32host code (which is c++) to clone itself, this is needed on
589 win32 if you want to run two threads at the same time,
590 if you just want to do some stuff in a separate perl interpreter
591 and then throw it away and return to the original one,
592 you don't need to do anything.
594 PerlInterpreter* perl_clone(PerlInterpreter* interp, UV flags)
602 =head1 CV Manipulation Functions
609 Returns the stash of the CV.
619 Returns the CV of the specified Perl subroutine. If C<create> is set and
620 the Perl subroutine does not exist then it will be declared (which has the
621 same effect as saying C<sub name;>). If C<create> is not set and the
622 subroutine does not exist then NULL is returned.
624 NOTE: the perl_ form of this function is deprecated.
626 CV* get_cv(const char* name, I32 create)
634 =head1 Embedding Functions
641 Clear out all the active components of a CV. This can happen either
642 by an explicit C<undef &foo>, or by the reference count going to zero.
643 In the former case, we keep the CvOUTSIDE pointer, so that any anonymous
644 children can still follow the full lexical scope chain.
646 void cv_undef(CV* cv)
654 Loads the module whose name is pointed to by the string part of name.
655 Note that the actual module name, not its filename, should be given.
656 Eg, "Foo::Bar" instead of "Foo/Bar.pm". flags can be any of
657 PERL_LOADMOD_DENY, PERL_LOADMOD_NOIMPORT, or PERL_LOADMOD_IMPORT_OPS
658 (or 0 for no flags). ver, if specified, provides version semantics
659 similar to C<use Foo::Bar VERSION>. The optional trailing SV*
660 arguments can be used to specify arguments to the module's import()
661 method, similar to C<use Foo::Bar VERSION LIST>.
663 void load_module(U32 flags, SV* name, SV* ver, ...)
671 Stub that provides thread hook for perl_destruct when there are
682 Allocates a new Perl interpreter. See L<perlembed>.
684 PerlInterpreter* perl_alloc()
692 Initializes a new Perl interpreter. See L<perlembed>.
694 void perl_construct(PerlInterpreter* interp)
702 Shuts down a Perl interpreter. See L<perlembed>.
704 int perl_destruct(PerlInterpreter* interp)
712 Releases a Perl interpreter. See L<perlembed>.
714 void perl_free(PerlInterpreter* interp)
722 Tells a Perl interpreter to parse a Perl script. See L<perlembed>.
724 int perl_parse(PerlInterpreter* interp, XSINIT_t xsinit, int argc, char** argv, char** env)
732 Tells a Perl interpreter to run. See L<perlembed>.
734 int perl_run(PerlInterpreter* interp)
742 Tells Perl to C<require> the file named by the string argument. It is
743 analogous to the Perl code C<eval "require '$file'">. It's even
744 implemented that way; consider using load_module instead.
746 NOTE: the perl_ form of this function is deprecated.
748 void require_pv(const char* pv)
756 =head1 Functions in file mathoms.c
764 See L<gv_fetchmethod_autoload>.
766 GV* gv_fetchmethod(HV* stash, const char* name)
769 Found in file mathoms.c
771 =item sv_2pvbyte_nolen
774 Return a pointer to the byte-encoded representation of the SV.
775 May cause the SV to be downgraded from UTF-8 as a side-effect.
777 Usually accessed via the C<SvPVbyte_nolen> macro.
779 char* sv_2pvbyte_nolen(SV* sv)
782 Found in file mathoms.c
784 =item sv_2pvutf8_nolen
787 Return a pointer to the UTF-8-encoded representation of the SV.
788 May cause the SV to be upgraded to UTF-8 as a side-effect.
790 Usually accessed via the C<SvPVutf8_nolen> macro.
792 char* sv_2pvutf8_nolen(SV* sv)
795 Found in file mathoms.c
800 Like C<sv_2pv()>, but doesn't return the length too. You should usually
801 use the macro wrapper C<SvPV_nolen(sv)> instead.
802 char* sv_2pv_nolen(SV* sv)
805 Found in file mathoms.c
810 Like C<sv_catpvn>, but also handles 'set' magic.
812 void sv_catpvn_mg(SV *sv, const char *ptr, STRLEN len)
815 Found in file mathoms.c
820 Like C<sv_catsv>, but also handles 'set' magic.
822 void sv_catsv_mg(SV *dstr, SV *sstr)
825 Found in file mathoms.c
827 =item sv_force_normal
830 Undo various types of fakery on an SV: if the PV is a shared string, make
831 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
832 an xpvmg. See also C<sv_force_normal_flags>.
834 void sv_force_normal(SV *sv)
837 Found in file mathoms.c
842 A private implementation of the C<SvIVx> macro for compilers which can't
843 cope with complex macro expressions. Always use the macro instead.
848 Found in file mathoms.c
853 Dummy routine which "locks" an SV when there is no locking module present.
854 Exists to avoid test for a NULL function pointer and because it could
855 potentially warn under some level of strict-ness.
857 "Superseded" by sv_nosharing().
859 void sv_nolocking(SV *sv)
862 Found in file mathoms.c
867 Dummy routine which "unlocks" an SV when there is no locking module present.
868 Exists to avoid test for a NULL function pointer and because it could
869 potentially warn under some level of strict-ness.
871 "Superseded" by sv_nosharing().
873 void sv_nounlocking(SV *sv)
876 Found in file mathoms.c
881 A private implementation of the C<SvNVx> macro for compilers which can't
882 cope with complex macro expressions. Always use the macro instead.
887 Found in file mathoms.c
892 Use the C<SvPV_nolen> macro instead
897 Found in file mathoms.c
902 Use C<SvPVbyte_nolen> instead.
904 char* sv_pvbyte(SV *sv)
907 Found in file mathoms.c
912 A private implementation of the C<SvPVbyte> macro for compilers
913 which can't cope with complex macro expressions. Always use the macro
916 char* sv_pvbyten(SV *sv, STRLEN *len)
919 Found in file mathoms.c
924 A private implementation of the C<SvPV> macro for compilers which can't
925 cope with complex macro expressions. Always use the macro instead.
927 char* sv_pvn(SV *sv, STRLEN *len)
930 Found in file mathoms.c
935 Use the C<SvPVutf8_nolen> macro instead
937 char* sv_pvutf8(SV *sv)
940 Found in file mathoms.c
945 A private implementation of the C<SvPVutf8> macro for compilers
946 which can't cope with complex macro expressions. Always use the macro
949 char* sv_pvutf8n(SV *sv, STRLEN *len)
952 Found in file mathoms.c
957 Taint an SV. Use C<SvTAINTED_on> instead.
958 void sv_taint(SV* sv)
961 Found in file mathoms.c
966 Unsets the RV status of the SV, and decrements the reference count of
967 whatever was being referenced by the RV. This can almost be thought of
968 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
969 being zero. See C<SvROK_off>.
971 void sv_unref(SV* sv)
974 Found in file mathoms.c
979 A private implementation of the C<SvUVx> macro for compilers which can't
980 cope with complex macro expressions. Always use the macro instead.
985 Found in file mathoms.c
990 =head1 Functions in file pp_pack.c
998 The engine implementing pack() Perl function.
1000 void packlist(SV *cat, const char *pat, const char *patend, SV **beglist, SV **endlist)
1003 Found in file pp_pack.c
1008 The engine implementing pack() Perl function. Note: parameters next_in_list and
1009 flags are not used. This call should not be used; use packlist instead.
1011 void pack_cat(SV *cat, const char *pat, const char *patend, SV **beglist, SV **endlist, SV ***next_in_list, U32 flags)
1014 Found in file pp_pack.c
1019 The engine implementing unpack() Perl function. C<unpackstring> puts the
1020 extracted list items on the stack and returns the number of elements.
1021 Issue C<PUTBACK> before and C<SPAGAIN> after the call to this function.
1023 I32 unpackstring(const char *pat, const char *patend, const char *s, const char *strend, U32 flags)
1026 Found in file pp_pack.c
1031 The engine implementing unpack() Perl function. Note: parameters strbeg, new_s
1032 and ocnt are not used. This call should not be used, use unpackstring instead.
1034 I32 unpack_str(const char *pat, const char *patend, const char *s, const char *strbeg, const char *strend, char **new_s, I32 ocnt, U32 flags)
1037 Found in file pp_pack.c
1042 =head1 Global Variables
1049 C<PL_modglobal> is a general purpose, interpreter global HV for use by
1050 extensions that need to keep information on a per-interpreter basis.
1051 In a pinch, it can also be used as a symbol table for extensions
1052 to share data among each other. It is a good idea to use keys
1053 prefixed by the package name of the extension that owns the data.
1058 Found in file intrpvar.h
1063 A convenience variable which is typically used with C<SvPV> when one
1064 doesn't care about the length of the string. It is usually more efficient
1065 to either declare a local variable and use that instead or to use the
1066 C<SvPV_nolen> macro.
1071 Found in file thrdvar.h
1076 This is the C<false> SV. See C<PL_sv_yes>. Always refer to this as
1082 Found in file intrpvar.h
1087 This is the C<undef> SV. Always refer to this as C<&PL_sv_undef>.
1092 Found in file intrpvar.h
1097 This is the C<true> SV. See C<PL_sv_no>. Always refer to this as
1103 Found in file intrpvar.h
1115 Return the SV from the GV.
1125 If C<gv> is a typeglob whose subroutine entry is a constant sub eligible for
1126 inlining, or C<gv> is a placeholder reference that would be promoted to such
1127 a typeglob, then returns the value returned by the sub. Otherwise, returns
1130 SV* gv_const_sv(GV* gv)
1138 Returns the glob with the given C<name> and a defined subroutine or
1139 C<NULL>. The glob lives in the given C<stash>, or in the stashes
1140 accessible via @ISA and UNIVERSAL::.
1142 The argument C<level> should be either 0 or -1. If C<level==0>, as a
1143 side-effect creates a glob with the given C<name> in the given C<stash>
1144 which in the case of success contains an alias for the subroutine, and sets
1145 up caching info for this glob. Similarly for all the searched stashes.
1147 This function grants C<"SUPER"> token as a postfix of the stash name. The
1148 GV returned from C<gv_fetchmeth> may be a method cache entry, which is not
1149 visible to Perl code. So when calling C<call_sv>, you should not use
1150 the GV directly; instead, you should use the method's CV, which can be
1151 obtained from the GV with the C<GvCV> macro.
1153 GV* gv_fetchmeth(HV* stash, const char* name, STRLEN len, I32 level)
1158 =item gv_fetchmethod_autoload
1159 X<gv_fetchmethod_autoload>
1161 Returns the glob which contains the subroutine to call to invoke the method
1162 on the C<stash>. In fact in the presence of autoloading this may be the
1163 glob for "AUTOLOAD". In this case the corresponding variable $AUTOLOAD is
1166 The third parameter of C<gv_fetchmethod_autoload> determines whether
1167 AUTOLOAD lookup is performed if the given method is not present: non-zero
1168 means yes, look for AUTOLOAD; zero means no, don't look for AUTOLOAD.
1169 Calling C<gv_fetchmethod> is equivalent to calling C<gv_fetchmethod_autoload>
1170 with a non-zero C<autoload> parameter.
1172 These functions grant C<"SUPER"> token as a prefix of the method name. Note
1173 that if you want to keep the returned glob for a long time, you need to
1174 check for it being "AUTOLOAD", since at the later time the call may load a
1175 different subroutine due to $AUTOLOAD changing its value. Use the glob
1176 created via a side effect to do this.
1178 These functions have the same side-effects and as C<gv_fetchmeth> with
1179 C<level==0>. C<name> should be writable if contains C<':'> or C<'
1180 ''>. The warning against passing the GV returned by C<gv_fetchmeth> to
1181 C<call_sv> apply equally to these functions.
1183 GV* gv_fetchmethod_autoload(HV* stash, const char* name, I32 autoload)
1188 =item gv_fetchmeth_autoload
1189 X<gv_fetchmeth_autoload>
1191 Same as gv_fetchmeth(), but looks for autoloaded subroutines too.
1192 Returns a glob for the subroutine.
1194 For an autoloaded subroutine without a GV, will create a GV even
1195 if C<level < 0>. For an autoloaded subroutine without a stub, GvCV()
1196 of the result may be zero.
1198 GV* gv_fetchmeth_autoload(HV* stash, const char* name, STRLEN len, I32 level)
1206 Returns a pointer to the stash for a specified package. C<name> should
1207 be a valid UTF-8 string and must be null-terminated. If C<create> is set
1208 then the package will be created if it does not already exist. If C<create>
1209 is not set and the package does not exist then NULL is returned.
1211 HV* gv_stashpv(const char* name, I32 create)
1219 Returns a pointer to the stash for a specified package. C<name> should
1220 be a valid UTF-8 string. The C<namelen> parameter indicates the length of
1221 the C<name>, in bytes. If C<create> is set then the package will be
1222 created if it does not already exist. If C<create> is not set and the
1223 package does not exist then NULL is returned.
1225 HV* gv_stashpvn(const char* name, U32 namelen, I32 create)
1233 Returns a pointer to the stash for a specified package, which must be a
1234 valid UTF-8 string. See C<gv_stashpv>.
1236 HV* gv_stashsv(SV* sv, I32 create)
1259 Null character pointer.
1262 Found in file handy.h
1286 Found in file handy.h
1291 =head1 Hash Manipulation Functions
1298 Returns the HV of the specified Perl hash. If C<create> is set and the
1299 Perl variable does not exist then it will be created. If C<create> is not
1300 set and the variable does not exist then NULL is returned.
1302 NOTE: the perl_ form of this function is deprecated.
1304 HV* get_hv(const char* name, I32 create)
1307 Found in file perl.c
1312 This flag, used in the length slot of hash entries and magic structures,
1313 specifies the structure contains an C<SV*> pointer where a C<char*> pointer
1314 is to be expected. (For information only--not to be used).
1322 Returns the computed hash stored in the hash entry.
1332 Returns the actual pointer stored in the key slot of the hash entry. The
1333 pointer may be either C<char*> or C<SV*>, depending on the value of
1334 C<HeKLEN()>. Can be assigned to. The C<HePV()> or C<HeSVKEY()> macros are
1335 usually preferable for finding the value of a key.
1345 If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry
1346 holds an C<SV*> key. Otherwise, holds the actual length of the key. Can
1347 be assigned to. The C<HePV()> macro is usually preferable for finding key
1350 STRLEN HeKLEN(HE* he)
1358 Returns the key slot of the hash entry as a C<char*> value, doing any
1359 necessary dereferencing of possibly C<SV*> keys. The length of the string
1360 is placed in C<len> (this is a macro, so do I<not> use C<&len>). If you do
1361 not care about what the length of the key is, you may use the global
1362 variable C<PL_na>, though this is rather less efficient than using a local
1363 variable. Remember though, that hash keys in perl are free to contain
1364 embedded nulls, so using C<strlen()> or similar is not a good way to find
1365 the length of hash keys. This is very similar to the C<SvPV()> macro
1366 described elsewhere in this document.
1368 char* HePV(HE* he, STRLEN len)
1376 Returns the key as an C<SV*>, or C<NULL> if the hash entry does not
1377 contain an C<SV*> key.
1387 Returns the key as an C<SV*>. Will create and return a temporary mortal
1388 C<SV*> if the hash entry contains only a C<char*> key.
1390 SV* HeSVKEY_force(HE* he)
1398 Sets the key to a given C<SV*>, taking care to set the appropriate flags to
1399 indicate the presence of an C<SV*> key, and returns the same
1402 SV* HeSVKEY_set(HE* he, SV* sv)
1410 Returns the value slot (type C<SV*>) stored in the hash entry.
1420 Returns the package name of a stash, or NULL if C<stash> isn't a stash.
1421 See C<SvSTASH>, C<CvSTASH>.
1423 char* HvNAME(HV* stash)
1431 Check that a hash is in an internally consistent state.
1433 void hv_assert(HV* tb)
1441 Clears a hash, making it empty.
1443 void hv_clear(HV* tb)
1448 =item hv_clear_placeholders
1449 X<hv_clear_placeholders>
1451 Clears any placeholders from a hash. If a restricted hash has any of its keys
1452 marked as readonly and the key is subsequently deleted, the key is not actually
1453 deleted but is marked by assigning it a value of &PL_sv_placeholder. This tags
1454 it so it will be ignored by future operations such as iterating over the hash,
1455 but will still allow the hash to have a value reassigned to the key at some
1456 future point. This function clears any such placeholder keys from the hash.
1457 See Hash::Util::lock_keys() for an example of its use.
1459 void hv_clear_placeholders(HV* hb)
1467 Deletes a key/value pair in the hash. The value SV is removed from the
1468 hash and returned to the caller. The C<klen> is the length of the key.
1469 The C<flags> value will normally be zero; if set to G_DISCARD then NULL
1472 SV* hv_delete(HV* tb, const char* key, I32 klen, I32 flags)
1480 Deletes a key/value pair in the hash. The value SV is removed from the
1481 hash and returned to the caller. The C<flags> value will normally be zero;
1482 if set to G_DISCARD then NULL will be returned. C<hash> can be a valid
1483 precomputed hash value, or 0 to ask for it to be computed.
1485 SV* hv_delete_ent(HV* tb, SV* key, I32 flags, U32 hash)
1493 Returns a boolean indicating whether the specified hash key exists. The
1494 C<klen> is the length of the key.
1496 bool hv_exists(HV* tb, const char* key, I32 klen)
1504 Returns a boolean indicating whether the specified hash key exists. C<hash>
1505 can be a valid precomputed hash value, or 0 to ask for it to be
1508 bool hv_exists_ent(HV* tb, SV* key, U32 hash)
1516 Returns the SV which corresponds to the specified key in the hash. The
1517 C<klen> is the length of the key. If C<lval> is set then the fetch will be
1518 part of a store. Check that the return value is non-null before
1519 dereferencing it to an C<SV*>.
1521 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1522 information on how to use this function on tied hashes.
1524 SV** hv_fetch(HV* tb, const char* key, I32 klen, I32 lval)
1532 Returns the hash entry which corresponds to the specified key in the hash.
1533 C<hash> must be a valid precomputed hash number for the given C<key>, or 0
1534 if you want the function to compute it. IF C<lval> is set then the fetch
1535 will be part of a store. Make sure the return value is non-null before
1536 accessing it. The return value when C<tb> is a tied hash is a pointer to a
1537 static location, so be sure to make a copy of the structure if you need to
1540 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1541 information on how to use this function on tied hashes.
1543 HE* hv_fetch_ent(HV* tb, SV* key, I32 lval, U32 hash)
1551 Prepares a starting point to traverse a hash table. Returns the number of
1552 keys in the hash (i.e. the same as C<HvKEYS(tb)>). The return value is
1553 currently only meaningful for hashes without tie magic.
1555 NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
1556 hash buckets that happen to be in use. If you still need that esoteric
1557 value, you can get it through the macro C<HvFILL(tb)>.
1560 I32 hv_iterinit(HV* tb)
1568 Returns the key from the current position of the hash iterator. See
1571 char* hv_iterkey(HE* entry, I32* retlen)
1579 Returns the key as an C<SV*> from the current position of the hash
1580 iterator. The return value will always be a mortal copy of the key. Also
1583 SV* hv_iterkeysv(HE* entry)
1591 Returns entries from a hash iterator. See C<hv_iterinit>.
1593 You may call C<hv_delete> or C<hv_delete_ent> on the hash entry that the
1594 iterator currently points to, without losing your place or invalidating your
1595 iterator. Note that in this case the current entry is deleted from the hash
1596 with your iterator holding the last reference to it. Your iterator is flagged
1597 to free the entry on the next call to C<hv_iternext>, so you must not discard
1598 your iterator immediately else the entry will leak - call C<hv_iternext> to
1599 trigger the resource deallocation.
1601 HE* hv_iternext(HV* tb)
1609 Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
1612 SV* hv_iternextsv(HV* hv, char** key, I32* retlen)
1617 =item hv_iternext_flags
1618 X<hv_iternext_flags>
1620 Returns entries from a hash iterator. See C<hv_iterinit> and C<hv_iternext>.
1621 The C<flags> value will normally be zero; if HV_ITERNEXT_WANTPLACEHOLDERS is
1622 set the placeholders keys (for restricted hashes) will be returned in addition
1623 to normal keys. By default placeholders are automatically skipped over.
1624 Currently a placeholder is implemented with a value that is
1625 C<&Perl_sv_placeholder>. Note that the implementation of placeholders and
1626 restricted hashes may change, and the implementation currently is
1627 insufficiently abstracted for any change to be tidy.
1629 NOTE: this function is experimental and may change or be
1630 removed without notice.
1632 HE* hv_iternext_flags(HV* tb, I32 flags)
1640 Returns the value from the current position of the hash iterator. See
1643 SV* hv_iterval(HV* tb, HE* entry)
1651 Adds magic to a hash. See C<sv_magic>.
1653 void hv_magic(HV* hv, GV* gv, int how)
1661 Evaluates the hash in scalar context and returns the result. Handles magic when the hash is tied.
1663 SV* hv_scalar(HV* hv)
1671 Stores an SV in a hash. The hash key is specified as C<key> and C<klen> is
1672 the length of the key. The C<hash> parameter is the precomputed hash
1673 value; if it is zero then Perl will compute it. The return value will be
1674 NULL if the operation failed or if the value did not need to be actually
1675 stored within the hash (as in the case of tied hashes). Otherwise it can
1676 be dereferenced to get the original C<SV*>. Note that the caller is
1677 responsible for suitably incrementing the reference count of C<val> before
1678 the call, and decrementing it if the function returned NULL. Effectively
1679 a successful hv_store takes ownership of one reference to C<val>. This is
1680 usually what you want; a newly created SV has a reference count of one, so
1681 if all your code does is create SVs then store them in a hash, hv_store
1682 will own the only reference to the new SV, and your code doesn't need to do
1683 anything further to tidy up. hv_store is not implemented as a call to
1684 hv_store_ent, and does not create a temporary SV for the key, so if your
1685 key data is not already in SV form then use hv_store in preference to
1688 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1689 information on how to use this function on tied hashes.
1691 SV** hv_store(HV* tb, const char* key, I32 klen, SV* val, U32 hash)
1699 Stores C<val> in a hash. The hash key is specified as C<key>. The C<hash>
1700 parameter is the precomputed hash value; if it is zero then Perl will
1701 compute it. The return value is the new hash entry so created. It will be
1702 NULL if the operation failed or if the value did not need to be actually
1703 stored within the hash (as in the case of tied hashes). Otherwise the
1704 contents of the return value can be accessed using the C<He?> macros
1705 described here. Note that the caller is responsible for suitably
1706 incrementing the reference count of C<val> before the call, and
1707 decrementing it if the function returned NULL. Effectively a successful
1708 hv_store_ent takes ownership of one reference to C<val>. This is
1709 usually what you want; a newly created SV has a reference count of one, so
1710 if all your code does is create SVs then store them in a hash, hv_store
1711 will own the only reference to the new SV, and your code doesn't need to do
1712 anything further to tidy up. Note that hv_store_ent only reads the C<key>;
1713 unlike C<val> it does not take ownership of it, so maintaining the correct
1714 reference count on C<key> is entirely the caller's responsibility. hv_store
1715 is not implemented as a call to hv_store_ent, and does not create a temporary
1716 SV for the key, so if your key data is not already in SV form then use
1717 hv_store in preference to hv_store_ent.
1719 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1720 information on how to use this function on tied hashes.
1722 HE* hv_store_ent(HV* tb, SV* key, SV* val, U32 hash)
1732 void hv_undef(HV* tb)
1740 Creates a new HV. The reference count is set to 1.
1750 =head1 Magical Functions
1757 Clear something magical that the SV represents. See C<sv_magic>.
1759 int mg_clear(SV* sv)
1767 Copies the magic from one SV to another. See C<sv_magic>.
1769 int mg_copy(SV* sv, SV* nsv, const char* key, I32 klen)
1777 Finds the magic pointer for type matching the SV. See C<sv_magic>.
1779 MAGIC* mg_find(const SV* sv, int type)
1787 Free any magic storage used by the SV. See C<sv_magic>.
1797 Do magic after a value is retrieved from the SV. See C<sv_magic>.
1807 Report on the SV's length. See C<sv_magic>.
1809 U32 mg_length(SV* sv)
1817 Turns on the magical status of an SV. See C<sv_magic>.
1819 void mg_magical(SV* sv)
1827 Do magic after a value is assigned to the SV. See C<sv_magic>.
1837 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
1838 argument more than once.
1840 void SvGETMAGIC(SV* sv)
1848 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
1859 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
1860 argument more than once.
1862 void SvSETMAGIC(SV* sv)
1870 Like C<SvSetSV>, but does any set magic required afterwards.
1872 void SvSetMagicSV(SV* dsb, SV* ssv)
1877 =item SvSetMagicSV_nosteal
1878 X<SvSetMagicSV_nosteal>
1880 Like C<SvSetSV_nosteal>, but does any set magic required afterwards.
1882 void SvSetMagicSV_nosteal(SV* dsv, SV* ssv)
1890 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
1893 void SvSetSV(SV* dsb, SV* ssv)
1898 =item SvSetSV_nosteal
1901 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
1902 ssv. May evaluate arguments more than once.
1904 void SvSetSV_nosteal(SV* dsv, SV* ssv)
1912 Arranges for sv to be shared between threads if a suitable module
1915 void SvSHARE(SV* sv)
1923 Releases a mutual exclusion lock on sv if a suitable module
1926 void SvUNLOCK(SV* sv)
1934 =head1 Memory Management
1941 The XSUB-writer's interface to the C C<memcpy> function. The C<src> is the
1942 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1943 the type. May fail on overlapping copies. See also C<Move>.
1945 void Copy(void* src, void* dest, int nitems, type)
1948 Found in file handy.h
1953 Like C<Copy> but returns dest. Useful for encouraging compilers to tail-call
1956 void * CopyD(void* src, void* dest, int nitems, type)
1959 Found in file handy.h
1964 The XSUB-writer's interface to the C C<memmove> function. The C<src> is the
1965 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1966 the type. Can do overlapping moves. See also C<Copy>.
1968 void Move(void* src, void* dest, int nitems, type)
1971 Found in file handy.h
1976 Like C<Move> but returns dest. Useful for encouraging compilers to tail-call
1979 void * MoveD(void* src, void* dest, int nitems, type)
1982 Found in file handy.h
1987 The XSUB-writer's interface to the C C<malloc> function.
1989 In 5.9.3, Newx() and friends replace the older New() API, and drops
1990 the first parameter, I<x>, a debug aid which allowed callers to identify
1991 themselves. This aid has been superseded by a new build option,
1992 PERL_MEM_LOG (see L<perlhack/PERL_MEM_LOG>). The older API is still
1993 there for use in XS modules supporting older perls.
1995 void Newx(void* ptr, int nitems, type)
1998 Found in file handy.h
2003 The XSUB-writer's interface to the C C<malloc> function, with
2004 cast. See also C<Newx>.
2006 void Newxc(void* ptr, int nitems, type, cast)
2009 Found in file handy.h
2014 The XSUB-writer's interface to the C C<malloc> function. The allocated
2015 memory is zeroed with C<memzero>. See also C<Newx>.
2017 void Newxz(void* ptr, int nitems, type)
2020 Found in file handy.h
2025 PoisonWith(0xEF) for catching access to freed memory.
2027 void Poison(void* dest, int nitems, type)
2030 Found in file handy.h
2035 PoisonWith(0xAB) for catching access to allocated but uninitialized memory.
2037 void PoisonNew(void* dest, int nitems, type)
2040 Found in file handy.h
2045 Fill up memory with a byte pattern (a byte repeated over and over
2046 again) that hopefully catches attempts to access uninitialized memory.
2048 void PoisonWith(void* dest, int nitems, type, U8 byte)
2051 Found in file handy.h
2056 The XSUB-writer's interface to the C C<realloc> function.
2058 void Renew(void* ptr, int nitems, type)
2061 Found in file handy.h
2066 The XSUB-writer's interface to the C C<realloc> function, with
2069 void Renewc(void* ptr, int nitems, type, cast)
2072 Found in file handy.h
2077 The XSUB-writer's interface to the C C<free> function.
2079 void Safefree(void* ptr)
2082 Found in file handy.h
2087 Perl's version of C<strdup()>. Returns a pointer to a newly allocated
2088 string which is a duplicate of C<pv>. The size of the string is
2089 determined by C<strlen()>. The memory allocated for the new string can
2090 be freed with the C<Safefree()> function.
2092 char* savepv(const char* pv)
2095 Found in file util.c
2100 Perl's version of what C<strndup()> would be if it existed. Returns a
2101 pointer to a newly allocated string which is a duplicate of the first
2102 C<len> bytes from C<pv>. The memory allocated for the new string can be
2103 freed with the C<Safefree()> function.
2105 char* savepvn(const char* pv, I32 len)
2108 Found in file util.c
2113 A version of C<savepv()> which allocates the duplicate string in memory
2114 which is shared between threads.
2116 char* savesharedpv(const char* pv)
2119 Found in file util.c
2124 A version of C<savepv()>/C<savepvn()> which gets the string to duplicate from
2125 the passed in SV using C<SvPV()>
2127 char* savesvpv(SV* sv)
2130 Found in file util.c
2135 This is an architecture-independent macro to copy one structure to another.
2137 void StructCopy(type src, type dest, type)
2140 Found in file handy.h
2145 The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the
2146 destination, C<nitems> is the number of items, and C<type> is the type.
2148 void Zero(void* dest, int nitems, type)
2151 Found in file handy.h
2156 Like C<Zero> but returns dest. Useful for encouraging compilers to tail-call
2159 void * ZeroD(void* dest, int nitems, type)
2162 Found in file handy.h
2167 =head1 Miscellaneous Functions
2174 Analyses the string in order to make fast searches on it using fbm_instr()
2175 -- the Boyer-Moore algorithm.
2177 void fbm_compile(SV* sv, U32 flags)
2180 Found in file util.c
2185 Returns the location of the SV in the string delimited by C<str> and
2186 C<strend>. It returns C<NULL> if the string can't be found. The C<sv>
2187 does not have to be fbm_compiled, but the search will not be as fast
2190 char* fbm_instr(unsigned char* big, unsigned char* bigend, SV* littlesv, U32 flags)
2193 Found in file util.c
2198 Takes a sprintf-style format pattern and conventional
2199 (non-SV) arguments and returns the formatted string.
2201 (char *) Perl_form(pTHX_ const char* pat, ...)
2203 can be used any place a string (char *) is required:
2205 char * s = Perl_form("%d.%d",major,minor);
2207 Uses a single private buffer so if you want to format several strings you
2208 must explicitly copy the earlier strings away (and free the copies when you
2211 char* form(const char* pat, ...)
2214 Found in file util.c
2219 Fill the sv with current working directory
2221 int getcwd_sv(SV* sv)
2224 Found in file util.c
2229 The C library C<sprintf>, wrapped if necessary, to ensure that it will return
2230 the length of the string written to the buffer. Only rare pre-ANSI systems
2231 need the wrapper function - usually this is a direct call to C<sprintf>.
2233 int my_sprintf(char *buffer, const char *pat, ...)
2236 Found in file util.c
2241 Returns a new version object based on the passed in SV:
2243 SV *sv = new_version(SV *ver);
2245 Does not alter the passed in ver SV. See "upg_version" if you
2246 want to upgrade the SV.
2248 SV* new_version(SV *ver)
2251 Found in file util.c
2256 Returns a pointer to the next character after the parsed
2257 version string, as well as upgrading the passed in SV to
2260 Function must be called with an already existing SV like
2263 s = scan_version(s,SV *sv, bool qv);
2265 Performs some preprocessing to the string to ensure that
2266 it has the correct characteristics of a version. Flags the
2267 object if it contains an underscore (which denotes this
2268 is a alpha version). The boolean qv denotes that the version
2269 should be interpreted as if it had multiple decimals, even if
2272 const char* scan_version(const char *vstr, SV *sv, bool qv)
2275 Found in file util.c
2280 Test two strings to see if they are equal. Returns true or false.
2282 bool strEQ(char* s1, char* s2)
2285 Found in file handy.h
2290 Test two strings to see if the first, C<s1>, is greater than or equal to
2291 the second, C<s2>. Returns true or false.
2293 bool strGE(char* s1, char* s2)
2296 Found in file handy.h
2301 Test two strings to see if the first, C<s1>, is greater than the second,
2302 C<s2>. Returns true or false.
2304 bool strGT(char* s1, char* s2)
2307 Found in file handy.h
2312 Test two strings to see if the first, C<s1>, is less than or equal to the
2313 second, C<s2>. Returns true or false.
2315 bool strLE(char* s1, char* s2)
2318 Found in file handy.h
2323 Test two strings to see if the first, C<s1>, is less than the second,
2324 C<s2>. Returns true or false.
2326 bool strLT(char* s1, char* s2)
2329 Found in file handy.h
2334 Test two strings to see if they are different. Returns true or
2337 bool strNE(char* s1, char* s2)
2340 Found in file handy.h
2345 Test two strings to see if they are equal. The C<len> parameter indicates
2346 the number of bytes to compare. Returns true or false. (A wrapper for
2349 bool strnEQ(char* s1, char* s2, STRLEN len)
2352 Found in file handy.h
2357 Test two strings to see if they are different. The C<len> parameter
2358 indicates the number of bytes to compare. Returns true or false. (A
2359 wrapper for C<strncmp>).
2361 bool strnNE(char* s1, char* s2, STRLEN len)
2364 Found in file handy.h
2369 Dummy routine which "shares" an SV when there is no sharing module present.
2370 Or "locks" it. Or "unlocks" it. In other words, ignores its single SV argument.
2371 Exists to avoid test for a NULL function pointer and because it could
2372 potentially warn under some level of strict-ness.
2374 void sv_nosharing(SV *sv)
2377 Found in file util.c
2382 In-place upgrade of the supplied SV to a version object.
2384 SV *sv = upg_version(SV *sv);
2386 Returns a pointer to the upgraded SV.
2388 SV* upg_version(SV *ver)
2391 Found in file util.c
2396 Version object aware cmp. Both operands must already have been
2397 converted into version objects.
2399 int vcmp(SV *lvs, SV *rvs)
2402 Found in file util.c
2407 Accepts a version object and returns the normalized string
2408 representation. Call like:
2412 NOTE: you can pass either the object directly or the SV
2413 contained within the RV.
2418 Found in file util.c
2423 Accepts a version object and returns the normalized floating
2424 point representation. Call like:
2428 NOTE: you can pass either the object directly or the SV
2429 contained within the RV.
2434 Found in file util.c
2439 In order to maintain maximum compatibility with earlier versions
2440 of Perl, this function will return either the floating point
2441 notation or the multiple dotted notation, depending on whether
2442 the original version contained 1 or more dots, respectively
2444 SV* vstringify(SV *vs)
2447 Found in file util.c
2452 Validates that the SV contains a valid version object.
2454 bool vverify(SV *vobj);
2456 Note that it only confirms the bare minimum structure (so as not to get
2457 confused by derived classes which may contain additional hash entries):
2459 bool vverify(SV *vs)
2462 Found in file util.c
2467 =head1 Multicall Functions
2474 Declare local variables for a multicall. See L<perlcall/Lightweight Callbacks>.
2484 Make a lightweight callback. See L<perlcall/Lightweight Callbacks>.
2494 Closing bracket for a lightweight callback.
2495 See L<perlcall/Lightweight Callbacks>.
2502 =item PUSH_MULTICALL
2505 Opening bracket for a lightweight callback.
2506 See L<perlcall/Lightweight Callbacks>.
2516 =head1 Numeric functions
2523 converts a string representing a binary number to numeric form.
2525 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2526 conversion flags, and I<result> should be NULL or a pointer to an NV.
2527 The scan stops at the end of the string, or the first invalid character.
2528 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2529 invalid character will also trigger a warning.
2530 On return I<*len> is set to the length of the scanned string,
2531 and I<*flags> gives output flags.
2533 If the value is <= C<UV_MAX> it is returned as a UV, the output flags are clear,
2534 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_bin>
2535 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2536 and writes the value to I<*result> (or the value is discarded if I<result>
2539 The binary number may optionally be prefixed with "0b" or "b" unless
2540 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
2541 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the binary
2542 number may use '_' characters to separate digits.
2544 UV grok_bin(const char* start, STRLEN* len_p, I32* flags, NV *result)
2547 Found in file numeric.c
2552 converts a string representing a hex number to numeric form.
2554 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2555 conversion flags, and I<result> should be NULL or a pointer to an NV.
2556 The scan stops at the end of the string, or the first invalid character.
2557 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2558 invalid character will also trigger a warning.
2559 On return I<*len> is set to the length of the scanned string,
2560 and I<*flags> gives output flags.
2562 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2563 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_hex>
2564 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2565 and writes the value to I<*result> (or the value is discarded if I<result>
2568 The hex number may optionally be prefixed with "0x" or "x" unless
2569 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
2570 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the hex
2571 number may use '_' characters to separate digits.
2573 UV grok_hex(const char* start, STRLEN* len_p, I32* flags, NV *result)
2576 Found in file numeric.c
2581 Recognise (or not) a number. The type of the number is returned
2582 (0 if unrecognised), otherwise it is a bit-ORed combination of
2583 IS_NUMBER_IN_UV, IS_NUMBER_GREATER_THAN_UV_MAX, IS_NUMBER_NOT_INT,
2584 IS_NUMBER_NEG, IS_NUMBER_INFINITY, IS_NUMBER_NAN (defined in perl.h).
2586 If the value of the number can fit an in UV, it is returned in the *valuep
2587 IS_NUMBER_IN_UV will be set to indicate that *valuep is valid, IS_NUMBER_IN_UV
2588 will never be set unless *valuep is valid, but *valuep may have been assigned
2589 to during processing even though IS_NUMBER_IN_UV is not set on return.
2590 If valuep is NULL, IS_NUMBER_IN_UV will be set for the same cases as when
2591 valuep is non-NULL, but no actual assignment (or SEGV) will occur.
2593 IS_NUMBER_NOT_INT will be set with IS_NUMBER_IN_UV if trailing decimals were
2594 seen (in which case *valuep gives the true value truncated to an integer), and
2595 IS_NUMBER_NEG if the number is negative (in which case *valuep holds the
2596 absolute value). IS_NUMBER_IN_UV is not set if e notation was used or the
2597 number is larger than a UV.
2599 int grok_number(const char *pv, STRLEN len, UV *valuep)
2602 Found in file numeric.c
2604 =item grok_numeric_radix
2605 X<grok_numeric_radix>
2607 Scan and skip for a numeric decimal separator (radix).
2609 bool grok_numeric_radix(const char **sp, const char *send)
2612 Found in file numeric.c
2617 converts a string representing an octal number to numeric form.
2619 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2620 conversion flags, and I<result> should be NULL or a pointer to an NV.
2621 The scan stops at the end of the string, or the first invalid character.
2622 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2623 invalid character will also trigger a warning.
2624 On return I<*len> is set to the length of the scanned string,
2625 and I<*flags> gives output flags.
2627 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2628 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_oct>
2629 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2630 and writes the value to I<*result> (or the value is discarded if I<result>
2633 If C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the octal
2634 number may use '_' characters to separate digits.
2636 UV grok_oct(const char* start, STRLEN* len_p, I32* flags, NV *result)
2639 Found in file numeric.c
2644 For backwards compatibility. Use C<grok_bin> instead.
2646 NV scan_bin(const char* start, STRLEN len, STRLEN* retlen)
2649 Found in file numeric.c
2654 For backwards compatibility. Use C<grok_hex> instead.
2656 NV scan_hex(const char* start, STRLEN len, STRLEN* retlen)
2659 Found in file numeric.c
2664 For backwards compatibility. Use C<grok_oct> instead.
2666 NV scan_oct(const char* start, STRLEN len, STRLEN* retlen)
2669 Found in file numeric.c
2674 =head1 Optree Manipulation Functions
2681 If C<cv> is a constant sub eligible for inlining. returns the constant
2682 value returned by the sub. Otherwise, returns NULL.
2684 Constant subs can be created with C<newCONSTSUB> or as described in
2685 L<perlsub/"Constant Functions">.
2687 SV* cv_const_sv(CV* cv)
2695 Creates a constant sub equivalent to Perl C<sub FOO () { 123 }> which is
2696 eligible for inlining at compile-time.
2698 CV* newCONSTSUB(HV* stash, const char* name, SV* sv)
2706 Used by C<xsubpp> to hook up XSUBs as Perl subs.
2714 =head1 Pad Data Structures
2721 Get the value at offset po in the current pad.
2722 Use macro PAD_SV instead of calling this function directly.
2724 SV* pad_sv(PADOFFSET po)
2732 =head1 Simple Exception Handling Macros
2739 Set up necessary local variables for exception handling.
2740 See L<perlguts/"Exception Handling">.
2745 Found in file XSUB.h
2750 Introduces a catch block. See L<perlguts/"Exception Handling">.
2753 Found in file XSUB.h
2758 Rethrows a previously caught exception. See L<perlguts/"Exception Handling">.
2763 Found in file XSUB.h
2768 Ends a try block. See L<perlguts/"Exception Handling">.
2771 Found in file XSUB.h
2773 =item XCPT_TRY_START
2776 Starts a try block. See L<perlguts/"Exception Handling">.
2779 Found in file XSUB.h
2784 =head1 Stack Manipulation Macros
2791 Declare a stack marker variable, C<mark>, for the XSUB. See C<MARK> and
2802 Saves the original stack mark for the XSUB. See C<ORIGMARK>.
2812 Declares a local copy of perl's stack pointer for the XSUB, available via
2813 the C<SP> macro. See C<SP>.
2823 Used to extend the argument stack for an XSUB's return values. Once
2824 used, guarantees that there is room for at least C<nitems> to be pushed
2827 void EXTEND(SP, int nitems)
2835 Stack marker variable for the XSUB. See C<dMARK>.
2843 Push an integer onto the stack. The stack must have room for this element.
2844 Handles 'set' magic. Does not use C<TARG>. See also C<PUSHi>, C<mXPUSHi>
2855 Push a double onto the stack. The stack must have room for this element.
2856 Handles 'set' magic. Does not use C<TARG>. See also C<PUSHn>, C<mXPUSHn>
2867 Push a string onto the stack. The stack must have room for this element.
2868 The C<len> indicates the length of the string. Handles 'set' magic. Does
2869 not use C<TARG>. See also C<PUSHp>, C<mXPUSHp> and C<XPUSHp>.
2871 void mPUSHp(char* str, STRLEN len)
2879 Push an unsigned integer onto the stack. The stack must have room for this
2880 element. Handles 'set' magic. Does not use C<TARG>. See also C<PUSHu>,
2881 C<mXPUSHu> and C<XPUSHu>.
2891 Push an integer onto the stack, extending the stack if necessary. Handles
2892 'set' magic. Does not use C<TARG>. See also C<XPUSHi>, C<mPUSHi> and
2903 Push a double onto the stack, extending the stack if necessary. Handles
2904 'set' magic. Does not use C<TARG>. See also C<XPUSHn>, C<mPUSHn> and
2915 Push a string onto the stack, extending the stack if necessary. The C<len>
2916 indicates the length of the string. Handles 'set' magic. Does not use
2917 C<TARG>. See also C<XPUSHp>, C<mPUSHp> and C<PUSHp>.
2919 void mXPUSHp(char* str, STRLEN len)
2927 Push an unsigned integer onto the stack, extending the stack if necessary.
2928 Handles 'set' magic. Does not use C<TARG>. See also C<XPUSHu>, C<mPUSHu>
2939 The original stack mark for the XSUB. See C<dORIGMARK>.
2947 Pops an integer off the stack.
2957 Pops a long off the stack.
2967 Pops a double off the stack.
2977 Pops a string off the stack. Deprecated. New code should use POPpx.
2987 Pops a string off the stack which must consist of bytes i.e. characters < 256.
2997 Pops a string off the stack.
3007 Pops an SV off the stack.
3017 Push an integer onto the stack. The stack must have room for this element.
3018 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3019 called to declare it. Do not call multiple C<TARG>-oriented macros to
3020 return lists from XSUB's - see C<mPUSHi> instead. See also C<XPUSHi> and
3031 Opening bracket for arguments on a callback. See C<PUTBACK> and
3042 Push a new mortal SV onto the stack. The stack must have room for this
3043 element. Does not handle 'set' magic. Does not use C<TARG>. See also
3044 C<PUSHs>, C<XPUSHmortal> and C<XPUSHs>.
3054 Push a double onto the stack. The stack must have room for this element.
3055 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3056 called to declare it. Do not call multiple C<TARG>-oriented macros to
3057 return lists from XSUB's - see C<mPUSHn> instead. See also C<XPUSHn> and
3068 Push a string onto the stack. The stack must have room for this element.
3069 The C<len> indicates the length of the string. Handles 'set' magic. Uses
3070 C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to declare it. Do not
3071 call multiple C<TARG>-oriented macros to return lists from XSUB's - see
3072 C<mPUSHp> instead. See also C<XPUSHp> and C<mXPUSHp>.
3074 void PUSHp(char* str, STRLEN len)
3082 Push an SV onto the stack. The stack must have room for this element.
3083 Does not handle 'set' magic. Does not use C<TARG>. See also C<PUSHmortal>,
3084 C<XPUSHs> and C<XPUSHmortal>.
3094 Push an unsigned integer onto the stack. The stack must have room for this
3095 element. Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG>
3096 should be called to declare it. Do not call multiple C<TARG>-oriented
3097 macros to return lists from XSUB's - see C<mPUSHu> instead. See also
3098 C<XPUSHu> and C<mXPUSHu>.
3108 Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
3109 See C<PUSHMARK> and L<perlcall> for other uses.
3119 Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and
3128 Refetch the stack pointer. Used after a callback. See L<perlcall>.
3138 Push an integer onto the stack, extending the stack if necessary. Handles
3139 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
3140 declare it. Do not call multiple C<TARG>-oriented macros to return lists
3141 from XSUB's - see C<mXPUSHi> instead. See also C<PUSHi> and C<mPUSHi>.
3151 Push a new mortal SV onto the stack, extending the stack if necessary. Does
3152 not handle 'set' magic. Does not use C<TARG>. See also C<XPUSHs>,
3153 C<PUSHmortal> and C<PUSHs>.
3163 Push a double onto the stack, extending the stack if necessary. Handles
3164 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
3165 declare it. Do not call multiple C<TARG>-oriented macros to return lists
3166 from XSUB's - see C<mXPUSHn> instead. See also C<PUSHn> and C<mPUSHn>.
3176 Push a string onto the stack, extending the stack if necessary. The C<len>
3177 indicates the length of the string. Handles 'set' magic. Uses C<TARG>, so
3178 C<dTARGET> or C<dXSTARG> should be called to declare it. Do not call
3179 multiple C<TARG>-oriented macros to return lists from XSUB's - see
3180 C<mXPUSHp> instead. See also C<PUSHp> and C<mPUSHp>.
3182 void XPUSHp(char* str, STRLEN len)
3190 Push an SV onto the stack, extending the stack if necessary. Does not
3191 handle 'set' magic. Does not use C<TARG>. See also C<XPUSHmortal>,
3192 C<PUSHs> and C<PUSHmortal>.
3202 Push an unsigned integer onto the stack, extending the stack if necessary.
3203 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3204 called to declare it. Do not call multiple C<TARG>-oriented macros to
3205 return lists from XSUB's - see C<mXPUSHu> instead. See also C<PUSHu> and
3216 Return from XSUB, indicating number of items on the stack. This is usually
3217 handled by C<xsubpp>.
3219 void XSRETURN(int nitems)
3222 Found in file XSUB.h
3224 =item XSRETURN_EMPTY
3227 Return an empty list from an XSUB immediately.
3232 Found in file XSUB.h
3237 Return an integer from an XSUB immediately. Uses C<XST_mIV>.
3239 void XSRETURN_IV(IV iv)
3242 Found in file XSUB.h
3247 Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
3252 Found in file XSUB.h
3257 Return a double from an XSUB immediately. Uses C<XST_mNV>.
3259 void XSRETURN_NV(NV nv)
3262 Found in file XSUB.h
3267 Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
3269 void XSRETURN_PV(char* str)
3272 Found in file XSUB.h
3274 =item XSRETURN_UNDEF
3277 Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
3282 Found in file XSUB.h
3287 Return an integer from an XSUB immediately. Uses C<XST_mUV>.
3289 void XSRETURN_UV(IV uv)
3292 Found in file XSUB.h
3297 Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
3302 Found in file XSUB.h
3307 Place an integer into the specified position C<pos> on the stack. The
3308 value is stored in a new mortal SV.
3310 void XST_mIV(int pos, IV iv)
3313 Found in file XSUB.h
3318 Place C<&PL_sv_no> into the specified position C<pos> on the
3321 void XST_mNO(int pos)
3324 Found in file XSUB.h
3329 Place a double into the specified position C<pos> on the stack. The value
3330 is stored in a new mortal SV.
3332 void XST_mNV(int pos, NV nv)
3335 Found in file XSUB.h
3340 Place a copy of a string into the specified position C<pos> on the stack.
3341 The value is stored in a new mortal SV.
3343 void XST_mPV(int pos, char* str)
3346 Found in file XSUB.h
3351 Place C<&PL_sv_undef> into the specified position C<pos> on the
3354 void XST_mUNDEF(int pos)
3357 Found in file XSUB.h
3362 Place C<&PL_sv_yes> into the specified position C<pos> on the
3365 void XST_mYES(int pos)
3368 Found in file XSUB.h
3380 An enum of flags for Perl types. These are found in the file B<sv.h>
3381 in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
3389 Integer type flag for scalars. See C<svtype>.
3397 Double type flag for scalars. See C<svtype>.
3405 Pointer type flag for scalars. See C<svtype>.
3413 Type flag for arrays. See C<svtype>.
3421 Type flag for code refs. See C<svtype>.
3429 Type flag for hashes. See C<svtype>.
3437 Type flag for blessed scalars. See C<svtype>.
3445 =head1 SV Manipulation Functions
3452 Returns the SV of the specified Perl scalar. If C<create> is set and the
3453 Perl variable does not exist then it will be created. If C<create> is not
3454 set and the variable does not exist then NULL is returned.
3456 NOTE: the perl_ form of this function is deprecated.
3458 SV* get_sv(const char* name, I32 create)
3461 Found in file perl.c
3466 Creates an RV wrapper for an SV. The reference count for the original SV is
3469 SV* newRV_inc(SV* sv)
3477 Returns the length of the string which is in the SV. See C<SvLEN>.
3479 STRLEN SvCUR(SV* sv)
3487 Set the current length of the string which is in the SV. See C<SvCUR>
3490 void SvCUR_set(SV* sv, STRLEN len)
3498 Returns a pointer to the last character in the string which is in the SV.
3499 See C<SvCUR>. Access the character as *(SvEND(sv)).
3509 Expands the character buffer in the SV so that it has room for the
3510 indicated number of bytes (remember to reserve space for an extra trailing
3511 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
3512 Returns a pointer to the character buffer.
3514 char * SvGROW(SV* sv, STRLEN len)
3522 Returns a boolean indicating whether the SV contains an integer.
3532 Returns a boolean indicating whether the SV contains an integer. Checks
3533 the B<private> setting. Use C<SvIOK>.
3543 Returns a boolean indicating whether the SV contains a signed integer.
3545 bool SvIOK_notUV(SV* sv)
3553 Unsets the IV status of an SV.
3555 void SvIOK_off(SV* sv)
3563 Tells an SV that it is an integer.
3565 void SvIOK_on(SV* sv)
3573 Tells an SV that it is an integer and disables all other OK bits.
3575 void SvIOK_only(SV* sv)
3583 Tells and SV that it is an unsigned integer and disables all other OK bits.
3585 void SvIOK_only_UV(SV* sv)
3593 Returns a boolean indicating whether the SV contains an unsigned integer.
3595 bool SvIOK_UV(SV* sv)
3603 Returns a boolean indicating whether the SV is Copy-On-Write. (either shared
3604 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
3607 bool SvIsCOW(SV* sv)
3612 =item SvIsCOW_shared_hash
3613 X<SvIsCOW_shared_hash>
3615 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
3618 bool SvIsCOW_shared_hash(SV* sv)
3626 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
3627 version which guarantees to evaluate sv only once.
3637 Returns the raw value in the SV's IV slot, without checks or conversions.
3638 Only use when you are sure SvIOK is true. See also C<SvIV()>.
3648 Coerces the given SV to an integer and returns it. Guarantees to evaluate
3649 sv only once. Use the more efficient C<SvIV> otherwise.
3659 Like C<SvIV> but doesn't process magic.
3661 IV SvIV_nomg(SV* sv)
3669 Set the value of the IV pointer in sv to val. It is possible to perform
3670 the same function of this macro with an lvalue assignment to C<SvIVX>.
3671 With future Perls, however, it will be more efficient to use
3672 C<SvIV_set> instead of the lvalue assignment to C<SvIVX>.
3674 void SvIV_set(SV* sv, IV val)
3682 Returns the size of the string buffer in the SV, not including any part
3683 attributable to C<SvOOK>. See C<SvCUR>.
3685 STRLEN SvLEN(SV* sv)
3693 Set the actual length of the string which is in the SV. See C<SvIV_set>.
3695 void SvLEN_set(SV* sv, STRLEN len)
3703 Set the value of the MAGIC pointer in sv to val. See C<SvIV_set>.
3705 void SvMAGIC_set(SV* sv, MAGIC* val)
3713 Returns a boolean indicating whether the SV contains a number, integer or
3724 Returns a boolean indicating whether the SV contains a number, integer or
3725 double. Checks the B<private> setting. Use C<SvNIOK>.
3727 bool SvNIOKp(SV* sv)
3735 Unsets the NV/IV status of an SV.
3737 void SvNIOK_off(SV* sv)
3745 Returns a boolean indicating whether the SV contains a double.
3755 Returns a boolean indicating whether the SV contains a double. Checks the
3756 B<private> setting. Use C<SvNOK>.
3766 Unsets the NV status of an SV.
3768 void SvNOK_off(SV* sv)
3776 Tells an SV that it is a double.
3778 void SvNOK_on(SV* sv)
3786 Tells an SV that it is a double and disables all other OK bits.
3788 void SvNOK_only(SV* sv)
3796 Coerce the given SV to a double and return it. See C<SvNVx> for a version
3797 which guarantees to evaluate sv only once.
3807 Returns the raw value in the SV's NV slot, without checks or conversions.
3808 Only use when you are sure SvNOK is true. See also C<SvNV()>.
3818 Coerces the given SV to a double and returns it. Guarantees to evaluate
3819 sv only once. Use the more efficient C<SvNV> otherwise.
3829 Set the value of the NV pointer in sv to val. See C<SvIV_set>.
3831 void SvNV_set(SV* sv, NV val)
3839 Returns a boolean indicating whether the value is an SV. It also tells
3840 whether the value is defined or not.
3850 Returns a boolean indicating whether the SvIVX is a valid offset value for
3851 the SvPVX. This hack is used internally to speed up removal of characters
3852 from the beginning of a SvPV. When SvOOK is true, then the start of the
3853 allocated string buffer is really (SvPVX - SvIVX).
3863 Returns a boolean indicating whether the SV contains a character
3874 Returns a boolean indicating whether the SV contains a character string.
3875 Checks the B<private> setting. Use C<SvPOK>.
3885 Unsets the PV status of an SV.
3887 void SvPOK_off(SV* sv)
3895 Tells an SV that it is a string.
3897 void SvPOK_on(SV* sv)
3905 Tells an SV that it is a string and disables all other OK bits.
3906 Will also turn off the UTF-8 status.
3908 void SvPOK_only(SV* sv)
3913 =item SvPOK_only_UTF8
3916 Tells an SV that it is a string and disables all other OK bits,
3917 and leaves the UTF-8 status as it was.
3919 void SvPOK_only_UTF8(SV* sv)
3927 Returns a pointer to the string in the SV, or a stringified form of
3928 the SV if the SV does not contain a string. The SV may cache the
3929 stringified version becoming C<SvPOK>. Handles 'get' magic. See also
3930 C<SvPVx> for a version which guarantees to evaluate sv only once.
3932 char* SvPV(SV* sv, STRLEN len)
3940 Like C<SvPV>, but converts sv to byte representation first if necessary.
3942 char* SvPVbyte(SV* sv, STRLEN len)
3950 Like C<SvPV>, but converts sv to byte representation first if necessary.
3951 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
3954 char* SvPVbytex(SV* sv, STRLEN len)
3959 =item SvPVbytex_force
3962 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
3963 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
3966 char* SvPVbytex_force(SV* sv, STRLEN len)
3971 =item SvPVbyte_force
3974 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
3976 char* SvPVbyte_force(SV* sv, STRLEN len)
3981 =item SvPVbyte_nolen
3984 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
3986 char* SvPVbyte_nolen(SV* sv)
3994 Like C<SvPV>, but converts sv to utf8 first if necessary.
3996 char* SvPVutf8(SV* sv, STRLEN len)
4004 Like C<SvPV>, but converts sv to utf8 first if necessary.
4005 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
4008 char* SvPVutf8x(SV* sv, STRLEN len)
4013 =item SvPVutf8x_force
4016 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
4017 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
4020 char* SvPVutf8x_force(SV* sv, STRLEN len)
4025 =item SvPVutf8_force
4028 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
4030 char* SvPVutf8_force(SV* sv, STRLEN len)
4035 =item SvPVutf8_nolen
4038 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
4040 char* SvPVutf8_nolen(SV* sv)
4048 Returns a pointer to the physical string in the SV. The SV must contain a
4059 A version of C<SvPV> which guarantees to evaluate sv only once.
4061 char* SvPVx(SV* sv, STRLEN len)
4069 Like C<SvPV> but will force the SV into containing just a string
4070 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
4073 char* SvPV_force(SV* sv, STRLEN len)
4078 =item SvPV_force_nomg
4081 Like C<SvPV> but will force the SV into containing just a string
4082 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
4083 directly. Doesn't process magic.
4085 char* SvPV_force_nomg(SV* sv, STRLEN len)
4093 Returns a pointer to the string in the SV, or a stringified form of
4094 the SV if the SV does not contain a string. The SV may cache the
4095 stringified form becoming C<SvPOK>. Handles 'get' magic.
4097 char* SvPV_nolen(SV* sv)
4105 Like C<SvPV> but doesn't process magic.
4107 char* SvPV_nomg(SV* sv, STRLEN len)
4115 Set the value of the PV pointer in sv to val. See C<SvIV_set>.
4117 void SvPV_set(SV* sv, char* val)
4125 Returns the value of the object's reference count.
4127 U32 SvREFCNT(SV* sv)
4135 Decrements the reference count of the given SV.
4137 void SvREFCNT_dec(SV* sv)
4145 Increments the reference count of the given SV.
4147 SV* SvREFCNT_inc(SV* sv)
4152 =item SvREFCNT_inc_NN
4155 Same as SvREFCNT_inc, but can only be used if you know I<sv>
4156 is not NULL. Since we don't have to check the NULLness, it's faster
4159 SV* SvREFCNT_inc_NN(SV* sv)
4164 =item SvREFCNT_inc_simple
4165 X<SvREFCNT_inc_simple>
4167 Same as SvREFCNT_inc, but can only be used with simple variables, not
4168 expressions or pointer dereferences. Since we don't have to store a
4169 temporary value, it's faster.
4171 SV* SvREFCNT_inc_simple(SV* sv)
4176 =item SvREFCNT_inc_simple_NN
4177 X<SvREFCNT_inc_simple_NN>
4179 Same as SvREFCNT_inc_simple, but can only be used if you know I<sv>
4180 is not NULL. Since we don't have to check the NULLness, it's faster
4183 SV* SvREFCNT_inc_simple_NN(SV* sv)
4188 =item SvREFCNT_inc_simple_void
4189 X<SvREFCNT_inc_simple_void>
4191 Same as SvREFCNT_inc_simple, but can only be used if you don't need the
4192 return value. The macro doesn't need to return a meaningful value.
4194 SV* SvREFCNT_inc_simple_void(SV* sv)
4199 =item SvREFCNT_inc_void
4200 X<SvREFCNT_inc_void>
4202 Same as SvREFCNT_inc, but can only be used if you don't need the
4203 return value. The macro doesn't need to return a meaningful value.
4205 SV* SvREFCNT_inc_void(SV* sv)
4210 =item SvREFCNT_inc_void_NN
4211 X<SvREFCNT_inc_void_NN>
4213 Same as SvREFCNT_inc, but can only be used if you don't need the return
4214 value, and you know that I<sv> is not NULL. The macro doesn't need
4215 to return a meaningful value, or check for NULLness, so it's smaller
4218 SV* SvREFCNT_inc_void_NN(SV* sv)
4226 Tests if the SV is an RV.
4236 Unsets the RV status of an SV.
4238 void SvROK_off(SV* sv)
4246 Tells an SV that it is an RV.
4248 void SvROK_on(SV* sv)
4256 Dereferences an RV to return the SV.
4266 Set the value of the RV pointer in sv to val. See C<SvIV_set>.
4268 void SvRV_set(SV* sv, SV* val)
4276 Returns the stash of the SV.
4286 Set the value of the STASH pointer in sv to val. See C<SvIV_set>.
4288 void SvSTASH_set(SV* sv, STASH* val)
4296 Taints an SV if tainting is enabled.
4298 void SvTAINT(SV* sv)
4306 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
4309 bool SvTAINTED(SV* sv)
4317 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
4318 some of Perl's fundamental security features. XS module authors should not
4319 use this function unless they fully understand all the implications of
4320 unconditionally untainting the value. Untainting should be done in the
4321 standard perl fashion, via a carefully crafted regexp, rather than directly
4322 untainting variables.
4324 void SvTAINTED_off(SV* sv)
4332 Marks an SV as tainted if tainting is enabled.
4334 void SvTAINTED_on(SV* sv)
4342 Returns a boolean indicating whether Perl would evaluate the SV as true or
4343 false, defined or undefined. Does not handle 'get' magic.
4353 Returns the type of the SV. See C<svtype>.
4355 svtype SvTYPE(SV* sv)
4363 Returns a boolean indicating whether the SV contains an unsigned integer.
4373 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
4374 perform the upgrade if necessary. See C<svtype>.
4376 void SvUPGRADE(SV* sv, svtype type)
4384 Returns a boolean indicating whether the SV contains UTF-8 encoded data.
4394 Unsets the UTF-8 status of an SV.
4396 void SvUTF8_off(SV *sv)
4404 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
4405 Do not use frivolously.
4407 void SvUTF8_on(SV *sv)
4415 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
4416 for a version which guarantees to evaluate sv only once.
4426 Returns the raw value in the SV's UV slot, without checks or conversions.
4427 Only use when you are sure SvIOK is true. See also C<SvUV()>.
4437 Coerces the given SV to an unsigned integer and returns it. Guarantees to
4438 evaluate sv only once. Use the more efficient C<SvUV> otherwise.
4448 Like C<SvUV> but doesn't process magic.
4450 UV SvUV_nomg(SV* sv)
4458 Set the value of the UV pointer in sv to val. See C<SvIV_set>.
4460 void SvUV_set(SV* sv, UV val)
4468 Returns a boolean indicating whether the SV contains a v-string.
4475 =item sv_catpvn_nomg
4478 Like C<sv_catpvn> but doesn't process magic.
4480 void sv_catpvn_nomg(SV* sv, const char* ptr, STRLEN len)
4488 Like C<sv_catsv> but doesn't process magic.
4490 void sv_catsv_nomg(SV* dsv, SV* ssv)
4495 =item sv_derived_from
4498 Returns a boolean indicating whether the SV is derived from the specified
4499 class. This is the function that implements C<UNIVERSAL::isa>. It works
4500 for class names as well as for objects.
4502 bool sv_derived_from(SV* sv, const char* name)
4505 Found in file universal.c
4507 =item sv_report_used
4510 Dump the contents of all SVs not yet freed. (Debugging aid).
4512 void sv_report_used()
4520 Like C<sv_setsv> but doesn't process magic.
4522 void sv_setsv_nomg(SV* dsv, SV* ssv)
4530 =head1 SV-Body Allocation
4534 =item looks_like_number
4535 X<looks_like_number>
4537 Test if the content of an SV looks like a number (or is a number).
4538 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
4539 non-numeric warning), even if your atof() doesn't grok them.
4541 I32 looks_like_number(SV* sv)
4549 Creates an RV wrapper for an SV. The reference count for the original
4550 SV is B<not> incremented.
4552 SV* newRV_noinc(SV* sv)
4560 Creates a new SV. A non-zero C<len> parameter indicates the number of
4561 bytes of preallocated string space the SV should have. An extra byte for a
4562 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4563 space is allocated.) The reference count for the new SV is set to 1.
4565 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4566 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4567 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4568 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4569 modules supporting older perls.
4571 SV* newSV(STRLEN len)
4579 Creates a new SV from the hash key structure. It will generate scalars that
4580 point to the shared string table where possible. Returns a new (undefined)
4581 SV if the hek is NULL.
4583 SV* newSVhek(const HEK *hek)
4591 Creates a new SV and copies an integer into it. The reference count for the
4602 Creates a new SV and copies a floating point value into it.
4603 The reference count for the SV is set to 1.
4613 Creates a new SV and copies a string into it. The reference count for the
4614 SV is set to 1. If C<len> is zero, Perl will compute the length using
4615 strlen(). For efficiency, consider using C<newSVpvn> instead.
4617 SV* newSVpv(const char* s, STRLEN len)
4625 Creates a new SV and initializes it with the string formatted like
4628 SV* newSVpvf(const char* pat, ...)
4636 Creates a new SV and copies a string into it. The reference count for the
4637 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
4638 string. You are responsible for ensuring that the source string is at least
4639 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
4641 SV* newSVpvn(const char* s, STRLEN len)
4646 =item newSVpvn_share
4649 Creates a new SV with its SvPVX_const pointing to a shared string in the string
4650 table. If the string does not already exist in the table, it is created
4651 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
4652 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
4653 otherwise the hash is computed. The idea here is that as the string table
4654 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
4655 hash lookup will avoid string compare.
4657 SV* newSVpvn_share(const char* s, I32 len, U32 hash)
4665 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
4666 it will be upgraded to one. If C<classname> is non-null then the new SV will
4667 be blessed in the specified package. The new SV is returned and its
4668 reference count is 1.
4670 SV* newSVrv(SV* rv, const char* classname)
4678 Creates a new SV which is an exact duplicate of the original SV.
4681 SV* newSVsv(SV* old)
4689 Creates a new SV and copies an unsigned integer into it.
4690 The reference count for the SV is set to 1.
4700 This function is only called on magical items, and is only used by
4701 sv_true() or its macro equivalent.
4703 bool sv_2bool(SV* sv)
4711 Using various gambits, try to get a CV from an SV; in addition, try if
4712 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
4713 The flags in C<lref> are passed to sv_fetchsv.
4715 CV* sv_2cv(SV* sv, HV** st, GV** gvp, I32 lref)
4723 Using various gambits, try to get an IO from an SV: the IO slot if its a
4724 GV; or the recursive result if we're an RV; or the IO slot of the symbol
4725 named after the PV if we're a string.
4735 Return the integer value of an SV, doing any necessary string
4736 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
4737 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
4739 IV sv_2iv_flags(SV* sv, I32 flags)
4747 Marks an existing SV as mortal. The SV will be destroyed "soon", either
4748 by an explicit call to FREETMPS, or by an implicit call at places such as
4749 statement boundaries. SvTEMP() is turned on which means that the SV's
4750 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
4751 and C<sv_mortalcopy>.
4753 SV* sv_2mortal(SV* sv)
4761 Return the num value of an SV, doing any necessary string or integer
4762 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
4773 Return a pointer to the byte-encoded representation of the SV, and set *lp
4774 to its length. May cause the SV to be downgraded from UTF-8 as a
4777 Usually accessed via the C<SvPVbyte> macro.
4779 char* sv_2pvbyte(SV* sv, STRLEN* lp)
4787 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
4788 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
4790 Usually accessed via the C<SvPVutf8> macro.
4792 char* sv_2pvutf8(SV* sv, STRLEN* lp)
4800 Returns a pointer to the string value of an SV, and sets *lp to its length.
4801 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
4803 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
4804 usually end up here too.
4806 char* sv_2pv_flags(SV* sv, STRLEN* lp, I32 flags)
4814 Return the unsigned integer value of an SV, doing any necessary string
4815 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
4816 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
4818 UV sv_2uv_flags(SV* sv, I32 flags)
4826 Remove any string offset. You should normally use the C<SvOOK_off> macro
4829 int sv_backoff(SV* sv)
4837 Blesses an SV into a specified package. The SV must be an RV. The package
4838 must be designated by its stash (see C<gv_stashpv()>). The reference count
4839 of the SV is unaffected.
4841 SV* sv_bless(SV* sv, HV* stash)
4849 Concatenates the string onto the end of the string which is in the SV.
4850 If the SV has the UTF-8 status set, then the bytes appended should be
4851 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4853 void sv_catpv(SV* sv, const char* ptr)
4861 Processes its arguments like C<sprintf> and appends the formatted
4862 output to an SV. If the appended data contains "wide" characters
4863 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
4864 and characters >255 formatted with %c), the original SV might get
4865 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
4866 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
4867 valid UTF-8; if the original SV was bytes, the pattern should be too.
4869 void sv_catpvf(SV* sv, const char* pat, ...)
4877 Like C<sv_catpvf>, but also handles 'set' magic.
4879 void sv_catpvf_mg(SV *sv, const char* pat, ...)
4887 Concatenates the string onto the end of the string which is in the SV. The
4888 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4889 status set, then the bytes appended should be valid UTF-8.
4890 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4892 void sv_catpvn(SV* sv, const char* ptr, STRLEN len)
4897 =item sv_catpvn_flags
4900 Concatenates the string onto the end of the string which is in the SV. The
4901 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4902 status set, then the bytes appended should be valid UTF-8.
4903 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4904 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4905 in terms of this function.
4907 void sv_catpvn_flags(SV* sv, const char* ptr, STRLEN len, I32 flags)
4915 Like C<sv_catpv>, but also handles 'set' magic.
4917 void sv_catpv_mg(SV *sv, const char *ptr)
4925 Concatenates the string from SV C<ssv> onto the end of the string in
4926 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4927 not 'set' magic. See C<sv_catsv_mg>.
4929 void sv_catsv(SV* dsv, SV* ssv)
4934 =item sv_catsv_flags
4937 Concatenates the string from SV C<ssv> onto the end of the string in
4938 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4939 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4940 and C<sv_catsv_nomg> are implemented in terms of this function.
4942 void sv_catsv_flags(SV* dsv, SV* ssv, I32 flags)
4950 Efficient removal of characters from the beginning of the string buffer.
4951 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4952 the string buffer. The C<ptr> becomes the first character of the adjusted
4953 string. Uses the "OOK hack".
4954 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4955 refer to the same chunk of data.
4957 void sv_chop(SV* sv, const char* ptr)
4965 Clear an SV: call any destructors, free up any memory used by the body,
4966 and free the body itself. The SV's head is I<not> freed, although
4967 its type is set to all 1's so that it won't inadvertently be assumed
4968 to be live during global destruction etc.
4969 This function should only be called when REFCNT is zero. Most of the time
4970 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
4973 void sv_clear(SV* sv)
4981 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
4982 string in C<sv1> is less than, equal to, or greater than the string in
4983 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
4984 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
4986 I32 sv_cmp(SV* sv1, SV* sv2)
4994 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
4995 'use bytes' aware, handles get magic, and will coerce its args to strings
4996 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
4998 I32 sv_cmp_locale(SV* sv1, SV* sv2)
5006 Add Collate Transform magic to an SV if it doesn't already have it.
5008 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
5009 scalar data of the variable, but transformed to such a format that a normal
5010 memory comparison can be used to compare the data according to the locale
5013 char* sv_collxfrm(SV* sv, STRLEN* nxp)
5021 Copies a stringified representation of the source SV into the
5022 destination SV. Automatically performs any necessary mg_get and
5023 coercion of numeric values into strings. Guaranteed to preserve
5024 UTF-8 flag even from overloaded objects. Similar in nature to
5025 sv_2pv[_flags] but operates directly on an SV instead of just the
5026 string. Mostly uses sv_2pv_flags to do its work, except when that
5027 would lose the UTF-8'ness of the PV.
5029 void sv_copypv(SV* dsv, SV* ssv)
5037 Auto-decrement of the value in the SV, doing string to numeric conversion
5038 if necessary. Handles 'get' magic.
5048 Returns a boolean indicating whether the strings in the two SVs are
5049 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5050 coerce its args to strings if necessary.
5052 I32 sv_eq(SV* sv1, SV* sv2)
5057 =item sv_force_normal_flags
5058 X<sv_force_normal_flags>
5060 Undo various types of fakery on an SV: if the PV is a shared string, make
5061 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
5062 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
5063 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
5064 then a copy-on-write scalar drops its PV buffer (if any) and becomes
5065 SvPOK_off rather than making a copy. (Used where this scalar is about to be
5066 set to some other value.) In addition, the C<flags> parameter gets passed to
5067 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
5068 with flags set to 0.
5070 void sv_force_normal_flags(SV *sv, U32 flags)
5078 Decrement an SV's reference count, and if it drops to zero, call
5079 C<sv_clear> to invoke destructors and free up any memory used by
5080 the body; finally, deallocate the SV's head itself.
5081 Normally called via a wrapper macro C<SvREFCNT_dec>.
5083 void sv_free(SV* sv)
5091 Get a line from the filehandle and store it into the SV, optionally
5092 appending to the currently-stored string.
5094 char* sv_gets(SV* sv, PerlIO* fp, I32 append)
5102 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
5103 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
5104 Use the C<SvGROW> wrapper instead.
5106 char* sv_grow(SV* sv, STRLEN newlen)
5114 Auto-increment of the value in the SV, doing string to numeric conversion
5115 if necessary. Handles 'get' magic.
5125 Inserts a string at the specified offset/length within the SV. Similar to
5126 the Perl substr() function.
5128 void sv_insert(SV* bigsv, STRLEN offset, STRLEN len, const char* little, STRLEN littlelen)
5136 Returns a boolean indicating whether the SV is blessed into the specified
5137 class. This does not check for subtypes; use C<sv_derived_from> to verify
5138 an inheritance relationship.
5140 int sv_isa(SV* sv, const char* name)
5148 Returns a boolean indicating whether the SV is an RV pointing to a blessed
5149 object. If the SV is not an RV, or if the object is not blessed, then this
5152 int sv_isobject(SV* sv)
5160 Returns the length of the string in the SV. Handles magic and type
5161 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5163 STRLEN sv_len(SV* sv)
5171 Returns the number of characters in the string in an SV, counting wide
5172 UTF-8 bytes as a single character. Handles magic and type coercion.
5174 STRLEN sv_len_utf8(SV* sv)
5182 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
5183 then adds a new magic item of type C<how> to the head of the magic list.
5185 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
5186 handling of the C<name> and C<namlen> arguments.
5188 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
5189 to add more than one instance of the same 'how'.
5191 void sv_magic(SV* sv, SV* obj, int how, const char* name, I32 namlen)
5199 Adds magic to an SV, upgrading it if necessary. Applies the
5200 supplied vtable and returns a pointer to the magic added.
5202 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
5203 In particular, you can add magic to SvREADONLY SVs, and add more than
5204 one instance of the same 'how'.
5206 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
5207 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
5208 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
5209 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
5211 (This is now used as a subroutine by C<sv_magic>.)
5213 MAGIC * sv_magicext(SV* sv, SV* obj, int how, MGVTBL *vtbl, const char* name, I32 namlen)
5221 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
5222 The new SV is marked as mortal. It will be destroyed "soon", either by an
5223 explicit call to FREETMPS, or by an implicit call at places such as
5224 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
5226 SV* sv_mortalcopy(SV* oldsv)
5234 Creates a new null SV which is mortal. The reference count of the SV is
5235 set to 1. It will be destroyed "soon", either by an explicit call to
5236 FREETMPS, or by an implicit call at places such as statement boundaries.
5237 See also C<sv_mortalcopy> and C<sv_2mortal>.
5247 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5250 SV* sv_newref(SV* sv)
5258 Converts the value pointed to by offsetp from a count of bytes from the
5259 start of the string, to a count of the equivalent number of UTF-8 chars.
5260 Handles magic and type coercion.
5262 void sv_pos_b2u(SV* sv, I32* offsetp)
5270 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5271 the start of the string, to a count of the equivalent number of bytes; if
5272 lenp is non-zero, it does the same to lenp, but this time starting from
5273 the offset, rather than from the start of the string. Handles magic and
5276 void sv_pos_u2b(SV* sv, I32* offsetp, I32* lenp)
5281 =item sv_pvbyten_force
5284 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
5286 char* sv_pvbyten_force(SV* sv, STRLEN* lp)
5294 Get a sensible string out of the SV somehow.
5295 A private implementation of the C<SvPV_force> macro for compilers which
5296 can't cope with complex macro expressions. Always use the macro instead.
5298 char* sv_pvn_force(SV* sv, STRLEN* lp)
5303 =item sv_pvn_force_flags
5304 X<sv_pvn_force_flags>
5306 Get a sensible string out of the SV somehow.
5307 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
5308 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
5309 implemented in terms of this function.
5310 You normally want to use the various wrapper macros instead: see
5311 C<SvPV_force> and C<SvPV_force_nomg>
5313 char* sv_pvn_force_flags(SV* sv, STRLEN* lp, I32 flags)
5318 =item sv_pvutf8n_force
5321 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
5323 char* sv_pvutf8n_force(SV* sv, STRLEN* lp)
5331 Returns a string describing what the SV is a reference to.
5333 char* sv_reftype(const SV* sv, int ob)
5341 Make the first argument a copy of the second, then delete the original.
5342 The target SV physically takes over ownership of the body of the source SV
5343 and inherits its flags; however, the target keeps any magic it owns,
5344 and any magic in the source is discarded.
5345 Note that this is a rather specialist SV copying operation; most of the
5346 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5348 void sv_replace(SV* sv, SV* nsv)
5356 Underlying implementation for the C<reset> Perl function.
5357 Note that the perl-level function is vaguely deprecated.
5359 void sv_reset(const char* s, HV* stash)
5367 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
5368 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
5369 push a back-reference to this RV onto the array of backreferences
5370 associated with that magic.
5372 SV* sv_rvweaken(SV *sv)
5380 Copies an integer into the given SV, upgrading first if necessary.
5381 Does not handle 'set' magic. See also C<sv_setiv_mg>.
5383 void sv_setiv(SV* sv, IV num)
5391 Like C<sv_setiv>, but also handles 'set' magic.
5393 void sv_setiv_mg(SV *sv, IV i)
5401 Copies a double into the given SV, upgrading first if necessary.
5402 Does not handle 'set' magic. See also C<sv_setnv_mg>.
5404 void sv_setnv(SV* sv, NV num)
5412 Like C<sv_setnv>, but also handles 'set' magic.
5414 void sv_setnv_mg(SV *sv, NV num)
5422 Copies a string into an SV. The string must be null-terminated. Does not
5423 handle 'set' magic. See C<sv_setpv_mg>.
5425 void sv_setpv(SV* sv, const char* ptr)
5433 Works like C<sv_catpvf> but copies the text into the SV instead of
5434 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
5436 void sv_setpvf(SV* sv, const char* pat, ...)
5444 Like C<sv_setpvf>, but also handles 'set' magic.
5446 void sv_setpvf_mg(SV *sv, const char* pat, ...)
5454 Copies an integer into the given SV, also updating its string value.
5455 Does not handle 'set' magic. See C<sv_setpviv_mg>.
5457 void sv_setpviv(SV* sv, IV num)
5465 Like C<sv_setpviv>, but also handles 'set' magic.
5467 void sv_setpviv_mg(SV *sv, IV iv)
5475 Copies a string into an SV. The C<len> parameter indicates the number of
5476 bytes to be copied. If the C<ptr> argument is NULL the SV will become
5477 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
5479 void sv_setpvn(SV* sv, const char* ptr, STRLEN len)
5487 Like C<sv_setpvn>, but also handles 'set' magic.
5489 void sv_setpvn_mg(SV *sv, const char *ptr, STRLEN len)
5497 Like C<sv_setpv>, but also handles 'set' magic.
5499 void sv_setpv_mg(SV *sv, const char *ptr)
5507 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
5508 argument will be upgraded to an RV. That RV will be modified to point to
5509 the new SV. The C<classname> argument indicates the package for the
5510 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
5511 will have a reference count of 1, and the RV will be returned.
5513 SV* sv_setref_iv(SV* rv, const char* classname, IV iv)
5521 Copies a double into a new SV, optionally blessing the SV. The C<rv>
5522 argument will be upgraded to an RV. That RV will be modified to point to
5523 the new SV. The C<classname> argument indicates the package for the
5524 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
5525 will have a reference count of 1, and the RV will be returned.
5527 SV* sv_setref_nv(SV* rv, const char* classname, NV nv)
5535 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
5536 argument will be upgraded to an RV. That RV will be modified to point to
5537 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
5538 into the SV. The C<classname> argument indicates the package for the
5539 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
5540 will have a reference count of 1, and the RV will be returned.
5542 Do not use with other Perl types such as HV, AV, SV, CV, because those
5543 objects will become corrupted by the pointer copy process.
5545 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
5547 SV* sv_setref_pv(SV* rv, const char* classname, void* pv)
5555 Copies a string into a new SV, optionally blessing the SV. The length of the
5556 string must be specified with C<n>. The C<rv> argument will be upgraded to
5557 an RV. That RV will be modified to point to the new SV. The C<classname>
5558 argument indicates the package for the blessing. Set C<classname> to
5559 C<NULL> to avoid the blessing. The new SV will have a reference count
5560 of 1, and the RV will be returned.
5562 Note that C<sv_setref_pv> copies the pointer while this copies the string.
5564 SV* sv_setref_pvn(SV* rv, const char* classname, const char* pv, STRLEN n)
5572 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
5573 argument will be upgraded to an RV. That RV will be modified to point to
5574 the new 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 SV* sv_setref_uv(SV* rv, const char* classname, UV uv)
5586 Copies the contents of the source SV C<ssv> into the destination SV
5587 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
5588 function if the source SV needs to be reused. Does not handle 'set' magic.
5589 Loosely speaking, it performs a copy-by-value, obliterating any previous
5590 content of the destination.
5592 You probably want to use one of the assortment of wrappers, such as
5593 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
5594 C<SvSetMagicSV_nosteal>.
5596 void sv_setsv(SV* dsv, SV* ssv)
5601 =item sv_setsv_flags
5604 Copies the contents of the source SV C<ssv> into the destination SV
5605 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
5606 function if the source SV needs to be reused. Does not handle 'set' magic.
5607 Loosely speaking, it performs a copy-by-value, obliterating any previous
5608 content of the destination.
5609 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
5610 C<ssv> if appropriate, else not. If the C<flags> parameter has the
5611 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
5612 and C<sv_setsv_nomg> are implemented in terms of this function.
5614 You probably want to use one of the assortment of wrappers, such as
5615 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
5616 C<SvSetMagicSV_nosteal>.
5618 This is the primary function for copying scalars, and most other
5619 copy-ish functions and macros use this underneath.
5621 void sv_setsv_flags(SV* dsv, SV* ssv, I32 flags)
5629 Like C<sv_setsv>, but also handles 'set' magic.
5631 void sv_setsv_mg(SV *dstr, SV *sstr)
5639 Copies an unsigned integer into the given SV, upgrading first if necessary.
5640 Does not handle 'set' magic. See also C<sv_setuv_mg>.
5642 void sv_setuv(SV* sv, UV num)
5650 Like C<sv_setuv>, but also handles 'set' magic.
5652 void sv_setuv_mg(SV *sv, UV u)
5660 Test an SV for taintedness. Use C<SvTAINTED> instead.
5661 bool sv_tainted(SV* sv)
5669 Returns true if the SV has a true value by Perl's rules.
5670 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
5671 instead use an in-line version.
5681 Removes all magic of type C<type> from an SV.
5683 int sv_unmagic(SV* sv, int type)
5688 =item sv_unref_flags
5691 Unsets the RV status of the SV, and decrements the reference count of
5692 whatever was being referenced by the RV. This can almost be thought of
5693 as a reversal of C<newSVrv>. The C<cflags> argument can contain
5694 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
5695 (otherwise the decrementing is conditional on the reference count being
5696 different from one or the reference being a readonly SV).
5699 void sv_unref_flags(SV* sv, U32 flags)
5707 Untaint an SV. Use C<SvTAINTED_off> instead.
5708 void sv_untaint(SV* sv)
5716 Upgrade an SV to a more complex form. Generally adds a new body type to the
5717 SV, then copies across as much information as possible from the old body.
5718 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
5720 void sv_upgrade(SV* sv, U32 mt)
5728 Tells an SV to use C<ptr> to find its string value. Normally the string is
5729 stored inside the SV but sv_usepvn allows the SV to use an outside string.
5730 The C<ptr> should point to memory that was allocated by C<malloc>. The
5731 string length, C<len>, must be supplied. This function will realloc the
5732 memory pointed to by C<ptr>, so that pointer should not be freed or used by
5733 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
5734 See C<sv_usepvn_mg>.
5736 void sv_usepvn(SV* sv, char* ptr, STRLEN len)
5744 Like C<sv_usepvn>, but also handles 'set' magic.
5746 void sv_usepvn_mg(SV *sv, char *ptr, STRLEN len)
5751 =item sv_utf8_decode
5754 If the PV of the SV is an octet sequence in UTF-8
5755 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
5756 so that it looks like a character. If the PV contains only single-byte
5757 characters, the C<SvUTF8> flag stays being off.
5758 Scans PV for validity and returns false if the PV is invalid UTF-8.
5760 NOTE: this function is experimental and may change or be
5761 removed without notice.
5763 bool sv_utf8_decode(SV *sv)
5768 =item sv_utf8_downgrade
5769 X<sv_utf8_downgrade>
5771 Attempts to convert the PV of an SV from characters to bytes.
5772 If the PV contains a character beyond byte, this conversion will fail;
5773 in this case, either returns false or, if C<fail_ok> is not
5776 This is not as a general purpose Unicode to byte encoding interface:
5777 use the Encode extension for that.
5779 NOTE: this function is experimental and may change or be
5780 removed without notice.
5782 bool sv_utf8_downgrade(SV *sv, bool fail_ok)
5787 =item sv_utf8_encode
5790 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
5791 flag off so that it looks like octets again.
5793 void sv_utf8_encode(SV *sv)
5798 =item sv_utf8_upgrade
5801 Converts the PV of an SV to its UTF-8-encoded form.
5802 Forces the SV to string form if it is not already.
5803 Always sets the SvUTF8 flag to avoid future validity checks even
5804 if all the bytes have hibit clear.
5806 This is not as a general purpose byte encoding to Unicode interface:
5807 use the Encode extension for that.
5809 STRLEN sv_utf8_upgrade(SV *sv)
5814 =item sv_utf8_upgrade_flags
5815 X<sv_utf8_upgrade_flags>
5817 Converts the PV of an SV to its UTF-8-encoded form.
5818 Forces the SV to string form if it is not already.
5819 Always sets the SvUTF8 flag to avoid future validity checks even
5820 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
5821 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
5822 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
5824 This is not as a general purpose byte encoding to Unicode interface:
5825 use the Encode extension for that.
5827 STRLEN sv_utf8_upgrade_flags(SV *sv, I32 flags)
5835 Processes its arguments like C<vsprintf> and appends the formatted output
5836 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
5838 Usually used via its frontend C<sv_catpvf>.
5840 void sv_vcatpvf(SV* sv, const char* pat, va_list* args)
5848 Processes its arguments like C<vsprintf> and appends the formatted output
5849 to an SV. Uses an array of SVs if the C style variable argument list is
5850 missing (NULL). When running with taint checks enabled, indicates via
5851 C<maybe_tainted> if results are untrustworthy (often due to the use of
5854 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
5856 void sv_vcatpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
5864 Like C<sv_vcatpvf>, but also handles 'set' magic.
5866 Usually used via its frontend C<sv_catpvf_mg>.
5868 void sv_vcatpvf_mg(SV* sv, const char* pat, va_list* args)
5876 Works like C<sv_vcatpvf> but copies the text into the SV instead of
5877 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
5879 Usually used via its frontend C<sv_setpvf>.
5881 void sv_vsetpvf(SV* sv, const char* pat, va_list* args)
5889 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
5892 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
5894 void sv_vsetpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
5902 Like C<sv_vsetpvf>, but also handles 'set' magic.
5904 Usually used via its frontend C<sv_setpvf_mg>.
5906 void sv_vsetpvf_mg(SV* sv, const char* pat, va_list* args)
5914 =head1 Unicode Support
5918 =item bytes_from_utf8
5921 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
5922 Unlike C<utf8_to_bytes> but like C<bytes_to_utf8>, returns a pointer to
5923 the newly-created string, and updates C<len> to contain the new
5924 length. Returns the original string if no conversion occurs, C<len>
5925 is unchanged. Do nothing if C<is_utf8> points to 0. Sets C<is_utf8> to
5926 0 if C<s> is converted or contains all 7bit characters.
5928 NOTE: this function is experimental and may change or be
5929 removed without notice.
5931 U8* bytes_from_utf8(const U8 *s, STRLEN *len, bool *is_utf8)
5934 Found in file utf8.c
5939 Converts a string C<s> of length C<len> from ASCII into UTF-8 encoding.
5940 Returns a pointer to the newly-created string, and sets C<len> to
5941 reflect the new length.
5943 If you want to convert to UTF-8 from other encodings than ASCII,
5944 see sv_recode_to_utf8().
5946 NOTE: this function is experimental and may change or be
5947 removed without notice.
5949 U8* bytes_to_utf8(const U8 *s, STRLEN *len)
5952 Found in file utf8.c
5957 Return true if the strings s1 and s2 differ case-insensitively, false
5958 if not (if they are equal case-insensitively). If u1 is true, the
5959 string s1 is assumed to be in UTF-8-encoded Unicode. If u2 is true,
5960 the string s2 is assumed to be in UTF-8-encoded Unicode. If u1 or u2
5961 are false, the respective string is assumed to be in native 8-bit
5964 If the pe1 and pe2 are non-NULL, the scanning pointers will be copied
5965 in there (they will point at the beginning of the I<next> character).
5966 If the pointers behind pe1 or pe2 are non-NULL, they are the end
5967 pointers beyond which scanning will not continue under any
5968 circumstances. If the byte lengths l1 and l2 are non-zero, s1+l1 and
5969 s2+l2 will be used as goal end pointers that will also stop the scan,
5970 and which qualify towards defining a successful match: all the scans
5971 that define an explicit length must reach their goal pointers for
5972 a match to succeed).
5974 For case-insensitiveness, the "casefolding" of Unicode is used
5975 instead of upper/lowercasing both the characters, see
5976 http://www.unicode.org/unicode/reports/tr21/ (Case Mappings).
5978 I32 ibcmp_utf8(const char* a, char **pe1, UV l1, bool u1, const char* b, char **pe2, UV l2, bool u2)
5981 Found in file utf8.c
5986 Tests if some arbitrary number of bytes begins in a valid UTF-8
5987 character. Note that an INVARIANT (i.e. ASCII) character is a valid
5988 UTF-8 character. The actual number of bytes in the UTF-8 character
5989 will be returned if it is valid, otherwise 0.
5991 STRLEN is_utf8_char(const U8 *p)
5994 Found in file utf8.c
5996 =item is_utf8_string
5999 Returns true if first C<len> bytes of the given string form a valid
6000 UTF-8 string, false otherwise. Note that 'a valid UTF-8 string' does
6001 not mean 'a string that contains code points above 0x7F encoded in UTF-8'
6002 because a valid ASCII string is a valid UTF-8 string.
6004 See also is_utf8_string_loclen() and is_utf8_string_loc().
6006 bool is_utf8_string(const U8 *s, STRLEN len)
6009 Found in file utf8.c
6011 =item is_utf8_string_loc
6012 X<is_utf8_string_loc>
6014 Like is_utf8_string() but stores the location of the failure (in the
6015 case of "utf8ness failure") or the location s+len (in the case of
6016 "utf8ness success") in the C<ep>.
6018 See also is_utf8_string_loclen() and is_utf8_string().
6020 bool is_utf8_string_loc(const U8 *s, STRLEN len, const U8 **p)
6023 Found in file utf8.c
6025 =item is_utf8_string_loclen
6026 X<is_utf8_string_loclen>
6028 Like is_utf8_string() but stores the location of the failure (in the
6029 case of "utf8ness failure") or the location s+len (in the case of
6030 "utf8ness success") in the C<ep>, and the number of UTF-8
6031 encoded characters in the C<el>.
6033 See also is_utf8_string_loc() and is_utf8_string().
6035 bool is_utf8_string_loclen(const U8 *s, STRLEN len, const U8 **ep, STRLEN *el)
6038 Found in file utf8.c
6040 =item pv_uni_display
6043 Build to the scalar dsv a displayable version of the string spv,
6044 length len, the displayable version being at most pvlim bytes long
6045 (if longer, the rest is truncated and "..." will be appended).
6047 The flags argument can have UNI_DISPLAY_ISPRINT set to display
6048 isPRINT()able characters as themselves, UNI_DISPLAY_BACKSLASH
6049 to display the \\[nrfta\\] as the backslashed versions (like '\n')
6050 (UNI_DISPLAY_BACKSLASH is preferred over UNI_DISPLAY_ISPRINT for \\).
6051 UNI_DISPLAY_QQ (and its alias UNI_DISPLAY_REGEX) have both
6052 UNI_DISPLAY_BACKSLASH and UNI_DISPLAY_ISPRINT turned on.
6054 The pointer to the PV of the dsv is returned.
6056 char* pv_uni_display(SV *dsv, const U8 *spv, STRLEN len, STRLEN pvlim, UV flags)
6059 Found in file utf8.c
6064 The encoding is assumed to be an Encode object, the PV of the ssv is
6065 assumed to be octets in that encoding and decoding the input starts
6066 from the position which (PV + *offset) pointed to. The dsv will be
6067 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
6068 when the string tstr appears in decoding output or the input ends on
6069 the PV of the ssv. The value which the offset points will be modified
6070 to the last input position on the ssv.
6072 Returns TRUE if the terminator was found, else returns FALSE.
6074 bool sv_cat_decode(SV* dsv, SV *encoding, SV *ssv, int *offset, char* tstr, int tlen)
6079 =item sv_recode_to_utf8
6080 X<sv_recode_to_utf8>
6082 The encoding is assumed to be an Encode object, on entry the PV
6083 of the sv is assumed to be octets in that encoding, and the sv
6084 will be converted into Unicode (and UTF-8).
6086 If the sv already is UTF-8 (or if it is not POK), or if the encoding
6087 is not a reference, nothing is done to the sv. If the encoding is not
6088 an C<Encode::XS> Encoding object, bad things will happen.
6089 (See F<lib/encoding.pm> and L<Encode>).
6091 The PV of the sv is returned.
6093 char* sv_recode_to_utf8(SV* sv, SV *encoding)
6098 =item sv_uni_display
6101 Build to the scalar dsv a displayable version of the scalar sv,
6102 the displayable version being at most pvlim bytes long
6103 (if longer, the rest is truncated and "..." will be appended).
6105 The flags argument is as in pv_uni_display().
6107 The pointer to the PV of the dsv is returned.
6109 char* sv_uni_display(SV *dsv, SV *ssv, STRLEN pvlim, UV flags)
6112 Found in file utf8.c
6117 The "p" contains the pointer to the UTF-8 string encoding
6118 the character that is being converted.
6120 The "ustrp" is a pointer to the character buffer to put the
6121 conversion result to. The "lenp" is a pointer to the length
6124 The "swashp" is a pointer to the swash to use.
6126 Both the special and normal mappings are stored lib/unicore/To/Foo.pl,
6127 and loaded by SWASHNEW, using lib/utf8_heavy.pl. The special (usually,
6128 but not always, a multicharacter mapping), is tried first.
6130 The "special" is a string like "utf8::ToSpecLower", which means the
6131 hash %utf8::ToSpecLower. The access to the hash is through
6132 Perl_to_utf8_case().
6134 The "normal" is a string like "ToLower" which means the swash
6137 UV to_utf8_case(const U8 *p, U8* ustrp, STRLEN *lenp, SV **swashp, const char *normal, const char *special)
6140 Found in file utf8.c
6145 Convert the UTF-8 encoded character at p to its foldcase version and
6146 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6147 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6148 foldcase version may be longer than the original character (up to
6151 The first character of the foldcased version is returned
6152 (but note, as explained above, that there may be more.)
6154 UV to_utf8_fold(const U8 *p, U8* ustrp, STRLEN *lenp)
6157 Found in file utf8.c
6162 Convert the UTF-8 encoded character at p to its lowercase version and
6163 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6164 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6165 lowercase version may be longer than the original character.
6167 The first character of the lowercased version is returned
6168 (but note, as explained above, that there may be more.)
6170 UV to_utf8_lower(const U8 *p, U8* ustrp, STRLEN *lenp)
6173 Found in file utf8.c
6178 Convert the UTF-8 encoded character at p to its titlecase version and
6179 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6180 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6181 titlecase version may be longer than the original character.
6183 The first character of the titlecased version is returned
6184 (but note, as explained above, that there may be more.)
6186 UV to_utf8_title(const U8 *p, U8* ustrp, STRLEN *lenp)
6189 Found in file utf8.c
6194 Convert the UTF-8 encoded character at p to its uppercase 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
6197 the uppercase version may be longer than the original character.
6199 The first character of the uppercased version is returned
6200 (but note, as explained above, that there may be more.)
6202 UV to_utf8_upper(const U8 *p, U8* ustrp, STRLEN *lenp)
6205 Found in file utf8.c
6207 =item utf8n_to_uvchr
6212 Returns the native character value of the first character in the string
6214 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6215 length, in bytes, of that character.
6217 Allows length and flags to be passed to low level routine.
6219 UV utf8n_to_uvchr(const U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags)
6222 Found in file utf8.c
6224 =item utf8n_to_uvuni
6227 Bottom level UTF-8 decode routine.
6228 Returns the unicode code point value of the first character in the string C<s>
6229 which is assumed to be in UTF-8 encoding and no longer than C<curlen>;
6230 C<retlen> will be set to the length, in bytes, of that character.
6232 If C<s> does not point to a well-formed UTF-8 character, the behaviour
6233 is dependent on the value of C<flags>: if it contains UTF8_CHECK_ONLY,
6234 it is assumed that the caller will raise a warning, and this function
6235 will silently just set C<retlen> to C<-1> and return zero. If the
6236 C<flags> does not contain UTF8_CHECK_ONLY, warnings about
6237 malformations will be given, C<retlen> will be set to the expected
6238 length of the UTF-8 character in bytes, and zero will be returned.
6240 The C<flags> can also contain various flags to allow deviations from
6241 the strict UTF-8 encoding (see F<utf8.h>).
6243 Most code should use utf8_to_uvchr() rather than call this directly.
6245 UV utf8n_to_uvuni(const U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags)
6248 Found in file utf8.c
6253 Returns the number of UTF-8 characters between the UTF-8 pointers C<a>
6256 WARNING: use only if you *know* that the pointers point inside the
6259 IV utf8_distance(const U8 *a, const U8 *b)
6262 Found in file utf8.c
6267 Return the UTF-8 pointer C<s> displaced by C<off> characters, either
6268 forward or backward.
6270 WARNING: do not use the following unless you *know* C<off> is within
6271 the UTF-8 data pointed to by C<s> *and* that on entry C<s> is aligned
6272 on the first byte of character or just after the last byte of a character.
6274 U8* utf8_hop(const U8 *s, I32 off)
6277 Found in file utf8.c
6282 Return the length of the UTF-8 char encoded string C<s> in characters.
6283 Stops at C<e> (inclusive). If C<e E<lt> s> or if the scan would end
6284 up past C<e>, croaks.
6286 STRLEN utf8_length(const U8* s, const U8 *e)
6289 Found in file utf8.c
6294 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
6295 Unlike C<bytes_to_utf8>, this over-writes the original string, and
6296 updates len to contain the new length.
6297 Returns zero on failure, setting C<len> to -1.
6299 NOTE: this function is experimental and may change or be
6300 removed without notice.
6302 U8* utf8_to_bytes(U8 *s, STRLEN *len)
6305 Found in file utf8.c
6310 Returns the native character value of the first character in the string C<s>
6311 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6312 length, in bytes, of that character.
6314 If C<s> does not point to a well-formed UTF-8 character, zero is
6315 returned and retlen is set, if possible, to -1.
6317 UV utf8_to_uvchr(const U8 *s, STRLEN *retlen)
6320 Found in file utf8.c
6325 Returns the Unicode code point of the first character in the string C<s>
6326 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6327 length, in bytes, of that character.
6329 This function should only be used when returned UV is considered
6330 an index into the Unicode semantic tables (e.g. swashes).
6332 If C<s> does not point to a well-formed UTF-8 character, zero is
6333 returned and retlen is set, if possible, to -1.
6335 UV utf8_to_uvuni(const U8 *s, STRLEN *retlen)
6338 Found in file utf8.c
6343 Adds the UTF-8 representation of the Native codepoint C<uv> to the end
6344 of the string C<d>; C<d> should be have at least C<UTF8_MAXBYTES+1> free
6345 bytes available. The return value is the pointer to the byte after the
6346 end of the new character. In other words,
6348 d = uvchr_to_utf8(d, uv);
6350 is the recommended wide native character-aware way of saying
6354 U8* uvchr_to_utf8(U8 *d, UV uv)
6357 Found in file utf8.c
6359 =item uvuni_to_utf8_flags
6360 X<uvuni_to_utf8_flags>
6362 Adds the UTF-8 representation of the Unicode codepoint C<uv> to the end
6363 of the string C<d>; C<d> should be have at least C<UTF8_MAXBYTES+1> free
6364 bytes available. The return value is the pointer to the byte after the
6365 end of the new character. In other words,
6367 d = uvuni_to_utf8_flags(d, uv, flags);
6371 d = uvuni_to_utf8(d, uv);
6373 (which is equivalent to)
6375 d = uvuni_to_utf8_flags(d, uv, 0);
6377 is the recommended Unicode-aware way of saying
6381 U8* uvuni_to_utf8_flags(U8 *d, UV uv, UV flags)
6384 Found in file utf8.c
6389 =head1 Variables created by C<xsubpp> and C<xsubpp> internal functions
6396 Variable which is setup by C<xsubpp> to indicate the stack base offset,
6397 used by the C<ST>, C<XSprePUSH> and C<XSRETURN> macros. The C<dMARK> macro
6398 must be called prior to setup the C<MARK> variable.
6403 Found in file XSUB.h
6408 Variable which is setup by C<xsubpp> to indicate the
6409 class name for a C++ XS constructor. This is always a C<char*>. See C<THIS>.
6414 Found in file XSUB.h
6419 Sets up the C<ax> variable.
6420 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
6425 Found in file XSUB.h
6430 Sets up the C<ax> variable and stack marker variable C<mark>.
6431 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
6436 Found in file XSUB.h
6441 Sets up the C<items> variable.
6442 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
6447 Found in file XSUB.h
6452 Sets up the C<padoff_du> variable for an XSUB that wishes to use
6458 Found in file XSUB.h
6463 Sets up stack and mark pointers for an XSUB, calling dSP and dMARK.
6464 Sets up the C<ax> and C<items> variables by calling C<dAX> and C<dITEMS>.
6465 This is usually handled automatically by C<xsubpp>.
6470 Found in file XSUB.h
6475 Sets up the C<ix> variable for an XSUB which has aliases. This is usually
6476 handled automatically by C<xsubpp>.
6481 Found in file XSUB.h
6486 Variable which is setup by C<xsubpp> to indicate the number of
6487 items on the stack. See L<perlxs/"Variable-length Parameter Lists">.
6492 Found in file XSUB.h
6497 Variable which is setup by C<xsubpp> to indicate which of an
6498 XSUB's aliases was used to invoke it. See L<perlxs/"The ALIAS: Keyword">.
6503 Found in file XSUB.h
6508 Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
6512 Found in file XSUB.h
6517 Variable which is setup by C<xsubpp> to hold the return value for an
6518 XSUB. This is always the proper type for the XSUB. See
6519 L<perlxs/"The RETVAL Variable">.
6524 Found in file XSUB.h
6529 Used to access elements on the XSUB's stack.
6534 Found in file XSUB.h
6539 Variable which is setup by C<xsubpp> to designate the object in a C++
6540 XSUB. This is always the proper type for the C++ object. See C<CLASS> and
6541 L<perlxs/"Using XS With C++">.
6546 Found in file XSUB.h
6551 The SV* corresponding to the $_ variable. Works even if there
6552 is a lexical $_ in scope.
6555 Found in file XSUB.h
6560 Macro to declare an XSUB and its C parameter list. This is handled by
6564 Found in file XSUB.h
6569 The version identifier for an XS module. This is usually
6570 handled automatically by C<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>.
6573 Found in file XSUB.h
6575 =item XS_VERSION_BOOTCHECK
6576 X<XS_VERSION_BOOTCHECK>
6578 Macro to verify that a PM module's $VERSION variable matches the XS
6579 module's C<XS_VERSION> variable. This is usually handled automatically by
6580 C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">.
6582 XS_VERSION_BOOTCHECK;
6585 Found in file XSUB.h
6590 =head1 Warning and Dieing
6597 This is the XSUB-writer's interface to Perl's C<die> function.
6598 Normally call this function the same way you call the C C<printf>
6599 function. Calling C<croak> returns control directly to Perl,
6600 sidestepping the normal C order of execution. See C<warn>.
6602 If you want to throw an exception object, assign the object to
6603 C<$@> and then pass C<NULL> to croak():
6605 errsv = get_sv("@", TRUE);
6606 sv_setsv(errsv, exception_object);
6609 void croak(const char* pat, ...)
6612 Found in file util.c
6617 This is the XSUB-writer's interface to Perl's C<warn> function. Call this
6618 function the same way you call the C C<printf> function. See C<croak>.
6620 void warn(const char* pat, ...)
6623 Found in file util.c
6630 Until May 1997, this document was maintained by Jeff Okamoto
6631 <okamoto@corp.hp.com>. It is now maintained as part of Perl itself.
6633 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
6634 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
6635 Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
6636 Stephen McCamant, and Gurusamy Sarathy.
6638 API Listing originally by Dean Roehrich <roehrich@cray.com>.
6640 Updated to be autogenerated from comments in the source by Benjamin Stuhl.
6644 perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
https://perl5.git.perl.org / perl5.git / blob