1 -*- buffer-read-only: t -*-
3 !!!!!!! DO NOT EDIT THIS FILE !!!!!!!
4 This file is built by autodoc.pl extracting documentation from the C source
9 perlapi - autogenerated documentation for the perl public API
12 X<Perl API> X<API> X<api>
14 This file contains the documentation of the perl public API generated by
15 embed.pl, specifically a listing of functions, macros, flags, and variables
16 that may be used by extension writers. The interfaces of any functions that
17 are not listed here are subject to change without notice. For this reason,
18 blindly using functions listed in proto.h is to be avoided when writing
21 Note that all Perl API global variables must be referenced with the C<PL_>
22 prefix. Some macros are provided for compatibility with the older,
23 unadorned names, but this support may be disabled in a future release.
25 The listing is alphabetical, case insensitive.
35 A backward-compatible version of C<GIMME_V> which can only return
36 C<G_SCALAR> or C<G_ARRAY>; in a void context, it returns C<G_SCALAR>.
37 Deprecated. Use C<GIMME_V> instead.
47 The XSUB-writer's equivalent to Perl's C<wantarray>. Returns C<G_VOID>,
48 C<G_SCALAR> or C<G_ARRAY> for void, scalar or list context,
59 Used to indicate list context. See C<GIMME_V>, C<GIMME> and
68 Indicates that arguments returned from a callback should be discarded. See
77 Used to force a Perl C<eval> wrapper around a callback. See
86 Indicates that no arguments are being sent to a callback. See
95 Used to indicate scalar context. See C<GIMME_V>, C<GIMME>, and
104 Used to indicate void context. See C<GIMME_V> and L<perlcall>.
112 =head1 Array Manipulation Functions
119 Same as C<av_len()>. Deprecated, use C<av_len()> instead.
129 Clears an array, making it empty. Does not free the memory used by the
132 void av_clear(AV* ar)
140 Deletes the element indexed by C<key> from the array. Returns the
141 deleted element. If C<flags> equals C<G_DISCARD>, the element is freed
142 and null is returned.
144 SV* av_delete(AV* ar, I32 key, I32 flags)
152 Returns true if the element indexed by C<key> has been initialized.
154 This relies on the fact that uninitialized array elements are set to
157 bool av_exists(AV* ar, I32 key)
165 Pre-extend an array. The C<key> is the index to which the array should be
168 void av_extend(AV* ar, I32 key)
176 Returns the SV at the specified index in the array. The C<key> is the
177 index. If C<lval> is set then the fetch will be part of a store. Check
178 that the return value is non-null before dereferencing it to a C<SV*>.
180 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for
181 more information on how to use this function on tied arrays.
183 SV** av_fetch(AV* ar, I32 key, I32 lval)
191 Set the highest index in the array to the given number, equivalent to
192 Perl's C<$#array = $fill;>.
194 The number of elements in the an array will be C<fill + 1> after
195 av_fill() returns. If the array was previously shorter then the
196 additional elements appended are set to C<PL_sv_undef>. If the array
197 was longer, then the excess elements are freed. C<av_fill(av, -1)> is
198 the same as C<av_clear(av)>.
200 void av_fill(AV* ar, I32 fill)
208 Returns the highest index in the array. The number of elements in the
209 array is C<av_len(av) + 1>. Returns -1 if the array is empty.
211 I32 av_len(const AV* ar)
219 Creates a new AV and populates it with a list of SVs. The SVs are copied
220 into the array, so they may be freed after the call to av_make. The new AV
221 will have a reference count of 1.
223 AV* av_make(I32 size, SV** svp)
231 Pops an SV off the end of the array. Returns C<&PL_sv_undef> if the array
242 Pushes an SV onto the end of the array. The array will grow automatically
243 to accommodate the addition.
245 void av_push(AV* ar, SV* val)
253 Shifts an SV off the beginning of the array.
263 Stores an SV in an array. The array index is specified as C<key>. The
264 return value will be NULL if the operation failed or if the value did not
265 need to be actually stored within the array (as in the case of tied
266 arrays). Otherwise it can be dereferenced to get the original C<SV*>. Note
267 that the caller is responsible for suitably incrementing the reference
268 count of C<val> before the call, and decrementing it if the function
271 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for
272 more information on how to use this function on tied arrays.
274 SV** av_store(AV* ar, I32 key, SV* val)
282 Undefines the array. Frees the memory used by the array itself.
284 void av_undef(AV* ar)
292 Unshift the given number of C<undef> values onto the beginning of the
293 array. The array will grow automatically to accommodate the addition. You
294 must then use C<av_store> to assign values to these new elements.
296 void av_unshift(AV* ar, I32 num)
304 Returns the AV of the specified Perl array. If C<create> is set and the
305 Perl variable does not exist then it will be created. If C<create> is not
306 set and the variable does not exist then NULL is returned.
308 NOTE: the perl_ form of this function is deprecated.
310 AV* get_av(const char* name, I32 create)
318 Creates a new AV. The reference count is set to 1.
328 Sort an array. Here is an example:
330 sortsv(AvARRAY(av), av_len(av)+1, Perl_sv_cmp_locale);
332 Currently this always uses mergesort. See sortsv_flags for a more
335 void sortsv(SV** array, size_t num_elts, SVCOMPARE_t cmp)
338 Found in file pp_sort.c
343 Sort an array, with various options.
345 void sortsv_flags(SV** array, size_t num_elts, SVCOMPARE_t cmp, U32 flags)
348 Found in file pp_sort.c
353 =head1 Callback Functions
360 Performs a callback to the specified Perl sub. See L<perlcall>.
362 NOTE: the perl_ form of this function is deprecated.
364 I32 call_argv(const char* sub_name, I32 flags, char** argv)
372 Performs a callback to the specified Perl method. The blessed object must
373 be on the stack. See L<perlcall>.
375 NOTE: the perl_ form of this function is deprecated.
377 I32 call_method(const char* methname, I32 flags)
385 Performs a callback to the specified Perl sub. See L<perlcall>.
387 NOTE: the perl_ form of this function is deprecated.
389 I32 call_pv(const char* sub_name, I32 flags)
397 Performs a callback to the Perl sub whose name is in the SV. See
400 NOTE: the perl_ form of this function is deprecated.
402 I32 call_sv(SV* sv, I32 flags)
410 Opening bracket on a callback. See C<LEAVE> and L<perlcall>.
415 Found in file scope.h
420 Tells Perl to C<eval> the given string and return an SV* result.
422 NOTE: the perl_ form of this function is deprecated.
424 SV* eval_pv(const char* p, I32 croak_on_error)
432 Tells Perl to C<eval> the string in the SV.
434 NOTE: the perl_ form of this function is deprecated.
436 I32 eval_sv(SV* sv, I32 flags)
444 Closing bracket for temporaries on a callback. See C<SAVETMPS> and
450 Found in file scope.h
455 Closing bracket on a callback. See C<ENTER> and L<perlcall>.
460 Found in file scope.h
465 Opening bracket for temporaries on a callback. See C<FREETMPS> and
471 Found in file scope.h
476 =head1 Character classes
483 Returns a boolean indicating whether the C C<char> is an ASCII alphanumeric
484 character (including underscore) or digit.
486 bool isALNUM(char ch)
489 Found in file handy.h
494 Returns a boolean indicating whether the C C<char> is an ASCII alphabetic
497 bool isALPHA(char ch)
500 Found in file handy.h
505 Returns a boolean indicating whether the C C<char> is an ASCII
508 bool isDIGIT(char ch)
511 Found in file handy.h
516 Returns a boolean indicating whether the C C<char> is a lowercase
519 bool isLOWER(char ch)
522 Found in file handy.h
527 Returns a boolean indicating whether the C C<char> is whitespace.
529 bool isSPACE(char ch)
532 Found in file handy.h
537 Returns a boolean indicating whether the C C<char> is an uppercase
540 bool isUPPER(char ch)
543 Found in file handy.h
548 Converts the specified character to lowercase.
550 char toLOWER(char ch)
553 Found in file handy.h
558 Converts the specified character to uppercase.
560 char toUPPER(char ch)
563 Found in file handy.h
568 =head1 Cloning an interpreter
575 Create and return a new interpreter by cloning the current one.
577 perl_clone takes these flags as parameters:
579 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
580 without it we only clone the data and zero the stacks,
581 with it we copy the stacks and the new perl interpreter is
582 ready to run at the exact same point as the previous one.
583 The pseudo-fork code uses COPY_STACKS while the
584 threads->new doesn't.
586 CLONEf_KEEP_PTR_TABLE
587 perl_clone keeps a ptr_table with the pointer of the old
588 variable as a key and the new variable as a value,
589 this allows it to check if something has been cloned and not
590 clone it again but rather just use the value and increase the
591 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
592 the ptr_table using the function
593 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
594 reason to keep it around is if you want to dup some of your own
595 variable who are outside the graph perl scans, example of this
596 code is in threads.xs create
599 This is a win32 thing, it is ignored on unix, it tells perls
600 win32host code (which is c++) to clone itself, this is needed on
601 win32 if you want to run two threads at the same time,
602 if you just want to do some stuff in a separate perl interpreter
603 and then throw it away and return to the original one,
604 you don't need to do anything.
606 PerlInterpreter* perl_clone(PerlInterpreter* interp, UV flags)
614 =head1 CV Manipulation Functions
621 Returns the stash of the CV.
631 Returns the CV of the specified Perl subroutine. If C<create> is set and
632 the Perl subroutine does not exist then it will be declared (which has the
633 same effect as saying C<sub name;>). If C<create> is not set and the
634 subroutine does not exist then NULL is returned.
636 NOTE: the perl_ form of this function is deprecated.
638 CV* get_cv(const char* name, I32 create)
646 =head1 Embedding Functions
653 Clear out all the active components of a CV. This can happen either
654 by an explicit C<undef &foo>, or by the reference count going to zero.
655 In the former case, we keep the CvOUTSIDE pointer, so that any anonymous
656 children can still follow the full lexical scope chain.
658 void cv_undef(CV* cv)
666 Loads the module whose name is pointed to by the string part of name.
667 Note that the actual module name, not its filename, should be given.
668 Eg, "Foo::Bar" instead of "Foo/Bar.pm". flags can be any of
669 PERL_LOADMOD_DENY, PERL_LOADMOD_NOIMPORT, or PERL_LOADMOD_IMPORT_OPS
670 (or 0 for no flags). ver, if specified, provides version semantics
671 similar to C<use Foo::Bar VERSION>. The optional trailing SV*
672 arguments can be used to specify arguments to the module's import()
673 method, similar to C<use Foo::Bar VERSION LIST>.
675 void load_module(U32 flags, SV* name, SV* ver, ...)
683 Stub that provides thread hook for perl_destruct when there are
694 Allocates a new Perl interpreter. See L<perlembed>.
696 PerlInterpreter* perl_alloc()
704 Initializes a new Perl interpreter. See L<perlembed>.
706 void perl_construct(PerlInterpreter* interp)
714 Shuts down a Perl interpreter. See L<perlembed>.
716 int perl_destruct(PerlInterpreter* interp)
724 Releases a Perl interpreter. See L<perlembed>.
726 void perl_free(PerlInterpreter* interp)
734 Tells a Perl interpreter to parse a Perl script. See L<perlembed>.
736 int perl_parse(PerlInterpreter* interp, XSINIT_t xsinit, int argc, char** argv, char** env)
744 Tells a Perl interpreter to run. See L<perlembed>.
746 int perl_run(PerlInterpreter* interp)
754 Tells Perl to C<require> the file named by the string argument. It is
755 analogous to the Perl code C<eval "require '$file'">. It's even
756 implemented that way; consider using load_module instead.
758 NOTE: the perl_ form of this function is deprecated.
760 void require_pv(const char* pv)
768 =head1 Functions in file dump.c
776 char *pv_display(SV *dsv, const char *pv, STRLEN cur, STRLEN len,
777 STRLEN pvlim, U32 flags)
781 pv_escape(dsv,pv,cur,pvlim,PERL_PV_ESCAPE_QUOTE);
783 except that an additional "\0" will be appended to the string when
784 len > cur and pv[cur] is "\0".
786 Note that the final string may be up to 7 chars longer than pvlim.
788 char* pv_display(SV *dsv, const char *pv, STRLEN cur, STRLEN len, STRLEN pvlim)
796 |const STRLEN count|const STRLEN max
797 |STRLEN const *escaped, const U32 flags
799 Escapes at most the first "count" chars of pv and puts the results into
800 dsv such that the size of the escaped string will not exceed "max" chars
801 and will not contain any incomplete escape sequences.
803 If flags contains PERL_PV_ESCAPE_QUOTE then any double quotes in the string
804 will also be escaped.
806 Normally the SV will be cleared before the escaped string is prepared,
807 but when PERL_PV_ESCAPE_NOCLEAR is set this will not occur.
809 If PERL_PV_ESCAPE_UNI is set then the input string is treated as unicode,
810 if PERL_PV_ESCAPE_UNI_DETECT is set then the input string is scanned
811 using C<is_utf8_string()> to determine if it is unicode.
813 If PERL_PV_ESCAPE_ALL is set then all input chars will be output
814 using C<\x01F1> style escapes, otherwise only chars above 255 will be
815 escaped using this style, other non printable chars will use octal or
816 common escaped patterns like C<\n>. If PERL_PV_ESCAPE_NOBACKSLASH
817 then all chars below 255 will be treated as printable and
818 will be output as literals.
820 If PERL_PV_ESCAPE_FIRSTCHAR is set then only the first char of the
821 string will be escaped, regardles of max. If the string is utf8 and
822 the chars value is >255 then it will be returned as a plain hex
823 sequence. Thus the output will either be a single char,
824 an octal escape sequence, a special escape like C<\n> or a 3 or
825 more digit hex value.
827 Returns a pointer to the escaped text as held by dsv.
829 NOTE: the perl_ form of this function is deprecated.
831 char* pv_escape(SV *dsv, char const * const str, const STRLEN count, const STRLEN max, STRLEN * const escaped, const U32 flags)
839 |const STRLEN count|const STRLEN max\
840 |const char const *start_color| const char const *end_color\
843 Converts a string into something presentable, handling escaping via
844 pv_escape() and supporting quoting and elipses.
846 If the PERL_PV_PRETTY_QUOTE flag is set then the result will be
847 double quoted with any double quotes in the string escaped. Otherwise
848 if the PERL_PV_PRETTY_LTGT flag is set then the result be wrapped in
851 If the PERL_PV_PRETTY_ELIPSES flag is set and not all characters in
852 string were output then an elipses C<...> will be appended to the
853 string. Note that this happens AFTER it has been quoted.
855 If start_color is non-null then it will be inserted after the opening
856 quote (if there is one) but before the escaped text. If end_color
857 is non-null then it will be inserted after the escaped text but before
858 any quotes or elipses.
860 Returns a pointer to the prettified text as held by dsv.
862 NOTE: the perl_ form of this function is deprecated.
864 char* pv_pretty(SV *dsv, char const * const str, const STRLEN count, const STRLEN max, char const * const start_color, char const * const end_color, const U32 flags)
872 =head1 Functions in file mathoms.c
880 See L<gv_fetchmethod_autoload>.
882 GV* gv_fetchmethod(HV* stash, const char* name)
885 Found in file mathoms.c
890 The engine implementing pack() Perl function. Note: parameters next_in_list and
891 flags are not used. This call should not be used; use packlist instead.
893 void pack_cat(SV *cat, const char *pat, const char *patend, SV **beglist, SV **endlist, SV ***next_in_list, U32 flags)
896 Found in file mathoms.c
898 =item sv_2pvbyte_nolen
901 Return a pointer to the byte-encoded representation of the SV.
902 May cause the SV to be downgraded from UTF-8 as a side-effect.
904 Usually accessed via the C<SvPVbyte_nolen> macro.
906 char* sv_2pvbyte_nolen(SV* sv)
909 Found in file mathoms.c
911 =item sv_2pvutf8_nolen
914 Return a pointer to the UTF-8-encoded representation of the SV.
915 May cause the SV to be upgraded to UTF-8 as a side-effect.
917 Usually accessed via the C<SvPVutf8_nolen> macro.
919 char* sv_2pvutf8_nolen(SV* sv)
922 Found in file mathoms.c
927 Like C<sv_2pv()>, but doesn't return the length too. You should usually
928 use the macro wrapper C<SvPV_nolen(sv)> instead.
929 char* sv_2pv_nolen(SV* sv)
932 Found in file mathoms.c
937 Like C<sv_catpvn>, but also handles 'set' magic.
939 void sv_catpvn_mg(SV *sv, const char *ptr, STRLEN len)
942 Found in file mathoms.c
947 Like C<sv_catsv>, but also handles 'set' magic.
949 void sv_catsv_mg(SV *dstr, SV *sstr)
952 Found in file mathoms.c
954 =item sv_force_normal
957 Undo various types of fakery on an SV: if the PV is a shared string, make
958 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
959 an xpvmg. See also C<sv_force_normal_flags>.
961 void sv_force_normal(SV *sv)
964 Found in file mathoms.c
969 A private implementation of the C<SvIVx> macro for compilers which can't
970 cope with complex macro expressions. Always use the macro instead.
975 Found in file mathoms.c
980 Dummy routine which "locks" an SV when there is no locking module present.
981 Exists to avoid test for a NULL function pointer and because it could
982 potentially warn under some level of strict-ness.
984 "Superseded" by sv_nosharing().
986 void sv_nolocking(SV *sv)
989 Found in file mathoms.c
994 Dummy routine which "unlocks" an SV when there is no locking module present.
995 Exists to avoid test for a NULL function pointer and because it could
996 potentially warn under some level of strict-ness.
998 "Superseded" by sv_nosharing().
1000 void sv_nounlocking(SV *sv)
1003 Found in file mathoms.c
1008 A private implementation of the C<SvNVx> macro for compilers which can't
1009 cope with complex macro expressions. Always use the macro instead.
1014 Found in file mathoms.c
1019 Use the C<SvPV_nolen> macro instead
1024 Found in file mathoms.c
1029 Use C<SvPVbyte_nolen> instead.
1031 char* sv_pvbyte(SV *sv)
1034 Found in file mathoms.c
1039 A private implementation of the C<SvPVbyte> macro for compilers
1040 which can't cope with complex macro expressions. Always use the macro
1043 char* sv_pvbyten(SV *sv, STRLEN *len)
1046 Found in file mathoms.c
1051 A private implementation of the C<SvPV> macro for compilers which can't
1052 cope with complex macro expressions. Always use the macro instead.
1054 char* sv_pvn(SV *sv, STRLEN *len)
1057 Found in file mathoms.c
1062 Use the C<SvPVutf8_nolen> macro instead
1064 char* sv_pvutf8(SV *sv)
1067 Found in file mathoms.c
1072 A private implementation of the C<SvPVutf8> macro for compilers
1073 which can't cope with complex macro expressions. Always use the macro
1076 char* sv_pvutf8n(SV *sv, STRLEN *len)
1079 Found in file mathoms.c
1084 Taint an SV. Use C<SvTAINTED_on> instead.
1085 void sv_taint(SV* sv)
1088 Found in file mathoms.c
1093 Unsets the RV status of the SV, and decrements the reference count of
1094 whatever was being referenced by the RV. This can almost be thought of
1095 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
1096 being zero. See C<SvROK_off>.
1098 void sv_unref(SV* sv)
1101 Found in file mathoms.c
1106 Tells an SV to use C<ptr> to find its string value. Implemented by
1107 calling C<sv_usepvn_flags> with C<flags> of 0, hence does not handle 'set'
1108 magic. See C<sv_usepvn_flags>.
1110 void sv_usepvn(SV* sv, char* ptr, STRLEN len)
1113 Found in file mathoms.c
1118 Like C<sv_usepvn>, but also handles 'set' magic.
1120 void sv_usepvn_mg(SV *sv, char *ptr, STRLEN len)
1123 Found in file mathoms.c
1128 A private implementation of the C<SvUVx> macro for compilers which can't
1129 cope with complex macro expressions. Always use the macro instead.
1134 Found in file mathoms.c
1139 The engine implementing unpack() Perl function. Note: parameters strbeg, new_s
1140 and ocnt are not used. This call should not be used, use unpackstring instead.
1142 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)
1145 Found in file mathoms.c
1150 =head1 Functions in file pp_pack.c
1158 The engine implementing pack() Perl function.
1160 void packlist(SV *cat, const char *pat, const char *patend, SV **beglist, SV **endlist)
1163 Found in file pp_pack.c
1168 The engine implementing unpack() Perl function. C<unpackstring> puts the
1169 extracted list items on the stack and returns the number of elements.
1170 Issue C<PUTBACK> before and C<SPAGAIN> after the call to this function.
1172 I32 unpackstring(const char *pat, const char *patend, const char *s, const char *strend, U32 flags)
1175 Found in file pp_pack.c
1180 =head1 Global Variables
1187 C<PL_modglobal> is a general purpose, interpreter global HV for use by
1188 extensions that need to keep information on a per-interpreter basis.
1189 In a pinch, it can also be used as a symbol table for extensions
1190 to share data among each other. It is a good idea to use keys
1191 prefixed by the package name of the extension that owns the data.
1196 Found in file intrpvar.h
1201 A convenience variable which is typically used with C<SvPV> when one
1202 doesn't care about the length of the string. It is usually more efficient
1203 to either declare a local variable and use that instead or to use the
1204 C<SvPV_nolen> macro.
1209 Found in file thrdvar.h
1214 This is the C<false> SV. See C<PL_sv_yes>. Always refer to this as
1220 Found in file intrpvar.h
1225 This is the C<undef> SV. Always refer to this as C<&PL_sv_undef>.
1230 Found in file intrpvar.h
1235 This is the C<true> SV. See C<PL_sv_no>. Always refer to this as
1241 Found in file intrpvar.h
1253 Return the SV from the GV.
1263 If C<gv> is a typeglob whose subroutine entry is a constant sub eligible for
1264 inlining, or C<gv> is a placeholder reference that would be promoted to such
1265 a typeglob, then returns the value returned by the sub. Otherwise, returns
1268 SV* gv_const_sv(GV* gv)
1276 Returns the glob with the given C<name> and a defined subroutine or
1277 C<NULL>. The glob lives in the given C<stash>, or in the stashes
1278 accessible via @ISA and UNIVERSAL::.
1280 The argument C<level> should be either 0 or -1. If C<level==0>, as a
1281 side-effect creates a glob with the given C<name> in the given C<stash>
1282 which in the case of success contains an alias for the subroutine, and sets
1283 up caching info for this glob. Similarly for all the searched stashes.
1285 This function grants C<"SUPER"> token as a postfix of the stash name. The
1286 GV returned from C<gv_fetchmeth> may be a method cache entry, which is not
1287 visible to Perl code. So when calling C<call_sv>, you should not use
1288 the GV directly; instead, you should use the method's CV, which can be
1289 obtained from the GV with the C<GvCV> macro.
1291 GV* gv_fetchmeth(HV* stash, const char* name, STRLEN len, I32 level)
1296 =item gv_fetchmethod_autoload
1297 X<gv_fetchmethod_autoload>
1299 Returns the glob which contains the subroutine to call to invoke the method
1300 on the C<stash>. In fact in the presence of autoloading this may be the
1301 glob for "AUTOLOAD". In this case the corresponding variable $AUTOLOAD is
1304 The third parameter of C<gv_fetchmethod_autoload> determines whether
1305 AUTOLOAD lookup is performed if the given method is not present: non-zero
1306 means yes, look for AUTOLOAD; zero means no, don't look for AUTOLOAD.
1307 Calling C<gv_fetchmethod> is equivalent to calling C<gv_fetchmethod_autoload>
1308 with a non-zero C<autoload> parameter.
1310 These functions grant C<"SUPER"> token as a prefix of the method name. Note
1311 that if you want to keep the returned glob for a long time, you need to
1312 check for it being "AUTOLOAD", since at the later time the call may load a
1313 different subroutine due to $AUTOLOAD changing its value. Use the glob
1314 created via a side effect to do this.
1316 These functions have the same side-effects and as C<gv_fetchmeth> with
1317 C<level==0>. C<name> should be writable if contains C<':'> or C<'
1318 ''>. The warning against passing the GV returned by C<gv_fetchmeth> to
1319 C<call_sv> apply equally to these functions.
1321 GV* gv_fetchmethod_autoload(HV* stash, const char* name, I32 autoload)
1326 =item gv_fetchmeth_autoload
1327 X<gv_fetchmeth_autoload>
1329 Same as gv_fetchmeth(), but looks for autoloaded subroutines too.
1330 Returns a glob for the subroutine.
1332 For an autoloaded subroutine without a GV, will create a GV even
1333 if C<level < 0>. For an autoloaded subroutine without a stub, GvCV()
1334 of the result may be zero.
1336 GV* gv_fetchmeth_autoload(HV* stash, const char* name, STRLEN len, I32 level)
1344 Returns a pointer to the stash for a specified package. C<name> should
1345 be a valid UTF-8 string and must be null-terminated. If C<create> is set
1346 then the package will be created if it does not already exist. If C<create>
1347 is not set and the package does not exist then NULL is returned.
1349 HV* gv_stashpv(const char* name, I32 create)
1357 Returns a pointer to the stash for a specified package. C<name> should
1358 be a valid UTF-8 string. The C<namelen> parameter indicates the length of
1359 the C<name>, in bytes. If C<create> is set then the package will be
1360 created if it does not already exist. If C<create> is not set and the
1361 package does not exist then NULL is returned.
1363 HV* gv_stashpvn(const char* name, U32 namelen, I32 create)
1371 Like C<gv_stashpvn>, but takes a literal string instead of a string/length pair.
1373 HV* gv_stashpvs(const char* name, I32 create)
1376 Found in file handy.h
1381 Returns a pointer to the stash for a specified package, which must be a
1382 valid UTF-8 string. See C<gv_stashpv>.
1384 HV* gv_stashsv(SV* sv, I32 create)
1407 Null character pointer.
1410 Found in file handy.h
1434 Found in file handy.h
1439 =head1 Hash Manipulation Functions
1446 Returns the HV of the specified Perl hash. If C<create> is set and the
1447 Perl variable does not exist then it will be created. If C<create> is not
1448 set and the variable does not exist then NULL is returned.
1450 NOTE: the perl_ form of this function is deprecated.
1452 HV* get_hv(const char* name, I32 create)
1455 Found in file perl.c
1460 This flag, used in the length slot of hash entries and magic structures,
1461 specifies the structure contains an C<SV*> pointer where a C<char*> pointer
1462 is to be expected. (For information only--not to be used).
1470 Returns the computed hash stored in the hash entry.
1480 Returns the actual pointer stored in the key slot of the hash entry. The
1481 pointer may be either C<char*> or C<SV*>, depending on the value of
1482 C<HeKLEN()>. Can be assigned to. The C<HePV()> or C<HeSVKEY()> macros are
1483 usually preferable for finding the value of a key.
1493 If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry
1494 holds an C<SV*> key. Otherwise, holds the actual length of the key. Can
1495 be assigned to. The C<HePV()> macro is usually preferable for finding key
1498 STRLEN HeKLEN(HE* he)
1506 Returns the key slot of the hash entry as a C<char*> value, doing any
1507 necessary dereferencing of possibly C<SV*> keys. The length of the string
1508 is placed in C<len> (this is a macro, so do I<not> use C<&len>). If you do
1509 not care about what the length of the key is, you may use the global
1510 variable C<PL_na>, though this is rather less efficient than using a local
1511 variable. Remember though, that hash keys in perl are free to contain
1512 embedded nulls, so using C<strlen()> or similar is not a good way to find
1513 the length of hash keys. This is very similar to the C<SvPV()> macro
1514 described elsewhere in this document.
1516 char* HePV(HE* he, STRLEN len)
1524 Returns the key as an C<SV*>, or C<NULL> if the hash entry does not
1525 contain an C<SV*> key.
1535 Returns the key as an C<SV*>. Will create and return a temporary mortal
1536 C<SV*> if the hash entry contains only a C<char*> key.
1538 SV* HeSVKEY_force(HE* he)
1546 Sets the key to a given C<SV*>, taking care to set the appropriate flags to
1547 indicate the presence of an C<SV*> key, and returns the same
1550 SV* HeSVKEY_set(HE* he, SV* sv)
1558 Returns the value slot (type C<SV*>) stored in the hash entry.
1568 Returns the package name of a stash, or NULL if C<stash> isn't a stash.
1569 See C<SvSTASH>, C<CvSTASH>.
1571 char* HvNAME(HV* stash)
1579 Check that a hash is in an internally consistent state.
1581 void hv_assert(HV* tb)
1589 Clears a hash, making it empty.
1591 void hv_clear(HV* tb)
1596 =item hv_clear_placeholders
1597 X<hv_clear_placeholders>
1599 Clears any placeholders from a hash. If a restricted hash has any of its keys
1600 marked as readonly and the key is subsequently deleted, the key is not actually
1601 deleted but is marked by assigning it a value of &PL_sv_placeholder. This tags
1602 it so it will be ignored by future operations such as iterating over the hash,
1603 but will still allow the hash to have a value reassigned to the key at some
1604 future point. This function clears any such placeholder keys from the hash.
1605 See Hash::Util::lock_keys() for an example of its use.
1607 void hv_clear_placeholders(HV* hb)
1615 Deletes a key/value pair in the hash. The value SV is removed from the
1616 hash and returned to the caller. The C<klen> is the length of the key.
1617 The C<flags> value will normally be zero; if set to G_DISCARD then NULL
1620 SV* hv_delete(HV* tb, const char* key, I32 klen, I32 flags)
1628 Deletes a key/value pair in the hash. The value SV is removed from the
1629 hash and returned to the caller. The C<flags> value will normally be zero;
1630 if set to G_DISCARD then NULL will be returned. C<hash> can be a valid
1631 precomputed hash value, or 0 to ask for it to be computed.
1633 SV* hv_delete_ent(HV* tb, SV* key, I32 flags, U32 hash)
1641 Returns a boolean indicating whether the specified hash key exists. The
1642 C<klen> is the length of the key.
1644 bool hv_exists(HV* tb, const char* key, I32 klen)
1652 Returns a boolean indicating whether the specified hash key exists. C<hash>
1653 can be a valid precomputed hash value, or 0 to ask for it to be
1656 bool hv_exists_ent(HV* tb, SV* key, U32 hash)
1664 Returns the SV which corresponds to the specified key in the hash. The
1665 C<klen> is the length of the key. If C<lval> is set then the fetch will be
1666 part of a store. Check that the return value is non-null before
1667 dereferencing it to an C<SV*>.
1669 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1670 information on how to use this function on tied hashes.
1672 SV** hv_fetch(HV* tb, const char* key, I32 klen, I32 lval)
1680 Like C<hv_fetch>, but takes a literal string instead of a string/length pair.
1682 SV** hv_fetchs(HV* tb, const char* key, I32 lval)
1685 Found in file handy.h
1690 Returns the hash entry which corresponds to the specified key in the hash.
1691 C<hash> must be a valid precomputed hash number for the given C<key>, or 0
1692 if you want the function to compute it. IF C<lval> is set then the fetch
1693 will be part of a store. Make sure the return value is non-null before
1694 accessing it. The return value when C<tb> is a tied hash is a pointer to a
1695 static location, so be sure to make a copy of the structure if you need to
1698 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1699 information on how to use this function on tied hashes.
1701 HE* hv_fetch_ent(HV* tb, SV* key, I32 lval, U32 hash)
1709 Prepares a starting point to traverse a hash table. Returns the number of
1710 keys in the hash (i.e. the same as C<HvKEYS(tb)>). The return value is
1711 currently only meaningful for hashes without tie magic.
1713 NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
1714 hash buckets that happen to be in use. If you still need that esoteric
1715 value, you can get it through the macro C<HvFILL(tb)>.
1718 I32 hv_iterinit(HV* tb)
1726 Returns the key from the current position of the hash iterator. See
1729 char* hv_iterkey(HE* entry, I32* retlen)
1737 Returns the key as an C<SV*> from the current position of the hash
1738 iterator. The return value will always be a mortal copy of the key. Also
1741 SV* hv_iterkeysv(HE* entry)
1749 Returns entries from a hash iterator. See C<hv_iterinit>.
1751 You may call C<hv_delete> or C<hv_delete_ent> on the hash entry that the
1752 iterator currently points to, without losing your place or invalidating your
1753 iterator. Note that in this case the current entry is deleted from the hash
1754 with your iterator holding the last reference to it. Your iterator is flagged
1755 to free the entry on the next call to C<hv_iternext>, so you must not discard
1756 your iterator immediately else the entry will leak - call C<hv_iternext> to
1757 trigger the resource deallocation.
1759 HE* hv_iternext(HV* tb)
1767 Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
1770 SV* hv_iternextsv(HV* hv, char** key, I32* retlen)
1775 =item hv_iternext_flags
1776 X<hv_iternext_flags>
1778 Returns entries from a hash iterator. See C<hv_iterinit> and C<hv_iternext>.
1779 The C<flags> value will normally be zero; if HV_ITERNEXT_WANTPLACEHOLDERS is
1780 set the placeholders keys (for restricted hashes) will be returned in addition
1781 to normal keys. By default placeholders are automatically skipped over.
1782 Currently a placeholder is implemented with a value that is
1783 C<&Perl_sv_placeholder>. Note that the implementation of placeholders and
1784 restricted hashes may change, and the implementation currently is
1785 insufficiently abstracted for any change to be tidy.
1787 NOTE: this function is experimental and may change or be
1788 removed without notice.
1790 HE* hv_iternext_flags(HV* tb, I32 flags)
1798 Returns the value from the current position of the hash iterator. See
1801 SV* hv_iterval(HV* tb, HE* entry)
1809 Adds magic to a hash. See C<sv_magic>.
1811 void hv_magic(HV* hv, GV* gv, int how)
1819 Evaluates the hash in scalar context and returns the result. Handles magic when the hash is tied.
1821 SV* hv_scalar(HV* hv)
1829 Stores an SV in a hash. The hash key is specified as C<key> and C<klen> is
1830 the length of the key. The C<hash> parameter is the precomputed hash
1831 value; if it is zero then Perl will compute it. The return value will be
1832 NULL if the operation failed or if the value did not need to be actually
1833 stored within the hash (as in the case of tied hashes). Otherwise it can
1834 be dereferenced to get the original C<SV*>. Note that the caller is
1835 responsible for suitably incrementing the reference count of C<val> before
1836 the call, and decrementing it if the function returned NULL. Effectively
1837 a successful hv_store takes ownership of one reference to C<val>. This is
1838 usually what you want; a newly created SV has a reference count of one, so
1839 if all your code does is create SVs then store them in a hash, hv_store
1840 will own the only reference to the new SV, and your code doesn't need to do
1841 anything further to tidy up. hv_store is not implemented as a call to
1842 hv_store_ent, and does not create a temporary SV for the key, so if your
1843 key data is not already in SV form then use hv_store in preference to
1846 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1847 information on how to use this function on tied hashes.
1849 SV** hv_store(HV* tb, const char* key, I32 klen, SV* val, U32 hash)
1857 Like C<hv_store>, but takes a literal string instead of a string/length pair
1858 and omits the hash parameter.
1860 SV** hv_stores(HV* tb, const char* key, NULLOK SV* val)
1863 Found in file handy.h
1868 Stores C<val> in a hash. The hash key is specified as C<key>. The C<hash>
1869 parameter is the precomputed hash value; if it is zero then Perl will
1870 compute it. The return value is the new hash entry so created. It will be
1871 NULL if the operation failed or if the value did not need to be actually
1872 stored within the hash (as in the case of tied hashes). Otherwise the
1873 contents of the return value can be accessed using the C<He?> macros
1874 described here. Note that the caller is responsible for suitably
1875 incrementing the reference count of C<val> before the call, and
1876 decrementing it if the function returned NULL. Effectively a successful
1877 hv_store_ent takes ownership of one reference to C<val>. This is
1878 usually what you want; a newly created SV has a reference count of one, so
1879 if all your code does is create SVs then store them in a hash, hv_store
1880 will own the only reference to the new SV, and your code doesn't need to do
1881 anything further to tidy up. Note that hv_store_ent only reads the C<key>;
1882 unlike C<val> it does not take ownership of it, so maintaining the correct
1883 reference count on C<key> is entirely the caller's responsibility. hv_store
1884 is not implemented as a call to hv_store_ent, and does not create a temporary
1885 SV for the key, so if your key data is not already in SV form then use
1886 hv_store in preference to hv_store_ent.
1888 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1889 information on how to use this function on tied hashes.
1891 HE* hv_store_ent(HV* tb, SV* key, SV* val, U32 hash)
1901 void hv_undef(HV* tb)
1909 Creates a new HV. The reference count is set to 1.
1916 =item refcounted_he_chain_2hv
1917 X<refcounted_he_chain_2hv>
1919 Generates an returns a C<HV *> by walking up the tree starting at the passed
1920 in C<struct refcounted_he *>.
1922 NOTE: this function is experimental and may change or be
1923 removed without notice.
1925 HV * refcounted_he_chain_2hv(const struct refcounted_he *c)
1933 =head1 Magical Functions
1940 Clear something magical that the SV represents. See C<sv_magic>.
1942 int mg_clear(SV* sv)
1950 Copies the magic from one SV to another. See C<sv_magic>.
1952 int mg_copy(SV* sv, SV* nsv, const char* key, I32 klen)
1960 Finds the magic pointer for type matching the SV. See C<sv_magic>.
1962 MAGIC* mg_find(const SV* sv, int type)
1970 Free any magic storage used by the SV. See C<sv_magic>.
1980 Do magic after a value is retrieved from the SV. See C<sv_magic>.
1990 Report on the SV's length. See C<sv_magic>.
1992 U32 mg_length(SV* sv)
2000 Turns on the magical status of an SV. See C<sv_magic>.
2002 void mg_magical(SV* sv)
2010 Do magic after a value is assigned to the SV. See C<sv_magic>.
2020 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
2021 argument more than once.
2023 void SvGETMAGIC(SV* sv)
2031 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
2042 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
2043 argument more than once.
2045 void SvSETMAGIC(SV* sv)
2053 Like C<SvSetSV>, but does any set magic required afterwards.
2055 void SvSetMagicSV(SV* dsb, SV* ssv)
2060 =item SvSetMagicSV_nosteal
2061 X<SvSetMagicSV_nosteal>
2063 Like C<SvSetSV_nosteal>, but does any set magic required afterwards.
2065 void SvSetMagicSV_nosteal(SV* dsv, SV* ssv)
2073 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
2076 void SvSetSV(SV* dsb, SV* ssv)
2081 =item SvSetSV_nosteal
2084 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
2085 ssv. May evaluate arguments more than once.
2087 void SvSetSV_nosteal(SV* dsv, SV* ssv)
2095 Arranges for sv to be shared between threads if a suitable module
2098 void SvSHARE(SV* sv)
2106 Releases a mutual exclusion lock on sv if a suitable module
2109 void SvUNLOCK(SV* sv)
2117 =head1 Memory Management
2124 The XSUB-writer's interface to the C C<memcpy> function. The C<src> is the
2125 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
2126 the type. May fail on overlapping copies. See also C<Move>.
2128 void Copy(void* src, void* dest, int nitems, type)
2131 Found in file handy.h
2136 Like C<Copy> but returns dest. Useful for encouraging compilers to tail-call
2139 void * CopyD(void* src, void* dest, int nitems, type)
2142 Found in file handy.h
2147 The XSUB-writer's interface to the C C<memmove> function. The C<src> is the
2148 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
2149 the type. Can do overlapping moves. See also C<Copy>.
2151 void Move(void* src, void* dest, int nitems, type)
2154 Found in file handy.h
2159 Like C<Move> but returns dest. Useful for encouraging compilers to tail-call
2162 void * MoveD(void* src, void* dest, int nitems, type)
2165 Found in file handy.h
2170 The XSUB-writer's interface to the C C<malloc> function.
2172 In 5.9.3, Newx() and friends replace the older New() API, and drops
2173 the first parameter, I<x>, a debug aid which allowed callers to identify
2174 themselves. This aid has been superseded by a new build option,
2175 PERL_MEM_LOG (see L<perlhack/PERL_MEM_LOG>). The older API is still
2176 there for use in XS modules supporting older perls.
2178 void Newx(void* ptr, int nitems, type)
2181 Found in file handy.h
2186 The XSUB-writer's interface to the C C<malloc> function, with
2187 cast. See also C<Newx>.
2189 void Newxc(void* ptr, int nitems, type, cast)
2192 Found in file handy.h
2197 The XSUB-writer's interface to the C C<malloc> function. The allocated
2198 memory is zeroed with C<memzero>. See also C<Newx>.
2200 void Newxz(void* ptr, int nitems, type)
2203 Found in file handy.h
2208 PoisonWith(0xEF) for catching access to freed memory.
2210 void Poison(void* dest, int nitems, type)
2213 Found in file handy.h
2218 PoisonWith(0xEF) for catching access to freed memory.
2220 void PoisonFree(void* dest, int nitems, type)
2223 Found in file handy.h
2228 PoisonWith(0xAB) for catching access to allocated but uninitialized memory.
2230 void PoisonNew(void* dest, int nitems, type)
2233 Found in file handy.h
2238 Fill up memory with a byte pattern (a byte repeated over and over
2239 again) that hopefully catches attempts to access uninitialized memory.
2241 void PoisonWith(void* dest, int nitems, type, U8 byte)
2244 Found in file handy.h
2249 The XSUB-writer's interface to the C C<realloc> function.
2251 void Renew(void* ptr, int nitems, type)
2254 Found in file handy.h
2259 The XSUB-writer's interface to the C C<realloc> function, with
2262 void Renewc(void* ptr, int nitems, type, cast)
2265 Found in file handy.h
2270 The XSUB-writer's interface to the C C<free> function.
2272 void Safefree(void* ptr)
2275 Found in file handy.h
2280 Perl's version of C<strdup()>. Returns a pointer to a newly allocated
2281 string which is a duplicate of C<pv>. The size of the string is
2282 determined by C<strlen()>. The memory allocated for the new string can
2283 be freed with the C<Safefree()> function.
2285 char* savepv(const char* pv)
2288 Found in file util.c
2293 Perl's version of what C<strndup()> would be if it existed. Returns a
2294 pointer to a newly allocated string which is a duplicate of the first
2295 C<len> bytes from C<pv>, plus a trailing NUL byte. The memory allocated for
2296 the new string can be freed with the C<Safefree()> function.
2298 char* savepvn(const char* pv, I32 len)
2301 Found in file util.c
2306 Like C<savepvn>, but takes a literal string instead of a string/length pair.
2308 char* savepvs(const char* s)
2311 Found in file handy.h
2316 A version of C<savepv()> which allocates the duplicate string in memory
2317 which is shared between threads.
2319 char* savesharedpv(const char* pv)
2322 Found in file util.c
2327 A version of C<savepv()>/C<savepvn()> which gets the string to duplicate from
2328 the passed in SV using C<SvPV()>
2330 char* savesvpv(SV* sv)
2333 Found in file util.c
2338 This is an architecture-independent macro to copy one structure to another.
2340 void StructCopy(type src, type dest, type)
2343 Found in file handy.h
2348 The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the
2349 destination, C<nitems> is the number of items, and C<type> is the type.
2351 void Zero(void* dest, int nitems, type)
2354 Found in file handy.h
2359 Like C<Zero> but returns dest. Useful for encouraging compilers to tail-call
2362 void * ZeroD(void* dest, int nitems, type)
2365 Found in file handy.h
2370 =head1 Miscellaneous Functions
2377 Analyses the string in order to make fast searches on it using fbm_instr()
2378 -- the Boyer-Moore algorithm.
2380 void fbm_compile(SV* sv, U32 flags)
2383 Found in file util.c
2388 Returns the location of the SV in the string delimited by C<str> and
2389 C<strend>. It returns C<NULL> if the string can't be found. The C<sv>
2390 does not have to be fbm_compiled, but the search will not be as fast
2393 char* fbm_instr(unsigned char* big, unsigned char* bigend, SV* littlesv, U32 flags)
2396 Found in file util.c
2401 Takes a sprintf-style format pattern and conventional
2402 (non-SV) arguments and returns the formatted string.
2404 (char *) Perl_form(pTHX_ const char* pat, ...)
2406 can be used any place a string (char *) is required:
2408 char * s = Perl_form("%d.%d",major,minor);
2410 Uses a single private buffer so if you want to format several strings you
2411 must explicitly copy the earlier strings away (and free the copies when you
2414 char* form(const char* pat, ...)
2417 Found in file util.c
2422 Fill the sv with current working directory
2424 int getcwd_sv(SV* sv)
2427 Found in file util.c
2432 The C library C<snprintf> functionality, if available and
2433 standards-compliant (uses C<vsnprintf>, actually). However, if the
2434 C<vsnprintf> is not available, will unfortunately use the unsafe
2435 C<vsprintf> which can overrun the buffer (there is an overrun check,
2436 but that may be too late). Consider using C<sv_vcatpvf> instead, or
2437 getting C<vsnprintf>.
2439 int my_snprintf(char *buffer, const Size_t len, const char *format, ...)
2442 Found in file util.c
2447 The C library C<sprintf>, wrapped if necessary, to ensure that it will return
2448 the length of the string written to the buffer. Only rare pre-ANSI systems
2449 need the wrapper function - usually this is a direct call to C<sprintf>.
2451 int my_sprintf(char *buffer, const char *pat, ...)
2454 Found in file util.c
2459 The C library C<vsnprintf> if available and standards-compliant.
2460 However, if if the C<vsnprintf> is not available, will unfortunately
2461 use the unsafe C<vsprintf> which can overrun the buffer (there is an
2462 overrun check, but that may be too late). Consider using
2463 C<sv_vcatpvf> instead, or getting C<vsnprintf>.
2465 int my_vsnprintf(char *buffer, const Size_t len, const char *format, va_list ap)
2468 Found in file util.c
2473 Returns a new version object based on the passed in SV:
2475 SV *sv = new_version(SV *ver);
2477 Does not alter the passed in ver SV. See "upg_version" if you
2478 want to upgrade the SV.
2480 SV* new_version(SV *ver)
2483 Found in file util.c
2488 Returns a pointer to the next character after the parsed
2489 version string, as well as upgrading the passed in SV to
2492 Function must be called with an already existing SV like
2495 s = scan_version(s,SV *sv, bool qv);
2497 Performs some preprocessing to the string to ensure that
2498 it has the correct characteristics of a version. Flags the
2499 object if it contains an underscore (which denotes this
2500 is a alpha version). The boolean qv denotes that the version
2501 should be interpreted as if it had multiple decimals, even if
2504 const char* scan_version(const char *vstr, SV *sv, bool qv)
2507 Found in file util.c
2512 Test two strings to see if they are equal. Returns true or false.
2514 bool strEQ(char* s1, char* s2)
2517 Found in file handy.h
2522 Test two strings to see if the first, C<s1>, is greater than or equal to
2523 the second, C<s2>. Returns true or false.
2525 bool strGE(char* s1, char* s2)
2528 Found in file handy.h
2533 Test two strings to see if the first, C<s1>, is greater than the second,
2534 C<s2>. Returns true or false.
2536 bool strGT(char* s1, char* s2)
2539 Found in file handy.h
2544 Test two strings to see if the first, C<s1>, is less than or equal to the
2545 second, C<s2>. Returns true or false.
2547 bool strLE(char* s1, char* s2)
2550 Found in file handy.h
2555 Test two strings to see if the first, C<s1>, is less than the second,
2556 C<s2>. Returns true or false.
2558 bool strLT(char* s1, char* s2)
2561 Found in file handy.h
2566 Test two strings to see if they are different. Returns true or
2569 bool strNE(char* s1, char* s2)
2572 Found in file handy.h
2577 Test two strings to see if they are equal. The C<len> parameter indicates
2578 the number of bytes to compare. Returns true or false. (A wrapper for
2581 bool strnEQ(char* s1, char* s2, STRLEN len)
2584 Found in file handy.h
2589 Test two strings to see if they are different. The C<len> parameter
2590 indicates the number of bytes to compare. Returns true or false. (A
2591 wrapper for C<strncmp>).
2593 bool strnNE(char* s1, char* s2, STRLEN len)
2596 Found in file handy.h
2601 Dummy routine which "shares" an SV when there is no sharing module present.
2602 Or "locks" it. Or "unlocks" it. In other words, ignores its single SV argument.
2603 Exists to avoid test for a NULL function pointer and because it could
2604 potentially warn under some level of strict-ness.
2606 void sv_nosharing(SV *sv)
2609 Found in file util.c
2614 In-place upgrade of the supplied SV to a version object.
2616 SV *sv = upg_version(SV *sv);
2618 Returns a pointer to the upgraded SV.
2620 SV* upg_version(SV *ver)
2623 Found in file util.c
2628 Version object aware cmp. Both operands must already have been
2629 converted into version objects.
2631 int vcmp(SV *lvs, SV *rvs)
2634 Found in file util.c
2639 Accepts a version object and returns the normalized string
2640 representation. Call like:
2644 NOTE: you can pass either the object directly or the SV
2645 contained within the RV.
2650 Found in file util.c
2655 Accepts a version object and returns the normalized floating
2656 point representation. Call like:
2660 NOTE: you can pass either the object directly or the SV
2661 contained within the RV.
2666 Found in file util.c
2671 In order to maintain maximum compatibility with earlier versions
2672 of Perl, this function will return either the floating point
2673 notation or the multiple dotted notation, depending on whether
2674 the original version contained 1 or more dots, respectively
2676 SV* vstringify(SV *vs)
2679 Found in file util.c
2684 Validates that the SV contains a valid version object.
2686 bool vverify(SV *vobj);
2688 Note that it only confirms the bare minimum structure (so as not to get
2689 confused by derived classes which may contain additional hash entries):
2691 bool vverify(SV *vs)
2694 Found in file util.c
2699 =head1 Multicall Functions
2706 Declare local variables for a multicall. See L<perlcall/Lightweight Callbacks>.
2716 Make a lightweight callback. See L<perlcall/Lightweight Callbacks>.
2726 Closing bracket for a lightweight callback.
2727 See L<perlcall/Lightweight Callbacks>.
2734 =item PUSH_MULTICALL
2737 Opening bracket for a lightweight callback.
2738 See L<perlcall/Lightweight Callbacks>.
2748 =head1 Numeric functions
2755 converts a string representing a binary number to numeric form.
2757 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2758 conversion flags, and I<result> should be NULL or a pointer to an NV.
2759 The scan stops at the end of the string, or the first invalid character.
2760 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2761 invalid character will also trigger a warning.
2762 On return I<*len> is set to the length of the scanned string,
2763 and I<*flags> gives output flags.
2765 If the value is <= C<UV_MAX> it is returned as a UV, the output flags are clear,
2766 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_bin>
2767 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2768 and writes the value to I<*result> (or the value is discarded if I<result>
2771 The binary number may optionally be prefixed with "0b" or "b" unless
2772 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
2773 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the binary
2774 number may use '_' characters to separate digits.
2776 UV grok_bin(const char* start, STRLEN* len_p, I32* flags, NV *result)
2779 Found in file numeric.c
2784 converts a string representing a hex number to numeric form.
2786 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2787 conversion flags, and I<result> should be NULL or a pointer to an NV.
2788 The scan stops at the end of the string, or the first invalid character.
2789 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2790 invalid character will also trigger a warning.
2791 On return I<*len> is set to the length of the scanned string,
2792 and I<*flags> gives output flags.
2794 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2795 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_hex>
2796 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2797 and writes the value to I<*result> (or the value is discarded if I<result>
2800 The hex number may optionally be prefixed with "0x" or "x" unless
2801 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
2802 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the hex
2803 number may use '_' characters to separate digits.
2805 UV grok_hex(const char* start, STRLEN* len_p, I32* flags, NV *result)
2808 Found in file numeric.c
2813 Recognise (or not) a number. The type of the number is returned
2814 (0 if unrecognised), otherwise it is a bit-ORed combination of
2815 IS_NUMBER_IN_UV, IS_NUMBER_GREATER_THAN_UV_MAX, IS_NUMBER_NOT_INT,
2816 IS_NUMBER_NEG, IS_NUMBER_INFINITY, IS_NUMBER_NAN (defined in perl.h).
2818 If the value of the number can fit an in UV, it is returned in the *valuep
2819 IS_NUMBER_IN_UV will be set to indicate that *valuep is valid, IS_NUMBER_IN_UV
2820 will never be set unless *valuep is valid, but *valuep may have been assigned
2821 to during processing even though IS_NUMBER_IN_UV is not set on return.
2822 If valuep is NULL, IS_NUMBER_IN_UV will be set for the same cases as when
2823 valuep is non-NULL, but no actual assignment (or SEGV) will occur.
2825 IS_NUMBER_NOT_INT will be set with IS_NUMBER_IN_UV if trailing decimals were
2826 seen (in which case *valuep gives the true value truncated to an integer), and
2827 IS_NUMBER_NEG if the number is negative (in which case *valuep holds the
2828 absolute value). IS_NUMBER_IN_UV is not set if e notation was used or the
2829 number is larger than a UV.
2831 int grok_number(const char *pv, STRLEN len, UV *valuep)
2834 Found in file numeric.c
2836 =item grok_numeric_radix
2837 X<grok_numeric_radix>
2839 Scan and skip for a numeric decimal separator (radix).
2841 bool grok_numeric_radix(const char **sp, const char *send)
2844 Found in file numeric.c
2849 converts a string representing an octal number to numeric form.
2851 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2852 conversion flags, and I<result> should be NULL or a pointer to an NV.
2853 The scan stops at the end of the string, or the first invalid character.
2854 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2855 invalid character will also trigger a warning.
2856 On return I<*len> is set to the length of the scanned string,
2857 and I<*flags> gives output flags.
2859 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2860 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_oct>
2861 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2862 and writes the value to I<*result> (or the value is discarded if I<result>
2865 If C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the octal
2866 number may use '_' characters to separate digits.
2868 UV grok_oct(const char* start, STRLEN* len_p, I32* flags, NV *result)
2871 Found in file numeric.c
2876 For backwards compatibility. Use C<grok_bin> instead.
2878 NV scan_bin(const char* start, STRLEN len, STRLEN* retlen)
2881 Found in file numeric.c
2886 For backwards compatibility. Use C<grok_hex> instead.
2888 NV scan_hex(const char* start, STRLEN len, STRLEN* retlen)
2891 Found in file numeric.c
2896 For backwards compatibility. Use C<grok_oct> instead.
2898 NV scan_oct(const char* start, STRLEN len, STRLEN* retlen)
2901 Found in file numeric.c
2906 =head1 Optree Manipulation Functions
2913 If C<cv> is a constant sub eligible for inlining. returns the constant
2914 value returned by the sub. Otherwise, returns NULL.
2916 Constant subs can be created with C<newCONSTSUB> or as described in
2917 L<perlsub/"Constant Functions">.
2919 SV* cv_const_sv(CV* cv)
2927 Creates a constant sub equivalent to Perl C<sub FOO () { 123 }> which is
2928 eligible for inlining at compile-time.
2930 CV* newCONSTSUB(HV* stash, const char* name, SV* sv)
2938 Used by C<xsubpp> to hook up XSUBs as Perl subs. I<filename> needs to be
2939 static storage, as it is used directly as CvFILE(), without a copy being made.
2947 =head1 Pad Data Structures
2954 Get the value at offset po in the current pad.
2955 Use macro PAD_SV instead of calling this function directly.
2957 SV* pad_sv(PADOFFSET po)
2965 =head1 Simple Exception Handling Macros
2972 Set up necessary local variables for exception handling.
2973 See L<perlguts/"Exception Handling">.
2978 Found in file XSUB.h
2983 Introduces a catch block. See L<perlguts/"Exception Handling">.
2986 Found in file XSUB.h
2991 Rethrows a previously caught exception. See L<perlguts/"Exception Handling">.
2996 Found in file XSUB.h
3001 Ends a try block. See L<perlguts/"Exception Handling">.
3004 Found in file XSUB.h
3006 =item XCPT_TRY_START
3009 Starts a try block. See L<perlguts/"Exception Handling">.
3012 Found in file XSUB.h
3017 =head1 Stack Manipulation Macros
3024 Declare a stack marker variable, C<mark>, for the XSUB. See C<MARK> and
3035 Saves the original stack mark for the XSUB. See C<ORIGMARK>.
3045 Declares a local copy of perl's stack pointer for the XSUB, available via
3046 the C<SP> macro. See C<SP>.
3056 Used to extend the argument stack for an XSUB's return values. Once
3057 used, guarantees that there is room for at least C<nitems> to be pushed
3060 void EXTEND(SP, int nitems)
3068 Stack marker variable for the XSUB. See C<dMARK>.
3076 Push an integer onto the stack. The stack must have room for this element.
3077 Handles 'set' magic. Does not use C<TARG>. See also C<PUSHi>, C<mXPUSHi>
3088 Push a double onto the stack. The stack must have room for this element.
3089 Handles 'set' magic. Does not use C<TARG>. See also C<PUSHn>, C<mXPUSHn>
3100 Push a string onto the stack. The stack must have room for this element.
3101 The C<len> indicates the length of the string. Handles 'set' magic. Does
3102 not use C<TARG>. See also C<PUSHp>, C<mXPUSHp> and C<XPUSHp>.
3104 void mPUSHp(char* str, STRLEN len)
3112 Push an unsigned integer onto the stack. The stack must have room for this
3113 element. Handles 'set' magic. Does not use C<TARG>. See also C<PUSHu>,
3114 C<mXPUSHu> and C<XPUSHu>.
3124 Push an integer onto the stack, extending the stack if necessary. Handles
3125 'set' magic. Does not use C<TARG>. See also C<XPUSHi>, C<mPUSHi> and
3136 Push a double onto the stack, extending the stack if necessary. Handles
3137 'set' magic. Does not use C<TARG>. See also C<XPUSHn>, C<mPUSHn> and
3148 Push a string onto the stack, extending the stack if necessary. The C<len>
3149 indicates the length of the string. Handles 'set' magic. Does not use
3150 C<TARG>. See also C<XPUSHp>, C<mPUSHp> and C<PUSHp>.
3152 void mXPUSHp(char* str, STRLEN len)
3160 Push an unsigned integer onto the stack, extending the stack if necessary.
3161 Handles 'set' magic. Does not use C<TARG>. See also C<XPUSHu>, C<mPUSHu>
3172 The original stack mark for the XSUB. See C<dORIGMARK>.
3180 Pops an integer off the stack.
3190 Pops a long off the stack.
3200 Pops a double off the stack.
3210 Pops a string off the stack. Deprecated. New code should use POPpx.
3220 Pops a string off the stack which must consist of bytes i.e. characters < 256.
3230 Pops a string off the stack.
3240 Pops an SV off the stack.
3250 Push an integer onto the stack. The stack must have room for this element.
3251 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3252 called to declare it. Do not call multiple C<TARG>-oriented macros to
3253 return lists from XSUB's - see C<mPUSHi> instead. See also C<XPUSHi> and
3264 Opening bracket for arguments on a callback. See C<PUTBACK> and
3275 Push a new mortal SV onto the stack. The stack must have room for this
3276 element. Does not handle 'set' magic. Does not use C<TARG>. See also
3277 C<PUSHs>, C<XPUSHmortal> and C<XPUSHs>.
3287 Push a double onto the stack. The stack must have room for this element.
3288 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3289 called to declare it. Do not call multiple C<TARG>-oriented macros to
3290 return lists from XSUB's - see C<mPUSHn> instead. See also C<XPUSHn> and
3301 Push a string onto the stack. The stack must have room for this element.
3302 The C<len> indicates the length of the string. Handles 'set' magic. Uses
3303 C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to declare it. Do not
3304 call multiple C<TARG>-oriented macros to return lists from XSUB's - see
3305 C<mPUSHp> instead. See also C<XPUSHp> and C<mXPUSHp>.
3307 void PUSHp(char* str, STRLEN len)
3315 Push an SV onto the stack. The stack must have room for this element.
3316 Does not handle 'set' magic. Does not use C<TARG>. See also C<PUSHmortal>,
3317 C<XPUSHs> and C<XPUSHmortal>.
3327 Push an unsigned integer onto the stack. The stack must have room for this
3328 element. Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG>
3329 should be called to declare it. Do not call multiple C<TARG>-oriented
3330 macros to return lists from XSUB's - see C<mPUSHu> instead. See also
3331 C<XPUSHu> and C<mXPUSHu>.
3341 Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
3342 See C<PUSHMARK> and L<perlcall> for other uses.
3352 Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and
3361 Refetch the stack pointer. Used after a callback. See L<perlcall>.
3371 Push an integer onto the stack, extending the stack if necessary. Handles
3372 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
3373 declare it. Do not call multiple C<TARG>-oriented macros to return lists
3374 from XSUB's - see C<mXPUSHi> instead. See also C<PUSHi> and C<mPUSHi>.
3384 Push a new mortal SV onto the stack, extending the stack if necessary. Does
3385 not handle 'set' magic. Does not use C<TARG>. See also C<XPUSHs>,
3386 C<PUSHmortal> and C<PUSHs>.
3396 Push a double onto the stack, extending the stack if necessary. Handles
3397 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
3398 declare it. Do not call multiple C<TARG>-oriented macros to return lists
3399 from XSUB's - see C<mXPUSHn> instead. See also C<PUSHn> and C<mPUSHn>.
3409 Push a string onto the stack, extending the stack if necessary. The C<len>
3410 indicates the length of the string. Handles 'set' magic. Uses C<TARG>, so
3411 C<dTARGET> or C<dXSTARG> should be called to declare it. Do not call
3412 multiple C<TARG>-oriented macros to return lists from XSUB's - see
3413 C<mXPUSHp> instead. See also C<PUSHp> and C<mPUSHp>.
3415 void XPUSHp(char* str, STRLEN len)
3423 Push an SV onto the stack, extending the stack if necessary. Does not
3424 handle 'set' magic. Does not use C<TARG>. See also C<XPUSHmortal>,
3425 C<PUSHs> and C<PUSHmortal>.
3435 Push an unsigned integer onto the stack, extending the stack if necessary.
3436 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3437 called to declare it. Do not call multiple C<TARG>-oriented macros to
3438 return lists from XSUB's - see C<mXPUSHu> instead. See also C<PUSHu> and
3449 Return from XSUB, indicating number of items on the stack. This is usually
3450 handled by C<xsubpp>.
3452 void XSRETURN(int nitems)
3455 Found in file XSUB.h
3457 =item XSRETURN_EMPTY
3460 Return an empty list from an XSUB immediately.
3465 Found in file XSUB.h
3470 Return an integer from an XSUB immediately. Uses C<XST_mIV>.
3472 void XSRETURN_IV(IV iv)
3475 Found in file XSUB.h
3480 Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
3485 Found in file XSUB.h
3490 Return a double from an XSUB immediately. Uses C<XST_mNV>.
3492 void XSRETURN_NV(NV nv)
3495 Found in file XSUB.h
3500 Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
3502 void XSRETURN_PV(char* str)
3505 Found in file XSUB.h
3507 =item XSRETURN_UNDEF
3510 Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
3515 Found in file XSUB.h
3520 Return an integer from an XSUB immediately. Uses C<XST_mUV>.
3522 void XSRETURN_UV(IV uv)
3525 Found in file XSUB.h
3530 Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
3535 Found in file XSUB.h
3540 Place an integer into the specified position C<pos> on the stack. The
3541 value is stored in a new mortal SV.
3543 void XST_mIV(int pos, IV iv)
3546 Found in file XSUB.h
3551 Place C<&PL_sv_no> into the specified position C<pos> on the
3554 void XST_mNO(int pos)
3557 Found in file XSUB.h
3562 Place a double into the specified position C<pos> on the stack. The value
3563 is stored in a new mortal SV.
3565 void XST_mNV(int pos, NV nv)
3568 Found in file XSUB.h
3573 Place a copy of a string into the specified position C<pos> on the stack.
3574 The value is stored in a new mortal SV.
3576 void XST_mPV(int pos, char* str)
3579 Found in file XSUB.h
3584 Place C<&PL_sv_undef> into the specified position C<pos> on the
3587 void XST_mUNDEF(int pos)
3590 Found in file XSUB.h
3595 Place C<&PL_sv_yes> into the specified position C<pos> on the
3598 void XST_mYES(int pos)
3601 Found in file XSUB.h
3613 An enum of flags for Perl types. These are found in the file B<sv.h>
3614 in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
3622 Integer type flag for scalars. See C<svtype>.
3630 Double type flag for scalars. See C<svtype>.
3638 Pointer type flag for scalars. See C<svtype>.
3646 Type flag for arrays. See C<svtype>.
3654 Type flag for code refs. See C<svtype>.
3662 Type flag for hashes. See C<svtype>.
3670 Type flag for blessed scalars. See C<svtype>.
3678 =head1 SV Manipulation Functions
3685 Returns the SV of the specified Perl scalar. If C<create> is set and the
3686 Perl variable does not exist then it will be created. If C<create> is not
3687 set and the variable does not exist then NULL is returned.
3689 NOTE: the perl_ form of this function is deprecated.
3691 SV* get_sv(const char* name, I32 create)
3694 Found in file perl.c
3699 Creates an RV wrapper for an SV. The reference count for the original SV is
3702 SV* newRV_inc(SV* sv)
3710 Returns the length of the string which is in the SV. See C<SvLEN>.
3712 STRLEN SvCUR(SV* sv)
3720 Set the current length of the string which is in the SV. See C<SvCUR>
3723 void SvCUR_set(SV* sv, STRLEN len)
3731 Returns a pointer to the last character in the string which is in the SV.
3732 See C<SvCUR>. Access the character as *(SvEND(sv)).
3742 Returns true if the SV has get magic or overloading. If either is true then
3743 the scalar is active data, and has the potential to return a new value every
3744 time it is accessed. Hence you must be careful to only read it once per user
3745 logical operation and work with that returned value. If neither is true then
3746 the scalar's value cannot change unless written to.
3748 char* SvGAMAGIC(SV* sv)
3756 Expands the character buffer in the SV so that it has room for the
3757 indicated number of bytes (remember to reserve space for an extra trailing
3758 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
3759 Returns a pointer to the character buffer.
3761 char * SvGROW(SV* sv, STRLEN len)
3769 Returns a boolean indicating whether the SV contains an integer.
3779 Returns a boolean indicating whether the SV contains an integer. Checks
3780 the B<private> setting. Use C<SvIOK>.
3790 Returns a boolean indicating whether the SV contains a signed integer.
3792 bool SvIOK_notUV(SV* sv)
3800 Unsets the IV status of an SV.
3802 void SvIOK_off(SV* sv)
3810 Tells an SV that it is an integer.
3812 void SvIOK_on(SV* sv)
3820 Tells an SV that it is an integer and disables all other OK bits.
3822 void SvIOK_only(SV* sv)
3830 Tells and SV that it is an unsigned integer and disables all other OK bits.
3832 void SvIOK_only_UV(SV* sv)
3840 Returns a boolean indicating whether the SV contains an unsigned integer.
3842 bool SvIOK_UV(SV* sv)
3850 Returns a boolean indicating whether the SV is Copy-On-Write. (either shared
3851 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
3854 bool SvIsCOW(SV* sv)
3859 =item SvIsCOW_shared_hash
3860 X<SvIsCOW_shared_hash>
3862 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
3865 bool SvIsCOW_shared_hash(SV* sv)
3873 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
3874 version which guarantees to evaluate sv only once.
3884 Returns the raw value in the SV's IV slot, without checks or conversions.
3885 Only use when you are sure SvIOK is true. See also C<SvIV()>.
3895 Coerces the given SV to an integer and returns it. Guarantees to evaluate
3896 sv only once. Use the more efficient C<SvIV> otherwise.
3906 Like C<SvIV> but doesn't process magic.
3908 IV SvIV_nomg(SV* sv)
3916 Set the value of the IV pointer in sv to val. It is possible to perform
3917 the same function of this macro with an lvalue assignment to C<SvIVX>.
3918 With future Perls, however, it will be more efficient to use
3919 C<SvIV_set> instead of the lvalue assignment to C<SvIVX>.
3921 void SvIV_set(SV* sv, IV val)
3929 Returns the size of the string buffer in the SV, not including any part
3930 attributable to C<SvOOK>. See C<SvCUR>.
3932 STRLEN SvLEN(SV* sv)
3940 Set the actual length of the string which is in the SV. See C<SvIV_set>.
3942 void SvLEN_set(SV* sv, STRLEN len)
3950 Set the value of the MAGIC pointer in sv to val. See C<SvIV_set>.
3952 void SvMAGIC_set(SV* sv, MAGIC* val)
3960 Returns a boolean indicating whether the SV contains a number, integer or
3971 Returns a boolean indicating whether the SV contains a number, integer or
3972 double. Checks the B<private> setting. Use C<SvNIOK>.
3974 bool SvNIOKp(SV* sv)
3982 Unsets the NV/IV status of an SV.
3984 void SvNIOK_off(SV* sv)
3992 Returns a boolean indicating whether the SV contains a double.
4002 Returns a boolean indicating whether the SV contains a double. Checks the
4003 B<private> setting. Use C<SvNOK>.
4013 Unsets the NV status of an SV.
4015 void SvNOK_off(SV* sv)
4023 Tells an SV that it is a double.
4025 void SvNOK_on(SV* sv)
4033 Tells an SV that it is a double and disables all other OK bits.
4035 void SvNOK_only(SV* sv)
4043 Coerce the given SV to a double and return it. See C<SvNVx> for a version
4044 which guarantees to evaluate sv only once.
4054 Returns the raw value in the SV's NV slot, without checks or conversions.
4055 Only use when you are sure SvNOK is true. See also C<SvNV()>.
4065 Coerces the given SV to a double and returns it. Guarantees to evaluate
4066 sv only once. Use the more efficient C<SvNV> otherwise.
4076 Set the value of the NV pointer in sv to val. See C<SvIV_set>.
4078 void SvNV_set(SV* sv, NV val)
4086 Returns a boolean indicating whether the value is an SV. It also tells
4087 whether the value is defined or not.
4097 Returns a boolean indicating whether the SvIVX is a valid offset value for
4098 the SvPVX. This hack is used internally to speed up removal of characters
4099 from the beginning of a SvPV. When SvOOK is true, then the start of the
4100 allocated string buffer is really (SvPVX - SvIVX).
4110 Returns a boolean indicating whether the SV contains a character
4121 Returns a boolean indicating whether the SV contains a character string.
4122 Checks the B<private> setting. Use C<SvPOK>.
4132 Unsets the PV status of an SV.
4134 void SvPOK_off(SV* sv)
4142 Tells an SV that it is a string.
4144 void SvPOK_on(SV* sv)
4152 Tells an SV that it is a string and disables all other OK bits.
4153 Will also turn off the UTF-8 status.
4155 void SvPOK_only(SV* sv)
4160 =item SvPOK_only_UTF8
4163 Tells an SV that it is a string and disables all other OK bits,
4164 and leaves the UTF-8 status as it was.
4166 void SvPOK_only_UTF8(SV* sv)
4174 Returns a pointer to the string in the SV, or a stringified form of
4175 the SV if the SV does not contain a string. The SV may cache the
4176 stringified version becoming C<SvPOK>. Handles 'get' magic. See also
4177 C<SvPVx> for a version which guarantees to evaluate sv only once.
4179 char* SvPV(SV* sv, STRLEN len)
4187 Like C<SvPV>, but converts sv to byte representation first if necessary.
4189 char* SvPVbyte(SV* sv, STRLEN len)
4197 Like C<SvPV>, but converts sv to byte representation first if necessary.
4198 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
4201 char* SvPVbytex(SV* sv, STRLEN len)
4206 =item SvPVbytex_force
4209 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
4210 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
4213 char* SvPVbytex_force(SV* sv, STRLEN len)
4218 =item SvPVbyte_force
4221 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
4223 char* SvPVbyte_force(SV* sv, STRLEN len)
4228 =item SvPVbyte_nolen
4231 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
4233 char* SvPVbyte_nolen(SV* sv)
4241 Like C<SvPV>, but converts sv to utf8 first if necessary.
4243 char* SvPVutf8(SV* sv, STRLEN len)
4251 Like C<SvPV>, but converts sv to utf8 first if necessary.
4252 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
4255 char* SvPVutf8x(SV* sv, STRLEN len)
4260 =item SvPVutf8x_force
4263 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
4264 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
4267 char* SvPVutf8x_force(SV* sv, STRLEN len)
4272 =item SvPVutf8_force
4275 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
4277 char* SvPVutf8_force(SV* sv, STRLEN len)
4282 =item SvPVutf8_nolen
4285 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
4287 char* SvPVutf8_nolen(SV* sv)
4295 Returns a pointer to the physical string in the SV. The SV must contain a
4306 A version of C<SvPV> which guarantees to evaluate sv only once.
4308 char* SvPVx(SV* sv, STRLEN len)
4316 Like C<SvPV> but will force the SV into containing just a string
4317 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
4320 char* SvPV_force(SV* sv, STRLEN len)
4325 =item SvPV_force_nomg
4328 Like C<SvPV> but will force the SV into containing just a string
4329 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
4330 directly. Doesn't process magic.
4332 char* SvPV_force_nomg(SV* sv, STRLEN len)
4340 Returns a pointer to the string in the SV, or a stringified form of
4341 the SV if the SV does not contain a string. The SV may cache the
4342 stringified form becoming C<SvPOK>. Handles 'get' magic.
4344 char* SvPV_nolen(SV* sv)
4352 Like C<SvPV> but doesn't process magic.
4354 char* SvPV_nomg(SV* sv, STRLEN len)
4362 Set the value of the PV pointer in sv to val. See C<SvIV_set>.
4364 void SvPV_set(SV* sv, char* val)
4372 Returns the value of the object's reference count.
4374 U32 SvREFCNT(SV* sv)
4382 Decrements the reference count of the given SV.
4384 void SvREFCNT_dec(SV* sv)
4392 Increments the reference count of the given SV.
4394 All of the following SvREFCNT_inc* macros are optimized versions of
4395 SvREFCNT_inc, and can be replaced with SvREFCNT_inc.
4397 SV* SvREFCNT_inc(SV* sv)
4402 =item SvREFCNT_inc_NN
4405 Same as SvREFCNT_inc, but can only be used if you know I<sv>
4406 is not NULL. Since we don't have to check the NULLness, it's faster
4409 SV* SvREFCNT_inc_NN(SV* sv)
4414 =item SvREFCNT_inc_simple
4415 X<SvREFCNT_inc_simple>
4417 Same as SvREFCNT_inc, but can only be used with simple variables, not
4418 expressions or pointer dereferences. Since we don't have to store a
4419 temporary value, it's faster.
4421 SV* SvREFCNT_inc_simple(SV* sv)
4426 =item SvREFCNT_inc_simple_NN
4427 X<SvREFCNT_inc_simple_NN>
4429 Same as SvREFCNT_inc_simple, but can only be used if you know I<sv>
4430 is not NULL. Since we don't have to check the NULLness, it's faster
4433 SV* SvREFCNT_inc_simple_NN(SV* sv)
4438 =item SvREFCNT_inc_simple_void
4439 X<SvREFCNT_inc_simple_void>
4441 Same as SvREFCNT_inc_simple, but can only be used if you don't need the
4442 return value. The macro doesn't need to return a meaningful value.
4444 void SvREFCNT_inc_simple_void(SV* sv)
4449 =item SvREFCNT_inc_simple_void_NN
4450 X<SvREFCNT_inc_simple_void_NN>
4452 Same as SvREFCNT_inc, but can only be used if you don't need the return
4453 value, and you know that I<sv> is not NULL. The macro doesn't need
4454 to return a meaningful value, or check for NULLness, so it's smaller
4457 void SvREFCNT_inc_simple_void_NN(SV* sv)
4462 =item SvREFCNT_inc_void
4463 X<SvREFCNT_inc_void>
4465 Same as SvREFCNT_inc, but can only be used if you don't need the
4466 return value. The macro doesn't need to return a meaningful value.
4468 void SvREFCNT_inc_void(SV* sv)
4473 =item SvREFCNT_inc_void_NN
4474 X<SvREFCNT_inc_void_NN>
4476 Same as SvREFCNT_inc, but can only be used if you don't need the return
4477 value, and you know that I<sv> is not NULL. The macro doesn't need
4478 to return a meaningful value, or check for NULLness, so it's smaller
4481 void SvREFCNT_inc_void_NN(SV* sv)
4489 Tests if the SV is an RV.
4499 Unsets the RV status of an SV.
4501 void SvROK_off(SV* sv)
4509 Tells an SV that it is an RV.
4511 void SvROK_on(SV* sv)
4519 Dereferences an RV to return the SV.
4529 Set the value of the RV pointer in sv to val. See C<SvIV_set>.
4531 void SvRV_set(SV* sv, SV* val)
4539 Returns the stash of the SV.
4549 Set the value of the STASH pointer in sv to val. See C<SvIV_set>.
4551 void SvSTASH_set(SV* sv, HV* val)
4559 Taints an SV if tainting is enabled.
4561 void SvTAINT(SV* sv)
4569 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
4572 bool SvTAINTED(SV* sv)
4580 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
4581 some of Perl's fundamental security features. XS module authors should not
4582 use this function unless they fully understand all the implications of
4583 unconditionally untainting the value. Untainting should be done in the
4584 standard perl fashion, via a carefully crafted regexp, rather than directly
4585 untainting variables.
4587 void SvTAINTED_off(SV* sv)
4595 Marks an SV as tainted if tainting is enabled.
4597 void SvTAINTED_on(SV* sv)
4605 Returns a boolean indicating whether Perl would evaluate the SV as true or
4606 false, defined or undefined. Does not handle 'get' magic.
4616 Returns the type of the SV. See C<svtype>.
4618 svtype SvTYPE(SV* sv)
4626 Returns a boolean indicating whether the SV contains an unsigned integer.
4636 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
4637 perform the upgrade if necessary. See C<svtype>.
4639 void SvUPGRADE(SV* sv, svtype type)
4647 Returns a boolean indicating whether the SV contains UTF-8 encoded data.
4657 Unsets the UTF-8 status of an SV.
4659 void SvUTF8_off(SV *sv)
4667 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
4668 Do not use frivolously.
4670 void SvUTF8_on(SV *sv)
4678 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
4679 for a version which guarantees to evaluate sv only once.
4689 Returns the raw value in the SV's UV slot, without checks or conversions.
4690 Only use when you are sure SvIOK is true. See also C<SvUV()>.
4700 Coerces the given SV to an unsigned integer and returns it. Guarantees to
4701 evaluate sv only once. Use the more efficient C<SvUV> otherwise.
4711 Like C<SvUV> but doesn't process magic.
4713 UV SvUV_nomg(SV* sv)
4721 Set the value of the UV pointer in sv to val. See C<SvIV_set>.
4723 void SvUV_set(SV* sv, UV val)
4731 Returns a boolean indicating whether the SV contains a v-string.
4738 =item sv_catpvn_nomg
4741 Like C<sv_catpvn> but doesn't process magic.
4743 void sv_catpvn_nomg(SV* sv, const char* ptr, STRLEN len)
4751 Like C<sv_catsv> but doesn't process magic.
4753 void sv_catsv_nomg(SV* dsv, SV* ssv)
4758 =item sv_derived_from
4761 Returns a boolean indicating whether the SV is derived from the specified class
4762 I<at the C level>. To check derivation at the Perl level, call C<isa()> as a
4765 bool sv_derived_from(SV* sv, const char* name)
4768 Found in file universal.c
4773 Returns a boolean indicating whether the SV performs a specific, named role.
4774 The SV can be a Perl object or the name of a Perl class.
4776 bool sv_does(SV* sv, const char* name)
4779 Found in file universal.c
4781 =item sv_report_used
4784 Dump the contents of all SVs not yet freed. (Debugging aid).
4786 void sv_report_used()
4794 Like C<sv_setsv> but doesn't process magic.
4796 void sv_setsv_nomg(SV* dsv, SV* ssv)
4804 =head1 SV-Body Allocation
4808 =item looks_like_number
4809 X<looks_like_number>
4811 Test if the content of an SV looks like a number (or is a number).
4812 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
4813 non-numeric warning), even if your atof() doesn't grok them.
4815 I32 looks_like_number(SV* sv)
4823 Creates an RV wrapper for an SV. The reference count for the original
4824 SV is B<not> incremented.
4826 SV* newRV_noinc(SV* sv)
4834 Creates a new SV. A non-zero C<len> parameter indicates the number of
4835 bytes of preallocated string space the SV should have. An extra byte for a
4836 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4837 space is allocated.) The reference count for the new SV is set to 1.
4839 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4840 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4841 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4842 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4843 modules supporting older perls.
4845 SV* newSV(STRLEN len)
4853 Creates a new SV from the hash key structure. It will generate scalars that
4854 point to the shared string table where possible. Returns a new (undefined)
4855 SV if the hek is NULL.
4857 SV* newSVhek(const HEK *hek)
4865 Creates a new SV and copies an integer into it. The reference count for the
4876 Creates a new SV and copies a floating point value into it.
4877 The reference count for the SV is set to 1.
4887 Creates a new SV and copies a string into it. The reference count for the
4888 SV is set to 1. If C<len> is zero, Perl will compute the length using
4889 strlen(). For efficiency, consider using C<newSVpvn> instead.
4891 SV* newSVpv(const char* s, STRLEN len)
4899 Creates a new SV and initializes it with the string formatted like
4902 SV* newSVpvf(const char* pat, ...)
4910 Creates a new SV and copies a string into it. The reference count for the
4911 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
4912 string. You are responsible for ensuring that the source string is at least
4913 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
4915 SV* newSVpvn(const char* s, STRLEN len)
4920 =item newSVpvn_share
4923 Creates a new SV with its SvPVX_const pointing to a shared string in the string
4924 table. If the string does not already exist in the table, it is created
4925 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
4926 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
4927 otherwise the hash is computed. The idea here is that as the string table
4928 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
4929 hash lookup will avoid string compare.
4931 SV* newSVpvn_share(const char* s, I32 len, U32 hash)
4939 Like C<newSVpvn>, but takes a literal string instead of a string/length pair.
4941 SV* newSVpvs(const char* s)
4944 Found in file handy.h
4946 =item newSVpvs_share
4949 Like C<newSVpvn_share>, but takes a literal string instead of a string/length
4950 pair and omits the hash parameter.
4952 SV* newSVpvs_share(const char* s)
4955 Found in file handy.h
4960 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
4961 it will be upgraded to one. If C<classname> is non-null then the new SV will
4962 be blessed in the specified package. The new SV is returned and its
4963 reference count is 1.
4965 SV* newSVrv(SV* rv, const char* classname)
4973 Creates a new SV which is an exact duplicate of the original SV.
4976 SV* newSVsv(SV* old)
4984 Creates a new SV and copies an unsigned integer into it.
4985 The reference count for the SV is set to 1.
4995 This function is only called on magical items, and is only used by
4996 sv_true() or its macro equivalent.
4998 bool sv_2bool(SV* sv)
5006 Using various gambits, try to get a CV from an SV; in addition, try if
5007 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
5008 The flags in C<lref> are passed to sv_fetchsv.
5010 CV* sv_2cv(SV* sv, HV** st, GV** gvp, I32 lref)
5018 Using various gambits, try to get an IO from an SV: the IO slot if its a
5019 GV; or the recursive result if we're an RV; or the IO slot of the symbol
5020 named after the PV if we're a string.
5030 Return the integer value of an SV, doing any necessary string
5031 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
5032 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
5034 IV sv_2iv_flags(SV* sv, I32 flags)
5042 Marks an existing SV as mortal. The SV will be destroyed "soon", either
5043 by an explicit call to FREETMPS, or by an implicit call at places such as
5044 statement boundaries. SvTEMP() is turned on which means that the SV's
5045 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
5046 and C<sv_mortalcopy>.
5048 SV* sv_2mortal(SV* sv)
5056 Return the num value of an SV, doing any necessary string or integer
5057 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
5068 Return a pointer to the byte-encoded representation of the SV, and set *lp
5069 to its length. May cause the SV to be downgraded from UTF-8 as a
5072 Usually accessed via the C<SvPVbyte> macro.
5074 char* sv_2pvbyte(SV* sv, STRLEN* lp)
5082 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
5083 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
5085 Usually accessed via the C<SvPVutf8> macro.
5087 char* sv_2pvutf8(SV* sv, STRLEN* lp)
5095 Returns a pointer to the string value of an SV, and sets *lp to its length.
5096 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
5098 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
5099 usually end up here too.
5101 char* sv_2pv_flags(SV* sv, STRLEN* lp, I32 flags)
5109 Return the unsigned integer value of an SV, doing any necessary string
5110 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
5111 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
5113 UV sv_2uv_flags(SV* sv, I32 flags)
5121 Remove any string offset. You should normally use the C<SvOOK_off> macro
5124 int sv_backoff(SV* sv)
5132 Blesses an SV into a specified package. The SV must be an RV. The package
5133 must be designated by its stash (see C<gv_stashpv()>). The reference count
5134 of the SV is unaffected.
5136 SV* sv_bless(SV* sv, HV* stash)
5144 Concatenates the string onto the end of the string which is in the SV.
5145 If the SV has the UTF-8 status set, then the bytes appended should be
5146 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
5148 void sv_catpv(SV* sv, const char* ptr)
5156 Processes its arguments like C<sprintf> and appends the formatted
5157 output to an SV. If the appended data contains "wide" characters
5158 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
5159 and characters >255 formatted with %c), the original SV might get
5160 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
5161 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
5162 valid UTF-8; if the original SV was bytes, the pattern should be too.
5164 void sv_catpvf(SV* sv, const char* pat, ...)
5172 Like C<sv_catpvf>, but also handles 'set' magic.
5174 void sv_catpvf_mg(SV *sv, const char* pat, ...)
5182 Concatenates the string onto the end of the string which is in the SV. The
5183 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5184 status set, then the bytes appended should be valid UTF-8.
5185 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
5187 void sv_catpvn(SV* sv, const char* ptr, STRLEN len)
5192 =item sv_catpvn_flags
5195 Concatenates the string onto the end of the string which is in the SV. The
5196 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5197 status set, then the bytes appended should be valid UTF-8.
5198 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
5199 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
5200 in terms of this function.
5202 void sv_catpvn_flags(SV* sv, const char* ptr, STRLEN len, I32 flags)
5210 Like C<sv_catpvn>, but takes a literal string instead of a string/length pair.
5212 void sv_catpvs(SV* sv, const char* s)
5215 Found in file handy.h
5220 Like C<sv_catpv>, but also handles 'set' magic.
5222 void sv_catpv_mg(SV *sv, const char *ptr)
5230 Concatenates the string from SV C<ssv> onto the end of the string in
5231 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
5232 not 'set' magic. See C<sv_catsv_mg>.
5234 void sv_catsv(SV* dsv, SV* ssv)
5239 =item sv_catsv_flags
5242 Concatenates the string from SV C<ssv> onto the end of the string in
5243 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
5244 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
5245 and C<sv_catsv_nomg> are implemented in terms of this function.
5247 void sv_catsv_flags(SV* dsv, SV* ssv, I32 flags)
5255 Efficient removal of characters from the beginning of the string buffer.
5256 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
5257 the string buffer. The C<ptr> becomes the first character of the adjusted
5258 string. Uses the "OOK hack".
5259 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
5260 refer to the same chunk of data.
5262 void sv_chop(SV* sv, const char* ptr)
5270 Clear an SV: call any destructors, free up any memory used by the body,
5271 and free the body itself. The SV's head is I<not> freed, although
5272 its type is set to all 1's so that it won't inadvertently be assumed
5273 to be live during global destruction etc.
5274 This function should only be called when REFCNT is zero. Most of the time
5275 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5278 void sv_clear(SV* sv)
5286 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5287 string in C<sv1> is less than, equal to, or greater than the string in
5288 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5289 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
5291 I32 sv_cmp(SV* sv1, SV* sv2)
5299 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
5300 'use bytes' aware, handles get magic, and will coerce its args to strings
5301 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
5303 I32 sv_cmp_locale(SV* sv1, SV* sv2)
5311 Add Collate Transform magic to an SV if it doesn't already have it.
5313 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
5314 scalar data of the variable, but transformed to such a format that a normal
5315 memory comparison can be used to compare the data according to the locale
5318 char* sv_collxfrm(SV* sv, STRLEN* nxp)
5326 Copies a stringified representation of the source SV into the
5327 destination SV. Automatically performs any necessary mg_get and
5328 coercion of numeric values into strings. Guaranteed to preserve
5329 UTF-8 flag even from overloaded objects. Similar in nature to
5330 sv_2pv[_flags] but operates directly on an SV instead of just the
5331 string. Mostly uses sv_2pv_flags to do its work, except when that
5332 would lose the UTF-8'ness of the PV.
5334 void sv_copypv(SV* dsv, SV* ssv)
5342 Auto-decrement of the value in the SV, doing string to numeric conversion
5343 if necessary. Handles 'get' magic.
5353 Returns a boolean indicating whether the strings in the two SVs are
5354 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5355 coerce its args to strings if necessary.
5357 I32 sv_eq(SV* sv1, SV* sv2)
5362 =item sv_force_normal_flags
5363 X<sv_force_normal_flags>
5365 Undo various types of fakery on an SV: if the PV is a shared string, make
5366 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
5367 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
5368 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
5369 then a copy-on-write scalar drops its PV buffer (if any) and becomes
5370 SvPOK_off rather than making a copy. (Used where this scalar is about to be
5371 set to some other value.) In addition, the C<flags> parameter gets passed to
5372 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
5373 with flags set to 0.
5375 void sv_force_normal_flags(SV *sv, U32 flags)
5383 Decrement an SV's reference count, and if it drops to zero, call
5384 C<sv_clear> to invoke destructors and free up any memory used by
5385 the body; finally, deallocate the SV's head itself.
5386 Normally called via a wrapper macro C<SvREFCNT_dec>.
5388 void sv_free(SV* sv)
5396 Get a line from the filehandle and store it into the SV, optionally
5397 appending to the currently-stored string.
5399 char* sv_gets(SV* sv, PerlIO* fp, I32 append)
5407 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
5408 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
5409 Use the C<SvGROW> wrapper instead.
5411 char* sv_grow(SV* sv, STRLEN newlen)
5419 Auto-increment of the value in the SV, doing string to numeric conversion
5420 if necessary. Handles 'get' magic.
5430 Inserts a string at the specified offset/length within the SV. Similar to
5431 the Perl substr() function.
5433 void sv_insert(SV* bigsv, STRLEN offset, STRLEN len, const char* little, STRLEN littlelen)
5441 Returns a boolean indicating whether the SV is blessed into the specified
5442 class. This does not check for subtypes; use C<sv_derived_from> to verify
5443 an inheritance relationship.
5445 int sv_isa(SV* sv, const char* name)
5453 Returns a boolean indicating whether the SV is an RV pointing to a blessed
5454 object. If the SV is not an RV, or if the object is not blessed, then this
5457 int sv_isobject(SV* sv)
5465 Returns the length of the string in the SV. Handles magic and type
5466 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5468 STRLEN sv_len(SV* sv)
5476 Returns the number of characters in the string in an SV, counting wide
5477 UTF-8 bytes as a single character. Handles magic and type coercion.
5479 STRLEN sv_len_utf8(SV* sv)
5487 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
5488 then adds a new magic item of type C<how> to the head of the magic list.
5490 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
5491 handling of the C<name> and C<namlen> arguments.
5493 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
5494 to add more than one instance of the same 'how'.
5496 void sv_magic(SV* sv, SV* obj, int how, const char* name, I32 namlen)
5504 Adds magic to an SV, upgrading it if necessary. Applies the
5505 supplied vtable and returns a pointer to the magic added.
5507 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
5508 In particular, you can add magic to SvREADONLY SVs, and add more than
5509 one instance of the same 'how'.
5511 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
5512 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
5513 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
5514 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
5516 (This is now used as a subroutine by C<sv_magic>.)
5518 MAGIC * sv_magicext(SV* sv, SV* obj, int how, MGVTBL *vtbl, const char* name, I32 namlen)
5526 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
5527 The new SV is marked as mortal. It will be destroyed "soon", either by an
5528 explicit call to FREETMPS, or by an implicit call at places such as
5529 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
5531 SV* sv_mortalcopy(SV* oldsv)
5539 Creates a new null SV which is mortal. The reference count of the SV is
5540 set to 1. It will be destroyed "soon", either by an explicit call to
5541 FREETMPS, or by an implicit call at places such as statement boundaries.
5542 See also C<sv_mortalcopy> and C<sv_2mortal>.
5552 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5555 SV* sv_newref(SV* sv)
5563 Converts the value pointed to by offsetp from a count of bytes from the
5564 start of the string, to a count of the equivalent number of UTF-8 chars.
5565 Handles magic and type coercion.
5567 void sv_pos_b2u(SV* sv, I32* offsetp)
5575 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5576 the start of the string, to a count of the equivalent number of bytes; if
5577 lenp is non-zero, it does the same to lenp, but this time starting from
5578 the offset, rather than from the start of the string. Handles magic and
5581 void sv_pos_u2b(SV* sv, I32* offsetp, I32* lenp)
5586 =item sv_pvbyten_force
5589 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
5591 char* sv_pvbyten_force(SV* sv, STRLEN* lp)
5599 Get a sensible string out of the SV somehow.
5600 A private implementation of the C<SvPV_force> macro for compilers which
5601 can't cope with complex macro expressions. Always use the macro instead.
5603 char* sv_pvn_force(SV* sv, STRLEN* lp)
5608 =item sv_pvn_force_flags
5609 X<sv_pvn_force_flags>
5611 Get a sensible string out of the SV somehow.
5612 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
5613 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
5614 implemented in terms of this function.
5615 You normally want to use the various wrapper macros instead: see
5616 C<SvPV_force> and C<SvPV_force_nomg>
5618 char* sv_pvn_force_flags(SV* sv, STRLEN* lp, I32 flags)
5623 =item sv_pvutf8n_force
5626 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
5628 char* sv_pvutf8n_force(SV* sv, STRLEN* lp)
5636 Returns a string describing what the SV is a reference to.
5638 const char* sv_reftype(const SV* sv, int ob)
5646 Make the first argument a copy of the second, then delete the original.
5647 The target SV physically takes over ownership of the body of the source SV
5648 and inherits its flags; however, the target keeps any magic it owns,
5649 and any magic in the source is discarded.
5650 Note that this is a rather specialist SV copying operation; most of the
5651 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5653 void sv_replace(SV* sv, SV* nsv)
5661 Underlying implementation for the C<reset> Perl function.
5662 Note that the perl-level function is vaguely deprecated.
5664 void sv_reset(const char* s, HV* stash)
5672 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
5673 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
5674 push a back-reference to this RV onto the array of backreferences
5675 associated with that magic. If the RV is magical, set magic will be
5676 called after the RV is cleared.
5678 SV* sv_rvweaken(SV *sv)
5686 Copies an integer into the given SV, upgrading first if necessary.
5687 Does not handle 'set' magic. See also C<sv_setiv_mg>.
5689 void sv_setiv(SV* sv, IV num)
5697 Like C<sv_setiv>, but also handles 'set' magic.
5699 void sv_setiv_mg(SV *sv, IV i)
5707 Copies a double into the given SV, upgrading first if necessary.
5708 Does not handle 'set' magic. See also C<sv_setnv_mg>.
5710 void sv_setnv(SV* sv, NV num)
5718 Like C<sv_setnv>, but also handles 'set' magic.
5720 void sv_setnv_mg(SV *sv, NV num)
5728 Copies a string into an SV. The string must be null-terminated. Does not
5729 handle 'set' magic. See C<sv_setpv_mg>.
5731 void sv_setpv(SV* sv, const char* ptr)
5739 Works like C<sv_catpvf> but copies the text into the SV instead of
5740 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
5742 void sv_setpvf(SV* sv, const char* pat, ...)
5750 Like C<sv_setpvf>, but also handles 'set' magic.
5752 void sv_setpvf_mg(SV *sv, const char* pat, ...)
5760 Copies an integer into the given SV, also updating its string value.
5761 Does not handle 'set' magic. See C<sv_setpviv_mg>.
5763 void sv_setpviv(SV* sv, IV num)
5771 Like C<sv_setpviv>, but also handles 'set' magic.
5773 void sv_setpviv_mg(SV *sv, IV iv)
5781 Copies a string into an SV. The C<len> parameter indicates the number of
5782 bytes to be copied. If the C<ptr> argument is NULL the SV will become
5783 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
5785 void sv_setpvn(SV* sv, const char* ptr, STRLEN len)
5793 Like C<sv_setpvn>, but also handles 'set' magic.
5795 void sv_setpvn_mg(SV *sv, const char *ptr, STRLEN len)
5803 Like C<sv_setpvn>, but takes a literal string instead of a string/length pair.
5805 void sv_setpvs(SV* sv, const char* s)
5808 Found in file handy.h
5813 Like C<sv_setpv>, but also handles 'set' magic.
5815 void sv_setpv_mg(SV *sv, const char *ptr)
5823 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
5824 argument will be upgraded to an RV. That RV will be modified to point to
5825 the new SV. The C<classname> argument indicates the package for the
5826 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
5827 will have a reference count of 1, and the RV will be returned.
5829 SV* sv_setref_iv(SV* rv, const char* classname, IV iv)
5837 Copies a double into a new SV, optionally blessing the SV. The C<rv>
5838 argument will be upgraded to an RV. That RV will be modified to point to
5839 the new SV. The C<classname> argument indicates the package for the
5840 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
5841 will have a reference count of 1, and the RV will be returned.
5843 SV* sv_setref_nv(SV* rv, const char* classname, NV nv)
5851 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
5852 argument will be upgraded to an RV. That RV will be modified to point to
5853 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
5854 into the SV. The C<classname> argument indicates the package for the
5855 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
5856 will have a reference count of 1, and the RV will be returned.
5858 Do not use with other Perl types such as HV, AV, SV, CV, because those
5859 objects will become corrupted by the pointer copy process.
5861 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
5863 SV* sv_setref_pv(SV* rv, const char* classname, void* pv)
5871 Copies a string into a new SV, optionally blessing the SV. The length of the
5872 string must be specified with C<n>. The C<rv> argument will be upgraded to
5873 an RV. That RV will be modified to point to the new SV. The C<classname>
5874 argument indicates the package for the blessing. Set C<classname> to
5875 C<NULL> to avoid the blessing. The new SV will have a reference count
5876 of 1, and the RV will be returned.
5878 Note that C<sv_setref_pv> copies the pointer while this copies the string.
5880 SV* sv_setref_pvn(SV* rv, const char* classname, const char* pv, STRLEN n)
5888 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
5889 argument will be upgraded to an RV. That RV will be modified to point to
5890 the new SV. The C<classname> argument indicates the package for the
5891 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
5892 will have a reference count of 1, and the RV will be returned.
5894 SV* sv_setref_uv(SV* rv, const char* classname, UV uv)
5902 Copies the contents of the source SV C<ssv> into the destination SV
5903 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
5904 function if the source SV needs to be reused. Does not handle 'set' magic.
5905 Loosely speaking, it performs a copy-by-value, obliterating any previous
5906 content of the destination.
5908 You probably want to use one of the assortment of wrappers, such as
5909 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
5910 C<SvSetMagicSV_nosteal>.
5912 void sv_setsv(SV* dsv, SV* ssv)
5917 =item sv_setsv_flags
5920 Copies the contents of the source SV C<ssv> into the destination SV
5921 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
5922 function if the source SV needs to be reused. Does not handle 'set' magic.
5923 Loosely speaking, it performs a copy-by-value, obliterating any previous
5924 content of the destination.
5925 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
5926 C<ssv> if appropriate, else not. If the C<flags> parameter has the
5927 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
5928 and C<sv_setsv_nomg> are implemented in terms of this function.
5930 You probably want to use one of the assortment of wrappers, such as
5931 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
5932 C<SvSetMagicSV_nosteal>.
5934 This is the primary function for copying scalars, and most other
5935 copy-ish functions and macros use this underneath.
5937 void sv_setsv_flags(SV* dsv, SV* ssv, I32 flags)
5945 Like C<sv_setsv>, but also handles 'set' magic.
5947 void sv_setsv_mg(SV *dstr, SV *sstr)
5955 Copies an unsigned integer into the given SV, upgrading first if necessary.
5956 Does not handle 'set' magic. See also C<sv_setuv_mg>.
5958 void sv_setuv(SV* sv, UV num)
5966 Like C<sv_setuv>, but also handles 'set' magic.
5968 void sv_setuv_mg(SV *sv, UV u)
5976 Test an SV for taintedness. Use C<SvTAINTED> instead.
5977 bool sv_tainted(SV* sv)
5985 Returns true if the SV has a true value by Perl's rules.
5986 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
5987 instead use an in-line version.
5997 Removes all magic of type C<type> from an SV.
5999 int sv_unmagic(SV* sv, int type)
6004 =item sv_unref_flags
6007 Unsets the RV status of the SV, and decrements the reference count of
6008 whatever was being referenced by the RV. This can almost be thought of
6009 as a reversal of C<newSVrv>. The C<cflags> argument can contain
6010 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
6011 (otherwise the decrementing is conditional on the reference count being
6012 different from one or the reference being a readonly SV).
6015 void sv_unref_flags(SV* sv, U32 flags)
6023 Untaint an SV. Use C<SvTAINTED_off> instead.
6024 void sv_untaint(SV* sv)
6032 Upgrade an SV to a more complex form. Generally adds a new body type to the
6033 SV, then copies across as much information as possible from the old body.
6034 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
6036 void sv_upgrade(SV* sv, svtype new_type)
6041 =item sv_usepvn_flags
6044 Tells an SV to use C<ptr> to find its string value. Normally the
6045 string is stored inside the SV but sv_usepvn allows the SV to use an
6046 outside string. The C<ptr> should point to memory that was allocated
6047 by C<malloc>. The string length, C<len>, must be supplied. By default
6048 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
6049 so that pointer should not be freed or used by the programmer after
6050 giving it to sv_usepvn, and neither should any pointers from "behind"
6051 that pointer (e.g. ptr + 1) be used.
6053 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
6054 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
6055 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
6056 C<len>, and already meets the requirements for storing in C<SvPVX>)
6058 void sv_usepvn_flags(SV* sv, char* ptr, STRLEN len, U32 flags)
6063 =item sv_utf8_decode
6066 If the PV of the SV is an octet sequence in UTF-8
6067 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
6068 so that it looks like a character. If the PV contains only single-byte
6069 characters, the C<SvUTF8> flag stays being off.
6070 Scans PV for validity and returns false if the PV is invalid UTF-8.
6072 NOTE: this function is experimental and may change or be
6073 removed without notice.
6075 bool sv_utf8_decode(SV *sv)
6080 =item sv_utf8_downgrade
6081 X<sv_utf8_downgrade>
6083 Attempts to convert the PV of an SV from characters to bytes.
6084 If the PV contains a character beyond byte, this conversion will fail;
6085 in this case, either returns false or, if C<fail_ok> is not
6088 This is not as a general purpose Unicode to byte encoding interface:
6089 use the Encode extension for that.
6091 NOTE: this function is experimental and may change or be
6092 removed without notice.
6094 bool sv_utf8_downgrade(SV *sv, bool fail_ok)
6099 =item sv_utf8_encode
6102 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
6103 flag off so that it looks like octets again.
6105 void sv_utf8_encode(SV *sv)
6110 =item sv_utf8_upgrade
6113 Converts the PV of an SV to its UTF-8-encoded form.
6114 Forces the SV to string form if it is not already.
6115 Always sets the SvUTF8 flag to avoid future validity checks even
6116 if all the bytes have hibit clear.
6118 This is not as a general purpose byte encoding to Unicode interface:
6119 use the Encode extension for that.
6121 STRLEN sv_utf8_upgrade(SV *sv)
6126 =item sv_utf8_upgrade_flags
6127 X<sv_utf8_upgrade_flags>
6129 Converts the PV of an SV to its UTF-8-encoded form.
6130 Forces the SV to string form if it is not already.
6131 Always sets the SvUTF8 flag to avoid future validity checks even
6132 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
6133 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
6134 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
6136 This is not as a general purpose byte encoding to Unicode interface:
6137 use the Encode extension for that.
6139 STRLEN sv_utf8_upgrade_flags(SV *sv, I32 flags)
6147 Processes its arguments like C<vsprintf> and appends the formatted output
6148 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
6150 Usually used via its frontend C<sv_catpvf>.
6152 void sv_vcatpvf(SV* sv, const char* pat, va_list* args)
6160 Processes its arguments like C<vsprintf> and appends the formatted output
6161 to an SV. Uses an array of SVs if the C style variable argument list is
6162 missing (NULL). When running with taint checks enabled, indicates via
6163 C<maybe_tainted> if results are untrustworthy (often due to the use of
6166 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
6168 void sv_vcatpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
6176 Like C<sv_vcatpvf>, but also handles 'set' magic.
6178 Usually used via its frontend C<sv_catpvf_mg>.
6180 void sv_vcatpvf_mg(SV* sv, const char* pat, va_list* args)
6188 Works like C<sv_vcatpvf> but copies the text into the SV instead of
6189 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
6191 Usually used via its frontend C<sv_setpvf>.
6193 void sv_vsetpvf(SV* sv, const char* pat, va_list* args)
6201 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
6204 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
6206 void sv_vsetpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
6214 Like C<sv_vsetpvf>, but also handles 'set' magic.
6216 Usually used via its frontend C<sv_setpvf_mg>.
6218 void sv_vsetpvf_mg(SV* sv, const char* pat, va_list* args)
6226 =head1 Unicode Support
6230 =item bytes_from_utf8
6233 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
6234 Unlike C<utf8_to_bytes> but like C<bytes_to_utf8>, returns a pointer to
6235 the newly-created string, and updates C<len> to contain the new
6236 length. Returns the original string if no conversion occurs, C<len>
6237 is unchanged. Do nothing if C<is_utf8> points to 0. Sets C<is_utf8> to
6238 0 if C<s> is converted or contains all 7bit characters.
6240 NOTE: this function is experimental and may change or be
6241 removed without notice.
6243 U8* bytes_from_utf8(const U8 *s, STRLEN *len, bool *is_utf8)
6246 Found in file utf8.c
6251 Converts a string C<s> of length C<len> from ASCII into UTF-8 encoding.
6252 Returns a pointer to the newly-created string, and sets C<len> to
6253 reflect the new length.
6255 If you want to convert to UTF-8 from other encodings than ASCII,
6256 see sv_recode_to_utf8().
6258 NOTE: this function is experimental and may change or be
6259 removed without notice.
6261 U8* bytes_to_utf8(const U8 *s, STRLEN *len)
6264 Found in file utf8.c
6269 Return true if the strings s1 and s2 differ case-insensitively, false
6270 if not (if they are equal case-insensitively). If u1 is true, the
6271 string s1 is assumed to be in UTF-8-encoded Unicode. If u2 is true,
6272 the string s2 is assumed to be in UTF-8-encoded Unicode. If u1 or u2
6273 are false, the respective string is assumed to be in native 8-bit
6276 If the pe1 and pe2 are non-NULL, the scanning pointers will be copied
6277 in there (they will point at the beginning of the I<next> character).
6278 If the pointers behind pe1 or pe2 are non-NULL, they are the end
6279 pointers beyond which scanning will not continue under any
6280 circumstances. If the byte lengths l1 and l2 are non-zero, s1+l1 and
6281 s2+l2 will be used as goal end pointers that will also stop the scan,
6282 and which qualify towards defining a successful match: all the scans
6283 that define an explicit length must reach their goal pointers for
6284 a match to succeed).
6286 For case-insensitiveness, the "casefolding" of Unicode is used
6287 instead of upper/lowercasing both the characters, see
6288 http://www.unicode.org/unicode/reports/tr21/ (Case Mappings).
6290 I32 ibcmp_utf8(const char* a, char **pe1, UV l1, bool u1, const char* b, char **pe2, UV l2, bool u2)
6293 Found in file utf8.c
6298 Tests if some arbitrary number of bytes begins in a valid UTF-8
6299 character. Note that an INVARIANT (i.e. ASCII) character is a valid
6300 UTF-8 character. The actual number of bytes in the UTF-8 character
6301 will be returned if it is valid, otherwise 0.
6303 STRLEN is_utf8_char(const U8 *p)
6306 Found in file utf8.c
6308 =item is_utf8_string
6311 Returns true if first C<len> bytes of the given string form a valid
6312 UTF-8 string, false otherwise. Note that 'a valid UTF-8 string' does
6313 not mean 'a string that contains code points above 0x7F encoded in UTF-8'
6314 because a valid ASCII string is a valid UTF-8 string.
6316 See also is_utf8_string_loclen() and is_utf8_string_loc().
6318 bool is_utf8_string(const U8 *s, STRLEN len)
6321 Found in file utf8.c
6323 =item is_utf8_string_loc
6324 X<is_utf8_string_loc>
6326 Like is_utf8_string() but stores the location of the failure (in the
6327 case of "utf8ness failure") or the location s+len (in the case of
6328 "utf8ness success") in the C<ep>.
6330 See also is_utf8_string_loclen() and is_utf8_string().
6332 bool is_utf8_string_loc(const U8 *s, STRLEN len, const U8 **p)
6335 Found in file utf8.c
6337 =item is_utf8_string_loclen
6338 X<is_utf8_string_loclen>
6340 Like is_utf8_string() but stores the location of the failure (in the
6341 case of "utf8ness failure") or the location s+len (in the case of
6342 "utf8ness success") in the C<ep>, and the number of UTF-8
6343 encoded characters in the C<el>.
6345 See also is_utf8_string_loc() and is_utf8_string().
6347 bool is_utf8_string_loclen(const U8 *s, STRLEN len, const U8 **ep, STRLEN *el)
6350 Found in file utf8.c
6352 =item pv_uni_display
6355 Build to the scalar dsv a displayable version of the string spv,
6356 length len, the displayable version being at most pvlim bytes long
6357 (if longer, the rest is truncated and "..." will be appended).
6359 The flags argument can have UNI_DISPLAY_ISPRINT set to display
6360 isPRINT()able characters as themselves, UNI_DISPLAY_BACKSLASH
6361 to display the \\[nrfta\\] as the backslashed versions (like '\n')
6362 (UNI_DISPLAY_BACKSLASH is preferred over UNI_DISPLAY_ISPRINT for \\).
6363 UNI_DISPLAY_QQ (and its alias UNI_DISPLAY_REGEX) have both
6364 UNI_DISPLAY_BACKSLASH and UNI_DISPLAY_ISPRINT turned on.
6366 The pointer to the PV of the dsv is returned.
6368 char* pv_uni_display(SV *dsv, const U8 *spv, STRLEN len, STRLEN pvlim, UV flags)
6371 Found in file utf8.c
6376 The encoding is assumed to be an Encode object, the PV of the ssv is
6377 assumed to be octets in that encoding and decoding the input starts
6378 from the position which (PV + *offset) pointed to. The dsv will be
6379 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
6380 when the string tstr appears in decoding output or the input ends on
6381 the PV of the ssv. The value which the offset points will be modified
6382 to the last input position on the ssv.
6384 Returns TRUE if the terminator was found, else returns FALSE.
6386 bool sv_cat_decode(SV* dsv, SV *encoding, SV *ssv, int *offset, char* tstr, int tlen)
6391 =item sv_recode_to_utf8
6392 X<sv_recode_to_utf8>
6394 The encoding is assumed to be an Encode object, on entry the PV
6395 of the sv is assumed to be octets in that encoding, and the sv
6396 will be converted into Unicode (and UTF-8).
6398 If the sv already is UTF-8 (or if it is not POK), or if the encoding
6399 is not a reference, nothing is done to the sv. If the encoding is not
6400 an C<Encode::XS> Encoding object, bad things will happen.
6401 (See F<lib/encoding.pm> and L<Encode>).
6403 The PV of the sv is returned.
6405 char* sv_recode_to_utf8(SV* sv, SV *encoding)
6410 =item sv_uni_display
6413 Build to the scalar dsv a displayable version of the scalar sv,
6414 the displayable version being at most pvlim bytes long
6415 (if longer, the rest is truncated and "..." will be appended).
6417 The flags argument is as in pv_uni_display().
6419 The pointer to the PV of the dsv is returned.
6421 char* sv_uni_display(SV *dsv, SV *ssv, STRLEN pvlim, UV flags)
6424 Found in file utf8.c
6429 The "p" contains the pointer to the UTF-8 string encoding
6430 the character that is being converted.
6432 The "ustrp" is a pointer to the character buffer to put the
6433 conversion result to. The "lenp" is a pointer to the length
6436 The "swashp" is a pointer to the swash to use.
6438 Both the special and normal mappings are stored lib/unicore/To/Foo.pl,
6439 and loaded by SWASHNEW, using lib/utf8_heavy.pl. The special (usually,
6440 but not always, a multicharacter mapping), is tried first.
6442 The "special" is a string like "utf8::ToSpecLower", which means the
6443 hash %utf8::ToSpecLower. The access to the hash is through
6444 Perl_to_utf8_case().
6446 The "normal" is a string like "ToLower" which means the swash
6449 UV to_utf8_case(const U8 *p, U8* ustrp, STRLEN *lenp, SV **swashp, const char *normal, const char *special)
6452 Found in file utf8.c
6457 Convert the UTF-8 encoded character at p to its foldcase version and
6458 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6459 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6460 foldcase version may be longer than the original character (up to
6463 The first character of the foldcased version is returned
6464 (but note, as explained above, that there may be more.)
6466 UV to_utf8_fold(const U8 *p, U8* ustrp, STRLEN *lenp)
6469 Found in file utf8.c
6474 Convert the UTF-8 encoded character at p to its lowercase version and
6475 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6476 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6477 lowercase version may be longer than the original character.
6479 The first character of the lowercased version is returned
6480 (but note, as explained above, that there may be more.)
6482 UV to_utf8_lower(const U8 *p, U8* ustrp, STRLEN *lenp)
6485 Found in file utf8.c
6490 Convert the UTF-8 encoded character at p to its titlecase version and
6491 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6492 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6493 titlecase version may be longer than the original character.
6495 The first character of the titlecased version is returned
6496 (but note, as explained above, that there may be more.)
6498 UV to_utf8_title(const U8 *p, U8* ustrp, STRLEN *lenp)
6501 Found in file utf8.c
6506 Convert the UTF-8 encoded character at p to its uppercase version and
6507 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6508 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since
6509 the uppercase version may be longer than the original character.
6511 The first character of the uppercased version is returned
6512 (but note, as explained above, that there may be more.)
6514 UV to_utf8_upper(const U8 *p, U8* ustrp, STRLEN *lenp)
6517 Found in file utf8.c
6519 =item utf8n_to_uvchr
6524 Returns the native character value of the first character in the string
6526 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6527 length, in bytes, of that character.
6529 Allows length and flags to be passed to low level routine.
6531 UV utf8n_to_uvchr(const U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags)
6534 Found in file utf8.c
6536 =item utf8n_to_uvuni
6539 Bottom level UTF-8 decode routine.
6540 Returns the unicode code point value of the first character in the string C<s>
6541 which is assumed to be in UTF-8 encoding and no longer than C<curlen>;
6542 C<retlen> will be set to the length, in bytes, of that character.
6544 If C<s> does not point to a well-formed UTF-8 character, the behaviour
6545 is dependent on the value of C<flags>: if it contains UTF8_CHECK_ONLY,
6546 it is assumed that the caller will raise a warning, and this function
6547 will silently just set C<retlen> to C<-1> and return zero. If the
6548 C<flags> does not contain UTF8_CHECK_ONLY, warnings about
6549 malformations will be given, C<retlen> will be set to the expected
6550 length of the UTF-8 character in bytes, and zero will be returned.
6552 The C<flags> can also contain various flags to allow deviations from
6553 the strict UTF-8 encoding (see F<utf8.h>).
6555 Most code should use utf8_to_uvchr() rather than call this directly.
6557 UV utf8n_to_uvuni(const U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags)
6560 Found in file utf8.c
6565 Returns the number of UTF-8 characters between the UTF-8 pointers C<a>
6568 WARNING: use only if you *know* that the pointers point inside the
6571 IV utf8_distance(const U8 *a, const U8 *b)
6574 Found in file utf8.c
6579 Return the UTF-8 pointer C<s> displaced by C<off> characters, either
6580 forward or backward.
6582 WARNING: do not use the following unless you *know* C<off> is within
6583 the UTF-8 data pointed to by C<s> *and* that on entry C<s> is aligned
6584 on the first byte of character or just after the last byte of a character.
6586 U8* utf8_hop(const U8 *s, I32 off)
6589 Found in file utf8.c
6594 Return the length of the UTF-8 char encoded string C<s> in characters.
6595 Stops at C<e> (inclusive). If C<e E<lt> s> or if the scan would end
6596 up past C<e>, croaks.
6598 STRLEN utf8_length(const U8* s, const U8 *e)
6601 Found in file utf8.c
6606 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
6607 Unlike C<bytes_to_utf8>, this over-writes the original string, and
6608 updates len to contain the new length.
6609 Returns zero on failure, setting C<len> to -1.
6611 If you need a copy of the string, see C<bytes_from_utf8>.
6613 NOTE: this function is experimental and may change or be
6614 removed without notice.
6616 U8* utf8_to_bytes(U8 *s, STRLEN *len)
6619 Found in file utf8.c
6624 Returns the native character value of the first character in the string C<s>
6625 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6626 length, in bytes, of that character.
6628 If C<s> does not point to a well-formed UTF-8 character, zero is
6629 returned and retlen is set, if possible, to -1.
6631 UV utf8_to_uvchr(const U8 *s, STRLEN *retlen)
6634 Found in file utf8.c
6639 Returns the Unicode code point of the first character in the string C<s>
6640 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6641 length, in bytes, of that character.
6643 This function should only be used when returned UV is considered
6644 an index into the Unicode semantic tables (e.g. swashes).
6646 If C<s> does not point to a well-formed UTF-8 character, zero is
6647 returned and retlen is set, if possible, to -1.
6649 UV utf8_to_uvuni(const U8 *s, STRLEN *retlen)
6652 Found in file utf8.c
6657 Adds the UTF-8 representation of the Native codepoint C<uv> to the end
6658 of the string C<d>; C<d> should be have at least C<UTF8_MAXBYTES+1> free
6659 bytes available. The return value is the pointer to the byte after the
6660 end of the new character. In other words,
6662 d = uvchr_to_utf8(d, uv);
6664 is the recommended wide native character-aware way of saying
6668 U8* uvchr_to_utf8(U8 *d, UV uv)
6671 Found in file utf8.c
6673 =item uvuni_to_utf8_flags
6674 X<uvuni_to_utf8_flags>
6676 Adds the UTF-8 representation of the Unicode codepoint C<uv> to the end
6677 of the string C<d>; C<d> should be have at least C<UTF8_MAXBYTES+1> free
6678 bytes available. The return value is the pointer to the byte after the
6679 end of the new character. In other words,
6681 d = uvuni_to_utf8_flags(d, uv, flags);
6685 d = uvuni_to_utf8(d, uv);
6687 (which is equivalent to)
6689 d = uvuni_to_utf8_flags(d, uv, 0);
6691 is the recommended Unicode-aware way of saying
6695 U8* uvuni_to_utf8_flags(U8 *d, UV uv, UV flags)
6698 Found in file utf8.c
6703 =head1 Variables created by C<xsubpp> and C<xsubpp> internal functions
6710 Variable which is setup by C<xsubpp> to indicate the stack base offset,
6711 used by the C<ST>, C<XSprePUSH> and C<XSRETURN> macros. The C<dMARK> macro
6712 must be called prior to setup the C<MARK> variable.
6717 Found in file XSUB.h
6722 Variable which is setup by C<xsubpp> to indicate the
6723 class name for a C++ XS constructor. This is always a C<char*>. See C<THIS>.
6728 Found in file XSUB.h
6733 Sets up the C<ax> variable.
6734 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
6739 Found in file XSUB.h
6744 Sets up the C<ax> variable and stack marker variable C<mark>.
6745 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
6750 Found in file XSUB.h
6755 Sets up the C<items> variable.
6756 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
6761 Found in file XSUB.h
6766 Sets up the C<padoff_du> variable for an XSUB that wishes to use
6772 Found in file XSUB.h
6777 Sets up stack and mark pointers for an XSUB, calling dSP and dMARK.
6778 Sets up the C<ax> and C<items> variables by calling C<dAX> and C<dITEMS>.
6779 This is usually handled automatically by C<xsubpp>.
6784 Found in file XSUB.h
6789 Sets up the C<ix> variable for an XSUB which has aliases. This is usually
6790 handled automatically by C<xsubpp>.
6795 Found in file XSUB.h
6800 Variable which is setup by C<xsubpp> to indicate the number of
6801 items on the stack. See L<perlxs/"Variable-length Parameter Lists">.
6806 Found in file XSUB.h
6811 Variable which is setup by C<xsubpp> to indicate which of an
6812 XSUB's aliases was used to invoke it. See L<perlxs/"The ALIAS: Keyword">.
6817 Found in file XSUB.h
6822 Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
6826 Found in file XSUB.h
6831 Variable which is setup by C<xsubpp> to hold the return value for an
6832 XSUB. This is always the proper type for the XSUB. See
6833 L<perlxs/"The RETVAL Variable">.
6838 Found in file XSUB.h
6843 Used to access elements on the XSUB's stack.
6848 Found in file XSUB.h
6853 Variable which is setup by C<xsubpp> to designate the object in a C++
6854 XSUB. This is always the proper type for the C++ object. See C<CLASS> and
6855 L<perlxs/"Using XS With C++">.
6860 Found in file XSUB.h
6865 The SV* corresponding to the $_ variable. Works even if there
6866 is a lexical $_ in scope.
6869 Found in file XSUB.h
6874 Macro to declare an XSUB and its C parameter list. This is handled by
6878 Found in file XSUB.h
6883 The version identifier for an XS module. This is usually
6884 handled automatically by C<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>.
6887 Found in file XSUB.h
6889 =item XS_VERSION_BOOTCHECK
6890 X<XS_VERSION_BOOTCHECK>
6892 Macro to verify that a PM module's $VERSION variable matches the XS
6893 module's C<XS_VERSION> variable. This is usually handled automatically by
6894 C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">.
6896 XS_VERSION_BOOTCHECK;
6899 Found in file XSUB.h
6904 =head1 Warning and Dieing
6911 This is the XSUB-writer's interface to Perl's C<die> function.
6912 Normally call this function the same way you call the C C<printf>
6913 function. Calling C<croak> returns control directly to Perl,
6914 sidestepping the normal C order of execution. See C<warn>.
6916 If you want to throw an exception object, assign the object to
6917 C<$@> and then pass C<NULL> to croak():
6919 errsv = get_sv("@", TRUE);
6920 sv_setsv(errsv, exception_object);
6923 void croak(const char* pat, ...)
6926 Found in file util.c
6931 This is the XSUB-writer's interface to Perl's C<warn> function. Call this
6932 function the same way you call the C C<printf> function. See C<croak>.
6934 void warn(const char* pat, ...)
6937 Found in file util.c
6944 Until May 1997, this document was maintained by Jeff Okamoto
6945 <okamoto@corp.hp.com>. It is now maintained as part of Perl itself.
6947 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
6948 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
6949 Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
6950 Stephen McCamant, and Gurusamy Sarathy.
6952 API Listing originally by Dean Roehrich <roehrich@cray.com>.
6954 Updated to be autogenerated from comments in the source by Benjamin Stuhl.
6958 perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
projects / p5sagit/p5-mst-13.2.git / blob