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). However, if the
2253 C<vsnprintf> is not available, will unfortunately use the unsafe
2254 C<vsprintf> which can overrun the buffer (there is an overrun check,
2255 but that may be too late). Consider using C<sv_vcatpvf> instead, or
2256 getting C<vsnprintf>.
2258 int my_snprintf(char *buffer, const Size_t len, const char *format, ...)
2261 Found in file util.c
2266 The C library C<sprintf>, wrapped if necessary, to ensure that it will return
2267 the length of the string written to the buffer. Only rare pre-ANSI systems
2268 need the wrapper function - usually this is a direct call to C<sprintf>.
2270 int my_sprintf(char *buffer, const char *pat, ...)
2273 Found in file util.c
2278 The C library C<vsnprintf> if available and standards-compliant.
2279 However, if if the C<vsnprintf> is not available, will unfortunately
2280 use the unsafe C<vsprintf> which can overrun the buffer (there is an
2281 overrun check, but that may be too late). Consider using
2282 C<sv_vcatpvf> instead, or getting C<vsnprintf>.
2284 int my_vsnprintf(char *buffer, const Size_t len, const char *format, va_list ap)
2287 Found in file util.c
2292 Returns a new version object based on the passed in SV:
2294 SV *sv = new_version(SV *ver);
2296 Does not alter the passed in ver SV. See "upg_version" if you
2297 want to upgrade the SV.
2299 SV* new_version(SV *ver)
2302 Found in file util.c
2307 Returns a pointer to the next character after the parsed
2308 version string, as well as upgrading the passed in SV to
2311 Function must be called with an already existing SV like
2314 s = scan_version(s,SV *sv, bool qv);
2316 Performs some preprocessing to the string to ensure that
2317 it has the correct characteristics of a version. Flags the
2318 object if it contains an underscore (which denotes this
2319 is a alpha version). The boolean qv denotes that the version
2320 should be interpreted as if it had multiple decimals, even if
2323 const char* scan_version(const char *vstr, SV *sv, bool qv)
2326 Found in file util.c
2331 Test two strings to see if they are equal. Returns true or false.
2333 bool strEQ(char* s1, char* s2)
2336 Found in file handy.h
2341 Test two strings to see if the first, C<s1>, is greater than or equal to
2342 the second, C<s2>. Returns true or false.
2344 bool strGE(char* s1, char* s2)
2347 Found in file handy.h
2352 Test two strings to see if the first, C<s1>, is greater than the second,
2353 C<s2>. Returns true or false.
2355 bool strGT(char* s1, char* s2)
2358 Found in file handy.h
2363 Test two strings to see if the first, C<s1>, is less than or equal to the
2364 second, C<s2>. Returns true or false.
2366 bool strLE(char* s1, char* s2)
2369 Found in file handy.h
2374 Test two strings to see if the first, C<s1>, is less than the second,
2375 C<s2>. Returns true or false.
2377 bool strLT(char* s1, char* s2)
2380 Found in file handy.h
2385 Test two strings to see if they are different. Returns true or
2388 bool strNE(char* s1, char* s2)
2391 Found in file handy.h
2396 Test two strings to see if they are equal. The C<len> parameter indicates
2397 the number of bytes to compare. Returns true or false. (A wrapper for
2400 bool strnEQ(char* s1, char* s2, STRLEN len)
2403 Found in file handy.h
2408 Test two strings to see if they are different. The C<len> parameter
2409 indicates the number of bytes to compare. Returns true or false. (A
2410 wrapper for C<strncmp>).
2412 bool strnNE(char* s1, char* s2, STRLEN len)
2415 Found in file handy.h
2420 Dummy routine which "shares" an SV when there is no sharing module present.
2421 Or "locks" it. Or "unlocks" it. In other words, ignores its single SV argument.
2422 Exists to avoid test for a NULL function pointer and because it could
2423 potentially warn under some level of strict-ness.
2425 void sv_nosharing(SV *sv)
2428 Found in file util.c
2433 In-place upgrade of the supplied SV to a version object.
2435 SV *sv = upg_version(SV *sv);
2437 Returns a pointer to the upgraded SV.
2439 SV* upg_version(SV *ver)
2442 Found in file util.c
2447 Version object aware cmp. Both operands must already have been
2448 converted into version objects.
2450 int vcmp(SV *lvs, SV *rvs)
2453 Found in file util.c
2458 Accepts a version object and returns the normalized string
2459 representation. Call like:
2463 NOTE: you can pass either the object directly or the SV
2464 contained within the RV.
2469 Found in file util.c
2474 Accepts a version object and returns the normalized floating
2475 point representation. Call like:
2479 NOTE: you can pass either the object directly or the SV
2480 contained within the RV.
2485 Found in file util.c
2490 In order to maintain maximum compatibility with earlier versions
2491 of Perl, this function will return either the floating point
2492 notation or the multiple dotted notation, depending on whether
2493 the original version contained 1 or more dots, respectively
2495 SV* vstringify(SV *vs)
2498 Found in file util.c
2503 Validates that the SV contains a valid version object.
2505 bool vverify(SV *vobj);
2507 Note that it only confirms the bare minimum structure (so as not to get
2508 confused by derived classes which may contain additional hash entries):
2510 bool vverify(SV *vs)
2513 Found in file util.c
2518 =head1 Multicall Functions
2525 Declare local variables for a multicall. See L<perlcall/Lightweight Callbacks>.
2535 Make a lightweight callback. See L<perlcall/Lightweight Callbacks>.
2545 Closing bracket for a lightweight callback.
2546 See L<perlcall/Lightweight Callbacks>.
2553 =item PUSH_MULTICALL
2556 Opening bracket for a lightweight callback.
2557 See L<perlcall/Lightweight Callbacks>.
2567 =head1 Numeric functions
2574 converts a string representing a binary number to numeric form.
2576 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2577 conversion flags, and I<result> should be NULL or a pointer to an NV.
2578 The scan stops at the end of the string, or the first invalid character.
2579 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2580 invalid character will also trigger a warning.
2581 On return I<*len> is set to the length of the scanned string,
2582 and I<*flags> gives output flags.
2584 If the value is <= C<UV_MAX> it is returned as a UV, the output flags are clear,
2585 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_bin>
2586 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2587 and writes the value to I<*result> (or the value is discarded if I<result>
2590 The binary number may optionally be prefixed with "0b" or "b" unless
2591 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
2592 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the binary
2593 number may use '_' characters to separate digits.
2595 UV grok_bin(const char* start, STRLEN* len_p, I32* flags, NV *result)
2598 Found in file numeric.c
2603 converts a string representing a hex number to numeric form.
2605 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2606 conversion flags, and I<result> should be NULL or a pointer to an NV.
2607 The scan stops at the end of the string, or the first invalid character.
2608 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2609 invalid character will also trigger a warning.
2610 On return I<*len> is set to the length of the scanned string,
2611 and I<*flags> gives output flags.
2613 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2614 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_hex>
2615 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2616 and writes the value to I<*result> (or the value is discarded if I<result>
2619 The hex number may optionally be prefixed with "0x" or "x" unless
2620 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
2621 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the hex
2622 number may use '_' characters to separate digits.
2624 UV grok_hex(const char* start, STRLEN* len_p, I32* flags, NV *result)
2627 Found in file numeric.c
2632 Recognise (or not) a number. The type of the number is returned
2633 (0 if unrecognised), otherwise it is a bit-ORed combination of
2634 IS_NUMBER_IN_UV, IS_NUMBER_GREATER_THAN_UV_MAX, IS_NUMBER_NOT_INT,
2635 IS_NUMBER_NEG, IS_NUMBER_INFINITY, IS_NUMBER_NAN (defined in perl.h).
2637 If the value of the number can fit an in UV, it is returned in the *valuep
2638 IS_NUMBER_IN_UV will be set to indicate that *valuep is valid, IS_NUMBER_IN_UV
2639 will never be set unless *valuep is valid, but *valuep may have been assigned
2640 to during processing even though IS_NUMBER_IN_UV is not set on return.
2641 If valuep is NULL, IS_NUMBER_IN_UV will be set for the same cases as when
2642 valuep is non-NULL, but no actual assignment (or SEGV) will occur.
2644 IS_NUMBER_NOT_INT will be set with IS_NUMBER_IN_UV if trailing decimals were
2645 seen (in which case *valuep gives the true value truncated to an integer), and
2646 IS_NUMBER_NEG if the number is negative (in which case *valuep holds the
2647 absolute value). IS_NUMBER_IN_UV is not set if e notation was used or the
2648 number is larger than a UV.
2650 int grok_number(const char *pv, STRLEN len, UV *valuep)
2653 Found in file numeric.c
2655 =item grok_numeric_radix
2656 X<grok_numeric_radix>
2658 Scan and skip for a numeric decimal separator (radix).
2660 bool grok_numeric_radix(const char **sp, const char *send)
2663 Found in file numeric.c
2668 converts a string representing an octal number to numeric form.
2670 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2671 conversion flags, and I<result> should be NULL or a pointer to an NV.
2672 The scan stops at the end of the string, or the first invalid character.
2673 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2674 invalid character will also trigger a warning.
2675 On return I<*len> is set to the length of the scanned string,
2676 and I<*flags> gives output flags.
2678 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2679 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_oct>
2680 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2681 and writes the value to I<*result> (or the value is discarded if I<result>
2684 If C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the octal
2685 number may use '_' characters to separate digits.
2687 UV grok_oct(const char* start, STRLEN* len_p, I32* flags, NV *result)
2690 Found in file numeric.c
2695 For backwards compatibility. Use C<grok_bin> instead.
2697 NV scan_bin(const char* start, STRLEN len, STRLEN* retlen)
2700 Found in file numeric.c
2705 For backwards compatibility. Use C<grok_hex> instead.
2707 NV scan_hex(const char* start, STRLEN len, STRLEN* retlen)
2710 Found in file numeric.c
2715 For backwards compatibility. Use C<grok_oct> instead.
2717 NV scan_oct(const char* start, STRLEN len, STRLEN* retlen)
2720 Found in file numeric.c
2725 =head1 Optree Manipulation Functions
2732 If C<cv> is a constant sub eligible for inlining. returns the constant
2733 value returned by the sub. Otherwise, returns NULL.
2735 Constant subs can be created with C<newCONSTSUB> or as described in
2736 L<perlsub/"Constant Functions">.
2738 SV* cv_const_sv(CV* cv)
2746 Creates a constant sub equivalent to Perl C<sub FOO () { 123 }> which is
2747 eligible for inlining at compile-time.
2749 CV* newCONSTSUB(HV* stash, const char* name, SV* sv)
2757 Used by C<xsubpp> to hook up XSUBs as Perl subs. I<filename> needs to be
2758 static storage, as it is used directly as CvFILE(), without a copy being made.
2766 =head1 Pad Data Structures
2773 Get the value at offset po in the current pad.
2774 Use macro PAD_SV instead of calling this function directly.
2776 SV* pad_sv(PADOFFSET po)
2784 =head1 Simple Exception Handling Macros
2791 Set up necessary local variables for exception handling.
2792 See L<perlguts/"Exception Handling">.
2797 Found in file XSUB.h
2802 Introduces a catch block. See L<perlguts/"Exception Handling">.
2805 Found in file XSUB.h
2810 Rethrows a previously caught exception. See L<perlguts/"Exception Handling">.
2815 Found in file XSUB.h
2820 Ends a try block. See L<perlguts/"Exception Handling">.
2823 Found in file XSUB.h
2825 =item XCPT_TRY_START
2828 Starts a try block. See L<perlguts/"Exception Handling">.
2831 Found in file XSUB.h
2836 =head1 Stack Manipulation Macros
2843 Declare a stack marker variable, C<mark>, for the XSUB. See C<MARK> and
2854 Saves the original stack mark for the XSUB. See C<ORIGMARK>.
2864 Declares a local copy of perl's stack pointer for the XSUB, available via
2865 the C<SP> macro. See C<SP>.
2875 Used to extend the argument stack for an XSUB's return values. Once
2876 used, guarantees that there is room for at least C<nitems> to be pushed
2879 void EXTEND(SP, int nitems)
2887 Stack marker variable for the XSUB. See C<dMARK>.
2895 Push an integer onto the stack. The stack must have room for this element.
2896 Handles 'set' magic. Does not use C<TARG>. See also C<PUSHi>, C<mXPUSHi>
2907 Push a double onto the stack. The stack must have room for this element.
2908 Handles 'set' magic. Does not use C<TARG>. See also C<PUSHn>, C<mXPUSHn>
2919 Push a string onto the stack. The stack must have room for this element.
2920 The C<len> indicates the length of the string. Handles 'set' magic. Does
2921 not use C<TARG>. See also C<PUSHp>, C<mXPUSHp> and C<XPUSHp>.
2923 void mPUSHp(char* str, STRLEN len)
2931 Push an unsigned integer onto the stack. The stack must have room for this
2932 element. Handles 'set' magic. Does not use C<TARG>. See also C<PUSHu>,
2933 C<mXPUSHu> and C<XPUSHu>.
2943 Push an integer onto the stack, extending the stack if necessary. Handles
2944 'set' magic. Does not use C<TARG>. See also C<XPUSHi>, C<mPUSHi> and
2955 Push a double onto the stack, extending the stack if necessary. Handles
2956 'set' magic. Does not use C<TARG>. See also C<XPUSHn>, C<mPUSHn> and
2967 Push a string onto the stack, extending the stack if necessary. The C<len>
2968 indicates the length of the string. Handles 'set' magic. Does not use
2969 C<TARG>. See also C<XPUSHp>, C<mPUSHp> and C<PUSHp>.
2971 void mXPUSHp(char* str, STRLEN len)
2979 Push an unsigned integer onto the stack, extending the stack if necessary.
2980 Handles 'set' magic. Does not use C<TARG>. See also C<XPUSHu>, C<mPUSHu>
2991 The original stack mark for the XSUB. See C<dORIGMARK>.
2999 Pops an integer off the stack.
3009 Pops a long off the stack.
3019 Pops a double off the stack.
3029 Pops a string off the stack. Deprecated. New code should use POPpx.
3039 Pops a string off the stack which must consist of bytes i.e. characters < 256.
3049 Pops a string off the stack.
3059 Pops an SV off the stack.
3069 Push an integer onto the stack. The stack must have room for this element.
3070 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3071 called to declare it. Do not call multiple C<TARG>-oriented macros to
3072 return lists from XSUB's - see C<mPUSHi> instead. See also C<XPUSHi> and
3083 Opening bracket for arguments on a callback. See C<PUTBACK> and
3094 Push a new mortal SV onto the stack. The stack must have room for this
3095 element. Does not handle 'set' magic. Does not use C<TARG>. See also
3096 C<PUSHs>, C<XPUSHmortal> and C<XPUSHs>.
3106 Push a double onto the stack. The stack must have room for this element.
3107 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3108 called to declare it. Do not call multiple C<TARG>-oriented macros to
3109 return lists from XSUB's - see C<mPUSHn> instead. See also C<XPUSHn> and
3120 Push a string onto the stack. The stack must have room for this element.
3121 The C<len> indicates the length of the string. Handles 'set' magic. Uses
3122 C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to declare it. Do not
3123 call multiple C<TARG>-oriented macros to return lists from XSUB's - see
3124 C<mPUSHp> instead. See also C<XPUSHp> and C<mXPUSHp>.
3126 void PUSHp(char* str, STRLEN len)
3134 Push an SV onto the stack. The stack must have room for this element.
3135 Does not handle 'set' magic. Does not use C<TARG>. See also C<PUSHmortal>,
3136 C<XPUSHs> and C<XPUSHmortal>.
3146 Push an unsigned integer onto the stack. The stack must have room for this
3147 element. Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG>
3148 should be called to declare it. Do not call multiple C<TARG>-oriented
3149 macros to return lists from XSUB's - see C<mPUSHu> instead. See also
3150 C<XPUSHu> and C<mXPUSHu>.
3160 Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
3161 See C<PUSHMARK> and L<perlcall> for other uses.
3171 Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and
3180 Refetch the stack pointer. Used after a callback. See L<perlcall>.
3190 Push an integer onto the stack, extending the stack if necessary. Handles
3191 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
3192 declare it. Do not call multiple C<TARG>-oriented macros to return lists
3193 from XSUB's - see C<mXPUSHi> instead. See also C<PUSHi> and C<mPUSHi>.
3203 Push a new mortal SV onto the stack, extending the stack if necessary. Does
3204 not handle 'set' magic. Does not use C<TARG>. See also C<XPUSHs>,
3205 C<PUSHmortal> and C<PUSHs>.
3215 Push a double onto the stack, extending the stack if necessary. Handles
3216 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
3217 declare it. Do not call multiple C<TARG>-oriented macros to return lists
3218 from XSUB's - see C<mXPUSHn> instead. See also C<PUSHn> and C<mPUSHn>.
3228 Push a string onto the stack, extending the stack if necessary. The C<len>
3229 indicates the length of the string. Handles 'set' magic. Uses C<TARG>, so
3230 C<dTARGET> or C<dXSTARG> should be called to declare it. Do not call
3231 multiple C<TARG>-oriented macros to return lists from XSUB's - see
3232 C<mXPUSHp> instead. See also C<PUSHp> and C<mPUSHp>.
3234 void XPUSHp(char* str, STRLEN len)
3242 Push an SV onto the stack, extending the stack if necessary. Does not
3243 handle 'set' magic. Does not use C<TARG>. See also C<XPUSHmortal>,
3244 C<PUSHs> and C<PUSHmortal>.
3254 Push an unsigned integer onto the stack, extending the stack if necessary.
3255 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3256 called to declare it. Do not call multiple C<TARG>-oriented macros to
3257 return lists from XSUB's - see C<mXPUSHu> instead. See also C<PUSHu> and
3268 Return from XSUB, indicating number of items on the stack. This is usually
3269 handled by C<xsubpp>.
3271 void XSRETURN(int nitems)
3274 Found in file XSUB.h
3276 =item XSRETURN_EMPTY
3279 Return an empty list from an XSUB immediately.
3284 Found in file XSUB.h
3289 Return an integer from an XSUB immediately. Uses C<XST_mIV>.
3291 void XSRETURN_IV(IV iv)
3294 Found in file XSUB.h
3299 Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
3304 Found in file XSUB.h
3309 Return a double from an XSUB immediately. Uses C<XST_mNV>.
3311 void XSRETURN_NV(NV nv)
3314 Found in file XSUB.h
3319 Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
3321 void XSRETURN_PV(char* str)
3324 Found in file XSUB.h
3326 =item XSRETURN_UNDEF
3329 Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
3334 Found in file XSUB.h
3339 Return an integer from an XSUB immediately. Uses C<XST_mUV>.
3341 void XSRETURN_UV(IV uv)
3344 Found in file XSUB.h
3349 Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
3354 Found in file XSUB.h
3359 Place an integer into the specified position C<pos> on the stack. The
3360 value is stored in a new mortal SV.
3362 void XST_mIV(int pos, IV iv)
3365 Found in file XSUB.h
3370 Place C<&PL_sv_no> into the specified position C<pos> on the
3373 void XST_mNO(int pos)
3376 Found in file XSUB.h
3381 Place a double into the specified position C<pos> on the stack. The value
3382 is stored in a new mortal SV.
3384 void XST_mNV(int pos, NV nv)
3387 Found in file XSUB.h
3392 Place a copy of a string into the specified position C<pos> on the stack.
3393 The value is stored in a new mortal SV.
3395 void XST_mPV(int pos, char* str)
3398 Found in file XSUB.h
3403 Place C<&PL_sv_undef> into the specified position C<pos> on the
3406 void XST_mUNDEF(int pos)
3409 Found in file XSUB.h
3414 Place C<&PL_sv_yes> into the specified position C<pos> on the
3417 void XST_mYES(int pos)
3420 Found in file XSUB.h
3432 An enum of flags for Perl types. These are found in the file B<sv.h>
3433 in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
3441 Integer type flag for scalars. See C<svtype>.
3449 Double type flag for scalars. See C<svtype>.
3457 Pointer type flag for scalars. See C<svtype>.
3465 Type flag for arrays. See C<svtype>.
3473 Type flag for code refs. See C<svtype>.
3481 Type flag for hashes. See C<svtype>.
3489 Type flag for blessed scalars. See C<svtype>.
3497 =head1 SV Manipulation Functions
3504 Returns the SV of the specified Perl scalar. If C<create> is set and the
3505 Perl variable does not exist then it will be created. If C<create> is not
3506 set and the variable does not exist then NULL is returned.
3508 NOTE: the perl_ form of this function is deprecated.
3510 SV* get_sv(const char* name, I32 create)
3513 Found in file perl.c
3518 Creates an RV wrapper for an SV. The reference count for the original SV is
3521 SV* newRV_inc(SV* sv)
3529 Returns the length of the string which is in the SV. See C<SvLEN>.
3531 STRLEN SvCUR(SV* sv)
3539 Set the current length of the string which is in the SV. See C<SvCUR>
3542 void SvCUR_set(SV* sv, STRLEN len)
3550 Returns a pointer to the last character in the string which is in the SV.
3551 See C<SvCUR>. Access the character as *(SvEND(sv)).
3561 Returns true if the SV has get magic or overloading. If either is true then
3562 the scalar is active data, and has the potential to return a new value every
3563 time it is accessed. Hence you must be careful to only read it once per user
3564 logical operation and work with that returned value. If neither is true then
3565 the scalar's value cannot change unless written to.
3567 char* SvGAMAGIC(SV* sv)
3575 Expands the character buffer in the SV so that it has room for the
3576 indicated number of bytes (remember to reserve space for an extra trailing
3577 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
3578 Returns a pointer to the character buffer.
3580 char * SvGROW(SV* sv, STRLEN len)
3588 Returns a boolean indicating whether the SV contains an integer.
3598 Returns a boolean indicating whether the SV contains an integer. Checks
3599 the B<private> setting. Use C<SvIOK>.
3609 Returns a boolean indicating whether the SV contains a signed integer.
3611 bool SvIOK_notUV(SV* sv)
3619 Unsets the IV status of an SV.
3621 void SvIOK_off(SV* sv)
3629 Tells an SV that it is an integer.
3631 void SvIOK_on(SV* sv)
3639 Tells an SV that it is an integer and disables all other OK bits.
3641 void SvIOK_only(SV* sv)
3649 Tells and SV that it is an unsigned integer and disables all other OK bits.
3651 void SvIOK_only_UV(SV* sv)
3659 Returns a boolean indicating whether the SV contains an unsigned integer.
3661 bool SvIOK_UV(SV* sv)
3669 Returns a boolean indicating whether the SV is Copy-On-Write. (either shared
3670 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
3673 bool SvIsCOW(SV* sv)
3678 =item SvIsCOW_shared_hash
3679 X<SvIsCOW_shared_hash>
3681 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
3684 bool SvIsCOW_shared_hash(SV* sv)
3692 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
3693 version which guarantees to evaluate sv only once.
3703 Returns the raw value in the SV's IV slot, without checks or conversions.
3704 Only use when you are sure SvIOK is true. See also C<SvIV()>.
3714 Coerces the given SV to an integer and returns it. Guarantees to evaluate
3715 sv only once. Use the more efficient C<SvIV> otherwise.
3725 Like C<SvIV> but doesn't process magic.
3727 IV SvIV_nomg(SV* sv)
3735 Set the value of the IV pointer in sv to val. It is possible to perform
3736 the same function of this macro with an lvalue assignment to C<SvIVX>.
3737 With future Perls, however, it will be more efficient to use
3738 C<SvIV_set> instead of the lvalue assignment to C<SvIVX>.
3740 void SvIV_set(SV* sv, IV val)
3748 Returns the size of the string buffer in the SV, not including any part
3749 attributable to C<SvOOK>. See C<SvCUR>.
3751 STRLEN SvLEN(SV* sv)
3759 Set the actual length of the string which is in the SV. See C<SvIV_set>.
3761 void SvLEN_set(SV* sv, STRLEN len)
3769 Set the value of the MAGIC pointer in sv to val. See C<SvIV_set>.
3771 void SvMAGIC_set(SV* sv, MAGIC* val)
3779 Returns a boolean indicating whether the SV contains a number, integer or
3790 Returns a boolean indicating whether the SV contains a number, integer or
3791 double. Checks the B<private> setting. Use C<SvNIOK>.
3793 bool SvNIOKp(SV* sv)
3801 Unsets the NV/IV status of an SV.
3803 void SvNIOK_off(SV* sv)
3811 Returns a boolean indicating whether the SV contains a double.
3821 Returns a boolean indicating whether the SV contains a double. Checks the
3822 B<private> setting. Use C<SvNOK>.
3832 Unsets the NV status of an SV.
3834 void SvNOK_off(SV* sv)
3842 Tells an SV that it is a double.
3844 void SvNOK_on(SV* sv)
3852 Tells an SV that it is a double and disables all other OK bits.
3854 void SvNOK_only(SV* sv)
3862 Coerce the given SV to a double and return it. See C<SvNVx> for a version
3863 which guarantees to evaluate sv only once.
3873 Returns the raw value in the SV's NV slot, without checks or conversions.
3874 Only use when you are sure SvNOK is true. See also C<SvNV()>.
3884 Coerces the given SV to a double and returns it. Guarantees to evaluate
3885 sv only once. Use the more efficient C<SvNV> otherwise.
3895 Set the value of the NV pointer in sv to val. See C<SvIV_set>.
3897 void SvNV_set(SV* sv, NV val)
3905 Returns a boolean indicating whether the value is an SV. It also tells
3906 whether the value is defined or not.
3916 Returns a boolean indicating whether the SvIVX is a valid offset value for
3917 the SvPVX. This hack is used internally to speed up removal of characters
3918 from the beginning of a SvPV. When SvOOK is true, then the start of the
3919 allocated string buffer is really (SvPVX - SvIVX).
3929 Returns a boolean indicating whether the SV contains a character
3940 Returns a boolean indicating whether the SV contains a character string.
3941 Checks the B<private> setting. Use C<SvPOK>.
3951 Unsets the PV status of an SV.
3953 void SvPOK_off(SV* sv)
3961 Tells an SV that it is a string.
3963 void SvPOK_on(SV* sv)
3971 Tells an SV that it is a string and disables all other OK bits.
3972 Will also turn off the UTF-8 status.
3974 void SvPOK_only(SV* sv)
3979 =item SvPOK_only_UTF8
3982 Tells an SV that it is a string and disables all other OK bits,
3983 and leaves the UTF-8 status as it was.
3985 void SvPOK_only_UTF8(SV* sv)
3993 Returns a pointer to the string in the SV, or a stringified form of
3994 the SV if the SV does not contain a string. The SV may cache the
3995 stringified version becoming C<SvPOK>. Handles 'get' magic. See also
3996 C<SvPVx> for a version which guarantees to evaluate sv only once.
3998 char* SvPV(SV* sv, STRLEN len)
4006 Like C<SvPV>, but converts sv to byte representation first if necessary.
4008 char* SvPVbyte(SV* sv, STRLEN len)
4016 Like C<SvPV>, but converts sv to byte representation first if necessary.
4017 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
4020 char* SvPVbytex(SV* sv, STRLEN len)
4025 =item SvPVbytex_force
4028 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
4029 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
4032 char* SvPVbytex_force(SV* sv, STRLEN len)
4037 =item SvPVbyte_force
4040 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
4042 char* SvPVbyte_force(SV* sv, STRLEN len)
4047 =item SvPVbyte_nolen
4050 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
4052 char* SvPVbyte_nolen(SV* sv)
4060 Like C<SvPV>, but converts sv to utf8 first if necessary.
4062 char* SvPVutf8(SV* sv, STRLEN len)
4070 Like C<SvPV>, but converts sv to utf8 first if necessary.
4071 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
4074 char* SvPVutf8x(SV* sv, STRLEN len)
4079 =item SvPVutf8x_force
4082 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
4083 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
4086 char* SvPVutf8x_force(SV* sv, STRLEN len)
4091 =item SvPVutf8_force
4094 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
4096 char* SvPVutf8_force(SV* sv, STRLEN len)
4101 =item SvPVutf8_nolen
4104 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
4106 char* SvPVutf8_nolen(SV* sv)
4114 Returns a pointer to the physical string in the SV. The SV must contain a
4125 A version of C<SvPV> which guarantees to evaluate sv only once.
4127 char* SvPVx(SV* sv, STRLEN len)
4135 Like C<SvPV> but will force the SV into containing just a string
4136 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
4139 char* SvPV_force(SV* sv, STRLEN len)
4144 =item SvPV_force_nomg
4147 Like C<SvPV> but will force the SV into containing just a string
4148 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
4149 directly. Doesn't process magic.
4151 char* SvPV_force_nomg(SV* sv, STRLEN len)
4159 Returns a pointer to the string in the SV, or a stringified form of
4160 the SV if the SV does not contain a string. The SV may cache the
4161 stringified form becoming C<SvPOK>. Handles 'get' magic.
4163 char* SvPV_nolen(SV* sv)
4171 Like C<SvPV> but doesn't process magic.
4173 char* SvPV_nomg(SV* sv, STRLEN len)
4181 Set the value of the PV pointer in sv to val. See C<SvIV_set>.
4183 void SvPV_set(SV* sv, char* val)
4191 Returns the value of the object's reference count.
4193 U32 SvREFCNT(SV* sv)
4201 Decrements the reference count of the given SV.
4203 void SvREFCNT_dec(SV* sv)
4211 Increments the reference count of the given SV.
4213 SV* SvREFCNT_inc(SV* sv)
4218 =item SvREFCNT_inc_NN
4221 Same as SvREFCNT_inc, but can only be used if you know I<sv>
4222 is not NULL. Since we don't have to check the NULLness, it's faster
4225 SV* SvREFCNT_inc_NN(SV* sv)
4230 =item SvREFCNT_inc_simple
4231 X<SvREFCNT_inc_simple>
4233 Same as SvREFCNT_inc, but can only be used with simple variables, not
4234 expressions or pointer dereferences. Since we don't have to store a
4235 temporary value, it's faster.
4237 SV* SvREFCNT_inc_simple(SV* sv)
4242 =item SvREFCNT_inc_simple_NN
4243 X<SvREFCNT_inc_simple_NN>
4245 Same as SvREFCNT_inc_simple, but can only be used if you know I<sv>
4246 is not NULL. Since we don't have to check the NULLness, it's faster
4249 SV* SvREFCNT_inc_simple_NN(SV* sv)
4254 =item SvREFCNT_inc_simple_void
4255 X<SvREFCNT_inc_simple_void>
4257 Same as SvREFCNT_inc_simple, but can only be used if you don't need the
4258 return value. The macro doesn't need to return a meaningful value.
4260 SV* SvREFCNT_inc_simple_void(SV* sv)
4265 =item SvREFCNT_inc_void
4266 X<SvREFCNT_inc_void>
4268 Same as SvREFCNT_inc, but can only be used if you don't need the
4269 return value. The macro doesn't need to return a meaningful value.
4271 SV* SvREFCNT_inc_void(SV* sv)
4276 =item SvREFCNT_inc_void_NN
4277 X<SvREFCNT_inc_void_NN>
4279 Same as SvREFCNT_inc, but can only be used if you don't need the return
4280 value, and you know that I<sv> is not NULL. The macro doesn't need
4281 to return a meaningful value, or check for NULLness, so it's smaller
4284 SV* SvREFCNT_inc_void_NN(SV* sv)
4292 Tests if the SV is an RV.
4302 Unsets the RV status of an SV.
4304 void SvROK_off(SV* sv)
4312 Tells an SV that it is an RV.
4314 void SvROK_on(SV* sv)
4322 Dereferences an RV to return the SV.
4332 Set the value of the RV pointer in sv to val. See C<SvIV_set>.
4334 void SvRV_set(SV* sv, SV* val)
4342 Returns the stash of the SV.
4352 Set the value of the STASH pointer in sv to val. See C<SvIV_set>.
4354 void SvSTASH_set(SV* sv, STASH* val)
4362 Taints an SV if tainting is enabled.
4364 void SvTAINT(SV* sv)
4372 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
4375 bool SvTAINTED(SV* sv)
4383 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
4384 some of Perl's fundamental security features. XS module authors should not
4385 use this function unless they fully understand all the implications of
4386 unconditionally untainting the value. Untainting should be done in the
4387 standard perl fashion, via a carefully crafted regexp, rather than directly
4388 untainting variables.
4390 void SvTAINTED_off(SV* sv)
4398 Marks an SV as tainted if tainting is enabled.
4400 void SvTAINTED_on(SV* sv)
4408 Returns a boolean indicating whether Perl would evaluate the SV as true or
4409 false, defined or undefined. Does not handle 'get' magic.
4419 Returns the type of the SV. See C<svtype>.
4421 svtype SvTYPE(SV* sv)
4429 Returns a boolean indicating whether the SV contains an unsigned integer.
4439 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
4440 perform the upgrade if necessary. See C<svtype>.
4442 void SvUPGRADE(SV* sv, svtype type)
4450 Returns a boolean indicating whether the SV contains UTF-8 encoded data.
4460 Unsets the UTF-8 status of an SV.
4462 void SvUTF8_off(SV *sv)
4470 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
4471 Do not use frivolously.
4473 void SvUTF8_on(SV *sv)
4481 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
4482 for a version which guarantees to evaluate sv only once.
4492 Returns the raw value in the SV's UV slot, without checks or conversions.
4493 Only use when you are sure SvIOK is true. See also C<SvUV()>.
4503 Coerces the given SV to an unsigned integer and returns it. Guarantees to
4504 evaluate sv only once. Use the more efficient C<SvUV> otherwise.
4514 Like C<SvUV> but doesn't process magic.
4516 UV SvUV_nomg(SV* sv)
4524 Set the value of the UV pointer in sv to val. See C<SvIV_set>.
4526 void SvUV_set(SV* sv, UV val)
4534 Returns a boolean indicating whether the SV contains a v-string.
4541 =item sv_catpvn_nomg
4544 Like C<sv_catpvn> but doesn't process magic.
4546 void sv_catpvn_nomg(SV* sv, const char* ptr, STRLEN len)
4554 Like C<sv_catsv> but doesn't process magic.
4556 void sv_catsv_nomg(SV* dsv, SV* ssv)
4561 =item sv_derived_from
4564 Returns a boolean indicating whether the SV is derived from the specified class
4565 I<at the C level>. To check derivation at the Perl level, call C<isa()> as a
4568 bool sv_derived_from(SV* sv, const char* name)
4571 Found in file universal.c
4573 =item sv_report_used
4576 Dump the contents of all SVs not yet freed. (Debugging aid).
4578 void sv_report_used()
4586 Like C<sv_setsv> but doesn't process magic.
4588 void sv_setsv_nomg(SV* dsv, SV* ssv)
4596 =head1 SV-Body Allocation
4600 =item looks_like_number
4601 X<looks_like_number>
4603 Test if the content of an SV looks like a number (or is a number).
4604 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
4605 non-numeric warning), even if your atof() doesn't grok them.
4607 I32 looks_like_number(SV* sv)
4615 Creates an RV wrapper for an SV. The reference count for the original
4616 SV is B<not> incremented.
4618 SV* newRV_noinc(SV* sv)
4626 Creates a new SV. A non-zero C<len> parameter indicates the number of
4627 bytes of preallocated string space the SV should have. An extra byte for a
4628 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4629 space is allocated.) The reference count for the new SV is set to 1.
4631 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4632 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4633 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4634 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4635 modules supporting older perls.
4637 SV* newSV(STRLEN len)
4645 Creates a new SV from the hash key structure. It will generate scalars that
4646 point to the shared string table where possible. Returns a new (undefined)
4647 SV if the hek is NULL.
4649 SV* newSVhek(const HEK *hek)
4657 Creates a new SV and copies an integer into it. The reference count for the
4668 Creates a new SV and copies a floating point value into it.
4669 The reference count for the SV is set to 1.
4679 Creates a new SV and copies a string into it. The reference count for the
4680 SV is set to 1. If C<len> is zero, Perl will compute the length using
4681 strlen(). For efficiency, consider using C<newSVpvn> instead.
4683 SV* newSVpv(const char* s, STRLEN len)
4691 Creates a new SV and initializes it with the string formatted like
4694 SV* newSVpvf(const char* pat, ...)
4702 Creates a new SV and copies a string into it. The reference count for the
4703 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
4704 string. You are responsible for ensuring that the source string is at least
4705 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
4707 SV* newSVpvn(const char* s, STRLEN len)
4712 =item newSVpvn_share
4715 Creates a new SV with its SvPVX_const pointing to a shared string in the string
4716 table. If the string does not already exist in the table, it is created
4717 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
4718 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
4719 otherwise the hash is computed. The idea here is that as the string table
4720 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
4721 hash lookup will avoid string compare.
4723 SV* newSVpvn_share(const char* s, I32 len, U32 hash)
4731 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
4732 it will be upgraded to one. If C<classname> is non-null then the new SV will
4733 be blessed in the specified package. The new SV is returned and its
4734 reference count is 1.
4736 SV* newSVrv(SV* rv, const char* classname)
4744 Creates a new SV which is an exact duplicate of the original SV.
4747 SV* newSVsv(SV* old)
4755 Creates a new SV and copies an unsigned integer into it.
4756 The reference count for the SV is set to 1.
4766 This function is only called on magical items, and is only used by
4767 sv_true() or its macro equivalent.
4769 bool sv_2bool(SV* sv)
4777 Using various gambits, try to get a CV from an SV; in addition, try if
4778 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
4779 The flags in C<lref> are passed to sv_fetchsv.
4781 CV* sv_2cv(SV* sv, HV** st, GV** gvp, I32 lref)
4789 Using various gambits, try to get an IO from an SV: the IO slot if its a
4790 GV; or the recursive result if we're an RV; or the IO slot of the symbol
4791 named after the PV if we're a string.
4801 Return the integer value of an SV, doing any necessary string
4802 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
4803 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
4805 IV sv_2iv_flags(SV* sv, I32 flags)
4813 Marks an existing SV as mortal. The SV will be destroyed "soon", either
4814 by an explicit call to FREETMPS, or by an implicit call at places such as
4815 statement boundaries. SvTEMP() is turned on which means that the SV's
4816 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
4817 and C<sv_mortalcopy>.
4819 SV* sv_2mortal(SV* sv)
4827 Return the num value of an SV, doing any necessary string or integer
4828 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
4839 Return a pointer to the byte-encoded representation of the SV, and set *lp
4840 to its length. May cause the SV to be downgraded from UTF-8 as a
4843 Usually accessed via the C<SvPVbyte> macro.
4845 char* sv_2pvbyte(SV* sv, STRLEN* lp)
4853 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
4854 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
4856 Usually accessed via the C<SvPVutf8> macro.
4858 char* sv_2pvutf8(SV* sv, STRLEN* lp)
4866 Returns a pointer to the string value of an SV, and sets *lp to its length.
4867 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
4869 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
4870 usually end up here too.
4872 char* sv_2pv_flags(SV* sv, STRLEN* lp, I32 flags)
4880 Return the unsigned integer value of an SV, doing any necessary string
4881 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
4882 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
4884 UV sv_2uv_flags(SV* sv, I32 flags)
4892 Remove any string offset. You should normally use the C<SvOOK_off> macro
4895 int sv_backoff(SV* sv)
4903 Blesses an SV into a specified package. The SV must be an RV. The package
4904 must be designated by its stash (see C<gv_stashpv()>). The reference count
4905 of the SV is unaffected.
4907 SV* sv_bless(SV* sv, HV* stash)
4915 Concatenates the string onto the end of the string which is in the SV.
4916 If the SV has the UTF-8 status set, then the bytes appended should be
4917 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4919 void sv_catpv(SV* sv, const char* ptr)
4927 Processes its arguments like C<sprintf> and appends the formatted
4928 output to an SV. If the appended data contains "wide" characters
4929 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
4930 and characters >255 formatted with %c), the original SV might get
4931 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
4932 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
4933 valid UTF-8; if the original SV was bytes, the pattern should be too.
4935 void sv_catpvf(SV* sv, const char* pat, ...)
4943 Like C<sv_catpvf>, but also handles 'set' magic.
4945 void sv_catpvf_mg(SV *sv, const char* pat, ...)
4953 Concatenates the string onto the end of the string which is in the SV. The
4954 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4955 status set, then the bytes appended should be valid UTF-8.
4956 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4958 void sv_catpvn(SV* sv, const char* ptr, STRLEN len)
4963 =item sv_catpvn_flags
4966 Concatenates the string onto the end of the string which is in the SV. The
4967 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4968 status set, then the bytes appended should be valid UTF-8.
4969 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4970 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4971 in terms of this function.
4973 void sv_catpvn_flags(SV* sv, const char* ptr, STRLEN len, I32 flags)
4981 Like C<sv_catpv>, but also handles 'set' magic.
4983 void sv_catpv_mg(SV *sv, const char *ptr)
4991 Concatenates the string from SV C<ssv> onto the end of the string in
4992 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4993 not 'set' magic. See C<sv_catsv_mg>.
4995 void sv_catsv(SV* dsv, SV* ssv)
5000 =item sv_catsv_flags
5003 Concatenates the string from SV C<ssv> onto the end of the string in
5004 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
5005 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
5006 and C<sv_catsv_nomg> are implemented in terms of this function.
5008 void sv_catsv_flags(SV* dsv, SV* ssv, I32 flags)
5016 Efficient removal of characters from the beginning of the string buffer.
5017 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
5018 the string buffer. The C<ptr> becomes the first character of the adjusted
5019 string. Uses the "OOK hack".
5020 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
5021 refer to the same chunk of data.
5023 void sv_chop(SV* sv, const char* ptr)
5031 Clear an SV: call any destructors, free up any memory used by the body,
5032 and free the body itself. The SV's head is I<not> freed, although
5033 its type is set to all 1's so that it won't inadvertently be assumed
5034 to be live during global destruction etc.
5035 This function should only be called when REFCNT is zero. Most of the time
5036 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5039 void sv_clear(SV* sv)
5047 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5048 string in C<sv1> is less than, equal to, or greater than the string in
5049 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5050 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
5052 I32 sv_cmp(SV* sv1, SV* sv2)
5060 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
5061 'use bytes' aware, handles get magic, and will coerce its args to strings
5062 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
5064 I32 sv_cmp_locale(SV* sv1, SV* sv2)
5072 Add Collate Transform magic to an SV if it doesn't already have it.
5074 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
5075 scalar data of the variable, but transformed to such a format that a normal
5076 memory comparison can be used to compare the data according to the locale
5079 char* sv_collxfrm(SV* sv, STRLEN* nxp)
5087 Copies a stringified representation of the source SV into the
5088 destination SV. Automatically performs any necessary mg_get and
5089 coercion of numeric values into strings. Guaranteed to preserve
5090 UTF-8 flag even from overloaded objects. Similar in nature to
5091 sv_2pv[_flags] but operates directly on an SV instead of just the
5092 string. Mostly uses sv_2pv_flags to do its work, except when that
5093 would lose the UTF-8'ness of the PV.
5095 void sv_copypv(SV* dsv, SV* ssv)
5103 Auto-decrement of the value in the SV, doing string to numeric conversion
5104 if necessary. Handles 'get' magic.
5114 Returns a boolean indicating whether the strings in the two SVs are
5115 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5116 coerce its args to strings if necessary.
5118 I32 sv_eq(SV* sv1, SV* sv2)
5123 =item sv_force_normal_flags
5124 X<sv_force_normal_flags>
5126 Undo various types of fakery on an SV: if the PV is a shared string, make
5127 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
5128 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
5129 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
5130 then a copy-on-write scalar drops its PV buffer (if any) and becomes
5131 SvPOK_off rather than making a copy. (Used where this scalar is about to be
5132 set to some other value.) In addition, the C<flags> parameter gets passed to
5133 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
5134 with flags set to 0.
5136 void sv_force_normal_flags(SV *sv, U32 flags)
5144 Decrement an SV's reference count, and if it drops to zero, call
5145 C<sv_clear> to invoke destructors and free up any memory used by
5146 the body; finally, deallocate the SV's head itself.
5147 Normally called via a wrapper macro C<SvREFCNT_dec>.
5149 void sv_free(SV* sv)
5157 Get a line from the filehandle and store it into the SV, optionally
5158 appending to the currently-stored string.
5160 char* sv_gets(SV* sv, PerlIO* fp, I32 append)
5168 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
5169 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
5170 Use the C<SvGROW> wrapper instead.
5172 char* sv_grow(SV* sv, STRLEN newlen)
5180 Auto-increment of the value in the SV, doing string to numeric conversion
5181 if necessary. Handles 'get' magic.
5191 Inserts a string at the specified offset/length within the SV. Similar to
5192 the Perl substr() function.
5194 void sv_insert(SV* bigsv, STRLEN offset, STRLEN len, const char* little, STRLEN littlelen)
5202 Returns a boolean indicating whether the SV is blessed into the specified
5203 class. This does not check for subtypes; use C<sv_derived_from> to verify
5204 an inheritance relationship.
5206 int sv_isa(SV* sv, const char* name)
5214 Returns a boolean indicating whether the SV is an RV pointing to a blessed
5215 object. If the SV is not an RV, or if the object is not blessed, then this
5218 int sv_isobject(SV* sv)
5226 Returns the length of the string in the SV. Handles magic and type
5227 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5229 STRLEN sv_len(SV* sv)
5237 Returns the number of characters in the string in an SV, counting wide
5238 UTF-8 bytes as a single character. Handles magic and type coercion.
5240 STRLEN sv_len_utf8(SV* sv)
5248 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
5249 then adds a new magic item of type C<how> to the head of the magic list.
5251 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
5252 handling of the C<name> and C<namlen> arguments.
5254 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
5255 to add more than one instance of the same 'how'.
5257 void sv_magic(SV* sv, SV* obj, int how, const char* name, I32 namlen)
5265 Adds magic to an SV, upgrading it if necessary. Applies the
5266 supplied vtable and returns a pointer to the magic added.
5268 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
5269 In particular, you can add magic to SvREADONLY SVs, and add more than
5270 one instance of the same 'how'.
5272 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
5273 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
5274 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
5275 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
5277 (This is now used as a subroutine by C<sv_magic>.)
5279 MAGIC * sv_magicext(SV* sv, SV* obj, int how, MGVTBL *vtbl, const char* name, I32 namlen)
5287 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
5288 The new SV is marked as mortal. It will be destroyed "soon", either by an
5289 explicit call to FREETMPS, or by an implicit call at places such as
5290 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
5292 SV* sv_mortalcopy(SV* oldsv)
5300 Creates a new null SV which is mortal. The reference count of the SV is
5301 set to 1. It will be destroyed "soon", either by an explicit call to
5302 FREETMPS, or by an implicit call at places such as statement boundaries.
5303 See also C<sv_mortalcopy> and C<sv_2mortal>.
5313 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5316 SV* sv_newref(SV* sv)
5324 Converts the value pointed to by offsetp from a count of bytes from the
5325 start of the string, to a count of the equivalent number of UTF-8 chars.
5326 Handles magic and type coercion.
5328 void sv_pos_b2u(SV* sv, I32* offsetp)
5336 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5337 the start of the string, to a count of the equivalent number of bytes; if
5338 lenp is non-zero, it does the same to lenp, but this time starting from
5339 the offset, rather than from the start of the string. Handles magic and
5342 void sv_pos_u2b(SV* sv, I32* offsetp, I32* lenp)
5347 =item sv_pvbyten_force
5350 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
5352 char* sv_pvbyten_force(SV* sv, STRLEN* lp)
5360 Get a sensible string out of the SV somehow.
5361 A private implementation of the C<SvPV_force> macro for compilers which
5362 can't cope with complex macro expressions. Always use the macro instead.
5364 char* sv_pvn_force(SV* sv, STRLEN* lp)
5369 =item sv_pvn_force_flags
5370 X<sv_pvn_force_flags>
5372 Get a sensible string out of the SV somehow.
5373 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
5374 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
5375 implemented in terms of this function.
5376 You normally want to use the various wrapper macros instead: see
5377 C<SvPV_force> and C<SvPV_force_nomg>
5379 char* sv_pvn_force_flags(SV* sv, STRLEN* lp, I32 flags)
5384 =item sv_pvutf8n_force
5387 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
5389 char* sv_pvutf8n_force(SV* sv, STRLEN* lp)
5397 Returns a string describing what the SV is a reference to.
5399 char* sv_reftype(const SV* sv, int ob)
5407 Make the first argument a copy of the second, then delete the original.
5408 The target SV physically takes over ownership of the body of the source SV
5409 and inherits its flags; however, the target keeps any magic it owns,
5410 and any magic in the source is discarded.
5411 Note that this is a rather specialist SV copying operation; most of the
5412 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5414 void sv_replace(SV* sv, SV* nsv)
5422 Underlying implementation for the C<reset> Perl function.
5423 Note that the perl-level function is vaguely deprecated.
5425 void sv_reset(const char* s, HV* stash)
5433 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
5434 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
5435 push a back-reference to this RV onto the array of backreferences
5436 associated with that magic.
5438 SV* sv_rvweaken(SV *sv)
5446 Copies an integer into the given SV, upgrading first if necessary.
5447 Does not handle 'set' magic. See also C<sv_setiv_mg>.
5449 void sv_setiv(SV* sv, IV num)
5457 Like C<sv_setiv>, but also handles 'set' magic.
5459 void sv_setiv_mg(SV *sv, IV i)
5467 Copies a double into the given SV, upgrading first if necessary.
5468 Does not handle 'set' magic. See also C<sv_setnv_mg>.
5470 void sv_setnv(SV* sv, NV num)
5478 Like C<sv_setnv>, but also handles 'set' magic.
5480 void sv_setnv_mg(SV *sv, NV num)
5488 Copies a string into an SV. The string must be null-terminated. Does not
5489 handle 'set' magic. See C<sv_setpv_mg>.
5491 void sv_setpv(SV* sv, const char* ptr)
5499 Works like C<sv_catpvf> but copies the text into the SV instead of
5500 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
5502 void sv_setpvf(SV* sv, const char* pat, ...)
5510 Like C<sv_setpvf>, but also handles 'set' magic.
5512 void sv_setpvf_mg(SV *sv, const char* pat, ...)
5520 Copies an integer into the given SV, also updating its string value.
5521 Does not handle 'set' magic. See C<sv_setpviv_mg>.
5523 void sv_setpviv(SV* sv, IV num)
5531 Like C<sv_setpviv>, but also handles 'set' magic.
5533 void sv_setpviv_mg(SV *sv, IV iv)
5541 Copies a string into an SV. The C<len> parameter indicates the number of
5542 bytes to be copied. If the C<ptr> argument is NULL the SV will become
5543 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
5545 void sv_setpvn(SV* sv, const char* ptr, STRLEN len)
5553 Like C<sv_setpvn>, but also handles 'set' magic.
5555 void sv_setpvn_mg(SV *sv, const char *ptr, STRLEN len)
5563 Like C<sv_setpv>, but also handles 'set' magic.
5565 void sv_setpv_mg(SV *sv, const char *ptr)
5573 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
5574 argument will be upgraded to an RV. That RV will be modified to point to
5575 the new SV. The C<classname> argument indicates the package for the
5576 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
5577 will have a reference count of 1, and the RV will be returned.
5579 SV* sv_setref_iv(SV* rv, const char* classname, IV iv)
5587 Copies a double into a new SV, optionally blessing the SV. The C<rv>
5588 argument will be upgraded to an RV. That RV will be modified to point to
5589 the new SV. The C<classname> argument indicates the package for the
5590 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
5591 will have a reference count of 1, and the RV will be returned.
5593 SV* sv_setref_nv(SV* rv, const char* classname, NV nv)
5601 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
5602 argument will be upgraded to an RV. That RV will be modified to point to
5603 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
5604 into the SV. The C<classname> argument indicates the package for the
5605 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
5606 will have a reference count of 1, and the RV will be returned.
5608 Do not use with other Perl types such as HV, AV, SV, CV, because those
5609 objects will become corrupted by the pointer copy process.
5611 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
5613 SV* sv_setref_pv(SV* rv, const char* classname, void* pv)
5621 Copies a string into a new SV, optionally blessing the SV. The length of the
5622 string must be specified with C<n>. The C<rv> argument will be upgraded to
5623 an RV. That RV will be modified to point to the new SV. The C<classname>
5624 argument indicates the package for the blessing. Set C<classname> to
5625 C<NULL> to avoid the blessing. The new SV will have a reference count
5626 of 1, and the RV will be returned.
5628 Note that C<sv_setref_pv> copies the pointer while this copies the string.
5630 SV* sv_setref_pvn(SV* rv, const char* classname, const char* pv, STRLEN n)
5638 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
5639 argument will be upgraded to an RV. That RV will be modified to point to
5640 the new SV. The C<classname> argument indicates the package for the
5641 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
5642 will have a reference count of 1, and the RV will be returned.
5644 SV* sv_setref_uv(SV* rv, const char* classname, UV uv)
5652 Copies the contents of the source SV C<ssv> into the destination SV
5653 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
5654 function if the source SV needs to be reused. Does not handle 'set' magic.
5655 Loosely speaking, it performs a copy-by-value, obliterating any previous
5656 content of the destination.
5658 You probably want to use one of the assortment of wrappers, such as
5659 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
5660 C<SvSetMagicSV_nosteal>.
5662 void sv_setsv(SV* dsv, SV* ssv)
5667 =item sv_setsv_flags
5670 Copies the contents of the source SV C<ssv> into the destination SV
5671 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
5672 function if the source SV needs to be reused. Does not handle 'set' magic.
5673 Loosely speaking, it performs a copy-by-value, obliterating any previous
5674 content of the destination.
5675 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
5676 C<ssv> if appropriate, else not. If the C<flags> parameter has the
5677 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
5678 and C<sv_setsv_nomg> are implemented in terms of this function.
5680 You probably want to use one of the assortment of wrappers, such as
5681 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
5682 C<SvSetMagicSV_nosteal>.
5684 This is the primary function for copying scalars, and most other
5685 copy-ish functions and macros use this underneath.
5687 void sv_setsv_flags(SV* dsv, SV* ssv, I32 flags)
5695 Like C<sv_setsv>, but also handles 'set' magic.
5697 void sv_setsv_mg(SV *dstr, SV *sstr)
5705 Copies an unsigned integer into the given SV, upgrading first if necessary.
5706 Does not handle 'set' magic. See also C<sv_setuv_mg>.
5708 void sv_setuv(SV* sv, UV num)
5716 Like C<sv_setuv>, but also handles 'set' magic.
5718 void sv_setuv_mg(SV *sv, UV u)
5726 Test an SV for taintedness. Use C<SvTAINTED> instead.
5727 bool sv_tainted(SV* sv)
5735 Returns true if the SV has a true value by Perl's rules.
5736 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
5737 instead use an in-line version.
5747 Removes all magic of type C<type> from an SV.
5749 int sv_unmagic(SV* sv, int type)
5754 =item sv_unref_flags
5757 Unsets the RV status of the SV, and decrements the reference count of
5758 whatever was being referenced by the RV. This can almost be thought of
5759 as a reversal of C<newSVrv>. The C<cflags> argument can contain
5760 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
5761 (otherwise the decrementing is conditional on the reference count being
5762 different from one or the reference being a readonly SV).
5765 void sv_unref_flags(SV* sv, U32 flags)
5773 Untaint an SV. Use C<SvTAINTED_off> instead.
5774 void sv_untaint(SV* sv)
5782 Upgrade an SV to a more complex form. Generally adds a new body type to the
5783 SV, then copies across as much information as possible from the old body.
5784 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
5786 void sv_upgrade(SV* sv, U32 mt)
5791 =item sv_usepvn_flags
5794 Tells an SV to use C<ptr> to find its string value. Normally the
5795 string is stored inside the SV but sv_usepvn allows the SV to use an
5796 outside string. The C<ptr> should point to memory that was allocated
5797 by C<malloc>. The string length, C<len>, must be supplied. By default
5798 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
5799 so that pointer should not be freed or used by the programmer after
5800 giving it to sv_usepvn, and neither should any pointers from "behind"
5801 that pointer (e.g. ptr + 1) be used.
5803 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
5804 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
5805 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
5806 C<len>, and already meets the requirements for storing in C<SvPVX>)
5808 void sv_usepvn_flags(SV* sv, char* ptr, STRLEN len, U32 flags)
5813 =item sv_utf8_decode
5816 If the PV of the SV is an octet sequence in UTF-8
5817 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
5818 so that it looks like a character. If the PV contains only single-byte
5819 characters, the C<SvUTF8> flag stays being off.
5820 Scans PV for validity and returns false if the PV is invalid UTF-8.
5822 NOTE: this function is experimental and may change or be
5823 removed without notice.
5825 bool sv_utf8_decode(SV *sv)
5830 =item sv_utf8_downgrade
5831 X<sv_utf8_downgrade>
5833 Attempts to convert the PV of an SV from characters to bytes.
5834 If the PV contains a character beyond byte, this conversion will fail;
5835 in this case, either returns false or, if C<fail_ok> is not
5838 This is not as a general purpose Unicode to byte encoding interface:
5839 use the Encode extension for that.
5841 NOTE: this function is experimental and may change or be
5842 removed without notice.
5844 bool sv_utf8_downgrade(SV *sv, bool fail_ok)
5849 =item sv_utf8_encode
5852 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
5853 flag off so that it looks like octets again.
5855 void sv_utf8_encode(SV *sv)
5860 =item sv_utf8_upgrade
5863 Converts the PV of an SV to its UTF-8-encoded form.
5864 Forces the SV to string form if it is not already.
5865 Always sets the SvUTF8 flag to avoid future validity checks even
5866 if all the bytes have hibit clear.
5868 This is not as a general purpose byte encoding to Unicode interface:
5869 use the Encode extension for that.
5871 STRLEN sv_utf8_upgrade(SV *sv)
5876 =item sv_utf8_upgrade_flags
5877 X<sv_utf8_upgrade_flags>
5879 Converts the PV of an SV to its UTF-8-encoded form.
5880 Forces the SV to string form if it is not already.
5881 Always sets the SvUTF8 flag to avoid future validity checks even
5882 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
5883 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
5884 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
5886 This is not as a general purpose byte encoding to Unicode interface:
5887 use the Encode extension for that.
5889 STRLEN sv_utf8_upgrade_flags(SV *sv, I32 flags)
5897 Processes its arguments like C<vsprintf> and appends the formatted output
5898 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
5900 Usually used via its frontend C<sv_catpvf>.
5902 void sv_vcatpvf(SV* sv, const char* pat, va_list* args)
5910 Processes its arguments like C<vsprintf> and appends the formatted output
5911 to an SV. Uses an array of SVs if the C style variable argument list is
5912 missing (NULL). When running with taint checks enabled, indicates via
5913 C<maybe_tainted> if results are untrustworthy (often due to the use of
5916 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
5918 void sv_vcatpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
5926 Like C<sv_vcatpvf>, but also handles 'set' magic.
5928 Usually used via its frontend C<sv_catpvf_mg>.
5930 void sv_vcatpvf_mg(SV* sv, const char* pat, va_list* args)
5938 Works like C<sv_vcatpvf> but copies the text into the SV instead of
5939 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
5941 Usually used via its frontend C<sv_setpvf>.
5943 void sv_vsetpvf(SV* sv, const char* pat, va_list* args)
5951 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
5954 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
5956 void sv_vsetpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
5964 Like C<sv_vsetpvf>, but also handles 'set' magic.
5966 Usually used via its frontend C<sv_setpvf_mg>.
5968 void sv_vsetpvf_mg(SV* sv, const char* pat, va_list* args)
5976 =head1 Unicode Support
5980 =item bytes_from_utf8
5983 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
5984 Unlike C<utf8_to_bytes> but like C<bytes_to_utf8>, returns a pointer to
5985 the newly-created string, and updates C<len> to contain the new
5986 length. Returns the original string if no conversion occurs, C<len>
5987 is unchanged. Do nothing if C<is_utf8> points to 0. Sets C<is_utf8> to
5988 0 if C<s> is converted or contains all 7bit characters.
5990 NOTE: this function is experimental and may change or be
5991 removed without notice.
5993 U8* bytes_from_utf8(const U8 *s, STRLEN *len, bool *is_utf8)
5996 Found in file utf8.c
6001 Converts a string C<s> of length C<len> from ASCII into UTF-8 encoding.
6002 Returns a pointer to the newly-created string, and sets C<len> to
6003 reflect the new length.
6005 If you want to convert to UTF-8 from other encodings than ASCII,
6006 see sv_recode_to_utf8().
6008 NOTE: this function is experimental and may change or be
6009 removed without notice.
6011 U8* bytes_to_utf8(const U8 *s, STRLEN *len)
6014 Found in file utf8.c
6019 Return true if the strings s1 and s2 differ case-insensitively, false
6020 if not (if they are equal case-insensitively). If u1 is true, the
6021 string s1 is assumed to be in UTF-8-encoded Unicode. If u2 is true,
6022 the string s2 is assumed to be in UTF-8-encoded Unicode. If u1 or u2
6023 are false, the respective string is assumed to be in native 8-bit
6026 If the pe1 and pe2 are non-NULL, the scanning pointers will be copied
6027 in there (they will point at the beginning of the I<next> character).
6028 If the pointers behind pe1 or pe2 are non-NULL, they are the end
6029 pointers beyond which scanning will not continue under any
6030 circumstances. If the byte lengths l1 and l2 are non-zero, s1+l1 and
6031 s2+l2 will be used as goal end pointers that will also stop the scan,
6032 and which qualify towards defining a successful match: all the scans
6033 that define an explicit length must reach their goal pointers for
6034 a match to succeed).
6036 For case-insensitiveness, the "casefolding" of Unicode is used
6037 instead of upper/lowercasing both the characters, see
6038 http://www.unicode.org/unicode/reports/tr21/ (Case Mappings).
6040 I32 ibcmp_utf8(const char* a, char **pe1, UV l1, bool u1, const char* b, char **pe2, UV l2, bool u2)
6043 Found in file utf8.c
6048 Tests if some arbitrary number of bytes begins in a valid UTF-8
6049 character. Note that an INVARIANT (i.e. ASCII) character is a valid
6050 UTF-8 character. The actual number of bytes in the UTF-8 character
6051 will be returned if it is valid, otherwise 0.
6053 STRLEN is_utf8_char(const U8 *p)
6056 Found in file utf8.c
6058 =item is_utf8_string
6061 Returns true if first C<len> bytes of the given string form a valid
6062 UTF-8 string, false otherwise. Note that 'a valid UTF-8 string' does
6063 not mean 'a string that contains code points above 0x7F encoded in UTF-8'
6064 because a valid ASCII string is a valid UTF-8 string.
6066 See also is_utf8_string_loclen() and is_utf8_string_loc().
6068 bool is_utf8_string(const U8 *s, STRLEN len)
6071 Found in file utf8.c
6073 =item is_utf8_string_loc
6074 X<is_utf8_string_loc>
6076 Like is_utf8_string() but stores the location of the failure (in the
6077 case of "utf8ness failure") or the location s+len (in the case of
6078 "utf8ness success") in the C<ep>.
6080 See also is_utf8_string_loclen() and is_utf8_string().
6082 bool is_utf8_string_loc(const U8 *s, STRLEN len, const U8 **p)
6085 Found in file utf8.c
6087 =item is_utf8_string_loclen
6088 X<is_utf8_string_loclen>
6090 Like is_utf8_string() but stores the location of the failure (in the
6091 case of "utf8ness failure") or the location s+len (in the case of
6092 "utf8ness success") in the C<ep>, and the number of UTF-8
6093 encoded characters in the C<el>.
6095 See also is_utf8_string_loc() and is_utf8_string().
6097 bool is_utf8_string_loclen(const U8 *s, STRLEN len, const U8 **ep, STRLEN *el)
6100 Found in file utf8.c
6102 =item pv_uni_display
6105 Build to the scalar dsv a displayable version of the string spv,
6106 length len, the displayable version being at most pvlim bytes long
6107 (if longer, the rest is truncated and "..." will be appended).
6109 The flags argument can have UNI_DISPLAY_ISPRINT set to display
6110 isPRINT()able characters as themselves, UNI_DISPLAY_BACKSLASH
6111 to display the \\[nrfta\\] as the backslashed versions (like '\n')
6112 (UNI_DISPLAY_BACKSLASH is preferred over UNI_DISPLAY_ISPRINT for \\).
6113 UNI_DISPLAY_QQ (and its alias UNI_DISPLAY_REGEX) have both
6114 UNI_DISPLAY_BACKSLASH and UNI_DISPLAY_ISPRINT turned on.
6116 The pointer to the PV of the dsv is returned.
6118 char* pv_uni_display(SV *dsv, const U8 *spv, STRLEN len, STRLEN pvlim, UV flags)
6121 Found in file utf8.c
6126 The encoding is assumed to be an Encode object, the PV of the ssv is
6127 assumed to be octets in that encoding and decoding the input starts
6128 from the position which (PV + *offset) pointed to. The dsv will be
6129 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
6130 when the string tstr appears in decoding output or the input ends on
6131 the PV of the ssv. The value which the offset points will be modified
6132 to the last input position on the ssv.
6134 Returns TRUE if the terminator was found, else returns FALSE.
6136 bool sv_cat_decode(SV* dsv, SV *encoding, SV *ssv, int *offset, char* tstr, int tlen)
6141 =item sv_recode_to_utf8
6142 X<sv_recode_to_utf8>
6144 The encoding is assumed to be an Encode object, on entry the PV
6145 of the sv is assumed to be octets in that encoding, and the sv
6146 will be converted into Unicode (and UTF-8).
6148 If the sv already is UTF-8 (or if it is not POK), or if the encoding
6149 is not a reference, nothing is done to the sv. If the encoding is not
6150 an C<Encode::XS> Encoding object, bad things will happen.
6151 (See F<lib/encoding.pm> and L<Encode>).
6153 The PV of the sv is returned.
6155 char* sv_recode_to_utf8(SV* sv, SV *encoding)
6160 =item sv_uni_display
6163 Build to the scalar dsv a displayable version of the scalar sv,
6164 the displayable version being at most pvlim bytes long
6165 (if longer, the rest is truncated and "..." will be appended).
6167 The flags argument is as in pv_uni_display().
6169 The pointer to the PV of the dsv is returned.
6171 char* sv_uni_display(SV *dsv, SV *ssv, STRLEN pvlim, UV flags)
6174 Found in file utf8.c
6179 The "p" contains the pointer to the UTF-8 string encoding
6180 the character that is being converted.
6182 The "ustrp" is a pointer to the character buffer to put the
6183 conversion result to. The "lenp" is a pointer to the length
6186 The "swashp" is a pointer to the swash to use.
6188 Both the special and normal mappings are stored lib/unicore/To/Foo.pl,
6189 and loaded by SWASHNEW, using lib/utf8_heavy.pl. The special (usually,
6190 but not always, a multicharacter mapping), is tried first.
6192 The "special" is a string like "utf8::ToSpecLower", which means the
6193 hash %utf8::ToSpecLower. The access to the hash is through
6194 Perl_to_utf8_case().
6196 The "normal" is a string like "ToLower" which means the swash
6199 UV to_utf8_case(const U8 *p, U8* ustrp, STRLEN *lenp, SV **swashp, const char *normal, const char *special)
6202 Found in file utf8.c
6207 Convert the UTF-8 encoded character at p to its foldcase version and
6208 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6209 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6210 foldcase version may be longer than the original character (up to
6213 The first character of the foldcased version is returned
6214 (but note, as explained above, that there may be more.)
6216 UV to_utf8_fold(const U8 *p, U8* ustrp, STRLEN *lenp)
6219 Found in file utf8.c
6224 Convert the UTF-8 encoded character at p to its lowercase version and
6225 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6226 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6227 lowercase version may be longer than the original character.
6229 The first character of the lowercased version is returned
6230 (but note, as explained above, that there may be more.)
6232 UV to_utf8_lower(const U8 *p, U8* ustrp, STRLEN *lenp)
6235 Found in file utf8.c
6240 Convert the UTF-8 encoded character at p to its titlecase version and
6241 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6242 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6243 titlecase version may be longer than the original character.
6245 The first character of the titlecased version is returned
6246 (but note, as explained above, that there may be more.)
6248 UV to_utf8_title(const U8 *p, U8* ustrp, STRLEN *lenp)
6251 Found in file utf8.c
6256 Convert the UTF-8 encoded character at p to its uppercase version and
6257 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6258 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since
6259 the uppercase version may be longer than the original character.
6261 The first character of the uppercased version is returned
6262 (but note, as explained above, that there may be more.)
6264 UV to_utf8_upper(const U8 *p, U8* ustrp, STRLEN *lenp)
6267 Found in file utf8.c
6269 =item utf8n_to_uvchr
6274 Returns the native character value of the first character in the string
6276 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6277 length, in bytes, of that character.
6279 Allows length and flags to be passed to low level routine.
6281 UV utf8n_to_uvchr(const U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags)
6284 Found in file utf8.c
6286 =item utf8n_to_uvuni
6289 Bottom level UTF-8 decode routine.
6290 Returns the unicode code point value of the first character in the string C<s>
6291 which is assumed to be in UTF-8 encoding and no longer than C<curlen>;
6292 C<retlen> will be set to the length, in bytes, of that character.
6294 If C<s> does not point to a well-formed UTF-8 character, the behaviour
6295 is dependent on the value of C<flags>: if it contains UTF8_CHECK_ONLY,
6296 it is assumed that the caller will raise a warning, and this function
6297 will silently just set C<retlen> to C<-1> and return zero. If the
6298 C<flags> does not contain UTF8_CHECK_ONLY, warnings about
6299 malformations will be given, C<retlen> will be set to the expected
6300 length of the UTF-8 character in bytes, and zero will be returned.
6302 The C<flags> can also contain various flags to allow deviations from
6303 the strict UTF-8 encoding (see F<utf8.h>).
6305 Most code should use utf8_to_uvchr() rather than call this directly.
6307 UV utf8n_to_uvuni(const U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags)
6310 Found in file utf8.c
6315 Returns the number of UTF-8 characters between the UTF-8 pointers C<a>
6318 WARNING: use only if you *know* that the pointers point inside the
6321 IV utf8_distance(const U8 *a, const U8 *b)
6324 Found in file utf8.c
6329 Return the UTF-8 pointer C<s> displaced by C<off> characters, either
6330 forward or backward.
6332 WARNING: do not use the following unless you *know* C<off> is within
6333 the UTF-8 data pointed to by C<s> *and* that on entry C<s> is aligned
6334 on the first byte of character or just after the last byte of a character.
6336 U8* utf8_hop(const U8 *s, I32 off)
6339 Found in file utf8.c
6344 Return the length of the UTF-8 char encoded string C<s> in characters.
6345 Stops at C<e> (inclusive). If C<e E<lt> s> or if the scan would end
6346 up past C<e>, croaks.
6348 STRLEN utf8_length(const U8* s, const U8 *e)
6351 Found in file utf8.c
6356 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
6357 Unlike C<bytes_to_utf8>, this over-writes the original string, and
6358 updates len to contain the new length.
6359 Returns zero on failure, setting C<len> to -1.
6361 If you need a copy of the string, see C<bytes_from_utf8>.
6363 NOTE: this function is experimental and may change or be
6364 removed without notice.
6366 U8* utf8_to_bytes(U8 *s, STRLEN *len)
6369 Found in file utf8.c
6374 Returns the native character value of the first character in the string C<s>
6375 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6376 length, in bytes, of that character.
6378 If C<s> does not point to a well-formed UTF-8 character, zero is
6379 returned and retlen is set, if possible, to -1.
6381 UV utf8_to_uvchr(const U8 *s, STRLEN *retlen)
6384 Found in file utf8.c
6389 Returns the Unicode code point of the first character in the string C<s>
6390 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6391 length, in bytes, of that character.
6393 This function should only be used when returned UV is considered
6394 an index into the Unicode semantic tables (e.g. swashes).
6396 If C<s> does not point to a well-formed UTF-8 character, zero is
6397 returned and retlen is set, if possible, to -1.
6399 UV utf8_to_uvuni(const U8 *s, STRLEN *retlen)
6402 Found in file utf8.c
6407 Adds the UTF-8 representation of the Native codepoint C<uv> to the end
6408 of the string C<d>; C<d> should be have at least C<UTF8_MAXBYTES+1> free
6409 bytes available. The return value is the pointer to the byte after the
6410 end of the new character. In other words,
6412 d = uvchr_to_utf8(d, uv);
6414 is the recommended wide native character-aware way of saying
6418 U8* uvchr_to_utf8(U8 *d, UV uv)
6421 Found in file utf8.c
6423 =item uvuni_to_utf8_flags
6424 X<uvuni_to_utf8_flags>
6426 Adds the UTF-8 representation of the Unicode codepoint C<uv> to the end
6427 of the string C<d>; C<d> should be have at least C<UTF8_MAXBYTES+1> free
6428 bytes available. The return value is the pointer to the byte after the
6429 end of the new character. In other words,
6431 d = uvuni_to_utf8_flags(d, uv, flags);
6435 d = uvuni_to_utf8(d, uv);
6437 (which is equivalent to)
6439 d = uvuni_to_utf8_flags(d, uv, 0);
6441 is the recommended Unicode-aware way of saying
6445 U8* uvuni_to_utf8_flags(U8 *d, UV uv, UV flags)
6448 Found in file utf8.c
6453 =head1 Variables created by C<xsubpp> and C<xsubpp> internal functions
6460 Variable which is setup by C<xsubpp> to indicate the stack base offset,
6461 used by the C<ST>, C<XSprePUSH> and C<XSRETURN> macros. The C<dMARK> macro
6462 must be called prior to setup the C<MARK> variable.
6467 Found in file XSUB.h
6472 Variable which is setup by C<xsubpp> to indicate the
6473 class name for a C++ XS constructor. This is always a C<char*>. See C<THIS>.
6478 Found in file XSUB.h
6483 Sets up the C<ax> variable.
6484 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
6489 Found in file XSUB.h
6494 Sets up the C<ax> variable and stack marker variable C<mark>.
6495 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
6500 Found in file XSUB.h
6505 Sets up the C<items> variable.
6506 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
6511 Found in file XSUB.h
6516 Sets up the C<padoff_du> variable for an XSUB that wishes to use
6522 Found in file XSUB.h
6527 Sets up stack and mark pointers for an XSUB, calling dSP and dMARK.
6528 Sets up the C<ax> and C<items> variables by calling C<dAX> and C<dITEMS>.
6529 This is usually handled automatically by C<xsubpp>.
6534 Found in file XSUB.h
6539 Sets up the C<ix> variable for an XSUB which has aliases. This is usually
6540 handled automatically by C<xsubpp>.
6545 Found in file XSUB.h
6550 Variable which is setup by C<xsubpp> to indicate the number of
6551 items on the stack. See L<perlxs/"Variable-length Parameter Lists">.
6556 Found in file XSUB.h
6561 Variable which is setup by C<xsubpp> to indicate which of an
6562 XSUB's aliases was used to invoke it. See L<perlxs/"The ALIAS: Keyword">.
6567 Found in file XSUB.h
6572 Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
6576 Found in file XSUB.h
6581 Variable which is setup by C<xsubpp> to hold the return value for an
6582 XSUB. This is always the proper type for the XSUB. See
6583 L<perlxs/"The RETVAL Variable">.
6588 Found in file XSUB.h
6593 Used to access elements on the XSUB's stack.
6598 Found in file XSUB.h
6603 Variable which is setup by C<xsubpp> to designate the object in a C++
6604 XSUB. This is always the proper type for the C++ object. See C<CLASS> and
6605 L<perlxs/"Using XS With C++">.
6610 Found in file XSUB.h
6615 The SV* corresponding to the $_ variable. Works even if there
6616 is a lexical $_ in scope.
6619 Found in file XSUB.h
6624 Macro to declare an XSUB and its C parameter list. This is handled by
6628 Found in file XSUB.h
6633 The version identifier for an XS module. This is usually
6634 handled automatically by C<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>.
6637 Found in file XSUB.h
6639 =item XS_VERSION_BOOTCHECK
6640 X<XS_VERSION_BOOTCHECK>
6642 Macro to verify that a PM module's $VERSION variable matches the XS
6643 module's C<XS_VERSION> variable. This is usually handled automatically by
6644 C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">.
6646 XS_VERSION_BOOTCHECK;
6649 Found in file XSUB.h
6654 =head1 Warning and Dieing
6661 This is the XSUB-writer's interface to Perl's C<die> function.
6662 Normally call this function the same way you call the C C<printf>
6663 function. Calling C<croak> returns control directly to Perl,
6664 sidestepping the normal C order of execution. See C<warn>.
6666 If you want to throw an exception object, assign the object to
6667 C<$@> and then pass C<NULL> to croak():
6669 errsv = get_sv("@", TRUE);
6670 sv_setsv(errsv, exception_object);
6673 void croak(const char* pat, ...)
6676 Found in file util.c
6681 This is the XSUB-writer's interface to Perl's C<warn> function. Call this
6682 function the same way you call the C C<printf> function. See C<croak>.
6684 void warn(const char* pat, ...)
6687 Found in file util.c
6694 Until May 1997, this document was maintained by Jeff Okamoto
6695 <okamoto@corp.hp.com>. It is now maintained as part of Perl itself.
6697 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
6698 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
6699 Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
6700 Stephen McCamant, and Gurusamy Sarathy.
6702 API Listing originally by Dean Roehrich <roehrich@cray.com>.
6704 Updated to be autogenerated from comments in the source by Benjamin Stuhl.
6708 perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
projects / p5sagit/p5-mst-13.2.git / blob