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)
137 =item av_create_and_push
138 X<av_create_and_push>
140 Push an SV onto the end of the array, creating the array if necessary.
141 A small internal helper function to remove a commonly duplicated idiom.
143 NOTE: this function is experimental and may change or be
144 removed without notice.
146 void av_create_and_push(AV **const avp, SV *const val)
151 =item av_create_and_unshift_one
152 X<av_create_and_unshift_one>
154 Unshifts an SV onto the beginning of the array, creating the array if
156 A small internal helper function to remove a commonly duplicated idiom.
158 NOTE: this function is experimental and may change or be
159 removed without notice.
161 SV** av_create_and_unshift_one(AV **const avp, SV *const val)
169 Deletes the element indexed by C<key> from the array. Returns the
170 deleted element. If C<flags> equals C<G_DISCARD>, the element is freed
171 and null is returned.
173 SV* av_delete(AV* ar, I32 key, I32 flags)
181 Returns true if the element indexed by C<key> has been initialized.
183 This relies on the fact that uninitialized array elements are set to
186 bool av_exists(AV* ar, I32 key)
194 Pre-extend an array. The C<key> is the index to which the array should be
197 void av_extend(AV* ar, I32 key)
205 Returns the SV at the specified index in the array. The C<key> is the
206 index. If C<lval> is set then the fetch will be part of a store. Check
207 that the return value is non-null before dereferencing it to a C<SV*>.
209 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for
210 more information on how to use this function on tied arrays.
212 SV** av_fetch(AV* ar, I32 key, I32 lval)
220 Set the highest index in the array to the given number, equivalent to
221 Perl's C<$#array = $fill;>.
223 The number of elements in the an array will be C<fill + 1> after
224 av_fill() returns. If the array was previously shorter then the
225 additional elements appended are set to C<PL_sv_undef>. If the array
226 was longer, then the excess elements are freed. C<av_fill(av, -1)> is
227 the same as C<av_clear(av)>.
229 void av_fill(AV* ar, I32 fill)
237 Returns the highest index in the array. The number of elements in the
238 array is C<av_len(av) + 1>. Returns -1 if the array is empty.
240 I32 av_len(const AV* ar)
248 Creates a new AV and populates it with a list of SVs. The SVs are copied
249 into the array, so they may be freed after the call to av_make. The new AV
250 will have a reference count of 1.
252 AV* av_make(I32 size, SV** svp)
260 Pops an SV off the end of the array. Returns C<&PL_sv_undef> if the array
271 Pushes an SV onto the end of the array. The array will grow automatically
272 to accommodate the addition.
274 void av_push(AV* ar, SV* val)
282 Shifts an SV off the beginning of the array.
292 Stores an SV in an array. The array index is specified as C<key>. The
293 return value will be NULL if the operation failed or if the value did not
294 need to be actually stored within the array (as in the case of tied
295 arrays). Otherwise it can be dereferenced to get the original C<SV*>. Note
296 that the caller is responsible for suitably incrementing the reference
297 count of C<val> before the call, and decrementing it if the function
300 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for
301 more information on how to use this function on tied arrays.
303 SV** av_store(AV* ar, I32 key, SV* val)
311 Undefines the array. Frees the memory used by the array itself.
313 void av_undef(AV* ar)
321 Unshift the given number of C<undef> values onto the beginning of the
322 array. The array will grow automatically to accommodate the addition. You
323 must then use C<av_store> to assign values to these new elements.
325 void av_unshift(AV* ar, I32 num)
333 Returns the AV of the specified Perl array. If C<create> is set and the
334 Perl variable does not exist then it will be created. If C<create> is not
335 set and the variable does not exist then NULL is returned.
337 NOTE: the perl_ form of this function is deprecated.
339 AV* get_av(const char* name, I32 create)
347 Creates a new AV. The reference count is set to 1.
357 Sort an array. Here is an example:
359 sortsv(AvARRAY(av), av_len(av)+1, Perl_sv_cmp_locale);
361 Currently this always uses mergesort. See sortsv_flags for a more
364 void sortsv(SV** array, size_t num_elts, SVCOMPARE_t cmp)
367 Found in file pp_sort.c
372 Sort an array, with various options.
374 void sortsv_flags(SV** array, size_t num_elts, SVCOMPARE_t cmp, U32 flags)
377 Found in file pp_sort.c
382 =head1 Callback Functions
389 Performs a callback to the specified Perl sub. See L<perlcall>.
391 NOTE: the perl_ form of this function is deprecated.
393 I32 call_argv(const char* sub_name, I32 flags, char** argv)
401 Performs a callback to the specified Perl method. The blessed object must
402 be on the stack. See L<perlcall>.
404 NOTE: the perl_ form of this function is deprecated.
406 I32 call_method(const char* methname, I32 flags)
414 Performs a callback to the specified Perl sub. See L<perlcall>.
416 NOTE: the perl_ form of this function is deprecated.
418 I32 call_pv(const char* sub_name, I32 flags)
426 Performs a callback to the Perl sub whose name is in the SV. See
429 NOTE: the perl_ form of this function is deprecated.
431 I32 call_sv(SV* sv, I32 flags)
439 Opening bracket on a callback. See C<LEAVE> and L<perlcall>.
444 Found in file scope.h
449 Tells Perl to C<eval> the given string and return an SV* result.
451 NOTE: the perl_ form of this function is deprecated.
453 SV* eval_pv(const char* p, I32 croak_on_error)
461 Tells Perl to C<eval> the string in the SV.
463 NOTE: the perl_ form of this function is deprecated.
465 I32 eval_sv(SV* sv, I32 flags)
473 Closing bracket for temporaries on a callback. See C<SAVETMPS> and
479 Found in file scope.h
484 Closing bracket on a callback. See C<ENTER> and L<perlcall>.
489 Found in file scope.h
494 Opening bracket for temporaries on a callback. See C<FREETMPS> and
500 Found in file scope.h
505 =head1 Character classes
512 Returns a boolean indicating whether the C C<char> is an ASCII alphanumeric
513 character (including underscore) or digit.
515 bool isALNUM(char ch)
518 Found in file handy.h
523 Returns a boolean indicating whether the C C<char> is an ASCII alphabetic
526 bool isALPHA(char ch)
529 Found in file handy.h
534 Returns a boolean indicating whether the C C<char> is an ASCII
537 bool isDIGIT(char ch)
540 Found in file handy.h
545 Returns a boolean indicating whether the C C<char> is a lowercase
548 bool isLOWER(char ch)
551 Found in file handy.h
556 Returns a boolean indicating whether the C C<char> is whitespace.
558 bool isSPACE(char ch)
561 Found in file handy.h
566 Returns a boolean indicating whether the C C<char> is an uppercase
569 bool isUPPER(char ch)
572 Found in file handy.h
577 Converts the specified character to lowercase.
579 char toLOWER(char ch)
582 Found in file handy.h
587 Converts the specified character to uppercase.
589 char toUPPER(char ch)
592 Found in file handy.h
597 =head1 Cloning an interpreter
604 Create and return a new interpreter by cloning the current one.
606 perl_clone takes these flags as parameters:
608 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
609 without it we only clone the data and zero the stacks,
610 with it we copy the stacks and the new perl interpreter is
611 ready to run at the exact same point as the previous one.
612 The pseudo-fork code uses COPY_STACKS while the
613 threads->create doesn't.
615 CLONEf_KEEP_PTR_TABLE
616 perl_clone keeps a ptr_table with the pointer of the old
617 variable as a key and the new variable as a value,
618 this allows it to check if something has been cloned and not
619 clone it again but rather just use the value and increase the
620 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
621 the ptr_table using the function
622 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
623 reason to keep it around is if you want to dup some of your own
624 variable who are outside the graph perl scans, example of this
625 code is in threads.xs create
628 This is a win32 thing, it is ignored on unix, it tells perls
629 win32host code (which is c++) to clone itself, this is needed on
630 win32 if you want to run two threads at the same time,
631 if you just want to do some stuff in a separate perl interpreter
632 and then throw it away and return to the original one,
633 you don't need to do anything.
635 PerlInterpreter* perl_clone(PerlInterpreter* interp, UV flags)
643 =head1 CV Manipulation Functions
650 Returns the stash of the CV.
660 Uses C<strlen> to get the length of C<name>, then calls C<get_cvn_flags>.
662 NOTE: the perl_ form of this function is deprecated.
664 CV* get_cv(const char* name, I32 flags)
672 Returns the CV of the specified Perl subroutine. C<flags> are passed to
673 C<gv_fetchpvn_flags>. If C<GV_ADD> is set and the Perl subroutine does not
674 exist then it will be declared (which has the same effect as saying
675 C<sub name;>). If C<GV_ADD> is not set and the subroutine does not exist
676 then NULL is returned.
678 NOTE: the perl_ form of this function is deprecated.
680 CV* get_cvn_flags(const char* name, STRLEN len, I32 flags)
688 =head1 Embedding Functions
695 Clear out all the active components of a CV. This can happen either
696 by an explicit C<undef &foo>, or by the reference count going to zero.
697 In the former case, we keep the CvOUTSIDE pointer, so that any anonymous
698 children can still follow the full lexical scope chain.
700 void cv_undef(CV* cv)
708 Loads the module whose name is pointed to by the string part of name.
709 Note that the actual module name, not its filename, should be given.
710 Eg, "Foo::Bar" instead of "Foo/Bar.pm". flags can be any of
711 PERL_LOADMOD_DENY, PERL_LOADMOD_NOIMPORT, or PERL_LOADMOD_IMPORT_OPS
712 (or 0 for no flags). ver, if specified, provides version semantics
713 similar to C<use Foo::Bar VERSION>. The optional trailing SV*
714 arguments can be used to specify arguments to the module's import()
715 method, similar to C<use Foo::Bar VERSION LIST>.
717 void load_module(U32 flags, SV* name, SV* ver, ...)
725 Stub that provides thread hook for perl_destruct when there are
736 Allocates a new Perl interpreter. See L<perlembed>.
738 PerlInterpreter* perl_alloc()
746 Initializes a new Perl interpreter. See L<perlembed>.
748 void perl_construct(PerlInterpreter* interp)
756 Shuts down a Perl interpreter. See L<perlembed>.
758 int perl_destruct(PerlInterpreter* interp)
766 Releases a Perl interpreter. See L<perlembed>.
768 void perl_free(PerlInterpreter* interp)
776 Tells a Perl interpreter to parse a Perl script. See L<perlembed>.
778 int perl_parse(PerlInterpreter* interp, XSINIT_t xsinit, int argc, char** argv, char** env)
786 Tells a Perl interpreter to run. See L<perlembed>.
788 int perl_run(PerlInterpreter* interp)
796 Tells Perl to C<require> the file named by the string argument. It is
797 analogous to the Perl code C<eval "require '$file'">. It's even
798 implemented that way; consider using load_module instead.
800 NOTE: the perl_ form of this function is deprecated.
802 void require_pv(const char* pv)
810 =head1 Functions in file dump.c
818 char *pv_display(SV *dsv, const char *pv, STRLEN cur, STRLEN len,
819 STRLEN pvlim, U32 flags)
823 pv_escape(dsv,pv,cur,pvlim,PERL_PV_ESCAPE_QUOTE);
825 except that an additional "\0" will be appended to the string when
826 len > cur and pv[cur] is "\0".
828 Note that the final string may be up to 7 chars longer than pvlim.
830 char* pv_display(SV *dsv, const char *pv, STRLEN cur, STRLEN len, STRLEN pvlim)
838 |const STRLEN count|const STRLEN max
839 |STRLEN const *escaped, const U32 flags
841 Escapes at most the first "count" chars of pv and puts the results into
842 dsv such that the size of the escaped string will not exceed "max" chars
843 and will not contain any incomplete escape sequences.
845 If flags contains PERL_PV_ESCAPE_QUOTE then any double quotes in the string
846 will also be escaped.
848 Normally the SV will be cleared before the escaped string is prepared,
849 but when PERL_PV_ESCAPE_NOCLEAR is set this will not occur.
851 If PERL_PV_ESCAPE_UNI is set then the input string is treated as Unicode,
852 if PERL_PV_ESCAPE_UNI_DETECT is set then the input string is scanned
853 using C<is_utf8_string()> to determine if it is Unicode.
855 If PERL_PV_ESCAPE_ALL is set then all input chars will be output
856 using C<\x01F1> style escapes, otherwise only chars above 255 will be
857 escaped using this style, other non printable chars will use octal or
858 common escaped patterns like C<\n>. If PERL_PV_ESCAPE_NOBACKSLASH
859 then all chars below 255 will be treated as printable and
860 will be output as literals.
862 If PERL_PV_ESCAPE_FIRSTCHAR is set then only the first char of the
863 string will be escaped, regardles of max. If the string is utf8 and
864 the chars value is >255 then it will be returned as a plain hex
865 sequence. Thus the output will either be a single char,
866 an octal escape sequence, a special escape like C<\n> or a 3 or
867 more digit hex value.
869 If PERL_PV_ESCAPE_RE is set then the escape char used will be a '%' and
870 not a '\\'. This is because regexes very often contain backslashed
871 sequences, whereas '%' is not a particularly common character in patterns.
873 Returns a pointer to the escaped text as held by dsv.
875 NOTE: the perl_ form of this function is deprecated.
877 char* pv_escape(SV *dsv, char const * const str, const STRLEN count, const STRLEN max, STRLEN * const escaped, const U32 flags)
885 |const STRLEN count|const STRLEN max\
886 |const char const *start_color| const char const *end_color\
889 Converts a string into something presentable, handling escaping via
890 pv_escape() and supporting quoting and elipses.
892 If the PERL_PV_PRETTY_QUOTE flag is set then the result will be
893 double quoted with any double quotes in the string escaped. Otherwise
894 if the PERL_PV_PRETTY_LTGT flag is set then the result be wrapped in
897 If the PERL_PV_PRETTY_ELIPSES flag is set and not all characters in
898 string were output then an elipses C<...> will be appended to the
899 string. Note that this happens AFTER it has been quoted.
901 If start_color is non-null then it will be inserted after the opening
902 quote (if there is one) but before the escaped text. If end_color
903 is non-null then it will be inserted after the escaped text but before
904 any quotes or elipses.
906 Returns a pointer to the prettified text as held by dsv.
908 NOTE: the perl_ form of this function is deprecated.
910 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)
918 =head1 Functions in file mathoms.c
926 See L<gv_fetchmethod_autoload>.
928 GV* gv_fetchmethod(HV* stash, const char* name)
931 Found in file mathoms.c
936 The engine implementing pack() Perl function. Note: parameters next_in_list and
937 flags are not used. This call should not be used; use packlist instead.
939 void pack_cat(SV *cat, const char *pat, const char *patend, SV **beglist, SV **endlist, SV ***next_in_list, U32 flags)
942 Found in file mathoms.c
944 =item sv_2pvbyte_nolen
947 Return a pointer to the byte-encoded representation of the SV.
948 May cause the SV to be downgraded from UTF-8 as a side-effect.
950 Usually accessed via the C<SvPVbyte_nolen> macro.
952 char* sv_2pvbyte_nolen(SV* sv)
955 Found in file mathoms.c
957 =item sv_2pvutf8_nolen
960 Return a pointer to the UTF-8-encoded representation of the SV.
961 May cause the SV to be upgraded to UTF-8 as a side-effect.
963 Usually accessed via the C<SvPVutf8_nolen> macro.
965 char* sv_2pvutf8_nolen(SV* sv)
968 Found in file mathoms.c
973 Like C<sv_2pv()>, but doesn't return the length too. You should usually
974 use the macro wrapper C<SvPV_nolen(sv)> instead.
975 char* sv_2pv_nolen(SV* sv)
978 Found in file mathoms.c
983 Like C<sv_catpvn>, but also handles 'set' magic.
985 void sv_catpvn_mg(SV *sv, const char *ptr, STRLEN len)
988 Found in file mathoms.c
993 Like C<sv_catsv>, but also handles 'set' magic.
995 void sv_catsv_mg(SV *dstr, SV *sstr)
998 Found in file mathoms.c
1000 =item sv_force_normal
1003 Undo various types of fakery on an SV: if the PV is a shared string, make
1004 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
1005 an xpvmg. See also C<sv_force_normal_flags>.
1007 void sv_force_normal(SV *sv)
1010 Found in file mathoms.c
1015 A private implementation of the C<SvIVx> macro for compilers which can't
1016 cope with complex macro expressions. Always use the macro instead.
1021 Found in file mathoms.c
1026 Dummy routine which "locks" an SV when there is no locking module present.
1027 Exists to avoid test for a NULL function pointer and because it could
1028 potentially warn under some level of strict-ness.
1030 "Superseded" by sv_nosharing().
1032 void sv_nolocking(SV *sv)
1035 Found in file mathoms.c
1037 =item sv_nounlocking
1040 Dummy routine which "unlocks" an SV when there is no locking module present.
1041 Exists to avoid test for a NULL function pointer and because it could
1042 potentially warn under some level of strict-ness.
1044 "Superseded" by sv_nosharing().
1046 void sv_nounlocking(SV *sv)
1049 Found in file mathoms.c
1054 A private implementation of the C<SvNVx> macro for compilers which can't
1055 cope with complex macro expressions. Always use the macro instead.
1060 Found in file mathoms.c
1065 Use the C<SvPV_nolen> macro instead
1070 Found in file mathoms.c
1075 Use C<SvPVbyte_nolen> instead.
1077 char* sv_pvbyte(SV *sv)
1080 Found in file mathoms.c
1085 A private implementation of the C<SvPVbyte> macro for compilers
1086 which can't cope with complex macro expressions. Always use the macro
1089 char* sv_pvbyten(SV *sv, STRLEN *len)
1092 Found in file mathoms.c
1097 A private implementation of the C<SvPV> macro for compilers which can't
1098 cope with complex macro expressions. Always use the macro instead.
1100 char* sv_pvn(SV *sv, STRLEN *len)
1103 Found in file mathoms.c
1108 Use the C<SvPVutf8_nolen> macro instead
1110 char* sv_pvutf8(SV *sv)
1113 Found in file mathoms.c
1118 A private implementation of the C<SvPVutf8> macro for compilers
1119 which can't cope with complex macro expressions. Always use the macro
1122 char* sv_pvutf8n(SV *sv, STRLEN *len)
1125 Found in file mathoms.c
1130 Taint an SV. Use C<SvTAINTED_on> instead.
1131 void sv_taint(SV* sv)
1134 Found in file mathoms.c
1139 Unsets the RV status of the SV, and decrements the reference count of
1140 whatever was being referenced by the RV. This can almost be thought of
1141 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
1142 being zero. See C<SvROK_off>.
1144 void sv_unref(SV* sv)
1147 Found in file mathoms.c
1152 Tells an SV to use C<ptr> to find its string value. Implemented by
1153 calling C<sv_usepvn_flags> with C<flags> of 0, hence does not handle 'set'
1154 magic. See C<sv_usepvn_flags>.
1156 void sv_usepvn(SV* sv, char* ptr, STRLEN len)
1159 Found in file mathoms.c
1164 Like C<sv_usepvn>, but also handles 'set' magic.
1166 void sv_usepvn_mg(SV *sv, char *ptr, STRLEN len)
1169 Found in file mathoms.c
1174 A private implementation of the C<SvUVx> macro for compilers which can't
1175 cope with complex macro expressions. Always use the macro instead.
1180 Found in file mathoms.c
1185 The engine implementing unpack() Perl function. Note: parameters strbeg, new_s
1186 and ocnt are not used. This call should not be used, use unpackstring instead.
1188 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)
1191 Found in file mathoms.c
1196 =head1 Functions in file pp_pack.c
1204 The engine implementing pack() Perl function.
1206 void packlist(SV *cat, const char *pat, const char *patend, SV **beglist, SV **endlist)
1209 Found in file pp_pack.c
1214 The engine implementing unpack() Perl function. C<unpackstring> puts the
1215 extracted list items on the stack and returns the number of elements.
1216 Issue C<PUTBACK> before and C<SPAGAIN> after the call to this function.
1218 I32 unpackstring(const char *pat, const char *patend, const char *s, const char *strend, U32 flags)
1221 Found in file pp_pack.c
1233 Return the SV from the GV.
1243 If C<gv> is a typeglob whose subroutine entry is a constant sub eligible for
1244 inlining, or C<gv> is a placeholder reference that would be promoted to such
1245 a typeglob, then returns the value returned by the sub. Otherwise, returns
1248 SV* gv_const_sv(GV* gv)
1256 Returns the glob with the given C<name> and a defined subroutine or
1257 C<NULL>. The glob lives in the given C<stash>, or in the stashes
1258 accessible via @ISA and UNIVERSAL::.
1260 The argument C<level> should be either 0 or -1. If C<level==0>, as a
1261 side-effect creates a glob with the given C<name> in the given C<stash>
1262 which in the case of success contains an alias for the subroutine, and sets
1263 up caching info for this glob.
1265 This function grants C<"SUPER"> token as a postfix of the stash name. The
1266 GV returned from C<gv_fetchmeth> may be a method cache entry, which is not
1267 visible to Perl code. So when calling C<call_sv>, you should not use
1268 the GV directly; instead, you should use the method's CV, which can be
1269 obtained from the GV with the C<GvCV> macro.
1271 GV* gv_fetchmeth(HV* stash, const char* name, STRLEN len, I32 level)
1276 =item gv_fetchmethod_autoload
1277 X<gv_fetchmethod_autoload>
1279 Returns the glob which contains the subroutine to call to invoke the method
1280 on the C<stash>. In fact in the presence of autoloading this may be the
1281 glob for "AUTOLOAD". In this case the corresponding variable $AUTOLOAD is
1284 The third parameter of C<gv_fetchmethod_autoload> determines whether
1285 AUTOLOAD lookup is performed if the given method is not present: non-zero
1286 means yes, look for AUTOLOAD; zero means no, don't look for AUTOLOAD.
1287 Calling C<gv_fetchmethod> is equivalent to calling C<gv_fetchmethod_autoload>
1288 with a non-zero C<autoload> parameter.
1290 These functions grant C<"SUPER"> token as a prefix of the method name. Note
1291 that if you want to keep the returned glob for a long time, you need to
1292 check for it being "AUTOLOAD", since at the later time the call may load a
1293 different subroutine due to $AUTOLOAD changing its value. Use the glob
1294 created via a side effect to do this.
1296 These functions have the same side-effects and as C<gv_fetchmeth> with
1297 C<level==0>. C<name> should be writable if contains C<':'> or C<'
1298 ''>. The warning against passing the GV returned by C<gv_fetchmeth> to
1299 C<call_sv> apply equally to these functions.
1301 GV* gv_fetchmethod_autoload(HV* stash, const char* name, I32 autoload)
1306 =item gv_fetchmeth_autoload
1307 X<gv_fetchmeth_autoload>
1309 Same as gv_fetchmeth(), but looks for autoloaded subroutines too.
1310 Returns a glob for the subroutine.
1312 For an autoloaded subroutine without a GV, will create a GV even
1313 if C<level < 0>. For an autoloaded subroutine without a stub, GvCV()
1314 of the result may be zero.
1316 GV* gv_fetchmeth_autoload(HV* stash, const char* name, STRLEN len, I32 level)
1324 Returns a pointer to the stash for a specified package. Uses C<strlen> to
1325 determine the length of C<name>, then calls C<gv_stashpvn()>.
1327 HV* gv_stashpv(const char* name, I32 flags)
1335 Returns a pointer to the stash for a specified package. The C<namelen>
1336 parameter indicates the length of the C<name>, in bytes. C<flags> is passed
1337 to C<gv_fetchpvn_flags()>, so if set to C<GV_ADD> then the package will be
1338 created if it does not already exist. If the package does not exist and
1339 C<flags> is 0 (or any other setting that does not create packages) then NULL
1343 HV* gv_stashpvn(const char* name, U32 namelen, I32 flags)
1351 Like C<gv_stashpvn>, but takes a literal string instead of a string/length pair.
1353 HV* gv_stashpvs(const char* name, I32 create)
1356 Found in file handy.h
1361 Returns a pointer to the stash for a specified package. See C<gv_stashpvn>.
1363 HV* gv_stashsv(SV* sv, I32 flags)
1386 Null character pointer.
1389 Found in file handy.h
1413 Found in file handy.h
1418 =head1 Hash Manipulation Functions
1425 Returns the HV of the specified Perl hash. If C<create> is set and the
1426 Perl variable does not exist then it will be created. If C<create> is not
1427 set and the variable does not exist then NULL is returned.
1429 NOTE: the perl_ form of this function is deprecated.
1431 HV* get_hv(const char* name, I32 create)
1434 Found in file perl.c
1439 This flag, used in the length slot of hash entries and magic structures,
1440 specifies the structure contains an C<SV*> pointer where a C<char*> pointer
1441 is to be expected. (For information only--not to be used).
1449 Returns the computed hash stored in the hash entry.
1459 Returns the actual pointer stored in the key slot of the hash entry. The
1460 pointer may be either C<char*> or C<SV*>, depending on the value of
1461 C<HeKLEN()>. Can be assigned to. The C<HePV()> or C<HeSVKEY()> macros are
1462 usually preferable for finding the value of a key.
1472 If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry
1473 holds an C<SV*> key. Otherwise, holds the actual length of the key. Can
1474 be assigned to. The C<HePV()> macro is usually preferable for finding key
1477 STRLEN HeKLEN(HE* he)
1485 Returns the key slot of the hash entry as a C<char*> value, doing any
1486 necessary dereferencing of possibly C<SV*> keys. The length of the string
1487 is placed in C<len> (this is a macro, so do I<not> use C<&len>). If you do
1488 not care about what the length of the key is, you may use the global
1489 variable C<PL_na>, though this is rather less efficient than using a local
1490 variable. Remember though, that hash keys in perl are free to contain
1491 embedded nulls, so using C<strlen()> or similar is not a good way to find
1492 the length of hash keys. This is very similar to the C<SvPV()> macro
1493 described elsewhere in this document.
1495 char* HePV(HE* he, STRLEN len)
1503 Returns the key as an C<SV*>, or C<NULL> if the hash entry does not
1504 contain an C<SV*> key.
1514 Returns the key as an C<SV*>. Will create and return a temporary mortal
1515 C<SV*> if the hash entry contains only a C<char*> key.
1517 SV* HeSVKEY_force(HE* he)
1525 Sets the key to a given C<SV*>, taking care to set the appropriate flags to
1526 indicate the presence of an C<SV*> key, and returns the same
1529 SV* HeSVKEY_set(HE* he, SV* sv)
1537 Returns the value slot (type C<SV*>) stored in the hash entry.
1547 Returns the package name of a stash, or NULL if C<stash> isn't a stash.
1548 See C<SvSTASH>, C<CvSTASH>.
1550 char* HvNAME(HV* stash)
1558 Check that a hash is in an internally consistent state.
1560 void hv_assert(HV* tb)
1568 Clears a hash, making it empty.
1570 void hv_clear(HV* tb)
1575 =item hv_clear_placeholders
1576 X<hv_clear_placeholders>
1578 Clears any placeholders from a hash. If a restricted hash has any of its keys
1579 marked as readonly and the key is subsequently deleted, the key is not actually
1580 deleted but is marked by assigning it a value of &PL_sv_placeholder. This tags
1581 it so it will be ignored by future operations such as iterating over the hash,
1582 but will still allow the hash to have a value reassigned to the key at some
1583 future point. This function clears any such placeholder keys from the hash.
1584 See Hash::Util::lock_keys() for an example of its use.
1586 void hv_clear_placeholders(HV* hb)
1594 Deletes a key/value pair in the hash. The value SV is removed from the
1595 hash and returned to the caller. The C<klen> is the length of the key.
1596 The C<flags> value will normally be zero; if set to G_DISCARD then NULL
1599 SV* hv_delete(HV* tb, const char* key, I32 klen, I32 flags)
1607 Deletes a key/value pair in the hash. The value SV is removed from the
1608 hash and returned to the caller. The C<flags> value will normally be zero;
1609 if set to G_DISCARD then NULL will be returned. C<hash> can be a valid
1610 precomputed hash value, or 0 to ask for it to be computed.
1612 SV* hv_delete_ent(HV* tb, SV* key, I32 flags, U32 hash)
1620 Returns a boolean indicating whether the specified hash key exists. The
1621 C<klen> is the length of the key.
1623 bool hv_exists(HV* tb, const char* key, I32 klen)
1631 Returns a boolean indicating whether the specified hash key exists. C<hash>
1632 can be a valid precomputed hash value, or 0 to ask for it to be
1635 bool hv_exists_ent(HV* tb, SV* key, U32 hash)
1643 Returns the SV which corresponds to the specified key in the hash. The
1644 C<klen> is the length of the key. If C<lval> is set then the fetch will be
1645 part of a store. Check that the return value is non-null before
1646 dereferencing it to an C<SV*>.
1648 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1649 information on how to use this function on tied hashes.
1651 SV** hv_fetch(HV* tb, const char* key, I32 klen, I32 lval)
1659 Like C<hv_fetch>, but takes a literal string instead of a string/length pair.
1661 SV** hv_fetchs(HV* tb, const char* key, I32 lval)
1664 Found in file handy.h
1669 Returns the hash entry which corresponds to the specified key in the hash.
1670 C<hash> must be a valid precomputed hash number for the given C<key>, or 0
1671 if you want the function to compute it. IF C<lval> is set then the fetch
1672 will be part of a store. Make sure the return value is non-null before
1673 accessing it. The return value when C<tb> is a tied hash is a pointer to a
1674 static location, so be sure to make a copy of the structure if you need to
1677 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1678 information on how to use this function on tied hashes.
1680 HE* hv_fetch_ent(HV* tb, SV* key, I32 lval, U32 hash)
1688 Prepares a starting point to traverse a hash table. Returns the number of
1689 keys in the hash (i.e. the same as C<HvKEYS(tb)>). The return value is
1690 currently only meaningful for hashes without tie magic.
1692 NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
1693 hash buckets that happen to be in use. If you still need that esoteric
1694 value, you can get it through the macro C<HvFILL(tb)>.
1697 I32 hv_iterinit(HV* tb)
1705 Returns the key from the current position of the hash iterator. See
1708 char* hv_iterkey(HE* entry, I32* retlen)
1716 Returns the key as an C<SV*> from the current position of the hash
1717 iterator. The return value will always be a mortal copy of the key. Also
1720 SV* hv_iterkeysv(HE* entry)
1728 Returns entries from a hash iterator. See C<hv_iterinit>.
1730 You may call C<hv_delete> or C<hv_delete_ent> on the hash entry that the
1731 iterator currently points to, without losing your place or invalidating your
1732 iterator. Note that in this case the current entry is deleted from the hash
1733 with your iterator holding the last reference to it. Your iterator is flagged
1734 to free the entry on the next call to C<hv_iternext>, so you must not discard
1735 your iterator immediately else the entry will leak - call C<hv_iternext> to
1736 trigger the resource deallocation.
1738 HE* hv_iternext(HV* tb)
1746 Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
1749 SV* hv_iternextsv(HV* hv, char** key, I32* retlen)
1754 =item hv_iternext_flags
1755 X<hv_iternext_flags>
1757 Returns entries from a hash iterator. See C<hv_iterinit> and C<hv_iternext>.
1758 The C<flags> value will normally be zero; if HV_ITERNEXT_WANTPLACEHOLDERS is
1759 set the placeholders keys (for restricted hashes) will be returned in addition
1760 to normal keys. By default placeholders are automatically skipped over.
1761 Currently a placeholder is implemented with a value that is
1762 C<&Perl_sv_placeholder>. Note that the implementation of placeholders and
1763 restricted hashes may change, and the implementation currently is
1764 insufficiently abstracted for any change to be tidy.
1766 NOTE: this function is experimental and may change or be
1767 removed without notice.
1769 HE* hv_iternext_flags(HV* tb, I32 flags)
1777 Returns the value from the current position of the hash iterator. See
1780 SV* hv_iterval(HV* tb, HE* entry)
1788 Adds magic to a hash. See C<sv_magic>.
1790 void hv_magic(HV* hv, GV* gv, int how)
1798 Evaluates the hash in scalar context and returns the result. Handles magic when the hash is tied.
1800 SV* hv_scalar(HV* hv)
1808 Stores an SV in a hash. The hash key is specified as C<key> and C<klen> is
1809 the length of the key. The C<hash> parameter is the precomputed hash
1810 value; if it is zero then Perl will compute it. The return value will be
1811 NULL if the operation failed or if the value did not need to be actually
1812 stored within the hash (as in the case of tied hashes). Otherwise it can
1813 be dereferenced to get the original C<SV*>. Note that the caller is
1814 responsible for suitably incrementing the reference count of C<val> before
1815 the call, and decrementing it if the function returned NULL. Effectively
1816 a successful hv_store takes ownership of one reference to C<val>. This is
1817 usually what you want; a newly created SV has a reference count of one, so
1818 if all your code does is create SVs then store them in a hash, hv_store
1819 will own the only reference to the new SV, and your code doesn't need to do
1820 anything further to tidy up. hv_store is not implemented as a call to
1821 hv_store_ent, and does not create a temporary SV for the key, so if your
1822 key data is not already in SV form then use hv_store in preference to
1825 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1826 information on how to use this function on tied hashes.
1828 SV** hv_store(HV* tb, const char* key, I32 klen, SV* val, U32 hash)
1836 Like C<hv_store>, but takes a literal string instead of a string/length pair
1837 and omits the hash parameter.
1839 SV** hv_stores(HV* tb, const char* key, NULLOK SV* val)
1842 Found in file handy.h
1847 Stores C<val> in a hash. The hash key is specified as C<key>. The C<hash>
1848 parameter is the precomputed hash value; if it is zero then Perl will
1849 compute it. The return value is the new hash entry so created. It will be
1850 NULL if the operation failed or if the value did not need to be actually
1851 stored within the hash (as in the case of tied hashes). Otherwise the
1852 contents of the return value can be accessed using the C<He?> macros
1853 described here. Note that the caller is responsible for suitably
1854 incrementing the reference count of C<val> before the call, and
1855 decrementing it if the function returned NULL. Effectively a successful
1856 hv_store_ent takes ownership of one reference to C<val>. This is
1857 usually what you want; a newly created SV has a reference count of one, so
1858 if all your code does is create SVs then store them in a hash, hv_store
1859 will own the only reference to the new SV, and your code doesn't need to do
1860 anything further to tidy up. Note that hv_store_ent only reads the C<key>;
1861 unlike C<val> it does not take ownership of it, so maintaining the correct
1862 reference count on C<key> is entirely the caller's responsibility. hv_store
1863 is not implemented as a call to hv_store_ent, and does not create a temporary
1864 SV for the key, so if your key data is not already in SV form then use
1865 hv_store in preference to hv_store_ent.
1867 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1868 information on how to use this function on tied hashes.
1870 HE* hv_store_ent(HV* tb, SV* key, SV* val, U32 hash)
1880 void hv_undef(HV* tb)
1888 Creates a new HV. The reference count is set to 1.
1898 =head1 Magical Functions
1905 Clear something magical that the SV represents. See C<sv_magic>.
1907 int mg_clear(SV* sv)
1915 Copies the magic from one SV to another. See C<sv_magic>.
1917 int mg_copy(SV* sv, SV* nsv, const char* key, I32 klen)
1925 Finds the magic pointer for type matching the SV. See C<sv_magic>.
1927 MAGIC* mg_find(const SV* sv, int type)
1935 Free any magic storage used by the SV. See C<sv_magic>.
1945 Do magic after a value is retrieved from the SV. See C<sv_magic>.
1955 Report on the SV's length. See C<sv_magic>.
1957 U32 mg_length(SV* sv)
1965 Turns on the magical status of an SV. See C<sv_magic>.
1967 void mg_magical(SV* sv)
1975 Do magic after a value is assigned to the SV. See C<sv_magic>.
1985 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
1986 argument more than once.
1988 void SvGETMAGIC(SV* sv)
1996 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
2007 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
2008 argument more than once.
2010 void SvSETMAGIC(SV* sv)
2018 Like C<SvSetSV>, but does any set magic required afterwards.
2020 void SvSetMagicSV(SV* dsb, SV* ssv)
2025 =item SvSetMagicSV_nosteal
2026 X<SvSetMagicSV_nosteal>
2028 Like C<SvSetSV_nosteal>, but does any set magic required afterwards.
2030 void SvSetMagicSV_nosteal(SV* dsv, SV* ssv)
2038 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
2041 void SvSetSV(SV* dsb, SV* ssv)
2046 =item SvSetSV_nosteal
2049 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
2050 ssv. May evaluate arguments more than once.
2052 void SvSetSV_nosteal(SV* dsv, SV* ssv)
2060 Arranges for sv to be shared between threads if a suitable module
2063 void SvSHARE(SV* sv)
2071 Releases a mutual exclusion lock on sv if a suitable module
2074 void SvUNLOCK(SV* sv)
2082 =head1 Memory Management
2089 The XSUB-writer's interface to the C C<memcpy> function. The C<src> is the
2090 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
2091 the type. May fail on overlapping copies. See also C<Move>.
2093 void Copy(void* src, void* dest, int nitems, type)
2096 Found in file handy.h
2101 Like C<Copy> but returns dest. Useful for encouraging compilers to tail-call
2104 void * CopyD(void* src, void* dest, int nitems, type)
2107 Found in file handy.h
2112 The XSUB-writer's interface to the C C<memmove> function. The C<src> is the
2113 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
2114 the type. Can do overlapping moves. See also C<Copy>.
2116 void Move(void* src, void* dest, int nitems, type)
2119 Found in file handy.h
2124 Like C<Move> but returns dest. Useful for encouraging compilers to tail-call
2127 void * MoveD(void* src, void* dest, int nitems, type)
2130 Found in file handy.h
2135 The XSUB-writer's interface to the C C<malloc> function.
2137 In 5.9.3, Newx() and friends replace the older New() API, and drops
2138 the first parameter, I<x>, a debug aid which allowed callers to identify
2139 themselves. This aid has been superseded by a new build option,
2140 PERL_MEM_LOG (see L<perlhack/PERL_MEM_LOG>). The older API is still
2141 there for use in XS modules supporting older perls.
2143 void Newx(void* ptr, int nitems, type)
2146 Found in file handy.h
2151 The XSUB-writer's interface to the C C<malloc> function, with
2152 cast. See also C<Newx>.
2154 void Newxc(void* ptr, int nitems, type, cast)
2157 Found in file handy.h
2162 The XSUB-writer's interface to the C C<malloc> function. The allocated
2163 memory is zeroed with C<memzero>. See also C<Newx>.
2165 void Newxz(void* ptr, int nitems, type)
2168 Found in file handy.h
2173 PoisonWith(0xEF) for catching access to freed memory.
2175 void Poison(void* dest, int nitems, type)
2178 Found in file handy.h
2183 PoisonWith(0xEF) for catching access to freed memory.
2185 void PoisonFree(void* dest, int nitems, type)
2188 Found in file handy.h
2193 PoisonWith(0xAB) for catching access to allocated but uninitialized memory.
2195 void PoisonNew(void* dest, int nitems, type)
2198 Found in file handy.h
2203 Fill up memory with a byte pattern (a byte repeated over and over
2204 again) that hopefully catches attempts to access uninitialized memory.
2206 void PoisonWith(void* dest, int nitems, type, U8 byte)
2209 Found in file handy.h
2214 The XSUB-writer's interface to the C C<realloc> function.
2216 void Renew(void* ptr, int nitems, type)
2219 Found in file handy.h
2224 The XSUB-writer's interface to the C C<realloc> function, with
2227 void Renewc(void* ptr, int nitems, type, cast)
2230 Found in file handy.h
2235 The XSUB-writer's interface to the C C<free> function.
2237 void Safefree(void* ptr)
2240 Found in file handy.h
2245 Perl's version of C<strdup()>. Returns a pointer to a newly allocated
2246 string which is a duplicate of C<pv>. The size of the string is
2247 determined by C<strlen()>. The memory allocated for the new string can
2248 be freed with the C<Safefree()> function.
2250 char* savepv(const char* pv)
2253 Found in file util.c
2258 Perl's version of what C<strndup()> would be if it existed. Returns a
2259 pointer to a newly allocated string which is a duplicate of the first
2260 C<len> bytes from C<pv>, plus a trailing NUL byte. The memory allocated for
2261 the new string can be freed with the C<Safefree()> function.
2263 char* savepvn(const char* pv, I32 len)
2266 Found in file util.c
2271 Like C<savepvn>, but takes a literal string instead of a string/length pair.
2273 char* savepvs(const char* s)
2276 Found in file handy.h
2281 A version of C<savepv()> which allocates the duplicate string in memory
2282 which is shared between threads.
2284 char* savesharedpv(const char* pv)
2287 Found in file util.c
2292 A version of C<savepvn()> which allocates the duplicate string in memory
2293 which is shared between threads. (With the specific difference that a NULL
2294 pointer is not acceptable)
2296 char* savesharedpvn(const char *const pv, const STRLEN len)
2299 Found in file util.c
2304 A version of C<savepv()>/C<savepvn()> which gets the string to duplicate from
2305 the passed in SV using C<SvPV()>
2307 char* savesvpv(SV* sv)
2310 Found in file util.c
2315 This is an architecture-independent macro to copy one structure to another.
2317 void StructCopy(type src, type dest, type)
2320 Found in file handy.h
2325 The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the
2326 destination, C<nitems> is the number of items, and C<type> is the type.
2328 void Zero(void* dest, int nitems, type)
2331 Found in file handy.h
2336 Like C<Zero> but returns dest. Useful for encouraging compilers to tail-call
2339 void * ZeroD(void* dest, int nitems, type)
2342 Found in file handy.h
2347 =head1 Miscellaneous Functions
2354 Analyses the string in order to make fast searches on it using fbm_instr()
2355 -- the Boyer-Moore algorithm.
2357 void fbm_compile(SV* sv, U32 flags)
2360 Found in file util.c
2365 Returns the location of the SV in the string delimited by C<str> and
2366 C<strend>. It returns C<NULL> if the string can't be found. The C<sv>
2367 does not have to be fbm_compiled, but the search will not be as fast
2370 char* fbm_instr(unsigned char* big, unsigned char* bigend, SV* littlesv, U32 flags)
2373 Found in file util.c
2378 Takes a sprintf-style format pattern and conventional
2379 (non-SV) arguments and returns the formatted string.
2381 (char *) Perl_form(pTHX_ const char* pat, ...)
2383 can be used any place a string (char *) is required:
2385 char * s = Perl_form("%d.%d",major,minor);
2387 Uses a single private buffer so if you want to format several strings you
2388 must explicitly copy the earlier strings away (and free the copies when you
2391 char* form(const char* pat, ...)
2394 Found in file util.c
2399 Fill the sv with current working directory
2401 int getcwd_sv(SV* sv)
2404 Found in file util.c
2409 The C library C<snprintf> functionality, if available and
2410 standards-compliant (uses C<vsnprintf>, actually). However, if the
2411 C<vsnprintf> is not available, will unfortunately use the unsafe
2412 C<vsprintf> which can overrun the buffer (there is an overrun check,
2413 but that may be too late). Consider using C<sv_vcatpvf> instead, or
2414 getting C<vsnprintf>.
2416 int my_snprintf(char *buffer, const Size_t len, const char *format, ...)
2419 Found in file util.c
2424 The C library C<sprintf>, wrapped if necessary, to ensure that it will return
2425 the length of the string written to the buffer. Only rare pre-ANSI systems
2426 need the wrapper function - usually this is a direct call to C<sprintf>.
2428 int my_sprintf(char *buffer, const char *pat, ...)
2431 Found in file util.c
2436 The C library C<vsnprintf> if available and standards-compliant.
2437 However, if if the C<vsnprintf> is not available, will unfortunately
2438 use the unsafe C<vsprintf> which can overrun the buffer (there is an
2439 overrun check, but that may be too late). Consider using
2440 C<sv_vcatpvf> instead, or getting C<vsnprintf>.
2442 int my_vsnprintf(char *buffer, const Size_t len, const char *format, va_list ap)
2445 Found in file util.c
2450 Returns a new version object based on the passed in SV:
2452 SV *sv = new_version(SV *ver);
2454 Does not alter the passed in ver SV. See "upg_version" if you
2455 want to upgrade the SV.
2457 SV* new_version(SV *ver)
2460 Found in file util.c
2465 Returns a pointer to the next character after the parsed
2466 version string, as well as upgrading the passed in SV to
2469 Function must be called with an already existing SV like
2472 s = scan_version(s, SV *sv, bool qv);
2474 Performs some preprocessing to the string to ensure that
2475 it has the correct characteristics of a version. Flags the
2476 object if it contains an underscore (which denotes this
2477 is an alpha version). The boolean qv denotes that the version
2478 should be interpreted as if it had multiple decimals, even if
2481 const char* scan_version(const char *vstr, SV *sv, bool qv)
2484 Found in file util.c
2489 Test two strings to see if they are equal. Returns true or false.
2491 bool strEQ(char* s1, char* s2)
2494 Found in file handy.h
2499 Test two strings to see if the first, C<s1>, is greater than or equal to
2500 the second, C<s2>. Returns true or false.
2502 bool strGE(char* s1, char* s2)
2505 Found in file handy.h
2510 Test two strings to see if the first, C<s1>, is greater than the second,
2511 C<s2>. Returns true or false.
2513 bool strGT(char* s1, char* s2)
2516 Found in file handy.h
2521 Test two strings to see if the first, C<s1>, is less than or equal to the
2522 second, C<s2>. Returns true or false.
2524 bool strLE(char* s1, char* s2)
2527 Found in file handy.h
2532 Test two strings to see if the first, C<s1>, is less than the second,
2533 C<s2>. Returns true or false.
2535 bool strLT(char* s1, char* s2)
2538 Found in file handy.h
2543 Test two strings to see if they are different. Returns true or
2546 bool strNE(char* s1, char* s2)
2549 Found in file handy.h
2554 Test two strings to see if they are equal. The C<len> parameter indicates
2555 the number of bytes to compare. Returns true or false. (A wrapper for
2558 bool strnEQ(char* s1, char* s2, STRLEN len)
2561 Found in file handy.h
2566 Test two strings to see if they are different. The C<len> parameter
2567 indicates the number of bytes to compare. Returns true or false. (A
2568 wrapper for C<strncmp>).
2570 bool strnNE(char* s1, char* s2, STRLEN len)
2573 Found in file handy.h
2578 Dummy routine which "shares" an SV when there is no sharing module present.
2579 Or "locks" it. Or "unlocks" it. In other words, ignores its single SV argument.
2580 Exists to avoid test for a NULL function pointer and because it could
2581 potentially warn under some level of strict-ness.
2583 void sv_nosharing(SV *sv)
2586 Found in file util.c
2591 In-place upgrade of the supplied SV to a version object.
2593 SV *sv = upg_version(SV *sv, bool qv);
2595 Returns a pointer to the upgraded SV. Set the boolean qv if you want
2596 to force this SV to be interpreted as an "extended" version.
2598 SV* upg_version(SV *ver, bool qv)
2601 Found in file util.c
2606 Version object aware cmp. Both operands must already have been
2607 converted into version objects.
2609 int vcmp(SV *lvs, SV *rvs)
2612 Found in file util.c
2617 Accepts a version object and returns the normalized string
2618 representation. Call like:
2622 NOTE: you can pass either the object directly or the SV
2623 contained within the RV.
2628 Found in file util.c
2633 Accepts a version object and returns the normalized floating
2634 point representation. Call like:
2638 NOTE: you can pass either the object directly or the SV
2639 contained within the RV.
2644 Found in file util.c
2649 In order to maintain maximum compatibility with earlier versions
2650 of Perl, this function will return either the floating point
2651 notation or the multiple dotted notation, depending on whether
2652 the original version contained 1 or more dots, respectively
2654 SV* vstringify(SV *vs)
2657 Found in file util.c
2662 Validates that the SV contains a valid version object.
2664 bool vverify(SV *vobj);
2666 Note that it only confirms the bare minimum structure (so as not to get
2667 confused by derived classes which may contain additional hash entries):
2669 bool vverify(SV *vs)
2672 Found in file util.c
2677 =head1 MRO Functions
2681 =item mro_get_linear_isa
2682 X<mro_get_linear_isa>
2684 Returns either C<mro_get_linear_isa_c3> or
2685 C<mro_get_linear_isa_dfs> for the given stash,
2686 dependant upon which MRO is in effect
2687 for that stash. The return value is a
2690 You are responsible for C<SvREFCNT_inc()> on the
2691 return value if you plan to store it anywhere
2692 semi-permanently (otherwise it might be deleted
2693 out from under you the next time the cache is
2696 AV* mro_get_linear_isa(HV* stash)
2701 =item mro_get_linear_isa_c3
2702 X<mro_get_linear_isa_c3>
2704 Returns the C3 linearization of @ISA
2705 the given stash. The return value is a read-only AV*.
2706 C<level> should be 0 (it is used internally in this
2707 function's recursion).
2709 You are responsible for C<SvREFCNT_inc()> on the
2710 return value if you plan to store it anywhere
2711 semi-permanently (otherwise it might be deleted
2712 out from under you the next time the cache is
2715 AV* mro_get_linear_isa_c3(HV* stash, I32 level)
2720 =item mro_get_linear_isa_dfs
2721 X<mro_get_linear_isa_dfs>
2723 Returns the Depth-First Search linearization of @ISA
2724 the given stash. The return value is a read-only AV*.
2725 C<level> should be 0 (it is used internally in this
2726 function's recursion).
2728 You are responsible for C<SvREFCNT_inc()> on the
2729 return value if you plan to store it anywhere
2730 semi-permanently (otherwise it might be deleted
2731 out from under you the next time the cache is
2734 AV* mro_get_linear_isa_dfs(HV* stash, I32 level)
2739 =item mro_method_changed_in
2740 X<mro_method_changed_in>
2742 Invalidates method caching on any child classes
2743 of the given stash, so that they might notice
2744 the changes in this one.
2746 Ideally, all instances of C<PL_sub_generation++> in
2747 perl source outside of C<mro.c> should be
2748 replaced by calls to this.
2750 Perl automatically handles most of the common
2751 ways a method might be redefined. However, there
2752 are a few ways you could change a method in a stash
2753 without the cache code noticing, in which case you
2754 need to call this method afterwards:
2756 1) Directly manipulating the stash HV entries from
2759 2) Assigning a reference to a readonly scalar
2760 constant into a stash entry in order to create
2761 a constant subroutine (like constant.pm
2764 This same method is available from pure perl
2765 via, C<mro::method_changed_in(classname)>.
2767 void mro_method_changed_in(HV* stash)
2775 =head1 Multicall Functions
2782 Declare local variables for a multicall. See L<perlcall/Lightweight Callbacks>.
2792 Make a lightweight callback. See L<perlcall/Lightweight Callbacks>.
2802 Closing bracket for a lightweight callback.
2803 See L<perlcall/Lightweight Callbacks>.
2810 =item PUSH_MULTICALL
2813 Opening bracket for a lightweight callback.
2814 See L<perlcall/Lightweight Callbacks>.
2824 =head1 Numeric functions
2831 converts a string representing a binary number to numeric form.
2833 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2834 conversion flags, and I<result> should be NULL or a pointer to an NV.
2835 The scan stops at the end of the string, or the first invalid character.
2836 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2837 invalid character will also trigger a warning.
2838 On return I<*len> is set to the length of the scanned string,
2839 and I<*flags> gives output flags.
2841 If the value is <= C<UV_MAX> it is returned as a UV, the output flags are clear,
2842 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_bin>
2843 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2844 and writes the value to I<*result> (or the value is discarded if I<result>
2847 The binary number may optionally be prefixed with "0b" or "b" unless
2848 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
2849 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the binary
2850 number may use '_' characters to separate digits.
2852 UV grok_bin(const char* start, STRLEN* len_p, I32* flags, NV *result)
2855 Found in file numeric.c
2860 converts a string representing a hex number to numeric form.
2862 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2863 conversion flags, and I<result> should be NULL or a pointer to an NV.
2864 The scan stops at the end of the string, or the first invalid character.
2865 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2866 invalid character will also trigger a warning.
2867 On return I<*len> is set to the length of the scanned string,
2868 and I<*flags> gives output flags.
2870 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2871 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_hex>
2872 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2873 and writes the value to I<*result> (or the value is discarded if I<result>
2876 The hex number may optionally be prefixed with "0x" or "x" unless
2877 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
2878 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the hex
2879 number may use '_' characters to separate digits.
2881 UV grok_hex(const char* start, STRLEN* len_p, I32* flags, NV *result)
2884 Found in file numeric.c
2889 Recognise (or not) a number. The type of the number is returned
2890 (0 if unrecognised), otherwise it is a bit-ORed combination of
2891 IS_NUMBER_IN_UV, IS_NUMBER_GREATER_THAN_UV_MAX, IS_NUMBER_NOT_INT,
2892 IS_NUMBER_NEG, IS_NUMBER_INFINITY, IS_NUMBER_NAN (defined in perl.h).
2894 If the value of the number can fit an in UV, it is returned in the *valuep
2895 IS_NUMBER_IN_UV will be set to indicate that *valuep is valid, IS_NUMBER_IN_UV
2896 will never be set unless *valuep is valid, but *valuep may have been assigned
2897 to during processing even though IS_NUMBER_IN_UV is not set on return.
2898 If valuep is NULL, IS_NUMBER_IN_UV will be set for the same cases as when
2899 valuep is non-NULL, but no actual assignment (or SEGV) will occur.
2901 IS_NUMBER_NOT_INT will be set with IS_NUMBER_IN_UV if trailing decimals were
2902 seen (in which case *valuep gives the true value truncated to an integer), and
2903 IS_NUMBER_NEG if the number is negative (in which case *valuep holds the
2904 absolute value). IS_NUMBER_IN_UV is not set if e notation was used or the
2905 number is larger than a UV.
2907 int grok_number(const char *pv, STRLEN len, UV *valuep)
2910 Found in file numeric.c
2912 =item grok_numeric_radix
2913 X<grok_numeric_radix>
2915 Scan and skip for a numeric decimal separator (radix).
2917 bool grok_numeric_radix(const char **sp, const char *send)
2920 Found in file numeric.c
2925 converts a string representing an octal number to numeric form.
2927 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2928 conversion flags, and I<result> should be NULL or a pointer to an NV.
2929 The scan stops at the end of the string, or the first invalid character.
2930 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2931 invalid character will also trigger a warning.
2932 On return I<*len> is set to the length of the scanned string,
2933 and I<*flags> gives output flags.
2935 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2936 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_oct>
2937 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2938 and writes the value to I<*result> (or the value is discarded if I<result>
2941 If C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the octal
2942 number may use '_' characters to separate digits.
2944 UV grok_oct(const char* start, STRLEN* len_p, I32* flags, NV *result)
2947 Found in file numeric.c
2952 Return a non-zero integer if the sign bit on an NV is set, and 0 if
2955 If Configure detects this system has a signbit() that will work with
2956 our NVs, then we just use it via the #define in perl.h. Otherwise,
2957 fall back on this implementation. As a first pass, this gets everything
2958 right except -0.0. Alas, catching -0.0 is the main use for this function,
2959 so this is not too helpful yet. Still, at least we have the scaffolding
2960 in place to support other systems, should that prove useful.
2963 Configure notes: This function is called 'Perl_signbit' instead of a
2964 plain 'signbit' because it is easy to imagine a system having a signbit()
2965 function or macro that doesn't happen to work with our particular choice
2966 of NVs. We shouldn't just re-#define signbit as Perl_signbit and expect
2967 the standard system headers to be happy. Also, this is a no-context
2968 function (no pTHX_) because Perl_signbit() is usually re-#defined in
2969 perl.h as a simple macro call to the system's signbit().
2970 Users should just always call Perl_signbit().
2972 NOTE: this function is experimental and may change or be
2973 removed without notice.
2975 int Perl_signbit(NV f)
2978 Found in file numeric.c
2983 For backwards compatibility. Use C<grok_bin> instead.
2985 NV scan_bin(const char* start, STRLEN len, STRLEN* retlen)
2988 Found in file numeric.c
2993 For backwards compatibility. Use C<grok_hex> instead.
2995 NV scan_hex(const char* start, STRLEN len, STRLEN* retlen)
2998 Found in file numeric.c
3003 For backwards compatibility. Use C<grok_oct> instead.
3005 NV scan_oct(const char* start, STRLEN len, STRLEN* retlen)
3008 Found in file numeric.c
3013 =head1 Optree Manipulation Functions
3020 If C<cv> is a constant sub eligible for inlining. returns the constant
3021 value returned by the sub. Otherwise, returns NULL.
3023 Constant subs can be created with C<newCONSTSUB> or as described in
3024 L<perlsub/"Constant Functions">.
3026 SV* cv_const_sv(CV* cv)
3034 Creates a constant sub equivalent to Perl C<sub FOO () { 123 }> which is
3035 eligible for inlining at compile-time.
3037 CV* newCONSTSUB(HV* stash, const char* name, SV* sv)
3045 Used by C<xsubpp> to hook up XSUBs as Perl subs. I<filename> needs to be
3046 static storage, as it is used directly as CvFILE(), without a copy being made.
3054 =head1 Pad Data Structures
3061 Get the value at offset po in the current pad.
3062 Use macro PAD_SV instead of calling this function directly.
3064 SV* pad_sv(PADOFFSET po)
3072 =head1 Per-Interpreter Variables
3079 C<PL_modglobal> is a general purpose, interpreter global HV for use by
3080 extensions that need to keep information on a per-interpreter basis.
3081 In a pinch, it can also be used as a symbol table for extensions
3082 to share data among each other. It is a good idea to use keys
3083 prefixed by the package name of the extension that owns the data.
3088 Found in file intrpvar.h
3093 A convenience variable which is typically used with C<SvPV> when one
3094 doesn't care about the length of the string. It is usually more efficient
3095 to either declare a local variable and use that instead or to use the
3096 C<SvPV_nolen> macro.
3101 Found in file intrpvar.h
3106 This is the C<false> SV. See C<PL_sv_yes>. Always refer to this as
3112 Found in file intrpvar.h
3117 This is the C<undef> SV. Always refer to this as C<&PL_sv_undef>.
3122 Found in file intrpvar.h
3127 This is the C<true> SV. See C<PL_sv_no>. Always refer to this as
3133 Found in file intrpvar.h
3138 =head1 REGEXP Functions
3145 Convenience macro to get the REGEXP from a SV. This is approximately
3146 equivalent to the following snippet:
3151 (tmpsv = (SV*)SvRV(sv)) &&
3152 SvTYPE(tmpsv) == SVt_PVMG &&
3153 (tmpmg = mg_find(tmpsv, PERL_MAGIC_qr)))
3155 return (REGEXP *)tmpmg->mg_obj;
3158 NULL will be returned if a REGEXP* is not found.
3160 REGEXP * SvRX(SV *sv)
3163 Found in file regexp.h
3168 Returns a boolean indicating whether the SV contains qr magic
3171 If you want to do something with the REGEXP* later use SvRX instead
3177 Found in file regexp.h
3182 =head1 Simple Exception Handling Macros
3189 Set up necessary local variables for exception handling.
3190 See L<perlguts/"Exception Handling">.
3195 Found in file XSUB.h
3200 Introduces a catch block. See L<perlguts/"Exception Handling">.
3203 Found in file XSUB.h
3208 Rethrows a previously caught exception. See L<perlguts/"Exception Handling">.
3213 Found in file XSUB.h
3218 Ends a try block. See L<perlguts/"Exception Handling">.
3221 Found in file XSUB.h
3223 =item XCPT_TRY_START
3226 Starts a try block. See L<perlguts/"Exception Handling">.
3229 Found in file XSUB.h
3234 =head1 Stack Manipulation Macros
3241 Declare a stack marker variable, C<mark>, for the XSUB. See C<MARK> and
3252 Saves the original stack mark for the XSUB. See C<ORIGMARK>.
3262 Declares a local copy of perl's stack pointer for the XSUB, available via
3263 the C<SP> macro. See C<SP>.
3273 Used to extend the argument stack for an XSUB's return values. Once
3274 used, guarantees that there is room for at least C<nitems> to be pushed
3277 void EXTEND(SP, int nitems)
3285 Stack marker variable for the XSUB. See C<dMARK>.
3293 Push an integer onto the stack. The stack must have room for this element.
3294 Handles 'set' magic. Does not use C<TARG>. See also C<PUSHi>, C<mXPUSHi>
3305 Push a double onto the stack. The stack must have room for this element.
3306 Handles 'set' magic. Does not use C<TARG>. See also C<PUSHn>, C<mXPUSHn>
3317 Push a string onto the stack. The stack must have room for this element.
3318 The C<len> indicates the length of the string. Handles 'set' magic. Does
3319 not use C<TARG>. See also C<PUSHp>, C<mXPUSHp> and C<XPUSHp>.
3321 void mPUSHp(char* str, STRLEN len)
3329 Push an unsigned integer onto the stack. The stack must have room for this
3330 element. Handles 'set' magic. Does not use C<TARG>. See also C<PUSHu>,
3331 C<mXPUSHu> and C<XPUSHu>.
3341 Push an integer onto the stack, extending the stack if necessary. Handles
3342 'set' magic. Does not use C<TARG>. See also C<XPUSHi>, C<mPUSHi> and
3353 Push a double onto the stack, extending the stack if necessary. Handles
3354 'set' magic. Does not use C<TARG>. See also C<XPUSHn>, C<mPUSHn> and
3365 Push a string onto the stack, extending the stack if necessary. The C<len>
3366 indicates the length of the string. Handles 'set' magic. Does not use
3367 C<TARG>. See also C<XPUSHp>, C<mPUSHp> and C<PUSHp>.
3369 void mXPUSHp(char* str, STRLEN len)
3377 Push an unsigned integer onto the stack, extending the stack if necessary.
3378 Handles 'set' magic. Does not use C<TARG>. See also C<XPUSHu>, C<mPUSHu>
3389 The original stack mark for the XSUB. See C<dORIGMARK>.
3397 Pops an integer off the stack.
3407 Pops a long off the stack.
3417 Pops a double off the stack.
3427 Pops a string off the stack. Deprecated. New code should use POPpx.
3437 Pops a string off the stack which must consist of bytes i.e. characters < 256.
3447 Pops a string off the stack.
3457 Pops an SV off the stack.
3467 Push an integer onto the stack. The stack must have room for this element.
3468 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3469 called to declare it. Do not call multiple C<TARG>-oriented macros to
3470 return lists from XSUB's - see C<mPUSHi> instead. See also C<XPUSHi> and
3481 Opening bracket for arguments on a callback. See C<PUTBACK> and
3492 Push a new mortal SV onto the stack. The stack must have room for this
3493 element. Does not handle 'set' magic. Does not use C<TARG>. See also
3494 C<PUSHs>, C<XPUSHmortal> and C<XPUSHs>.
3504 Push a double onto the stack. The stack must have room for this element.
3505 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3506 called to declare it. Do not call multiple C<TARG>-oriented macros to
3507 return lists from XSUB's - see C<mPUSHn> instead. See also C<XPUSHn> and
3518 Push a string onto the stack. The stack must have room for this element.
3519 The C<len> indicates the length of the string. Handles 'set' magic. Uses
3520 C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to declare it. Do not
3521 call multiple C<TARG>-oriented macros to return lists from XSUB's - see
3522 C<mPUSHp> instead. See also C<XPUSHp> and C<mXPUSHp>.
3524 void PUSHp(char* str, STRLEN len)
3532 Push an SV onto the stack. The stack must have room for this element.
3533 Does not handle 'set' magic. Does not use C<TARG>. See also C<PUSHmortal>,
3534 C<XPUSHs> and C<XPUSHmortal>.
3544 Push an unsigned integer onto the stack. The stack must have room for this
3545 element. Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG>
3546 should be called to declare it. Do not call multiple C<TARG>-oriented
3547 macros to return lists from XSUB's - see C<mPUSHu> instead. See also
3548 C<XPUSHu> and C<mXPUSHu>.
3558 Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
3559 See C<PUSHMARK> and L<perlcall> for other uses.
3569 Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and
3578 Refetch the stack pointer. Used after a callback. See L<perlcall>.
3588 Push an integer onto the stack, extending the stack if necessary. Handles
3589 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
3590 declare it. Do not call multiple C<TARG>-oriented macros to return lists
3591 from XSUB's - see C<mXPUSHi> instead. See also C<PUSHi> and C<mPUSHi>.
3601 Push a new mortal SV onto the stack, extending the stack if necessary. Does
3602 not handle 'set' magic. Does not use C<TARG>. See also C<XPUSHs>,
3603 C<PUSHmortal> and C<PUSHs>.
3613 Push a double onto the stack, extending the stack if necessary. Handles
3614 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
3615 declare it. Do not call multiple C<TARG>-oriented macros to return lists
3616 from XSUB's - see C<mXPUSHn> instead. See also C<PUSHn> and C<mPUSHn>.
3626 Push a string onto the stack, extending the stack if necessary. The C<len>
3627 indicates the length of the string. Handles 'set' magic. Uses C<TARG>, so
3628 C<dTARGET> or C<dXSTARG> should be called to declare it. Do not call
3629 multiple C<TARG>-oriented macros to return lists from XSUB's - see
3630 C<mXPUSHp> instead. See also C<PUSHp> and C<mPUSHp>.
3632 void XPUSHp(char* str, STRLEN len)
3640 Push an SV onto the stack, extending the stack if necessary. Does not
3641 handle 'set' magic. Does not use C<TARG>. See also C<XPUSHmortal>,
3642 C<PUSHs> and C<PUSHmortal>.
3652 Push an unsigned integer onto the stack, extending the stack if necessary.
3653 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3654 called to declare it. Do not call multiple C<TARG>-oriented macros to
3655 return lists from XSUB's - see C<mXPUSHu> instead. See also C<PUSHu> and
3666 Return from XSUB, indicating number of items on the stack. This is usually
3667 handled by C<xsubpp>.
3669 void XSRETURN(int nitems)
3672 Found in file XSUB.h
3674 =item XSRETURN_EMPTY
3677 Return an empty list from an XSUB immediately.
3682 Found in file XSUB.h
3687 Return an integer from an XSUB immediately. Uses C<XST_mIV>.
3689 void XSRETURN_IV(IV iv)
3692 Found in file XSUB.h
3697 Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
3702 Found in file XSUB.h
3707 Return a double from an XSUB immediately. Uses C<XST_mNV>.
3709 void XSRETURN_NV(NV nv)
3712 Found in file XSUB.h
3717 Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
3719 void XSRETURN_PV(char* str)
3722 Found in file XSUB.h
3724 =item XSRETURN_UNDEF
3727 Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
3732 Found in file XSUB.h
3737 Return an integer from an XSUB immediately. Uses C<XST_mUV>.
3739 void XSRETURN_UV(IV uv)
3742 Found in file XSUB.h
3747 Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
3752 Found in file XSUB.h
3757 Place an integer into the specified position C<pos> on the stack. The
3758 value is stored in a new mortal SV.
3760 void XST_mIV(int pos, IV iv)
3763 Found in file XSUB.h
3768 Place C<&PL_sv_no> into the specified position C<pos> on the
3771 void XST_mNO(int pos)
3774 Found in file XSUB.h
3779 Place a double into the specified position C<pos> on the stack. The value
3780 is stored in a new mortal SV.
3782 void XST_mNV(int pos, NV nv)
3785 Found in file XSUB.h
3790 Place a copy of a string into the specified position C<pos> on the stack.
3791 The value is stored in a new mortal SV.
3793 void XST_mPV(int pos, char* str)
3796 Found in file XSUB.h
3801 Place C<&PL_sv_undef> into the specified position C<pos> on the
3804 void XST_mUNDEF(int pos)
3807 Found in file XSUB.h
3812 Place C<&PL_sv_yes> into the specified position C<pos> on the
3815 void XST_mYES(int pos)
3818 Found in file XSUB.h
3830 An enum of flags for Perl types. These are found in the file B<sv.h>
3831 in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
3839 Integer type flag for scalars. See C<svtype>.
3847 Double type flag for scalars. See C<svtype>.
3855 Pointer type flag for scalars. See C<svtype>.
3863 Type flag for arrays. See C<svtype>.
3871 Type flag for code refs. See C<svtype>.
3879 Type flag for hashes. See C<svtype>.
3887 Type flag for blessed scalars. See C<svtype>.
3895 =head1 SV Manipulation Functions
3902 Returns the SV of the specified Perl scalar. If C<create> is set and the
3903 Perl variable does not exist then it will be created. If C<create> is not
3904 set and the variable does not exist then NULL is returned.
3906 NOTE: the perl_ form of this function is deprecated.
3908 SV* get_sv(const char* name, I32 create)
3911 Found in file perl.c
3916 Creates an RV wrapper for an SV. The reference count for the original SV is
3919 SV* newRV_inc(SV* sv)
3927 Returns the length of the string which is in the SV. See C<SvLEN>.
3929 STRLEN SvCUR(SV* sv)
3937 Set the current length of the string which is in the SV. See C<SvCUR>
3940 void SvCUR_set(SV* sv, STRLEN len)
3948 Returns a pointer to the last character in the string which is in the SV.
3949 See C<SvCUR>. Access the character as *(SvEND(sv)).
3959 Returns true if the SV has get magic or overloading. If either is true then
3960 the scalar is active data, and has the potential to return a new value every
3961 time it is accessed. Hence you must be careful to only read it once per user
3962 logical operation and work with that returned value. If neither is true then
3963 the scalar's value cannot change unless written to.
3965 char* SvGAMAGIC(SV* sv)
3973 Expands the character buffer in the SV so that it has room for the
3974 indicated number of bytes (remember to reserve space for an extra trailing
3975 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
3976 Returns a pointer to the character buffer.
3978 char * SvGROW(SV* sv, STRLEN len)
3986 Returns a U32 value indicating whether the SV contains an integer.
3996 Returns a U32 value indicating whether the SV contains an integer. Checks
3997 the B<private> setting. Use C<SvIOK>.
4007 Returns a boolean indicating whether the SV contains a signed integer.
4009 bool SvIOK_notUV(SV* sv)
4017 Unsets the IV status of an SV.
4019 void SvIOK_off(SV* sv)
4027 Tells an SV that it is an integer.
4029 void SvIOK_on(SV* sv)
4037 Tells an SV that it is an integer and disables all other OK bits.
4039 void SvIOK_only(SV* sv)
4047 Tells and SV that it is an unsigned integer and disables all other OK bits.
4049 void SvIOK_only_UV(SV* sv)
4057 Returns a boolean indicating whether the SV contains an unsigned integer.
4059 bool SvIOK_UV(SV* sv)
4067 Returns a boolean indicating whether the SV is Copy-On-Write. (either shared
4068 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
4071 bool SvIsCOW(SV* sv)
4076 =item SvIsCOW_shared_hash
4077 X<SvIsCOW_shared_hash>
4079 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
4082 bool SvIsCOW_shared_hash(SV* sv)
4090 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
4091 version which guarantees to evaluate sv only once.
4101 Returns the raw value in the SV's IV slot, without checks or conversions.
4102 Only use when you are sure SvIOK is true. See also C<SvIV()>.
4112 Coerces the given SV to an integer and returns it. Guarantees to evaluate
4113 C<sv> only once. Only use this if C<sv> is an expression with side effects,
4114 otherwise use the more efficient C<SvIV>.
4124 Like C<SvIV> but doesn't process magic.
4126 IV SvIV_nomg(SV* sv)
4134 Set the value of the IV pointer in sv to val. It is possible to perform
4135 the same function of this macro with an lvalue assignment to C<SvIVX>.
4136 With future Perls, however, it will be more efficient to use
4137 C<SvIV_set> instead of the lvalue assignment to C<SvIVX>.
4139 void SvIV_set(SV* sv, IV val)
4147 Returns the size of the string buffer in the SV, not including any part
4148 attributable to C<SvOOK>. See C<SvCUR>.
4150 STRLEN SvLEN(SV* sv)
4158 Set the actual length of the string which is in the SV. See C<SvIV_set>.
4160 void SvLEN_set(SV* sv, STRLEN len)
4168 Set the value of the MAGIC pointer in sv to val. See C<SvIV_set>.
4170 void SvMAGIC_set(SV* sv, MAGIC* val)
4178 Returns a U32 value indicating whether the SV contains a number, integer or
4189 Returns a U32 value indicating whether the SV contains a number, integer or
4190 double. Checks the B<private> setting. Use C<SvNIOK>.
4200 Unsets the NV/IV status of an SV.
4202 void SvNIOK_off(SV* sv)
4210 Returns a U32 value indicating whether the SV contains a double.
4220 Returns a U32 value indicating whether the SV contains a double. Checks the
4221 B<private> setting. Use C<SvNOK>.
4231 Unsets the NV status of an SV.
4233 void SvNOK_off(SV* sv)
4241 Tells an SV that it is a double.
4243 void SvNOK_on(SV* sv)
4251 Tells an SV that it is a double and disables all other OK bits.
4253 void SvNOK_only(SV* sv)
4261 Coerce the given SV to a double and return it. See C<SvNVx> for a version
4262 which guarantees to evaluate sv only once.
4272 Returns the raw value in the SV's NV slot, without checks or conversions.
4273 Only use when you are sure SvNOK is true. See also C<SvNV()>.
4283 Coerces the given SV to a double and returns it. Guarantees to evaluate
4284 C<sv> only once. Only use this if C<sv> is an expression with side effects,
4285 otherwise use the more efficient C<SvNV>.
4295 Set the value of the NV pointer in sv to val. See C<SvIV_set>.
4297 void SvNV_set(SV* sv, NV val)
4305 Returns a U32 value indicating whether the value is an SV. It also tells
4306 whether the value is defined or not.
4316 Returns a U32 indicating whether the SvIVX is a valid offset value for
4317 the SvPVX. This hack is used internally to speed up removal of characters
4318 from the beginning of a SvPV. When SvOOK is true, then the start of the
4319 allocated string buffer is really (SvPVX - SvIVX).
4329 Returns a U32 value indicating whether the SV contains a character
4340 Returns a U32 value indicating whether the SV contains a character string.
4341 Checks the B<private> setting. Use C<SvPOK>.
4351 Unsets the PV status of an SV.
4353 void SvPOK_off(SV* sv)
4361 Tells an SV that it is a string.
4363 void SvPOK_on(SV* sv)
4371 Tells an SV that it is a string and disables all other OK bits.
4372 Will also turn off the UTF-8 status.
4374 void SvPOK_only(SV* sv)
4379 =item SvPOK_only_UTF8
4382 Tells an SV that it is a string and disables all other OK bits,
4383 and leaves the UTF-8 status as it was.
4385 void SvPOK_only_UTF8(SV* sv)
4393 Returns a pointer to the string in the SV, or a stringified form of
4394 the SV if the SV does not contain a string. The SV may cache the
4395 stringified version becoming C<SvPOK>. Handles 'get' magic. See also
4396 C<SvPVx> for a version which guarantees to evaluate sv only once.
4398 char* SvPV(SV* sv, STRLEN len)
4406 Like C<SvPV>, but converts sv to byte representation first if necessary.
4408 char* SvPVbyte(SV* sv, STRLEN len)
4416 Like C<SvPV>, but converts sv to byte representation first if necessary.
4417 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
4420 char* SvPVbytex(SV* sv, STRLEN len)
4425 =item SvPVbytex_force
4428 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
4429 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
4432 char* SvPVbytex_force(SV* sv, STRLEN len)
4437 =item SvPVbyte_force
4440 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
4442 char* SvPVbyte_force(SV* sv, STRLEN len)
4447 =item SvPVbyte_nolen
4450 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
4452 char* SvPVbyte_nolen(SV* sv)
4460 Like C<SvPV>, but converts sv to utf8 first if necessary.
4462 char* SvPVutf8(SV* sv, STRLEN len)
4470 Like C<SvPV>, but converts sv to utf8 first if necessary.
4471 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
4474 char* SvPVutf8x(SV* sv, STRLEN len)
4479 =item SvPVutf8x_force
4482 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
4483 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
4486 char* SvPVutf8x_force(SV* sv, STRLEN len)
4491 =item SvPVutf8_force
4494 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
4496 char* SvPVutf8_force(SV* sv, STRLEN len)
4501 =item SvPVutf8_nolen
4504 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
4506 char* SvPVutf8_nolen(SV* sv)
4514 Returns a pointer to the physical string in the SV. The SV must contain a
4525 A version of C<SvPV> which guarantees to evaluate C<sv> only once.
4526 Only use this if C<sv> is an expression with side effects, otherwise use the
4527 more efficient C<SvPVX>.
4529 char* SvPVx(SV* sv, STRLEN len)
4537 Like C<SvPV> but will force the SV into containing just a string
4538 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
4541 char* SvPV_force(SV* sv, STRLEN len)
4546 =item SvPV_force_nomg
4549 Like C<SvPV> but will force the SV into containing just a string
4550 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
4551 directly. Doesn't process magic.
4553 char* SvPV_force_nomg(SV* sv, STRLEN len)
4561 Returns a pointer to the string in the SV, or a stringified form of
4562 the SV if the SV does not contain a string. The SV may cache the
4563 stringified form becoming C<SvPOK>. Handles 'get' magic.
4565 char* SvPV_nolen(SV* sv)
4573 Like C<SvPV> but doesn't process magic.
4575 char* SvPV_nomg(SV* sv, STRLEN len)
4583 Set the value of the PV pointer in sv to val. See C<SvIV_set>.
4585 void SvPV_set(SV* sv, char* val)
4593 Returns the value of the object's reference count.
4595 U32 SvREFCNT(SV* sv)
4603 Decrements the reference count of the given SV.
4605 void SvREFCNT_dec(SV* sv)
4613 Increments the reference count of the given SV.
4615 All of the following SvREFCNT_inc* macros are optimized versions of
4616 SvREFCNT_inc, and can be replaced with SvREFCNT_inc.
4618 SV* SvREFCNT_inc(SV* sv)
4623 =item SvREFCNT_inc_NN
4626 Same as SvREFCNT_inc, but can only be used if you know I<sv>
4627 is not NULL. Since we don't have to check the NULLness, it's faster
4630 SV* SvREFCNT_inc_NN(SV* sv)
4635 =item SvREFCNT_inc_simple
4636 X<SvREFCNT_inc_simple>
4638 Same as SvREFCNT_inc, but can only be used with expressions without side
4639 effects. Since we don't have to store a temporary value, it's faster.
4641 SV* SvREFCNT_inc_simple(SV* sv)
4646 =item SvREFCNT_inc_simple_NN
4647 X<SvREFCNT_inc_simple_NN>
4649 Same as SvREFCNT_inc_simple, but can only be used if you know I<sv>
4650 is not NULL. Since we don't have to check the NULLness, it's faster
4653 SV* SvREFCNT_inc_simple_NN(SV* sv)
4658 =item SvREFCNT_inc_simple_void
4659 X<SvREFCNT_inc_simple_void>
4661 Same as SvREFCNT_inc_simple, but can only be used if you don't need the
4662 return value. The macro doesn't need to return a meaningful value.
4664 void SvREFCNT_inc_simple_void(SV* sv)
4669 =item SvREFCNT_inc_simple_void_NN
4670 X<SvREFCNT_inc_simple_void_NN>
4672 Same as SvREFCNT_inc, but can only be used if you don't need the return
4673 value, and you know that I<sv> is not NULL. The macro doesn't need
4674 to return a meaningful value, or check for NULLness, so it's smaller
4677 void SvREFCNT_inc_simple_void_NN(SV* sv)
4682 =item SvREFCNT_inc_void
4683 X<SvREFCNT_inc_void>
4685 Same as SvREFCNT_inc, but can only be used if you don't need the
4686 return value. The macro doesn't need to return a meaningful value.
4688 void SvREFCNT_inc_void(SV* sv)
4693 =item SvREFCNT_inc_void_NN
4694 X<SvREFCNT_inc_void_NN>
4696 Same as SvREFCNT_inc, but can only be used if you don't need the return
4697 value, and you know that I<sv> is not NULL. The macro doesn't need
4698 to return a meaningful value, or check for NULLness, so it's smaller
4701 void SvREFCNT_inc_void_NN(SV* sv)
4709 Tests if the SV is an RV.
4719 Unsets the RV status of an SV.
4721 void SvROK_off(SV* sv)
4729 Tells an SV that it is an RV.
4731 void SvROK_on(SV* sv)
4739 Dereferences an RV to return the SV.
4749 Set the value of the RV pointer in sv to val. See C<SvIV_set>.
4751 void SvRV_set(SV* sv, SV* val)
4759 Returns the stash of the SV.
4769 Set the value of the STASH pointer in sv to val. See C<SvIV_set>.
4771 void SvSTASH_set(SV* sv, HV* val)
4779 Taints an SV if tainting is enabled.
4781 void SvTAINT(SV* sv)
4789 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
4792 bool SvTAINTED(SV* sv)
4800 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
4801 some of Perl's fundamental security features. XS module authors should not
4802 use this function unless they fully understand all the implications of
4803 unconditionally untainting the value. Untainting should be done in the
4804 standard perl fashion, via a carefully crafted regexp, rather than directly
4805 untainting variables.
4807 void SvTAINTED_off(SV* sv)
4815 Marks an SV as tainted if tainting is enabled.
4817 void SvTAINTED_on(SV* sv)
4825 Returns a boolean indicating whether Perl would evaluate the SV as true or
4826 false, defined or undefined. Does not handle 'get' magic.
4836 Returns the type of the SV. See C<svtype>.
4838 svtype SvTYPE(SV* sv)
4846 Returns a boolean indicating whether the SV contains an unsigned integer.
4856 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
4857 perform the upgrade if necessary. See C<svtype>.
4859 void SvUPGRADE(SV* sv, svtype type)
4867 Returns a U32 value indicating whether the SV contains UTF-8 encoded data.
4868 Call this after SvPV() in case any call to string overloading updates the
4879 Unsets the UTF-8 status of an SV.
4881 void SvUTF8_off(SV *sv)
4889 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
4890 Do not use frivolously.
4892 void SvUTF8_on(SV *sv)
4900 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
4901 for a version which guarantees to evaluate sv only once.
4911 Returns the raw value in the SV's UV slot, without checks or conversions.
4912 Only use when you are sure SvIOK is true. See also C<SvUV()>.
4922 Coerces the given SV to an unsigned integer and returns it. Guarantees to
4923 C<sv> only once. Only use this if C<sv> is an expression with side effects,
4924 otherwise use the more efficient C<SvUV>.
4934 Like C<SvUV> but doesn't process magic.
4936 UV SvUV_nomg(SV* sv)
4944 Set the value of the UV pointer in sv to val. See C<SvIV_set>.
4946 void SvUV_set(SV* sv, UV val)
4954 Returns a boolean indicating whether the SV contains a v-string.
4961 =item sv_catpvn_nomg
4964 Like C<sv_catpvn> but doesn't process magic.
4966 void sv_catpvn_nomg(SV* sv, const char* ptr, STRLEN len)
4974 Like C<sv_catsv> but doesn't process magic.
4976 void sv_catsv_nomg(SV* dsv, SV* ssv)
4981 =item sv_derived_from
4984 Returns a boolean indicating whether the SV is derived from the specified class
4985 I<at the C level>. To check derivation at the Perl level, call C<isa()> as a
4988 bool sv_derived_from(SV* sv, const char* name)
4991 Found in file universal.c
4996 Returns a boolean indicating whether the SV performs a specific, named role.
4997 The SV can be a Perl object or the name of a Perl class.
4999 bool sv_does(SV* sv, const char* name)
5002 Found in file universal.c
5004 =item sv_report_used
5007 Dump the contents of all SVs not yet freed. (Debugging aid).
5009 void sv_report_used()
5017 Like C<sv_setsv> but doesn't process magic.
5019 void sv_setsv_nomg(SV* dsv, SV* ssv)
5027 =head1 SV-Body Allocation
5031 =item looks_like_number
5032 X<looks_like_number>
5034 Test if the content of an SV looks like a number (or is a number).
5035 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
5036 non-numeric warning), even if your atof() doesn't grok them.
5038 I32 looks_like_number(SV* sv)
5046 Creates an RV wrapper for an SV. The reference count for the original
5047 SV is B<not> incremented.
5049 SV* newRV_noinc(SV* sv)
5057 Creates a new SV. A non-zero C<len> parameter indicates the number of
5058 bytes of preallocated string space the SV should have. An extra byte for a
5059 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
5060 space is allocated.) The reference count for the new SV is set to 1.
5062 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
5063 parameter, I<x>, a debug aid which allowed callers to identify themselves.
5064 This aid has been superseded by a new build option, PERL_MEM_LOG (see
5065 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
5066 modules supporting older perls.
5068 SV* newSV(STRLEN len)
5076 Creates a new SV from the hash key structure. It will generate scalars that
5077 point to the shared string table where possible. Returns a new (undefined)
5078 SV if the hek is NULL.
5080 SV* newSVhek(const HEK *hek)
5088 Creates a new SV and copies an integer into it. The reference count for the
5099 Creates a new SV and copies a floating point value into it.
5100 The reference count for the SV is set to 1.
5110 Creates a new SV and copies a string into it. The reference count for the
5111 SV is set to 1. If C<len> is zero, Perl will compute the length using
5112 strlen(). For efficiency, consider using C<newSVpvn> instead.
5114 SV* newSVpv(const char* s, STRLEN len)
5122 Creates a new SV and initializes it with the string formatted like
5125 SV* newSVpvf(const char* pat, ...)
5133 Creates a new SV and copies a string into it. The reference count for the
5134 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
5135 string. You are responsible for ensuring that the source string is at least
5136 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
5138 SV* newSVpvn(const char* s, STRLEN len)
5143 =item newSVpvn_share
5146 Creates a new SV with its SvPVX_const pointing to a shared string in the string
5147 table. If the string does not already exist in the table, it is created
5148 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
5149 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
5150 otherwise the hash is computed. The idea here is that as the string table
5151 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
5152 hash lookup will avoid string compare.
5154 SV* newSVpvn_share(const char* s, I32 len, U32 hash)
5162 Like C<newSVpvn>, but takes a literal string instead of a string/length pair.
5164 SV* newSVpvs(const char* s)
5167 Found in file handy.h
5169 =item newSVpvs_share
5172 Like C<newSVpvn_share>, but takes a literal string instead of a string/length
5173 pair and omits the hash parameter.
5175 SV* newSVpvs_share(const char* s)
5178 Found in file handy.h
5183 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
5184 it will be upgraded to one. If C<classname> is non-null then the new SV will
5185 be blessed in the specified package. The new SV is returned and its
5186 reference count is 1.
5188 SV* newSVrv(SV* rv, const char* classname)
5196 Creates a new SV which is an exact duplicate of the original SV.
5199 SV* newSVsv(SV* old)
5207 Creates a new SV and copies an unsigned integer into it.
5208 The reference count for the SV is set to 1.
5218 Creates a new SV, of the type specificied. The reference count for the new SV
5221 SV* newSV_type(svtype type)
5229 This function is only called on magical items, and is only used by
5230 sv_true() or its macro equivalent.
5232 bool sv_2bool(SV* sv)
5240 Using various gambits, try to get a CV from an SV; in addition, try if
5241 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
5242 The flags in C<lref> are passed to sv_fetchsv.
5244 CV* sv_2cv(SV* sv, HV** st, GV** gvp, I32 lref)
5252 Using various gambits, try to get an IO from an SV: the IO slot if its a
5253 GV; or the recursive result if we're an RV; or the IO slot of the symbol
5254 named after the PV if we're a string.
5264 Return the integer value of an SV, doing any necessary string
5265 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
5266 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
5268 IV sv_2iv_flags(SV* sv, I32 flags)
5276 Marks an existing SV as mortal. The SV will be destroyed "soon", either
5277 by an explicit call to FREETMPS, or by an implicit call at places such as
5278 statement boundaries. SvTEMP() is turned on which means that the SV's
5279 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
5280 and C<sv_mortalcopy>.
5282 SV* sv_2mortal(SV* sv)
5290 Return the num value of an SV, doing any necessary string or integer
5291 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
5302 Return a pointer to the byte-encoded representation of the SV, and set *lp
5303 to its length. May cause the SV to be downgraded from UTF-8 as a
5306 Usually accessed via the C<SvPVbyte> macro.
5308 char* sv_2pvbyte(SV* sv, STRLEN* lp)
5316 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
5317 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
5319 Usually accessed via the C<SvPVutf8> macro.
5321 char* sv_2pvutf8(SV* sv, STRLEN* lp)
5329 Returns a pointer to the string value of an SV, and sets *lp to its length.
5330 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
5332 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
5333 usually end up here too.
5335 char* sv_2pv_flags(SV* sv, STRLEN* lp, I32 flags)
5343 Return the unsigned integer value of an SV, doing any necessary string
5344 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
5345 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
5347 UV sv_2uv_flags(SV* sv, I32 flags)
5355 Remove any string offset. You should normally use the C<SvOOK_off> macro
5358 int sv_backoff(SV* sv)
5366 Blesses an SV into a specified package. The SV must be an RV. The package
5367 must be designated by its stash (see C<gv_stashpv()>). The reference count
5368 of the SV is unaffected.
5370 SV* sv_bless(SV* sv, HV* stash)
5378 Concatenates the string onto the end of the string which is in the SV.
5379 If the SV has the UTF-8 status set, then the bytes appended should be
5380 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
5382 void sv_catpv(SV* sv, const char* ptr)
5390 Processes its arguments like C<sprintf> and appends the formatted
5391 output to an SV. If the appended data contains "wide" characters
5392 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
5393 and characters >255 formatted with %c), the original SV might get
5394 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
5395 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
5396 valid UTF-8; if the original SV was bytes, the pattern should be too.
5398 void sv_catpvf(SV* sv, const char* pat, ...)
5406 Like C<sv_catpvf>, but also handles 'set' magic.
5408 void sv_catpvf_mg(SV *sv, const char* pat, ...)
5416 Concatenates the string onto the end of the string which is in the SV. The
5417 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5418 status set, then the bytes appended should be valid UTF-8.
5419 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
5421 void sv_catpvn(SV* sv, const char* ptr, STRLEN len)
5426 =item sv_catpvn_flags
5429 Concatenates the string onto the end of the string which is in the SV. The
5430 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5431 status set, then the bytes appended should be valid UTF-8.
5432 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
5433 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
5434 in terms of this function.
5436 void sv_catpvn_flags(SV* sv, const char* ptr, STRLEN len, I32 flags)
5444 Like C<sv_catpvn>, but takes a literal string instead of a string/length pair.
5446 void sv_catpvs(SV* sv, const char* s)
5449 Found in file handy.h
5454 Like C<sv_catpv>, but also handles 'set' magic.
5456 void sv_catpv_mg(SV *sv, const char *ptr)
5464 Concatenates the string from SV C<ssv> onto the end of the string in
5465 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
5466 not 'set' magic. See C<sv_catsv_mg>.
5468 void sv_catsv(SV* dsv, SV* ssv)
5473 =item sv_catsv_flags
5476 Concatenates the string from SV C<ssv> onto the end of the string in
5477 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
5478 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
5479 and C<sv_catsv_nomg> are implemented in terms of this function.
5481 void sv_catsv_flags(SV* dsv, SV* ssv, I32 flags)
5489 Efficient removal of characters from the beginning of the string buffer.
5490 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
5491 the string buffer. The C<ptr> becomes the first character of the adjusted
5492 string. Uses the "OOK hack".
5493 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
5494 refer to the same chunk of data.
5496 void sv_chop(SV* sv, const char* ptr)
5504 Clear an SV: call any destructors, free up any memory used by the body,
5505 and free the body itself. The SV's head is I<not> freed, although
5506 its type is set to all 1's so that it won't inadvertently be assumed
5507 to be live during global destruction etc.
5508 This function should only be called when REFCNT is zero. Most of the time
5509 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5512 void sv_clear(SV* sv)
5520 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5521 string in C<sv1> is less than, equal to, or greater than the string in
5522 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5523 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
5525 I32 sv_cmp(SV* sv1, SV* sv2)
5533 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
5534 'use bytes' aware, handles get magic, and will coerce its args to strings
5535 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
5537 I32 sv_cmp_locale(SV* sv1, SV* sv2)
5545 Add Collate Transform magic to an SV if it doesn't already have it.
5547 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
5548 scalar data of the variable, but transformed to such a format that a normal
5549 memory comparison can be used to compare the data according to the locale
5552 char* sv_collxfrm(SV* sv, STRLEN* nxp)
5560 Copies a stringified representation of the source SV into the
5561 destination SV. Automatically performs any necessary mg_get and
5562 coercion of numeric values into strings. Guaranteed to preserve
5563 UTF8 flag even from overloaded objects. Similar in nature to
5564 sv_2pv[_flags] but operates directly on an SV instead of just the
5565 string. Mostly uses sv_2pv_flags to do its work, except when that
5566 would lose the UTF-8'ness of the PV.
5568 void sv_copypv(SV* dsv, SV* ssv)
5576 Auto-decrement of the value in the SV, doing string to numeric conversion
5577 if necessary. Handles 'get' magic.
5587 Returns a boolean indicating whether the strings in the two SVs are
5588 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5589 coerce its args to strings if necessary.
5591 I32 sv_eq(SV* sv1, SV* sv2)
5596 =item sv_force_normal_flags
5597 X<sv_force_normal_flags>
5599 Undo various types of fakery on an SV: if the PV is a shared string, make
5600 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
5601 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
5602 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
5603 then a copy-on-write scalar drops its PV buffer (if any) and becomes
5604 SvPOK_off rather than making a copy. (Used where this scalar is about to be
5605 set to some other value.) In addition, the C<flags> parameter gets passed to
5606 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
5607 with flags set to 0.
5609 void sv_force_normal_flags(SV *sv, U32 flags)
5617 Decrement an SV's reference count, and if it drops to zero, call
5618 C<sv_clear> to invoke destructors and free up any memory used by
5619 the body; finally, deallocate the SV's head itself.
5620 Normally called via a wrapper macro C<SvREFCNT_dec>.
5622 void sv_free(SV* sv)
5630 Get a line from the filehandle and store it into the SV, optionally
5631 appending to the currently-stored string.
5633 char* sv_gets(SV* sv, PerlIO* fp, I32 append)
5641 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
5642 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
5643 Use the C<SvGROW> wrapper instead.
5645 char* sv_grow(SV* sv, STRLEN newlen)
5653 Auto-increment of the value in the SV, doing string to numeric conversion
5654 if necessary. Handles 'get' magic.
5664 Inserts a string at the specified offset/length within the SV. Similar to
5665 the Perl substr() function.
5667 void sv_insert(SV* bigsv, STRLEN offset, STRLEN len, const char* little, STRLEN littlelen)
5675 Returns a boolean indicating whether the SV is blessed into the specified
5676 class. This does not check for subtypes; use C<sv_derived_from> to verify
5677 an inheritance relationship.
5679 int sv_isa(SV* sv, const char* name)
5687 Returns a boolean indicating whether the SV is an RV pointing to a blessed
5688 object. If the SV is not an RV, or if the object is not blessed, then this
5691 int sv_isobject(SV* sv)
5699 Returns the length of the string in the SV. Handles magic and type
5700 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5702 STRLEN sv_len(SV* sv)
5710 Returns the number of characters in the string in an SV, counting wide
5711 UTF-8 bytes as a single character. Handles magic and type coercion.
5713 STRLEN sv_len_utf8(SV* sv)
5721 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
5722 then adds a new magic item of type C<how> to the head of the magic list.
5724 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
5725 handling of the C<name> and C<namlen> arguments.
5727 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
5728 to add more than one instance of the same 'how'.
5730 void sv_magic(SV* sv, SV* obj, int how, const char* name, I32 namlen)
5738 Adds magic to an SV, upgrading it if necessary. Applies the
5739 supplied vtable and returns a pointer to the magic added.
5741 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
5742 In particular, you can add magic to SvREADONLY SVs, and add more than
5743 one instance of the same 'how'.
5745 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
5746 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
5747 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
5748 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
5750 (This is now used as a subroutine by C<sv_magic>.)
5752 MAGIC * sv_magicext(SV* sv, SV* obj, int how, const MGVTBL *vtbl, const char* name, I32 namlen)
5760 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
5761 The new SV is marked as mortal. It will be destroyed "soon", either by an
5762 explicit call to FREETMPS, or by an implicit call at places such as
5763 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
5765 SV* sv_mortalcopy(SV* oldsv)
5773 Creates a new null SV which is mortal. The reference count of the SV is
5774 set to 1. It will be destroyed "soon", either by an explicit call to
5775 FREETMPS, or by an implicit call at places such as statement boundaries.
5776 See also C<sv_mortalcopy> and C<sv_2mortal>.
5786 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5789 SV* sv_newref(SV* sv)
5797 Converts the value pointed to by offsetp from a count of bytes from the
5798 start of the string, to a count of the equivalent number of UTF-8 chars.
5799 Handles magic and type coercion.
5801 void sv_pos_b2u(SV* sv, I32* offsetp)
5809 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5810 the start of the string, to a count of the equivalent number of bytes; if
5811 lenp is non-zero, it does the same to lenp, but this time starting from
5812 the offset, rather than from the start of the string. Handles magic and
5815 void sv_pos_u2b(SV* sv, I32* offsetp, I32* lenp)
5820 =item sv_pvbyten_force
5823 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
5825 char* sv_pvbyten_force(SV* sv, STRLEN* lp)
5833 Get a sensible string out of the SV somehow.
5834 A private implementation of the C<SvPV_force> macro for compilers which
5835 can't cope with complex macro expressions. Always use the macro instead.
5837 char* sv_pvn_force(SV* sv, STRLEN* lp)
5842 =item sv_pvn_force_flags
5843 X<sv_pvn_force_flags>
5845 Get a sensible string out of the SV somehow.
5846 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
5847 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
5848 implemented in terms of this function.
5849 You normally want to use the various wrapper macros instead: see
5850 C<SvPV_force> and C<SvPV_force_nomg>
5852 char* sv_pvn_force_flags(SV* sv, STRLEN* lp, I32 flags)
5857 =item sv_pvutf8n_force
5860 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
5862 char* sv_pvutf8n_force(SV* sv, STRLEN* lp)
5870 Returns a string describing what the SV is a reference to.
5872 const char* sv_reftype(const SV* sv, int ob)
5880 Make the first argument a copy of the second, then delete the original.
5881 The target SV physically takes over ownership of the body of the source SV
5882 and inherits its flags; however, the target keeps any magic it owns,
5883 and any magic in the source is discarded.
5884 Note that this is a rather specialist SV copying operation; most of the
5885 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5887 void sv_replace(SV* sv, SV* nsv)
5895 Underlying implementation for the C<reset> Perl function.
5896 Note that the perl-level function is vaguely deprecated.
5898 void sv_reset(const char* s, HV* stash)
5906 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
5907 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
5908 push a back-reference to this RV onto the array of backreferences
5909 associated with that magic. If the RV is magical, set magic will be
5910 called after the RV is cleared.
5912 SV* sv_rvweaken(SV *sv)
5920 Copies an integer into the given SV, upgrading first if necessary.
5921 Does not handle 'set' magic. See also C<sv_setiv_mg>.
5923 void sv_setiv(SV* sv, IV num)
5931 Like C<sv_setiv>, but also handles 'set' magic.
5933 void sv_setiv_mg(SV *sv, IV i)
5941 Copies a double into the given SV, upgrading first if necessary.
5942 Does not handle 'set' magic. See also C<sv_setnv_mg>.
5944 void sv_setnv(SV* sv, NV num)
5952 Like C<sv_setnv>, but also handles 'set' magic.
5954 void sv_setnv_mg(SV *sv, NV num)
5962 Copies a string into an SV. The string must be null-terminated. Does not
5963 handle 'set' magic. See C<sv_setpv_mg>.
5965 void sv_setpv(SV* sv, const char* ptr)
5973 Works like C<sv_catpvf> but copies the text into the SV instead of
5974 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
5976 void sv_setpvf(SV* sv, const char* pat, ...)
5984 Like C<sv_setpvf>, but also handles 'set' magic.
5986 void sv_setpvf_mg(SV *sv, const char* pat, ...)
5994 Copies an integer into the given SV, also updating its string value.
5995 Does not handle 'set' magic. See C<sv_setpviv_mg>.
5997 void sv_setpviv(SV* sv, IV num)
6005 Like C<sv_setpviv>, but also handles 'set' magic.
6007 void sv_setpviv_mg(SV *sv, IV iv)
6015 Copies a string into an SV. The C<len> parameter indicates the number of
6016 bytes to be copied. If the C<ptr> argument is NULL the SV will become
6017 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
6019 void sv_setpvn(SV* sv, const char* ptr, STRLEN len)
6027 Like C<sv_setpvn>, but also handles 'set' magic.
6029 void sv_setpvn_mg(SV *sv, const char *ptr, STRLEN len)
6037 Like C<sv_setpvn>, but takes a literal string instead of a string/length pair.
6039 void sv_setpvs(SV* sv, const char* s)
6042 Found in file handy.h
6047 Like C<sv_setpv>, but also handles 'set' magic.
6049 void sv_setpv_mg(SV *sv, const char *ptr)
6057 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
6058 argument will be upgraded to an RV. That RV will be modified to point to
6059 the new SV. The C<classname> argument indicates the package for the
6060 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
6061 will have a reference count of 1, and the RV will be returned.
6063 SV* sv_setref_iv(SV* rv, const char* classname, IV iv)
6071 Copies a double into a new SV, optionally blessing the SV. The C<rv>
6072 argument will be upgraded to an RV. That RV will be modified to point to
6073 the new SV. The C<classname> argument indicates the package for the
6074 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
6075 will have a reference count of 1, and the RV will be returned.
6077 SV* sv_setref_nv(SV* rv, const char* classname, NV nv)
6085 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
6086 argument will be upgraded to an RV. That RV will be modified to point to
6087 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
6088 into the SV. The C<classname> argument indicates the package for the
6089 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
6090 will have a reference count of 1, and the RV will be returned.
6092 Do not use with other Perl types such as HV, AV, SV, CV, because those
6093 objects will become corrupted by the pointer copy process.
6095 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
6097 SV* sv_setref_pv(SV* rv, const char* classname, void* pv)
6105 Copies a string into a new SV, optionally blessing the SV. The length of the
6106 string must be specified with C<n>. The C<rv> argument will be upgraded to
6107 an RV. That RV will be modified to point to the new SV. The C<classname>
6108 argument indicates the package for the blessing. Set C<classname> to
6109 C<NULL> to avoid the blessing. The new SV will have a reference count
6110 of 1, and the RV will be returned.
6112 Note that C<sv_setref_pv> copies the pointer while this copies the string.
6114 SV* sv_setref_pvn(SV* rv, const char* classname, const char* pv, STRLEN n)
6122 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
6123 argument will be upgraded to an RV. That RV will be modified to point to
6124 the new SV. The C<classname> argument indicates the package for the
6125 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
6126 will have a reference count of 1, and the RV will be returned.
6128 SV* sv_setref_uv(SV* rv, const char* classname, UV uv)
6136 Copies the contents of the source SV C<ssv> into the destination SV
6137 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
6138 function if the source SV needs to be reused. Does not handle 'set' magic.
6139 Loosely speaking, it performs a copy-by-value, obliterating any previous
6140 content of the destination.
6142 You probably want to use one of the assortment of wrappers, such as
6143 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
6144 C<SvSetMagicSV_nosteal>.
6146 void sv_setsv(SV* dsv, SV* ssv)
6151 =item sv_setsv_flags
6154 Copies the contents of the source SV C<ssv> into the destination SV
6155 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
6156 function if the source SV needs to be reused. Does not handle 'set' magic.
6157 Loosely speaking, it performs a copy-by-value, obliterating any previous
6158 content of the destination.
6159 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
6160 C<ssv> if appropriate, else not. If the C<flags> parameter has the
6161 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
6162 and C<sv_setsv_nomg> are implemented in terms of this function.
6164 You probably want to use one of the assortment of wrappers, such as
6165 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
6166 C<SvSetMagicSV_nosteal>.
6168 This is the primary function for copying scalars, and most other
6169 copy-ish functions and macros use this underneath.
6171 void sv_setsv_flags(SV* dsv, SV* ssv, I32 flags)
6179 Like C<sv_setsv>, but also handles 'set' magic.
6181 void sv_setsv_mg(SV *dstr, SV *sstr)
6189 Copies an unsigned integer into the given SV, upgrading first if necessary.
6190 Does not handle 'set' magic. See also C<sv_setuv_mg>.
6192 void sv_setuv(SV* sv, UV num)
6200 Like C<sv_setuv>, but also handles 'set' magic.
6202 void sv_setuv_mg(SV *sv, UV u)
6210 Test an SV for taintedness. Use C<SvTAINTED> instead.
6211 bool sv_tainted(SV* sv)
6219 Returns true if the SV has a true value by Perl's rules.
6220 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
6221 instead use an in-line version.
6231 Removes all magic of type C<type> from an SV.
6233 int sv_unmagic(SV* sv, int type)
6238 =item sv_unref_flags
6241 Unsets the RV status of the SV, and decrements the reference count of
6242 whatever was being referenced by the RV. This can almost be thought of
6243 as a reversal of C<newSVrv>. The C<cflags> argument can contain
6244 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
6245 (otherwise the decrementing is conditional on the reference count being
6246 different from one or the reference being a readonly SV).
6249 void sv_unref_flags(SV* sv, U32 flags)
6257 Untaint an SV. Use C<SvTAINTED_off> instead.
6258 void sv_untaint(SV* sv)
6266 Upgrade an SV to a more complex form. Generally adds a new body type to the
6267 SV, then copies across as much information as possible from the old body.
6268 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
6270 void sv_upgrade(SV* sv, svtype new_type)
6275 =item sv_usepvn_flags
6278 Tells an SV to use C<ptr> to find its string value. Normally the
6279 string is stored inside the SV but sv_usepvn allows the SV to use an
6280 outside string. The C<ptr> should point to memory that was allocated
6281 by C<malloc>. The string length, C<len>, must be supplied. By default
6282 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
6283 so that pointer should not be freed or used by the programmer after
6284 giving it to sv_usepvn, and neither should any pointers from "behind"
6285 that pointer (e.g. ptr + 1) be used.
6287 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
6288 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
6289 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
6290 C<len>, and already meets the requirements for storing in C<SvPVX>)
6292 void sv_usepvn_flags(SV* sv, char* ptr, STRLEN len, U32 flags)
6297 =item sv_utf8_decode
6300 If the PV of the SV is an octet sequence in UTF-8
6301 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
6302 so that it looks like a character. If the PV contains only single-byte
6303 characters, the C<SvUTF8> flag stays being off.
6304 Scans PV for validity and returns false if the PV is invalid UTF-8.
6306 NOTE: this function is experimental and may change or be
6307 removed without notice.
6309 bool sv_utf8_decode(SV *sv)
6314 =item sv_utf8_downgrade
6315 X<sv_utf8_downgrade>
6317 Attempts to convert the PV of an SV from characters to bytes.
6318 If the PV contains a character beyond byte, this conversion will fail;
6319 in this case, either returns false or, if C<fail_ok> is not
6322 This is not as a general purpose Unicode to byte encoding interface:
6323 use the Encode extension for that.
6325 NOTE: this function is experimental and may change or be
6326 removed without notice.
6328 bool sv_utf8_downgrade(SV *sv, bool fail_ok)
6333 =item sv_utf8_encode
6336 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
6337 flag off so that it looks like octets again.
6339 void sv_utf8_encode(SV *sv)
6344 =item sv_utf8_upgrade
6347 Converts the PV of an SV to its UTF-8-encoded form.
6348 Forces the SV to string form if it is not already.
6349 Always sets the SvUTF8 flag to avoid future validity checks even
6350 if all the bytes have hibit clear.
6352 This is not as a general purpose byte encoding to Unicode interface:
6353 use the Encode extension for that.
6355 STRLEN sv_utf8_upgrade(SV *sv)
6360 =item sv_utf8_upgrade_flags
6361 X<sv_utf8_upgrade_flags>
6363 Converts the PV of an SV to its UTF-8-encoded form.
6364 Forces the SV to string form if it is not already.
6365 Always sets the SvUTF8 flag to avoid future validity checks even
6366 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
6367 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
6368 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
6370 This is not as a general purpose byte encoding to Unicode interface:
6371 use the Encode extension for that.
6373 STRLEN sv_utf8_upgrade_flags(SV *sv, I32 flags)
6381 Processes its arguments like C<vsprintf> and appends the formatted output
6382 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
6384 Usually used via its frontend C<sv_catpvf>.
6386 void sv_vcatpvf(SV* sv, const char* pat, va_list* args)
6394 Processes its arguments like C<vsprintf> and appends the formatted output
6395 to an SV. Uses an array of SVs if the C style variable argument list is
6396 missing (NULL). When running with taint checks enabled, indicates via
6397 C<maybe_tainted> if results are untrustworthy (often due to the use of
6400 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
6402 void sv_vcatpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
6410 Like C<sv_vcatpvf>, but also handles 'set' magic.
6412 Usually used via its frontend C<sv_catpvf_mg>.
6414 void sv_vcatpvf_mg(SV* sv, const char* pat, va_list* args)
6422 Works like C<sv_vcatpvf> but copies the text into the SV instead of
6423 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
6425 Usually used via its frontend C<sv_setpvf>.
6427 void sv_vsetpvf(SV* sv, const char* pat, va_list* args)
6435 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
6438 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
6440 void sv_vsetpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
6448 Like C<sv_vsetpvf>, but also handles 'set' magic.
6450 Usually used via its frontend C<sv_setpvf_mg>.
6452 void sv_vsetpvf_mg(SV* sv, const char* pat, va_list* args)
6460 =head1 Unicode Support
6464 =item bytes_from_utf8
6467 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
6468 Unlike C<utf8_to_bytes> but like C<bytes_to_utf8>, returns a pointer to
6469 the newly-created string, and updates C<len> to contain the new
6470 length. Returns the original string if no conversion occurs, C<len>
6471 is unchanged. Do nothing if C<is_utf8> points to 0. Sets C<is_utf8> to
6472 0 if C<s> is converted or contains all 7bit characters.
6474 NOTE: this function is experimental and may change or be
6475 removed without notice.
6477 U8* bytes_from_utf8(const U8 *s, STRLEN *len, bool *is_utf8)
6480 Found in file utf8.c
6485 Converts a string C<s> of length C<len> from ASCII into UTF-8 encoding.
6486 Returns a pointer to the newly-created string, and sets C<len> to
6487 reflect the new length.
6489 If you want to convert to UTF-8 from other encodings than ASCII,
6490 see sv_recode_to_utf8().
6492 NOTE: this function is experimental and may change or be
6493 removed without notice.
6495 U8* bytes_to_utf8(const U8 *s, STRLEN *len)
6498 Found in file utf8.c
6503 Return true if the strings s1 and s2 differ case-insensitively, false
6504 if not (if they are equal case-insensitively). If u1 is true, the
6505 string s1 is assumed to be in UTF-8-encoded Unicode. If u2 is true,
6506 the string s2 is assumed to be in UTF-8-encoded Unicode. If u1 or u2
6507 are false, the respective string is assumed to be in native 8-bit
6510 If the pe1 and pe2 are non-NULL, the scanning pointers will be copied
6511 in there (they will point at the beginning of the I<next> character).
6512 If the pointers behind pe1 or pe2 are non-NULL, they are the end
6513 pointers beyond which scanning will not continue under any
6514 circumstances. If the byte lengths l1 and l2 are non-zero, s1+l1 and
6515 s2+l2 will be used as goal end pointers that will also stop the scan,
6516 and which qualify towards defining a successful match: all the scans
6517 that define an explicit length must reach their goal pointers for
6518 a match to succeed).
6520 For case-insensitiveness, the "casefolding" of Unicode is used
6521 instead of upper/lowercasing both the characters, see
6522 http://www.unicode.org/unicode/reports/tr21/ (Case Mappings).
6524 I32 ibcmp_utf8(const char* a, char **pe1, UV l1, bool u1, const char* b, char **pe2, UV l2, bool u2)
6527 Found in file utf8.c
6532 Tests if some arbitrary number of bytes begins in a valid UTF-8
6533 character. Note that an INVARIANT (i.e. ASCII) character is a valid
6534 UTF-8 character. The actual number of bytes in the UTF-8 character
6535 will be returned if it is valid, otherwise 0.
6537 STRLEN is_utf8_char(const U8 *p)
6540 Found in file utf8.c
6542 =item is_utf8_string
6545 Returns true if first C<len> bytes of the given string form a valid
6546 UTF-8 string, false otherwise. Note that 'a valid UTF-8 string' does
6547 not mean 'a string that contains code points above 0x7F encoded in UTF-8'
6548 because a valid ASCII string is a valid UTF-8 string.
6550 See also is_utf8_string_loclen() and is_utf8_string_loc().
6552 bool is_utf8_string(const U8 *s, STRLEN len)
6555 Found in file utf8.c
6557 =item is_utf8_string_loc
6558 X<is_utf8_string_loc>
6560 Like is_utf8_string() but stores the location of the failure (in the
6561 case of "utf8ness failure") or the location s+len (in the case of
6562 "utf8ness success") in the C<ep>.
6564 See also is_utf8_string_loclen() and is_utf8_string().
6566 bool is_utf8_string_loc(const U8 *s, STRLEN len, const U8 **p)
6569 Found in file utf8.c
6571 =item is_utf8_string_loclen
6572 X<is_utf8_string_loclen>
6574 Like is_utf8_string() but stores the location of the failure (in the
6575 case of "utf8ness failure") or the location s+len (in the case of
6576 "utf8ness success") in the C<ep>, and the number of UTF-8
6577 encoded characters in the C<el>.
6579 See also is_utf8_string_loc() and is_utf8_string().
6581 bool is_utf8_string_loclen(const U8 *s, STRLEN len, const U8 **ep, STRLEN *el)
6584 Found in file utf8.c
6586 =item pv_uni_display
6589 Build to the scalar dsv a displayable version of the string spv,
6590 length len, the displayable version being at most pvlim bytes long
6591 (if longer, the rest is truncated and "..." will be appended).
6593 The flags argument can have UNI_DISPLAY_ISPRINT set to display
6594 isPRINT()able characters as themselves, UNI_DISPLAY_BACKSLASH
6595 to display the \\[nrfta\\] as the backslashed versions (like '\n')
6596 (UNI_DISPLAY_BACKSLASH is preferred over UNI_DISPLAY_ISPRINT for \\).
6597 UNI_DISPLAY_QQ (and its alias UNI_DISPLAY_REGEX) have both
6598 UNI_DISPLAY_BACKSLASH and UNI_DISPLAY_ISPRINT turned on.
6600 The pointer to the PV of the dsv is returned.
6602 char* pv_uni_display(SV *dsv, const U8 *spv, STRLEN len, STRLEN pvlim, UV flags)
6605 Found in file utf8.c
6610 The encoding is assumed to be an Encode object, the PV of the ssv is
6611 assumed to be octets in that encoding and decoding the input starts
6612 from the position which (PV + *offset) pointed to. The dsv will be
6613 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
6614 when the string tstr appears in decoding output or the input ends on
6615 the PV of the ssv. The value which the offset points will be modified
6616 to the last input position on the ssv.
6618 Returns TRUE if the terminator was found, else returns FALSE.
6620 bool sv_cat_decode(SV* dsv, SV *encoding, SV *ssv, int *offset, char* tstr, int tlen)
6625 =item sv_recode_to_utf8
6626 X<sv_recode_to_utf8>
6628 The encoding is assumed to be an Encode object, on entry the PV
6629 of the sv is assumed to be octets in that encoding, and the sv
6630 will be converted into Unicode (and UTF-8).
6632 If the sv already is UTF-8 (or if it is not POK), or if the encoding
6633 is not a reference, nothing is done to the sv. If the encoding is not
6634 an C<Encode::XS> Encoding object, bad things will happen.
6635 (See F<lib/encoding.pm> and L<Encode>).
6637 The PV of the sv is returned.
6639 char* sv_recode_to_utf8(SV* sv, SV *encoding)
6644 =item sv_uni_display
6647 Build to the scalar dsv a displayable version of the scalar sv,
6648 the displayable version being at most pvlim bytes long
6649 (if longer, the rest is truncated and "..." will be appended).
6651 The flags argument is as in pv_uni_display().
6653 The pointer to the PV of the dsv is returned.
6655 char* sv_uni_display(SV *dsv, SV *ssv, STRLEN pvlim, UV flags)
6658 Found in file utf8.c
6663 The "p" contains the pointer to the UTF-8 string encoding
6664 the character that is being converted.
6666 The "ustrp" is a pointer to the character buffer to put the
6667 conversion result to. The "lenp" is a pointer to the length
6670 The "swashp" is a pointer to the swash to use.
6672 Both the special and normal mappings are stored lib/unicore/To/Foo.pl,
6673 and loaded by SWASHNEW, using lib/utf8_heavy.pl. The special (usually,
6674 but not always, a multicharacter mapping), is tried first.
6676 The "special" is a string like "utf8::ToSpecLower", which means the
6677 hash %utf8::ToSpecLower. The access to the hash is through
6678 Perl_to_utf8_case().
6680 The "normal" is a string like "ToLower" which means the swash
6683 UV to_utf8_case(const U8 *p, U8* ustrp, STRLEN *lenp, SV **swashp, const char *normal, const char *special)
6686 Found in file utf8.c
6691 Convert the UTF-8 encoded character at p to its foldcase version and
6692 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6693 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6694 foldcase version may be longer than the original character (up to
6697 The first character of the foldcased version is returned
6698 (but note, as explained above, that there may be more.)
6700 UV to_utf8_fold(const U8 *p, U8* ustrp, STRLEN *lenp)
6703 Found in file utf8.c
6708 Convert the UTF-8 encoded character at p to its lowercase version and
6709 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6710 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6711 lowercase version may be longer than the original character.
6713 The first character of the lowercased version is returned
6714 (but note, as explained above, that there may be more.)
6716 UV to_utf8_lower(const U8 *p, U8* ustrp, STRLEN *lenp)
6719 Found in file utf8.c
6724 Convert the UTF-8 encoded character at p to its titlecase version and
6725 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6726 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6727 titlecase version may be longer than the original character.
6729 The first character of the titlecased version is returned
6730 (but note, as explained above, that there may be more.)
6732 UV to_utf8_title(const U8 *p, U8* ustrp, STRLEN *lenp)
6735 Found in file utf8.c
6740 Convert the UTF-8 encoded character at p to its uppercase version and
6741 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6742 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since
6743 the uppercase version may be longer than the original character.
6745 The first character of the uppercased version is returned
6746 (but note, as explained above, that there may be more.)
6748 UV to_utf8_upper(const U8 *p, U8* ustrp, STRLEN *lenp)
6751 Found in file utf8.c
6753 =item utf8n_to_uvchr
6758 Returns the native character value of the first character in the string
6760 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6761 length, in bytes, of that character.
6763 Allows length and flags to be passed to low level routine.
6765 UV utf8n_to_uvchr(const U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags)
6768 Found in file utf8.c
6770 =item utf8n_to_uvuni
6773 Bottom level UTF-8 decode routine.
6774 Returns the Unicode code point value of the first character in the string C<s>
6775 which is assumed to be in UTF-8 encoding and no longer than C<curlen>;
6776 C<retlen> will be set to the length, in bytes, of that character.
6778 If C<s> does not point to a well-formed UTF-8 character, the behaviour
6779 is dependent on the value of C<flags>: if it contains UTF8_CHECK_ONLY,
6780 it is assumed that the caller will raise a warning, and this function
6781 will silently just set C<retlen> to C<-1> and return zero. If the
6782 C<flags> does not contain UTF8_CHECK_ONLY, warnings about
6783 malformations will be given, C<retlen> will be set to the expected
6784 length of the UTF-8 character in bytes, and zero will be returned.
6786 The C<flags> can also contain various flags to allow deviations from
6787 the strict UTF-8 encoding (see F<utf8.h>).
6789 Most code should use utf8_to_uvchr() rather than call this directly.
6791 UV utf8n_to_uvuni(const U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags)
6794 Found in file utf8.c
6799 Returns the number of UTF-8 characters between the UTF-8 pointers C<a>
6802 WARNING: use only if you *know* that the pointers point inside the
6805 IV utf8_distance(const U8 *a, const U8 *b)
6808 Found in file utf8.c
6813 Return the UTF-8 pointer C<s> displaced by C<off> characters, either
6814 forward or backward.
6816 WARNING: do not use the following unless you *know* C<off> is within
6817 the UTF-8 data pointed to by C<s> *and* that on entry C<s> is aligned
6818 on the first byte of character or just after the last byte of a character.
6820 U8* utf8_hop(const U8 *s, I32 off)
6823 Found in file utf8.c
6828 Return the length of the UTF-8 char encoded string C<s> in characters.
6829 Stops at C<e> (inclusive). If C<e E<lt> s> or if the scan would end
6830 up past C<e>, croaks.
6832 STRLEN utf8_length(const U8* s, const U8 *e)
6835 Found in file utf8.c
6840 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
6841 Unlike C<bytes_to_utf8>, this over-writes the original string, and
6842 updates len to contain the new length.
6843 Returns zero on failure, setting C<len> to -1.
6845 If you need a copy of the string, see C<bytes_from_utf8>.
6847 NOTE: this function is experimental and may change or be
6848 removed without notice.
6850 U8* utf8_to_bytes(U8 *s, STRLEN *len)
6853 Found in file utf8.c
6858 Returns the native character value of the first character in the string C<s>
6859 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6860 length, in bytes, of that character.
6862 If C<s> does not point to a well-formed UTF-8 character, zero is
6863 returned and retlen is set, if possible, to -1.
6865 UV utf8_to_uvchr(const U8 *s, STRLEN *retlen)
6868 Found in file utf8.c
6873 Returns the Unicode code point of the first character in the string C<s>
6874 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6875 length, in bytes, of that character.
6877 This function should only be used when returned UV is considered
6878 an index into the Unicode semantic tables (e.g. swashes).
6880 If C<s> does not point to a well-formed UTF-8 character, zero is
6881 returned and retlen is set, if possible, to -1.
6883 UV utf8_to_uvuni(const U8 *s, STRLEN *retlen)
6886 Found in file utf8.c
6891 Adds the UTF-8 representation of the Native codepoint C<uv> to the end
6892 of the string C<d>; C<d> should be have at least C<UTF8_MAXBYTES+1> free
6893 bytes available. The return value is the pointer to the byte after the
6894 end of the new character. In other words,
6896 d = uvchr_to_utf8(d, uv);
6898 is the recommended wide native character-aware way of saying
6902 U8* uvchr_to_utf8(U8 *d, UV uv)
6905 Found in file utf8.c
6907 =item uvuni_to_utf8_flags
6908 X<uvuni_to_utf8_flags>
6910 Adds the UTF-8 representation of the Unicode codepoint C<uv> to the end
6911 of the string C<d>; C<d> should be have at least C<UTF8_MAXBYTES+1> free
6912 bytes available. The return value is the pointer to the byte after the
6913 end of the new character. In other words,
6915 d = uvuni_to_utf8_flags(d, uv, flags);
6919 d = uvuni_to_utf8(d, uv);
6921 (which is equivalent to)
6923 d = uvuni_to_utf8_flags(d, uv, 0);
6925 is the recommended Unicode-aware way of saying
6929 U8* uvuni_to_utf8_flags(U8 *d, UV uv, UV flags)
6932 Found in file utf8.c
6937 =head1 Variables created by C<xsubpp> and C<xsubpp> internal functions
6944 Variable which is setup by C<xsubpp> to indicate the stack base offset,
6945 used by the C<ST>, C<XSprePUSH> and C<XSRETURN> macros. The C<dMARK> macro
6946 must be called prior to setup the C<MARK> variable.
6951 Found in file XSUB.h
6956 Variable which is setup by C<xsubpp> to indicate the
6957 class name for a C++ XS constructor. This is always a C<char*>. See C<THIS>.
6962 Found in file XSUB.h
6967 Sets up the C<ax> variable.
6968 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
6973 Found in file XSUB.h
6978 Sets up the C<ax> variable and stack marker variable C<mark>.
6979 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
6984 Found in file XSUB.h
6989 Sets up the C<items> variable.
6990 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
6995 Found in file XSUB.h
7000 Sets up the C<padoff_du> variable for an XSUB that wishes to use
7006 Found in file XSUB.h
7011 Sets up stack and mark pointers for an XSUB, calling dSP and dMARK.
7012 Sets up the C<ax> and C<items> variables by calling C<dAX> and C<dITEMS>.
7013 This is usually handled automatically by C<xsubpp>.
7018 Found in file XSUB.h
7023 Sets up the C<ix> variable for an XSUB which has aliases. This is usually
7024 handled automatically by C<xsubpp>.
7029 Found in file XSUB.h
7034 Variable which is setup by C<xsubpp> to indicate the number of
7035 items on the stack. See L<perlxs/"Variable-length Parameter Lists">.
7040 Found in file XSUB.h
7045 Variable which is setup by C<xsubpp> to indicate which of an
7046 XSUB's aliases was used to invoke it. See L<perlxs/"The ALIAS: Keyword">.
7051 Found in file XSUB.h
7056 Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
7060 Found in file XSUB.h
7065 Variable which is setup by C<xsubpp> to hold the return value for an
7066 XSUB. This is always the proper type for the XSUB. See
7067 L<perlxs/"The RETVAL Variable">.
7072 Found in file XSUB.h
7077 Used to access elements on the XSUB's stack.
7082 Found in file XSUB.h
7087 Variable which is setup by C<xsubpp> to designate the object in a C++
7088 XSUB. This is always the proper type for the C++ object. See C<CLASS> and
7089 L<perlxs/"Using XS With C++">.
7094 Found in file XSUB.h
7099 The SV* corresponding to the $_ variable. Works even if there
7100 is a lexical $_ in scope.
7103 Found in file XSUB.h
7108 Macro to declare an XSUB and its C parameter list. This is handled by
7112 Found in file XSUB.h
7117 The version identifier for an XS module. This is usually
7118 handled automatically by C<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>.
7121 Found in file XSUB.h
7123 =item XS_VERSION_BOOTCHECK
7124 X<XS_VERSION_BOOTCHECK>
7126 Macro to verify that a PM module's $VERSION variable matches the XS
7127 module's C<XS_VERSION> variable. This is usually handled automatically by
7128 C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">.
7130 XS_VERSION_BOOTCHECK;
7133 Found in file XSUB.h
7138 =head1 Warning and Dieing
7145 This is the XSUB-writer's interface to Perl's C<die> function.
7146 Normally call this function the same way you call the C C<printf>
7147 function. Calling C<croak> returns control directly to Perl,
7148 sidestepping the normal C order of execution. See C<warn>.
7150 If you want to throw an exception object, assign the object to
7151 C<$@> and then pass C<NULL> to croak():
7153 errsv = get_sv("@", TRUE);
7154 sv_setsv(errsv, exception_object);
7157 void croak(const char* pat, ...)
7160 Found in file util.c
7165 This is the XSUB-writer's interface to Perl's C<warn> function. Call this
7166 function the same way you call the C C<printf> function. See C<croak>.
7168 void warn(const char* pat, ...)
7171 Found in file util.c
7178 Until May 1997, this document was maintained by Jeff Okamoto
7179 <okamoto@corp.hp.com>. It is now maintained as part of Perl itself.
7181 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
7182 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
7183 Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
7184 Stephen McCamant, and Gurusamy Sarathy.
7186 API Listing originally by Dean Roehrich <roehrich@cray.com>.
7188 Updated to be autogenerated from comments in the source by Benjamin Stuhl.
7192 perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
projects / p5sagit/p5-mst-13.2.git / blob