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, VOL 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)
1402 (deprecated - use C<(AV *)NULL> instead)
1410 Null character pointer. (No longer available when C<PERL_CORE> is defined.)
1413 Found in file handy.h
1420 (deprecated - use C<(CV *)NULL> instead)
1430 (deprecated - use C<(HV *)NULL> instead)
1438 Null SV pointer. (No longer available when C<PERL_CORE> is defined.)
1441 Found in file handy.h
1446 =head1 Hash Manipulation Functions
1453 Returns the HV of the specified Perl hash. If C<create> is set and the
1454 Perl variable does not exist then it will be created. If C<create> is not
1455 set and the variable does not exist then NULL is returned.
1457 NOTE: the perl_ form of this function is deprecated.
1459 HV* get_hv(const char* name, I32 create)
1462 Found in file perl.c
1467 This flag, used in the length slot of hash entries and magic structures,
1468 specifies the structure contains an C<SV*> pointer where a C<char*> pointer
1469 is to be expected. (For information only--not to be used).
1477 Returns the computed hash stored in the hash entry.
1487 Returns the actual pointer stored in the key slot of the hash entry. The
1488 pointer may be either C<char*> or C<SV*>, depending on the value of
1489 C<HeKLEN()>. Can be assigned to. The C<HePV()> or C<HeSVKEY()> macros are
1490 usually preferable for finding the value of a key.
1500 If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry
1501 holds an C<SV*> key. Otherwise, holds the actual length of the key. Can
1502 be assigned to. The C<HePV()> macro is usually preferable for finding key
1505 STRLEN HeKLEN(HE* he)
1513 Returns the key slot of the hash entry as a C<char*> value, doing any
1514 necessary dereferencing of possibly C<SV*> keys. The length of the string
1515 is placed in C<len> (this is a macro, so do I<not> use C<&len>). If you do
1516 not care about what the length of the key is, you may use the global
1517 variable C<PL_na>, though this is rather less efficient than using a local
1518 variable. Remember though, that hash keys in perl are free to contain
1519 embedded nulls, so using C<strlen()> or similar is not a good way to find
1520 the length of hash keys. This is very similar to the C<SvPV()> macro
1521 described elsewhere in this document. See also C<HeUTF8>.
1523 If you are using C<HePV> to get values to pass to C<newSVpvn()> to create a
1524 new SV, you should consider using C<newSVhek(HeKEY_hek(he))> as it is more
1527 char* HePV(HE* he, STRLEN len)
1535 Returns the key as an C<SV*>, or C<NULL> if the hash entry does not
1536 contain an C<SV*> key.
1546 Returns the key as an C<SV*>. Will create and return a temporary mortal
1547 C<SV*> if the hash entry contains only a C<char*> key.
1549 SV* HeSVKEY_force(HE* he)
1557 Sets the key to a given C<SV*>, taking care to set the appropriate flags to
1558 indicate the presence of an C<SV*> key, and returns the same
1561 SV* HeSVKEY_set(HE* he, SV* sv)
1569 Returns whether the C<char *> value returned by C<HePV> is encoded in UTF-8,
1570 doing any necessary dereferencing of possibly C<SV*> keys. The value returned
1571 will be 0 or non-0, not necessarily 1 (or even a value with any low bits set),
1572 so B<do not> blindly assign this to a C<bool> variable, as C<bool> may be a
1573 typedef for C<char>.
1575 char* HeUTF8(HE* he, STRLEN len)
1583 Returns the value slot (type C<SV*>) stored in the hash entry.
1593 Returns the package name of a stash, or NULL if C<stash> isn't a stash.
1594 See C<SvSTASH>, C<CvSTASH>.
1596 char* HvNAME(HV* stash)
1604 Check that a hash is in an internally consistent state.
1606 void hv_assert(HV* tb)
1614 Clears a hash, making it empty.
1616 void hv_clear(HV* tb)
1621 =item hv_clear_placeholders
1622 X<hv_clear_placeholders>
1624 Clears any placeholders from a hash. If a restricted hash has any of its keys
1625 marked as readonly and the key is subsequently deleted, the key is not actually
1626 deleted but is marked by assigning it a value of &PL_sv_placeholder. This tags
1627 it so it will be ignored by future operations such as iterating over the hash,
1628 but will still allow the hash to have a value reassigned to the key at some
1629 future point. This function clears any such placeholder keys from the hash.
1630 See Hash::Util::lock_keys() for an example of its use.
1632 void hv_clear_placeholders(HV* hb)
1640 Deletes a key/value pair in the hash. The value SV is removed from the
1641 hash and returned to the caller. The C<klen> is the length of the key.
1642 The C<flags> value will normally be zero; if set to G_DISCARD then NULL
1645 SV* hv_delete(HV* tb, const char* key, I32 klen, I32 flags)
1653 Deletes a key/value pair in the hash. The value SV is removed from the
1654 hash and returned to the caller. The C<flags> value will normally be zero;
1655 if set to G_DISCARD then NULL will be returned. C<hash> can be a valid
1656 precomputed hash value, or 0 to ask for it to be computed.
1658 SV* hv_delete_ent(HV* tb, SV* key, I32 flags, U32 hash)
1666 Returns a boolean indicating whether the specified hash key exists. The
1667 C<klen> is the length of the key.
1669 bool hv_exists(HV* tb, const char* key, I32 klen)
1677 Returns a boolean indicating whether the specified hash key exists. C<hash>
1678 can be a valid precomputed hash value, or 0 to ask for it to be
1681 bool hv_exists_ent(HV* tb, SV* key, U32 hash)
1689 Returns the SV which corresponds to the specified key in the hash. The
1690 C<klen> is the length of the key. If C<lval> is set then the fetch will be
1691 part of a store. Check that the return value is non-null before
1692 dereferencing it to an C<SV*>.
1694 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1695 information on how to use this function on tied hashes.
1697 SV** hv_fetch(HV* tb, const char* key, I32 klen, I32 lval)
1705 Like C<hv_fetch>, but takes a literal string instead of a string/length pair.
1707 SV** hv_fetchs(HV* tb, const char* key, I32 lval)
1710 Found in file handy.h
1715 Returns the hash entry which corresponds to the specified key in the hash.
1716 C<hash> must be a valid precomputed hash number for the given C<key>, or 0
1717 if you want the function to compute it. IF C<lval> is set then the fetch
1718 will be part of a store. Make sure the return value is non-null before
1719 accessing it. The return value when C<tb> is a tied hash is a pointer to a
1720 static location, so be sure to make a copy of the structure if you need to
1723 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1724 information on how to use this function on tied hashes.
1726 HE* hv_fetch_ent(HV* tb, SV* key, I32 lval, U32 hash)
1734 Prepares a starting point to traverse a hash table. Returns the number of
1735 keys in the hash (i.e. the same as C<HvKEYS(tb)>). The return value is
1736 currently only meaningful for hashes without tie magic.
1738 NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
1739 hash buckets that happen to be in use. If you still need that esoteric
1740 value, you can get it through the macro C<HvFILL(tb)>.
1743 I32 hv_iterinit(HV* tb)
1751 Returns the key from the current position of the hash iterator. See
1754 char* hv_iterkey(HE* entry, I32* retlen)
1762 Returns the key as an C<SV*> from the current position of the hash
1763 iterator. The return value will always be a mortal copy of the key. Also
1766 SV* hv_iterkeysv(HE* entry)
1774 Returns entries from a hash iterator. See C<hv_iterinit>.
1776 You may call C<hv_delete> or C<hv_delete_ent> on the hash entry that the
1777 iterator currently points to, without losing your place or invalidating your
1778 iterator. Note that in this case the current entry is deleted from the hash
1779 with your iterator holding the last reference to it. Your iterator is flagged
1780 to free the entry on the next call to C<hv_iternext>, so you must not discard
1781 your iterator immediately else the entry will leak - call C<hv_iternext> to
1782 trigger the resource deallocation.
1784 HE* hv_iternext(HV* tb)
1792 Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
1795 SV* hv_iternextsv(HV* hv, char** key, I32* retlen)
1800 =item hv_iternext_flags
1801 X<hv_iternext_flags>
1803 Returns entries from a hash iterator. See C<hv_iterinit> and C<hv_iternext>.
1804 The C<flags> value will normally be zero; if HV_ITERNEXT_WANTPLACEHOLDERS is
1805 set the placeholders keys (for restricted hashes) will be returned in addition
1806 to normal keys. By default placeholders are automatically skipped over.
1807 Currently a placeholder is implemented with a value that is
1808 C<&Perl_sv_placeholder>. Note that the implementation of placeholders and
1809 restricted hashes may change, and the implementation currently is
1810 insufficiently abstracted for any change to be tidy.
1812 NOTE: this function is experimental and may change or be
1813 removed without notice.
1815 HE* hv_iternext_flags(HV* tb, I32 flags)
1823 Returns the value from the current position of the hash iterator. See
1826 SV* hv_iterval(HV* tb, HE* entry)
1834 Adds magic to a hash. See C<sv_magic>.
1836 void hv_magic(HV* hv, GV* gv, int how)
1844 Evaluates the hash in scalar context and returns the result. Handles magic when the hash is tied.
1846 SV* hv_scalar(HV* hv)
1854 Stores an SV in a hash. The hash key is specified as C<key> and C<klen> is
1855 the length of the key. The C<hash> parameter is the precomputed hash
1856 value; if it is zero then Perl will compute it. The return value will be
1857 NULL if the operation failed or if the value did not need to be actually
1858 stored within the hash (as in the case of tied hashes). Otherwise it can
1859 be dereferenced to get the original C<SV*>. Note that the caller is
1860 responsible for suitably incrementing the reference count of C<val> before
1861 the call, and decrementing it if the function returned NULL. Effectively
1862 a successful hv_store takes ownership of one reference to C<val>. This is
1863 usually what you want; a newly created SV has a reference count of one, so
1864 if all your code does is create SVs then store them in a hash, hv_store
1865 will own the only reference to the new SV, and your code doesn't need to do
1866 anything further to tidy up. hv_store is not implemented as a call to
1867 hv_store_ent, and does not create a temporary SV for the key, so if your
1868 key data is not already in SV form then use hv_store in preference to
1871 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1872 information on how to use this function on tied hashes.
1874 SV** hv_store(HV* tb, const char* key, I32 klen, SV* val, U32 hash)
1882 Like C<hv_store>, but takes a literal string instead of a string/length pair
1883 and omits the hash parameter.
1885 SV** hv_stores(HV* tb, const char* key, NULLOK SV* val)
1888 Found in file handy.h
1893 Stores C<val> in a hash. The hash key is specified as C<key>. The C<hash>
1894 parameter is the precomputed hash value; if it is zero then Perl will
1895 compute it. The return value is the new hash entry so created. It will be
1896 NULL if the operation failed or if the value did not need to be actually
1897 stored within the hash (as in the case of tied hashes). Otherwise the
1898 contents of the return value can be accessed using the C<He?> macros
1899 described here. Note that the caller is responsible for suitably
1900 incrementing the reference count of C<val> before the call, and
1901 decrementing it if the function returned NULL. Effectively a successful
1902 hv_store_ent takes ownership of one reference to C<val>. This is
1903 usually what you want; a newly created SV has a reference count of one, so
1904 if all your code does is create SVs then store them in a hash, hv_store
1905 will own the only reference to the new SV, and your code doesn't need to do
1906 anything further to tidy up. Note that hv_store_ent only reads the C<key>;
1907 unlike C<val> it does not take ownership of it, so maintaining the correct
1908 reference count on C<key> is entirely the caller's responsibility. hv_store
1909 is not implemented as a call to hv_store_ent, and does not create a temporary
1910 SV for the key, so if your key data is not already in SV form then use
1911 hv_store in preference to hv_store_ent.
1913 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1914 information on how to use this function on tied hashes.
1916 HE* hv_store_ent(HV* tb, SV* key, SV* val, U32 hash)
1926 void hv_undef(HV* tb)
1934 Creates a new HV. The reference count is set to 1.
1944 =head1 Magical Functions
1951 Clear something magical that the SV represents. See C<sv_magic>.
1953 int mg_clear(SV* sv)
1961 Copies the magic from one SV to another. See C<sv_magic>.
1963 int mg_copy(SV* sv, SV* nsv, const char* key, I32 klen)
1971 Finds the magic pointer for type matching the SV. See C<sv_magic>.
1973 MAGIC* mg_find(const SV* sv, int type)
1981 Free any magic storage used by the SV. See C<sv_magic>.
1991 Do magic after a value is retrieved from the SV. See C<sv_magic>.
2001 Report on the SV's length. See C<sv_magic>.
2003 U32 mg_length(SV* sv)
2011 Turns on the magical status of an SV. See C<sv_magic>.
2013 void mg_magical(SV* sv)
2021 Do magic after a value is assigned to the SV. See C<sv_magic>.
2031 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
2032 argument more than once.
2034 void SvGETMAGIC(SV* sv)
2042 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
2053 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
2054 argument more than once.
2056 void SvSETMAGIC(SV* sv)
2064 Like C<SvSetSV>, but does any set magic required afterwards.
2066 void SvSetMagicSV(SV* dsb, SV* ssv)
2071 =item SvSetMagicSV_nosteal
2072 X<SvSetMagicSV_nosteal>
2074 Like C<SvSetSV_nosteal>, but does any set magic required afterwards.
2076 void SvSetMagicSV_nosteal(SV* dsv, SV* ssv)
2084 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
2087 void SvSetSV(SV* dsb, SV* ssv)
2092 =item SvSetSV_nosteal
2095 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
2096 ssv. May evaluate arguments more than once.
2098 void SvSetSV_nosteal(SV* dsv, SV* ssv)
2106 Arranges for sv to be shared between threads if a suitable module
2109 void SvSHARE(SV* sv)
2117 Releases a mutual exclusion lock on sv if a suitable module
2120 void SvUNLOCK(SV* sv)
2128 =head1 Memory Management
2135 The XSUB-writer's interface to the C C<memcpy> function. The C<src> is the
2136 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
2137 the type. May fail on overlapping copies. See also C<Move>.
2139 void Copy(void* src, void* dest, int nitems, type)
2142 Found in file handy.h
2147 Like C<Copy> but returns dest. Useful for encouraging compilers to tail-call
2150 void * CopyD(void* src, void* dest, int nitems, type)
2153 Found in file handy.h
2158 The XSUB-writer's interface to the C C<memmove> function. The C<src> is the
2159 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
2160 the type. Can do overlapping moves. See also C<Copy>.
2162 void Move(void* src, void* dest, int nitems, type)
2165 Found in file handy.h
2170 Like C<Move> but returns dest. Useful for encouraging compilers to tail-call
2173 void * MoveD(void* src, void* dest, int nitems, type)
2176 Found in file handy.h
2181 The XSUB-writer's interface to the C C<malloc> function.
2183 In 5.9.3, Newx() and friends replace the older New() API, and drops
2184 the first parameter, I<x>, a debug aid which allowed callers to identify
2185 themselves. This aid has been superseded by a new build option,
2186 PERL_MEM_LOG (see L<perlhack/PERL_MEM_LOG>). The older API is still
2187 there for use in XS modules supporting older perls.
2189 void Newx(void* ptr, int nitems, type)
2192 Found in file handy.h
2197 The XSUB-writer's interface to the C C<malloc> function, with
2198 cast. See also C<Newx>.
2200 void Newxc(void* ptr, int nitems, type, cast)
2203 Found in file handy.h
2208 The XSUB-writer's interface to the C C<malloc> function. The allocated
2209 memory is zeroed with C<memzero>. See also C<Newx>.
2211 void Newxz(void* ptr, int nitems, type)
2214 Found in file handy.h
2219 PoisonWith(0xEF) for catching access to freed memory.
2221 void Poison(void* dest, int nitems, type)
2224 Found in file handy.h
2229 PoisonWith(0xEF) for catching access to freed memory.
2231 void PoisonFree(void* dest, int nitems, type)
2234 Found in file handy.h
2239 PoisonWith(0xAB) for catching access to allocated but uninitialized memory.
2241 void PoisonNew(void* dest, int nitems, type)
2244 Found in file handy.h
2249 Fill up memory with a byte pattern (a byte repeated over and over
2250 again) that hopefully catches attempts to access uninitialized memory.
2252 void PoisonWith(void* dest, int nitems, type, U8 byte)
2255 Found in file handy.h
2260 The XSUB-writer's interface to the C C<realloc> function.
2262 void Renew(void* ptr, int nitems, type)
2265 Found in file handy.h
2270 The XSUB-writer's interface to the C C<realloc> function, with
2273 void Renewc(void* ptr, int nitems, type, cast)
2276 Found in file handy.h
2281 The XSUB-writer's interface to the C C<free> function.
2283 void Safefree(void* ptr)
2286 Found in file handy.h
2291 Perl's version of C<strdup()>. Returns a pointer to a newly allocated
2292 string which is a duplicate of C<pv>. The size of the string is
2293 determined by C<strlen()>. The memory allocated for the new string can
2294 be freed with the C<Safefree()> function.
2296 char* savepv(const char* pv)
2299 Found in file util.c
2304 Perl's version of what C<strndup()> would be if it existed. Returns a
2305 pointer to a newly allocated string which is a duplicate of the first
2306 C<len> bytes from C<pv>, plus a trailing NUL byte. The memory allocated for
2307 the new string can be freed with the C<Safefree()> function.
2309 char* savepvn(const char* pv, I32 len)
2312 Found in file util.c
2317 Like C<savepvn>, but takes a literal string instead of a string/length pair.
2319 char* savepvs(const char* s)
2322 Found in file handy.h
2327 A version of C<savepv()> which allocates the duplicate string in memory
2328 which is shared between threads.
2330 char* savesharedpv(const char* pv)
2333 Found in file util.c
2338 A version of C<savepvn()> which allocates the duplicate string in memory
2339 which is shared between threads. (With the specific difference that a NULL
2340 pointer is not acceptable)
2342 char* savesharedpvn(const char *const pv, const STRLEN len)
2345 Found in file util.c
2350 A version of C<savepv()>/C<savepvn()> which gets the string to duplicate from
2351 the passed in SV using C<SvPV()>
2353 char* savesvpv(SV* sv)
2356 Found in file util.c
2361 This is an architecture-independent macro to copy one structure to another.
2363 void StructCopy(type src, type dest, type)
2366 Found in file handy.h
2371 The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the
2372 destination, C<nitems> is the number of items, and C<type> is the type.
2374 void Zero(void* dest, int nitems, type)
2377 Found in file handy.h
2382 Like C<Zero> but returns dest. Useful for encouraging compilers to tail-call
2385 void * ZeroD(void* dest, int nitems, type)
2388 Found in file handy.h
2393 =head1 Miscellaneous Functions
2400 Analyses the string in order to make fast searches on it using fbm_instr()
2401 -- the Boyer-Moore algorithm.
2403 void fbm_compile(SV* sv, U32 flags)
2406 Found in file util.c
2411 Returns the location of the SV in the string delimited by C<str> and
2412 C<strend>. It returns C<NULL> if the string can't be found. The C<sv>
2413 does not have to be fbm_compiled, but the search will not be as fast
2416 char* fbm_instr(unsigned char* big, unsigned char* bigend, SV* littlesv, U32 flags)
2419 Found in file util.c
2424 Takes a sprintf-style format pattern and conventional
2425 (non-SV) arguments and returns the formatted string.
2427 (char *) Perl_form(pTHX_ const char* pat, ...)
2429 can be used any place a string (char *) is required:
2431 char * s = Perl_form("%d.%d",major,minor);
2433 Uses a single private buffer so if you want to format several strings you
2434 must explicitly copy the earlier strings away (and free the copies when you
2437 char* form(const char* pat, ...)
2440 Found in file util.c
2445 Fill the sv with current working directory
2447 int getcwd_sv(SV* sv)
2450 Found in file util.c
2455 The C library C<snprintf> functionality, if available and
2456 standards-compliant (uses C<vsnprintf>, actually). However, if the
2457 C<vsnprintf> is not available, will unfortunately use the unsafe
2458 C<vsprintf> which can overrun the buffer (there is an overrun check,
2459 but that may be too late). Consider using C<sv_vcatpvf> instead, or
2460 getting C<vsnprintf>.
2462 int my_snprintf(char *buffer, const Size_t len, const char *format, ...)
2465 Found in file util.c
2470 The C library C<sprintf>, wrapped if necessary, to ensure that it will return
2471 the length of the string written to the buffer. Only rare pre-ANSI systems
2472 need the wrapper function - usually this is a direct call to C<sprintf>.
2474 int my_sprintf(char *buffer, const char *pat, ...)
2477 Found in file util.c
2482 The C library C<vsnprintf> if available and standards-compliant.
2483 However, if if the C<vsnprintf> is not available, will unfortunately
2484 use the unsafe C<vsprintf> which can overrun the buffer (there is an
2485 overrun check, but that may be too late). Consider using
2486 C<sv_vcatpvf> instead, or getting C<vsnprintf>.
2488 int my_vsnprintf(char *buffer, const Size_t len, const char *format, va_list ap)
2491 Found in file util.c
2496 Returns a new version object based on the passed in SV:
2498 SV *sv = new_version(SV *ver);
2500 Does not alter the passed in ver SV. See "upg_version" if you
2501 want to upgrade the SV.
2503 SV* new_version(SV *ver)
2506 Found in file util.c
2511 Returns a pointer to the next character after the parsed
2512 version string, as well as upgrading the passed in SV to
2515 Function must be called with an already existing SV like
2518 s = scan_version(s, SV *sv, bool qv);
2520 Performs some preprocessing to the string to ensure that
2521 it has the correct characteristics of a version. Flags the
2522 object if it contains an underscore (which denotes this
2523 is an alpha version). The boolean qv denotes that the version
2524 should be interpreted as if it had multiple decimals, even if
2527 const char* scan_version(const char *vstr, SV *sv, bool qv)
2530 Found in file util.c
2535 Test two strings to see if they are equal. Returns true or false.
2537 bool strEQ(char* s1, char* s2)
2540 Found in file handy.h
2545 Test two strings to see if the first, C<s1>, is greater than or equal to
2546 the second, C<s2>. Returns true or false.
2548 bool strGE(char* s1, char* s2)
2551 Found in file handy.h
2556 Test two strings to see if the first, C<s1>, is greater than the second,
2557 C<s2>. Returns true or false.
2559 bool strGT(char* s1, char* s2)
2562 Found in file handy.h
2567 Test two strings to see if the first, C<s1>, is less than or equal to the
2568 second, C<s2>. Returns true or false.
2570 bool strLE(char* s1, char* s2)
2573 Found in file handy.h
2578 Test two strings to see if the first, C<s1>, is less than the second,
2579 C<s2>. Returns true or false.
2581 bool strLT(char* s1, char* s2)
2584 Found in file handy.h
2589 Test two strings to see if they are different. Returns true or
2592 bool strNE(char* s1, char* s2)
2595 Found in file handy.h
2600 Test two strings to see if they are equal. The C<len> parameter indicates
2601 the number of bytes to compare. Returns true or false. (A wrapper for
2604 bool strnEQ(char* s1, char* s2, STRLEN len)
2607 Found in file handy.h
2612 Test two strings to see if they are different. The C<len> parameter
2613 indicates the number of bytes to compare. Returns true or false. (A
2614 wrapper for C<strncmp>).
2616 bool strnNE(char* s1, char* s2, STRLEN len)
2619 Found in file handy.h
2621 =item sv_destroyable
2624 Dummy routine which reports that object can be destroyed when there is no
2625 sharing module present. It ignores its single SV argument, and returns
2626 'true'. Exists to avoid test for a NULL function pointer and because it
2627 could potentially warn under some level of strict-ness.
2629 bool sv_destroyable(SV *sv)
2632 Found in file util.c
2637 Dummy routine which "shares" an SV when there is no sharing module present.
2638 Or "locks" it. Or "unlocks" it. In other words, ignores its single SV argument.
2639 Exists to avoid test for a NULL function pointer and because it could
2640 potentially warn under some level of strict-ness.
2642 void sv_nosharing(SV *sv)
2645 Found in file util.c
2650 In-place upgrade of the supplied SV to a version object.
2652 SV *sv = upg_version(SV *sv, bool qv);
2654 Returns a pointer to the upgraded SV. Set the boolean qv if you want
2655 to force this SV to be interpreted as an "extended" version.
2657 SV* upg_version(SV *ver, bool qv)
2660 Found in file util.c
2665 Version object aware cmp. Both operands must already have been
2666 converted into version objects.
2668 int vcmp(SV *lvs, SV *rvs)
2671 Found in file util.c
2676 Accepts a version object and returns the normalized string
2677 representation. Call like:
2681 NOTE: you can pass either the object directly or the SV
2682 contained within the RV.
2687 Found in file util.c
2692 Accepts a version object and returns the normalized floating
2693 point representation. Call like:
2697 NOTE: you can pass either the object directly or the SV
2698 contained within the RV.
2703 Found in file util.c
2708 In order to maintain maximum compatibility with earlier versions
2709 of Perl, this function will return either the floating point
2710 notation or the multiple dotted notation, depending on whether
2711 the original version contained 1 or more dots, respectively
2713 SV* vstringify(SV *vs)
2716 Found in file util.c
2721 Validates that the SV contains a valid version object.
2723 bool vverify(SV *vobj);
2725 Note that it only confirms the bare minimum structure (so as not to get
2726 confused by derived classes which may contain additional hash entries):
2728 bool vverify(SV *vs)
2731 Found in file util.c
2736 =head1 MRO Functions
2740 =item mro_get_linear_isa
2741 X<mro_get_linear_isa>
2743 Returns either C<mro_get_linear_isa_c3> or
2744 C<mro_get_linear_isa_dfs> for the given stash,
2745 dependant upon which MRO is in effect
2746 for that stash. The return value is a
2749 You are responsible for C<SvREFCNT_inc()> on the
2750 return value if you plan to store it anywhere
2751 semi-permanently (otherwise it might be deleted
2752 out from under you the next time the cache is
2755 AV* mro_get_linear_isa(HV* stash)
2760 =item mro_method_changed_in
2761 X<mro_method_changed_in>
2763 Invalidates method caching on any child classes
2764 of the given stash, so that they might notice
2765 the changes in this one.
2767 Ideally, all instances of C<PL_sub_generation++> in
2768 perl source outside of C<mro.c> should be
2769 replaced by calls to this.
2771 Perl automatically handles most of the common
2772 ways a method might be redefined. However, there
2773 are a few ways you could change a method in a stash
2774 without the cache code noticing, in which case you
2775 need to call this method afterwards:
2777 1) Directly manipulating the stash HV entries from
2780 2) Assigning a reference to a readonly scalar
2781 constant into a stash entry in order to create
2782 a constant subroutine (like constant.pm
2785 This same method is available from pure perl
2786 via, C<mro::method_changed_in(classname)>.
2788 void mro_method_changed_in(HV* stash)
2796 =head1 Multicall Functions
2803 Declare local variables for a multicall. See L<perlcall/Lightweight Callbacks>.
2813 Make a lightweight callback. See L<perlcall/Lightweight Callbacks>.
2823 Closing bracket for a lightweight callback.
2824 See L<perlcall/Lightweight Callbacks>.
2831 =item PUSH_MULTICALL
2834 Opening bracket for a lightweight callback.
2835 See L<perlcall/Lightweight Callbacks>.
2845 =head1 Numeric functions
2852 converts a string representing a binary number to numeric form.
2854 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2855 conversion flags, and I<result> should be NULL or a pointer to an NV.
2856 The scan stops at the end of the string, or the first invalid character.
2857 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2858 invalid character will also trigger a warning.
2859 On return I<*len> is set to the length of the scanned string,
2860 and I<*flags> gives output flags.
2862 If the value is <= C<UV_MAX> it is returned as a UV, the output flags are clear,
2863 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_bin>
2864 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2865 and writes the value to I<*result> (or the value is discarded if I<result>
2868 The binary number may optionally be prefixed with "0b" or "b" unless
2869 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
2870 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the binary
2871 number may use '_' characters to separate digits.
2873 UV grok_bin(const char* start, STRLEN* len_p, I32* flags, NV *result)
2876 Found in file numeric.c
2881 converts a string representing a hex number to numeric form.
2883 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2884 conversion flags, and I<result> should be NULL or a pointer to an NV.
2885 The scan stops at the end of the string, or the first invalid character.
2886 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2887 invalid character will also trigger a warning.
2888 On return I<*len> is set to the length of the scanned string,
2889 and I<*flags> gives output flags.
2891 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2892 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_hex>
2893 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2894 and writes the value to I<*result> (or the value is discarded if I<result>
2897 The hex number may optionally be prefixed with "0x" or "x" unless
2898 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
2899 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the hex
2900 number may use '_' characters to separate digits.
2902 UV grok_hex(const char* start, STRLEN* len_p, I32* flags, NV *result)
2905 Found in file numeric.c
2910 Recognise (or not) a number. The type of the number is returned
2911 (0 if unrecognised), otherwise it is a bit-ORed combination of
2912 IS_NUMBER_IN_UV, IS_NUMBER_GREATER_THAN_UV_MAX, IS_NUMBER_NOT_INT,
2913 IS_NUMBER_NEG, IS_NUMBER_INFINITY, IS_NUMBER_NAN (defined in perl.h).
2915 If the value of the number can fit an in UV, it is returned in the *valuep
2916 IS_NUMBER_IN_UV will be set to indicate that *valuep is valid, IS_NUMBER_IN_UV
2917 will never be set unless *valuep is valid, but *valuep may have been assigned
2918 to during processing even though IS_NUMBER_IN_UV is not set on return.
2919 If valuep is NULL, IS_NUMBER_IN_UV will be set for the same cases as when
2920 valuep is non-NULL, but no actual assignment (or SEGV) will occur.
2922 IS_NUMBER_NOT_INT will be set with IS_NUMBER_IN_UV if trailing decimals were
2923 seen (in which case *valuep gives the true value truncated to an integer), and
2924 IS_NUMBER_NEG if the number is negative (in which case *valuep holds the
2925 absolute value). IS_NUMBER_IN_UV is not set if e notation was used or the
2926 number is larger than a UV.
2928 int grok_number(const char *pv, STRLEN len, UV *valuep)
2931 Found in file numeric.c
2933 =item grok_numeric_radix
2934 X<grok_numeric_radix>
2936 Scan and skip for a numeric decimal separator (radix).
2938 bool grok_numeric_radix(const char **sp, const char *send)
2941 Found in file numeric.c
2946 converts a string representing an octal number to numeric form.
2948 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2949 conversion flags, and I<result> should be NULL or a pointer to an NV.
2950 The scan stops at the end of the string, or the first invalid character.
2951 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2952 invalid character will also trigger a warning.
2953 On return I<*len> is set to the length of the scanned string,
2954 and I<*flags> gives output flags.
2956 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2957 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_oct>
2958 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2959 and writes the value to I<*result> (or the value is discarded if I<result>
2962 If C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the octal
2963 number may use '_' characters to separate digits.
2965 UV grok_oct(const char* start, STRLEN* len_p, I32* flags, NV *result)
2968 Found in file numeric.c
2973 Return a non-zero integer if the sign bit on an NV is set, and 0 if
2976 If Configure detects this system has a signbit() that will work with
2977 our NVs, then we just use it via the #define in perl.h. Otherwise,
2978 fall back on this implementation. As a first pass, this gets everything
2979 right except -0.0. Alas, catching -0.0 is the main use for this function,
2980 so this is not too helpful yet. Still, at least we have the scaffolding
2981 in place to support other systems, should that prove useful.
2984 Configure notes: This function is called 'Perl_signbit' instead of a
2985 plain 'signbit' because it is easy to imagine a system having a signbit()
2986 function or macro that doesn't happen to work with our particular choice
2987 of NVs. We shouldn't just re-#define signbit as Perl_signbit and expect
2988 the standard system headers to be happy. Also, this is a no-context
2989 function (no pTHX_) because Perl_signbit() is usually re-#defined in
2990 perl.h as a simple macro call to the system's signbit().
2991 Users should just always call Perl_signbit().
2993 NOTE: this function is experimental and may change or be
2994 removed without notice.
2996 int Perl_signbit(NV f)
2999 Found in file numeric.c
3004 For backwards compatibility. Use C<grok_bin> instead.
3006 NV scan_bin(const char* start, STRLEN len, STRLEN* retlen)
3009 Found in file numeric.c
3014 For backwards compatibility. Use C<grok_hex> instead.
3016 NV scan_hex(const char* start, STRLEN len, STRLEN* retlen)
3019 Found in file numeric.c
3024 For backwards compatibility. Use C<grok_oct> instead.
3026 NV scan_oct(const char* start, STRLEN len, STRLEN* retlen)
3029 Found in file numeric.c
3034 =head1 Optree Manipulation Functions
3041 If C<cv> is a constant sub eligible for inlining. returns the constant
3042 value returned by the sub. Otherwise, returns NULL.
3044 Constant subs can be created with C<newCONSTSUB> or as described in
3045 L<perlsub/"Constant Functions">.
3047 SV* cv_const_sv(CV* cv)
3055 Creates a constant sub equivalent to Perl C<sub FOO () { 123 }> which is
3056 eligible for inlining at compile-time.
3058 CV* newCONSTSUB(HV* stash, const char* name, SV* sv)
3066 Used by C<xsubpp> to hook up XSUBs as Perl subs. I<filename> needs to be
3067 static storage, as it is used directly as CvFILE(), without a copy being made.
3075 =head1 Pad Data Structures
3082 Get the value at offset po in the current pad.
3083 Use macro PAD_SV instead of calling this function directly.
3085 SV* pad_sv(PADOFFSET po)
3093 =head1 Per-Interpreter Variables
3100 C<PL_modglobal> is a general purpose, interpreter global HV for use by
3101 extensions that need to keep information on a per-interpreter basis.
3102 In a pinch, it can also be used as a symbol table for extensions
3103 to share data among each other. It is a good idea to use keys
3104 prefixed by the package name of the extension that owns the data.
3109 Found in file intrpvar.h
3114 A convenience variable which is typically used with C<SvPV> when one
3115 doesn't care about the length of the string. It is usually more efficient
3116 to either declare a local variable and use that instead or to use the
3117 C<SvPV_nolen> macro.
3122 Found in file intrpvar.h
3127 This is the C<false> SV. See C<PL_sv_yes>. Always refer to this as
3133 Found in file intrpvar.h
3138 This is the C<undef> SV. Always refer to this as C<&PL_sv_undef>.
3143 Found in file intrpvar.h
3148 This is the C<true> SV. See C<PL_sv_no>. Always refer to this as
3154 Found in file intrpvar.h
3159 =head1 REGEXP Functions
3166 Convenience macro to get the REGEXP from a SV. This is approximately
3167 equivalent to the following snippet:
3172 (tmpsv = (SV*)SvRV(sv)) &&
3173 SvTYPE(tmpsv) == SVt_PVMG &&
3174 (tmpmg = mg_find(tmpsv, PERL_MAGIC_qr)))
3176 return (REGEXP *)tmpmg->mg_obj;
3179 NULL will be returned if a REGEXP* is not found.
3181 REGEXP * SvRX(SV *sv)
3184 Found in file regexp.h
3189 Returns a boolean indicating whether the SV contains qr magic
3192 If you want to do something with the REGEXP* later use SvRX instead
3198 Found in file regexp.h
3203 =head1 Simple Exception Handling Macros
3210 Set up necessary local variables for exception handling.
3211 See L<perlguts/"Exception Handling">.
3216 Found in file XSUB.h
3221 Introduces a catch block. See L<perlguts/"Exception Handling">.
3224 Found in file XSUB.h
3229 Rethrows a previously caught exception. See L<perlguts/"Exception Handling">.
3234 Found in file XSUB.h
3239 Ends a try block. See L<perlguts/"Exception Handling">.
3242 Found in file XSUB.h
3244 =item XCPT_TRY_START
3247 Starts a try block. See L<perlguts/"Exception Handling">.
3250 Found in file XSUB.h
3255 =head1 Stack Manipulation Macros
3262 Declare a stack marker variable, C<mark>, for the XSUB. See C<MARK> and
3273 Saves the original stack mark for the XSUB. See C<ORIGMARK>.
3283 Declares a local copy of perl's stack pointer for the XSUB, available via
3284 the C<SP> macro. See C<SP>.
3294 Used to extend the argument stack for an XSUB's return values. Once
3295 used, guarantees that there is room for at least C<nitems> to be pushed
3298 void EXTEND(SP, int nitems)
3306 Stack marker variable for the XSUB. See C<dMARK>.
3314 Push an integer onto the stack. The stack must have room for this element.
3315 Does not use C<TARG>. See also C<PUSHi>, C<mXPUSHi> and C<XPUSHi>.
3325 Push a double onto the stack. The stack must have room for this element.
3326 Does not use C<TARG>. See also C<PUSHn>, C<mXPUSHn> and C<XPUSHn>.
3336 Push a string onto the stack. The stack must have room for this element.
3337 The C<len> indicates the length of the string. Does not use C<TARG>.
3338 See also C<PUSHp>, C<mXPUSHp> and C<XPUSHp>.
3340 void mPUSHp(char* str, STRLEN len)
3348 Push an SV onto the stack and mortalizes the SV. The stack must have room
3349 for this element. Does not use C<TARG>. See also C<PUSHs> and C<mXPUSHs>.
3359 Push an unsigned integer onto the stack. The stack must have room for this
3360 element. Does not use C<TARG>. See also C<PUSHu>, C<mXPUSHu> and C<XPUSHu>.
3370 Push an integer onto the stack, extending the stack if necessary.
3371 Does not use C<TARG>. See also C<XPUSHi>, C<mPUSHi> and C<PUSHi>.
3381 Push a double onto the stack, extending the stack if necessary.
3382 Does not use C<TARG>. See also C<XPUSHn>, C<mPUSHn> and C<PUSHn>.
3392 Push a string onto the stack, extending the stack if necessary. The C<len>
3393 indicates the length of the string. Does not use C<TARG>. See also C<XPUSHp>,
3394 C<mPUSHp> and C<PUSHp>.
3396 void mXPUSHp(char* str, STRLEN len)
3404 Push an SV onto the stack, extending the stack if necessary and mortalizes
3405 the SV. Does not use C<TARG>. See also C<XPUSHs> and C<mPUSHs>.
3407 void mXPUSHs(SV* sv)
3415 Push an unsigned integer onto the stack, extending the stack if necessary.
3416 Does not use C<TARG>. See also C<XPUSHu>, C<mPUSHu> and C<PUSHu>.
3426 The original stack mark for the XSUB. See C<dORIGMARK>.
3434 Pops an integer off the stack.
3444 Pops a long off the stack.
3454 Pops a double off the stack.
3464 Pops a string off the stack. Deprecated. New code should use POPpx.
3474 Pops a string off the stack which must consist of bytes i.e. characters < 256.
3484 Pops a string off the stack.
3494 Pops an SV off the stack.
3504 Push an integer onto the stack. The stack must have room for this element.
3505 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3506 called to declare it. Do not call multiple C<TARG>-oriented macros to
3507 return lists from XSUB's - see C<mPUSHi> instead. See also C<XPUSHi> and
3518 Opening bracket for arguments on a callback. See C<PUTBACK> and
3529 Push a new mortal SV onto the stack. The stack must have room for this
3530 element. Does not use C<TARG>. See also C<PUSHs>, C<XPUSHmortal> and C<XPUSHs>.
3540 Push a double onto the stack. The stack must have room for this element.
3541 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3542 called to declare it. Do not call multiple C<TARG>-oriented macros to
3543 return lists from XSUB's - see C<mPUSHn> instead. See also C<XPUSHn> and
3554 Push a string onto the stack. The stack must have room for this element.
3555 The C<len> indicates the length of the string. Handles 'set' magic. Uses
3556 C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to declare it. Do not
3557 call multiple C<TARG>-oriented macros to return lists from XSUB's - see
3558 C<mPUSHp> instead. See also C<XPUSHp> and C<mXPUSHp>.
3560 void PUSHp(char* str, STRLEN len)
3568 Push an SV onto the stack. The stack must have room for this element.
3569 Does not handle 'set' magic. Does not use C<TARG>. See also C<PUSHmortal>,
3570 C<XPUSHs> and C<XPUSHmortal>.
3580 Push an unsigned integer onto the stack. The stack must have room for this
3581 element. Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG>
3582 should be called to declare it. Do not call multiple C<TARG>-oriented
3583 macros to return lists from XSUB's - see C<mPUSHu> instead. See also
3584 C<XPUSHu> and C<mXPUSHu>.
3594 Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
3595 See C<PUSHMARK> and L<perlcall> for other uses.
3605 Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and
3614 Refetch the stack pointer. Used after a callback. See L<perlcall>.
3624 Push an integer onto the stack, extending the stack if necessary. Handles
3625 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
3626 declare it. Do not call multiple C<TARG>-oriented macros to return lists
3627 from XSUB's - see C<mXPUSHi> instead. See also C<PUSHi> and C<mPUSHi>.
3637 Push a new mortal SV onto the stack, extending the stack if necessary.
3638 Does not use C<TARG>. See also C<XPUSHs>, C<PUSHmortal> and C<PUSHs>.
3648 Push a double onto the stack, extending the stack if necessary. Handles
3649 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
3650 declare it. Do not call multiple C<TARG>-oriented macros to return lists
3651 from XSUB's - see C<mXPUSHn> instead. See also C<PUSHn> and C<mPUSHn>.
3661 Push a string onto the stack, extending the stack if necessary. The C<len>
3662 indicates the length of the string. Handles 'set' magic. Uses C<TARG>, so
3663 C<dTARGET> or C<dXSTARG> should be called to declare it. Do not call
3664 multiple C<TARG>-oriented macros to return lists from XSUB's - see
3665 C<mXPUSHp> instead. See also C<PUSHp> and C<mPUSHp>.
3667 void XPUSHp(char* str, STRLEN len)
3675 Push an SV onto the stack, extending the stack if necessary. Does not
3676 handle 'set' magic. Does not use C<TARG>. See also C<XPUSHmortal>,
3677 C<PUSHs> and C<PUSHmortal>.
3687 Push an unsigned integer onto the stack, extending the stack if necessary.
3688 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3689 called to declare it. Do not call multiple C<TARG>-oriented macros to
3690 return lists from XSUB's - see C<mXPUSHu> instead. See also C<PUSHu> and
3701 Return from XSUB, indicating number of items on the stack. This is usually
3702 handled by C<xsubpp>.
3704 void XSRETURN(int nitems)
3707 Found in file XSUB.h
3709 =item XSRETURN_EMPTY
3712 Return an empty list from an XSUB immediately.
3717 Found in file XSUB.h
3722 Return an integer from an XSUB immediately. Uses C<XST_mIV>.
3724 void XSRETURN_IV(IV iv)
3727 Found in file XSUB.h
3732 Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
3737 Found in file XSUB.h
3742 Return a double from an XSUB immediately. Uses C<XST_mNV>.
3744 void XSRETURN_NV(NV nv)
3747 Found in file XSUB.h
3752 Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
3754 void XSRETURN_PV(char* str)
3757 Found in file XSUB.h
3759 =item XSRETURN_UNDEF
3762 Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
3767 Found in file XSUB.h
3772 Return an integer from an XSUB immediately. Uses C<XST_mUV>.
3774 void XSRETURN_UV(IV uv)
3777 Found in file XSUB.h
3782 Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
3787 Found in file XSUB.h
3792 Place an integer into the specified position C<pos> on the stack. The
3793 value is stored in a new mortal SV.
3795 void XST_mIV(int pos, IV iv)
3798 Found in file XSUB.h
3803 Place C<&PL_sv_no> into the specified position C<pos> on the
3806 void XST_mNO(int pos)
3809 Found in file XSUB.h
3814 Place a double into the specified position C<pos> on the stack. The value
3815 is stored in a new mortal SV.
3817 void XST_mNV(int pos, NV nv)
3820 Found in file XSUB.h
3825 Place a copy of a string into the specified position C<pos> on the stack.
3826 The value is stored in a new mortal SV.
3828 void XST_mPV(int pos, char* str)
3831 Found in file XSUB.h
3836 Place C<&PL_sv_undef> into the specified position C<pos> on the
3839 void XST_mUNDEF(int pos)
3842 Found in file XSUB.h
3847 Place C<&PL_sv_yes> into the specified position C<pos> on the
3850 void XST_mYES(int pos)
3853 Found in file XSUB.h
3865 An enum of flags for Perl types. These are found in the file B<sv.h>
3866 in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
3874 Integer type flag for scalars. See C<svtype>.
3882 Double type flag for scalars. See C<svtype>.
3890 Pointer type flag for scalars. See C<svtype>.
3898 Type flag for arrays. See C<svtype>.
3906 Type flag for code refs. See C<svtype>.
3914 Type flag for hashes. See C<svtype>.
3922 Type flag for blessed scalars. See C<svtype>.
3930 =head1 SV Manipulation Functions
3937 Returns the SV of the specified Perl scalar. If C<create> is set and the
3938 Perl variable does not exist then it will be created. If C<create> is not
3939 set and the variable does not exist then NULL is returned.
3941 NOTE: the perl_ form of this function is deprecated.
3943 SV* get_sv(const char* name, I32 create)
3946 Found in file perl.c
3951 Creates an RV wrapper for an SV. The reference count for the original SV is
3954 SV* newRV_inc(SV* sv)
3962 Creates a new SV and copies a string into it. If utf8 is true, calls
3963 C<SvUTF8_on> on the new SV. Implemented as a wrapper around C<newSVpvn_flags>.
3965 SV* newSVpvn_utf8(NULLOK const char* s, STRLEN len, U32 utf8)
3973 Returns the length of the string which is in the SV. See C<SvLEN>.
3975 STRLEN SvCUR(SV* sv)
3983 Set the current length of the string which is in the SV. See C<SvCUR>
3986 void SvCUR_set(SV* sv, STRLEN len)
3994 Returns a pointer to the last character in the string which is in the SV.
3995 See C<SvCUR>. Access the character as *(SvEND(sv)).
4005 Returns true if the SV has get magic or overloading. If either is true then
4006 the scalar is active data, and has the potential to return a new value every
4007 time it is accessed. Hence you must be careful to only read it once per user
4008 logical operation and work with that returned value. If neither is true then
4009 the scalar's value cannot change unless written to.
4011 char* SvGAMAGIC(SV* sv)
4019 Expands the character buffer in the SV so that it has room for the
4020 indicated number of bytes (remember to reserve space for an extra trailing
4021 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
4022 Returns a pointer to the character buffer.
4024 char * SvGROW(SV* sv, STRLEN len)
4032 Returns a U32 value indicating whether the SV contains an integer.
4042 Returns a U32 value indicating whether the SV contains an integer. Checks
4043 the B<private> setting. Use C<SvIOK>.
4053 Returns a boolean indicating whether the SV contains a signed integer.
4055 bool SvIOK_notUV(SV* sv)
4063 Unsets the IV status of an SV.
4065 void SvIOK_off(SV* sv)
4073 Tells an SV that it is an integer.
4075 void SvIOK_on(SV* sv)
4083 Tells an SV that it is an integer and disables all other OK bits.
4085 void SvIOK_only(SV* sv)
4093 Tells and SV that it is an unsigned integer and disables all other OK bits.
4095 void SvIOK_only_UV(SV* sv)
4103 Returns a boolean indicating whether the SV contains an unsigned integer.
4105 bool SvIOK_UV(SV* sv)
4113 Returns a boolean indicating whether the SV is Copy-On-Write. (either shared
4114 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
4117 bool SvIsCOW(SV* sv)
4122 =item SvIsCOW_shared_hash
4123 X<SvIsCOW_shared_hash>
4125 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
4128 bool SvIsCOW_shared_hash(SV* sv)
4136 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
4137 version which guarantees to evaluate sv only once.
4147 Returns the raw value in the SV's IV slot, without checks or conversions.
4148 Only use when you are sure SvIOK is true. See also C<SvIV()>.
4158 Coerces the given SV to an integer and returns it. Guarantees to evaluate
4159 C<sv> only once. Only use this if C<sv> is an expression with side effects,
4160 otherwise use the more efficient C<SvIV>.
4170 Like C<SvIV> but doesn't process magic.
4172 IV SvIV_nomg(SV* sv)
4180 Set the value of the IV pointer in sv to val. It is possible to perform
4181 the same function of this macro with an lvalue assignment to C<SvIVX>.
4182 With future Perls, however, it will be more efficient to use
4183 C<SvIV_set> instead of the lvalue assignment to C<SvIVX>.
4185 void SvIV_set(SV* sv, IV val)
4193 Returns the size of the string buffer in the SV, not including any part
4194 attributable to C<SvOOK>. See C<SvCUR>.
4196 STRLEN SvLEN(SV* sv)
4204 Set the actual length of the string which is in the SV. See C<SvIV_set>.
4206 void SvLEN_set(SV* sv, STRLEN len)
4214 Set the value of the MAGIC pointer in sv to val. See C<SvIV_set>.
4216 void SvMAGIC_set(SV* sv, MAGIC* val)
4224 Returns a U32 value indicating whether the SV contains a number, integer or
4235 Returns a U32 value indicating whether the SV contains a number, integer or
4236 double. Checks the B<private> setting. Use C<SvNIOK>.
4246 Unsets the NV/IV status of an SV.
4248 void SvNIOK_off(SV* sv)
4256 Returns a U32 value indicating whether the SV contains a double.
4266 Returns a U32 value indicating whether the SV contains a double. Checks the
4267 B<private> setting. Use C<SvNOK>.
4277 Unsets the NV status of an SV.
4279 void SvNOK_off(SV* sv)
4287 Tells an SV that it is a double.
4289 void SvNOK_on(SV* sv)
4297 Tells an SV that it is a double and disables all other OK bits.
4299 void SvNOK_only(SV* sv)
4307 Coerce the given SV to a double and return it. See C<SvNVx> for a version
4308 which guarantees to evaluate sv only once.
4318 Returns the raw value in the SV's NV slot, without checks or conversions.
4319 Only use when you are sure SvNOK is true. See also C<SvNV()>.
4329 Coerces the given SV to a double and returns it. Guarantees to evaluate
4330 C<sv> only once. Only use this if C<sv> is an expression with side effects,
4331 otherwise use the more efficient C<SvNV>.
4341 Set the value of the NV pointer in sv to val. See C<SvIV_set>.
4343 void SvNV_set(SV* sv, NV val)
4351 Returns a U32 value indicating whether the value is an SV. It also tells
4352 whether the value is defined or not.
4362 Returns a U32 indicating whether the pointer to the string buffer is offset.
4363 This hack is used internally to speed up removal of characters from the
4364 beginning of a SvPV. When SvOOK is true, then the start of the
4365 allocated string buffer is actually C<SvOOK_offset()> bytes before SvPVX.
4366 This offset used to be stored in SvIVX, but is now stored within the spare
4377 Reads into I<len> the offset from SvPVX back to the true start of the
4378 allocated buffer, which will be non-zero if C<sv_chop> has been used to
4379 efficiently remove characters from start of the buffer. Implemented as a
4380 macro, which takes the address of I<len>, which must be of type C<STRLEN>.
4381 Evaluates I<sv> more than once. Sets I<len> to 0 if C<SvOOK(sv)> is false.
4383 void SvOOK_offset(NN SV*sv, STRLEN len)
4391 Returns a U32 value indicating whether the SV contains a character
4402 Returns a U32 value indicating whether the SV contains a character string.
4403 Checks the B<private> setting. Use C<SvPOK>.
4413 Unsets the PV status of an SV.
4415 void SvPOK_off(SV* sv)
4423 Tells an SV that it is a string.
4425 void SvPOK_on(SV* sv)
4433 Tells an SV that it is a string and disables all other OK bits.
4434 Will also turn off the UTF-8 status.
4436 void SvPOK_only(SV* sv)
4441 =item SvPOK_only_UTF8
4444 Tells an SV that it is a string and disables all other OK bits,
4445 and leaves the UTF-8 status as it was.
4447 void SvPOK_only_UTF8(SV* sv)
4455 Returns a pointer to the string in the SV, or a stringified form of
4456 the SV if the SV does not contain a string. The SV may cache the
4457 stringified version becoming C<SvPOK>. Handles 'get' magic. See also
4458 C<SvPVx> for a version which guarantees to evaluate sv only once.
4460 char* SvPV(SV* sv, STRLEN len)
4468 Like C<SvPV>, but converts sv to byte representation first if necessary.
4470 char* SvPVbyte(SV* sv, STRLEN len)
4478 Like C<SvPV>, but converts sv to byte representation first if necessary.
4479 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
4482 char* SvPVbytex(SV* sv, STRLEN len)
4487 =item SvPVbytex_force
4490 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
4491 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
4494 char* SvPVbytex_force(SV* sv, STRLEN len)
4499 =item SvPVbyte_force
4502 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
4504 char* SvPVbyte_force(SV* sv, STRLEN len)
4509 =item SvPVbyte_nolen
4512 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
4514 char* SvPVbyte_nolen(SV* sv)
4522 Like C<SvPV>, but converts sv to utf8 first if necessary.
4524 char* SvPVutf8(SV* sv, STRLEN len)
4532 Like C<SvPV>, but converts sv to utf8 first if necessary.
4533 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
4536 char* SvPVutf8x(SV* sv, STRLEN len)
4541 =item SvPVutf8x_force
4544 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
4545 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
4548 char* SvPVutf8x_force(SV* sv, STRLEN len)
4553 =item SvPVutf8_force
4556 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
4558 char* SvPVutf8_force(SV* sv, STRLEN len)
4563 =item SvPVutf8_nolen
4566 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
4568 char* SvPVutf8_nolen(SV* sv)
4576 Returns a pointer to the physical string in the SV. The SV must contain a
4587 A version of C<SvPV> which guarantees to evaluate C<sv> only once.
4588 Only use this if C<sv> is an expression with side effects, otherwise use the
4589 more efficient C<SvPVX>.
4591 char* SvPVx(SV* sv, STRLEN len)
4599 Like C<SvPV> but will force the SV into containing just a string
4600 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
4603 char* SvPV_force(SV* sv, STRLEN len)
4608 =item SvPV_force_nomg
4611 Like C<SvPV> but will force the SV into containing just a string
4612 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
4613 directly. Doesn't process magic.
4615 char* SvPV_force_nomg(SV* sv, STRLEN len)
4623 Returns a pointer to the string in the SV, or a stringified form of
4624 the SV if the SV does not contain a string. The SV may cache the
4625 stringified form becoming C<SvPOK>. Handles 'get' magic.
4627 char* SvPV_nolen(SV* sv)
4635 Like C<SvPV> but doesn't process magic.
4637 char* SvPV_nomg(SV* sv, STRLEN len)
4645 Set the value of the PV pointer in sv to val. See C<SvIV_set>.
4647 void SvPV_set(SV* sv, char* val)
4655 Returns the value of the object's reference count.
4657 U32 SvREFCNT(SV* sv)
4665 Decrements the reference count of the given SV.
4667 void SvREFCNT_dec(SV* sv)
4675 Increments the reference count of the given SV.
4677 All of the following SvREFCNT_inc* macros are optimized versions of
4678 SvREFCNT_inc, and can be replaced with SvREFCNT_inc.
4680 SV* SvREFCNT_inc(SV* sv)
4685 =item SvREFCNT_inc_NN
4688 Same as SvREFCNT_inc, but can only be used if you know I<sv>
4689 is not NULL. Since we don't have to check the NULLness, it's faster
4692 SV* SvREFCNT_inc_NN(SV* sv)
4697 =item SvREFCNT_inc_simple
4698 X<SvREFCNT_inc_simple>
4700 Same as SvREFCNT_inc, but can only be used with expressions without side
4701 effects. Since we don't have to store a temporary value, it's faster.
4703 SV* SvREFCNT_inc_simple(SV* sv)
4708 =item SvREFCNT_inc_simple_NN
4709 X<SvREFCNT_inc_simple_NN>
4711 Same as SvREFCNT_inc_simple, but can only be used if you know I<sv>
4712 is not NULL. Since we don't have to check the NULLness, it's faster
4715 SV* SvREFCNT_inc_simple_NN(SV* sv)
4720 =item SvREFCNT_inc_simple_void
4721 X<SvREFCNT_inc_simple_void>
4723 Same as SvREFCNT_inc_simple, but can only be used if you don't need the
4724 return value. The macro doesn't need to return a meaningful value.
4726 void SvREFCNT_inc_simple_void(SV* sv)
4731 =item SvREFCNT_inc_simple_void_NN
4732 X<SvREFCNT_inc_simple_void_NN>
4734 Same as SvREFCNT_inc, but can only be used if you don't need the return
4735 value, and you know that I<sv> is not NULL. The macro doesn't need
4736 to return a meaningful value, or check for NULLness, so it's smaller
4739 void SvREFCNT_inc_simple_void_NN(SV* sv)
4744 =item SvREFCNT_inc_void
4745 X<SvREFCNT_inc_void>
4747 Same as SvREFCNT_inc, but can only be used if you don't need the
4748 return value. The macro doesn't need to return a meaningful value.
4750 void SvREFCNT_inc_void(SV* sv)
4755 =item SvREFCNT_inc_void_NN
4756 X<SvREFCNT_inc_void_NN>
4758 Same as SvREFCNT_inc, but can only be used if you don't need the return
4759 value, and you know that I<sv> is not NULL. The macro doesn't need
4760 to return a meaningful value, or check for NULLness, so it's smaller
4763 void SvREFCNT_inc_void_NN(SV* sv)
4771 Tests if the SV is an RV.
4781 Unsets the RV status of an SV.
4783 void SvROK_off(SV* sv)
4791 Tells an SV that it is an RV.
4793 void SvROK_on(SV* sv)
4801 Dereferences an RV to return the SV.
4811 Set the value of the RV pointer in sv to val. See C<SvIV_set>.
4813 void SvRV_set(SV* sv, SV* val)
4821 Returns the stash of the SV.
4831 Set the value of the STASH pointer in sv to val. See C<SvIV_set>.
4833 void SvSTASH_set(SV* sv, HV* val)
4841 Taints an SV if tainting is enabled.
4843 void SvTAINT(SV* sv)
4851 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
4854 bool SvTAINTED(SV* sv)
4862 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
4863 some of Perl's fundamental security features. XS module authors should not
4864 use this function unless they fully understand all the implications of
4865 unconditionally untainting the value. Untainting should be done in the
4866 standard perl fashion, via a carefully crafted regexp, rather than directly
4867 untainting variables.
4869 void SvTAINTED_off(SV* sv)
4877 Marks an SV as tainted if tainting is enabled.
4879 void SvTAINTED_on(SV* sv)
4887 Returns a boolean indicating whether Perl would evaluate the SV as true or
4888 false, defined or undefined. Does not handle 'get' magic.
4898 Returns the type of the SV. See C<svtype>.
4900 svtype SvTYPE(SV* sv)
4908 Returns a boolean indicating whether the SV contains an unsigned integer.
4918 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
4919 perform the upgrade if necessary. See C<svtype>.
4921 void SvUPGRADE(SV* sv, svtype type)
4929 Returns a U32 value indicating whether the SV contains UTF-8 encoded data.
4930 Call this after SvPV() in case any call to string overloading updates the
4941 Unsets the UTF-8 status of an SV.
4943 void SvUTF8_off(SV *sv)
4951 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
4952 Do not use frivolously.
4954 void SvUTF8_on(SV *sv)
4962 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
4963 for a version which guarantees to evaluate sv only once.
4973 Returns the raw value in the SV's UV slot, without checks or conversions.
4974 Only use when you are sure SvIOK is true. See also C<SvUV()>.
4984 Coerces the given SV to an unsigned integer and returns it. Guarantees to
4985 C<sv> only once. Only use this if C<sv> is an expression with side effects,
4986 otherwise use the more efficient C<SvUV>.
4996 Like C<SvUV> but doesn't process magic.
4998 UV SvUV_nomg(SV* sv)
5006 Set the value of the UV pointer in sv to val. See C<SvIV_set>.
5008 void SvUV_set(SV* sv, UV val)
5016 Returns a boolean indicating whether the SV contains a v-string.
5023 =item sv_catpvn_nomg
5026 Like C<sv_catpvn> but doesn't process magic.
5028 void sv_catpvn_nomg(SV* sv, const char* ptr, STRLEN len)
5036 Like C<sv_catsv> but doesn't process magic.
5038 void sv_catsv_nomg(SV* dsv, SV* ssv)
5043 =item sv_derived_from
5046 Returns a boolean indicating whether the SV is derived from the specified class
5047 I<at the C level>. To check derivation at the Perl level, call C<isa()> as a
5050 bool sv_derived_from(SV* sv, const char *const name)
5053 Found in file universal.c
5058 Returns a boolean indicating whether the SV performs a specific, named role.
5059 The SV can be a Perl object or the name of a Perl class.
5061 bool sv_does(SV* sv, const char *const name)
5064 Found in file universal.c
5066 =item sv_report_used
5069 Dump the contents of all SVs not yet freed. (Debugging aid).
5071 void sv_report_used()
5079 Like C<sv_setsv> but doesn't process magic.
5081 void sv_setsv_nomg(SV* dsv, SV* ssv)
5089 =head1 SV-Body Allocation
5093 =item looks_like_number
5094 X<looks_like_number>
5096 Test if the content of an SV looks like a number (or is a number).
5097 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
5098 non-numeric warning), even if your atof() doesn't grok them.
5100 I32 looks_like_number(SV *const sv)
5108 Creates an RV wrapper for an SV. The reference count for the original
5109 SV is B<not> incremented.
5111 SV* newRV_noinc(SV* sv)
5119 Creates a new SV. A non-zero C<len> parameter indicates the number of
5120 bytes of preallocated string space the SV should have. An extra byte for a
5121 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
5122 space is allocated.) The reference count for the new SV is set to 1.
5124 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
5125 parameter, I<x>, a debug aid which allowed callers to identify themselves.
5126 This aid has been superseded by a new build option, PERL_MEM_LOG (see
5127 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
5128 modules supporting older perls.
5130 SV* newSV(STRLEN len)
5138 Creates a new SV from the hash key structure. It will generate scalars that
5139 point to the shared string table where possible. Returns a new (undefined)
5140 SV if the hek is NULL.
5142 SV* newSVhek(const HEK *hek)
5150 Creates a new SV and copies an integer into it. The reference count for the
5161 Creates a new SV and copies a floating point value into it.
5162 The reference count for the SV is set to 1.
5172 Creates a new SV and copies a string into it. The reference count for the
5173 SV is set to 1. If C<len> is zero, Perl will compute the length using
5174 strlen(). For efficiency, consider using C<newSVpvn> instead.
5176 SV* newSVpv(const char* s, STRLEN len)
5184 Creates a new SV and initializes it with the string formatted like
5187 SV* newSVpvf(const char* pat, ...)
5195 Creates a new SV and copies a string into it. The reference count for the
5196 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
5197 string. You are responsible for ensuring that the source string is at least
5198 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
5200 SV* newSVpvn(const char* s, STRLEN len)
5205 =item newSVpvn_flags
5208 Creates a new SV and copies a string into it. The reference count for the
5209 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
5210 string. You are responsible for ensuring that the source string is at least
5211 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
5212 Currently the only flag bits accepted are C<SVf_UTF8> and C<SVs_TEMP>.
5213 If C<SVs_TEMP> is set, then C<sv2mortal()> is called on the result before
5214 returning. If C<SVf_UTF8> is set, then it will be set on the new SV.
5215 C<newSVpvn_utf8()> is a convenience wrapper for this function, defined as
5217 #define newSVpvn_utf8(s, len, u) \
5218 newSVpvn_flags((s), (len), (u) ? SVf_UTF8 : 0)
5220 SV* newSVpvn_flags(const char* s, STRLEN len, U32 flags)
5225 =item newSVpvn_share
5228 Creates a new SV with its SvPVX_const pointing to a shared string in the string
5229 table. If the string does not already exist in the table, it is created
5230 first. Turns on READONLY and FAKE. If the C<hash> parameter is non-zero, that
5231 value is used; otherwise the hash is computed. The string's hash can be later
5232 be retrieved from the SV with the C<SvSHARED_HASH()> macro. The idea here is
5233 that as the string table is used for shared hash keys these strings will have
5234 SvPVX_const == HeKEY and hash lookup will avoid string compare.
5236 SV* newSVpvn_share(const char* s, I32 len, U32 hash)
5244 Like C<newSVpvn>, but takes a literal string instead of a string/length pair.
5246 SV* newSVpvs(const char* s)
5249 Found in file handy.h
5251 =item newSVpvs_flags
5254 Like C<newSVpvn_flags>, but takes a literal string instead of a string/length
5257 SV* newSVpvs_flags(const char* s, U32 flags)
5260 Found in file handy.h
5262 =item newSVpvs_share
5265 Like C<newSVpvn_share>, but takes a literal string instead of a string/length
5266 pair and omits the hash parameter.
5268 SV* newSVpvs_share(const char* s)
5271 Found in file handy.h
5276 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
5277 it will be upgraded to one. If C<classname> is non-null then the new SV will
5278 be blessed in the specified package. The new SV is returned and its
5279 reference count is 1.
5281 SV* newSVrv(SV* rv, const char* classname)
5289 Creates a new SV which is an exact duplicate of the original SV.
5292 SV* newSVsv(SV* old)
5300 Creates a new SV and copies an unsigned integer into it.
5301 The reference count for the SV is set to 1.
5311 Creates a new SV, of the type specified. The reference count for the new SV
5314 SV* newSV_type(svtype type)
5322 This function is only called on magical items, and is only used by
5323 sv_true() or its macro equivalent.
5325 bool sv_2bool(SV* sv)
5333 Using various gambits, try to get a CV from an SV; in addition, try if
5334 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
5335 The flags in C<lref> are passed to sv_fetchsv.
5337 CV* sv_2cv(SV* sv, HV** st, GV** gvp, I32 lref)
5345 Using various gambits, try to get an IO from an SV: the IO slot if its a
5346 GV; or the recursive result if we're an RV; or the IO slot of the symbol
5347 named after the PV if we're a string.
5357 Return the integer value of an SV, doing any necessary string
5358 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
5359 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
5361 IV sv_2iv_flags(SV* sv, I32 flags)
5369 Marks an existing SV as mortal. The SV will be destroyed "soon", either
5370 by an explicit call to FREETMPS, or by an implicit call at places such as
5371 statement boundaries. SvTEMP() is turned on which means that the SV's
5372 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
5373 and C<sv_mortalcopy>.
5375 SV* sv_2mortal(SV* sv)
5383 Return the num value of an SV, doing any necessary string or integer
5384 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
5395 Return a pointer to the byte-encoded representation of the SV, and set *lp
5396 to its length. May cause the SV to be downgraded from UTF-8 as a
5399 Usually accessed via the C<SvPVbyte> macro.
5401 char* sv_2pvbyte(SV* sv, STRLEN* lp)
5409 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
5410 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
5412 Usually accessed via the C<SvPVutf8> macro.
5414 char* sv_2pvutf8(SV* sv, STRLEN* lp)
5422 Returns a pointer to the string value of an SV, and sets *lp to its length.
5423 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
5425 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
5426 usually end up here too.
5428 char* sv_2pv_flags(SV* sv, STRLEN* lp, I32 flags)
5436 Return the unsigned integer value of an SV, doing any necessary string
5437 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
5438 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
5440 UV sv_2uv_flags(SV* sv, I32 flags)
5448 Remove any string offset. You should normally use the C<SvOOK_off> macro
5451 int sv_backoff(SV *const sv)
5459 Blesses an SV into a specified package. The SV must be an RV. The package
5460 must be designated by its stash (see C<gv_stashpv()>). The reference count
5461 of the SV is unaffected.
5463 SV* sv_bless(SV* sv, HV* stash)
5471 Concatenates the string onto the end of the string which is in the SV.
5472 If the SV has the UTF-8 status set, then the bytes appended should be
5473 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
5475 void sv_catpv(SV* sv, const char* ptr)
5483 Processes its arguments like C<sprintf> and appends the formatted
5484 output to an SV. If the appended data contains "wide" characters
5485 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
5486 and characters >255 formatted with %c), the original SV might get
5487 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
5488 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
5489 valid UTF-8; if the original SV was bytes, the pattern should be too.
5491 void sv_catpvf(SV* sv, const char* pat, ...)
5499 Like C<sv_catpvf>, but also handles 'set' magic.
5501 void sv_catpvf_mg(SV *sv, const char* pat, ...)
5509 Concatenates the string onto the end of the string which is in the SV. The
5510 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5511 status set, then the bytes appended should be valid UTF-8.
5512 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
5514 void sv_catpvn(SV* sv, const char* ptr, STRLEN len)
5519 =item sv_catpvn_flags
5522 Concatenates the string onto the end of the string which is in the SV. The
5523 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5524 status set, then the bytes appended should be valid UTF-8.
5525 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
5526 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
5527 in terms of this function.
5529 void sv_catpvn_flags(SV* sv, const char* ptr, STRLEN len, I32 flags)
5537 Like C<sv_catpvn>, but takes a literal string instead of a string/length pair.
5539 void sv_catpvs(SV* sv, const char* s)
5542 Found in file handy.h
5547 Like C<sv_catpv>, but also handles 'set' magic.
5549 void sv_catpv_mg(SV *sv, const char *ptr)
5557 Concatenates the string from SV C<ssv> onto the end of the string in
5558 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
5559 not 'set' magic. See C<sv_catsv_mg>.
5561 void sv_catsv(SV* dsv, SV* ssv)
5566 =item sv_catsv_flags
5569 Concatenates the string from SV C<ssv> onto the end of the string in
5570 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
5571 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
5572 and C<sv_catsv_nomg> are implemented in terms of this function.
5574 void sv_catsv_flags(SV* dsv, SV* ssv, I32 flags)
5582 Efficient removal of characters from the beginning of the string buffer.
5583 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
5584 the string buffer. The C<ptr> becomes the first character of the adjusted
5585 string. Uses the "OOK hack".
5586 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
5587 refer to the same chunk of data.
5589 void sv_chop(SV* sv, const char* ptr)
5597 Clear an SV: call any destructors, free up any memory used by the body,
5598 and free the body itself. The SV's head is I<not> freed, although
5599 its type is set to all 1's so that it won't inadvertently be assumed
5600 to be live during global destruction etc.
5601 This function should only be called when REFCNT is zero. Most of the time
5602 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5605 void sv_clear(SV* sv)
5613 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5614 string in C<sv1> is less than, equal to, or greater than the string in
5615 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5616 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
5618 I32 sv_cmp(SV* sv1, SV* sv2)
5626 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
5627 'use bytes' aware, handles get magic, and will coerce its args to strings
5628 if necessary. See also C<sv_cmp>.
5630 I32 sv_cmp_locale(SV* sv1, SV* sv2)
5638 Add Collate Transform magic to an SV if it doesn't already have it.
5640 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
5641 scalar data of the variable, but transformed to such a format that a normal
5642 memory comparison can be used to compare the data according to the locale
5645 char* sv_collxfrm(SV* sv, STRLEN* nxp)
5653 Copies a stringified representation of the source SV into the
5654 destination SV. Automatically performs any necessary mg_get and
5655 coercion of numeric values into strings. Guaranteed to preserve
5656 UTF8 flag even from overloaded objects. Similar in nature to
5657 sv_2pv[_flags] but operates directly on an SV instead of just the
5658 string. Mostly uses sv_2pv_flags to do its work, except when that
5659 would lose the UTF-8'ness of the PV.
5661 void sv_copypv(SV* dsv, SV* ssv)
5669 Auto-decrement of the value in the SV, doing string to numeric conversion
5670 if necessary. Handles 'get' magic.
5680 Returns a boolean indicating whether the strings in the two SVs are
5681 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5682 coerce its args to strings if necessary.
5684 I32 sv_eq(SV* sv1, SV* sv2)
5689 =item sv_force_normal_flags
5690 X<sv_force_normal_flags>
5692 Undo various types of fakery on an SV: if the PV is a shared string, make
5693 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
5694 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
5695 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
5696 then a copy-on-write scalar drops its PV buffer (if any) and becomes
5697 SvPOK_off rather than making a copy. (Used where this scalar is about to be
5698 set to some other value.) In addition, the C<flags> parameter gets passed to
5699 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
5700 with flags set to 0.
5702 void sv_force_normal_flags(SV *sv, U32 flags)
5710 Decrement an SV's reference count, and if it drops to zero, call
5711 C<sv_clear> to invoke destructors and free up any memory used by
5712 the body; finally, deallocate the SV's head itself.
5713 Normally called via a wrapper macro C<SvREFCNT_dec>.
5715 void sv_free(SV* sv)
5723 Get a line from the filehandle and store it into the SV, optionally
5724 appending to the currently-stored string.
5726 char* sv_gets(SV* sv, PerlIO* fp, I32 append)
5734 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
5735 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
5736 Use the C<SvGROW> wrapper instead.
5738 char* sv_grow(SV *const sv, STRLEN newlen)
5746 Auto-increment of the value in the SV, doing string to numeric conversion
5747 if necessary. Handles 'get' magic.
5757 Inserts a string at the specified offset/length within the SV. Similar to
5758 the Perl substr() function.
5760 void sv_insert(SV* bigsv, STRLEN offset, STRLEN len, const char* little, STRLEN littlelen)
5768 Returns a boolean indicating whether the SV is blessed into the specified
5769 class. This does not check for subtypes; use C<sv_derived_from> to verify
5770 an inheritance relationship.
5772 int sv_isa(SV* sv, const char* name)
5780 Returns a boolean indicating whether the SV is an RV pointing to a blessed
5781 object. If the SV is not an RV, or if the object is not blessed, then this
5784 int sv_isobject(SV* sv)
5792 Returns the length of the string in the SV. Handles magic and type
5793 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5795 STRLEN sv_len(SV* sv)
5803 Returns the number of characters in the string in an SV, counting wide
5804 UTF-8 bytes as a single character. Handles magic and type coercion.
5806 STRLEN sv_len_utf8(SV* sv)
5814 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
5815 then adds a new magic item of type C<how> to the head of the magic list.
5817 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
5818 handling of the C<name> and C<namlen> arguments.
5820 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
5821 to add more than one instance of the same 'how'.
5823 void sv_magic(SV* sv, SV* obj, int how, const char* name, I32 namlen)
5831 Adds magic to an SV, upgrading it if necessary. Applies the
5832 supplied vtable and returns a pointer to the magic added.
5834 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
5835 In particular, you can add magic to SvREADONLY SVs, and add more than
5836 one instance of the same 'how'.
5838 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
5839 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
5840 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
5841 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
5843 (This is now used as a subroutine by C<sv_magic>.)
5845 MAGIC * sv_magicext(SV* sv, SV* obj, int how, const MGVTBL *vtbl, const char* name, I32 namlen)
5853 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
5854 The new SV is marked as mortal. It will be destroyed "soon", either by an
5855 explicit call to FREETMPS, or by an implicit call at places such as
5856 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
5858 SV* sv_mortalcopy(SV* oldsv)
5866 Creates a new null SV which is mortal. The reference count of the SV is
5867 set to 1. It will be destroyed "soon", either by an explicit call to
5868 FREETMPS, or by an implicit call at places such as statement boundaries.
5869 See also C<sv_mortalcopy> and C<sv_2mortal>.
5879 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5882 SV* sv_newref(SV* sv)
5890 Converts the value pointed to by offsetp from a count of bytes from the
5891 start of the string, to a count of the equivalent number of UTF-8 chars.
5892 Handles magic and type coercion.
5894 void sv_pos_b2u(SV* sv, I32* offsetp)
5902 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5903 the start of the string, to a count of the equivalent number of bytes; if
5904 lenp is non-zero, it does the same to lenp, but this time starting from
5905 the offset, rather than from the start of the string. Handles magic and
5908 void sv_pos_u2b(SV* sv, I32* offsetp, I32* lenp)
5913 =item sv_pvbyten_force
5916 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
5918 char* sv_pvbyten_force(SV* sv, STRLEN* lp)
5926 Get a sensible string out of the SV somehow.
5927 A private implementation of the C<SvPV_force> macro for compilers which
5928 can't cope with complex macro expressions. Always use the macro instead.
5930 char* sv_pvn_force(SV* sv, STRLEN* lp)
5935 =item sv_pvn_force_flags
5936 X<sv_pvn_force_flags>
5938 Get a sensible string out of the SV somehow.
5939 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
5940 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
5941 implemented in terms of this function.
5942 You normally want to use the various wrapper macros instead: see
5943 C<SvPV_force> and C<SvPV_force_nomg>
5945 char* sv_pvn_force_flags(SV* sv, STRLEN* lp, I32 flags)
5950 =item sv_pvutf8n_force
5953 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
5955 char* sv_pvutf8n_force(SV* sv, STRLEN* lp)
5963 Returns a string describing what the SV is a reference to.
5965 const char* sv_reftype(const SV* sv, int ob)
5973 Make the first argument a copy of the second, then delete the original.
5974 The target SV physically takes over ownership of the body of the source SV
5975 and inherits its flags; however, the target keeps any magic it owns,
5976 and any magic in the source is discarded.
5977 Note that this is a rather specialist SV copying operation; most of the
5978 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5980 void sv_replace(SV* sv, SV* nsv)
5988 Underlying implementation for the C<reset> Perl function.
5989 Note that the perl-level function is vaguely deprecated.
5991 void sv_reset(const char* s, HV* stash)
5999 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
6000 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
6001 push a back-reference to this RV onto the array of backreferences
6002 associated with that magic. If the RV is magical, set magic will be
6003 called after the RV is cleared.
6005 SV* sv_rvweaken(SV *sv)
6013 Copies an integer into the given SV, upgrading first if necessary.
6014 Does not handle 'set' magic. See also C<sv_setiv_mg>.
6016 void sv_setiv(SV *const sv, const IV num)
6024 Like C<sv_setiv>, but also handles 'set' magic.
6026 void sv_setiv_mg(SV *const sv, const IV i)
6034 Copies a double into the given SV, upgrading first if necessary.
6035 Does not handle 'set' magic. See also C<sv_setnv_mg>.
6037 void sv_setnv(SV *const sv, const NV num)
6045 Like C<sv_setnv>, but also handles 'set' magic.
6047 void sv_setnv_mg(SV *const sv, const NV num)
6055 Copies a string into an SV. The string must be null-terminated. Does not
6056 handle 'set' magic. See C<sv_setpv_mg>.
6058 void sv_setpv(SV* sv, const char* ptr)
6066 Works like C<sv_catpvf> but copies the text into the SV instead of
6067 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
6069 void sv_setpvf(SV* sv, const char* pat, ...)
6077 Like C<sv_setpvf>, but also handles 'set' magic.
6079 void sv_setpvf_mg(SV *sv, const char* pat, ...)
6087 Copies an integer into the given SV, also updating its string value.
6088 Does not handle 'set' magic. See C<sv_setpviv_mg>.
6090 void sv_setpviv(SV* sv, IV num)
6098 Like C<sv_setpviv>, but also handles 'set' magic.
6100 void sv_setpviv_mg(SV *sv, IV iv)
6108 Copies a string into an SV. The C<len> parameter indicates the number of
6109 bytes to be copied. If the C<ptr> argument is NULL the SV will become
6110 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
6112 void sv_setpvn(SV* sv, const char* ptr, STRLEN len)
6120 Like C<sv_setpvn>, but also handles 'set' magic.
6122 void sv_setpvn_mg(SV *sv, const char *ptr, STRLEN len)
6130 Like C<sv_setpvn>, but takes a literal string instead of a string/length pair.
6132 void sv_setpvs(SV* sv, const char* s)
6135 Found in file handy.h
6140 Like C<sv_setpv>, but also handles 'set' magic.
6142 void sv_setpv_mg(SV *sv, const char *ptr)
6150 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
6151 argument will be upgraded to an RV. That RV will be modified to point to
6152 the new SV. The C<classname> argument indicates the package for the
6153 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
6154 will have a reference count of 1, and the RV will be returned.
6156 SV* sv_setref_iv(SV* rv, const char* classname, IV iv)
6164 Copies a double into a new SV, optionally blessing the SV. The C<rv>
6165 argument will be upgraded to an RV. That RV will be modified to point to
6166 the new SV. The C<classname> argument indicates the package for the
6167 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
6168 will have a reference count of 1, and the RV will be returned.
6170 SV* sv_setref_nv(SV* rv, const char* classname, NV nv)
6178 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
6179 argument will be upgraded to an RV. That RV will be modified to point to
6180 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
6181 into the SV. The C<classname> argument indicates the package for the
6182 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
6183 will have a reference count of 1, and the RV will be returned.
6185 Do not use with other Perl types such as HV, AV, SV, CV, because those
6186 objects will become corrupted by the pointer copy process.
6188 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
6190 SV* sv_setref_pv(SV* rv, const char* classname, void* pv)
6198 Copies a string into a new SV, optionally blessing the SV. The length of the
6199 string must be specified with C<n>. The C<rv> argument will be upgraded to
6200 an RV. That RV will be modified to point to the new SV. The C<classname>
6201 argument indicates the package for the blessing. Set C<classname> to
6202 C<NULL> to avoid the blessing. The new SV will have a reference count
6203 of 1, and the RV will be returned.
6205 Note that C<sv_setref_pv> copies the pointer while this copies the string.
6207 SV* sv_setref_pvn(SV* rv, const char* classname, const char* pv, STRLEN n)
6215 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
6216 argument will be upgraded to an RV. That RV will be modified to point to
6217 the new SV. The C<classname> argument indicates the package for the
6218 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
6219 will have a reference count of 1, and the RV will be returned.
6221 SV* sv_setref_uv(SV* rv, const char* classname, UV uv)
6229 Copies the contents of the source SV C<ssv> into the destination SV
6230 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
6231 function if the source SV needs to be reused. Does not handle 'set' magic.
6232 Loosely speaking, it performs a copy-by-value, obliterating any previous
6233 content of the destination.
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 void sv_setsv(SV* dsv, SV* ssv)
6244 =item sv_setsv_flags
6247 Copies the contents of the source SV C<ssv> into the destination SV
6248 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
6249 function if the source SV needs to be reused. Does not handle 'set' magic.
6250 Loosely speaking, it performs a copy-by-value, obliterating any previous
6251 content of the destination.
6252 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
6253 C<ssv> if appropriate, else not. If the C<flags> parameter has the
6254 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
6255 and C<sv_setsv_nomg> are implemented in terms of this function.
6257 You probably want to use one of the assortment of wrappers, such as
6258 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
6259 C<SvSetMagicSV_nosteal>.
6261 This is the primary function for copying scalars, and most other
6262 copy-ish functions and macros use this underneath.
6264 void sv_setsv_flags(SV* dsv, SV* ssv, I32 flags)
6272 Like C<sv_setsv>, but also handles 'set' magic.
6274 void sv_setsv_mg(SV *dstr, SV *sstr)
6282 Copies an unsigned integer into the given SV, upgrading first if necessary.
6283 Does not handle 'set' magic. See also C<sv_setuv_mg>.
6285 void sv_setuv(SV *const sv, const UV num)
6293 Like C<sv_setuv>, but also handles 'set' magic.
6295 void sv_setuv_mg(SV *const sv, const UV u)
6303 Test an SV for taintedness. Use C<SvTAINTED> instead.
6304 bool sv_tainted(SV* sv)
6312 Returns true if the SV has a true value by Perl's rules.
6313 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
6314 instead use an in-line version.
6324 Removes all magic of type C<type> from an SV.
6326 int sv_unmagic(SV* sv, int type)
6331 =item sv_unref_flags
6334 Unsets the RV status of the SV, and decrements the reference count of
6335 whatever was being referenced by the RV. This can almost be thought of
6336 as a reversal of C<newSVrv>. The C<cflags> argument can contain
6337 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
6338 (otherwise the decrementing is conditional on the reference count being
6339 different from one or the reference being a readonly SV).
6342 void sv_unref_flags(SV* sv, U32 flags)
6350 Untaint an SV. Use C<SvTAINTED_off> instead.
6351 void sv_untaint(SV* sv)
6359 Upgrade an SV to a more complex form. Generally adds a new body type to the
6360 SV, then copies across as much information as possible from the old body.
6361 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
6363 void sv_upgrade(SV *const sv, svtype new_type)
6368 =item sv_usepvn_flags
6371 Tells an SV to use C<ptr> to find its string value. Normally the
6372 string is stored inside the SV but sv_usepvn allows the SV to use an
6373 outside string. The C<ptr> should point to memory that was allocated
6374 by C<malloc>. The string length, C<len>, must be supplied. By default
6375 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
6376 so that pointer should not be freed or used by the programmer after
6377 giving it to sv_usepvn, and neither should any pointers from "behind"
6378 that pointer (e.g. ptr + 1) be used.
6380 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
6381 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
6382 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
6383 C<len>, and already meets the requirements for storing in C<SvPVX>)
6385 void sv_usepvn_flags(SV* sv, char* ptr, STRLEN len, U32 flags)
6390 =item sv_utf8_decode
6393 If the PV of the SV is an octet sequence in UTF-8
6394 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
6395 so that it looks like a character. If the PV contains only single-byte
6396 characters, the C<SvUTF8> flag stays being off.
6397 Scans PV for validity and returns false if the PV is invalid UTF-8.
6399 NOTE: this function is experimental and may change or be
6400 removed without notice.
6402 bool sv_utf8_decode(SV *sv)
6407 =item sv_utf8_downgrade
6408 X<sv_utf8_downgrade>
6410 Attempts to convert the PV of an SV from characters to bytes.
6411 If the PV contains a character beyond byte, this conversion will fail;
6412 in this case, either returns false or, if C<fail_ok> is not
6415 This is not as a general purpose Unicode to byte encoding interface:
6416 use the Encode extension for that.
6418 NOTE: this function is experimental and may change or be
6419 removed without notice.
6421 bool sv_utf8_downgrade(SV *sv, bool fail_ok)
6426 =item sv_utf8_encode
6429 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
6430 flag off so that it looks like octets again.
6432 void sv_utf8_encode(SV *sv)
6437 =item sv_utf8_upgrade
6440 Converts the PV of an SV to its UTF-8-encoded form.
6441 Forces the SV to string form if it is not already.
6442 Always sets the SvUTF8 flag to avoid future validity checks even
6443 if all the bytes have hibit clear.
6445 This is not as a general purpose byte encoding to Unicode interface:
6446 use the Encode extension for that.
6448 STRLEN sv_utf8_upgrade(SV *sv)
6453 =item sv_utf8_upgrade_flags
6454 X<sv_utf8_upgrade_flags>
6456 Converts the PV of an SV to its UTF-8-encoded form.
6457 Forces the SV to string form if it is not already.
6458 Always sets the SvUTF8 flag to avoid future validity checks even
6459 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
6460 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
6461 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
6463 This is not as a general purpose byte encoding to Unicode interface:
6464 use the Encode extension for that.
6466 STRLEN sv_utf8_upgrade_flags(SV *sv, I32 flags)
6474 Processes its arguments like C<vsprintf> and appends the formatted output
6475 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
6477 Usually used via its frontend C<sv_catpvf>.
6479 void sv_vcatpvf(SV* sv, const char* pat, va_list* args)
6487 Processes its arguments like C<vsprintf> and appends the formatted output
6488 to an SV. Uses an array of SVs if the C style variable argument list is
6489 missing (NULL). When running with taint checks enabled, indicates via
6490 C<maybe_tainted> if results are untrustworthy (often due to the use of
6493 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
6495 void sv_vcatpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
6503 Like C<sv_vcatpvf>, but also handles 'set' magic.
6505 Usually used via its frontend C<sv_catpvf_mg>.
6507 void sv_vcatpvf_mg(SV* sv, const char* pat, va_list* args)
6515 Works like C<sv_vcatpvf> but copies the text into the SV instead of
6516 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
6518 Usually used via its frontend C<sv_setpvf>.
6520 void sv_vsetpvf(SV* sv, const char* pat, va_list* args)
6528 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
6531 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
6533 void sv_vsetpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
6541 Like C<sv_vsetpvf>, but also handles 'set' magic.
6543 Usually used via its frontend C<sv_setpvf_mg>.
6545 void sv_vsetpvf_mg(SV* sv, const char* pat, va_list* args)
6553 =head1 Unicode Support
6557 =item bytes_from_utf8
6560 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
6561 Unlike C<utf8_to_bytes> but like C<bytes_to_utf8>, returns a pointer to
6562 the newly-created string, and updates C<len> to contain the new
6563 length. Returns the original string if no conversion occurs, C<len>
6564 is unchanged. Do nothing if C<is_utf8> points to 0. Sets C<is_utf8> to
6565 0 if C<s> is converted or contains all 7bit characters.
6567 NOTE: this function is experimental and may change or be
6568 removed without notice.
6570 U8* bytes_from_utf8(const U8 *s, STRLEN *len, bool *is_utf8)
6573 Found in file utf8.c
6578 Converts a string C<s> of length C<len> from ASCII into UTF-8 encoding.
6579 Returns a pointer to the newly-created string, and sets C<len> to
6580 reflect the new length.
6582 If you want to convert to UTF-8 from other encodings than ASCII,
6583 see sv_recode_to_utf8().
6585 NOTE: this function is experimental and may change or be
6586 removed without notice.
6588 U8* bytes_to_utf8(const U8 *s, STRLEN *len)
6591 Found in file utf8.c
6596 Return true if the strings s1 and s2 differ case-insensitively, false
6597 if not (if they are equal case-insensitively). If u1 is true, the
6598 string s1 is assumed to be in UTF-8-encoded Unicode. If u2 is true,
6599 the string s2 is assumed to be in UTF-8-encoded Unicode. If u1 or u2
6600 are false, the respective string is assumed to be in native 8-bit
6603 If the pe1 and pe2 are non-NULL, the scanning pointers will be copied
6604 in there (they will point at the beginning of the I<next> character).
6605 If the pointers behind pe1 or pe2 are non-NULL, they are the end
6606 pointers beyond which scanning will not continue under any
6607 circumstances. If the byte lengths l1 and l2 are non-zero, s1+l1 and
6608 s2+l2 will be used as goal end pointers that will also stop the scan,
6609 and which qualify towards defining a successful match: all the scans
6610 that define an explicit length must reach their goal pointers for
6611 a match to succeed).
6613 For case-insensitiveness, the "casefolding" of Unicode is used
6614 instead of upper/lowercasing both the characters, see
6615 http://www.unicode.org/unicode/reports/tr21/ (Case Mappings).
6617 I32 ibcmp_utf8(const char* a, char **pe1, UV l1, bool u1, const char* b, char **pe2, UV l2, bool u2)
6620 Found in file utf8.c
6625 Tests if some arbitrary number of bytes begins in a valid UTF-8
6626 character. Note that an INVARIANT (i.e. ASCII) character is a valid
6627 UTF-8 character. The actual number of bytes in the UTF-8 character
6628 will be returned if it is valid, otherwise 0.
6630 STRLEN is_utf8_char(const U8 *p)
6633 Found in file utf8.c
6635 =item is_utf8_string
6638 Returns true if first C<len> bytes of the given string form a valid
6639 UTF-8 string, false otherwise. Note that 'a valid UTF-8 string' does
6640 not mean 'a string that contains code points above 0x7F encoded in UTF-8'
6641 because a valid ASCII string is a valid UTF-8 string.
6643 See also is_utf8_string_loclen() and is_utf8_string_loc().
6645 bool is_utf8_string(const U8 *s, STRLEN len)
6648 Found in file utf8.c
6650 =item is_utf8_string_loc
6651 X<is_utf8_string_loc>
6653 Like is_utf8_string() but stores the location of the failure (in the
6654 case of "utf8ness failure") or the location s+len (in the case of
6655 "utf8ness success") in the C<ep>.
6657 See also is_utf8_string_loclen() and is_utf8_string().
6659 bool is_utf8_string_loc(const U8 *s, STRLEN len, const U8 **p)
6662 Found in file utf8.c
6664 =item is_utf8_string_loclen
6665 X<is_utf8_string_loclen>
6667 Like is_utf8_string() but stores the location of the failure (in the
6668 case of "utf8ness failure") or the location s+len (in the case of
6669 "utf8ness success") in the C<ep>, and the number of UTF-8
6670 encoded characters in the C<el>.
6672 See also is_utf8_string_loc() and is_utf8_string().
6674 bool is_utf8_string_loclen(const U8 *s, STRLEN len, const U8 **ep, STRLEN *el)
6677 Found in file utf8.c
6679 =item pv_uni_display
6682 Build to the scalar dsv a displayable version of the string spv,
6683 length len, the displayable version being at most pvlim bytes long
6684 (if longer, the rest is truncated and "..." will be appended).
6686 The flags argument can have UNI_DISPLAY_ISPRINT set to display
6687 isPRINT()able characters as themselves, UNI_DISPLAY_BACKSLASH
6688 to display the \\[nrfta\\] as the backslashed versions (like '\n')
6689 (UNI_DISPLAY_BACKSLASH is preferred over UNI_DISPLAY_ISPRINT for \\).
6690 UNI_DISPLAY_QQ (and its alias UNI_DISPLAY_REGEX) have both
6691 UNI_DISPLAY_BACKSLASH and UNI_DISPLAY_ISPRINT turned on.
6693 The pointer to the PV of the dsv is returned.
6695 char* pv_uni_display(SV *dsv, const U8 *spv, STRLEN len, STRLEN pvlim, UV flags)
6698 Found in file utf8.c
6703 The encoding is assumed to be an Encode object, the PV of the ssv is
6704 assumed to be octets in that encoding and decoding the input starts
6705 from the position which (PV + *offset) pointed to. The dsv will be
6706 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
6707 when the string tstr appears in decoding output or the input ends on
6708 the PV of the ssv. The value which the offset points will be modified
6709 to the last input position on the ssv.
6711 Returns TRUE if the terminator was found, else returns FALSE.
6713 bool sv_cat_decode(SV* dsv, SV *encoding, SV *ssv, int *offset, char* tstr, int tlen)
6718 =item sv_recode_to_utf8
6719 X<sv_recode_to_utf8>
6721 The encoding is assumed to be an Encode object, on entry the PV
6722 of the sv is assumed to be octets in that encoding, and the sv
6723 will be converted into Unicode (and UTF-8).
6725 If the sv already is UTF-8 (or if it is not POK), or if the encoding
6726 is not a reference, nothing is done to the sv. If the encoding is not
6727 an C<Encode::XS> Encoding object, bad things will happen.
6728 (See F<lib/encoding.pm> and L<Encode>).
6730 The PV of the sv is returned.
6732 char* sv_recode_to_utf8(SV* sv, SV *encoding)
6737 =item sv_uni_display
6740 Build to the scalar dsv a displayable version of the scalar sv,
6741 the displayable version being at most pvlim bytes long
6742 (if longer, the rest is truncated and "..." will be appended).
6744 The flags argument is as in pv_uni_display().
6746 The pointer to the PV of the dsv is returned.
6748 char* sv_uni_display(SV *dsv, SV *ssv, STRLEN pvlim, UV flags)
6751 Found in file utf8.c
6756 The "p" contains the pointer to the UTF-8 string encoding
6757 the character that is being converted.
6759 The "ustrp" is a pointer to the character buffer to put the
6760 conversion result to. The "lenp" is a pointer to the length
6763 The "swashp" is a pointer to the swash to use.
6765 Both the special and normal mappings are stored lib/unicore/To/Foo.pl,
6766 and loaded by SWASHNEW, using lib/utf8_heavy.pl. The special (usually,
6767 but not always, a multicharacter mapping), is tried first.
6769 The "special" is a string like "utf8::ToSpecLower", which means the
6770 hash %utf8::ToSpecLower. The access to the hash is through
6771 Perl_to_utf8_case().
6773 The "normal" is a string like "ToLower" which means the swash
6776 UV to_utf8_case(const U8 *p, U8* ustrp, STRLEN *lenp, SV **swashp, const char *normal, const char *special)
6779 Found in file utf8.c
6784 Convert the UTF-8 encoded character at p to its foldcase version and
6785 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6786 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6787 foldcase version may be longer than the original character (up to
6790 The first character of the foldcased version is returned
6791 (but note, as explained above, that there may be more.)
6793 UV to_utf8_fold(const U8 *p, U8* ustrp, STRLEN *lenp)
6796 Found in file utf8.c
6801 Convert the UTF-8 encoded character at p to its lowercase version and
6802 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6803 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6804 lowercase version may be longer than the original character.
6806 The first character of the lowercased version is returned
6807 (but note, as explained above, that there may be more.)
6809 UV to_utf8_lower(const U8 *p, U8* ustrp, STRLEN *lenp)
6812 Found in file utf8.c
6817 Convert the UTF-8 encoded character at p to its titlecase version and
6818 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6819 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6820 titlecase version may be longer than the original character.
6822 The first character of the titlecased version is returned
6823 (but note, as explained above, that there may be more.)
6825 UV to_utf8_title(const U8 *p, U8* ustrp, STRLEN *lenp)
6828 Found in file utf8.c
6833 Convert the UTF-8 encoded character at p to its uppercase version and
6834 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6835 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since
6836 the uppercase version may be longer than the original character.
6838 The first character of the uppercased version is returned
6839 (but note, as explained above, that there may be more.)
6841 UV to_utf8_upper(const U8 *p, U8* ustrp, STRLEN *lenp)
6844 Found in file utf8.c
6846 =item utf8n_to_uvchr
6851 Returns the native character value of the first character in the string
6853 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6854 length, in bytes, of that character.
6856 Allows length and flags to be passed to low level routine.
6858 UV utf8n_to_uvchr(const U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags)
6861 Found in file utf8.c
6863 =item utf8n_to_uvuni
6866 Bottom level UTF-8 decode routine.
6867 Returns the Unicode code point value of the first character in the string C<s>
6868 which is assumed to be in UTF-8 encoding and no longer than C<curlen>;
6869 C<retlen> will be set to the length, in bytes, of that character.
6871 If C<s> does not point to a well-formed UTF-8 character, the behaviour
6872 is dependent on the value of C<flags>: if it contains UTF8_CHECK_ONLY,
6873 it is assumed that the caller will raise a warning, and this function
6874 will silently just set C<retlen> to C<-1> and return zero. If the
6875 C<flags> does not contain UTF8_CHECK_ONLY, warnings about
6876 malformations will be given, C<retlen> will be set to the expected
6877 length of the UTF-8 character in bytes, and zero will be returned.
6879 The C<flags> can also contain various flags to allow deviations from
6880 the strict UTF-8 encoding (see F<utf8.h>).
6882 Most code should use utf8_to_uvchr() rather than call this directly.
6884 UV utf8n_to_uvuni(const U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags)
6887 Found in file utf8.c
6892 Returns the number of UTF-8 characters between the UTF-8 pointers C<a>
6895 WARNING: use only if you *know* that the pointers point inside the
6898 IV utf8_distance(const U8 *a, const U8 *b)
6901 Found in file utf8.c
6906 Return the UTF-8 pointer C<s> displaced by C<off> characters, either
6907 forward or backward.
6909 WARNING: do not use the following unless you *know* C<off> is within
6910 the UTF-8 data pointed to by C<s> *and* that on entry C<s> is aligned
6911 on the first byte of character or just after the last byte of a character.
6913 U8* utf8_hop(const U8 *s, I32 off)
6916 Found in file utf8.c
6921 Return the length of the UTF-8 char encoded string C<s> in characters.
6922 Stops at C<e> (inclusive). If C<e E<lt> s> or if the scan would end
6923 up past C<e>, croaks.
6925 STRLEN utf8_length(const U8* s, const U8 *e)
6928 Found in file utf8.c
6933 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
6934 Unlike C<bytes_to_utf8>, this over-writes the original string, and
6935 updates len to contain the new length.
6936 Returns zero on failure, setting C<len> to -1.
6938 If you need a copy of the string, see C<bytes_from_utf8>.
6940 NOTE: this function is experimental and may change or be
6941 removed without notice.
6943 U8* utf8_to_bytes(U8 *s, STRLEN *len)
6946 Found in file utf8.c
6951 Returns the native character value of the first character in the string C<s>
6952 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6953 length, in bytes, of that character.
6955 If C<s> does not point to a well-formed UTF-8 character, zero is
6956 returned and retlen is set, if possible, to -1.
6958 UV utf8_to_uvchr(const U8 *s, STRLEN *retlen)
6961 Found in file utf8.c
6966 Returns the Unicode code point of the first character in the string C<s>
6967 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6968 length, in bytes, of that character.
6970 This function should only be used when returned UV is considered
6971 an index into the Unicode semantic tables (e.g. swashes).
6973 If C<s> does not point to a well-formed UTF-8 character, zero is
6974 returned and retlen is set, if possible, to -1.
6976 UV utf8_to_uvuni(const U8 *s, STRLEN *retlen)
6979 Found in file utf8.c
6984 Adds the UTF-8 representation of the Native codepoint C<uv> to the end
6985 of the string C<d>; C<d> should be have at least C<UTF8_MAXBYTES+1> free
6986 bytes available. The return value is the pointer to the byte after the
6987 end of the new character. In other words,
6989 d = uvchr_to_utf8(d, uv);
6991 is the recommended wide native character-aware way of saying
6995 U8* uvchr_to_utf8(U8 *d, UV uv)
6998 Found in file utf8.c
7000 =item uvuni_to_utf8_flags
7001 X<uvuni_to_utf8_flags>
7003 Adds the UTF-8 representation of the Unicode codepoint C<uv> to the end
7004 of the string C<d>; C<d> should be have at least C<UTF8_MAXBYTES+1> free
7005 bytes available. The return value is the pointer to the byte after the
7006 end of the new character. In other words,
7008 d = uvuni_to_utf8_flags(d, uv, flags);
7012 d = uvuni_to_utf8(d, uv);
7014 (which is equivalent to)
7016 d = uvuni_to_utf8_flags(d, uv, 0);
7018 is the recommended Unicode-aware way of saying
7022 U8* uvuni_to_utf8_flags(U8 *d, UV uv, UV flags)
7025 Found in file utf8.c
7030 =head1 Variables created by C<xsubpp> and C<xsubpp> internal functions
7037 Variable which is setup by C<xsubpp> to indicate the stack base offset,
7038 used by the C<ST>, C<XSprePUSH> and C<XSRETURN> macros. The C<dMARK> macro
7039 must be called prior to setup the C<MARK> variable.
7044 Found in file XSUB.h
7049 Variable which is setup by C<xsubpp> to indicate the
7050 class name for a C++ XS constructor. This is always a C<char*>. See C<THIS>.
7055 Found in file XSUB.h
7060 Sets up the C<ax> 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<ax> variable and stack marker variable C<mark>.
7072 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
7077 Found in file XSUB.h
7082 Sets up the C<items> variable.
7083 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
7088 Found in file XSUB.h
7093 Sets up the C<padoff_du> variable for an XSUB that wishes to use
7099 Found in file XSUB.h
7104 Sets up stack and mark pointers for an XSUB, calling dSP and dMARK.
7105 Sets up the C<ax> and C<items> variables by calling C<dAX> and C<dITEMS>.
7106 This is usually handled automatically by C<xsubpp>.
7111 Found in file XSUB.h
7116 Sets up the C<ix> variable for an XSUB which has aliases. This is usually
7117 handled automatically by C<xsubpp>.
7122 Found in file XSUB.h
7127 Variable which is setup by C<xsubpp> to indicate the number of
7128 items on the stack. See L<perlxs/"Variable-length Parameter Lists">.
7133 Found in file XSUB.h
7138 Variable which is setup by C<xsubpp> to indicate which of an
7139 XSUB's aliases was used to invoke it. See L<perlxs/"The ALIAS: Keyword">.
7144 Found in file XSUB.h
7149 Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
7153 Found in file XSUB.h
7158 Variable which is setup by C<xsubpp> to hold the return value for an
7159 XSUB. This is always the proper type for the XSUB. See
7160 L<perlxs/"The RETVAL Variable">.
7165 Found in file XSUB.h
7170 Used to access elements on the XSUB's stack.
7175 Found in file XSUB.h
7180 Variable which is setup by C<xsubpp> to designate the object in a C++
7181 XSUB. This is always the proper type for the C++ object. See C<CLASS> and
7182 L<perlxs/"Using XS With C++">.
7187 Found in file XSUB.h
7192 The SV* corresponding to the $_ variable. Works even if there
7193 is a lexical $_ in scope.
7196 Found in file XSUB.h
7201 Macro to declare an XSUB and its C parameter list. This is handled by
7205 Found in file XSUB.h
7210 The version identifier for an XS module. This is usually
7211 handled automatically by C<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>.
7214 Found in file XSUB.h
7216 =item XS_VERSION_BOOTCHECK
7217 X<XS_VERSION_BOOTCHECK>
7219 Macro to verify that a PM module's $VERSION variable matches the XS
7220 module's C<XS_VERSION> variable. This is usually handled automatically by
7221 C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">.
7223 XS_VERSION_BOOTCHECK;
7226 Found in file XSUB.h
7231 =head1 Warning and Dieing
7238 This is the XSUB-writer's interface to Perl's C<die> function.
7239 Normally call this function the same way you call the C C<printf>
7240 function. Calling C<croak> returns control directly to Perl,
7241 sidestepping the normal C order of execution. See C<warn>.
7243 If you want to throw an exception object, assign the object to
7244 C<$@> and then pass C<NULL> to croak():
7246 errsv = get_sv("@", TRUE);
7247 sv_setsv(errsv, exception_object);
7250 void croak(const char* pat, ...)
7253 Found in file util.c
7258 This is the XSUB-writer's interface to Perl's C<warn> function. Call this
7259 function the same way you call the C C<printf> function. See C<croak>.
7261 void warn(const char* pat, ...)
7264 Found in file util.c
7271 Until May 1997, this document was maintained by Jeff Okamoto
7272 <okamoto@corp.hp.com>. It is now maintained as part of Perl itself.
7274 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
7275 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
7276 Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
7277 Stephen McCamant, and Gurusamy Sarathy.
7279 API Listing originally by Dean Roehrich <roehrich@cray.com>.
7281 Updated to be autogenerated from comments in the source by Benjamin Stuhl.
7285 perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
projects / p5sagit/p5-mst-13.2.git / blob