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 ellipses.
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_ELLIPSES flag is set and not all characters in
898 string were output then an ellipsis 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 ellipses.
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_ctl.c
1204 Locate the CV corresponding to the currently executing sub or eval.
1205 If db_seqp is non_null, skip CVs that are in the DB package and populate
1206 *db_seqp with the cop sequence number at the point that the DB:: code was
1207 entered. (allows debuggers to eval in the scope of the breakpoint rather
1208 than in the scope of the debugger itself).
1210 CV* find_runcv(U32 *db_seqp)
1213 Found in file pp_ctl.c
1218 =head1 Functions in file pp_pack.c
1226 The engine implementing pack() Perl function.
1228 void packlist(SV *cat, const char *pat, const char *patend, SV **beglist, SV **endlist)
1231 Found in file pp_pack.c
1236 The engine implementing unpack() Perl function. C<unpackstring> puts the
1237 extracted list items on the stack and returns the number of elements.
1238 Issue C<PUTBACK> before and C<SPAGAIN> after the call to this function.
1240 I32 unpackstring(const char *pat, const char *patend, const char *s, const char *strend, U32 flags)
1243 Found in file pp_pack.c
1255 Return the SV from the GV.
1265 If C<gv> is a typeglob whose subroutine entry is a constant sub eligible for
1266 inlining, or C<gv> is a placeholder reference that would be promoted to such
1267 a typeglob, then returns the value returned by the sub. Otherwise, returns
1270 SV* gv_const_sv(GV* gv)
1278 Returns the glob with the given C<name> and a defined subroutine or
1279 C<NULL>. The glob lives in the given C<stash>, or in the stashes
1280 accessible via @ISA and UNIVERSAL::.
1282 The argument C<level> should be either 0 or -1. If C<level==0>, as a
1283 side-effect creates a glob with the given C<name> in the given C<stash>
1284 which in the case of success contains an alias for the subroutine, and sets
1285 up caching info for this glob.
1287 This function grants C<"SUPER"> token as a postfix of the stash name. The
1288 GV returned from C<gv_fetchmeth> may be a method cache entry, which is not
1289 visible to Perl code. So when calling C<call_sv>, you should not use
1290 the GV directly; instead, you should use the method's CV, which can be
1291 obtained from the GV with the C<GvCV> macro.
1293 GV* gv_fetchmeth(HV* stash, const char* name, STRLEN len, I32 level)
1298 =item gv_fetchmethod_autoload
1299 X<gv_fetchmethod_autoload>
1301 Returns the glob which contains the subroutine to call to invoke the method
1302 on the C<stash>. In fact in the presence of autoloading this may be the
1303 glob for "AUTOLOAD". In this case the corresponding variable $AUTOLOAD is
1306 The third parameter of C<gv_fetchmethod_autoload> determines whether
1307 AUTOLOAD lookup is performed if the given method is not present: non-zero
1308 means yes, look for AUTOLOAD; zero means no, don't look for AUTOLOAD.
1309 Calling C<gv_fetchmethod> is equivalent to calling C<gv_fetchmethod_autoload>
1310 with a non-zero C<autoload> parameter.
1312 These functions grant C<"SUPER"> token as a prefix of the method name. Note
1313 that if you want to keep the returned glob for a long time, you need to
1314 check for it being "AUTOLOAD", since at the later time the call may load a
1315 different subroutine due to $AUTOLOAD changing its value. Use the glob
1316 created via a side effect to do this.
1318 These functions have the same side-effects and as C<gv_fetchmeth> with
1319 C<level==0>. C<name> should be writable if contains C<':'> or C<'
1320 ''>. The warning against passing the GV returned by C<gv_fetchmeth> to
1321 C<call_sv> apply equally to these functions.
1323 GV* gv_fetchmethod_autoload(HV* stash, const char* name, I32 autoload)
1328 =item gv_fetchmeth_autoload
1329 X<gv_fetchmeth_autoload>
1331 Same as gv_fetchmeth(), but looks for autoloaded subroutines too.
1332 Returns a glob for the subroutine.
1334 For an autoloaded subroutine without a GV, will create a GV even
1335 if C<level < 0>. For an autoloaded subroutine without a stub, GvCV()
1336 of the result may be zero.
1338 GV* gv_fetchmeth_autoload(HV* stash, const char* name, STRLEN len, I32 level)
1346 Returns a pointer to the stash for a specified package. Uses C<strlen> to
1347 determine the length of C<name>, then calls C<gv_stashpvn()>.
1349 HV* gv_stashpv(const char* name, I32 flags)
1357 Returns a pointer to the stash for a specified package. The C<namelen>
1358 parameter indicates the length of the C<name>, in bytes. C<flags> is passed
1359 to C<gv_fetchpvn_flags()>, so if set to C<GV_ADD> then the package will be
1360 created if it does not already exist. If the package does not exist and
1361 C<flags> is 0 (or any other setting that does not create packages) then NULL
1365 HV* gv_stashpvn(const char* name, U32 namelen, I32 flags)
1373 Like C<gv_stashpvn>, but takes a literal string instead of a string/length pair.
1375 HV* gv_stashpvs(const char* name, I32 create)
1378 Found in file handy.h
1383 Returns a pointer to the stash for a specified package. See C<gv_stashpvn>.
1385 HV* gv_stashsv(SV* sv, I32 flags)
1408 Null character pointer. (No longer available when C<PERL_CORE> is defined.)
1411 Found in file handy.h
1432 Null SV pointer. (No longer available when C<PERL_CORE> is defined.)
1435 Found in file handy.h
1440 =head1 Hash Manipulation Functions
1447 Returns the HV of the specified Perl hash. If C<create> is set and the
1448 Perl variable does not exist then it will be created. If C<create> is not
1449 set and the variable does not exist then NULL is returned.
1451 NOTE: the perl_ form of this function is deprecated.
1453 HV* get_hv(const char* name, I32 create)
1456 Found in file perl.c
1461 This flag, used in the length slot of hash entries and magic structures,
1462 specifies the structure contains an C<SV*> pointer where a C<char*> pointer
1463 is to be expected. (For information only--not to be used).
1471 Returns the computed hash stored in the hash entry.
1481 Returns the actual pointer stored in the key slot of the hash entry. The
1482 pointer may be either C<char*> or C<SV*>, depending on the value of
1483 C<HeKLEN()>. Can be assigned to. The C<HePV()> or C<HeSVKEY()> macros are
1484 usually preferable for finding the value of a key.
1494 If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry
1495 holds an C<SV*> key. Otherwise, holds the actual length of the key. Can
1496 be assigned to. The C<HePV()> macro is usually preferable for finding key
1499 STRLEN HeKLEN(HE* he)
1507 Returns the key slot of the hash entry as a C<char*> value, doing any
1508 necessary dereferencing of possibly C<SV*> keys. The length of the string
1509 is placed in C<len> (this is a macro, so do I<not> use C<&len>). If you do
1510 not care about what the length of the key is, you may use the global
1511 variable C<PL_na>, though this is rather less efficient than using a local
1512 variable. Remember though, that hash keys in perl are free to contain
1513 embedded nulls, so using C<strlen()> or similar is not a good way to find
1514 the length of hash keys. This is very similar to the C<SvPV()> macro
1515 described elsewhere in this document. See also C<HeUTF8>.
1517 If you are using C<HePV> to get values to pass to C<newSVpvn()> to create a
1518 new SV, you should consider using C<newSVhek(HeKEY_hek(he))> as it is more
1521 char* HePV(HE* he, STRLEN len)
1529 Returns the key as an C<SV*>, or C<NULL> if the hash entry does not
1530 contain an C<SV*> key.
1540 Returns the key as an C<SV*>. Will create and return a temporary mortal
1541 C<SV*> if the hash entry contains only a C<char*> key.
1543 SV* HeSVKEY_force(HE* he)
1551 Sets the key to a given C<SV*>, taking care to set the appropriate flags to
1552 indicate the presence of an C<SV*> key, and returns the same
1555 SV* HeSVKEY_set(HE* he, SV* sv)
1563 Returns whether the C<char *> value returned by C<HePV> is encoded in UTF-8,
1564 doing any necessary dereferencing of possibly C<SV*> keys. The value returned
1565 will be 0 or non-0, not necesarily 1 (or even a value with any low bits set),
1566 so B<do not> blindly assign this to a C<bool> variable, as C<bool> may be a
1567 typedef for C<char>.
1569 char* HeUTF8(HE* he, STRLEN len)
1577 Returns the value slot (type C<SV*>) stored in the hash entry.
1587 Returns the package name of a stash, or NULL if C<stash> isn't a stash.
1588 See C<SvSTASH>, C<CvSTASH>.
1590 char* HvNAME(HV* stash)
1598 Check that a hash is in an internally consistent state.
1600 void hv_assert(HV* tb)
1608 Clears a hash, making it empty.
1610 void hv_clear(HV* tb)
1615 =item hv_clear_placeholders
1616 X<hv_clear_placeholders>
1618 Clears any placeholders from a hash. If a restricted hash has any of its keys
1619 marked as readonly and the key is subsequently deleted, the key is not actually
1620 deleted but is marked by assigning it a value of &PL_sv_placeholder. This tags
1621 it so it will be ignored by future operations such as iterating over the hash,
1622 but will still allow the hash to have a value reassigned to the key at some
1623 future point. This function clears any such placeholder keys from the hash.
1624 See Hash::Util::lock_keys() for an example of its use.
1626 void hv_clear_placeholders(HV* hb)
1634 Deletes a key/value pair in the hash. The value SV is removed from the
1635 hash and returned to the caller. The C<klen> is the length of the key.
1636 The C<flags> value will normally be zero; if set to G_DISCARD then NULL
1639 SV* hv_delete(HV* tb, const char* key, I32 klen, I32 flags)
1647 Deletes a key/value pair in the hash. The value SV is removed from the
1648 hash and returned to the caller. The C<flags> value will normally be zero;
1649 if set to G_DISCARD then NULL will be returned. C<hash> can be a valid
1650 precomputed hash value, or 0 to ask for it to be computed.
1652 SV* hv_delete_ent(HV* tb, SV* key, I32 flags, U32 hash)
1660 Returns a boolean indicating whether the specified hash key exists. The
1661 C<klen> is the length of the key.
1663 bool hv_exists(HV* tb, const char* key, I32 klen)
1671 Returns a boolean indicating whether the specified hash key exists. C<hash>
1672 can be a valid precomputed hash value, or 0 to ask for it to be
1675 bool hv_exists_ent(HV* tb, SV* key, U32 hash)
1683 Returns the SV which corresponds to the specified key in the hash. The
1684 C<klen> is the length of the key. If C<lval> is set then the fetch will be
1685 part of a store. Check that the return value is non-null before
1686 dereferencing it to an C<SV*>.
1688 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1689 information on how to use this function on tied hashes.
1691 SV** hv_fetch(HV* tb, const char* key, I32 klen, I32 lval)
1699 Like C<hv_fetch>, but takes a literal string instead of a string/length pair.
1701 SV** hv_fetchs(HV* tb, const char* key, I32 lval)
1704 Found in file handy.h
1709 Returns the hash entry which corresponds to the specified key in the hash.
1710 C<hash> must be a valid precomputed hash number for the given C<key>, or 0
1711 if you want the function to compute it. IF C<lval> is set then the fetch
1712 will be part of a store. Make sure the return value is non-null before
1713 accessing it. The return value when C<tb> is a tied hash is a pointer to a
1714 static location, so be sure to make a copy of the structure if you need to
1717 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1718 information on how to use this function on tied hashes.
1720 HE* hv_fetch_ent(HV* tb, SV* key, I32 lval, U32 hash)
1728 Prepares a starting point to traverse a hash table. Returns the number of
1729 keys in the hash (i.e. the same as C<HvKEYS(tb)>). The return value is
1730 currently only meaningful for hashes without tie magic.
1732 NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
1733 hash buckets that happen to be in use. If you still need that esoteric
1734 value, you can get it through the macro C<HvFILL(tb)>.
1737 I32 hv_iterinit(HV* tb)
1745 Returns the key from the current position of the hash iterator. See
1748 char* hv_iterkey(HE* entry, I32* retlen)
1756 Returns the key as an C<SV*> from the current position of the hash
1757 iterator. The return value will always be a mortal copy of the key. Also
1760 SV* hv_iterkeysv(HE* entry)
1768 Returns entries from a hash iterator. See C<hv_iterinit>.
1770 You may call C<hv_delete> or C<hv_delete_ent> on the hash entry that the
1771 iterator currently points to, without losing your place or invalidating your
1772 iterator. Note that in this case the current entry is deleted from the hash
1773 with your iterator holding the last reference to it. Your iterator is flagged
1774 to free the entry on the next call to C<hv_iternext>, so you must not discard
1775 your iterator immediately else the entry will leak - call C<hv_iternext> to
1776 trigger the resource deallocation.
1778 HE* hv_iternext(HV* tb)
1786 Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
1789 SV* hv_iternextsv(HV* hv, char** key, I32* retlen)
1794 =item hv_iternext_flags
1795 X<hv_iternext_flags>
1797 Returns entries from a hash iterator. See C<hv_iterinit> and C<hv_iternext>.
1798 The C<flags> value will normally be zero; if HV_ITERNEXT_WANTPLACEHOLDERS is
1799 set the placeholders keys (for restricted hashes) will be returned in addition
1800 to normal keys. By default placeholders are automatically skipped over.
1801 Currently a placeholder is implemented with a value that is
1802 C<&Perl_sv_placeholder>. Note that the implementation of placeholders and
1803 restricted hashes may change, and the implementation currently is
1804 insufficiently abstracted for any change to be tidy.
1806 NOTE: this function is experimental and may change or be
1807 removed without notice.
1809 HE* hv_iternext_flags(HV* tb, I32 flags)
1817 Returns the value from the current position of the hash iterator. See
1820 SV* hv_iterval(HV* tb, HE* entry)
1828 Adds magic to a hash. See C<sv_magic>.
1830 void hv_magic(HV* hv, GV* gv, int how)
1838 Evaluates the hash in scalar context and returns the result. Handles magic when the hash is tied.
1840 SV* hv_scalar(HV* hv)
1848 Stores an SV in a hash. The hash key is specified as C<key> and C<klen> is
1849 the length of the key. The C<hash> parameter is the precomputed hash
1850 value; if it is zero then Perl will compute it. The return value will be
1851 NULL if the operation failed or if the value did not need to be actually
1852 stored within the hash (as in the case of tied hashes). Otherwise it can
1853 be dereferenced to get the original C<SV*>. Note that the caller is
1854 responsible for suitably incrementing the reference count of C<val> before
1855 the call, and decrementing it if the function returned NULL. Effectively
1856 a successful hv_store 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. hv_store is not implemented as a call to
1861 hv_store_ent, and does not create a temporary SV for the key, so if your
1862 key data is not already in SV form then use hv_store in preference to
1865 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1866 information on how to use this function on tied hashes.
1868 SV** hv_store(HV* tb, const char* key, I32 klen, SV* val, U32 hash)
1876 Like C<hv_store>, but takes a literal string instead of a string/length pair
1877 and omits the hash parameter.
1879 SV** hv_stores(HV* tb, const char* key, NULLOK SV* val)
1882 Found in file handy.h
1887 Stores C<val> in a hash. The hash key is specified as C<key>. The C<hash>
1888 parameter is the precomputed hash value; if it is zero then Perl will
1889 compute it. The return value is the new hash entry so created. It will be
1890 NULL if the operation failed or if the value did not need to be actually
1891 stored within the hash (as in the case of tied hashes). Otherwise the
1892 contents of the return value can be accessed using the C<He?> macros
1893 described here. Note that the caller is responsible for suitably
1894 incrementing the reference count of C<val> before the call, and
1895 decrementing it if the function returned NULL. Effectively a successful
1896 hv_store_ent takes ownership of one reference to C<val>. This is
1897 usually what you want; a newly created SV has a reference count of one, so
1898 if all your code does is create SVs then store them in a hash, hv_store
1899 will own the only reference to the new SV, and your code doesn't need to do
1900 anything further to tidy up. Note that hv_store_ent only reads the C<key>;
1901 unlike C<val> it does not take ownership of it, so maintaining the correct
1902 reference count on C<key> is entirely the caller's responsibility. hv_store
1903 is not implemented as a call to hv_store_ent, and does not create a temporary
1904 SV for the key, so if your key data is not already in SV form then use
1905 hv_store in preference to hv_store_ent.
1907 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1908 information on how to use this function on tied hashes.
1910 HE* hv_store_ent(HV* tb, SV* key, SV* val, U32 hash)
1920 void hv_undef(HV* tb)
1928 Creates a new HV. The reference count is set to 1.
1938 =head1 Magical Functions
1945 Clear something magical that the SV represents. See C<sv_magic>.
1947 int mg_clear(SV* sv)
1955 Copies the magic from one SV to another. See C<sv_magic>.
1957 int mg_copy(SV* sv, SV* nsv, const char* key, I32 klen)
1965 Finds the magic pointer for type matching the SV. See C<sv_magic>.
1967 MAGIC* mg_find(const SV* sv, int type)
1975 Free any magic storage used by the SV. See C<sv_magic>.
1985 Do magic after a value is retrieved from the SV. See C<sv_magic>.
1995 Report on the SV's length. See C<sv_magic>.
1997 U32 mg_length(SV* sv)
2005 Turns on the magical status of an SV. See C<sv_magic>.
2007 void mg_magical(SV* sv)
2015 Do magic after a value is assigned to the SV. See C<sv_magic>.
2025 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
2026 argument more than once.
2028 void SvGETMAGIC(SV* sv)
2036 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
2047 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
2048 argument more than once.
2050 void SvSETMAGIC(SV* sv)
2058 Like C<SvSetSV>, but does any set magic required afterwards.
2060 void SvSetMagicSV(SV* dsb, SV* ssv)
2065 =item SvSetMagicSV_nosteal
2066 X<SvSetMagicSV_nosteal>
2068 Like C<SvSetSV_nosteal>, but does any set magic required afterwards.
2070 void SvSetMagicSV_nosteal(SV* dsv, SV* ssv)
2078 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
2081 void SvSetSV(SV* dsb, SV* ssv)
2086 =item SvSetSV_nosteal
2089 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
2090 ssv. May evaluate arguments more than once.
2092 void SvSetSV_nosteal(SV* dsv, SV* ssv)
2100 Arranges for sv to be shared between threads if a suitable module
2103 void SvSHARE(SV* sv)
2111 Releases a mutual exclusion lock on sv if a suitable module
2114 void SvUNLOCK(SV* sv)
2122 =head1 Memory Management
2129 The XSUB-writer's interface to the C C<memcpy> function. The C<src> is the
2130 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
2131 the type. May fail on overlapping copies. See also C<Move>.
2133 void Copy(void* src, void* dest, int nitems, type)
2136 Found in file handy.h
2141 Like C<Copy> but returns dest. Useful for encouraging compilers to tail-call
2144 void * CopyD(void* src, void* dest, int nitems, type)
2147 Found in file handy.h
2152 The XSUB-writer's interface to the C C<memmove> function. The C<src> is the
2153 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
2154 the type. Can do overlapping moves. See also C<Copy>.
2156 void Move(void* src, void* dest, int nitems, type)
2159 Found in file handy.h
2164 Like C<Move> but returns dest. Useful for encouraging compilers to tail-call
2167 void * MoveD(void* src, void* dest, int nitems, type)
2170 Found in file handy.h
2175 The XSUB-writer's interface to the C C<malloc> function.
2177 In 5.9.3, Newx() and friends replace the older New() API, and drops
2178 the first parameter, I<x>, a debug aid which allowed callers to identify
2179 themselves. This aid has been superseded by a new build option,
2180 PERL_MEM_LOG (see L<perlhack/PERL_MEM_LOG>). The older API is still
2181 there for use in XS modules supporting older perls.
2183 void Newx(void* ptr, int nitems, type)
2186 Found in file handy.h
2191 The XSUB-writer's interface to the C C<malloc> function, with
2192 cast. See also C<Newx>.
2194 void Newxc(void* ptr, int nitems, type, cast)
2197 Found in file handy.h
2202 The XSUB-writer's interface to the C C<malloc> function. The allocated
2203 memory is zeroed with C<memzero>. See also C<Newx>.
2205 void Newxz(void* ptr, int nitems, type)
2208 Found in file handy.h
2213 PoisonWith(0xEF) for catching access to freed memory.
2215 void Poison(void* dest, int nitems, type)
2218 Found in file handy.h
2223 PoisonWith(0xEF) for catching access to freed memory.
2225 void PoisonFree(void* dest, int nitems, type)
2228 Found in file handy.h
2233 PoisonWith(0xAB) for catching access to allocated but uninitialized memory.
2235 void PoisonNew(void* dest, int nitems, type)
2238 Found in file handy.h
2243 Fill up memory with a byte pattern (a byte repeated over and over
2244 again) that hopefully catches attempts to access uninitialized memory.
2246 void PoisonWith(void* dest, int nitems, type, U8 byte)
2249 Found in file handy.h
2254 The XSUB-writer's interface to the C C<realloc> function.
2256 void Renew(void* ptr, int nitems, type)
2259 Found in file handy.h
2264 The XSUB-writer's interface to the C C<realloc> function, with
2267 void Renewc(void* ptr, int nitems, type, cast)
2270 Found in file handy.h
2275 The XSUB-writer's interface to the C C<free> function.
2277 void Safefree(void* ptr)
2280 Found in file handy.h
2285 Perl's version of C<strdup()>. Returns a pointer to a newly allocated
2286 string which is a duplicate of C<pv>. The size of the string is
2287 determined by C<strlen()>. The memory allocated for the new string can
2288 be freed with the C<Safefree()> function.
2290 char* savepv(const char* pv)
2293 Found in file util.c
2298 Perl's version of what C<strndup()> would be if it existed. Returns a
2299 pointer to a newly allocated string which is a duplicate of the first
2300 C<len> bytes from C<pv>, plus a trailing NUL byte. The memory allocated for
2301 the new string can be freed with the C<Safefree()> function.
2303 char* savepvn(const char* pv, I32 len)
2306 Found in file util.c
2311 Like C<savepvn>, but takes a literal string instead of a string/length pair.
2313 char* savepvs(const char* s)
2316 Found in file handy.h
2321 A version of C<savepv()> which allocates the duplicate string in memory
2322 which is shared between threads.
2324 char* savesharedpv(const char* pv)
2327 Found in file util.c
2332 A version of C<savepvn()> which allocates the duplicate string in memory
2333 which is shared between threads. (With the specific difference that a NULL
2334 pointer is not acceptable)
2336 char* savesharedpvn(const char *const pv, const STRLEN len)
2339 Found in file util.c
2344 A version of C<savepv()>/C<savepvn()> which gets the string to duplicate from
2345 the passed in SV using C<SvPV()>
2347 char* savesvpv(SV* sv)
2350 Found in file util.c
2355 This is an architecture-independent macro to copy one structure to another.
2357 void StructCopy(type src, type dest, type)
2360 Found in file handy.h
2365 The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the
2366 destination, C<nitems> is the number of items, and C<type> is the type.
2368 void Zero(void* dest, int nitems, type)
2371 Found in file handy.h
2376 Like C<Zero> but returns dest. Useful for encouraging compilers to tail-call
2379 void * ZeroD(void* dest, int nitems, type)
2382 Found in file handy.h
2387 =head1 Miscellaneous Functions
2394 Analyses the string in order to make fast searches on it using fbm_instr()
2395 -- the Boyer-Moore algorithm.
2397 void fbm_compile(SV* sv, U32 flags)
2400 Found in file util.c
2405 Returns the location of the SV in the string delimited by C<str> and
2406 C<strend>. It returns C<NULL> if the string can't be found. The C<sv>
2407 does not have to be fbm_compiled, but the search will not be as fast
2410 char* fbm_instr(unsigned char* big, unsigned char* bigend, SV* littlesv, U32 flags)
2413 Found in file util.c
2418 Takes a sprintf-style format pattern and conventional
2419 (non-SV) arguments and returns the formatted string.
2421 (char *) Perl_form(pTHX_ const char* pat, ...)
2423 can be used any place a string (char *) is required:
2425 char * s = Perl_form("%d.%d",major,minor);
2427 Uses a single private buffer so if you want to format several strings you
2428 must explicitly copy the earlier strings away (and free the copies when you
2431 char* form(const char* pat, ...)
2434 Found in file util.c
2439 Fill the sv with current working directory
2441 int getcwd_sv(SV* sv)
2444 Found in file util.c
2449 The C library C<snprintf> functionality, if available and
2450 standards-compliant (uses C<vsnprintf>, actually). However, if the
2451 C<vsnprintf> is not available, will unfortunately use the unsafe
2452 C<vsprintf> which can overrun the buffer (there is an overrun check,
2453 but that may be too late). Consider using C<sv_vcatpvf> instead, or
2454 getting C<vsnprintf>.
2456 int my_snprintf(char *buffer, const Size_t len, const char *format, ...)
2459 Found in file util.c
2464 The C library C<sprintf>, wrapped if necessary, to ensure that it will return
2465 the length of the string written to the buffer. Only rare pre-ANSI systems
2466 need the wrapper function - usually this is a direct call to C<sprintf>.
2468 int my_sprintf(char *buffer, const char *pat, ...)
2471 Found in file util.c
2476 The C library C<vsnprintf> if available and standards-compliant.
2477 However, if if the C<vsnprintf> is not available, will unfortunately
2478 use the unsafe C<vsprintf> which can overrun the buffer (there is an
2479 overrun check, but that may be too late). Consider using
2480 C<sv_vcatpvf> instead, or getting C<vsnprintf>.
2482 int my_vsnprintf(char *buffer, const Size_t len, const char *format, va_list ap)
2485 Found in file util.c
2490 Returns a new version object based on the passed in SV:
2492 SV *sv = new_version(SV *ver);
2494 Does not alter the passed in ver SV. See "upg_version" if you
2495 want to upgrade the SV.
2497 SV* new_version(SV *ver)
2500 Found in file util.c
2505 Returns a pointer to the next character after the parsed
2506 version string, as well as upgrading the passed in SV to
2509 Function must be called with an already existing SV like
2512 s = scan_version(s, SV *sv, bool qv);
2514 Performs some preprocessing to the string to ensure that
2515 it has the correct characteristics of a version. Flags the
2516 object if it contains an underscore (which denotes this
2517 is an alpha version). The boolean qv denotes that the version
2518 should be interpreted as if it had multiple decimals, even if
2521 const char* scan_version(const char *vstr, SV *sv, bool qv)
2524 Found in file util.c
2529 Test two strings to see if they are equal. Returns true or false.
2531 bool strEQ(char* s1, char* s2)
2534 Found in file handy.h
2539 Test two strings to see if the first, C<s1>, is greater than or equal to
2540 the second, C<s2>. Returns true or false.
2542 bool strGE(char* s1, char* s2)
2545 Found in file handy.h
2550 Test two strings to see if the first, C<s1>, is greater than the second,
2551 C<s2>. Returns true or false.
2553 bool strGT(char* s1, char* s2)
2556 Found in file handy.h
2561 Test two strings to see if the first, C<s1>, is less than or equal to the
2562 second, C<s2>. Returns true or false.
2564 bool strLE(char* s1, char* s2)
2567 Found in file handy.h
2572 Test two strings to see if the first, C<s1>, is less than the second,
2573 C<s2>. Returns true or false.
2575 bool strLT(char* s1, char* s2)
2578 Found in file handy.h
2583 Test two strings to see if they are different. Returns true or
2586 bool strNE(char* s1, char* s2)
2589 Found in file handy.h
2594 Test two strings to see if they are equal. The C<len> parameter indicates
2595 the number of bytes to compare. Returns true or false. (A wrapper for
2598 bool strnEQ(char* s1, char* s2, STRLEN len)
2601 Found in file handy.h
2606 Test two strings to see if they are different. The C<len> parameter
2607 indicates the number of bytes to compare. Returns true or false. (A
2608 wrapper for C<strncmp>).
2610 bool strnNE(char* s1, char* s2, STRLEN len)
2613 Found in file handy.h
2615 =item sv_destroyable
2618 Dummy routine which reports that object can be destroyed when there is no
2619 sharing module present. It ignores its single SV argument, and returns
2620 'true'. Exists to avoid test for a NULL function pointer and because it
2621 could potentially warn under some level of strict-ness.
2623 bool sv_destroyable(SV *sv)
2626 Found in file util.c
2631 Dummy routine which "shares" an SV when there is no sharing module present.
2632 Or "locks" it. Or "unlocks" it. In other words, ignores its single SV argument.
2633 Exists to avoid test for a NULL function pointer and because it could
2634 potentially warn under some level of strict-ness.
2636 void sv_nosharing(SV *sv)
2639 Found in file util.c
2644 In-place upgrade of the supplied SV to a version object.
2646 SV *sv = upg_version(SV *sv, bool qv);
2648 Returns a pointer to the upgraded SV. Set the boolean qv if you want
2649 to force this SV to be interpreted as an "extended" version.
2651 SV* upg_version(SV *ver, bool qv)
2654 Found in file util.c
2659 Version object aware cmp. Both operands must already have been
2660 converted into version objects.
2662 int vcmp(SV *lvs, SV *rvs)
2665 Found in file util.c
2670 Accepts a version object and returns the normalized string
2671 representation. Call like:
2675 NOTE: you can pass either the object directly or the SV
2676 contained within the RV.
2681 Found in file util.c
2686 Accepts a version object and returns the normalized floating
2687 point representation. Call like:
2691 NOTE: you can pass either the object directly or the SV
2692 contained within the RV.
2697 Found in file util.c
2702 In order to maintain maximum compatibility with earlier versions
2703 of Perl, this function will return either the floating point
2704 notation or the multiple dotted notation, depending on whether
2705 the original version contained 1 or more dots, respectively
2707 SV* vstringify(SV *vs)
2710 Found in file util.c
2715 Validates that the SV contains a valid version object.
2717 bool vverify(SV *vobj);
2719 Note that it only confirms the bare minimum structure (so as not to get
2720 confused by derived classes which may contain additional hash entries):
2722 bool vverify(SV *vs)
2725 Found in file util.c
2730 =head1 MRO Functions
2734 =item mro_get_linear_isa
2735 X<mro_get_linear_isa>
2737 Returns either C<mro_get_linear_isa_c3> or
2738 C<mro_get_linear_isa_dfs> for the given stash,
2739 dependant upon which MRO is in effect
2740 for that stash. The return value is a
2743 You are responsible for C<SvREFCNT_inc()> on the
2744 return value if you plan to store it anywhere
2745 semi-permanently (otherwise it might be deleted
2746 out from under you the next time the cache is
2749 AV* mro_get_linear_isa(HV* stash)
2754 =item mro_method_changed_in
2755 X<mro_method_changed_in>
2757 Invalidates method caching on any child classes
2758 of the given stash, so that they might notice
2759 the changes in this one.
2761 Ideally, all instances of C<PL_sub_generation++> in
2762 perl source outside of C<mro.c> should be
2763 replaced by calls to this.
2765 Perl automatically handles most of the common
2766 ways a method might be redefined. However, there
2767 are a few ways you could change a method in a stash
2768 without the cache code noticing, in which case you
2769 need to call this method afterwards:
2771 1) Directly manipulating the stash HV entries from
2774 2) Assigning a reference to a readonly scalar
2775 constant into a stash entry in order to create
2776 a constant subroutine (like constant.pm
2779 This same method is available from pure perl
2780 via, C<mro::method_changed_in(classname)>.
2782 void mro_method_changed_in(HV* stash)
2790 =head1 Multicall Functions
2797 Declare local variables for a multicall. See L<perlcall/Lightweight Callbacks>.
2807 Make a lightweight callback. See L<perlcall/Lightweight Callbacks>.
2817 Closing bracket for a lightweight callback.
2818 See L<perlcall/Lightweight Callbacks>.
2825 =item PUSH_MULTICALL
2828 Opening bracket for a lightweight callback.
2829 See L<perlcall/Lightweight Callbacks>.
2839 =head1 Numeric functions
2846 converts a string representing a binary number to numeric form.
2848 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2849 conversion flags, and I<result> should be NULL or a pointer to an NV.
2850 The scan stops at the end of the string, or the first invalid character.
2851 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2852 invalid character will also trigger a warning.
2853 On return I<*len> is set to the length of the scanned string,
2854 and I<*flags> gives output flags.
2856 If the value is <= C<UV_MAX> it is returned as a UV, the output flags are clear,
2857 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_bin>
2858 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2859 and writes the value to I<*result> (or the value is discarded if I<result>
2862 The binary number may optionally be prefixed with "0b" or "b" unless
2863 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
2864 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the binary
2865 number may use '_' characters to separate digits.
2867 UV grok_bin(const char* start, STRLEN* len_p, I32* flags, NV *result)
2870 Found in file numeric.c
2875 converts a string representing a hex number to numeric form.
2877 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2878 conversion flags, and I<result> should be NULL or a pointer to an NV.
2879 The scan stops at the end of the string, or the first invalid character.
2880 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2881 invalid character will also trigger a warning.
2882 On return I<*len> is set to the length of the scanned string,
2883 and I<*flags> gives output flags.
2885 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2886 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_hex>
2887 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2888 and writes the value to I<*result> (or the value is discarded if I<result>
2891 The hex number may optionally be prefixed with "0x" or "x" unless
2892 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
2893 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the hex
2894 number may use '_' characters to separate digits.
2896 UV grok_hex(const char* start, STRLEN* len_p, I32* flags, NV *result)
2899 Found in file numeric.c
2904 Recognise (or not) a number. The type of the number is returned
2905 (0 if unrecognised), otherwise it is a bit-ORed combination of
2906 IS_NUMBER_IN_UV, IS_NUMBER_GREATER_THAN_UV_MAX, IS_NUMBER_NOT_INT,
2907 IS_NUMBER_NEG, IS_NUMBER_INFINITY, IS_NUMBER_NAN (defined in perl.h).
2909 If the value of the number can fit an in UV, it is returned in the *valuep
2910 IS_NUMBER_IN_UV will be set to indicate that *valuep is valid, IS_NUMBER_IN_UV
2911 will never be set unless *valuep is valid, but *valuep may have been assigned
2912 to during processing even though IS_NUMBER_IN_UV is not set on return.
2913 If valuep is NULL, IS_NUMBER_IN_UV will be set for the same cases as when
2914 valuep is non-NULL, but no actual assignment (or SEGV) will occur.
2916 IS_NUMBER_NOT_INT will be set with IS_NUMBER_IN_UV if trailing decimals were
2917 seen (in which case *valuep gives the true value truncated to an integer), and
2918 IS_NUMBER_NEG if the number is negative (in which case *valuep holds the
2919 absolute value). IS_NUMBER_IN_UV is not set if e notation was used or the
2920 number is larger than a UV.
2922 int grok_number(const char *pv, STRLEN len, UV *valuep)
2925 Found in file numeric.c
2927 =item grok_numeric_radix
2928 X<grok_numeric_radix>
2930 Scan and skip for a numeric decimal separator (radix).
2932 bool grok_numeric_radix(const char **sp, const char *send)
2935 Found in file numeric.c
2940 converts a string representing an octal number to numeric form.
2942 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2943 conversion flags, and I<result> should be NULL or a pointer to an NV.
2944 The scan stops at the end of the string, or the first invalid character.
2945 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2946 invalid character will also trigger a warning.
2947 On return I<*len> is set to the length of the scanned string,
2948 and I<*flags> gives output flags.
2950 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2951 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_oct>
2952 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2953 and writes the value to I<*result> (or the value is discarded if I<result>
2956 If C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the octal
2957 number may use '_' characters to separate digits.
2959 UV grok_oct(const char* start, STRLEN* len_p, I32* flags, NV *result)
2962 Found in file numeric.c
2967 Return a non-zero integer if the sign bit on an NV is set, and 0 if
2970 If Configure detects this system has a signbit() that will work with
2971 our NVs, then we just use it via the #define in perl.h. Otherwise,
2972 fall back on this implementation. As a first pass, this gets everything
2973 right except -0.0. Alas, catching -0.0 is the main use for this function,
2974 so this is not too helpful yet. Still, at least we have the scaffolding
2975 in place to support other systems, should that prove useful.
2978 Configure notes: This function is called 'Perl_signbit' instead of a
2979 plain 'signbit' because it is easy to imagine a system having a signbit()
2980 function or macro that doesn't happen to work with our particular choice
2981 of NVs. We shouldn't just re-#define signbit as Perl_signbit and expect
2982 the standard system headers to be happy. Also, this is a no-context
2983 function (no pTHX_) because Perl_signbit() is usually re-#defined in
2984 perl.h as a simple macro call to the system's signbit().
2985 Users should just always call Perl_signbit().
2987 NOTE: this function is experimental and may change or be
2988 removed without notice.
2990 int Perl_signbit(NV f)
2993 Found in file numeric.c
2998 For backwards compatibility. Use C<grok_bin> instead.
3000 NV scan_bin(const char* start, STRLEN len, STRLEN* retlen)
3003 Found in file numeric.c
3008 For backwards compatibility. Use C<grok_hex> instead.
3010 NV scan_hex(const char* start, STRLEN len, STRLEN* retlen)
3013 Found in file numeric.c
3018 For backwards compatibility. Use C<grok_oct> instead.
3020 NV scan_oct(const char* start, STRLEN len, STRLEN* retlen)
3023 Found in file numeric.c
3028 =head1 Optree Manipulation Functions
3035 If C<cv> is a constant sub eligible for inlining. returns the constant
3036 value returned by the sub. Otherwise, returns NULL.
3038 Constant subs can be created with C<newCONSTSUB> or as described in
3039 L<perlsub/"Constant Functions">.
3041 SV* cv_const_sv(CV* cv)
3049 Creates a constant sub equivalent to Perl C<sub FOO () { 123 }> which is
3050 eligible for inlining at compile-time.
3052 CV* newCONSTSUB(HV* stash, const char* name, SV* sv)
3060 Used by C<xsubpp> to hook up XSUBs as Perl subs. I<filename> needs to be
3061 static storage, as it is used directly as CvFILE(), without a copy being made.
3069 =head1 Pad Data Structures
3076 Get the value at offset po in the current pad.
3077 Use macro PAD_SV instead of calling this function directly.
3079 SV* pad_sv(PADOFFSET po)
3087 =head1 Per-Interpreter Variables
3094 C<PL_modglobal> is a general purpose, interpreter global HV for use by
3095 extensions that need to keep information on a per-interpreter basis.
3096 In a pinch, it can also be used as a symbol table for extensions
3097 to share data among each other. It is a good idea to use keys
3098 prefixed by the package name of the extension that owns the data.
3103 Found in file intrpvar.h
3108 A convenience variable which is typically used with C<SvPV> when one
3109 doesn't care about the length of the string. It is usually more efficient
3110 to either declare a local variable and use that instead or to use the
3111 C<SvPV_nolen> macro.
3116 Found in file intrpvar.h
3121 This is the C<false> SV. See C<PL_sv_yes>. Always refer to this as
3127 Found in file intrpvar.h
3132 This is the C<undef> SV. Always refer to this as C<&PL_sv_undef>.
3137 Found in file intrpvar.h
3142 This is the C<true> SV. See C<PL_sv_no>. Always refer to this as
3148 Found in file intrpvar.h
3153 =head1 REGEXP Functions
3160 Convenience macro to get the REGEXP from a SV. This is approximately
3161 equivalent to the following snippet:
3166 (tmpsv = (SV*)SvRV(sv)) &&
3167 SvTYPE(tmpsv) == SVt_PVMG &&
3168 (tmpmg = mg_find(tmpsv, PERL_MAGIC_qr)))
3170 return (REGEXP *)tmpmg->mg_obj;
3173 NULL will be returned if a REGEXP* is not found.
3175 REGEXP * SvRX(SV *sv)
3178 Found in file regexp.h
3183 Returns a boolean indicating whether the SV contains qr magic
3186 If you want to do something with the REGEXP* later use SvRX instead
3192 Found in file regexp.h
3197 =head1 Simple Exception Handling Macros
3204 Set up necessary local variables for exception handling.
3205 See L<perlguts/"Exception Handling">.
3210 Found in file XSUB.h
3215 Introduces a catch block. See L<perlguts/"Exception Handling">.
3218 Found in file XSUB.h
3223 Rethrows a previously caught exception. See L<perlguts/"Exception Handling">.
3228 Found in file XSUB.h
3233 Ends a try block. See L<perlguts/"Exception Handling">.
3236 Found in file XSUB.h
3238 =item XCPT_TRY_START
3241 Starts a try block. See L<perlguts/"Exception Handling">.
3244 Found in file XSUB.h
3249 =head1 Stack Manipulation Macros
3256 Declare a stack marker variable, C<mark>, for the XSUB. See C<MARK> and
3267 Saves the original stack mark for the XSUB. See C<ORIGMARK>.
3277 Declares a local copy of perl's stack pointer for the XSUB, available via
3278 the C<SP> macro. See C<SP>.
3288 Used to extend the argument stack for an XSUB's return values. Once
3289 used, guarantees that there is room for at least C<nitems> to be pushed
3292 void EXTEND(SP, int nitems)
3300 Stack marker variable for the XSUB. See C<dMARK>.
3308 Push an integer onto the stack. The stack must have room for this element.
3309 Does not use C<TARG>. See also C<PUSHi>, C<mXPUSHi> and C<XPUSHi>.
3319 Push a double onto the stack. The stack must have room for this element.
3320 Does not use C<TARG>. See also C<PUSHn>, C<mXPUSHn> and C<XPUSHn>.
3330 Push a string onto the stack. The stack must have room for this element.
3331 The C<len> indicates the length of the string. Does not use C<TARG>.
3332 See also C<PUSHp>, C<mXPUSHp> and C<XPUSHp>.
3334 void mPUSHp(char* str, STRLEN len)
3342 Push an SV onto the stack and mortalizes the SV. The stack must have room
3343 for this element. Does not use C<TARG>. See also C<PUSHs> and C<mXPUSHs>.
3353 Push an unsigned integer onto the stack. The stack must have room for this
3354 element. Does not use C<TARG>. See also C<PUSHu>, C<mXPUSHu> and C<XPUSHu>.
3364 Push an integer onto the stack, extending the stack if necessary.
3365 Does not use C<TARG>. See also C<XPUSHi>, C<mPUSHi> and C<PUSHi>.
3375 Push a double onto the stack, extending the stack if necessary.
3376 Does not use C<TARG>. See also C<XPUSHn>, C<mPUSHn> and C<PUSHn>.
3386 Push a string onto the stack, extending the stack if necessary. The C<len>
3387 indicates the length of the string. Does not use C<TARG>. See also C<XPUSHp>,
3388 C<mPUSHp> and C<PUSHp>.
3390 void mXPUSHp(char* str, STRLEN len)
3398 Push an SV onto the stack, extending the stack if necessary and mortalizes
3399 the SV. Does not use C<TARG>. See also C<XPUSHs> and C<mPUSHs>.
3401 void mXPUSHs(SV* sv)
3409 Push an unsigned integer onto the stack, extending the stack if necessary.
3410 Does not use C<TARG>. See also C<XPUSHu>, C<mPUSHu> and C<PUSHu>.
3420 The original stack mark for the XSUB. See C<dORIGMARK>.
3428 Pops an integer off the stack.
3438 Pops a long off the stack.
3448 Pops a double off the stack.
3458 Pops a string off the stack. Deprecated. New code should use POPpx.
3468 Pops a string off the stack which must consist of bytes i.e. characters < 256.
3478 Pops a string off the stack.
3488 Pops an SV off the stack.
3498 Push an integer onto the stack. The stack must have room for this element.
3499 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3500 called to declare it. Do not call multiple C<TARG>-oriented macros to
3501 return lists from XSUB's - see C<mPUSHi> instead. See also C<XPUSHi> and
3512 Opening bracket for arguments on a callback. See C<PUTBACK> and
3523 Push a new mortal SV onto the stack. The stack must have room for this
3524 element. Does not use C<TARG>. See also C<PUSHs>, C<XPUSHmortal> and C<XPUSHs>.
3534 Push a double onto the stack. The stack must have room for this element.
3535 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3536 called to declare it. Do not call multiple C<TARG>-oriented macros to
3537 return lists from XSUB's - see C<mPUSHn> instead. See also C<XPUSHn> and
3548 Push a string onto the stack. The stack must have room for this element.
3549 The C<len> indicates the length of the string. Handles 'set' magic. Uses
3550 C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to declare it. Do not
3551 call multiple C<TARG>-oriented macros to return lists from XSUB's - see
3552 C<mPUSHp> instead. See also C<XPUSHp> and C<mXPUSHp>.
3554 void PUSHp(char* str, STRLEN len)
3562 Push an SV onto the stack. The stack must have room for this element.
3563 Does not handle 'set' magic. Does not use C<TARG>. See also C<PUSHmortal>,
3564 C<XPUSHs> and C<XPUSHmortal>.
3574 Push an unsigned integer onto the stack. The stack must have room for this
3575 element. Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG>
3576 should be called to declare it. Do not call multiple C<TARG>-oriented
3577 macros to return lists from XSUB's - see C<mPUSHu> instead. See also
3578 C<XPUSHu> and C<mXPUSHu>.
3588 Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
3589 See C<PUSHMARK> and L<perlcall> for other uses.
3599 Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and
3608 Refetch the stack pointer. Used after a callback. See L<perlcall>.
3618 Push an integer onto the stack, extending the stack if necessary. Handles
3619 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
3620 declare it. Do not call multiple C<TARG>-oriented macros to return lists
3621 from XSUB's - see C<mXPUSHi> instead. See also C<PUSHi> and C<mPUSHi>.
3631 Push a new mortal SV onto the stack, extending the stack if necessary.
3632 Does not use C<TARG>. See also C<XPUSHs>, C<PUSHmortal> and C<PUSHs>.
3642 Push a double onto the stack, extending the stack if necessary. Handles
3643 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
3644 declare it. Do not call multiple C<TARG>-oriented macros to return lists
3645 from XSUB's - see C<mXPUSHn> instead. See also C<PUSHn> and C<mPUSHn>.
3655 Push a string onto the stack, extending the stack if necessary. The C<len>
3656 indicates the length of the string. Handles 'set' magic. Uses C<TARG>, so
3657 C<dTARGET> or C<dXSTARG> should be called to declare it. Do not call
3658 multiple C<TARG>-oriented macros to return lists from XSUB's - see
3659 C<mXPUSHp> instead. See also C<PUSHp> and C<mPUSHp>.
3661 void XPUSHp(char* str, STRLEN len)
3669 Push an SV onto the stack, extending the stack if necessary. Does not
3670 handle 'set' magic. Does not use C<TARG>. See also C<XPUSHmortal>,
3671 C<PUSHs> and C<PUSHmortal>.
3681 Push an unsigned integer onto the stack, extending the stack if necessary.
3682 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3683 called to declare it. Do not call multiple C<TARG>-oriented macros to
3684 return lists from XSUB's - see C<mXPUSHu> instead. See also C<PUSHu> and
3695 Return from XSUB, indicating number of items on the stack. This is usually
3696 handled by C<xsubpp>.
3698 void XSRETURN(int nitems)
3701 Found in file XSUB.h
3703 =item XSRETURN_EMPTY
3706 Return an empty list from an XSUB immediately.
3711 Found in file XSUB.h
3716 Return an integer from an XSUB immediately. Uses C<XST_mIV>.
3718 void XSRETURN_IV(IV iv)
3721 Found in file XSUB.h
3726 Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
3731 Found in file XSUB.h
3736 Return a double from an XSUB immediately. Uses C<XST_mNV>.
3738 void XSRETURN_NV(NV nv)
3741 Found in file XSUB.h
3746 Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
3748 void XSRETURN_PV(char* str)
3751 Found in file XSUB.h
3753 =item XSRETURN_UNDEF
3756 Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
3761 Found in file XSUB.h
3766 Return an integer from an XSUB immediately. Uses C<XST_mUV>.
3768 void XSRETURN_UV(IV uv)
3771 Found in file XSUB.h
3776 Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
3781 Found in file XSUB.h
3786 Place an integer into the specified position C<pos> on the stack. The
3787 value is stored in a new mortal SV.
3789 void XST_mIV(int pos, IV iv)
3792 Found in file XSUB.h
3797 Place C<&PL_sv_no> into the specified position C<pos> on the
3800 void XST_mNO(int pos)
3803 Found in file XSUB.h
3808 Place a double into the specified position C<pos> on the stack. The value
3809 is stored in a new mortal SV.
3811 void XST_mNV(int pos, NV nv)
3814 Found in file XSUB.h
3819 Place a copy of a string into the specified position C<pos> on the stack.
3820 The value is stored in a new mortal SV.
3822 void XST_mPV(int pos, char* str)
3825 Found in file XSUB.h
3830 Place C<&PL_sv_undef> into the specified position C<pos> on the
3833 void XST_mUNDEF(int pos)
3836 Found in file XSUB.h
3841 Place C<&PL_sv_yes> into the specified position C<pos> on the
3844 void XST_mYES(int pos)
3847 Found in file XSUB.h
3859 An enum of flags for Perl types. These are found in the file B<sv.h>
3860 in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
3868 Integer type flag for scalars. See C<svtype>.
3876 Double type flag for scalars. See C<svtype>.
3884 Pointer type flag for scalars. See C<svtype>.
3892 Type flag for arrays. See C<svtype>.
3900 Type flag for code refs. See C<svtype>.
3908 Type flag for hashes. See C<svtype>.
3916 Type flag for blessed scalars. See C<svtype>.
3924 =head1 SV Manipulation Functions
3931 Returns the SV of the specified Perl scalar. If C<create> is set and the
3932 Perl variable does not exist then it will be created. If C<create> is not
3933 set and the variable does not exist then NULL is returned.
3935 NOTE: the perl_ form of this function is deprecated.
3937 SV* get_sv(const char* name, I32 create)
3940 Found in file perl.c
3945 Creates an RV wrapper for an SV. The reference count for the original SV is
3948 SV* newRV_inc(SV* sv)
3956 Creates a new SV and copies a string into it. If utf8 is true, calls
3957 C<SvUTF8_on> on the new SV. Implemented as a wrapper around C<newSVpvn_flags>.
3959 SV* newSVpvn_utf8(NULLOK const char* s, STRLEN len, U32 utf8)
3967 Returns the length of the string which is in the SV. See C<SvLEN>.
3969 STRLEN SvCUR(SV* sv)
3977 Set the current length of the string which is in the SV. See C<SvCUR>
3980 void SvCUR_set(SV* sv, STRLEN len)
3988 Returns a pointer to the last character in the string which is in the SV.
3989 See C<SvCUR>. Access the character as *(SvEND(sv)).
3999 Returns true if the SV has get magic or overloading. If either is true then
4000 the scalar is active data, and has the potential to return a new value every
4001 time it is accessed. Hence you must be careful to only read it once per user
4002 logical operation and work with that returned value. If neither is true then
4003 the scalar's value cannot change unless written to.
4005 char* SvGAMAGIC(SV* sv)
4013 Expands the character buffer in the SV so that it has room for the
4014 indicated number of bytes (remember to reserve space for an extra trailing
4015 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
4016 Returns a pointer to the character buffer.
4018 char * SvGROW(SV* sv, STRLEN len)
4026 Returns a U32 value indicating whether the SV contains an integer.
4036 Returns a U32 value indicating whether the SV contains an integer. Checks
4037 the B<private> setting. Use C<SvIOK>.
4047 Returns a boolean indicating whether the SV contains a signed integer.
4049 bool SvIOK_notUV(SV* sv)
4057 Unsets the IV status of an SV.
4059 void SvIOK_off(SV* sv)
4067 Tells an SV that it is an integer.
4069 void SvIOK_on(SV* sv)
4077 Tells an SV that it is an integer and disables all other OK bits.
4079 void SvIOK_only(SV* sv)
4087 Tells and SV that it is an unsigned integer and disables all other OK bits.
4089 void SvIOK_only_UV(SV* sv)
4097 Returns a boolean indicating whether the SV contains an unsigned integer.
4099 bool SvIOK_UV(SV* sv)
4107 Returns a boolean indicating whether the SV is Copy-On-Write. (either shared
4108 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
4111 bool SvIsCOW(SV* sv)
4116 =item SvIsCOW_shared_hash
4117 X<SvIsCOW_shared_hash>
4119 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
4122 bool SvIsCOW_shared_hash(SV* sv)
4130 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
4131 version which guarantees to evaluate sv only once.
4141 Returns the raw value in the SV's IV slot, without checks or conversions.
4142 Only use when you are sure SvIOK is true. See also C<SvIV()>.
4152 Coerces the given SV to an integer and returns it. Guarantees to evaluate
4153 C<sv> only once. Only use this if C<sv> is an expression with side effects,
4154 otherwise use the more efficient C<SvIV>.
4164 Like C<SvIV> but doesn't process magic.
4166 IV SvIV_nomg(SV* sv)
4174 Set the value of the IV pointer in sv to val. It is possible to perform
4175 the same function of this macro with an lvalue assignment to C<SvIVX>.
4176 With future Perls, however, it will be more efficient to use
4177 C<SvIV_set> instead of the lvalue assignment to C<SvIVX>.
4179 void SvIV_set(SV* sv, IV val)
4187 Returns the size of the string buffer in the SV, not including any part
4188 attributable to C<SvOOK>. See C<SvCUR>.
4190 STRLEN SvLEN(SV* sv)
4198 Set the actual length of the string which is in the SV. See C<SvIV_set>.
4200 void SvLEN_set(SV* sv, STRLEN len)
4208 Set the value of the MAGIC pointer in sv to val. See C<SvIV_set>.
4210 void SvMAGIC_set(SV* sv, MAGIC* val)
4218 Returns a U32 value indicating whether the SV contains a number, integer or
4229 Returns a U32 value indicating whether the SV contains a number, integer or
4230 double. Checks the B<private> setting. Use C<SvNIOK>.
4240 Unsets the NV/IV status of an SV.
4242 void SvNIOK_off(SV* sv)
4250 Returns a U32 value indicating whether the SV contains a double.
4260 Returns a U32 value indicating whether the SV contains a double. Checks the
4261 B<private> setting. Use C<SvNOK>.
4271 Unsets the NV status of an SV.
4273 void SvNOK_off(SV* sv)
4281 Tells an SV that it is a double.
4283 void SvNOK_on(SV* sv)
4291 Tells an SV that it is a double and disables all other OK bits.
4293 void SvNOK_only(SV* sv)
4301 Coerce the given SV to a double and return it. See C<SvNVx> for a version
4302 which guarantees to evaluate sv only once.
4312 Returns the raw value in the SV's NV slot, without checks or conversions.
4313 Only use when you are sure SvNOK is true. See also C<SvNV()>.
4323 Coerces the given SV to a double and returns it. Guarantees to evaluate
4324 C<sv> only once. Only use this if C<sv> is an expression with side effects,
4325 otherwise use the more efficient C<SvNV>.
4335 Set the value of the NV pointer in sv to val. See C<SvIV_set>.
4337 void SvNV_set(SV* sv, NV val)
4345 Returns a U32 value indicating whether the value is an SV. It also tells
4346 whether the value is defined or not.
4356 Returns a U32 indicating whether the SvIVX is a valid offset value for
4357 the SvPVX. This hack is used internally to speed up removal of characters
4358 from the beginning of a SvPV. When SvOOK is true, then the start of the
4359 allocated string buffer is really (SvPVX - SvIVX).
4369 Returns a U32 value indicating whether the SV contains a character
4380 Returns a U32 value indicating whether the SV contains a character string.
4381 Checks the B<private> setting. Use C<SvPOK>.
4391 Unsets the PV status of an SV.
4393 void SvPOK_off(SV* sv)
4401 Tells an SV that it is a string.
4403 void SvPOK_on(SV* sv)
4411 Tells an SV that it is a string and disables all other OK bits.
4412 Will also turn off the UTF-8 status.
4414 void SvPOK_only(SV* sv)
4419 =item SvPOK_only_UTF8
4422 Tells an SV that it is a string and disables all other OK bits,
4423 and leaves the UTF-8 status as it was.
4425 void SvPOK_only_UTF8(SV* sv)
4433 Returns a pointer to the string in the SV, or a stringified form of
4434 the SV if the SV does not contain a string. The SV may cache the
4435 stringified version becoming C<SvPOK>. Handles 'get' magic. See also
4436 C<SvPVx> for a version which guarantees to evaluate sv only once.
4438 char* SvPV(SV* sv, STRLEN len)
4446 Like C<SvPV>, but converts sv to byte representation first if necessary.
4448 char* SvPVbyte(SV* sv, STRLEN len)
4456 Like C<SvPV>, but converts sv to byte representation first if necessary.
4457 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
4460 char* SvPVbytex(SV* sv, STRLEN len)
4465 =item SvPVbytex_force
4468 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
4469 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
4472 char* SvPVbytex_force(SV* sv, STRLEN len)
4477 =item SvPVbyte_force
4480 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
4482 char* SvPVbyte_force(SV* sv, STRLEN len)
4487 =item SvPVbyte_nolen
4490 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
4492 char* SvPVbyte_nolen(SV* sv)
4500 Like C<SvPV>, but converts sv to utf8 first if necessary.
4502 char* SvPVutf8(SV* sv, STRLEN len)
4510 Like C<SvPV>, but converts sv to utf8 first if necessary.
4511 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
4514 char* SvPVutf8x(SV* sv, STRLEN len)
4519 =item SvPVutf8x_force
4522 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
4523 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
4526 char* SvPVutf8x_force(SV* sv, STRLEN len)
4531 =item SvPVutf8_force
4534 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
4536 char* SvPVutf8_force(SV* sv, STRLEN len)
4541 =item SvPVutf8_nolen
4544 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
4546 char* SvPVutf8_nolen(SV* sv)
4554 Returns a pointer to the physical string in the SV. The SV must contain a
4565 A version of C<SvPV> which guarantees to evaluate C<sv> only once.
4566 Only use this if C<sv> is an expression with side effects, otherwise use the
4567 more efficient C<SvPVX>.
4569 char* SvPVx(SV* sv, STRLEN len)
4577 Like C<SvPV> but will force the SV into containing just a string
4578 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
4581 char* SvPV_force(SV* sv, STRLEN len)
4586 =item SvPV_force_nomg
4589 Like C<SvPV> but will force the SV into containing just a string
4590 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
4591 directly. Doesn't process magic.
4593 char* SvPV_force_nomg(SV* sv, STRLEN len)
4601 Returns a pointer to the string in the SV, or a stringified form of
4602 the SV if the SV does not contain a string. The SV may cache the
4603 stringified form becoming C<SvPOK>. Handles 'get' magic.
4605 char* SvPV_nolen(SV* sv)
4613 Like C<SvPV> but doesn't process magic.
4615 char* SvPV_nomg(SV* sv, STRLEN len)
4623 Set the value of the PV pointer in sv to val. See C<SvIV_set>.
4625 void SvPV_set(SV* sv, char* val)
4633 Returns the value of the object's reference count.
4635 U32 SvREFCNT(SV* sv)
4643 Decrements the reference count of the given SV.
4645 void SvREFCNT_dec(SV* sv)
4653 Increments the reference count of the given SV.
4655 All of the following SvREFCNT_inc* macros are optimized versions of
4656 SvREFCNT_inc, and can be replaced with SvREFCNT_inc.
4658 SV* SvREFCNT_inc(SV* sv)
4663 =item SvREFCNT_inc_NN
4666 Same as SvREFCNT_inc, but can only be used if you know I<sv>
4667 is not NULL. Since we don't have to check the NULLness, it's faster
4670 SV* SvREFCNT_inc_NN(SV* sv)
4675 =item SvREFCNT_inc_simple
4676 X<SvREFCNT_inc_simple>
4678 Same as SvREFCNT_inc, but can only be used with expressions without side
4679 effects. Since we don't have to store a temporary value, it's faster.
4681 SV* SvREFCNT_inc_simple(SV* sv)
4686 =item SvREFCNT_inc_simple_NN
4687 X<SvREFCNT_inc_simple_NN>
4689 Same as SvREFCNT_inc_simple, but can only be used if you know I<sv>
4690 is not NULL. Since we don't have to check the NULLness, it's faster
4693 SV* SvREFCNT_inc_simple_NN(SV* sv)
4698 =item SvREFCNT_inc_simple_void
4699 X<SvREFCNT_inc_simple_void>
4701 Same as SvREFCNT_inc_simple, but can only be used if you don't need the
4702 return value. The macro doesn't need to return a meaningful value.
4704 void SvREFCNT_inc_simple_void(SV* sv)
4709 =item SvREFCNT_inc_simple_void_NN
4710 X<SvREFCNT_inc_simple_void_NN>
4712 Same as SvREFCNT_inc, but can only be used if you don't need the return
4713 value, and you know that I<sv> is not NULL. The macro doesn't need
4714 to return a meaningful value, or check for NULLness, so it's smaller
4717 void SvREFCNT_inc_simple_void_NN(SV* sv)
4722 =item SvREFCNT_inc_void
4723 X<SvREFCNT_inc_void>
4725 Same as SvREFCNT_inc, but can only be used if you don't need the
4726 return value. The macro doesn't need to return a meaningful value.
4728 void SvREFCNT_inc_void(SV* sv)
4733 =item SvREFCNT_inc_void_NN
4734 X<SvREFCNT_inc_void_NN>
4736 Same as SvREFCNT_inc, but can only be used if you don't need the return
4737 value, and you know that I<sv> is not NULL. The macro doesn't need
4738 to return a meaningful value, or check for NULLness, so it's smaller
4741 void SvREFCNT_inc_void_NN(SV* sv)
4749 Tests if the SV is an RV.
4759 Unsets the RV status of an SV.
4761 void SvROK_off(SV* sv)
4769 Tells an SV that it is an RV.
4771 void SvROK_on(SV* sv)
4779 Dereferences an RV to return the SV.
4789 Set the value of the RV pointer in sv to val. See C<SvIV_set>.
4791 void SvRV_set(SV* sv, SV* val)
4799 Returns the stash of the SV.
4809 Set the value of the STASH pointer in sv to val. See C<SvIV_set>.
4811 void SvSTASH_set(SV* sv, HV* val)
4819 Taints an SV if tainting is enabled.
4821 void SvTAINT(SV* sv)
4829 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
4832 bool SvTAINTED(SV* sv)
4840 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
4841 some of Perl's fundamental security features. XS module authors should not
4842 use this function unless they fully understand all the implications of
4843 unconditionally untainting the value. Untainting should be done in the
4844 standard perl fashion, via a carefully crafted regexp, rather than directly
4845 untainting variables.
4847 void SvTAINTED_off(SV* sv)
4855 Marks an SV as tainted if tainting is enabled.
4857 void SvTAINTED_on(SV* sv)
4865 Returns a boolean indicating whether Perl would evaluate the SV as true or
4866 false, defined or undefined. Does not handle 'get' magic.
4876 Returns the type of the SV. See C<svtype>.
4878 svtype SvTYPE(SV* sv)
4886 Returns a boolean indicating whether the SV contains an unsigned integer.
4896 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
4897 perform the upgrade if necessary. See C<svtype>.
4899 void SvUPGRADE(SV* sv, svtype type)
4907 Returns a U32 value indicating whether the SV contains UTF-8 encoded data.
4908 Call this after SvPV() in case any call to string overloading updates the
4919 Unsets the UTF-8 status of an SV.
4921 void SvUTF8_off(SV *sv)
4929 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
4930 Do not use frivolously.
4932 void SvUTF8_on(SV *sv)
4940 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
4941 for a version which guarantees to evaluate sv only once.
4951 Returns the raw value in the SV's UV slot, without checks or conversions.
4952 Only use when you are sure SvIOK is true. See also C<SvUV()>.
4962 Coerces the given SV to an unsigned integer and returns it. Guarantees to
4963 C<sv> only once. Only use this if C<sv> is an expression with side effects,
4964 otherwise use the more efficient C<SvUV>.
4974 Like C<SvUV> but doesn't process magic.
4976 UV SvUV_nomg(SV* sv)
4984 Set the value of the UV pointer in sv to val. See C<SvIV_set>.
4986 void SvUV_set(SV* sv, UV val)
4994 Returns a boolean indicating whether the SV contains a v-string.
5001 =item sv_catpvn_nomg
5004 Like C<sv_catpvn> but doesn't process magic.
5006 void sv_catpvn_nomg(SV* sv, const char* ptr, STRLEN len)
5014 Like C<sv_catsv> but doesn't process magic.
5016 void sv_catsv_nomg(SV* dsv, SV* ssv)
5021 =item sv_derived_from
5024 Returns a boolean indicating whether the SV is derived from the specified class
5025 I<at the C level>. To check derivation at the Perl level, call C<isa()> as a
5028 bool sv_derived_from(SV* sv, const char* name)
5031 Found in file universal.c
5036 Returns a boolean indicating whether the SV performs a specific, named role.
5037 The SV can be a Perl object or the name of a Perl class.
5039 bool sv_does(SV* sv, const char* name)
5042 Found in file universal.c
5044 =item sv_report_used
5047 Dump the contents of all SVs not yet freed. (Debugging aid).
5049 void sv_report_used()
5057 Like C<sv_setsv> but doesn't process magic.
5059 void sv_setsv_nomg(SV* dsv, SV* ssv)
5067 =head1 SV-Body Allocation
5071 =item looks_like_number
5072 X<looks_like_number>
5074 Test if the content of an SV looks like a number (or is a number).
5075 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
5076 non-numeric warning), even if your atof() doesn't grok them.
5078 I32 looks_like_number(SV* sv)
5086 Creates an RV wrapper for an SV. The reference count for the original
5087 SV is B<not> incremented.
5089 SV* newRV_noinc(SV* sv)
5097 Creates a new SV. A non-zero C<len> parameter indicates the number of
5098 bytes of preallocated string space the SV should have. An extra byte for a
5099 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
5100 space is allocated.) The reference count for the new SV is set to 1.
5102 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
5103 parameter, I<x>, a debug aid which allowed callers to identify themselves.
5104 This aid has been superseded by a new build option, PERL_MEM_LOG (see
5105 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
5106 modules supporting older perls.
5108 SV* newSV(STRLEN len)
5116 Creates a new SV from the hash key structure. It will generate scalars that
5117 point to the shared string table where possible. Returns a new (undefined)
5118 SV if the hek is NULL.
5120 SV* newSVhek(const HEK *hek)
5128 Creates a new SV and copies an integer into it. The reference count for the
5139 Creates a new SV and copies a floating point value into it.
5140 The reference count for the SV is set to 1.
5150 Creates a new SV and copies a string into it. The reference count for the
5151 SV is set to 1. If C<len> is zero, Perl will compute the length using
5152 strlen(). For efficiency, consider using C<newSVpvn> instead.
5154 SV* newSVpv(const char* s, STRLEN len)
5162 Creates a new SV and initializes it with the string formatted like
5165 SV* newSVpvf(const char* pat, ...)
5173 Creates a new SV and copies a string into it. The reference count for the
5174 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
5175 string. You are responsible for ensuring that the source string is at least
5176 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
5178 SV* newSVpvn(const char* s, STRLEN len)
5183 =item newSVpvn_flags
5186 Creates a new SV and copies a string into it. The reference count for the
5187 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
5188 string. You are responsible for ensuring that the source string is at least
5189 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
5190 Currently the only flag bits accepted are C<SVf_UTF8> and C<SVs_TEMP>.
5191 If C<SVs_TEMP> is set, then C<sv2mortal()> is called on the result before
5192 returning. If C<SVf_UTF8> is set, then it will be set on the new SV.
5193 C<newSVpvn_utf8()> is a convenience wrapper for this function, defined as
5195 #define newSVpvn_utf8(s, len, u) \
5196 newSVpvn_flags((s), (len), (u) ? SVf_UTF8 : 0)
5198 SV* newSVpvn_flags(const char* s, STRLEN len, U32 flags)
5203 =item newSVpvn_share
5206 Creates a new SV with its SvPVX_const pointing to a shared string in the string
5207 table. If the string does not already exist in the table, it is created
5208 first. Turns on READONLY and FAKE. If the C<hash> parameter is non-zero, that
5209 value is used; otherwise the hash is computed. The string's hash can be later
5210 be retrieved from the SV with the C<SvSHARED_HASH()> macro. The idea here is
5211 that as the string table is used for shared hash keys these strings will have
5212 SvPVX_const == HeKEY and hash lookup will avoid string compare.
5214 SV* newSVpvn_share(const char* s, I32 len, U32 hash)
5222 Like C<newSVpvn>, but takes a literal string instead of a string/length pair.
5224 SV* newSVpvs(const char* s)
5227 Found in file handy.h
5229 =item newSVpvs_flags
5232 Like C<newSVpvn_flags>, but takes a literal string instead of a string/length
5235 SV* newSVpvs_flags(const char* s, U32 flags)
5238 Found in file handy.h
5240 =item newSVpvs_share
5243 Like C<newSVpvn_share>, but takes a literal string instead of a string/length
5244 pair and omits the hash parameter.
5246 SV* newSVpvs_share(const char* s)
5249 Found in file handy.h
5254 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
5255 it will be upgraded to one. If C<classname> is non-null then the new SV will
5256 be blessed in the specified package. The new SV is returned and its
5257 reference count is 1.
5259 SV* newSVrv(SV* rv, const char* classname)
5267 Creates a new SV which is an exact duplicate of the original SV.
5270 SV* newSVsv(SV* old)
5278 Creates a new SV and copies an unsigned integer into it.
5279 The reference count for the SV is set to 1.
5289 Creates a new SV, of the type specified. The reference count for the new SV
5292 SV* newSV_type(svtype type)
5300 This function is only called on magical items, and is only used by
5301 sv_true() or its macro equivalent.
5303 bool sv_2bool(SV* sv)
5311 Using various gambits, try to get a CV from an SV; in addition, try if
5312 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
5313 The flags in C<lref> are passed to sv_fetchsv.
5315 CV* sv_2cv(SV* sv, HV** st, GV** gvp, I32 lref)
5323 Using various gambits, try to get an IO from an SV: the IO slot if its a
5324 GV; or the recursive result if we're an RV; or the IO slot of the symbol
5325 named after the PV if we're a string.
5335 Return the integer value of an SV, doing any necessary string
5336 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
5337 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
5339 IV sv_2iv_flags(SV* sv, I32 flags)
5347 Marks an existing SV as mortal. The SV will be destroyed "soon", either
5348 by an explicit call to FREETMPS, or by an implicit call at places such as
5349 statement boundaries. SvTEMP() is turned on which means that the SV's
5350 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
5351 and C<sv_mortalcopy>.
5353 SV* sv_2mortal(SV* sv)
5361 Return the num value of an SV, doing any necessary string or integer
5362 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
5373 Return a pointer to the byte-encoded representation of the SV, and set *lp
5374 to its length. May cause the SV to be downgraded from UTF-8 as a
5377 Usually accessed via the C<SvPVbyte> macro.
5379 char* sv_2pvbyte(SV* sv, STRLEN* lp)
5387 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
5388 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
5390 Usually accessed via the C<SvPVutf8> macro.
5392 char* sv_2pvutf8(SV* sv, STRLEN* lp)
5400 Returns a pointer to the string value of an SV, and sets *lp to its length.
5401 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
5403 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
5404 usually end up here too.
5406 char* sv_2pv_flags(SV* sv, STRLEN* lp, I32 flags)
5414 Return the unsigned integer value of an SV, doing any necessary string
5415 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
5416 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
5418 UV sv_2uv_flags(SV* sv, I32 flags)
5426 Remove any string offset. You should normally use the C<SvOOK_off> macro
5429 int sv_backoff(SV* sv)
5437 Blesses an SV into a specified package. The SV must be an RV. The package
5438 must be designated by its stash (see C<gv_stashpv()>). The reference count
5439 of the SV is unaffected.
5441 SV* sv_bless(SV* sv, HV* stash)
5449 Concatenates the string onto the end of the string which is in the SV.
5450 If the SV has the UTF-8 status set, then the bytes appended should be
5451 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
5453 void sv_catpv(SV* sv, const char* ptr)
5461 Processes its arguments like C<sprintf> and appends the formatted
5462 output to an SV. If the appended data contains "wide" characters
5463 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
5464 and characters >255 formatted with %c), the original SV might get
5465 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
5466 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
5467 valid UTF-8; if the original SV was bytes, the pattern should be too.
5469 void sv_catpvf(SV* sv, const char* pat, ...)
5477 Like C<sv_catpvf>, but also handles 'set' magic.
5479 void sv_catpvf_mg(SV *sv, const char* pat, ...)
5487 Concatenates the string onto the end of the string which is in the SV. The
5488 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5489 status set, then the bytes appended should be valid UTF-8.
5490 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
5492 void sv_catpvn(SV* sv, const char* ptr, STRLEN len)
5497 =item sv_catpvn_flags
5500 Concatenates the string onto the end of the string which is in the SV. The
5501 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5502 status set, then the bytes appended should be valid UTF-8.
5503 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
5504 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
5505 in terms of this function.
5507 void sv_catpvn_flags(SV* sv, const char* ptr, STRLEN len, I32 flags)
5515 Like C<sv_catpvn>, but takes a literal string instead of a string/length pair.
5517 void sv_catpvs(SV* sv, const char* s)
5520 Found in file handy.h
5525 Like C<sv_catpv>, but also handles 'set' magic.
5527 void sv_catpv_mg(SV *sv, const char *ptr)
5535 Concatenates the string from SV C<ssv> onto the end of the string in
5536 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
5537 not 'set' magic. See C<sv_catsv_mg>.
5539 void sv_catsv(SV* dsv, SV* ssv)
5544 =item sv_catsv_flags
5547 Concatenates the string from SV C<ssv> onto the end of the string in
5548 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
5549 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
5550 and C<sv_catsv_nomg> are implemented in terms of this function.
5552 void sv_catsv_flags(SV* dsv, SV* ssv, I32 flags)
5560 Efficient removal of characters from the beginning of the string buffer.
5561 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
5562 the string buffer. The C<ptr> becomes the first character of the adjusted
5563 string. Uses the "OOK hack".
5564 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
5565 refer to the same chunk of data.
5567 void sv_chop(SV* sv, const char* ptr)
5575 Clear an SV: call any destructors, free up any memory used by the body,
5576 and free the body itself. The SV's head is I<not> freed, although
5577 its type is set to all 1's so that it won't inadvertently be assumed
5578 to be live during global destruction etc.
5579 This function should only be called when REFCNT is zero. Most of the time
5580 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5583 void sv_clear(SV* sv)
5591 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5592 string in C<sv1> is less than, equal to, or greater than the string in
5593 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5594 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
5596 I32 sv_cmp(SV* sv1, SV* sv2)
5604 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
5605 'use bytes' aware, handles get magic, and will coerce its args to strings
5606 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
5608 I32 sv_cmp_locale(SV* sv1, SV* sv2)
5616 Add Collate Transform magic to an SV if it doesn't already have it.
5618 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
5619 scalar data of the variable, but transformed to such a format that a normal
5620 memory comparison can be used to compare the data according to the locale
5623 char* sv_collxfrm(SV* sv, STRLEN* nxp)
5631 Copies a stringified representation of the source SV into the
5632 destination SV. Automatically performs any necessary mg_get and
5633 coercion of numeric values into strings. Guaranteed to preserve
5634 UTF8 flag even from overloaded objects. Similar in nature to
5635 sv_2pv[_flags] but operates directly on an SV instead of just the
5636 string. Mostly uses sv_2pv_flags to do its work, except when that
5637 would lose the UTF-8'ness of the PV.
5639 void sv_copypv(SV* dsv, SV* ssv)
5647 Auto-decrement of the value in the SV, doing string to numeric conversion
5648 if necessary. Handles 'get' magic.
5658 Returns a boolean indicating whether the strings in the two SVs are
5659 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5660 coerce its args to strings if necessary.
5662 I32 sv_eq(SV* sv1, SV* sv2)
5667 =item sv_force_normal_flags
5668 X<sv_force_normal_flags>
5670 Undo various types of fakery on an SV: if the PV is a shared string, make
5671 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
5672 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
5673 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
5674 then a copy-on-write scalar drops its PV buffer (if any) and becomes
5675 SvPOK_off rather than making a copy. (Used where this scalar is about to be
5676 set to some other value.) In addition, the C<flags> parameter gets passed to
5677 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
5678 with flags set to 0.
5680 void sv_force_normal_flags(SV *sv, U32 flags)
5688 Decrement an SV's reference count, and if it drops to zero, call
5689 C<sv_clear> to invoke destructors and free up any memory used by
5690 the body; finally, deallocate the SV's head itself.
5691 Normally called via a wrapper macro C<SvREFCNT_dec>.
5693 void sv_free(SV* sv)
5701 Get a line from the filehandle and store it into the SV, optionally
5702 appending to the currently-stored string.
5704 char* sv_gets(SV* sv, PerlIO* fp, I32 append)
5712 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
5713 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
5714 Use the C<SvGROW> wrapper instead.
5716 char* sv_grow(SV* sv, STRLEN newlen)
5724 Auto-increment of the value in the SV, doing string to numeric conversion
5725 if necessary. Handles 'get' magic.
5735 Inserts a string at the specified offset/length within the SV. Similar to
5736 the Perl substr() function.
5738 void sv_insert(SV* bigsv, STRLEN offset, STRLEN len, const char* little, STRLEN littlelen)
5746 Returns a boolean indicating whether the SV is blessed into the specified
5747 class. This does not check for subtypes; use C<sv_derived_from> to verify
5748 an inheritance relationship.
5750 int sv_isa(SV* sv, const char* name)
5758 Returns a boolean indicating whether the SV is an RV pointing to a blessed
5759 object. If the SV is not an RV, or if the object is not blessed, then this
5762 int sv_isobject(SV* sv)
5770 Returns the length of the string in the SV. Handles magic and type
5771 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5773 STRLEN sv_len(SV* sv)
5781 Returns the number of characters in the string in an SV, counting wide
5782 UTF-8 bytes as a single character. Handles magic and type coercion.
5784 STRLEN sv_len_utf8(SV* sv)
5792 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
5793 then adds a new magic item of type C<how> to the head of the magic list.
5795 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
5796 handling of the C<name> and C<namlen> arguments.
5798 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
5799 to add more than one instance of the same 'how'.
5801 void sv_magic(SV* sv, SV* obj, int how, const char* name, I32 namlen)
5809 Adds magic to an SV, upgrading it if necessary. Applies the
5810 supplied vtable and returns a pointer to the magic added.
5812 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
5813 In particular, you can add magic to SvREADONLY SVs, and add more than
5814 one instance of the same 'how'.
5816 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
5817 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
5818 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
5819 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
5821 (This is now used as a subroutine by C<sv_magic>.)
5823 MAGIC * sv_magicext(SV* sv, SV* obj, int how, const MGVTBL *vtbl, const char* name, I32 namlen)
5831 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
5832 The new SV is marked as mortal. It will be destroyed "soon", either by an
5833 explicit call to FREETMPS, or by an implicit call at places such as
5834 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
5836 SV* sv_mortalcopy(SV* oldsv)
5844 Creates a new null SV which is mortal. The reference count of the SV is
5845 set to 1. It will be destroyed "soon", either by an explicit call to
5846 FREETMPS, or by an implicit call at places such as statement boundaries.
5847 See also C<sv_mortalcopy> and C<sv_2mortal>.
5857 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5860 SV* sv_newref(SV* sv)
5868 Converts the value pointed to by offsetp from a count of bytes from the
5869 start of the string, to a count of the equivalent number of UTF-8 chars.
5870 Handles magic and type coercion.
5872 void sv_pos_b2u(SV* sv, I32* offsetp)
5880 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5881 the start of the string, to a count of the equivalent number of bytes; if
5882 lenp is non-zero, it does the same to lenp, but this time starting from
5883 the offset, rather than from the start of the string. Handles magic and
5886 void sv_pos_u2b(SV* sv, I32* offsetp, I32* lenp)
5891 =item sv_pvbyten_force
5894 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
5896 char* sv_pvbyten_force(SV* sv, STRLEN* lp)
5904 Get a sensible string out of the SV somehow.
5905 A private implementation of the C<SvPV_force> macro for compilers which
5906 can't cope with complex macro expressions. Always use the macro instead.
5908 char* sv_pvn_force(SV* sv, STRLEN* lp)
5913 =item sv_pvn_force_flags
5914 X<sv_pvn_force_flags>
5916 Get a sensible string out of the SV somehow.
5917 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
5918 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
5919 implemented in terms of this function.
5920 You normally want to use the various wrapper macros instead: see
5921 C<SvPV_force> and C<SvPV_force_nomg>
5923 char* sv_pvn_force_flags(SV* sv, STRLEN* lp, I32 flags)
5928 =item sv_pvutf8n_force
5931 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
5933 char* sv_pvutf8n_force(SV* sv, STRLEN* lp)
5941 Returns a string describing what the SV is a reference to.
5943 const char* sv_reftype(const SV* sv, int ob)
5951 Make the first argument a copy of the second, then delete the original.
5952 The target SV physically takes over ownership of the body of the source SV
5953 and inherits its flags; however, the target keeps any magic it owns,
5954 and any magic in the source is discarded.
5955 Note that this is a rather specialist SV copying operation; most of the
5956 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5958 void sv_replace(SV* sv, SV* nsv)
5966 Underlying implementation for the C<reset> Perl function.
5967 Note that the perl-level function is vaguely deprecated.
5969 void sv_reset(const char* s, HV* stash)
5977 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
5978 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
5979 push a back-reference to this RV onto the array of backreferences
5980 associated with that magic. If the RV is magical, set magic will be
5981 called after the RV is cleared.
5983 SV* sv_rvweaken(SV *sv)
5991 Copies an integer into the given SV, upgrading first if necessary.
5992 Does not handle 'set' magic. See also C<sv_setiv_mg>.
5994 void sv_setiv(SV* sv, IV num)
6002 Like C<sv_setiv>, but also handles 'set' magic.
6004 void sv_setiv_mg(SV *sv, IV i)
6012 Copies a double into the given SV, upgrading first if necessary.
6013 Does not handle 'set' magic. See also C<sv_setnv_mg>.
6015 void sv_setnv(SV* sv, NV num)
6023 Like C<sv_setnv>, but also handles 'set' magic.
6025 void sv_setnv_mg(SV *sv, NV num)
6033 Copies a string into an SV. The string must be null-terminated. Does not
6034 handle 'set' magic. See C<sv_setpv_mg>.
6036 void sv_setpv(SV* sv, const char* ptr)
6044 Works like C<sv_catpvf> but copies the text into the SV instead of
6045 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
6047 void sv_setpvf(SV* sv, const char* pat, ...)
6055 Like C<sv_setpvf>, but also handles 'set' magic.
6057 void sv_setpvf_mg(SV *sv, const char* pat, ...)
6065 Copies an integer into the given SV, also updating its string value.
6066 Does not handle 'set' magic. See C<sv_setpviv_mg>.
6068 void sv_setpviv(SV* sv, IV num)
6076 Like C<sv_setpviv>, but also handles 'set' magic.
6078 void sv_setpviv_mg(SV *sv, IV iv)
6086 Copies a string into an SV. The C<len> parameter indicates the number of
6087 bytes to be copied. If the C<ptr> argument is NULL the SV will become
6088 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
6090 void sv_setpvn(SV* sv, const char* ptr, STRLEN len)
6098 Like C<sv_setpvn>, but also handles 'set' magic.
6100 void sv_setpvn_mg(SV *sv, const char *ptr, STRLEN len)
6108 Like C<sv_setpvn>, but takes a literal string instead of a string/length pair.
6110 void sv_setpvs(SV* sv, const char* s)
6113 Found in file handy.h
6118 Like C<sv_setpv>, but also handles 'set' magic.
6120 void sv_setpv_mg(SV *sv, const char *ptr)
6128 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
6129 argument will be upgraded to an RV. That RV will be modified to point to
6130 the new SV. The C<classname> argument indicates the package for the
6131 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
6132 will have a reference count of 1, and the RV will be returned.
6134 SV* sv_setref_iv(SV* rv, const char* classname, IV iv)
6142 Copies a double into a new SV, optionally blessing the SV. The C<rv>
6143 argument will be upgraded to an RV. That RV will be modified to point to
6144 the new SV. The C<classname> argument indicates the package for the
6145 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
6146 will have a reference count of 1, and the RV will be returned.
6148 SV* sv_setref_nv(SV* rv, const char* classname, NV nv)
6156 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
6157 argument will be upgraded to an RV. That RV will be modified to point to
6158 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
6159 into the SV. The C<classname> argument indicates the package for the
6160 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
6161 will have a reference count of 1, and the RV will be returned.
6163 Do not use with other Perl types such as HV, AV, SV, CV, because those
6164 objects will become corrupted by the pointer copy process.
6166 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
6168 SV* sv_setref_pv(SV* rv, const char* classname, void* pv)
6176 Copies a string into a new SV, optionally blessing the SV. The length of the
6177 string must be specified with C<n>. The C<rv> argument will be upgraded to
6178 an RV. That RV will be modified to point to the new SV. The C<classname>
6179 argument indicates the package for the blessing. Set C<classname> to
6180 C<NULL> to avoid the blessing. The new SV will have a reference count
6181 of 1, and the RV will be returned.
6183 Note that C<sv_setref_pv> copies the pointer while this copies the string.
6185 SV* sv_setref_pvn(SV* rv, const char* classname, const char* pv, STRLEN n)
6193 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
6194 argument will be upgraded to an RV. That RV will be modified to point to
6195 the new SV. The C<classname> argument indicates the package for the
6196 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
6197 will have a reference count of 1, and the RV will be returned.
6199 SV* sv_setref_uv(SV* rv, const char* classname, UV uv)
6207 Copies the contents of the source SV C<ssv> into the destination SV
6208 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
6209 function if the source SV needs to be reused. Does not handle 'set' magic.
6210 Loosely speaking, it performs a copy-by-value, obliterating any previous
6211 content of the destination.
6213 You probably want to use one of the assortment of wrappers, such as
6214 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
6215 C<SvSetMagicSV_nosteal>.
6217 void sv_setsv(SV* dsv, SV* ssv)
6222 =item sv_setsv_flags
6225 Copies the contents of the source SV C<ssv> into the destination SV
6226 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
6227 function if the source SV needs to be reused. Does not handle 'set' magic.
6228 Loosely speaking, it performs a copy-by-value, obliterating any previous
6229 content of the destination.
6230 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
6231 C<ssv> if appropriate, else not. If the C<flags> parameter has the
6232 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
6233 and C<sv_setsv_nomg> are implemented in terms of this function.
6235 You probably want to use one of the assortment of wrappers, such as
6236 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
6237 C<SvSetMagicSV_nosteal>.
6239 This is the primary function for copying scalars, and most other
6240 copy-ish functions and macros use this underneath.
6242 void sv_setsv_flags(SV* dsv, SV* ssv, I32 flags)
6250 Like C<sv_setsv>, but also handles 'set' magic.
6252 void sv_setsv_mg(SV *dstr, SV *sstr)
6260 Copies an unsigned integer into the given SV, upgrading first if necessary.
6261 Does not handle 'set' magic. See also C<sv_setuv_mg>.
6263 void sv_setuv(SV* sv, UV num)
6271 Like C<sv_setuv>, but also handles 'set' magic.
6273 void sv_setuv_mg(SV *sv, UV u)
6281 Test an SV for taintedness. Use C<SvTAINTED> instead.
6282 bool sv_tainted(SV* sv)
6290 Returns true if the SV has a true value by Perl's rules.
6291 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
6292 instead use an in-line version.
6302 Removes all magic of type C<type> from an SV.
6304 int sv_unmagic(SV* sv, int type)
6309 =item sv_unref_flags
6312 Unsets the RV status of the SV, and decrements the reference count of
6313 whatever was being referenced by the RV. This can almost be thought of
6314 as a reversal of C<newSVrv>. The C<cflags> argument can contain
6315 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
6316 (otherwise the decrementing is conditional on the reference count being
6317 different from one or the reference being a readonly SV).
6320 void sv_unref_flags(SV* sv, U32 flags)
6328 Untaint an SV. Use C<SvTAINTED_off> instead.
6329 void sv_untaint(SV* sv)
6337 Upgrade an SV to a more complex form. Generally adds a new body type to the
6338 SV, then copies across as much information as possible from the old body.
6339 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
6341 void sv_upgrade(SV* sv, svtype new_type)
6346 =item sv_usepvn_flags
6349 Tells an SV to use C<ptr> to find its string value. Normally the
6350 string is stored inside the SV but sv_usepvn allows the SV to use an
6351 outside string. The C<ptr> should point to memory that was allocated
6352 by C<malloc>. The string length, C<len>, must be supplied. By default
6353 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
6354 so that pointer should not be freed or used by the programmer after
6355 giving it to sv_usepvn, and neither should any pointers from "behind"
6356 that pointer (e.g. ptr + 1) be used.
6358 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
6359 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
6360 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
6361 C<len>, and already meets the requirements for storing in C<SvPVX>)
6363 void sv_usepvn_flags(SV* sv, char* ptr, STRLEN len, U32 flags)
6368 =item sv_utf8_decode
6371 If the PV of the SV is an octet sequence in UTF-8
6372 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
6373 so that it looks like a character. If the PV contains only single-byte
6374 characters, the C<SvUTF8> flag stays being off.
6375 Scans PV for validity and returns false if the PV is invalid UTF-8.
6377 NOTE: this function is experimental and may change or be
6378 removed without notice.
6380 bool sv_utf8_decode(SV *sv)
6385 =item sv_utf8_downgrade
6386 X<sv_utf8_downgrade>
6388 Attempts to convert the PV of an SV from characters to bytes.
6389 If the PV contains a character beyond byte, this conversion will fail;
6390 in this case, either returns false or, if C<fail_ok> is not
6393 This is not as a general purpose Unicode to byte encoding interface:
6394 use the Encode extension for that.
6396 NOTE: this function is experimental and may change or be
6397 removed without notice.
6399 bool sv_utf8_downgrade(SV *sv, bool fail_ok)
6404 =item sv_utf8_encode
6407 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
6408 flag off so that it looks like octets again.
6410 void sv_utf8_encode(SV *sv)
6415 =item sv_utf8_upgrade
6418 Converts the PV of an SV to its UTF-8-encoded form.
6419 Forces the SV to string form if it is not already.
6420 Always sets the SvUTF8 flag to avoid future validity checks even
6421 if all the bytes have hibit clear.
6423 This is not as a general purpose byte encoding to Unicode interface:
6424 use the Encode extension for that.
6426 STRLEN sv_utf8_upgrade(SV *sv)
6431 =item sv_utf8_upgrade_flags
6432 X<sv_utf8_upgrade_flags>
6434 Converts the PV of an SV to its UTF-8-encoded form.
6435 Forces the SV to string form if it is not already.
6436 Always sets the SvUTF8 flag to avoid future validity checks even
6437 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
6438 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
6439 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
6441 This is not as a general purpose byte encoding to Unicode interface:
6442 use the Encode extension for that.
6444 STRLEN sv_utf8_upgrade_flags(SV *sv, I32 flags)
6452 Processes its arguments like C<vsprintf> and appends the formatted output
6453 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
6455 Usually used via its frontend C<sv_catpvf>.
6457 void sv_vcatpvf(SV* sv, const char* pat, va_list* args)
6465 Processes its arguments like C<vsprintf> and appends the formatted output
6466 to an SV. Uses an array of SVs if the C style variable argument list is
6467 missing (NULL). When running with taint checks enabled, indicates via
6468 C<maybe_tainted> if results are untrustworthy (often due to the use of
6471 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
6473 void sv_vcatpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
6481 Like C<sv_vcatpvf>, but also handles 'set' magic.
6483 Usually used via its frontend C<sv_catpvf_mg>.
6485 void sv_vcatpvf_mg(SV* sv, const char* pat, va_list* args)
6493 Works like C<sv_vcatpvf> but copies the text into the SV instead of
6494 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
6496 Usually used via its frontend C<sv_setpvf>.
6498 void sv_vsetpvf(SV* sv, const char* pat, va_list* args)
6506 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
6509 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
6511 void sv_vsetpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
6519 Like C<sv_vsetpvf>, but also handles 'set' magic.
6521 Usually used via its frontend C<sv_setpvf_mg>.
6523 void sv_vsetpvf_mg(SV* sv, const char* pat, va_list* args)
6531 =head1 Unicode Support
6535 =item bytes_from_utf8
6538 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
6539 Unlike C<utf8_to_bytes> but like C<bytes_to_utf8>, returns a pointer to
6540 the newly-created string, and updates C<len> to contain the new
6541 length. Returns the original string if no conversion occurs, C<len>
6542 is unchanged. Do nothing if C<is_utf8> points to 0. Sets C<is_utf8> to
6543 0 if C<s> is converted or contains all 7bit characters.
6545 NOTE: this function is experimental and may change or be
6546 removed without notice.
6548 U8* bytes_from_utf8(const U8 *s, STRLEN *len, bool *is_utf8)
6551 Found in file utf8.c
6556 Converts a string C<s> of length C<len> from ASCII into UTF-8 encoding.
6557 Returns a pointer to the newly-created string, and sets C<len> to
6558 reflect the new length.
6560 If you want to convert to UTF-8 from other encodings than ASCII,
6561 see sv_recode_to_utf8().
6563 NOTE: this function is experimental and may change or be
6564 removed without notice.
6566 U8* bytes_to_utf8(const U8 *s, STRLEN *len)
6569 Found in file utf8.c
6574 Return true if the strings s1 and s2 differ case-insensitively, false
6575 if not (if they are equal case-insensitively). If u1 is true, the
6576 string s1 is assumed to be in UTF-8-encoded Unicode. If u2 is true,
6577 the string s2 is assumed to be in UTF-8-encoded Unicode. If u1 or u2
6578 are false, the respective string is assumed to be in native 8-bit
6581 If the pe1 and pe2 are non-NULL, the scanning pointers will be copied
6582 in there (they will point at the beginning of the I<next> character).
6583 If the pointers behind pe1 or pe2 are non-NULL, they are the end
6584 pointers beyond which scanning will not continue under any
6585 circumstances. If the byte lengths l1 and l2 are non-zero, s1+l1 and
6586 s2+l2 will be used as goal end pointers that will also stop the scan,
6587 and which qualify towards defining a successful match: all the scans
6588 that define an explicit length must reach their goal pointers for
6589 a match to succeed).
6591 For case-insensitiveness, the "casefolding" of Unicode is used
6592 instead of upper/lowercasing both the characters, see
6593 http://www.unicode.org/unicode/reports/tr21/ (Case Mappings).
6595 I32 ibcmp_utf8(const char* a, char **pe1, UV l1, bool u1, const char* b, char **pe2, UV l2, bool u2)
6598 Found in file utf8.c
6603 Tests if some arbitrary number of bytes begins in a valid UTF-8
6604 character. Note that an INVARIANT (i.e. ASCII) character is a valid
6605 UTF-8 character. The actual number of bytes in the UTF-8 character
6606 will be returned if it is valid, otherwise 0.
6608 STRLEN is_utf8_char(const U8 *p)
6611 Found in file utf8.c
6613 =item is_utf8_string
6616 Returns true if first C<len> bytes of the given string form a valid
6617 UTF-8 string, false otherwise. Note that 'a valid UTF-8 string' does
6618 not mean 'a string that contains code points above 0x7F encoded in UTF-8'
6619 because a valid ASCII string is a valid UTF-8 string.
6621 See also is_utf8_string_loclen() and is_utf8_string_loc().
6623 bool is_utf8_string(const U8 *s, STRLEN len)
6626 Found in file utf8.c
6628 =item is_utf8_string_loc
6629 X<is_utf8_string_loc>
6631 Like is_utf8_string() but stores the location of the failure (in the
6632 case of "utf8ness failure") or the location s+len (in the case of
6633 "utf8ness success") in the C<ep>.
6635 See also is_utf8_string_loclen() and is_utf8_string().
6637 bool is_utf8_string_loc(const U8 *s, STRLEN len, const U8 **p)
6640 Found in file utf8.c
6642 =item is_utf8_string_loclen
6643 X<is_utf8_string_loclen>
6645 Like is_utf8_string() but stores the location of the failure (in the
6646 case of "utf8ness failure") or the location s+len (in the case of
6647 "utf8ness success") in the C<ep>, and the number of UTF-8
6648 encoded characters in the C<el>.
6650 See also is_utf8_string_loc() and is_utf8_string().
6652 bool is_utf8_string_loclen(const U8 *s, STRLEN len, const U8 **ep, STRLEN *el)
6655 Found in file utf8.c
6657 =item pv_uni_display
6660 Build to the scalar dsv a displayable version of the string spv,
6661 length len, the displayable version being at most pvlim bytes long
6662 (if longer, the rest is truncated and "..." will be appended).
6664 The flags argument can have UNI_DISPLAY_ISPRINT set to display
6665 isPRINT()able characters as themselves, UNI_DISPLAY_BACKSLASH
6666 to display the \\[nrfta\\] as the backslashed versions (like '\n')
6667 (UNI_DISPLAY_BACKSLASH is preferred over UNI_DISPLAY_ISPRINT for \\).
6668 UNI_DISPLAY_QQ (and its alias UNI_DISPLAY_REGEX) have both
6669 UNI_DISPLAY_BACKSLASH and UNI_DISPLAY_ISPRINT turned on.
6671 The pointer to the PV of the dsv is returned.
6673 char* pv_uni_display(SV *dsv, const U8 *spv, STRLEN len, STRLEN pvlim, UV flags)
6676 Found in file utf8.c
6681 The encoding is assumed to be an Encode object, the PV of the ssv is
6682 assumed to be octets in that encoding and decoding the input starts
6683 from the position which (PV + *offset) pointed to. The dsv will be
6684 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
6685 when the string tstr appears in decoding output or the input ends on
6686 the PV of the ssv. The value which the offset points will be modified
6687 to the last input position on the ssv.
6689 Returns TRUE if the terminator was found, else returns FALSE.
6691 bool sv_cat_decode(SV* dsv, SV *encoding, SV *ssv, int *offset, char* tstr, int tlen)
6696 =item sv_recode_to_utf8
6697 X<sv_recode_to_utf8>
6699 The encoding is assumed to be an Encode object, on entry the PV
6700 of the sv is assumed to be octets in that encoding, and the sv
6701 will be converted into Unicode (and UTF-8).
6703 If the sv already is UTF-8 (or if it is not POK), or if the encoding
6704 is not a reference, nothing is done to the sv. If the encoding is not
6705 an C<Encode::XS> Encoding object, bad things will happen.
6706 (See F<lib/encoding.pm> and L<Encode>).
6708 The PV of the sv is returned.
6710 char* sv_recode_to_utf8(SV* sv, SV *encoding)
6715 =item sv_uni_display
6718 Build to the scalar dsv a displayable version of the scalar sv,
6719 the displayable version being at most pvlim bytes long
6720 (if longer, the rest is truncated and "..." will be appended).
6722 The flags argument is as in pv_uni_display().
6724 The pointer to the PV of the dsv is returned.
6726 char* sv_uni_display(SV *dsv, SV *ssv, STRLEN pvlim, UV flags)
6729 Found in file utf8.c
6734 The "p" contains the pointer to the UTF-8 string encoding
6735 the character that is being converted.
6737 The "ustrp" is a pointer to the character buffer to put the
6738 conversion result to. The "lenp" is a pointer to the length
6741 The "swashp" is a pointer to the swash to use.
6743 Both the special and normal mappings are stored lib/unicore/To/Foo.pl,
6744 and loaded by SWASHNEW, using lib/utf8_heavy.pl. The special (usually,
6745 but not always, a multicharacter mapping), is tried first.
6747 The "special" is a string like "utf8::ToSpecLower", which means the
6748 hash %utf8::ToSpecLower. The access to the hash is through
6749 Perl_to_utf8_case().
6751 The "normal" is a string like "ToLower" which means the swash
6754 UV to_utf8_case(const U8 *p, U8* ustrp, STRLEN *lenp, SV **swashp, const char *normal, const char *special)
6757 Found in file utf8.c
6762 Convert the UTF-8 encoded character at p to its foldcase version and
6763 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6764 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6765 foldcase version may be longer than the original character (up to
6768 The first character of the foldcased version is returned
6769 (but note, as explained above, that there may be more.)
6771 UV to_utf8_fold(const U8 *p, U8* ustrp, STRLEN *lenp)
6774 Found in file utf8.c
6779 Convert the UTF-8 encoded character at p to its lowercase version and
6780 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6781 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6782 lowercase version may be longer than the original character.
6784 The first character of the lowercased version is returned
6785 (but note, as explained above, that there may be more.)
6787 UV to_utf8_lower(const U8 *p, U8* ustrp, STRLEN *lenp)
6790 Found in file utf8.c
6795 Convert the UTF-8 encoded character at p to its titlecase version and
6796 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6797 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6798 titlecase version may be longer than the original character.
6800 The first character of the titlecased version is returned
6801 (but note, as explained above, that there may be more.)
6803 UV to_utf8_title(const U8 *p, U8* ustrp, STRLEN *lenp)
6806 Found in file utf8.c
6811 Convert the UTF-8 encoded character at p to its uppercase version and
6812 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6813 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since
6814 the uppercase version may be longer than the original character.
6816 The first character of the uppercased version is returned
6817 (but note, as explained above, that there may be more.)
6819 UV to_utf8_upper(const U8 *p, U8* ustrp, STRLEN *lenp)
6822 Found in file utf8.c
6824 =item utf8n_to_uvchr
6829 Returns the native character value of the first character in the string
6831 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6832 length, in bytes, of that character.
6834 Allows length and flags to be passed to low level routine.
6836 UV utf8n_to_uvchr(const U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags)
6839 Found in file utf8.c
6841 =item utf8n_to_uvuni
6844 Bottom level UTF-8 decode routine.
6845 Returns the Unicode code point value of the first character in the string C<s>
6846 which is assumed to be in UTF-8 encoding and no longer than C<curlen>;
6847 C<retlen> will be set to the length, in bytes, of that character.
6849 If C<s> does not point to a well-formed UTF-8 character, the behaviour
6850 is dependent on the value of C<flags>: if it contains UTF8_CHECK_ONLY,
6851 it is assumed that the caller will raise a warning, and this function
6852 will silently just set C<retlen> to C<-1> and return zero. If the
6853 C<flags> does not contain UTF8_CHECK_ONLY, warnings about
6854 malformations will be given, C<retlen> will be set to the expected
6855 length of the UTF-8 character in bytes, and zero will be returned.
6857 The C<flags> can also contain various flags to allow deviations from
6858 the strict UTF-8 encoding (see F<utf8.h>).
6860 Most code should use utf8_to_uvchr() rather than call this directly.
6862 UV utf8n_to_uvuni(const U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags)
6865 Found in file utf8.c
6870 Returns the number of UTF-8 characters between the UTF-8 pointers C<a>
6873 WARNING: use only if you *know* that the pointers point inside the
6876 IV utf8_distance(const U8 *a, const U8 *b)
6879 Found in file utf8.c
6884 Return the UTF-8 pointer C<s> displaced by C<off> characters, either
6885 forward or backward.
6887 WARNING: do not use the following unless you *know* C<off> is within
6888 the UTF-8 data pointed to by C<s> *and* that on entry C<s> is aligned
6889 on the first byte of character or just after the last byte of a character.
6891 U8* utf8_hop(const U8 *s, I32 off)
6894 Found in file utf8.c
6899 Return the length of the UTF-8 char encoded string C<s> in characters.
6900 Stops at C<e> (inclusive). If C<e E<lt> s> or if the scan would end
6901 up past C<e>, croaks.
6903 STRLEN utf8_length(const U8* s, const U8 *e)
6906 Found in file utf8.c
6911 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
6912 Unlike C<bytes_to_utf8>, this over-writes the original string, and
6913 updates len to contain the new length.
6914 Returns zero on failure, setting C<len> to -1.
6916 If you need a copy of the string, see C<bytes_from_utf8>.
6918 NOTE: this function is experimental and may change or be
6919 removed without notice.
6921 U8* utf8_to_bytes(U8 *s, STRLEN *len)
6924 Found in file utf8.c
6929 Returns the native character value of the first character in the string C<s>
6930 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6931 length, in bytes, of that character.
6933 If C<s> does not point to a well-formed UTF-8 character, zero is
6934 returned and retlen is set, if possible, to -1.
6936 UV utf8_to_uvchr(const U8 *s, STRLEN *retlen)
6939 Found in file utf8.c
6944 Returns the Unicode code point of the first character in the string C<s>
6945 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6946 length, in bytes, of that character.
6948 This function should only be used when returned UV is considered
6949 an index into the Unicode semantic tables (e.g. swashes).
6951 If C<s> does not point to a well-formed UTF-8 character, zero is
6952 returned and retlen is set, if possible, to -1.
6954 UV utf8_to_uvuni(const U8 *s, STRLEN *retlen)
6957 Found in file utf8.c
6962 Adds the UTF-8 representation of the Native codepoint C<uv> to the end
6963 of the string C<d>; C<d> should be have at least C<UTF8_MAXBYTES+1> free
6964 bytes available. The return value is the pointer to the byte after the
6965 end of the new character. In other words,
6967 d = uvchr_to_utf8(d, uv);
6969 is the recommended wide native character-aware way of saying
6973 U8* uvchr_to_utf8(U8 *d, UV uv)
6976 Found in file utf8.c
6978 =item uvuni_to_utf8_flags
6979 X<uvuni_to_utf8_flags>
6981 Adds the UTF-8 representation of the Unicode codepoint C<uv> to the end
6982 of the string C<d>; C<d> should be have at least C<UTF8_MAXBYTES+1> free
6983 bytes available. The return value is the pointer to the byte after the
6984 end of the new character. In other words,
6986 d = uvuni_to_utf8_flags(d, uv, flags);
6990 d = uvuni_to_utf8(d, uv);
6992 (which is equivalent to)
6994 d = uvuni_to_utf8_flags(d, uv, 0);
6996 is the recommended Unicode-aware way of saying
7000 U8* uvuni_to_utf8_flags(U8 *d, UV uv, UV flags)
7003 Found in file utf8.c
7008 =head1 Variables created by C<xsubpp> and C<xsubpp> internal functions
7015 Variable which is setup by C<xsubpp> to indicate the stack base offset,
7016 used by the C<ST>, C<XSprePUSH> and C<XSRETURN> macros. The C<dMARK> macro
7017 must be called prior to setup the C<MARK> variable.
7022 Found in file XSUB.h
7027 Variable which is setup by C<xsubpp> to indicate the
7028 class name for a C++ XS constructor. This is always a C<char*>. See C<THIS>.
7033 Found in file XSUB.h
7038 Sets up the C<ax> variable.
7039 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
7044 Found in file XSUB.h
7049 Sets up the C<ax> variable and stack marker variable C<mark>.
7050 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
7055 Found in file XSUB.h
7060 Sets up the C<items> variable.
7061 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
7066 Found in file XSUB.h
7071 Sets up the C<padoff_du> variable for an XSUB that wishes to use
7077 Found in file XSUB.h
7082 Sets up stack and mark pointers for an XSUB, calling dSP and dMARK.
7083 Sets up the C<ax> and C<items> variables by calling C<dAX> and C<dITEMS>.
7084 This is usually handled automatically by C<xsubpp>.
7089 Found in file XSUB.h
7094 Sets up the C<ix> variable for an XSUB which has aliases. This is usually
7095 handled automatically by C<xsubpp>.
7100 Found in file XSUB.h
7105 Variable which is setup by C<xsubpp> to indicate the number of
7106 items on the stack. See L<perlxs/"Variable-length Parameter Lists">.
7111 Found in file XSUB.h
7116 Variable which is setup by C<xsubpp> to indicate which of an
7117 XSUB's aliases was used to invoke it. See L<perlxs/"The ALIAS: Keyword">.
7122 Found in file XSUB.h
7127 Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
7131 Found in file XSUB.h
7136 Variable which is setup by C<xsubpp> to hold the return value for an
7137 XSUB. This is always the proper type for the XSUB. See
7138 L<perlxs/"The RETVAL Variable">.
7143 Found in file XSUB.h
7148 Used to access elements on the XSUB's stack.
7153 Found in file XSUB.h
7158 Variable which is setup by C<xsubpp> to designate the object in a C++
7159 XSUB. This is always the proper type for the C++ object. See C<CLASS> and
7160 L<perlxs/"Using XS With C++">.
7165 Found in file XSUB.h
7170 The SV* corresponding to the $_ variable. Works even if there
7171 is a lexical $_ in scope.
7174 Found in file XSUB.h
7179 Macro to declare an XSUB and its C parameter list. This is handled by
7183 Found in file XSUB.h
7188 The version identifier for an XS module. This is usually
7189 handled automatically by C<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>.
7192 Found in file XSUB.h
7194 =item XS_VERSION_BOOTCHECK
7195 X<XS_VERSION_BOOTCHECK>
7197 Macro to verify that a PM module's $VERSION variable matches the XS
7198 module's C<XS_VERSION> variable. This is usually handled automatically by
7199 C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">.
7201 XS_VERSION_BOOTCHECK;
7204 Found in file XSUB.h
7209 =head1 Warning and Dieing
7216 This is the XSUB-writer's interface to Perl's C<die> function.
7217 Normally call this function the same way you call the C C<printf>
7218 function. Calling C<croak> returns control directly to Perl,
7219 sidestepping the normal C order of execution. See C<warn>.
7221 If you want to throw an exception object, assign the object to
7222 C<$@> and then pass C<NULL> to croak():
7224 errsv = get_sv("@", TRUE);
7225 sv_setsv(errsv, exception_object);
7228 void croak(const char* pat, ...)
7231 Found in file util.c
7236 This is the XSUB-writer's interface to Perl's C<warn> function. Call this
7237 function the same way you call the C C<printf> function. See C<croak>.
7239 void warn(const char* pat, ...)
7242 Found in file util.c
7249 Until May 1997, this document was maintained by Jeff Okamoto
7250 <okamoto@corp.hp.com>. It is now maintained as part of Perl itself.
7252 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
7253 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
7254 Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
7255 Stephen McCamant, and Gurusamy Sarathy.
7257 API Listing originally by Dean Roehrich <roehrich@cray.com>.
7259 Updated to be autogenerated from comments in the source by Benjamin Stuhl.
7263 perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
projects / p5sagit/p5-mst-13.2.git / blob