1 -*- buffer-read-only: t -*-
3 !!!!!!! DO NOT EDIT THIS FILE !!!!!!!
4 This file is built by autodoc.pl extracting documentation from the C source
9 perlapi - autogenerated documentation for the perl public API
12 X<Perl API> X<API> X<api>
14 This file contains the documentation of the perl public API generated by
15 embed.pl, specifically a listing of functions, macros, flags, and variables
16 that may be used by extension writers. The interfaces of any functions that
17 are not listed here are subject to change without notice. For this reason,
18 blindly using functions listed in proto.h is to be avoided when writing
21 Note that all Perl API global variables must be referenced with the C<PL_>
22 prefix. Some macros are provided for compatibility with the older,
23 unadorned names, but this support may be disabled in a future release.
25 The listing is alphabetical, case insensitive.
35 A backward-compatible version of C<GIMME_V> which can only return
36 C<G_SCALAR> or C<G_ARRAY>; in a void context, it returns C<G_SCALAR>.
37 Deprecated. Use C<GIMME_V> instead.
47 The XSUB-writer's equivalent to Perl's C<wantarray>. Returns C<G_VOID>,
48 C<G_SCALAR> or C<G_ARRAY> for void, scalar or list context,
59 Used to indicate list context. See C<GIMME_V>, C<GIMME> and
68 Indicates that arguments returned from a callback should be discarded. See
77 Used to force a Perl C<eval> wrapper around a callback. See
86 Indicates that no arguments are being sent to a callback. See
95 Used to indicate scalar context. See C<GIMME_V>, C<GIMME>, and
104 Used to indicate void context. See C<GIMME_V> and L<perlcall>.
112 =head1 Array Manipulation Functions
119 Same as C<av_len()>. Deprecated, use C<av_len()> instead.
129 Clears an array, making it empty. Does not free the memory used by the
132 void av_clear(AV* ar)
137 =item av_create_and_push
138 X<av_create_and_push>
140 Push an SV onto the end of the array, creating the array if necessary.
141 A small internal helper function to remove a commonly duplicated idiom.
143 NOTE: this function is experimental and may change or be
144 removed without notice.
146 void av_create_and_push(AV **const avp, SV *const val)
151 =item av_create_and_unshift_one
152 X<av_create_and_unshift_one>
154 Unshifts an SV onto the beginning of the array, creating the array if
156 A small internal helper function to remove a commonly duplicated idiom.
158 NOTE: this function is experimental and may change or be
159 removed without notice.
161 SV** av_create_and_unshift_one(AV **const avp, SV *const val)
169 Deletes the element indexed by C<key> from the array. Returns the
170 deleted element. If C<flags> equals C<G_DISCARD>, the element is freed
171 and null is returned.
173 SV* av_delete(AV* ar, I32 key, I32 flags)
181 Returns true if the element indexed by C<key> has been initialized.
183 This relies on the fact that uninitialized array elements are set to
186 bool av_exists(AV* ar, I32 key)
194 Pre-extend an array. The C<key> is the index to which the array should be
197 void av_extend(AV* ar, I32 key)
205 Returns the SV at the specified index in the array. The C<key> is the
206 index. If C<lval> is set then the fetch will be part of a store. Check
207 that the return value is non-null before dereferencing it to a C<SV*>.
209 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for
210 more information on how to use this function on tied arrays.
212 SV** av_fetch(AV* ar, I32 key, I32 lval)
220 Set the highest index in the array to the given number, equivalent to
221 Perl's C<$#array = $fill;>.
223 The number of elements in the an array will be C<fill + 1> after
224 av_fill() returns. If the array was previously shorter then the
225 additional elements appended are set to C<PL_sv_undef>. If the array
226 was longer, then the excess elements are freed. C<av_fill(av, -1)> is
227 the same as C<av_clear(av)>.
229 void av_fill(AV* ar, I32 fill)
237 Returns the highest index in the array. The number of elements in the
238 array is C<av_len(av) + 1>. Returns -1 if the array is empty.
240 I32 av_len(const AV* ar)
248 Creates a new AV and populates it with a list of SVs. The SVs are copied
249 into the array, so they may be freed after the call to av_make. The new AV
250 will have a reference count of 1.
252 AV* av_make(I32 size, SV** svp)
260 Pops an SV off the end of the array. Returns C<&PL_sv_undef> if the array
271 Pushes an SV onto the end of the array. The array will grow automatically
272 to accommodate the addition.
274 void av_push(AV* ar, SV* val)
282 Shifts an SV off the beginning of the array.
292 Stores an SV in an array. The array index is specified as C<key>. The
293 return value will be NULL if the operation failed or if the value did not
294 need to be actually stored within the array (as in the case of tied
295 arrays). Otherwise it can be dereferenced to get the original C<SV*>. Note
296 that the caller is responsible for suitably incrementing the reference
297 count of C<val> before the call, and decrementing it if the function
300 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for
301 more information on how to use this function on tied arrays.
303 SV** av_store(AV* ar, I32 key, SV* val)
311 Undefines the array. Frees the memory used by the array itself.
313 void av_undef(AV* ar)
321 Unshift the given number of C<undef> values onto the beginning of the
322 array. The array will grow automatically to accommodate the addition. You
323 must then use C<av_store> to assign values to these new elements.
325 void av_unshift(AV* ar, I32 num)
333 Returns the AV of the specified Perl array. If C<create> is set and the
334 Perl variable does not exist then it will be created. If C<create> is not
335 set and the variable does not exist then NULL is returned.
337 NOTE: the perl_ form of this function is deprecated.
339 AV* get_av(const char* name, I32 create)
347 Creates a new AV. The reference count is set to 1.
357 Sort an array. Here is an example:
359 sortsv(AvARRAY(av), av_len(av)+1, Perl_sv_cmp_locale);
361 Currently this always uses mergesort. See sortsv_flags for a more
364 void sortsv(SV** array, size_t num_elts, SVCOMPARE_t cmp)
367 Found in file pp_sort.c
372 Sort an array, with various options.
374 void sortsv_flags(SV** array, size_t num_elts, SVCOMPARE_t cmp, U32 flags)
377 Found in file pp_sort.c
382 =head1 Callback Functions
389 Performs a callback to the specified Perl sub. See L<perlcall>.
391 NOTE: the perl_ form of this function is deprecated.
393 I32 call_argv(const char* sub_name, I32 flags, char** argv)
401 Performs a callback to the specified Perl method. The blessed object must
402 be on the stack. See L<perlcall>.
404 NOTE: the perl_ form of this function is deprecated.
406 I32 call_method(const char* methname, I32 flags)
414 Performs a callback to the specified Perl sub. See L<perlcall>.
416 NOTE: the perl_ form of this function is deprecated.
418 I32 call_pv(const char* sub_name, I32 flags)
426 Performs a callback to the Perl sub whose name is in the SV. See
429 NOTE: the perl_ form of this function is deprecated.
431 I32 call_sv(SV* sv, I32 flags)
439 Opening bracket on a callback. See C<LEAVE> and L<perlcall>.
444 Found in file scope.h
449 Tells Perl to C<eval> the given string and return an SV* result.
451 NOTE: the perl_ form of this function is deprecated.
453 SV* eval_pv(const char* p, I32 croak_on_error)
461 Tells Perl to C<eval> the string in the SV.
463 NOTE: the perl_ form of this function is deprecated.
465 I32 eval_sv(SV* sv, I32 flags)
473 Closing bracket for temporaries on a callback. See C<SAVETMPS> and
479 Found in file scope.h
484 Closing bracket on a callback. See C<ENTER> and L<perlcall>.
489 Found in file scope.h
494 Opening bracket for temporaries on a callback. See C<FREETMPS> and
500 Found in file scope.h
505 =head1 Character classes
512 Returns a boolean indicating whether the C C<char> is an ASCII alphanumeric
513 character (including underscore) or digit.
515 bool isALNUM(char ch)
518 Found in file handy.h
523 Returns a boolean indicating whether the C C<char> is an ASCII alphabetic
526 bool isALPHA(char ch)
529 Found in file handy.h
534 Returns a boolean indicating whether the C C<char> is an ASCII
537 bool isDIGIT(char ch)
540 Found in file handy.h
545 Returns a boolean indicating whether the C C<char> is a lowercase
548 bool isLOWER(char ch)
551 Found in file handy.h
556 Returns a boolean indicating whether the C C<char> is whitespace.
558 bool isSPACE(char ch)
561 Found in file handy.h
566 Returns a boolean indicating whether the C C<char> is an uppercase
569 bool isUPPER(char ch)
572 Found in file handy.h
577 Converts the specified character to lowercase.
579 char toLOWER(char ch)
582 Found in file handy.h
587 Converts the specified character to uppercase.
589 char toUPPER(char ch)
592 Found in file handy.h
597 =head1 Cloning an interpreter
604 Create and return a new interpreter by cloning the current one.
606 perl_clone takes these flags as parameters:
608 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
609 without it we only clone the data and zero the stacks,
610 with it we copy the stacks and the new perl interpreter is
611 ready to run at the exact same point as the previous one.
612 The pseudo-fork code uses COPY_STACKS while the
613 threads->create doesn't.
615 CLONEf_KEEP_PTR_TABLE
616 perl_clone keeps a ptr_table with the pointer of the old
617 variable as a key and the new variable as a value,
618 this allows it to check if something has been cloned and not
619 clone it again but rather just use the value and increase the
620 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
621 the ptr_table using the function
622 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
623 reason to keep it around is if you want to dup some of your own
624 variable who are outside the graph perl scans, example of this
625 code is in threads.xs create
628 This is a win32 thing, it is ignored on unix, it tells perls
629 win32host code (which is c++) to clone itself, this is needed on
630 win32 if you want to run two threads at the same time,
631 if you just want to do some stuff in a separate perl interpreter
632 and then throw it away and return to the original one,
633 you don't need to do anything.
635 PerlInterpreter* perl_clone(PerlInterpreter* interp, UV flags)
643 =head1 CV Manipulation Functions
650 Returns the stash of the CV.
660 Uses C<strlen> to get the length of C<name>, then calls C<get_cvn_flags>.
662 NOTE: the perl_ form of this function is deprecated.
664 CV* get_cv(const char* name, I32 flags)
672 Returns the CV of the specified Perl subroutine. C<flags> are passed to
673 C<gv_fetchpvn_flags>. If C<GV_ADD> is set and the Perl subroutine does not
674 exist then it will be declared (which has the same effect as saying
675 C<sub name;>). If C<GV_ADD> is not set and the subroutine does not exist
676 then NULL is returned.
678 NOTE: the perl_ form of this function is deprecated.
680 CV* get_cvn_flags(const char* name, STRLEN len, I32 flags)
688 =head1 Embedding Functions
695 Clear out all the active components of a CV. This can happen either
696 by an explicit C<undef &foo>, or by the reference count going to zero.
697 In the former case, we keep the CvOUTSIDE pointer, so that any anonymous
698 children can still follow the full lexical scope chain.
700 void cv_undef(CV* cv)
708 Loads the module whose name is pointed to by the string part of name.
709 Note that the actual module name, not its filename, should be given.
710 Eg, "Foo::Bar" instead of "Foo/Bar.pm". flags can be any of
711 PERL_LOADMOD_DENY, PERL_LOADMOD_NOIMPORT, or PERL_LOADMOD_IMPORT_OPS
712 (or 0 for no flags). ver, if specified, provides version semantics
713 similar to C<use Foo::Bar VERSION>. The optional trailing SV*
714 arguments can be used to specify arguments to the module's import()
715 method, similar to C<use Foo::Bar VERSION LIST>.
717 void load_module(U32 flags, SV* name, SV* ver, ...)
725 Stub that provides thread hook for perl_destruct when there are
736 Allocates a new Perl interpreter. See L<perlembed>.
738 PerlInterpreter* perl_alloc()
746 Initializes a new Perl interpreter. See L<perlembed>.
748 void perl_construct(PerlInterpreter* interp)
756 Shuts down a Perl interpreter. See L<perlembed>.
758 int perl_destruct(PerlInterpreter* interp)
766 Releases a Perl interpreter. See L<perlembed>.
768 void perl_free(PerlInterpreter* interp)
776 Tells a Perl interpreter to parse a Perl script. See L<perlembed>.
778 int perl_parse(PerlInterpreter* interp, XSINIT_t xsinit, int argc, char** argv, char** env)
786 Tells a Perl interpreter to run. See L<perlembed>.
788 int perl_run(PerlInterpreter* interp)
796 Tells Perl to C<require> the file named by the string argument. It is
797 analogous to the Perl code C<eval "require '$file'">. It's even
798 implemented that way; consider using load_module instead.
800 NOTE: the perl_ form of this function is deprecated.
802 void require_pv(const char* pv)
810 =head1 Functions in file dump.c
818 char *pv_display(SV *dsv, const char *pv, STRLEN cur, STRLEN len,
819 STRLEN pvlim, U32 flags)
823 pv_escape(dsv,pv,cur,pvlim,PERL_PV_ESCAPE_QUOTE);
825 except that an additional "\0" will be appended to the string when
826 len > cur and pv[cur] is "\0".
828 Note that the final string may be up to 7 chars longer than pvlim.
830 char* pv_display(SV *dsv, const char *pv, STRLEN cur, STRLEN len, STRLEN pvlim)
838 |const STRLEN count|const STRLEN max
839 |STRLEN const *escaped, const U32 flags
841 Escapes at most the first "count" chars of pv and puts the results into
842 dsv such that the size of the escaped string will not exceed "max" chars
843 and will not contain any incomplete escape sequences.
845 If flags contains PERL_PV_ESCAPE_QUOTE then any double quotes in the string
846 will also be escaped.
848 Normally the SV will be cleared before the escaped string is prepared,
849 but when PERL_PV_ESCAPE_NOCLEAR is set this will not occur.
851 If PERL_PV_ESCAPE_UNI is set then the input string is treated as Unicode,
852 if PERL_PV_ESCAPE_UNI_DETECT is set then the input string is scanned
853 using C<is_utf8_string()> to determine if it is Unicode.
855 If PERL_PV_ESCAPE_ALL is set then all input chars will be output
856 using C<\x01F1> style escapes, otherwise only chars above 255 will be
857 escaped using this style, other non printable chars will use octal or
858 common escaped patterns like C<\n>. If PERL_PV_ESCAPE_NOBACKSLASH
859 then all chars below 255 will be treated as printable and
860 will be output as literals.
862 If PERL_PV_ESCAPE_FIRSTCHAR is set then only the first char of the
863 string will be escaped, regardles of max. If the string is utf8 and
864 the chars value is >255 then it will be returned as a plain hex
865 sequence. Thus the output will either be a single char,
866 an octal escape sequence, a special escape like C<\n> or a 3 or
867 more digit hex value.
869 If PERL_PV_ESCAPE_RE is set then the escape char used will be a '%' and
870 not a '\\'. This is because regexes very often contain backslashed
871 sequences, whereas '%' is not a particularly common character in patterns.
873 Returns a pointer to the escaped text as held by dsv.
875 NOTE: the perl_ form of this function is deprecated.
877 char* pv_escape(SV *dsv, char const * const str, const STRLEN count, const STRLEN max, STRLEN * const escaped, const U32 flags)
885 |const STRLEN count|const STRLEN max\
886 |const char const *start_color| const char const *end_color\
889 Converts a string into something presentable, handling escaping via
890 pv_escape() and supporting quoting and ellipses.
892 If the PERL_PV_PRETTY_QUOTE flag is set then the result will be
893 double quoted with any double quotes in the string escaped. Otherwise
894 if the PERL_PV_PRETTY_LTGT flag is set then the result be wrapped in
897 If the PERL_PV_PRETTY_ELLIPSES flag is set and not all characters in
898 string were output then an ellipsis C<...> will be appended to the
899 string. Note that this happens AFTER it has been quoted.
901 If start_color is non-null then it will be inserted after the opening
902 quote (if there is one) but before the escaped text. If end_color
903 is non-null then it will be inserted after the escaped text but before
904 any quotes or ellipses.
906 Returns a pointer to the prettified text as held by dsv.
908 NOTE: the perl_ form of this function is deprecated.
910 char* pv_pretty(SV *dsv, char const * const str, const STRLEN count, const STRLEN max, char const * const start_color, char const * const end_color, const U32 flags)
918 =head1 Functions in file mathoms.c
926 See L<gv_fetchmethod_autoload>.
928 GV* gv_fetchmethod(HV* stash, const char* name)
931 Found in file mathoms.c
936 The engine implementing pack() Perl function. Note: parameters next_in_list and
937 flags are not used. This call should not be used; use packlist instead.
939 void pack_cat(SV *cat, const char *pat, const char *patend, SV **beglist, SV **endlist, SV ***next_in_list, U32 flags)
942 Found in file mathoms.c
944 =item sv_2pvbyte_nolen
947 Return a pointer to the byte-encoded representation of the SV.
948 May cause the SV to be downgraded from UTF-8 as a side-effect.
950 Usually accessed via the C<SvPVbyte_nolen> macro.
952 char* sv_2pvbyte_nolen(SV* sv)
955 Found in file mathoms.c
957 =item sv_2pvutf8_nolen
960 Return a pointer to the UTF-8-encoded representation of the SV.
961 May cause the SV to be upgraded to UTF-8 as a side-effect.
963 Usually accessed via the C<SvPVutf8_nolen> macro.
965 char* sv_2pvutf8_nolen(SV* sv)
968 Found in file mathoms.c
973 Like C<sv_2pv()>, but doesn't return the length too. You should usually
974 use the macro wrapper C<SvPV_nolen(sv)> instead.
975 char* sv_2pv_nolen(SV* sv)
978 Found in file mathoms.c
983 Like C<sv_catpvn>, but also handles 'set' magic.
985 void sv_catpvn_mg(SV *sv, const char *ptr, STRLEN len)
988 Found in file mathoms.c
993 Like C<sv_catsv>, but also handles 'set' magic.
995 void sv_catsv_mg(SV *dstr, SV *sstr)
998 Found in file mathoms.c
1000 =item sv_force_normal
1003 Undo various types of fakery on an SV: if the PV is a shared string, make
1004 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
1005 an xpvmg. See also C<sv_force_normal_flags>.
1007 void sv_force_normal(SV *sv)
1010 Found in file mathoms.c
1015 A private implementation of the C<SvIVx> macro for compilers which can't
1016 cope with complex macro expressions. Always use the macro instead.
1021 Found in file mathoms.c
1026 Dummy routine which "locks" an SV when there is no locking module present.
1027 Exists to avoid test for a NULL function pointer and because it could
1028 potentially warn under some level of strict-ness.
1030 "Superseded" by sv_nosharing().
1032 void sv_nolocking(SV *sv)
1035 Found in file mathoms.c
1037 =item sv_nounlocking
1040 Dummy routine which "unlocks" an SV when there is no locking module present.
1041 Exists to avoid test for a NULL function pointer and because it could
1042 potentially warn under some level of strict-ness.
1044 "Superseded" by sv_nosharing().
1046 void sv_nounlocking(SV *sv)
1049 Found in file mathoms.c
1054 A private implementation of the C<SvNVx> macro for compilers which can't
1055 cope with complex macro expressions. Always use the macro instead.
1060 Found in file mathoms.c
1065 Use the C<SvPV_nolen> macro instead
1070 Found in file mathoms.c
1075 Use C<SvPVbyte_nolen> instead.
1077 char* sv_pvbyte(SV *sv)
1080 Found in file mathoms.c
1085 A private implementation of the C<SvPVbyte> macro for compilers
1086 which can't cope with complex macro expressions. Always use the macro
1089 char* sv_pvbyten(SV *sv, STRLEN *len)
1092 Found in file mathoms.c
1097 A private implementation of the C<SvPV> macro for compilers which can't
1098 cope with complex macro expressions. Always use the macro instead.
1100 char* sv_pvn(SV *sv, STRLEN *len)
1103 Found in file mathoms.c
1108 Use the C<SvPVutf8_nolen> macro instead
1110 char* sv_pvutf8(SV *sv)
1113 Found in file mathoms.c
1118 A private implementation of the C<SvPVutf8> macro for compilers
1119 which can't cope with complex macro expressions. Always use the macro
1122 char* sv_pvutf8n(SV *sv, STRLEN *len)
1125 Found in file mathoms.c
1130 Taint an SV. Use C<SvTAINTED_on> instead.
1131 void sv_taint(SV* sv)
1134 Found in file mathoms.c
1139 Unsets the RV status of the SV, and decrements the reference count of
1140 whatever was being referenced by the RV. This can almost be thought of
1141 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
1142 being zero. See C<SvROK_off>.
1144 void sv_unref(SV* sv)
1147 Found in file mathoms.c
1152 Tells an SV to use C<ptr> to find its string value. Implemented by
1153 calling C<sv_usepvn_flags> with C<flags> of 0, hence does not handle 'set'
1154 magic. See C<sv_usepvn_flags>.
1156 void sv_usepvn(SV* sv, char* ptr, STRLEN len)
1159 Found in file mathoms.c
1164 Like C<sv_usepvn>, but also handles 'set' magic.
1166 void sv_usepvn_mg(SV *sv, char *ptr, STRLEN len)
1169 Found in file mathoms.c
1174 A private implementation of the C<SvUVx> macro for compilers which can't
1175 cope with complex macro expressions. Always use the macro instead.
1180 Found in file mathoms.c
1185 The engine implementing unpack() Perl function. Note: parameters strbeg, new_s
1186 and ocnt are not used. This call should not be used, use unpackstring instead.
1188 I32 unpack_str(const char *pat, const char *patend, const char *s, const char *strbeg, const char *strend, char **new_s, I32 ocnt, U32 flags)
1191 Found in file mathoms.c
1196 =head1 Functions in file pp_ctl.c
1204 Locate the CV corresponding to the currently executing sub or eval.
1205 If db_seqp is non_null, skip CVs that are in the DB package and populate
1206 *db_seqp with the cop sequence number at the point that the DB:: code was
1207 entered. (allows debuggers to eval in the scope of the breakpoint rather
1208 than in the scope of the debugger itself).
1210 CV* find_runcv(U32 *db_seqp)
1213 Found in file pp_ctl.c
1218 =head1 Functions in file pp_pack.c
1226 The engine implementing pack() Perl function.
1228 void packlist(SV *cat, const char *pat, const char *patend, SV **beglist, SV **endlist)
1231 Found in file pp_pack.c
1236 The engine implementing unpack() Perl function. C<unpackstring> puts the
1237 extracted list items on the stack and returns the number of elements.
1238 Issue C<PUTBACK> before and C<SPAGAIN> after the call to this function.
1240 I32 unpackstring(const char *pat, const char *patend, const char *s, const char *strend, U32 flags)
1243 Found in file pp_pack.c
1255 Return the SV from the GV.
1265 If C<gv> is a typeglob whose subroutine entry is a constant sub eligible for
1266 inlining, or C<gv> is a placeholder reference that would be promoted to such
1267 a typeglob, then returns the value returned by the sub. Otherwise, returns
1270 SV* gv_const_sv(GV* gv)
1278 Returns the glob with the given C<name> and a defined subroutine or
1279 C<NULL>. The glob lives in the given C<stash>, or in the stashes
1280 accessible via @ISA and UNIVERSAL::.
1282 The argument C<level> should be either 0 or -1. If C<level==0>, as a
1283 side-effect creates a glob with the given C<name> in the given C<stash>
1284 which in the case of success contains an alias for the subroutine, and sets
1285 up caching info for this glob.
1287 This function grants C<"SUPER"> token as a postfix of the stash name. The
1288 GV returned from C<gv_fetchmeth> may be a method cache entry, which is not
1289 visible to Perl code. So when calling C<call_sv>, you should not use
1290 the GV directly; instead, you should use the method's CV, which can be
1291 obtained from the GV with the C<GvCV> macro.
1293 GV* gv_fetchmeth(HV* stash, const char* name, STRLEN len, I32 level)
1298 =item gv_fetchmethod_autoload
1299 X<gv_fetchmethod_autoload>
1301 Returns the glob which contains the subroutine to call to invoke the method
1302 on the C<stash>. In fact in the presence of autoloading this may be the
1303 glob for "AUTOLOAD". In this case the corresponding variable $AUTOLOAD is
1306 The third parameter of C<gv_fetchmethod_autoload> determines whether
1307 AUTOLOAD lookup is performed if the given method is not present: non-zero
1308 means yes, look for AUTOLOAD; zero means no, don't look for AUTOLOAD.
1309 Calling C<gv_fetchmethod> is equivalent to calling C<gv_fetchmethod_autoload>
1310 with a non-zero C<autoload> parameter.
1312 These functions grant C<"SUPER"> token as a prefix of the method name. Note
1313 that if you want to keep the returned glob for a long time, you need to
1314 check for it being "AUTOLOAD", since at the later time the call may load a
1315 different subroutine due to $AUTOLOAD changing its value. Use the glob
1316 created via a side effect to do this.
1318 These functions have the same side-effects and as C<gv_fetchmeth> with
1319 C<level==0>. C<name> should be writable if contains C<':'> or C<'
1320 ''>. The warning against passing the GV returned by C<gv_fetchmeth> to
1321 C<call_sv> apply equally to these functions.
1323 GV* gv_fetchmethod_autoload(HV* stash, const char* name, I32 autoload)
1328 =item gv_fetchmeth_autoload
1329 X<gv_fetchmeth_autoload>
1331 Same as gv_fetchmeth(), but looks for autoloaded subroutines too.
1332 Returns a glob for the subroutine.
1334 For an autoloaded subroutine without a GV, will create a GV even
1335 if C<level < 0>. For an autoloaded subroutine without a stub, GvCV()
1336 of the result may be zero.
1338 GV* gv_fetchmeth_autoload(HV* stash, const char* name, STRLEN len, I32 level)
1346 Returns a pointer to the stash for a specified package. Uses C<strlen> to
1347 determine the length of C<name>, then calls C<gv_stashpvn()>.
1349 HV* gv_stashpv(const char* name, I32 flags)
1357 Returns a pointer to the stash for a specified package. The C<namelen>
1358 parameter indicates the length of the C<name>, in bytes. C<flags> is passed
1359 to C<gv_fetchpvn_flags()>, so if set to C<GV_ADD> then the package will be
1360 created if it does not already exist. If the package does not exist and
1361 C<flags> is 0 (or any other setting that does not create packages) then NULL
1365 HV* gv_stashpvn(const char* name, U32 namelen, I32 flags)
1373 Like C<gv_stashpvn>, but takes a literal string instead of a string/length pair.
1375 HV* gv_stashpvs(const char* name, I32 create)
1378 Found in file handy.h
1383 Returns a pointer to the stash for a specified package. See C<gv_stashpvn>.
1385 HV* gv_stashsv(SV* sv, I32 flags)
1408 Null character pointer.
1411 Found in file handy.h
1435 Found in file handy.h
1440 =head1 Hash Manipulation Functions
1447 Returns the HV of the specified Perl hash. If C<create> is set and the
1448 Perl variable does not exist then it will be created. If C<create> is not
1449 set and the variable does not exist then NULL is returned.
1451 NOTE: the perl_ form of this function is deprecated.
1453 HV* get_hv(const char* name, I32 create)
1456 Found in file perl.c
1461 This flag, used in the length slot of hash entries and magic structures,
1462 specifies the structure contains an C<SV*> pointer where a C<char*> pointer
1463 is to be expected. (For information only--not to be used).
1471 Returns the computed hash stored in the hash entry.
1481 Returns the actual pointer stored in the key slot of the hash entry. The
1482 pointer may be either C<char*> or C<SV*>, depending on the value of
1483 C<HeKLEN()>. Can be assigned to. The C<HePV()> or C<HeSVKEY()> macros are
1484 usually preferable for finding the value of a key.
1494 If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry
1495 holds an C<SV*> key. Otherwise, holds the actual length of the key. Can
1496 be assigned to. The C<HePV()> macro is usually preferable for finding key
1499 STRLEN HeKLEN(HE* he)
1507 Returns the key slot of the hash entry as a C<char*> value, doing any
1508 necessary dereferencing of possibly C<SV*> keys. The length of the string
1509 is placed in C<len> (this is a macro, so do I<not> use C<&len>). If you do
1510 not care about what the length of the key is, you may use the global
1511 variable C<PL_na>, though this is rather less efficient than using a local
1512 variable. Remember though, that hash keys in perl are free to contain
1513 embedded nulls, so using C<strlen()> or similar is not a good way to find
1514 the length of hash keys. This is very similar to the C<SvPV()> macro
1515 described elsewhere in this document.
1517 char* HePV(HE* he, STRLEN len)
1525 Returns the key as an C<SV*>, or C<NULL> if the hash entry does not
1526 contain an C<SV*> key.
1536 Returns the key as an C<SV*>. Will create and return a temporary mortal
1537 C<SV*> if the hash entry contains only a C<char*> key.
1539 SV* HeSVKEY_force(HE* he)
1547 Sets the key to a given C<SV*>, taking care to set the appropriate flags to
1548 indicate the presence of an C<SV*> key, and returns the same
1551 SV* HeSVKEY_set(HE* he, SV* sv)
1559 Returns the value slot (type C<SV*>) stored in the hash entry.
1569 Returns the package name of a stash, or NULL if C<stash> isn't a stash.
1570 See C<SvSTASH>, C<CvSTASH>.
1572 char* HvNAME(HV* stash)
1580 Check that a hash is in an internally consistent state.
1582 void hv_assert(HV* tb)
1590 Clears a hash, making it empty.
1592 void hv_clear(HV* tb)
1597 =item hv_clear_placeholders
1598 X<hv_clear_placeholders>
1600 Clears any placeholders from a hash. If a restricted hash has any of its keys
1601 marked as readonly and the key is subsequently deleted, the key is not actually
1602 deleted but is marked by assigning it a value of &PL_sv_placeholder. This tags
1603 it so it will be ignored by future operations such as iterating over the hash,
1604 but will still allow the hash to have a value reassigned to the key at some
1605 future point. This function clears any such placeholder keys from the hash.
1606 See Hash::Util::lock_keys() for an example of its use.
1608 void hv_clear_placeholders(HV* hb)
1616 Deletes a key/value pair in the hash. The value SV is removed from the
1617 hash and returned to the caller. The C<klen> is the length of the key.
1618 The C<flags> value will normally be zero; if set to G_DISCARD then NULL
1621 SV* hv_delete(HV* tb, const char* key, I32 klen, I32 flags)
1629 Deletes a key/value pair in the hash. The value SV is removed from the
1630 hash and returned to the caller. The C<flags> value will normally be zero;
1631 if set to G_DISCARD then NULL will be returned. C<hash> can be a valid
1632 precomputed hash value, or 0 to ask for it to be computed.
1634 SV* hv_delete_ent(HV* tb, SV* key, I32 flags, U32 hash)
1642 Returns a boolean indicating whether the specified hash key exists. The
1643 C<klen> is the length of the key.
1645 bool hv_exists(HV* tb, const char* key, I32 klen)
1653 Returns a boolean indicating whether the specified hash key exists. C<hash>
1654 can be a valid precomputed hash value, or 0 to ask for it to be
1657 bool hv_exists_ent(HV* tb, SV* key, U32 hash)
1665 Returns the SV which corresponds to the specified key in the hash. The
1666 C<klen> is the length of the key. If C<lval> is set then the fetch will be
1667 part of a store. Check that the return value is non-null before
1668 dereferencing it to an C<SV*>.
1670 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1671 information on how to use this function on tied hashes.
1673 SV** hv_fetch(HV* tb, const char* key, I32 klen, I32 lval)
1681 Like C<hv_fetch>, but takes a literal string instead of a string/length pair.
1683 SV** hv_fetchs(HV* tb, const char* key, I32 lval)
1686 Found in file handy.h
1691 Returns the hash entry which corresponds to the specified key in the hash.
1692 C<hash> must be a valid precomputed hash number for the given C<key>, or 0
1693 if you want the function to compute it. IF C<lval> is set then the fetch
1694 will be part of a store. Make sure the return value is non-null before
1695 accessing it. The return value when C<tb> is a tied hash is a pointer to a
1696 static location, so be sure to make a copy of the structure if you need to
1699 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1700 information on how to use this function on tied hashes.
1702 HE* hv_fetch_ent(HV* tb, SV* key, I32 lval, U32 hash)
1710 Prepares a starting point to traverse a hash table. Returns the number of
1711 keys in the hash (i.e. the same as C<HvKEYS(tb)>). The return value is
1712 currently only meaningful for hashes without tie magic.
1714 NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
1715 hash buckets that happen to be in use. If you still need that esoteric
1716 value, you can get it through the macro C<HvFILL(tb)>.
1719 I32 hv_iterinit(HV* tb)
1727 Returns the key from the current position of the hash iterator. See
1730 char* hv_iterkey(HE* entry, I32* retlen)
1738 Returns the key as an C<SV*> from the current position of the hash
1739 iterator. The return value will always be a mortal copy of the key. Also
1742 SV* hv_iterkeysv(HE* entry)
1750 Returns entries from a hash iterator. See C<hv_iterinit>.
1752 You may call C<hv_delete> or C<hv_delete_ent> on the hash entry that the
1753 iterator currently points to, without losing your place or invalidating your
1754 iterator. Note that in this case the current entry is deleted from the hash
1755 with your iterator holding the last reference to it. Your iterator is flagged
1756 to free the entry on the next call to C<hv_iternext>, so you must not discard
1757 your iterator immediately else the entry will leak - call C<hv_iternext> to
1758 trigger the resource deallocation.
1760 HE* hv_iternext(HV* tb)
1768 Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
1771 SV* hv_iternextsv(HV* hv, char** key, I32* retlen)
1776 =item hv_iternext_flags
1777 X<hv_iternext_flags>
1779 Returns entries from a hash iterator. See C<hv_iterinit> and C<hv_iternext>.
1780 The C<flags> value will normally be zero; if HV_ITERNEXT_WANTPLACEHOLDERS is
1781 set the placeholders keys (for restricted hashes) will be returned in addition
1782 to normal keys. By default placeholders are automatically skipped over.
1783 Currently a placeholder is implemented with a value that is
1784 C<&Perl_sv_placeholder>. Note that the implementation of placeholders and
1785 restricted hashes may change, and the implementation currently is
1786 insufficiently abstracted for any change to be tidy.
1788 NOTE: this function is experimental and may change or be
1789 removed without notice.
1791 HE* hv_iternext_flags(HV* tb, I32 flags)
1799 Returns the value from the current position of the hash iterator. See
1802 SV* hv_iterval(HV* tb, HE* entry)
1810 Adds magic to a hash. See C<sv_magic>.
1812 void hv_magic(HV* hv, GV* gv, int how)
1820 Evaluates the hash in scalar context and returns the result. Handles magic when the hash is tied.
1822 SV* hv_scalar(HV* hv)
1830 Stores an SV in a hash. The hash key is specified as C<key> and C<klen> is
1831 the length of the key. The C<hash> parameter is the precomputed hash
1832 value; if it is zero then Perl will compute it. The return value will be
1833 NULL if the operation failed or if the value did not need to be actually
1834 stored within the hash (as in the case of tied hashes). Otherwise it can
1835 be dereferenced to get the original C<SV*>. Note that the caller is
1836 responsible for suitably incrementing the reference count of C<val> before
1837 the call, and decrementing it if the function returned NULL. Effectively
1838 a successful hv_store takes ownership of one reference to C<val>. This is
1839 usually what you want; a newly created SV has a reference count of one, so
1840 if all your code does is create SVs then store them in a hash, hv_store
1841 will own the only reference to the new SV, and your code doesn't need to do
1842 anything further to tidy up. hv_store is not implemented as a call to
1843 hv_store_ent, and does not create a temporary SV for the key, so if your
1844 key data is not already in SV form then use hv_store in preference to
1847 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1848 information on how to use this function on tied hashes.
1850 SV** hv_store(HV* tb, const char* key, I32 klen, SV* val, U32 hash)
1858 Like C<hv_store>, but takes a literal string instead of a string/length pair
1859 and omits the hash parameter.
1861 SV** hv_stores(HV* tb, const char* key, NULLOK SV* val)
1864 Found in file handy.h
1869 Stores C<val> in a hash. The hash key is specified as C<key>. The C<hash>
1870 parameter is the precomputed hash value; if it is zero then Perl will
1871 compute it. The return value is the new hash entry so created. It will be
1872 NULL if the operation failed or if the value did not need to be actually
1873 stored within the hash (as in the case of tied hashes). Otherwise the
1874 contents of the return value can be accessed using the C<He?> macros
1875 described here. Note that the caller is responsible for suitably
1876 incrementing the reference count of C<val> before the call, and
1877 decrementing it if the function returned NULL. Effectively a successful
1878 hv_store_ent takes ownership of one reference to C<val>. This is
1879 usually what you want; a newly created SV has a reference count of one, so
1880 if all your code does is create SVs then store them in a hash, hv_store
1881 will own the only reference to the new SV, and your code doesn't need to do
1882 anything further to tidy up. Note that hv_store_ent only reads the C<key>;
1883 unlike C<val> it does not take ownership of it, so maintaining the correct
1884 reference count on C<key> is entirely the caller's responsibility. hv_store
1885 is not implemented as a call to hv_store_ent, and does not create a temporary
1886 SV for the key, so if your key data is not already in SV form then use
1887 hv_store in preference to hv_store_ent.
1889 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1890 information on how to use this function on tied hashes.
1892 HE* hv_store_ent(HV* tb, SV* key, SV* val, U32 hash)
1902 void hv_undef(HV* tb)
1910 Creates a new HV. The reference count is set to 1.
1920 =head1 Magical Functions
1927 Clear something magical that the SV represents. See C<sv_magic>.
1929 int mg_clear(SV* sv)
1937 Copies the magic from one SV to another. See C<sv_magic>.
1939 int mg_copy(SV* sv, SV* nsv, const char* key, I32 klen)
1947 Finds the magic pointer for type matching the SV. See C<sv_magic>.
1949 MAGIC* mg_find(const SV* sv, int type)
1957 Free any magic storage used by the SV. See C<sv_magic>.
1967 Do magic after a value is retrieved from the SV. See C<sv_magic>.
1977 Report on the SV's length. See C<sv_magic>.
1979 U32 mg_length(SV* sv)
1987 Turns on the magical status of an SV. See C<sv_magic>.
1989 void mg_magical(SV* sv)
1997 Do magic after a value is assigned to the SV. See C<sv_magic>.
2007 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
2008 argument more than once.
2010 void SvGETMAGIC(SV* sv)
2018 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
2029 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
2030 argument more than once.
2032 void SvSETMAGIC(SV* sv)
2040 Like C<SvSetSV>, but does any set magic required afterwards.
2042 void SvSetMagicSV(SV* dsb, SV* ssv)
2047 =item SvSetMagicSV_nosteal
2048 X<SvSetMagicSV_nosteal>
2050 Like C<SvSetSV_nosteal>, but does any set magic required afterwards.
2052 void SvSetMagicSV_nosteal(SV* dsv, SV* ssv)
2060 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
2063 void SvSetSV(SV* dsb, SV* ssv)
2068 =item SvSetSV_nosteal
2071 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
2072 ssv. May evaluate arguments more than once.
2074 void SvSetSV_nosteal(SV* dsv, SV* ssv)
2082 Arranges for sv to be shared between threads if a suitable module
2085 void SvSHARE(SV* sv)
2093 Releases a mutual exclusion lock on sv if a suitable module
2096 void SvUNLOCK(SV* sv)
2104 =head1 Memory Management
2111 The XSUB-writer's interface to the C C<memcpy> function. The C<src> is the
2112 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
2113 the type. May fail on overlapping copies. See also C<Move>.
2115 void Copy(void* src, void* dest, int nitems, type)
2118 Found in file handy.h
2123 Like C<Copy> but returns dest. Useful for encouraging compilers to tail-call
2126 void * CopyD(void* src, void* dest, int nitems, type)
2129 Found in file handy.h
2134 The XSUB-writer's interface to the C C<memmove> function. The C<src> is the
2135 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
2136 the type. Can do overlapping moves. See also C<Copy>.
2138 void Move(void* src, void* dest, int nitems, type)
2141 Found in file handy.h
2146 Like C<Move> but returns dest. Useful for encouraging compilers to tail-call
2149 void * MoveD(void* src, void* dest, int nitems, type)
2152 Found in file handy.h
2157 The XSUB-writer's interface to the C C<malloc> function.
2159 In 5.9.3, Newx() and friends replace the older New() API, and drops
2160 the first parameter, I<x>, a debug aid which allowed callers to identify
2161 themselves. This aid has been superseded by a new build option,
2162 PERL_MEM_LOG (see L<perlhack/PERL_MEM_LOG>). The older API is still
2163 there for use in XS modules supporting older perls.
2165 void Newx(void* ptr, int nitems, type)
2168 Found in file handy.h
2173 The XSUB-writer's interface to the C C<malloc> function, with
2174 cast. See also C<Newx>.
2176 void Newxc(void* ptr, int nitems, type, cast)
2179 Found in file handy.h
2184 The XSUB-writer's interface to the C C<malloc> function. The allocated
2185 memory is zeroed with C<memzero>. See also C<Newx>.
2187 void Newxz(void* ptr, int nitems, type)
2190 Found in file handy.h
2195 PoisonWith(0xEF) for catching access to freed memory.
2197 void Poison(void* dest, int nitems, type)
2200 Found in file handy.h
2205 PoisonWith(0xEF) for catching access to freed memory.
2207 void PoisonFree(void* dest, int nitems, type)
2210 Found in file handy.h
2215 PoisonWith(0xAB) for catching access to allocated but uninitialized memory.
2217 void PoisonNew(void* dest, int nitems, type)
2220 Found in file handy.h
2225 Fill up memory with a byte pattern (a byte repeated over and over
2226 again) that hopefully catches attempts to access uninitialized memory.
2228 void PoisonWith(void* dest, int nitems, type, U8 byte)
2231 Found in file handy.h
2236 The XSUB-writer's interface to the C C<realloc> function.
2238 void Renew(void* ptr, int nitems, type)
2241 Found in file handy.h
2246 The XSUB-writer's interface to the C C<realloc> function, with
2249 void Renewc(void* ptr, int nitems, type, cast)
2252 Found in file handy.h
2257 The XSUB-writer's interface to the C C<free> function.
2259 void Safefree(void* ptr)
2262 Found in file handy.h
2267 Perl's version of C<strdup()>. Returns a pointer to a newly allocated
2268 string which is a duplicate of C<pv>. The size of the string is
2269 determined by C<strlen()>. The memory allocated for the new string can
2270 be freed with the C<Safefree()> function.
2272 char* savepv(const char* pv)
2275 Found in file util.c
2280 Perl's version of what C<strndup()> would be if it existed. Returns a
2281 pointer to a newly allocated string which is a duplicate of the first
2282 C<len> bytes from C<pv>, plus a trailing NUL byte. The memory allocated for
2283 the new string can be freed with the C<Safefree()> function.
2285 char* savepvn(const char* pv, I32 len)
2288 Found in file util.c
2293 Like C<savepvn>, but takes a literal string instead of a string/length pair.
2295 char* savepvs(const char* s)
2298 Found in file handy.h
2303 A version of C<savepv()> which allocates the duplicate string in memory
2304 which is shared between threads.
2306 char* savesharedpv(const char* pv)
2309 Found in file util.c
2314 A version of C<savepvn()> which allocates the duplicate string in memory
2315 which is shared between threads. (With the specific difference that a NULL
2316 pointer is not acceptable)
2318 char* savesharedpvn(const char *const pv, const STRLEN len)
2321 Found in file util.c
2326 A version of C<savepv()>/C<savepvn()> which gets the string to duplicate from
2327 the passed in SV using C<SvPV()>
2329 char* savesvpv(SV* sv)
2332 Found in file util.c
2337 This is an architecture-independent macro to copy one structure to another.
2339 void StructCopy(type src, type dest, type)
2342 Found in file handy.h
2347 The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the
2348 destination, C<nitems> is the number of items, and C<type> is the type.
2350 void Zero(void* dest, int nitems, type)
2353 Found in file handy.h
2358 Like C<Zero> but returns dest. Useful for encouraging compilers to tail-call
2361 void * ZeroD(void* dest, int nitems, type)
2364 Found in file handy.h
2369 =head1 Miscellaneous Functions
2376 Analyses the string in order to make fast searches on it using fbm_instr()
2377 -- the Boyer-Moore algorithm.
2379 void fbm_compile(SV* sv, U32 flags)
2382 Found in file util.c
2387 Returns the location of the SV in the string delimited by C<str> and
2388 C<strend>. It returns C<NULL> if the string can't be found. The C<sv>
2389 does not have to be fbm_compiled, but the search will not be as fast
2392 char* fbm_instr(unsigned char* big, unsigned char* bigend, SV* littlesv, U32 flags)
2395 Found in file util.c
2400 Takes a sprintf-style format pattern and conventional
2401 (non-SV) arguments and returns the formatted string.
2403 (char *) Perl_form(pTHX_ const char* pat, ...)
2405 can be used any place a string (char *) is required:
2407 char * s = Perl_form("%d.%d",major,minor);
2409 Uses a single private buffer so if you want to format several strings you
2410 must explicitly copy the earlier strings away (and free the copies when you
2413 char* form(const char* pat, ...)
2416 Found in file util.c
2421 Fill the sv with current working directory
2423 int getcwd_sv(SV* sv)
2426 Found in file util.c
2431 The C library C<snprintf> functionality, if available and
2432 standards-compliant (uses C<vsnprintf>, actually). However, if the
2433 C<vsnprintf> is not available, will unfortunately use the unsafe
2434 C<vsprintf> which can overrun the buffer (there is an overrun check,
2435 but that may be too late). Consider using C<sv_vcatpvf> instead, or
2436 getting C<vsnprintf>.
2438 int my_snprintf(char *buffer, const Size_t len, const char *format, ...)
2441 Found in file util.c
2446 The C library C<sprintf>, wrapped if necessary, to ensure that it will return
2447 the length of the string written to the buffer. Only rare pre-ANSI systems
2448 need the wrapper function - usually this is a direct call to C<sprintf>.
2450 int my_sprintf(char *buffer, const char *pat, ...)
2453 Found in file util.c
2458 The C library C<vsnprintf> if available and standards-compliant.
2459 However, if if the C<vsnprintf> is not available, will unfortunately
2460 use the unsafe C<vsprintf> which can overrun the buffer (there is an
2461 overrun check, but that may be too late). Consider using
2462 C<sv_vcatpvf> instead, or getting C<vsnprintf>.
2464 int my_vsnprintf(char *buffer, const Size_t len, const char *format, va_list ap)
2467 Found in file util.c
2472 Returns a new version object based on the passed in SV:
2474 SV *sv = new_version(SV *ver);
2476 Does not alter the passed in ver SV. See "upg_version" if you
2477 want to upgrade the SV.
2479 SV* new_version(SV *ver)
2482 Found in file util.c
2487 Returns a pointer to the next character after the parsed
2488 version string, as well as upgrading the passed in SV to
2491 Function must be called with an already existing SV like
2494 s = scan_version(s, SV *sv, bool qv);
2496 Performs some preprocessing to the string to ensure that
2497 it has the correct characteristics of a version. Flags the
2498 object if it contains an underscore (which denotes this
2499 is an alpha version). The boolean qv denotes that the version
2500 should be interpreted as if it had multiple decimals, even if
2503 const char* scan_version(const char *vstr, SV *sv, bool qv)
2506 Found in file util.c
2511 Test two strings to see if they are equal. Returns true or false.
2513 bool strEQ(char* s1, char* s2)
2516 Found in file handy.h
2521 Test two strings to see if the first, C<s1>, is greater than or equal to
2522 the second, C<s2>. Returns true or false.
2524 bool strGE(char* s1, char* s2)
2527 Found in file handy.h
2532 Test two strings to see if the first, C<s1>, is greater than the second,
2533 C<s2>. Returns true or false.
2535 bool strGT(char* s1, char* s2)
2538 Found in file handy.h
2543 Test two strings to see if the first, C<s1>, is less than or equal to the
2544 second, C<s2>. Returns true or false.
2546 bool strLE(char* s1, char* s2)
2549 Found in file handy.h
2554 Test two strings to see if the first, C<s1>, is less than the second,
2555 C<s2>. Returns true or false.
2557 bool strLT(char* s1, char* s2)
2560 Found in file handy.h
2565 Test two strings to see if they are different. Returns true or
2568 bool strNE(char* s1, char* s2)
2571 Found in file handy.h
2576 Test two strings to see if they are equal. The C<len> parameter indicates
2577 the number of bytes to compare. Returns true or false. (A wrapper for
2580 bool strnEQ(char* s1, char* s2, STRLEN len)
2583 Found in file handy.h
2588 Test two strings to see if they are different. The C<len> parameter
2589 indicates the number of bytes to compare. Returns true or false. (A
2590 wrapper for C<strncmp>).
2592 bool strnNE(char* s1, char* s2, STRLEN len)
2595 Found in file handy.h
2597 =item sv_destroyable
2600 Dummy routine which reports that object can be destroyed when there is no
2601 sharing module present. It ignores its single SV argument, and returns
2602 'true'. Exists to avoid test for a NULL function pointer and because it
2603 could potentially warn under some level of strict-ness.
2605 bool sv_destroyable(SV *sv)
2608 Found in file util.c
2613 Dummy routine which "shares" an SV when there is no sharing module present.
2614 Or "locks" it. Or "unlocks" it. In other words, ignores its single SV argument.
2615 Exists to avoid test for a NULL function pointer and because it could
2616 potentially warn under some level of strict-ness.
2618 void sv_nosharing(SV *sv)
2621 Found in file util.c
2626 In-place upgrade of the supplied SV to a version object.
2628 SV *sv = upg_version(SV *sv, bool qv);
2630 Returns a pointer to the upgraded SV. Set the boolean qv if you want
2631 to force this SV to be interpreted as an "extended" version.
2633 SV* upg_version(SV *ver, bool qv)
2636 Found in file util.c
2641 Version object aware cmp. Both operands must already have been
2642 converted into version objects.
2644 int vcmp(SV *lvs, SV *rvs)
2647 Found in file util.c
2652 Accepts a version object and returns the normalized string
2653 representation. Call like:
2657 NOTE: you can pass either the object directly or the SV
2658 contained within the RV.
2663 Found in file util.c
2668 Accepts a version object and returns the normalized floating
2669 point representation. Call like:
2673 NOTE: you can pass either the object directly or the SV
2674 contained within the RV.
2679 Found in file util.c
2684 In order to maintain maximum compatibility with earlier versions
2685 of Perl, this function will return either the floating point
2686 notation or the multiple dotted notation, depending on whether
2687 the original version contained 1 or more dots, respectively
2689 SV* vstringify(SV *vs)
2692 Found in file util.c
2697 Validates that the SV contains a valid version object.
2699 bool vverify(SV *vobj);
2701 Note that it only confirms the bare minimum structure (so as not to get
2702 confused by derived classes which may contain additional hash entries):
2704 bool vverify(SV *vs)
2707 Found in file util.c
2712 =head1 MRO Functions
2716 =item mro_get_linear_isa
2717 X<mro_get_linear_isa>
2719 Returns either C<mro_get_linear_isa_c3> or
2720 C<mro_get_linear_isa_dfs> for the given stash,
2721 dependant upon which MRO is in effect
2722 for that stash. The return value is a
2725 You are responsible for C<SvREFCNT_inc()> on the
2726 return value if you plan to store it anywhere
2727 semi-permanently (otherwise it might be deleted
2728 out from under you the next time the cache is
2731 AV* mro_get_linear_isa(HV* stash)
2736 =item mro_method_changed_in
2737 X<mro_method_changed_in>
2739 Invalidates method caching on any child classes
2740 of the given stash, so that they might notice
2741 the changes in this one.
2743 Ideally, all instances of C<PL_sub_generation++> in
2744 perl source outside of C<mro.c> should be
2745 replaced by calls to this.
2747 Perl automatically handles most of the common
2748 ways a method might be redefined. However, there
2749 are a few ways you could change a method in a stash
2750 without the cache code noticing, in which case you
2751 need to call this method afterwards:
2753 1) Directly manipulating the stash HV entries from
2756 2) Assigning a reference to a readonly scalar
2757 constant into a stash entry in order to create
2758 a constant subroutine (like constant.pm
2761 This same method is available from pure perl
2762 via, C<mro::method_changed_in(classname)>.
2764 void mro_method_changed_in(HV* stash)
2772 =head1 Multicall Functions
2779 Declare local variables for a multicall. See L<perlcall/Lightweight Callbacks>.
2789 Make a lightweight callback. See L<perlcall/Lightweight Callbacks>.
2799 Closing bracket for a lightweight callback.
2800 See L<perlcall/Lightweight Callbacks>.
2807 =item PUSH_MULTICALL
2810 Opening bracket for a lightweight callback.
2811 See L<perlcall/Lightweight Callbacks>.
2821 =head1 Numeric functions
2828 converts a string representing a binary number to numeric form.
2830 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2831 conversion flags, and I<result> should be NULL or a pointer to an NV.
2832 The scan stops at the end of the string, or the first invalid character.
2833 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2834 invalid character will also trigger a warning.
2835 On return I<*len> is set to the length of the scanned string,
2836 and I<*flags> gives output flags.
2838 If the value is <= C<UV_MAX> it is returned as a UV, the output flags are clear,
2839 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_bin>
2840 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2841 and writes the value to I<*result> (or the value is discarded if I<result>
2844 The binary number may optionally be prefixed with "0b" or "b" unless
2845 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
2846 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the binary
2847 number may use '_' characters to separate digits.
2849 UV grok_bin(const char* start, STRLEN* len_p, I32* flags, NV *result)
2852 Found in file numeric.c
2857 converts a string representing a hex number to numeric form.
2859 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2860 conversion flags, and I<result> should be NULL or a pointer to an NV.
2861 The scan stops at the end of the string, or the first invalid character.
2862 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2863 invalid character will also trigger a warning.
2864 On return I<*len> is set to the length of the scanned string,
2865 and I<*flags> gives output flags.
2867 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2868 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_hex>
2869 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2870 and writes the value to I<*result> (or the value is discarded if I<result>
2873 The hex number may optionally be prefixed with "0x" or "x" unless
2874 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
2875 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the hex
2876 number may use '_' characters to separate digits.
2878 UV grok_hex(const char* start, STRLEN* len_p, I32* flags, NV *result)
2881 Found in file numeric.c
2886 Recognise (or not) a number. The type of the number is returned
2887 (0 if unrecognised), otherwise it is a bit-ORed combination of
2888 IS_NUMBER_IN_UV, IS_NUMBER_GREATER_THAN_UV_MAX, IS_NUMBER_NOT_INT,
2889 IS_NUMBER_NEG, IS_NUMBER_INFINITY, IS_NUMBER_NAN (defined in perl.h).
2891 If the value of the number can fit an in UV, it is returned in the *valuep
2892 IS_NUMBER_IN_UV will be set to indicate that *valuep is valid, IS_NUMBER_IN_UV
2893 will never be set unless *valuep is valid, but *valuep may have been assigned
2894 to during processing even though IS_NUMBER_IN_UV is not set on return.
2895 If valuep is NULL, IS_NUMBER_IN_UV will be set for the same cases as when
2896 valuep is non-NULL, but no actual assignment (or SEGV) will occur.
2898 IS_NUMBER_NOT_INT will be set with IS_NUMBER_IN_UV if trailing decimals were
2899 seen (in which case *valuep gives the true value truncated to an integer), and
2900 IS_NUMBER_NEG if the number is negative (in which case *valuep holds the
2901 absolute value). IS_NUMBER_IN_UV is not set if e notation was used or the
2902 number is larger than a UV.
2904 int grok_number(const char *pv, STRLEN len, UV *valuep)
2907 Found in file numeric.c
2909 =item grok_numeric_radix
2910 X<grok_numeric_radix>
2912 Scan and skip for a numeric decimal separator (radix).
2914 bool grok_numeric_radix(const char **sp, const char *send)
2917 Found in file numeric.c
2922 converts a string representing an octal number to numeric form.
2924 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2925 conversion flags, and I<result> should be NULL or a pointer to an NV.
2926 The scan stops at the end of the string, or the first invalid character.
2927 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2928 invalid character will also trigger a warning.
2929 On return I<*len> is set to the length of the scanned string,
2930 and I<*flags> gives output flags.
2932 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2933 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_oct>
2934 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2935 and writes the value to I<*result> (or the value is discarded if I<result>
2938 If C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the octal
2939 number may use '_' characters to separate digits.
2941 UV grok_oct(const char* start, STRLEN* len_p, I32* flags, NV *result)
2944 Found in file numeric.c
2949 Return a non-zero integer if the sign bit on an NV is set, and 0 if
2952 If Configure detects this system has a signbit() that will work with
2953 our NVs, then we just use it via the #define in perl.h. Otherwise,
2954 fall back on this implementation. As a first pass, this gets everything
2955 right except -0.0. Alas, catching -0.0 is the main use for this function,
2956 so this is not too helpful yet. Still, at least we have the scaffolding
2957 in place to support other systems, should that prove useful.
2960 Configure notes: This function is called 'Perl_signbit' instead of a
2961 plain 'signbit' because it is easy to imagine a system having a signbit()
2962 function or macro that doesn't happen to work with our particular choice
2963 of NVs. We shouldn't just re-#define signbit as Perl_signbit and expect
2964 the standard system headers to be happy. Also, this is a no-context
2965 function (no pTHX_) because Perl_signbit() is usually re-#defined in
2966 perl.h as a simple macro call to the system's signbit().
2967 Users should just always call Perl_signbit().
2969 NOTE: this function is experimental and may change or be
2970 removed without notice.
2972 int Perl_signbit(NV f)
2975 Found in file numeric.c
2980 For backwards compatibility. Use C<grok_bin> instead.
2982 NV scan_bin(const char* start, STRLEN len, STRLEN* retlen)
2985 Found in file numeric.c
2990 For backwards compatibility. Use C<grok_hex> instead.
2992 NV scan_hex(const char* start, STRLEN len, STRLEN* retlen)
2995 Found in file numeric.c
3000 For backwards compatibility. Use C<grok_oct> instead.
3002 NV scan_oct(const char* start, STRLEN len, STRLEN* retlen)
3005 Found in file numeric.c
3010 =head1 Optree Manipulation Functions
3017 If C<cv> is a constant sub eligible for inlining. returns the constant
3018 value returned by the sub. Otherwise, returns NULL.
3020 Constant subs can be created with C<newCONSTSUB> or as described in
3021 L<perlsub/"Constant Functions">.
3023 SV* cv_const_sv(CV* cv)
3031 Creates a constant sub equivalent to Perl C<sub FOO () { 123 }> which is
3032 eligible for inlining at compile-time.
3034 CV* newCONSTSUB(HV* stash, const char* name, SV* sv)
3042 Used by C<xsubpp> to hook up XSUBs as Perl subs. I<filename> needs to be
3043 static storage, as it is used directly as CvFILE(), without a copy being made.
3051 =head1 Pad Data Structures
3058 Get the value at offset po in the current pad.
3059 Use macro PAD_SV instead of calling this function directly.
3061 SV* pad_sv(PADOFFSET po)
3069 =head1 Per-Interpreter Variables
3076 C<PL_modglobal> is a general purpose, interpreter global HV for use by
3077 extensions that need to keep information on a per-interpreter basis.
3078 In a pinch, it can also be used as a symbol table for extensions
3079 to share data among each other. It is a good idea to use keys
3080 prefixed by the package name of the extension that owns the data.
3085 Found in file intrpvar.h
3090 A convenience variable which is typically used with C<SvPV> when one
3091 doesn't care about the length of the string. It is usually more efficient
3092 to either declare a local variable and use that instead or to use the
3093 C<SvPV_nolen> macro.
3098 Found in file intrpvar.h
3103 This is the C<false> SV. See C<PL_sv_yes>. Always refer to this as
3109 Found in file intrpvar.h
3114 This is the C<undef> SV. Always refer to this as C<&PL_sv_undef>.
3119 Found in file intrpvar.h
3124 This is the C<true> SV. See C<PL_sv_no>. Always refer to this as
3130 Found in file intrpvar.h
3135 =head1 REGEXP Functions
3142 Convenience macro to get the REGEXP from a SV. This is approximately
3143 equivalent to the following snippet:
3148 (tmpsv = (SV*)SvRV(sv)) &&
3149 SvTYPE(tmpsv) == SVt_PVMG &&
3150 (tmpmg = mg_find(tmpsv, PERL_MAGIC_qr)))
3152 return (REGEXP *)tmpmg->mg_obj;
3155 NULL will be returned if a REGEXP* is not found.
3157 REGEXP * SvRX(SV *sv)
3160 Found in file regexp.h
3165 Returns a boolean indicating whether the SV contains qr magic
3168 If you want to do something with the REGEXP* later use SvRX instead
3174 Found in file regexp.h
3179 =head1 Simple Exception Handling Macros
3186 Set up necessary local variables for exception handling.
3187 See L<perlguts/"Exception Handling">.
3192 Found in file XSUB.h
3197 Introduces a catch block. See L<perlguts/"Exception Handling">.
3200 Found in file XSUB.h
3205 Rethrows a previously caught exception. See L<perlguts/"Exception Handling">.
3210 Found in file XSUB.h
3215 Ends a try block. See L<perlguts/"Exception Handling">.
3218 Found in file XSUB.h
3220 =item XCPT_TRY_START
3223 Starts a try block. See L<perlguts/"Exception Handling">.
3226 Found in file XSUB.h
3231 =head1 Stack Manipulation Macros
3238 Declare a stack marker variable, C<mark>, for the XSUB. See C<MARK> and
3249 Saves the original stack mark for the XSUB. See C<ORIGMARK>.
3259 Declares a local copy of perl's stack pointer for the XSUB, available via
3260 the C<SP> macro. See C<SP>.
3270 Used to extend the argument stack for an XSUB's return values. Once
3271 used, guarantees that there is room for at least C<nitems> to be pushed
3274 void EXTEND(SP, int nitems)
3282 Stack marker variable for the XSUB. See C<dMARK>.
3290 Push an integer onto the stack. The stack must have room for this element.
3291 Handles 'set' magic. Does not use C<TARG>. See also C<PUSHi>, C<mXPUSHi>
3302 Push a double onto the stack. The stack must have room for this element.
3303 Handles 'set' magic. Does not use C<TARG>. See also C<PUSHn>, C<mXPUSHn>
3314 Push a string onto the stack. The stack must have room for this element.
3315 The C<len> indicates the length of the string. Handles 'set' magic. Does
3316 not use C<TARG>. See also C<PUSHp>, C<mXPUSHp> and C<XPUSHp>.
3318 void mPUSHp(char* str, STRLEN len)
3326 Push an unsigned integer onto the stack. The stack must have room for this
3327 element. Handles 'set' magic. Does not use C<TARG>. See also C<PUSHu>,
3328 C<mXPUSHu> and C<XPUSHu>.
3338 Push an integer onto the stack, extending the stack if necessary. Handles
3339 'set' magic. Does not use C<TARG>. See also C<XPUSHi>, C<mPUSHi> and
3350 Push a double onto the stack, extending the stack if necessary. Handles
3351 'set' magic. Does not use C<TARG>. See also C<XPUSHn>, C<mPUSHn> and
3362 Push a string onto the stack, extending the stack if necessary. The C<len>
3363 indicates the length of the string. Handles 'set' magic. Does not use
3364 C<TARG>. See also C<XPUSHp>, C<mPUSHp> and C<PUSHp>.
3366 void mXPUSHp(char* str, STRLEN len)
3374 Push an unsigned integer onto the stack, extending the stack if necessary.
3375 Handles 'set' magic. Does not use C<TARG>. See also C<XPUSHu>, C<mPUSHu>
3386 The original stack mark for the XSUB. See C<dORIGMARK>.
3394 Pops an integer off the stack.
3404 Pops a long off the stack.
3414 Pops a double off the stack.
3424 Pops a string off the stack. Deprecated. New code should use POPpx.
3434 Pops a string off the stack which must consist of bytes i.e. characters < 256.
3444 Pops a string off the stack.
3454 Pops an SV off the stack.
3464 Push an integer onto the stack. The stack must have room for this element.
3465 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3466 called to declare it. Do not call multiple C<TARG>-oriented macros to
3467 return lists from XSUB's - see C<mPUSHi> instead. See also C<XPUSHi> and
3478 Opening bracket for arguments on a callback. See C<PUTBACK> and
3489 Push a new mortal SV onto the stack. The stack must have room for this
3490 element. Does not handle 'set' magic. Does not use C<TARG>. See also
3491 C<PUSHs>, C<XPUSHmortal> and C<XPUSHs>.
3501 Push a double onto the stack. The stack must have room for this element.
3502 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3503 called to declare it. Do not call multiple C<TARG>-oriented macros to
3504 return lists from XSUB's - see C<mPUSHn> instead. See also C<XPUSHn> and
3515 Push a string onto the stack. The stack must have room for this element.
3516 The C<len> indicates the length of the string. Handles 'set' magic. Uses
3517 C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to declare it. Do not
3518 call multiple C<TARG>-oriented macros to return lists from XSUB's - see
3519 C<mPUSHp> instead. See also C<XPUSHp> and C<mXPUSHp>.
3521 void PUSHp(char* str, STRLEN len)
3529 Push an SV onto the stack. The stack must have room for this element.
3530 Does not handle 'set' magic. Does not use C<TARG>. See also C<PUSHmortal>,
3531 C<XPUSHs> and C<XPUSHmortal>.
3541 Push an unsigned integer onto the stack. The stack must have room for this
3542 element. Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG>
3543 should be called to declare it. Do not call multiple C<TARG>-oriented
3544 macros to return lists from XSUB's - see C<mPUSHu> instead. See also
3545 C<XPUSHu> and C<mXPUSHu>.
3555 Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
3556 See C<PUSHMARK> and L<perlcall> for other uses.
3566 Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and
3575 Refetch the stack pointer. Used after a callback. See L<perlcall>.
3585 Push an integer onto the stack, extending the stack if necessary. Handles
3586 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
3587 declare it. Do not call multiple C<TARG>-oriented macros to return lists
3588 from XSUB's - see C<mXPUSHi> instead. See also C<PUSHi> and C<mPUSHi>.
3598 Push a new mortal SV onto the stack, extending the stack if necessary. Does
3599 not handle 'set' magic. Does not use C<TARG>. See also C<XPUSHs>,
3600 C<PUSHmortal> and C<PUSHs>.
3610 Push a double onto the stack, extending the stack if necessary. Handles
3611 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
3612 declare it. Do not call multiple C<TARG>-oriented macros to return lists
3613 from XSUB's - see C<mXPUSHn> instead. See also C<PUSHn> and C<mPUSHn>.
3623 Push a string onto the stack, extending the stack if necessary. The C<len>
3624 indicates the length of the string. Handles 'set' magic. Uses C<TARG>, so
3625 C<dTARGET> or C<dXSTARG> should be called to declare it. Do not call
3626 multiple C<TARG>-oriented macros to return lists from XSUB's - see
3627 C<mXPUSHp> instead. See also C<PUSHp> and C<mPUSHp>.
3629 void XPUSHp(char* str, STRLEN len)
3637 Push an SV onto the stack, extending the stack if necessary. Does not
3638 handle 'set' magic. Does not use C<TARG>. See also C<XPUSHmortal>,
3639 C<PUSHs> and C<PUSHmortal>.
3649 Push an unsigned integer onto the stack, extending the stack if necessary.
3650 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3651 called to declare it. Do not call multiple C<TARG>-oriented macros to
3652 return lists from XSUB's - see C<mXPUSHu> instead. See also C<PUSHu> and
3663 Return from XSUB, indicating number of items on the stack. This is usually
3664 handled by C<xsubpp>.
3666 void XSRETURN(int nitems)
3669 Found in file XSUB.h
3671 =item XSRETURN_EMPTY
3674 Return an empty list from an XSUB immediately.
3679 Found in file XSUB.h
3684 Return an integer from an XSUB immediately. Uses C<XST_mIV>.
3686 void XSRETURN_IV(IV iv)
3689 Found in file XSUB.h
3694 Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
3699 Found in file XSUB.h
3704 Return a double from an XSUB immediately. Uses C<XST_mNV>.
3706 void XSRETURN_NV(NV nv)
3709 Found in file XSUB.h
3714 Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
3716 void XSRETURN_PV(char* str)
3719 Found in file XSUB.h
3721 =item XSRETURN_UNDEF
3724 Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
3729 Found in file XSUB.h
3734 Return an integer from an XSUB immediately. Uses C<XST_mUV>.
3736 void XSRETURN_UV(IV uv)
3739 Found in file XSUB.h
3744 Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
3749 Found in file XSUB.h
3754 Place an integer into the specified position C<pos> on the stack. The
3755 value is stored in a new mortal SV.
3757 void XST_mIV(int pos, IV iv)
3760 Found in file XSUB.h
3765 Place C<&PL_sv_no> into the specified position C<pos> on the
3768 void XST_mNO(int pos)
3771 Found in file XSUB.h
3776 Place a double into the specified position C<pos> on the stack. The value
3777 is stored in a new mortal SV.
3779 void XST_mNV(int pos, NV nv)
3782 Found in file XSUB.h
3787 Place a copy of a string into the specified position C<pos> on the stack.
3788 The value is stored in a new mortal SV.
3790 void XST_mPV(int pos, char* str)
3793 Found in file XSUB.h
3798 Place C<&PL_sv_undef> into the specified position C<pos> on the
3801 void XST_mUNDEF(int pos)
3804 Found in file XSUB.h
3809 Place C<&PL_sv_yes> into the specified position C<pos> on the
3812 void XST_mYES(int pos)
3815 Found in file XSUB.h
3827 An enum of flags for Perl types. These are found in the file B<sv.h>
3828 in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
3836 Integer type flag for scalars. See C<svtype>.
3844 Double type flag for scalars. See C<svtype>.
3852 Pointer type flag for scalars. See C<svtype>.
3860 Type flag for arrays. See C<svtype>.
3868 Type flag for code refs. See C<svtype>.
3876 Type flag for hashes. See C<svtype>.
3884 Type flag for blessed scalars. See C<svtype>.
3892 =head1 SV Manipulation Functions
3899 Returns the SV of the specified Perl scalar. If C<create> is set and the
3900 Perl variable does not exist then it will be created. If C<create> is not
3901 set and the variable does not exist then NULL is returned.
3903 NOTE: the perl_ form of this function is deprecated.
3905 SV* get_sv(const char* name, I32 create)
3908 Found in file perl.c
3913 Creates an RV wrapper for an SV. The reference count for the original SV is
3916 SV* newRV_inc(SV* sv)
3924 Returns the length of the string which is in the SV. See C<SvLEN>.
3926 STRLEN SvCUR(SV* sv)
3934 Set the current length of the string which is in the SV. See C<SvCUR>
3937 void SvCUR_set(SV* sv, STRLEN len)
3945 Returns a pointer to the last character in the string which is in the SV.
3946 See C<SvCUR>. Access the character as *(SvEND(sv)).
3956 Returns true if the SV has get magic or overloading. If either is true then
3957 the scalar is active data, and has the potential to return a new value every
3958 time it is accessed. Hence you must be careful to only read it once per user
3959 logical operation and work with that returned value. If neither is true then
3960 the scalar's value cannot change unless written to.
3962 char* SvGAMAGIC(SV* sv)
3970 Expands the character buffer in the SV so that it has room for the
3971 indicated number of bytes (remember to reserve space for an extra trailing
3972 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
3973 Returns a pointer to the character buffer.
3975 char * SvGROW(SV* sv, STRLEN len)
3983 Returns a U32 value indicating whether the SV contains an integer.
3993 Returns a U32 value indicating whether the SV contains an integer. Checks
3994 the B<private> setting. Use C<SvIOK>.
4004 Returns a boolean indicating whether the SV contains a signed integer.
4006 bool SvIOK_notUV(SV* sv)
4014 Unsets the IV status of an SV.
4016 void SvIOK_off(SV* sv)
4024 Tells an SV that it is an integer.
4026 void SvIOK_on(SV* sv)
4034 Tells an SV that it is an integer and disables all other OK bits.
4036 void SvIOK_only(SV* sv)
4044 Tells and SV that it is an unsigned integer and disables all other OK bits.
4046 void SvIOK_only_UV(SV* sv)
4054 Returns a boolean indicating whether the SV contains an unsigned integer.
4056 bool SvIOK_UV(SV* sv)
4064 Returns a boolean indicating whether the SV is Copy-On-Write. (either shared
4065 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
4068 bool SvIsCOW(SV* sv)
4073 =item SvIsCOW_shared_hash
4074 X<SvIsCOW_shared_hash>
4076 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
4079 bool SvIsCOW_shared_hash(SV* sv)
4087 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
4088 version which guarantees to evaluate sv only once.
4098 Returns the raw value in the SV's IV slot, without checks or conversions.
4099 Only use when you are sure SvIOK is true. See also C<SvIV()>.
4109 Coerces the given SV to an integer and returns it. Guarantees to evaluate
4110 C<sv> only once. Only use this if C<sv> is an expression with side effects,
4111 otherwise use the more efficient C<SvIV>.
4121 Like C<SvIV> but doesn't process magic.
4123 IV SvIV_nomg(SV* sv)
4131 Set the value of the IV pointer in sv to val. It is possible to perform
4132 the same function of this macro with an lvalue assignment to C<SvIVX>.
4133 With future Perls, however, it will be more efficient to use
4134 C<SvIV_set> instead of the lvalue assignment to C<SvIVX>.
4136 void SvIV_set(SV* sv, IV val)
4144 Returns the size of the string buffer in the SV, not including any part
4145 attributable to C<SvOOK>. See C<SvCUR>.
4147 STRLEN SvLEN(SV* sv)
4155 Set the actual length of the string which is in the SV. See C<SvIV_set>.
4157 void SvLEN_set(SV* sv, STRLEN len)
4165 Set the value of the MAGIC pointer in sv to val. See C<SvIV_set>.
4167 void SvMAGIC_set(SV* sv, MAGIC* val)
4175 Returns a U32 value indicating whether the SV contains a number, integer or
4186 Returns a U32 value indicating whether the SV contains a number, integer or
4187 double. Checks the B<private> setting. Use C<SvNIOK>.
4197 Unsets the NV/IV status of an SV.
4199 void SvNIOK_off(SV* sv)
4207 Returns a U32 value indicating whether the SV contains a double.
4217 Returns a U32 value indicating whether the SV contains a double. Checks the
4218 B<private> setting. Use C<SvNOK>.
4228 Unsets the NV status of an SV.
4230 void SvNOK_off(SV* sv)
4238 Tells an SV that it is a double.
4240 void SvNOK_on(SV* sv)
4248 Tells an SV that it is a double and disables all other OK bits.
4250 void SvNOK_only(SV* sv)
4258 Coerce the given SV to a double and return it. See C<SvNVx> for a version
4259 which guarantees to evaluate sv only once.
4269 Returns the raw value in the SV's NV slot, without checks or conversions.
4270 Only use when you are sure SvNOK is true. See also C<SvNV()>.
4280 Coerces the given SV to a double and returns it. Guarantees to evaluate
4281 C<sv> only once. Only use this if C<sv> is an expression with side effects,
4282 otherwise use the more efficient C<SvNV>.
4292 Set the value of the NV pointer in sv to val. See C<SvIV_set>.
4294 void SvNV_set(SV* sv, NV val)
4302 Returns a U32 value indicating whether the value is an SV. It also tells
4303 whether the value is defined or not.
4313 Returns a U32 indicating whether the SvIVX is a valid offset value for
4314 the SvPVX. This hack is used internally to speed up removal of characters
4315 from the beginning of a SvPV. When SvOOK is true, then the start of the
4316 allocated string buffer is really (SvPVX - SvIVX).
4326 Returns a U32 value indicating whether the SV contains a character
4337 Returns a U32 value indicating whether the SV contains a character string.
4338 Checks the B<private> setting. Use C<SvPOK>.
4348 Unsets the PV status of an SV.
4350 void SvPOK_off(SV* sv)
4358 Tells an SV that it is a string.
4360 void SvPOK_on(SV* sv)
4368 Tells an SV that it is a string and disables all other OK bits.
4369 Will also turn off the UTF-8 status.
4371 void SvPOK_only(SV* sv)
4376 =item SvPOK_only_UTF8
4379 Tells an SV that it is a string and disables all other OK bits,
4380 and leaves the UTF-8 status as it was.
4382 void SvPOK_only_UTF8(SV* sv)
4390 Returns a pointer to the string in the SV, or a stringified form of
4391 the SV if the SV does not contain a string. The SV may cache the
4392 stringified version becoming C<SvPOK>. Handles 'get' magic. See also
4393 C<SvPVx> for a version which guarantees to evaluate sv only once.
4395 char* SvPV(SV* sv, STRLEN len)
4403 Like C<SvPV>, but converts sv to byte representation first if necessary.
4405 char* SvPVbyte(SV* sv, STRLEN len)
4413 Like C<SvPV>, but converts sv to byte representation first if necessary.
4414 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
4417 char* SvPVbytex(SV* sv, STRLEN len)
4422 =item SvPVbytex_force
4425 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
4426 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
4429 char* SvPVbytex_force(SV* sv, STRLEN len)
4434 =item SvPVbyte_force
4437 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
4439 char* SvPVbyte_force(SV* sv, STRLEN len)
4444 =item SvPVbyte_nolen
4447 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
4449 char* SvPVbyte_nolen(SV* sv)
4457 Like C<SvPV>, but converts sv to utf8 first if necessary.
4459 char* SvPVutf8(SV* sv, STRLEN len)
4467 Like C<SvPV>, but converts sv to utf8 first if necessary.
4468 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
4471 char* SvPVutf8x(SV* sv, STRLEN len)
4476 =item SvPVutf8x_force
4479 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
4480 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
4483 char* SvPVutf8x_force(SV* sv, STRLEN len)
4488 =item SvPVutf8_force
4491 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
4493 char* SvPVutf8_force(SV* sv, STRLEN len)
4498 =item SvPVutf8_nolen
4501 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
4503 char* SvPVutf8_nolen(SV* sv)
4511 Returns a pointer to the physical string in the SV. The SV must contain a
4522 A version of C<SvPV> which guarantees to evaluate C<sv> only once.
4523 Only use this if C<sv> is an expression with side effects, otherwise use the
4524 more efficient C<SvPVX>.
4526 char* SvPVx(SV* sv, STRLEN len)
4534 Like C<SvPV> but will force the SV into containing just a string
4535 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
4538 char* SvPV_force(SV* sv, STRLEN len)
4543 =item SvPV_force_nomg
4546 Like C<SvPV> but will force the SV into containing just a string
4547 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
4548 directly. Doesn't process magic.
4550 char* SvPV_force_nomg(SV* sv, STRLEN len)
4558 Returns a pointer to the string in the SV, or a stringified form of
4559 the SV if the SV does not contain a string. The SV may cache the
4560 stringified form becoming C<SvPOK>. Handles 'get' magic.
4562 char* SvPV_nolen(SV* sv)
4570 Like C<SvPV> but doesn't process magic.
4572 char* SvPV_nomg(SV* sv, STRLEN len)
4580 Set the value of the PV pointer in sv to val. See C<SvIV_set>.
4582 void SvPV_set(SV* sv, char* val)
4590 Returns the value of the object's reference count.
4592 U32 SvREFCNT(SV* sv)
4600 Decrements the reference count of the given SV.
4602 void SvREFCNT_dec(SV* sv)
4610 Increments the reference count of the given SV.
4612 All of the following SvREFCNT_inc* macros are optimized versions of
4613 SvREFCNT_inc, and can be replaced with SvREFCNT_inc.
4615 SV* SvREFCNT_inc(SV* sv)
4620 =item SvREFCNT_inc_NN
4623 Same as SvREFCNT_inc, but can only be used if you know I<sv>
4624 is not NULL. Since we don't have to check the NULLness, it's faster
4627 SV* SvREFCNT_inc_NN(SV* sv)
4632 =item SvREFCNT_inc_simple
4633 X<SvREFCNT_inc_simple>
4635 Same as SvREFCNT_inc, but can only be used with expressions without side
4636 effects. Since we don't have to store a temporary value, it's faster.
4638 SV* SvREFCNT_inc_simple(SV* sv)
4643 =item SvREFCNT_inc_simple_NN
4644 X<SvREFCNT_inc_simple_NN>
4646 Same as SvREFCNT_inc_simple, but can only be used if you know I<sv>
4647 is not NULL. Since we don't have to check the NULLness, it's faster
4650 SV* SvREFCNT_inc_simple_NN(SV* sv)
4655 =item SvREFCNT_inc_simple_void
4656 X<SvREFCNT_inc_simple_void>
4658 Same as SvREFCNT_inc_simple, but can only be used if you don't need the
4659 return value. The macro doesn't need to return a meaningful value.
4661 void SvREFCNT_inc_simple_void(SV* sv)
4666 =item SvREFCNT_inc_simple_void_NN
4667 X<SvREFCNT_inc_simple_void_NN>
4669 Same as SvREFCNT_inc, but can only be used if you don't need the return
4670 value, and you know that I<sv> is not NULL. The macro doesn't need
4671 to return a meaningful value, or check for NULLness, so it's smaller
4674 void SvREFCNT_inc_simple_void_NN(SV* sv)
4679 =item SvREFCNT_inc_void
4680 X<SvREFCNT_inc_void>
4682 Same as SvREFCNT_inc, but can only be used if you don't need the
4683 return value. The macro doesn't need to return a meaningful value.
4685 void SvREFCNT_inc_void(SV* sv)
4690 =item SvREFCNT_inc_void_NN
4691 X<SvREFCNT_inc_void_NN>
4693 Same as SvREFCNT_inc, but can only be used if you don't need the return
4694 value, and you know that I<sv> is not NULL. The macro doesn't need
4695 to return a meaningful value, or check for NULLness, so it's smaller
4698 void SvREFCNT_inc_void_NN(SV* sv)
4706 Tests if the SV is an RV.
4716 Unsets the RV status of an SV.
4718 void SvROK_off(SV* sv)
4726 Tells an SV that it is an RV.
4728 void SvROK_on(SV* sv)
4736 Dereferences an RV to return the SV.
4746 Set the value of the RV pointer in sv to val. See C<SvIV_set>.
4748 void SvRV_set(SV* sv, SV* val)
4756 Returns the stash of the SV.
4766 Set the value of the STASH pointer in sv to val. See C<SvIV_set>.
4768 void SvSTASH_set(SV* sv, HV* val)
4776 Taints an SV if tainting is enabled.
4778 void SvTAINT(SV* sv)
4786 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
4789 bool SvTAINTED(SV* sv)
4797 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
4798 some of Perl's fundamental security features. XS module authors should not
4799 use this function unless they fully understand all the implications of
4800 unconditionally untainting the value. Untainting should be done in the
4801 standard perl fashion, via a carefully crafted regexp, rather than directly
4802 untainting variables.
4804 void SvTAINTED_off(SV* sv)
4812 Marks an SV as tainted if tainting is enabled.
4814 void SvTAINTED_on(SV* sv)
4822 Returns a boolean indicating whether Perl would evaluate the SV as true or
4823 false, defined or undefined. Does not handle 'get' magic.
4833 Returns the type of the SV. See C<svtype>.
4835 svtype SvTYPE(SV* sv)
4843 Returns a boolean indicating whether the SV contains an unsigned integer.
4853 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
4854 perform the upgrade if necessary. See C<svtype>.
4856 void SvUPGRADE(SV* sv, svtype type)
4864 Returns a U32 value indicating whether the SV contains UTF-8 encoded data.
4865 Call this after SvPV() in case any call to string overloading updates the
4876 Unsets the UTF-8 status of an SV.
4878 void SvUTF8_off(SV *sv)
4886 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
4887 Do not use frivolously.
4889 void SvUTF8_on(SV *sv)
4897 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
4898 for a version which guarantees to evaluate sv only once.
4908 Returns the raw value in the SV's UV slot, without checks or conversions.
4909 Only use when you are sure SvIOK is true. See also C<SvUV()>.
4919 Coerces the given SV to an unsigned integer and returns it. Guarantees to
4920 C<sv> only once. Only use this if C<sv> is an expression with side effects,
4921 otherwise use the more efficient C<SvUV>.
4931 Like C<SvUV> but doesn't process magic.
4933 UV SvUV_nomg(SV* sv)
4941 Set the value of the UV pointer in sv to val. See C<SvIV_set>.
4943 void SvUV_set(SV* sv, UV val)
4951 Returns a boolean indicating whether the SV contains a v-string.
4958 =item sv_catpvn_nomg
4961 Like C<sv_catpvn> but doesn't process magic.
4963 void sv_catpvn_nomg(SV* sv, const char* ptr, STRLEN len)
4971 Like C<sv_catsv> but doesn't process magic.
4973 void sv_catsv_nomg(SV* dsv, SV* ssv)
4978 =item sv_derived_from
4981 Returns a boolean indicating whether the SV is derived from the specified class
4982 I<at the C level>. To check derivation at the Perl level, call C<isa()> as a
4985 bool sv_derived_from(SV* sv, const char* name)
4988 Found in file universal.c
4993 Returns a boolean indicating whether the SV performs a specific, named role.
4994 The SV can be a Perl object or the name of a Perl class.
4996 bool sv_does(SV* sv, const char* name)
4999 Found in file universal.c
5001 =item sv_report_used
5004 Dump the contents of all SVs not yet freed. (Debugging aid).
5006 void sv_report_used()
5014 Like C<sv_setsv> but doesn't process magic.
5016 void sv_setsv_nomg(SV* dsv, SV* ssv)
5024 =head1 SV-Body Allocation
5028 =item looks_like_number
5029 X<looks_like_number>
5031 Test if the content of an SV looks like a number (or is a number).
5032 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
5033 non-numeric warning), even if your atof() doesn't grok them.
5035 I32 looks_like_number(SV* sv)
5043 Creates an RV wrapper for an SV. The reference count for the original
5044 SV is B<not> incremented.
5046 SV* newRV_noinc(SV* sv)
5054 Creates a new SV. A non-zero C<len> parameter indicates the number of
5055 bytes of preallocated string space the SV should have. An extra byte for a
5056 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
5057 space is allocated.) The reference count for the new SV is set to 1.
5059 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
5060 parameter, I<x>, a debug aid which allowed callers to identify themselves.
5061 This aid has been superseded by a new build option, PERL_MEM_LOG (see
5062 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
5063 modules supporting older perls.
5065 SV* newSV(STRLEN len)
5073 Creates a new SV from the hash key structure. It will generate scalars that
5074 point to the shared string table where possible. Returns a new (undefined)
5075 SV if the hek is NULL.
5077 SV* newSVhek(const HEK *hek)
5085 Creates a new SV and copies an integer into it. The reference count for the
5096 Creates a new SV and copies a floating point value into it.
5097 The reference count for the SV is set to 1.
5107 Creates a new SV and copies a string into it. The reference count for the
5108 SV is set to 1. If C<len> is zero, Perl will compute the length using
5109 strlen(). For efficiency, consider using C<newSVpvn> instead.
5111 SV* newSVpv(const char* s, STRLEN len)
5119 Creates a new SV and initializes it with the string formatted like
5122 SV* newSVpvf(const char* pat, ...)
5130 Creates a new SV and copies a string into it. The reference count for the
5131 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
5132 string. You are responsible for ensuring that the source string is at least
5133 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
5135 SV* newSVpvn(const char* s, STRLEN len)
5140 =item newSVpvn_share
5143 Creates a new SV with its SvPVX_const pointing to a shared string in the string
5144 table. If the string does not already exist in the table, it is created
5145 first. Turns on READONLY and FAKE. If the C<hash> parameter is non-zero, that
5146 value is used; otherwise the hash is computed. The string's hash can be later
5147 be retrieved from the SV with the C<SvSHARED_HASH()> macro. The idea here is
5148 that as the string table is used for shared hash keys these strings will have
5149 SvPVX_const == HeKEY and hash lookup will avoid string compare.
5151 SV* newSVpvn_share(const char* s, I32 len, U32 hash)
5159 Like C<newSVpvn>, but takes a literal string instead of a string/length pair.
5161 SV* newSVpvs(const char* s)
5164 Found in file handy.h
5166 =item newSVpvs_share
5169 Like C<newSVpvn_share>, but takes a literal string instead of a string/length
5170 pair and omits the hash parameter.
5172 SV* newSVpvs_share(const char* s)
5175 Found in file handy.h
5180 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
5181 it will be upgraded to one. If C<classname> is non-null then the new SV will
5182 be blessed in the specified package. The new SV is returned and its
5183 reference count is 1.
5185 SV* newSVrv(SV* rv, const char* classname)
5193 Creates a new SV which is an exact duplicate of the original SV.
5196 SV* newSVsv(SV* old)
5204 Creates a new SV and copies an unsigned integer into it.
5205 The reference count for the SV is set to 1.
5215 Creates a new SV, of the type specified. The reference count for the new SV
5218 SV* newSV_type(svtype type)
5226 This function is only called on magical items, and is only used by
5227 sv_true() or its macro equivalent.
5229 bool sv_2bool(SV* sv)
5237 Using various gambits, try to get a CV from an SV; in addition, try if
5238 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
5239 The flags in C<lref> are passed to sv_fetchsv.
5241 CV* sv_2cv(SV* sv, HV** st, GV** gvp, I32 lref)
5249 Using various gambits, try to get an IO from an SV: the IO slot if its a
5250 GV; or the recursive result if we're an RV; or the IO slot of the symbol
5251 named after the PV if we're a string.
5261 Return the integer value of an SV, doing any necessary string
5262 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
5263 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
5265 IV sv_2iv_flags(SV* sv, I32 flags)
5273 Marks an existing SV as mortal. The SV will be destroyed "soon", either
5274 by an explicit call to FREETMPS, or by an implicit call at places such as
5275 statement boundaries. SvTEMP() is turned on which means that the SV's
5276 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
5277 and C<sv_mortalcopy>.
5279 SV* sv_2mortal(SV* sv)
5287 Return the num value of an SV, doing any necessary string or integer
5288 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
5299 Return a pointer to the byte-encoded representation of the SV, and set *lp
5300 to its length. May cause the SV to be downgraded from UTF-8 as a
5303 Usually accessed via the C<SvPVbyte> macro.
5305 char* sv_2pvbyte(SV* sv, STRLEN* lp)
5313 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
5314 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
5316 Usually accessed via the C<SvPVutf8> macro.
5318 char* sv_2pvutf8(SV* sv, STRLEN* lp)
5326 Returns a pointer to the string value of an SV, and sets *lp to its length.
5327 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
5329 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
5330 usually end up here too.
5332 char* sv_2pv_flags(SV* sv, STRLEN* lp, I32 flags)
5340 Return the unsigned integer value of an SV, doing any necessary string
5341 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
5342 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
5344 UV sv_2uv_flags(SV* sv, I32 flags)
5352 Remove any string offset. You should normally use the C<SvOOK_off> macro
5355 int sv_backoff(SV* sv)
5363 Blesses an SV into a specified package. The SV must be an RV. The package
5364 must be designated by its stash (see C<gv_stashpv()>). The reference count
5365 of the SV is unaffected.
5367 SV* sv_bless(SV* sv, HV* stash)
5375 Concatenates the string onto the end of the string which is in the SV.
5376 If the SV has the UTF-8 status set, then the bytes appended should be
5377 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
5379 void sv_catpv(SV* sv, const char* ptr)
5387 Processes its arguments like C<sprintf> and appends the formatted
5388 output to an SV. If the appended data contains "wide" characters
5389 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
5390 and characters >255 formatted with %c), the original SV might get
5391 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
5392 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
5393 valid UTF-8; if the original SV was bytes, the pattern should be too.
5395 void sv_catpvf(SV* sv, const char* pat, ...)
5403 Like C<sv_catpvf>, but also handles 'set' magic.
5405 void sv_catpvf_mg(SV *sv, const char* pat, ...)
5413 Concatenates the string onto the end of the string which is in the SV. The
5414 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5415 status set, then the bytes appended should be valid UTF-8.
5416 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
5418 void sv_catpvn(SV* sv, const char* ptr, STRLEN len)
5423 =item sv_catpvn_flags
5426 Concatenates the string onto the end of the string which is in the SV. The
5427 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5428 status set, then the bytes appended should be valid UTF-8.
5429 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
5430 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
5431 in terms of this function.
5433 void sv_catpvn_flags(SV* sv, const char* ptr, STRLEN len, I32 flags)
5441 Like C<sv_catpvn>, but takes a literal string instead of a string/length pair.
5443 void sv_catpvs(SV* sv, const char* s)
5446 Found in file handy.h
5451 Like C<sv_catpv>, but also handles 'set' magic.
5453 void sv_catpv_mg(SV *sv, const char *ptr)
5461 Concatenates the string from SV C<ssv> onto the end of the string in
5462 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
5463 not 'set' magic. See C<sv_catsv_mg>.
5465 void sv_catsv(SV* dsv, SV* ssv)
5470 =item sv_catsv_flags
5473 Concatenates the string from SV C<ssv> onto the end of the string in
5474 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
5475 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
5476 and C<sv_catsv_nomg> are implemented in terms of this function.
5478 void sv_catsv_flags(SV* dsv, SV* ssv, I32 flags)
5486 Efficient removal of characters from the beginning of the string buffer.
5487 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
5488 the string buffer. The C<ptr> becomes the first character of the adjusted
5489 string. Uses the "OOK hack".
5490 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
5491 refer to the same chunk of data.
5493 void sv_chop(SV* sv, const char* ptr)
5501 Clear an SV: call any destructors, free up any memory used by the body,
5502 and free the body itself. The SV's head is I<not> freed, although
5503 its type is set to all 1's so that it won't inadvertently be assumed
5504 to be live during global destruction etc.
5505 This function should only be called when REFCNT is zero. Most of the time
5506 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5509 void sv_clear(SV* sv)
5517 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5518 string in C<sv1> is less than, equal to, or greater than the string in
5519 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5520 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
5522 I32 sv_cmp(SV* sv1, SV* sv2)
5530 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
5531 'use bytes' aware, handles get magic, and will coerce its args to strings
5532 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
5534 I32 sv_cmp_locale(SV* sv1, SV* sv2)
5542 Add Collate Transform magic to an SV if it doesn't already have it.
5544 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
5545 scalar data of the variable, but transformed to such a format that a normal
5546 memory comparison can be used to compare the data according to the locale
5549 char* sv_collxfrm(SV* sv, STRLEN* nxp)
5557 Copies a stringified representation of the source SV into the
5558 destination SV. Automatically performs any necessary mg_get and
5559 coercion of numeric values into strings. Guaranteed to preserve
5560 UTF8 flag even from overloaded objects. Similar in nature to
5561 sv_2pv[_flags] but operates directly on an SV instead of just the
5562 string. Mostly uses sv_2pv_flags to do its work, except when that
5563 would lose the UTF-8'ness of the PV.
5565 void sv_copypv(SV* dsv, SV* ssv)
5573 Auto-decrement of the value in the SV, doing string to numeric conversion
5574 if necessary. Handles 'get' magic.
5584 Returns a boolean indicating whether the strings in the two SVs are
5585 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5586 coerce its args to strings if necessary.
5588 I32 sv_eq(SV* sv1, SV* sv2)
5593 =item sv_force_normal_flags
5594 X<sv_force_normal_flags>
5596 Undo various types of fakery on an SV: if the PV is a shared string, make
5597 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
5598 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
5599 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
5600 then a copy-on-write scalar drops its PV buffer (if any) and becomes
5601 SvPOK_off rather than making a copy. (Used where this scalar is about to be
5602 set to some other value.) In addition, the C<flags> parameter gets passed to
5603 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
5604 with flags set to 0.
5606 void sv_force_normal_flags(SV *sv, U32 flags)
5614 Decrement an SV's reference count, and if it drops to zero, call
5615 C<sv_clear> to invoke destructors and free up any memory used by
5616 the body; finally, deallocate the SV's head itself.
5617 Normally called via a wrapper macro C<SvREFCNT_dec>.
5619 void sv_free(SV* sv)
5627 Get a line from the filehandle and store it into the SV, optionally
5628 appending to the currently-stored string.
5630 char* sv_gets(SV* sv, PerlIO* fp, I32 append)
5638 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
5639 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
5640 Use the C<SvGROW> wrapper instead.
5642 char* sv_grow(SV* sv, STRLEN newlen)
5650 Auto-increment of the value in the SV, doing string to numeric conversion
5651 if necessary. Handles 'get' magic.
5661 Inserts a string at the specified offset/length within the SV. Similar to
5662 the Perl substr() function.
5664 void sv_insert(SV* bigsv, STRLEN offset, STRLEN len, const char* little, STRLEN littlelen)
5672 Returns a boolean indicating whether the SV is blessed into the specified
5673 class. This does not check for subtypes; use C<sv_derived_from> to verify
5674 an inheritance relationship.
5676 int sv_isa(SV* sv, const char* name)
5684 Returns a boolean indicating whether the SV is an RV pointing to a blessed
5685 object. If the SV is not an RV, or if the object is not blessed, then this
5688 int sv_isobject(SV* sv)
5696 Returns the length of the string in the SV. Handles magic and type
5697 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5699 STRLEN sv_len(SV* sv)
5707 Returns the number of characters in the string in an SV, counting wide
5708 UTF-8 bytes as a single character. Handles magic and type coercion.
5710 STRLEN sv_len_utf8(SV* sv)
5718 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
5719 then adds a new magic item of type C<how> to the head of the magic list.
5721 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
5722 handling of the C<name> and C<namlen> arguments.
5724 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
5725 to add more than one instance of the same 'how'.
5727 void sv_magic(SV* sv, SV* obj, int how, const char* name, I32 namlen)
5735 Adds magic to an SV, upgrading it if necessary. Applies the
5736 supplied vtable and returns a pointer to the magic added.
5738 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
5739 In particular, you can add magic to SvREADONLY SVs, and add more than
5740 one instance of the same 'how'.
5742 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
5743 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
5744 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
5745 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
5747 (This is now used as a subroutine by C<sv_magic>.)
5749 MAGIC * sv_magicext(SV* sv, SV* obj, int how, const MGVTBL *vtbl, const char* name, I32 namlen)
5757 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
5758 The new SV is marked as mortal. It will be destroyed "soon", either by an
5759 explicit call to FREETMPS, or by an implicit call at places such as
5760 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
5762 SV* sv_mortalcopy(SV* oldsv)
5770 Creates a new null SV which is mortal. The reference count of the SV is
5771 set to 1. It will be destroyed "soon", either by an explicit call to
5772 FREETMPS, or by an implicit call at places such as statement boundaries.
5773 See also C<sv_mortalcopy> and C<sv_2mortal>.
5783 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5786 SV* sv_newref(SV* sv)
5794 Converts the value pointed to by offsetp from a count of bytes from the
5795 start of the string, to a count of the equivalent number of UTF-8 chars.
5796 Handles magic and type coercion.
5798 void sv_pos_b2u(SV* sv, I32* offsetp)
5806 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5807 the start of the string, to a count of the equivalent number of bytes; if
5808 lenp is non-zero, it does the same to lenp, but this time starting from
5809 the offset, rather than from the start of the string. Handles magic and
5812 void sv_pos_u2b(SV* sv, I32* offsetp, I32* lenp)
5817 =item sv_pvbyten_force
5820 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
5822 char* sv_pvbyten_force(SV* sv, STRLEN* lp)
5830 Get a sensible string out of the SV somehow.
5831 A private implementation of the C<SvPV_force> macro for compilers which
5832 can't cope with complex macro expressions. Always use the macro instead.
5834 char* sv_pvn_force(SV* sv, STRLEN* lp)
5839 =item sv_pvn_force_flags
5840 X<sv_pvn_force_flags>
5842 Get a sensible string out of the SV somehow.
5843 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
5844 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
5845 implemented in terms of this function.
5846 You normally want to use the various wrapper macros instead: see
5847 C<SvPV_force> and C<SvPV_force_nomg>
5849 char* sv_pvn_force_flags(SV* sv, STRLEN* lp, I32 flags)
5854 =item sv_pvutf8n_force
5857 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
5859 char* sv_pvutf8n_force(SV* sv, STRLEN* lp)
5867 Returns a string describing what the SV is a reference to.
5869 const char* sv_reftype(const SV* sv, int ob)
5877 Make the first argument a copy of the second, then delete the original.
5878 The target SV physically takes over ownership of the body of the source SV
5879 and inherits its flags; however, the target keeps any magic it owns,
5880 and any magic in the source is discarded.
5881 Note that this is a rather specialist SV copying operation; most of the
5882 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5884 void sv_replace(SV* sv, SV* nsv)
5892 Underlying implementation for the C<reset> Perl function.
5893 Note that the perl-level function is vaguely deprecated.
5895 void sv_reset(const char* s, HV* stash)
5903 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
5904 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
5905 push a back-reference to this RV onto the array of backreferences
5906 associated with that magic. If the RV is magical, set magic will be
5907 called after the RV is cleared.
5909 SV* sv_rvweaken(SV *sv)
5917 Copies an integer into the given SV, upgrading first if necessary.
5918 Does not handle 'set' magic. See also C<sv_setiv_mg>.
5920 void sv_setiv(SV* sv, IV num)
5928 Like C<sv_setiv>, but also handles 'set' magic.
5930 void sv_setiv_mg(SV *sv, IV i)
5938 Copies a double into the given SV, upgrading first if necessary.
5939 Does not handle 'set' magic. See also C<sv_setnv_mg>.
5941 void sv_setnv(SV* sv, NV num)
5949 Like C<sv_setnv>, but also handles 'set' magic.
5951 void sv_setnv_mg(SV *sv, NV num)
5959 Copies a string into an SV. The string must be null-terminated. Does not
5960 handle 'set' magic. See C<sv_setpv_mg>.
5962 void sv_setpv(SV* sv, const char* ptr)
5970 Works like C<sv_catpvf> but copies the text into the SV instead of
5971 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
5973 void sv_setpvf(SV* sv, const char* pat, ...)
5981 Like C<sv_setpvf>, but also handles 'set' magic.
5983 void sv_setpvf_mg(SV *sv, const char* pat, ...)
5991 Copies an integer into the given SV, also updating its string value.
5992 Does not handle 'set' magic. See C<sv_setpviv_mg>.
5994 void sv_setpviv(SV* sv, IV num)
6002 Like C<sv_setpviv>, but also handles 'set' magic.
6004 void sv_setpviv_mg(SV *sv, IV iv)
6012 Copies a string into an SV. The C<len> parameter indicates the number of
6013 bytes to be copied. If the C<ptr> argument is NULL the SV will become
6014 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
6016 void sv_setpvn(SV* sv, const char* ptr, STRLEN len)
6024 Like C<sv_setpvn>, but also handles 'set' magic.
6026 void sv_setpvn_mg(SV *sv, const char *ptr, STRLEN len)
6034 Like C<sv_setpvn>, but takes a literal string instead of a string/length pair.
6036 void sv_setpvs(SV* sv, const char* s)
6039 Found in file handy.h
6044 Like C<sv_setpv>, but also handles 'set' magic.
6046 void sv_setpv_mg(SV *sv, const char *ptr)
6054 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
6055 argument will be upgraded to an RV. That RV will be modified to point to
6056 the new SV. The C<classname> argument indicates the package for the
6057 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
6058 will have a reference count of 1, and the RV will be returned.
6060 SV* sv_setref_iv(SV* rv, const char* classname, IV iv)
6068 Copies a double into a new SV, optionally blessing the SV. The C<rv>
6069 argument will be upgraded to an RV. That RV will be modified to point to
6070 the new SV. The C<classname> argument indicates the package for the
6071 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
6072 will have a reference count of 1, and the RV will be returned.
6074 SV* sv_setref_nv(SV* rv, const char* classname, NV nv)
6082 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
6083 argument will be upgraded to an RV. That RV will be modified to point to
6084 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
6085 into the SV. The C<classname> argument indicates the package for the
6086 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
6087 will have a reference count of 1, and the RV will be returned.
6089 Do not use with other Perl types such as HV, AV, SV, CV, because those
6090 objects will become corrupted by the pointer copy process.
6092 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
6094 SV* sv_setref_pv(SV* rv, const char* classname, void* pv)
6102 Copies a string into a new SV, optionally blessing the SV. The length of the
6103 string must be specified with C<n>. The C<rv> argument will be upgraded to
6104 an RV. That RV will be modified to point to the new SV. The C<classname>
6105 argument indicates the package for the blessing. Set C<classname> to
6106 C<NULL> to avoid the blessing. The new SV will have a reference count
6107 of 1, and the RV will be returned.
6109 Note that C<sv_setref_pv> copies the pointer while this copies the string.
6111 SV* sv_setref_pvn(SV* rv, const char* classname, const char* pv, STRLEN n)
6119 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
6120 argument will be upgraded to an RV. That RV will be modified to point to
6121 the new SV. The C<classname> argument indicates the package for the
6122 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
6123 will have a reference count of 1, and the RV will be returned.
6125 SV* sv_setref_uv(SV* rv, const char* classname, UV uv)
6133 Copies the contents of the source SV C<ssv> into the destination SV
6134 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
6135 function if the source SV needs to be reused. Does not handle 'set' magic.
6136 Loosely speaking, it performs a copy-by-value, obliterating any previous
6137 content of the destination.
6139 You probably want to use one of the assortment of wrappers, such as
6140 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
6141 C<SvSetMagicSV_nosteal>.
6143 void sv_setsv(SV* dsv, SV* ssv)
6148 =item sv_setsv_flags
6151 Copies the contents of the source SV C<ssv> into the destination SV
6152 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
6153 function if the source SV needs to be reused. Does not handle 'set' magic.
6154 Loosely speaking, it performs a copy-by-value, obliterating any previous
6155 content of the destination.
6156 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
6157 C<ssv> if appropriate, else not. If the C<flags> parameter has the
6158 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
6159 and C<sv_setsv_nomg> are implemented in terms of this function.
6161 You probably want to use one of the assortment of wrappers, such as
6162 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
6163 C<SvSetMagicSV_nosteal>.
6165 This is the primary function for copying scalars, and most other
6166 copy-ish functions and macros use this underneath.
6168 void sv_setsv_flags(SV* dsv, SV* ssv, I32 flags)
6176 Like C<sv_setsv>, but also handles 'set' magic.
6178 void sv_setsv_mg(SV *dstr, SV *sstr)
6186 Copies an unsigned integer into the given SV, upgrading first if necessary.
6187 Does not handle 'set' magic. See also C<sv_setuv_mg>.
6189 void sv_setuv(SV* sv, UV num)
6197 Like C<sv_setuv>, but also handles 'set' magic.
6199 void sv_setuv_mg(SV *sv, UV u)
6207 Test an SV for taintedness. Use C<SvTAINTED> instead.
6208 bool sv_tainted(SV* sv)
6216 Returns true if the SV has a true value by Perl's rules.
6217 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
6218 instead use an in-line version.
6228 Removes all magic of type C<type> from an SV.
6230 int sv_unmagic(SV* sv, int type)
6235 =item sv_unref_flags
6238 Unsets the RV status of the SV, and decrements the reference count of
6239 whatever was being referenced by the RV. This can almost be thought of
6240 as a reversal of C<newSVrv>. The C<cflags> argument can contain
6241 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
6242 (otherwise the decrementing is conditional on the reference count being
6243 different from one or the reference being a readonly SV).
6246 void sv_unref_flags(SV* sv, U32 flags)
6254 Untaint an SV. Use C<SvTAINTED_off> instead.
6255 void sv_untaint(SV* sv)
6263 Upgrade an SV to a more complex form. Generally adds a new body type to the
6264 SV, then copies across as much information as possible from the old body.
6265 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
6267 void sv_upgrade(SV* sv, svtype new_type)
6272 =item sv_usepvn_flags
6275 Tells an SV to use C<ptr> to find its string value. Normally the
6276 string is stored inside the SV but sv_usepvn allows the SV to use an
6277 outside string. The C<ptr> should point to memory that was allocated
6278 by C<malloc>. The string length, C<len>, must be supplied. By default
6279 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
6280 so that pointer should not be freed or used by the programmer after
6281 giving it to sv_usepvn, and neither should any pointers from "behind"
6282 that pointer (e.g. ptr + 1) be used.
6284 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
6285 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
6286 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
6287 C<len>, and already meets the requirements for storing in C<SvPVX>)
6289 void sv_usepvn_flags(SV* sv, char* ptr, STRLEN len, U32 flags)
6294 =item sv_utf8_decode
6297 If the PV of the SV is an octet sequence in UTF-8
6298 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
6299 so that it looks like a character. If the PV contains only single-byte
6300 characters, the C<SvUTF8> flag stays being off.
6301 Scans PV for validity and returns false if the PV is invalid UTF-8.
6303 NOTE: this function is experimental and may change or be
6304 removed without notice.
6306 bool sv_utf8_decode(SV *sv)
6311 =item sv_utf8_downgrade
6312 X<sv_utf8_downgrade>
6314 Attempts to convert the PV of an SV from characters to bytes.
6315 If the PV contains a character beyond byte, this conversion will fail;
6316 in this case, either returns false or, if C<fail_ok> is not
6319 This is not as a general purpose Unicode to byte encoding interface:
6320 use the Encode extension for that.
6322 NOTE: this function is experimental and may change or be
6323 removed without notice.
6325 bool sv_utf8_downgrade(SV *sv, bool fail_ok)
6330 =item sv_utf8_encode
6333 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
6334 flag off so that it looks like octets again.
6336 void sv_utf8_encode(SV *sv)
6341 =item sv_utf8_upgrade
6344 Converts the PV of an SV to its UTF-8-encoded form.
6345 Forces the SV to string form if it is not already.
6346 Always sets the SvUTF8 flag to avoid future validity checks even
6347 if all the bytes have hibit clear.
6349 This is not as a general purpose byte encoding to Unicode interface:
6350 use the Encode extension for that.
6352 STRLEN sv_utf8_upgrade(SV *sv)
6357 =item sv_utf8_upgrade_flags
6358 X<sv_utf8_upgrade_flags>
6360 Converts the PV of an SV to its UTF-8-encoded form.
6361 Forces the SV to string form if it is not already.
6362 Always sets the SvUTF8 flag to avoid future validity checks even
6363 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
6364 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
6365 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
6367 This is not as a general purpose byte encoding to Unicode interface:
6368 use the Encode extension for that.
6370 STRLEN sv_utf8_upgrade_flags(SV *sv, I32 flags)
6378 Processes its arguments like C<vsprintf> and appends the formatted output
6379 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
6381 Usually used via its frontend C<sv_catpvf>.
6383 void sv_vcatpvf(SV* sv, const char* pat, va_list* args)
6391 Processes its arguments like C<vsprintf> and appends the formatted output
6392 to an SV. Uses an array of SVs if the C style variable argument list is
6393 missing (NULL). When running with taint checks enabled, indicates via
6394 C<maybe_tainted> if results are untrustworthy (often due to the use of
6397 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
6399 void sv_vcatpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
6407 Like C<sv_vcatpvf>, but also handles 'set' magic.
6409 Usually used via its frontend C<sv_catpvf_mg>.
6411 void sv_vcatpvf_mg(SV* sv, const char* pat, va_list* args)
6419 Works like C<sv_vcatpvf> but copies the text into the SV instead of
6420 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
6422 Usually used via its frontend C<sv_setpvf>.
6424 void sv_vsetpvf(SV* sv, const char* pat, va_list* args)
6432 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
6435 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
6437 void sv_vsetpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
6445 Like C<sv_vsetpvf>, but also handles 'set' magic.
6447 Usually used via its frontend C<sv_setpvf_mg>.
6449 void sv_vsetpvf_mg(SV* sv, const char* pat, va_list* args)
6457 =head1 Unicode Support
6461 =item bytes_from_utf8
6464 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
6465 Unlike C<utf8_to_bytes> but like C<bytes_to_utf8>, returns a pointer to
6466 the newly-created string, and updates C<len> to contain the new
6467 length. Returns the original string if no conversion occurs, C<len>
6468 is unchanged. Do nothing if C<is_utf8> points to 0. Sets C<is_utf8> to
6469 0 if C<s> is converted or contains all 7bit characters.
6471 NOTE: this function is experimental and may change or be
6472 removed without notice.
6474 U8* bytes_from_utf8(const U8 *s, STRLEN *len, bool *is_utf8)
6477 Found in file utf8.c
6482 Converts a string C<s> of length C<len> from ASCII into UTF-8 encoding.
6483 Returns a pointer to the newly-created string, and sets C<len> to
6484 reflect the new length.
6486 If you want to convert to UTF-8 from other encodings than ASCII,
6487 see sv_recode_to_utf8().
6489 NOTE: this function is experimental and may change or be
6490 removed without notice.
6492 U8* bytes_to_utf8(const U8 *s, STRLEN *len)
6495 Found in file utf8.c
6500 Return true if the strings s1 and s2 differ case-insensitively, false
6501 if not (if they are equal case-insensitively). If u1 is true, the
6502 string s1 is assumed to be in UTF-8-encoded Unicode. If u2 is true,
6503 the string s2 is assumed to be in UTF-8-encoded Unicode. If u1 or u2
6504 are false, the respective string is assumed to be in native 8-bit
6507 If the pe1 and pe2 are non-NULL, the scanning pointers will be copied
6508 in there (they will point at the beginning of the I<next> character).
6509 If the pointers behind pe1 or pe2 are non-NULL, they are the end
6510 pointers beyond which scanning will not continue under any
6511 circumstances. If the byte lengths l1 and l2 are non-zero, s1+l1 and
6512 s2+l2 will be used as goal end pointers that will also stop the scan,
6513 and which qualify towards defining a successful match: all the scans
6514 that define an explicit length must reach their goal pointers for
6515 a match to succeed).
6517 For case-insensitiveness, the "casefolding" of Unicode is used
6518 instead of upper/lowercasing both the characters, see
6519 http://www.unicode.org/unicode/reports/tr21/ (Case Mappings).
6521 I32 ibcmp_utf8(const char* a, char **pe1, UV l1, bool u1, const char* b, char **pe2, UV l2, bool u2)
6524 Found in file utf8.c
6529 Tests if some arbitrary number of bytes begins in a valid UTF-8
6530 character. Note that an INVARIANT (i.e. ASCII) character is a valid
6531 UTF-8 character. The actual number of bytes in the UTF-8 character
6532 will be returned if it is valid, otherwise 0.
6534 STRLEN is_utf8_char(const U8 *p)
6537 Found in file utf8.c
6539 =item is_utf8_string
6542 Returns true if first C<len> bytes of the given string form a valid
6543 UTF-8 string, false otherwise. Note that 'a valid UTF-8 string' does
6544 not mean 'a string that contains code points above 0x7F encoded in UTF-8'
6545 because a valid ASCII string is a valid UTF-8 string.
6547 See also is_utf8_string_loclen() and is_utf8_string_loc().
6549 bool is_utf8_string(const U8 *s, STRLEN len)
6552 Found in file utf8.c
6554 =item is_utf8_string_loc
6555 X<is_utf8_string_loc>
6557 Like is_utf8_string() but stores the location of the failure (in the
6558 case of "utf8ness failure") or the location s+len (in the case of
6559 "utf8ness success") in the C<ep>.
6561 See also is_utf8_string_loclen() and is_utf8_string().
6563 bool is_utf8_string_loc(const U8 *s, STRLEN len, const U8 **p)
6566 Found in file utf8.c
6568 =item is_utf8_string_loclen
6569 X<is_utf8_string_loclen>
6571 Like is_utf8_string() but stores the location of the failure (in the
6572 case of "utf8ness failure") or the location s+len (in the case of
6573 "utf8ness success") in the C<ep>, and the number of UTF-8
6574 encoded characters in the C<el>.
6576 See also is_utf8_string_loc() and is_utf8_string().
6578 bool is_utf8_string_loclen(const U8 *s, STRLEN len, const U8 **ep, STRLEN *el)
6581 Found in file utf8.c
6583 =item pv_uni_display
6586 Build to the scalar dsv a displayable version of the string spv,
6587 length len, the displayable version being at most pvlim bytes long
6588 (if longer, the rest is truncated and "..." will be appended).
6590 The flags argument can have UNI_DISPLAY_ISPRINT set to display
6591 isPRINT()able characters as themselves, UNI_DISPLAY_BACKSLASH
6592 to display the \\[nrfta\\] as the backslashed versions (like '\n')
6593 (UNI_DISPLAY_BACKSLASH is preferred over UNI_DISPLAY_ISPRINT for \\).
6594 UNI_DISPLAY_QQ (and its alias UNI_DISPLAY_REGEX) have both
6595 UNI_DISPLAY_BACKSLASH and UNI_DISPLAY_ISPRINT turned on.
6597 The pointer to the PV of the dsv is returned.
6599 char* pv_uni_display(SV *dsv, const U8 *spv, STRLEN len, STRLEN pvlim, UV flags)
6602 Found in file utf8.c
6607 The encoding is assumed to be an Encode object, the PV of the ssv is
6608 assumed to be octets in that encoding and decoding the input starts
6609 from the position which (PV + *offset) pointed to. The dsv will be
6610 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
6611 when the string tstr appears in decoding output or the input ends on
6612 the PV of the ssv. The value which the offset points will be modified
6613 to the last input position on the ssv.
6615 Returns TRUE if the terminator was found, else returns FALSE.
6617 bool sv_cat_decode(SV* dsv, SV *encoding, SV *ssv, int *offset, char* tstr, int tlen)
6622 =item sv_recode_to_utf8
6623 X<sv_recode_to_utf8>
6625 The encoding is assumed to be an Encode object, on entry the PV
6626 of the sv is assumed to be octets in that encoding, and the sv
6627 will be converted into Unicode (and UTF-8).
6629 If the sv already is UTF-8 (or if it is not POK), or if the encoding
6630 is not a reference, nothing is done to the sv. If the encoding is not
6631 an C<Encode::XS> Encoding object, bad things will happen.
6632 (See F<lib/encoding.pm> and L<Encode>).
6634 The PV of the sv is returned.
6636 char* sv_recode_to_utf8(SV* sv, SV *encoding)
6641 =item sv_uni_display
6644 Build to the scalar dsv a displayable version of the scalar sv,
6645 the displayable version being at most pvlim bytes long
6646 (if longer, the rest is truncated and "..." will be appended).
6648 The flags argument is as in pv_uni_display().
6650 The pointer to the PV of the dsv is returned.
6652 char* sv_uni_display(SV *dsv, SV *ssv, STRLEN pvlim, UV flags)
6655 Found in file utf8.c
6660 The "p" contains the pointer to the UTF-8 string encoding
6661 the character that is being converted.
6663 The "ustrp" is a pointer to the character buffer to put the
6664 conversion result to. The "lenp" is a pointer to the length
6667 The "swashp" is a pointer to the swash to use.
6669 Both the special and normal mappings are stored lib/unicore/To/Foo.pl,
6670 and loaded by SWASHNEW, using lib/utf8_heavy.pl. The special (usually,
6671 but not always, a multicharacter mapping), is tried first.
6673 The "special" is a string like "utf8::ToSpecLower", which means the
6674 hash %utf8::ToSpecLower. The access to the hash is through
6675 Perl_to_utf8_case().
6677 The "normal" is a string like "ToLower" which means the swash
6680 UV to_utf8_case(const U8 *p, U8* ustrp, STRLEN *lenp, SV **swashp, const char *normal, const char *special)
6683 Found in file utf8.c
6688 Convert the UTF-8 encoded character at p to its foldcase version and
6689 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6690 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6691 foldcase version may be longer than the original character (up to
6694 The first character of the foldcased version is returned
6695 (but note, as explained above, that there may be more.)
6697 UV to_utf8_fold(const U8 *p, U8* ustrp, STRLEN *lenp)
6700 Found in file utf8.c
6705 Convert the UTF-8 encoded character at p to its lowercase version and
6706 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6707 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6708 lowercase version may be longer than the original character.
6710 The first character of the lowercased version is returned
6711 (but note, as explained above, that there may be more.)
6713 UV to_utf8_lower(const U8 *p, U8* ustrp, STRLEN *lenp)
6716 Found in file utf8.c
6721 Convert the UTF-8 encoded character at p to its titlecase version and
6722 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6723 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6724 titlecase version may be longer than the original character.
6726 The first character of the titlecased version is returned
6727 (but note, as explained above, that there may be more.)
6729 UV to_utf8_title(const U8 *p, U8* ustrp, STRLEN *lenp)
6732 Found in file utf8.c
6737 Convert the UTF-8 encoded character at p to its uppercase version and
6738 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6739 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since
6740 the uppercase version may be longer than the original character.
6742 The first character of the uppercased version is returned
6743 (but note, as explained above, that there may be more.)
6745 UV to_utf8_upper(const U8 *p, U8* ustrp, STRLEN *lenp)
6748 Found in file utf8.c
6750 =item utf8n_to_uvchr
6755 Returns the native character value of the first character in the string
6757 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6758 length, in bytes, of that character.
6760 Allows length and flags to be passed to low level routine.
6762 UV utf8n_to_uvchr(const U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags)
6765 Found in file utf8.c
6767 =item utf8n_to_uvuni
6770 Bottom level UTF-8 decode routine.
6771 Returns the Unicode code point value of the first character in the string C<s>
6772 which is assumed to be in UTF-8 encoding and no longer than C<curlen>;
6773 C<retlen> will be set to the length, in bytes, of that character.
6775 If C<s> does not point to a well-formed UTF-8 character, the behaviour
6776 is dependent on the value of C<flags>: if it contains UTF8_CHECK_ONLY,
6777 it is assumed that the caller will raise a warning, and this function
6778 will silently just set C<retlen> to C<-1> and return zero. If the
6779 C<flags> does not contain UTF8_CHECK_ONLY, warnings about
6780 malformations will be given, C<retlen> will be set to the expected
6781 length of the UTF-8 character in bytes, and zero will be returned.
6783 The C<flags> can also contain various flags to allow deviations from
6784 the strict UTF-8 encoding (see F<utf8.h>).
6786 Most code should use utf8_to_uvchr() rather than call this directly.
6788 UV utf8n_to_uvuni(const U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags)
6791 Found in file utf8.c
6796 Returns the number of UTF-8 characters between the UTF-8 pointers C<a>
6799 WARNING: use only if you *know* that the pointers point inside the
6802 IV utf8_distance(const U8 *a, const U8 *b)
6805 Found in file utf8.c
6810 Return the UTF-8 pointer C<s> displaced by C<off> characters, either
6811 forward or backward.
6813 WARNING: do not use the following unless you *know* C<off> is within
6814 the UTF-8 data pointed to by C<s> *and* that on entry C<s> is aligned
6815 on the first byte of character or just after the last byte of a character.
6817 U8* utf8_hop(const U8 *s, I32 off)
6820 Found in file utf8.c
6825 Return the length of the UTF-8 char encoded string C<s> in characters.
6826 Stops at C<e> (inclusive). If C<e E<lt> s> or if the scan would end
6827 up past C<e>, croaks.
6829 STRLEN utf8_length(const U8* s, const U8 *e)
6832 Found in file utf8.c
6837 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
6838 Unlike C<bytes_to_utf8>, this over-writes the original string, and
6839 updates len to contain the new length.
6840 Returns zero on failure, setting C<len> to -1.
6842 If you need a copy of the string, see C<bytes_from_utf8>.
6844 NOTE: this function is experimental and may change or be
6845 removed without notice.
6847 U8* utf8_to_bytes(U8 *s, STRLEN *len)
6850 Found in file utf8.c
6855 Returns the native character value of the first character in the string C<s>
6856 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6857 length, in bytes, of that character.
6859 If C<s> does not point to a well-formed UTF-8 character, zero is
6860 returned and retlen is set, if possible, to -1.
6862 UV utf8_to_uvchr(const U8 *s, STRLEN *retlen)
6865 Found in file utf8.c
6870 Returns the Unicode code point of the first character in the string C<s>
6871 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6872 length, in bytes, of that character.
6874 This function should only be used when returned UV is considered
6875 an index into the Unicode semantic tables (e.g. swashes).
6877 If C<s> does not point to a well-formed UTF-8 character, zero is
6878 returned and retlen is set, if possible, to -1.
6880 UV utf8_to_uvuni(const U8 *s, STRLEN *retlen)
6883 Found in file utf8.c
6888 Adds the UTF-8 representation of the Native codepoint C<uv> to the end
6889 of the string C<d>; C<d> should be have at least C<UTF8_MAXBYTES+1> free
6890 bytes available. The return value is the pointer to the byte after the
6891 end of the new character. In other words,
6893 d = uvchr_to_utf8(d, uv);
6895 is the recommended wide native character-aware way of saying
6899 U8* uvchr_to_utf8(U8 *d, UV uv)
6902 Found in file utf8.c
6904 =item uvuni_to_utf8_flags
6905 X<uvuni_to_utf8_flags>
6907 Adds the UTF-8 representation of the Unicode codepoint C<uv> to the end
6908 of the string C<d>; C<d> should be have at least C<UTF8_MAXBYTES+1> free
6909 bytes available. The return value is the pointer to the byte after the
6910 end of the new character. In other words,
6912 d = uvuni_to_utf8_flags(d, uv, flags);
6916 d = uvuni_to_utf8(d, uv);
6918 (which is equivalent to)
6920 d = uvuni_to_utf8_flags(d, uv, 0);
6922 is the recommended Unicode-aware way of saying
6926 U8* uvuni_to_utf8_flags(U8 *d, UV uv, UV flags)
6929 Found in file utf8.c
6934 =head1 Variables created by C<xsubpp> and C<xsubpp> internal functions
6941 Variable which is setup by C<xsubpp> to indicate the stack base offset,
6942 used by the C<ST>, C<XSprePUSH> and C<XSRETURN> macros. The C<dMARK> macro
6943 must be called prior to setup the C<MARK> variable.
6948 Found in file XSUB.h
6953 Variable which is setup by C<xsubpp> to indicate the
6954 class name for a C++ XS constructor. This is always a C<char*>. See C<THIS>.
6959 Found in file XSUB.h
6964 Sets up the C<ax> variable.
6965 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
6970 Found in file XSUB.h
6975 Sets up the C<ax> variable and stack marker variable C<mark>.
6976 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
6981 Found in file XSUB.h
6986 Sets up the C<items> variable.
6987 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
6992 Found in file XSUB.h
6997 Sets up the C<padoff_du> variable for an XSUB that wishes to use
7003 Found in file XSUB.h
7008 Sets up stack and mark pointers for an XSUB, calling dSP and dMARK.
7009 Sets up the C<ax> and C<items> variables by calling C<dAX> and C<dITEMS>.
7010 This is usually handled automatically by C<xsubpp>.
7015 Found in file XSUB.h
7020 Sets up the C<ix> variable for an XSUB which has aliases. This is usually
7021 handled automatically by C<xsubpp>.
7026 Found in file XSUB.h
7031 Variable which is setup by C<xsubpp> to indicate the number of
7032 items on the stack. See L<perlxs/"Variable-length Parameter Lists">.
7037 Found in file XSUB.h
7042 Variable which is setup by C<xsubpp> to indicate which of an
7043 XSUB's aliases was used to invoke it. See L<perlxs/"The ALIAS: Keyword">.
7048 Found in file XSUB.h
7053 Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
7057 Found in file XSUB.h
7062 Variable which is setup by C<xsubpp> to hold the return value for an
7063 XSUB. This is always the proper type for the XSUB. See
7064 L<perlxs/"The RETVAL Variable">.
7069 Found in file XSUB.h
7074 Used to access elements on the XSUB's stack.
7079 Found in file XSUB.h
7084 Variable which is setup by C<xsubpp> to designate the object in a C++
7085 XSUB. This is always the proper type for the C++ object. See C<CLASS> and
7086 L<perlxs/"Using XS With C++">.
7091 Found in file XSUB.h
7096 The SV* corresponding to the $_ variable. Works even if there
7097 is a lexical $_ in scope.
7100 Found in file XSUB.h
7105 Macro to declare an XSUB and its C parameter list. This is handled by
7109 Found in file XSUB.h
7114 The version identifier for an XS module. This is usually
7115 handled automatically by C<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>.
7118 Found in file XSUB.h
7120 =item XS_VERSION_BOOTCHECK
7121 X<XS_VERSION_BOOTCHECK>
7123 Macro to verify that a PM module's $VERSION variable matches the XS
7124 module's C<XS_VERSION> variable. This is usually handled automatically by
7125 C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">.
7127 XS_VERSION_BOOTCHECK;
7130 Found in file XSUB.h
7135 =head1 Warning and Dieing
7142 This is the XSUB-writer's interface to Perl's C<die> function.
7143 Normally call this function the same way you call the C C<printf>
7144 function. Calling C<croak> returns control directly to Perl,
7145 sidestepping the normal C order of execution. See C<warn>.
7147 If you want to throw an exception object, assign the object to
7148 C<$@> and then pass C<NULL> to croak():
7150 errsv = get_sv("@", TRUE);
7151 sv_setsv(errsv, exception_object);
7154 void croak(const char* pat, ...)
7157 Found in file util.c
7162 This is the XSUB-writer's interface to Perl's C<warn> function. Call this
7163 function the same way you call the C C<printf> function. See C<croak>.
7165 void warn(const char* pat, ...)
7168 Found in file util.c
7175 Until May 1997, this document was maintained by Jeff Okamoto
7176 <okamoto@corp.hp.com>. It is now maintained as part of Perl itself.
7178 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
7179 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
7180 Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
7181 Stephen McCamant, and Gurusamy Sarathy.
7183 API Listing originally by Dean Roehrich <roehrich@cray.com>.
7185 Updated to be autogenerated from comments in the source by Benjamin Stuhl.
7189 perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
projects / p5sagit/p5-mst-13.2.git / blob