1 -*- buffer-read-only: t -*-
3 !!!!!!! DO NOT EDIT THIS FILE !!!!!!!
4 This file is built by autodoc.pl extracting documentation from the C source
9 perlapi - autogenerated documentation for the perl public API
12 X<Perl API> X<API> X<api>
14 This file contains the documentation of the perl public API generated by
15 embed.pl, specifically a listing of functions, macros, flags, and variables
16 that may be used by extension writers. The interfaces of any functions that
17 are not listed here are subject to change without notice. For this reason,
18 blindly using functions listed in proto.h is to be avoided when writing
21 Note that all Perl API global variables must be referenced with the C<PL_>
22 prefix. Some macros are provided for compatibility with the older,
23 unadorned names, but this support may be disabled in a future release.
25 The listing is alphabetical, case insensitive.
35 A backward-compatible version of C<GIMME_V> which can only return
36 C<G_SCALAR> or C<G_ARRAY>; in a void context, it returns C<G_SCALAR>.
37 Deprecated. Use C<GIMME_V> instead.
47 The XSUB-writer's equivalent to Perl's C<wantarray>. Returns C<G_VOID>,
48 C<G_SCALAR> or C<G_ARRAY> for void, scalar or list context,
59 Used to indicate list context. See C<GIMME_V>, C<GIMME> and
68 Indicates that arguments returned from a callback should be discarded. See
77 Used to force a Perl C<eval> wrapper around a callback. See
86 Indicates that no arguments are being sent to a callback. See
95 Used to indicate scalar context. See C<GIMME_V>, C<GIMME>, and
104 Used to indicate void context. See C<GIMME_V> and L<perlcall>.
112 =head1 Array Manipulation Functions
119 Same as C<av_len()>. Deprecated, use C<av_len()> instead.
129 Clears an array, making it empty. Does not free the memory used by the
132 void av_clear(AV* ar)
137 =item av_create_and_push
138 X<av_create_and_push>
140 Push an SV onto the end of the array, creating the array if necessary.
141 A small internal helper function to remove a commonly duplicated idiom.
143 NOTE: this function is experimental and may change or be
144 removed without notice.
146 void av_create_and_push(AV **const avp, SV *const val)
151 =item av_create_and_unshift_one
152 X<av_create_and_unshift_one>
154 Unshifts an SV onto the beginning of the array, creating the array if
156 A small internal helper function to remove a commonly duplicated idiom.
158 NOTE: this function is experimental and may change or be
159 removed without notice.
161 SV** av_create_and_unshift_one(AV **const avp, SV *const val)
169 Deletes the element indexed by C<key> from the array. Returns the
170 deleted element. If C<flags> equals C<G_DISCARD>, the element is freed
171 and null is returned.
173 SV* av_delete(AV* ar, I32 key, I32 flags)
181 Returns true if the element indexed by C<key> has been initialized.
183 This relies on the fact that uninitialized array elements are set to
186 bool av_exists(AV* ar, I32 key)
194 Pre-extend an array. The C<key> is the index to which the array should be
197 void av_extend(AV* ar, I32 key)
205 Returns the SV at the specified index in the array. The C<key> is the
206 index. If C<lval> is set then the fetch will be part of a store. Check
207 that the return value is non-null before dereferencing it to a C<SV*>.
209 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for
210 more information on how to use this function on tied arrays.
212 SV** av_fetch(AV* ar, I32 key, I32 lval)
220 Set the highest index in the array to the given number, equivalent to
221 Perl's C<$#array = $fill;>.
223 The number of elements in the an array will be C<fill + 1> after
224 av_fill() returns. If the array was previously shorter then the
225 additional elements appended are set to C<PL_sv_undef>. If the array
226 was longer, then the excess elements are freed. C<av_fill(av, -1)> is
227 the same as C<av_clear(av)>.
229 void av_fill(AV* ar, I32 fill)
237 Returns the highest index in the array. The number of elements in the
238 array is C<av_len(av) + 1>. Returns -1 if the array is empty.
240 I32 av_len(const AV* ar)
248 Creates a new AV and populates it with a list of SVs. The SVs are copied
249 into the array, so they may be freed after the call to av_make. The new AV
250 will have a reference count of 1.
252 AV* av_make(I32 size, SV** svp)
260 Pops an SV off the end of the array. Returns C<&PL_sv_undef> if the array
271 Pushes an SV onto the end of the array. The array will grow automatically
272 to accommodate the addition.
274 void av_push(AV* ar, SV* val)
282 Shifts an SV off the beginning of the array.
292 Stores an SV in an array. The array index is specified as C<key>. The
293 return value will be NULL if the operation failed or if the value did not
294 need to be actually stored within the array (as in the case of tied
295 arrays). Otherwise it can be dereferenced to get the original C<SV*>. Note
296 that the caller is responsible for suitably incrementing the reference
297 count of C<val> before the call, and decrementing it if the function
300 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for
301 more information on how to use this function on tied arrays.
303 SV** av_store(AV* ar, I32 key, SV* val)
311 Undefines the array. Frees the memory used by the array itself.
313 void av_undef(AV* ar)
321 Unshift the given number of C<undef> values onto the beginning of the
322 array. The array will grow automatically to accommodate the addition. You
323 must then use C<av_store> to assign values to these new elements.
325 void av_unshift(AV* ar, I32 num)
333 Returns the AV of the specified Perl array. If C<create> is set and the
334 Perl variable does not exist then it will be created. If C<create> is not
335 set and the variable does not exist then NULL is returned.
337 NOTE: the perl_ form of this function is deprecated.
339 AV* get_av(const char* name, I32 create)
347 Creates a new AV. The reference count is set to 1.
357 Sort an array. Here is an example:
359 sortsv(AvARRAY(av), av_len(av)+1, Perl_sv_cmp_locale);
361 Currently this always uses mergesort. See sortsv_flags for a more
364 void sortsv(SV** array, size_t num_elts, SVCOMPARE_t cmp)
367 Found in file pp_sort.c
372 Sort an array, with various options.
374 void sortsv_flags(SV** array, size_t num_elts, SVCOMPARE_t cmp, U32 flags)
377 Found in file pp_sort.c
382 =head1 Callback Functions
389 Performs a callback to the specified Perl sub. See L<perlcall>.
391 NOTE: the perl_ form of this function is deprecated.
393 I32 call_argv(const char* sub_name, I32 flags, char** argv)
401 Performs a callback to the specified Perl method. The blessed object must
402 be on the stack. See L<perlcall>.
404 NOTE: the perl_ form of this function is deprecated.
406 I32 call_method(const char* methname, I32 flags)
414 Performs a callback to the specified Perl sub. See L<perlcall>.
416 NOTE: the perl_ form of this function is deprecated.
418 I32 call_pv(const char* sub_name, I32 flags)
426 Performs a callback to the Perl sub whose name is in the SV. See
429 NOTE: the perl_ form of this function is deprecated.
431 I32 call_sv(SV* sv, I32 flags)
439 Opening bracket on a callback. See C<LEAVE> and L<perlcall>.
444 Found in file scope.h
449 Tells Perl to C<eval> the given string and return an SV* result.
451 NOTE: the perl_ form of this function is deprecated.
453 SV* eval_pv(const char* p, I32 croak_on_error)
461 Tells Perl to C<eval> the string in the SV.
463 NOTE: the perl_ form of this function is deprecated.
465 I32 eval_sv(SV* sv, I32 flags)
473 Closing bracket for temporaries on a callback. See C<SAVETMPS> and
479 Found in file scope.h
484 Closing bracket on a callback. See C<ENTER> and L<perlcall>.
489 Found in file scope.h
494 Opening bracket for temporaries on a callback. See C<FREETMPS> and
500 Found in file scope.h
505 =head1 Character classes
512 Returns a boolean indicating whether the C C<char> is an ASCII alphanumeric
513 character (including underscore) or digit.
515 bool isALNUM(char ch)
518 Found in file handy.h
523 Returns a boolean indicating whether the C C<char> is an ASCII alphabetic
526 bool isALPHA(char ch)
529 Found in file handy.h
534 Returns a boolean indicating whether the C C<char> is an ASCII
537 bool isDIGIT(char ch)
540 Found in file handy.h
545 Returns a boolean indicating whether the C C<char> is a lowercase
548 bool isLOWER(char ch)
551 Found in file handy.h
556 Returns a boolean indicating whether the C C<char> is whitespace.
558 bool isSPACE(char ch)
561 Found in file handy.h
566 Returns a boolean indicating whether the C C<char> is an uppercase
569 bool isUPPER(char ch)
572 Found in file handy.h
577 Converts the specified character to lowercase.
579 char toLOWER(char ch)
582 Found in file handy.h
587 Converts the specified character to uppercase.
589 char toUPPER(char ch)
592 Found in file handy.h
597 =head1 Cloning an interpreter
604 Create and return a new interpreter by cloning the current one.
606 perl_clone takes these flags as parameters:
608 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
609 without it we only clone the data and zero the stacks,
610 with it we copy the stacks and the new perl interpreter is
611 ready to run at the exact same point as the previous one.
612 The pseudo-fork code uses COPY_STACKS while the
613 threads->create doesn't.
615 CLONEf_KEEP_PTR_TABLE
616 perl_clone keeps a ptr_table with the pointer of the old
617 variable as a key and the new variable as a value,
618 this allows it to check if something has been cloned and not
619 clone it again but rather just use the value and increase the
620 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
621 the ptr_table using the function
622 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
623 reason to keep it around is if you want to dup some of your own
624 variable who are outside the graph perl scans, example of this
625 code is in threads.xs create
628 This is a win32 thing, it is ignored on unix, it tells perls
629 win32host code (which is c++) to clone itself, this is needed on
630 win32 if you want to run two threads at the same time,
631 if you just want to do some stuff in a separate perl interpreter
632 and then throw it away and return to the original one,
633 you don't need to do anything.
635 PerlInterpreter* perl_clone(PerlInterpreter* interp, UV flags)
643 =head1 CV Manipulation Functions
650 Returns the stash of the CV.
660 Uses C<strlen> to get the length of C<name>, then calls C<get_cvn_flags>.
662 NOTE: the perl_ form of this function is deprecated.
664 CV* get_cv(const char* name, I32 flags)
672 Returns the CV of the specified Perl subroutine. C<flags> are passed to
673 C<gv_fetchpvn_flags>. If C<GV_ADD> is set and the Perl subroutine does not
674 exist then it will be declared (which has the same effect as saying
675 C<sub name;>). If C<GV_ADD> is not set and the subroutine does not exist
676 then NULL is returned.
678 NOTE: the perl_ form of this function is deprecated.
680 CV* get_cvn_flags(const char* name, STRLEN len, I32 flags)
688 =head1 Embedding Functions
695 Clear out all the active components of a CV. This can happen either
696 by an explicit C<undef &foo>, or by the reference count going to zero.
697 In the former case, we keep the CvOUTSIDE pointer, so that any anonymous
698 children can still follow the full lexical scope chain.
700 void cv_undef(CV* cv)
708 Loads the module whose name is pointed to by the string part of name.
709 Note that the actual module name, not its filename, should be given.
710 Eg, "Foo::Bar" instead of "Foo/Bar.pm". flags can be any of
711 PERL_LOADMOD_DENY, PERL_LOADMOD_NOIMPORT, or PERL_LOADMOD_IMPORT_OPS
712 (or 0 for no flags). ver, if specified, provides version semantics
713 similar to C<use Foo::Bar VERSION>. The optional trailing SV*
714 arguments can be used to specify arguments to the module's import()
715 method, similar to C<use Foo::Bar VERSION LIST>.
717 void load_module(U32 flags, SV* name, SV* ver, ...)
725 Stub that provides thread hook for perl_destruct when there are
736 Allocates a new Perl interpreter. See L<perlembed>.
738 PerlInterpreter* perl_alloc()
746 Initializes a new Perl interpreter. See L<perlembed>.
748 void perl_construct(PerlInterpreter* interp)
756 Shuts down a Perl interpreter. See L<perlembed>.
758 int perl_destruct(PerlInterpreter* interp)
766 Releases a Perl interpreter. See L<perlembed>.
768 void perl_free(PerlInterpreter* interp)
776 Tells a Perl interpreter to parse a Perl script. See L<perlembed>.
778 int perl_parse(PerlInterpreter* interp, XSINIT_t xsinit, int argc, char** argv, char** env)
786 Tells a Perl interpreter to run. See L<perlembed>.
788 int perl_run(PerlInterpreter* interp)
796 Tells Perl to C<require> the file named by the string argument. It is
797 analogous to the Perl code C<eval "require '$file'">. It's even
798 implemented that way; consider using load_module instead.
800 NOTE: the perl_ form of this function is deprecated.
802 void require_pv(const char* pv)
810 =head1 Functions in file dump.c
818 char *pv_display(SV *dsv, const char *pv, STRLEN cur, STRLEN len,
819 STRLEN pvlim, U32 flags)
823 pv_escape(dsv,pv,cur,pvlim,PERL_PV_ESCAPE_QUOTE);
825 except that an additional "\0" will be appended to the string when
826 len > cur and pv[cur] is "\0".
828 Note that the final string may be up to 7 chars longer than pvlim.
830 char* pv_display(SV *dsv, const char *pv, STRLEN cur, STRLEN len, STRLEN pvlim)
838 |const STRLEN count|const STRLEN max
839 |STRLEN const *escaped, const U32 flags
841 Escapes at most the first "count" chars of pv and puts the results into
842 dsv such that the size of the escaped string will not exceed "max" chars
843 and will not contain any incomplete escape sequences.
845 If flags contains PERL_PV_ESCAPE_QUOTE then any double quotes in the string
846 will also be escaped.
848 Normally the SV will be cleared before the escaped string is prepared,
849 but when PERL_PV_ESCAPE_NOCLEAR is set this will not occur.
851 If PERL_PV_ESCAPE_UNI is set then the input string is treated as unicode,
852 if PERL_PV_ESCAPE_UNI_DETECT is set then the input string is scanned
853 using C<is_utf8_string()> to determine if it is unicode.
855 If PERL_PV_ESCAPE_ALL is set then all input chars will be output
856 using C<\x01F1> style escapes, otherwise only chars above 255 will be
857 escaped using this style, other non printable chars will use octal or
858 common escaped patterns like C<\n>. If PERL_PV_ESCAPE_NOBACKSLASH
859 then all chars below 255 will be treated as printable and
860 will be output as literals.
862 If PERL_PV_ESCAPE_FIRSTCHAR is set then only the first char of the
863 string will be escaped, regardles of max. If the string is utf8 and
864 the chars value is >255 then it will be returned as a plain hex
865 sequence. Thus the output will either be a single char,
866 an octal escape sequence, a special escape like C<\n> or a 3 or
867 more digit hex value.
869 If PERL_PV_ESCAPE_RE is set then the escape char used will be a '%' and
870 not a '\\'. This is because regexes very often contain backslashed
871 sequences, whereas '%' is not a particularly common character in patterns.
873 Returns a pointer to the escaped text as held by dsv.
875 NOTE: the perl_ form of this function is deprecated.
877 char* pv_escape(SV *dsv, char const * const str, const STRLEN count, const STRLEN max, STRLEN * const escaped, const U32 flags)
885 |const STRLEN count|const STRLEN max\
886 |const char const *start_color| const char const *end_color\
889 Converts a string into something presentable, handling escaping via
890 pv_escape() and supporting quoting and elipses.
892 If the PERL_PV_PRETTY_QUOTE flag is set then the result will be
893 double quoted with any double quotes in the string escaped. Otherwise
894 if the PERL_PV_PRETTY_LTGT flag is set then the result be wrapped in
897 If the PERL_PV_PRETTY_ELIPSES flag is set and not all characters in
898 string were output then an elipses C<...> will be appended to the
899 string. Note that this happens AFTER it has been quoted.
901 If start_color is non-null then it will be inserted after the opening
902 quote (if there is one) but before the escaped text. If end_color
903 is non-null then it will be inserted after the escaped text but before
904 any quotes or elipses.
906 Returns a pointer to the prettified text as held by dsv.
908 NOTE: the perl_ form of this function is deprecated.
910 char* pv_pretty(SV *dsv, char const * const str, const STRLEN count, const STRLEN max, char const * const start_color, char const * const end_color, const U32 flags)
918 =head1 Functions in file mathoms.c
926 See L<gv_fetchmethod_autoload>.
928 GV* gv_fetchmethod(HV* stash, const char* name)
931 Found in file mathoms.c
936 The engine implementing pack() Perl function. Note: parameters next_in_list and
937 flags are not used. This call should not be used; use packlist instead.
939 void pack_cat(SV *cat, const char *pat, const char *patend, SV **beglist, SV **endlist, SV ***next_in_list, U32 flags)
942 Found in file mathoms.c
944 =item sv_2pvbyte_nolen
947 Return a pointer to the byte-encoded representation of the SV.
948 May cause the SV to be downgraded from UTF-8 as a side-effect.
950 Usually accessed via the C<SvPVbyte_nolen> macro.
952 char* sv_2pvbyte_nolen(SV* sv)
955 Found in file mathoms.c
957 =item sv_2pvutf8_nolen
960 Return a pointer to the UTF-8-encoded representation of the SV.
961 May cause the SV to be upgraded to UTF-8 as a side-effect.
963 Usually accessed via the C<SvPVutf8_nolen> macro.
965 char* sv_2pvutf8_nolen(SV* sv)
968 Found in file mathoms.c
973 Like C<sv_2pv()>, but doesn't return the length too. You should usually
974 use the macro wrapper C<SvPV_nolen(sv)> instead.
975 char* sv_2pv_nolen(SV* sv)
978 Found in file mathoms.c
983 Like C<sv_catpvn>, but also handles 'set' magic.
985 void sv_catpvn_mg(SV *sv, const char *ptr, STRLEN len)
988 Found in file mathoms.c
993 Like C<sv_catsv>, but also handles 'set' magic.
995 void sv_catsv_mg(SV *dstr, SV *sstr)
998 Found in file mathoms.c
1000 =item sv_force_normal
1003 Undo various types of fakery on an SV: if the PV is a shared string, make
1004 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
1005 an xpvmg. See also C<sv_force_normal_flags>.
1007 void sv_force_normal(SV *sv)
1010 Found in file mathoms.c
1015 A private implementation of the C<SvIVx> macro for compilers which can't
1016 cope with complex macro expressions. Always use the macro instead.
1021 Found in file mathoms.c
1026 Dummy routine which "locks" an SV when there is no locking module present.
1027 Exists to avoid test for a NULL function pointer and because it could
1028 potentially warn under some level of strict-ness.
1030 "Superseded" by sv_nosharing().
1032 void sv_nolocking(SV *sv)
1035 Found in file mathoms.c
1037 =item sv_nounlocking
1040 Dummy routine which "unlocks" an SV when there is no locking module present.
1041 Exists to avoid test for a NULL function pointer and because it could
1042 potentially warn under some level of strict-ness.
1044 "Superseded" by sv_nosharing().
1046 void sv_nounlocking(SV *sv)
1049 Found in file mathoms.c
1054 A private implementation of the C<SvNVx> macro for compilers which can't
1055 cope with complex macro expressions. Always use the macro instead.
1060 Found in file mathoms.c
1065 Use the C<SvPV_nolen> macro instead
1070 Found in file mathoms.c
1075 Use C<SvPVbyte_nolen> instead.
1077 char* sv_pvbyte(SV *sv)
1080 Found in file mathoms.c
1085 A private implementation of the C<SvPVbyte> macro for compilers
1086 which can't cope with complex macro expressions. Always use the macro
1089 char* sv_pvbyten(SV *sv, STRLEN *len)
1092 Found in file mathoms.c
1097 A private implementation of the C<SvPV> macro for compilers which can't
1098 cope with complex macro expressions. Always use the macro instead.
1100 char* sv_pvn(SV *sv, STRLEN *len)
1103 Found in file mathoms.c
1108 Use the C<SvPVutf8_nolen> macro instead
1110 char* sv_pvutf8(SV *sv)
1113 Found in file mathoms.c
1118 A private implementation of the C<SvPVutf8> macro for compilers
1119 which can't cope with complex macro expressions. Always use the macro
1122 char* sv_pvutf8n(SV *sv, STRLEN *len)
1125 Found in file mathoms.c
1130 Taint an SV. Use C<SvTAINTED_on> instead.
1131 void sv_taint(SV* sv)
1134 Found in file mathoms.c
1139 Unsets the RV status of the SV, and decrements the reference count of
1140 whatever was being referenced by the RV. This can almost be thought of
1141 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
1142 being zero. See C<SvROK_off>.
1144 void sv_unref(SV* sv)
1147 Found in file mathoms.c
1152 Tells an SV to use C<ptr> to find its string value. Implemented by
1153 calling C<sv_usepvn_flags> with C<flags> of 0, hence does not handle 'set'
1154 magic. See C<sv_usepvn_flags>.
1156 void sv_usepvn(SV* sv, char* ptr, STRLEN len)
1159 Found in file mathoms.c
1164 Like C<sv_usepvn>, but also handles 'set' magic.
1166 void sv_usepvn_mg(SV *sv, char *ptr, STRLEN len)
1169 Found in file mathoms.c
1174 A private implementation of the C<SvUVx> macro for compilers which can't
1175 cope with complex macro expressions. Always use the macro instead.
1180 Found in file mathoms.c
1185 The engine implementing unpack() Perl function. Note: parameters strbeg, new_s
1186 and ocnt are not used. This call should not be used, use unpackstring instead.
1188 I32 unpack_str(const char *pat, const char *patend, const char *s, const char *strbeg, const char *strend, char **new_s, I32 ocnt, U32 flags)
1191 Found in file mathoms.c
1196 =head1 Functions in file pp_pack.c
1204 The engine implementing pack() Perl function.
1206 void packlist(SV *cat, const char *pat, const char *patend, SV **beglist, SV **endlist)
1209 Found in file pp_pack.c
1214 The engine implementing unpack() Perl function. C<unpackstring> puts the
1215 extracted list items on the stack and returns the number of elements.
1216 Issue C<PUTBACK> before and C<SPAGAIN> after the call to this function.
1218 I32 unpackstring(const char *pat, const char *patend, const char *s, const char *strend, U32 flags)
1221 Found in file pp_pack.c
1226 =head1 Global Variables
1233 C<PL_modglobal> is a general purpose, interpreter global HV for use by
1234 extensions that need to keep information on a per-interpreter basis.
1235 In a pinch, it can also be used as a symbol table for extensions
1236 to share data among each other. It is a good idea to use keys
1237 prefixed by the package name of the extension that owns the data.
1242 Found in file intrpvar.h
1247 A convenience variable which is typically used with C<SvPV> when one
1248 doesn't care about the length of the string. It is usually more efficient
1249 to either declare a local variable and use that instead or to use the
1250 C<SvPV_nolen> macro.
1255 Found in file thrdvar.h
1260 This is the C<false> SV. See C<PL_sv_yes>. Always refer to this as
1266 Found in file intrpvar.h
1271 This is the C<undef> SV. Always refer to this as C<&PL_sv_undef>.
1276 Found in file intrpvar.h
1281 This is the C<true> SV. See C<PL_sv_no>. Always refer to this as
1287 Found in file intrpvar.h
1299 Return the SV from the GV.
1309 If C<gv> is a typeglob whose subroutine entry is a constant sub eligible for
1310 inlining, or C<gv> is a placeholder reference that would be promoted to such
1311 a typeglob, then returns the value returned by the sub. Otherwise, returns
1314 SV* gv_const_sv(GV* gv)
1322 Returns the glob with the given C<name> and a defined subroutine or
1323 C<NULL>. The glob lives in the given C<stash>, or in the stashes
1324 accessible via @ISA and UNIVERSAL::.
1326 The argument C<level> should be either 0 or -1. If C<level==0>, as a
1327 side-effect creates a glob with the given C<name> in the given C<stash>
1328 which in the case of success contains an alias for the subroutine, and sets
1329 up caching info for this glob.
1331 This function grants C<"SUPER"> token as a postfix of the stash name. The
1332 GV returned from C<gv_fetchmeth> may be a method cache entry, which is not
1333 visible to Perl code. So when calling C<call_sv>, you should not use
1334 the GV directly; instead, you should use the method's CV, which can be
1335 obtained from the GV with the C<GvCV> macro.
1337 GV* gv_fetchmeth(HV* stash, const char* name, STRLEN len, I32 level)
1342 =item gv_fetchmethod_autoload
1343 X<gv_fetchmethod_autoload>
1345 Returns the glob which contains the subroutine to call to invoke the method
1346 on the C<stash>. In fact in the presence of autoloading this may be the
1347 glob for "AUTOLOAD". In this case the corresponding variable $AUTOLOAD is
1350 The third parameter of C<gv_fetchmethod_autoload> determines whether
1351 AUTOLOAD lookup is performed if the given method is not present: non-zero
1352 means yes, look for AUTOLOAD; zero means no, don't look for AUTOLOAD.
1353 Calling C<gv_fetchmethod> is equivalent to calling C<gv_fetchmethod_autoload>
1354 with a non-zero C<autoload> parameter.
1356 These functions grant C<"SUPER"> token as a prefix of the method name. Note
1357 that if you want to keep the returned glob for a long time, you need to
1358 check for it being "AUTOLOAD", since at the later time the call may load a
1359 different subroutine due to $AUTOLOAD changing its value. Use the glob
1360 created via a side effect to do this.
1362 These functions have the same side-effects and as C<gv_fetchmeth> with
1363 C<level==0>. C<name> should be writable if contains C<':'> or C<'
1364 ''>. The warning against passing the GV returned by C<gv_fetchmeth> to
1365 C<call_sv> apply equally to these functions.
1367 GV* gv_fetchmethod_autoload(HV* stash, const char* name, I32 autoload)
1372 =item gv_fetchmeth_autoload
1373 X<gv_fetchmeth_autoload>
1375 Same as gv_fetchmeth(), but looks for autoloaded subroutines too.
1376 Returns a glob for the subroutine.
1378 For an autoloaded subroutine without a GV, will create a GV even
1379 if C<level < 0>. For an autoloaded subroutine without a stub, GvCV()
1380 of the result may be zero.
1382 GV* gv_fetchmeth_autoload(HV* stash, const char* name, STRLEN len, I32 level)
1390 Returns a pointer to the stash for a specified package. Uses C<strlen> to
1391 determine the length of C<name>, then calls C<gv_stashpvn()>.
1393 HV* gv_stashpv(const char* name, I32 flags)
1401 Returns a pointer to the stash for a specified package. The C<namelen>
1402 parameter indicates the length of the C<name>, in bytes. C<flags> is passed
1403 to C<gv_fetchpvn_flags()>, so if set to C<GV_ADD> then the package will be
1404 created if it does not already exist. If the package does not exist and
1405 C<flags> is 0 (or any other setting that does not create packages) then NULL
1409 HV* gv_stashpvn(const char* name, U32 namelen, I32 flags)
1417 Like C<gv_stashpvn>, but takes a literal string instead of a string/length pair.
1419 HV* gv_stashpvs(const char* name, I32 create)
1422 Found in file handy.h
1427 Returns a pointer to the stash for a specified package. See C<gv_stashpvn>.
1429 HV* gv_stashsv(SV* sv, I32 flags)
1452 Null character pointer.
1455 Found in file handy.h
1479 Found in file handy.h
1484 =head1 Hash Manipulation Functions
1491 Returns the HV of the specified Perl hash. If C<create> is set and the
1492 Perl variable does not exist then it will be created. If C<create> is not
1493 set and the variable does not exist then NULL is returned.
1495 NOTE: the perl_ form of this function is deprecated.
1497 HV* get_hv(const char* name, I32 create)
1500 Found in file perl.c
1505 This flag, used in the length slot of hash entries and magic structures,
1506 specifies the structure contains an C<SV*> pointer where a C<char*> pointer
1507 is to be expected. (For information only--not to be used).
1515 Returns the computed hash stored in the hash entry.
1525 Returns the actual pointer stored in the key slot of the hash entry. The
1526 pointer may be either C<char*> or C<SV*>, depending on the value of
1527 C<HeKLEN()>. Can be assigned to. The C<HePV()> or C<HeSVKEY()> macros are
1528 usually preferable for finding the value of a key.
1538 If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry
1539 holds an C<SV*> key. Otherwise, holds the actual length of the key. Can
1540 be assigned to. The C<HePV()> macro is usually preferable for finding key
1543 STRLEN HeKLEN(HE* he)
1551 Returns the key slot of the hash entry as a C<char*> value, doing any
1552 necessary dereferencing of possibly C<SV*> keys. The length of the string
1553 is placed in C<len> (this is a macro, so do I<not> use C<&len>). If you do
1554 not care about what the length of the key is, you may use the global
1555 variable C<PL_na>, though this is rather less efficient than using a local
1556 variable. Remember though, that hash keys in perl are free to contain
1557 embedded nulls, so using C<strlen()> or similar is not a good way to find
1558 the length of hash keys. This is very similar to the C<SvPV()> macro
1559 described elsewhere in this document.
1561 char* HePV(HE* he, STRLEN len)
1569 Returns the key as an C<SV*>, or C<NULL> if the hash entry does not
1570 contain an C<SV*> key.
1580 Returns the key as an C<SV*>. Will create and return a temporary mortal
1581 C<SV*> if the hash entry contains only a C<char*> key.
1583 SV* HeSVKEY_force(HE* he)
1591 Sets the key to a given C<SV*>, taking care to set the appropriate flags to
1592 indicate the presence of an C<SV*> key, and returns the same
1595 SV* HeSVKEY_set(HE* he, SV* sv)
1603 Returns the value slot (type C<SV*>) stored in the hash entry.
1613 Returns the package name of a stash, or NULL if C<stash> isn't a stash.
1614 See C<SvSTASH>, C<CvSTASH>.
1616 char* HvNAME(HV* stash)
1624 Check that a hash is in an internally consistent state.
1626 void hv_assert(HV* tb)
1634 Clears a hash, making it empty.
1636 void hv_clear(HV* tb)
1641 =item hv_clear_placeholders
1642 X<hv_clear_placeholders>
1644 Clears any placeholders from a hash. If a restricted hash has any of its keys
1645 marked as readonly and the key is subsequently deleted, the key is not actually
1646 deleted but is marked by assigning it a value of &PL_sv_placeholder. This tags
1647 it so it will be ignored by future operations such as iterating over the hash,
1648 but will still allow the hash to have a value reassigned to the key at some
1649 future point. This function clears any such placeholder keys from the hash.
1650 See Hash::Util::lock_keys() for an example of its use.
1652 void hv_clear_placeholders(HV* hb)
1660 Deletes a key/value pair in the hash. The value SV is removed from the
1661 hash and returned to the caller. The C<klen> is the length of the key.
1662 The C<flags> value will normally be zero; if set to G_DISCARD then NULL
1665 SV* hv_delete(HV* tb, const char* key, I32 klen, I32 flags)
1673 Deletes a key/value pair in the hash. The value SV is removed from the
1674 hash and returned to the caller. The C<flags> value will normally be zero;
1675 if set to G_DISCARD then NULL will be returned. C<hash> can be a valid
1676 precomputed hash value, or 0 to ask for it to be computed.
1678 SV* hv_delete_ent(HV* tb, SV* key, I32 flags, U32 hash)
1686 Returns a boolean indicating whether the specified hash key exists. The
1687 C<klen> is the length of the key.
1689 bool hv_exists(HV* tb, const char* key, I32 klen)
1697 Returns a boolean indicating whether the specified hash key exists. C<hash>
1698 can be a valid precomputed hash value, or 0 to ask for it to be
1701 bool hv_exists_ent(HV* tb, SV* key, U32 hash)
1709 Returns the SV which corresponds to the specified key in the hash. The
1710 C<klen> is the length of the key. If C<lval> is set then the fetch will be
1711 part of a store. Check that the return value is non-null before
1712 dereferencing it to an C<SV*>.
1714 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1715 information on how to use this function on tied hashes.
1717 SV** hv_fetch(HV* tb, const char* key, I32 klen, I32 lval)
1725 Like C<hv_fetch>, but takes a literal string instead of a string/length pair.
1727 SV** hv_fetchs(HV* tb, const char* key, I32 lval)
1730 Found in file handy.h
1735 Returns the hash entry which corresponds to the specified key in the hash.
1736 C<hash> must be a valid precomputed hash number for the given C<key>, or 0
1737 if you want the function to compute it. IF C<lval> is set then the fetch
1738 will be part of a store. Make sure the return value is non-null before
1739 accessing it. The return value when C<tb> is a tied hash is a pointer to a
1740 static location, so be sure to make a copy of the structure if you need to
1743 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1744 information on how to use this function on tied hashes.
1746 HE* hv_fetch_ent(HV* tb, SV* key, I32 lval, U32 hash)
1754 Prepares a starting point to traverse a hash table. Returns the number of
1755 keys in the hash (i.e. the same as C<HvKEYS(tb)>). The return value is
1756 currently only meaningful for hashes without tie magic.
1758 NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
1759 hash buckets that happen to be in use. If you still need that esoteric
1760 value, you can get it through the macro C<HvFILL(tb)>.
1763 I32 hv_iterinit(HV* tb)
1771 Returns the key from the current position of the hash iterator. See
1774 char* hv_iterkey(HE* entry, I32* retlen)
1782 Returns the key as an C<SV*> from the current position of the hash
1783 iterator. The return value will always be a mortal copy of the key. Also
1786 SV* hv_iterkeysv(HE* entry)
1794 Returns entries from a hash iterator. See C<hv_iterinit>.
1796 You may call C<hv_delete> or C<hv_delete_ent> on the hash entry that the
1797 iterator currently points to, without losing your place or invalidating your
1798 iterator. Note that in this case the current entry is deleted from the hash
1799 with your iterator holding the last reference to it. Your iterator is flagged
1800 to free the entry on the next call to C<hv_iternext>, so you must not discard
1801 your iterator immediately else the entry will leak - call C<hv_iternext> to
1802 trigger the resource deallocation.
1804 HE* hv_iternext(HV* tb)
1812 Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
1815 SV* hv_iternextsv(HV* hv, char** key, I32* retlen)
1820 =item hv_iternext_flags
1821 X<hv_iternext_flags>
1823 Returns entries from a hash iterator. See C<hv_iterinit> and C<hv_iternext>.
1824 The C<flags> value will normally be zero; if HV_ITERNEXT_WANTPLACEHOLDERS is
1825 set the placeholders keys (for restricted hashes) will be returned in addition
1826 to normal keys. By default placeholders are automatically skipped over.
1827 Currently a placeholder is implemented with a value that is
1828 C<&Perl_sv_placeholder>. Note that the implementation of placeholders and
1829 restricted hashes may change, and the implementation currently is
1830 insufficiently abstracted for any change to be tidy.
1832 NOTE: this function is experimental and may change or be
1833 removed without notice.
1835 HE* hv_iternext_flags(HV* tb, I32 flags)
1843 Returns the value from the current position of the hash iterator. See
1846 SV* hv_iterval(HV* tb, HE* entry)
1854 Adds magic to a hash. See C<sv_magic>.
1856 void hv_magic(HV* hv, GV* gv, int how)
1864 Evaluates the hash in scalar context and returns the result. Handles magic when the hash is tied.
1866 SV* hv_scalar(HV* hv)
1874 Stores an SV in a hash. The hash key is specified as C<key> and C<klen> is
1875 the length of the key. The C<hash> parameter is the precomputed hash
1876 value; if it is zero then Perl will compute it. The return value will be
1877 NULL if the operation failed or if the value did not need to be actually
1878 stored within the hash (as in the case of tied hashes). Otherwise it can
1879 be dereferenced to get the original C<SV*>. Note that the caller is
1880 responsible for suitably incrementing the reference count of C<val> before
1881 the call, and decrementing it if the function returned NULL. Effectively
1882 a successful hv_store takes ownership of one reference to C<val>. This is
1883 usually what you want; a newly created SV has a reference count of one, so
1884 if all your code does is create SVs then store them in a hash, hv_store
1885 will own the only reference to the new SV, and your code doesn't need to do
1886 anything further to tidy up. hv_store is not implemented as a call to
1887 hv_store_ent, and does not create a temporary SV for the key, so if your
1888 key data is not already in SV form then use hv_store in preference to
1891 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1892 information on how to use this function on tied hashes.
1894 SV** hv_store(HV* tb, const char* key, I32 klen, SV* val, U32 hash)
1902 Like C<hv_store>, but takes a literal string instead of a string/length pair
1903 and omits the hash parameter.
1905 SV** hv_stores(HV* tb, const char* key, NULLOK SV* val)
1908 Found in file handy.h
1913 Stores C<val> in a hash. The hash key is specified as C<key>. The C<hash>
1914 parameter is the precomputed hash value; if it is zero then Perl will
1915 compute it. The return value is the new hash entry so created. It will be
1916 NULL if the operation failed or if the value did not need to be actually
1917 stored within the hash (as in the case of tied hashes). Otherwise the
1918 contents of the return value can be accessed using the C<He?> macros
1919 described here. Note that the caller is responsible for suitably
1920 incrementing the reference count of C<val> before the call, and
1921 decrementing it if the function returned NULL. Effectively a successful
1922 hv_store_ent takes ownership of one reference to C<val>. This is
1923 usually what you want; a newly created SV has a reference count of one, so
1924 if all your code does is create SVs then store them in a hash, hv_store
1925 will own the only reference to the new SV, and your code doesn't need to do
1926 anything further to tidy up. Note that hv_store_ent only reads the C<key>;
1927 unlike C<val> it does not take ownership of it, so maintaining the correct
1928 reference count on C<key> is entirely the caller's responsibility. hv_store
1929 is not implemented as a call to hv_store_ent, and does not create a temporary
1930 SV for the key, so if your key data is not already in SV form then use
1931 hv_store in preference to hv_store_ent.
1933 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1934 information on how to use this function on tied hashes.
1936 HE* hv_store_ent(HV* tb, SV* key, SV* val, U32 hash)
1946 void hv_undef(HV* tb)
1954 Creates a new HV. The reference count is set to 1.
1964 =head1 Magical Functions
1971 Clear something magical that the SV represents. See C<sv_magic>.
1973 int mg_clear(SV* sv)
1981 Copies the magic from one SV to another. See C<sv_magic>.
1983 int mg_copy(SV* sv, SV* nsv, const char* key, I32 klen)
1991 Finds the magic pointer for type matching the SV. See C<sv_magic>.
1993 MAGIC* mg_find(const SV* sv, int type)
2001 Free any magic storage used by the SV. See C<sv_magic>.
2011 Do magic after a value is retrieved from the SV. See C<sv_magic>.
2021 Report on the SV's length. See C<sv_magic>.
2023 U32 mg_length(SV* sv)
2031 Turns on the magical status of an SV. See C<sv_magic>.
2033 void mg_magical(SV* sv)
2041 Do magic after a value is assigned to the SV. See C<sv_magic>.
2051 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
2052 argument more than once.
2054 void SvGETMAGIC(SV* sv)
2062 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
2073 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
2074 argument more than once.
2076 void SvSETMAGIC(SV* sv)
2084 Like C<SvSetSV>, but does any set magic required afterwards.
2086 void SvSetMagicSV(SV* dsb, SV* ssv)
2091 =item SvSetMagicSV_nosteal
2092 X<SvSetMagicSV_nosteal>
2094 Like C<SvSetSV_nosteal>, but does any set magic required afterwards.
2096 void SvSetMagicSV_nosteal(SV* dsv, SV* ssv)
2104 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
2107 void SvSetSV(SV* dsb, SV* ssv)
2112 =item SvSetSV_nosteal
2115 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
2116 ssv. May evaluate arguments more than once.
2118 void SvSetSV_nosteal(SV* dsv, SV* ssv)
2126 Arranges for sv to be shared between threads if a suitable module
2129 void SvSHARE(SV* sv)
2137 Releases a mutual exclusion lock on sv if a suitable module
2140 void SvUNLOCK(SV* sv)
2148 =head1 Memory Management
2155 The XSUB-writer's interface to the C C<memcpy> function. The C<src> is the
2156 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
2157 the type. May fail on overlapping copies. See also C<Move>.
2159 void Copy(void* src, void* dest, int nitems, type)
2162 Found in file handy.h
2167 Like C<Copy> but returns dest. Useful for encouraging compilers to tail-call
2170 void * CopyD(void* src, void* dest, int nitems, type)
2173 Found in file handy.h
2178 The XSUB-writer's interface to the C C<memmove> function. The C<src> is the
2179 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
2180 the type. Can do overlapping moves. See also C<Copy>.
2182 void Move(void* src, void* dest, int nitems, type)
2185 Found in file handy.h
2190 Like C<Move> but returns dest. Useful for encouraging compilers to tail-call
2193 void * MoveD(void* src, void* dest, int nitems, type)
2196 Found in file handy.h
2201 The XSUB-writer's interface to the C C<malloc> function.
2203 In 5.9.3, Newx() and friends replace the older New() API, and drops
2204 the first parameter, I<x>, a debug aid which allowed callers to identify
2205 themselves. This aid has been superseded by a new build option,
2206 PERL_MEM_LOG (see L<perlhack/PERL_MEM_LOG>). The older API is still
2207 there for use in XS modules supporting older perls.
2209 void Newx(void* ptr, int nitems, type)
2212 Found in file handy.h
2217 The XSUB-writer's interface to the C C<malloc> function, with
2218 cast. See also C<Newx>.
2220 void Newxc(void* ptr, int nitems, type, cast)
2223 Found in file handy.h
2228 The XSUB-writer's interface to the C C<malloc> function. The allocated
2229 memory is zeroed with C<memzero>. See also C<Newx>.
2231 void Newxz(void* ptr, int nitems, type)
2234 Found in file handy.h
2239 PoisonWith(0xEF) for catching access to freed memory.
2241 void Poison(void* dest, int nitems, type)
2244 Found in file handy.h
2249 PoisonWith(0xEF) for catching access to freed memory.
2251 void PoisonFree(void* dest, int nitems, type)
2254 Found in file handy.h
2259 PoisonWith(0xAB) for catching access to allocated but uninitialized memory.
2261 void PoisonNew(void* dest, int nitems, type)
2264 Found in file handy.h
2269 Fill up memory with a byte pattern (a byte repeated over and over
2270 again) that hopefully catches attempts to access uninitialized memory.
2272 void PoisonWith(void* dest, int nitems, type, U8 byte)
2275 Found in file handy.h
2280 The XSUB-writer's interface to the C C<realloc> function.
2282 void Renew(void* ptr, int nitems, type)
2285 Found in file handy.h
2290 The XSUB-writer's interface to the C C<realloc> function, with
2293 void Renewc(void* ptr, int nitems, type, cast)
2296 Found in file handy.h
2301 The XSUB-writer's interface to the C C<free> function.
2303 void Safefree(void* ptr)
2306 Found in file handy.h
2311 Perl's version of C<strdup()>. Returns a pointer to a newly allocated
2312 string which is a duplicate of C<pv>. The size of the string is
2313 determined by C<strlen()>. The memory allocated for the new string can
2314 be freed with the C<Safefree()> function.
2316 char* savepv(const char* pv)
2319 Found in file util.c
2324 Perl's version of what C<strndup()> would be if it existed. Returns a
2325 pointer to a newly allocated string which is a duplicate of the first
2326 C<len> bytes from C<pv>, plus a trailing NUL byte. The memory allocated for
2327 the new string can be freed with the C<Safefree()> function.
2329 char* savepvn(const char* pv, I32 len)
2332 Found in file util.c
2337 Like C<savepvn>, but takes a literal string instead of a string/length pair.
2339 char* savepvs(const char* s)
2342 Found in file handy.h
2347 A version of C<savepv()> which allocates the duplicate string in memory
2348 which is shared between threads.
2350 char* savesharedpv(const char* pv)
2353 Found in file util.c
2358 A version of C<savepvn()> which allocates the duplicate string in memory
2359 which is shared between threads. (With the specific difference that a NULL
2360 pointer is not acceptable)
2362 char* savesharedpvn(const char *const pv, const STRLEN len)
2365 Found in file util.c
2370 A version of C<savepv()>/C<savepvn()> which gets the string to duplicate from
2371 the passed in SV using C<SvPV()>
2373 char* savesvpv(SV* sv)
2376 Found in file util.c
2381 This is an architecture-independent macro to copy one structure to another.
2383 void StructCopy(type src, type dest, type)
2386 Found in file handy.h
2391 The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the
2392 destination, C<nitems> is the number of items, and C<type> is the type.
2394 void Zero(void* dest, int nitems, type)
2397 Found in file handy.h
2402 Like C<Zero> but returns dest. Useful for encouraging compilers to tail-call
2405 void * ZeroD(void* dest, int nitems, type)
2408 Found in file handy.h
2413 =head1 Miscellaneous Functions
2420 Analyses the string in order to make fast searches on it using fbm_instr()
2421 -- the Boyer-Moore algorithm.
2423 void fbm_compile(SV* sv, U32 flags)
2426 Found in file util.c
2431 Returns the location of the SV in the string delimited by C<str> and
2432 C<strend>. It returns C<NULL> if the string can't be found. The C<sv>
2433 does not have to be fbm_compiled, but the search will not be as fast
2436 char* fbm_instr(unsigned char* big, unsigned char* bigend, SV* littlesv, U32 flags)
2439 Found in file util.c
2444 Takes a sprintf-style format pattern and conventional
2445 (non-SV) arguments and returns the formatted string.
2447 (char *) Perl_form(pTHX_ const char* pat, ...)
2449 can be used any place a string (char *) is required:
2451 char * s = Perl_form("%d.%d",major,minor);
2453 Uses a single private buffer so if you want to format several strings you
2454 must explicitly copy the earlier strings away (and free the copies when you
2457 char* form(const char* pat, ...)
2460 Found in file util.c
2465 Fill the sv with current working directory
2467 int getcwd_sv(SV* sv)
2470 Found in file util.c
2475 The C library C<snprintf> functionality, if available and
2476 standards-compliant (uses C<vsnprintf>, actually). However, if the
2477 C<vsnprintf> is not available, will unfortunately use the unsafe
2478 C<vsprintf> which can overrun the buffer (there is an overrun check,
2479 but that may be too late). Consider using C<sv_vcatpvf> instead, or
2480 getting C<vsnprintf>.
2482 int my_snprintf(char *buffer, const Size_t len, const char *format, ...)
2485 Found in file util.c
2490 The C library C<sprintf>, wrapped if necessary, to ensure that it will return
2491 the length of the string written to the buffer. Only rare pre-ANSI systems
2492 need the wrapper function - usually this is a direct call to C<sprintf>.
2494 int my_sprintf(char *buffer, const char *pat, ...)
2497 Found in file util.c
2502 The C library C<vsnprintf> if available and standards-compliant.
2503 However, if if the C<vsnprintf> is not available, will unfortunately
2504 use the unsafe C<vsprintf> which can overrun the buffer (there is an
2505 overrun check, but that may be too late). Consider using
2506 C<sv_vcatpvf> instead, or getting C<vsnprintf>.
2508 int my_vsnprintf(char *buffer, const Size_t len, const char *format, va_list ap)
2511 Found in file util.c
2516 Returns a new version object based on the passed in SV:
2518 SV *sv = new_version(SV *ver);
2520 Does not alter the passed in ver SV. See "upg_version" if you
2521 want to upgrade the SV.
2523 SV* new_version(SV *ver)
2526 Found in file util.c
2531 Returns a pointer to the next character after the parsed
2532 version string, as well as upgrading the passed in SV to
2535 Function must be called with an already existing SV like
2538 s = scan_version(s, SV *sv, bool qv);
2540 Performs some preprocessing to the string to ensure that
2541 it has the correct characteristics of a version. Flags the
2542 object if it contains an underscore (which denotes this
2543 is an alpha version). The boolean qv denotes that the version
2544 should be interpreted as if it had multiple decimals, even if
2547 const char* scan_version(const char *vstr, SV *sv, bool qv)
2550 Found in file util.c
2555 Test two strings to see if they are equal. Returns true or false.
2557 bool strEQ(char* s1, char* s2)
2560 Found in file handy.h
2565 Test two strings to see if the first, C<s1>, is greater than or equal to
2566 the second, C<s2>. Returns true or false.
2568 bool strGE(char* s1, char* s2)
2571 Found in file handy.h
2576 Test two strings to see if the first, C<s1>, is greater than the second,
2577 C<s2>. Returns true or false.
2579 bool strGT(char* s1, char* s2)
2582 Found in file handy.h
2587 Test two strings to see if the first, C<s1>, is less than or equal to the
2588 second, C<s2>. Returns true or false.
2590 bool strLE(char* s1, char* s2)
2593 Found in file handy.h
2598 Test two strings to see if the first, C<s1>, is less than the second,
2599 C<s2>. Returns true or false.
2601 bool strLT(char* s1, char* s2)
2604 Found in file handy.h
2609 Test two strings to see if they are different. Returns true or
2612 bool strNE(char* s1, char* s2)
2615 Found in file handy.h
2620 Test two strings to see if they are equal. The C<len> parameter indicates
2621 the number of bytes to compare. Returns true or false. (A wrapper for
2624 bool strnEQ(char* s1, char* s2, STRLEN len)
2627 Found in file handy.h
2632 Test two strings to see if they are different. The C<len> parameter
2633 indicates the number of bytes to compare. Returns true or false. (A
2634 wrapper for C<strncmp>).
2636 bool strnNE(char* s1, char* s2, STRLEN len)
2639 Found in file handy.h
2644 Dummy routine which "shares" an SV when there is no sharing module present.
2645 Or "locks" it. Or "unlocks" it. In other words, ignores its single SV argument.
2646 Exists to avoid test for a NULL function pointer and because it could
2647 potentially warn under some level of strict-ness.
2649 void sv_nosharing(SV *sv)
2652 Found in file util.c
2657 In-place upgrade of the supplied SV to a version object.
2659 SV *sv = upg_version(SV *sv, bool qv);
2661 Returns a pointer to the upgraded SV. Set the boolean qv if you want
2662 to force this SV to be interpreted as an "extended" version.
2664 SV* upg_version(SV *ver, bool qv)
2667 Found in file util.c
2672 Version object aware cmp. Both operands must already have been
2673 converted into version objects.
2675 int vcmp(SV *lvs, SV *rvs)
2678 Found in file util.c
2683 Accepts a version object and returns the normalized string
2684 representation. Call like:
2688 NOTE: you can pass either the object directly or the SV
2689 contained within the RV.
2694 Found in file util.c
2699 Accepts a version object and returns the normalized floating
2700 point representation. Call like:
2704 NOTE: you can pass either the object directly or the SV
2705 contained within the RV.
2710 Found in file util.c
2715 In order to maintain maximum compatibility with earlier versions
2716 of Perl, this function will return either the floating point
2717 notation or the multiple dotted notation, depending on whether
2718 the original version contained 1 or more dots, respectively
2720 SV* vstringify(SV *vs)
2723 Found in file util.c
2728 Validates that the SV contains a valid version object.
2730 bool vverify(SV *vobj);
2732 Note that it only confirms the bare minimum structure (so as not to get
2733 confused by derived classes which may contain additional hash entries):
2735 bool vverify(SV *vs)
2738 Found in file util.c
2743 =head1 Multicall Functions
2750 Declare local variables for a multicall. See L<perlcall/Lightweight Callbacks>.
2760 Make a lightweight callback. See L<perlcall/Lightweight Callbacks>.
2770 Closing bracket for a lightweight callback.
2771 See L<perlcall/Lightweight Callbacks>.
2778 =item PUSH_MULTICALL
2781 Opening bracket for a lightweight callback.
2782 See L<perlcall/Lightweight Callbacks>.
2792 =head1 Numeric functions
2799 converts a string representing a binary number to numeric form.
2801 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2802 conversion flags, and I<result> should be NULL or a pointer to an NV.
2803 The scan stops at the end of the string, or the first invalid character.
2804 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2805 invalid character will also trigger a warning.
2806 On return I<*len> is set to the length of the scanned string,
2807 and I<*flags> gives output flags.
2809 If the value is <= C<UV_MAX> it is returned as a UV, the output flags are clear,
2810 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_bin>
2811 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2812 and writes the value to I<*result> (or the value is discarded if I<result>
2815 The binary number may optionally be prefixed with "0b" or "b" unless
2816 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
2817 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the binary
2818 number may use '_' characters to separate digits.
2820 UV grok_bin(const char* start, STRLEN* len_p, I32* flags, NV *result)
2823 Found in file numeric.c
2828 converts a string representing a hex 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 <= 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_hex>
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 hex number may optionally be prefixed with "0x" or "x" 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 hex
2847 number may use '_' characters to separate digits.
2849 UV grok_hex(const char* start, STRLEN* len_p, I32* flags, NV *result)
2852 Found in file numeric.c
2857 Recognise (or not) a number. The type of the number is returned
2858 (0 if unrecognised), otherwise it is a bit-ORed combination of
2859 IS_NUMBER_IN_UV, IS_NUMBER_GREATER_THAN_UV_MAX, IS_NUMBER_NOT_INT,
2860 IS_NUMBER_NEG, IS_NUMBER_INFINITY, IS_NUMBER_NAN (defined in perl.h).
2862 If the value of the number can fit an in UV, it is returned in the *valuep
2863 IS_NUMBER_IN_UV will be set to indicate that *valuep is valid, IS_NUMBER_IN_UV
2864 will never be set unless *valuep is valid, but *valuep may have been assigned
2865 to during processing even though IS_NUMBER_IN_UV is not set on return.
2866 If valuep is NULL, IS_NUMBER_IN_UV will be set for the same cases as when
2867 valuep is non-NULL, but no actual assignment (or SEGV) will occur.
2869 IS_NUMBER_NOT_INT will be set with IS_NUMBER_IN_UV if trailing decimals were
2870 seen (in which case *valuep gives the true value truncated to an integer), and
2871 IS_NUMBER_NEG if the number is negative (in which case *valuep holds the
2872 absolute value). IS_NUMBER_IN_UV is not set if e notation was used or the
2873 number is larger than a UV.
2875 int grok_number(const char *pv, STRLEN len, UV *valuep)
2878 Found in file numeric.c
2880 =item grok_numeric_radix
2881 X<grok_numeric_radix>
2883 Scan and skip for a numeric decimal separator (radix).
2885 bool grok_numeric_radix(const char **sp, const char *send)
2888 Found in file numeric.c
2893 converts a string representing an octal number to numeric form.
2895 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2896 conversion flags, and I<result> should be NULL or a pointer to an NV.
2897 The scan stops at the end of the string, or the first invalid character.
2898 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2899 invalid character will also trigger a warning.
2900 On return I<*len> is set to the length of the scanned string,
2901 and I<*flags> gives output flags.
2903 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2904 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_oct>
2905 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2906 and writes the value to I<*result> (or the value is discarded if I<result>
2909 If C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the octal
2910 number may use '_' characters to separate digits.
2912 UV grok_oct(const char* start, STRLEN* len_p, I32* flags, NV *result)
2915 Found in file numeric.c
2920 Return a non-zero integer if the sign bit on an NV is set, and 0 if
2923 If Configure detects this system has a signbit() that will work with
2924 our NVs, then we just use it via the #define in perl.h. Otherwise,
2925 fall back on this implementation. As a first pass, this gets everything
2926 right except -0.0. Alas, catching -0.0 is the main use for this function,
2927 so this is not too helpful yet. Still, at least we have the scaffolding
2928 in place to support other systems, should that prove useful.
2931 Configure notes: This function is called 'Perl_signbit' instead of a
2932 plain 'signbit' because it is easy to imagine a system having a signbit()
2933 function or macro that doesn't happen to work with our particular choice
2934 of NVs. We shouldn't just re-#define signbit as Perl_signbit and expect
2935 the standard system headers to be happy. Also, this is a no-context
2936 function (no pTHX_) because Perl_signbit() is usually re-#defined in
2937 perl.h as a simple macro call to the system's signbit().
2938 Users should just always call Perl_signbit().
2940 NOTE: this function is experimental and may change or be
2941 removed without notice.
2943 int Perl_signbit(NV f)
2946 Found in file numeric.c
2951 For backwards compatibility. Use C<grok_bin> instead.
2953 NV scan_bin(const char* start, STRLEN len, STRLEN* retlen)
2956 Found in file numeric.c
2961 For backwards compatibility. Use C<grok_hex> instead.
2963 NV scan_hex(const char* start, STRLEN len, STRLEN* retlen)
2966 Found in file numeric.c
2971 For backwards compatibility. Use C<grok_oct> instead.
2973 NV scan_oct(const char* start, STRLEN len, STRLEN* retlen)
2976 Found in file numeric.c
2981 =head1 Optree Manipulation Functions
2988 If C<cv> is a constant sub eligible for inlining. returns the constant
2989 value returned by the sub. Otherwise, returns NULL.
2991 Constant subs can be created with C<newCONSTSUB> or as described in
2992 L<perlsub/"Constant Functions">.
2994 SV* cv_const_sv(CV* cv)
3002 Creates a constant sub equivalent to Perl C<sub FOO () { 123 }> which is
3003 eligible for inlining at compile-time.
3005 CV* newCONSTSUB(HV* stash, const char* name, SV* sv)
3013 Used by C<xsubpp> to hook up XSUBs as Perl subs. I<filename> needs to be
3014 static storage, as it is used directly as CvFILE(), without a copy being made.
3022 =head1 Pad Data Structures
3029 Get the value at offset po in the current pad.
3030 Use macro PAD_SV instead of calling this function directly.
3032 SV* pad_sv(PADOFFSET po)
3040 =head1 Simple Exception Handling Macros
3047 Set up necessary local variables for exception handling.
3048 See L<perlguts/"Exception Handling">.
3053 Found in file XSUB.h
3058 Introduces a catch block. See L<perlguts/"Exception Handling">.
3061 Found in file XSUB.h
3066 Rethrows a previously caught exception. See L<perlguts/"Exception Handling">.
3071 Found in file XSUB.h
3076 Ends a try block. See L<perlguts/"Exception Handling">.
3079 Found in file XSUB.h
3081 =item XCPT_TRY_START
3084 Starts a try block. See L<perlguts/"Exception Handling">.
3087 Found in file XSUB.h
3092 =head1 Stack Manipulation Macros
3099 Declare a stack marker variable, C<mark>, for the XSUB. See C<MARK> and
3110 Saves the original stack mark for the XSUB. See C<ORIGMARK>.
3120 Declares a local copy of perl's stack pointer for the XSUB, available via
3121 the C<SP> macro. See C<SP>.
3131 Used to extend the argument stack for an XSUB's return values. Once
3132 used, guarantees that there is room for at least C<nitems> to be pushed
3135 void EXTEND(SP, int nitems)
3143 Stack marker variable for the XSUB. See C<dMARK>.
3151 Push an integer onto the stack. The stack must have room for this element.
3152 Handles 'set' magic. Does not use C<TARG>. See also C<PUSHi>, C<mXPUSHi>
3163 Push a double onto the stack. The stack must have room for this element.
3164 Handles 'set' magic. Does not use C<TARG>. See also C<PUSHn>, C<mXPUSHn>
3175 Push a string onto the stack. The stack must have room for this element.
3176 The C<len> indicates the length of the string. Handles 'set' magic. Does
3177 not use C<TARG>. See also C<PUSHp>, C<mXPUSHp> and C<XPUSHp>.
3179 void mPUSHp(char* str, STRLEN len)
3187 Push an unsigned integer onto the stack. The stack must have room for this
3188 element. Handles 'set' magic. Does not use C<TARG>. See also C<PUSHu>,
3189 C<mXPUSHu> and C<XPUSHu>.
3199 Push an integer onto the stack, extending the stack if necessary. Handles
3200 'set' magic. Does not use C<TARG>. See also C<XPUSHi>, C<mPUSHi> and
3211 Push a double onto the stack, extending the stack if necessary. Handles
3212 'set' magic. Does not use C<TARG>. See also C<XPUSHn>, C<mPUSHn> and
3223 Push a string onto the stack, extending the stack if necessary. The C<len>
3224 indicates the length of the string. Handles 'set' magic. Does not use
3225 C<TARG>. See also C<XPUSHp>, C<mPUSHp> and C<PUSHp>.
3227 void mXPUSHp(char* str, STRLEN len)
3235 Push an unsigned integer onto the stack, extending the stack if necessary.
3236 Handles 'set' magic. Does not use C<TARG>. See also C<XPUSHu>, C<mPUSHu>
3247 The original stack mark for the XSUB. See C<dORIGMARK>.
3255 Pops an integer off the stack.
3265 Pops a long off the stack.
3275 Pops a double off the stack.
3285 Pops a string off the stack. Deprecated. New code should use POPpx.
3295 Pops a string off the stack which must consist of bytes i.e. characters < 256.
3305 Pops a string off the stack.
3315 Pops an SV off the stack.
3325 Push an integer onto the stack. The stack must have room for this element.
3326 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3327 called to declare it. Do not call multiple C<TARG>-oriented macros to
3328 return lists from XSUB's - see C<mPUSHi> instead. See also C<XPUSHi> and
3339 Opening bracket for arguments on a callback. See C<PUTBACK> and
3350 Push a new mortal SV onto the stack. The stack must have room for this
3351 element. Does not handle 'set' magic. Does not use C<TARG>. See also
3352 C<PUSHs>, C<XPUSHmortal> and C<XPUSHs>.
3362 Push a double onto the stack. The stack must have room for this element.
3363 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3364 called to declare it. Do not call multiple C<TARG>-oriented macros to
3365 return lists from XSUB's - see C<mPUSHn> instead. See also C<XPUSHn> and
3376 Push a string onto the stack. The stack must have room for this element.
3377 The C<len> indicates the length of the string. Handles 'set' magic. Uses
3378 C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to declare it. Do not
3379 call multiple C<TARG>-oriented macros to return lists from XSUB's - see
3380 C<mPUSHp> instead. See also C<XPUSHp> and C<mXPUSHp>.
3382 void PUSHp(char* str, STRLEN len)
3390 Push an SV onto the stack. The stack must have room for this element.
3391 Does not handle 'set' magic. Does not use C<TARG>. See also C<PUSHmortal>,
3392 C<XPUSHs> and C<XPUSHmortal>.
3402 Push an unsigned integer onto the stack. The stack must have room for this
3403 element. Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG>
3404 should be called to declare it. Do not call multiple C<TARG>-oriented
3405 macros to return lists from XSUB's - see C<mPUSHu> instead. See also
3406 C<XPUSHu> and C<mXPUSHu>.
3416 Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
3417 See C<PUSHMARK> and L<perlcall> for other uses.
3427 Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and
3436 Refetch the stack pointer. Used after a callback. See L<perlcall>.
3446 Push an integer onto the stack, extending the stack if necessary. Handles
3447 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
3448 declare it. Do not call multiple C<TARG>-oriented macros to return lists
3449 from XSUB's - see C<mXPUSHi> instead. See also C<PUSHi> and C<mPUSHi>.
3459 Push a new mortal SV onto the stack, extending the stack if necessary. Does
3460 not handle 'set' magic. Does not use C<TARG>. See also C<XPUSHs>,
3461 C<PUSHmortal> and C<PUSHs>.
3471 Push a double onto the stack, extending the stack if necessary. Handles
3472 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
3473 declare it. Do not call multiple C<TARG>-oriented macros to return lists
3474 from XSUB's - see C<mXPUSHn> instead. See also C<PUSHn> and C<mPUSHn>.
3484 Push a string onto the stack, extending the stack if necessary. The C<len>
3485 indicates the length of the string. Handles 'set' magic. Uses C<TARG>, so
3486 C<dTARGET> or C<dXSTARG> should be called to declare it. Do not call
3487 multiple C<TARG>-oriented macros to return lists from XSUB's - see
3488 C<mXPUSHp> instead. See also C<PUSHp> and C<mPUSHp>.
3490 void XPUSHp(char* str, STRLEN len)
3498 Push an SV onto the stack, extending the stack if necessary. Does not
3499 handle 'set' magic. Does not use C<TARG>. See also C<XPUSHmortal>,
3500 C<PUSHs> and C<PUSHmortal>.
3510 Push an unsigned integer onto the stack, extending the stack if necessary.
3511 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3512 called to declare it. Do not call multiple C<TARG>-oriented macros to
3513 return lists from XSUB's - see C<mXPUSHu> instead. See also C<PUSHu> and
3524 Return from XSUB, indicating number of items on the stack. This is usually
3525 handled by C<xsubpp>.
3527 void XSRETURN(int nitems)
3530 Found in file XSUB.h
3532 =item XSRETURN_EMPTY
3535 Return an empty list from an XSUB immediately.
3540 Found in file XSUB.h
3545 Return an integer from an XSUB immediately. Uses C<XST_mIV>.
3547 void XSRETURN_IV(IV iv)
3550 Found in file XSUB.h
3555 Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
3560 Found in file XSUB.h
3565 Return a double from an XSUB immediately. Uses C<XST_mNV>.
3567 void XSRETURN_NV(NV nv)
3570 Found in file XSUB.h
3575 Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
3577 void XSRETURN_PV(char* str)
3580 Found in file XSUB.h
3582 =item XSRETURN_UNDEF
3585 Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
3590 Found in file XSUB.h
3595 Return an integer from an XSUB immediately. Uses C<XST_mUV>.
3597 void XSRETURN_UV(IV uv)
3600 Found in file XSUB.h
3605 Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
3610 Found in file XSUB.h
3615 Place an integer into the specified position C<pos> on the stack. The
3616 value is stored in a new mortal SV.
3618 void XST_mIV(int pos, IV iv)
3621 Found in file XSUB.h
3626 Place C<&PL_sv_no> into the specified position C<pos> on the
3629 void XST_mNO(int pos)
3632 Found in file XSUB.h
3637 Place a double into the specified position C<pos> on the stack. The value
3638 is stored in a new mortal SV.
3640 void XST_mNV(int pos, NV nv)
3643 Found in file XSUB.h
3648 Place a copy of a string into the specified position C<pos> on the stack.
3649 The value is stored in a new mortal SV.
3651 void XST_mPV(int pos, char* str)
3654 Found in file XSUB.h
3659 Place C<&PL_sv_undef> into the specified position C<pos> on the
3662 void XST_mUNDEF(int pos)
3665 Found in file XSUB.h
3670 Place C<&PL_sv_yes> into the specified position C<pos> on the
3673 void XST_mYES(int pos)
3676 Found in file XSUB.h
3688 An enum of flags for Perl types. These are found in the file B<sv.h>
3689 in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
3697 Integer type flag for scalars. See C<svtype>.
3705 Double type flag for scalars. See C<svtype>.
3713 Pointer type flag for scalars. See C<svtype>.
3721 Type flag for arrays. See C<svtype>.
3729 Type flag for code refs. See C<svtype>.
3737 Type flag for hashes. See C<svtype>.
3745 Type flag for blessed scalars. See C<svtype>.
3753 =head1 SV Manipulation Functions
3760 Returns the SV of the specified Perl scalar. If C<create> is set and the
3761 Perl variable does not exist then it will be created. If C<create> is not
3762 set and the variable does not exist then NULL is returned.
3764 NOTE: the perl_ form of this function is deprecated.
3766 SV* get_sv(const char* name, I32 create)
3769 Found in file perl.c
3774 Creates an RV wrapper for an SV. The reference count for the original SV is
3777 SV* newRV_inc(SV* sv)
3785 Returns the length of the string which is in the SV. See C<SvLEN>.
3787 STRLEN SvCUR(SV* sv)
3795 Set the current length of the string which is in the SV. See C<SvCUR>
3798 void SvCUR_set(SV* sv, STRLEN len)
3806 Returns a pointer to the last character in the string which is in the SV.
3807 See C<SvCUR>. Access the character as *(SvEND(sv)).
3817 Returns true if the SV has get magic or overloading. If either is true then
3818 the scalar is active data, and has the potential to return a new value every
3819 time it is accessed. Hence you must be careful to only read it once per user
3820 logical operation and work with that returned value. If neither is true then
3821 the scalar's value cannot change unless written to.
3823 char* SvGAMAGIC(SV* sv)
3831 Expands the character buffer in the SV so that it has room for the
3832 indicated number of bytes (remember to reserve space for an extra trailing
3833 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
3834 Returns a pointer to the character buffer.
3836 char * SvGROW(SV* sv, STRLEN len)
3844 Returns a U32 value indicating whether the SV contains an integer.
3854 Returns a U32 value indicating whether the SV contains an integer. Checks
3855 the B<private> setting. Use C<SvIOK>.
3865 Returns a boolean indicating whether the SV contains a signed integer.
3867 bool SvIOK_notUV(SV* sv)
3875 Unsets the IV status of an SV.
3877 void SvIOK_off(SV* sv)
3885 Tells an SV that it is an integer.
3887 void SvIOK_on(SV* sv)
3895 Tells an SV that it is an integer and disables all other OK bits.
3897 void SvIOK_only(SV* sv)
3905 Tells and SV that it is an unsigned integer and disables all other OK bits.
3907 void SvIOK_only_UV(SV* sv)
3915 Returns a boolean indicating whether the SV contains an unsigned integer.
3917 bool SvIOK_UV(SV* sv)
3925 Returns a boolean indicating whether the SV is Copy-On-Write. (either shared
3926 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
3929 bool SvIsCOW(SV* sv)
3934 =item SvIsCOW_shared_hash
3935 X<SvIsCOW_shared_hash>
3937 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
3940 bool SvIsCOW_shared_hash(SV* sv)
3948 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
3949 version which guarantees to evaluate sv only once.
3959 Returns the raw value in the SV's IV slot, without checks or conversions.
3960 Only use when you are sure SvIOK is true. See also C<SvIV()>.
3970 Coerces the given SV to an integer and returns it. Guarantees to evaluate
3971 C<sv> only once. Only use this if C<sv> is an expression with side effects,
3972 otherwise use the more efficient C<SvIV>.
3982 Like C<SvIV> but doesn't process magic.
3984 IV SvIV_nomg(SV* sv)
3992 Set the value of the IV pointer in sv to val. It is possible to perform
3993 the same function of this macro with an lvalue assignment to C<SvIVX>.
3994 With future Perls, however, it will be more efficient to use
3995 C<SvIV_set> instead of the lvalue assignment to C<SvIVX>.
3997 void SvIV_set(SV* sv, IV val)
4005 Returns the size of the string buffer in the SV, not including any part
4006 attributable to C<SvOOK>. See C<SvCUR>.
4008 STRLEN SvLEN(SV* sv)
4016 Set the actual length of the string which is in the SV. See C<SvIV_set>.
4018 void SvLEN_set(SV* sv, STRLEN len)
4026 Set the value of the MAGIC pointer in sv to val. See C<SvIV_set>.
4028 void SvMAGIC_set(SV* sv, MAGIC* val)
4036 Returns a U32 value indicating whether the SV contains a number, integer or
4047 Returns a U32 value indicating whether the SV contains a number, integer or
4048 double. Checks the B<private> setting. Use C<SvNIOK>.
4058 Unsets the NV/IV status of an SV.
4060 void SvNIOK_off(SV* sv)
4068 Returns a U32 value indicating whether the SV contains a double.
4078 Returns a U32 value indicating whether the SV contains a double. Checks the
4079 B<private> setting. Use C<SvNOK>.
4089 Unsets the NV status of an SV.
4091 void SvNOK_off(SV* sv)
4099 Tells an SV that it is a double.
4101 void SvNOK_on(SV* sv)
4109 Tells an SV that it is a double and disables all other OK bits.
4111 void SvNOK_only(SV* sv)
4119 Coerce the given SV to a double and return it. See C<SvNVx> for a version
4120 which guarantees to evaluate sv only once.
4130 Returns the raw value in the SV's NV slot, without checks or conversions.
4131 Only use when you are sure SvNOK is true. See also C<SvNV()>.
4141 Coerces the given SV to a double and returns it. Guarantees to evaluate
4142 C<sv> only once. Only use this if C<sv> is an expression with side effects,
4143 otherwise use the more efficient C<SvNV>.
4153 Set the value of the NV pointer in sv to val. See C<SvIV_set>.
4155 void SvNV_set(SV* sv, NV val)
4163 Returns a U32 value indicating whether the value is an SV. It also tells
4164 whether the value is defined or not.
4174 Returns a U32 indicating whether the SvIVX is a valid offset value for
4175 the SvPVX. This hack is used internally to speed up removal of characters
4176 from the beginning of a SvPV. When SvOOK is true, then the start of the
4177 allocated string buffer is really (SvPVX - SvIVX).
4187 Returns a U32 value indicating whether the SV contains a character
4198 Returns a U32 value indicating whether the SV contains a character string.
4199 Checks the B<private> setting. Use C<SvPOK>.
4209 Unsets the PV status of an SV.
4211 void SvPOK_off(SV* sv)
4219 Tells an SV that it is a string.
4221 void SvPOK_on(SV* sv)
4229 Tells an SV that it is a string and disables all other OK bits.
4230 Will also turn off the UTF-8 status.
4232 void SvPOK_only(SV* sv)
4237 =item SvPOK_only_UTF8
4240 Tells an SV that it is a string and disables all other OK bits,
4241 and leaves the UTF-8 status as it was.
4243 void SvPOK_only_UTF8(SV* sv)
4251 Returns a pointer to the string in the SV, or a stringified form of
4252 the SV if the SV does not contain a string. The SV may cache the
4253 stringified version becoming C<SvPOK>. Handles 'get' magic. See also
4254 C<SvPVx> for a version which guarantees to evaluate sv only once.
4256 char* SvPV(SV* sv, STRLEN len)
4264 Like C<SvPV>, but converts sv to byte representation first if necessary.
4266 char* SvPVbyte(SV* sv, STRLEN len)
4274 Like C<SvPV>, but converts sv to byte representation first if necessary.
4275 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
4278 char* SvPVbytex(SV* sv, STRLEN len)
4283 =item SvPVbytex_force
4286 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
4287 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
4290 char* SvPVbytex_force(SV* sv, STRLEN len)
4295 =item SvPVbyte_force
4298 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
4300 char* SvPVbyte_force(SV* sv, STRLEN len)
4305 =item SvPVbyte_nolen
4308 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
4310 char* SvPVbyte_nolen(SV* sv)
4318 Like C<SvPV>, but converts sv to utf8 first if necessary.
4320 char* SvPVutf8(SV* sv, STRLEN len)
4328 Like C<SvPV>, but converts sv to utf8 first if necessary.
4329 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
4332 char* SvPVutf8x(SV* sv, STRLEN len)
4337 =item SvPVutf8x_force
4340 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
4341 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
4344 char* SvPVutf8x_force(SV* sv, STRLEN len)
4349 =item SvPVutf8_force
4352 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
4354 char* SvPVutf8_force(SV* sv, STRLEN len)
4359 =item SvPVutf8_nolen
4362 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
4364 char* SvPVutf8_nolen(SV* sv)
4372 Returns a pointer to the physical string in the SV. The SV must contain a
4383 A version of C<SvPV> which guarantees to evaluate C<sv> only once.
4384 Only use this if C<sv> is an expression with side effects, otherwise use the
4385 more efficient C<SvPVX>.
4387 char* SvPVx(SV* sv, STRLEN len)
4395 Like C<SvPV> but will force the SV into containing just a string
4396 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
4399 char* SvPV_force(SV* sv, STRLEN len)
4404 =item SvPV_force_nomg
4407 Like C<SvPV> but will force the SV into containing just a string
4408 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
4409 directly. Doesn't process magic.
4411 char* SvPV_force_nomg(SV* sv, STRLEN len)
4419 Returns a pointer to the string in the SV, or a stringified form of
4420 the SV if the SV does not contain a string. The SV may cache the
4421 stringified form becoming C<SvPOK>. Handles 'get' magic.
4423 char* SvPV_nolen(SV* sv)
4431 Like C<SvPV> but doesn't process magic.
4433 char* SvPV_nomg(SV* sv, STRLEN len)
4441 Set the value of the PV pointer in sv to val. See C<SvIV_set>.
4443 void SvPV_set(SV* sv, char* val)
4451 Returns the value of the object's reference count.
4453 U32 SvREFCNT(SV* sv)
4461 Decrements the reference count of the given SV.
4463 void SvREFCNT_dec(SV* sv)
4471 Increments the reference count of the given SV.
4473 All of the following SvREFCNT_inc* macros are optimized versions of
4474 SvREFCNT_inc, and can be replaced with SvREFCNT_inc.
4476 SV* SvREFCNT_inc(SV* sv)
4481 =item SvREFCNT_inc_NN
4484 Same as SvREFCNT_inc, but can only be used if you know I<sv>
4485 is not NULL. Since we don't have to check the NULLness, it's faster
4488 SV* SvREFCNT_inc_NN(SV* sv)
4493 =item SvREFCNT_inc_simple
4494 X<SvREFCNT_inc_simple>
4496 Same as SvREFCNT_inc, but can only be used with expressions without side
4497 effects. Since we don't have to store a temporary value, it's faster.
4499 SV* SvREFCNT_inc_simple(SV* sv)
4504 =item SvREFCNT_inc_simple_NN
4505 X<SvREFCNT_inc_simple_NN>
4507 Same as SvREFCNT_inc_simple, but can only be used if you know I<sv>
4508 is not NULL. Since we don't have to check the NULLness, it's faster
4511 SV* SvREFCNT_inc_simple_NN(SV* sv)
4516 =item SvREFCNT_inc_simple_void
4517 X<SvREFCNT_inc_simple_void>
4519 Same as SvREFCNT_inc_simple, but can only be used if you don't need the
4520 return value. The macro doesn't need to return a meaningful value.
4522 void SvREFCNT_inc_simple_void(SV* sv)
4527 =item SvREFCNT_inc_simple_void_NN
4528 X<SvREFCNT_inc_simple_void_NN>
4530 Same as SvREFCNT_inc, but can only be used if you don't need the return
4531 value, and you know that I<sv> is not NULL. The macro doesn't need
4532 to return a meaningful value, or check for NULLness, so it's smaller
4535 void SvREFCNT_inc_simple_void_NN(SV* sv)
4540 =item SvREFCNT_inc_void
4541 X<SvREFCNT_inc_void>
4543 Same as SvREFCNT_inc, but can only be used if you don't need the
4544 return value. The macro doesn't need to return a meaningful value.
4546 void SvREFCNT_inc_void(SV* sv)
4551 =item SvREFCNT_inc_void_NN
4552 X<SvREFCNT_inc_void_NN>
4554 Same as SvREFCNT_inc, but can only be used if you don't need the return
4555 value, and you know that I<sv> is not NULL. The macro doesn't need
4556 to return a meaningful value, or check for NULLness, so it's smaller
4559 void SvREFCNT_inc_void_NN(SV* sv)
4567 Tests if the SV is an RV.
4577 Unsets the RV status of an SV.
4579 void SvROK_off(SV* sv)
4587 Tells an SV that it is an RV.
4589 void SvROK_on(SV* sv)
4597 Dereferences an RV to return the SV.
4607 Set the value of the RV pointer in sv to val. See C<SvIV_set>.
4609 void SvRV_set(SV* sv, SV* val)
4617 Returns the stash of the SV.
4627 Set the value of the STASH pointer in sv to val. See C<SvIV_set>.
4629 void SvSTASH_set(SV* sv, HV* val)
4637 Taints an SV if tainting is enabled.
4639 void SvTAINT(SV* sv)
4647 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
4650 bool SvTAINTED(SV* sv)
4658 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
4659 some of Perl's fundamental security features. XS module authors should not
4660 use this function unless they fully understand all the implications of
4661 unconditionally untainting the value. Untainting should be done in the
4662 standard perl fashion, via a carefully crafted regexp, rather than directly
4663 untainting variables.
4665 void SvTAINTED_off(SV* sv)
4673 Marks an SV as tainted if tainting is enabled.
4675 void SvTAINTED_on(SV* sv)
4683 Returns a boolean indicating whether Perl would evaluate the SV as true or
4684 false, defined or undefined. Does not handle 'get' magic.
4694 Returns the type of the SV. See C<svtype>.
4696 svtype SvTYPE(SV* sv)
4704 Returns a boolean indicating whether the SV contains an unsigned integer.
4714 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
4715 perform the upgrade if necessary. See C<svtype>.
4717 void SvUPGRADE(SV* sv, svtype type)
4725 Returns a U32 value indicating whether the SV contains UTF-8 encoded data.
4726 Call this after SvPV() in case any call to string overloading updates the
4737 Unsets the UTF-8 status of an SV.
4739 void SvUTF8_off(SV *sv)
4747 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
4748 Do not use frivolously.
4750 void SvUTF8_on(SV *sv)
4758 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
4759 for a version which guarantees to evaluate sv only once.
4769 Returns the raw value in the SV's UV slot, without checks or conversions.
4770 Only use when you are sure SvIOK is true. See also C<SvUV()>.
4780 Coerces the given SV to an unsigned integer and returns it. Guarantees to
4781 C<sv> only once. Only use this if C<sv> is an expression with side effects,
4782 otherwise use the more efficient C<SvUV>.
4792 Like C<SvUV> but doesn't process magic.
4794 UV SvUV_nomg(SV* sv)
4802 Set the value of the UV pointer in sv to val. See C<SvIV_set>.
4804 void SvUV_set(SV* sv, UV val)
4812 Returns a boolean indicating whether the SV contains a v-string.
4819 =item sv_catpvn_nomg
4822 Like C<sv_catpvn> but doesn't process magic.
4824 void sv_catpvn_nomg(SV* sv, const char* ptr, STRLEN len)
4832 Like C<sv_catsv> but doesn't process magic.
4834 void sv_catsv_nomg(SV* dsv, SV* ssv)
4839 =item sv_derived_from
4842 Returns a boolean indicating whether the SV is derived from the specified class
4843 I<at the C level>. To check derivation at the Perl level, call C<isa()> as a
4846 bool sv_derived_from(SV* sv, const char* name)
4849 Found in file universal.c
4854 Returns a boolean indicating whether the SV performs a specific, named role.
4855 The SV can be a Perl object or the name of a Perl class.
4857 bool sv_does(SV* sv, const char* name)
4860 Found in file universal.c
4862 =item sv_report_used
4865 Dump the contents of all SVs not yet freed. (Debugging aid).
4867 void sv_report_used()
4875 Like C<sv_setsv> but doesn't process magic.
4877 void sv_setsv_nomg(SV* dsv, SV* ssv)
4885 =head1 SV-Body Allocation
4889 =item looks_like_number
4890 X<looks_like_number>
4892 Test if the content of an SV looks like a number (or is a number).
4893 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
4894 non-numeric warning), even if your atof() doesn't grok them.
4896 I32 looks_like_number(SV* sv)
4904 Creates an RV wrapper for an SV. The reference count for the original
4905 SV is B<not> incremented.
4907 SV* newRV_noinc(SV* sv)
4915 Creates a new SV. A non-zero C<len> parameter indicates the number of
4916 bytes of preallocated string space the SV should have. An extra byte for a
4917 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4918 space is allocated.) The reference count for the new SV is set to 1.
4920 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4921 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4922 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4923 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4924 modules supporting older perls.
4926 SV* newSV(STRLEN len)
4934 Creates a new SV from the hash key structure. It will generate scalars that
4935 point to the shared string table where possible. Returns a new (undefined)
4936 SV if the hek is NULL.
4938 SV* newSVhek(const HEK *hek)
4946 Creates a new SV and copies an integer into it. The reference count for the
4957 Creates a new SV and copies a floating point value into it.
4958 The reference count for the SV is set to 1.
4968 Creates a new SV and copies a string into it. The reference count for the
4969 SV is set to 1. If C<len> is zero, Perl will compute the length using
4970 strlen(). For efficiency, consider using C<newSVpvn> instead.
4972 SV* newSVpv(const char* s, STRLEN len)
4980 Creates a new SV and initializes it with the string formatted like
4983 SV* newSVpvf(const char* pat, ...)
4991 Creates a new SV and copies a string into it. The reference count for the
4992 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
4993 string. You are responsible for ensuring that the source string is at least
4994 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
4996 SV* newSVpvn(const char* s, STRLEN len)
5001 =item newSVpvn_share
5004 Creates a new SV with its SvPVX_const pointing to a shared string in the string
5005 table. If the string does not already exist in the table, it is created
5006 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
5007 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
5008 otherwise the hash is computed. The idea here is that as the string table
5009 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
5010 hash lookup will avoid string compare.
5012 SV* newSVpvn_share(const char* s, I32 len, U32 hash)
5020 Like C<newSVpvn>, but takes a literal string instead of a string/length pair.
5022 SV* newSVpvs(const char* s)
5025 Found in file handy.h
5027 =item newSVpvs_share
5030 Like C<newSVpvn_share>, but takes a literal string instead of a string/length
5031 pair and omits the hash parameter.
5033 SV* newSVpvs_share(const char* s)
5036 Found in file handy.h
5041 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
5042 it will be upgraded to one. If C<classname> is non-null then the new SV will
5043 be blessed in the specified package. The new SV is returned and its
5044 reference count is 1.
5046 SV* newSVrv(SV* rv, const char* classname)
5054 Creates a new SV which is an exact duplicate of the original SV.
5057 SV* newSVsv(SV* old)
5065 Creates a new SV and copies an unsigned integer into it.
5066 The reference count for the SV is set to 1.
5076 Creates a new SV, of the type specificied. The reference count for the new SV
5079 SV* newSV_type(svtype type)
5087 This function is only called on magical items, and is only used by
5088 sv_true() or its macro equivalent.
5090 bool sv_2bool(SV* sv)
5098 Using various gambits, try to get a CV from an SV; in addition, try if
5099 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
5100 The flags in C<lref> are passed to sv_fetchsv.
5102 CV* sv_2cv(SV* sv, HV** st, GV** gvp, I32 lref)
5110 Using various gambits, try to get an IO from an SV: the IO slot if its a
5111 GV; or the recursive result if we're an RV; or the IO slot of the symbol
5112 named after the PV if we're a string.
5122 Return the integer value of an SV, doing any necessary string
5123 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
5124 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
5126 IV sv_2iv_flags(SV* sv, I32 flags)
5134 Marks an existing SV as mortal. The SV will be destroyed "soon", either
5135 by an explicit call to FREETMPS, or by an implicit call at places such as
5136 statement boundaries. SvTEMP() is turned on which means that the SV's
5137 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
5138 and C<sv_mortalcopy>.
5140 SV* sv_2mortal(SV* sv)
5148 Return the num value of an SV, doing any necessary string or integer
5149 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
5160 Return a pointer to the byte-encoded representation of the SV, and set *lp
5161 to its length. May cause the SV to be downgraded from UTF-8 as a
5164 Usually accessed via the C<SvPVbyte> macro.
5166 char* sv_2pvbyte(SV* sv, STRLEN* lp)
5174 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
5175 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
5177 Usually accessed via the C<SvPVutf8> macro.
5179 char* sv_2pvutf8(SV* sv, STRLEN* lp)
5187 Returns a pointer to the string value of an SV, and sets *lp to its length.
5188 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
5190 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
5191 usually end up here too.
5193 char* sv_2pv_flags(SV* sv, STRLEN* lp, I32 flags)
5201 Return the unsigned integer value of an SV, doing any necessary string
5202 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
5203 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
5205 UV sv_2uv_flags(SV* sv, I32 flags)
5213 Remove any string offset. You should normally use the C<SvOOK_off> macro
5216 int sv_backoff(SV* sv)
5224 Blesses an SV into a specified package. The SV must be an RV. The package
5225 must be designated by its stash (see C<gv_stashpv()>). The reference count
5226 of the SV is unaffected.
5228 SV* sv_bless(SV* sv, HV* stash)
5236 Concatenates the string onto the end of the string which is in the SV.
5237 If the SV has the UTF-8 status set, then the bytes appended should be
5238 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
5240 void sv_catpv(SV* sv, const char* ptr)
5248 Processes its arguments like C<sprintf> and appends the formatted
5249 output to an SV. If the appended data contains "wide" characters
5250 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
5251 and characters >255 formatted with %c), the original SV might get
5252 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
5253 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
5254 valid UTF-8; if the original SV was bytes, the pattern should be too.
5256 void sv_catpvf(SV* sv, const char* pat, ...)
5264 Like C<sv_catpvf>, but also handles 'set' magic.
5266 void sv_catpvf_mg(SV *sv, const char* pat, ...)
5274 Concatenates the string onto the end of the string which is in the SV. The
5275 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5276 status set, then the bytes appended should be valid UTF-8.
5277 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
5279 void sv_catpvn(SV* sv, const char* ptr, STRLEN len)
5284 =item sv_catpvn_flags
5287 Concatenates the string onto the end of the string which is in the SV. The
5288 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5289 status set, then the bytes appended should be valid UTF-8.
5290 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
5291 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
5292 in terms of this function.
5294 void sv_catpvn_flags(SV* sv, const char* ptr, STRLEN len, I32 flags)
5302 Like C<sv_catpvn>, but takes a literal string instead of a string/length pair.
5304 void sv_catpvs(SV* sv, const char* s)
5307 Found in file handy.h
5312 Like C<sv_catpv>, but also handles 'set' magic.
5314 void sv_catpv_mg(SV *sv, const char *ptr)
5322 Concatenates the string from SV C<ssv> onto the end of the string in
5323 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
5324 not 'set' magic. See C<sv_catsv_mg>.
5326 void sv_catsv(SV* dsv, SV* ssv)
5331 =item sv_catsv_flags
5334 Concatenates the string from SV C<ssv> onto the end of the string in
5335 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
5336 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
5337 and C<sv_catsv_nomg> are implemented in terms of this function.
5339 void sv_catsv_flags(SV* dsv, SV* ssv, I32 flags)
5347 Efficient removal of characters from the beginning of the string buffer.
5348 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
5349 the string buffer. The C<ptr> becomes the first character of the adjusted
5350 string. Uses the "OOK hack".
5351 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
5352 refer to the same chunk of data.
5354 void sv_chop(SV* sv, const char* ptr)
5362 Clear an SV: call any destructors, free up any memory used by the body,
5363 and free the body itself. The SV's head is I<not> freed, although
5364 its type is set to all 1's so that it won't inadvertently be assumed
5365 to be live during global destruction etc.
5366 This function should only be called when REFCNT is zero. Most of the time
5367 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5370 void sv_clear(SV* sv)
5378 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5379 string in C<sv1> is less than, equal to, or greater than the string in
5380 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5381 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
5383 I32 sv_cmp(SV* sv1, SV* sv2)
5391 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
5392 'use bytes' aware, handles get magic, and will coerce its args to strings
5393 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
5395 I32 sv_cmp_locale(SV* sv1, SV* sv2)
5403 Add Collate Transform magic to an SV if it doesn't already have it.
5405 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
5406 scalar data of the variable, but transformed to such a format that a normal
5407 memory comparison can be used to compare the data according to the locale
5410 char* sv_collxfrm(SV* sv, STRLEN* nxp)
5418 Copies a stringified representation of the source SV into the
5419 destination SV. Automatically performs any necessary mg_get and
5420 coercion of numeric values into strings. Guaranteed to preserve
5421 UTF8 flag even from overloaded objects. Similar in nature to
5422 sv_2pv[_flags] but operates directly on an SV instead of just the
5423 string. Mostly uses sv_2pv_flags to do its work, except when that
5424 would lose the UTF-8'ness of the PV.
5426 void sv_copypv(SV* dsv, SV* ssv)
5434 Auto-decrement of the value in the SV, doing string to numeric conversion
5435 if necessary. Handles 'get' magic.
5445 Returns a boolean indicating whether the strings in the two SVs are
5446 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5447 coerce its args to strings if necessary.
5449 I32 sv_eq(SV* sv1, SV* sv2)
5454 =item sv_force_normal_flags
5455 X<sv_force_normal_flags>
5457 Undo various types of fakery on an SV: if the PV is a shared string, make
5458 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
5459 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
5460 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
5461 then a copy-on-write scalar drops its PV buffer (if any) and becomes
5462 SvPOK_off rather than making a copy. (Used where this scalar is about to be
5463 set to some other value.) In addition, the C<flags> parameter gets passed to
5464 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
5465 with flags set to 0.
5467 void sv_force_normal_flags(SV *sv, U32 flags)
5475 Decrement an SV's reference count, and if it drops to zero, call
5476 C<sv_clear> to invoke destructors and free up any memory used by
5477 the body; finally, deallocate the SV's head itself.
5478 Normally called via a wrapper macro C<SvREFCNT_dec>.
5480 void sv_free(SV* sv)
5488 Get a line from the filehandle and store it into the SV, optionally
5489 appending to the currently-stored string.
5491 char* sv_gets(SV* sv, PerlIO* fp, I32 append)
5499 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
5500 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
5501 Use the C<SvGROW> wrapper instead.
5503 char* sv_grow(SV* sv, STRLEN newlen)
5511 Auto-increment of the value in the SV, doing string to numeric conversion
5512 if necessary. Handles 'get' magic.
5522 Inserts a string at the specified offset/length within the SV. Similar to
5523 the Perl substr() function.
5525 void sv_insert(SV* bigsv, STRLEN offset, STRLEN len, const char* little, STRLEN littlelen)
5533 Returns a boolean indicating whether the SV is blessed into the specified
5534 class. This does not check for subtypes; use C<sv_derived_from> to verify
5535 an inheritance relationship.
5537 int sv_isa(SV* sv, const char* name)
5545 Returns a boolean indicating whether the SV is an RV pointing to a blessed
5546 object. If the SV is not an RV, or if the object is not blessed, then this
5549 int sv_isobject(SV* sv)
5557 Returns the length of the string in the SV. Handles magic and type
5558 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5560 STRLEN sv_len(SV* sv)
5568 Returns the number of characters in the string in an SV, counting wide
5569 UTF-8 bytes as a single character. Handles magic and type coercion.
5571 STRLEN sv_len_utf8(SV* sv)
5579 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
5580 then adds a new magic item of type C<how> to the head of the magic list.
5582 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
5583 handling of the C<name> and C<namlen> arguments.
5585 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
5586 to add more than one instance of the same 'how'.
5588 void sv_magic(SV* sv, SV* obj, int how, const char* name, I32 namlen)
5596 Adds magic to an SV, upgrading it if necessary. Applies the
5597 supplied vtable and returns a pointer to the magic added.
5599 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
5600 In particular, you can add magic to SvREADONLY SVs, and add more than
5601 one instance of the same 'how'.
5603 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
5604 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
5605 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
5606 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
5608 (This is now used as a subroutine by C<sv_magic>.)
5610 MAGIC * sv_magicext(SV* sv, SV* obj, int how, const MGVTBL *vtbl, const char* name, I32 namlen)
5618 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
5619 The new SV is marked as mortal. It will be destroyed "soon", either by an
5620 explicit call to FREETMPS, or by an implicit call at places such as
5621 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
5623 SV* sv_mortalcopy(SV* oldsv)
5631 Creates a new null SV which is mortal. The reference count of the SV is
5632 set to 1. It will be destroyed "soon", either by an explicit call to
5633 FREETMPS, or by an implicit call at places such as statement boundaries.
5634 See also C<sv_mortalcopy> and C<sv_2mortal>.
5644 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5647 SV* sv_newref(SV* sv)
5655 Converts the value pointed to by offsetp from a count of bytes from the
5656 start of the string, to a count of the equivalent number of UTF-8 chars.
5657 Handles magic and type coercion.
5659 void sv_pos_b2u(SV* sv, I32* offsetp)
5667 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5668 the start of the string, to a count of the equivalent number of bytes; if
5669 lenp is non-zero, it does the same to lenp, but this time starting from
5670 the offset, rather than from the start of the string. Handles magic and
5673 void sv_pos_u2b(SV* sv, I32* offsetp, I32* lenp)
5678 =item sv_pvbyten_force
5681 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
5683 char* sv_pvbyten_force(SV* sv, STRLEN* lp)
5691 Get a sensible string out of the SV somehow.
5692 A private implementation of the C<SvPV_force> macro for compilers which
5693 can't cope with complex macro expressions. Always use the macro instead.
5695 char* sv_pvn_force(SV* sv, STRLEN* lp)
5700 =item sv_pvn_force_flags
5701 X<sv_pvn_force_flags>
5703 Get a sensible string out of the SV somehow.
5704 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
5705 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
5706 implemented in terms of this function.
5707 You normally want to use the various wrapper macros instead: see
5708 C<SvPV_force> and C<SvPV_force_nomg>
5710 char* sv_pvn_force_flags(SV* sv, STRLEN* lp, I32 flags)
5715 =item sv_pvutf8n_force
5718 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
5720 char* sv_pvutf8n_force(SV* sv, STRLEN* lp)
5728 Returns a string describing what the SV is a reference to.
5730 const char* sv_reftype(const SV* sv, int ob)
5738 Make the first argument a copy of the second, then delete the original.
5739 The target SV physically takes over ownership of the body of the source SV
5740 and inherits its flags; however, the target keeps any magic it owns,
5741 and any magic in the source is discarded.
5742 Note that this is a rather specialist SV copying operation; most of the
5743 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5745 void sv_replace(SV* sv, SV* nsv)
5753 Underlying implementation for the C<reset> Perl function.
5754 Note that the perl-level function is vaguely deprecated.
5756 void sv_reset(const char* s, HV* stash)
5764 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
5765 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
5766 push a back-reference to this RV onto the array of backreferences
5767 associated with that magic. If the RV is magical, set magic will be
5768 called after the RV is cleared.
5770 SV* sv_rvweaken(SV *sv)
5778 Copies an integer into the given SV, upgrading first if necessary.
5779 Does not handle 'set' magic. See also C<sv_setiv_mg>.
5781 void sv_setiv(SV* sv, IV num)
5789 Like C<sv_setiv>, but also handles 'set' magic.
5791 void sv_setiv_mg(SV *sv, IV i)
5799 Copies a double into the given SV, upgrading first if necessary.
5800 Does not handle 'set' magic. See also C<sv_setnv_mg>.
5802 void sv_setnv(SV* sv, NV num)
5810 Like C<sv_setnv>, but also handles 'set' magic.
5812 void sv_setnv_mg(SV *sv, NV num)
5820 Copies a string into an SV. The string must be null-terminated. Does not
5821 handle 'set' magic. See C<sv_setpv_mg>.
5823 void sv_setpv(SV* sv, const char* ptr)
5831 Works like C<sv_catpvf> but copies the text into the SV instead of
5832 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
5834 void sv_setpvf(SV* sv, const char* pat, ...)
5842 Like C<sv_setpvf>, but also handles 'set' magic.
5844 void sv_setpvf_mg(SV *sv, const char* pat, ...)
5852 Copies an integer into the given SV, also updating its string value.
5853 Does not handle 'set' magic. See C<sv_setpviv_mg>.
5855 void sv_setpviv(SV* sv, IV num)
5863 Like C<sv_setpviv>, but also handles 'set' magic.
5865 void sv_setpviv_mg(SV *sv, IV iv)
5873 Copies a string into an SV. The C<len> parameter indicates the number of
5874 bytes to be copied. If the C<ptr> argument is NULL the SV will become
5875 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
5877 void sv_setpvn(SV* sv, const char* ptr, STRLEN len)
5885 Like C<sv_setpvn>, but also handles 'set' magic.
5887 void sv_setpvn_mg(SV *sv, const char *ptr, STRLEN len)
5895 Like C<sv_setpvn>, but takes a literal string instead of a string/length pair.
5897 void sv_setpvs(SV* sv, const char* s)
5900 Found in file handy.h
5905 Like C<sv_setpv>, but also handles 'set' magic.
5907 void sv_setpv_mg(SV *sv, const char *ptr)
5915 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
5916 argument will be upgraded to an RV. That RV will be modified to point to
5917 the new SV. The C<classname> argument indicates the package for the
5918 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
5919 will have a reference count of 1, and the RV will be returned.
5921 SV* sv_setref_iv(SV* rv, const char* classname, IV iv)
5929 Copies a double into a new SV, optionally blessing the SV. The C<rv>
5930 argument will be upgraded to an RV. That RV will be modified to point to
5931 the new SV. The C<classname> argument indicates the package for the
5932 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
5933 will have a reference count of 1, and the RV will be returned.
5935 SV* sv_setref_nv(SV* rv, const char* classname, NV nv)
5943 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
5944 argument will be upgraded to an RV. That RV will be modified to point to
5945 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
5946 into the SV. The C<classname> argument indicates the package for the
5947 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
5948 will have a reference count of 1, and the RV will be returned.
5950 Do not use with other Perl types such as HV, AV, SV, CV, because those
5951 objects will become corrupted by the pointer copy process.
5953 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
5955 SV* sv_setref_pv(SV* rv, const char* classname, void* pv)
5963 Copies a string into a new SV, optionally blessing the SV. The length of the
5964 string must be specified with C<n>. The C<rv> argument will be upgraded to
5965 an RV. That RV will be modified to point to the new SV. The C<classname>
5966 argument indicates the package for the blessing. Set C<classname> to
5967 C<NULL> to avoid the blessing. The new SV will have a reference count
5968 of 1, and the RV will be returned.
5970 Note that C<sv_setref_pv> copies the pointer while this copies the string.
5972 SV* sv_setref_pvn(SV* rv, const char* classname, const char* pv, STRLEN n)
5980 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
5981 argument will be upgraded to an RV. That RV will be modified to point to
5982 the new SV. The C<classname> argument indicates the package for the
5983 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
5984 will have a reference count of 1, and the RV will be returned.
5986 SV* sv_setref_uv(SV* rv, const char* classname, UV uv)
5994 Copies the contents of the source SV C<ssv> into the destination SV
5995 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
5996 function if the source SV needs to be reused. Does not handle 'set' magic.
5997 Loosely speaking, it performs a copy-by-value, obliterating any previous
5998 content of the destination.
6000 You probably want to use one of the assortment of wrappers, such as
6001 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
6002 C<SvSetMagicSV_nosteal>.
6004 void sv_setsv(SV* dsv, SV* ssv)
6009 =item sv_setsv_flags
6012 Copies the contents of the source SV C<ssv> into the destination SV
6013 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
6014 function if the source SV needs to be reused. Does not handle 'set' magic.
6015 Loosely speaking, it performs a copy-by-value, obliterating any previous
6016 content of the destination.
6017 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
6018 C<ssv> if appropriate, else not. If the C<flags> parameter has the
6019 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
6020 and C<sv_setsv_nomg> are implemented in terms of this function.
6022 You probably want to use one of the assortment of wrappers, such as
6023 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
6024 C<SvSetMagicSV_nosteal>.
6026 This is the primary function for copying scalars, and most other
6027 copy-ish functions and macros use this underneath.
6029 void sv_setsv_flags(SV* dsv, SV* ssv, I32 flags)
6037 Like C<sv_setsv>, but also handles 'set' magic.
6039 void sv_setsv_mg(SV *dstr, SV *sstr)
6047 Copies an unsigned integer into the given SV, upgrading first if necessary.
6048 Does not handle 'set' magic. See also C<sv_setuv_mg>.
6050 void sv_setuv(SV* sv, UV num)
6058 Like C<sv_setuv>, but also handles 'set' magic.
6060 void sv_setuv_mg(SV *sv, UV u)
6068 Test an SV for taintedness. Use C<SvTAINTED> instead.
6069 bool sv_tainted(SV* sv)
6077 Returns true if the SV has a true value by Perl's rules.
6078 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
6079 instead use an in-line version.
6089 Removes all magic of type C<type> from an SV.
6091 int sv_unmagic(SV* sv, int type)
6096 =item sv_unref_flags
6099 Unsets the RV status of the SV, and decrements the reference count of
6100 whatever was being referenced by the RV. This can almost be thought of
6101 as a reversal of C<newSVrv>. The C<cflags> argument can contain
6102 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
6103 (otherwise the decrementing is conditional on the reference count being
6104 different from one or the reference being a readonly SV).
6107 void sv_unref_flags(SV* sv, U32 flags)
6115 Untaint an SV. Use C<SvTAINTED_off> instead.
6116 void sv_untaint(SV* sv)
6124 Upgrade an SV to a more complex form. Generally adds a new body type to the
6125 SV, then copies across as much information as possible from the old body.
6126 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
6128 void sv_upgrade(SV* sv, svtype new_type)
6133 =item sv_usepvn_flags
6136 Tells an SV to use C<ptr> to find its string value. Normally the
6137 string is stored inside the SV but sv_usepvn allows the SV to use an
6138 outside string. The C<ptr> should point to memory that was allocated
6139 by C<malloc>. The string length, C<len>, must be supplied. By default
6140 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
6141 so that pointer should not be freed or used by the programmer after
6142 giving it to sv_usepvn, and neither should any pointers from "behind"
6143 that pointer (e.g. ptr + 1) be used.
6145 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
6146 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
6147 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
6148 C<len>, and already meets the requirements for storing in C<SvPVX>)
6150 void sv_usepvn_flags(SV* sv, char* ptr, STRLEN len, U32 flags)
6155 =item sv_utf8_decode
6158 If the PV of the SV is an octet sequence in UTF-8
6159 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
6160 so that it looks like a character. If the PV contains only single-byte
6161 characters, the C<SvUTF8> flag stays being off.
6162 Scans PV for validity and returns false if the PV is invalid UTF-8.
6164 NOTE: this function is experimental and may change or be
6165 removed without notice.
6167 bool sv_utf8_decode(SV *sv)
6172 =item sv_utf8_downgrade
6173 X<sv_utf8_downgrade>
6175 Attempts to convert the PV of an SV from characters to bytes.
6176 If the PV contains a character beyond byte, this conversion will fail;
6177 in this case, either returns false or, if C<fail_ok> is not
6180 This is not as a general purpose Unicode to byte encoding interface:
6181 use the Encode extension for that.
6183 NOTE: this function is experimental and may change or be
6184 removed without notice.
6186 bool sv_utf8_downgrade(SV *sv, bool fail_ok)
6191 =item sv_utf8_encode
6194 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
6195 flag off so that it looks like octets again.
6197 void sv_utf8_encode(SV *sv)
6202 =item sv_utf8_upgrade
6205 Converts the PV of an SV to its UTF-8-encoded form.
6206 Forces the SV to string form if it is not already.
6207 Always sets the SvUTF8 flag to avoid future validity checks even
6208 if all the bytes have hibit clear.
6210 This is not as a general purpose byte encoding to Unicode interface:
6211 use the Encode extension for that.
6213 STRLEN sv_utf8_upgrade(SV *sv)
6218 =item sv_utf8_upgrade_flags
6219 X<sv_utf8_upgrade_flags>
6221 Converts the PV of an SV to its UTF-8-encoded form.
6222 Forces the SV to string form if it is not already.
6223 Always sets the SvUTF8 flag to avoid future validity checks even
6224 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
6225 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
6226 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
6228 This is not as a general purpose byte encoding to Unicode interface:
6229 use the Encode extension for that.
6231 STRLEN sv_utf8_upgrade_flags(SV *sv, I32 flags)
6239 Processes its arguments like C<vsprintf> and appends the formatted output
6240 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
6242 Usually used via its frontend C<sv_catpvf>.
6244 void sv_vcatpvf(SV* sv, const char* pat, va_list* args)
6252 Processes its arguments like C<vsprintf> and appends the formatted output
6253 to an SV. Uses an array of SVs if the C style variable argument list is
6254 missing (NULL). When running with taint checks enabled, indicates via
6255 C<maybe_tainted> if results are untrustworthy (often due to the use of
6258 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
6260 void sv_vcatpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
6268 Like C<sv_vcatpvf>, but also handles 'set' magic.
6270 Usually used via its frontend C<sv_catpvf_mg>.
6272 void sv_vcatpvf_mg(SV* sv, const char* pat, va_list* args)
6280 Works like C<sv_vcatpvf> but copies the text into the SV instead of
6281 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
6283 Usually used via its frontend C<sv_setpvf>.
6285 void sv_vsetpvf(SV* sv, const char* pat, va_list* args)
6293 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
6296 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
6298 void sv_vsetpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
6306 Like C<sv_vsetpvf>, but also handles 'set' magic.
6308 Usually used via its frontend C<sv_setpvf_mg>.
6310 void sv_vsetpvf_mg(SV* sv, const char* pat, va_list* args)
6318 =head1 Unicode Support
6322 =item bytes_from_utf8
6325 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
6326 Unlike C<utf8_to_bytes> but like C<bytes_to_utf8>, returns a pointer to
6327 the newly-created string, and updates C<len> to contain the new
6328 length. Returns the original string if no conversion occurs, C<len>
6329 is unchanged. Do nothing if C<is_utf8> points to 0. Sets C<is_utf8> to
6330 0 if C<s> is converted or contains all 7bit characters.
6332 NOTE: this function is experimental and may change or be
6333 removed without notice.
6335 U8* bytes_from_utf8(const U8 *s, STRLEN *len, bool *is_utf8)
6338 Found in file utf8.c
6343 Converts a string C<s> of length C<len> from ASCII into UTF-8 encoding.
6344 Returns a pointer to the newly-created string, and sets C<len> to
6345 reflect the new length.
6347 If you want to convert to UTF-8 from other encodings than ASCII,
6348 see sv_recode_to_utf8().
6350 NOTE: this function is experimental and may change or be
6351 removed without notice.
6353 U8* bytes_to_utf8(const U8 *s, STRLEN *len)
6356 Found in file utf8.c
6361 Return true if the strings s1 and s2 differ case-insensitively, false
6362 if not (if they are equal case-insensitively). If u1 is true, the
6363 string s1 is assumed to be in UTF-8-encoded Unicode. If u2 is true,
6364 the string s2 is assumed to be in UTF-8-encoded Unicode. If u1 or u2
6365 are false, the respective string is assumed to be in native 8-bit
6368 If the pe1 and pe2 are non-NULL, the scanning pointers will be copied
6369 in there (they will point at the beginning of the I<next> character).
6370 If the pointers behind pe1 or pe2 are non-NULL, they are the end
6371 pointers beyond which scanning will not continue under any
6372 circumstances. If the byte lengths l1 and l2 are non-zero, s1+l1 and
6373 s2+l2 will be used as goal end pointers that will also stop the scan,
6374 and which qualify towards defining a successful match: all the scans
6375 that define an explicit length must reach their goal pointers for
6376 a match to succeed).
6378 For case-insensitiveness, the "casefolding" of Unicode is used
6379 instead of upper/lowercasing both the characters, see
6380 http://www.unicode.org/unicode/reports/tr21/ (Case Mappings).
6382 I32 ibcmp_utf8(const char* a, char **pe1, UV l1, bool u1, const char* b, char **pe2, UV l2, bool u2)
6385 Found in file utf8.c
6390 Tests if some arbitrary number of bytes begins in a valid UTF-8
6391 character. Note that an INVARIANT (i.e. ASCII) character is a valid
6392 UTF-8 character. The actual number of bytes in the UTF-8 character
6393 will be returned if it is valid, otherwise 0.
6395 STRLEN is_utf8_char(const U8 *p)
6398 Found in file utf8.c
6400 =item is_utf8_string
6403 Returns true if first C<len> bytes of the given string form a valid
6404 UTF-8 string, false otherwise. Note that 'a valid UTF-8 string' does
6405 not mean 'a string that contains code points above 0x7F encoded in UTF-8'
6406 because a valid ASCII string is a valid UTF-8 string.
6408 See also is_utf8_string_loclen() and is_utf8_string_loc().
6410 bool is_utf8_string(const U8 *s, STRLEN len)
6413 Found in file utf8.c
6415 =item is_utf8_string_loc
6416 X<is_utf8_string_loc>
6418 Like is_utf8_string() but stores the location of the failure (in the
6419 case of "utf8ness failure") or the location s+len (in the case of
6420 "utf8ness success") in the C<ep>.
6422 See also is_utf8_string_loclen() and is_utf8_string().
6424 bool is_utf8_string_loc(const U8 *s, STRLEN len, const U8 **p)
6427 Found in file utf8.c
6429 =item is_utf8_string_loclen
6430 X<is_utf8_string_loclen>
6432 Like is_utf8_string() but stores the location of the failure (in the
6433 case of "utf8ness failure") or the location s+len (in the case of
6434 "utf8ness success") in the C<ep>, and the number of UTF-8
6435 encoded characters in the C<el>.
6437 See also is_utf8_string_loc() and is_utf8_string().
6439 bool is_utf8_string_loclen(const U8 *s, STRLEN len, const U8 **ep, STRLEN *el)
6442 Found in file utf8.c
6444 =item pv_uni_display
6447 Build to the scalar dsv a displayable version of the string spv,
6448 length len, the displayable version being at most pvlim bytes long
6449 (if longer, the rest is truncated and "..." will be appended).
6451 The flags argument can have UNI_DISPLAY_ISPRINT set to display
6452 isPRINT()able characters as themselves, UNI_DISPLAY_BACKSLASH
6453 to display the \\[nrfta\\] as the backslashed versions (like '\n')
6454 (UNI_DISPLAY_BACKSLASH is preferred over UNI_DISPLAY_ISPRINT for \\).
6455 UNI_DISPLAY_QQ (and its alias UNI_DISPLAY_REGEX) have both
6456 UNI_DISPLAY_BACKSLASH and UNI_DISPLAY_ISPRINT turned on.
6458 The pointer to the PV of the dsv is returned.
6460 char* pv_uni_display(SV *dsv, const U8 *spv, STRLEN len, STRLEN pvlim, UV flags)
6463 Found in file utf8.c
6468 The encoding is assumed to be an Encode object, the PV of the ssv is
6469 assumed to be octets in that encoding and decoding the input starts
6470 from the position which (PV + *offset) pointed to. The dsv will be
6471 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
6472 when the string tstr appears in decoding output or the input ends on
6473 the PV of the ssv. The value which the offset points will be modified
6474 to the last input position on the ssv.
6476 Returns TRUE if the terminator was found, else returns FALSE.
6478 bool sv_cat_decode(SV* dsv, SV *encoding, SV *ssv, int *offset, char* tstr, int tlen)
6483 =item sv_recode_to_utf8
6484 X<sv_recode_to_utf8>
6486 The encoding is assumed to be an Encode object, on entry the PV
6487 of the sv is assumed to be octets in that encoding, and the sv
6488 will be converted into Unicode (and UTF-8).
6490 If the sv already is UTF-8 (or if it is not POK), or if the encoding
6491 is not a reference, nothing is done to the sv. If the encoding is not
6492 an C<Encode::XS> Encoding object, bad things will happen.
6493 (See F<lib/encoding.pm> and L<Encode>).
6495 The PV of the sv is returned.
6497 char* sv_recode_to_utf8(SV* sv, SV *encoding)
6502 =item sv_uni_display
6505 Build to the scalar dsv a displayable version of the scalar sv,
6506 the displayable version being at most pvlim bytes long
6507 (if longer, the rest is truncated and "..." will be appended).
6509 The flags argument is as in pv_uni_display().
6511 The pointer to the PV of the dsv is returned.
6513 char* sv_uni_display(SV *dsv, SV *ssv, STRLEN pvlim, UV flags)
6516 Found in file utf8.c
6521 The "p" contains the pointer to the UTF-8 string encoding
6522 the character that is being converted.
6524 The "ustrp" is a pointer to the character buffer to put the
6525 conversion result to. The "lenp" is a pointer to the length
6528 The "swashp" is a pointer to the swash to use.
6530 Both the special and normal mappings are stored lib/unicore/To/Foo.pl,
6531 and loaded by SWASHNEW, using lib/utf8_heavy.pl. The special (usually,
6532 but not always, a multicharacter mapping), is tried first.
6534 The "special" is a string like "utf8::ToSpecLower", which means the
6535 hash %utf8::ToSpecLower. The access to the hash is through
6536 Perl_to_utf8_case().
6538 The "normal" is a string like "ToLower" which means the swash
6541 UV to_utf8_case(const U8 *p, U8* ustrp, STRLEN *lenp, SV **swashp, const char *normal, const char *special)
6544 Found in file utf8.c
6549 Convert the UTF-8 encoded character at p to its foldcase version and
6550 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6551 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6552 foldcase version may be longer than the original character (up to
6555 The first character of the foldcased version is returned
6556 (but note, as explained above, that there may be more.)
6558 UV to_utf8_fold(const U8 *p, U8* ustrp, STRLEN *lenp)
6561 Found in file utf8.c
6566 Convert the UTF-8 encoded character at p to its lowercase version and
6567 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6568 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6569 lowercase version may be longer than the original character.
6571 The first character of the lowercased version is returned
6572 (but note, as explained above, that there may be more.)
6574 UV to_utf8_lower(const U8 *p, U8* ustrp, STRLEN *lenp)
6577 Found in file utf8.c
6582 Convert the UTF-8 encoded character at p to its titlecase version and
6583 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6584 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6585 titlecase version may be longer than the original character.
6587 The first character of the titlecased version is returned
6588 (but note, as explained above, that there may be more.)
6590 UV to_utf8_title(const U8 *p, U8* ustrp, STRLEN *lenp)
6593 Found in file utf8.c
6598 Convert the UTF-8 encoded character at p to its uppercase version and
6599 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6600 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since
6601 the uppercase version may be longer than the original character.
6603 The first character of the uppercased version is returned
6604 (but note, as explained above, that there may be more.)
6606 UV to_utf8_upper(const U8 *p, U8* ustrp, STRLEN *lenp)
6609 Found in file utf8.c
6611 =item utf8n_to_uvchr
6616 Returns the native character value of the first character in the string
6618 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6619 length, in bytes, of that character.
6621 Allows length and flags to be passed to low level routine.
6623 UV utf8n_to_uvchr(const U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags)
6626 Found in file utf8.c
6628 =item utf8n_to_uvuni
6631 Bottom level UTF-8 decode routine.
6632 Returns the unicode code point value of the first character in the string C<s>
6633 which is assumed to be in UTF-8 encoding and no longer than C<curlen>;
6634 C<retlen> will be set to the length, in bytes, of that character.
6636 If C<s> does not point to a well-formed UTF-8 character, the behaviour
6637 is dependent on the value of C<flags>: if it contains UTF8_CHECK_ONLY,
6638 it is assumed that the caller will raise a warning, and this function
6639 will silently just set C<retlen> to C<-1> and return zero. If the
6640 C<flags> does not contain UTF8_CHECK_ONLY, warnings about
6641 malformations will be given, C<retlen> will be set to the expected
6642 length of the UTF-8 character in bytes, and zero will be returned.
6644 The C<flags> can also contain various flags to allow deviations from
6645 the strict UTF-8 encoding (see F<utf8.h>).
6647 Most code should use utf8_to_uvchr() rather than call this directly.
6649 UV utf8n_to_uvuni(const U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags)
6652 Found in file utf8.c
6657 Returns the number of UTF-8 characters between the UTF-8 pointers C<a>
6660 WARNING: use only if you *know* that the pointers point inside the
6663 IV utf8_distance(const U8 *a, const U8 *b)
6666 Found in file utf8.c
6671 Return the UTF-8 pointer C<s> displaced by C<off> characters, either
6672 forward or backward.
6674 WARNING: do not use the following unless you *know* C<off> is within
6675 the UTF-8 data pointed to by C<s> *and* that on entry C<s> is aligned
6676 on the first byte of character or just after the last byte of a character.
6678 U8* utf8_hop(const U8 *s, I32 off)
6681 Found in file utf8.c
6686 Return the length of the UTF-8 char encoded string C<s> in characters.
6687 Stops at C<e> (inclusive). If C<e E<lt> s> or if the scan would end
6688 up past C<e>, croaks.
6690 STRLEN utf8_length(const U8* s, const U8 *e)
6693 Found in file utf8.c
6698 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
6699 Unlike C<bytes_to_utf8>, this over-writes the original string, and
6700 updates len to contain the new length.
6701 Returns zero on failure, setting C<len> to -1.
6703 If you need a copy of the string, see C<bytes_from_utf8>.
6705 NOTE: this function is experimental and may change or be
6706 removed without notice.
6708 U8* utf8_to_bytes(U8 *s, STRLEN *len)
6711 Found in file utf8.c
6716 Returns the native character value of the first character in the string C<s>
6717 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6718 length, in bytes, of that character.
6720 If C<s> does not point to a well-formed UTF-8 character, zero is
6721 returned and retlen is set, if possible, to -1.
6723 UV utf8_to_uvchr(const U8 *s, STRLEN *retlen)
6726 Found in file utf8.c
6731 Returns the Unicode code point of the first character in the string C<s>
6732 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6733 length, in bytes, of that character.
6735 This function should only be used when returned UV is considered
6736 an index into the Unicode semantic tables (e.g. swashes).
6738 If C<s> does not point to a well-formed UTF-8 character, zero is
6739 returned and retlen is set, if possible, to -1.
6741 UV utf8_to_uvuni(const U8 *s, STRLEN *retlen)
6744 Found in file utf8.c
6749 Adds the UTF-8 representation of the Native codepoint C<uv> to the end
6750 of the string C<d>; C<d> should be have at least C<UTF8_MAXBYTES+1> free
6751 bytes available. The return value is the pointer to the byte after the
6752 end of the new character. In other words,
6754 d = uvchr_to_utf8(d, uv);
6756 is the recommended wide native character-aware way of saying
6760 U8* uvchr_to_utf8(U8 *d, UV uv)
6763 Found in file utf8.c
6765 =item uvuni_to_utf8_flags
6766 X<uvuni_to_utf8_flags>
6768 Adds the UTF-8 representation of the Unicode codepoint C<uv> to the end
6769 of the string C<d>; C<d> should be have at least C<UTF8_MAXBYTES+1> free
6770 bytes available. The return value is the pointer to the byte after the
6771 end of the new character. In other words,
6773 d = uvuni_to_utf8_flags(d, uv, flags);
6777 d = uvuni_to_utf8(d, uv);
6779 (which is equivalent to)
6781 d = uvuni_to_utf8_flags(d, uv, 0);
6783 is the recommended Unicode-aware way of saying
6787 U8* uvuni_to_utf8_flags(U8 *d, UV uv, UV flags)
6790 Found in file utf8.c
6795 =head1 Variables created by C<xsubpp> and C<xsubpp> internal functions
6802 Variable which is setup by C<xsubpp> to indicate the stack base offset,
6803 used by the C<ST>, C<XSprePUSH> and C<XSRETURN> macros. The C<dMARK> macro
6804 must be called prior to setup the C<MARK> variable.
6809 Found in file XSUB.h
6814 Variable which is setup by C<xsubpp> to indicate the
6815 class name for a C++ XS constructor. This is always a C<char*>. See C<THIS>.
6820 Found in file XSUB.h
6825 Sets up the C<ax> variable.
6826 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
6831 Found in file XSUB.h
6836 Sets up the C<ax> variable and stack marker variable C<mark>.
6837 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
6842 Found in file XSUB.h
6847 Sets up the C<items> variable.
6848 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
6853 Found in file XSUB.h
6858 Sets up the C<padoff_du> variable for an XSUB that wishes to use
6864 Found in file XSUB.h
6869 Sets up stack and mark pointers for an XSUB, calling dSP and dMARK.
6870 Sets up the C<ax> and C<items> variables by calling C<dAX> and C<dITEMS>.
6871 This is usually handled automatically by C<xsubpp>.
6876 Found in file XSUB.h
6881 Sets up the C<ix> variable for an XSUB which has aliases. This is usually
6882 handled automatically by C<xsubpp>.
6887 Found in file XSUB.h
6892 Variable which is setup by C<xsubpp> to indicate the number of
6893 items on the stack. See L<perlxs/"Variable-length Parameter Lists">.
6898 Found in file XSUB.h
6903 Variable which is setup by C<xsubpp> to indicate which of an
6904 XSUB's aliases was used to invoke it. See L<perlxs/"The ALIAS: Keyword">.
6909 Found in file XSUB.h
6914 Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
6918 Found in file XSUB.h
6923 Variable which is setup by C<xsubpp> to hold the return value for an
6924 XSUB. This is always the proper type for the XSUB. See
6925 L<perlxs/"The RETVAL Variable">.
6930 Found in file XSUB.h
6935 Used to access elements on the XSUB's stack.
6940 Found in file XSUB.h
6945 Variable which is setup by C<xsubpp> to designate the object in a C++
6946 XSUB. This is always the proper type for the C++ object. See C<CLASS> and
6947 L<perlxs/"Using XS With C++">.
6952 Found in file XSUB.h
6957 The SV* corresponding to the $_ variable. Works even if there
6958 is a lexical $_ in scope.
6961 Found in file XSUB.h
6966 Macro to declare an XSUB and its C parameter list. This is handled by
6970 Found in file XSUB.h
6975 The version identifier for an XS module. This is usually
6976 handled automatically by C<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>.
6979 Found in file XSUB.h
6981 =item XS_VERSION_BOOTCHECK
6982 X<XS_VERSION_BOOTCHECK>
6984 Macro to verify that a PM module's $VERSION variable matches the XS
6985 module's C<XS_VERSION> variable. This is usually handled automatically by
6986 C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">.
6988 XS_VERSION_BOOTCHECK;
6991 Found in file XSUB.h
6996 =head1 Warning and Dieing
7003 This is the XSUB-writer's interface to Perl's C<die> function.
7004 Normally call this function the same way you call the C C<printf>
7005 function. Calling C<croak> returns control directly to Perl,
7006 sidestepping the normal C order of execution. See C<warn>.
7008 If you want to throw an exception object, assign the object to
7009 C<$@> and then pass C<NULL> to croak():
7011 errsv = get_sv("@", TRUE);
7012 sv_setsv(errsv, exception_object);
7015 void croak(const char* pat, ...)
7018 Found in file util.c
7023 This is the XSUB-writer's interface to Perl's C<warn> function. Call this
7024 function the same way you call the C C<printf> function. See C<croak>.
7026 void warn(const char* pat, ...)
7029 Found in file util.c
7036 Until May 1997, this document was maintained by Jeff Okamoto
7037 <okamoto@corp.hp.com>. It is now maintained as part of Perl itself.
7039 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
7040 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
7041 Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
7042 Stephen McCamant, and Gurusamy Sarathy.
7044 API Listing originally by Dean Roehrich <roehrich@cray.com>.
7046 Updated to be autogenerated from comments in the source by Benjamin Stuhl.
7050 perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
https://perl5.git.perl.org / perl5.git / blob