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 dump.c
764 char *pv_display(SV *dsv, const char *pv, STRLEN cur, STRLEN len,
765 STRLEN pvlim, U32 flags)
769 pv_escape(dsv,pv,cur,pvlim,PERL_PV_ESCAPE_QUOTE);
771 except that an additional "\0" will be appended to the string when
772 len > cur and pv[cur] is "\0".
774 Note that the final string may be up to 7 chars longer than pvlim.
776 char* pv_display(SV *dsv, const char *pv, STRLEN cur, STRLEN len, STRLEN pvlim)
784 Escapes at most the first "count" chars of pv and puts the results into
785 buf such that the size of the escaped string will not exceed "max" chars
786 and will not contain any incomplete escape sequences.
788 If flags contains PERL_PV_ESCAPE_QUOTE then the string will have quotes
789 placed around it; moreover, if the number of chars converted was less than
790 "count" then a trailing elipses (...) will be added after the closing
793 If PERL_PV_ESCAPE_QUOTE is not set, but PERL_PV_ESCAPE_PADR is, then the
794 returned string will be right padded with spaces such that it is max chars
797 Normally the SV will be cleared before the escaped string is prepared,
798 but when PERL_PV_ESCAPE_CAT is set this will not occur.
800 Returns a pointer to the string contained by SV.
802 NOTE: the perl_ form of this function is deprecated.
804 char* pv_escape(SV *dsv, const char *pv, const STRLEN count, const STRLEN max, const U32 flags)
812 =head1 Functions in file mathoms.c
820 See L<gv_fetchmethod_autoload>.
822 GV* gv_fetchmethod(HV* stash, const char* name)
825 Found in file mathoms.c
830 The engine implementing pack() Perl function. Note: parameters next_in_list and
831 flags are not used. This call should not be used; use packlist instead.
833 void pack_cat(SV *cat, const char *pat, const char *patend, SV **beglist, SV **endlist, SV ***next_in_list, U32 flags)
836 Found in file mathoms.c
838 =item sv_2pvbyte_nolen
841 Return a pointer to the byte-encoded representation of the SV.
842 May cause the SV to be downgraded from UTF-8 as a side-effect.
844 Usually accessed via the C<SvPVbyte_nolen> macro.
846 char* sv_2pvbyte_nolen(SV* sv)
849 Found in file mathoms.c
851 =item sv_2pvutf8_nolen
854 Return a pointer to the UTF-8-encoded representation of the SV.
855 May cause the SV to be upgraded to UTF-8 as a side-effect.
857 Usually accessed via the C<SvPVutf8_nolen> macro.
859 char* sv_2pvutf8_nolen(SV* sv)
862 Found in file mathoms.c
867 Like C<sv_2pv()>, but doesn't return the length too. You should usually
868 use the macro wrapper C<SvPV_nolen(sv)> instead.
869 char* sv_2pv_nolen(SV* sv)
872 Found in file mathoms.c
877 Like C<sv_catpvn>, but also handles 'set' magic.
879 void sv_catpvn_mg(SV *sv, const char *ptr, STRLEN len)
882 Found in file mathoms.c
887 Like C<sv_catsv>, but also handles 'set' magic.
889 void sv_catsv_mg(SV *dstr, SV *sstr)
892 Found in file mathoms.c
894 =item sv_force_normal
897 Undo various types of fakery on an SV: if the PV is a shared string, make
898 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
899 an xpvmg. See also C<sv_force_normal_flags>.
901 void sv_force_normal(SV *sv)
904 Found in file mathoms.c
909 A private implementation of the C<SvIVx> macro for compilers which can't
910 cope with complex macro expressions. Always use the macro instead.
915 Found in file mathoms.c
920 Dummy routine which "locks" an SV when there is no locking module present.
921 Exists to avoid test for a NULL function pointer and because it could
922 potentially warn under some level of strict-ness.
924 "Superseded" by sv_nosharing().
926 void sv_nolocking(SV *sv)
929 Found in file mathoms.c
934 Dummy routine which "unlocks" an SV when there is no locking module present.
935 Exists to avoid test for a NULL function pointer and because it could
936 potentially warn under some level of strict-ness.
938 "Superseded" by sv_nosharing().
940 void sv_nounlocking(SV *sv)
943 Found in file mathoms.c
948 A private implementation of the C<SvNVx> macro for compilers which can't
949 cope with complex macro expressions. Always use the macro instead.
954 Found in file mathoms.c
959 Use the C<SvPV_nolen> macro instead
964 Found in file mathoms.c
969 Use C<SvPVbyte_nolen> instead.
971 char* sv_pvbyte(SV *sv)
974 Found in file mathoms.c
979 A private implementation of the C<SvPVbyte> macro for compilers
980 which can't cope with complex macro expressions. Always use the macro
983 char* sv_pvbyten(SV *sv, STRLEN *len)
986 Found in file mathoms.c
991 A private implementation of the C<SvPV> macro for compilers which can't
992 cope with complex macro expressions. Always use the macro instead.
994 char* sv_pvn(SV *sv, STRLEN *len)
997 Found in file mathoms.c
1002 Use the C<SvPVutf8_nolen> macro instead
1004 char* sv_pvutf8(SV *sv)
1007 Found in file mathoms.c
1012 A private implementation of the C<SvPVutf8> macro for compilers
1013 which can't cope with complex macro expressions. Always use the macro
1016 char* sv_pvutf8n(SV *sv, STRLEN *len)
1019 Found in file mathoms.c
1024 Taint an SV. Use C<SvTAINTED_on> instead.
1025 void sv_taint(SV* sv)
1028 Found in file mathoms.c
1033 Unsets the RV status of the SV, and decrements the reference count of
1034 whatever was being referenced by the RV. This can almost be thought of
1035 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
1036 being zero. See C<SvROK_off>.
1038 void sv_unref(SV* sv)
1041 Found in file mathoms.c
1046 Tells an SV to use C<ptr> to find its string value. Implemented by
1047 calling C<sv_usepvn_flags> with C<flags> of 0, hence does not handle 'set'
1048 magic. See C<sv_usepvn_flags>.
1050 void sv_usepvn(SV* sv, char* ptr, STRLEN len)
1053 Found in file mathoms.c
1058 Like C<sv_usepvn>, but also handles 'set' magic.
1060 void sv_usepvn_mg(SV *sv, char *ptr, STRLEN len)
1063 Found in file mathoms.c
1068 A private implementation of the C<SvUVx> macro for compilers which can't
1069 cope with complex macro expressions. Always use the macro instead.
1074 Found in file mathoms.c
1079 The engine implementing unpack() Perl function. Note: parameters strbeg, new_s
1080 and ocnt are not used. This call should not be used, use unpackstring instead.
1082 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)
1085 Found in file mathoms.c
1090 =head1 Functions in file pp_pack.c
1098 The engine implementing pack() Perl function.
1100 void packlist(SV *cat, const char *pat, const char *patend, SV **beglist, SV **endlist)
1103 Found in file pp_pack.c
1108 The engine implementing unpack() Perl function. C<unpackstring> puts the
1109 extracted list items on the stack and returns the number of elements.
1110 Issue C<PUTBACK> before and C<SPAGAIN> after the call to this function.
1112 I32 unpackstring(const char *pat, const char *patend, const char *s, const char *strend, U32 flags)
1115 Found in file pp_pack.c
1120 =head1 Global Variables
1127 C<PL_modglobal> is a general purpose, interpreter global HV for use by
1128 extensions that need to keep information on a per-interpreter basis.
1129 In a pinch, it can also be used as a symbol table for extensions
1130 to share data among each other. It is a good idea to use keys
1131 prefixed by the package name of the extension that owns the data.
1136 Found in file intrpvar.h
1141 A convenience variable which is typically used with C<SvPV> when one
1142 doesn't care about the length of the string. It is usually more efficient
1143 to either declare a local variable and use that instead or to use the
1144 C<SvPV_nolen> macro.
1149 Found in file thrdvar.h
1154 This is the C<false> SV. See C<PL_sv_yes>. Always refer to this as
1160 Found in file intrpvar.h
1165 This is the C<undef> SV. Always refer to this as C<&PL_sv_undef>.
1170 Found in file intrpvar.h
1175 This is the C<true> SV. See C<PL_sv_no>. Always refer to this as
1181 Found in file intrpvar.h
1193 Return the SV from the GV.
1203 If C<gv> is a typeglob whose subroutine entry is a constant sub eligible for
1204 inlining, or C<gv> is a placeholder reference that would be promoted to such
1205 a typeglob, then returns the value returned by the sub. Otherwise, returns
1208 SV* gv_const_sv(GV* gv)
1216 Returns the glob with the given C<name> and a defined subroutine or
1217 C<NULL>. The glob lives in the given C<stash>, or in the stashes
1218 accessible via @ISA and UNIVERSAL::.
1220 The argument C<level> should be either 0 or -1. If C<level==0>, as a
1221 side-effect creates a glob with the given C<name> in the given C<stash>
1222 which in the case of success contains an alias for the subroutine, and sets
1223 up caching info for this glob. Similarly for all the searched stashes.
1225 This function grants C<"SUPER"> token as a postfix of the stash name. The
1226 GV returned from C<gv_fetchmeth> may be a method cache entry, which is not
1227 visible to Perl code. So when calling C<call_sv>, you should not use
1228 the GV directly; instead, you should use the method's CV, which can be
1229 obtained from the GV with the C<GvCV> macro.
1231 GV* gv_fetchmeth(HV* stash, const char* name, STRLEN len, I32 level)
1236 =item gv_fetchmethod_autoload
1237 X<gv_fetchmethod_autoload>
1239 Returns the glob which contains the subroutine to call to invoke the method
1240 on the C<stash>. In fact in the presence of autoloading this may be the
1241 glob for "AUTOLOAD". In this case the corresponding variable $AUTOLOAD is
1244 The third parameter of C<gv_fetchmethod_autoload> determines whether
1245 AUTOLOAD lookup is performed if the given method is not present: non-zero
1246 means yes, look for AUTOLOAD; zero means no, don't look for AUTOLOAD.
1247 Calling C<gv_fetchmethod> is equivalent to calling C<gv_fetchmethod_autoload>
1248 with a non-zero C<autoload> parameter.
1250 These functions grant C<"SUPER"> token as a prefix of the method name. Note
1251 that if you want to keep the returned glob for a long time, you need to
1252 check for it being "AUTOLOAD", since at the later time the call may load a
1253 different subroutine due to $AUTOLOAD changing its value. Use the glob
1254 created via a side effect to do this.
1256 These functions have the same side-effects and as C<gv_fetchmeth> with
1257 C<level==0>. C<name> should be writable if contains C<':'> or C<'
1258 ''>. The warning against passing the GV returned by C<gv_fetchmeth> to
1259 C<call_sv> apply equally to these functions.
1261 GV* gv_fetchmethod_autoload(HV* stash, const char* name, I32 autoload)
1266 =item gv_fetchmeth_autoload
1267 X<gv_fetchmeth_autoload>
1269 Same as gv_fetchmeth(), but looks for autoloaded subroutines too.
1270 Returns a glob for the subroutine.
1272 For an autoloaded subroutine without a GV, will create a GV even
1273 if C<level < 0>. For an autoloaded subroutine without a stub, GvCV()
1274 of the result may be zero.
1276 GV* gv_fetchmeth_autoload(HV* stash, const char* name, STRLEN len, I32 level)
1284 Returns a pointer to the stash for a specified package. C<name> should
1285 be a valid UTF-8 string and must be null-terminated. If C<create> is set
1286 then the package will be created if it does not already exist. If C<create>
1287 is not set and the package does not exist then NULL is returned.
1289 HV* gv_stashpv(const char* name, I32 create)
1297 Returns a pointer to the stash for a specified package. C<name> should
1298 be a valid UTF-8 string. The C<namelen> parameter indicates the length of
1299 the C<name>, in bytes. If C<create> is set then the package will be
1300 created if it does not already exist. If C<create> is not set and the
1301 package does not exist then NULL is returned.
1303 HV* gv_stashpvn(const char* name, U32 namelen, I32 create)
1311 Like C<gv_stashpvn>, but takes a literal string instead of a string/length pair.
1313 HV* gv_stashpvs(const char* name, I32 create)
1316 Found in file handy.h
1321 Returns a pointer to the stash for a specified package, which must be a
1322 valid UTF-8 string. See C<gv_stashpv>.
1324 HV* gv_stashsv(SV* sv, I32 create)
1347 Null character pointer.
1350 Found in file handy.h
1374 Found in file handy.h
1379 =head1 Hash Manipulation Functions
1386 Returns the HV of the specified Perl hash. If C<create> is set and the
1387 Perl variable does not exist then it will be created. If C<create> is not
1388 set and the variable does not exist then NULL is returned.
1390 NOTE: the perl_ form of this function is deprecated.
1392 HV* get_hv(const char* name, I32 create)
1395 Found in file perl.c
1400 This flag, used in the length slot of hash entries and magic structures,
1401 specifies the structure contains an C<SV*> pointer where a C<char*> pointer
1402 is to be expected. (For information only--not to be used).
1410 Returns the computed hash stored in the hash entry.
1420 Returns the actual pointer stored in the key slot of the hash entry. The
1421 pointer may be either C<char*> or C<SV*>, depending on the value of
1422 C<HeKLEN()>. Can be assigned to. The C<HePV()> or C<HeSVKEY()> macros are
1423 usually preferable for finding the value of a key.
1433 If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry
1434 holds an C<SV*> key. Otherwise, holds the actual length of the key. Can
1435 be assigned to. The C<HePV()> macro is usually preferable for finding key
1438 STRLEN HeKLEN(HE* he)
1446 Returns the key slot of the hash entry as a C<char*> value, doing any
1447 necessary dereferencing of possibly C<SV*> keys. The length of the string
1448 is placed in C<len> (this is a macro, so do I<not> use C<&len>). If you do
1449 not care about what the length of the key is, you may use the global
1450 variable C<PL_na>, though this is rather less efficient than using a local
1451 variable. Remember though, that hash keys in perl are free to contain
1452 embedded nulls, so using C<strlen()> or similar is not a good way to find
1453 the length of hash keys. This is very similar to the C<SvPV()> macro
1454 described elsewhere in this document.
1456 char* HePV(HE* he, STRLEN len)
1464 Returns the key as an C<SV*>, or C<NULL> if the hash entry does not
1465 contain an C<SV*> key.
1475 Returns the key as an C<SV*>. Will create and return a temporary mortal
1476 C<SV*> if the hash entry contains only a C<char*> key.
1478 SV* HeSVKEY_force(HE* he)
1486 Sets the key to a given C<SV*>, taking care to set the appropriate flags to
1487 indicate the presence of an C<SV*> key, and returns the same
1490 SV* HeSVKEY_set(HE* he, SV* sv)
1498 Returns the value slot (type C<SV*>) stored in the hash entry.
1508 Returns the package name of a stash, or NULL if C<stash> isn't a stash.
1509 See C<SvSTASH>, C<CvSTASH>.
1511 char* HvNAME(HV* stash)
1519 Check that a hash is in an internally consistent state.
1521 void hv_assert(HV* tb)
1529 Clears a hash, making it empty.
1531 void hv_clear(HV* tb)
1536 =item hv_clear_placeholders
1537 X<hv_clear_placeholders>
1539 Clears any placeholders from a hash. If a restricted hash has any of its keys
1540 marked as readonly and the key is subsequently deleted, the key is not actually
1541 deleted but is marked by assigning it a value of &PL_sv_placeholder. This tags
1542 it so it will be ignored by future operations such as iterating over the hash,
1543 but will still allow the hash to have a value reassigned to the key at some
1544 future point. This function clears any such placeholder keys from the hash.
1545 See Hash::Util::lock_keys() for an example of its use.
1547 void hv_clear_placeholders(HV* hb)
1555 Deletes a key/value pair in the hash. The value SV is removed from the
1556 hash and returned to the caller. The C<klen> is the length of the key.
1557 The C<flags> value will normally be zero; if set to G_DISCARD then NULL
1560 SV* hv_delete(HV* tb, const char* key, I32 klen, I32 flags)
1568 Deletes a key/value pair in the hash. The value SV is removed from the
1569 hash and returned to the caller. The C<flags> value will normally be zero;
1570 if set to G_DISCARD then NULL will be returned. C<hash> can be a valid
1571 precomputed hash value, or 0 to ask for it to be computed.
1573 SV* hv_delete_ent(HV* tb, SV* key, I32 flags, U32 hash)
1581 Returns a boolean indicating whether the specified hash key exists. The
1582 C<klen> is the length of the key.
1584 bool hv_exists(HV* tb, const char* key, I32 klen)
1592 Returns a boolean indicating whether the specified hash key exists. C<hash>
1593 can be a valid precomputed hash value, or 0 to ask for it to be
1596 bool hv_exists_ent(HV* tb, SV* key, U32 hash)
1604 Returns the SV which corresponds to the specified key in the hash. The
1605 C<klen> is the length of the key. If C<lval> is set then the fetch will be
1606 part of a store. Check that the return value is non-null before
1607 dereferencing it to an C<SV*>.
1609 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1610 information on how to use this function on tied hashes.
1612 SV** hv_fetch(HV* tb, const char* key, I32 klen, I32 lval)
1620 Like C<hv_fetch>, but takes a literal string instead of a string/length pair.
1622 SV** hv_fetchs(HV* tb, const char* key, I32 lval)
1625 Found in file handy.h
1630 Returns the hash entry which corresponds to the specified key in the hash.
1631 C<hash> must be a valid precomputed hash number for the given C<key>, or 0
1632 if you want the function to compute it. IF C<lval> is set then the fetch
1633 will be part of a store. Make sure the return value is non-null before
1634 accessing it. The return value when C<tb> is a tied hash is a pointer to a
1635 static location, so be sure to make a copy of the structure if you need to
1638 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1639 information on how to use this function on tied hashes.
1641 HE* hv_fetch_ent(HV* tb, SV* key, I32 lval, U32 hash)
1649 Prepares a starting point to traverse a hash table. Returns the number of
1650 keys in the hash (i.e. the same as C<HvKEYS(tb)>). The return value is
1651 currently only meaningful for hashes without tie magic.
1653 NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
1654 hash buckets that happen to be in use. If you still need that esoteric
1655 value, you can get it through the macro C<HvFILL(tb)>.
1658 I32 hv_iterinit(HV* tb)
1666 Returns the key from the current position of the hash iterator. See
1669 char* hv_iterkey(HE* entry, I32* retlen)
1677 Returns the key as an C<SV*> from the current position of the hash
1678 iterator. The return value will always be a mortal copy of the key. Also
1681 SV* hv_iterkeysv(HE* entry)
1689 Returns entries from a hash iterator. See C<hv_iterinit>.
1691 You may call C<hv_delete> or C<hv_delete_ent> on the hash entry that the
1692 iterator currently points to, without losing your place or invalidating your
1693 iterator. Note that in this case the current entry is deleted from the hash
1694 with your iterator holding the last reference to it. Your iterator is flagged
1695 to free the entry on the next call to C<hv_iternext>, so you must not discard
1696 your iterator immediately else the entry will leak - call C<hv_iternext> to
1697 trigger the resource deallocation.
1699 HE* hv_iternext(HV* tb)
1707 Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
1710 SV* hv_iternextsv(HV* hv, char** key, I32* retlen)
1715 =item hv_iternext_flags
1716 X<hv_iternext_flags>
1718 Returns entries from a hash iterator. See C<hv_iterinit> and C<hv_iternext>.
1719 The C<flags> value will normally be zero; if HV_ITERNEXT_WANTPLACEHOLDERS is
1720 set the placeholders keys (for restricted hashes) will be returned in addition
1721 to normal keys. By default placeholders are automatically skipped over.
1722 Currently a placeholder is implemented with a value that is
1723 C<&Perl_sv_placeholder>. Note that the implementation of placeholders and
1724 restricted hashes may change, and the implementation currently is
1725 insufficiently abstracted for any change to be tidy.
1727 NOTE: this function is experimental and may change or be
1728 removed without notice.
1730 HE* hv_iternext_flags(HV* tb, I32 flags)
1738 Returns the value from the current position of the hash iterator. See
1741 SV* hv_iterval(HV* tb, HE* entry)
1749 Adds magic to a hash. See C<sv_magic>.
1751 void hv_magic(HV* hv, GV* gv, int how)
1759 Evaluates the hash in scalar context and returns the result. Handles magic when the hash is tied.
1761 SV* hv_scalar(HV* hv)
1769 Stores an SV in a hash. The hash key is specified as C<key> and C<klen> is
1770 the length of the key. The C<hash> parameter is the precomputed hash
1771 value; if it is zero then Perl will compute it. The return value will be
1772 NULL if the operation failed or if the value did not need to be actually
1773 stored within the hash (as in the case of tied hashes). Otherwise it can
1774 be dereferenced to get the original C<SV*>. Note that the caller is
1775 responsible for suitably incrementing the reference count of C<val> before
1776 the call, and decrementing it if the function returned NULL. Effectively
1777 a successful hv_store takes ownership of one reference to C<val>. This is
1778 usually what you want; a newly created SV has a reference count of one, so
1779 if all your code does is create SVs then store them in a hash, hv_store
1780 will own the only reference to the new SV, and your code doesn't need to do
1781 anything further to tidy up. hv_store is not implemented as a call to
1782 hv_store_ent, and does not create a temporary SV for the key, so if your
1783 key data is not already in SV form then use hv_store in preference to
1786 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1787 information on how to use this function on tied hashes.
1789 SV** hv_store(HV* tb, const char* key, I32 klen, SV* val, U32 hash)
1797 Like C<hv_store>, but takes a literal string instead of a string/length pair
1798 and omits the hash parameter.
1800 SV** hv_stores(HV* tb, const char* key, NULLOK SV* val)
1803 Found in file handy.h
1808 Stores C<val> in a hash. The hash key is specified as C<key>. The C<hash>
1809 parameter is the precomputed hash value; if it is zero then Perl will
1810 compute it. The return value is the new hash entry so created. It will be
1811 NULL if the operation failed or if the value did not need to be actually
1812 stored within the hash (as in the case of tied hashes). Otherwise the
1813 contents of the return value can be accessed using the C<He?> macros
1814 described here. Note that the caller is responsible for suitably
1815 incrementing the reference count of C<val> before the call, and
1816 decrementing it if the function returned NULL. Effectively a successful
1817 hv_store_ent takes ownership of one reference to C<val>. This is
1818 usually what you want; a newly created SV has a reference count of one, so
1819 if all your code does is create SVs then store them in a hash, hv_store
1820 will own the only reference to the new SV, and your code doesn't need to do
1821 anything further to tidy up. Note that hv_store_ent only reads the C<key>;
1822 unlike C<val> it does not take ownership of it, so maintaining the correct
1823 reference count on C<key> is entirely the caller's responsibility. hv_store
1824 is not implemented as a call to hv_store_ent, and does not create a temporary
1825 SV for the key, so if your key data is not already in SV form then use
1826 hv_store in preference to hv_store_ent.
1828 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1829 information on how to use this function on tied hashes.
1831 HE* hv_store_ent(HV* tb, SV* key, SV* val, U32 hash)
1841 void hv_undef(HV* tb)
1849 Creates a new HV. The reference count is set to 1.
1859 =head1 Magical Functions
1866 Clear something magical that the SV represents. See C<sv_magic>.
1868 int mg_clear(SV* sv)
1876 Copies the magic from one SV to another. See C<sv_magic>.
1878 int mg_copy(SV* sv, SV* nsv, const char* key, I32 klen)
1886 Finds the magic pointer for type matching the SV. See C<sv_magic>.
1888 MAGIC* mg_find(const SV* sv, int type)
1896 Free any magic storage used by the SV. See C<sv_magic>.
1906 Do magic after a value is retrieved from the SV. See C<sv_magic>.
1916 Report on the SV's length. See C<sv_magic>.
1918 U32 mg_length(SV* sv)
1926 Turns on the magical status of an SV. See C<sv_magic>.
1928 void mg_magical(SV* sv)
1936 Do magic after a value is assigned to the SV. See C<sv_magic>.
1946 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
1947 argument more than once.
1949 void SvGETMAGIC(SV* sv)
1957 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
1968 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
1969 argument more than once.
1971 void SvSETMAGIC(SV* sv)
1979 Like C<SvSetSV>, but does any set magic required afterwards.
1981 void SvSetMagicSV(SV* dsb, SV* ssv)
1986 =item SvSetMagicSV_nosteal
1987 X<SvSetMagicSV_nosteal>
1989 Like C<SvSetSV_nosteal>, but does any set magic required afterwards.
1991 void SvSetMagicSV_nosteal(SV* dsv, SV* ssv)
1999 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
2002 void SvSetSV(SV* dsb, SV* ssv)
2007 =item SvSetSV_nosteal
2010 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
2011 ssv. May evaluate arguments more than once.
2013 void SvSetSV_nosteal(SV* dsv, SV* ssv)
2021 Arranges for sv to be shared between threads if a suitable module
2024 void SvSHARE(SV* sv)
2032 Releases a mutual exclusion lock on sv if a suitable module
2035 void SvUNLOCK(SV* sv)
2043 =head1 Memory Management
2050 The XSUB-writer's interface to the C C<memcpy> function. The C<src> is the
2051 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
2052 the type. May fail on overlapping copies. See also C<Move>.
2054 void Copy(void* src, void* dest, int nitems, type)
2057 Found in file handy.h
2062 Like C<Copy> but returns dest. Useful for encouraging compilers to tail-call
2065 void * CopyD(void* src, void* dest, int nitems, type)
2068 Found in file handy.h
2073 The XSUB-writer's interface to the C C<memmove> function. The C<src> is the
2074 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
2075 the type. Can do overlapping moves. See also C<Copy>.
2077 void Move(void* src, void* dest, int nitems, type)
2080 Found in file handy.h
2085 Like C<Move> but returns dest. Useful for encouraging compilers to tail-call
2088 void * MoveD(void* src, void* dest, int nitems, type)
2091 Found in file handy.h
2096 The XSUB-writer's interface to the C C<malloc> function.
2098 In 5.9.3, Newx() and friends replace the older New() API, and drops
2099 the first parameter, I<x>, a debug aid which allowed callers to identify
2100 themselves. This aid has been superseded by a new build option,
2101 PERL_MEM_LOG (see L<perlhack/PERL_MEM_LOG>). The older API is still
2102 there for use in XS modules supporting older perls.
2104 void Newx(void* ptr, int nitems, type)
2107 Found in file handy.h
2112 The XSUB-writer's interface to the C C<malloc> function, with
2113 cast. See also C<Newx>.
2115 void Newxc(void* ptr, int nitems, type, cast)
2118 Found in file handy.h
2123 The XSUB-writer's interface to the C C<malloc> function. The allocated
2124 memory is zeroed with C<memzero>. See also C<Newx>.
2126 void Newxz(void* ptr, int nitems, type)
2129 Found in file handy.h
2134 PoisonWith(0xEF) for catching access to freed memory.
2136 void Poison(void* dest, int nitems, type)
2139 Found in file handy.h
2144 PoisonWith(0xEF) for catching access to freed memory.
2146 void PoisonFree(void* dest, int nitems, type)
2149 Found in file handy.h
2154 PoisonWith(0xAB) for catching access to allocated but uninitialized memory.
2156 void PoisonNew(void* dest, int nitems, type)
2159 Found in file handy.h
2164 Fill up memory with a byte pattern (a byte repeated over and over
2165 again) that hopefully catches attempts to access uninitialized memory.
2167 void PoisonWith(void* dest, int nitems, type, U8 byte)
2170 Found in file handy.h
2175 The XSUB-writer's interface to the C C<realloc> function.
2177 void Renew(void* ptr, int nitems, type)
2180 Found in file handy.h
2185 The XSUB-writer's interface to the C C<realloc> function, with
2188 void Renewc(void* ptr, int nitems, type, cast)
2191 Found in file handy.h
2196 The XSUB-writer's interface to the C C<free> function.
2198 void Safefree(void* ptr)
2201 Found in file handy.h
2206 Perl's version of C<strdup()>. Returns a pointer to a newly allocated
2207 string which is a duplicate of C<pv>. The size of the string is
2208 determined by C<strlen()>. The memory allocated for the new string can
2209 be freed with the C<Safefree()> function.
2211 char* savepv(const char* pv)
2214 Found in file util.c
2219 Perl's version of what C<strndup()> would be if it existed. Returns a
2220 pointer to a newly allocated string which is a duplicate of the first
2221 C<len> bytes from C<pv>, plus a trailing NUL byte. The memory allocated for
2222 the new string can be freed with the C<Safefree()> function.
2224 char* savepvn(const char* pv, I32 len)
2227 Found in file util.c
2232 Like C<savepvn>, but takes a literal string instead of a string/length pair.
2234 char* savepvs(const char* s)
2237 Found in file handy.h
2242 A version of C<savepv()> which allocates the duplicate string in memory
2243 which is shared between threads.
2245 char* savesharedpv(const char* pv)
2248 Found in file util.c
2253 A version of C<savepv()>/C<savepvn()> which gets the string to duplicate from
2254 the passed in SV using C<SvPV()>
2256 char* savesvpv(SV* sv)
2259 Found in file util.c
2264 This is an architecture-independent macro to copy one structure to another.
2266 void StructCopy(type src, type dest, type)
2269 Found in file handy.h
2274 The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the
2275 destination, C<nitems> is the number of items, and C<type> is the type.
2277 void Zero(void* dest, int nitems, type)
2280 Found in file handy.h
2285 Like C<Zero> but returns dest. Useful for encouraging compilers to tail-call
2288 void * ZeroD(void* dest, int nitems, type)
2291 Found in file handy.h
2296 =head1 Miscellaneous Functions
2303 Analyses the string in order to make fast searches on it using fbm_instr()
2304 -- the Boyer-Moore algorithm.
2306 void fbm_compile(SV* sv, U32 flags)
2309 Found in file util.c
2314 Returns the location of the SV in the string delimited by C<str> and
2315 C<strend>. It returns C<NULL> if the string can't be found. The C<sv>
2316 does not have to be fbm_compiled, but the search will not be as fast
2319 char* fbm_instr(unsigned char* big, unsigned char* bigend, SV* littlesv, U32 flags)
2322 Found in file util.c
2327 Takes a sprintf-style format pattern and conventional
2328 (non-SV) arguments and returns the formatted string.
2330 (char *) Perl_form(pTHX_ const char* pat, ...)
2332 can be used any place a string (char *) is required:
2334 char * s = Perl_form("%d.%d",major,minor);
2336 Uses a single private buffer so if you want to format several strings you
2337 must explicitly copy the earlier strings away (and free the copies when you
2340 char* form(const char* pat, ...)
2343 Found in file util.c
2348 Fill the sv with current working directory
2350 int getcwd_sv(SV* sv)
2353 Found in file util.c
2358 The C library C<snprintf> functionality, if available and
2359 standards-compliant (uses C<vsnprintf>, actually). However, if the
2360 C<vsnprintf> is not available, will unfortunately use the unsafe
2361 C<vsprintf> which can overrun the buffer (there is an overrun check,
2362 but that may be too late). Consider using C<sv_vcatpvf> instead, or
2363 getting C<vsnprintf>.
2365 int my_snprintf(char *buffer, const Size_t len, const char *format, ...)
2368 Found in file util.c
2373 The C library C<sprintf>, wrapped if necessary, to ensure that it will return
2374 the length of the string written to the buffer. Only rare pre-ANSI systems
2375 need the wrapper function - usually this is a direct call to C<sprintf>.
2377 int my_sprintf(char *buffer, const char *pat, ...)
2380 Found in file util.c
2385 The C library C<vsnprintf> if available and standards-compliant.
2386 However, if if the C<vsnprintf> is not available, will unfortunately
2387 use the unsafe C<vsprintf> which can overrun the buffer (there is an
2388 overrun check, but that may be too late). Consider using
2389 C<sv_vcatpvf> instead, or getting C<vsnprintf>.
2391 int my_vsnprintf(char *buffer, const Size_t len, const char *format, va_list ap)
2394 Found in file util.c
2399 Returns a new version object based on the passed in SV:
2401 SV *sv = new_version(SV *ver);
2403 Does not alter the passed in ver SV. See "upg_version" if you
2404 want to upgrade the SV.
2406 SV* new_version(SV *ver)
2409 Found in file util.c
2414 Returns a pointer to the next character after the parsed
2415 version string, as well as upgrading the passed in SV to
2418 Function must be called with an already existing SV like
2421 s = scan_version(s,SV *sv, bool qv);
2423 Performs some preprocessing to the string to ensure that
2424 it has the correct characteristics of a version. Flags the
2425 object if it contains an underscore (which denotes this
2426 is a alpha version). The boolean qv denotes that the version
2427 should be interpreted as if it had multiple decimals, even if
2430 const char* scan_version(const char *vstr, SV *sv, bool qv)
2433 Found in file util.c
2438 Test two strings to see if they are equal. Returns true or false.
2440 bool strEQ(char* s1, char* s2)
2443 Found in file handy.h
2448 Test two strings to see if the first, C<s1>, is greater than or equal to
2449 the second, C<s2>. Returns true or false.
2451 bool strGE(char* s1, char* s2)
2454 Found in file handy.h
2459 Test two strings to see if the first, C<s1>, is greater than the second,
2460 C<s2>. Returns true or false.
2462 bool strGT(char* s1, char* s2)
2465 Found in file handy.h
2470 Test two strings to see if the first, C<s1>, is less than or equal to the
2471 second, C<s2>. Returns true or false.
2473 bool strLE(char* s1, char* s2)
2476 Found in file handy.h
2481 Test two strings to see if the first, C<s1>, is less than the second,
2482 C<s2>. Returns true or false.
2484 bool strLT(char* s1, char* s2)
2487 Found in file handy.h
2492 Test two strings to see if they are different. Returns true or
2495 bool strNE(char* s1, char* s2)
2498 Found in file handy.h
2503 Test two strings to see if they are equal. The C<len> parameter indicates
2504 the number of bytes to compare. Returns true or false. (A wrapper for
2507 bool strnEQ(char* s1, char* s2, STRLEN len)
2510 Found in file handy.h
2515 Test two strings to see if they are different. The C<len> parameter
2516 indicates the number of bytes to compare. Returns true or false. (A
2517 wrapper for C<strncmp>).
2519 bool strnNE(char* s1, char* s2, STRLEN len)
2522 Found in file handy.h
2527 Dummy routine which "shares" an SV when there is no sharing module present.
2528 Or "locks" it. Or "unlocks" it. In other words, ignores its single SV argument.
2529 Exists to avoid test for a NULL function pointer and because it could
2530 potentially warn under some level of strict-ness.
2532 void sv_nosharing(SV *sv)
2535 Found in file util.c
2540 In-place upgrade of the supplied SV to a version object.
2542 SV *sv = upg_version(SV *sv);
2544 Returns a pointer to the upgraded SV.
2546 SV* upg_version(SV *ver)
2549 Found in file util.c
2554 Version object aware cmp. Both operands must already have been
2555 converted into version objects.
2557 int vcmp(SV *lvs, SV *rvs)
2560 Found in file util.c
2565 Accepts a version object and returns the normalized string
2566 representation. Call like:
2570 NOTE: you can pass either the object directly or the SV
2571 contained within the RV.
2576 Found in file util.c
2581 Accepts a version object and returns the normalized floating
2582 point representation. Call like:
2586 NOTE: you can pass either the object directly or the SV
2587 contained within the RV.
2592 Found in file util.c
2597 In order to maintain maximum compatibility with earlier versions
2598 of Perl, this function will return either the floating point
2599 notation or the multiple dotted notation, depending on whether
2600 the original version contained 1 or more dots, respectively
2602 SV* vstringify(SV *vs)
2605 Found in file util.c
2610 Validates that the SV contains a valid version object.
2612 bool vverify(SV *vobj);
2614 Note that it only confirms the bare minimum structure (so as not to get
2615 confused by derived classes which may contain additional hash entries):
2617 bool vverify(SV *vs)
2620 Found in file util.c
2625 =head1 Multicall Functions
2632 Declare local variables for a multicall. See L<perlcall/Lightweight Callbacks>.
2642 Make a lightweight callback. See L<perlcall/Lightweight Callbacks>.
2652 Closing bracket for a lightweight callback.
2653 See L<perlcall/Lightweight Callbacks>.
2660 =item PUSH_MULTICALL
2663 Opening bracket for a lightweight callback.
2664 See L<perlcall/Lightweight Callbacks>.
2674 =head1 Numeric functions
2681 converts a string representing a binary number to numeric form.
2683 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2684 conversion flags, and I<result> should be NULL or a pointer to an NV.
2685 The scan stops at the end of the string, or the first invalid character.
2686 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2687 invalid character will also trigger a warning.
2688 On return I<*len> is set to the length of the scanned string,
2689 and I<*flags> gives output flags.
2691 If the value is <= C<UV_MAX> it is returned as a UV, the output flags are clear,
2692 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_bin>
2693 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2694 and writes the value to I<*result> (or the value is discarded if I<result>
2697 The binary number may optionally be prefixed with "0b" or "b" unless
2698 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
2699 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the binary
2700 number may use '_' characters to separate digits.
2702 UV grok_bin(const char* start, STRLEN* len_p, I32* flags, NV *result)
2705 Found in file numeric.c
2710 converts a string representing a hex number to numeric form.
2712 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2713 conversion flags, and I<result> should be NULL or a pointer to an NV.
2714 The scan stops at the end of the string, or the first invalid character.
2715 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2716 invalid character will also trigger a warning.
2717 On return I<*len> is set to the length of the scanned string,
2718 and I<*flags> gives output flags.
2720 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2721 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_hex>
2722 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2723 and writes the value to I<*result> (or the value is discarded if I<result>
2726 The hex number may optionally be prefixed with "0x" or "x" unless
2727 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
2728 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the hex
2729 number may use '_' characters to separate digits.
2731 UV grok_hex(const char* start, STRLEN* len_p, I32* flags, NV *result)
2734 Found in file numeric.c
2739 Recognise (or not) a number. The type of the number is returned
2740 (0 if unrecognised), otherwise it is a bit-ORed combination of
2741 IS_NUMBER_IN_UV, IS_NUMBER_GREATER_THAN_UV_MAX, IS_NUMBER_NOT_INT,
2742 IS_NUMBER_NEG, IS_NUMBER_INFINITY, IS_NUMBER_NAN (defined in perl.h).
2744 If the value of the number can fit an in UV, it is returned in the *valuep
2745 IS_NUMBER_IN_UV will be set to indicate that *valuep is valid, IS_NUMBER_IN_UV
2746 will never be set unless *valuep is valid, but *valuep may have been assigned
2747 to during processing even though IS_NUMBER_IN_UV is not set on return.
2748 If valuep is NULL, IS_NUMBER_IN_UV will be set for the same cases as when
2749 valuep is non-NULL, but no actual assignment (or SEGV) will occur.
2751 IS_NUMBER_NOT_INT will be set with IS_NUMBER_IN_UV if trailing decimals were
2752 seen (in which case *valuep gives the true value truncated to an integer), and
2753 IS_NUMBER_NEG if the number is negative (in which case *valuep holds the
2754 absolute value). IS_NUMBER_IN_UV is not set if e notation was used or the
2755 number is larger than a UV.
2757 int grok_number(const char *pv, STRLEN len, UV *valuep)
2760 Found in file numeric.c
2762 =item grok_numeric_radix
2763 X<grok_numeric_radix>
2765 Scan and skip for a numeric decimal separator (radix).
2767 bool grok_numeric_radix(const char **sp, const char *send)
2770 Found in file numeric.c
2775 converts a string representing an octal number to numeric form.
2777 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2778 conversion flags, and I<result> should be NULL or a pointer to an NV.
2779 The scan stops at the end of the string, or the first invalid character.
2780 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2781 invalid character will also trigger a warning.
2782 On return I<*len> is set to the length of the scanned string,
2783 and I<*flags> gives output flags.
2785 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2786 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_oct>
2787 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2788 and writes the value to I<*result> (or the value is discarded if I<result>
2791 If C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the octal
2792 number may use '_' characters to separate digits.
2794 UV grok_oct(const char* start, STRLEN* len_p, I32* flags, NV *result)
2797 Found in file numeric.c
2802 For backwards compatibility. Use C<grok_bin> instead.
2804 NV scan_bin(const char* start, STRLEN len, STRLEN* retlen)
2807 Found in file numeric.c
2812 For backwards compatibility. Use C<grok_hex> instead.
2814 NV scan_hex(const char* start, STRLEN len, STRLEN* retlen)
2817 Found in file numeric.c
2822 For backwards compatibility. Use C<grok_oct> instead.
2824 NV scan_oct(const char* start, STRLEN len, STRLEN* retlen)
2827 Found in file numeric.c
2832 =head1 Optree Manipulation Functions
2839 If C<cv> is a constant sub eligible for inlining. returns the constant
2840 value returned by the sub. Otherwise, returns NULL.
2842 Constant subs can be created with C<newCONSTSUB> or as described in
2843 L<perlsub/"Constant Functions">.
2845 SV* cv_const_sv(CV* cv)
2853 Creates a constant sub equivalent to Perl C<sub FOO () { 123 }> which is
2854 eligible for inlining at compile-time.
2856 CV* newCONSTSUB(HV* stash, const char* name, SV* sv)
2864 Used by C<xsubpp> to hook up XSUBs as Perl subs. I<filename> needs to be
2865 static storage, as it is used directly as CvFILE(), without a copy being made.
2873 =head1 Pad Data Structures
2880 Get the value at offset po in the current pad.
2881 Use macro PAD_SV instead of calling this function directly.
2883 SV* pad_sv(PADOFFSET po)
2891 =head1 Simple Exception Handling Macros
2898 Set up necessary local variables for exception handling.
2899 See L<perlguts/"Exception Handling">.
2904 Found in file XSUB.h
2909 Introduces a catch block. See L<perlguts/"Exception Handling">.
2912 Found in file XSUB.h
2917 Rethrows a previously caught exception. See L<perlguts/"Exception Handling">.
2922 Found in file XSUB.h
2927 Ends a try block. See L<perlguts/"Exception Handling">.
2930 Found in file XSUB.h
2932 =item XCPT_TRY_START
2935 Starts a try block. See L<perlguts/"Exception Handling">.
2938 Found in file XSUB.h
2943 =head1 Stack Manipulation Macros
2950 Declare a stack marker variable, C<mark>, for the XSUB. See C<MARK> and
2961 Saves the original stack mark for the XSUB. See C<ORIGMARK>.
2971 Declares a local copy of perl's stack pointer for the XSUB, available via
2972 the C<SP> macro. See C<SP>.
2982 Used to extend the argument stack for an XSUB's return values. Once
2983 used, guarantees that there is room for at least C<nitems> to be pushed
2986 void EXTEND(SP, int nitems)
2994 Stack marker variable for the XSUB. See C<dMARK>.
3002 Push an integer onto the stack. The stack must have room for this element.
3003 Handles 'set' magic. Does not use C<TARG>. See also C<PUSHi>, C<mXPUSHi>
3014 Push a double onto the stack. The stack must have room for this element.
3015 Handles 'set' magic. Does not use C<TARG>. See also C<PUSHn>, C<mXPUSHn>
3026 Push a string onto the stack. The stack must have room for this element.
3027 The C<len> indicates the length of the string. Handles 'set' magic. Does
3028 not use C<TARG>. See also C<PUSHp>, C<mXPUSHp> and C<XPUSHp>.
3030 void mPUSHp(char* str, STRLEN len)
3038 Push an unsigned integer onto the stack. The stack must have room for this
3039 element. Handles 'set' magic. Does not use C<TARG>. See also C<PUSHu>,
3040 C<mXPUSHu> and C<XPUSHu>.
3050 Push an integer onto the stack, extending the stack if necessary. Handles
3051 'set' magic. Does not use C<TARG>. See also C<XPUSHi>, C<mPUSHi> and
3062 Push a double onto the stack, extending the stack if necessary. Handles
3063 'set' magic. Does not use C<TARG>. See also C<XPUSHn>, C<mPUSHn> and
3074 Push a string onto the stack, extending the stack if necessary. The C<len>
3075 indicates the length of the string. Handles 'set' magic. Does not use
3076 C<TARG>. See also C<XPUSHp>, C<mPUSHp> and C<PUSHp>.
3078 void mXPUSHp(char* str, STRLEN len)
3086 Push an unsigned integer onto the stack, extending the stack if necessary.
3087 Handles 'set' magic. Does not use C<TARG>. See also C<XPUSHu>, C<mPUSHu>
3098 The original stack mark for the XSUB. See C<dORIGMARK>.
3106 Pops an integer off the stack.
3116 Pops a long off the stack.
3126 Pops a double off the stack.
3136 Pops a string off the stack. Deprecated. New code should use POPpx.
3146 Pops a string off the stack which must consist of bytes i.e. characters < 256.
3156 Pops a string off the stack.
3166 Pops an SV off the stack.
3176 Push an integer onto the stack. The stack must have room for this element.
3177 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3178 called to declare it. Do not call multiple C<TARG>-oriented macros to
3179 return lists from XSUB's - see C<mPUSHi> instead. See also C<XPUSHi> and
3190 Opening bracket for arguments on a callback. See C<PUTBACK> and
3201 Push a new mortal SV onto the stack. The stack must have room for this
3202 element. Does not handle 'set' magic. Does not use C<TARG>. See also
3203 C<PUSHs>, C<XPUSHmortal> and C<XPUSHs>.
3213 Push a double onto the stack. The stack must have room for this element.
3214 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3215 called to declare it. Do not call multiple C<TARG>-oriented macros to
3216 return lists from XSUB's - see C<mPUSHn> instead. See also C<XPUSHn> and
3227 Push a string onto the stack. The stack must have room for this element.
3228 The C<len> indicates the length of the string. Handles 'set' magic. Uses
3229 C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to declare it. Do not
3230 call multiple C<TARG>-oriented macros to return lists from XSUB's - see
3231 C<mPUSHp> instead. See also C<XPUSHp> and C<mXPUSHp>.
3233 void PUSHp(char* str, STRLEN len)
3241 Push an SV onto the stack. The stack must have room for this element.
3242 Does not handle 'set' magic. Does not use C<TARG>. See also C<PUSHmortal>,
3243 C<XPUSHs> and C<XPUSHmortal>.
3253 Push an unsigned integer onto the stack. The stack must have room for this
3254 element. Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG>
3255 should be called to declare it. Do not call multiple C<TARG>-oriented
3256 macros to return lists from XSUB's - see C<mPUSHu> instead. See also
3257 C<XPUSHu> and C<mXPUSHu>.
3267 Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
3268 See C<PUSHMARK> and L<perlcall> for other uses.
3278 Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and
3287 Refetch the stack pointer. Used after a callback. See L<perlcall>.
3297 Push an integer onto the stack, extending the stack if necessary. Handles
3298 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
3299 declare it. Do not call multiple C<TARG>-oriented macros to return lists
3300 from XSUB's - see C<mXPUSHi> instead. See also C<PUSHi> and C<mPUSHi>.
3310 Push a new mortal SV onto the stack, extending the stack if necessary. Does
3311 not handle 'set' magic. Does not use C<TARG>. See also C<XPUSHs>,
3312 C<PUSHmortal> and C<PUSHs>.
3322 Push a double onto the stack, extending the stack if necessary. Handles
3323 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
3324 declare it. Do not call multiple C<TARG>-oriented macros to return lists
3325 from XSUB's - see C<mXPUSHn> instead. See also C<PUSHn> and C<mPUSHn>.
3335 Push a string onto the stack, extending the stack if necessary. The C<len>
3336 indicates the length of the string. Handles 'set' magic. Uses C<TARG>, so
3337 C<dTARGET> or C<dXSTARG> should be called to declare it. Do not call
3338 multiple C<TARG>-oriented macros to return lists from XSUB's - see
3339 C<mXPUSHp> instead. See also C<PUSHp> and C<mPUSHp>.
3341 void XPUSHp(char* str, STRLEN len)
3349 Push an SV onto the stack, extending the stack if necessary. Does not
3350 handle 'set' magic. Does not use C<TARG>. See also C<XPUSHmortal>,
3351 C<PUSHs> and C<PUSHmortal>.
3361 Push an unsigned integer onto the stack, extending the stack if necessary.
3362 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3363 called to declare it. Do not call multiple C<TARG>-oriented macros to
3364 return lists from XSUB's - see C<mXPUSHu> instead. See also C<PUSHu> and
3375 Return from XSUB, indicating number of items on the stack. This is usually
3376 handled by C<xsubpp>.
3378 void XSRETURN(int nitems)
3381 Found in file XSUB.h
3383 =item XSRETURN_EMPTY
3386 Return an empty list from an XSUB immediately.
3391 Found in file XSUB.h
3396 Return an integer from an XSUB immediately. Uses C<XST_mIV>.
3398 void XSRETURN_IV(IV iv)
3401 Found in file XSUB.h
3406 Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
3411 Found in file XSUB.h
3416 Return a double from an XSUB immediately. Uses C<XST_mNV>.
3418 void XSRETURN_NV(NV nv)
3421 Found in file XSUB.h
3426 Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
3428 void XSRETURN_PV(char* str)
3431 Found in file XSUB.h
3433 =item XSRETURN_UNDEF
3436 Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
3441 Found in file XSUB.h
3446 Return an integer from an XSUB immediately. Uses C<XST_mUV>.
3448 void XSRETURN_UV(IV uv)
3451 Found in file XSUB.h
3456 Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
3461 Found in file XSUB.h
3466 Place an integer into the specified position C<pos> on the stack. The
3467 value is stored in a new mortal SV.
3469 void XST_mIV(int pos, IV iv)
3472 Found in file XSUB.h
3477 Place C<&PL_sv_no> into the specified position C<pos> on the
3480 void XST_mNO(int pos)
3483 Found in file XSUB.h
3488 Place a double into the specified position C<pos> on the stack. The value
3489 is stored in a new mortal SV.
3491 void XST_mNV(int pos, NV nv)
3494 Found in file XSUB.h
3499 Place a copy of a string into the specified position C<pos> on the stack.
3500 The value is stored in a new mortal SV.
3502 void XST_mPV(int pos, char* str)
3505 Found in file XSUB.h
3510 Place C<&PL_sv_undef> into the specified position C<pos> on the
3513 void XST_mUNDEF(int pos)
3516 Found in file XSUB.h
3521 Place C<&PL_sv_yes> into the specified position C<pos> on the
3524 void XST_mYES(int pos)
3527 Found in file XSUB.h
3539 An enum of flags for Perl types. These are found in the file B<sv.h>
3540 in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
3548 Integer type flag for scalars. See C<svtype>.
3556 Double type flag for scalars. See C<svtype>.
3564 Pointer type flag for scalars. See C<svtype>.
3572 Type flag for arrays. See C<svtype>.
3580 Type flag for code refs. See C<svtype>.
3588 Type flag for hashes. See C<svtype>.
3596 Type flag for blessed scalars. See C<svtype>.
3604 =head1 SV Manipulation Functions
3611 Returns the SV of the specified Perl scalar. If C<create> is set and the
3612 Perl variable does not exist then it will be created. If C<create> is not
3613 set and the variable does not exist then NULL is returned.
3615 NOTE: the perl_ form of this function is deprecated.
3617 SV* get_sv(const char* name, I32 create)
3620 Found in file perl.c
3625 Creates an RV wrapper for an SV. The reference count for the original SV is
3628 SV* newRV_inc(SV* sv)
3636 Returns the length of the string which is in the SV. See C<SvLEN>.
3638 STRLEN SvCUR(SV* sv)
3646 Set the current length of the string which is in the SV. See C<SvCUR>
3649 void SvCUR_set(SV* sv, STRLEN len)
3657 Returns a pointer to the last character in the string which is in the SV.
3658 See C<SvCUR>. Access the character as *(SvEND(sv)).
3668 Returns true if the SV has get magic or overloading. If either is true then
3669 the scalar is active data, and has the potential to return a new value every
3670 time it is accessed. Hence you must be careful to only read it once per user
3671 logical operation and work with that returned value. If neither is true then
3672 the scalar's value cannot change unless written to.
3674 char* SvGAMAGIC(SV* sv)
3682 Expands the character buffer in the SV so that it has room for the
3683 indicated number of bytes (remember to reserve space for an extra trailing
3684 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
3685 Returns a pointer to the character buffer.
3687 char * SvGROW(SV* sv, STRLEN len)
3695 Returns a boolean indicating whether the SV contains an integer.
3705 Returns a boolean indicating whether the SV contains an integer. Checks
3706 the B<private> setting. Use C<SvIOK>.
3716 Returns a boolean indicating whether the SV contains a signed integer.
3718 bool SvIOK_notUV(SV* sv)
3726 Unsets the IV status of an SV.
3728 void SvIOK_off(SV* sv)
3736 Tells an SV that it is an integer.
3738 void SvIOK_on(SV* sv)
3746 Tells an SV that it is an integer and disables all other OK bits.
3748 void SvIOK_only(SV* sv)
3756 Tells and SV that it is an unsigned integer and disables all other OK bits.
3758 void SvIOK_only_UV(SV* sv)
3766 Returns a boolean indicating whether the SV contains an unsigned integer.
3768 bool SvIOK_UV(SV* sv)
3776 Returns a boolean indicating whether the SV is Copy-On-Write. (either shared
3777 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
3780 bool SvIsCOW(SV* sv)
3785 =item SvIsCOW_shared_hash
3786 X<SvIsCOW_shared_hash>
3788 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
3791 bool SvIsCOW_shared_hash(SV* sv)
3799 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
3800 version which guarantees to evaluate sv only once.
3810 Returns the raw value in the SV's IV slot, without checks or conversions.
3811 Only use when you are sure SvIOK is true. See also C<SvIV()>.
3821 Coerces the given SV to an integer and returns it. Guarantees to evaluate
3822 sv only once. Use the more efficient C<SvIV> otherwise.
3832 Like C<SvIV> but doesn't process magic.
3834 IV SvIV_nomg(SV* sv)
3842 Set the value of the IV pointer in sv to val. It is possible to perform
3843 the same function of this macro with an lvalue assignment to C<SvIVX>.
3844 With future Perls, however, it will be more efficient to use
3845 C<SvIV_set> instead of the lvalue assignment to C<SvIVX>.
3847 void SvIV_set(SV* sv, IV val)
3855 Returns the size of the string buffer in the SV, not including any part
3856 attributable to C<SvOOK>. See C<SvCUR>.
3858 STRLEN SvLEN(SV* sv)
3866 Set the actual length of the string which is in the SV. See C<SvIV_set>.
3868 void SvLEN_set(SV* sv, STRLEN len)
3876 Set the value of the MAGIC pointer in sv to val. See C<SvIV_set>.
3878 void SvMAGIC_set(SV* sv, MAGIC* val)
3886 Returns a boolean indicating whether the SV contains a number, integer or
3897 Returns a boolean indicating whether the SV contains a number, integer or
3898 double. Checks the B<private> setting. Use C<SvNIOK>.
3900 bool SvNIOKp(SV* sv)
3908 Unsets the NV/IV status of an SV.
3910 void SvNIOK_off(SV* sv)
3918 Returns a boolean indicating whether the SV contains a double.
3928 Returns a boolean indicating whether the SV contains a double. Checks the
3929 B<private> setting. Use C<SvNOK>.
3939 Unsets the NV status of an SV.
3941 void SvNOK_off(SV* sv)
3949 Tells an SV that it is a double.
3951 void SvNOK_on(SV* sv)
3959 Tells an SV that it is a double and disables all other OK bits.
3961 void SvNOK_only(SV* sv)
3969 Coerce the given SV to a double and return it. See C<SvNVx> for a version
3970 which guarantees to evaluate sv only once.
3980 Returns the raw value in the SV's NV slot, without checks or conversions.
3981 Only use when you are sure SvNOK is true. See also C<SvNV()>.
3991 Coerces the given SV to a double and returns it. Guarantees to evaluate
3992 sv only once. Use the more efficient C<SvNV> otherwise.
4002 Set the value of the NV pointer in sv to val. See C<SvIV_set>.
4004 void SvNV_set(SV* sv, NV val)
4012 Returns a boolean indicating whether the value is an SV. It also tells
4013 whether the value is defined or not.
4023 Returns a boolean indicating whether the SvIVX is a valid offset value for
4024 the SvPVX. This hack is used internally to speed up removal of characters
4025 from the beginning of a SvPV. When SvOOK is true, then the start of the
4026 allocated string buffer is really (SvPVX - SvIVX).
4036 Returns a boolean indicating whether the SV contains a character
4047 Returns a boolean indicating whether the SV contains a character string.
4048 Checks the B<private> setting. Use C<SvPOK>.
4058 Unsets the PV status of an SV.
4060 void SvPOK_off(SV* sv)
4068 Tells an SV that it is a string.
4070 void SvPOK_on(SV* sv)
4078 Tells an SV that it is a string and disables all other OK bits.
4079 Will also turn off the UTF-8 status.
4081 void SvPOK_only(SV* sv)
4086 =item SvPOK_only_UTF8
4089 Tells an SV that it is a string and disables all other OK bits,
4090 and leaves the UTF-8 status as it was.
4092 void SvPOK_only_UTF8(SV* sv)
4100 Returns a pointer to the string in the SV, or a stringified form of
4101 the SV if the SV does not contain a string. The SV may cache the
4102 stringified version becoming C<SvPOK>. Handles 'get' magic. See also
4103 C<SvPVx> for a version which guarantees to evaluate sv only once.
4105 char* SvPV(SV* sv, STRLEN len)
4113 Like C<SvPV>, but converts sv to byte representation first if necessary.
4115 char* SvPVbyte(SV* sv, STRLEN len)
4123 Like C<SvPV>, but converts sv to byte representation first if necessary.
4124 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
4127 char* SvPVbytex(SV* sv, STRLEN len)
4132 =item SvPVbytex_force
4135 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
4136 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
4139 char* SvPVbytex_force(SV* sv, STRLEN len)
4144 =item SvPVbyte_force
4147 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
4149 char* SvPVbyte_force(SV* sv, STRLEN len)
4154 =item SvPVbyte_nolen
4157 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
4159 char* SvPVbyte_nolen(SV* sv)
4167 Like C<SvPV>, but converts sv to utf8 first if necessary.
4169 char* SvPVutf8(SV* sv, STRLEN len)
4177 Like C<SvPV>, but converts sv to utf8 first if necessary.
4178 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
4181 char* SvPVutf8x(SV* sv, STRLEN len)
4186 =item SvPVutf8x_force
4189 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
4190 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
4193 char* SvPVutf8x_force(SV* sv, STRLEN len)
4198 =item SvPVutf8_force
4201 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
4203 char* SvPVutf8_force(SV* sv, STRLEN len)
4208 =item SvPVutf8_nolen
4211 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
4213 char* SvPVutf8_nolen(SV* sv)
4221 Returns a pointer to the physical string in the SV. The SV must contain a
4232 A version of C<SvPV> which guarantees to evaluate sv only once.
4234 char* SvPVx(SV* sv, STRLEN len)
4242 Like C<SvPV> but will force the SV into containing just a string
4243 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
4246 char* SvPV_force(SV* sv, STRLEN len)
4251 =item SvPV_force_nomg
4254 Like C<SvPV> but will force the SV into containing just a string
4255 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
4256 directly. Doesn't process magic.
4258 char* SvPV_force_nomg(SV* sv, STRLEN len)
4266 Returns a pointer to the string in the SV, or a stringified form of
4267 the SV if the SV does not contain a string. The SV may cache the
4268 stringified form becoming C<SvPOK>. Handles 'get' magic.
4270 char* SvPV_nolen(SV* sv)
4278 Like C<SvPV> but doesn't process magic.
4280 char* SvPV_nomg(SV* sv, STRLEN len)
4288 Set the value of the PV pointer in sv to val. See C<SvIV_set>.
4290 void SvPV_set(SV* sv, char* val)
4298 Returns the value of the object's reference count.
4300 U32 SvREFCNT(SV* sv)
4308 Decrements the reference count of the given SV.
4310 void SvREFCNT_dec(SV* sv)
4318 Increments the reference count of the given SV.
4320 All of the following SvREFCNT_inc* macros are optimized versions of
4321 SvREFCNT_inc, and can be replaced with SvREFCNT_inc.
4323 SV* SvREFCNT_inc(SV* sv)
4328 =item SvREFCNT_inc_NN
4331 Same as SvREFCNT_inc, but can only be used if you know I<sv>
4332 is not NULL. Since we don't have to check the NULLness, it's faster
4335 SV* SvREFCNT_inc_NN(SV* sv)
4340 =item SvREFCNT_inc_simple
4341 X<SvREFCNT_inc_simple>
4343 Same as SvREFCNT_inc, but can only be used with simple variables, not
4344 expressions or pointer dereferences. Since we don't have to store a
4345 temporary value, it's faster.
4347 SV* SvREFCNT_inc_simple(SV* sv)
4352 =item SvREFCNT_inc_simple_NN
4353 X<SvREFCNT_inc_simple_NN>
4355 Same as SvREFCNT_inc_simple, but can only be used if you know I<sv>
4356 is not NULL. Since we don't have to check the NULLness, it's faster
4359 SV* SvREFCNT_inc_simple_NN(SV* sv)
4364 =item SvREFCNT_inc_simple_void
4365 X<SvREFCNT_inc_simple_void>
4367 Same as SvREFCNT_inc_simple, but can only be used if you don't need the
4368 return value. The macro doesn't need to return a meaningful value.
4370 void SvREFCNT_inc_simple_void(SV* sv)
4375 =item SvREFCNT_inc_simple_void_NN
4376 X<SvREFCNT_inc_simple_void_NN>
4378 Same as SvREFCNT_inc, but can only be used if you don't need the return
4379 value, and you know that I<sv> is not NULL. The macro doesn't need
4380 to return a meaningful value, or check for NULLness, so it's smaller
4383 void SvREFCNT_inc_simple_void_NN(SV* sv)
4388 =item SvREFCNT_inc_void
4389 X<SvREFCNT_inc_void>
4391 Same as SvREFCNT_inc, but can only be used if you don't need the
4392 return value. The macro doesn't need to return a meaningful value.
4394 void SvREFCNT_inc_void(SV* sv)
4399 =item SvREFCNT_inc_void_NN
4400 X<SvREFCNT_inc_void_NN>
4402 Same as SvREFCNT_inc, but can only be used if you don't need the return
4403 value, and you know that I<sv> is not NULL. The macro doesn't need
4404 to return a meaningful value, or check for NULLness, so it's smaller
4407 void SvREFCNT_inc_void_NN(SV* sv)
4415 Tests if the SV is an RV.
4425 Unsets the RV status of an SV.
4427 void SvROK_off(SV* sv)
4435 Tells an SV that it is an RV.
4437 void SvROK_on(SV* sv)
4445 Dereferences an RV to return the SV.
4455 Set the value of the RV pointer in sv to val. See C<SvIV_set>.
4457 void SvRV_set(SV* sv, SV* val)
4465 Returns the stash of the SV.
4475 Set the value of the STASH pointer in sv to val. See C<SvIV_set>.
4477 void SvSTASH_set(SV* sv, HV* val)
4485 Taints an SV if tainting is enabled.
4487 void SvTAINT(SV* sv)
4495 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
4498 bool SvTAINTED(SV* sv)
4506 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
4507 some of Perl's fundamental security features. XS module authors should not
4508 use this function unless they fully understand all the implications of
4509 unconditionally untainting the value. Untainting should be done in the
4510 standard perl fashion, via a carefully crafted regexp, rather than directly
4511 untainting variables.
4513 void SvTAINTED_off(SV* sv)
4521 Marks an SV as tainted if tainting is enabled.
4523 void SvTAINTED_on(SV* sv)
4531 Returns a boolean indicating whether Perl would evaluate the SV as true or
4532 false, defined or undefined. Does not handle 'get' magic.
4542 Returns the type of the SV. See C<svtype>.
4544 svtype SvTYPE(SV* sv)
4552 Returns a boolean indicating whether the SV contains an unsigned integer.
4562 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
4563 perform the upgrade if necessary. See C<svtype>.
4565 void SvUPGRADE(SV* sv, svtype type)
4573 Returns a boolean indicating whether the SV contains UTF-8 encoded data.
4583 Unsets the UTF-8 status of an SV.
4585 void SvUTF8_off(SV *sv)
4593 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
4594 Do not use frivolously.
4596 void SvUTF8_on(SV *sv)
4604 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
4605 for a version which guarantees to evaluate sv only once.
4615 Returns the raw value in the SV's UV slot, without checks or conversions.
4616 Only use when you are sure SvIOK is true. See also C<SvUV()>.
4626 Coerces the given SV to an unsigned integer and returns it. Guarantees to
4627 evaluate sv only once. Use the more efficient C<SvUV> otherwise.
4637 Like C<SvUV> but doesn't process magic.
4639 UV SvUV_nomg(SV* sv)
4647 Set the value of the UV pointer in sv to val. See C<SvIV_set>.
4649 void SvUV_set(SV* sv, UV val)
4657 Returns a boolean indicating whether the SV contains a v-string.
4664 =item sv_catpvn_nomg
4667 Like C<sv_catpvn> but doesn't process magic.
4669 void sv_catpvn_nomg(SV* sv, const char* ptr, STRLEN len)
4677 Like C<sv_catsv> but doesn't process magic.
4679 void sv_catsv_nomg(SV* dsv, SV* ssv)
4684 =item sv_derived_from
4687 Returns a boolean indicating whether the SV is derived from the specified class
4688 I<at the C level>. To check derivation at the Perl level, call C<isa()> as a
4691 bool sv_derived_from(SV* sv, const char* name)
4694 Found in file universal.c
4699 Returns a boolean indicating whether the SV performs a specific, named role.
4700 The SV can be a Perl object or the name of a Perl class.
4702 bool sv_does(SV* sv, const char* name)
4705 Found in file universal.c
4707 =item sv_report_used
4710 Dump the contents of all SVs not yet freed. (Debugging aid).
4712 void sv_report_used()
4720 Like C<sv_setsv> but doesn't process magic.
4722 void sv_setsv_nomg(SV* dsv, SV* ssv)
4730 =head1 SV-Body Allocation
4734 =item looks_like_number
4735 X<looks_like_number>
4737 Test if the content of an SV looks like a number (or is a number).
4738 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
4739 non-numeric warning), even if your atof() doesn't grok them.
4741 I32 looks_like_number(SV* sv)
4749 Creates an RV wrapper for an SV. The reference count for the original
4750 SV is B<not> incremented.
4752 SV* newRV_noinc(SV* sv)
4760 Creates a new SV. A non-zero C<len> parameter indicates the number of
4761 bytes of preallocated string space the SV should have. An extra byte for a
4762 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4763 space is allocated.) The reference count for the new SV is set to 1.
4765 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4766 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4767 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4768 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4769 modules supporting older perls.
4771 SV* newSV(STRLEN len)
4779 Creates a new SV from the hash key structure. It will generate scalars that
4780 point to the shared string table where possible. Returns a new (undefined)
4781 SV if the hek is NULL.
4783 SV* newSVhek(const HEK *hek)
4791 Creates a new SV and copies an integer into it. The reference count for the
4802 Creates a new SV and copies a floating point value into it.
4803 The reference count for the SV is set to 1.
4813 Creates a new SV and copies a string into it. The reference count for the
4814 SV is set to 1. If C<len> is zero, Perl will compute the length using
4815 strlen(). For efficiency, consider using C<newSVpvn> instead.
4817 SV* newSVpv(const char* s, STRLEN len)
4825 Creates a new SV and initializes it with the string formatted like
4828 SV* newSVpvf(const char* pat, ...)
4836 Creates a new SV and copies a string into it. The reference count for the
4837 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
4838 string. You are responsible for ensuring that the source string is at least
4839 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
4841 SV* newSVpvn(const char* s, STRLEN len)
4846 =item newSVpvn_share
4849 Creates a new SV with its SvPVX_const pointing to a shared string in the string
4850 table. If the string does not already exist in the table, it is created
4851 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
4852 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
4853 otherwise the hash is computed. The idea here is that as the string table
4854 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
4855 hash lookup will avoid string compare.
4857 SV* newSVpvn_share(const char* s, I32 len, U32 hash)
4865 Like C<newSVpvn>, but takes a literal string instead of a string/length pair.
4867 SV* newSVpvs(const char* s)
4870 Found in file handy.h
4872 =item newSVpvs_share
4875 Like C<newSVpvn_share>, but takes a literal string instead of a string/length
4876 pair and omits the hash parameter.
4878 SV* newSVpvs_share(const char* s)
4881 Found in file handy.h
4886 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
4887 it will be upgraded to one. If C<classname> is non-null then the new SV will
4888 be blessed in the specified package. The new SV is returned and its
4889 reference count is 1.
4891 SV* newSVrv(SV* rv, const char* classname)
4899 Creates a new SV which is an exact duplicate of the original SV.
4902 SV* newSVsv(SV* old)
4910 Creates a new SV and copies an unsigned integer into it.
4911 The reference count for the SV is set to 1.
4921 This function is only called on magical items, and is only used by
4922 sv_true() or its macro equivalent.
4924 bool sv_2bool(SV* sv)
4932 Using various gambits, try to get a CV from an SV; in addition, try if
4933 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
4934 The flags in C<lref> are passed to sv_fetchsv.
4936 CV* sv_2cv(SV* sv, HV** st, GV** gvp, I32 lref)
4944 Using various gambits, try to get an IO from an SV: the IO slot if its a
4945 GV; or the recursive result if we're an RV; or the IO slot of the symbol
4946 named after the PV if we're a string.
4956 Return the integer value of an SV, doing any necessary string
4957 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
4958 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
4960 IV sv_2iv_flags(SV* sv, I32 flags)
4968 Marks an existing SV as mortal. The SV will be destroyed "soon", either
4969 by an explicit call to FREETMPS, or by an implicit call at places such as
4970 statement boundaries. SvTEMP() is turned on which means that the SV's
4971 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
4972 and C<sv_mortalcopy>.
4974 SV* sv_2mortal(SV* sv)
4982 Return the num value of an SV, doing any necessary string or integer
4983 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
4994 Return a pointer to the byte-encoded representation of the SV, and set *lp
4995 to its length. May cause the SV to be downgraded from UTF-8 as a
4998 Usually accessed via the C<SvPVbyte> macro.
5000 char* sv_2pvbyte(SV* sv, STRLEN* lp)
5008 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
5009 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
5011 Usually accessed via the C<SvPVutf8> macro.
5013 char* sv_2pvutf8(SV* sv, STRLEN* lp)
5021 Returns a pointer to the string value of an SV, and sets *lp to its length.
5022 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
5024 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
5025 usually end up here too.
5027 char* sv_2pv_flags(SV* sv, STRLEN* lp, I32 flags)
5035 Return the unsigned integer value of an SV, doing any necessary string
5036 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
5037 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
5039 UV sv_2uv_flags(SV* sv, I32 flags)
5047 Remove any string offset. You should normally use the C<SvOOK_off> macro
5050 int sv_backoff(SV* sv)
5058 Blesses an SV into a specified package. The SV must be an RV. The package
5059 must be designated by its stash (see C<gv_stashpv()>). The reference count
5060 of the SV is unaffected.
5062 SV* sv_bless(SV* sv, HV* stash)
5070 Concatenates the string onto the end of the string which is in the SV.
5071 If the SV has the UTF-8 status set, then the bytes appended should be
5072 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
5074 void sv_catpv(SV* sv, const char* ptr)
5082 Processes its arguments like C<sprintf> and appends the formatted
5083 output to an SV. If the appended data contains "wide" characters
5084 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
5085 and characters >255 formatted with %c), the original SV might get
5086 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
5087 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
5088 valid UTF-8; if the original SV was bytes, the pattern should be too.
5090 void sv_catpvf(SV* sv, const char* pat, ...)
5098 Like C<sv_catpvf>, but also handles 'set' magic.
5100 void sv_catpvf_mg(SV *sv, const char* pat, ...)
5108 Concatenates the string onto the end of the string which is in the SV. The
5109 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5110 status set, then the bytes appended should be valid UTF-8.
5111 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
5113 void sv_catpvn(SV* sv, const char* ptr, STRLEN len)
5118 =item sv_catpvn_flags
5121 Concatenates the string onto the end of the string which is in the SV. The
5122 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5123 status set, then the bytes appended should be valid UTF-8.
5124 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
5125 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
5126 in terms of this function.
5128 void sv_catpvn_flags(SV* sv, const char* ptr, STRLEN len, I32 flags)
5136 Like C<sv_catpvn>, but takes a literal string instead of a string/length pair.
5138 void sv_catpvs(SV* sv, const char* s)
5141 Found in file handy.h
5146 Like C<sv_catpv>, but also handles 'set' magic.
5148 void sv_catpv_mg(SV *sv, const char *ptr)
5156 Concatenates the string from SV C<ssv> onto the end of the string in
5157 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
5158 not 'set' magic. See C<sv_catsv_mg>.
5160 void sv_catsv(SV* dsv, SV* ssv)
5165 =item sv_catsv_flags
5168 Concatenates the string from SV C<ssv> onto the end of the string in
5169 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
5170 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
5171 and C<sv_catsv_nomg> are implemented in terms of this function.
5173 void sv_catsv_flags(SV* dsv, SV* ssv, I32 flags)
5181 Efficient removal of characters from the beginning of the string buffer.
5182 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
5183 the string buffer. The C<ptr> becomes the first character of the adjusted
5184 string. Uses the "OOK hack".
5185 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
5186 refer to the same chunk of data.
5188 void sv_chop(SV* sv, const char* ptr)
5196 Clear an SV: call any destructors, free up any memory used by the body,
5197 and free the body itself. The SV's head is I<not> freed, although
5198 its type is set to all 1's so that it won't inadvertently be assumed
5199 to be live during global destruction etc.
5200 This function should only be called when REFCNT is zero. Most of the time
5201 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5204 void sv_clear(SV* sv)
5212 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5213 string in C<sv1> is less than, equal to, or greater than the string in
5214 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5215 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
5217 I32 sv_cmp(SV* sv1, SV* sv2)
5225 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
5226 'use bytes' aware, handles get magic, and will coerce its args to strings
5227 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
5229 I32 sv_cmp_locale(SV* sv1, SV* sv2)
5237 Add Collate Transform magic to an SV if it doesn't already have it.
5239 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
5240 scalar data of the variable, but transformed to such a format that a normal
5241 memory comparison can be used to compare the data according to the locale
5244 char* sv_collxfrm(SV* sv, STRLEN* nxp)
5252 Copies a stringified representation of the source SV into the
5253 destination SV. Automatically performs any necessary mg_get and
5254 coercion of numeric values into strings. Guaranteed to preserve
5255 UTF-8 flag even from overloaded objects. Similar in nature to
5256 sv_2pv[_flags] but operates directly on an SV instead of just the
5257 string. Mostly uses sv_2pv_flags to do its work, except when that
5258 would lose the UTF-8'ness of the PV.
5260 void sv_copypv(SV* dsv, SV* ssv)
5268 Auto-decrement of the value in the SV, doing string to numeric conversion
5269 if necessary. Handles 'get' magic.
5279 Returns a boolean indicating whether the strings in the two SVs are
5280 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5281 coerce its args to strings if necessary.
5283 I32 sv_eq(SV* sv1, SV* sv2)
5288 =item sv_force_normal_flags
5289 X<sv_force_normal_flags>
5291 Undo various types of fakery on an SV: if the PV is a shared string, make
5292 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
5293 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
5294 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
5295 then a copy-on-write scalar drops its PV buffer (if any) and becomes
5296 SvPOK_off rather than making a copy. (Used where this scalar is about to be
5297 set to some other value.) In addition, the C<flags> parameter gets passed to
5298 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
5299 with flags set to 0.
5301 void sv_force_normal_flags(SV *sv, U32 flags)
5309 Decrement an SV's reference count, and if it drops to zero, call
5310 C<sv_clear> to invoke destructors and free up any memory used by
5311 the body; finally, deallocate the SV's head itself.
5312 Normally called via a wrapper macro C<SvREFCNT_dec>.
5314 void sv_free(SV* sv)
5322 Get a line from the filehandle and store it into the SV, optionally
5323 appending to the currently-stored string.
5325 char* sv_gets(SV* sv, PerlIO* fp, I32 append)
5333 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
5334 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
5335 Use the C<SvGROW> wrapper instead.
5337 char* sv_grow(SV* sv, STRLEN newlen)
5345 Auto-increment of the value in the SV, doing string to numeric conversion
5346 if necessary. Handles 'get' magic.
5356 Inserts a string at the specified offset/length within the SV. Similar to
5357 the Perl substr() function.
5359 void sv_insert(SV* bigsv, STRLEN offset, STRLEN len, const char* little, STRLEN littlelen)
5367 Returns a boolean indicating whether the SV is blessed into the specified
5368 class. This does not check for subtypes; use C<sv_derived_from> to verify
5369 an inheritance relationship.
5371 int sv_isa(SV* sv, const char* name)
5379 Returns a boolean indicating whether the SV is an RV pointing to a blessed
5380 object. If the SV is not an RV, or if the object is not blessed, then this
5383 int sv_isobject(SV* sv)
5391 Returns the length of the string in the SV. Handles magic and type
5392 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5394 STRLEN sv_len(SV* sv)
5402 Returns the number of characters in the string in an SV, counting wide
5403 UTF-8 bytes as a single character. Handles magic and type coercion.
5405 STRLEN sv_len_utf8(SV* sv)
5413 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
5414 then adds a new magic item of type C<how> to the head of the magic list.
5416 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
5417 handling of the C<name> and C<namlen> arguments.
5419 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
5420 to add more than one instance of the same 'how'.
5422 void sv_magic(SV* sv, SV* obj, int how, const char* name, I32 namlen)
5430 Adds magic to an SV, upgrading it if necessary. Applies the
5431 supplied vtable and returns a pointer to the magic added.
5433 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
5434 In particular, you can add magic to SvREADONLY SVs, and add more than
5435 one instance of the same 'how'.
5437 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
5438 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
5439 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
5440 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
5442 (This is now used as a subroutine by C<sv_magic>.)
5444 MAGIC * sv_magicext(SV* sv, SV* obj, int how, MGVTBL *vtbl, const char* name, I32 namlen)
5452 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
5453 The new SV is marked as mortal. It will be destroyed "soon", either by an
5454 explicit call to FREETMPS, or by an implicit call at places such as
5455 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
5457 SV* sv_mortalcopy(SV* oldsv)
5465 Creates a new null SV which is mortal. The reference count of the SV is
5466 set to 1. It will be destroyed "soon", either by an explicit call to
5467 FREETMPS, or by an implicit call at places such as statement boundaries.
5468 See also C<sv_mortalcopy> and C<sv_2mortal>.
5478 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5481 SV* sv_newref(SV* sv)
5489 Converts the value pointed to by offsetp from a count of bytes from the
5490 start of the string, to a count of the equivalent number of UTF-8 chars.
5491 Handles magic and type coercion.
5493 void sv_pos_b2u(SV* sv, I32* offsetp)
5501 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5502 the start of the string, to a count of the equivalent number of bytes; if
5503 lenp is non-zero, it does the same to lenp, but this time starting from
5504 the offset, rather than from the start of the string. Handles magic and
5507 void sv_pos_u2b(SV* sv, I32* offsetp, I32* lenp)
5512 =item sv_pvbyten_force
5515 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
5517 char* sv_pvbyten_force(SV* sv, STRLEN* lp)
5525 Get a sensible string out of the SV somehow.
5526 A private implementation of the C<SvPV_force> macro for compilers which
5527 can't cope with complex macro expressions. Always use the macro instead.
5529 char* sv_pvn_force(SV* sv, STRLEN* lp)
5534 =item sv_pvn_force_flags
5535 X<sv_pvn_force_flags>
5537 Get a sensible string out of the SV somehow.
5538 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
5539 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
5540 implemented in terms of this function.
5541 You normally want to use the various wrapper macros instead: see
5542 C<SvPV_force> and C<SvPV_force_nomg>
5544 char* sv_pvn_force_flags(SV* sv, STRLEN* lp, I32 flags)
5549 =item sv_pvutf8n_force
5552 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
5554 char* sv_pvutf8n_force(SV* sv, STRLEN* lp)
5562 Returns a string describing what the SV is a reference to.
5564 char* sv_reftype(const SV* sv, int ob)
5572 Make the first argument a copy of the second, then delete the original.
5573 The target SV physically takes over ownership of the body of the source SV
5574 and inherits its flags; however, the target keeps any magic it owns,
5575 and any magic in the source is discarded.
5576 Note that this is a rather specialist SV copying operation; most of the
5577 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5579 void sv_replace(SV* sv, SV* nsv)
5587 Underlying implementation for the C<reset> Perl function.
5588 Note that the perl-level function is vaguely deprecated.
5590 void sv_reset(const char* s, HV* stash)
5598 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
5599 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
5600 push a back-reference to this RV onto the array of backreferences
5601 associated with that magic. If the RV is magical, set magic will be
5602 called after the RV is cleared.
5604 SV* sv_rvweaken(SV *sv)
5612 Copies an integer into the given SV, upgrading first if necessary.
5613 Does not handle 'set' magic. See also C<sv_setiv_mg>.
5615 void sv_setiv(SV* sv, IV num)
5623 Like C<sv_setiv>, but also handles 'set' magic.
5625 void sv_setiv_mg(SV *sv, IV i)
5633 Copies a double into the given SV, upgrading first if necessary.
5634 Does not handle 'set' magic. See also C<sv_setnv_mg>.
5636 void sv_setnv(SV* sv, NV num)
5644 Like C<sv_setnv>, but also handles 'set' magic.
5646 void sv_setnv_mg(SV *sv, NV num)
5654 Copies a string into an SV. The string must be null-terminated. Does not
5655 handle 'set' magic. See C<sv_setpv_mg>.
5657 void sv_setpv(SV* sv, const char* ptr)
5665 Works like C<sv_catpvf> but copies the text into the SV instead of
5666 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
5668 void sv_setpvf(SV* sv, const char* pat, ...)
5676 Like C<sv_setpvf>, but also handles 'set' magic.
5678 void sv_setpvf_mg(SV *sv, const char* pat, ...)
5686 Copies an integer into the given SV, also updating its string value.
5687 Does not handle 'set' magic. See C<sv_setpviv_mg>.
5689 void sv_setpviv(SV* sv, IV num)
5697 Like C<sv_setpviv>, but also handles 'set' magic.
5699 void sv_setpviv_mg(SV *sv, IV iv)
5707 Copies a string into an SV. The C<len> parameter indicates the number of
5708 bytes to be copied. If the C<ptr> argument is NULL the SV will become
5709 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
5711 void sv_setpvn(SV* sv, const char* ptr, STRLEN len)
5719 Like C<sv_setpvn>, but also handles 'set' magic.
5721 void sv_setpvn_mg(SV *sv, const char *ptr, STRLEN len)
5729 Like C<sv_setpvn>, but takes a literal string instead of a string/length pair.
5731 void sv_setpvs(SV* sv, const char* s)
5734 Found in file handy.h
5739 Like C<sv_setpv>, but also handles 'set' magic.
5741 void sv_setpv_mg(SV *sv, const char *ptr)
5749 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
5750 argument will be upgraded to an RV. That RV will be modified to point to
5751 the new SV. The C<classname> argument indicates the package for the
5752 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
5753 will have a reference count of 1, and the RV will be returned.
5755 SV* sv_setref_iv(SV* rv, const char* classname, IV iv)
5763 Copies a double into a new SV, optionally blessing the SV. The C<rv>
5764 argument will be upgraded to an RV. That RV will be modified to point to
5765 the new SV. The C<classname> argument indicates the package for the
5766 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
5767 will have a reference count of 1, and the RV will be returned.
5769 SV* sv_setref_nv(SV* rv, const char* classname, NV nv)
5777 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
5778 argument will be upgraded to an RV. That RV will be modified to point to
5779 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
5780 into the SV. The C<classname> argument indicates the package for the
5781 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
5782 will have a reference count of 1, and the RV will be returned.
5784 Do not use with other Perl types such as HV, AV, SV, CV, because those
5785 objects will become corrupted by the pointer copy process.
5787 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
5789 SV* sv_setref_pv(SV* rv, const char* classname, void* pv)
5797 Copies a string into a new SV, optionally blessing the SV. The length of the
5798 string must be specified with C<n>. The C<rv> argument will be upgraded to
5799 an RV. That RV will be modified to point to the new SV. The C<classname>
5800 argument indicates the package for the blessing. Set C<classname> to
5801 C<NULL> to avoid the blessing. The new SV will have a reference count
5802 of 1, and the RV will be returned.
5804 Note that C<sv_setref_pv> copies the pointer while this copies the string.
5806 SV* sv_setref_pvn(SV* rv, const char* classname, const char* pv, STRLEN n)
5814 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
5815 argument will be upgraded to an RV. That RV will be modified to point to
5816 the new SV. The C<classname> argument indicates the package for the
5817 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
5818 will have a reference count of 1, and the RV will be returned.
5820 SV* sv_setref_uv(SV* rv, const char* classname, UV uv)
5828 Copies the contents of the source SV C<ssv> into the destination SV
5829 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
5830 function if the source SV needs to be reused. Does not handle 'set' magic.
5831 Loosely speaking, it performs a copy-by-value, obliterating any previous
5832 content of the destination.
5834 You probably want to use one of the assortment of wrappers, such as
5835 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
5836 C<SvSetMagicSV_nosteal>.
5838 void sv_setsv(SV* dsv, SV* ssv)
5843 =item sv_setsv_flags
5846 Copies the contents of the source SV C<ssv> into the destination SV
5847 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
5848 function if the source SV needs to be reused. Does not handle 'set' magic.
5849 Loosely speaking, it performs a copy-by-value, obliterating any previous
5850 content of the destination.
5851 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
5852 C<ssv> if appropriate, else not. If the C<flags> parameter has the
5853 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
5854 and C<sv_setsv_nomg> are implemented in terms of this function.
5856 You probably want to use one of the assortment of wrappers, such as
5857 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
5858 C<SvSetMagicSV_nosteal>.
5860 This is the primary function for copying scalars, and most other
5861 copy-ish functions and macros use this underneath.
5863 void sv_setsv_flags(SV* dsv, SV* ssv, I32 flags)
5871 Like C<sv_setsv>, but also handles 'set' magic.
5873 void sv_setsv_mg(SV *dstr, SV *sstr)
5881 Copies an unsigned integer into the given SV, upgrading first if necessary.
5882 Does not handle 'set' magic. See also C<sv_setuv_mg>.
5884 void sv_setuv(SV* sv, UV num)
5892 Like C<sv_setuv>, but also handles 'set' magic.
5894 void sv_setuv_mg(SV *sv, UV u)
5902 Test an SV for taintedness. Use C<SvTAINTED> instead.
5903 bool sv_tainted(SV* sv)
5911 Returns true if the SV has a true value by Perl's rules.
5912 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
5913 instead use an in-line version.
5923 Removes all magic of type C<type> from an SV.
5925 int sv_unmagic(SV* sv, int type)
5930 =item sv_unref_flags
5933 Unsets the RV status of the SV, and decrements the reference count of
5934 whatever was being referenced by the RV. This can almost be thought of
5935 as a reversal of C<newSVrv>. The C<cflags> argument can contain
5936 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
5937 (otherwise the decrementing is conditional on the reference count being
5938 different from one or the reference being a readonly SV).
5941 void sv_unref_flags(SV* sv, U32 flags)
5949 Untaint an SV. Use C<SvTAINTED_off> instead.
5950 void sv_untaint(SV* sv)
5958 Upgrade an SV to a more complex form. Generally adds a new body type to the
5959 SV, then copies across as much information as possible from the old body.
5960 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
5962 void sv_upgrade(SV* sv, svtype new_type)
5967 =item sv_usepvn_flags
5970 Tells an SV to use C<ptr> to find its string value. Normally the
5971 string is stored inside the SV but sv_usepvn allows the SV to use an
5972 outside string. The C<ptr> should point to memory that was allocated
5973 by C<malloc>. The string length, C<len>, must be supplied. By default
5974 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
5975 so that pointer should not be freed or used by the programmer after
5976 giving it to sv_usepvn, and neither should any pointers from "behind"
5977 that pointer (e.g. ptr + 1) be used.
5979 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
5980 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
5981 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
5982 C<len>, and already meets the requirements for storing in C<SvPVX>)
5984 void sv_usepvn_flags(SV* sv, char* ptr, STRLEN len, U32 flags)
5989 =item sv_utf8_decode
5992 If the PV of the SV is an octet sequence in UTF-8
5993 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
5994 so that it looks like a character. If the PV contains only single-byte
5995 characters, the C<SvUTF8> flag stays being off.
5996 Scans PV for validity and returns false if the PV is invalid UTF-8.
5998 NOTE: this function is experimental and may change or be
5999 removed without notice.
6001 bool sv_utf8_decode(SV *sv)
6006 =item sv_utf8_downgrade
6007 X<sv_utf8_downgrade>
6009 Attempts to convert the PV of an SV from characters to bytes.
6010 If the PV contains a character beyond byte, this conversion will fail;
6011 in this case, either returns false or, if C<fail_ok> is not
6014 This is not as a general purpose Unicode to byte encoding interface:
6015 use the Encode extension for that.
6017 NOTE: this function is experimental and may change or be
6018 removed without notice.
6020 bool sv_utf8_downgrade(SV *sv, bool fail_ok)
6025 =item sv_utf8_encode
6028 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
6029 flag off so that it looks like octets again.
6031 void sv_utf8_encode(SV *sv)
6036 =item sv_utf8_upgrade
6039 Converts the PV of an SV to its UTF-8-encoded form.
6040 Forces the SV to string form if it is not already.
6041 Always sets the SvUTF8 flag to avoid future validity checks even
6042 if all the bytes have hibit clear.
6044 This is not as a general purpose byte encoding to Unicode interface:
6045 use the Encode extension for that.
6047 STRLEN sv_utf8_upgrade(SV *sv)
6052 =item sv_utf8_upgrade_flags
6053 X<sv_utf8_upgrade_flags>
6055 Converts the PV of an SV to its UTF-8-encoded form.
6056 Forces the SV to string form if it is not already.
6057 Always sets the SvUTF8 flag to avoid future validity checks even
6058 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
6059 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
6060 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
6062 This is not as a general purpose byte encoding to Unicode interface:
6063 use the Encode extension for that.
6065 STRLEN sv_utf8_upgrade_flags(SV *sv, I32 flags)
6073 Processes its arguments like C<vsprintf> and appends the formatted output
6074 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
6076 Usually used via its frontend C<sv_catpvf>.
6078 void sv_vcatpvf(SV* sv, const char* pat, va_list* args)
6086 Processes its arguments like C<vsprintf> and appends the formatted output
6087 to an SV. Uses an array of SVs if the C style variable argument list is
6088 missing (NULL). When running with taint checks enabled, indicates via
6089 C<maybe_tainted> if results are untrustworthy (often due to the use of
6092 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
6094 void sv_vcatpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
6102 Like C<sv_vcatpvf>, but also handles 'set' magic.
6104 Usually used via its frontend C<sv_catpvf_mg>.
6106 void sv_vcatpvf_mg(SV* sv, const char* pat, va_list* args)
6114 Works like C<sv_vcatpvf> but copies the text into the SV instead of
6115 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
6117 Usually used via its frontend C<sv_setpvf>.
6119 void sv_vsetpvf(SV* sv, const char* pat, va_list* args)
6127 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
6130 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
6132 void sv_vsetpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
6140 Like C<sv_vsetpvf>, but also handles 'set' magic.
6142 Usually used via its frontend C<sv_setpvf_mg>.
6144 void sv_vsetpvf_mg(SV* sv, const char* pat, va_list* args)
6152 =head1 Unicode Support
6156 =item bytes_from_utf8
6159 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
6160 Unlike C<utf8_to_bytes> but like C<bytes_to_utf8>, returns a pointer to
6161 the newly-created string, and updates C<len> to contain the new
6162 length. Returns the original string if no conversion occurs, C<len>
6163 is unchanged. Do nothing if C<is_utf8> points to 0. Sets C<is_utf8> to
6164 0 if C<s> is converted or contains all 7bit characters.
6166 NOTE: this function is experimental and may change or be
6167 removed without notice.
6169 U8* bytes_from_utf8(const U8 *s, STRLEN *len, bool *is_utf8)
6172 Found in file utf8.c
6177 Converts a string C<s> of length C<len> from ASCII into UTF-8 encoding.
6178 Returns a pointer to the newly-created string, and sets C<len> to
6179 reflect the new length.
6181 If you want to convert to UTF-8 from other encodings than ASCII,
6182 see sv_recode_to_utf8().
6184 NOTE: this function is experimental and may change or be
6185 removed without notice.
6187 U8* bytes_to_utf8(const U8 *s, STRLEN *len)
6190 Found in file utf8.c
6195 Return true if the strings s1 and s2 differ case-insensitively, false
6196 if not (if they are equal case-insensitively). If u1 is true, the
6197 string s1 is assumed to be in UTF-8-encoded Unicode. If u2 is true,
6198 the string s2 is assumed to be in UTF-8-encoded Unicode. If u1 or u2
6199 are false, the respective string is assumed to be in native 8-bit
6202 If the pe1 and pe2 are non-NULL, the scanning pointers will be copied
6203 in there (they will point at the beginning of the I<next> character).
6204 If the pointers behind pe1 or pe2 are non-NULL, they are the end
6205 pointers beyond which scanning will not continue under any
6206 circumstances. If the byte lengths l1 and l2 are non-zero, s1+l1 and
6207 s2+l2 will be used as goal end pointers that will also stop the scan,
6208 and which qualify towards defining a successful match: all the scans
6209 that define an explicit length must reach their goal pointers for
6210 a match to succeed).
6212 For case-insensitiveness, the "casefolding" of Unicode is used
6213 instead of upper/lowercasing both the characters, see
6214 http://www.unicode.org/unicode/reports/tr21/ (Case Mappings).
6216 I32 ibcmp_utf8(const char* a, char **pe1, UV l1, bool u1, const char* b, char **pe2, UV l2, bool u2)
6219 Found in file utf8.c
6224 Tests if some arbitrary number of bytes begins in a valid UTF-8
6225 character. Note that an INVARIANT (i.e. ASCII) character is a valid
6226 UTF-8 character. The actual number of bytes in the UTF-8 character
6227 will be returned if it is valid, otherwise 0.
6229 STRLEN is_utf8_char(const U8 *p)
6232 Found in file utf8.c
6234 =item is_utf8_string
6237 Returns true if first C<len> bytes of the given string form a valid
6238 UTF-8 string, false otherwise. Note that 'a valid UTF-8 string' does
6239 not mean 'a string that contains code points above 0x7F encoded in UTF-8'
6240 because a valid ASCII string is a valid UTF-8 string.
6242 See also is_utf8_string_loclen() and is_utf8_string_loc().
6244 bool is_utf8_string(const U8 *s, STRLEN len)
6247 Found in file utf8.c
6249 =item is_utf8_string_loc
6250 X<is_utf8_string_loc>
6252 Like is_utf8_string() but stores the location of the failure (in the
6253 case of "utf8ness failure") or the location s+len (in the case of
6254 "utf8ness success") in the C<ep>.
6256 See also is_utf8_string_loclen() and is_utf8_string().
6258 bool is_utf8_string_loc(const U8 *s, STRLEN len, const U8 **p)
6261 Found in file utf8.c
6263 =item is_utf8_string_loclen
6264 X<is_utf8_string_loclen>
6266 Like is_utf8_string() but stores the location of the failure (in the
6267 case of "utf8ness failure") or the location s+len (in the case of
6268 "utf8ness success") in the C<ep>, and the number of UTF-8
6269 encoded characters in the C<el>.
6271 See also is_utf8_string_loc() and is_utf8_string().
6273 bool is_utf8_string_loclen(const U8 *s, STRLEN len, const U8 **ep, STRLEN *el)
6276 Found in file utf8.c
6278 =item pv_uni_display
6281 Build to the scalar dsv a displayable version of the string spv,
6282 length len, the displayable version being at most pvlim bytes long
6283 (if longer, the rest is truncated and "..." will be appended).
6285 The flags argument can have UNI_DISPLAY_ISPRINT set to display
6286 isPRINT()able characters as themselves, UNI_DISPLAY_BACKSLASH
6287 to display the \\[nrfta\\] as the backslashed versions (like '\n')
6288 (UNI_DISPLAY_BACKSLASH is preferred over UNI_DISPLAY_ISPRINT for \\).
6289 UNI_DISPLAY_QQ (and its alias UNI_DISPLAY_REGEX) have both
6290 UNI_DISPLAY_BACKSLASH and UNI_DISPLAY_ISPRINT turned on.
6292 The pointer to the PV of the dsv is returned.
6294 char* pv_uni_display(SV *dsv, const U8 *spv, STRLEN len, STRLEN pvlim, UV flags)
6297 Found in file utf8.c
6302 The encoding is assumed to be an Encode object, the PV of the ssv is
6303 assumed to be octets in that encoding and decoding the input starts
6304 from the position which (PV + *offset) pointed to. The dsv will be
6305 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
6306 when the string tstr appears in decoding output or the input ends on
6307 the PV of the ssv. The value which the offset points will be modified
6308 to the last input position on the ssv.
6310 Returns TRUE if the terminator was found, else returns FALSE.
6312 bool sv_cat_decode(SV* dsv, SV *encoding, SV *ssv, int *offset, char* tstr, int tlen)
6317 =item sv_recode_to_utf8
6318 X<sv_recode_to_utf8>
6320 The encoding is assumed to be an Encode object, on entry the PV
6321 of the sv is assumed to be octets in that encoding, and the sv
6322 will be converted into Unicode (and UTF-8).
6324 If the sv already is UTF-8 (or if it is not POK), or if the encoding
6325 is not a reference, nothing is done to the sv. If the encoding is not
6326 an C<Encode::XS> Encoding object, bad things will happen.
6327 (See F<lib/encoding.pm> and L<Encode>).
6329 The PV of the sv is returned.
6331 char* sv_recode_to_utf8(SV* sv, SV *encoding)
6336 =item sv_uni_display
6339 Build to the scalar dsv a displayable version of the scalar sv,
6340 the displayable version being at most pvlim bytes long
6341 (if longer, the rest is truncated and "..." will be appended).
6343 The flags argument is as in pv_uni_display().
6345 The pointer to the PV of the dsv is returned.
6347 char* sv_uni_display(SV *dsv, SV *ssv, STRLEN pvlim, UV flags)
6350 Found in file utf8.c
6355 The "p" contains the pointer to the UTF-8 string encoding
6356 the character that is being converted.
6358 The "ustrp" is a pointer to the character buffer to put the
6359 conversion result to. The "lenp" is a pointer to the length
6362 The "swashp" is a pointer to the swash to use.
6364 Both the special and normal mappings are stored lib/unicore/To/Foo.pl,
6365 and loaded by SWASHNEW, using lib/utf8_heavy.pl. The special (usually,
6366 but not always, a multicharacter mapping), is tried first.
6368 The "special" is a string like "utf8::ToSpecLower", which means the
6369 hash %utf8::ToSpecLower. The access to the hash is through
6370 Perl_to_utf8_case().
6372 The "normal" is a string like "ToLower" which means the swash
6375 UV to_utf8_case(const U8 *p, U8* ustrp, STRLEN *lenp, SV **swashp, const char *normal, const char *special)
6378 Found in file utf8.c
6383 Convert the UTF-8 encoded character at p to its foldcase version and
6384 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6385 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6386 foldcase version may be longer than the original character (up to
6389 The first character of the foldcased version is returned
6390 (but note, as explained above, that there may be more.)
6392 UV to_utf8_fold(const U8 *p, U8* ustrp, STRLEN *lenp)
6395 Found in file utf8.c
6400 Convert the UTF-8 encoded character at p to its lowercase version and
6401 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6402 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6403 lowercase version may be longer than the original character.
6405 The first character of the lowercased version is returned
6406 (but note, as explained above, that there may be more.)
6408 UV to_utf8_lower(const U8 *p, U8* ustrp, STRLEN *lenp)
6411 Found in file utf8.c
6416 Convert the UTF-8 encoded character at p to its titlecase version and
6417 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6418 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6419 titlecase version may be longer than the original character.
6421 The first character of the titlecased version is returned
6422 (but note, as explained above, that there may be more.)
6424 UV to_utf8_title(const U8 *p, U8* ustrp, STRLEN *lenp)
6427 Found in file utf8.c
6432 Convert the UTF-8 encoded character at p to its uppercase version and
6433 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6434 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since
6435 the uppercase version may be longer than the original character.
6437 The first character of the uppercased version is returned
6438 (but note, as explained above, that there may be more.)
6440 UV to_utf8_upper(const U8 *p, U8* ustrp, STRLEN *lenp)
6443 Found in file utf8.c
6445 =item utf8n_to_uvchr
6450 Returns the native character value of the first character in the string
6452 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6453 length, in bytes, of that character.
6455 Allows length and flags to be passed to low level routine.
6457 UV utf8n_to_uvchr(const U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags)
6460 Found in file utf8.c
6462 =item utf8n_to_uvuni
6465 Bottom level UTF-8 decode routine.
6466 Returns the unicode code point value of the first character in the string C<s>
6467 which is assumed to be in UTF-8 encoding and no longer than C<curlen>;
6468 C<retlen> will be set to the length, in bytes, of that character.
6470 If C<s> does not point to a well-formed UTF-8 character, the behaviour
6471 is dependent on the value of C<flags>: if it contains UTF8_CHECK_ONLY,
6472 it is assumed that the caller will raise a warning, and this function
6473 will silently just set C<retlen> to C<-1> and return zero. If the
6474 C<flags> does not contain UTF8_CHECK_ONLY, warnings about
6475 malformations will be given, C<retlen> will be set to the expected
6476 length of the UTF-8 character in bytes, and zero will be returned.
6478 The C<flags> can also contain various flags to allow deviations from
6479 the strict UTF-8 encoding (see F<utf8.h>).
6481 Most code should use utf8_to_uvchr() rather than call this directly.
6483 UV utf8n_to_uvuni(const U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags)
6486 Found in file utf8.c
6491 Returns the number of UTF-8 characters between the UTF-8 pointers C<a>
6494 WARNING: use only if you *know* that the pointers point inside the
6497 IV utf8_distance(const U8 *a, const U8 *b)
6500 Found in file utf8.c
6505 Return the UTF-8 pointer C<s> displaced by C<off> characters, either
6506 forward or backward.
6508 WARNING: do not use the following unless you *know* C<off> is within
6509 the UTF-8 data pointed to by C<s> *and* that on entry C<s> is aligned
6510 on the first byte of character or just after the last byte of a character.
6512 U8* utf8_hop(const U8 *s, I32 off)
6515 Found in file utf8.c
6520 Return the length of the UTF-8 char encoded string C<s> in characters.
6521 Stops at C<e> (inclusive). If C<e E<lt> s> or if the scan would end
6522 up past C<e>, croaks.
6524 STRLEN utf8_length(const U8* s, const U8 *e)
6527 Found in file utf8.c
6532 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
6533 Unlike C<bytes_to_utf8>, this over-writes the original string, and
6534 updates len to contain the new length.
6535 Returns zero on failure, setting C<len> to -1.
6537 If you need a copy of the string, see C<bytes_from_utf8>.
6539 NOTE: this function is experimental and may change or be
6540 removed without notice.
6542 U8* utf8_to_bytes(U8 *s, STRLEN *len)
6545 Found in file utf8.c
6550 Returns the native character value of the first character in the string C<s>
6551 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6552 length, in bytes, of that character.
6554 If C<s> does not point to a well-formed UTF-8 character, zero is
6555 returned and retlen is set, if possible, to -1.
6557 UV utf8_to_uvchr(const U8 *s, STRLEN *retlen)
6560 Found in file utf8.c
6565 Returns the Unicode code point of the first character in the string C<s>
6566 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6567 length, in bytes, of that character.
6569 This function should only be used when returned UV is considered
6570 an index into the Unicode semantic tables (e.g. swashes).
6572 If C<s> does not point to a well-formed UTF-8 character, zero is
6573 returned and retlen is set, if possible, to -1.
6575 UV utf8_to_uvuni(const U8 *s, STRLEN *retlen)
6578 Found in file utf8.c
6583 Adds the UTF-8 representation of the Native codepoint C<uv> to the end
6584 of the string C<d>; C<d> should be have at least C<UTF8_MAXBYTES+1> free
6585 bytes available. The return value is the pointer to the byte after the
6586 end of the new character. In other words,
6588 d = uvchr_to_utf8(d, uv);
6590 is the recommended wide native character-aware way of saying
6594 U8* uvchr_to_utf8(U8 *d, UV uv)
6597 Found in file utf8.c
6599 =item uvuni_to_utf8_flags
6600 X<uvuni_to_utf8_flags>
6602 Adds the UTF-8 representation of the Unicode codepoint C<uv> to the end
6603 of the string C<d>; C<d> should be have at least C<UTF8_MAXBYTES+1> free
6604 bytes available. The return value is the pointer to the byte after the
6605 end of the new character. In other words,
6607 d = uvuni_to_utf8_flags(d, uv, flags);
6611 d = uvuni_to_utf8(d, uv);
6613 (which is equivalent to)
6615 d = uvuni_to_utf8_flags(d, uv, 0);
6617 is the recommended Unicode-aware way of saying
6621 U8* uvuni_to_utf8_flags(U8 *d, UV uv, UV flags)
6624 Found in file utf8.c
6629 =head1 Variables created by C<xsubpp> and C<xsubpp> internal functions
6636 Variable which is setup by C<xsubpp> to indicate the stack base offset,
6637 used by the C<ST>, C<XSprePUSH> and C<XSRETURN> macros. The C<dMARK> macro
6638 must be called prior to setup the C<MARK> variable.
6643 Found in file XSUB.h
6648 Variable which is setup by C<xsubpp> to indicate the
6649 class name for a C++ XS constructor. This is always a C<char*>. See C<THIS>.
6654 Found in file XSUB.h
6659 Sets up the C<ax> variable.
6660 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
6665 Found in file XSUB.h
6670 Sets up the C<ax> variable and stack marker variable C<mark>.
6671 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
6676 Found in file XSUB.h
6681 Sets up the C<items> variable.
6682 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
6687 Found in file XSUB.h
6692 Sets up the C<padoff_du> variable for an XSUB that wishes to use
6698 Found in file XSUB.h
6703 Sets up stack and mark pointers for an XSUB, calling dSP and dMARK.
6704 Sets up the C<ax> and C<items> variables by calling C<dAX> and C<dITEMS>.
6705 This is usually handled automatically by C<xsubpp>.
6710 Found in file XSUB.h
6715 Sets up the C<ix> variable for an XSUB which has aliases. This is usually
6716 handled automatically by C<xsubpp>.
6721 Found in file XSUB.h
6726 Variable which is setup by C<xsubpp> to indicate the number of
6727 items on the stack. See L<perlxs/"Variable-length Parameter Lists">.
6732 Found in file XSUB.h
6737 Variable which is setup by C<xsubpp> to indicate which of an
6738 XSUB's aliases was used to invoke it. See L<perlxs/"The ALIAS: Keyword">.
6743 Found in file XSUB.h
6748 Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
6752 Found in file XSUB.h
6757 Variable which is setup by C<xsubpp> to hold the return value for an
6758 XSUB. This is always the proper type for the XSUB. See
6759 L<perlxs/"The RETVAL Variable">.
6764 Found in file XSUB.h
6769 Used to access elements on the XSUB's stack.
6774 Found in file XSUB.h
6779 Variable which is setup by C<xsubpp> to designate the object in a C++
6780 XSUB. This is always the proper type for the C++ object. See C<CLASS> and
6781 L<perlxs/"Using XS With C++">.
6786 Found in file XSUB.h
6791 The SV* corresponding to the $_ variable. Works even if there
6792 is a lexical $_ in scope.
6795 Found in file XSUB.h
6800 Macro to declare an XSUB and its C parameter list. This is handled by
6804 Found in file XSUB.h
6809 The version identifier for an XS module. This is usually
6810 handled automatically by C<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>.
6813 Found in file XSUB.h
6815 =item XS_VERSION_BOOTCHECK
6816 X<XS_VERSION_BOOTCHECK>
6818 Macro to verify that a PM module's $VERSION variable matches the XS
6819 module's C<XS_VERSION> variable. This is usually handled automatically by
6820 C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">.
6822 XS_VERSION_BOOTCHECK;
6825 Found in file XSUB.h
6830 =head1 Warning and Dieing
6837 This is the XSUB-writer's interface to Perl's C<die> function.
6838 Normally call this function the same way you call the C C<printf>
6839 function. Calling C<croak> returns control directly to Perl,
6840 sidestepping the normal C order of execution. See C<warn>.
6842 If you want to throw an exception object, assign the object to
6843 C<$@> and then pass C<NULL> to croak():
6845 errsv = get_sv("@", TRUE);
6846 sv_setsv(errsv, exception_object);
6849 void croak(const char* pat, ...)
6852 Found in file util.c
6857 This is the XSUB-writer's interface to Perl's C<warn> function. Call this
6858 function the same way you call the C C<printf> function. See C<croak>.
6860 void warn(const char* pat, ...)
6863 Found in file util.c
6870 Until May 1997, this document was maintained by Jeff Okamoto
6871 <okamoto@corp.hp.com>. It is now maintained as part of Perl itself.
6873 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
6874 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
6875 Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
6876 Stephen McCamant, and Gurusamy Sarathy.
6878 API Listing originally by Dean Roehrich <roehrich@cray.com>.
6880 Updated to be autogenerated from comments in the source by Benjamin Stuhl.
6884 perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
projects / p5sagit/p5-mst-13.2.git / blob