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
774 The engine implementing pack() Perl function. Note: parameters next_in_list and
775 flags are not used. This call should not be used; use packlist instead.
777 void pack_cat(SV *cat, const char *pat, const char *patend, SV **beglist, SV **endlist, SV ***next_in_list, U32 flags)
780 Found in file mathoms.c
782 =item sv_2pvbyte_nolen
785 Return a pointer to the byte-encoded representation of the SV.
786 May cause the SV to be downgraded from UTF-8 as a side-effect.
788 Usually accessed via the C<SvPVbyte_nolen> macro.
790 char* sv_2pvbyte_nolen(SV* sv)
793 Found in file mathoms.c
795 =item sv_2pvutf8_nolen
798 Return a pointer to the UTF-8-encoded representation of the SV.
799 May cause the SV to be upgraded to UTF-8 as a side-effect.
801 Usually accessed via the C<SvPVutf8_nolen> macro.
803 char* sv_2pvutf8_nolen(SV* sv)
806 Found in file mathoms.c
811 Like C<sv_2pv()>, but doesn't return the length too. You should usually
812 use the macro wrapper C<SvPV_nolen(sv)> instead.
813 char* sv_2pv_nolen(SV* sv)
816 Found in file mathoms.c
821 Like C<sv_catpvn>, but also handles 'set' magic.
823 void sv_catpvn_mg(SV *sv, const char *ptr, STRLEN len)
826 Found in file mathoms.c
831 Like C<sv_catsv>, but also handles 'set' magic.
833 void sv_catsv_mg(SV *dstr, SV *sstr)
836 Found in file mathoms.c
838 =item sv_force_normal
841 Undo various types of fakery on an SV: if the PV is a shared string, make
842 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
843 an xpvmg. See also C<sv_force_normal_flags>.
845 void sv_force_normal(SV *sv)
848 Found in file mathoms.c
853 A private implementation of the C<SvIVx> macro for compilers which can't
854 cope with complex macro expressions. Always use the macro instead.
859 Found in file mathoms.c
864 Dummy routine which "locks" an SV when there is no locking module present.
865 Exists to avoid test for a NULL function pointer and because it could
866 potentially warn under some level of strict-ness.
868 "Superseded" by sv_nosharing().
870 void sv_nolocking(SV *sv)
873 Found in file mathoms.c
878 Dummy routine which "unlocks" an SV when there is no locking module present.
879 Exists to avoid test for a NULL function pointer and because it could
880 potentially warn under some level of strict-ness.
882 "Superseded" by sv_nosharing().
884 void sv_nounlocking(SV *sv)
887 Found in file mathoms.c
892 A private implementation of the C<SvNVx> macro for compilers which can't
893 cope with complex macro expressions. Always use the macro instead.
898 Found in file mathoms.c
903 Use the C<SvPV_nolen> macro instead
908 Found in file mathoms.c
913 Use C<SvPVbyte_nolen> instead.
915 char* sv_pvbyte(SV *sv)
918 Found in file mathoms.c
923 A private implementation of the C<SvPVbyte> macro for compilers
924 which can't cope with complex macro expressions. Always use the macro
927 char* sv_pvbyten(SV *sv, STRLEN *len)
930 Found in file mathoms.c
935 A private implementation of the C<SvPV> macro for compilers which can't
936 cope with complex macro expressions. Always use the macro instead.
938 char* sv_pvn(SV *sv, STRLEN *len)
941 Found in file mathoms.c
946 Use the C<SvPVutf8_nolen> macro instead
948 char* sv_pvutf8(SV *sv)
951 Found in file mathoms.c
956 A private implementation of the C<SvPVutf8> macro for compilers
957 which can't cope with complex macro expressions. Always use the macro
960 char* sv_pvutf8n(SV *sv, STRLEN *len)
963 Found in file mathoms.c
968 Taint an SV. Use C<SvTAINTED_on> instead.
969 void sv_taint(SV* sv)
972 Found in file mathoms.c
977 Unsets the RV status of the SV, and decrements the reference count of
978 whatever was being referenced by the RV. This can almost be thought of
979 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
980 being zero. See C<SvROK_off>.
982 void sv_unref(SV* sv)
985 Found in file mathoms.c
990 Tells an SV to use C<ptr> to find its string value. Implemented by
991 calling C<sv_usepvn_flags> with C<flags> of 0, hence does not handle 'set'
992 magic. See C<sv_usepvn_flags>.
994 void sv_usepvn(SV* sv, char* ptr, STRLEN len)
997 Found in file mathoms.c
1002 Like C<sv_usepvn>, but also handles 'set' magic.
1004 void sv_usepvn_mg(SV *sv, char *ptr, STRLEN len)
1007 Found in file mathoms.c
1012 A private implementation of the C<SvUVx> macro for compilers which can't
1013 cope with complex macro expressions. Always use the macro instead.
1018 Found in file mathoms.c
1023 The engine implementing unpack() Perl function. Note: parameters strbeg, new_s
1024 and ocnt are not used. This call should not be used, use unpackstring instead.
1026 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)
1029 Found in file mathoms.c
1034 =head1 Functions in file pp_pack.c
1042 The engine implementing pack() Perl function.
1044 void packlist(SV *cat, const char *pat, const char *patend, SV **beglist, SV **endlist)
1047 Found in file pp_pack.c
1052 The engine implementing unpack() Perl function. C<unpackstring> puts the
1053 extracted list items on the stack and returns the number of elements.
1054 Issue C<PUTBACK> before and C<SPAGAIN> after the call to this function.
1056 I32 unpackstring(const char *pat, const char *patend, const char *s, const char *strend, U32 flags)
1059 Found in file pp_pack.c
1064 =head1 Global Variables
1071 C<PL_modglobal> is a general purpose, interpreter global HV for use by
1072 extensions that need to keep information on a per-interpreter basis.
1073 In a pinch, it can also be used as a symbol table for extensions
1074 to share data among each other. It is a good idea to use keys
1075 prefixed by the package name of the extension that owns the data.
1080 Found in file intrpvar.h
1085 A convenience variable which is typically used with C<SvPV> when one
1086 doesn't care about the length of the string. It is usually more efficient
1087 to either declare a local variable and use that instead or to use the
1088 C<SvPV_nolen> macro.
1093 Found in file thrdvar.h
1098 This is the C<false> SV. See C<PL_sv_yes>. Always refer to this as
1104 Found in file intrpvar.h
1109 This is the C<undef> SV. Always refer to this as C<&PL_sv_undef>.
1114 Found in file intrpvar.h
1119 This is the C<true> SV. See C<PL_sv_no>. Always refer to this as
1125 Found in file intrpvar.h
1137 Return the SV from the GV.
1147 If C<gv> is a typeglob whose subroutine entry is a constant sub eligible for
1148 inlining, or C<gv> is a placeholder reference that would be promoted to such
1149 a typeglob, then returns the value returned by the sub. Otherwise, returns
1152 SV* gv_const_sv(GV* gv)
1160 Returns the glob with the given C<name> and a defined subroutine or
1161 C<NULL>. The glob lives in the given C<stash>, or in the stashes
1162 accessible via @ISA and UNIVERSAL::.
1164 The argument C<level> should be either 0 or -1. If C<level==0>, as a
1165 side-effect creates a glob with the given C<name> in the given C<stash>
1166 which in the case of success contains an alias for the subroutine, and sets
1167 up caching info for this glob. Similarly for all the searched stashes.
1169 This function grants C<"SUPER"> token as a postfix of the stash name. The
1170 GV returned from C<gv_fetchmeth> may be a method cache entry, which is not
1171 visible to Perl code. So when calling C<call_sv>, you should not use
1172 the GV directly; instead, you should use the method's CV, which can be
1173 obtained from the GV with the C<GvCV> macro.
1175 GV* gv_fetchmeth(HV* stash, const char* name, STRLEN len, I32 level)
1180 =item gv_fetchmethod_autoload
1181 X<gv_fetchmethod_autoload>
1183 Returns the glob which contains the subroutine to call to invoke the method
1184 on the C<stash>. In fact in the presence of autoloading this may be the
1185 glob for "AUTOLOAD". In this case the corresponding variable $AUTOLOAD is
1188 The third parameter of C<gv_fetchmethod_autoload> determines whether
1189 AUTOLOAD lookup is performed if the given method is not present: non-zero
1190 means yes, look for AUTOLOAD; zero means no, don't look for AUTOLOAD.
1191 Calling C<gv_fetchmethod> is equivalent to calling C<gv_fetchmethod_autoload>
1192 with a non-zero C<autoload> parameter.
1194 These functions grant C<"SUPER"> token as a prefix of the method name. Note
1195 that if you want to keep the returned glob for a long time, you need to
1196 check for it being "AUTOLOAD", since at the later time the call may load a
1197 different subroutine due to $AUTOLOAD changing its value. Use the glob
1198 created via a side effect to do this.
1200 These functions have the same side-effects and as C<gv_fetchmeth> with
1201 C<level==0>. C<name> should be writable if contains C<':'> or C<'
1202 ''>. The warning against passing the GV returned by C<gv_fetchmeth> to
1203 C<call_sv> apply equally to these functions.
1205 GV* gv_fetchmethod_autoload(HV* stash, const char* name, I32 autoload)
1210 =item gv_fetchmeth_autoload
1211 X<gv_fetchmeth_autoload>
1213 Same as gv_fetchmeth(), but looks for autoloaded subroutines too.
1214 Returns a glob for the subroutine.
1216 For an autoloaded subroutine without a GV, will create a GV even
1217 if C<level < 0>. For an autoloaded subroutine without a stub, GvCV()
1218 of the result may be zero.
1220 GV* gv_fetchmeth_autoload(HV* stash, const char* name, STRLEN len, I32 level)
1228 Returns a pointer to the stash for a specified package. C<name> should
1229 be a valid UTF-8 string and must be null-terminated. If C<create> is set
1230 then the package will be created if it does not already exist. If C<create>
1231 is not set and the package does not exist then NULL is returned.
1233 HV* gv_stashpv(const char* name, I32 create)
1241 Returns a pointer to the stash for a specified package. C<name> should
1242 be a valid UTF-8 string. The C<namelen> parameter indicates the length of
1243 the C<name>, in bytes. If C<create> is set then the package will be
1244 created if it does not already exist. If C<create> is not set and the
1245 package does not exist then NULL is returned.
1247 HV* gv_stashpvn(const char* name, U32 namelen, I32 create)
1255 Returns a pointer to the stash for a specified package, which must be a
1256 valid UTF-8 string. See C<gv_stashpv>.
1258 HV* gv_stashsv(SV* sv, I32 create)
1281 Null character pointer.
1284 Found in file handy.h
1308 Found in file handy.h
1313 =head1 Hash Manipulation Functions
1320 Returns the HV of the specified Perl hash. If C<create> is set and the
1321 Perl variable does not exist then it will be created. If C<create> is not
1322 set and the variable does not exist then NULL is returned.
1324 NOTE: the perl_ form of this function is deprecated.
1326 HV* get_hv(const char* name, I32 create)
1329 Found in file perl.c
1334 This flag, used in the length slot of hash entries and magic structures,
1335 specifies the structure contains an C<SV*> pointer where a C<char*> pointer
1336 is to be expected. (For information only--not to be used).
1344 Returns the computed hash stored in the hash entry.
1354 Returns the actual pointer stored in the key slot of the hash entry. The
1355 pointer may be either C<char*> or C<SV*>, depending on the value of
1356 C<HeKLEN()>. Can be assigned to. The C<HePV()> or C<HeSVKEY()> macros are
1357 usually preferable for finding the value of a key.
1367 If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry
1368 holds an C<SV*> key. Otherwise, holds the actual length of the key. Can
1369 be assigned to. The C<HePV()> macro is usually preferable for finding key
1372 STRLEN HeKLEN(HE* he)
1380 Returns the key slot of the hash entry as a C<char*> value, doing any
1381 necessary dereferencing of possibly C<SV*> keys. The length of the string
1382 is placed in C<len> (this is a macro, so do I<not> use C<&len>). If you do
1383 not care about what the length of the key is, you may use the global
1384 variable C<PL_na>, though this is rather less efficient than using a local
1385 variable. Remember though, that hash keys in perl are free to contain
1386 embedded nulls, so using C<strlen()> or similar is not a good way to find
1387 the length of hash keys. This is very similar to the C<SvPV()> macro
1388 described elsewhere in this document.
1390 char* HePV(HE* he, STRLEN len)
1398 Returns the key as an C<SV*>, or C<NULL> if the hash entry does not
1399 contain an C<SV*> key.
1409 Returns the key as an C<SV*>. Will create and return a temporary mortal
1410 C<SV*> if the hash entry contains only a C<char*> key.
1412 SV* HeSVKEY_force(HE* he)
1420 Sets the key to a given C<SV*>, taking care to set the appropriate flags to
1421 indicate the presence of an C<SV*> key, and returns the same
1424 SV* HeSVKEY_set(HE* he, SV* sv)
1432 Returns the value slot (type C<SV*>) stored in the hash entry.
1442 Returns the package name of a stash, or NULL if C<stash> isn't a stash.
1443 See C<SvSTASH>, C<CvSTASH>.
1445 char* HvNAME(HV* stash)
1453 Check that a hash is in an internally consistent state.
1455 void hv_assert(HV* tb)
1463 Clears a hash, making it empty.
1465 void hv_clear(HV* tb)
1470 =item hv_clear_placeholders
1471 X<hv_clear_placeholders>
1473 Clears any placeholders from a hash. If a restricted hash has any of its keys
1474 marked as readonly and the key is subsequently deleted, the key is not actually
1475 deleted but is marked by assigning it a value of &PL_sv_placeholder. This tags
1476 it so it will be ignored by future operations such as iterating over the hash,
1477 but will still allow the hash to have a value reassigned to the key at some
1478 future point. This function clears any such placeholder keys from the hash.
1479 See Hash::Util::lock_keys() for an example of its use.
1481 void hv_clear_placeholders(HV* hb)
1489 Deletes a key/value pair in the hash. The value SV is removed from the
1490 hash and returned to the caller. The C<klen> is the length of the key.
1491 The C<flags> value will normally be zero; if set to G_DISCARD then NULL
1494 SV* hv_delete(HV* tb, const char* key, I32 klen, I32 flags)
1502 Deletes a key/value pair in the hash. The value SV is removed from the
1503 hash and returned to the caller. The C<flags> value will normally be zero;
1504 if set to G_DISCARD then NULL will be returned. C<hash> can be a valid
1505 precomputed hash value, or 0 to ask for it to be computed.
1507 SV* hv_delete_ent(HV* tb, SV* key, I32 flags, U32 hash)
1515 Returns a boolean indicating whether the specified hash key exists. The
1516 C<klen> is the length of the key.
1518 bool hv_exists(HV* tb, const char* key, I32 klen)
1526 Returns a boolean indicating whether the specified hash key exists. C<hash>
1527 can be a valid precomputed hash value, or 0 to ask for it to be
1530 bool hv_exists_ent(HV* tb, SV* key, U32 hash)
1538 Returns the SV which corresponds to the specified key in the hash. The
1539 C<klen> is the length of the key. If C<lval> is set then the fetch will be
1540 part of a store. Check that the return value is non-null before
1541 dereferencing it to an C<SV*>.
1543 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1544 information on how to use this function on tied hashes.
1546 SV** hv_fetch(HV* tb, const char* key, I32 klen, I32 lval)
1554 Returns the hash entry which corresponds to the specified key in the hash.
1555 C<hash> must be a valid precomputed hash number for the given C<key>, or 0
1556 if you want the function to compute it. IF C<lval> is set then the fetch
1557 will be part of a store. Make sure the return value is non-null before
1558 accessing it. The return value when C<tb> is a tied hash is a pointer to a
1559 static location, so be sure to make a copy of the structure if you need to
1562 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1563 information on how to use this function on tied hashes.
1565 HE* hv_fetch_ent(HV* tb, SV* key, I32 lval, U32 hash)
1573 Prepares a starting point to traverse a hash table. Returns the number of
1574 keys in the hash (i.e. the same as C<HvKEYS(tb)>). The return value is
1575 currently only meaningful for hashes without tie magic.
1577 NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
1578 hash buckets that happen to be in use. If you still need that esoteric
1579 value, you can get it through the macro C<HvFILL(tb)>.
1582 I32 hv_iterinit(HV* tb)
1590 Returns the key from the current position of the hash iterator. See
1593 char* hv_iterkey(HE* entry, I32* retlen)
1601 Returns the key as an C<SV*> from the current position of the hash
1602 iterator. The return value will always be a mortal copy of the key. Also
1605 SV* hv_iterkeysv(HE* entry)
1613 Returns entries from a hash iterator. See C<hv_iterinit>.
1615 You may call C<hv_delete> or C<hv_delete_ent> on the hash entry that the
1616 iterator currently points to, without losing your place or invalidating your
1617 iterator. Note that in this case the current entry is deleted from the hash
1618 with your iterator holding the last reference to it. Your iterator is flagged
1619 to free the entry on the next call to C<hv_iternext>, so you must not discard
1620 your iterator immediately else the entry will leak - call C<hv_iternext> to
1621 trigger the resource deallocation.
1623 HE* hv_iternext(HV* tb)
1631 Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
1634 SV* hv_iternextsv(HV* hv, char** key, I32* retlen)
1639 =item hv_iternext_flags
1640 X<hv_iternext_flags>
1642 Returns entries from a hash iterator. See C<hv_iterinit> and C<hv_iternext>.
1643 The C<flags> value will normally be zero; if HV_ITERNEXT_WANTPLACEHOLDERS is
1644 set the placeholders keys (for restricted hashes) will be returned in addition
1645 to normal keys. By default placeholders are automatically skipped over.
1646 Currently a placeholder is implemented with a value that is
1647 C<&Perl_sv_placeholder>. Note that the implementation of placeholders and
1648 restricted hashes may change, and the implementation currently is
1649 insufficiently abstracted for any change to be tidy.
1651 NOTE: this function is experimental and may change or be
1652 removed without notice.
1654 HE* hv_iternext_flags(HV* tb, I32 flags)
1662 Returns the value from the current position of the hash iterator. See
1665 SV* hv_iterval(HV* tb, HE* entry)
1673 Adds magic to a hash. See C<sv_magic>.
1675 void hv_magic(HV* hv, GV* gv, int how)
1683 Evaluates the hash in scalar context and returns the result. Handles magic when the hash is tied.
1685 SV* hv_scalar(HV* hv)
1693 Stores an SV in a hash. The hash key is specified as C<key> and C<klen> is
1694 the length of the key. The C<hash> parameter is the precomputed hash
1695 value; if it is zero then Perl will compute it. The return value will be
1696 NULL if the operation failed or if the value did not need to be actually
1697 stored within the hash (as in the case of tied hashes). Otherwise it can
1698 be dereferenced to get the original C<SV*>. Note that the caller is
1699 responsible for suitably incrementing the reference count of C<val> before
1700 the call, and decrementing it if the function returned NULL. Effectively
1701 a successful hv_store takes ownership of one reference to C<val>. This is
1702 usually what you want; a newly created SV has a reference count of one, so
1703 if all your code does is create SVs then store them in a hash, hv_store
1704 will own the only reference to the new SV, and your code doesn't need to do
1705 anything further to tidy up. hv_store is not implemented as a call to
1706 hv_store_ent, and does not create a temporary SV for the key, so if your
1707 key data is not already in SV form then use hv_store in preference to
1710 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1711 information on how to use this function on tied hashes.
1713 SV** hv_store(HV* tb, const char* key, I32 klen, SV* val, U32 hash)
1721 Stores C<val> in a hash. The hash key is specified as C<key>. The C<hash>
1722 parameter is the precomputed hash value; if it is zero then Perl will
1723 compute it. The return value is the new hash entry so created. It will be
1724 NULL if the operation failed or if the value did not need to be actually
1725 stored within the hash (as in the case of tied hashes). Otherwise the
1726 contents of the return value can be accessed using the C<He?> macros
1727 described here. Note that the caller is responsible for suitably
1728 incrementing the reference count of C<val> before the call, and
1729 decrementing it if the function returned NULL. Effectively a successful
1730 hv_store_ent takes ownership of one reference to C<val>. This is
1731 usually what you want; a newly created SV has a reference count of one, so
1732 if all your code does is create SVs then store them in a hash, hv_store
1733 will own the only reference to the new SV, and your code doesn't need to do
1734 anything further to tidy up. Note that hv_store_ent only reads the C<key>;
1735 unlike C<val> it does not take ownership of it, so maintaining the correct
1736 reference count on C<key> is entirely the caller's responsibility. hv_store
1737 is not implemented as a call to hv_store_ent, and does not create a temporary
1738 SV for the key, so if your key data is not already in SV form then use
1739 hv_store in preference to hv_store_ent.
1741 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1742 information on how to use this function on tied hashes.
1744 HE* hv_store_ent(HV* tb, SV* key, SV* val, U32 hash)
1754 void hv_undef(HV* tb)
1762 Creates a new HV. The reference count is set to 1.
1772 =head1 Magical Functions
1779 Clear something magical that the SV represents. See C<sv_magic>.
1781 int mg_clear(SV* sv)
1789 Copies the magic from one SV to another. See C<sv_magic>.
1791 int mg_copy(SV* sv, SV* nsv, const char* key, I32 klen)
1799 Finds the magic pointer for type matching the SV. See C<sv_magic>.
1801 MAGIC* mg_find(const SV* sv, int type)
1809 Free any magic storage used by the SV. See C<sv_magic>.
1819 Do magic after a value is retrieved from the SV. See C<sv_magic>.
1829 Report on the SV's length. See C<sv_magic>.
1831 U32 mg_length(SV* sv)
1839 Turns on the magical status of an SV. See C<sv_magic>.
1841 void mg_magical(SV* sv)
1849 Do magic after a value is assigned to the SV. See C<sv_magic>.
1859 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
1860 argument more than once.
1862 void SvGETMAGIC(SV* sv)
1870 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
1881 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
1882 argument more than once.
1884 void SvSETMAGIC(SV* sv)
1892 Like C<SvSetSV>, but does any set magic required afterwards.
1894 void SvSetMagicSV(SV* dsb, SV* ssv)
1899 =item SvSetMagicSV_nosteal
1900 X<SvSetMagicSV_nosteal>
1902 Like C<SvSetSV_nosteal>, but does any set magic required afterwards.
1904 void SvSetMagicSV_nosteal(SV* dsv, SV* ssv)
1912 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
1915 void SvSetSV(SV* dsb, SV* ssv)
1920 =item SvSetSV_nosteal
1923 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
1924 ssv. May evaluate arguments more than once.
1926 void SvSetSV_nosteal(SV* dsv, SV* ssv)
1934 Arranges for sv to be shared between threads if a suitable module
1937 void SvSHARE(SV* sv)
1945 Releases a mutual exclusion lock on sv if a suitable module
1948 void SvUNLOCK(SV* sv)
1956 =head1 Memory Management
1963 The XSUB-writer's interface to the C C<memcpy> function. The C<src> is the
1964 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1965 the type. May fail on overlapping copies. See also C<Move>.
1967 void Copy(void* src, void* dest, int nitems, type)
1970 Found in file handy.h
1975 Like C<Copy> but returns dest. Useful for encouraging compilers to tail-call
1978 void * CopyD(void* src, void* dest, int nitems, type)
1981 Found in file handy.h
1986 The XSUB-writer's interface to the C C<memmove> function. The C<src> is the
1987 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1988 the type. Can do overlapping moves. See also C<Copy>.
1990 void Move(void* src, void* dest, int nitems, type)
1993 Found in file handy.h
1998 Like C<Move> but returns dest. Useful for encouraging compilers to tail-call
2001 void * MoveD(void* src, void* dest, int nitems, type)
2004 Found in file handy.h
2009 The XSUB-writer's interface to the C C<malloc> function.
2011 In 5.9.3, Newx() and friends replace the older New() API, and drops
2012 the first parameter, I<x>, a debug aid which allowed callers to identify
2013 themselves. This aid has been superseded by a new build option,
2014 PERL_MEM_LOG (see L<perlhack/PERL_MEM_LOG>). The older API is still
2015 there for use in XS modules supporting older perls.
2017 void Newx(void* ptr, int nitems, type)
2020 Found in file handy.h
2025 The XSUB-writer's interface to the C C<malloc> function, with
2026 cast. See also C<Newx>.
2028 void Newxc(void* ptr, int nitems, type, cast)
2031 Found in file handy.h
2036 The XSUB-writer's interface to the C C<malloc> function. The allocated
2037 memory is zeroed with C<memzero>. See also C<Newx>.
2039 void Newxz(void* ptr, int nitems, type)
2042 Found in file handy.h
2047 PoisonWith(0xEF) for catching access to freed memory.
2049 void Poison(void* dest, int nitems, type)
2052 Found in file handy.h
2057 PoisonWith(0xAB) for catching access to allocated but uninitialized memory.
2059 void PoisonNew(void* dest, int nitems, type)
2062 Found in file handy.h
2067 Fill up memory with a byte pattern (a byte repeated over and over
2068 again) that hopefully catches attempts to access uninitialized memory.
2070 void PoisonWith(void* dest, int nitems, type, U8 byte)
2073 Found in file handy.h
2078 The XSUB-writer's interface to the C C<realloc> function.
2080 void Renew(void* ptr, int nitems, type)
2083 Found in file handy.h
2088 The XSUB-writer's interface to the C C<realloc> function, with
2091 void Renewc(void* ptr, int nitems, type, cast)
2094 Found in file handy.h
2099 The XSUB-writer's interface to the C C<free> function.
2101 void Safefree(void* ptr)
2104 Found in file handy.h
2109 Perl's version of C<strdup()>. Returns a pointer to a newly allocated
2110 string which is a duplicate of C<pv>. The size of the string is
2111 determined by C<strlen()>. The memory allocated for the new string can
2112 be freed with the C<Safefree()> function.
2114 char* savepv(const char* pv)
2117 Found in file util.c
2122 Perl's version of what C<strndup()> would be if it existed. Returns a
2123 pointer to a newly allocated string which is a duplicate of the first
2124 C<len> bytes from C<pv>, plus a trailing NUL byte. The memory allocated for
2125 the new string can be freed with the C<Safefree()> function.
2127 char* savepvn(const char* pv, I32 len)
2130 Found in file util.c
2135 A version of C<savepv()> which allocates the duplicate string in memory
2136 which is shared between threads.
2138 char* savesharedpv(const char* pv)
2141 Found in file util.c
2146 A version of C<savepv()>/C<savepvn()> which gets the string to duplicate from
2147 the passed in SV using C<SvPV()>
2149 char* savesvpv(SV* sv)
2152 Found in file util.c
2157 This is an architecture-independent macro to copy one structure to another.
2159 void StructCopy(type src, type dest, type)
2162 Found in file handy.h
2167 The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the
2168 destination, C<nitems> is the number of items, and C<type> is the type.
2170 void Zero(void* dest, int nitems, type)
2173 Found in file handy.h
2178 Like C<Zero> but returns dest. Useful for encouraging compilers to tail-call
2181 void * ZeroD(void* dest, int nitems, type)
2184 Found in file handy.h
2189 =head1 Miscellaneous Functions
2196 Analyses the string in order to make fast searches on it using fbm_instr()
2197 -- the Boyer-Moore algorithm.
2199 void fbm_compile(SV* sv, U32 flags)
2202 Found in file util.c
2207 Returns the location of the SV in the string delimited by C<str> and
2208 C<strend>. It returns C<NULL> if the string can't be found. The C<sv>
2209 does not have to be fbm_compiled, but the search will not be as fast
2212 char* fbm_instr(unsigned char* big, unsigned char* bigend, SV* littlesv, U32 flags)
2215 Found in file util.c
2220 Takes a sprintf-style format pattern and conventional
2221 (non-SV) arguments and returns the formatted string.
2223 (char *) Perl_form(pTHX_ const char* pat, ...)
2225 can be used any place a string (char *) is required:
2227 char * s = Perl_form("%d.%d",major,minor);
2229 Uses a single private buffer so if you want to format several strings you
2230 must explicitly copy the earlier strings away (and free the copies when you
2233 char* form(const char* pat, ...)
2236 Found in file util.c
2241 Fill the sv with current working directory
2243 int getcwd_sv(SV* sv)
2246 Found in file util.c
2251 The C library C<snprintf> functionality, if available and
2252 standards-compliant (uses C<vsnprintf>, actually). If the
2253 C<vsnprintf> is not available, will unfortunately use the unsafe
2254 C<vsprintf>. Consider using C<sv_vcatpvf> instead.
2256 int my_snprintf(char *buffer, const Size_t len, const char *format, ...)
2259 Found in file util.c
2264 The C library C<sprintf>, wrapped if necessary, to ensure that it will return
2265 the length of the string written to the buffer. Only rare pre-ANSI systems
2266 need the wrapper function - usually this is a direct call to C<sprintf>.
2268 int my_sprintf(char *buffer, const char *pat, ...)
2271 Found in file util.c
2276 The C library C<vsnprintf> if available and standards-compliant,
2277 but if the C<vsnprintf> is not available, will unfortunately use
2278 the unsafe C<vsprintf>. Consider using C<sv_vcatpvf> instead.
2280 int my_vsnprintf(char *buffer, const Size_t len, const char *format, va_list ap)
2283 Found in file util.c
2288 Returns a new version object based on the passed in SV:
2290 SV *sv = new_version(SV *ver);
2292 Does not alter the passed in ver SV. See "upg_version" if you
2293 want to upgrade the SV.
2295 SV* new_version(SV *ver)
2298 Found in file util.c
2303 Returns a pointer to the next character after the parsed
2304 version string, as well as upgrading the passed in SV to
2307 Function must be called with an already existing SV like
2310 s = scan_version(s,SV *sv, bool qv);
2312 Performs some preprocessing to the string to ensure that
2313 it has the correct characteristics of a version. Flags the
2314 object if it contains an underscore (which denotes this
2315 is a alpha version). The boolean qv denotes that the version
2316 should be interpreted as if it had multiple decimals, even if
2319 const char* scan_version(const char *vstr, SV *sv, bool qv)
2322 Found in file util.c
2327 Test two strings to see if they are equal. Returns true or false.
2329 bool strEQ(char* s1, char* s2)
2332 Found in file handy.h
2337 Test two strings to see if the first, C<s1>, is greater than or equal to
2338 the second, C<s2>. Returns true or false.
2340 bool strGE(char* s1, char* s2)
2343 Found in file handy.h
2348 Test two strings to see if the first, C<s1>, is greater than the second,
2349 C<s2>. Returns true or false.
2351 bool strGT(char* s1, char* s2)
2354 Found in file handy.h
2359 Test two strings to see if the first, C<s1>, is less than or equal to the
2360 second, C<s2>. Returns true or false.
2362 bool strLE(char* s1, char* s2)
2365 Found in file handy.h
2370 Test two strings to see if the first, C<s1>, is less than the second,
2371 C<s2>. Returns true or false.
2373 bool strLT(char* s1, char* s2)
2376 Found in file handy.h
2381 Test two strings to see if they are different. Returns true or
2384 bool strNE(char* s1, char* s2)
2387 Found in file handy.h
2392 Test two strings to see if they are equal. The C<len> parameter indicates
2393 the number of bytes to compare. Returns true or false. (A wrapper for
2396 bool strnEQ(char* s1, char* s2, STRLEN len)
2399 Found in file handy.h
2404 Test two strings to see if they are different. The C<len> parameter
2405 indicates the number of bytes to compare. Returns true or false. (A
2406 wrapper for C<strncmp>).
2408 bool strnNE(char* s1, char* s2, STRLEN len)
2411 Found in file handy.h
2416 Dummy routine which "shares" an SV when there is no sharing module present.
2417 Or "locks" it. Or "unlocks" it. In other words, ignores its single SV argument.
2418 Exists to avoid test for a NULL function pointer and because it could
2419 potentially warn under some level of strict-ness.
2421 void sv_nosharing(SV *sv)
2424 Found in file util.c
2429 In-place upgrade of the supplied SV to a version object.
2431 SV *sv = upg_version(SV *sv);
2433 Returns a pointer to the upgraded SV.
2435 SV* upg_version(SV *ver)
2438 Found in file util.c
2443 Version object aware cmp. Both operands must already have been
2444 converted into version objects.
2446 int vcmp(SV *lvs, SV *rvs)
2449 Found in file util.c
2454 Accepts a version object and returns the normalized string
2455 representation. Call like:
2459 NOTE: you can pass either the object directly or the SV
2460 contained within the RV.
2465 Found in file util.c
2470 Accepts a version object and returns the normalized floating
2471 point representation. Call like:
2475 NOTE: you can pass either the object directly or the SV
2476 contained within the RV.
2481 Found in file util.c
2486 In order to maintain maximum compatibility with earlier versions
2487 of Perl, this function will return either the floating point
2488 notation or the multiple dotted notation, depending on whether
2489 the original version contained 1 or more dots, respectively
2491 SV* vstringify(SV *vs)
2494 Found in file util.c
2499 Validates that the SV contains a valid version object.
2501 bool vverify(SV *vobj);
2503 Note that it only confirms the bare minimum structure (so as not to get
2504 confused by derived classes which may contain additional hash entries):
2506 bool vverify(SV *vs)
2509 Found in file util.c
2514 =head1 Multicall Functions
2521 Declare local variables for a multicall. See L<perlcall/Lightweight Callbacks>.
2531 Make a lightweight callback. See L<perlcall/Lightweight Callbacks>.
2541 Closing bracket for a lightweight callback.
2542 See L<perlcall/Lightweight Callbacks>.
2549 =item PUSH_MULTICALL
2552 Opening bracket for a lightweight callback.
2553 See L<perlcall/Lightweight Callbacks>.
2563 =head1 Numeric functions
2570 converts a string representing a binary number to numeric form.
2572 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2573 conversion flags, and I<result> should be NULL or a pointer to an NV.
2574 The scan stops at the end of the string, or the first invalid character.
2575 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2576 invalid character will also trigger a warning.
2577 On return I<*len> is set to the length of the scanned string,
2578 and I<*flags> gives output flags.
2580 If the value is <= C<UV_MAX> it is returned as a UV, the output flags are clear,
2581 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_bin>
2582 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2583 and writes the value to I<*result> (or the value is discarded if I<result>
2586 The binary number may optionally be prefixed with "0b" or "b" unless
2587 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
2588 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the binary
2589 number may use '_' characters to separate digits.
2591 UV grok_bin(const char* start, STRLEN* len_p, I32* flags, NV *result)
2594 Found in file numeric.c
2599 converts a string representing a hex number to numeric form.
2601 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2602 conversion flags, and I<result> should be NULL or a pointer to an NV.
2603 The scan stops at the end of the string, or the first invalid character.
2604 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2605 invalid character will also trigger a warning.
2606 On return I<*len> is set to the length of the scanned string,
2607 and I<*flags> gives output flags.
2609 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2610 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_hex>
2611 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2612 and writes the value to I<*result> (or the value is discarded if I<result>
2615 The hex number may optionally be prefixed with "0x" or "x" unless
2616 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
2617 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the hex
2618 number may use '_' characters to separate digits.
2620 UV grok_hex(const char* start, STRLEN* len_p, I32* flags, NV *result)
2623 Found in file numeric.c
2628 Recognise (or not) a number. The type of the number is returned
2629 (0 if unrecognised), otherwise it is a bit-ORed combination of
2630 IS_NUMBER_IN_UV, IS_NUMBER_GREATER_THAN_UV_MAX, IS_NUMBER_NOT_INT,
2631 IS_NUMBER_NEG, IS_NUMBER_INFINITY, IS_NUMBER_NAN (defined in perl.h).
2633 If the value of the number can fit an in UV, it is returned in the *valuep
2634 IS_NUMBER_IN_UV will be set to indicate that *valuep is valid, IS_NUMBER_IN_UV
2635 will never be set unless *valuep is valid, but *valuep may have been assigned
2636 to during processing even though IS_NUMBER_IN_UV is not set on return.
2637 If valuep is NULL, IS_NUMBER_IN_UV will be set for the same cases as when
2638 valuep is non-NULL, but no actual assignment (or SEGV) will occur.
2640 IS_NUMBER_NOT_INT will be set with IS_NUMBER_IN_UV if trailing decimals were
2641 seen (in which case *valuep gives the true value truncated to an integer), and
2642 IS_NUMBER_NEG if the number is negative (in which case *valuep holds the
2643 absolute value). IS_NUMBER_IN_UV is not set if e notation was used or the
2644 number is larger than a UV.
2646 int grok_number(const char *pv, STRLEN len, UV *valuep)
2649 Found in file numeric.c
2651 =item grok_numeric_radix
2652 X<grok_numeric_radix>
2654 Scan and skip for a numeric decimal separator (radix).
2656 bool grok_numeric_radix(const char **sp, const char *send)
2659 Found in file numeric.c
2664 converts a string representing an octal number to numeric form.
2666 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2667 conversion flags, and I<result> should be NULL or a pointer to an NV.
2668 The scan stops at the end of the string, or the first invalid character.
2669 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2670 invalid character will also trigger a warning.
2671 On return I<*len> is set to the length of the scanned string,
2672 and I<*flags> gives output flags.
2674 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2675 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_oct>
2676 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2677 and writes the value to I<*result> (or the value is discarded if I<result>
2680 If C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the octal
2681 number may use '_' characters to separate digits.
2683 UV grok_oct(const char* start, STRLEN* len_p, I32* flags, NV *result)
2686 Found in file numeric.c
2691 For backwards compatibility. Use C<grok_bin> instead.
2693 NV scan_bin(const char* start, STRLEN len, STRLEN* retlen)
2696 Found in file numeric.c
2701 For backwards compatibility. Use C<grok_hex> instead.
2703 NV scan_hex(const char* start, STRLEN len, STRLEN* retlen)
2706 Found in file numeric.c
2711 For backwards compatibility. Use C<grok_oct> instead.
2713 NV scan_oct(const char* start, STRLEN len, STRLEN* retlen)
2716 Found in file numeric.c
2721 =head1 Optree Manipulation Functions
2728 If C<cv> is a constant sub eligible for inlining. returns the constant
2729 value returned by the sub. Otherwise, returns NULL.
2731 Constant subs can be created with C<newCONSTSUB> or as described in
2732 L<perlsub/"Constant Functions">.
2734 SV* cv_const_sv(CV* cv)
2742 Creates a constant sub equivalent to Perl C<sub FOO () { 123 }> which is
2743 eligible for inlining at compile-time.
2745 CV* newCONSTSUB(HV* stash, const char* name, SV* sv)
2753 Used by C<xsubpp> to hook up XSUBs as Perl subs. I<filename> needs to be
2754 static storage, as it is used directly as CvFILE(), without a copy being made.
2762 =head1 Pad Data Structures
2769 Get the value at offset po in the current pad.
2770 Use macro PAD_SV instead of calling this function directly.
2772 SV* pad_sv(PADOFFSET po)
2780 =head1 Simple Exception Handling Macros
2787 Set up necessary local variables for exception handling.
2788 See L<perlguts/"Exception Handling">.
2793 Found in file XSUB.h
2798 Introduces a catch block. See L<perlguts/"Exception Handling">.
2801 Found in file XSUB.h
2806 Rethrows a previously caught exception. See L<perlguts/"Exception Handling">.
2811 Found in file XSUB.h
2816 Ends a try block. See L<perlguts/"Exception Handling">.
2819 Found in file XSUB.h
2821 =item XCPT_TRY_START
2824 Starts a try block. See L<perlguts/"Exception Handling">.
2827 Found in file XSUB.h
2832 =head1 Stack Manipulation Macros
2839 Declare a stack marker variable, C<mark>, for the XSUB. See C<MARK> and
2850 Saves the original stack mark for the XSUB. See C<ORIGMARK>.
2860 Declares a local copy of perl's stack pointer for the XSUB, available via
2861 the C<SP> macro. See C<SP>.
2871 Used to extend the argument stack for an XSUB's return values. Once
2872 used, guarantees that there is room for at least C<nitems> to be pushed
2875 void EXTEND(SP, int nitems)
2883 Stack marker variable for the XSUB. See C<dMARK>.
2891 Push an integer onto the stack. The stack must have room for this element.
2892 Handles 'set' magic. Does not use C<TARG>. See also C<PUSHi>, C<mXPUSHi>
2903 Push a double onto the stack. The stack must have room for this element.
2904 Handles 'set' magic. Does not use C<TARG>. See also C<PUSHn>, C<mXPUSHn>
2915 Push a string onto the stack. The stack must have room for this element.
2916 The C<len> indicates the length of the string. Handles 'set' magic. Does
2917 not use C<TARG>. See also C<PUSHp>, C<mXPUSHp> and C<XPUSHp>.
2919 void mPUSHp(char* str, STRLEN len)
2927 Push an unsigned integer onto the stack. The stack must have room for this
2928 element. Handles 'set' magic. Does not use C<TARG>. See also C<PUSHu>,
2929 C<mXPUSHu> and C<XPUSHu>.
2939 Push an integer onto the stack, extending the stack if necessary. Handles
2940 'set' magic. Does not use C<TARG>. See also C<XPUSHi>, C<mPUSHi> and
2951 Push a double onto the stack, extending the stack if necessary. Handles
2952 'set' magic. Does not use C<TARG>. See also C<XPUSHn>, C<mPUSHn> and
2963 Push a string onto the stack, extending the stack if necessary. The C<len>
2964 indicates the length of the string. Handles 'set' magic. Does not use
2965 C<TARG>. See also C<XPUSHp>, C<mPUSHp> and C<PUSHp>.
2967 void mXPUSHp(char* str, STRLEN len)
2975 Push an unsigned integer onto the stack, extending the stack if necessary.
2976 Handles 'set' magic. Does not use C<TARG>. See also C<XPUSHu>, C<mPUSHu>
2987 The original stack mark for the XSUB. See C<dORIGMARK>.
2995 Pops an integer off the stack.
3005 Pops a long off the stack.
3015 Pops a double off the stack.
3025 Pops a string off the stack. Deprecated. New code should use POPpx.
3035 Pops a string off the stack which must consist of bytes i.e. characters < 256.
3045 Pops a string off the stack.
3055 Pops an SV off the stack.
3065 Push an integer onto the stack. The stack must have room for this element.
3066 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3067 called to declare it. Do not call multiple C<TARG>-oriented macros to
3068 return lists from XSUB's - see C<mPUSHi> instead. See also C<XPUSHi> and
3079 Opening bracket for arguments on a callback. See C<PUTBACK> and
3090 Push a new mortal SV onto the stack. The stack must have room for this
3091 element. Does not handle 'set' magic. Does not use C<TARG>. See also
3092 C<PUSHs>, C<XPUSHmortal> and C<XPUSHs>.
3102 Push a double onto the stack. The stack must have room for this element.
3103 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3104 called to declare it. Do not call multiple C<TARG>-oriented macros to
3105 return lists from XSUB's - see C<mPUSHn> instead. See also C<XPUSHn> and
3116 Push a string onto the stack. The stack must have room for this element.
3117 The C<len> indicates the length of the string. Handles 'set' magic. Uses
3118 C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to declare it. Do not
3119 call multiple C<TARG>-oriented macros to return lists from XSUB's - see
3120 C<mPUSHp> instead. See also C<XPUSHp> and C<mXPUSHp>.
3122 void PUSHp(char* str, STRLEN len)
3130 Push an SV onto the stack. The stack must have room for this element.
3131 Does not handle 'set' magic. Does not use C<TARG>. See also C<PUSHmortal>,
3132 C<XPUSHs> and C<XPUSHmortal>.
3142 Push an unsigned integer onto the stack. The stack must have room for this
3143 element. Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG>
3144 should be called to declare it. Do not call multiple C<TARG>-oriented
3145 macros to return lists from XSUB's - see C<mPUSHu> instead. See also
3146 C<XPUSHu> and C<mXPUSHu>.
3156 Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
3157 See C<PUSHMARK> and L<perlcall> for other uses.
3167 Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and
3176 Refetch the stack pointer. Used after a callback. See L<perlcall>.
3186 Push an integer onto the stack, extending the stack if necessary. Handles
3187 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
3188 declare it. Do not call multiple C<TARG>-oriented macros to return lists
3189 from XSUB's - see C<mXPUSHi> instead. See also C<PUSHi> and C<mPUSHi>.
3199 Push a new mortal SV onto the stack, extending the stack if necessary. Does
3200 not handle 'set' magic. Does not use C<TARG>. See also C<XPUSHs>,
3201 C<PUSHmortal> and C<PUSHs>.
3211 Push a double onto the stack, extending the stack if necessary. Handles
3212 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
3213 declare it. Do not call multiple C<TARG>-oriented macros to return lists
3214 from XSUB's - see C<mXPUSHn> instead. See also C<PUSHn> and C<mPUSHn>.
3224 Push a string onto the stack, extending the stack if necessary. The C<len>
3225 indicates the length of the string. Handles 'set' magic. Uses C<TARG>, so
3226 C<dTARGET> or C<dXSTARG> should be called to declare it. Do not call
3227 multiple C<TARG>-oriented macros to return lists from XSUB's - see
3228 C<mXPUSHp> instead. See also C<PUSHp> and C<mPUSHp>.
3230 void XPUSHp(char* str, STRLEN len)
3238 Push an SV onto the stack, extending the stack if necessary. Does not
3239 handle 'set' magic. Does not use C<TARG>. See also C<XPUSHmortal>,
3240 C<PUSHs> and C<PUSHmortal>.
3250 Push an unsigned integer onto the stack, extending the stack if necessary.
3251 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3252 called to declare it. Do not call multiple C<TARG>-oriented macros to
3253 return lists from XSUB's - see C<mXPUSHu> instead. See also C<PUSHu> and
3264 Return from XSUB, indicating number of items on the stack. This is usually
3265 handled by C<xsubpp>.
3267 void XSRETURN(int nitems)
3270 Found in file XSUB.h
3272 =item XSRETURN_EMPTY
3275 Return an empty list from an XSUB immediately.
3280 Found in file XSUB.h
3285 Return an integer from an XSUB immediately. Uses C<XST_mIV>.
3287 void XSRETURN_IV(IV iv)
3290 Found in file XSUB.h
3295 Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
3300 Found in file XSUB.h
3305 Return a double from an XSUB immediately. Uses C<XST_mNV>.
3307 void XSRETURN_NV(NV nv)
3310 Found in file XSUB.h
3315 Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
3317 void XSRETURN_PV(char* str)
3320 Found in file XSUB.h
3322 =item XSRETURN_UNDEF
3325 Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
3330 Found in file XSUB.h
3335 Return an integer from an XSUB immediately. Uses C<XST_mUV>.
3337 void XSRETURN_UV(IV uv)
3340 Found in file XSUB.h
3345 Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
3350 Found in file XSUB.h
3355 Place an integer into the specified position C<pos> on the stack. The
3356 value is stored in a new mortal SV.
3358 void XST_mIV(int pos, IV iv)
3361 Found in file XSUB.h
3366 Place C<&PL_sv_no> into the specified position C<pos> on the
3369 void XST_mNO(int pos)
3372 Found in file XSUB.h
3377 Place a double into the specified position C<pos> on the stack. The value
3378 is stored in a new mortal SV.
3380 void XST_mNV(int pos, NV nv)
3383 Found in file XSUB.h
3388 Place a copy of a string into the specified position C<pos> on the stack.
3389 The value is stored in a new mortal SV.
3391 void XST_mPV(int pos, char* str)
3394 Found in file XSUB.h
3399 Place C<&PL_sv_undef> into the specified position C<pos> on the
3402 void XST_mUNDEF(int pos)
3405 Found in file XSUB.h
3410 Place C<&PL_sv_yes> into the specified position C<pos> on the
3413 void XST_mYES(int pos)
3416 Found in file XSUB.h
3428 An enum of flags for Perl types. These are found in the file B<sv.h>
3429 in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
3437 Integer type flag for scalars. See C<svtype>.
3445 Double type flag for scalars. See C<svtype>.
3453 Pointer type flag for scalars. See C<svtype>.
3461 Type flag for arrays. See C<svtype>.
3469 Type flag for code refs. See C<svtype>.
3477 Type flag for hashes. See C<svtype>.
3485 Type flag for blessed scalars. See C<svtype>.
3493 =head1 SV Manipulation Functions
3500 Returns the SV of the specified Perl scalar. If C<create> is set and the
3501 Perl variable does not exist then it will be created. If C<create> is not
3502 set and the variable does not exist then NULL is returned.
3504 NOTE: the perl_ form of this function is deprecated.
3506 SV* get_sv(const char* name, I32 create)
3509 Found in file perl.c
3514 Creates an RV wrapper for an SV. The reference count for the original SV is
3517 SV* newRV_inc(SV* sv)
3525 Returns the length of the string which is in the SV. See C<SvLEN>.
3527 STRLEN SvCUR(SV* sv)
3535 Set the current length of the string which is in the SV. See C<SvCUR>
3538 void SvCUR_set(SV* sv, STRLEN len)
3546 Returns a pointer to the last character in the string which is in the SV.
3547 See C<SvCUR>. Access the character as *(SvEND(sv)).
3557 Returns true if the SV has get magic or overloading. If either is true then
3558 the scalar is active data, and has the potential to return a new value every
3559 time it is accessed. Hence you must be careful to only read it once per user
3560 logical operation and work with that returned value. If neither is true then
3561 the scalar's value cannot change unless written to.
3563 char* SvGAMAGIC(SV* sv)
3571 Expands the character buffer in the SV so that it has room for the
3572 indicated number of bytes (remember to reserve space for an extra trailing
3573 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
3574 Returns a pointer to the character buffer.
3576 char * SvGROW(SV* sv, STRLEN len)
3584 Returns a boolean indicating whether the SV contains an integer.
3594 Returns a boolean indicating whether the SV contains an integer. Checks
3595 the B<private> setting. Use C<SvIOK>.
3605 Returns a boolean indicating whether the SV contains a signed integer.
3607 bool SvIOK_notUV(SV* sv)
3615 Unsets the IV status of an SV.
3617 void SvIOK_off(SV* sv)
3625 Tells an SV that it is an integer.
3627 void SvIOK_on(SV* sv)
3635 Tells an SV that it is an integer and disables all other OK bits.
3637 void SvIOK_only(SV* sv)
3645 Tells and SV that it is an unsigned integer and disables all other OK bits.
3647 void SvIOK_only_UV(SV* sv)
3655 Returns a boolean indicating whether the SV contains an unsigned integer.
3657 bool SvIOK_UV(SV* sv)
3665 Returns a boolean indicating whether the SV is Copy-On-Write. (either shared
3666 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
3669 bool SvIsCOW(SV* sv)
3674 =item SvIsCOW_shared_hash
3675 X<SvIsCOW_shared_hash>
3677 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
3680 bool SvIsCOW_shared_hash(SV* sv)
3688 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
3689 version which guarantees to evaluate sv only once.
3699 Returns the raw value in the SV's IV slot, without checks or conversions.
3700 Only use when you are sure SvIOK is true. See also C<SvIV()>.
3710 Coerces the given SV to an integer and returns it. Guarantees to evaluate
3711 sv only once. Use the more efficient C<SvIV> otherwise.
3721 Like C<SvIV> but doesn't process magic.
3723 IV SvIV_nomg(SV* sv)
3731 Set the value of the IV pointer in sv to val. It is possible to perform
3732 the same function of this macro with an lvalue assignment to C<SvIVX>.
3733 With future Perls, however, it will be more efficient to use
3734 C<SvIV_set> instead of the lvalue assignment to C<SvIVX>.
3736 void SvIV_set(SV* sv, IV val)
3744 Returns the size of the string buffer in the SV, not including any part
3745 attributable to C<SvOOK>. See C<SvCUR>.
3747 STRLEN SvLEN(SV* sv)
3755 Set the actual length of the string which is in the SV. See C<SvIV_set>.
3757 void SvLEN_set(SV* sv, STRLEN len)
3765 Set the value of the MAGIC pointer in sv to val. See C<SvIV_set>.
3767 void SvMAGIC_set(SV* sv, MAGIC* val)
3775 Returns a boolean indicating whether the SV contains a number, integer or
3786 Returns a boolean indicating whether the SV contains a number, integer or
3787 double. Checks the B<private> setting. Use C<SvNIOK>.
3789 bool SvNIOKp(SV* sv)
3797 Unsets the NV/IV status of an SV.
3799 void SvNIOK_off(SV* sv)
3807 Returns a boolean indicating whether the SV contains a double.
3817 Returns a boolean indicating whether the SV contains a double. Checks the
3818 B<private> setting. Use C<SvNOK>.
3828 Unsets the NV status of an SV.
3830 void SvNOK_off(SV* sv)
3838 Tells an SV that it is a double.
3840 void SvNOK_on(SV* sv)
3848 Tells an SV that it is a double and disables all other OK bits.
3850 void SvNOK_only(SV* sv)
3858 Coerce the given SV to a double and return it. See C<SvNVx> for a version
3859 which guarantees to evaluate sv only once.
3869 Returns the raw value in the SV's NV slot, without checks or conversions.
3870 Only use when you are sure SvNOK is true. See also C<SvNV()>.
3880 Coerces the given SV to a double and returns it. Guarantees to evaluate
3881 sv only once. Use the more efficient C<SvNV> otherwise.
3891 Set the value of the NV pointer in sv to val. See C<SvIV_set>.
3893 void SvNV_set(SV* sv, NV val)
3901 Returns a boolean indicating whether the value is an SV. It also tells
3902 whether the value is defined or not.
3912 Returns a boolean indicating whether the SvIVX is a valid offset value for
3913 the SvPVX. This hack is used internally to speed up removal of characters
3914 from the beginning of a SvPV. When SvOOK is true, then the start of the
3915 allocated string buffer is really (SvPVX - SvIVX).
3925 Returns a boolean indicating whether the SV contains a character
3936 Returns a boolean indicating whether the SV contains a character string.
3937 Checks the B<private> setting. Use C<SvPOK>.
3947 Unsets the PV status of an SV.
3949 void SvPOK_off(SV* sv)
3957 Tells an SV that it is a string.
3959 void SvPOK_on(SV* sv)
3967 Tells an SV that it is a string and disables all other OK bits.
3968 Will also turn off the UTF-8 status.
3970 void SvPOK_only(SV* sv)
3975 =item SvPOK_only_UTF8
3978 Tells an SV that it is a string and disables all other OK bits,
3979 and leaves the UTF-8 status as it was.
3981 void SvPOK_only_UTF8(SV* sv)
3989 Returns a pointer to the string in the SV, or a stringified form of
3990 the SV if the SV does not contain a string. The SV may cache the
3991 stringified version becoming C<SvPOK>. Handles 'get' magic. See also
3992 C<SvPVx> for a version which guarantees to evaluate sv only once.
3994 char* SvPV(SV* sv, STRLEN len)
4002 Like C<SvPV>, but converts sv to byte representation first if necessary.
4004 char* SvPVbyte(SV* sv, STRLEN len)
4012 Like C<SvPV>, but converts sv to byte representation first if necessary.
4013 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
4016 char* SvPVbytex(SV* sv, STRLEN len)
4021 =item SvPVbytex_force
4024 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
4025 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
4028 char* SvPVbytex_force(SV* sv, STRLEN len)
4033 =item SvPVbyte_force
4036 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
4038 char* SvPVbyte_force(SV* sv, STRLEN len)
4043 =item SvPVbyte_nolen
4046 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
4048 char* SvPVbyte_nolen(SV* sv)
4056 Like C<SvPV>, but converts sv to utf8 first if necessary.
4058 char* SvPVutf8(SV* sv, STRLEN len)
4066 Like C<SvPV>, but converts sv to utf8 first if necessary.
4067 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
4070 char* SvPVutf8x(SV* sv, STRLEN len)
4075 =item SvPVutf8x_force
4078 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
4079 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
4082 char* SvPVutf8x_force(SV* sv, STRLEN len)
4087 =item SvPVutf8_force
4090 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
4092 char* SvPVutf8_force(SV* sv, STRLEN len)
4097 =item SvPVutf8_nolen
4100 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
4102 char* SvPVutf8_nolen(SV* sv)
4110 Returns a pointer to the physical string in the SV. The SV must contain a
4121 A version of C<SvPV> which guarantees to evaluate sv only once.
4123 char* SvPVx(SV* sv, STRLEN len)
4131 Like C<SvPV> but will force the SV into containing just a string
4132 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
4135 char* SvPV_force(SV* sv, STRLEN len)
4140 =item SvPV_force_nomg
4143 Like C<SvPV> but will force the SV into containing just a string
4144 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
4145 directly. Doesn't process magic.
4147 char* SvPV_force_nomg(SV* sv, STRLEN len)
4155 Returns a pointer to the string in the SV, or a stringified form of
4156 the SV if the SV does not contain a string. The SV may cache the
4157 stringified form becoming C<SvPOK>. Handles 'get' magic.
4159 char* SvPV_nolen(SV* sv)
4167 Like C<SvPV> but doesn't process magic.
4169 char* SvPV_nomg(SV* sv, STRLEN len)
4177 Set the value of the PV pointer in sv to val. See C<SvIV_set>.
4179 void SvPV_set(SV* sv, char* val)
4187 Returns the value of the object's reference count.
4189 U32 SvREFCNT(SV* sv)
4197 Decrements the reference count of the given SV.
4199 void SvREFCNT_dec(SV* sv)
4207 Increments the reference count of the given SV.
4209 SV* SvREFCNT_inc(SV* sv)
4214 =item SvREFCNT_inc_NN
4217 Same as SvREFCNT_inc, but can only be used if you know I<sv>
4218 is not NULL. Since we don't have to check the NULLness, it's faster
4221 SV* SvREFCNT_inc_NN(SV* sv)
4226 =item SvREFCNT_inc_simple
4227 X<SvREFCNT_inc_simple>
4229 Same as SvREFCNT_inc, but can only be used with simple variables, not
4230 expressions or pointer dereferences. Since we don't have to store a
4231 temporary value, it's faster.
4233 SV* SvREFCNT_inc_simple(SV* sv)
4238 =item SvREFCNT_inc_simple_NN
4239 X<SvREFCNT_inc_simple_NN>
4241 Same as SvREFCNT_inc_simple, but can only be used if you know I<sv>
4242 is not NULL. Since we don't have to check the NULLness, it's faster
4245 SV* SvREFCNT_inc_simple_NN(SV* sv)
4250 =item SvREFCNT_inc_simple_void
4251 X<SvREFCNT_inc_simple_void>
4253 Same as SvREFCNT_inc_simple, but can only be used if you don't need the
4254 return value. The macro doesn't need to return a meaningful value.
4256 SV* SvREFCNT_inc_simple_void(SV* sv)
4261 =item SvREFCNT_inc_void
4262 X<SvREFCNT_inc_void>
4264 Same as SvREFCNT_inc, but can only be used if you don't need the
4265 return value. The macro doesn't need to return a meaningful value.
4267 SV* SvREFCNT_inc_void(SV* sv)
4272 =item SvREFCNT_inc_void_NN
4273 X<SvREFCNT_inc_void_NN>
4275 Same as SvREFCNT_inc, but can only be used if you don't need the return
4276 value, and you know that I<sv> is not NULL. The macro doesn't need
4277 to return a meaningful value, or check for NULLness, so it's smaller
4280 SV* SvREFCNT_inc_void_NN(SV* sv)
4288 Tests if the SV is an RV.
4298 Unsets the RV status of an SV.
4300 void SvROK_off(SV* sv)
4308 Tells an SV that it is an RV.
4310 void SvROK_on(SV* sv)
4318 Dereferences an RV to return the SV.
4328 Set the value of the RV pointer in sv to val. See C<SvIV_set>.
4330 void SvRV_set(SV* sv, SV* val)
4338 Returns the stash of the SV.
4348 Set the value of the STASH pointer in sv to val. See C<SvIV_set>.
4350 void SvSTASH_set(SV* sv, STASH* val)
4358 Taints an SV if tainting is enabled.
4360 void SvTAINT(SV* sv)
4368 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
4371 bool SvTAINTED(SV* sv)
4379 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
4380 some of Perl's fundamental security features. XS module authors should not
4381 use this function unless they fully understand all the implications of
4382 unconditionally untainting the value. Untainting should be done in the
4383 standard perl fashion, via a carefully crafted regexp, rather than directly
4384 untainting variables.
4386 void SvTAINTED_off(SV* sv)
4394 Marks an SV as tainted if tainting is enabled.
4396 void SvTAINTED_on(SV* sv)
4404 Returns a boolean indicating whether Perl would evaluate the SV as true or
4405 false, defined or undefined. Does not handle 'get' magic.
4415 Returns the type of the SV. See C<svtype>.
4417 svtype SvTYPE(SV* sv)
4425 Returns a boolean indicating whether the SV contains an unsigned integer.
4435 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
4436 perform the upgrade if necessary. See C<svtype>.
4438 void SvUPGRADE(SV* sv, svtype type)
4446 Returns a boolean indicating whether the SV contains UTF-8 encoded data.
4456 Unsets the UTF-8 status of an SV.
4458 void SvUTF8_off(SV *sv)
4466 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
4467 Do not use frivolously.
4469 void SvUTF8_on(SV *sv)
4477 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
4478 for a version which guarantees to evaluate sv only once.
4488 Returns the raw value in the SV's UV slot, without checks or conversions.
4489 Only use when you are sure SvIOK is true. See also C<SvUV()>.
4499 Coerces the given SV to an unsigned integer and returns it. Guarantees to
4500 evaluate sv only once. Use the more efficient C<SvUV> otherwise.
4510 Like C<SvUV> but doesn't process magic.
4512 UV SvUV_nomg(SV* sv)
4520 Set the value of the UV pointer in sv to val. See C<SvIV_set>.
4522 void SvUV_set(SV* sv, UV val)
4530 Returns a boolean indicating whether the SV contains a v-string.
4537 =item sv_catpvn_nomg
4540 Like C<sv_catpvn> but doesn't process magic.
4542 void sv_catpvn_nomg(SV* sv, const char* ptr, STRLEN len)
4550 Like C<sv_catsv> but doesn't process magic.
4552 void sv_catsv_nomg(SV* dsv, SV* ssv)
4557 =item sv_derived_from
4560 Returns a boolean indicating whether the SV is derived from the specified class
4561 I<at the C level>. To check derivation at the Perl level, call C<isa()> as a
4564 bool sv_derived_from(SV* sv, const char* name)
4567 Found in file universal.c
4569 =item sv_report_used
4572 Dump the contents of all SVs not yet freed. (Debugging aid).
4574 void sv_report_used()
4582 Like C<sv_setsv> but doesn't process magic.
4584 void sv_setsv_nomg(SV* dsv, SV* ssv)
4592 =head1 SV-Body Allocation
4596 =item looks_like_number
4597 X<looks_like_number>
4599 Test if the content of an SV looks like a number (or is a number).
4600 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
4601 non-numeric warning), even if your atof() doesn't grok them.
4603 I32 looks_like_number(SV* sv)
4611 Creates an RV wrapper for an SV. The reference count for the original
4612 SV is B<not> incremented.
4614 SV* newRV_noinc(SV* sv)
4622 Creates a new SV. A non-zero C<len> parameter indicates the number of
4623 bytes of preallocated string space the SV should have. An extra byte for a
4624 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4625 space is allocated.) The reference count for the new SV is set to 1.
4627 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4628 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4629 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4630 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4631 modules supporting older perls.
4633 SV* newSV(STRLEN len)
4641 Creates a new SV from the hash key structure. It will generate scalars that
4642 point to the shared string table where possible. Returns a new (undefined)
4643 SV if the hek is NULL.
4645 SV* newSVhek(const HEK *hek)
4653 Creates a new SV and copies an integer into it. The reference count for the
4664 Creates a new SV and copies a floating point value into it.
4665 The reference count for the SV is set to 1.
4675 Creates a new SV and copies a string into it. The reference count for the
4676 SV is set to 1. If C<len> is zero, Perl will compute the length using
4677 strlen(). For efficiency, consider using C<newSVpvn> instead.
4679 SV* newSVpv(const char* s, STRLEN len)
4687 Creates a new SV and initializes it with the string formatted like
4690 SV* newSVpvf(const char* pat, ...)
4698 Creates a new SV and copies a string into it. The reference count for the
4699 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
4700 string. You are responsible for ensuring that the source string is at least
4701 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
4703 SV* newSVpvn(const char* s, STRLEN len)
4708 =item newSVpvn_share
4711 Creates a new SV with its SvPVX_const pointing to a shared string in the string
4712 table. If the string does not already exist in the table, it is created
4713 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
4714 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
4715 otherwise the hash is computed. The idea here is that as the string table
4716 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
4717 hash lookup will avoid string compare.
4719 SV* newSVpvn_share(const char* s, I32 len, U32 hash)
4727 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
4728 it will be upgraded to one. If C<classname> is non-null then the new SV will
4729 be blessed in the specified package. The new SV is returned and its
4730 reference count is 1.
4732 SV* newSVrv(SV* rv, const char* classname)
4740 Creates a new SV which is an exact duplicate of the original SV.
4743 SV* newSVsv(SV* old)
4751 Creates a new SV and copies an unsigned integer into it.
4752 The reference count for the SV is set to 1.
4762 This function is only called on magical items, and is only used by
4763 sv_true() or its macro equivalent.
4765 bool sv_2bool(SV* sv)
4773 Using various gambits, try to get a CV from an SV; in addition, try if
4774 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
4775 The flags in C<lref> are passed to sv_fetchsv.
4777 CV* sv_2cv(SV* sv, HV** st, GV** gvp, I32 lref)
4785 Using various gambits, try to get an IO from an SV: the IO slot if its a
4786 GV; or the recursive result if we're an RV; or the IO slot of the symbol
4787 named after the PV if we're a string.
4797 Return the integer value of an SV, doing any necessary string
4798 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
4799 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
4801 IV sv_2iv_flags(SV* sv, I32 flags)
4809 Marks an existing SV as mortal. The SV will be destroyed "soon", either
4810 by an explicit call to FREETMPS, or by an implicit call at places such as
4811 statement boundaries. SvTEMP() is turned on which means that the SV's
4812 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
4813 and C<sv_mortalcopy>.
4815 SV* sv_2mortal(SV* sv)
4823 Return the num value of an SV, doing any necessary string or integer
4824 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
4835 Return a pointer to the byte-encoded representation of the SV, and set *lp
4836 to its length. May cause the SV to be downgraded from UTF-8 as a
4839 Usually accessed via the C<SvPVbyte> macro.
4841 char* sv_2pvbyte(SV* sv, STRLEN* lp)
4849 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
4850 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
4852 Usually accessed via the C<SvPVutf8> macro.
4854 char* sv_2pvutf8(SV* sv, STRLEN* lp)
4862 Returns a pointer to the string value of an SV, and sets *lp to its length.
4863 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
4865 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
4866 usually end up here too.
4868 char* sv_2pv_flags(SV* sv, STRLEN* lp, I32 flags)
4876 Return the unsigned integer value of an SV, doing any necessary string
4877 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
4878 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
4880 UV sv_2uv_flags(SV* sv, I32 flags)
4888 Remove any string offset. You should normally use the C<SvOOK_off> macro
4891 int sv_backoff(SV* sv)
4899 Blesses an SV into a specified package. The SV must be an RV. The package
4900 must be designated by its stash (see C<gv_stashpv()>). The reference count
4901 of the SV is unaffected.
4903 SV* sv_bless(SV* sv, HV* stash)
4911 Concatenates the string onto the end of the string which is in the SV.
4912 If the SV has the UTF-8 status set, then the bytes appended should be
4913 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4915 void sv_catpv(SV* sv, const char* ptr)
4923 Processes its arguments like C<sprintf> and appends the formatted
4924 output to an SV. If the appended data contains "wide" characters
4925 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
4926 and characters >255 formatted with %c), the original SV might get
4927 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
4928 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
4929 valid UTF-8; if the original SV was bytes, the pattern should be too.
4931 void sv_catpvf(SV* sv, const char* pat, ...)
4939 Like C<sv_catpvf>, but also handles 'set' magic.
4941 void sv_catpvf_mg(SV *sv, const char* pat, ...)
4949 Concatenates the string onto the end of the string which is in the SV. The
4950 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4951 status set, then the bytes appended should be valid UTF-8.
4952 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4954 void sv_catpvn(SV* sv, const char* ptr, STRLEN len)
4959 =item sv_catpvn_flags
4962 Concatenates the string onto the end of the string which is in the SV. The
4963 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4964 status set, then the bytes appended should be valid UTF-8.
4965 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4966 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4967 in terms of this function.
4969 void sv_catpvn_flags(SV* sv, const char* ptr, STRLEN len, I32 flags)
4977 Like C<sv_catpv>, but also handles 'set' magic.
4979 void sv_catpv_mg(SV *sv, const char *ptr)
4987 Concatenates the string from SV C<ssv> onto the end of the string in
4988 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4989 not 'set' magic. See C<sv_catsv_mg>.
4991 void sv_catsv(SV* dsv, SV* ssv)
4996 =item sv_catsv_flags
4999 Concatenates the string from SV C<ssv> onto the end of the string in
5000 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
5001 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
5002 and C<sv_catsv_nomg> are implemented in terms of this function.
5004 void sv_catsv_flags(SV* dsv, SV* ssv, I32 flags)
5012 Efficient removal of characters from the beginning of the string buffer.
5013 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
5014 the string buffer. The C<ptr> becomes the first character of the adjusted
5015 string. Uses the "OOK hack".
5016 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
5017 refer to the same chunk of data.
5019 void sv_chop(SV* sv, const char* ptr)
5027 Clear an SV: call any destructors, free up any memory used by the body,
5028 and free the body itself. The SV's head is I<not> freed, although
5029 its type is set to all 1's so that it won't inadvertently be assumed
5030 to be live during global destruction etc.
5031 This function should only be called when REFCNT is zero. Most of the time
5032 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5035 void sv_clear(SV* sv)
5043 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5044 string in C<sv1> is less than, equal to, or greater than the string in
5045 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5046 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
5048 I32 sv_cmp(SV* sv1, SV* sv2)
5056 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
5057 'use bytes' aware, handles get magic, and will coerce its args to strings
5058 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
5060 I32 sv_cmp_locale(SV* sv1, SV* sv2)
5068 Add Collate Transform magic to an SV if it doesn't already have it.
5070 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
5071 scalar data of the variable, but transformed to such a format that a normal
5072 memory comparison can be used to compare the data according to the locale
5075 char* sv_collxfrm(SV* sv, STRLEN* nxp)
5083 Copies a stringified representation of the source SV into the
5084 destination SV. Automatically performs any necessary mg_get and
5085 coercion of numeric values into strings. Guaranteed to preserve
5086 UTF-8 flag even from overloaded objects. Similar in nature to
5087 sv_2pv[_flags] but operates directly on an SV instead of just the
5088 string. Mostly uses sv_2pv_flags to do its work, except when that
5089 would lose the UTF-8'ness of the PV.
5091 void sv_copypv(SV* dsv, SV* ssv)
5099 Auto-decrement of the value in the SV, doing string to numeric conversion
5100 if necessary. Handles 'get' magic.
5110 Returns a boolean indicating whether the strings in the two SVs are
5111 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5112 coerce its args to strings if necessary.
5114 I32 sv_eq(SV* sv1, SV* sv2)
5119 =item sv_force_normal_flags
5120 X<sv_force_normal_flags>
5122 Undo various types of fakery on an SV: if the PV is a shared string, make
5123 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
5124 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
5125 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
5126 then a copy-on-write scalar drops its PV buffer (if any) and becomes
5127 SvPOK_off rather than making a copy. (Used where this scalar is about to be
5128 set to some other value.) In addition, the C<flags> parameter gets passed to
5129 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
5130 with flags set to 0.
5132 void sv_force_normal_flags(SV *sv, U32 flags)
5140 Decrement an SV's reference count, and if it drops to zero, call
5141 C<sv_clear> to invoke destructors and free up any memory used by
5142 the body; finally, deallocate the SV's head itself.
5143 Normally called via a wrapper macro C<SvREFCNT_dec>.
5145 void sv_free(SV* sv)
5153 Get a line from the filehandle and store it into the SV, optionally
5154 appending to the currently-stored string.
5156 char* sv_gets(SV* sv, PerlIO* fp, I32 append)
5164 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
5165 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
5166 Use the C<SvGROW> wrapper instead.
5168 char* sv_grow(SV* sv, STRLEN newlen)
5176 Auto-increment of the value in the SV, doing string to numeric conversion
5177 if necessary. Handles 'get' magic.
5187 Inserts a string at the specified offset/length within the SV. Similar to
5188 the Perl substr() function.
5190 void sv_insert(SV* bigsv, STRLEN offset, STRLEN len, const char* little, STRLEN littlelen)
5198 Returns a boolean indicating whether the SV is blessed into the specified
5199 class. This does not check for subtypes; use C<sv_derived_from> to verify
5200 an inheritance relationship.
5202 int sv_isa(SV* sv, const char* name)
5210 Returns a boolean indicating whether the SV is an RV pointing to a blessed
5211 object. If the SV is not an RV, or if the object is not blessed, then this
5214 int sv_isobject(SV* sv)
5222 Returns the length of the string in the SV. Handles magic and type
5223 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5225 STRLEN sv_len(SV* sv)
5233 Returns the number of characters in the string in an SV, counting wide
5234 UTF-8 bytes as a single character. Handles magic and type coercion.
5236 STRLEN sv_len_utf8(SV* sv)
5244 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
5245 then adds a new magic item of type C<how> to the head of the magic list.
5247 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
5248 handling of the C<name> and C<namlen> arguments.
5250 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
5251 to add more than one instance of the same 'how'.
5253 void sv_magic(SV* sv, SV* obj, int how, const char* name, I32 namlen)
5261 Adds magic to an SV, upgrading it if necessary. Applies the
5262 supplied vtable and returns a pointer to the magic added.
5264 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
5265 In particular, you can add magic to SvREADONLY SVs, and add more than
5266 one instance of the same 'how'.
5268 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
5269 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
5270 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
5271 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
5273 (This is now used as a subroutine by C<sv_magic>.)
5275 MAGIC * sv_magicext(SV* sv, SV* obj, int how, MGVTBL *vtbl, const char* name, I32 namlen)
5283 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
5284 The new SV is marked as mortal. It will be destroyed "soon", either by an
5285 explicit call to FREETMPS, or by an implicit call at places such as
5286 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
5288 SV* sv_mortalcopy(SV* oldsv)
5296 Creates a new null SV which is mortal. The reference count of the SV is
5297 set to 1. It will be destroyed "soon", either by an explicit call to
5298 FREETMPS, or by an implicit call at places such as statement boundaries.
5299 See also C<sv_mortalcopy> and C<sv_2mortal>.
5309 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5312 SV* sv_newref(SV* sv)
5320 Converts the value pointed to by offsetp from a count of bytes from the
5321 start of the string, to a count of the equivalent number of UTF-8 chars.
5322 Handles magic and type coercion.
5324 void sv_pos_b2u(SV* sv, I32* offsetp)
5332 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5333 the start of the string, to a count of the equivalent number of bytes; if
5334 lenp is non-zero, it does the same to lenp, but this time starting from
5335 the offset, rather than from the start of the string. Handles magic and
5338 void sv_pos_u2b(SV* sv, I32* offsetp, I32* lenp)
5343 =item sv_pvbyten_force
5346 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
5348 char* sv_pvbyten_force(SV* sv, STRLEN* lp)
5356 Get a sensible string out of the SV somehow.
5357 A private implementation of the C<SvPV_force> macro for compilers which
5358 can't cope with complex macro expressions. Always use the macro instead.
5360 char* sv_pvn_force(SV* sv, STRLEN* lp)
5365 =item sv_pvn_force_flags
5366 X<sv_pvn_force_flags>
5368 Get a sensible string out of the SV somehow.
5369 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
5370 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
5371 implemented in terms of this function.
5372 You normally want to use the various wrapper macros instead: see
5373 C<SvPV_force> and C<SvPV_force_nomg>
5375 char* sv_pvn_force_flags(SV* sv, STRLEN* lp, I32 flags)
5380 =item sv_pvutf8n_force
5383 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
5385 char* sv_pvutf8n_force(SV* sv, STRLEN* lp)
5393 Returns a string describing what the SV is a reference to.
5395 char* sv_reftype(const SV* sv, int ob)
5403 Make the first argument a copy of the second, then delete the original.
5404 The target SV physically takes over ownership of the body of the source SV
5405 and inherits its flags; however, the target keeps any magic it owns,
5406 and any magic in the source is discarded.
5407 Note that this is a rather specialist SV copying operation; most of the
5408 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5410 void sv_replace(SV* sv, SV* nsv)
5418 Underlying implementation for the C<reset> Perl function.
5419 Note that the perl-level function is vaguely deprecated.
5421 void sv_reset(const char* s, HV* stash)
5429 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
5430 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
5431 push a back-reference to this RV onto the array of backreferences
5432 associated with that magic.
5434 SV* sv_rvweaken(SV *sv)
5442 Copies an integer into the given SV, upgrading first if necessary.
5443 Does not handle 'set' magic. See also C<sv_setiv_mg>.
5445 void sv_setiv(SV* sv, IV num)
5453 Like C<sv_setiv>, but also handles 'set' magic.
5455 void sv_setiv_mg(SV *sv, IV i)
5463 Copies a double into the given SV, upgrading first if necessary.
5464 Does not handle 'set' magic. See also C<sv_setnv_mg>.
5466 void sv_setnv(SV* sv, NV num)
5474 Like C<sv_setnv>, but also handles 'set' magic.
5476 void sv_setnv_mg(SV *sv, NV num)
5484 Copies a string into an SV. The string must be null-terminated. Does not
5485 handle 'set' magic. See C<sv_setpv_mg>.
5487 void sv_setpv(SV* sv, const char* ptr)
5495 Works like C<sv_catpvf> but copies the text into the SV instead of
5496 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
5498 void sv_setpvf(SV* sv, const char* pat, ...)
5506 Like C<sv_setpvf>, but also handles 'set' magic.
5508 void sv_setpvf_mg(SV *sv, const char* pat, ...)
5516 Copies an integer into the given SV, also updating its string value.
5517 Does not handle 'set' magic. See C<sv_setpviv_mg>.
5519 void sv_setpviv(SV* sv, IV num)
5527 Like C<sv_setpviv>, but also handles 'set' magic.
5529 void sv_setpviv_mg(SV *sv, IV iv)
5537 Copies a string into an SV. The C<len> parameter indicates the number of
5538 bytes to be copied. If the C<ptr> argument is NULL the SV will become
5539 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
5541 void sv_setpvn(SV* sv, const char* ptr, STRLEN len)
5549 Like C<sv_setpvn>, but also handles 'set' magic.
5551 void sv_setpvn_mg(SV *sv, const char *ptr, STRLEN len)
5559 Like C<sv_setpv>, but also handles 'set' magic.
5561 void sv_setpv_mg(SV *sv, const char *ptr)
5569 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
5570 argument will be upgraded to an RV. That RV will be modified to point to
5571 the new SV. The C<classname> argument indicates the package for the
5572 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
5573 will have a reference count of 1, and the RV will be returned.
5575 SV* sv_setref_iv(SV* rv, const char* classname, IV iv)
5583 Copies a double into a new SV, optionally blessing the SV. The C<rv>
5584 argument will be upgraded to an RV. That RV will be modified to point to
5585 the new SV. The C<classname> argument indicates the package for the
5586 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
5587 will have a reference count of 1, and the RV will be returned.
5589 SV* sv_setref_nv(SV* rv, const char* classname, NV nv)
5597 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
5598 argument will be upgraded to an RV. That RV will be modified to point to
5599 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
5600 into the SV. The C<classname> argument indicates the package for the
5601 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
5602 will have a reference count of 1, and the RV will be returned.
5604 Do not use with other Perl types such as HV, AV, SV, CV, because those
5605 objects will become corrupted by the pointer copy process.
5607 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
5609 SV* sv_setref_pv(SV* rv, const char* classname, void* pv)
5617 Copies a string into a new SV, optionally blessing the SV. The length of the
5618 string must be specified with C<n>. The C<rv> argument will be upgraded to
5619 an RV. That RV will be modified to point to the new SV. The C<classname>
5620 argument indicates the package for the blessing. Set C<classname> to
5621 C<NULL> to avoid the blessing. The new SV will have a reference count
5622 of 1, and the RV will be returned.
5624 Note that C<sv_setref_pv> copies the pointer while this copies the string.
5626 SV* sv_setref_pvn(SV* rv, const char* classname, const char* pv, STRLEN n)
5634 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
5635 argument will be upgraded to an RV. That RV will be modified to point to
5636 the new SV. The C<classname> argument indicates the package for the
5637 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
5638 will have a reference count of 1, and the RV will be returned.
5640 SV* sv_setref_uv(SV* rv, const char* classname, UV uv)
5648 Copies the contents of the source SV C<ssv> into the destination SV
5649 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
5650 function if the source SV needs to be reused. Does not handle 'set' magic.
5651 Loosely speaking, it performs a copy-by-value, obliterating any previous
5652 content of the destination.
5654 You probably want to use one of the assortment of wrappers, such as
5655 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
5656 C<SvSetMagicSV_nosteal>.
5658 void sv_setsv(SV* dsv, SV* ssv)
5663 =item sv_setsv_flags
5666 Copies the contents of the source SV C<ssv> into the destination SV
5667 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
5668 function if the source SV needs to be reused. Does not handle 'set' magic.
5669 Loosely speaking, it performs a copy-by-value, obliterating any previous
5670 content of the destination.
5671 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
5672 C<ssv> if appropriate, else not. If the C<flags> parameter has the
5673 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
5674 and C<sv_setsv_nomg> are implemented in terms of this function.
5676 You probably want to use one of the assortment of wrappers, such as
5677 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
5678 C<SvSetMagicSV_nosteal>.
5680 This is the primary function for copying scalars, and most other
5681 copy-ish functions and macros use this underneath.
5683 void sv_setsv_flags(SV* dsv, SV* ssv, I32 flags)
5691 Like C<sv_setsv>, but also handles 'set' magic.
5693 void sv_setsv_mg(SV *dstr, SV *sstr)
5701 Copies an unsigned integer into the given SV, upgrading first if necessary.
5702 Does not handle 'set' magic. See also C<sv_setuv_mg>.
5704 void sv_setuv(SV* sv, UV num)
5712 Like C<sv_setuv>, but also handles 'set' magic.
5714 void sv_setuv_mg(SV *sv, UV u)
5722 Test an SV for taintedness. Use C<SvTAINTED> instead.
5723 bool sv_tainted(SV* sv)
5731 Returns true if the SV has a true value by Perl's rules.
5732 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
5733 instead use an in-line version.
5743 Removes all magic of type C<type> from an SV.
5745 int sv_unmagic(SV* sv, int type)
5750 =item sv_unref_flags
5753 Unsets the RV status of the SV, and decrements the reference count of
5754 whatever was being referenced by the RV. This can almost be thought of
5755 as a reversal of C<newSVrv>. The C<cflags> argument can contain
5756 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
5757 (otherwise the decrementing is conditional on the reference count being
5758 different from one or the reference being a readonly SV).
5761 void sv_unref_flags(SV* sv, U32 flags)
5769 Untaint an SV. Use C<SvTAINTED_off> instead.
5770 void sv_untaint(SV* sv)
5778 Upgrade an SV to a more complex form. Generally adds a new body type to the
5779 SV, then copies across as much information as possible from the old body.
5780 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
5782 void sv_upgrade(SV* sv, U32 mt)
5787 =item sv_usepvn_flags
5790 Tells an SV to use C<ptr> to find its string value. Normally the
5791 string is stored inside the SV but sv_usepvn allows the SV to use an
5792 outside string. The C<ptr> should point to memory that was allocated
5793 by C<malloc>. The string length, C<len>, must be supplied. By default
5794 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
5795 so that pointer should not be freed or used by the programmer after
5796 giving it to sv_usepvn, and neither should any pointers from "behind"
5797 that pointer (e.g. ptr + 1) be used.
5799 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
5800 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
5801 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
5802 C<len>, and already meets the requirements for storing in C<SvPVX>)
5804 void sv_usepvn_flags(SV* sv, char* ptr, STRLEN len, U32 flags)
5809 =item sv_utf8_decode
5812 If the PV of the SV is an octet sequence in UTF-8
5813 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
5814 so that it looks like a character. If the PV contains only single-byte
5815 characters, the C<SvUTF8> flag stays being off.
5816 Scans PV for validity and returns false if the PV is invalid UTF-8.
5818 NOTE: this function is experimental and may change or be
5819 removed without notice.
5821 bool sv_utf8_decode(SV *sv)
5826 =item sv_utf8_downgrade
5827 X<sv_utf8_downgrade>
5829 Attempts to convert the PV of an SV from characters to bytes.
5830 If the PV contains a character beyond byte, this conversion will fail;
5831 in this case, either returns false or, if C<fail_ok> is not
5834 This is not as a general purpose Unicode to byte encoding interface:
5835 use the Encode extension for that.
5837 NOTE: this function is experimental and may change or be
5838 removed without notice.
5840 bool sv_utf8_downgrade(SV *sv, bool fail_ok)
5845 =item sv_utf8_encode
5848 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
5849 flag off so that it looks like octets again.
5851 void sv_utf8_encode(SV *sv)
5856 =item sv_utf8_upgrade
5859 Converts the PV of an SV to its UTF-8-encoded form.
5860 Forces the SV to string form if it is not already.
5861 Always sets the SvUTF8 flag to avoid future validity checks even
5862 if all the bytes have hibit clear.
5864 This is not as a general purpose byte encoding to Unicode interface:
5865 use the Encode extension for that.
5867 STRLEN sv_utf8_upgrade(SV *sv)
5872 =item sv_utf8_upgrade_flags
5873 X<sv_utf8_upgrade_flags>
5875 Converts the PV of an SV to its UTF-8-encoded form.
5876 Forces the SV to string form if it is not already.
5877 Always sets the SvUTF8 flag to avoid future validity checks even
5878 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
5879 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
5880 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
5882 This is not as a general purpose byte encoding to Unicode interface:
5883 use the Encode extension for that.
5885 STRLEN sv_utf8_upgrade_flags(SV *sv, I32 flags)
5893 Processes its arguments like C<vsprintf> and appends the formatted output
5894 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
5896 Usually used via its frontend C<sv_catpvf>.
5898 void sv_vcatpvf(SV* sv, const char* pat, va_list* args)
5906 Processes its arguments like C<vsprintf> and appends the formatted output
5907 to an SV. Uses an array of SVs if the C style variable argument list is
5908 missing (NULL). When running with taint checks enabled, indicates via
5909 C<maybe_tainted> if results are untrustworthy (often due to the use of
5912 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
5914 void sv_vcatpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
5922 Like C<sv_vcatpvf>, but also handles 'set' magic.
5924 Usually used via its frontend C<sv_catpvf_mg>.
5926 void sv_vcatpvf_mg(SV* sv, const char* pat, va_list* args)
5934 Works like C<sv_vcatpvf> but copies the text into the SV instead of
5935 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
5937 Usually used via its frontend C<sv_setpvf>.
5939 void sv_vsetpvf(SV* sv, const char* pat, va_list* args)
5947 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
5950 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
5952 void sv_vsetpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
5960 Like C<sv_vsetpvf>, but also handles 'set' magic.
5962 Usually used via its frontend C<sv_setpvf_mg>.
5964 void sv_vsetpvf_mg(SV* sv, const char* pat, va_list* args)
5972 =head1 Unicode Support
5976 =item bytes_from_utf8
5979 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
5980 Unlike C<utf8_to_bytes> but like C<bytes_to_utf8>, returns a pointer to
5981 the newly-created string, and updates C<len> to contain the new
5982 length. Returns the original string if no conversion occurs, C<len>
5983 is unchanged. Do nothing if C<is_utf8> points to 0. Sets C<is_utf8> to
5984 0 if C<s> is converted or contains all 7bit characters.
5986 NOTE: this function is experimental and may change or be
5987 removed without notice.
5989 U8* bytes_from_utf8(const U8 *s, STRLEN *len, bool *is_utf8)
5992 Found in file utf8.c
5997 Converts a string C<s> of length C<len> from ASCII into UTF-8 encoding.
5998 Returns a pointer to the newly-created string, and sets C<len> to
5999 reflect the new length.
6001 If you want to convert to UTF-8 from other encodings than ASCII,
6002 see sv_recode_to_utf8().
6004 NOTE: this function is experimental and may change or be
6005 removed without notice.
6007 U8* bytes_to_utf8(const U8 *s, STRLEN *len)
6010 Found in file utf8.c
6015 Return true if the strings s1 and s2 differ case-insensitively, false
6016 if not (if they are equal case-insensitively). If u1 is true, the
6017 string s1 is assumed to be in UTF-8-encoded Unicode. If u2 is true,
6018 the string s2 is assumed to be in UTF-8-encoded Unicode. If u1 or u2
6019 are false, the respective string is assumed to be in native 8-bit
6022 If the pe1 and pe2 are non-NULL, the scanning pointers will be copied
6023 in there (they will point at the beginning of the I<next> character).
6024 If the pointers behind pe1 or pe2 are non-NULL, they are the end
6025 pointers beyond which scanning will not continue under any
6026 circumstances. If the byte lengths l1 and l2 are non-zero, s1+l1 and
6027 s2+l2 will be used as goal end pointers that will also stop the scan,
6028 and which qualify towards defining a successful match: all the scans
6029 that define an explicit length must reach their goal pointers for
6030 a match to succeed).
6032 For case-insensitiveness, the "casefolding" of Unicode is used
6033 instead of upper/lowercasing both the characters, see
6034 http://www.unicode.org/unicode/reports/tr21/ (Case Mappings).
6036 I32 ibcmp_utf8(const char* a, char **pe1, UV l1, bool u1, const char* b, char **pe2, UV l2, bool u2)
6039 Found in file utf8.c
6044 Tests if some arbitrary number of bytes begins in a valid UTF-8
6045 character. Note that an INVARIANT (i.e. ASCII) character is a valid
6046 UTF-8 character. The actual number of bytes in the UTF-8 character
6047 will be returned if it is valid, otherwise 0.
6049 STRLEN is_utf8_char(const U8 *p)
6052 Found in file utf8.c
6054 =item is_utf8_string
6057 Returns true if first C<len> bytes of the given string form a valid
6058 UTF-8 string, false otherwise. Note that 'a valid UTF-8 string' does
6059 not mean 'a string that contains code points above 0x7F encoded in UTF-8'
6060 because a valid ASCII string is a valid UTF-8 string.
6062 See also is_utf8_string_loclen() and is_utf8_string_loc().
6064 bool is_utf8_string(const U8 *s, STRLEN len)
6067 Found in file utf8.c
6069 =item is_utf8_string_loc
6070 X<is_utf8_string_loc>
6072 Like is_utf8_string() but stores the location of the failure (in the
6073 case of "utf8ness failure") or the location s+len (in the case of
6074 "utf8ness success") in the C<ep>.
6076 See also is_utf8_string_loclen() and is_utf8_string().
6078 bool is_utf8_string_loc(const U8 *s, STRLEN len, const U8 **p)
6081 Found in file utf8.c
6083 =item is_utf8_string_loclen
6084 X<is_utf8_string_loclen>
6086 Like is_utf8_string() but stores the location of the failure (in the
6087 case of "utf8ness failure") or the location s+len (in the case of
6088 "utf8ness success") in the C<ep>, and the number of UTF-8
6089 encoded characters in the C<el>.
6091 See also is_utf8_string_loc() and is_utf8_string().
6093 bool is_utf8_string_loclen(const U8 *s, STRLEN len, const U8 **ep, STRLEN *el)
6096 Found in file utf8.c
6098 =item pv_uni_display
6101 Build to the scalar dsv a displayable version of the string spv,
6102 length len, the displayable version being at most pvlim bytes long
6103 (if longer, the rest is truncated and "..." will be appended).
6105 The flags argument can have UNI_DISPLAY_ISPRINT set to display
6106 isPRINT()able characters as themselves, UNI_DISPLAY_BACKSLASH
6107 to display the \\[nrfta\\] as the backslashed versions (like '\n')
6108 (UNI_DISPLAY_BACKSLASH is preferred over UNI_DISPLAY_ISPRINT for \\).
6109 UNI_DISPLAY_QQ (and its alias UNI_DISPLAY_REGEX) have both
6110 UNI_DISPLAY_BACKSLASH and UNI_DISPLAY_ISPRINT turned on.
6112 The pointer to the PV of the dsv is returned.
6114 char* pv_uni_display(SV *dsv, const U8 *spv, STRLEN len, STRLEN pvlim, UV flags)
6117 Found in file utf8.c
6122 The encoding is assumed to be an Encode object, the PV of the ssv is
6123 assumed to be octets in that encoding and decoding the input starts
6124 from the position which (PV + *offset) pointed to. The dsv will be
6125 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
6126 when the string tstr appears in decoding output or the input ends on
6127 the PV of the ssv. The value which the offset points will be modified
6128 to the last input position on the ssv.
6130 Returns TRUE if the terminator was found, else returns FALSE.
6132 bool sv_cat_decode(SV* dsv, SV *encoding, SV *ssv, int *offset, char* tstr, int tlen)
6137 =item sv_recode_to_utf8
6138 X<sv_recode_to_utf8>
6140 The encoding is assumed to be an Encode object, on entry the PV
6141 of the sv is assumed to be octets in that encoding, and the sv
6142 will be converted into Unicode (and UTF-8).
6144 If the sv already is UTF-8 (or if it is not POK), or if the encoding
6145 is not a reference, nothing is done to the sv. If the encoding is not
6146 an C<Encode::XS> Encoding object, bad things will happen.
6147 (See F<lib/encoding.pm> and L<Encode>).
6149 The PV of the sv is returned.
6151 char* sv_recode_to_utf8(SV* sv, SV *encoding)
6156 =item sv_uni_display
6159 Build to the scalar dsv a displayable version of the scalar sv,
6160 the displayable version being at most pvlim bytes long
6161 (if longer, the rest is truncated and "..." will be appended).
6163 The flags argument is as in pv_uni_display().
6165 The pointer to the PV of the dsv is returned.
6167 char* sv_uni_display(SV *dsv, SV *ssv, STRLEN pvlim, UV flags)
6170 Found in file utf8.c
6175 The "p" contains the pointer to the UTF-8 string encoding
6176 the character that is being converted.
6178 The "ustrp" is a pointer to the character buffer to put the
6179 conversion result to. The "lenp" is a pointer to the length
6182 The "swashp" is a pointer to the swash to use.
6184 Both the special and normal mappings are stored lib/unicore/To/Foo.pl,
6185 and loaded by SWASHNEW, using lib/utf8_heavy.pl. The special (usually,
6186 but not always, a multicharacter mapping), is tried first.
6188 The "special" is a string like "utf8::ToSpecLower", which means the
6189 hash %utf8::ToSpecLower. The access to the hash is through
6190 Perl_to_utf8_case().
6192 The "normal" is a string like "ToLower" which means the swash
6195 UV to_utf8_case(const U8 *p, U8* ustrp, STRLEN *lenp, SV **swashp, const char *normal, const char *special)
6198 Found in file utf8.c
6203 Convert the UTF-8 encoded character at p to its foldcase version and
6204 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6205 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6206 foldcase version may be longer than the original character (up to
6209 The first character of the foldcased version is returned
6210 (but note, as explained above, that there may be more.)
6212 UV to_utf8_fold(const U8 *p, U8* ustrp, STRLEN *lenp)
6215 Found in file utf8.c
6220 Convert the UTF-8 encoded character at p to its lowercase version and
6221 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6222 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6223 lowercase version may be longer than the original character.
6225 The first character of the lowercased version is returned
6226 (but note, as explained above, that there may be more.)
6228 UV to_utf8_lower(const U8 *p, U8* ustrp, STRLEN *lenp)
6231 Found in file utf8.c
6236 Convert the UTF-8 encoded character at p to its titlecase version and
6237 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6238 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6239 titlecase version may be longer than the original character.
6241 The first character of the titlecased version is returned
6242 (but note, as explained above, that there may be more.)
6244 UV to_utf8_title(const U8 *p, U8* ustrp, STRLEN *lenp)
6247 Found in file utf8.c
6252 Convert the UTF-8 encoded character at p to its uppercase version and
6253 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6254 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since
6255 the uppercase version may be longer than the original character.
6257 The first character of the uppercased version is returned
6258 (but note, as explained above, that there may be more.)
6260 UV to_utf8_upper(const U8 *p, U8* ustrp, STRLEN *lenp)
6263 Found in file utf8.c
6265 =item utf8n_to_uvchr
6270 Returns the native character value of the first character in the string
6272 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6273 length, in bytes, of that character.
6275 Allows length and flags to be passed to low level routine.
6277 UV utf8n_to_uvchr(const U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags)
6280 Found in file utf8.c
6282 =item utf8n_to_uvuni
6285 Bottom level UTF-8 decode routine.
6286 Returns the unicode code point value of the first character in the string C<s>
6287 which is assumed to be in UTF-8 encoding and no longer than C<curlen>;
6288 C<retlen> will be set to the length, in bytes, of that character.
6290 If C<s> does not point to a well-formed UTF-8 character, the behaviour
6291 is dependent on the value of C<flags>: if it contains UTF8_CHECK_ONLY,
6292 it is assumed that the caller will raise a warning, and this function
6293 will silently just set C<retlen> to C<-1> and return zero. If the
6294 C<flags> does not contain UTF8_CHECK_ONLY, warnings about
6295 malformations will be given, C<retlen> will be set to the expected
6296 length of the UTF-8 character in bytes, and zero will be returned.
6298 The C<flags> can also contain various flags to allow deviations from
6299 the strict UTF-8 encoding (see F<utf8.h>).
6301 Most code should use utf8_to_uvchr() rather than call this directly.
6303 UV utf8n_to_uvuni(const U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags)
6306 Found in file utf8.c
6311 Returns the number of UTF-8 characters between the UTF-8 pointers C<a>
6314 WARNING: use only if you *know* that the pointers point inside the
6317 IV utf8_distance(const U8 *a, const U8 *b)
6320 Found in file utf8.c
6325 Return the UTF-8 pointer C<s> displaced by C<off> characters, either
6326 forward or backward.
6328 WARNING: do not use the following unless you *know* C<off> is within
6329 the UTF-8 data pointed to by C<s> *and* that on entry C<s> is aligned
6330 on the first byte of character or just after the last byte of a character.
6332 U8* utf8_hop(const U8 *s, I32 off)
6335 Found in file utf8.c
6340 Return the length of the UTF-8 char encoded string C<s> in characters.
6341 Stops at C<e> (inclusive). If C<e E<lt> s> or if the scan would end
6342 up past C<e>, croaks.
6344 STRLEN utf8_length(const U8* s, const U8 *e)
6347 Found in file utf8.c
6352 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
6353 Unlike C<bytes_to_utf8>, this over-writes the original string, and
6354 updates len to contain the new length.
6355 Returns zero on failure, setting C<len> to -1.
6357 If you need a copy of the string, see C<bytes_from_utf8>.
6359 NOTE: this function is experimental and may change or be
6360 removed without notice.
6362 U8* utf8_to_bytes(U8 *s, STRLEN *len)
6365 Found in file utf8.c
6370 Returns the native character value of the first character in the string C<s>
6371 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6372 length, in bytes, of that character.
6374 If C<s> does not point to a well-formed UTF-8 character, zero is
6375 returned and retlen is set, if possible, to -1.
6377 UV utf8_to_uvchr(const U8 *s, STRLEN *retlen)
6380 Found in file utf8.c
6385 Returns the Unicode code point of the first character in the string C<s>
6386 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6387 length, in bytes, of that character.
6389 This function should only be used when returned UV is considered
6390 an index into the Unicode semantic tables (e.g. swashes).
6392 If C<s> does not point to a well-formed UTF-8 character, zero is
6393 returned and retlen is set, if possible, to -1.
6395 UV utf8_to_uvuni(const U8 *s, STRLEN *retlen)
6398 Found in file utf8.c
6403 Adds the UTF-8 representation of the Native codepoint C<uv> to the end
6404 of the string C<d>; C<d> should be have at least C<UTF8_MAXBYTES+1> free
6405 bytes available. The return value is the pointer to the byte after the
6406 end of the new character. In other words,
6408 d = uvchr_to_utf8(d, uv);
6410 is the recommended wide native character-aware way of saying
6414 U8* uvchr_to_utf8(U8 *d, UV uv)
6417 Found in file utf8.c
6419 =item uvuni_to_utf8_flags
6420 X<uvuni_to_utf8_flags>
6422 Adds the UTF-8 representation of the Unicode codepoint C<uv> to the end
6423 of the string C<d>; C<d> should be have at least C<UTF8_MAXBYTES+1> free
6424 bytes available. The return value is the pointer to the byte after the
6425 end of the new character. In other words,
6427 d = uvuni_to_utf8_flags(d, uv, flags);
6431 d = uvuni_to_utf8(d, uv);
6433 (which is equivalent to)
6435 d = uvuni_to_utf8_flags(d, uv, 0);
6437 is the recommended Unicode-aware way of saying
6441 U8* uvuni_to_utf8_flags(U8 *d, UV uv, UV flags)
6444 Found in file utf8.c
6449 =head1 Variables created by C<xsubpp> and C<xsubpp> internal functions
6456 Variable which is setup by C<xsubpp> to indicate the stack base offset,
6457 used by the C<ST>, C<XSprePUSH> and C<XSRETURN> macros. The C<dMARK> macro
6458 must be called prior to setup the C<MARK> variable.
6463 Found in file XSUB.h
6468 Variable which is setup by C<xsubpp> to indicate the
6469 class name for a C++ XS constructor. This is always a C<char*>. See C<THIS>.
6474 Found in file XSUB.h
6479 Sets up the C<ax> variable.
6480 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
6485 Found in file XSUB.h
6490 Sets up the C<ax> variable and stack marker variable C<mark>.
6491 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
6496 Found in file XSUB.h
6501 Sets up the C<items> variable.
6502 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
6507 Found in file XSUB.h
6512 Sets up the C<padoff_du> variable for an XSUB that wishes to use
6518 Found in file XSUB.h
6523 Sets up stack and mark pointers for an XSUB, calling dSP and dMARK.
6524 Sets up the C<ax> and C<items> variables by calling C<dAX> and C<dITEMS>.
6525 This is usually handled automatically by C<xsubpp>.
6530 Found in file XSUB.h
6535 Sets up the C<ix> variable for an XSUB which has aliases. This is usually
6536 handled automatically by C<xsubpp>.
6541 Found in file XSUB.h
6546 Variable which is setup by C<xsubpp> to indicate the number of
6547 items on the stack. See L<perlxs/"Variable-length Parameter Lists">.
6552 Found in file XSUB.h
6557 Variable which is setup by C<xsubpp> to indicate which of an
6558 XSUB's aliases was used to invoke it. See L<perlxs/"The ALIAS: Keyword">.
6563 Found in file XSUB.h
6568 Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
6572 Found in file XSUB.h
6577 Variable which is setup by C<xsubpp> to hold the return value for an
6578 XSUB. This is always the proper type for the XSUB. See
6579 L<perlxs/"The RETVAL Variable">.
6584 Found in file XSUB.h
6589 Used to access elements on the XSUB's stack.
6594 Found in file XSUB.h
6599 Variable which is setup by C<xsubpp> to designate the object in a C++
6600 XSUB. This is always the proper type for the C++ object. See C<CLASS> and
6601 L<perlxs/"Using XS With C++">.
6606 Found in file XSUB.h
6611 The SV* corresponding to the $_ variable. Works even if there
6612 is a lexical $_ in scope.
6615 Found in file XSUB.h
6620 Macro to declare an XSUB and its C parameter list. This is handled by
6624 Found in file XSUB.h
6629 The version identifier for an XS module. This is usually
6630 handled automatically by C<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>.
6633 Found in file XSUB.h
6635 =item XS_VERSION_BOOTCHECK
6636 X<XS_VERSION_BOOTCHECK>
6638 Macro to verify that a PM module's $VERSION variable matches the XS
6639 module's C<XS_VERSION> variable. This is usually handled automatically by
6640 C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">.
6642 XS_VERSION_BOOTCHECK;
6645 Found in file XSUB.h
6650 =head1 Warning and Dieing
6657 This is the XSUB-writer's interface to Perl's C<die> function.
6658 Normally call this function the same way you call the C C<printf>
6659 function. Calling C<croak> returns control directly to Perl,
6660 sidestepping the normal C order of execution. See C<warn>.
6662 If you want to throw an exception object, assign the object to
6663 C<$@> and then pass C<NULL> to croak():
6665 errsv = get_sv("@", TRUE);
6666 sv_setsv(errsv, exception_object);
6669 void croak(const char* pat, ...)
6672 Found in file util.c
6677 This is the XSUB-writer's interface to Perl's C<warn> function. Call this
6678 function the same way you call the C C<printf> function. See C<croak>.
6680 void warn(const char* pat, ...)
6683 Found in file util.c
6690 Until May 1997, this document was maintained by Jeff Okamoto
6691 <okamoto@corp.hp.com>. It is now maintained as part of Perl itself.
6693 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
6694 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
6695 Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
6696 Stephen McCamant, and Gurusamy Sarathy.
6698 API Listing originally by Dean Roehrich <roehrich@cray.com>.
6700 Updated to be autogenerated from comments in the source by Benjamin Stuhl.
6704 perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
projects / p5sagit/p5-mst-13.2.git / blob