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)
140 Deletes the element indexed by C<key> from the array. Returns the
141 deleted element. If C<flags> equals C<G_DISCARD>, the element is freed
142 and null is returned.
144 SV* av_delete(AV* ar, I32 key, I32 flags)
152 Returns true if the element indexed by C<key> has been initialized.
154 This relies on the fact that uninitialized array elements are set to
157 bool av_exists(AV* ar, I32 key)
165 Pre-extend an array. The C<key> is the index to which the array should be
168 void av_extend(AV* ar, I32 key)
176 Returns the SV at the specified index in the array. The C<key> is the
177 index. If C<lval> is set then the fetch will be part of a store. Check
178 that the return value is non-null before dereferencing it to a C<SV*>.
180 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for
181 more information on how to use this function on tied arrays.
183 SV** av_fetch(AV* ar, I32 key, I32 lval)
191 Set the highest index in the array to the given number, equivalent to
192 Perl's C<$#array = $fill;>.
194 The number of elements in the an array will be C<fill + 1> after
195 av_fill() returns. If the array was previously shorter then the
196 additional elements appended are set to C<PL_sv_undef>. If the array
197 was longer, then the excess elements are freed. C<av_fill(av, -1)> is
198 the same as C<av_clear(av)>.
200 void av_fill(AV* ar, I32 fill)
208 Returns the highest index in the array. The number of elements in the
209 array is C<av_len(av) + 1>. Returns -1 if the array is empty.
211 I32 av_len(const AV* ar)
219 Creates a new AV and populates it with a list of SVs. The SVs are copied
220 into the array, so they may be freed after the call to av_make. The new AV
221 will have a reference count of 1.
223 AV* av_make(I32 size, SV** svp)
231 Pops an SV off the end of the array. Returns C<&PL_sv_undef> if the array
242 Pushes an SV onto the end of the array. The array will grow automatically
243 to accommodate the addition.
245 void av_push(AV* ar, SV* val)
253 Shifts an SV off the beginning of the array.
263 Stores an SV in an array. The array index is specified as C<key>. The
264 return value will be NULL if the operation failed or if the value did not
265 need to be actually stored within the array (as in the case of tied
266 arrays). Otherwise it can be dereferenced to get the original C<SV*>. Note
267 that the caller is responsible for suitably incrementing the reference
268 count of C<val> before the call, and decrementing it if the function
271 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for
272 more information on how to use this function on tied arrays.
274 SV** av_store(AV* ar, I32 key, SV* val)
282 Undefines the array. Frees the memory used by the array itself.
284 void av_undef(AV* ar)
292 Unshift the given number of C<undef> values onto the beginning of the
293 array. The array will grow automatically to accommodate the addition. You
294 must then use C<av_store> to assign values to these new elements.
296 void av_unshift(AV* ar, I32 num)
304 Returns the AV of the specified Perl array. If C<create> is set and the
305 Perl variable does not exist then it will be created. If C<create> is not
306 set and the variable does not exist then NULL is returned.
308 NOTE: the perl_ form of this function is deprecated.
310 AV* get_av(const char* name, I32 create)
318 Creates a new AV. The reference count is set to 1.
328 Sort an array. Here is an example:
330 sortsv(AvARRAY(av), av_len(av)+1, Perl_sv_cmp_locale);
332 Currently this always uses mergesort. See sortsv_flags for a more
335 void sortsv(SV** array, size_t num_elts, SVCOMPARE_t cmp)
338 Found in file pp_sort.c
343 Sort an array, with various options.
345 void sortsv_flags(SV** array, size_t num_elts, SVCOMPARE_t cmp, U32 flags)
348 Found in file pp_sort.c
353 =head1 Callback Functions
360 Performs a callback to the specified Perl sub. See L<perlcall>.
362 NOTE: the perl_ form of this function is deprecated.
364 I32 call_argv(const char* sub_name, I32 flags, char** argv)
372 Performs a callback to the specified Perl method. The blessed object must
373 be on the stack. See L<perlcall>.
375 NOTE: the perl_ form of this function is deprecated.
377 I32 call_method(const char* methname, I32 flags)
385 Performs a callback to the specified Perl sub. See L<perlcall>.
387 NOTE: the perl_ form of this function is deprecated.
389 I32 call_pv(const char* sub_name, I32 flags)
397 Performs a callback to the Perl sub whose name is in the SV. See
400 NOTE: the perl_ form of this function is deprecated.
402 I32 call_sv(SV* sv, I32 flags)
410 Opening bracket on a callback. See C<LEAVE> and L<perlcall>.
415 Found in file scope.h
420 Tells Perl to C<eval> the given string and return an SV* result.
422 NOTE: the perl_ form of this function is deprecated.
424 SV* eval_pv(const char* p, I32 croak_on_error)
432 Tells Perl to C<eval> the string in the SV.
434 NOTE: the perl_ form of this function is deprecated.
436 I32 eval_sv(SV* sv, I32 flags)
444 Closing bracket for temporaries on a callback. See C<SAVETMPS> and
450 Found in file scope.h
455 Closing bracket on a callback. See C<ENTER> and L<perlcall>.
460 Found in file scope.h
465 Opening bracket for temporaries on a callback. See C<FREETMPS> and
471 Found in file scope.h
476 =head1 Character classes
483 Returns a boolean indicating whether the C C<char> is an ASCII alphanumeric
484 character (including underscore) or digit.
486 bool isALNUM(char ch)
489 Found in file handy.h
494 Returns a boolean indicating whether the C C<char> is an ASCII alphabetic
497 bool isALPHA(char ch)
500 Found in file handy.h
505 Returns a boolean indicating whether the C C<char> is an ASCII
508 bool isDIGIT(char ch)
511 Found in file handy.h
516 Returns a boolean indicating whether the C C<char> is a lowercase
519 bool isLOWER(char ch)
522 Found in file handy.h
527 Returns a boolean indicating whether the C C<char> is whitespace.
529 bool isSPACE(char ch)
532 Found in file handy.h
537 Returns a boolean indicating whether the C C<char> is an uppercase
540 bool isUPPER(char ch)
543 Found in file handy.h
548 Converts the specified character to lowercase.
550 char toLOWER(char ch)
553 Found in file handy.h
558 Converts the specified character to uppercase.
560 char toUPPER(char ch)
563 Found in file handy.h
568 =head1 Cloning an interpreter
575 Create and return a new interpreter by cloning the current one.
577 perl_clone takes these flags as parameters:
579 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
580 without it we only clone the data and zero the stacks,
581 with it we copy the stacks and the new perl interpreter is
582 ready to run at the exact same point as the previous one.
583 The pseudo-fork code uses COPY_STACKS while the
584 threads->new doesn't.
586 CLONEf_KEEP_PTR_TABLE
587 perl_clone keeps a ptr_table with the pointer of the old
588 variable as a key and the new variable as a value,
589 this allows it to check if something has been cloned and not
590 clone it again but rather just use the value and increase the
591 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
592 the ptr_table using the function
593 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
594 reason to keep it around is if you want to dup some of your own
595 variable who are outside the graph perl scans, example of this
596 code is in threads.xs create
599 This is a win32 thing, it is ignored on unix, it tells perls
600 win32host code (which is c++) to clone itself, this is needed on
601 win32 if you want to run two threads at the same time,
602 if you just want to do some stuff in a separate perl interpreter
603 and then throw it away and return to the original one,
604 you don't need to do anything.
606 PerlInterpreter* perl_clone(PerlInterpreter* interp, UV flags)
614 =head1 CV Manipulation Functions
621 Returns the stash of the CV.
631 Uses C<strlen> to get the length of C<name>, then calls C<get_cvn_flags>.
633 NOTE: the perl_ form of this function is deprecated.
635 CV* get_cv(const char* name, I32 flags)
643 Returns the CV of the specified Perl subroutine. C<flags> are passed to
644 C<gv_fetchpvn_flags>. If C<GV_ADD> is set and the Perl subroutine does not
645 exist then it will be declared (which has the same effect as saying
646 C<sub name;>). If C<GV_ADD> is not set and the subroutine does not exist
647 then NULL is returned.
649 NOTE: the perl_ form of this function is deprecated.
651 CV* get_cvn_flags(const char* name, STRLEN len, I32 flags)
659 =head1 Embedding Functions
666 Clear out all the active components of a CV. This can happen either
667 by an explicit C<undef &foo>, or by the reference count going to zero.
668 In the former case, we keep the CvOUTSIDE pointer, so that any anonymous
669 children can still follow the full lexical scope chain.
671 void cv_undef(CV* cv)
679 Loads the module whose name is pointed to by the string part of name.
680 Note that the actual module name, not its filename, should be given.
681 Eg, "Foo::Bar" instead of "Foo/Bar.pm". flags can be any of
682 PERL_LOADMOD_DENY, PERL_LOADMOD_NOIMPORT, or PERL_LOADMOD_IMPORT_OPS
683 (or 0 for no flags). ver, if specified, provides version semantics
684 similar to C<use Foo::Bar VERSION>. The optional trailing SV*
685 arguments can be used to specify arguments to the module's import()
686 method, similar to C<use Foo::Bar VERSION LIST>.
688 void load_module(U32 flags, SV* name, SV* ver, ...)
696 Stub that provides thread hook for perl_destruct when there are
707 Allocates a new Perl interpreter. See L<perlembed>.
709 PerlInterpreter* perl_alloc()
717 Initializes a new Perl interpreter. See L<perlembed>.
719 void perl_construct(PerlInterpreter* interp)
727 Shuts down a Perl interpreter. See L<perlembed>.
729 int perl_destruct(PerlInterpreter* interp)
737 Releases a Perl interpreter. See L<perlembed>.
739 void perl_free(PerlInterpreter* interp)
747 Tells a Perl interpreter to parse a Perl script. See L<perlembed>.
749 int perl_parse(PerlInterpreter* interp, XSINIT_t xsinit, int argc, char** argv, char** env)
757 Tells a Perl interpreter to run. See L<perlembed>.
759 int perl_run(PerlInterpreter* interp)
767 Tells Perl to C<require> the file named by the string argument. It is
768 analogous to the Perl code C<eval "require '$file'">. It's even
769 implemented that way; consider using load_module instead.
771 NOTE: the perl_ form of this function is deprecated.
773 void require_pv(const char* pv)
781 =head1 Functions in file dump.c
789 char *pv_display(SV *dsv, const char *pv, STRLEN cur, STRLEN len,
790 STRLEN pvlim, U32 flags)
794 pv_escape(dsv,pv,cur,pvlim,PERL_PV_ESCAPE_QUOTE);
796 except that an additional "\0" will be appended to the string when
797 len > cur and pv[cur] is "\0".
799 Note that the final string may be up to 7 chars longer than pvlim.
801 char* pv_display(SV *dsv, const char *pv, STRLEN cur, STRLEN len, STRLEN pvlim)
809 |const STRLEN count|const STRLEN max
810 |STRLEN const *escaped, const U32 flags
812 Escapes at most the first "count" chars of pv and puts the results into
813 dsv such that the size of the escaped string will not exceed "max" chars
814 and will not contain any incomplete escape sequences.
816 If flags contains PERL_PV_ESCAPE_QUOTE then any double quotes in the string
817 will also be escaped.
819 Normally the SV will be cleared before the escaped string is prepared,
820 but when PERL_PV_ESCAPE_NOCLEAR is set this will not occur.
822 If PERL_PV_ESCAPE_UNI is set then the input string is treated as unicode,
823 if PERL_PV_ESCAPE_UNI_DETECT is set then the input string is scanned
824 using C<is_utf8_string()> to determine if it is unicode.
826 If PERL_PV_ESCAPE_ALL is set then all input chars will be output
827 using C<\x01F1> style escapes, otherwise only chars above 255 will be
828 escaped using this style, other non printable chars will use octal or
829 common escaped patterns like C<\n>. If PERL_PV_ESCAPE_NOBACKSLASH
830 then all chars below 255 will be treated as printable and
831 will be output as literals.
833 If PERL_PV_ESCAPE_FIRSTCHAR is set then only the first char of the
834 string will be escaped, regardles of max. If the string is utf8 and
835 the chars value is >255 then it will be returned as a plain hex
836 sequence. Thus the output will either be a single char,
837 an octal escape sequence, a special escape like C<\n> or a 3 or
838 more digit hex value.
840 If PERL_PV_ESCAPE_RE is set then the escape char used will be a '%' and
841 not a '\\'. This is because regexes very often contain backslashed
842 sequences, whereas '%' is not a particularly common character in patterns.
844 Returns a pointer to the escaped text as held by dsv.
846 NOTE: the perl_ form of this function is deprecated.
848 char* pv_escape(SV *dsv, char const * const str, const STRLEN count, const STRLEN max, STRLEN * const escaped, const U32 flags)
856 |const STRLEN count|const STRLEN max\
857 |const char const *start_color| const char const *end_color\
860 Converts a string into something presentable, handling escaping via
861 pv_escape() and supporting quoting and elipses.
863 If the PERL_PV_PRETTY_QUOTE flag is set then the result will be
864 double quoted with any double quotes in the string escaped. Otherwise
865 if the PERL_PV_PRETTY_LTGT flag is set then the result be wrapped in
868 If the PERL_PV_PRETTY_ELIPSES flag is set and not all characters in
869 string were output then an elipses C<...> will be appended to the
870 string. Note that this happens AFTER it has been quoted.
872 If start_color is non-null then it will be inserted after the opening
873 quote (if there is one) but before the escaped text. If end_color
874 is non-null then it will be inserted after the escaped text but before
875 any quotes or elipses.
877 Returns a pointer to the prettified text as held by dsv.
879 NOTE: the perl_ form of this function is deprecated.
881 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)
889 =head1 Functions in file mathoms.c
897 See L<gv_fetchmethod_autoload>.
899 GV* gv_fetchmethod(HV* stash, const char* name)
902 Found in file mathoms.c
907 The engine implementing pack() Perl function. Note: parameters next_in_list and
908 flags are not used. This call should not be used; use packlist instead.
910 void pack_cat(SV *cat, const char *pat, const char *patend, SV **beglist, SV **endlist, SV ***next_in_list, U32 flags)
913 Found in file mathoms.c
915 =item sv_2pvbyte_nolen
918 Return a pointer to the byte-encoded representation of the SV.
919 May cause the SV to be downgraded from UTF-8 as a side-effect.
921 Usually accessed via the C<SvPVbyte_nolen> macro.
923 char* sv_2pvbyte_nolen(SV* sv)
926 Found in file mathoms.c
928 =item sv_2pvutf8_nolen
931 Return a pointer to the UTF-8-encoded representation of the SV.
932 May cause the SV to be upgraded to UTF-8 as a side-effect.
934 Usually accessed via the C<SvPVutf8_nolen> macro.
936 char* sv_2pvutf8_nolen(SV* sv)
939 Found in file mathoms.c
944 Like C<sv_2pv()>, but doesn't return the length too. You should usually
945 use the macro wrapper C<SvPV_nolen(sv)> instead.
946 char* sv_2pv_nolen(SV* sv)
949 Found in file mathoms.c
954 Like C<sv_catpvn>, but also handles 'set' magic.
956 void sv_catpvn_mg(SV *sv, const char *ptr, STRLEN len)
959 Found in file mathoms.c
964 Like C<sv_catsv>, but also handles 'set' magic.
966 void sv_catsv_mg(SV *dstr, SV *sstr)
969 Found in file mathoms.c
971 =item sv_force_normal
974 Undo various types of fakery on an SV: if the PV is a shared string, make
975 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
976 an xpvmg. See also C<sv_force_normal_flags>.
978 void sv_force_normal(SV *sv)
981 Found in file mathoms.c
986 A private implementation of the C<SvIVx> macro for compilers which can't
987 cope with complex macro expressions. Always use the macro instead.
992 Found in file mathoms.c
997 Dummy routine which "locks" an SV when there is no locking module present.
998 Exists to avoid test for a NULL function pointer and because it could
999 potentially warn under some level of strict-ness.
1001 "Superseded" by sv_nosharing().
1003 void sv_nolocking(SV *sv)
1006 Found in file mathoms.c
1008 =item sv_nounlocking
1011 Dummy routine which "unlocks" an SV when there is no locking module present.
1012 Exists to avoid test for a NULL function pointer and because it could
1013 potentially warn under some level of strict-ness.
1015 "Superseded" by sv_nosharing().
1017 void sv_nounlocking(SV *sv)
1020 Found in file mathoms.c
1025 A private implementation of the C<SvNVx> macro for compilers which can't
1026 cope with complex macro expressions. Always use the macro instead.
1031 Found in file mathoms.c
1036 Use the C<SvPV_nolen> macro instead
1041 Found in file mathoms.c
1046 Use C<SvPVbyte_nolen> instead.
1048 char* sv_pvbyte(SV *sv)
1051 Found in file mathoms.c
1056 A private implementation of the C<SvPVbyte> macro for compilers
1057 which can't cope with complex macro expressions. Always use the macro
1060 char* sv_pvbyten(SV *sv, STRLEN *len)
1063 Found in file mathoms.c
1068 A private implementation of the C<SvPV> macro for compilers which can't
1069 cope with complex macro expressions. Always use the macro instead.
1071 char* sv_pvn(SV *sv, STRLEN *len)
1074 Found in file mathoms.c
1079 Use the C<SvPVutf8_nolen> macro instead
1081 char* sv_pvutf8(SV *sv)
1084 Found in file mathoms.c
1089 A private implementation of the C<SvPVutf8> macro for compilers
1090 which can't cope with complex macro expressions. Always use the macro
1093 char* sv_pvutf8n(SV *sv, STRLEN *len)
1096 Found in file mathoms.c
1101 Taint an SV. Use C<SvTAINTED_on> instead.
1102 void sv_taint(SV* sv)
1105 Found in file mathoms.c
1110 Unsets the RV status of the SV, and decrements the reference count of
1111 whatever was being referenced by the RV. This can almost be thought of
1112 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
1113 being zero. See C<SvROK_off>.
1115 void sv_unref(SV* sv)
1118 Found in file mathoms.c
1123 Tells an SV to use C<ptr> to find its string value. Implemented by
1124 calling C<sv_usepvn_flags> with C<flags> of 0, hence does not handle 'set'
1125 magic. See C<sv_usepvn_flags>.
1127 void sv_usepvn(SV* sv, char* ptr, STRLEN len)
1130 Found in file mathoms.c
1135 Like C<sv_usepvn>, but also handles 'set' magic.
1137 void sv_usepvn_mg(SV *sv, char *ptr, STRLEN len)
1140 Found in file mathoms.c
1145 A private implementation of the C<SvUVx> macro for compilers which can't
1146 cope with complex macro expressions. Always use the macro instead.
1151 Found in file mathoms.c
1156 The engine implementing unpack() Perl function. Note: parameters strbeg, new_s
1157 and ocnt are not used. This call should not be used, use unpackstring instead.
1159 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)
1162 Found in file mathoms.c
1167 =head1 Functions in file pp_pack.c
1175 The engine implementing pack() Perl function.
1177 void packlist(SV *cat, const char *pat, const char *patend, SV **beglist, SV **endlist)
1180 Found in file pp_pack.c
1185 The engine implementing unpack() Perl function. C<unpackstring> puts the
1186 extracted list items on the stack and returns the number of elements.
1187 Issue C<PUTBACK> before and C<SPAGAIN> after the call to this function.
1189 I32 unpackstring(const char *pat, const char *patend, const char *s, const char *strend, U32 flags)
1192 Found in file pp_pack.c
1197 =head1 Global Variables
1204 C<PL_modglobal> is a general purpose, interpreter global HV for use by
1205 extensions that need to keep information on a per-interpreter basis.
1206 In a pinch, it can also be used as a symbol table for extensions
1207 to share data among each other. It is a good idea to use keys
1208 prefixed by the package name of the extension that owns the data.
1213 Found in file intrpvar.h
1218 A convenience variable which is typically used with C<SvPV> when one
1219 doesn't care about the length of the string. It is usually more efficient
1220 to either declare a local variable and use that instead or to use the
1221 C<SvPV_nolen> macro.
1226 Found in file thrdvar.h
1231 This is the C<false> SV. See C<PL_sv_yes>. Always refer to this as
1237 Found in file intrpvar.h
1242 This is the C<undef> SV. Always refer to this as C<&PL_sv_undef>.
1247 Found in file intrpvar.h
1252 This is the C<true> SV. See C<PL_sv_no>. Always refer to this as
1258 Found in file intrpvar.h
1270 Return the SV from the GV.
1280 If C<gv> is a typeglob whose subroutine entry is a constant sub eligible for
1281 inlining, or C<gv> is a placeholder reference that would be promoted to such
1282 a typeglob, then returns the value returned by the sub. Otherwise, returns
1285 SV* gv_const_sv(GV* gv)
1293 Returns the glob with the given C<name> and a defined subroutine or
1294 C<NULL>. The glob lives in the given C<stash>, or in the stashes
1295 accessible via @ISA and UNIVERSAL::.
1297 The argument C<level> should be either 0 or -1. If C<level==0>, as a
1298 side-effect creates a glob with the given C<name> in the given C<stash>
1299 which in the case of success contains an alias for the subroutine, and sets
1300 up caching info for this glob. Similarly for all the searched stashes.
1302 This function grants C<"SUPER"> token as a postfix of the stash name. The
1303 GV returned from C<gv_fetchmeth> may be a method cache entry, which is not
1304 visible to Perl code. So when calling C<call_sv>, you should not use
1305 the GV directly; instead, you should use the method's CV, which can be
1306 obtained from the GV with the C<GvCV> macro.
1308 GV* gv_fetchmeth(HV* stash, const char* name, STRLEN len, I32 level)
1313 =item gv_fetchmethod_autoload
1314 X<gv_fetchmethod_autoload>
1316 Returns the glob which contains the subroutine to call to invoke the method
1317 on the C<stash>. In fact in the presence of autoloading this may be the
1318 glob for "AUTOLOAD". In this case the corresponding variable $AUTOLOAD is
1321 The third parameter of C<gv_fetchmethod_autoload> determines whether
1322 AUTOLOAD lookup is performed if the given method is not present: non-zero
1323 means yes, look for AUTOLOAD; zero means no, don't look for AUTOLOAD.
1324 Calling C<gv_fetchmethod> is equivalent to calling C<gv_fetchmethod_autoload>
1325 with a non-zero C<autoload> parameter.
1327 These functions grant C<"SUPER"> token as a prefix of the method name. Note
1328 that if you want to keep the returned glob for a long time, you need to
1329 check for it being "AUTOLOAD", since at the later time the call may load a
1330 different subroutine due to $AUTOLOAD changing its value. Use the glob
1331 created via a side effect to do this.
1333 These functions have the same side-effects and as C<gv_fetchmeth> with
1334 C<level==0>. C<name> should be writable if contains C<':'> or C<'
1335 ''>. The warning against passing the GV returned by C<gv_fetchmeth> to
1336 C<call_sv> apply equally to these functions.
1338 GV* gv_fetchmethod_autoload(HV* stash, const char* name, I32 autoload)
1343 =item gv_fetchmeth_autoload
1344 X<gv_fetchmeth_autoload>
1346 Same as gv_fetchmeth(), but looks for autoloaded subroutines too.
1347 Returns a glob for the subroutine.
1349 For an autoloaded subroutine without a GV, will create a GV even
1350 if C<level < 0>. For an autoloaded subroutine without a stub, GvCV()
1351 of the result may be zero.
1353 GV* gv_fetchmeth_autoload(HV* stash, const char* name, STRLEN len, I32 level)
1361 Returns a pointer to the stash for a specified package. Uses C<strlen> to
1362 determine the length of C<name, then calls C<gv_stashpvn()>.
1364 HV* gv_stashpv(const char* name, I32 flags)
1372 Returns a pointer to the stash for a specified package. The C<namelen>
1373 parameter indicates the length of the C<name>, in bytes. C<flags> is passed
1374 to C<gv_fetchpvn_flags()>, so if set to C<GV_ADD> then the package will be
1375 created if it does not already exist. If the package does not exist and
1376 C<flags> is 0 (or any other setting that does not create packages) then NULL
1380 HV* gv_stashpvn(const char* name, U32 namelen, I32 flags)
1388 Like C<gv_stashpvn>, but takes a literal string instead of a string/length pair.
1390 HV* gv_stashpvs(const char* name, I32 create)
1393 Found in file handy.h
1398 Returns a pointer to the stash for a specified package. See C<gv_stashpvn>.
1400 HV* gv_stashsv(SV* sv, I32 flags)
1423 Null character pointer.
1426 Found in file handy.h
1450 Found in file handy.h
1455 =head1 Hash Manipulation Functions
1462 Returns the HV of the specified Perl hash. If C<create> is set and the
1463 Perl variable does not exist then it will be created. If C<create> is not
1464 set and the variable does not exist then NULL is returned.
1466 NOTE: the perl_ form of this function is deprecated.
1468 HV* get_hv(const char* name, I32 create)
1471 Found in file perl.c
1476 This flag, used in the length slot of hash entries and magic structures,
1477 specifies the structure contains an C<SV*> pointer where a C<char*> pointer
1478 is to be expected. (For information only--not to be used).
1486 Returns the computed hash stored in the hash entry.
1496 Returns the actual pointer stored in the key slot of the hash entry. The
1497 pointer may be either C<char*> or C<SV*>, depending on the value of
1498 C<HeKLEN()>. Can be assigned to. The C<HePV()> or C<HeSVKEY()> macros are
1499 usually preferable for finding the value of a key.
1509 If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry
1510 holds an C<SV*> key. Otherwise, holds the actual length of the key. Can
1511 be assigned to. The C<HePV()> macro is usually preferable for finding key
1514 STRLEN HeKLEN(HE* he)
1522 Returns the key slot of the hash entry as a C<char*> value, doing any
1523 necessary dereferencing of possibly C<SV*> keys. The length of the string
1524 is placed in C<len> (this is a macro, so do I<not> use C<&len>). If you do
1525 not care about what the length of the key is, you may use the global
1526 variable C<PL_na>, though this is rather less efficient than using a local
1527 variable. Remember though, that hash keys in perl are free to contain
1528 embedded nulls, so using C<strlen()> or similar is not a good way to find
1529 the length of hash keys. This is very similar to the C<SvPV()> macro
1530 described elsewhere in this document.
1532 char* HePV(HE* he, STRLEN len)
1540 Returns the key as an C<SV*>, or C<NULL> if the hash entry does not
1541 contain an C<SV*> key.
1551 Returns the key as an C<SV*>. Will create and return a temporary mortal
1552 C<SV*> if the hash entry contains only a C<char*> key.
1554 SV* HeSVKEY_force(HE* he)
1562 Sets the key to a given C<SV*>, taking care to set the appropriate flags to
1563 indicate the presence of an C<SV*> key, and returns the same
1566 SV* HeSVKEY_set(HE* he, SV* sv)
1574 Returns the value slot (type C<SV*>) stored in the hash entry.
1584 Returns the package name of a stash, or NULL if C<stash> isn't a stash.
1585 See C<SvSTASH>, C<CvSTASH>.
1587 char* HvNAME(HV* stash)
1595 Check that a hash is in an internally consistent state.
1597 void hv_assert(HV* tb)
1605 Clears a hash, making it empty.
1607 void hv_clear(HV* tb)
1612 =item hv_clear_placeholders
1613 X<hv_clear_placeholders>
1615 Clears any placeholders from a hash. If a restricted hash has any of its keys
1616 marked as readonly and the key is subsequently deleted, the key is not actually
1617 deleted but is marked by assigning it a value of &PL_sv_placeholder. This tags
1618 it so it will be ignored by future operations such as iterating over the hash,
1619 but will still allow the hash to have a value reassigned to the key at some
1620 future point. This function clears any such placeholder keys from the hash.
1621 See Hash::Util::lock_keys() for an example of its use.
1623 void hv_clear_placeholders(HV* hb)
1631 Deletes a key/value pair in the hash. The value SV is removed from the
1632 hash and returned to the caller. The C<klen> is the length of the key.
1633 The C<flags> value will normally be zero; if set to G_DISCARD then NULL
1636 SV* hv_delete(HV* tb, const char* key, I32 klen, I32 flags)
1644 Deletes a key/value pair in the hash. The value SV is removed from the
1645 hash and returned to the caller. The C<flags> value will normally be zero;
1646 if set to G_DISCARD then NULL will be returned. C<hash> can be a valid
1647 precomputed hash value, or 0 to ask for it to be computed.
1649 SV* hv_delete_ent(HV* tb, SV* key, I32 flags, U32 hash)
1657 Returns a boolean indicating whether the specified hash key exists. The
1658 C<klen> is the length of the key.
1660 bool hv_exists(HV* tb, const char* key, I32 klen)
1668 Returns a boolean indicating whether the specified hash key exists. C<hash>
1669 can be a valid precomputed hash value, or 0 to ask for it to be
1672 bool hv_exists_ent(HV* tb, SV* key, U32 hash)
1680 Returns the SV which corresponds to the specified key in the hash. The
1681 C<klen> is the length of the key. If C<lval> is set then the fetch will be
1682 part of a store. Check that the return value is non-null before
1683 dereferencing it to an C<SV*>.
1685 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1686 information on how to use this function on tied hashes.
1688 SV** hv_fetch(HV* tb, const char* key, I32 klen, I32 lval)
1696 Like C<hv_fetch>, but takes a literal string instead of a string/length pair.
1698 SV** hv_fetchs(HV* tb, const char* key, I32 lval)
1701 Found in file handy.h
1706 Returns the hash entry which corresponds to the specified key in the hash.
1707 C<hash> must be a valid precomputed hash number for the given C<key>, or 0
1708 if you want the function to compute it. IF C<lval> is set then the fetch
1709 will be part of a store. Make sure the return value is non-null before
1710 accessing it. The return value when C<tb> is a tied hash is a pointer to a
1711 static location, so be sure to make a copy of the structure if you need to
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 HE* hv_fetch_ent(HV* tb, SV* key, I32 lval, U32 hash)
1725 Prepares a starting point to traverse a hash table. Returns the number of
1726 keys in the hash (i.e. the same as C<HvKEYS(tb)>). The return value is
1727 currently only meaningful for hashes without tie magic.
1729 NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
1730 hash buckets that happen to be in use. If you still need that esoteric
1731 value, you can get it through the macro C<HvFILL(tb)>.
1734 I32 hv_iterinit(HV* tb)
1742 Returns the key from the current position of the hash iterator. See
1745 char* hv_iterkey(HE* entry, I32* retlen)
1753 Returns the key as an C<SV*> from the current position of the hash
1754 iterator. The return value will always be a mortal copy of the key. Also
1757 SV* hv_iterkeysv(HE* entry)
1765 Returns entries from a hash iterator. See C<hv_iterinit>.
1767 You may call C<hv_delete> or C<hv_delete_ent> on the hash entry that the
1768 iterator currently points to, without losing your place or invalidating your
1769 iterator. Note that in this case the current entry is deleted from the hash
1770 with your iterator holding the last reference to it. Your iterator is flagged
1771 to free the entry on the next call to C<hv_iternext>, so you must not discard
1772 your iterator immediately else the entry will leak - call C<hv_iternext> to
1773 trigger the resource deallocation.
1775 HE* hv_iternext(HV* tb)
1783 Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
1786 SV* hv_iternextsv(HV* hv, char** key, I32* retlen)
1791 =item hv_iternext_flags
1792 X<hv_iternext_flags>
1794 Returns entries from a hash iterator. See C<hv_iterinit> and C<hv_iternext>.
1795 The C<flags> value will normally be zero; if HV_ITERNEXT_WANTPLACEHOLDERS is
1796 set the placeholders keys (for restricted hashes) will be returned in addition
1797 to normal keys. By default placeholders are automatically skipped over.
1798 Currently a placeholder is implemented with a value that is
1799 C<&Perl_sv_placeholder>. Note that the implementation of placeholders and
1800 restricted hashes may change, and the implementation currently is
1801 insufficiently abstracted for any change to be tidy.
1803 NOTE: this function is experimental and may change or be
1804 removed without notice.
1806 HE* hv_iternext_flags(HV* tb, I32 flags)
1814 Returns the value from the current position of the hash iterator. See
1817 SV* hv_iterval(HV* tb, HE* entry)
1825 Adds magic to a hash. See C<sv_magic>.
1827 void hv_magic(HV* hv, GV* gv, int how)
1835 Evaluates the hash in scalar context and returns the result. Handles magic when the hash is tied.
1837 SV* hv_scalar(HV* hv)
1845 Stores an SV in a hash. The hash key is specified as C<key> and C<klen> is
1846 the length of the key. The C<hash> parameter is the precomputed hash
1847 value; if it is zero then Perl will compute it. The return value will be
1848 NULL if the operation failed or if the value did not need to be actually
1849 stored within the hash (as in the case of tied hashes). Otherwise it can
1850 be dereferenced to get the original C<SV*>. Note that the caller is
1851 responsible for suitably incrementing the reference count of C<val> before
1852 the call, and decrementing it if the function returned NULL. Effectively
1853 a successful hv_store takes ownership of one reference to C<val>. This is
1854 usually what you want; a newly created SV has a reference count of one, so
1855 if all your code does is create SVs then store them in a hash, hv_store
1856 will own the only reference to the new SV, and your code doesn't need to do
1857 anything further to tidy up. hv_store is not implemented as a call to
1858 hv_store_ent, and does not create a temporary SV for the key, so if your
1859 key data is not already in SV form then use hv_store in preference to
1862 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1863 information on how to use this function on tied hashes.
1865 SV** hv_store(HV* tb, const char* key, I32 klen, SV* val, U32 hash)
1873 Like C<hv_store>, but takes a literal string instead of a string/length pair
1874 and omits the hash parameter.
1876 SV** hv_stores(HV* tb, const char* key, NULLOK SV* val)
1879 Found in file handy.h
1884 Stores C<val> in a hash. The hash key is specified as C<key>. The C<hash>
1885 parameter is the precomputed hash value; if it is zero then Perl will
1886 compute it. The return value is the new hash entry so created. It will be
1887 NULL if the operation failed or if the value did not need to be actually
1888 stored within the hash (as in the case of tied hashes). Otherwise the
1889 contents of the return value can be accessed using the C<He?> macros
1890 described here. Note that the caller is responsible for suitably
1891 incrementing the reference count of C<val> before the call, and
1892 decrementing it if the function returned NULL. Effectively a successful
1893 hv_store_ent takes ownership of one reference to C<val>. This is
1894 usually what you want; a newly created SV has a reference count of one, so
1895 if all your code does is create SVs then store them in a hash, hv_store
1896 will own the only reference to the new SV, and your code doesn't need to do
1897 anything further to tidy up. Note that hv_store_ent only reads the C<key>;
1898 unlike C<val> it does not take ownership of it, so maintaining the correct
1899 reference count on C<key> is entirely the caller's responsibility. hv_store
1900 is not implemented as a call to hv_store_ent, and does not create a temporary
1901 SV for the key, so if your key data is not already in SV form then use
1902 hv_store in preference to hv_store_ent.
1904 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1905 information on how to use this function on tied hashes.
1907 HE* hv_store_ent(HV* tb, SV* key, SV* val, U32 hash)
1917 void hv_undef(HV* tb)
1925 Creates a new HV. The reference count is set to 1.
1935 =head1 Magical Functions
1942 Clear something magical that the SV represents. See C<sv_magic>.
1944 int mg_clear(SV* sv)
1952 Copies the magic from one SV to another. See C<sv_magic>.
1954 int mg_copy(SV* sv, SV* nsv, const char* key, I32 klen)
1962 Finds the magic pointer for type matching the SV. See C<sv_magic>.
1964 MAGIC* mg_find(const SV* sv, int type)
1972 Free any magic storage used by the SV. See C<sv_magic>.
1982 Do magic after a value is retrieved from the SV. See C<sv_magic>.
1992 Report on the SV's length. See C<sv_magic>.
1994 U32 mg_length(SV* sv)
2002 Turns on the magical status of an SV. See C<sv_magic>.
2004 void mg_magical(SV* sv)
2012 Do magic after a value is assigned to the SV. See C<sv_magic>.
2022 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
2023 argument more than once.
2025 void SvGETMAGIC(SV* sv)
2033 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
2044 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
2045 argument more than once.
2047 void SvSETMAGIC(SV* sv)
2055 Like C<SvSetSV>, but does any set magic required afterwards.
2057 void SvSetMagicSV(SV* dsb, SV* ssv)
2062 =item SvSetMagicSV_nosteal
2063 X<SvSetMagicSV_nosteal>
2065 Like C<SvSetSV_nosteal>, but does any set magic required afterwards.
2067 void SvSetMagicSV_nosteal(SV* dsv, SV* ssv)
2075 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
2078 void SvSetSV(SV* dsb, SV* ssv)
2083 =item SvSetSV_nosteal
2086 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
2087 ssv. May evaluate arguments more than once.
2089 void SvSetSV_nosteal(SV* dsv, SV* ssv)
2097 Arranges for sv to be shared between threads if a suitable module
2100 void SvSHARE(SV* sv)
2108 Releases a mutual exclusion lock on sv if a suitable module
2111 void SvUNLOCK(SV* sv)
2119 =head1 Memory Management
2126 The XSUB-writer's interface to the C C<memcpy> function. The C<src> is the
2127 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
2128 the type. May fail on overlapping copies. See also C<Move>.
2130 void Copy(void* src, void* dest, int nitems, type)
2133 Found in file handy.h
2138 Like C<Copy> but returns dest. Useful for encouraging compilers to tail-call
2141 void * CopyD(void* src, void* dest, int nitems, type)
2144 Found in file handy.h
2149 The XSUB-writer's interface to the C C<memmove> function. The C<src> is the
2150 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
2151 the type. Can do overlapping moves. See also C<Copy>.
2153 void Move(void* src, void* dest, int nitems, type)
2156 Found in file handy.h
2161 Like C<Move> but returns dest. Useful for encouraging compilers to tail-call
2164 void * MoveD(void* src, void* dest, int nitems, type)
2167 Found in file handy.h
2172 The XSUB-writer's interface to the C C<malloc> function.
2174 In 5.9.3, Newx() and friends replace the older New() API, and drops
2175 the first parameter, I<x>, a debug aid which allowed callers to identify
2176 themselves. This aid has been superseded by a new build option,
2177 PERL_MEM_LOG (see L<perlhack/PERL_MEM_LOG>). The older API is still
2178 there for use in XS modules supporting older perls.
2180 void Newx(void* ptr, int nitems, type)
2183 Found in file handy.h
2188 The XSUB-writer's interface to the C C<malloc> function, with
2189 cast. See also C<Newx>.
2191 void Newxc(void* ptr, int nitems, type, cast)
2194 Found in file handy.h
2199 The XSUB-writer's interface to the C C<malloc> function. The allocated
2200 memory is zeroed with C<memzero>. See also C<Newx>.
2202 void Newxz(void* ptr, int nitems, type)
2205 Found in file handy.h
2210 PoisonWith(0xEF) for catching access to freed memory.
2212 void Poison(void* dest, int nitems, type)
2215 Found in file handy.h
2220 PoisonWith(0xEF) for catching access to freed memory.
2222 void PoisonFree(void* dest, int nitems, type)
2225 Found in file handy.h
2230 PoisonWith(0xAB) for catching access to allocated but uninitialized memory.
2232 void PoisonNew(void* dest, int nitems, type)
2235 Found in file handy.h
2240 Fill up memory with a byte pattern (a byte repeated over and over
2241 again) that hopefully catches attempts to access uninitialized memory.
2243 void PoisonWith(void* dest, int nitems, type, U8 byte)
2246 Found in file handy.h
2251 The XSUB-writer's interface to the C C<realloc> function.
2253 void Renew(void* ptr, int nitems, type)
2256 Found in file handy.h
2261 The XSUB-writer's interface to the C C<realloc> function, with
2264 void Renewc(void* ptr, int nitems, type, cast)
2267 Found in file handy.h
2272 The XSUB-writer's interface to the C C<free> function.
2274 void Safefree(void* ptr)
2277 Found in file handy.h
2282 Perl's version of C<strdup()>. Returns a pointer to a newly allocated
2283 string which is a duplicate of C<pv>. The size of the string is
2284 determined by C<strlen()>. The memory allocated for the new string can
2285 be freed with the C<Safefree()> function.
2287 char* savepv(const char* pv)
2290 Found in file util.c
2295 Perl's version of what C<strndup()> would be if it existed. Returns a
2296 pointer to a newly allocated string which is a duplicate of the first
2297 C<len> bytes from C<pv>, plus a trailing NUL byte. The memory allocated for
2298 the new string can be freed with the C<Safefree()> function.
2300 char* savepvn(const char* pv, I32 len)
2303 Found in file util.c
2308 Like C<savepvn>, but takes a literal string instead of a string/length pair.
2310 char* savepvs(const char* s)
2313 Found in file handy.h
2318 A version of C<savepv()> which allocates the duplicate string in memory
2319 which is shared between threads.
2321 char* savesharedpv(const char* pv)
2324 Found in file util.c
2329 A version of C<savepvn()> which allocates the duplicate string in memory
2330 which is shared between threads. (With the specific difference that a NULL
2331 pointer is not acceptable)
2333 char* savesharedpvn(const char *const pv, const STRLEN len)
2336 Found in file util.c
2341 A version of C<savepv()>/C<savepvn()> which gets the string to duplicate from
2342 the passed in SV using C<SvPV()>
2344 char* savesvpv(SV* sv)
2347 Found in file util.c
2352 This is an architecture-independent macro to copy one structure to another.
2354 void StructCopy(type src, type dest, type)
2357 Found in file handy.h
2362 The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the
2363 destination, C<nitems> is the number of items, and C<type> is the type.
2365 void Zero(void* dest, int nitems, type)
2368 Found in file handy.h
2373 Like C<Zero> but returns dest. Useful for encouraging compilers to tail-call
2376 void * ZeroD(void* dest, int nitems, type)
2379 Found in file handy.h
2384 =head1 Miscellaneous Functions
2391 Analyses the string in order to make fast searches on it using fbm_instr()
2392 -- the Boyer-Moore algorithm.
2394 void fbm_compile(SV* sv, U32 flags)
2397 Found in file util.c
2402 Returns the location of the SV in the string delimited by C<str> and
2403 C<strend>. It returns C<NULL> if the string can't be found. The C<sv>
2404 does not have to be fbm_compiled, but the search will not be as fast
2407 char* fbm_instr(unsigned char* big, unsigned char* bigend, SV* littlesv, U32 flags)
2410 Found in file util.c
2415 Takes a sprintf-style format pattern and conventional
2416 (non-SV) arguments and returns the formatted string.
2418 (char *) Perl_form(pTHX_ const char* pat, ...)
2420 can be used any place a string (char *) is required:
2422 char * s = Perl_form("%d.%d",major,minor);
2424 Uses a single private buffer so if you want to format several strings you
2425 must explicitly copy the earlier strings away (and free the copies when you
2428 char* form(const char* pat, ...)
2431 Found in file util.c
2436 Fill the sv with current working directory
2438 int getcwd_sv(SV* sv)
2441 Found in file util.c
2446 The C library C<snprintf> functionality, if available and
2447 standards-compliant (uses C<vsnprintf>, actually). However, if the
2448 C<vsnprintf> is not available, will unfortunately use the unsafe
2449 C<vsprintf> which can overrun the buffer (there is an overrun check,
2450 but that may be too late). Consider using C<sv_vcatpvf> instead, or
2451 getting C<vsnprintf>.
2453 int my_snprintf(char *buffer, const Size_t len, const char *format, ...)
2456 Found in file util.c
2461 The C library C<sprintf>, wrapped if necessary, to ensure that it will return
2462 the length of the string written to the buffer. Only rare pre-ANSI systems
2463 need the wrapper function - usually this is a direct call to C<sprintf>.
2465 int my_sprintf(char *buffer, const char *pat, ...)
2468 Found in file util.c
2473 The C library C<vsnprintf> if available and standards-compliant.
2474 However, if if the C<vsnprintf> is not available, will unfortunately
2475 use the unsafe C<vsprintf> which can overrun the buffer (there is an
2476 overrun check, but that may be too late). Consider using
2477 C<sv_vcatpvf> instead, or getting C<vsnprintf>.
2479 int my_vsnprintf(char *buffer, const Size_t len, const char *format, va_list ap)
2482 Found in file util.c
2487 Returns a new version object based on the passed in SV:
2489 SV *sv = new_version(SV *ver);
2491 Does not alter the passed in ver SV. See "upg_version" if you
2492 want to upgrade the SV.
2494 SV* new_version(SV *ver)
2497 Found in file util.c
2502 Returns a pointer to the next character after the parsed
2503 version string, as well as upgrading the passed in SV to
2506 Function must be called with an already existing SV like
2509 s = scan_version(s,SV *sv, bool qv);
2511 Performs some preprocessing to the string to ensure that
2512 it has the correct characteristics of a version. Flags the
2513 object if it contains an underscore (which denotes this
2514 is a alpha version). The boolean qv denotes that the version
2515 should be interpreted as if it had multiple decimals, even if
2518 const char* scan_version(const char *vstr, SV *sv, bool qv)
2521 Found in file util.c
2526 Test two strings to see if they are equal. Returns true or false.
2528 bool strEQ(char* s1, char* s2)
2531 Found in file handy.h
2536 Test two strings to see if the first, C<s1>, is greater than or equal to
2537 the second, C<s2>. Returns true or false.
2539 bool strGE(char* s1, char* s2)
2542 Found in file handy.h
2547 Test two strings to see if the first, C<s1>, is greater than the second,
2548 C<s2>. Returns true or false.
2550 bool strGT(char* s1, char* s2)
2553 Found in file handy.h
2558 Test two strings to see if the first, C<s1>, is less than or equal to the
2559 second, C<s2>. Returns true or false.
2561 bool strLE(char* s1, char* s2)
2564 Found in file handy.h
2569 Test two strings to see if the first, C<s1>, is less than the second,
2570 C<s2>. Returns true or false.
2572 bool strLT(char* s1, char* s2)
2575 Found in file handy.h
2580 Test two strings to see if they are different. Returns true or
2583 bool strNE(char* s1, char* s2)
2586 Found in file handy.h
2591 Test two strings to see if they are equal. The C<len> parameter indicates
2592 the number of bytes to compare. Returns true or false. (A wrapper for
2595 bool strnEQ(char* s1, char* s2, STRLEN len)
2598 Found in file handy.h
2603 Test two strings to see if they are different. The C<len> parameter
2604 indicates the number of bytes to compare. Returns true or false. (A
2605 wrapper for C<strncmp>).
2607 bool strnNE(char* s1, char* s2, STRLEN len)
2610 Found in file handy.h
2615 Dummy routine which "shares" an SV when there is no sharing module present.
2616 Or "locks" it. Or "unlocks" it. In other words, ignores its single SV argument.
2617 Exists to avoid test for a NULL function pointer and because it could
2618 potentially warn under some level of strict-ness.
2620 void sv_nosharing(SV *sv)
2623 Found in file util.c
2628 In-place upgrade of the supplied SV to a version object.
2630 SV *sv = upg_version(SV *sv);
2632 Returns a pointer to the upgraded SV.
2634 SV* upg_version(SV *ver)
2637 Found in file util.c
2642 Version object aware cmp. Both operands must already have been
2643 converted into version objects.
2645 int vcmp(SV *lvs, SV *rvs)
2648 Found in file util.c
2653 Accepts a version object and returns the normalized string
2654 representation. Call like:
2658 NOTE: you can pass either the object directly or the SV
2659 contained within the RV.
2664 Found in file util.c
2669 Accepts a version object and returns the normalized floating
2670 point representation. Call like:
2674 NOTE: you can pass either the object directly or the SV
2675 contained within the RV.
2680 Found in file util.c
2685 In order to maintain maximum compatibility with earlier versions
2686 of Perl, this function will return either the floating point
2687 notation or the multiple dotted notation, depending on whether
2688 the original version contained 1 or more dots, respectively
2690 SV* vstringify(SV *vs)
2693 Found in file util.c
2698 Validates that the SV contains a valid version object.
2700 bool vverify(SV *vobj);
2702 Note that it only confirms the bare minimum structure (so as not to get
2703 confused by derived classes which may contain additional hash entries):
2705 bool vverify(SV *vs)
2708 Found in file util.c
2713 =head1 Multicall Functions
2720 Declare local variables for a multicall. See L<perlcall/Lightweight Callbacks>.
2730 Make a lightweight callback. See L<perlcall/Lightweight Callbacks>.
2740 Closing bracket for a lightweight callback.
2741 See L<perlcall/Lightweight Callbacks>.
2748 =item PUSH_MULTICALL
2751 Opening bracket for a lightweight callback.
2752 See L<perlcall/Lightweight Callbacks>.
2762 =head1 Numeric functions
2769 converts a string representing a binary number to numeric form.
2771 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2772 conversion flags, and I<result> should be NULL or a pointer to an NV.
2773 The scan stops at the end of the string, or the first invalid character.
2774 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2775 invalid character will also trigger a warning.
2776 On return I<*len> is set to the length of the scanned string,
2777 and I<*flags> gives output flags.
2779 If the value is <= C<UV_MAX> it is returned as a UV, the output flags are clear,
2780 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_bin>
2781 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2782 and writes the value to I<*result> (or the value is discarded if I<result>
2785 The binary number may optionally be prefixed with "0b" or "b" unless
2786 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
2787 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the binary
2788 number may use '_' characters to separate digits.
2790 UV grok_bin(const char* start, STRLEN* len_p, I32* flags, NV *result)
2793 Found in file numeric.c
2798 converts a string representing a hex 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 <= 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_hex>
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 hex number may optionally be prefixed with "0x" or "x" 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 hex
2817 number may use '_' characters to separate digits.
2819 UV grok_hex(const char* start, STRLEN* len_p, I32* flags, NV *result)
2822 Found in file numeric.c
2827 Recognise (or not) a number. The type of the number is returned
2828 (0 if unrecognised), otherwise it is a bit-ORed combination of
2829 IS_NUMBER_IN_UV, IS_NUMBER_GREATER_THAN_UV_MAX, IS_NUMBER_NOT_INT,
2830 IS_NUMBER_NEG, IS_NUMBER_INFINITY, IS_NUMBER_NAN (defined in perl.h).
2832 If the value of the number can fit an in UV, it is returned in the *valuep
2833 IS_NUMBER_IN_UV will be set to indicate that *valuep is valid, IS_NUMBER_IN_UV
2834 will never be set unless *valuep is valid, but *valuep may have been assigned
2835 to during processing even though IS_NUMBER_IN_UV is not set on return.
2836 If valuep is NULL, IS_NUMBER_IN_UV will be set for the same cases as when
2837 valuep is non-NULL, but no actual assignment (or SEGV) will occur.
2839 IS_NUMBER_NOT_INT will be set with IS_NUMBER_IN_UV if trailing decimals were
2840 seen (in which case *valuep gives the true value truncated to an integer), and
2841 IS_NUMBER_NEG if the number is negative (in which case *valuep holds the
2842 absolute value). IS_NUMBER_IN_UV is not set if e notation was used or the
2843 number is larger than a UV.
2845 int grok_number(const char *pv, STRLEN len, UV *valuep)
2848 Found in file numeric.c
2850 =item grok_numeric_radix
2851 X<grok_numeric_radix>
2853 Scan and skip for a numeric decimal separator (radix).
2855 bool grok_numeric_radix(const char **sp, const char *send)
2858 Found in file numeric.c
2863 converts a string representing an octal number to numeric form.
2865 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2866 conversion flags, and I<result> should be NULL or a pointer to an NV.
2867 The scan stops at the end of the string, or the first invalid character.
2868 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2869 invalid character will also trigger a warning.
2870 On return I<*len> is set to the length of the scanned string,
2871 and I<*flags> gives output flags.
2873 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2874 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_oct>
2875 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2876 and writes the value to I<*result> (or the value is discarded if I<result>
2879 If C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the octal
2880 number may use '_' characters to separate digits.
2882 UV grok_oct(const char* start, STRLEN* len_p, I32* flags, NV *result)
2885 Found in file numeric.c
2890 For backwards compatibility. Use C<grok_bin> instead.
2892 NV scan_bin(const char* start, STRLEN len, STRLEN* retlen)
2895 Found in file numeric.c
2900 For backwards compatibility. Use C<grok_hex> instead.
2902 NV scan_hex(const char* start, STRLEN len, STRLEN* retlen)
2905 Found in file numeric.c
2910 For backwards compatibility. Use C<grok_oct> instead.
2912 NV scan_oct(const char* start, STRLEN len, STRLEN* retlen)
2915 Found in file numeric.c
2920 =head1 Optree Manipulation Functions
2927 If C<cv> is a constant sub eligible for inlining. returns the constant
2928 value returned by the sub. Otherwise, returns NULL.
2930 Constant subs can be created with C<newCONSTSUB> or as described in
2931 L<perlsub/"Constant Functions">.
2933 SV* cv_const_sv(CV* cv)
2941 Creates a constant sub equivalent to Perl C<sub FOO () { 123 }> which is
2942 eligible for inlining at compile-time.
2944 CV* newCONSTSUB(HV* stash, const char* name, SV* sv)
2952 Used by C<xsubpp> to hook up XSUBs as Perl subs. I<filename> needs to be
2953 static storage, as it is used directly as CvFILE(), without a copy being made.
2961 =head1 Pad Data Structures
2968 Get the value at offset po in the current pad.
2969 Use macro PAD_SV instead of calling this function directly.
2971 SV* pad_sv(PADOFFSET po)
2979 =head1 Simple Exception Handling Macros
2986 Set up necessary local variables for exception handling.
2987 See L<perlguts/"Exception Handling">.
2992 Found in file XSUB.h
2997 Introduces a catch block. See L<perlguts/"Exception Handling">.
3000 Found in file XSUB.h
3005 Rethrows a previously caught exception. See L<perlguts/"Exception Handling">.
3010 Found in file XSUB.h
3015 Ends a try block. See L<perlguts/"Exception Handling">.
3018 Found in file XSUB.h
3020 =item XCPT_TRY_START
3023 Starts a try block. See L<perlguts/"Exception Handling">.
3026 Found in file XSUB.h
3031 =head1 Stack Manipulation Macros
3038 Declare a stack marker variable, C<mark>, for the XSUB. See C<MARK> and
3049 Saves the original stack mark for the XSUB. See C<ORIGMARK>.
3059 Declares a local copy of perl's stack pointer for the XSUB, available via
3060 the C<SP> macro. See C<SP>.
3070 Used to extend the argument stack for an XSUB's return values. Once
3071 used, guarantees that there is room for at least C<nitems> to be pushed
3074 void EXTEND(SP, int nitems)
3082 Stack marker variable for the XSUB. See C<dMARK>.
3090 Push an integer onto the stack. The stack must have room for this element.
3091 Handles 'set' magic. Does not use C<TARG>. See also C<PUSHi>, C<mXPUSHi>
3102 Push a double onto the stack. The stack must have room for this element.
3103 Handles 'set' magic. Does not use C<TARG>. See also C<PUSHn>, C<mXPUSHn>
3114 Push a string onto the stack. The stack must have room for this element.
3115 The C<len> indicates the length of the string. Handles 'set' magic. Does
3116 not use C<TARG>. See also C<PUSHp>, C<mXPUSHp> and C<XPUSHp>.
3118 void mPUSHp(char* str, STRLEN len)
3126 Push an unsigned integer onto the stack. The stack must have room for this
3127 element. Handles 'set' magic. Does not use C<TARG>. See also C<PUSHu>,
3128 C<mXPUSHu> and C<XPUSHu>.
3138 Push an integer onto the stack, extending the stack if necessary. Handles
3139 'set' magic. Does not use C<TARG>. See also C<XPUSHi>, C<mPUSHi> and
3150 Push a double onto the stack, extending the stack if necessary. Handles
3151 'set' magic. Does not use C<TARG>. See also C<XPUSHn>, C<mPUSHn> and
3162 Push a string onto the stack, extending the stack if necessary. The C<len>
3163 indicates the length of the string. Handles 'set' magic. Does not use
3164 C<TARG>. See also C<XPUSHp>, C<mPUSHp> and C<PUSHp>.
3166 void mXPUSHp(char* str, STRLEN len)
3174 Push an unsigned integer onto the stack, extending the stack if necessary.
3175 Handles 'set' magic. Does not use C<TARG>. See also C<XPUSHu>, C<mPUSHu>
3186 The original stack mark for the XSUB. See C<dORIGMARK>.
3194 Pops an integer off the stack.
3204 Pops a long off the stack.
3214 Pops a double off the stack.
3224 Pops a string off the stack. Deprecated. New code should use POPpx.
3234 Pops a string off the stack which must consist of bytes i.e. characters < 256.
3244 Pops a string off the stack.
3254 Pops an SV off the stack.
3264 Push an integer onto the stack. The stack must have room for this element.
3265 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3266 called to declare it. Do not call multiple C<TARG>-oriented macros to
3267 return lists from XSUB's - see C<mPUSHi> instead. See also C<XPUSHi> and
3278 Opening bracket for arguments on a callback. See C<PUTBACK> and
3289 Push a new mortal SV onto the stack. The stack must have room for this
3290 element. Does not handle 'set' magic. Does not use C<TARG>. See also
3291 C<PUSHs>, C<XPUSHmortal> and C<XPUSHs>.
3301 Push a double onto the stack. The stack must have room for this element.
3302 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3303 called to declare it. Do not call multiple C<TARG>-oriented macros to
3304 return lists from XSUB's - see C<mPUSHn> instead. See also C<XPUSHn> and
3315 Push a string onto the stack. The stack must have room for this element.
3316 The C<len> indicates the length of the string. Handles 'set' magic. Uses
3317 C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to declare it. Do not
3318 call multiple C<TARG>-oriented macros to return lists from XSUB's - see
3319 C<mPUSHp> instead. See also C<XPUSHp> and C<mXPUSHp>.
3321 void PUSHp(char* str, STRLEN len)
3329 Push an SV onto the stack. The stack must have room for this element.
3330 Does not handle 'set' magic. Does not use C<TARG>. See also C<PUSHmortal>,
3331 C<XPUSHs> and C<XPUSHmortal>.
3341 Push an unsigned integer onto the stack. The stack must have room for this
3342 element. Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG>
3343 should be called to declare it. Do not call multiple C<TARG>-oriented
3344 macros to return lists from XSUB's - see C<mPUSHu> instead. See also
3345 C<XPUSHu> and C<mXPUSHu>.
3355 Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
3356 See C<PUSHMARK> and L<perlcall> for other uses.
3366 Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and
3375 Refetch the stack pointer. Used after a callback. See L<perlcall>.
3385 Push an integer onto the stack, extending the stack if necessary. Handles
3386 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
3387 declare it. Do not call multiple C<TARG>-oriented macros to return lists
3388 from XSUB's - see C<mXPUSHi> instead. See also C<PUSHi> and C<mPUSHi>.
3398 Push a new mortal SV onto the stack, extending the stack if necessary. Does
3399 not handle 'set' magic. Does not use C<TARG>. See also C<XPUSHs>,
3400 C<PUSHmortal> and C<PUSHs>.
3410 Push a double onto the stack, extending the stack if necessary. Handles
3411 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
3412 declare it. Do not call multiple C<TARG>-oriented macros to return lists
3413 from XSUB's - see C<mXPUSHn> instead. See also C<PUSHn> and C<mPUSHn>.
3423 Push a string onto the stack, extending the stack if necessary. The C<len>
3424 indicates the length of the string. Handles 'set' magic. Uses C<TARG>, so
3425 C<dTARGET> or C<dXSTARG> should be called to declare it. Do not call
3426 multiple C<TARG>-oriented macros to return lists from XSUB's - see
3427 C<mXPUSHp> instead. See also C<PUSHp> and C<mPUSHp>.
3429 void XPUSHp(char* str, STRLEN len)
3437 Push an SV onto the stack, extending the stack if necessary. Does not
3438 handle 'set' magic. Does not use C<TARG>. See also C<XPUSHmortal>,
3439 C<PUSHs> and C<PUSHmortal>.
3449 Push an unsigned integer onto the stack, extending the stack if necessary.
3450 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3451 called to declare it. Do not call multiple C<TARG>-oriented macros to
3452 return lists from XSUB's - see C<mXPUSHu> instead. See also C<PUSHu> and
3463 Return from XSUB, indicating number of items on the stack. This is usually
3464 handled by C<xsubpp>.
3466 void XSRETURN(int nitems)
3469 Found in file XSUB.h
3471 =item XSRETURN_EMPTY
3474 Return an empty list from an XSUB immediately.
3479 Found in file XSUB.h
3484 Return an integer from an XSUB immediately. Uses C<XST_mIV>.
3486 void XSRETURN_IV(IV iv)
3489 Found in file XSUB.h
3494 Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
3499 Found in file XSUB.h
3504 Return a double from an XSUB immediately. Uses C<XST_mNV>.
3506 void XSRETURN_NV(NV nv)
3509 Found in file XSUB.h
3514 Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
3516 void XSRETURN_PV(char* str)
3519 Found in file XSUB.h
3521 =item XSRETURN_UNDEF
3524 Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
3529 Found in file XSUB.h
3534 Return an integer from an XSUB immediately. Uses C<XST_mUV>.
3536 void XSRETURN_UV(IV uv)
3539 Found in file XSUB.h
3544 Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
3549 Found in file XSUB.h
3554 Place an integer into the specified position C<pos> on the stack. The
3555 value is stored in a new mortal SV.
3557 void XST_mIV(int pos, IV iv)
3560 Found in file XSUB.h
3565 Place C<&PL_sv_no> into the specified position C<pos> on the
3568 void XST_mNO(int pos)
3571 Found in file XSUB.h
3576 Place a double into the specified position C<pos> on the stack. The value
3577 is stored in a new mortal SV.
3579 void XST_mNV(int pos, NV nv)
3582 Found in file XSUB.h
3587 Place a copy of a string into the specified position C<pos> on the stack.
3588 The value is stored in a new mortal SV.
3590 void XST_mPV(int pos, char* str)
3593 Found in file XSUB.h
3598 Place C<&PL_sv_undef> into the specified position C<pos> on the
3601 void XST_mUNDEF(int pos)
3604 Found in file XSUB.h
3609 Place C<&PL_sv_yes> into the specified position C<pos> on the
3612 void XST_mYES(int pos)
3615 Found in file XSUB.h
3627 An enum of flags for Perl types. These are found in the file B<sv.h>
3628 in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
3636 Integer type flag for scalars. See C<svtype>.
3644 Double type flag for scalars. See C<svtype>.
3652 Pointer type flag for scalars. See C<svtype>.
3660 Type flag for arrays. See C<svtype>.
3668 Type flag for code refs. See C<svtype>.
3676 Type flag for hashes. See C<svtype>.
3684 Type flag for blessed scalars. See C<svtype>.
3692 =head1 SV Manipulation Functions
3699 Returns the SV of the specified Perl scalar. If C<create> is set and the
3700 Perl variable does not exist then it will be created. If C<create> is not
3701 set and the variable does not exist then NULL is returned.
3703 NOTE: the perl_ form of this function is deprecated.
3705 SV* get_sv(const char* name, I32 create)
3708 Found in file perl.c
3713 Creates an RV wrapper for an SV. The reference count for the original SV is
3716 SV* newRV_inc(SV* sv)
3724 Returns the length of the string which is in the SV. See C<SvLEN>.
3726 STRLEN SvCUR(SV* sv)
3734 Set the current length of the string which is in the SV. See C<SvCUR>
3737 void SvCUR_set(SV* sv, STRLEN len)
3745 Returns a pointer to the last character in the string which is in the SV.
3746 See C<SvCUR>. Access the character as *(SvEND(sv)).
3756 Returns true if the SV has get magic or overloading. If either is true then
3757 the scalar is active data, and has the potential to return a new value every
3758 time it is accessed. Hence you must be careful to only read it once per user
3759 logical operation and work with that returned value. If neither is true then
3760 the scalar's value cannot change unless written to.
3762 char* SvGAMAGIC(SV* sv)
3770 Expands the character buffer in the SV so that it has room for the
3771 indicated number of bytes (remember to reserve space for an extra trailing
3772 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
3773 Returns a pointer to the character buffer.
3775 char * SvGROW(SV* sv, STRLEN len)
3783 Returns a U32 value indicating whether the SV contains an integer.
3793 Returns a U32 value indicating whether the SV contains an integer. Checks
3794 the B<private> setting. Use C<SvIOK>.
3804 Returns a boolean indicating whether the SV contains a signed integer.
3806 bool SvIOK_notUV(SV* sv)
3814 Unsets the IV status of an SV.
3816 void SvIOK_off(SV* sv)
3824 Tells an SV that it is an integer.
3826 void SvIOK_on(SV* sv)
3834 Tells an SV that it is an integer and disables all other OK bits.
3836 void SvIOK_only(SV* sv)
3844 Tells and SV that it is an unsigned integer and disables all other OK bits.
3846 void SvIOK_only_UV(SV* sv)
3854 Returns a boolean indicating whether the SV contains an unsigned integer.
3856 bool SvIOK_UV(SV* sv)
3864 Returns a boolean indicating whether the SV is Copy-On-Write. (either shared
3865 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
3868 bool SvIsCOW(SV* sv)
3873 =item SvIsCOW_shared_hash
3874 X<SvIsCOW_shared_hash>
3876 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
3879 bool SvIsCOW_shared_hash(SV* sv)
3887 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
3888 version which guarantees to evaluate sv only once.
3898 Returns the raw value in the SV's IV slot, without checks or conversions.
3899 Only use when you are sure SvIOK is true. See also C<SvIV()>.
3909 Coerces the given SV to an integer and returns it. Guarantees to evaluate
3910 sv only once. Use the more efficient C<SvIV> otherwise.
3920 Like C<SvIV> but doesn't process magic.
3922 IV SvIV_nomg(SV* sv)
3930 Set the value of the IV pointer in sv to val. It is possible to perform
3931 the same function of this macro with an lvalue assignment to C<SvIVX>.
3932 With future Perls, however, it will be more efficient to use
3933 C<SvIV_set> instead of the lvalue assignment to C<SvIVX>.
3935 void SvIV_set(SV* sv, IV val)
3943 Returns the size of the string buffer in the SV, not including any part
3944 attributable to C<SvOOK>. See C<SvCUR>.
3946 STRLEN SvLEN(SV* sv)
3954 Set the actual length of the string which is in the SV. See C<SvIV_set>.
3956 void SvLEN_set(SV* sv, STRLEN len)
3964 Set the value of the MAGIC pointer in sv to val. See C<SvIV_set>.
3966 void SvMAGIC_set(SV* sv, MAGIC* val)
3974 Returns a U32 value indicating whether the SV contains a number, integer or
3985 Returns a U32 value indicating whether the SV contains a number, integer or
3986 double. Checks the B<private> setting. Use C<SvNIOK>.
3996 Unsets the NV/IV status of an SV.
3998 void SvNIOK_off(SV* sv)
4006 Returns a U32 value indicating whether the SV contains a double.
4016 Returns a U32 value indicating whether the SV contains a double. Checks the
4017 B<private> setting. Use C<SvNOK>.
4027 Unsets the NV status of an SV.
4029 void SvNOK_off(SV* sv)
4037 Tells an SV that it is a double.
4039 void SvNOK_on(SV* sv)
4047 Tells an SV that it is a double and disables all other OK bits.
4049 void SvNOK_only(SV* sv)
4057 Coerce the given SV to a double and return it. See C<SvNVx> for a version
4058 which guarantees to evaluate sv only once.
4068 Returns the raw value in the SV's NV slot, without checks or conversions.
4069 Only use when you are sure SvNOK is true. See also C<SvNV()>.
4079 Coerces the given SV to a double and returns it. Guarantees to evaluate
4080 sv only once. Use the more efficient C<SvNV> otherwise.
4090 Set the value of the NV pointer in sv to val. See C<SvIV_set>.
4092 void SvNV_set(SV* sv, NV val)
4100 Returns a U32 value indicating whether the value is an SV. It also tells
4101 whether the value is defined or not.
4111 Returns a U32 indicating whether the SvIVX is a valid offset value for
4112 the SvPVX. This hack is used internally to speed up removal of characters
4113 from the beginning of a SvPV. When SvOOK is true, then the start of the
4114 allocated string buffer is really (SvPVX - SvIVX).
4124 Returns a U32 value indicating whether the SV contains a character
4135 Returns a U32 value indicating whether the SV contains a character string.
4136 Checks the B<private> setting. Use C<SvPOK>.
4146 Unsets the PV status of an SV.
4148 void SvPOK_off(SV* sv)
4156 Tells an SV that it is a string.
4158 void SvPOK_on(SV* sv)
4166 Tells an SV that it is a string and disables all other OK bits.
4167 Will also turn off the UTF-8 status.
4169 void SvPOK_only(SV* sv)
4174 =item SvPOK_only_UTF8
4177 Tells an SV that it is a string and disables all other OK bits,
4178 and leaves the UTF-8 status as it was.
4180 void SvPOK_only_UTF8(SV* sv)
4188 Returns a pointer to the string in the SV, or a stringified form of
4189 the SV if the SV does not contain a string. The SV may cache the
4190 stringified version becoming C<SvPOK>. Handles 'get' magic. See also
4191 C<SvPVx> for a version which guarantees to evaluate sv only once.
4193 char* SvPV(SV* sv, STRLEN len)
4201 Like C<SvPV>, but converts sv to byte representation first if necessary.
4203 char* SvPVbyte(SV* sv, STRLEN len)
4211 Like C<SvPV>, but converts sv to byte representation first if necessary.
4212 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
4215 char* SvPVbytex(SV* sv, STRLEN len)
4220 =item SvPVbytex_force
4223 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
4224 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
4227 char* SvPVbytex_force(SV* sv, STRLEN len)
4232 =item SvPVbyte_force
4235 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
4237 char* SvPVbyte_force(SV* sv, STRLEN len)
4242 =item SvPVbyte_nolen
4245 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
4247 char* SvPVbyte_nolen(SV* sv)
4255 Like C<SvPV>, but converts sv to utf8 first if necessary.
4257 char* SvPVutf8(SV* sv, STRLEN len)
4265 Like C<SvPV>, but converts sv to utf8 first if necessary.
4266 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
4269 char* SvPVutf8x(SV* sv, STRLEN len)
4274 =item SvPVutf8x_force
4277 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
4278 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
4281 char* SvPVutf8x_force(SV* sv, STRLEN len)
4286 =item SvPVutf8_force
4289 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
4291 char* SvPVutf8_force(SV* sv, STRLEN len)
4296 =item SvPVutf8_nolen
4299 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
4301 char* SvPVutf8_nolen(SV* sv)
4309 Returns a pointer to the physical string in the SV. The SV must contain a
4320 A version of C<SvPV> which guarantees to evaluate sv only once.
4322 char* SvPVx(SV* sv, STRLEN len)
4330 Like C<SvPV> but will force the SV into containing just a string
4331 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
4334 char* SvPV_force(SV* sv, STRLEN len)
4339 =item SvPV_force_nomg
4342 Like C<SvPV> but will force the SV into containing just a string
4343 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
4344 directly. Doesn't process magic.
4346 char* SvPV_force_nomg(SV* sv, STRLEN len)
4354 Returns a pointer to the string in the SV, or a stringified form of
4355 the SV if the SV does not contain a string. The SV may cache the
4356 stringified form becoming C<SvPOK>. Handles 'get' magic.
4358 char* SvPV_nolen(SV* sv)
4366 Like C<SvPV> but doesn't process magic.
4368 char* SvPV_nomg(SV* sv, STRLEN len)
4376 Set the value of the PV pointer in sv to val. See C<SvIV_set>.
4378 void SvPV_set(SV* sv, char* val)
4386 Returns the value of the object's reference count.
4388 U32 SvREFCNT(SV* sv)
4396 Decrements the reference count of the given SV.
4398 void SvREFCNT_dec(SV* sv)
4406 Increments the reference count of the given SV.
4408 All of the following SvREFCNT_inc* macros are optimized versions of
4409 SvREFCNT_inc, and can be replaced with SvREFCNT_inc.
4411 SV* SvREFCNT_inc(SV* sv)
4416 =item SvREFCNT_inc_NN
4419 Same as SvREFCNT_inc, but can only be used if you know I<sv>
4420 is not NULL. Since we don't have to check the NULLness, it's faster
4423 SV* SvREFCNT_inc_NN(SV* sv)
4428 =item SvREFCNT_inc_simple
4429 X<SvREFCNT_inc_simple>
4431 Same as SvREFCNT_inc, but can only be used with simple variables, not
4432 expressions or pointer dereferences. Since we don't have to store a
4433 temporary value, it's faster.
4435 SV* SvREFCNT_inc_simple(SV* sv)
4440 =item SvREFCNT_inc_simple_NN
4441 X<SvREFCNT_inc_simple_NN>
4443 Same as SvREFCNT_inc_simple, but can only be used if you know I<sv>
4444 is not NULL. Since we don't have to check the NULLness, it's faster
4447 SV* SvREFCNT_inc_simple_NN(SV* sv)
4452 =item SvREFCNT_inc_simple_void
4453 X<SvREFCNT_inc_simple_void>
4455 Same as SvREFCNT_inc_simple, but can only be used if you don't need the
4456 return value. The macro doesn't need to return a meaningful value.
4458 void SvREFCNT_inc_simple_void(SV* sv)
4463 =item SvREFCNT_inc_simple_void_NN
4464 X<SvREFCNT_inc_simple_void_NN>
4466 Same as SvREFCNT_inc, but can only be used if you don't need the return
4467 value, and you know that I<sv> is not NULL. The macro doesn't need
4468 to return a meaningful value, or check for NULLness, so it's smaller
4471 void SvREFCNT_inc_simple_void_NN(SV* sv)
4476 =item SvREFCNT_inc_void
4477 X<SvREFCNT_inc_void>
4479 Same as SvREFCNT_inc, but can only be used if you don't need the
4480 return value. The macro doesn't need to return a meaningful value.
4482 void SvREFCNT_inc_void(SV* sv)
4487 =item SvREFCNT_inc_void_NN
4488 X<SvREFCNT_inc_void_NN>
4490 Same as SvREFCNT_inc, but can only be used if you don't need the return
4491 value, and you know that I<sv> is not NULL. The macro doesn't need
4492 to return a meaningful value, or check for NULLness, so it's smaller
4495 void SvREFCNT_inc_void_NN(SV* sv)
4503 Tests if the SV is an RV.
4513 Unsets the RV status of an SV.
4515 void SvROK_off(SV* sv)
4523 Tells an SV that it is an RV.
4525 void SvROK_on(SV* sv)
4533 Dereferences an RV to return the SV.
4543 Set the value of the RV pointer in sv to val. See C<SvIV_set>.
4545 void SvRV_set(SV* sv, SV* val)
4553 Returns the stash of the SV.
4563 Set the value of the STASH pointer in sv to val. See C<SvIV_set>.
4565 void SvSTASH_set(SV* sv, HV* val)
4573 Taints an SV if tainting is enabled.
4575 void SvTAINT(SV* sv)
4583 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
4586 bool SvTAINTED(SV* sv)
4594 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
4595 some of Perl's fundamental security features. XS module authors should not
4596 use this function unless they fully understand all the implications of
4597 unconditionally untainting the value. Untainting should be done in the
4598 standard perl fashion, via a carefully crafted regexp, rather than directly
4599 untainting variables.
4601 void SvTAINTED_off(SV* sv)
4609 Marks an SV as tainted if tainting is enabled.
4611 void SvTAINTED_on(SV* sv)
4619 Returns a boolean indicating whether Perl would evaluate the SV as true or
4620 false, defined or undefined. Does not handle 'get' magic.
4630 Returns the type of the SV. See C<svtype>.
4632 svtype SvTYPE(SV* sv)
4640 Returns a boolean indicating whether the SV contains an unsigned integer.
4650 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
4651 perform the upgrade if necessary. See C<svtype>.
4653 void SvUPGRADE(SV* sv, svtype type)
4661 Returns a U32 value indicating whether the SV contains UTF-8 encoded data.
4662 Call this after SvPV() in case any call to string overloading updates the
4673 Unsets the UTF-8 status of an SV.
4675 void SvUTF8_off(SV *sv)
4683 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
4684 Do not use frivolously.
4686 void SvUTF8_on(SV *sv)
4694 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
4695 for a version which guarantees to evaluate sv only once.
4705 Returns the raw value in the SV's UV slot, without checks or conversions.
4706 Only use when you are sure SvIOK is true. See also C<SvUV()>.
4716 Coerces the given SV to an unsigned integer and returns it. Guarantees to
4717 evaluate sv only once. Use the more efficient C<SvUV> otherwise.
4727 Like C<SvUV> but doesn't process magic.
4729 UV SvUV_nomg(SV* sv)
4737 Set the value of the UV pointer in sv to val. See C<SvIV_set>.
4739 void SvUV_set(SV* sv, UV val)
4747 Returns a boolean indicating whether the SV contains a v-string.
4754 =item sv_catpvn_nomg
4757 Like C<sv_catpvn> but doesn't process magic.
4759 void sv_catpvn_nomg(SV* sv, const char* ptr, STRLEN len)
4767 Like C<sv_catsv> but doesn't process magic.
4769 void sv_catsv_nomg(SV* dsv, SV* ssv)
4774 =item sv_derived_from
4777 Returns a boolean indicating whether the SV is derived from the specified class
4778 I<at the C level>. To check derivation at the Perl level, call C<isa()> as a
4781 bool sv_derived_from(SV* sv, const char* name)
4784 Found in file universal.c
4789 Returns a boolean indicating whether the SV performs a specific, named role.
4790 The SV can be a Perl object or the name of a Perl class.
4792 bool sv_does(SV* sv, const char* name)
4795 Found in file universal.c
4797 =item sv_report_used
4800 Dump the contents of all SVs not yet freed. (Debugging aid).
4802 void sv_report_used()
4810 Like C<sv_setsv> but doesn't process magic.
4812 void sv_setsv_nomg(SV* dsv, SV* ssv)
4820 =head1 SV-Body Allocation
4824 =item looks_like_number
4825 X<looks_like_number>
4827 Test if the content of an SV looks like a number (or is a number).
4828 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
4829 non-numeric warning), even if your atof() doesn't grok them.
4831 I32 looks_like_number(SV* sv)
4839 Creates an RV wrapper for an SV. The reference count for the original
4840 SV is B<not> incremented.
4842 SV* newRV_noinc(SV* sv)
4850 Creates a new SV. A non-zero C<len> parameter indicates the number of
4851 bytes of preallocated string space the SV should have. An extra byte for a
4852 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4853 space is allocated.) The reference count for the new SV is set to 1.
4855 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4856 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4857 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4858 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4859 modules supporting older perls.
4861 SV* newSV(STRLEN len)
4869 Creates a new SV from the hash key structure. It will generate scalars that
4870 point to the shared string table where possible. Returns a new (undefined)
4871 SV if the hek is NULL.
4873 SV* newSVhek(const HEK *hek)
4881 Creates a new SV and copies an integer into it. The reference count for the
4892 Creates a new SV and copies a floating point value into it.
4893 The reference count for the SV is set to 1.
4903 Creates a new SV and copies a string into it. The reference count for the
4904 SV is set to 1. If C<len> is zero, Perl will compute the length using
4905 strlen(). For efficiency, consider using C<newSVpvn> instead.
4907 SV* newSVpv(const char* s, STRLEN len)
4915 Creates a new SV and initializes it with the string formatted like
4918 SV* newSVpvf(const char* pat, ...)
4926 Creates a new SV and copies a string into it. The reference count for the
4927 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
4928 string. You are responsible for ensuring that the source string is at least
4929 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
4931 SV* newSVpvn(const char* s, STRLEN len)
4936 =item newSVpvn_share
4939 Creates a new SV with its SvPVX_const pointing to a shared string in the string
4940 table. If the string does not already exist in the table, it is created
4941 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
4942 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
4943 otherwise the hash is computed. The idea here is that as the string table
4944 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
4945 hash lookup will avoid string compare.
4947 SV* newSVpvn_share(const char* s, I32 len, U32 hash)
4955 Like C<newSVpvn>, but takes a literal string instead of a string/length pair.
4957 SV* newSVpvs(const char* s)
4960 Found in file handy.h
4962 =item newSVpvs_share
4965 Like C<newSVpvn_share>, but takes a literal string instead of a string/length
4966 pair and omits the hash parameter.
4968 SV* newSVpvs_share(const char* s)
4971 Found in file handy.h
4976 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
4977 it will be upgraded to one. If C<classname> is non-null then the new SV will
4978 be blessed in the specified package. The new SV is returned and its
4979 reference count is 1.
4981 SV* newSVrv(SV* rv, const char* classname)
4989 Creates a new SV which is an exact duplicate of the original SV.
4992 SV* newSVsv(SV* old)
5000 Creates a new SV and copies an unsigned integer into it.
5001 The reference count for the SV is set to 1.
5011 This function is only called on magical items, and is only used by
5012 sv_true() or its macro equivalent.
5014 bool sv_2bool(SV* sv)
5022 Using various gambits, try to get a CV from an SV; in addition, try if
5023 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
5024 The flags in C<lref> are passed to sv_fetchsv.
5026 CV* sv_2cv(SV* sv, HV** st, GV** gvp, I32 lref)
5034 Using various gambits, try to get an IO from an SV: the IO slot if its a
5035 GV; or the recursive result if we're an RV; or the IO slot of the symbol
5036 named after the PV if we're a string.
5046 Return the integer value of an SV, doing any necessary string
5047 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
5048 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
5050 IV sv_2iv_flags(SV* sv, I32 flags)
5058 Marks an existing SV as mortal. The SV will be destroyed "soon", either
5059 by an explicit call to FREETMPS, or by an implicit call at places such as
5060 statement boundaries. SvTEMP() is turned on which means that the SV's
5061 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
5062 and C<sv_mortalcopy>.
5064 SV* sv_2mortal(SV* sv)
5072 Return the num value of an SV, doing any necessary string or integer
5073 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
5084 Return a pointer to the byte-encoded representation of the SV, and set *lp
5085 to its length. May cause the SV to be downgraded from UTF-8 as a
5088 Usually accessed via the C<SvPVbyte> macro.
5090 char* sv_2pvbyte(SV* sv, STRLEN* lp)
5098 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
5099 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
5101 Usually accessed via the C<SvPVutf8> macro.
5103 char* sv_2pvutf8(SV* sv, STRLEN* lp)
5111 Returns a pointer to the string value of an SV, and sets *lp to its length.
5112 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
5114 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
5115 usually end up here too.
5117 char* sv_2pv_flags(SV* sv, STRLEN* lp, I32 flags)
5125 Return the unsigned integer value of an SV, doing any necessary string
5126 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
5127 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
5129 UV sv_2uv_flags(SV* sv, I32 flags)
5137 Remove any string offset. You should normally use the C<SvOOK_off> macro
5140 int sv_backoff(SV* sv)
5148 Blesses an SV into a specified package. The SV must be an RV. The package
5149 must be designated by its stash (see C<gv_stashpv()>). The reference count
5150 of the SV is unaffected.
5152 SV* sv_bless(SV* sv, HV* stash)
5160 Concatenates the string onto the end of the string which is in the SV.
5161 If the SV has the UTF-8 status set, then the bytes appended should be
5162 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
5164 void sv_catpv(SV* sv, const char* ptr)
5172 Processes its arguments like C<sprintf> and appends the formatted
5173 output to an SV. If the appended data contains "wide" characters
5174 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
5175 and characters >255 formatted with %c), the original SV might get
5176 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
5177 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
5178 valid UTF-8; if the original SV was bytes, the pattern should be too.
5180 void sv_catpvf(SV* sv, const char* pat, ...)
5188 Like C<sv_catpvf>, but also handles 'set' magic.
5190 void sv_catpvf_mg(SV *sv, const char* pat, ...)
5198 Concatenates the string onto the end of the string which is in the SV. The
5199 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5200 status set, then the bytes appended should be valid UTF-8.
5201 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
5203 void sv_catpvn(SV* sv, const char* ptr, STRLEN len)
5208 =item sv_catpvn_flags
5211 Concatenates the string onto the end of the string which is in the SV. The
5212 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5213 status set, then the bytes appended should be valid UTF-8.
5214 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
5215 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
5216 in terms of this function.
5218 void sv_catpvn_flags(SV* sv, const char* ptr, STRLEN len, I32 flags)
5226 Like C<sv_catpvn>, but takes a literal string instead of a string/length pair.
5228 void sv_catpvs(SV* sv, const char* s)
5231 Found in file handy.h
5236 Like C<sv_catpv>, but also handles 'set' magic.
5238 void sv_catpv_mg(SV *sv, const char *ptr)
5246 Concatenates the string from SV C<ssv> onto the end of the string in
5247 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
5248 not 'set' magic. See C<sv_catsv_mg>.
5250 void sv_catsv(SV* dsv, SV* ssv)
5255 =item sv_catsv_flags
5258 Concatenates the string from SV C<ssv> onto the end of the string in
5259 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
5260 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
5261 and C<sv_catsv_nomg> are implemented in terms of this function.
5263 void sv_catsv_flags(SV* dsv, SV* ssv, I32 flags)
5271 Efficient removal of characters from the beginning of the string buffer.
5272 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
5273 the string buffer. The C<ptr> becomes the first character of the adjusted
5274 string. Uses the "OOK hack".
5275 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
5276 refer to the same chunk of data.
5278 void sv_chop(SV* sv, const char* ptr)
5286 Clear an SV: call any destructors, free up any memory used by the body,
5287 and free the body itself. The SV's head is I<not> freed, although
5288 its type is set to all 1's so that it won't inadvertently be assumed
5289 to be live during global destruction etc.
5290 This function should only be called when REFCNT is zero. Most of the time
5291 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5294 void sv_clear(SV* sv)
5302 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5303 string in C<sv1> is less than, equal to, or greater than the string in
5304 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5305 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
5307 I32 sv_cmp(SV* sv1, SV* sv2)
5315 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
5316 'use bytes' aware, handles get magic, and will coerce its args to strings
5317 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
5319 I32 sv_cmp_locale(SV* sv1, SV* sv2)
5327 Add Collate Transform magic to an SV if it doesn't already have it.
5329 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
5330 scalar data of the variable, but transformed to such a format that a normal
5331 memory comparison can be used to compare the data according to the locale
5334 char* sv_collxfrm(SV* sv, STRLEN* nxp)
5342 Copies a stringified representation of the source SV into the
5343 destination SV. Automatically performs any necessary mg_get and
5344 coercion of numeric values into strings. Guaranteed to preserve
5345 UTF-8 flag even from overloaded objects. Similar in nature to
5346 sv_2pv[_flags] but operates directly on an SV instead of just the
5347 string. Mostly uses sv_2pv_flags to do its work, except when that
5348 would lose the UTF-8'ness of the PV.
5350 void sv_copypv(SV* dsv, SV* ssv)
5358 Auto-decrement of the value in the SV, doing string to numeric conversion
5359 if necessary. Handles 'get' magic.
5369 Returns a boolean indicating whether the strings in the two SVs are
5370 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5371 coerce its args to strings if necessary.
5373 I32 sv_eq(SV* sv1, SV* sv2)
5378 =item sv_force_normal_flags
5379 X<sv_force_normal_flags>
5381 Undo various types of fakery on an SV: if the PV is a shared string, make
5382 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
5383 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
5384 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
5385 then a copy-on-write scalar drops its PV buffer (if any) and becomes
5386 SvPOK_off rather than making a copy. (Used where this scalar is about to be
5387 set to some other value.) In addition, the C<flags> parameter gets passed to
5388 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
5389 with flags set to 0.
5391 void sv_force_normal_flags(SV *sv, U32 flags)
5399 Decrement an SV's reference count, and if it drops to zero, call
5400 C<sv_clear> to invoke destructors and free up any memory used by
5401 the body; finally, deallocate the SV's head itself.
5402 Normally called via a wrapper macro C<SvREFCNT_dec>.
5404 void sv_free(SV* sv)
5412 Get a line from the filehandle and store it into the SV, optionally
5413 appending to the currently-stored string.
5415 char* sv_gets(SV* sv, PerlIO* fp, I32 append)
5423 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
5424 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
5425 Use the C<SvGROW> wrapper instead.
5427 char* sv_grow(SV* sv, STRLEN newlen)
5435 Auto-increment of the value in the SV, doing string to numeric conversion
5436 if necessary. Handles 'get' magic.
5446 Inserts a string at the specified offset/length within the SV. Similar to
5447 the Perl substr() function.
5449 void sv_insert(SV* bigsv, STRLEN offset, STRLEN len, const char* little, STRLEN littlelen)
5457 Returns a boolean indicating whether the SV is blessed into the specified
5458 class. This does not check for subtypes; use C<sv_derived_from> to verify
5459 an inheritance relationship.
5461 int sv_isa(SV* sv, const char* name)
5469 Returns a boolean indicating whether the SV is an RV pointing to a blessed
5470 object. If the SV is not an RV, or if the object is not blessed, then this
5473 int sv_isobject(SV* sv)
5481 Returns the length of the string in the SV. Handles magic and type
5482 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5484 STRLEN sv_len(SV* sv)
5492 Returns the number of characters in the string in an SV, counting wide
5493 UTF-8 bytes as a single character. Handles magic and type coercion.
5495 STRLEN sv_len_utf8(SV* sv)
5503 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
5504 then adds a new magic item of type C<how> to the head of the magic list.
5506 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
5507 handling of the C<name> and C<namlen> arguments.
5509 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
5510 to add more than one instance of the same 'how'.
5512 void sv_magic(SV* sv, SV* obj, int how, const char* name, I32 namlen)
5520 Adds magic to an SV, upgrading it if necessary. Applies the
5521 supplied vtable and returns a pointer to the magic added.
5523 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
5524 In particular, you can add magic to SvREADONLY SVs, and add more than
5525 one instance of the same 'how'.
5527 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
5528 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
5529 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
5530 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
5532 (This is now used as a subroutine by C<sv_magic>.)
5534 MAGIC * sv_magicext(SV* sv, SV* obj, int how, const MGVTBL *vtbl, const char* name, I32 namlen)
5542 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
5543 The new SV is marked as mortal. It will be destroyed "soon", either by an
5544 explicit call to FREETMPS, or by an implicit call at places such as
5545 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
5547 SV* sv_mortalcopy(SV* oldsv)
5555 Creates a new null SV which is mortal. The reference count of the SV is
5556 set to 1. It will be destroyed "soon", either by an explicit call to
5557 FREETMPS, or by an implicit call at places such as statement boundaries.
5558 See also C<sv_mortalcopy> and C<sv_2mortal>.
5568 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5571 SV* sv_newref(SV* sv)
5579 Converts the value pointed to by offsetp from a count of bytes from the
5580 start of the string, to a count of the equivalent number of UTF-8 chars.
5581 Handles magic and type coercion.
5583 void sv_pos_b2u(SV* sv, I32* offsetp)
5591 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5592 the start of the string, to a count of the equivalent number of bytes; if
5593 lenp is non-zero, it does the same to lenp, but this time starting from
5594 the offset, rather than from the start of the string. Handles magic and
5597 void sv_pos_u2b(SV* sv, I32* offsetp, I32* lenp)
5602 =item sv_pvbyten_force
5605 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
5607 char* sv_pvbyten_force(SV* sv, STRLEN* lp)
5615 Get a sensible string out of the SV somehow.
5616 A private implementation of the C<SvPV_force> macro for compilers which
5617 can't cope with complex macro expressions. Always use the macro instead.
5619 char* sv_pvn_force(SV* sv, STRLEN* lp)
5624 =item sv_pvn_force_flags
5625 X<sv_pvn_force_flags>
5627 Get a sensible string out of the SV somehow.
5628 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
5629 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
5630 implemented in terms of this function.
5631 You normally want to use the various wrapper macros instead: see
5632 C<SvPV_force> and C<SvPV_force_nomg>
5634 char* sv_pvn_force_flags(SV* sv, STRLEN* lp, I32 flags)
5639 =item sv_pvutf8n_force
5642 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
5644 char* sv_pvutf8n_force(SV* sv, STRLEN* lp)
5652 Returns a string describing what the SV is a reference to.
5654 const char* sv_reftype(const SV* sv, int ob)
5662 Make the first argument a copy of the second, then delete the original.
5663 The target SV physically takes over ownership of the body of the source SV
5664 and inherits its flags; however, the target keeps any magic it owns,
5665 and any magic in the source is discarded.
5666 Note that this is a rather specialist SV copying operation; most of the
5667 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5669 void sv_replace(SV* sv, SV* nsv)
5677 Underlying implementation for the C<reset> Perl function.
5678 Note that the perl-level function is vaguely deprecated.
5680 void sv_reset(const char* s, HV* stash)
5688 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
5689 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
5690 push a back-reference to this RV onto the array of backreferences
5691 associated with that magic. If the RV is magical, set magic will be
5692 called after the RV is cleared.
5694 SV* sv_rvweaken(SV *sv)
5702 Copies an integer into the given SV, upgrading first if necessary.
5703 Does not handle 'set' magic. See also C<sv_setiv_mg>.
5705 void sv_setiv(SV* sv, IV num)
5713 Like C<sv_setiv>, but also handles 'set' magic.
5715 void sv_setiv_mg(SV *sv, IV i)
5723 Copies a double into the given SV, upgrading first if necessary.
5724 Does not handle 'set' magic. See also C<sv_setnv_mg>.
5726 void sv_setnv(SV* sv, NV num)
5734 Like C<sv_setnv>, but also handles 'set' magic.
5736 void sv_setnv_mg(SV *sv, NV num)
5744 Copies a string into an SV. The string must be null-terminated. Does not
5745 handle 'set' magic. See C<sv_setpv_mg>.
5747 void sv_setpv(SV* sv, const char* ptr)
5755 Works like C<sv_catpvf> but copies the text into the SV instead of
5756 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
5758 void sv_setpvf(SV* sv, const char* pat, ...)
5766 Like C<sv_setpvf>, but also handles 'set' magic.
5768 void sv_setpvf_mg(SV *sv, const char* pat, ...)
5776 Copies an integer into the given SV, also updating its string value.
5777 Does not handle 'set' magic. See C<sv_setpviv_mg>.
5779 void sv_setpviv(SV* sv, IV num)
5787 Like C<sv_setpviv>, but also handles 'set' magic.
5789 void sv_setpviv_mg(SV *sv, IV iv)
5797 Copies a string into an SV. The C<len> parameter indicates the number of
5798 bytes to be copied. If the C<ptr> argument is NULL the SV will become
5799 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
5801 void sv_setpvn(SV* sv, const char* ptr, STRLEN len)
5809 Like C<sv_setpvn>, but also handles 'set' magic.
5811 void sv_setpvn_mg(SV *sv, const char *ptr, STRLEN len)
5819 Like C<sv_setpvn>, but takes a literal string instead of a string/length pair.
5821 void sv_setpvs(SV* sv, const char* s)
5824 Found in file handy.h
5829 Like C<sv_setpv>, but also handles 'set' magic.
5831 void sv_setpv_mg(SV *sv, const char *ptr)
5839 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
5840 argument will be upgraded to an RV. That RV will be modified to point to
5841 the new SV. The C<classname> argument indicates the package for the
5842 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
5843 will have a reference count of 1, and the RV will be returned.
5845 SV* sv_setref_iv(SV* rv, const char* classname, IV iv)
5853 Copies a double into a new SV, optionally blessing the SV. The C<rv>
5854 argument will be upgraded to an RV. That RV will be modified to point to
5855 the new SV. The C<classname> argument indicates the package for the
5856 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
5857 will have a reference count of 1, and the RV will be returned.
5859 SV* sv_setref_nv(SV* rv, const char* classname, NV nv)
5867 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
5868 argument will be upgraded to an RV. That RV will be modified to point to
5869 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
5870 into the SV. The C<classname> argument indicates the package for the
5871 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
5872 will have a reference count of 1, and the RV will be returned.
5874 Do not use with other Perl types such as HV, AV, SV, CV, because those
5875 objects will become corrupted by the pointer copy process.
5877 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
5879 SV* sv_setref_pv(SV* rv, const char* classname, void* pv)
5887 Copies a string into a new SV, optionally blessing the SV. The length of the
5888 string must be specified with C<n>. The C<rv> argument will be upgraded to
5889 an RV. That RV will be modified to point to the new SV. The C<classname>
5890 argument indicates the package for the blessing. Set C<classname> to
5891 C<NULL> to avoid the blessing. The new SV will have a reference count
5892 of 1, and the RV will be returned.
5894 Note that C<sv_setref_pv> copies the pointer while this copies the string.
5896 SV* sv_setref_pvn(SV* rv, const char* classname, const char* pv, STRLEN n)
5904 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
5905 argument will be upgraded to an RV. That RV will be modified to point to
5906 the new SV. The C<classname> argument indicates the package for the
5907 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
5908 will have a reference count of 1, and the RV will be returned.
5910 SV* sv_setref_uv(SV* rv, const char* classname, UV uv)
5918 Copies the contents of the source SV C<ssv> into the destination SV
5919 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
5920 function if the source SV needs to be reused. Does not handle 'set' magic.
5921 Loosely speaking, it performs a copy-by-value, obliterating any previous
5922 content of the destination.
5924 You probably want to use one of the assortment of wrappers, such as
5925 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
5926 C<SvSetMagicSV_nosteal>.
5928 void sv_setsv(SV* dsv, SV* ssv)
5933 =item sv_setsv_flags
5936 Copies the contents of the source SV C<ssv> into the destination SV
5937 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
5938 function if the source SV needs to be reused. Does not handle 'set' magic.
5939 Loosely speaking, it performs a copy-by-value, obliterating any previous
5940 content of the destination.
5941 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
5942 C<ssv> if appropriate, else not. If the C<flags> parameter has the
5943 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
5944 and C<sv_setsv_nomg> are implemented in terms of this function.
5946 You probably want to use one of the assortment of wrappers, such as
5947 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
5948 C<SvSetMagicSV_nosteal>.
5950 This is the primary function for copying scalars, and most other
5951 copy-ish functions and macros use this underneath.
5953 void sv_setsv_flags(SV* dsv, SV* ssv, I32 flags)
5961 Like C<sv_setsv>, but also handles 'set' magic.
5963 void sv_setsv_mg(SV *dstr, SV *sstr)
5971 Copies an unsigned integer into the given SV, upgrading first if necessary.
5972 Does not handle 'set' magic. See also C<sv_setuv_mg>.
5974 void sv_setuv(SV* sv, UV num)
5982 Like C<sv_setuv>, but also handles 'set' magic.
5984 void sv_setuv_mg(SV *sv, UV u)
5992 Test an SV for taintedness. Use C<SvTAINTED> instead.
5993 bool sv_tainted(SV* sv)
6001 Returns true if the SV has a true value by Perl's rules.
6002 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
6003 instead use an in-line version.
6013 Removes all magic of type C<type> from an SV.
6015 int sv_unmagic(SV* sv, int type)
6020 =item sv_unref_flags
6023 Unsets the RV status of the SV, and decrements the reference count of
6024 whatever was being referenced by the RV. This can almost be thought of
6025 as a reversal of C<newSVrv>. The C<cflags> argument can contain
6026 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
6027 (otherwise the decrementing is conditional on the reference count being
6028 different from one or the reference being a readonly SV).
6031 void sv_unref_flags(SV* sv, U32 flags)
6039 Untaint an SV. Use C<SvTAINTED_off> instead.
6040 void sv_untaint(SV* sv)
6048 Upgrade an SV to a more complex form. Generally adds a new body type to the
6049 SV, then copies across as much information as possible from the old body.
6050 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
6052 void sv_upgrade(SV* sv, svtype new_type)
6057 =item sv_usepvn_flags
6060 Tells an SV to use C<ptr> to find its string value. Normally the
6061 string is stored inside the SV but sv_usepvn allows the SV to use an
6062 outside string. The C<ptr> should point to memory that was allocated
6063 by C<malloc>. The string length, C<len>, must be supplied. By default
6064 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
6065 so that pointer should not be freed or used by the programmer after
6066 giving it to sv_usepvn, and neither should any pointers from "behind"
6067 that pointer (e.g. ptr + 1) be used.
6069 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
6070 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
6071 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
6072 C<len>, and already meets the requirements for storing in C<SvPVX>)
6074 void sv_usepvn_flags(SV* sv, char* ptr, STRLEN len, U32 flags)
6079 =item sv_utf8_decode
6082 If the PV of the SV is an octet sequence in UTF-8
6083 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
6084 so that it looks like a character. If the PV contains only single-byte
6085 characters, the C<SvUTF8> flag stays being off.
6086 Scans PV for validity and returns false if the PV is invalid UTF-8.
6088 NOTE: this function is experimental and may change or be
6089 removed without notice.
6091 bool sv_utf8_decode(SV *sv)
6096 =item sv_utf8_downgrade
6097 X<sv_utf8_downgrade>
6099 Attempts to convert the PV of an SV from characters to bytes.
6100 If the PV contains a character beyond byte, this conversion will fail;
6101 in this case, either returns false or, if C<fail_ok> is not
6104 This is not as a general purpose Unicode to byte encoding interface:
6105 use the Encode extension for that.
6107 NOTE: this function is experimental and may change or be
6108 removed without notice.
6110 bool sv_utf8_downgrade(SV *sv, bool fail_ok)
6115 =item sv_utf8_encode
6118 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
6119 flag off so that it looks like octets again.
6121 void sv_utf8_encode(SV *sv)
6126 =item sv_utf8_upgrade
6129 Converts the PV of an SV to its UTF-8-encoded form.
6130 Forces the SV to string form if it is not already.
6131 Always sets the SvUTF8 flag to avoid future validity checks even
6132 if all the bytes have hibit clear.
6134 This is not as a general purpose byte encoding to Unicode interface:
6135 use the Encode extension for that.
6137 STRLEN sv_utf8_upgrade(SV *sv)
6142 =item sv_utf8_upgrade_flags
6143 X<sv_utf8_upgrade_flags>
6145 Converts the PV of an SV to its UTF-8-encoded form.
6146 Forces the SV to string form if it is not already.
6147 Always sets the SvUTF8 flag to avoid future validity checks even
6148 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
6149 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
6150 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
6152 This is not as a general purpose byte encoding to Unicode interface:
6153 use the Encode extension for that.
6155 STRLEN sv_utf8_upgrade_flags(SV *sv, I32 flags)
6163 Processes its arguments like C<vsprintf> and appends the formatted output
6164 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
6166 Usually used via its frontend C<sv_catpvf>.
6168 void sv_vcatpvf(SV* sv, const char* pat, va_list* args)
6176 Processes its arguments like C<vsprintf> and appends the formatted output
6177 to an SV. Uses an array of SVs if the C style variable argument list is
6178 missing (NULL). When running with taint checks enabled, indicates via
6179 C<maybe_tainted> if results are untrustworthy (often due to the use of
6182 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
6184 void sv_vcatpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
6192 Like C<sv_vcatpvf>, but also handles 'set' magic.
6194 Usually used via its frontend C<sv_catpvf_mg>.
6196 void sv_vcatpvf_mg(SV* sv, const char* pat, va_list* args)
6204 Works like C<sv_vcatpvf> but copies the text into the SV instead of
6205 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
6207 Usually used via its frontend C<sv_setpvf>.
6209 void sv_vsetpvf(SV* sv, const char* pat, va_list* args)
6217 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
6220 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
6222 void sv_vsetpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
6230 Like C<sv_vsetpvf>, but also handles 'set' magic.
6232 Usually used via its frontend C<sv_setpvf_mg>.
6234 void sv_vsetpvf_mg(SV* sv, const char* pat, va_list* args)
6242 =head1 Unicode Support
6246 =item bytes_from_utf8
6249 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
6250 Unlike C<utf8_to_bytes> but like C<bytes_to_utf8>, returns a pointer to
6251 the newly-created string, and updates C<len> to contain the new
6252 length. Returns the original string if no conversion occurs, C<len>
6253 is unchanged. Do nothing if C<is_utf8> points to 0. Sets C<is_utf8> to
6254 0 if C<s> is converted or contains all 7bit characters.
6256 NOTE: this function is experimental and may change or be
6257 removed without notice.
6259 U8* bytes_from_utf8(const U8 *s, STRLEN *len, bool *is_utf8)
6262 Found in file utf8.c
6267 Converts a string C<s> of length C<len> from ASCII into UTF-8 encoding.
6268 Returns a pointer to the newly-created string, and sets C<len> to
6269 reflect the new length.
6271 If you want to convert to UTF-8 from other encodings than ASCII,
6272 see sv_recode_to_utf8().
6274 NOTE: this function is experimental and may change or be
6275 removed without notice.
6277 U8* bytes_to_utf8(const U8 *s, STRLEN *len)
6280 Found in file utf8.c
6285 Return true if the strings s1 and s2 differ case-insensitively, false
6286 if not (if they are equal case-insensitively). If u1 is true, the
6287 string s1 is assumed to be in UTF-8-encoded Unicode. If u2 is true,
6288 the string s2 is assumed to be in UTF-8-encoded Unicode. If u1 or u2
6289 are false, the respective string is assumed to be in native 8-bit
6292 If the pe1 and pe2 are non-NULL, the scanning pointers will be copied
6293 in there (they will point at the beginning of the I<next> character).
6294 If the pointers behind pe1 or pe2 are non-NULL, they are the end
6295 pointers beyond which scanning will not continue under any
6296 circumstances. If the byte lengths l1 and l2 are non-zero, s1+l1 and
6297 s2+l2 will be used as goal end pointers that will also stop the scan,
6298 and which qualify towards defining a successful match: all the scans
6299 that define an explicit length must reach their goal pointers for
6300 a match to succeed).
6302 For case-insensitiveness, the "casefolding" of Unicode is used
6303 instead of upper/lowercasing both the characters, see
6304 http://www.unicode.org/unicode/reports/tr21/ (Case Mappings).
6306 I32 ibcmp_utf8(const char* a, char **pe1, UV l1, bool u1, const char* b, char **pe2, UV l2, bool u2)
6309 Found in file utf8.c
6314 Tests if some arbitrary number of bytes begins in a valid UTF-8
6315 character. Note that an INVARIANT (i.e. ASCII) character is a valid
6316 UTF-8 character. The actual number of bytes in the UTF-8 character
6317 will be returned if it is valid, otherwise 0.
6319 STRLEN is_utf8_char(const U8 *p)
6322 Found in file utf8.c
6324 =item is_utf8_string
6327 Returns true if first C<len> bytes of the given string form a valid
6328 UTF-8 string, false otherwise. Note that 'a valid UTF-8 string' does
6329 not mean 'a string that contains code points above 0x7F encoded in UTF-8'
6330 because a valid ASCII string is a valid UTF-8 string.
6332 See also is_utf8_string_loclen() and is_utf8_string_loc().
6334 bool is_utf8_string(const U8 *s, STRLEN len)
6337 Found in file utf8.c
6339 =item is_utf8_string_loc
6340 X<is_utf8_string_loc>
6342 Like is_utf8_string() but stores the location of the failure (in the
6343 case of "utf8ness failure") or the location s+len (in the case of
6344 "utf8ness success") in the C<ep>.
6346 See also is_utf8_string_loclen() and is_utf8_string().
6348 bool is_utf8_string_loc(const U8 *s, STRLEN len, const U8 **p)
6351 Found in file utf8.c
6353 =item is_utf8_string_loclen
6354 X<is_utf8_string_loclen>
6356 Like is_utf8_string() but stores the location of the failure (in the
6357 case of "utf8ness failure") or the location s+len (in the case of
6358 "utf8ness success") in the C<ep>, and the number of UTF-8
6359 encoded characters in the C<el>.
6361 See also is_utf8_string_loc() and is_utf8_string().
6363 bool is_utf8_string_loclen(const U8 *s, STRLEN len, const U8 **ep, STRLEN *el)
6366 Found in file utf8.c
6368 =item pv_uni_display
6371 Build to the scalar dsv a displayable version of the string spv,
6372 length len, the displayable version being at most pvlim bytes long
6373 (if longer, the rest is truncated and "..." will be appended).
6375 The flags argument can have UNI_DISPLAY_ISPRINT set to display
6376 isPRINT()able characters as themselves, UNI_DISPLAY_BACKSLASH
6377 to display the \\[nrfta\\] as the backslashed versions (like '\n')
6378 (UNI_DISPLAY_BACKSLASH is preferred over UNI_DISPLAY_ISPRINT for \\).
6379 UNI_DISPLAY_QQ (and its alias UNI_DISPLAY_REGEX) have both
6380 UNI_DISPLAY_BACKSLASH and UNI_DISPLAY_ISPRINT turned on.
6382 The pointer to the PV of the dsv is returned.
6384 char* pv_uni_display(SV *dsv, const U8 *spv, STRLEN len, STRLEN pvlim, UV flags)
6387 Found in file utf8.c
6392 The encoding is assumed to be an Encode object, the PV of the ssv is
6393 assumed to be octets in that encoding and decoding the input starts
6394 from the position which (PV + *offset) pointed to. The dsv will be
6395 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
6396 when the string tstr appears in decoding output or the input ends on
6397 the PV of the ssv. The value which the offset points will be modified
6398 to the last input position on the ssv.
6400 Returns TRUE if the terminator was found, else returns FALSE.
6402 bool sv_cat_decode(SV* dsv, SV *encoding, SV *ssv, int *offset, char* tstr, int tlen)
6407 =item sv_recode_to_utf8
6408 X<sv_recode_to_utf8>
6410 The encoding is assumed to be an Encode object, on entry the PV
6411 of the sv is assumed to be octets in that encoding, and the sv
6412 will be converted into Unicode (and UTF-8).
6414 If the sv already is UTF-8 (or if it is not POK), or if the encoding
6415 is not a reference, nothing is done to the sv. If the encoding is not
6416 an C<Encode::XS> Encoding object, bad things will happen.
6417 (See F<lib/encoding.pm> and L<Encode>).
6419 The PV of the sv is returned.
6421 char* sv_recode_to_utf8(SV* sv, SV *encoding)
6426 =item sv_uni_display
6429 Build to the scalar dsv a displayable version of the scalar sv,
6430 the displayable version being at most pvlim bytes long
6431 (if longer, the rest is truncated and "..." will be appended).
6433 The flags argument is as in pv_uni_display().
6435 The pointer to the PV of the dsv is returned.
6437 char* sv_uni_display(SV *dsv, SV *ssv, STRLEN pvlim, UV flags)
6440 Found in file utf8.c
6445 The "p" contains the pointer to the UTF-8 string encoding
6446 the character that is being converted.
6448 The "ustrp" is a pointer to the character buffer to put the
6449 conversion result to. The "lenp" is a pointer to the length
6452 The "swashp" is a pointer to the swash to use.
6454 Both the special and normal mappings are stored lib/unicore/To/Foo.pl,
6455 and loaded by SWASHNEW, using lib/utf8_heavy.pl. The special (usually,
6456 but not always, a multicharacter mapping), is tried first.
6458 The "special" is a string like "utf8::ToSpecLower", which means the
6459 hash %utf8::ToSpecLower. The access to the hash is through
6460 Perl_to_utf8_case().
6462 The "normal" is a string like "ToLower" which means the swash
6465 UV to_utf8_case(const U8 *p, U8* ustrp, STRLEN *lenp, SV **swashp, const char *normal, const char *special)
6468 Found in file utf8.c
6473 Convert the UTF-8 encoded character at p to its foldcase version and
6474 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6475 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6476 foldcase version may be longer than the original character (up to
6479 The first character of the foldcased version is returned
6480 (but note, as explained above, that there may be more.)
6482 UV to_utf8_fold(const U8 *p, U8* ustrp, STRLEN *lenp)
6485 Found in file utf8.c
6490 Convert the UTF-8 encoded character at p to its lowercase version and
6491 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6492 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6493 lowercase version may be longer than the original character.
6495 The first character of the lowercased version is returned
6496 (but note, as explained above, that there may be more.)
6498 UV to_utf8_lower(const U8 *p, U8* ustrp, STRLEN *lenp)
6501 Found in file utf8.c
6506 Convert the UTF-8 encoded character at p to its titlecase version and
6507 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6508 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6509 titlecase version may be longer than the original character.
6511 The first character of the titlecased version is returned
6512 (but note, as explained above, that there may be more.)
6514 UV to_utf8_title(const U8 *p, U8* ustrp, STRLEN *lenp)
6517 Found in file utf8.c
6522 Convert the UTF-8 encoded character at p to its uppercase version and
6523 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6524 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since
6525 the uppercase version may be longer than the original character.
6527 The first character of the uppercased version is returned
6528 (but note, as explained above, that there may be more.)
6530 UV to_utf8_upper(const U8 *p, U8* ustrp, STRLEN *lenp)
6533 Found in file utf8.c
6535 =item utf8n_to_uvchr
6540 Returns the native character value of the first character in the string
6542 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6543 length, in bytes, of that character.
6545 Allows length and flags to be passed to low level routine.
6547 UV utf8n_to_uvchr(const U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags)
6550 Found in file utf8.c
6552 =item utf8n_to_uvuni
6555 Bottom level UTF-8 decode routine.
6556 Returns the unicode code point value of the first character in the string C<s>
6557 which is assumed to be in UTF-8 encoding and no longer than C<curlen>;
6558 C<retlen> will be set to the length, in bytes, of that character.
6560 If C<s> does not point to a well-formed UTF-8 character, the behaviour
6561 is dependent on the value of C<flags>: if it contains UTF8_CHECK_ONLY,
6562 it is assumed that the caller will raise a warning, and this function
6563 will silently just set C<retlen> to C<-1> and return zero. If the
6564 C<flags> does not contain UTF8_CHECK_ONLY, warnings about
6565 malformations will be given, C<retlen> will be set to the expected
6566 length of the UTF-8 character in bytes, and zero will be returned.
6568 The C<flags> can also contain various flags to allow deviations from
6569 the strict UTF-8 encoding (see F<utf8.h>).
6571 Most code should use utf8_to_uvchr() rather than call this directly.
6573 UV utf8n_to_uvuni(const U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags)
6576 Found in file utf8.c
6581 Returns the number of UTF-8 characters between the UTF-8 pointers C<a>
6584 WARNING: use only if you *know* that the pointers point inside the
6587 IV utf8_distance(const U8 *a, const U8 *b)
6590 Found in file utf8.c
6595 Return the UTF-8 pointer C<s> displaced by C<off> characters, either
6596 forward or backward.
6598 WARNING: do not use the following unless you *know* C<off> is within
6599 the UTF-8 data pointed to by C<s> *and* that on entry C<s> is aligned
6600 on the first byte of character or just after the last byte of a character.
6602 U8* utf8_hop(const U8 *s, I32 off)
6605 Found in file utf8.c
6610 Return the length of the UTF-8 char encoded string C<s> in characters.
6611 Stops at C<e> (inclusive). If C<e E<lt> s> or if the scan would end
6612 up past C<e>, croaks.
6614 STRLEN utf8_length(const U8* s, const U8 *e)
6617 Found in file utf8.c
6622 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
6623 Unlike C<bytes_to_utf8>, this over-writes the original string, and
6624 updates len to contain the new length.
6625 Returns zero on failure, setting C<len> to -1.
6627 If you need a copy of the string, see C<bytes_from_utf8>.
6629 NOTE: this function is experimental and may change or be
6630 removed without notice.
6632 U8* utf8_to_bytes(U8 *s, STRLEN *len)
6635 Found in file utf8.c
6640 Returns the native character value of the first character in the string C<s>
6641 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6642 length, in bytes, of that character.
6644 If C<s> does not point to a well-formed UTF-8 character, zero is
6645 returned and retlen is set, if possible, to -1.
6647 UV utf8_to_uvchr(const U8 *s, STRLEN *retlen)
6650 Found in file utf8.c
6655 Returns the Unicode code point of the first character in the string C<s>
6656 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6657 length, in bytes, of that character.
6659 This function should only be used when returned UV is considered
6660 an index into the Unicode semantic tables (e.g. swashes).
6662 If C<s> does not point to a well-formed UTF-8 character, zero is
6663 returned and retlen is set, if possible, to -1.
6665 UV utf8_to_uvuni(const U8 *s, STRLEN *retlen)
6668 Found in file utf8.c
6673 Adds the UTF-8 representation of the Native codepoint C<uv> to the end
6674 of the string C<d>; C<d> should be have at least C<UTF8_MAXBYTES+1> free
6675 bytes available. The return value is the pointer to the byte after the
6676 end of the new character. In other words,
6678 d = uvchr_to_utf8(d, uv);
6680 is the recommended wide native character-aware way of saying
6684 U8* uvchr_to_utf8(U8 *d, UV uv)
6687 Found in file utf8.c
6689 =item uvuni_to_utf8_flags
6690 X<uvuni_to_utf8_flags>
6692 Adds the UTF-8 representation of the Unicode codepoint C<uv> to the end
6693 of the string C<d>; C<d> should be have at least C<UTF8_MAXBYTES+1> free
6694 bytes available. The return value is the pointer to the byte after the
6695 end of the new character. In other words,
6697 d = uvuni_to_utf8_flags(d, uv, flags);
6701 d = uvuni_to_utf8(d, uv);
6703 (which is equivalent to)
6705 d = uvuni_to_utf8_flags(d, uv, 0);
6707 is the recommended Unicode-aware way of saying
6711 U8* uvuni_to_utf8_flags(U8 *d, UV uv, UV flags)
6714 Found in file utf8.c
6719 =head1 Variables created by C<xsubpp> and C<xsubpp> internal functions
6726 Variable which is setup by C<xsubpp> to indicate the stack base offset,
6727 used by the C<ST>, C<XSprePUSH> and C<XSRETURN> macros. The C<dMARK> macro
6728 must be called prior to setup the C<MARK> variable.
6733 Found in file XSUB.h
6738 Variable which is setup by C<xsubpp> to indicate the
6739 class name for a C++ XS constructor. This is always a C<char*>. See C<THIS>.
6744 Found in file XSUB.h
6749 Sets up the C<ax> variable.
6750 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
6755 Found in file XSUB.h
6760 Sets up the C<ax> variable and stack marker variable C<mark>.
6761 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
6766 Found in file XSUB.h
6771 Sets up the C<items> variable.
6772 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
6777 Found in file XSUB.h
6782 Sets up the C<padoff_du> variable for an XSUB that wishes to use
6788 Found in file XSUB.h
6793 Sets up stack and mark pointers for an XSUB, calling dSP and dMARK.
6794 Sets up the C<ax> and C<items> variables by calling C<dAX> and C<dITEMS>.
6795 This is usually handled automatically by C<xsubpp>.
6800 Found in file XSUB.h
6805 Sets up the C<ix> variable for an XSUB which has aliases. This is usually
6806 handled automatically by C<xsubpp>.
6811 Found in file XSUB.h
6816 Variable which is setup by C<xsubpp> to indicate the number of
6817 items on the stack. See L<perlxs/"Variable-length Parameter Lists">.
6822 Found in file XSUB.h
6827 Variable which is setup by C<xsubpp> to indicate which of an
6828 XSUB's aliases was used to invoke it. See L<perlxs/"The ALIAS: Keyword">.
6833 Found in file XSUB.h
6838 Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
6842 Found in file XSUB.h
6847 Variable which is setup by C<xsubpp> to hold the return value for an
6848 XSUB. This is always the proper type for the XSUB. See
6849 L<perlxs/"The RETVAL Variable">.
6854 Found in file XSUB.h
6859 Used to access elements on the XSUB's stack.
6864 Found in file XSUB.h
6869 Variable which is setup by C<xsubpp> to designate the object in a C++
6870 XSUB. This is always the proper type for the C++ object. See C<CLASS> and
6871 L<perlxs/"Using XS With C++">.
6876 Found in file XSUB.h
6881 The SV* corresponding to the $_ variable. Works even if there
6882 is a lexical $_ in scope.
6885 Found in file XSUB.h
6890 Macro to declare an XSUB and its C parameter list. This is handled by
6894 Found in file XSUB.h
6899 The version identifier for an XS module. This is usually
6900 handled automatically by C<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>.
6903 Found in file XSUB.h
6905 =item XS_VERSION_BOOTCHECK
6906 X<XS_VERSION_BOOTCHECK>
6908 Macro to verify that a PM module's $VERSION variable matches the XS
6909 module's C<XS_VERSION> variable. This is usually handled automatically by
6910 C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">.
6912 XS_VERSION_BOOTCHECK;
6915 Found in file XSUB.h
6920 =head1 Warning and Dieing
6927 This is the XSUB-writer's interface to Perl's C<die> function.
6928 Normally call this function the same way you call the C C<printf>
6929 function. Calling C<croak> returns control directly to Perl,
6930 sidestepping the normal C order of execution. See C<warn>.
6932 If you want to throw an exception object, assign the object to
6933 C<$@> and then pass C<NULL> to croak():
6935 errsv = get_sv("@", TRUE);
6936 sv_setsv(errsv, exception_object);
6939 void croak(const char* pat, ...)
6942 Found in file util.c
6947 This is the XSUB-writer's interface to Perl's C<warn> function. Call this
6948 function the same way you call the C C<printf> function. See C<croak>.
6950 void warn(const char* pat, ...)
6953 Found in file util.c
6960 Until May 1997, this document was maintained by Jeff Okamoto
6961 <okamoto@corp.hp.com>. It is now maintained as part of Perl itself.
6963 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
6964 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
6965 Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
6966 Stephen McCamant, and Gurusamy Sarathy.
6968 API Listing originally by Dean Roehrich <roehrich@cray.com>.
6970 Updated to be autogenerated from comments in the source by Benjamin Stuhl.
6974 perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
projects / p5sagit/p5-mst-13.2.git / blob