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 Like C<gv_stashpvn>, but takes a literal string instead of a string/length pair.
1257 HV* gv_stashpvs(const char* name, I32 create)
1260 Found in file handy.h
1265 Returns a pointer to the stash for a specified package, which must be a
1266 valid UTF-8 string. See C<gv_stashpv>.
1268 HV* gv_stashsv(SV* sv, I32 create)
1291 Null character pointer.
1294 Found in file handy.h
1318 Found in file handy.h
1323 =head1 Hash Manipulation Functions
1330 Returns the HV of the specified Perl hash. If C<create> is set and the
1331 Perl variable does not exist then it will be created. If C<create> is not
1332 set and the variable does not exist then NULL is returned.
1334 NOTE: the perl_ form of this function is deprecated.
1336 HV* get_hv(const char* name, I32 create)
1339 Found in file perl.c
1344 This flag, used in the length slot of hash entries and magic structures,
1345 specifies the structure contains an C<SV*> pointer where a C<char*> pointer
1346 is to be expected. (For information only--not to be used).
1354 Returns the computed hash stored in the hash entry.
1364 Returns the actual pointer stored in the key slot of the hash entry. The
1365 pointer may be either C<char*> or C<SV*>, depending on the value of
1366 C<HeKLEN()>. Can be assigned to. The C<HePV()> or C<HeSVKEY()> macros are
1367 usually preferable for finding the value of a key.
1377 If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry
1378 holds an C<SV*> key. Otherwise, holds the actual length of the key. Can
1379 be assigned to. The C<HePV()> macro is usually preferable for finding key
1382 STRLEN HeKLEN(HE* he)
1390 Returns the key slot of the hash entry as a C<char*> value, doing any
1391 necessary dereferencing of possibly C<SV*> keys. The length of the string
1392 is placed in C<len> (this is a macro, so do I<not> use C<&len>). If you do
1393 not care about what the length of the key is, you may use the global
1394 variable C<PL_na>, though this is rather less efficient than using a local
1395 variable. Remember though, that hash keys in perl are free to contain
1396 embedded nulls, so using C<strlen()> or similar is not a good way to find
1397 the length of hash keys. This is very similar to the C<SvPV()> macro
1398 described elsewhere in this document.
1400 char* HePV(HE* he, STRLEN len)
1408 Returns the key as an C<SV*>, or C<NULL> if the hash entry does not
1409 contain an C<SV*> key.
1419 Returns the key as an C<SV*>. Will create and return a temporary mortal
1420 C<SV*> if the hash entry contains only a C<char*> key.
1422 SV* HeSVKEY_force(HE* he)
1430 Sets the key to a given C<SV*>, taking care to set the appropriate flags to
1431 indicate the presence of an C<SV*> key, and returns the same
1434 SV* HeSVKEY_set(HE* he, SV* sv)
1442 Returns the value slot (type C<SV*>) stored in the hash entry.
1452 Returns the package name of a stash, or NULL if C<stash> isn't a stash.
1453 See C<SvSTASH>, C<CvSTASH>.
1455 char* HvNAME(HV* stash)
1463 Check that a hash is in an internally consistent state.
1465 void hv_assert(HV* tb)
1473 Clears a hash, making it empty.
1475 void hv_clear(HV* tb)
1480 =item hv_clear_placeholders
1481 X<hv_clear_placeholders>
1483 Clears any placeholders from a hash. If a restricted hash has any of its keys
1484 marked as readonly and the key is subsequently deleted, the key is not actually
1485 deleted but is marked by assigning it a value of &PL_sv_placeholder. This tags
1486 it so it will be ignored by future operations such as iterating over the hash,
1487 but will still allow the hash to have a value reassigned to the key at some
1488 future point. This function clears any such placeholder keys from the hash.
1489 See Hash::Util::lock_keys() for an example of its use.
1491 void hv_clear_placeholders(HV* hb)
1499 Deletes a key/value pair in the hash. The value SV is removed from the
1500 hash and returned to the caller. The C<klen> is the length of the key.
1501 The C<flags> value will normally be zero; if set to G_DISCARD then NULL
1504 SV* hv_delete(HV* tb, const char* key, I32 klen, I32 flags)
1512 Deletes a key/value pair in the hash. The value SV is removed from the
1513 hash and returned to the caller. The C<flags> value will normally be zero;
1514 if set to G_DISCARD then NULL will be returned. C<hash> can be a valid
1515 precomputed hash value, or 0 to ask for it to be computed.
1517 SV* hv_delete_ent(HV* tb, SV* key, I32 flags, U32 hash)
1525 Returns a boolean indicating whether the specified hash key exists. The
1526 C<klen> is the length of the key.
1528 bool hv_exists(HV* tb, const char* key, I32 klen)
1536 Returns a boolean indicating whether the specified hash key exists. C<hash>
1537 can be a valid precomputed hash value, or 0 to ask for it to be
1540 bool hv_exists_ent(HV* tb, SV* key, U32 hash)
1548 Returns the SV which corresponds to the specified key in the hash. The
1549 C<klen> is the length of the key. If C<lval> is set then the fetch will be
1550 part of a store. Check that the return value is non-null before
1551 dereferencing it to an C<SV*>.
1553 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1554 information on how to use this function on tied hashes.
1556 SV** hv_fetch(HV* tb, const char* key, I32 klen, I32 lval)
1564 Like C<hv_fetch>, but takes a literal string instead of a string/length pair.
1566 SV** hv_fetchs(HV* tb, const char* key, I32 lval)
1569 Found in file handy.h
1574 Returns the hash entry which corresponds to the specified key in the hash.
1575 C<hash> must be a valid precomputed hash number for the given C<key>, or 0
1576 if you want the function to compute it. IF C<lval> is set then the fetch
1577 will be part of a store. Make sure the return value is non-null before
1578 accessing it. The return value when C<tb> is a tied hash is a pointer to a
1579 static location, so be sure to make a copy of the structure if you need to
1582 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1583 information on how to use this function on tied hashes.
1585 HE* hv_fetch_ent(HV* tb, SV* key, I32 lval, U32 hash)
1593 Prepares a starting point to traverse a hash table. Returns the number of
1594 keys in the hash (i.e. the same as C<HvKEYS(tb)>). The return value is
1595 currently only meaningful for hashes without tie magic.
1597 NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
1598 hash buckets that happen to be in use. If you still need that esoteric
1599 value, you can get it through the macro C<HvFILL(tb)>.
1602 I32 hv_iterinit(HV* tb)
1610 Returns the key from the current position of the hash iterator. See
1613 char* hv_iterkey(HE* entry, I32* retlen)
1621 Returns the key as an C<SV*> from the current position of the hash
1622 iterator. The return value will always be a mortal copy of the key. Also
1625 SV* hv_iterkeysv(HE* entry)
1633 Returns entries from a hash iterator. See C<hv_iterinit>.
1635 You may call C<hv_delete> or C<hv_delete_ent> on the hash entry that the
1636 iterator currently points to, without losing your place or invalidating your
1637 iterator. Note that in this case the current entry is deleted from the hash
1638 with your iterator holding the last reference to it. Your iterator is flagged
1639 to free the entry on the next call to C<hv_iternext>, so you must not discard
1640 your iterator immediately else the entry will leak - call C<hv_iternext> to
1641 trigger the resource deallocation.
1643 HE* hv_iternext(HV* tb)
1651 Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
1654 SV* hv_iternextsv(HV* hv, char** key, I32* retlen)
1659 =item hv_iternext_flags
1660 X<hv_iternext_flags>
1662 Returns entries from a hash iterator. See C<hv_iterinit> and C<hv_iternext>.
1663 The C<flags> value will normally be zero; if HV_ITERNEXT_WANTPLACEHOLDERS is
1664 set the placeholders keys (for restricted hashes) will be returned in addition
1665 to normal keys. By default placeholders are automatically skipped over.
1666 Currently a placeholder is implemented with a value that is
1667 C<&Perl_sv_placeholder>. Note that the implementation of placeholders and
1668 restricted hashes may change, and the implementation currently is
1669 insufficiently abstracted for any change to be tidy.
1671 NOTE: this function is experimental and may change or be
1672 removed without notice.
1674 HE* hv_iternext_flags(HV* tb, I32 flags)
1682 Returns the value from the current position of the hash iterator. See
1685 SV* hv_iterval(HV* tb, HE* entry)
1693 Adds magic to a hash. See C<sv_magic>.
1695 void hv_magic(HV* hv, GV* gv, int how)
1703 Evaluates the hash in scalar context and returns the result. Handles magic when the hash is tied.
1705 SV* hv_scalar(HV* hv)
1713 Stores an SV in a hash. The hash key is specified as C<key> and C<klen> is
1714 the length of the key. The C<hash> parameter is the precomputed hash
1715 value; if it is zero then Perl will compute it. The return value will be
1716 NULL if the operation failed or if the value did not need to be actually
1717 stored within the hash (as in the case of tied hashes). Otherwise it can
1718 be dereferenced to get the original C<SV*>. Note that the caller is
1719 responsible for suitably incrementing the reference count of C<val> before
1720 the call, and decrementing it if the function returned NULL. Effectively
1721 a successful hv_store takes ownership of one reference to C<val>. This is
1722 usually what you want; a newly created SV has a reference count of one, so
1723 if all your code does is create SVs then store them in a hash, hv_store
1724 will own the only reference to the new SV, and your code doesn't need to do
1725 anything further to tidy up. hv_store is not implemented as a call to
1726 hv_store_ent, and does not create a temporary SV for the key, so if your
1727 key data is not already in SV form then use hv_store in preference to
1730 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1731 information on how to use this function on tied hashes.
1733 SV** hv_store(HV* tb, const char* key, I32 klen, SV* val, U32 hash)
1741 Like C<hv_store>, but takes a literal string instead of a string/length pair
1742 and omits the hash parameter.
1744 SV** hv_stores(HV* tb, const char* key, NULLOK SV* val)
1747 Found in file handy.h
1752 Stores C<val> in a hash. The hash key is specified as C<key>. The C<hash>
1753 parameter is the precomputed hash value; if it is zero then Perl will
1754 compute it. The return value is the new hash entry so created. It will be
1755 NULL if the operation failed or if the value did not need to be actually
1756 stored within the hash (as in the case of tied hashes). Otherwise the
1757 contents of the return value can be accessed using the C<He?> macros
1758 described here. Note that the caller is responsible for suitably
1759 incrementing the reference count of C<val> before the call, and
1760 decrementing it if the function returned NULL. Effectively a successful
1761 hv_store_ent takes ownership of one reference to C<val>. This is
1762 usually what you want; a newly created SV has a reference count of one, so
1763 if all your code does is create SVs then store them in a hash, hv_store
1764 will own the only reference to the new SV, and your code doesn't need to do
1765 anything further to tidy up. Note that hv_store_ent only reads the C<key>;
1766 unlike C<val> it does not take ownership of it, so maintaining the correct
1767 reference count on C<key> is entirely the caller's responsibility. hv_store
1768 is not implemented as a call to hv_store_ent, and does not create a temporary
1769 SV for the key, so if your key data is not already in SV form then use
1770 hv_store in preference to hv_store_ent.
1772 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1773 information on how to use this function on tied hashes.
1775 HE* hv_store_ent(HV* tb, SV* key, SV* val, U32 hash)
1785 void hv_undef(HV* tb)
1793 Creates a new HV. The reference count is set to 1.
1803 =head1 Magical Functions
1810 Clear something magical that the SV represents. See C<sv_magic>.
1812 int mg_clear(SV* sv)
1820 Copies the magic from one SV to another. See C<sv_magic>.
1822 int mg_copy(SV* sv, SV* nsv, const char* key, I32 klen)
1830 Finds the magic pointer for type matching the SV. See C<sv_magic>.
1832 MAGIC* mg_find(const SV* sv, int type)
1840 Free any magic storage used by the SV. See C<sv_magic>.
1850 Do magic after a value is retrieved from the SV. See C<sv_magic>.
1860 Report on the SV's length. See C<sv_magic>.
1862 U32 mg_length(SV* sv)
1870 Turns on the magical status of an SV. See C<sv_magic>.
1872 void mg_magical(SV* sv)
1880 Do magic after a value is assigned to the SV. See C<sv_magic>.
1890 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
1891 argument more than once.
1893 void SvGETMAGIC(SV* sv)
1901 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
1912 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
1913 argument more than once.
1915 void SvSETMAGIC(SV* sv)
1923 Like C<SvSetSV>, but does any set magic required afterwards.
1925 void SvSetMagicSV(SV* dsb, SV* ssv)
1930 =item SvSetMagicSV_nosteal
1931 X<SvSetMagicSV_nosteal>
1933 Like C<SvSetSV_nosteal>, but does any set magic required afterwards.
1935 void SvSetMagicSV_nosteal(SV* dsv, SV* ssv)
1943 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
1946 void SvSetSV(SV* dsb, SV* ssv)
1951 =item SvSetSV_nosteal
1954 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
1955 ssv. May evaluate arguments more than once.
1957 void SvSetSV_nosteal(SV* dsv, SV* ssv)
1965 Arranges for sv to be shared between threads if a suitable module
1968 void SvSHARE(SV* sv)
1976 Releases a mutual exclusion lock on sv if a suitable module
1979 void SvUNLOCK(SV* sv)
1987 =head1 Memory Management
1994 The XSUB-writer's interface to the C C<memcpy> function. The C<src> is the
1995 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1996 the type. May fail on overlapping copies. See also C<Move>.
1998 void Copy(void* src, void* dest, int nitems, type)
2001 Found in file handy.h
2006 Like C<Copy> but returns dest. Useful for encouraging compilers to tail-call
2009 void * CopyD(void* src, void* dest, int nitems, type)
2012 Found in file handy.h
2017 The XSUB-writer's interface to the C C<memmove> function. The C<src> is the
2018 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
2019 the type. Can do overlapping moves. See also C<Copy>.
2021 void Move(void* src, void* dest, int nitems, type)
2024 Found in file handy.h
2029 Like C<Move> but returns dest. Useful for encouraging compilers to tail-call
2032 void * MoveD(void* src, void* dest, int nitems, type)
2035 Found in file handy.h
2040 The XSUB-writer's interface to the C C<malloc> function.
2042 In 5.9.3, Newx() and friends replace the older New() API, and drops
2043 the first parameter, I<x>, a debug aid which allowed callers to identify
2044 themselves. This aid has been superseded by a new build option,
2045 PERL_MEM_LOG (see L<perlhack/PERL_MEM_LOG>). The older API is still
2046 there for use in XS modules supporting older perls.
2048 void Newx(void* ptr, int nitems, type)
2051 Found in file handy.h
2056 The XSUB-writer's interface to the C C<malloc> function, with
2057 cast. See also C<Newx>.
2059 void Newxc(void* ptr, int nitems, type, cast)
2062 Found in file handy.h
2067 The XSUB-writer's interface to the C C<malloc> function. The allocated
2068 memory is zeroed with C<memzero>. See also C<Newx>.
2070 void Newxz(void* ptr, int nitems, type)
2073 Found in file handy.h
2078 PoisonWith(0xEF) for catching access to freed memory.
2080 void Poison(void* dest, int nitems, type)
2083 Found in file handy.h
2088 PoisonWith(0xEF) for catching access to freed memory.
2090 void PoisonFree(void* dest, int nitems, type)
2093 Found in file handy.h
2098 PoisonWith(0xAB) for catching access to allocated but uninitialized memory.
2100 void PoisonNew(void* dest, int nitems, type)
2103 Found in file handy.h
2108 Fill up memory with a byte pattern (a byte repeated over and over
2109 again) that hopefully catches attempts to access uninitialized memory.
2111 void PoisonWith(void* dest, int nitems, type, U8 byte)
2114 Found in file handy.h
2119 The XSUB-writer's interface to the C C<realloc> function.
2121 void Renew(void* ptr, int nitems, type)
2124 Found in file handy.h
2129 The XSUB-writer's interface to the C C<realloc> function, with
2132 void Renewc(void* ptr, int nitems, type, cast)
2135 Found in file handy.h
2140 The XSUB-writer's interface to the C C<free> function.
2142 void Safefree(void* ptr)
2145 Found in file handy.h
2150 Perl's version of C<strdup()>. Returns a pointer to a newly allocated
2151 string which is a duplicate of C<pv>. The size of the string is
2152 determined by C<strlen()>. The memory allocated for the new string can
2153 be freed with the C<Safefree()> function.
2155 char* savepv(const char* pv)
2158 Found in file util.c
2163 Perl's version of what C<strndup()> would be if it existed. Returns a
2164 pointer to a newly allocated string which is a duplicate of the first
2165 C<len> bytes from C<pv>, plus a trailing NUL byte. The memory allocated for
2166 the new string can be freed with the C<Safefree()> function.
2168 char* savepvn(const char* pv, I32 len)
2171 Found in file util.c
2176 Like C<savepvn>, but takes a literal string instead of a string/length pair.
2178 char* savepvs(const char* s)
2181 Found in file handy.h
2186 A version of C<savepv()> which allocates the duplicate string in memory
2187 which is shared between threads.
2189 char* savesharedpv(const char* pv)
2192 Found in file util.c
2197 A version of C<savepv()>/C<savepvn()> which gets the string to duplicate from
2198 the passed in SV using C<SvPV()>
2200 char* savesvpv(SV* sv)
2203 Found in file util.c
2208 This is an architecture-independent macro to copy one structure to another.
2210 void StructCopy(type src, type dest, type)
2213 Found in file handy.h
2218 The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the
2219 destination, C<nitems> is the number of items, and C<type> is the type.
2221 void Zero(void* dest, int nitems, type)
2224 Found in file handy.h
2229 Like C<Zero> but returns dest. Useful for encouraging compilers to tail-call
2232 void * ZeroD(void* dest, int nitems, type)
2235 Found in file handy.h
2240 =head1 Miscellaneous Functions
2247 Analyses the string in order to make fast searches on it using fbm_instr()
2248 -- the Boyer-Moore algorithm.
2250 void fbm_compile(SV* sv, U32 flags)
2253 Found in file util.c
2258 Returns the location of the SV in the string delimited by C<str> and
2259 C<strend>. It returns C<NULL> if the string can't be found. The C<sv>
2260 does not have to be fbm_compiled, but the search will not be as fast
2263 char* fbm_instr(unsigned char* big, unsigned char* bigend, SV* littlesv, U32 flags)
2266 Found in file util.c
2271 Takes a sprintf-style format pattern and conventional
2272 (non-SV) arguments and returns the formatted string.
2274 (char *) Perl_form(pTHX_ const char* pat, ...)
2276 can be used any place a string (char *) is required:
2278 char * s = Perl_form("%d.%d",major,minor);
2280 Uses a single private buffer so if you want to format several strings you
2281 must explicitly copy the earlier strings away (and free the copies when you
2284 char* form(const char* pat, ...)
2287 Found in file util.c
2292 Fill the sv with current working directory
2294 int getcwd_sv(SV* sv)
2297 Found in file util.c
2302 The C library C<snprintf> functionality, if available and
2303 standards-compliant (uses C<vsnprintf>, actually). However, if the
2304 C<vsnprintf> is not available, will unfortunately use the unsafe
2305 C<vsprintf> which can overrun the buffer (there is an overrun check,
2306 but that may be too late). Consider using C<sv_vcatpvf> instead, or
2307 getting C<vsnprintf>.
2309 int my_snprintf(char *buffer, const Size_t len, const char *format, ...)
2312 Found in file util.c
2317 The C library C<sprintf>, wrapped if necessary, to ensure that it will return
2318 the length of the string written to the buffer. Only rare pre-ANSI systems
2319 need the wrapper function - usually this is a direct call to C<sprintf>.
2321 int my_sprintf(char *buffer, const char *pat, ...)
2324 Found in file util.c
2329 The C library C<vsnprintf> if available and standards-compliant.
2330 However, if if the C<vsnprintf> is not available, will unfortunately
2331 use the unsafe C<vsprintf> which can overrun the buffer (there is an
2332 overrun check, but that may be too late). Consider using
2333 C<sv_vcatpvf> instead, or getting C<vsnprintf>.
2335 int my_vsnprintf(char *buffer, const Size_t len, const char *format, va_list ap)
2338 Found in file util.c
2343 Returns a new version object based on the passed in SV:
2345 SV *sv = new_version(SV *ver);
2347 Does not alter the passed in ver SV. See "upg_version" if you
2348 want to upgrade the SV.
2350 SV* new_version(SV *ver)
2353 Found in file util.c
2358 Returns a pointer to the next character after the parsed
2359 version string, as well as upgrading the passed in SV to
2362 Function must be called with an already existing SV like
2365 s = scan_version(s,SV *sv, bool qv);
2367 Performs some preprocessing to the string to ensure that
2368 it has the correct characteristics of a version. Flags the
2369 object if it contains an underscore (which denotes this
2370 is a alpha version). The boolean qv denotes that the version
2371 should be interpreted as if it had multiple decimals, even if
2374 const char* scan_version(const char *vstr, SV *sv, bool qv)
2377 Found in file util.c
2382 Test two strings to see if they are equal. Returns true or false.
2384 bool strEQ(char* s1, char* s2)
2387 Found in file handy.h
2392 Test two strings to see if the first, C<s1>, is greater than or equal to
2393 the second, C<s2>. Returns true or false.
2395 bool strGE(char* s1, char* s2)
2398 Found in file handy.h
2403 Test two strings to see if the first, C<s1>, is greater than the second,
2404 C<s2>. Returns true or false.
2406 bool strGT(char* s1, char* s2)
2409 Found in file handy.h
2414 Test two strings to see if the first, C<s1>, is less than or equal to the
2415 second, C<s2>. Returns true or false.
2417 bool strLE(char* s1, char* s2)
2420 Found in file handy.h
2425 Test two strings to see if the first, C<s1>, is less than the second,
2426 C<s2>. Returns true or false.
2428 bool strLT(char* s1, char* s2)
2431 Found in file handy.h
2436 Test two strings to see if they are different. Returns true or
2439 bool strNE(char* s1, char* s2)
2442 Found in file handy.h
2447 Test two strings to see if they are equal. The C<len> parameter indicates
2448 the number of bytes to compare. Returns true or false. (A wrapper for
2451 bool strnEQ(char* s1, char* s2, STRLEN len)
2454 Found in file handy.h
2459 Test two strings to see if they are different. The C<len> parameter
2460 indicates the number of bytes to compare. Returns true or false. (A
2461 wrapper for C<strncmp>).
2463 bool strnNE(char* s1, char* s2, STRLEN len)
2466 Found in file handy.h
2471 Dummy routine which "shares" an SV when there is no sharing module present.
2472 Or "locks" it. Or "unlocks" it. In other words, ignores its single SV argument.
2473 Exists to avoid test for a NULL function pointer and because it could
2474 potentially warn under some level of strict-ness.
2476 void sv_nosharing(SV *sv)
2479 Found in file util.c
2484 In-place upgrade of the supplied SV to a version object.
2486 SV *sv = upg_version(SV *sv);
2488 Returns a pointer to the upgraded SV.
2490 SV* upg_version(SV *ver)
2493 Found in file util.c
2498 Version object aware cmp. Both operands must already have been
2499 converted into version objects.
2501 int vcmp(SV *lvs, SV *rvs)
2504 Found in file util.c
2509 Accepts a version object and returns the normalized string
2510 representation. Call like:
2514 NOTE: you can pass either the object directly or the SV
2515 contained within the RV.
2520 Found in file util.c
2525 Accepts a version object and returns the normalized floating
2526 point representation. Call like:
2530 NOTE: you can pass either the object directly or the SV
2531 contained within the RV.
2536 Found in file util.c
2541 In order to maintain maximum compatibility with earlier versions
2542 of Perl, this function will return either the floating point
2543 notation or the multiple dotted notation, depending on whether
2544 the original version contained 1 or more dots, respectively
2546 SV* vstringify(SV *vs)
2549 Found in file util.c
2554 Validates that the SV contains a valid version object.
2556 bool vverify(SV *vobj);
2558 Note that it only confirms the bare minimum structure (so as not to get
2559 confused by derived classes which may contain additional hash entries):
2561 bool vverify(SV *vs)
2564 Found in file util.c
2569 =head1 Multicall Functions
2576 Declare local variables for a multicall. See L<perlcall/Lightweight Callbacks>.
2586 Make a lightweight callback. See L<perlcall/Lightweight Callbacks>.
2596 Closing bracket for a lightweight callback.
2597 See L<perlcall/Lightweight Callbacks>.
2604 =item PUSH_MULTICALL
2607 Opening bracket for a lightweight callback.
2608 See L<perlcall/Lightweight Callbacks>.
2618 =head1 Numeric functions
2625 converts a string representing a binary number to numeric form.
2627 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2628 conversion flags, and I<result> should be NULL or a pointer to an NV.
2629 The scan stops at the end of the string, or the first invalid character.
2630 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2631 invalid character will also trigger a warning.
2632 On return I<*len> is set to the length of the scanned string,
2633 and I<*flags> gives output flags.
2635 If the value is <= C<UV_MAX> it is returned as a UV, the output flags are clear,
2636 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_bin>
2637 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2638 and writes the value to I<*result> (or the value is discarded if I<result>
2641 The binary number may optionally be prefixed with "0b" or "b" unless
2642 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
2643 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the binary
2644 number may use '_' characters to separate digits.
2646 UV grok_bin(const char* start, STRLEN* len_p, I32* flags, NV *result)
2649 Found in file numeric.c
2654 converts a string representing a hex number to numeric form.
2656 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2657 conversion flags, and I<result> should be NULL or a pointer to an NV.
2658 The scan stops at the end of the string, or the first invalid character.
2659 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2660 invalid character will also trigger a warning.
2661 On return I<*len> is set to the length of the scanned string,
2662 and I<*flags> gives output flags.
2664 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2665 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_hex>
2666 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2667 and writes the value to I<*result> (or the value is discarded if I<result>
2670 The hex number may optionally be prefixed with "0x" or "x" unless
2671 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
2672 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the hex
2673 number may use '_' characters to separate digits.
2675 UV grok_hex(const char* start, STRLEN* len_p, I32* flags, NV *result)
2678 Found in file numeric.c
2683 Recognise (or not) a number. The type of the number is returned
2684 (0 if unrecognised), otherwise it is a bit-ORed combination of
2685 IS_NUMBER_IN_UV, IS_NUMBER_GREATER_THAN_UV_MAX, IS_NUMBER_NOT_INT,
2686 IS_NUMBER_NEG, IS_NUMBER_INFINITY, IS_NUMBER_NAN (defined in perl.h).
2688 If the value of the number can fit an in UV, it is returned in the *valuep
2689 IS_NUMBER_IN_UV will be set to indicate that *valuep is valid, IS_NUMBER_IN_UV
2690 will never be set unless *valuep is valid, but *valuep may have been assigned
2691 to during processing even though IS_NUMBER_IN_UV is not set on return.
2692 If valuep is NULL, IS_NUMBER_IN_UV will be set for the same cases as when
2693 valuep is non-NULL, but no actual assignment (or SEGV) will occur.
2695 IS_NUMBER_NOT_INT will be set with IS_NUMBER_IN_UV if trailing decimals were
2696 seen (in which case *valuep gives the true value truncated to an integer), and
2697 IS_NUMBER_NEG if the number is negative (in which case *valuep holds the
2698 absolute value). IS_NUMBER_IN_UV is not set if e notation was used or the
2699 number is larger than a UV.
2701 int grok_number(const char *pv, STRLEN len, UV *valuep)
2704 Found in file numeric.c
2706 =item grok_numeric_radix
2707 X<grok_numeric_radix>
2709 Scan and skip for a numeric decimal separator (radix).
2711 bool grok_numeric_radix(const char **sp, const char *send)
2714 Found in file numeric.c
2719 converts a string representing an octal number to numeric form.
2721 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2722 conversion flags, and I<result> should be NULL or a pointer to an NV.
2723 The scan stops at the end of the string, or the first invalid character.
2724 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2725 invalid character will also trigger a warning.
2726 On return I<*len> is set to the length of the scanned string,
2727 and I<*flags> gives output flags.
2729 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2730 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_oct>
2731 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2732 and writes the value to I<*result> (or the value is discarded if I<result>
2735 If C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the octal
2736 number may use '_' characters to separate digits.
2738 UV grok_oct(const char* start, STRLEN* len_p, I32* flags, NV *result)
2741 Found in file numeric.c
2746 For backwards compatibility. Use C<grok_bin> instead.
2748 NV scan_bin(const char* start, STRLEN len, STRLEN* retlen)
2751 Found in file numeric.c
2756 For backwards compatibility. Use C<grok_hex> instead.
2758 NV scan_hex(const char* start, STRLEN len, STRLEN* retlen)
2761 Found in file numeric.c
2766 For backwards compatibility. Use C<grok_oct> instead.
2768 NV scan_oct(const char* start, STRLEN len, STRLEN* retlen)
2771 Found in file numeric.c
2776 =head1 Optree Manipulation Functions
2783 If C<cv> is a constant sub eligible for inlining. returns the constant
2784 value returned by the sub. Otherwise, returns NULL.
2786 Constant subs can be created with C<newCONSTSUB> or as described in
2787 L<perlsub/"Constant Functions">.
2789 SV* cv_const_sv(CV* cv)
2797 Creates a constant sub equivalent to Perl C<sub FOO () { 123 }> which is
2798 eligible for inlining at compile-time.
2800 CV* newCONSTSUB(HV* stash, const char* name, SV* sv)
2808 Used by C<xsubpp> to hook up XSUBs as Perl subs. I<filename> needs to be
2809 static storage, as it is used directly as CvFILE(), without a copy being made.
2817 =head1 Pad Data Structures
2824 Get the value at offset po in the current pad.
2825 Use macro PAD_SV instead of calling this function directly.
2827 SV* pad_sv(PADOFFSET po)
2835 =head1 Simple Exception Handling Macros
2842 Set up necessary local variables for exception handling.
2843 See L<perlguts/"Exception Handling">.
2848 Found in file XSUB.h
2853 Introduces a catch block. See L<perlguts/"Exception Handling">.
2856 Found in file XSUB.h
2861 Rethrows a previously caught exception. See L<perlguts/"Exception Handling">.
2866 Found in file XSUB.h
2871 Ends a try block. See L<perlguts/"Exception Handling">.
2874 Found in file XSUB.h
2876 =item XCPT_TRY_START
2879 Starts a try block. See L<perlguts/"Exception Handling">.
2882 Found in file XSUB.h
2887 =head1 Stack Manipulation Macros
2894 Declare a stack marker variable, C<mark>, for the XSUB. See C<MARK> and
2905 Saves the original stack mark for the XSUB. See C<ORIGMARK>.
2915 Declares a local copy of perl's stack pointer for the XSUB, available via
2916 the C<SP> macro. See C<SP>.
2926 Used to extend the argument stack for an XSUB's return values. Once
2927 used, guarantees that there is room for at least C<nitems> to be pushed
2930 void EXTEND(SP, int nitems)
2938 Stack marker variable for the XSUB. See C<dMARK>.
2946 Push an integer onto the stack. The stack must have room for this element.
2947 Handles 'set' magic. Does not use C<TARG>. See also C<PUSHi>, C<mXPUSHi>
2958 Push a double onto the stack. The stack must have room for this element.
2959 Handles 'set' magic. Does not use C<TARG>. See also C<PUSHn>, C<mXPUSHn>
2970 Push a string onto the stack. The stack must have room for this element.
2971 The C<len> indicates the length of the string. Handles 'set' magic. Does
2972 not use C<TARG>. See also C<PUSHp>, C<mXPUSHp> and C<XPUSHp>.
2974 void mPUSHp(char* str, STRLEN len)
2982 Push an unsigned integer onto the stack. The stack must have room for this
2983 element. Handles 'set' magic. Does not use C<TARG>. See also C<PUSHu>,
2984 C<mXPUSHu> and C<XPUSHu>.
2994 Push an integer onto the stack, extending the stack if necessary. Handles
2995 'set' magic. Does not use C<TARG>. See also C<XPUSHi>, C<mPUSHi> and
3006 Push a double onto the stack, extending the stack if necessary. Handles
3007 'set' magic. Does not use C<TARG>. See also C<XPUSHn>, C<mPUSHn> and
3018 Push a string onto the stack, extending the stack if necessary. The C<len>
3019 indicates the length of the string. Handles 'set' magic. Does not use
3020 C<TARG>. See also C<XPUSHp>, C<mPUSHp> and C<PUSHp>.
3022 void mXPUSHp(char* str, STRLEN len)
3030 Push an unsigned integer onto the stack, extending the stack if necessary.
3031 Handles 'set' magic. Does not use C<TARG>. See also C<XPUSHu>, C<mPUSHu>
3042 The original stack mark for the XSUB. See C<dORIGMARK>.
3050 Pops an integer off the stack.
3060 Pops a long off the stack.
3070 Pops a double off the stack.
3080 Pops a string off the stack. Deprecated. New code should use POPpx.
3090 Pops a string off the stack which must consist of bytes i.e. characters < 256.
3100 Pops a string off the stack.
3110 Pops an SV off the stack.
3120 Push an integer onto the stack. The stack must have room for this element.
3121 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3122 called to declare it. Do not call multiple C<TARG>-oriented macros to
3123 return lists from XSUB's - see C<mPUSHi> instead. See also C<XPUSHi> and
3134 Opening bracket for arguments on a callback. See C<PUTBACK> and
3145 Push a new mortal SV onto the stack. The stack must have room for this
3146 element. Does not handle 'set' magic. Does not use C<TARG>. See also
3147 C<PUSHs>, C<XPUSHmortal> and C<XPUSHs>.
3157 Push a double onto the stack. The stack must have room for this element.
3158 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3159 called to declare it. Do not call multiple C<TARG>-oriented macros to
3160 return lists from XSUB's - see C<mPUSHn> instead. See also C<XPUSHn> and
3171 Push a string onto the stack. The stack must have room for this element.
3172 The C<len> indicates the length of the string. Handles 'set' magic. Uses
3173 C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to declare it. Do not
3174 call multiple C<TARG>-oriented macros to return lists from XSUB's - see
3175 C<mPUSHp> instead. See also C<XPUSHp> and C<mXPUSHp>.
3177 void PUSHp(char* str, STRLEN len)
3185 Push an SV onto the stack. The stack must have room for this element.
3186 Does not handle 'set' magic. Does not use C<TARG>. See also C<PUSHmortal>,
3187 C<XPUSHs> and C<XPUSHmortal>.
3197 Push an unsigned integer onto the stack. The stack must have room for this
3198 element. Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG>
3199 should be called to declare it. Do not call multiple C<TARG>-oriented
3200 macros to return lists from XSUB's - see C<mPUSHu> instead. See also
3201 C<XPUSHu> and C<mXPUSHu>.
3211 Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
3212 See C<PUSHMARK> and L<perlcall> for other uses.
3222 Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and
3231 Refetch the stack pointer. Used after a callback. See L<perlcall>.
3241 Push an integer onto the stack, extending the stack if necessary. Handles
3242 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
3243 declare it. Do not call multiple C<TARG>-oriented macros to return lists
3244 from XSUB's - see C<mXPUSHi> instead. See also C<PUSHi> and C<mPUSHi>.
3254 Push a new mortal SV onto the stack, extending the stack if necessary. Does
3255 not handle 'set' magic. Does not use C<TARG>. See also C<XPUSHs>,
3256 C<PUSHmortal> and C<PUSHs>.
3266 Push a double onto the stack, extending the stack if necessary. Handles
3267 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
3268 declare it. Do not call multiple C<TARG>-oriented macros to return lists
3269 from XSUB's - see C<mXPUSHn> instead. See also C<PUSHn> and C<mPUSHn>.
3279 Push a string onto the stack, extending the stack if necessary. The C<len>
3280 indicates the length of the string. Handles 'set' magic. Uses C<TARG>, so
3281 C<dTARGET> or C<dXSTARG> should be called to declare it. Do not call
3282 multiple C<TARG>-oriented macros to return lists from XSUB's - see
3283 C<mXPUSHp> instead. See also C<PUSHp> and C<mPUSHp>.
3285 void XPUSHp(char* str, STRLEN len)
3293 Push an SV onto the stack, extending the stack if necessary. Does not
3294 handle 'set' magic. Does not use C<TARG>. See also C<XPUSHmortal>,
3295 C<PUSHs> and C<PUSHmortal>.
3305 Push an unsigned integer onto the stack, extending the stack if necessary.
3306 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3307 called to declare it. Do not call multiple C<TARG>-oriented macros to
3308 return lists from XSUB's - see C<mXPUSHu> instead. See also C<PUSHu> and
3319 Return from XSUB, indicating number of items on the stack. This is usually
3320 handled by C<xsubpp>.
3322 void XSRETURN(int nitems)
3325 Found in file XSUB.h
3327 =item XSRETURN_EMPTY
3330 Return an empty list from an XSUB immediately.
3335 Found in file XSUB.h
3340 Return an integer from an XSUB immediately. Uses C<XST_mIV>.
3342 void XSRETURN_IV(IV iv)
3345 Found in file XSUB.h
3350 Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
3355 Found in file XSUB.h
3360 Return a double from an XSUB immediately. Uses C<XST_mNV>.
3362 void XSRETURN_NV(NV nv)
3365 Found in file XSUB.h
3370 Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
3372 void XSRETURN_PV(char* str)
3375 Found in file XSUB.h
3377 =item XSRETURN_UNDEF
3380 Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
3385 Found in file XSUB.h
3390 Return an integer from an XSUB immediately. Uses C<XST_mUV>.
3392 void XSRETURN_UV(IV uv)
3395 Found in file XSUB.h
3400 Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
3405 Found in file XSUB.h
3410 Place an integer into the specified position C<pos> on the stack. The
3411 value is stored in a new mortal SV.
3413 void XST_mIV(int pos, IV iv)
3416 Found in file XSUB.h
3421 Place C<&PL_sv_no> into the specified position C<pos> on the
3424 void XST_mNO(int pos)
3427 Found in file XSUB.h
3432 Place a double into the specified position C<pos> on the stack. The value
3433 is stored in a new mortal SV.
3435 void XST_mNV(int pos, NV nv)
3438 Found in file XSUB.h
3443 Place a copy of a string into the specified position C<pos> on the stack.
3444 The value is stored in a new mortal SV.
3446 void XST_mPV(int pos, char* str)
3449 Found in file XSUB.h
3454 Place C<&PL_sv_undef> into the specified position C<pos> on the
3457 void XST_mUNDEF(int pos)
3460 Found in file XSUB.h
3465 Place C<&PL_sv_yes> into the specified position C<pos> on the
3468 void XST_mYES(int pos)
3471 Found in file XSUB.h
3483 An enum of flags for Perl types. These are found in the file B<sv.h>
3484 in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
3492 Integer type flag for scalars. See C<svtype>.
3500 Double type flag for scalars. See C<svtype>.
3508 Pointer type flag for scalars. See C<svtype>.
3516 Type flag for arrays. See C<svtype>.
3524 Type flag for code refs. See C<svtype>.
3532 Type flag for hashes. See C<svtype>.
3540 Type flag for blessed scalars. See C<svtype>.
3548 =head1 SV Manipulation Functions
3555 Returns the SV of the specified Perl scalar. If C<create> is set and the
3556 Perl variable does not exist then it will be created. If C<create> is not
3557 set and the variable does not exist then NULL is returned.
3559 NOTE: the perl_ form of this function is deprecated.
3561 SV* get_sv(const char* name, I32 create)
3564 Found in file perl.c
3569 Creates an RV wrapper for an SV. The reference count for the original SV is
3572 SV* newRV_inc(SV* sv)
3580 Returns the length of the string which is in the SV. See C<SvLEN>.
3582 STRLEN SvCUR(SV* sv)
3590 Set the current length of the string which is in the SV. See C<SvCUR>
3593 void SvCUR_set(SV* sv, STRLEN len)
3601 Returns a pointer to the last character in the string which is in the SV.
3602 See C<SvCUR>. Access the character as *(SvEND(sv)).
3612 Returns true if the SV has get magic or overloading. If either is true then
3613 the scalar is active data, and has the potential to return a new value every
3614 time it is accessed. Hence you must be careful to only read it once per user
3615 logical operation and work with that returned value. If neither is true then
3616 the scalar's value cannot change unless written to.
3618 char* SvGAMAGIC(SV* sv)
3626 Expands the character buffer in the SV so that it has room for the
3627 indicated number of bytes (remember to reserve space for an extra trailing
3628 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
3629 Returns a pointer to the character buffer.
3631 char * SvGROW(SV* sv, STRLEN len)
3639 Returns a boolean indicating whether the SV contains an integer.
3649 Returns a boolean indicating whether the SV contains an integer. Checks
3650 the B<private> setting. Use C<SvIOK>.
3660 Returns a boolean indicating whether the SV contains a signed integer.
3662 bool SvIOK_notUV(SV* sv)
3670 Unsets the IV status of an SV.
3672 void SvIOK_off(SV* sv)
3680 Tells an SV that it is an integer.
3682 void SvIOK_on(SV* sv)
3690 Tells an SV that it is an integer and disables all other OK bits.
3692 void SvIOK_only(SV* sv)
3700 Tells and SV that it is an unsigned integer and disables all other OK bits.
3702 void SvIOK_only_UV(SV* sv)
3710 Returns a boolean indicating whether the SV contains an unsigned integer.
3712 bool SvIOK_UV(SV* sv)
3720 Returns a boolean indicating whether the SV is Copy-On-Write. (either shared
3721 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
3724 bool SvIsCOW(SV* sv)
3729 =item SvIsCOW_shared_hash
3730 X<SvIsCOW_shared_hash>
3732 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
3735 bool SvIsCOW_shared_hash(SV* sv)
3743 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
3744 version which guarantees to evaluate sv only once.
3754 Returns the raw value in the SV's IV slot, without checks or conversions.
3755 Only use when you are sure SvIOK is true. See also C<SvIV()>.
3765 Coerces the given SV to an integer and returns it. Guarantees to evaluate
3766 sv only once. Use the more efficient C<SvIV> otherwise.
3776 Like C<SvIV> but doesn't process magic.
3778 IV SvIV_nomg(SV* sv)
3786 Set the value of the IV pointer in sv to val. It is possible to perform
3787 the same function of this macro with an lvalue assignment to C<SvIVX>.
3788 With future Perls, however, it will be more efficient to use
3789 C<SvIV_set> instead of the lvalue assignment to C<SvIVX>.
3791 void SvIV_set(SV* sv, IV val)
3799 Returns the size of the string buffer in the SV, not including any part
3800 attributable to C<SvOOK>. See C<SvCUR>.
3802 STRLEN SvLEN(SV* sv)
3810 Set the actual length of the string which is in the SV. See C<SvIV_set>.
3812 void SvLEN_set(SV* sv, STRLEN len)
3820 Set the value of the MAGIC pointer in sv to val. See C<SvIV_set>.
3822 void SvMAGIC_set(SV* sv, MAGIC* val)
3830 Returns a boolean indicating whether the SV contains a number, integer or
3841 Returns a boolean indicating whether the SV contains a number, integer or
3842 double. Checks the B<private> setting. Use C<SvNIOK>.
3844 bool SvNIOKp(SV* sv)
3852 Unsets the NV/IV status of an SV.
3854 void SvNIOK_off(SV* sv)
3862 Returns a boolean indicating whether the SV contains a double.
3872 Returns a boolean indicating whether the SV contains a double. Checks the
3873 B<private> setting. Use C<SvNOK>.
3883 Unsets the NV status of an SV.
3885 void SvNOK_off(SV* sv)
3893 Tells an SV that it is a double.
3895 void SvNOK_on(SV* sv)
3903 Tells an SV that it is a double and disables all other OK bits.
3905 void SvNOK_only(SV* sv)
3913 Coerce the given SV to a double and return it. See C<SvNVx> for a version
3914 which guarantees to evaluate sv only once.
3924 Returns the raw value in the SV's NV slot, without checks or conversions.
3925 Only use when you are sure SvNOK is true. See also C<SvNV()>.
3935 Coerces the given SV to a double and returns it. Guarantees to evaluate
3936 sv only once. Use the more efficient C<SvNV> otherwise.
3946 Set the value of the NV pointer in sv to val. See C<SvIV_set>.
3948 void SvNV_set(SV* sv, NV val)
3956 Returns a boolean indicating whether the value is an SV. It also tells
3957 whether the value is defined or not.
3967 Returns a boolean indicating whether the SvIVX is a valid offset value for
3968 the SvPVX. This hack is used internally to speed up removal of characters
3969 from the beginning of a SvPV. When SvOOK is true, then the start of the
3970 allocated string buffer is really (SvPVX - SvIVX).
3980 Returns a boolean indicating whether the SV contains a character
3991 Returns a boolean indicating whether the SV contains a character string.
3992 Checks the B<private> setting. Use C<SvPOK>.
4002 Unsets the PV status of an SV.
4004 void SvPOK_off(SV* sv)
4012 Tells an SV that it is a string.
4014 void SvPOK_on(SV* sv)
4022 Tells an SV that it is a string and disables all other OK bits.
4023 Will also turn off the UTF-8 status.
4025 void SvPOK_only(SV* sv)
4030 =item SvPOK_only_UTF8
4033 Tells an SV that it is a string and disables all other OK bits,
4034 and leaves the UTF-8 status as it was.
4036 void SvPOK_only_UTF8(SV* sv)
4044 Returns a pointer to the string in the SV, or a stringified form of
4045 the SV if the SV does not contain a string. The SV may cache the
4046 stringified version becoming C<SvPOK>. Handles 'get' magic. See also
4047 C<SvPVx> for a version which guarantees to evaluate sv only once.
4049 char* SvPV(SV* sv, STRLEN len)
4057 Like C<SvPV>, but converts sv to byte representation first if necessary.
4059 char* SvPVbyte(SV* sv, STRLEN len)
4067 Like C<SvPV>, but converts sv to byte representation first if necessary.
4068 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
4071 char* SvPVbytex(SV* sv, STRLEN len)
4076 =item SvPVbytex_force
4079 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
4080 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
4083 char* SvPVbytex_force(SV* sv, STRLEN len)
4088 =item SvPVbyte_force
4091 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
4093 char* SvPVbyte_force(SV* sv, STRLEN len)
4098 =item SvPVbyte_nolen
4101 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
4103 char* SvPVbyte_nolen(SV* sv)
4111 Like C<SvPV>, but converts sv to utf8 first if necessary.
4113 char* SvPVutf8(SV* sv, STRLEN len)
4121 Like C<SvPV>, but converts sv to utf8 first if necessary.
4122 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
4125 char* SvPVutf8x(SV* sv, STRLEN len)
4130 =item SvPVutf8x_force
4133 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
4134 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
4137 char* SvPVutf8x_force(SV* sv, STRLEN len)
4142 =item SvPVutf8_force
4145 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
4147 char* SvPVutf8_force(SV* sv, STRLEN len)
4152 =item SvPVutf8_nolen
4155 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
4157 char* SvPVutf8_nolen(SV* sv)
4165 Returns a pointer to the physical string in the SV. The SV must contain a
4176 A version of C<SvPV> which guarantees to evaluate sv only once.
4178 char* SvPVx(SV* sv, STRLEN len)
4186 Like C<SvPV> but will force the SV into containing just a string
4187 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
4190 char* SvPV_force(SV* sv, STRLEN len)
4195 =item SvPV_force_nomg
4198 Like C<SvPV> but will force the SV into containing just a string
4199 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
4200 directly. Doesn't process magic.
4202 char* SvPV_force_nomg(SV* sv, STRLEN len)
4210 Returns a pointer to the string in the SV, or a stringified form of
4211 the SV if the SV does not contain a string. The SV may cache the
4212 stringified form becoming C<SvPOK>. Handles 'get' magic.
4214 char* SvPV_nolen(SV* sv)
4222 Like C<SvPV> but doesn't process magic.
4224 char* SvPV_nomg(SV* sv, STRLEN len)
4232 Set the value of the PV pointer in sv to val. See C<SvIV_set>.
4234 void SvPV_set(SV* sv, char* val)
4242 Returns the value of the object's reference count.
4244 U32 SvREFCNT(SV* sv)
4252 Decrements the reference count of the given SV.
4254 void SvREFCNT_dec(SV* sv)
4262 Increments the reference count of the given SV.
4264 All of the following SvREFCNT_inc* macros are optimized versions of
4265 SvREFCNT_inc, and can be replaced with SvREFCNT_inc.
4267 SV* SvREFCNT_inc(SV* sv)
4272 =item SvREFCNT_inc_NN
4275 Same as SvREFCNT_inc, but can only be used if you know I<sv>
4276 is not NULL. Since we don't have to check the NULLness, it's faster
4279 SV* SvREFCNT_inc_NN(SV* sv)
4284 =item SvREFCNT_inc_simple
4285 X<SvREFCNT_inc_simple>
4287 Same as SvREFCNT_inc, but can only be used with simple variables, not
4288 expressions or pointer dereferences. Since we don't have to store a
4289 temporary value, it's faster.
4291 SV* SvREFCNT_inc_simple(SV* sv)
4296 =item SvREFCNT_inc_simple_NN
4297 X<SvREFCNT_inc_simple_NN>
4299 Same as SvREFCNT_inc_simple, but can only be used if you know I<sv>
4300 is not NULL. Since we don't have to check the NULLness, it's faster
4303 SV* SvREFCNT_inc_simple_NN(SV* sv)
4308 =item SvREFCNT_inc_simple_void
4309 X<SvREFCNT_inc_simple_void>
4311 Same as SvREFCNT_inc_simple, but can only be used if you don't need the
4312 return value. The macro doesn't need to return a meaningful value.
4314 void SvREFCNT_inc_simple_void(SV* sv)
4319 =item SvREFCNT_inc_simple_void_NN
4320 X<SvREFCNT_inc_simple_void_NN>
4322 Same as SvREFCNT_inc, but can only be used if you don't need the return
4323 value, and you know that I<sv> is not NULL. The macro doesn't need
4324 to return a meaningful value, or check for NULLness, so it's smaller
4327 void SvREFCNT_inc_simple_void_NN(SV* sv)
4332 =item SvREFCNT_inc_void
4333 X<SvREFCNT_inc_void>
4335 Same as SvREFCNT_inc, but can only be used if you don't need the
4336 return value. The macro doesn't need to return a meaningful value.
4338 void SvREFCNT_inc_void(SV* sv)
4343 =item SvREFCNT_inc_void_NN
4344 X<SvREFCNT_inc_void_NN>
4346 Same as SvREFCNT_inc, but can only be used if you don't need the return
4347 value, and you know that I<sv> is not NULL. The macro doesn't need
4348 to return a meaningful value, or check for NULLness, so it's smaller
4351 void SvREFCNT_inc_void_NN(SV* sv)
4359 Tests if the SV is an RV.
4369 Unsets the RV status of an SV.
4371 void SvROK_off(SV* sv)
4379 Tells an SV that it is an RV.
4381 void SvROK_on(SV* sv)
4389 Dereferences an RV to return the SV.
4399 Set the value of the RV pointer in sv to val. See C<SvIV_set>.
4401 void SvRV_set(SV* sv, SV* val)
4409 Returns the stash of the SV.
4419 Set the value of the STASH pointer in sv to val. See C<SvIV_set>.
4421 void SvSTASH_set(SV* sv, HV* val)
4429 Taints an SV if tainting is enabled.
4431 void SvTAINT(SV* sv)
4439 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
4442 bool SvTAINTED(SV* sv)
4450 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
4451 some of Perl's fundamental security features. XS module authors should not
4452 use this function unless they fully understand all the implications of
4453 unconditionally untainting the value. Untainting should be done in the
4454 standard perl fashion, via a carefully crafted regexp, rather than directly
4455 untainting variables.
4457 void SvTAINTED_off(SV* sv)
4465 Marks an SV as tainted if tainting is enabled.
4467 void SvTAINTED_on(SV* sv)
4475 Returns a boolean indicating whether Perl would evaluate the SV as true or
4476 false, defined or undefined. Does not handle 'get' magic.
4486 Returns the type of the SV. See C<svtype>.
4488 svtype SvTYPE(SV* sv)
4496 Returns a boolean indicating whether the SV contains an unsigned integer.
4506 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
4507 perform the upgrade if necessary. See C<svtype>.
4509 void SvUPGRADE(SV* sv, svtype type)
4517 Returns a boolean indicating whether the SV contains UTF-8 encoded data.
4527 Unsets the UTF-8 status of an SV.
4529 void SvUTF8_off(SV *sv)
4537 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
4538 Do not use frivolously.
4540 void SvUTF8_on(SV *sv)
4548 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
4549 for a version which guarantees to evaluate sv only once.
4559 Returns the raw value in the SV's UV slot, without checks or conversions.
4560 Only use when you are sure SvIOK is true. See also C<SvUV()>.
4570 Coerces the given SV to an unsigned integer and returns it. Guarantees to
4571 evaluate sv only once. Use the more efficient C<SvUV> otherwise.
4581 Like C<SvUV> but doesn't process magic.
4583 UV SvUV_nomg(SV* sv)
4591 Set the value of the UV pointer in sv to val. See C<SvIV_set>.
4593 void SvUV_set(SV* sv, UV val)
4601 Returns a boolean indicating whether the SV contains a v-string.
4608 =item sv_catpvn_nomg
4611 Like C<sv_catpvn> but doesn't process magic.
4613 void sv_catpvn_nomg(SV* sv, const char* ptr, STRLEN len)
4621 Like C<sv_catsv> but doesn't process magic.
4623 void sv_catsv_nomg(SV* dsv, SV* ssv)
4628 =item sv_derived_from
4631 Returns a boolean indicating whether the SV is derived from the specified class
4632 I<at the C level>. To check derivation at the Perl level, call C<isa()> as a
4635 bool sv_derived_from(SV* sv, const char* name)
4638 Found in file universal.c
4643 Returns a boolean indicating whether the SV performs a specific, named role.
4644 The SV can be a Perl object or the name of a Perl class.
4646 bool sv_does(SV* sv, const char* name)
4649 Found in file universal.c
4651 =item sv_report_used
4654 Dump the contents of all SVs not yet freed. (Debugging aid).
4656 void sv_report_used()
4664 Like C<sv_setsv> but doesn't process magic.
4666 void sv_setsv_nomg(SV* dsv, SV* ssv)
4674 =head1 SV-Body Allocation
4678 =item looks_like_number
4679 X<looks_like_number>
4681 Test if the content of an SV looks like a number (or is a number).
4682 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
4683 non-numeric warning), even if your atof() doesn't grok them.
4685 I32 looks_like_number(SV* sv)
4693 Creates an RV wrapper for an SV. The reference count for the original
4694 SV is B<not> incremented.
4696 SV* newRV_noinc(SV* sv)
4704 Creates a new SV. A non-zero C<len> parameter indicates the number of
4705 bytes of preallocated string space the SV should have. An extra byte for a
4706 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4707 space is allocated.) The reference count for the new SV is set to 1.
4709 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4710 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4711 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4712 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4713 modules supporting older perls.
4715 SV* newSV(STRLEN len)
4723 Creates a new SV from the hash key structure. It will generate scalars that
4724 point to the shared string table where possible. Returns a new (undefined)
4725 SV if the hek is NULL.
4727 SV* newSVhek(const HEK *hek)
4735 Creates a new SV and copies an integer into it. The reference count for the
4746 Creates a new SV and copies a floating point value into it.
4747 The reference count for the SV is set to 1.
4757 Creates a new SV and copies a string into it. The reference count for the
4758 SV is set to 1. If C<len> is zero, Perl will compute the length using
4759 strlen(). For efficiency, consider using C<newSVpvn> instead.
4761 SV* newSVpv(const char* s, STRLEN len)
4769 Creates a new SV and initializes it with the string formatted like
4772 SV* newSVpvf(const char* pat, ...)
4780 Creates a new SV and copies a string into it. The reference count for the
4781 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
4782 string. You are responsible for ensuring that the source string is at least
4783 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
4785 SV* newSVpvn(const char* s, STRLEN len)
4790 =item newSVpvn_share
4793 Creates a new SV with its SvPVX_const pointing to a shared string in the string
4794 table. If the string does not already exist in the table, it is created
4795 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
4796 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
4797 otherwise the hash is computed. The idea here is that as the string table
4798 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
4799 hash lookup will avoid string compare.
4801 SV* newSVpvn_share(const char* s, I32 len, U32 hash)
4809 Like C<newSVpvn>, but takes a literal string instead of a string/length pair.
4811 SV* newSVpvs(const char* s)
4814 Found in file handy.h
4816 =item newSVpvs_share
4819 Like C<newSVpvn_share>, but takes a literal string instead of a string/length
4820 pair and omits the hash parameter.
4822 SV* newSVpvs_share(const char* s)
4825 Found in file handy.h
4830 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
4831 it will be upgraded to one. If C<classname> is non-null then the new SV will
4832 be blessed in the specified package. The new SV is returned and its
4833 reference count is 1.
4835 SV* newSVrv(SV* rv, const char* classname)
4843 Creates a new SV which is an exact duplicate of the original SV.
4846 SV* newSVsv(SV* old)
4854 Creates a new SV and copies an unsigned integer into it.
4855 The reference count for the SV is set to 1.
4865 This function is only called on magical items, and is only used by
4866 sv_true() or its macro equivalent.
4868 bool sv_2bool(SV* sv)
4876 Using various gambits, try to get a CV from an SV; in addition, try if
4877 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
4878 The flags in C<lref> are passed to sv_fetchsv.
4880 CV* sv_2cv(SV* sv, HV** st, GV** gvp, I32 lref)
4888 Using various gambits, try to get an IO from an SV: the IO slot if its a
4889 GV; or the recursive result if we're an RV; or the IO slot of the symbol
4890 named after the PV if we're a string.
4900 Return the integer value of an SV, doing any necessary string
4901 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
4902 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
4904 IV sv_2iv_flags(SV* sv, I32 flags)
4912 Marks an existing SV as mortal. The SV will be destroyed "soon", either
4913 by an explicit call to FREETMPS, or by an implicit call at places such as
4914 statement boundaries. SvTEMP() is turned on which means that the SV's
4915 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
4916 and C<sv_mortalcopy>.
4918 SV* sv_2mortal(SV* sv)
4926 Return the num value of an SV, doing any necessary string or integer
4927 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
4938 Return a pointer to the byte-encoded representation of the SV, and set *lp
4939 to its length. May cause the SV to be downgraded from UTF-8 as a
4942 Usually accessed via the C<SvPVbyte> macro.
4944 char* sv_2pvbyte(SV* sv, STRLEN* lp)
4952 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
4953 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
4955 Usually accessed via the C<SvPVutf8> macro.
4957 char* sv_2pvutf8(SV* sv, STRLEN* lp)
4965 Returns a pointer to the string value of an SV, and sets *lp to its length.
4966 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
4968 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
4969 usually end up here too.
4971 char* sv_2pv_flags(SV* sv, STRLEN* lp, I32 flags)
4979 Return the unsigned integer value of an SV, doing any necessary string
4980 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
4981 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
4983 UV sv_2uv_flags(SV* sv, I32 flags)
4991 Remove any string offset. You should normally use the C<SvOOK_off> macro
4994 int sv_backoff(SV* sv)
5002 Blesses an SV into a specified package. The SV must be an RV. The package
5003 must be designated by its stash (see C<gv_stashpv()>). The reference count
5004 of the SV is unaffected.
5006 SV* sv_bless(SV* sv, HV* stash)
5014 Concatenates the string onto the end of the string which is in the SV.
5015 If the SV has the UTF-8 status set, then the bytes appended should be
5016 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
5018 void sv_catpv(SV* sv, const char* ptr)
5026 Processes its arguments like C<sprintf> and appends the formatted
5027 output to an SV. If the appended data contains "wide" characters
5028 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
5029 and characters >255 formatted with %c), the original SV might get
5030 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
5031 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
5032 valid UTF-8; if the original SV was bytes, the pattern should be too.
5034 void sv_catpvf(SV* sv, const char* pat, ...)
5042 Like C<sv_catpvf>, but also handles 'set' magic.
5044 void sv_catpvf_mg(SV *sv, const char* pat, ...)
5052 Concatenates the string onto the end of the string which is in the SV. The
5053 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5054 status set, then the bytes appended should be valid UTF-8.
5055 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
5057 void sv_catpvn(SV* sv, const char* ptr, STRLEN len)
5062 =item sv_catpvn_flags
5065 Concatenates the string onto the end of the string which is in the SV. The
5066 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5067 status set, then the bytes appended should be valid UTF-8.
5068 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
5069 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
5070 in terms of this function.
5072 void sv_catpvn_flags(SV* sv, const char* ptr, STRLEN len, I32 flags)
5080 Like C<sv_catpvn>, but takes a literal string instead of a string/length pair.
5082 void sv_catpvs(SV* sv, const char* s)
5085 Found in file handy.h
5090 Like C<sv_catpv>, but also handles 'set' magic.
5092 void sv_catpv_mg(SV *sv, const char *ptr)
5100 Concatenates the string from SV C<ssv> onto the end of the string in
5101 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
5102 not 'set' magic. See C<sv_catsv_mg>.
5104 void sv_catsv(SV* dsv, SV* ssv)
5109 =item sv_catsv_flags
5112 Concatenates the string from SV C<ssv> onto the end of the string in
5113 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
5114 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
5115 and C<sv_catsv_nomg> are implemented in terms of this function.
5117 void sv_catsv_flags(SV* dsv, SV* ssv, I32 flags)
5125 Efficient removal of characters from the beginning of the string buffer.
5126 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
5127 the string buffer. The C<ptr> becomes the first character of the adjusted
5128 string. Uses the "OOK hack".
5129 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
5130 refer to the same chunk of data.
5132 void sv_chop(SV* sv, const char* ptr)
5140 Clear an SV: call any destructors, free up any memory used by the body,
5141 and free the body itself. The SV's head is I<not> freed, although
5142 its type is set to all 1's so that it won't inadvertently be assumed
5143 to be live during global destruction etc.
5144 This function should only be called when REFCNT is zero. Most of the time
5145 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5148 void sv_clear(SV* sv)
5156 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5157 string in C<sv1> is less than, equal to, or greater than the string in
5158 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5159 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
5161 I32 sv_cmp(SV* sv1, SV* sv2)
5169 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
5170 'use bytes' aware, handles get magic, and will coerce its args to strings
5171 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
5173 I32 sv_cmp_locale(SV* sv1, SV* sv2)
5181 Add Collate Transform magic to an SV if it doesn't already have it.
5183 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
5184 scalar data of the variable, but transformed to such a format that a normal
5185 memory comparison can be used to compare the data according to the locale
5188 char* sv_collxfrm(SV* sv, STRLEN* nxp)
5196 Copies a stringified representation of the source SV into the
5197 destination SV. Automatically performs any necessary mg_get and
5198 coercion of numeric values into strings. Guaranteed to preserve
5199 UTF-8 flag even from overloaded objects. Similar in nature to
5200 sv_2pv[_flags] but operates directly on an SV instead of just the
5201 string. Mostly uses sv_2pv_flags to do its work, except when that
5202 would lose the UTF-8'ness of the PV.
5204 void sv_copypv(SV* dsv, SV* ssv)
5212 Auto-decrement of the value in the SV, doing string to numeric conversion
5213 if necessary. Handles 'get' magic.
5223 Returns a boolean indicating whether the strings in the two SVs are
5224 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5225 coerce its args to strings if necessary.
5227 I32 sv_eq(SV* sv1, SV* sv2)
5232 =item sv_force_normal_flags
5233 X<sv_force_normal_flags>
5235 Undo various types of fakery on an SV: if the PV is a shared string, make
5236 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
5237 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
5238 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
5239 then a copy-on-write scalar drops its PV buffer (if any) and becomes
5240 SvPOK_off rather than making a copy. (Used where this scalar is about to be
5241 set to some other value.) In addition, the C<flags> parameter gets passed to
5242 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
5243 with flags set to 0.
5245 void sv_force_normal_flags(SV *sv, U32 flags)
5253 Decrement an SV's reference count, and if it drops to zero, call
5254 C<sv_clear> to invoke destructors and free up any memory used by
5255 the body; finally, deallocate the SV's head itself.
5256 Normally called via a wrapper macro C<SvREFCNT_dec>.
5258 void sv_free(SV* sv)
5266 Get a line from the filehandle and store it into the SV, optionally
5267 appending to the currently-stored string.
5269 char* sv_gets(SV* sv, PerlIO* fp, I32 append)
5277 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
5278 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
5279 Use the C<SvGROW> wrapper instead.
5281 char* sv_grow(SV* sv, STRLEN newlen)
5289 Auto-increment of the value in the SV, doing string to numeric conversion
5290 if necessary. Handles 'get' magic.
5300 Inserts a string at the specified offset/length within the SV. Similar to
5301 the Perl substr() function.
5303 void sv_insert(SV* bigsv, STRLEN offset, STRLEN len, const char* little, STRLEN littlelen)
5311 Returns a boolean indicating whether the SV is blessed into the specified
5312 class. This does not check for subtypes; use C<sv_derived_from> to verify
5313 an inheritance relationship.
5315 int sv_isa(SV* sv, const char* name)
5323 Returns a boolean indicating whether the SV is an RV pointing to a blessed
5324 object. If the SV is not an RV, or if the object is not blessed, then this
5327 int sv_isobject(SV* sv)
5335 Returns the length of the string in the SV. Handles magic and type
5336 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5338 STRLEN sv_len(SV* sv)
5346 Returns the number of characters in the string in an SV, counting wide
5347 UTF-8 bytes as a single character. Handles magic and type coercion.
5349 STRLEN sv_len_utf8(SV* sv)
5357 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
5358 then adds a new magic item of type C<how> to the head of the magic list.
5360 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
5361 handling of the C<name> and C<namlen> arguments.
5363 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
5364 to add more than one instance of the same 'how'.
5366 void sv_magic(SV* sv, SV* obj, int how, const char* name, I32 namlen)
5374 Adds magic to an SV, upgrading it if necessary. Applies the
5375 supplied vtable and returns a pointer to the magic added.
5377 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
5378 In particular, you can add magic to SvREADONLY SVs, and add more than
5379 one instance of the same 'how'.
5381 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
5382 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
5383 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
5384 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
5386 (This is now used as a subroutine by C<sv_magic>.)
5388 MAGIC * sv_magicext(SV* sv, SV* obj, int how, MGVTBL *vtbl, const char* name, I32 namlen)
5396 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
5397 The new SV is marked as mortal. It will be destroyed "soon", either by an
5398 explicit call to FREETMPS, or by an implicit call at places such as
5399 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
5401 SV* sv_mortalcopy(SV* oldsv)
5409 Creates a new null SV which is mortal. The reference count of the SV is
5410 set to 1. It will be destroyed "soon", either by an explicit call to
5411 FREETMPS, or by an implicit call at places such as statement boundaries.
5412 See also C<sv_mortalcopy> and C<sv_2mortal>.
5422 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5425 SV* sv_newref(SV* sv)
5433 Converts the value pointed to by offsetp from a count of bytes from the
5434 start of the string, to a count of the equivalent number of UTF-8 chars.
5435 Handles magic and type coercion.
5437 void sv_pos_b2u(SV* sv, I32* offsetp)
5445 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5446 the start of the string, to a count of the equivalent number of bytes; if
5447 lenp is non-zero, it does the same to lenp, but this time starting from
5448 the offset, rather than from the start of the string. Handles magic and
5451 void sv_pos_u2b(SV* sv, I32* offsetp, I32* lenp)
5456 =item sv_pvbyten_force
5459 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
5461 char* sv_pvbyten_force(SV* sv, STRLEN* lp)
5469 Get a sensible string out of the SV somehow.
5470 A private implementation of the C<SvPV_force> macro for compilers which
5471 can't cope with complex macro expressions. Always use the macro instead.
5473 char* sv_pvn_force(SV* sv, STRLEN* lp)
5478 =item sv_pvn_force_flags
5479 X<sv_pvn_force_flags>
5481 Get a sensible string out of the SV somehow.
5482 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
5483 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
5484 implemented in terms of this function.
5485 You normally want to use the various wrapper macros instead: see
5486 C<SvPV_force> and C<SvPV_force_nomg>
5488 char* sv_pvn_force_flags(SV* sv, STRLEN* lp, I32 flags)
5493 =item sv_pvutf8n_force
5496 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
5498 char* sv_pvutf8n_force(SV* sv, STRLEN* lp)
5506 Returns a string describing what the SV is a reference to.
5508 char* sv_reftype(const SV* sv, int ob)
5516 Make the first argument a copy of the second, then delete the original.
5517 The target SV physically takes over ownership of the body of the source SV
5518 and inherits its flags; however, the target keeps any magic it owns,
5519 and any magic in the source is discarded.
5520 Note that this is a rather specialist SV copying operation; most of the
5521 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5523 void sv_replace(SV* sv, SV* nsv)
5531 Underlying implementation for the C<reset> Perl function.
5532 Note that the perl-level function is vaguely deprecated.
5534 void sv_reset(const char* s, HV* stash)
5542 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
5543 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
5544 push a back-reference to this RV onto the array of backreferences
5545 associated with that magic.
5547 SV* sv_rvweaken(SV *sv)
5555 Copies an integer into the given SV, upgrading first if necessary.
5556 Does not handle 'set' magic. See also C<sv_setiv_mg>.
5558 void sv_setiv(SV* sv, IV num)
5566 Like C<sv_setiv>, but also handles 'set' magic.
5568 void sv_setiv_mg(SV *sv, IV i)
5576 Copies a double into the given SV, upgrading first if necessary.
5577 Does not handle 'set' magic. See also C<sv_setnv_mg>.
5579 void sv_setnv(SV* sv, NV num)
5587 Like C<sv_setnv>, but also handles 'set' magic.
5589 void sv_setnv_mg(SV *sv, NV num)
5597 Copies a string into an SV. The string must be null-terminated. Does not
5598 handle 'set' magic. See C<sv_setpv_mg>.
5600 void sv_setpv(SV* sv, const char* ptr)
5608 Works like C<sv_catpvf> but copies the text into the SV instead of
5609 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
5611 void sv_setpvf(SV* sv, const char* pat, ...)
5619 Like C<sv_setpvf>, but also handles 'set' magic.
5621 void sv_setpvf_mg(SV *sv, const char* pat, ...)
5629 Copies an integer into the given SV, also updating its string value.
5630 Does not handle 'set' magic. See C<sv_setpviv_mg>.
5632 void sv_setpviv(SV* sv, IV num)
5640 Like C<sv_setpviv>, but also handles 'set' magic.
5642 void sv_setpviv_mg(SV *sv, IV iv)
5650 Copies a string into an SV. The C<len> parameter indicates the number of
5651 bytes to be copied. If the C<ptr> argument is NULL the SV will become
5652 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
5654 void sv_setpvn(SV* sv, const char* ptr, STRLEN len)
5662 Like C<sv_setpvn>, but also handles 'set' magic.
5664 void sv_setpvn_mg(SV *sv, const char *ptr, STRLEN len)
5672 Like C<sv_setpvn>, but takes a literal string instead of a string/length pair.
5674 void sv_setpvs(SV* sv, const char* s)
5677 Found in file handy.h
5682 Like C<sv_setpv>, but also handles 'set' magic.
5684 void sv_setpv_mg(SV *sv, const char *ptr)
5692 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
5693 argument will be upgraded to an RV. That RV will be modified to point to
5694 the new SV. The C<classname> argument indicates the package for the
5695 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
5696 will have a reference count of 1, and the RV will be returned.
5698 SV* sv_setref_iv(SV* rv, const char* classname, IV iv)
5706 Copies a double into a new SV, optionally blessing the SV. The C<rv>
5707 argument will be upgraded to an RV. That RV will be modified to point to
5708 the new SV. The C<classname> argument indicates the package for the
5709 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
5710 will have a reference count of 1, and the RV will be returned.
5712 SV* sv_setref_nv(SV* rv, const char* classname, NV nv)
5720 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
5721 argument will be upgraded to an RV. That RV will be modified to point to
5722 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
5723 into the SV. The C<classname> argument indicates the package for the
5724 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
5725 will have a reference count of 1, and the RV will be returned.
5727 Do not use with other Perl types such as HV, AV, SV, CV, because those
5728 objects will become corrupted by the pointer copy process.
5730 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
5732 SV* sv_setref_pv(SV* rv, const char* classname, void* pv)
5740 Copies a string into a new SV, optionally blessing the SV. The length of the
5741 string must be specified with C<n>. The C<rv> argument will be upgraded to
5742 an RV. That RV will be modified to point to the new SV. The C<classname>
5743 argument indicates the package for the blessing. Set C<classname> to
5744 C<NULL> to avoid the blessing. The new SV will have a reference count
5745 of 1, and the RV will be returned.
5747 Note that C<sv_setref_pv> copies the pointer while this copies the string.
5749 SV* sv_setref_pvn(SV* rv, const char* classname, const char* pv, STRLEN n)
5757 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
5758 argument will be upgraded to an RV. That RV will be modified to point to
5759 the new SV. The C<classname> argument indicates the package for the
5760 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
5761 will have a reference count of 1, and the RV will be returned.
5763 SV* sv_setref_uv(SV* rv, const char* classname, UV uv)
5771 Copies the contents of the source SV C<ssv> into the destination SV
5772 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
5773 function if the source SV needs to be reused. Does not handle 'set' magic.
5774 Loosely speaking, it performs a copy-by-value, obliterating any previous
5775 content of the destination.
5777 You probably want to use one of the assortment of wrappers, such as
5778 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
5779 C<SvSetMagicSV_nosteal>.
5781 void sv_setsv(SV* dsv, SV* ssv)
5786 =item sv_setsv_flags
5789 Copies the contents of the source SV C<ssv> into the destination SV
5790 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
5791 function if the source SV needs to be reused. Does not handle 'set' magic.
5792 Loosely speaking, it performs a copy-by-value, obliterating any previous
5793 content of the destination.
5794 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
5795 C<ssv> if appropriate, else not. If the C<flags> parameter has the
5796 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
5797 and C<sv_setsv_nomg> are implemented in terms of this function.
5799 You probably want to use one of the assortment of wrappers, such as
5800 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
5801 C<SvSetMagicSV_nosteal>.
5803 This is the primary function for copying scalars, and most other
5804 copy-ish functions and macros use this underneath.
5806 void sv_setsv_flags(SV* dsv, SV* ssv, I32 flags)
5814 Like C<sv_setsv>, but also handles 'set' magic.
5816 void sv_setsv_mg(SV *dstr, SV *sstr)
5824 Copies an unsigned integer into the given SV, upgrading first if necessary.
5825 Does not handle 'set' magic. See also C<sv_setuv_mg>.
5827 void sv_setuv(SV* sv, UV num)
5835 Like C<sv_setuv>, but also handles 'set' magic.
5837 void sv_setuv_mg(SV *sv, UV u)
5845 Test an SV for taintedness. Use C<SvTAINTED> instead.
5846 bool sv_tainted(SV* sv)
5854 Returns true if the SV has a true value by Perl's rules.
5855 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
5856 instead use an in-line version.
5866 Removes all magic of type C<type> from an SV.
5868 int sv_unmagic(SV* sv, int type)
5873 =item sv_unref_flags
5876 Unsets the RV status of the SV, and decrements the reference count of
5877 whatever was being referenced by the RV. This can almost be thought of
5878 as a reversal of C<newSVrv>. The C<cflags> argument can contain
5879 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
5880 (otherwise the decrementing is conditional on the reference count being
5881 different from one or the reference being a readonly SV).
5884 void sv_unref_flags(SV* sv, U32 flags)
5892 Untaint an SV. Use C<SvTAINTED_off> instead.
5893 void sv_untaint(SV* sv)
5901 Upgrade an SV to a more complex form. Generally adds a new body type to the
5902 SV, then copies across as much information as possible from the old body.
5903 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
5905 void sv_upgrade(SV* sv, svtype new_type)
5910 =item sv_usepvn_flags
5913 Tells an SV to use C<ptr> to find its string value. Normally the
5914 string is stored inside the SV but sv_usepvn allows the SV to use an
5915 outside string. The C<ptr> should point to memory that was allocated
5916 by C<malloc>. The string length, C<len>, must be supplied. By default
5917 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
5918 so that pointer should not be freed or used by the programmer after
5919 giving it to sv_usepvn, and neither should any pointers from "behind"
5920 that pointer (e.g. ptr + 1) be used.
5922 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
5923 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
5924 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
5925 C<len>, and already meets the requirements for storing in C<SvPVX>)
5927 void sv_usepvn_flags(SV* sv, char* ptr, STRLEN len, U32 flags)
5932 =item sv_utf8_decode
5935 If the PV of the SV is an octet sequence in UTF-8
5936 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
5937 so that it looks like a character. If the PV contains only single-byte
5938 characters, the C<SvUTF8> flag stays being off.
5939 Scans PV for validity and returns false if the PV is invalid UTF-8.
5941 NOTE: this function is experimental and may change or be
5942 removed without notice.
5944 bool sv_utf8_decode(SV *sv)
5949 =item sv_utf8_downgrade
5950 X<sv_utf8_downgrade>
5952 Attempts to convert the PV of an SV from characters to bytes.
5953 If the PV contains a character beyond byte, this conversion will fail;
5954 in this case, either returns false or, if C<fail_ok> is not
5957 This is not as a general purpose Unicode to byte encoding interface:
5958 use the Encode extension for that.
5960 NOTE: this function is experimental and may change or be
5961 removed without notice.
5963 bool sv_utf8_downgrade(SV *sv, bool fail_ok)
5968 =item sv_utf8_encode
5971 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
5972 flag off so that it looks like octets again.
5974 void sv_utf8_encode(SV *sv)
5979 =item sv_utf8_upgrade
5982 Converts the PV of an SV to its UTF-8-encoded form.
5983 Forces the SV to string form if it is not already.
5984 Always sets the SvUTF8 flag to avoid future validity checks even
5985 if all the bytes have hibit clear.
5987 This is not as a general purpose byte encoding to Unicode interface:
5988 use the Encode extension for that.
5990 STRLEN sv_utf8_upgrade(SV *sv)
5995 =item sv_utf8_upgrade_flags
5996 X<sv_utf8_upgrade_flags>
5998 Converts the PV of an SV to its UTF-8-encoded form.
5999 Forces the SV to string form if it is not already.
6000 Always sets the SvUTF8 flag to avoid future validity checks even
6001 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
6002 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
6003 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
6005 This is not as a general purpose byte encoding to Unicode interface:
6006 use the Encode extension for that.
6008 STRLEN sv_utf8_upgrade_flags(SV *sv, I32 flags)
6016 Processes its arguments like C<vsprintf> and appends the formatted output
6017 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
6019 Usually used via its frontend C<sv_catpvf>.
6021 void sv_vcatpvf(SV* sv, const char* pat, va_list* args)
6029 Processes its arguments like C<vsprintf> and appends the formatted output
6030 to an SV. Uses an array of SVs if the C style variable argument list is
6031 missing (NULL). When running with taint checks enabled, indicates via
6032 C<maybe_tainted> if results are untrustworthy (often due to the use of
6035 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
6037 void sv_vcatpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
6045 Like C<sv_vcatpvf>, but also handles 'set' magic.
6047 Usually used via its frontend C<sv_catpvf_mg>.
6049 void sv_vcatpvf_mg(SV* sv, const char* pat, va_list* args)
6057 Works like C<sv_vcatpvf> but copies the text into the SV instead of
6058 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
6060 Usually used via its frontend C<sv_setpvf>.
6062 void sv_vsetpvf(SV* sv, const char* pat, va_list* args)
6070 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
6073 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
6075 void sv_vsetpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
6083 Like C<sv_vsetpvf>, but also handles 'set' magic.
6085 Usually used via its frontend C<sv_setpvf_mg>.
6087 void sv_vsetpvf_mg(SV* sv, const char* pat, va_list* args)
6095 =head1 Unicode Support
6099 =item bytes_from_utf8
6102 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
6103 Unlike C<utf8_to_bytes> but like C<bytes_to_utf8>, returns a pointer to
6104 the newly-created string, and updates C<len> to contain the new
6105 length. Returns the original string if no conversion occurs, C<len>
6106 is unchanged. Do nothing if C<is_utf8> points to 0. Sets C<is_utf8> to
6107 0 if C<s> is converted or contains all 7bit characters.
6109 NOTE: this function is experimental and may change or be
6110 removed without notice.
6112 U8* bytes_from_utf8(const U8 *s, STRLEN *len, bool *is_utf8)
6115 Found in file utf8.c
6120 Converts a string C<s> of length C<len> from ASCII into UTF-8 encoding.
6121 Returns a pointer to the newly-created string, and sets C<len> to
6122 reflect the new length.
6124 If you want to convert to UTF-8 from other encodings than ASCII,
6125 see sv_recode_to_utf8().
6127 NOTE: this function is experimental and may change or be
6128 removed without notice.
6130 U8* bytes_to_utf8(const U8 *s, STRLEN *len)
6133 Found in file utf8.c
6138 Return true if the strings s1 and s2 differ case-insensitively, false
6139 if not (if they are equal case-insensitively). If u1 is true, the
6140 string s1 is assumed to be in UTF-8-encoded Unicode. If u2 is true,
6141 the string s2 is assumed to be in UTF-8-encoded Unicode. If u1 or u2
6142 are false, the respective string is assumed to be in native 8-bit
6145 If the pe1 and pe2 are non-NULL, the scanning pointers will be copied
6146 in there (they will point at the beginning of the I<next> character).
6147 If the pointers behind pe1 or pe2 are non-NULL, they are the end
6148 pointers beyond which scanning will not continue under any
6149 circumstances. If the byte lengths l1 and l2 are non-zero, s1+l1 and
6150 s2+l2 will be used as goal end pointers that will also stop the scan,
6151 and which qualify towards defining a successful match: all the scans
6152 that define an explicit length must reach their goal pointers for
6153 a match to succeed).
6155 For case-insensitiveness, the "casefolding" of Unicode is used
6156 instead of upper/lowercasing both the characters, see
6157 http://www.unicode.org/unicode/reports/tr21/ (Case Mappings).
6159 I32 ibcmp_utf8(const char* a, char **pe1, UV l1, bool u1, const char* b, char **pe2, UV l2, bool u2)
6162 Found in file utf8.c
6167 Tests if some arbitrary number of bytes begins in a valid UTF-8
6168 character. Note that an INVARIANT (i.e. ASCII) character is a valid
6169 UTF-8 character. The actual number of bytes in the UTF-8 character
6170 will be returned if it is valid, otherwise 0.
6172 STRLEN is_utf8_char(const U8 *p)
6175 Found in file utf8.c
6177 =item is_utf8_string
6180 Returns true if first C<len> bytes of the given string form a valid
6181 UTF-8 string, false otherwise. Note that 'a valid UTF-8 string' does
6182 not mean 'a string that contains code points above 0x7F encoded in UTF-8'
6183 because a valid ASCII string is a valid UTF-8 string.
6185 See also is_utf8_string_loclen() and is_utf8_string_loc().
6187 bool is_utf8_string(const U8 *s, STRLEN len)
6190 Found in file utf8.c
6192 =item is_utf8_string_loc
6193 X<is_utf8_string_loc>
6195 Like is_utf8_string() but stores the location of the failure (in the
6196 case of "utf8ness failure") or the location s+len (in the case of
6197 "utf8ness success") in the C<ep>.
6199 See also is_utf8_string_loclen() and is_utf8_string().
6201 bool is_utf8_string_loc(const U8 *s, STRLEN len, const U8 **p)
6204 Found in file utf8.c
6206 =item is_utf8_string_loclen
6207 X<is_utf8_string_loclen>
6209 Like is_utf8_string() but stores the location of the failure (in the
6210 case of "utf8ness failure") or the location s+len (in the case of
6211 "utf8ness success") in the C<ep>, and the number of UTF-8
6212 encoded characters in the C<el>.
6214 See also is_utf8_string_loc() and is_utf8_string().
6216 bool is_utf8_string_loclen(const U8 *s, STRLEN len, const U8 **ep, STRLEN *el)
6219 Found in file utf8.c
6221 =item pv_uni_display
6224 Build to the scalar dsv a displayable version of the string spv,
6225 length len, the displayable version being at most pvlim bytes long
6226 (if longer, the rest is truncated and "..." will be appended).
6228 The flags argument can have UNI_DISPLAY_ISPRINT set to display
6229 isPRINT()able characters as themselves, UNI_DISPLAY_BACKSLASH
6230 to display the \\[nrfta\\] as the backslashed versions (like '\n')
6231 (UNI_DISPLAY_BACKSLASH is preferred over UNI_DISPLAY_ISPRINT for \\).
6232 UNI_DISPLAY_QQ (and its alias UNI_DISPLAY_REGEX) have both
6233 UNI_DISPLAY_BACKSLASH and UNI_DISPLAY_ISPRINT turned on.
6235 The pointer to the PV of the dsv is returned.
6237 char* pv_uni_display(SV *dsv, const U8 *spv, STRLEN len, STRLEN pvlim, UV flags)
6240 Found in file utf8.c
6245 The encoding is assumed to be an Encode object, the PV of the ssv is
6246 assumed to be octets in that encoding and decoding the input starts
6247 from the position which (PV + *offset) pointed to. The dsv will be
6248 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
6249 when the string tstr appears in decoding output or the input ends on
6250 the PV of the ssv. The value which the offset points will be modified
6251 to the last input position on the ssv.
6253 Returns TRUE if the terminator was found, else returns FALSE.
6255 bool sv_cat_decode(SV* dsv, SV *encoding, SV *ssv, int *offset, char* tstr, int tlen)
6260 =item sv_recode_to_utf8
6261 X<sv_recode_to_utf8>
6263 The encoding is assumed to be an Encode object, on entry the PV
6264 of the sv is assumed to be octets in that encoding, and the sv
6265 will be converted into Unicode (and UTF-8).
6267 If the sv already is UTF-8 (or if it is not POK), or if the encoding
6268 is not a reference, nothing is done to the sv. If the encoding is not
6269 an C<Encode::XS> Encoding object, bad things will happen.
6270 (See F<lib/encoding.pm> and L<Encode>).
6272 The PV of the sv is returned.
6274 char* sv_recode_to_utf8(SV* sv, SV *encoding)
6279 =item sv_uni_display
6282 Build to the scalar dsv a displayable version of the scalar sv,
6283 the displayable version being at most pvlim bytes long
6284 (if longer, the rest is truncated and "..." will be appended).
6286 The flags argument is as in pv_uni_display().
6288 The pointer to the PV of the dsv is returned.
6290 char* sv_uni_display(SV *dsv, SV *ssv, STRLEN pvlim, UV flags)
6293 Found in file utf8.c
6298 The "p" contains the pointer to the UTF-8 string encoding
6299 the character that is being converted.
6301 The "ustrp" is a pointer to the character buffer to put the
6302 conversion result to. The "lenp" is a pointer to the length
6305 The "swashp" is a pointer to the swash to use.
6307 Both the special and normal mappings are stored lib/unicore/To/Foo.pl,
6308 and loaded by SWASHNEW, using lib/utf8_heavy.pl. The special (usually,
6309 but not always, a multicharacter mapping), is tried first.
6311 The "special" is a string like "utf8::ToSpecLower", which means the
6312 hash %utf8::ToSpecLower. The access to the hash is through
6313 Perl_to_utf8_case().
6315 The "normal" is a string like "ToLower" which means the swash
6318 UV to_utf8_case(const U8 *p, U8* ustrp, STRLEN *lenp, SV **swashp, const char *normal, const char *special)
6321 Found in file utf8.c
6326 Convert the UTF-8 encoded character at p to its foldcase version and
6327 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6328 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6329 foldcase version may be longer than the original character (up to
6332 The first character of the foldcased version is returned
6333 (but note, as explained above, that there may be more.)
6335 UV to_utf8_fold(const U8 *p, U8* ustrp, STRLEN *lenp)
6338 Found in file utf8.c
6343 Convert the UTF-8 encoded character at p to its lowercase version and
6344 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6345 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6346 lowercase version may be longer than the original character.
6348 The first character of the lowercased version is returned
6349 (but note, as explained above, that there may be more.)
6351 UV to_utf8_lower(const U8 *p, U8* ustrp, STRLEN *lenp)
6354 Found in file utf8.c
6359 Convert the UTF-8 encoded character at p to its titlecase version and
6360 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6361 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6362 titlecase version may be longer than the original character.
6364 The first character of the titlecased version is returned
6365 (but note, as explained above, that there may be more.)
6367 UV to_utf8_title(const U8 *p, U8* ustrp, STRLEN *lenp)
6370 Found in file utf8.c
6375 Convert the UTF-8 encoded character at p to its uppercase version and
6376 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6377 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since
6378 the uppercase version may be longer than the original character.
6380 The first character of the uppercased version is returned
6381 (but note, as explained above, that there may be more.)
6383 UV to_utf8_upper(const U8 *p, U8* ustrp, STRLEN *lenp)
6386 Found in file utf8.c
6388 =item utf8n_to_uvchr
6393 Returns the native character value of the first character in the string
6395 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6396 length, in bytes, of that character.
6398 Allows length and flags to be passed to low level routine.
6400 UV utf8n_to_uvchr(const U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags)
6403 Found in file utf8.c
6405 =item utf8n_to_uvuni
6408 Bottom level UTF-8 decode routine.
6409 Returns the unicode code point value of the first character in the string C<s>
6410 which is assumed to be in UTF-8 encoding and no longer than C<curlen>;
6411 C<retlen> will be set to the length, in bytes, of that character.
6413 If C<s> does not point to a well-formed UTF-8 character, the behaviour
6414 is dependent on the value of C<flags>: if it contains UTF8_CHECK_ONLY,
6415 it is assumed that the caller will raise a warning, and this function
6416 will silently just set C<retlen> to C<-1> and return zero. If the
6417 C<flags> does not contain UTF8_CHECK_ONLY, warnings about
6418 malformations will be given, C<retlen> will be set to the expected
6419 length of the UTF-8 character in bytes, and zero will be returned.
6421 The C<flags> can also contain various flags to allow deviations from
6422 the strict UTF-8 encoding (see F<utf8.h>).
6424 Most code should use utf8_to_uvchr() rather than call this directly.
6426 UV utf8n_to_uvuni(const U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags)
6429 Found in file utf8.c
6434 Returns the number of UTF-8 characters between the UTF-8 pointers C<a>
6437 WARNING: use only if you *know* that the pointers point inside the
6440 IV utf8_distance(const U8 *a, const U8 *b)
6443 Found in file utf8.c
6448 Return the UTF-8 pointer C<s> displaced by C<off> characters, either
6449 forward or backward.
6451 WARNING: do not use the following unless you *know* C<off> is within
6452 the UTF-8 data pointed to by C<s> *and* that on entry C<s> is aligned
6453 on the first byte of character or just after the last byte of a character.
6455 U8* utf8_hop(const U8 *s, I32 off)
6458 Found in file utf8.c
6463 Return the length of the UTF-8 char encoded string C<s> in characters.
6464 Stops at C<e> (inclusive). If C<e E<lt> s> or if the scan would end
6465 up past C<e>, croaks.
6467 STRLEN utf8_length(const U8* s, const U8 *e)
6470 Found in file utf8.c
6475 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
6476 Unlike C<bytes_to_utf8>, this over-writes the original string, and
6477 updates len to contain the new length.
6478 Returns zero on failure, setting C<len> to -1.
6480 If you need a copy of the string, see C<bytes_from_utf8>.
6482 NOTE: this function is experimental and may change or be
6483 removed without notice.
6485 U8* utf8_to_bytes(U8 *s, STRLEN *len)
6488 Found in file utf8.c
6493 Returns the native character value of the first character in the string C<s>
6494 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6495 length, in bytes, of that character.
6497 If C<s> does not point to a well-formed UTF-8 character, zero is
6498 returned and retlen is set, if possible, to -1.
6500 UV utf8_to_uvchr(const U8 *s, STRLEN *retlen)
6503 Found in file utf8.c
6508 Returns the Unicode code point of the first character in the string C<s>
6509 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6510 length, in bytes, of that character.
6512 This function should only be used when returned UV is considered
6513 an index into the Unicode semantic tables (e.g. swashes).
6515 If C<s> does not point to a well-formed UTF-8 character, zero is
6516 returned and retlen is set, if possible, to -1.
6518 UV utf8_to_uvuni(const U8 *s, STRLEN *retlen)
6521 Found in file utf8.c
6526 Adds the UTF-8 representation of the Native codepoint C<uv> to the end
6527 of the string C<d>; C<d> should be have at least C<UTF8_MAXBYTES+1> free
6528 bytes available. The return value is the pointer to the byte after the
6529 end of the new character. In other words,
6531 d = uvchr_to_utf8(d, uv);
6533 is the recommended wide native character-aware way of saying
6537 U8* uvchr_to_utf8(U8 *d, UV uv)
6540 Found in file utf8.c
6542 =item uvuni_to_utf8_flags
6543 X<uvuni_to_utf8_flags>
6545 Adds the UTF-8 representation of the Unicode codepoint C<uv> to the end
6546 of the string C<d>; C<d> should be have at least C<UTF8_MAXBYTES+1> free
6547 bytes available. The return value is the pointer to the byte after the
6548 end of the new character. In other words,
6550 d = uvuni_to_utf8_flags(d, uv, flags);
6554 d = uvuni_to_utf8(d, uv);
6556 (which is equivalent to)
6558 d = uvuni_to_utf8_flags(d, uv, 0);
6560 is the recommended Unicode-aware way of saying
6564 U8* uvuni_to_utf8_flags(U8 *d, UV uv, UV flags)
6567 Found in file utf8.c
6572 =head1 Variables created by C<xsubpp> and C<xsubpp> internal functions
6579 Variable which is setup by C<xsubpp> to indicate the stack base offset,
6580 used by the C<ST>, C<XSprePUSH> and C<XSRETURN> macros. The C<dMARK> macro
6581 must be called prior to setup the C<MARK> variable.
6586 Found in file XSUB.h
6591 Variable which is setup by C<xsubpp> to indicate the
6592 class name for a C++ XS constructor. This is always a C<char*>. See C<THIS>.
6597 Found in file XSUB.h
6602 Sets up the C<ax> variable.
6603 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
6608 Found in file XSUB.h
6613 Sets up the C<ax> variable and stack marker variable C<mark>.
6614 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
6619 Found in file XSUB.h
6624 Sets up the C<items> variable.
6625 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
6630 Found in file XSUB.h
6635 Sets up the C<padoff_du> variable for an XSUB that wishes to use
6641 Found in file XSUB.h
6646 Sets up stack and mark pointers for an XSUB, calling dSP and dMARK.
6647 Sets up the C<ax> and C<items> variables by calling C<dAX> and C<dITEMS>.
6648 This is usually handled automatically by C<xsubpp>.
6653 Found in file XSUB.h
6658 Sets up the C<ix> variable for an XSUB which has aliases. This is usually
6659 handled automatically by C<xsubpp>.
6664 Found in file XSUB.h
6669 Variable which is setup by C<xsubpp> to indicate the number of
6670 items on the stack. See L<perlxs/"Variable-length Parameter Lists">.
6675 Found in file XSUB.h
6680 Variable which is setup by C<xsubpp> to indicate which of an
6681 XSUB's aliases was used to invoke it. See L<perlxs/"The ALIAS: Keyword">.
6686 Found in file XSUB.h
6691 Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
6695 Found in file XSUB.h
6700 Variable which is setup by C<xsubpp> to hold the return value for an
6701 XSUB. This is always the proper type for the XSUB. See
6702 L<perlxs/"The RETVAL Variable">.
6707 Found in file XSUB.h
6712 Used to access elements on the XSUB's stack.
6717 Found in file XSUB.h
6722 Variable which is setup by C<xsubpp> to designate the object in a C++
6723 XSUB. This is always the proper type for the C++ object. See C<CLASS> and
6724 L<perlxs/"Using XS With C++">.
6729 Found in file XSUB.h
6734 The SV* corresponding to the $_ variable. Works even if there
6735 is a lexical $_ in scope.
6738 Found in file XSUB.h
6743 Macro to declare an XSUB and its C parameter list. This is handled by
6747 Found in file XSUB.h
6752 The version identifier for an XS module. This is usually
6753 handled automatically by C<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>.
6756 Found in file XSUB.h
6758 =item XS_VERSION_BOOTCHECK
6759 X<XS_VERSION_BOOTCHECK>
6761 Macro to verify that a PM module's $VERSION variable matches the XS
6762 module's C<XS_VERSION> variable. This is usually handled automatically by
6763 C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">.
6765 XS_VERSION_BOOTCHECK;
6768 Found in file XSUB.h
6773 =head1 Warning and Dieing
6780 This is the XSUB-writer's interface to Perl's C<die> function.
6781 Normally call this function the same way you call the C C<printf>
6782 function. Calling C<croak> returns control directly to Perl,
6783 sidestepping the normal C order of execution. See C<warn>.
6785 If you want to throw an exception object, assign the object to
6786 C<$@> and then pass C<NULL> to croak():
6788 errsv = get_sv("@", TRUE);
6789 sv_setsv(errsv, exception_object);
6792 void croak(const char* pat, ...)
6795 Found in file util.c
6800 This is the XSUB-writer's interface to Perl's C<warn> function. Call this
6801 function the same way you call the C C<printf> function. See C<croak>.
6803 void warn(const char* pat, ...)
6806 Found in file util.c
6813 Until May 1997, this document was maintained by Jeff Okamoto
6814 <okamoto@corp.hp.com>. It is now maintained as part of Perl itself.
6816 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
6817 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
6818 Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
6819 Stephen McCamant, and Gurusamy Sarathy.
6821 API Listing originally by Dean Roehrich <roehrich@cray.com>.
6823 Updated to be autogenerated from comments in the source by Benjamin Stuhl.
6827 perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
projects / p5sagit/p5-mst-13.2.git / blob