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->new 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. Similarly for all the searched stashes.
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 a 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);
2661 Returns a pointer to the upgraded SV.
2663 SV* upg_version(SV *ver)
2666 Found in file util.c
2671 Version object aware cmp. Both operands must already have been
2672 converted into version objects.
2674 int vcmp(SV *lvs, SV *rvs)
2677 Found in file util.c
2682 Accepts a version object and returns the normalized string
2683 representation. Call like:
2687 NOTE: you can pass either the object directly or the SV
2688 contained within the RV.
2693 Found in file util.c
2698 Accepts a version object and returns the normalized floating
2699 point representation. Call like:
2703 NOTE: you can pass either the object directly or the SV
2704 contained within the RV.
2709 Found in file util.c
2714 In order to maintain maximum compatibility with earlier versions
2715 of Perl, this function will return either the floating point
2716 notation or the multiple dotted notation, depending on whether
2717 the original version contained 1 or more dots, respectively
2719 SV* vstringify(SV *vs)
2722 Found in file util.c
2727 Validates that the SV contains a valid version object.
2729 bool vverify(SV *vobj);
2731 Note that it only confirms the bare minimum structure (so as not to get
2732 confused by derived classes which may contain additional hash entries):
2734 bool vverify(SV *vs)
2737 Found in file util.c
2742 =head1 Multicall Functions
2749 Declare local variables for a multicall. See L<perlcall/Lightweight Callbacks>.
2759 Make a lightweight callback. See L<perlcall/Lightweight Callbacks>.
2769 Closing bracket for a lightweight callback.
2770 See L<perlcall/Lightweight Callbacks>.
2777 =item PUSH_MULTICALL
2780 Opening bracket for a lightweight callback.
2781 See L<perlcall/Lightweight Callbacks>.
2791 =head1 Numeric functions
2798 converts a string representing a binary number to numeric form.
2800 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2801 conversion flags, and I<result> should be NULL or a pointer to an NV.
2802 The scan stops at the end of the string, or the first invalid character.
2803 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2804 invalid character will also trigger a warning.
2805 On return I<*len> is set to the length of the scanned string,
2806 and I<*flags> gives output flags.
2808 If the value is <= C<UV_MAX> it is returned as a UV, the output flags are clear,
2809 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_bin>
2810 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2811 and writes the value to I<*result> (or the value is discarded if I<result>
2814 The binary number may optionally be prefixed with "0b" or "b" unless
2815 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
2816 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the binary
2817 number may use '_' characters to separate digits.
2819 UV grok_bin(const char* start, STRLEN* len_p, I32* flags, NV *result)
2822 Found in file numeric.c
2827 converts a string representing a hex number to numeric form.
2829 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2830 conversion flags, and I<result> should be NULL or a pointer to an NV.
2831 The scan stops at the end of the string, or the first invalid character.
2832 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2833 invalid character will also trigger a warning.
2834 On return I<*len> is set to the length of the scanned string,
2835 and I<*flags> gives output flags.
2837 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2838 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_hex>
2839 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2840 and writes the value to I<*result> (or the value is discarded if I<result>
2843 The hex number may optionally be prefixed with "0x" or "x" unless
2844 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
2845 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the hex
2846 number may use '_' characters to separate digits.
2848 UV grok_hex(const char* start, STRLEN* len_p, I32* flags, NV *result)
2851 Found in file numeric.c
2856 Recognise (or not) a number. The type of the number is returned
2857 (0 if unrecognised), otherwise it is a bit-ORed combination of
2858 IS_NUMBER_IN_UV, IS_NUMBER_GREATER_THAN_UV_MAX, IS_NUMBER_NOT_INT,
2859 IS_NUMBER_NEG, IS_NUMBER_INFINITY, IS_NUMBER_NAN (defined in perl.h).
2861 If the value of the number can fit an in UV, it is returned in the *valuep
2862 IS_NUMBER_IN_UV will be set to indicate that *valuep is valid, IS_NUMBER_IN_UV
2863 will never be set unless *valuep is valid, but *valuep may have been assigned
2864 to during processing even though IS_NUMBER_IN_UV is not set on return.
2865 If valuep is NULL, IS_NUMBER_IN_UV will be set for the same cases as when
2866 valuep is non-NULL, but no actual assignment (or SEGV) will occur.
2868 IS_NUMBER_NOT_INT will be set with IS_NUMBER_IN_UV if trailing decimals were
2869 seen (in which case *valuep gives the true value truncated to an integer), and
2870 IS_NUMBER_NEG if the number is negative (in which case *valuep holds the
2871 absolute value). IS_NUMBER_IN_UV is not set if e notation was used or the
2872 number is larger than a UV.
2874 int grok_number(const char *pv, STRLEN len, UV *valuep)
2877 Found in file numeric.c
2879 =item grok_numeric_radix
2880 X<grok_numeric_radix>
2882 Scan and skip for a numeric decimal separator (radix).
2884 bool grok_numeric_radix(const char **sp, const char *send)
2887 Found in file numeric.c
2892 converts a string representing an octal number to numeric form.
2894 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2895 conversion flags, and I<result> should be NULL or a pointer to an NV.
2896 The scan stops at the end of the string, or the first invalid character.
2897 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2898 invalid character will also trigger a warning.
2899 On return I<*len> is set to the length of the scanned string,
2900 and I<*flags> gives output flags.
2902 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2903 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_oct>
2904 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2905 and writes the value to I<*result> (or the value is discarded if I<result>
2908 If C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the octal
2909 number may use '_' characters to separate digits.
2911 UV grok_oct(const char* start, STRLEN* len_p, I32* flags, NV *result)
2914 Found in file numeric.c
2919 Return a non-zero integer if the sign bit on an NV is set, and 0 if
2922 If Configure detects this system has a signbit() that will work with
2923 our NVs, then we just use it via the #define in perl.h. Otherwise,
2924 fall back on this implementation. As a first pass, this gets everything
2925 right except -0.0. Alas, catching -0.0 is the main use for this function,
2926 so this is not too helpful yet. Still, at least we have the scaffolding
2927 in place to support other systems, should that prove useful.
2930 Configure notes: This function is called 'Perl_signbit' instead of a
2931 plain 'signbit' because it is easy to imagine a system having a signbit()
2932 function or macro that doesn't happen to work with our particular choice
2933 of NVs. We shouldn't just re-#define signbit as Perl_signbit and expect
2934 the standard system headers to be happy. Also, this is a no-context
2935 function (no pTHX_) because Perl_signbit() is usually re-#defined in
2936 perl.h as a simple macro call to the system's signbit().
2937 Users should just always call Perl_signbit().
2939 NOTE: this function is experimental and may change or be
2940 removed without notice.
2942 int Perl_signbit(NV f)
2945 Found in file numeric.c
2950 For backwards compatibility. Use C<grok_bin> instead.
2952 NV scan_bin(const char* start, STRLEN len, STRLEN* retlen)
2955 Found in file numeric.c
2960 For backwards compatibility. Use C<grok_hex> instead.
2962 NV scan_hex(const char* start, STRLEN len, STRLEN* retlen)
2965 Found in file numeric.c
2970 For backwards compatibility. Use C<grok_oct> instead.
2972 NV scan_oct(const char* start, STRLEN len, STRLEN* retlen)
2975 Found in file numeric.c
2980 =head1 Optree Manipulation Functions
2987 If C<cv> is a constant sub eligible for inlining. returns the constant
2988 value returned by the sub. Otherwise, returns NULL.
2990 Constant subs can be created with C<newCONSTSUB> or as described in
2991 L<perlsub/"Constant Functions">.
2993 SV* cv_const_sv(CV* cv)
3001 Creates a constant sub equivalent to Perl C<sub FOO () { 123 }> which is
3002 eligible for inlining at compile-time.
3004 CV* newCONSTSUB(HV* stash, const char* name, SV* sv)
3012 Used by C<xsubpp> to hook up XSUBs as Perl subs. I<filename> needs to be
3013 static storage, as it is used directly as CvFILE(), without a copy being made.
3021 =head1 Pad Data Structures
3028 Get the value at offset po in the current pad.
3029 Use macro PAD_SV instead of calling this function directly.
3031 SV* pad_sv(PADOFFSET po)
3039 =head1 Simple Exception Handling Macros
3046 Set up necessary local variables for exception handling.
3047 See L<perlguts/"Exception Handling">.
3052 Found in file XSUB.h
3057 Introduces a catch block. See L<perlguts/"Exception Handling">.
3060 Found in file XSUB.h
3065 Rethrows a previously caught exception. See L<perlguts/"Exception Handling">.
3070 Found in file XSUB.h
3075 Ends a try block. See L<perlguts/"Exception Handling">.
3078 Found in file XSUB.h
3080 =item XCPT_TRY_START
3083 Starts a try block. See L<perlguts/"Exception Handling">.
3086 Found in file XSUB.h
3091 =head1 Stack Manipulation Macros
3098 Declare a stack marker variable, C<mark>, for the XSUB. See C<MARK> and
3109 Saves the original stack mark for the XSUB. See C<ORIGMARK>.
3119 Declares a local copy of perl's stack pointer for the XSUB, available via
3120 the C<SP> macro. See C<SP>.
3130 Used to extend the argument stack for an XSUB's return values. Once
3131 used, guarantees that there is room for at least C<nitems> to be pushed
3134 void EXTEND(SP, int nitems)
3142 Stack marker variable for the XSUB. See C<dMARK>.
3150 Push an integer onto the stack. The stack must have room for this element.
3151 Handles 'set' magic. Does not use C<TARG>. See also C<PUSHi>, C<mXPUSHi>
3162 Push a double onto the stack. The stack must have room for this element.
3163 Handles 'set' magic. Does not use C<TARG>. See also C<PUSHn>, C<mXPUSHn>
3174 Push a string onto the stack. The stack must have room for this element.
3175 The C<len> indicates the length of the string. Handles 'set' magic. Does
3176 not use C<TARG>. See also C<PUSHp>, C<mXPUSHp> and C<XPUSHp>.
3178 void mPUSHp(char* str, STRLEN len)
3186 Push an unsigned integer onto the stack. The stack must have room for this
3187 element. Handles 'set' magic. Does not use C<TARG>. See also C<PUSHu>,
3188 C<mXPUSHu> and C<XPUSHu>.
3198 Push an integer onto the stack, extending the stack if necessary. Handles
3199 'set' magic. Does not use C<TARG>. See also C<XPUSHi>, C<mPUSHi> and
3210 Push a double onto the stack, extending the stack if necessary. Handles
3211 'set' magic. Does not use C<TARG>. See also C<XPUSHn>, C<mPUSHn> and
3222 Push a string onto the stack, extending the stack if necessary. The C<len>
3223 indicates the length of the string. Handles 'set' magic. Does not use
3224 C<TARG>. See also C<XPUSHp>, C<mPUSHp> and C<PUSHp>.
3226 void mXPUSHp(char* str, STRLEN len)
3234 Push an unsigned integer onto the stack, extending the stack if necessary.
3235 Handles 'set' magic. Does not use C<TARG>. See also C<XPUSHu>, C<mPUSHu>
3246 The original stack mark for the XSUB. See C<dORIGMARK>.
3254 Pops an integer off the stack.
3264 Pops a long off the stack.
3274 Pops a double off the stack.
3284 Pops a string off the stack. Deprecated. New code should use POPpx.
3294 Pops a string off the stack which must consist of bytes i.e. characters < 256.
3304 Pops a string off the stack.
3314 Pops an SV off the stack.
3324 Push an integer onto the stack. The stack must have room for this element.
3325 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3326 called to declare it. Do not call multiple C<TARG>-oriented macros to
3327 return lists from XSUB's - see C<mPUSHi> instead. See also C<XPUSHi> and
3338 Opening bracket for arguments on a callback. See C<PUTBACK> and
3349 Push a new mortal SV onto the stack. The stack must have room for this
3350 element. Does not handle 'set' magic. Does not use C<TARG>. See also
3351 C<PUSHs>, C<XPUSHmortal> and C<XPUSHs>.
3361 Push a double onto the stack. The stack must have room for this element.
3362 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3363 called to declare it. Do not call multiple C<TARG>-oriented macros to
3364 return lists from XSUB's - see C<mPUSHn> instead. See also C<XPUSHn> and
3375 Push a string onto the stack. The stack must have room for this element.
3376 The C<len> indicates the length of the string. Handles 'set' magic. Uses
3377 C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to declare it. Do not
3378 call multiple C<TARG>-oriented macros to return lists from XSUB's - see
3379 C<mPUSHp> instead. See also C<XPUSHp> and C<mXPUSHp>.
3381 void PUSHp(char* str, STRLEN len)
3389 Push an SV onto the stack. The stack must have room for this element.
3390 Does not handle 'set' magic. Does not use C<TARG>. See also C<PUSHmortal>,
3391 C<XPUSHs> and C<XPUSHmortal>.
3401 Push an unsigned integer onto the stack. The stack must have room for this
3402 element. Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG>
3403 should be called to declare it. Do not call multiple C<TARG>-oriented
3404 macros to return lists from XSUB's - see C<mPUSHu> instead. See also
3405 C<XPUSHu> and C<mXPUSHu>.
3415 Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
3416 See C<PUSHMARK> and L<perlcall> for other uses.
3426 Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and
3435 Refetch the stack pointer. Used after a callback. See L<perlcall>.
3445 Push an integer onto the stack, extending the stack if necessary. Handles
3446 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
3447 declare it. Do not call multiple C<TARG>-oriented macros to return lists
3448 from XSUB's - see C<mXPUSHi> instead. See also C<PUSHi> and C<mPUSHi>.
3458 Push a new mortal SV onto the stack, extending the stack if necessary. Does
3459 not handle 'set' magic. Does not use C<TARG>. See also C<XPUSHs>,
3460 C<PUSHmortal> and C<PUSHs>.
3470 Push a double onto the stack, extending the stack if necessary. Handles
3471 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
3472 declare it. Do not call multiple C<TARG>-oriented macros to return lists
3473 from XSUB's - see C<mXPUSHn> instead. See also C<PUSHn> and C<mPUSHn>.
3483 Push a string onto the stack, extending the stack if necessary. The C<len>
3484 indicates the length of the string. Handles 'set' magic. Uses C<TARG>, so
3485 C<dTARGET> or C<dXSTARG> should be called to declare it. Do not call
3486 multiple C<TARG>-oriented macros to return lists from XSUB's - see
3487 C<mXPUSHp> instead. See also C<PUSHp> and C<mPUSHp>.
3489 void XPUSHp(char* str, STRLEN len)
3497 Push an SV onto the stack, extending the stack if necessary. Does not
3498 handle 'set' magic. Does not use C<TARG>. See also C<XPUSHmortal>,
3499 C<PUSHs> and C<PUSHmortal>.
3509 Push an unsigned integer onto the stack, extending the stack if necessary.
3510 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3511 called to declare it. Do not call multiple C<TARG>-oriented macros to
3512 return lists from XSUB's - see C<mXPUSHu> instead. See also C<PUSHu> and
3523 Return from XSUB, indicating number of items on the stack. This is usually
3524 handled by C<xsubpp>.
3526 void XSRETURN(int nitems)
3529 Found in file XSUB.h
3531 =item XSRETURN_EMPTY
3534 Return an empty list from an XSUB immediately.
3539 Found in file XSUB.h
3544 Return an integer from an XSUB immediately. Uses C<XST_mIV>.
3546 void XSRETURN_IV(IV iv)
3549 Found in file XSUB.h
3554 Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
3559 Found in file XSUB.h
3564 Return a double from an XSUB immediately. Uses C<XST_mNV>.
3566 void XSRETURN_NV(NV nv)
3569 Found in file XSUB.h
3574 Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
3576 void XSRETURN_PV(char* str)
3579 Found in file XSUB.h
3581 =item XSRETURN_UNDEF
3584 Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
3589 Found in file XSUB.h
3594 Return an integer from an XSUB immediately. Uses C<XST_mUV>.
3596 void XSRETURN_UV(IV uv)
3599 Found in file XSUB.h
3604 Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
3609 Found in file XSUB.h
3614 Place an integer into the specified position C<pos> on the stack. The
3615 value is stored in a new mortal SV.
3617 void XST_mIV(int pos, IV iv)
3620 Found in file XSUB.h
3625 Place C<&PL_sv_no> into the specified position C<pos> on the
3628 void XST_mNO(int pos)
3631 Found in file XSUB.h
3636 Place a double into the specified position C<pos> on the stack. The value
3637 is stored in a new mortal SV.
3639 void XST_mNV(int pos, NV nv)
3642 Found in file XSUB.h
3647 Place a copy of a string into the specified position C<pos> on the stack.
3648 The value is stored in a new mortal SV.
3650 void XST_mPV(int pos, char* str)
3653 Found in file XSUB.h
3658 Place C<&PL_sv_undef> into the specified position C<pos> on the
3661 void XST_mUNDEF(int pos)
3664 Found in file XSUB.h
3669 Place C<&PL_sv_yes> into the specified position C<pos> on the
3672 void XST_mYES(int pos)
3675 Found in file XSUB.h
3687 An enum of flags for Perl types. These are found in the file B<sv.h>
3688 in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
3696 Integer type flag for scalars. See C<svtype>.
3704 Double type flag for scalars. See C<svtype>.
3712 Pointer type flag for scalars. See C<svtype>.
3720 Type flag for arrays. See C<svtype>.
3728 Type flag for code refs. See C<svtype>.
3736 Type flag for hashes. See C<svtype>.
3744 Type flag for blessed scalars. See C<svtype>.
3752 =head1 SV Manipulation Functions
3759 Returns the SV of the specified Perl scalar. If C<create> is set and the
3760 Perl variable does not exist then it will be created. If C<create> is not
3761 set and the variable does not exist then NULL is returned.
3763 NOTE: the perl_ form of this function is deprecated.
3765 SV* get_sv(const char* name, I32 create)
3768 Found in file perl.c
3773 Creates an RV wrapper for an SV. The reference count for the original SV is
3776 SV* newRV_inc(SV* sv)
3784 Returns the length of the string which is in the SV. See C<SvLEN>.
3786 STRLEN SvCUR(SV* sv)
3794 Set the current length of the string which is in the SV. See C<SvCUR>
3797 void SvCUR_set(SV* sv, STRLEN len)
3805 Returns a pointer to the last character in the string which is in the SV.
3806 See C<SvCUR>. Access the character as *(SvEND(sv)).
3816 Returns true if the SV has get magic or overloading. If either is true then
3817 the scalar is active data, and has the potential to return a new value every
3818 time it is accessed. Hence you must be careful to only read it once per user
3819 logical operation and work with that returned value. If neither is true then
3820 the scalar's value cannot change unless written to.
3822 char* SvGAMAGIC(SV* sv)
3830 Expands the character buffer in the SV so that it has room for the
3831 indicated number of bytes (remember to reserve space for an extra trailing
3832 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
3833 Returns a pointer to the character buffer.
3835 char * SvGROW(SV* sv, STRLEN len)
3843 Returns a U32 value indicating whether the SV contains an integer.
3853 Returns a U32 value indicating whether the SV contains an integer. Checks
3854 the B<private> setting. Use C<SvIOK>.
3864 Returns a boolean indicating whether the SV contains a signed integer.
3866 bool SvIOK_notUV(SV* sv)
3874 Unsets the IV status of an SV.
3876 void SvIOK_off(SV* sv)
3884 Tells an SV that it is an integer.
3886 void SvIOK_on(SV* sv)
3894 Tells an SV that it is an integer and disables all other OK bits.
3896 void SvIOK_only(SV* sv)
3904 Tells and SV that it is an unsigned integer and disables all other OK bits.
3906 void SvIOK_only_UV(SV* sv)
3914 Returns a boolean indicating whether the SV contains an unsigned integer.
3916 bool SvIOK_UV(SV* sv)
3924 Returns a boolean indicating whether the SV is Copy-On-Write. (either shared
3925 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
3928 bool SvIsCOW(SV* sv)
3933 =item SvIsCOW_shared_hash
3934 X<SvIsCOW_shared_hash>
3936 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
3939 bool SvIsCOW_shared_hash(SV* sv)
3947 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
3948 version which guarantees to evaluate sv only once.
3958 Returns the raw value in the SV's IV slot, without checks or conversions.
3959 Only use when you are sure SvIOK is true. See also C<SvIV()>.
3969 Coerces the given SV to an integer and returns it. Guarantees to evaluate
3970 sv only once. Use the more efficient C<SvIV> otherwise.
3980 Like C<SvIV> but doesn't process magic.
3982 IV SvIV_nomg(SV* sv)
3990 Set the value of the IV pointer in sv to val. It is possible to perform
3991 the same function of this macro with an lvalue assignment to C<SvIVX>.
3992 With future Perls, however, it will be more efficient to use
3993 C<SvIV_set> instead of the lvalue assignment to C<SvIVX>.
3995 void SvIV_set(SV* sv, IV val)
4003 Returns the size of the string buffer in the SV, not including any part
4004 attributable to C<SvOOK>. See C<SvCUR>.
4006 STRLEN SvLEN(SV* sv)
4014 Set the actual length of the string which is in the SV. See C<SvIV_set>.
4016 void SvLEN_set(SV* sv, STRLEN len)
4024 Set the value of the MAGIC pointer in sv to val. See C<SvIV_set>.
4026 void SvMAGIC_set(SV* sv, MAGIC* val)
4034 Returns a U32 value indicating whether the SV contains a number, integer or
4045 Returns a U32 value indicating whether the SV contains a number, integer or
4046 double. Checks the B<private> setting. Use C<SvNIOK>.
4056 Unsets the NV/IV status of an SV.
4058 void SvNIOK_off(SV* sv)
4066 Returns a U32 value indicating whether the SV contains a double.
4076 Returns a U32 value indicating whether the SV contains a double. Checks the
4077 B<private> setting. Use C<SvNOK>.
4087 Unsets the NV status of an SV.
4089 void SvNOK_off(SV* sv)
4097 Tells an SV that it is a double.
4099 void SvNOK_on(SV* sv)
4107 Tells an SV that it is a double and disables all other OK bits.
4109 void SvNOK_only(SV* sv)
4117 Coerce the given SV to a double and return it. See C<SvNVx> for a version
4118 which guarantees to evaluate sv only once.
4128 Returns the raw value in the SV's NV slot, without checks or conversions.
4129 Only use when you are sure SvNOK is true. See also C<SvNV()>.
4139 Coerces the given SV to a double and returns it. Guarantees to evaluate
4140 sv only once. Use the more efficient C<SvNV> otherwise.
4150 Set the value of the NV pointer in sv to val. See C<SvIV_set>.
4152 void SvNV_set(SV* sv, NV val)
4160 Returns a U32 value indicating whether the value is an SV. It also tells
4161 whether the value is defined or not.
4171 Returns a U32 indicating whether the SvIVX is a valid offset value for
4172 the SvPVX. This hack is used internally to speed up removal of characters
4173 from the beginning of a SvPV. When SvOOK is true, then the start of the
4174 allocated string buffer is really (SvPVX - SvIVX).
4184 Returns a U32 value indicating whether the SV contains a character
4195 Returns a U32 value indicating whether the SV contains a character string.
4196 Checks the B<private> setting. Use C<SvPOK>.
4206 Unsets the PV status of an SV.
4208 void SvPOK_off(SV* sv)
4216 Tells an SV that it is a string.
4218 void SvPOK_on(SV* sv)
4226 Tells an SV that it is a string and disables all other OK bits.
4227 Will also turn off the UTF-8 status.
4229 void SvPOK_only(SV* sv)
4234 =item SvPOK_only_UTF8
4237 Tells an SV that it is a string and disables all other OK bits,
4238 and leaves the UTF-8 status as it was.
4240 void SvPOK_only_UTF8(SV* sv)
4248 Returns a pointer to the string in the SV, or a stringified form of
4249 the SV if the SV does not contain a string. The SV may cache the
4250 stringified version becoming C<SvPOK>. Handles 'get' magic. See also
4251 C<SvPVx> for a version which guarantees to evaluate sv only once.
4253 char* SvPV(SV* sv, STRLEN len)
4261 Like C<SvPV>, but converts sv to byte representation first if necessary.
4263 char* SvPVbyte(SV* sv, STRLEN len)
4271 Like C<SvPV>, but converts sv to byte representation first if necessary.
4272 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
4275 char* SvPVbytex(SV* sv, STRLEN len)
4280 =item SvPVbytex_force
4283 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
4284 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
4287 char* SvPVbytex_force(SV* sv, STRLEN len)
4292 =item SvPVbyte_force
4295 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
4297 char* SvPVbyte_force(SV* sv, STRLEN len)
4302 =item SvPVbyte_nolen
4305 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
4307 char* SvPVbyte_nolen(SV* sv)
4315 Like C<SvPV>, but converts sv to utf8 first if necessary.
4317 char* SvPVutf8(SV* sv, STRLEN len)
4325 Like C<SvPV>, but converts sv to utf8 first if necessary.
4326 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
4329 char* SvPVutf8x(SV* sv, STRLEN len)
4334 =item SvPVutf8x_force
4337 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
4338 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
4341 char* SvPVutf8x_force(SV* sv, STRLEN len)
4346 =item SvPVutf8_force
4349 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
4351 char* SvPVutf8_force(SV* sv, STRLEN len)
4356 =item SvPVutf8_nolen
4359 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
4361 char* SvPVutf8_nolen(SV* sv)
4369 Returns a pointer to the physical string in the SV. The SV must contain a
4380 A version of C<SvPV> which guarantees to evaluate sv only once.
4382 char* SvPVx(SV* sv, STRLEN len)
4390 Like C<SvPV> but will force the SV into containing just a string
4391 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
4394 char* SvPV_force(SV* sv, STRLEN len)
4399 =item SvPV_force_nomg
4402 Like C<SvPV> but will force the SV into containing just a string
4403 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
4404 directly. Doesn't process magic.
4406 char* SvPV_force_nomg(SV* sv, STRLEN len)
4414 Returns a pointer to the string in the SV, or a stringified form of
4415 the SV if the SV does not contain a string. The SV may cache the
4416 stringified form becoming C<SvPOK>. Handles 'get' magic.
4418 char* SvPV_nolen(SV* sv)
4426 Like C<SvPV> but doesn't process magic.
4428 char* SvPV_nomg(SV* sv, STRLEN len)
4436 Set the value of the PV pointer in sv to val. See C<SvIV_set>.
4438 void SvPV_set(SV* sv, char* val)
4446 Returns the value of the object's reference count.
4448 U32 SvREFCNT(SV* sv)
4456 Decrements the reference count of the given SV.
4458 void SvREFCNT_dec(SV* sv)
4466 Increments the reference count of the given SV.
4468 All of the following SvREFCNT_inc* macros are optimized versions of
4469 SvREFCNT_inc, and can be replaced with SvREFCNT_inc.
4471 SV* SvREFCNT_inc(SV* sv)
4476 =item SvREFCNT_inc_NN
4479 Same as SvREFCNT_inc, but can only be used if you know I<sv>
4480 is not NULL. Since we don't have to check the NULLness, it's faster
4483 SV* SvREFCNT_inc_NN(SV* sv)
4488 =item SvREFCNT_inc_simple
4489 X<SvREFCNT_inc_simple>
4491 Same as SvREFCNT_inc, but can only be used with simple variables, not
4492 expressions or pointer dereferences. Since we don't have to store a
4493 temporary value, it's faster.
4495 SV* SvREFCNT_inc_simple(SV* sv)
4500 =item SvREFCNT_inc_simple_NN
4501 X<SvREFCNT_inc_simple_NN>
4503 Same as SvREFCNT_inc_simple, but can only be used if you know I<sv>
4504 is not NULL. Since we don't have to check the NULLness, it's faster
4507 SV* SvREFCNT_inc_simple_NN(SV* sv)
4512 =item SvREFCNT_inc_simple_void
4513 X<SvREFCNT_inc_simple_void>
4515 Same as SvREFCNT_inc_simple, but can only be used if you don't need the
4516 return value. The macro doesn't need to return a meaningful value.
4518 void SvREFCNT_inc_simple_void(SV* sv)
4523 =item SvREFCNT_inc_simple_void_NN
4524 X<SvREFCNT_inc_simple_void_NN>
4526 Same as SvREFCNT_inc, but can only be used if you don't need the return
4527 value, and you know that I<sv> is not NULL. The macro doesn't need
4528 to return a meaningful value, or check for NULLness, so it's smaller
4531 void SvREFCNT_inc_simple_void_NN(SV* sv)
4536 =item SvREFCNT_inc_void
4537 X<SvREFCNT_inc_void>
4539 Same as SvREFCNT_inc, but can only be used if you don't need the
4540 return value. The macro doesn't need to return a meaningful value.
4542 void SvREFCNT_inc_void(SV* sv)
4547 =item SvREFCNT_inc_void_NN
4548 X<SvREFCNT_inc_void_NN>
4550 Same as SvREFCNT_inc, but can only be used if you don't need the return
4551 value, and you know that I<sv> is not NULL. The macro doesn't need
4552 to return a meaningful value, or check for NULLness, so it's smaller
4555 void SvREFCNT_inc_void_NN(SV* sv)
4563 Tests if the SV is an RV.
4573 Unsets the RV status of an SV.
4575 void SvROK_off(SV* sv)
4583 Tells an SV that it is an RV.
4585 void SvROK_on(SV* sv)
4593 Dereferences an RV to return the SV.
4603 Set the value of the RV pointer in sv to val. See C<SvIV_set>.
4605 void SvRV_set(SV* sv, SV* val)
4613 Returns the stash of the SV.
4623 Set the value of the STASH pointer in sv to val. See C<SvIV_set>.
4625 void SvSTASH_set(SV* sv, HV* val)
4633 Taints an SV if tainting is enabled.
4635 void SvTAINT(SV* sv)
4643 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
4646 bool SvTAINTED(SV* sv)
4654 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
4655 some of Perl's fundamental security features. XS module authors should not
4656 use this function unless they fully understand all the implications of
4657 unconditionally untainting the value. Untainting should be done in the
4658 standard perl fashion, via a carefully crafted regexp, rather than directly
4659 untainting variables.
4661 void SvTAINTED_off(SV* sv)
4669 Marks an SV as tainted if tainting is enabled.
4671 void SvTAINTED_on(SV* sv)
4679 Returns a boolean indicating whether Perl would evaluate the SV as true or
4680 false, defined or undefined. Does not handle 'get' magic.
4690 Returns the type of the SV. See C<svtype>.
4692 svtype SvTYPE(SV* sv)
4700 Returns a boolean indicating whether the SV contains an unsigned integer.
4710 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
4711 perform the upgrade if necessary. See C<svtype>.
4713 void SvUPGRADE(SV* sv, svtype type)
4721 Returns a U32 value indicating whether the SV contains UTF-8 encoded data.
4722 Call this after SvPV() in case any call to string overloading updates the
4733 Unsets the UTF-8 status of an SV.
4735 void SvUTF8_off(SV *sv)
4743 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
4744 Do not use frivolously.
4746 void SvUTF8_on(SV *sv)
4754 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
4755 for a version which guarantees to evaluate sv only once.
4765 Returns the raw value in the SV's UV slot, without checks or conversions.
4766 Only use when you are sure SvIOK is true. See also C<SvUV()>.
4776 Coerces the given SV to an unsigned integer and returns it. Guarantees to
4777 evaluate sv only once. Use the more efficient C<SvUV> otherwise.
4787 Like C<SvUV> but doesn't process magic.
4789 UV SvUV_nomg(SV* sv)
4797 Set the value of the UV pointer in sv to val. See C<SvIV_set>.
4799 void SvUV_set(SV* sv, UV val)
4807 Returns a boolean indicating whether the SV contains a v-string.
4814 =item sv_catpvn_nomg
4817 Like C<sv_catpvn> but doesn't process magic.
4819 void sv_catpvn_nomg(SV* sv, const char* ptr, STRLEN len)
4827 Like C<sv_catsv> but doesn't process magic.
4829 void sv_catsv_nomg(SV* dsv, SV* ssv)
4834 =item sv_derived_from
4837 Returns a boolean indicating whether the SV is derived from the specified class
4838 I<at the C level>. To check derivation at the Perl level, call C<isa()> as a
4841 bool sv_derived_from(SV* sv, const char* name)
4844 Found in file universal.c
4849 Returns a boolean indicating whether the SV performs a specific, named role.
4850 The SV can be a Perl object or the name of a Perl class.
4852 bool sv_does(SV* sv, const char* name)
4855 Found in file universal.c
4857 =item sv_report_used
4860 Dump the contents of all SVs not yet freed. (Debugging aid).
4862 void sv_report_used()
4870 Like C<sv_setsv> but doesn't process magic.
4872 void sv_setsv_nomg(SV* dsv, SV* ssv)
4880 =head1 SV-Body Allocation
4884 =item looks_like_number
4885 X<looks_like_number>
4887 Test if the content of an SV looks like a number (or is a number).
4888 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
4889 non-numeric warning), even if your atof() doesn't grok them.
4891 I32 looks_like_number(SV* sv)
4899 Creates an RV wrapper for an SV. The reference count for the original
4900 SV is B<not> incremented.
4902 SV* newRV_noinc(SV* sv)
4910 Creates a new SV. A non-zero C<len> parameter indicates the number of
4911 bytes of preallocated string space the SV should have. An extra byte for a
4912 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4913 space is allocated.) The reference count for the new SV is set to 1.
4915 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4916 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4917 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4918 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4919 modules supporting older perls.
4921 SV* newSV(STRLEN len)
4929 Creates a new SV from the hash key structure. It will generate scalars that
4930 point to the shared string table where possible. Returns a new (undefined)
4931 SV if the hek is NULL.
4933 SV* newSVhek(const HEK *hek)
4941 Creates a new SV and copies an integer into it. The reference count for the
4952 Creates a new SV and copies a floating point value into it.
4953 The reference count for the SV is set to 1.
4963 Creates a new SV and copies a string into it. The reference count for the
4964 SV is set to 1. If C<len> is zero, Perl will compute the length using
4965 strlen(). For efficiency, consider using C<newSVpvn> instead.
4967 SV* newSVpv(const char* s, STRLEN len)
4975 Creates a new SV and initializes it with the string formatted like
4978 SV* newSVpvf(const char* pat, ...)
4986 Creates a new SV and copies a string into it. The reference count for the
4987 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
4988 string. You are responsible for ensuring that the source string is at least
4989 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
4991 SV* newSVpvn(const char* s, STRLEN len)
4996 =item newSVpvn_share
4999 Creates a new SV with its SvPVX_const pointing to a shared string in the string
5000 table. If the string does not already exist in the table, it is created
5001 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
5002 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
5003 otherwise the hash is computed. The idea here is that as the string table
5004 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
5005 hash lookup will avoid string compare.
5007 SV* newSVpvn_share(const char* s, I32 len, U32 hash)
5015 Like C<newSVpvn>, but takes a literal string instead of a string/length pair.
5017 SV* newSVpvs(const char* s)
5020 Found in file handy.h
5022 =item newSVpvs_share
5025 Like C<newSVpvn_share>, but takes a literal string instead of a string/length
5026 pair and omits the hash parameter.
5028 SV* newSVpvs_share(const char* s)
5031 Found in file handy.h
5036 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
5037 it will be upgraded to one. If C<classname> is non-null then the new SV will
5038 be blessed in the specified package. The new SV is returned and its
5039 reference count is 1.
5041 SV* newSVrv(SV* rv, const char* classname)
5049 Creates a new SV which is an exact duplicate of the original SV.
5052 SV* newSVsv(SV* old)
5060 Creates a new SV and copies an unsigned integer into it.
5061 The reference count for the SV is set to 1.
5071 This function is only called on magical items, and is only used by
5072 sv_true() or its macro equivalent.
5074 bool sv_2bool(SV* sv)
5082 Using various gambits, try to get a CV from an SV; in addition, try if
5083 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
5084 The flags in C<lref> are passed to sv_fetchsv.
5086 CV* sv_2cv(SV* sv, HV** st, GV** gvp, I32 lref)
5094 Using various gambits, try to get an IO from an SV: the IO slot if its a
5095 GV; or the recursive result if we're an RV; or the IO slot of the symbol
5096 named after the PV if we're a string.
5106 Return the integer value of an SV, doing any necessary string
5107 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
5108 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
5110 IV sv_2iv_flags(SV* sv, I32 flags)
5118 Marks an existing SV as mortal. The SV will be destroyed "soon", either
5119 by an explicit call to FREETMPS, or by an implicit call at places such as
5120 statement boundaries. SvTEMP() is turned on which means that the SV's
5121 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
5122 and C<sv_mortalcopy>.
5124 SV* sv_2mortal(SV* sv)
5132 Return the num value of an SV, doing any necessary string or integer
5133 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
5144 Return a pointer to the byte-encoded representation of the SV, and set *lp
5145 to its length. May cause the SV to be downgraded from UTF-8 as a
5148 Usually accessed via the C<SvPVbyte> macro.
5150 char* sv_2pvbyte(SV* sv, STRLEN* lp)
5158 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
5159 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
5161 Usually accessed via the C<SvPVutf8> macro.
5163 char* sv_2pvutf8(SV* sv, STRLEN* lp)
5171 Returns a pointer to the string value of an SV, and sets *lp to its length.
5172 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
5174 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
5175 usually end up here too.
5177 char* sv_2pv_flags(SV* sv, STRLEN* lp, I32 flags)
5185 Return the unsigned integer value of an SV, doing any necessary string
5186 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
5187 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
5189 UV sv_2uv_flags(SV* sv, I32 flags)
5197 Remove any string offset. You should normally use the C<SvOOK_off> macro
5200 int sv_backoff(SV* sv)
5208 Blesses an SV into a specified package. The SV must be an RV. The package
5209 must be designated by its stash (see C<gv_stashpv()>). The reference count
5210 of the SV is unaffected.
5212 SV* sv_bless(SV* sv, HV* stash)
5220 Concatenates the string onto the end of the string which is in the SV.
5221 If the SV has the UTF-8 status set, then the bytes appended should be
5222 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
5224 void sv_catpv(SV* sv, const char* ptr)
5232 Processes its arguments like C<sprintf> and appends the formatted
5233 output to an SV. If the appended data contains "wide" characters
5234 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
5235 and characters >255 formatted with %c), the original SV might get
5236 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
5237 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
5238 valid UTF-8; if the original SV was bytes, the pattern should be too.
5240 void sv_catpvf(SV* sv, const char* pat, ...)
5248 Like C<sv_catpvf>, but also handles 'set' magic.
5250 void sv_catpvf_mg(SV *sv, const char* pat, ...)
5258 Concatenates the string onto the end of the string which is in the SV. The
5259 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5260 status set, then the bytes appended should be valid UTF-8.
5261 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
5263 void sv_catpvn(SV* sv, const char* ptr, STRLEN len)
5268 =item sv_catpvn_flags
5271 Concatenates the string onto the end of the string which is in the SV. The
5272 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5273 status set, then the bytes appended should be valid UTF-8.
5274 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
5275 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
5276 in terms of this function.
5278 void sv_catpvn_flags(SV* sv, const char* ptr, STRLEN len, I32 flags)
5286 Like C<sv_catpvn>, but takes a literal string instead of a string/length pair.
5288 void sv_catpvs(SV* sv, const char* s)
5291 Found in file handy.h
5296 Like C<sv_catpv>, but also handles 'set' magic.
5298 void sv_catpv_mg(SV *sv, const char *ptr)
5306 Concatenates the string from SV C<ssv> onto the end of the string in
5307 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
5308 not 'set' magic. See C<sv_catsv_mg>.
5310 void sv_catsv(SV* dsv, SV* ssv)
5315 =item sv_catsv_flags
5318 Concatenates the string from SV C<ssv> onto the end of the string in
5319 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
5320 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
5321 and C<sv_catsv_nomg> are implemented in terms of this function.
5323 void sv_catsv_flags(SV* dsv, SV* ssv, I32 flags)
5331 Efficient removal of characters from the beginning of the string buffer.
5332 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
5333 the string buffer. The C<ptr> becomes the first character of the adjusted
5334 string. Uses the "OOK hack".
5335 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
5336 refer to the same chunk of data.
5338 void sv_chop(SV* sv, const char* ptr)
5346 Clear an SV: call any destructors, free up any memory used by the body,
5347 and free the body itself. The SV's head is I<not> freed, although
5348 its type is set to all 1's so that it won't inadvertently be assumed
5349 to be live during global destruction etc.
5350 This function should only be called when REFCNT is zero. Most of the time
5351 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5354 void sv_clear(SV* sv)
5362 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5363 string in C<sv1> is less than, equal to, or greater than the string in
5364 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5365 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
5367 I32 sv_cmp(SV* sv1, SV* sv2)
5375 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
5376 'use bytes' aware, handles get magic, and will coerce its args to strings
5377 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
5379 I32 sv_cmp_locale(SV* sv1, SV* sv2)
5387 Add Collate Transform magic to an SV if it doesn't already have it.
5389 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
5390 scalar data of the variable, but transformed to such a format that a normal
5391 memory comparison can be used to compare the data according to the locale
5394 char* sv_collxfrm(SV* sv, STRLEN* nxp)
5402 Copies a stringified representation of the source SV into the
5403 destination SV. Automatically performs any necessary mg_get and
5404 coercion of numeric values into strings. Guaranteed to preserve
5405 UTF-8 flag even from overloaded objects. Similar in nature to
5406 sv_2pv[_flags] but operates directly on an SV instead of just the
5407 string. Mostly uses sv_2pv_flags to do its work, except when that
5408 would lose the UTF-8'ness of the PV.
5410 void sv_copypv(SV* dsv, SV* ssv)
5418 Auto-decrement of the value in the SV, doing string to numeric conversion
5419 if necessary. Handles 'get' magic.
5429 Returns a boolean indicating whether the strings in the two SVs are
5430 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5431 coerce its args to strings if necessary.
5433 I32 sv_eq(SV* sv1, SV* sv2)
5438 =item sv_force_normal_flags
5439 X<sv_force_normal_flags>
5441 Undo various types of fakery on an SV: if the PV is a shared string, make
5442 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
5443 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
5444 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
5445 then a copy-on-write scalar drops its PV buffer (if any) and becomes
5446 SvPOK_off rather than making a copy. (Used where this scalar is about to be
5447 set to some other value.) In addition, the C<flags> parameter gets passed to
5448 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
5449 with flags set to 0.
5451 void sv_force_normal_flags(SV *sv, U32 flags)
5459 Decrement an SV's reference count, and if it drops to zero, call
5460 C<sv_clear> to invoke destructors and free up any memory used by
5461 the body; finally, deallocate the SV's head itself.
5462 Normally called via a wrapper macro C<SvREFCNT_dec>.
5464 void sv_free(SV* sv)
5472 Get a line from the filehandle and store it into the SV, optionally
5473 appending to the currently-stored string.
5475 char* sv_gets(SV* sv, PerlIO* fp, I32 append)
5483 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
5484 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
5485 Use the C<SvGROW> wrapper instead.
5487 char* sv_grow(SV* sv, STRLEN newlen)
5495 Auto-increment of the value in the SV, doing string to numeric conversion
5496 if necessary. Handles 'get' magic.
5506 Inserts a string at the specified offset/length within the SV. Similar to
5507 the Perl substr() function.
5509 void sv_insert(SV* bigsv, STRLEN offset, STRLEN len, const char* little, STRLEN littlelen)
5517 Returns a boolean indicating whether the SV is blessed into the specified
5518 class. This does not check for subtypes; use C<sv_derived_from> to verify
5519 an inheritance relationship.
5521 int sv_isa(SV* sv, const char* name)
5529 Returns a boolean indicating whether the SV is an RV pointing to a blessed
5530 object. If the SV is not an RV, or if the object is not blessed, then this
5533 int sv_isobject(SV* sv)
5541 Returns the length of the string in the SV. Handles magic and type
5542 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5544 STRLEN sv_len(SV* sv)
5552 Returns the number of characters in the string in an SV, counting wide
5553 UTF-8 bytes as a single character. Handles magic and type coercion.
5555 STRLEN sv_len_utf8(SV* sv)
5563 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
5564 then adds a new magic item of type C<how> to the head of the magic list.
5566 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
5567 handling of the C<name> and C<namlen> arguments.
5569 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
5570 to add more than one instance of the same 'how'.
5572 void sv_magic(SV* sv, SV* obj, int how, const char* name, I32 namlen)
5580 Adds magic to an SV, upgrading it if necessary. Applies the
5581 supplied vtable and returns a pointer to the magic added.
5583 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
5584 In particular, you can add magic to SvREADONLY SVs, and add more than
5585 one instance of the same 'how'.
5587 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
5588 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
5589 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
5590 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
5592 (This is now used as a subroutine by C<sv_magic>.)
5594 MAGIC * sv_magicext(SV* sv, SV* obj, int how, const MGVTBL *vtbl, const char* name, I32 namlen)
5602 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
5603 The new SV is marked as mortal. It will be destroyed "soon", either by an
5604 explicit call to FREETMPS, or by an implicit call at places such as
5605 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
5607 SV* sv_mortalcopy(SV* oldsv)
5615 Creates a new null SV which is mortal. The reference count of the SV is
5616 set to 1. It will be destroyed "soon", either by an explicit call to
5617 FREETMPS, or by an implicit call at places such as statement boundaries.
5618 See also C<sv_mortalcopy> and C<sv_2mortal>.
5628 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5631 SV* sv_newref(SV* sv)
5639 Converts the value pointed to by offsetp from a count of bytes from the
5640 start of the string, to a count of the equivalent number of UTF-8 chars.
5641 Handles magic and type coercion.
5643 void sv_pos_b2u(SV* sv, I32* offsetp)
5651 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5652 the start of the string, to a count of the equivalent number of bytes; if
5653 lenp is non-zero, it does the same to lenp, but this time starting from
5654 the offset, rather than from the start of the string. Handles magic and
5657 void sv_pos_u2b(SV* sv, I32* offsetp, I32* lenp)
5662 =item sv_pvbyten_force
5665 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
5667 char* sv_pvbyten_force(SV* sv, STRLEN* lp)
5675 Get a sensible string out of the SV somehow.
5676 A private implementation of the C<SvPV_force> macro for compilers which
5677 can't cope with complex macro expressions. Always use the macro instead.
5679 char* sv_pvn_force(SV* sv, STRLEN* lp)
5684 =item sv_pvn_force_flags
5685 X<sv_pvn_force_flags>
5687 Get a sensible string out of the SV somehow.
5688 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
5689 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
5690 implemented in terms of this function.
5691 You normally want to use the various wrapper macros instead: see
5692 C<SvPV_force> and C<SvPV_force_nomg>
5694 char* sv_pvn_force_flags(SV* sv, STRLEN* lp, I32 flags)
5699 =item sv_pvutf8n_force
5702 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
5704 char* sv_pvutf8n_force(SV* sv, STRLEN* lp)
5712 Returns a string describing what the SV is a reference to.
5714 const char* sv_reftype(const SV* sv, int ob)
5722 Make the first argument a copy of the second, then delete the original.
5723 The target SV physically takes over ownership of the body of the source SV
5724 and inherits its flags; however, the target keeps any magic it owns,
5725 and any magic in the source is discarded.
5726 Note that this is a rather specialist SV copying operation; most of the
5727 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5729 void sv_replace(SV* sv, SV* nsv)
5737 Underlying implementation for the C<reset> Perl function.
5738 Note that the perl-level function is vaguely deprecated.
5740 void sv_reset(const char* s, HV* stash)
5748 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
5749 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
5750 push a back-reference to this RV onto the array of backreferences
5751 associated with that magic. If the RV is magical, set magic will be
5752 called after the RV is cleared.
5754 SV* sv_rvweaken(SV *sv)
5762 Copies an integer into the given SV, upgrading first if necessary.
5763 Does not handle 'set' magic. See also C<sv_setiv_mg>.
5765 void sv_setiv(SV* sv, IV num)
5773 Like C<sv_setiv>, but also handles 'set' magic.
5775 void sv_setiv_mg(SV *sv, IV i)
5783 Copies a double into the given SV, upgrading first if necessary.
5784 Does not handle 'set' magic. See also C<sv_setnv_mg>.
5786 void sv_setnv(SV* sv, NV num)
5794 Like C<sv_setnv>, but also handles 'set' magic.
5796 void sv_setnv_mg(SV *sv, NV num)
5804 Copies a string into an SV. The string must be null-terminated. Does not
5805 handle 'set' magic. See C<sv_setpv_mg>.
5807 void sv_setpv(SV* sv, const char* ptr)
5815 Works like C<sv_catpvf> but copies the text into the SV instead of
5816 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
5818 void sv_setpvf(SV* sv, const char* pat, ...)
5826 Like C<sv_setpvf>, but also handles 'set' magic.
5828 void sv_setpvf_mg(SV *sv, const char* pat, ...)
5836 Copies an integer into the given SV, also updating its string value.
5837 Does not handle 'set' magic. See C<sv_setpviv_mg>.
5839 void sv_setpviv(SV* sv, IV num)
5847 Like C<sv_setpviv>, but also handles 'set' magic.
5849 void sv_setpviv_mg(SV *sv, IV iv)
5857 Copies a string into an SV. The C<len> parameter indicates the number of
5858 bytes to be copied. If the C<ptr> argument is NULL the SV will become
5859 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
5861 void sv_setpvn(SV* sv, const char* ptr, STRLEN len)
5869 Like C<sv_setpvn>, but also handles 'set' magic.
5871 void sv_setpvn_mg(SV *sv, const char *ptr, STRLEN len)
5879 Like C<sv_setpvn>, but takes a literal string instead of a string/length pair.
5881 void sv_setpvs(SV* sv, const char* s)
5884 Found in file handy.h
5889 Like C<sv_setpv>, but also handles 'set' magic.
5891 void sv_setpv_mg(SV *sv, const char *ptr)
5899 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
5900 argument will be upgraded to an RV. That RV will be modified to point to
5901 the new SV. The C<classname> argument indicates the package for the
5902 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
5903 will have a reference count of 1, and the RV will be returned.
5905 SV* sv_setref_iv(SV* rv, const char* classname, IV iv)
5913 Copies a double into a new SV, optionally blessing the SV. The C<rv>
5914 argument will be upgraded to an RV. That RV will be modified to point to
5915 the new SV. The C<classname> argument indicates the package for the
5916 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
5917 will have a reference count of 1, and the RV will be returned.
5919 SV* sv_setref_nv(SV* rv, const char* classname, NV nv)
5927 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
5928 argument will be upgraded to an RV. That RV will be modified to point to
5929 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
5930 into the SV. The C<classname> argument indicates the package for the
5931 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
5932 will have a reference count of 1, and the RV will be returned.
5934 Do not use with other Perl types such as HV, AV, SV, CV, because those
5935 objects will become corrupted by the pointer copy process.
5937 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
5939 SV* sv_setref_pv(SV* rv, const char* classname, void* pv)
5947 Copies a string into a new SV, optionally blessing the SV. The length of the
5948 string must be specified with C<n>. The C<rv> argument will be upgraded to
5949 an RV. That RV will be modified to point to the new SV. The C<classname>
5950 argument indicates the package for the blessing. Set C<classname> to
5951 C<NULL> to avoid the blessing. The new SV will have a reference count
5952 of 1, and the RV will be returned.
5954 Note that C<sv_setref_pv> copies the pointer while this copies the string.
5956 SV* sv_setref_pvn(SV* rv, const char* classname, const char* pv, STRLEN n)
5964 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
5965 argument will be upgraded to an RV. That RV will be modified to point to
5966 the new SV. The C<classname> argument indicates the package for the
5967 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
5968 will have a reference count of 1, and the RV will be returned.
5970 SV* sv_setref_uv(SV* rv, const char* classname, UV uv)
5978 Copies the contents of the source SV C<ssv> into the destination SV
5979 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
5980 function if the source SV needs to be reused. Does not handle 'set' magic.
5981 Loosely speaking, it performs a copy-by-value, obliterating any previous
5982 content of the destination.
5984 You probably want to use one of the assortment of wrappers, such as
5985 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
5986 C<SvSetMagicSV_nosteal>.
5988 void sv_setsv(SV* dsv, SV* ssv)
5993 =item sv_setsv_flags
5996 Copies the contents of the source SV C<ssv> into the destination SV
5997 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
5998 function if the source SV needs to be reused. Does not handle 'set' magic.
5999 Loosely speaking, it performs a copy-by-value, obliterating any previous
6000 content of the destination.
6001 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
6002 C<ssv> if appropriate, else not. If the C<flags> parameter has the
6003 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
6004 and C<sv_setsv_nomg> are implemented in terms of this function.
6006 You probably want to use one of the assortment of wrappers, such as
6007 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
6008 C<SvSetMagicSV_nosteal>.
6010 This is the primary function for copying scalars, and most other
6011 copy-ish functions and macros use this underneath.
6013 void sv_setsv_flags(SV* dsv, SV* ssv, I32 flags)
6021 Like C<sv_setsv>, but also handles 'set' magic.
6023 void sv_setsv_mg(SV *dstr, SV *sstr)
6031 Copies an unsigned integer into the given SV, upgrading first if necessary.
6032 Does not handle 'set' magic. See also C<sv_setuv_mg>.
6034 void sv_setuv(SV* sv, UV num)
6042 Like C<sv_setuv>, but also handles 'set' magic.
6044 void sv_setuv_mg(SV *sv, UV u)
6052 Test an SV for taintedness. Use C<SvTAINTED> instead.
6053 bool sv_tainted(SV* sv)
6061 Returns true if the SV has a true value by Perl's rules.
6062 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
6063 instead use an in-line version.
6073 Removes all magic of type C<type> from an SV.
6075 int sv_unmagic(SV* sv, int type)
6080 =item sv_unref_flags
6083 Unsets the RV status of the SV, and decrements the reference count of
6084 whatever was being referenced by the RV. This can almost be thought of
6085 as a reversal of C<newSVrv>. The C<cflags> argument can contain
6086 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
6087 (otherwise the decrementing is conditional on the reference count being
6088 different from one or the reference being a readonly SV).
6091 void sv_unref_flags(SV* sv, U32 flags)
6099 Untaint an SV. Use C<SvTAINTED_off> instead.
6100 void sv_untaint(SV* sv)
6108 Upgrade an SV to a more complex form. Generally adds a new body type to the
6109 SV, then copies across as much information as possible from the old body.
6110 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
6112 void sv_upgrade(SV* sv, svtype new_type)
6117 =item sv_usepvn_flags
6120 Tells an SV to use C<ptr> to find its string value. Normally the
6121 string is stored inside the SV but sv_usepvn allows the SV to use an
6122 outside string. The C<ptr> should point to memory that was allocated
6123 by C<malloc>. The string length, C<len>, must be supplied. By default
6124 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
6125 so that pointer should not be freed or used by the programmer after
6126 giving it to sv_usepvn, and neither should any pointers from "behind"
6127 that pointer (e.g. ptr + 1) be used.
6129 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
6130 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
6131 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
6132 C<len>, and already meets the requirements for storing in C<SvPVX>)
6134 void sv_usepvn_flags(SV* sv, char* ptr, STRLEN len, U32 flags)
6139 =item sv_utf8_decode
6142 If the PV of the SV is an octet sequence in UTF-8
6143 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
6144 so that it looks like a character. If the PV contains only single-byte
6145 characters, the C<SvUTF8> flag stays being off.
6146 Scans PV for validity and returns false if the PV is invalid UTF-8.
6148 NOTE: this function is experimental and may change or be
6149 removed without notice.
6151 bool sv_utf8_decode(SV *sv)
6156 =item sv_utf8_downgrade
6157 X<sv_utf8_downgrade>
6159 Attempts to convert the PV of an SV from characters to bytes.
6160 If the PV contains a character beyond byte, this conversion will fail;
6161 in this case, either returns false or, if C<fail_ok> is not
6164 This is not as a general purpose Unicode to byte encoding interface:
6165 use the Encode extension for that.
6167 NOTE: this function is experimental and may change or be
6168 removed without notice.
6170 bool sv_utf8_downgrade(SV *sv, bool fail_ok)
6175 =item sv_utf8_encode
6178 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
6179 flag off so that it looks like octets again.
6181 void sv_utf8_encode(SV *sv)
6186 =item sv_utf8_upgrade
6189 Converts the PV of an SV to its UTF-8-encoded form.
6190 Forces the SV to string form if it is not already.
6191 Always sets the SvUTF8 flag to avoid future validity checks even
6192 if all the bytes have hibit clear.
6194 This is not as a general purpose byte encoding to Unicode interface:
6195 use the Encode extension for that.
6197 STRLEN sv_utf8_upgrade(SV *sv)
6202 =item sv_utf8_upgrade_flags
6203 X<sv_utf8_upgrade_flags>
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. If C<flags> has C<SV_GMAGIC> bit set,
6209 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
6210 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
6212 This is not as a general purpose byte encoding to Unicode interface:
6213 use the Encode extension for that.
6215 STRLEN sv_utf8_upgrade_flags(SV *sv, I32 flags)
6223 Processes its arguments like C<vsprintf> and appends the formatted output
6224 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
6226 Usually used via its frontend C<sv_catpvf>.
6228 void sv_vcatpvf(SV* sv, const char* pat, va_list* args)
6236 Processes its arguments like C<vsprintf> and appends the formatted output
6237 to an SV. Uses an array of SVs if the C style variable argument list is
6238 missing (NULL). When running with taint checks enabled, indicates via
6239 C<maybe_tainted> if results are untrustworthy (often due to the use of
6242 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
6244 void sv_vcatpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
6252 Like C<sv_vcatpvf>, but also handles 'set' magic.
6254 Usually used via its frontend C<sv_catpvf_mg>.
6256 void sv_vcatpvf_mg(SV* sv, const char* pat, va_list* args)
6264 Works like C<sv_vcatpvf> but copies the text into the SV instead of
6265 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
6267 Usually used via its frontend C<sv_setpvf>.
6269 void sv_vsetpvf(SV* sv, const char* pat, va_list* args)
6277 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
6280 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
6282 void sv_vsetpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
6290 Like C<sv_vsetpvf>, but also handles 'set' magic.
6292 Usually used via its frontend C<sv_setpvf_mg>.
6294 void sv_vsetpvf_mg(SV* sv, const char* pat, va_list* args)
6302 =head1 Unicode Support
6306 =item bytes_from_utf8
6309 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
6310 Unlike C<utf8_to_bytes> but like C<bytes_to_utf8>, returns a pointer to
6311 the newly-created string, and updates C<len> to contain the new
6312 length. Returns the original string if no conversion occurs, C<len>
6313 is unchanged. Do nothing if C<is_utf8> points to 0. Sets C<is_utf8> to
6314 0 if C<s> is converted or contains all 7bit characters.
6316 NOTE: this function is experimental and may change or be
6317 removed without notice.
6319 U8* bytes_from_utf8(const U8 *s, STRLEN *len, bool *is_utf8)
6322 Found in file utf8.c
6327 Converts a string C<s> of length C<len> from ASCII into UTF-8 encoding.
6328 Returns a pointer to the newly-created string, and sets C<len> to
6329 reflect the new length.
6331 If you want to convert to UTF-8 from other encodings than ASCII,
6332 see sv_recode_to_utf8().
6334 NOTE: this function is experimental and may change or be
6335 removed without notice.
6337 U8* bytes_to_utf8(const U8 *s, STRLEN *len)
6340 Found in file utf8.c
6345 Return true if the strings s1 and s2 differ case-insensitively, false
6346 if not (if they are equal case-insensitively). If u1 is true, the
6347 string s1 is assumed to be in UTF-8-encoded Unicode. If u2 is true,
6348 the string s2 is assumed to be in UTF-8-encoded Unicode. If u1 or u2
6349 are false, the respective string is assumed to be in native 8-bit
6352 If the pe1 and pe2 are non-NULL, the scanning pointers will be copied
6353 in there (they will point at the beginning of the I<next> character).
6354 If the pointers behind pe1 or pe2 are non-NULL, they are the end
6355 pointers beyond which scanning will not continue under any
6356 circumstances. If the byte lengths l1 and l2 are non-zero, s1+l1 and
6357 s2+l2 will be used as goal end pointers that will also stop the scan,
6358 and which qualify towards defining a successful match: all the scans
6359 that define an explicit length must reach their goal pointers for
6360 a match to succeed).
6362 For case-insensitiveness, the "casefolding" of Unicode is used
6363 instead of upper/lowercasing both the characters, see
6364 http://www.unicode.org/unicode/reports/tr21/ (Case Mappings).
6366 I32 ibcmp_utf8(const char* a, char **pe1, UV l1, bool u1, const char* b, char **pe2, UV l2, bool u2)
6369 Found in file utf8.c
6374 Tests if some arbitrary number of bytes begins in a valid UTF-8
6375 character. Note that an INVARIANT (i.e. ASCII) character is a valid
6376 UTF-8 character. The actual number of bytes in the UTF-8 character
6377 will be returned if it is valid, otherwise 0.
6379 STRLEN is_utf8_char(const U8 *p)
6382 Found in file utf8.c
6384 =item is_utf8_string
6387 Returns true if first C<len> bytes of the given string form a valid
6388 UTF-8 string, false otherwise. Note that 'a valid UTF-8 string' does
6389 not mean 'a string that contains code points above 0x7F encoded in UTF-8'
6390 because a valid ASCII string is a valid UTF-8 string.
6392 See also is_utf8_string_loclen() and is_utf8_string_loc().
6394 bool is_utf8_string(const U8 *s, STRLEN len)
6397 Found in file utf8.c
6399 =item is_utf8_string_loc
6400 X<is_utf8_string_loc>
6402 Like is_utf8_string() but stores the location of the failure (in the
6403 case of "utf8ness failure") or the location s+len (in the case of
6404 "utf8ness success") in the C<ep>.
6406 See also is_utf8_string_loclen() and is_utf8_string().
6408 bool is_utf8_string_loc(const U8 *s, STRLEN len, const U8 **p)
6411 Found in file utf8.c
6413 =item is_utf8_string_loclen
6414 X<is_utf8_string_loclen>
6416 Like is_utf8_string() but stores the location of the failure (in the
6417 case of "utf8ness failure") or the location s+len (in the case of
6418 "utf8ness success") in the C<ep>, and the number of UTF-8
6419 encoded characters in the C<el>.
6421 See also is_utf8_string_loc() and is_utf8_string().
6423 bool is_utf8_string_loclen(const U8 *s, STRLEN len, const U8 **ep, STRLEN *el)
6426 Found in file utf8.c
6428 =item pv_uni_display
6431 Build to the scalar dsv a displayable version of the string spv,
6432 length len, the displayable version being at most pvlim bytes long
6433 (if longer, the rest is truncated and "..." will be appended).
6435 The flags argument can have UNI_DISPLAY_ISPRINT set to display
6436 isPRINT()able characters as themselves, UNI_DISPLAY_BACKSLASH
6437 to display the \\[nrfta\\] as the backslashed versions (like '\n')
6438 (UNI_DISPLAY_BACKSLASH is preferred over UNI_DISPLAY_ISPRINT for \\).
6439 UNI_DISPLAY_QQ (and its alias UNI_DISPLAY_REGEX) have both
6440 UNI_DISPLAY_BACKSLASH and UNI_DISPLAY_ISPRINT turned on.
6442 The pointer to the PV of the dsv is returned.
6444 char* pv_uni_display(SV *dsv, const U8 *spv, STRLEN len, STRLEN pvlim, UV flags)
6447 Found in file utf8.c
6452 The encoding is assumed to be an Encode object, the PV of the ssv is
6453 assumed to be octets in that encoding and decoding the input starts
6454 from the position which (PV + *offset) pointed to. The dsv will be
6455 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
6456 when the string tstr appears in decoding output or the input ends on
6457 the PV of the ssv. The value which the offset points will be modified
6458 to the last input position on the ssv.
6460 Returns TRUE if the terminator was found, else returns FALSE.
6462 bool sv_cat_decode(SV* dsv, SV *encoding, SV *ssv, int *offset, char* tstr, int tlen)
6467 =item sv_recode_to_utf8
6468 X<sv_recode_to_utf8>
6470 The encoding is assumed to be an Encode object, on entry the PV
6471 of the sv is assumed to be octets in that encoding, and the sv
6472 will be converted into Unicode (and UTF-8).
6474 If the sv already is UTF-8 (or if it is not POK), or if the encoding
6475 is not a reference, nothing is done to the sv. If the encoding is not
6476 an C<Encode::XS> Encoding object, bad things will happen.
6477 (See F<lib/encoding.pm> and L<Encode>).
6479 The PV of the sv is returned.
6481 char* sv_recode_to_utf8(SV* sv, SV *encoding)
6486 =item sv_uni_display
6489 Build to the scalar dsv a displayable version of the scalar sv,
6490 the displayable version being at most pvlim bytes long
6491 (if longer, the rest is truncated and "..." will be appended).
6493 The flags argument is as in pv_uni_display().
6495 The pointer to the PV of the dsv is returned.
6497 char* sv_uni_display(SV *dsv, SV *ssv, STRLEN pvlim, UV flags)
6500 Found in file utf8.c
6505 The "p" contains the pointer to the UTF-8 string encoding
6506 the character that is being converted.
6508 The "ustrp" is a pointer to the character buffer to put the
6509 conversion result to. The "lenp" is a pointer to the length
6512 The "swashp" is a pointer to the swash to use.
6514 Both the special and normal mappings are stored lib/unicore/To/Foo.pl,
6515 and loaded by SWASHNEW, using lib/utf8_heavy.pl. The special (usually,
6516 but not always, a multicharacter mapping), is tried first.
6518 The "special" is a string like "utf8::ToSpecLower", which means the
6519 hash %utf8::ToSpecLower. The access to the hash is through
6520 Perl_to_utf8_case().
6522 The "normal" is a string like "ToLower" which means the swash
6525 UV to_utf8_case(const U8 *p, U8* ustrp, STRLEN *lenp, SV **swashp, const char *normal, const char *special)
6528 Found in file utf8.c
6533 Convert the UTF-8 encoded character at p to its foldcase version and
6534 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6535 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6536 foldcase version may be longer than the original character (up to
6539 The first character of the foldcased version is returned
6540 (but note, as explained above, that there may be more.)
6542 UV to_utf8_fold(const U8 *p, U8* ustrp, STRLEN *lenp)
6545 Found in file utf8.c
6550 Convert the UTF-8 encoded character at p to its lowercase version and
6551 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6552 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6553 lowercase version may be longer than the original character.
6555 The first character of the lowercased version is returned
6556 (but note, as explained above, that there may be more.)
6558 UV to_utf8_lower(const U8 *p, U8* ustrp, STRLEN *lenp)
6561 Found in file utf8.c
6566 Convert the UTF-8 encoded character at p to its titlecase 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 titlecase version may be longer than the original character.
6571 The first character of the titlecased version is returned
6572 (but note, as explained above, that there may be more.)
6574 UV to_utf8_title(const U8 *p, U8* ustrp, STRLEN *lenp)
6577 Found in file utf8.c
6582 Convert the UTF-8 encoded character at p to its uppercase 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
6585 the uppercase version may be longer than the original character.
6587 The first character of the uppercased version is returned
6588 (but note, as explained above, that there may be more.)
6590 UV to_utf8_upper(const U8 *p, U8* ustrp, STRLEN *lenp)
6593 Found in file utf8.c
6595 =item utf8n_to_uvchr
6600 Returns the native character value of the first character in the string
6602 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6603 length, in bytes, of that character.
6605 Allows length and flags to be passed to low level routine.
6607 UV utf8n_to_uvchr(const U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags)
6610 Found in file utf8.c
6612 =item utf8n_to_uvuni
6615 Bottom level UTF-8 decode routine.
6616 Returns the unicode code point value of the first character in the string C<s>
6617 which is assumed to be in UTF-8 encoding and no longer than C<curlen>;
6618 C<retlen> will be set to the length, in bytes, of that character.
6620 If C<s> does not point to a well-formed UTF-8 character, the behaviour
6621 is dependent on the value of C<flags>: if it contains UTF8_CHECK_ONLY,
6622 it is assumed that the caller will raise a warning, and this function
6623 will silently just set C<retlen> to C<-1> and return zero. If the
6624 C<flags> does not contain UTF8_CHECK_ONLY, warnings about
6625 malformations will be given, C<retlen> will be set to the expected
6626 length of the UTF-8 character in bytes, and zero will be returned.
6628 The C<flags> can also contain various flags to allow deviations from
6629 the strict UTF-8 encoding (see F<utf8.h>).
6631 Most code should use utf8_to_uvchr() rather than call this directly.
6633 UV utf8n_to_uvuni(const U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags)
6636 Found in file utf8.c
6641 Returns the number of UTF-8 characters between the UTF-8 pointers C<a>
6644 WARNING: use only if you *know* that the pointers point inside the
6647 IV utf8_distance(const U8 *a, const U8 *b)
6650 Found in file utf8.c
6655 Return the UTF-8 pointer C<s> displaced by C<off> characters, either
6656 forward or backward.
6658 WARNING: do not use the following unless you *know* C<off> is within
6659 the UTF-8 data pointed to by C<s> *and* that on entry C<s> is aligned
6660 on the first byte of character or just after the last byte of a character.
6662 U8* utf8_hop(const U8 *s, I32 off)
6665 Found in file utf8.c
6670 Return the length of the UTF-8 char encoded string C<s> in characters.
6671 Stops at C<e> (inclusive). If C<e E<lt> s> or if the scan would end
6672 up past C<e>, croaks.
6674 STRLEN utf8_length(const U8* s, const U8 *e)
6677 Found in file utf8.c
6682 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
6683 Unlike C<bytes_to_utf8>, this over-writes the original string, and
6684 updates len to contain the new length.
6685 Returns zero on failure, setting C<len> to -1.
6687 If you need a copy of the string, see C<bytes_from_utf8>.
6689 NOTE: this function is experimental and may change or be
6690 removed without notice.
6692 U8* utf8_to_bytes(U8 *s, STRLEN *len)
6695 Found in file utf8.c
6700 Returns the native character value of the first character in the string C<s>
6701 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6702 length, in bytes, of that character.
6704 If C<s> does not point to a well-formed UTF-8 character, zero is
6705 returned and retlen is set, if possible, to -1.
6707 UV utf8_to_uvchr(const U8 *s, STRLEN *retlen)
6710 Found in file utf8.c
6715 Returns the Unicode code point of the first character in the string C<s>
6716 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6717 length, in bytes, of that character.
6719 This function should only be used when returned UV is considered
6720 an index into the Unicode semantic tables (e.g. swashes).
6722 If C<s> does not point to a well-formed UTF-8 character, zero is
6723 returned and retlen is set, if possible, to -1.
6725 UV utf8_to_uvuni(const U8 *s, STRLEN *retlen)
6728 Found in file utf8.c
6733 Adds the UTF-8 representation of the Native codepoint C<uv> to the end
6734 of the string C<d>; C<d> should be have at least C<UTF8_MAXBYTES+1> free
6735 bytes available. The return value is the pointer to the byte after the
6736 end of the new character. In other words,
6738 d = uvchr_to_utf8(d, uv);
6740 is the recommended wide native character-aware way of saying
6744 U8* uvchr_to_utf8(U8 *d, UV uv)
6747 Found in file utf8.c
6749 =item uvuni_to_utf8_flags
6750 X<uvuni_to_utf8_flags>
6752 Adds the UTF-8 representation of the Unicode codepoint C<uv> to the end
6753 of the string C<d>; C<d> should be have at least C<UTF8_MAXBYTES+1> free
6754 bytes available. The return value is the pointer to the byte after the
6755 end of the new character. In other words,
6757 d = uvuni_to_utf8_flags(d, uv, flags);
6761 d = uvuni_to_utf8(d, uv);
6763 (which is equivalent to)
6765 d = uvuni_to_utf8_flags(d, uv, 0);
6767 is the recommended Unicode-aware way of saying
6771 U8* uvuni_to_utf8_flags(U8 *d, UV uv, UV flags)
6774 Found in file utf8.c
6779 =head1 Variables created by C<xsubpp> and C<xsubpp> internal functions
6786 Variable which is setup by C<xsubpp> to indicate the stack base offset,
6787 used by the C<ST>, C<XSprePUSH> and C<XSRETURN> macros. The C<dMARK> macro
6788 must be called prior to setup the C<MARK> variable.
6793 Found in file XSUB.h
6798 Variable which is setup by C<xsubpp> to indicate the
6799 class name for a C++ XS constructor. This is always a C<char*>. See C<THIS>.
6804 Found in file XSUB.h
6809 Sets up the C<ax> variable.
6810 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
6815 Found in file XSUB.h
6820 Sets up the C<ax> variable and stack marker variable C<mark>.
6821 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
6826 Found in file XSUB.h
6831 Sets up the C<items> variable.
6832 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
6837 Found in file XSUB.h
6842 Sets up the C<padoff_du> variable for an XSUB that wishes to use
6848 Found in file XSUB.h
6853 Sets up stack and mark pointers for an XSUB, calling dSP and dMARK.
6854 Sets up the C<ax> and C<items> variables by calling C<dAX> and C<dITEMS>.
6855 This is usually handled automatically by C<xsubpp>.
6860 Found in file XSUB.h
6865 Sets up the C<ix> variable for an XSUB which has aliases. This is usually
6866 handled automatically by C<xsubpp>.
6871 Found in file XSUB.h
6876 Variable which is setup by C<xsubpp> to indicate the number of
6877 items on the stack. See L<perlxs/"Variable-length Parameter Lists">.
6882 Found in file XSUB.h
6887 Variable which is setup by C<xsubpp> to indicate which of an
6888 XSUB's aliases was used to invoke it. See L<perlxs/"The ALIAS: Keyword">.
6893 Found in file XSUB.h
6898 Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
6902 Found in file XSUB.h
6907 Variable which is setup by C<xsubpp> to hold the return value for an
6908 XSUB. This is always the proper type for the XSUB. See
6909 L<perlxs/"The RETVAL Variable">.
6914 Found in file XSUB.h
6919 Used to access elements on the XSUB's stack.
6924 Found in file XSUB.h
6929 Variable which is setup by C<xsubpp> to designate the object in a C++
6930 XSUB. This is always the proper type for the C++ object. See C<CLASS> and
6931 L<perlxs/"Using XS With C++">.
6936 Found in file XSUB.h
6941 The SV* corresponding to the $_ variable. Works even if there
6942 is a lexical $_ in scope.
6945 Found in file XSUB.h
6950 Macro to declare an XSUB and its C parameter list. This is handled by
6954 Found in file XSUB.h
6959 The version identifier for an XS module. This is usually
6960 handled automatically by C<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>.
6963 Found in file XSUB.h
6965 =item XS_VERSION_BOOTCHECK
6966 X<XS_VERSION_BOOTCHECK>
6968 Macro to verify that a PM module's $VERSION variable matches the XS
6969 module's C<XS_VERSION> variable. This is usually handled automatically by
6970 C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">.
6972 XS_VERSION_BOOTCHECK;
6975 Found in file XSUB.h
6980 =head1 Warning and Dieing
6987 This is the XSUB-writer's interface to Perl's C<die> function.
6988 Normally call this function the same way you call the C C<printf>
6989 function. Calling C<croak> returns control directly to Perl,
6990 sidestepping the normal C order of execution. See C<warn>.
6992 If you want to throw an exception object, assign the object to
6993 C<$@> and then pass C<NULL> to croak():
6995 errsv = get_sv("@", TRUE);
6996 sv_setsv(errsv, exception_object);
6999 void croak(const char* pat, ...)
7002 Found in file util.c
7007 This is the XSUB-writer's interface to Perl's C<warn> function. Call this
7008 function the same way you call the C C<printf> function. See C<croak>.
7010 void warn(const char* pat, ...)
7013 Found in file util.c
7020 Until May 1997, this document was maintained by Jeff Okamoto
7021 <okamoto@corp.hp.com>. It is now maintained as part of Perl itself.
7023 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
7024 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
7025 Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
7026 Stephen McCamant, and Gurusamy Sarathy.
7028 API Listing originally by Dean Roehrich <roehrich@cray.com>.
7030 Updated to be autogenerated from comments in the source by Benjamin Stuhl.
7034 perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
projects / p5sagit/p5-mst-13.2.git / blob