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. C<name> should
1362 be a valid UTF-8 string and must be null-terminated. If C<create> is set
1363 then the package will be created if it does not already exist. If C<create>
1364 is not set and the package does not exist then NULL is returned.
1366 HV* gv_stashpv(const char* name, I32 create)
1374 Returns a pointer to the stash for a specified package. C<name> should
1375 be a valid UTF-8 string. The C<namelen> parameter indicates the length of
1376 the C<name>, in bytes. If C<create> is set then the package will be
1377 created if it does not already exist. If C<create> is not set and the
1378 package does not exist then NULL is returned.
1380 HV* gv_stashpvn(const char* name, U32 namelen, I32 create)
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, which must be a
1399 valid UTF-8 string. See C<gv_stashpv>.
1401 HV* gv_stashsv(SV* sv, I32 create)
1424 Null character pointer.
1427 Found in file handy.h
1451 Found in file handy.h
1456 =head1 Hash Manipulation Functions
1463 Returns the HV of the specified Perl hash. If C<create> is set and the
1464 Perl variable does not exist then it will be created. If C<create> is not
1465 set and the variable does not exist then NULL is returned.
1467 NOTE: the perl_ form of this function is deprecated.
1469 HV* get_hv(const char* name, I32 create)
1472 Found in file perl.c
1477 This flag, used in the length slot of hash entries and magic structures,
1478 specifies the structure contains an C<SV*> pointer where a C<char*> pointer
1479 is to be expected. (For information only--not to be used).
1487 Returns the computed hash stored in the hash entry.
1497 Returns the actual pointer stored in the key slot of the hash entry. The
1498 pointer may be either C<char*> or C<SV*>, depending on the value of
1499 C<HeKLEN()>. Can be assigned to. The C<HePV()> or C<HeSVKEY()> macros are
1500 usually preferable for finding the value of a key.
1510 If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry
1511 holds an C<SV*> key. Otherwise, holds the actual length of the key. Can
1512 be assigned to. The C<HePV()> macro is usually preferable for finding key
1515 STRLEN HeKLEN(HE* he)
1523 Returns the key slot of the hash entry as a C<char*> value, doing any
1524 necessary dereferencing of possibly C<SV*> keys. The length of the string
1525 is placed in C<len> (this is a macro, so do I<not> use C<&len>). If you do
1526 not care about what the length of the key is, you may use the global
1527 variable C<PL_na>, though this is rather less efficient than using a local
1528 variable. Remember though, that hash keys in perl are free to contain
1529 embedded nulls, so using C<strlen()> or similar is not a good way to find
1530 the length of hash keys. This is very similar to the C<SvPV()> macro
1531 described elsewhere in this document.
1533 char* HePV(HE* he, STRLEN len)
1541 Returns the key as an C<SV*>, or C<NULL> if the hash entry does not
1542 contain an C<SV*> key.
1552 Returns the key as an C<SV*>. Will create and return a temporary mortal
1553 C<SV*> if the hash entry contains only a C<char*> key.
1555 SV* HeSVKEY_force(HE* he)
1563 Sets the key to a given C<SV*>, taking care to set the appropriate flags to
1564 indicate the presence of an C<SV*> key, and returns the same
1567 SV* HeSVKEY_set(HE* he, SV* sv)
1575 Returns the value slot (type C<SV*>) stored in the hash entry.
1585 Returns the package name of a stash, or NULL if C<stash> isn't a stash.
1586 See C<SvSTASH>, C<CvSTASH>.
1588 char* HvNAME(HV* stash)
1596 Check that a hash is in an internally consistent state.
1598 void hv_assert(HV* tb)
1606 Clears a hash, making it empty.
1608 void hv_clear(HV* tb)
1613 =item hv_clear_placeholders
1614 X<hv_clear_placeholders>
1616 Clears any placeholders from a hash. If a restricted hash has any of its keys
1617 marked as readonly and the key is subsequently deleted, the key is not actually
1618 deleted but is marked by assigning it a value of &PL_sv_placeholder. This tags
1619 it so it will be ignored by future operations such as iterating over the hash,
1620 but will still allow the hash to have a value reassigned to the key at some
1621 future point. This function clears any such placeholder keys from the hash.
1622 See Hash::Util::lock_keys() for an example of its use.
1624 void hv_clear_placeholders(HV* hb)
1632 Deletes a key/value pair in the hash. The value SV is removed from the
1633 hash and returned to the caller. The C<klen> is the length of the key.
1634 The C<flags> value will normally be zero; if set to G_DISCARD then NULL
1637 SV* hv_delete(HV* tb, const char* key, I32 klen, I32 flags)
1645 Deletes a key/value pair in the hash. The value SV is removed from the
1646 hash and returned to the caller. The C<flags> value will normally be zero;
1647 if set to G_DISCARD then NULL will be returned. C<hash> can be a valid
1648 precomputed hash value, or 0 to ask for it to be computed.
1650 SV* hv_delete_ent(HV* tb, SV* key, I32 flags, U32 hash)
1658 Returns a boolean indicating whether the specified hash key exists. The
1659 C<klen> is the length of the key.
1661 bool hv_exists(HV* tb, const char* key, I32 klen)
1669 Returns a boolean indicating whether the specified hash key exists. C<hash>
1670 can be a valid precomputed hash value, or 0 to ask for it to be
1673 bool hv_exists_ent(HV* tb, SV* key, U32 hash)
1681 Returns the SV which corresponds to the specified key in the hash. The
1682 C<klen> is the length of the key. If C<lval> is set then the fetch will be
1683 part of a store. Check that the return value is non-null before
1684 dereferencing it to an C<SV*>.
1686 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1687 information on how to use this function on tied hashes.
1689 SV** hv_fetch(HV* tb, const char* key, I32 klen, I32 lval)
1697 Like C<hv_fetch>, but takes a literal string instead of a string/length pair.
1699 SV** hv_fetchs(HV* tb, const char* key, I32 lval)
1702 Found in file handy.h
1707 Returns the hash entry which corresponds to the specified key in the hash.
1708 C<hash> must be a valid precomputed hash number for the given C<key>, or 0
1709 if you want the function to compute it. IF C<lval> is set then the fetch
1710 will be part of a store. Make sure the return value is non-null before
1711 accessing it. The return value when C<tb> is a tied hash is a pointer to a
1712 static location, so be sure to make a copy of the structure if you need to
1715 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1716 information on how to use this function on tied hashes.
1718 HE* hv_fetch_ent(HV* tb, SV* key, I32 lval, U32 hash)
1726 Prepares a starting point to traverse a hash table. Returns the number of
1727 keys in the hash (i.e. the same as C<HvKEYS(tb)>). The return value is
1728 currently only meaningful for hashes without tie magic.
1730 NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
1731 hash buckets that happen to be in use. If you still need that esoteric
1732 value, you can get it through the macro C<HvFILL(tb)>.
1735 I32 hv_iterinit(HV* tb)
1743 Returns the key from the current position of the hash iterator. See
1746 char* hv_iterkey(HE* entry, I32* retlen)
1754 Returns the key as an C<SV*> from the current position of the hash
1755 iterator. The return value will always be a mortal copy of the key. Also
1758 SV* hv_iterkeysv(HE* entry)
1766 Returns entries from a hash iterator. See C<hv_iterinit>.
1768 You may call C<hv_delete> or C<hv_delete_ent> on the hash entry that the
1769 iterator currently points to, without losing your place or invalidating your
1770 iterator. Note that in this case the current entry is deleted from the hash
1771 with your iterator holding the last reference to it. Your iterator is flagged
1772 to free the entry on the next call to C<hv_iternext>, so you must not discard
1773 your iterator immediately else the entry will leak - call C<hv_iternext> to
1774 trigger the resource deallocation.
1776 HE* hv_iternext(HV* tb)
1784 Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
1787 SV* hv_iternextsv(HV* hv, char** key, I32* retlen)
1792 =item hv_iternext_flags
1793 X<hv_iternext_flags>
1795 Returns entries from a hash iterator. See C<hv_iterinit> and C<hv_iternext>.
1796 The C<flags> value will normally be zero; if HV_ITERNEXT_WANTPLACEHOLDERS is
1797 set the placeholders keys (for restricted hashes) will be returned in addition
1798 to normal keys. By default placeholders are automatically skipped over.
1799 Currently a placeholder is implemented with a value that is
1800 C<&Perl_sv_placeholder>. Note that the implementation of placeholders and
1801 restricted hashes may change, and the implementation currently is
1802 insufficiently abstracted for any change to be tidy.
1804 NOTE: this function is experimental and may change or be
1805 removed without notice.
1807 HE* hv_iternext_flags(HV* tb, I32 flags)
1815 Returns the value from the current position of the hash iterator. See
1818 SV* hv_iterval(HV* tb, HE* entry)
1826 Adds magic to a hash. See C<sv_magic>.
1828 void hv_magic(HV* hv, GV* gv, int how)
1836 Evaluates the hash in scalar context and returns the result. Handles magic when the hash is tied.
1838 SV* hv_scalar(HV* hv)
1846 Stores an SV in a hash. The hash key is specified as C<key> and C<klen> is
1847 the length of the key. The C<hash> parameter is the precomputed hash
1848 value; if it is zero then Perl will compute it. The return value will be
1849 NULL if the operation failed or if the value did not need to be actually
1850 stored within the hash (as in the case of tied hashes). Otherwise it can
1851 be dereferenced to get the original C<SV*>. Note that the caller is
1852 responsible for suitably incrementing the reference count of C<val> before
1853 the call, and decrementing it if the function returned NULL. Effectively
1854 a successful hv_store takes ownership of one reference to C<val>. This is
1855 usually what you want; a newly created SV has a reference count of one, so
1856 if all your code does is create SVs then store them in a hash, hv_store
1857 will own the only reference to the new SV, and your code doesn't need to do
1858 anything further to tidy up. hv_store is not implemented as a call to
1859 hv_store_ent, and does not create a temporary SV for the key, so if your
1860 key data is not already in SV form then use hv_store in preference to
1863 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1864 information on how to use this function on tied hashes.
1866 SV** hv_store(HV* tb, const char* key, I32 klen, SV* val, U32 hash)
1874 Like C<hv_store>, but takes a literal string instead of a string/length pair
1875 and omits the hash parameter.
1877 SV** hv_stores(HV* tb, const char* key, NULLOK SV* val)
1880 Found in file handy.h
1885 Stores C<val> in a hash. The hash key is specified as C<key>. The C<hash>
1886 parameter is the precomputed hash value; if it is zero then Perl will
1887 compute it. The return value is the new hash entry so created. It will be
1888 NULL if the operation failed or if the value did not need to be actually
1889 stored within the hash (as in the case of tied hashes). Otherwise the
1890 contents of the return value can be accessed using the C<He?> macros
1891 described here. Note that the caller is responsible for suitably
1892 incrementing the reference count of C<val> before the call, and
1893 decrementing it if the function returned NULL. Effectively a successful
1894 hv_store_ent takes ownership of one reference to C<val>. This is
1895 usually what you want; a newly created SV has a reference count of one, so
1896 if all your code does is create SVs then store them in a hash, hv_store
1897 will own the only reference to the new SV, and your code doesn't need to do
1898 anything further to tidy up. Note that hv_store_ent only reads the C<key>;
1899 unlike C<val> it does not take ownership of it, so maintaining the correct
1900 reference count on C<key> is entirely the caller's responsibility. hv_store
1901 is not implemented as a call to hv_store_ent, and does not create a temporary
1902 SV for the key, so if your key data is not already in SV form then use
1903 hv_store in preference to hv_store_ent.
1905 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1906 information on how to use this function on tied hashes.
1908 HE* hv_store_ent(HV* tb, SV* key, SV* val, U32 hash)
1918 void hv_undef(HV* tb)
1926 Creates a new HV. The reference count is set to 1.
1936 =head1 Magical Functions
1943 Clear something magical that the SV represents. See C<sv_magic>.
1945 int mg_clear(SV* sv)
1953 Copies the magic from one SV to another. See C<sv_magic>.
1955 int mg_copy(SV* sv, SV* nsv, const char* key, I32 klen)
1963 Finds the magic pointer for type matching the SV. See C<sv_magic>.
1965 MAGIC* mg_find(const SV* sv, int type)
1973 Free any magic storage used by the SV. See C<sv_magic>.
1983 Do magic after a value is retrieved from the SV. See C<sv_magic>.
1993 Report on the SV's length. See C<sv_magic>.
1995 U32 mg_length(SV* sv)
2003 Turns on the magical status of an SV. See C<sv_magic>.
2005 void mg_magical(SV* sv)
2013 Do magic after a value is assigned to the SV. See C<sv_magic>.
2023 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
2024 argument more than once.
2026 void SvGETMAGIC(SV* sv)
2034 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
2045 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
2046 argument more than once.
2048 void SvSETMAGIC(SV* sv)
2056 Like C<SvSetSV>, but does any set magic required afterwards.
2058 void SvSetMagicSV(SV* dsb, SV* ssv)
2063 =item SvSetMagicSV_nosteal
2064 X<SvSetMagicSV_nosteal>
2066 Like C<SvSetSV_nosteal>, but does any set magic required afterwards.
2068 void SvSetMagicSV_nosteal(SV* dsv, SV* ssv)
2076 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
2079 void SvSetSV(SV* dsb, SV* ssv)
2084 =item SvSetSV_nosteal
2087 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
2088 ssv. May evaluate arguments more than once.
2090 void SvSetSV_nosteal(SV* dsv, SV* ssv)
2098 Arranges for sv to be shared between threads if a suitable module
2101 void SvSHARE(SV* sv)
2109 Releases a mutual exclusion lock on sv if a suitable module
2112 void SvUNLOCK(SV* sv)
2120 =head1 Memory Management
2127 The XSUB-writer's interface to the C C<memcpy> function. The C<src> is the
2128 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
2129 the type. May fail on overlapping copies. See also C<Move>.
2131 void Copy(void* src, void* dest, int nitems, type)
2134 Found in file handy.h
2139 Like C<Copy> but returns dest. Useful for encouraging compilers to tail-call
2142 void * CopyD(void* src, void* dest, int nitems, type)
2145 Found in file handy.h
2150 The XSUB-writer's interface to the C C<memmove> function. The C<src> is the
2151 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
2152 the type. Can do overlapping moves. See also C<Copy>.
2154 void Move(void* src, void* dest, int nitems, type)
2157 Found in file handy.h
2162 Like C<Move> but returns dest. Useful for encouraging compilers to tail-call
2165 void * MoveD(void* src, void* dest, int nitems, type)
2168 Found in file handy.h
2173 The XSUB-writer's interface to the C C<malloc> function.
2175 In 5.9.3, Newx() and friends replace the older New() API, and drops
2176 the first parameter, I<x>, a debug aid which allowed callers to identify
2177 themselves. This aid has been superseded by a new build option,
2178 PERL_MEM_LOG (see L<perlhack/PERL_MEM_LOG>). The older API is still
2179 there for use in XS modules supporting older perls.
2181 void Newx(void* ptr, int nitems, type)
2184 Found in file handy.h
2189 The XSUB-writer's interface to the C C<malloc> function, with
2190 cast. See also C<Newx>.
2192 void Newxc(void* ptr, int nitems, type, cast)
2195 Found in file handy.h
2200 The XSUB-writer's interface to the C C<malloc> function. The allocated
2201 memory is zeroed with C<memzero>. See also C<Newx>.
2203 void Newxz(void* ptr, int nitems, type)
2206 Found in file handy.h
2211 PoisonWith(0xEF) for catching access to freed memory.
2213 void Poison(void* dest, int nitems, type)
2216 Found in file handy.h
2221 PoisonWith(0xEF) for catching access to freed memory.
2223 void PoisonFree(void* dest, int nitems, type)
2226 Found in file handy.h
2231 PoisonWith(0xAB) for catching access to allocated but uninitialized memory.
2233 void PoisonNew(void* dest, int nitems, type)
2236 Found in file handy.h
2241 Fill up memory with a byte pattern (a byte repeated over and over
2242 again) that hopefully catches attempts to access uninitialized memory.
2244 void PoisonWith(void* dest, int nitems, type, U8 byte)
2247 Found in file handy.h
2252 The XSUB-writer's interface to the C C<realloc> function.
2254 void Renew(void* ptr, int nitems, type)
2257 Found in file handy.h
2262 The XSUB-writer's interface to the C C<realloc> function, with
2265 void Renewc(void* ptr, int nitems, type, cast)
2268 Found in file handy.h
2273 The XSUB-writer's interface to the C C<free> function.
2275 void Safefree(void* ptr)
2278 Found in file handy.h
2283 Perl's version of C<strdup()>. Returns a pointer to a newly allocated
2284 string which is a duplicate of C<pv>. The size of the string is
2285 determined by C<strlen()>. The memory allocated for the new string can
2286 be freed with the C<Safefree()> function.
2288 char* savepv(const char* pv)
2291 Found in file util.c
2296 Perl's version of what C<strndup()> would be if it existed. Returns a
2297 pointer to a newly allocated string which is a duplicate of the first
2298 C<len> bytes from C<pv>, plus a trailing NUL byte. The memory allocated for
2299 the new string can be freed with the C<Safefree()> function.
2301 char* savepvn(const char* pv, I32 len)
2304 Found in file util.c
2309 Like C<savepvn>, but takes a literal string instead of a string/length pair.
2311 char* savepvs(const char* s)
2314 Found in file handy.h
2319 A version of C<savepv()> which allocates the duplicate string in memory
2320 which is shared between threads.
2322 char* savesharedpv(const char* pv)
2325 Found in file util.c
2330 A version of C<savepv()>/C<savepvn()> which gets the string to duplicate from
2331 the passed in SV using C<SvPV()>
2333 char* savesvpv(SV* sv)
2336 Found in file util.c
2341 This is an architecture-independent macro to copy one structure to another.
2343 void StructCopy(type src, type dest, type)
2346 Found in file handy.h
2351 The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the
2352 destination, C<nitems> is the number of items, and C<type> is the type.
2354 void Zero(void* dest, int nitems, type)
2357 Found in file handy.h
2362 Like C<Zero> but returns dest. Useful for encouraging compilers to tail-call
2365 void * ZeroD(void* dest, int nitems, type)
2368 Found in file handy.h
2373 =head1 Miscellaneous Functions
2380 Analyses the string in order to make fast searches on it using fbm_instr()
2381 -- the Boyer-Moore algorithm.
2383 void fbm_compile(SV* sv, U32 flags)
2386 Found in file util.c
2391 Returns the location of the SV in the string delimited by C<str> and
2392 C<strend>. It returns C<NULL> if the string can't be found. The C<sv>
2393 does not have to be fbm_compiled, but the search will not be as fast
2396 char* fbm_instr(unsigned char* big, unsigned char* bigend, SV* littlesv, U32 flags)
2399 Found in file util.c
2404 Takes a sprintf-style format pattern and conventional
2405 (non-SV) arguments and returns the formatted string.
2407 (char *) Perl_form(pTHX_ const char* pat, ...)
2409 can be used any place a string (char *) is required:
2411 char * s = Perl_form("%d.%d",major,minor);
2413 Uses a single private buffer so if you want to format several strings you
2414 must explicitly copy the earlier strings away (and free the copies when you
2417 char* form(const char* pat, ...)
2420 Found in file util.c
2425 Fill the sv with current working directory
2427 int getcwd_sv(SV* sv)
2430 Found in file util.c
2435 The C library C<snprintf> functionality, if available and
2436 standards-compliant (uses C<vsnprintf>, actually). However, if the
2437 C<vsnprintf> is not available, will unfortunately use the unsafe
2438 C<vsprintf> which can overrun the buffer (there is an overrun check,
2439 but that may be too late). Consider using C<sv_vcatpvf> instead, or
2440 getting C<vsnprintf>.
2442 int my_snprintf(char *buffer, const Size_t len, const char *format, ...)
2445 Found in file util.c
2450 The C library C<sprintf>, wrapped if necessary, to ensure that it will return
2451 the length of the string written to the buffer. Only rare pre-ANSI systems
2452 need the wrapper function - usually this is a direct call to C<sprintf>.
2454 int my_sprintf(char *buffer, const char *pat, ...)
2457 Found in file util.c
2462 The C library C<vsnprintf> if available and standards-compliant.
2463 However, if if the C<vsnprintf> is not available, will unfortunately
2464 use the unsafe C<vsprintf> which can overrun the buffer (there is an
2465 overrun check, but that may be too late). Consider using
2466 C<sv_vcatpvf> instead, or getting C<vsnprintf>.
2468 int my_vsnprintf(char *buffer, const Size_t len, const char *format, va_list ap)
2471 Found in file util.c
2476 Returns a new version object based on the passed in SV:
2478 SV *sv = new_version(SV *ver);
2480 Does not alter the passed in ver SV. See "upg_version" if you
2481 want to upgrade the SV.
2483 SV* new_version(SV *ver)
2486 Found in file util.c
2491 Returns a pointer to the next character after the parsed
2492 version string, as well as upgrading the passed in SV to
2495 Function must be called with an already existing SV like
2498 s = scan_version(s,SV *sv, bool qv);
2500 Performs some preprocessing to the string to ensure that
2501 it has the correct characteristics of a version. Flags the
2502 object if it contains an underscore (which denotes this
2503 is a alpha version). The boolean qv denotes that the version
2504 should be interpreted as if it had multiple decimals, even if
2507 const char* scan_version(const char *vstr, SV *sv, bool qv)
2510 Found in file util.c
2515 Test two strings to see if they are equal. Returns true or false.
2517 bool strEQ(char* s1, char* s2)
2520 Found in file handy.h
2525 Test two strings to see if the first, C<s1>, is greater than or equal to
2526 the second, C<s2>. Returns true or false.
2528 bool strGE(char* s1, char* s2)
2531 Found in file handy.h
2536 Test two strings to see if the first, C<s1>, is greater than the second,
2537 C<s2>. Returns true or false.
2539 bool strGT(char* s1, char* s2)
2542 Found in file handy.h
2547 Test two strings to see if the first, C<s1>, is less than or equal to the
2548 second, C<s2>. Returns true or false.
2550 bool strLE(char* s1, char* s2)
2553 Found in file handy.h
2558 Test two strings to see if the first, C<s1>, is less than the second,
2559 C<s2>. Returns true or false.
2561 bool strLT(char* s1, char* s2)
2564 Found in file handy.h
2569 Test two strings to see if they are different. Returns true or
2572 bool strNE(char* s1, char* s2)
2575 Found in file handy.h
2580 Test two strings to see if they are equal. The C<len> parameter indicates
2581 the number of bytes to compare. Returns true or false. (A wrapper for
2584 bool strnEQ(char* s1, char* s2, STRLEN len)
2587 Found in file handy.h
2592 Test two strings to see if they are different. The C<len> parameter
2593 indicates the number of bytes to compare. Returns true or false. (A
2594 wrapper for C<strncmp>).
2596 bool strnNE(char* s1, char* s2, STRLEN len)
2599 Found in file handy.h
2604 Dummy routine which "shares" an SV when there is no sharing module present.
2605 Or "locks" it. Or "unlocks" it. In other words, ignores its single SV argument.
2606 Exists to avoid test for a NULL function pointer and because it could
2607 potentially warn under some level of strict-ness.
2609 void sv_nosharing(SV *sv)
2612 Found in file util.c
2617 In-place upgrade of the supplied SV to a version object.
2619 SV *sv = upg_version(SV *sv);
2621 Returns a pointer to the upgraded SV.
2623 SV* upg_version(SV *ver)
2626 Found in file util.c
2631 Version object aware cmp. Both operands must already have been
2632 converted into version objects.
2634 int vcmp(SV *lvs, SV *rvs)
2637 Found in file util.c
2642 Accepts a version object and returns the normalized string
2643 representation. Call like:
2647 NOTE: you can pass either the object directly or the SV
2648 contained within the RV.
2653 Found in file util.c
2658 Accepts a version object and returns the normalized floating
2659 point representation. Call like:
2663 NOTE: you can pass either the object directly or the SV
2664 contained within the RV.
2669 Found in file util.c
2674 In order to maintain maximum compatibility with earlier versions
2675 of Perl, this function will return either the floating point
2676 notation or the multiple dotted notation, depending on whether
2677 the original version contained 1 or more dots, respectively
2679 SV* vstringify(SV *vs)
2682 Found in file util.c
2687 Validates that the SV contains a valid version object.
2689 bool vverify(SV *vobj);
2691 Note that it only confirms the bare minimum structure (so as not to get
2692 confused by derived classes which may contain additional hash entries):
2694 bool vverify(SV *vs)
2697 Found in file util.c
2702 =head1 Multicall Functions
2709 Declare local variables for a multicall. See L<perlcall/Lightweight Callbacks>.
2719 Make a lightweight callback. See L<perlcall/Lightweight Callbacks>.
2729 Closing bracket for a lightweight callback.
2730 See L<perlcall/Lightweight Callbacks>.
2737 =item PUSH_MULTICALL
2740 Opening bracket for a lightweight callback.
2741 See L<perlcall/Lightweight Callbacks>.
2751 =head1 Numeric functions
2758 converts a string representing a binary number to numeric form.
2760 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2761 conversion flags, and I<result> should be NULL or a pointer to an NV.
2762 The scan stops at the end of the string, or the first invalid character.
2763 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2764 invalid character will also trigger a warning.
2765 On return I<*len> is set to the length of the scanned string,
2766 and I<*flags> gives output flags.
2768 If the value is <= C<UV_MAX> it is returned as a UV, the output flags are clear,
2769 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_bin>
2770 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2771 and writes the value to I<*result> (or the value is discarded if I<result>
2774 The binary number may optionally be prefixed with "0b" or "b" unless
2775 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
2776 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the binary
2777 number may use '_' characters to separate digits.
2779 UV grok_bin(const char* start, STRLEN* len_p, I32* flags, NV *result)
2782 Found in file numeric.c
2787 converts a string representing a hex number to numeric form.
2789 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2790 conversion flags, and I<result> should be NULL or a pointer to an NV.
2791 The scan stops at the end of the string, or the first invalid character.
2792 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2793 invalid character will also trigger a warning.
2794 On return I<*len> is set to the length of the scanned string,
2795 and I<*flags> gives output flags.
2797 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2798 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_hex>
2799 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2800 and writes the value to I<*result> (or the value is discarded if I<result>
2803 The hex number may optionally be prefixed with "0x" or "x" unless
2804 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
2805 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the hex
2806 number may use '_' characters to separate digits.
2808 UV grok_hex(const char* start, STRLEN* len_p, I32* flags, NV *result)
2811 Found in file numeric.c
2816 Recognise (or not) a number. The type of the number is returned
2817 (0 if unrecognised), otherwise it is a bit-ORed combination of
2818 IS_NUMBER_IN_UV, IS_NUMBER_GREATER_THAN_UV_MAX, IS_NUMBER_NOT_INT,
2819 IS_NUMBER_NEG, IS_NUMBER_INFINITY, IS_NUMBER_NAN (defined in perl.h).
2821 If the value of the number can fit an in UV, it is returned in the *valuep
2822 IS_NUMBER_IN_UV will be set to indicate that *valuep is valid, IS_NUMBER_IN_UV
2823 will never be set unless *valuep is valid, but *valuep may have been assigned
2824 to during processing even though IS_NUMBER_IN_UV is not set on return.
2825 If valuep is NULL, IS_NUMBER_IN_UV will be set for the same cases as when
2826 valuep is non-NULL, but no actual assignment (or SEGV) will occur.
2828 IS_NUMBER_NOT_INT will be set with IS_NUMBER_IN_UV if trailing decimals were
2829 seen (in which case *valuep gives the true value truncated to an integer), and
2830 IS_NUMBER_NEG if the number is negative (in which case *valuep holds the
2831 absolute value). IS_NUMBER_IN_UV is not set if e notation was used or the
2832 number is larger than a UV.
2834 int grok_number(const char *pv, STRLEN len, UV *valuep)
2837 Found in file numeric.c
2839 =item grok_numeric_radix
2840 X<grok_numeric_radix>
2842 Scan and skip for a numeric decimal separator (radix).
2844 bool grok_numeric_radix(const char **sp, const char *send)
2847 Found in file numeric.c
2852 converts a string representing an octal number to numeric form.
2854 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2855 conversion flags, and I<result> should be NULL or a pointer to an NV.
2856 The scan stops at the end of the string, or the first invalid character.
2857 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2858 invalid character will also trigger a warning.
2859 On return I<*len> is set to the length of the scanned string,
2860 and I<*flags> gives output flags.
2862 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2863 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_oct>
2864 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2865 and writes the value to I<*result> (or the value is discarded if I<result>
2868 If C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the octal
2869 number may use '_' characters to separate digits.
2871 UV grok_oct(const char* start, STRLEN* len_p, I32* flags, NV *result)
2874 Found in file numeric.c
2879 For backwards compatibility. Use C<grok_bin> instead.
2881 NV scan_bin(const char* start, STRLEN len, STRLEN* retlen)
2884 Found in file numeric.c
2889 For backwards compatibility. Use C<grok_hex> instead.
2891 NV scan_hex(const char* start, STRLEN len, STRLEN* retlen)
2894 Found in file numeric.c
2899 For backwards compatibility. Use C<grok_oct> instead.
2901 NV scan_oct(const char* start, STRLEN len, STRLEN* retlen)
2904 Found in file numeric.c
2909 =head1 Optree Manipulation Functions
2916 If C<cv> is a constant sub eligible for inlining. returns the constant
2917 value returned by the sub. Otherwise, returns NULL.
2919 Constant subs can be created with C<newCONSTSUB> or as described in
2920 L<perlsub/"Constant Functions">.
2922 SV* cv_const_sv(CV* cv)
2930 Creates a constant sub equivalent to Perl C<sub FOO () { 123 }> which is
2931 eligible for inlining at compile-time.
2933 CV* newCONSTSUB(HV* stash, const char* name, SV* sv)
2941 Used by C<xsubpp> to hook up XSUBs as Perl subs. I<filename> needs to be
2942 static storage, as it is used directly as CvFILE(), without a copy being made.
2950 =head1 Pad Data Structures
2957 Get the value at offset po in the current pad.
2958 Use macro PAD_SV instead of calling this function directly.
2960 SV* pad_sv(PADOFFSET po)
2968 =head1 Simple Exception Handling Macros
2975 Set up necessary local variables for exception handling.
2976 See L<perlguts/"Exception Handling">.
2981 Found in file XSUB.h
2986 Introduces a catch block. See L<perlguts/"Exception Handling">.
2989 Found in file XSUB.h
2994 Rethrows a previously caught exception. See L<perlguts/"Exception Handling">.
2999 Found in file XSUB.h
3004 Ends a try block. See L<perlguts/"Exception Handling">.
3007 Found in file XSUB.h
3009 =item XCPT_TRY_START
3012 Starts a try block. See L<perlguts/"Exception Handling">.
3015 Found in file XSUB.h
3020 =head1 Stack Manipulation Macros
3027 Declare a stack marker variable, C<mark>, for the XSUB. See C<MARK> and
3038 Saves the original stack mark for the XSUB. See C<ORIGMARK>.
3048 Declares a local copy of perl's stack pointer for the XSUB, available via
3049 the C<SP> macro. See C<SP>.
3059 Used to extend the argument stack for an XSUB's return values. Once
3060 used, guarantees that there is room for at least C<nitems> to be pushed
3063 void EXTEND(SP, int nitems)
3071 Stack marker variable for the XSUB. See C<dMARK>.
3079 Push an integer onto the stack. The stack must have room for this element.
3080 Handles 'set' magic. Does not use C<TARG>. See also C<PUSHi>, C<mXPUSHi>
3091 Push a double onto the stack. The stack must have room for this element.
3092 Handles 'set' magic. Does not use C<TARG>. See also C<PUSHn>, C<mXPUSHn>
3103 Push a string onto the stack. The stack must have room for this element.
3104 The C<len> indicates the length of the string. Handles 'set' magic. Does
3105 not use C<TARG>. See also C<PUSHp>, C<mXPUSHp> and C<XPUSHp>.
3107 void mPUSHp(char* str, STRLEN len)
3115 Push an unsigned integer onto the stack. The stack must have room for this
3116 element. Handles 'set' magic. Does not use C<TARG>. See also C<PUSHu>,
3117 C<mXPUSHu> and C<XPUSHu>.
3127 Push an integer onto the stack, extending the stack if necessary. Handles
3128 'set' magic. Does not use C<TARG>. See also C<XPUSHi>, C<mPUSHi> and
3139 Push a double onto the stack, extending the stack if necessary. Handles
3140 'set' magic. Does not use C<TARG>. See also C<XPUSHn>, C<mPUSHn> and
3151 Push a string onto the stack, extending the stack if necessary. The C<len>
3152 indicates the length of the string. Handles 'set' magic. Does not use
3153 C<TARG>. See also C<XPUSHp>, C<mPUSHp> and C<PUSHp>.
3155 void mXPUSHp(char* str, STRLEN len)
3163 Push an unsigned integer onto the stack, extending the stack if necessary.
3164 Handles 'set' magic. Does not use C<TARG>. See also C<XPUSHu>, C<mPUSHu>
3175 The original stack mark for the XSUB. See C<dORIGMARK>.
3183 Pops an integer off the stack.
3193 Pops a long off the stack.
3203 Pops a double off the stack.
3213 Pops a string off the stack. Deprecated. New code should use POPpx.
3223 Pops a string off the stack which must consist of bytes i.e. characters < 256.
3233 Pops a string off the stack.
3243 Pops an SV off the stack.
3253 Push an integer onto the stack. The stack must have room for this element.
3254 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3255 called to declare it. Do not call multiple C<TARG>-oriented macros to
3256 return lists from XSUB's - see C<mPUSHi> instead. See also C<XPUSHi> and
3267 Opening bracket for arguments on a callback. See C<PUTBACK> and
3278 Push a new mortal SV onto the stack. The stack must have room for this
3279 element. Does not handle 'set' magic. Does not use C<TARG>. See also
3280 C<PUSHs>, C<XPUSHmortal> and C<XPUSHs>.
3290 Push a double onto the stack. The stack must have room for this element.
3291 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3292 called to declare it. Do not call multiple C<TARG>-oriented macros to
3293 return lists from XSUB's - see C<mPUSHn> instead. See also C<XPUSHn> and
3304 Push a string onto the stack. The stack must have room for this element.
3305 The C<len> indicates the length of the string. Handles 'set' magic. Uses
3306 C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to declare it. Do not
3307 call multiple C<TARG>-oriented macros to return lists from XSUB's - see
3308 C<mPUSHp> instead. See also C<XPUSHp> and C<mXPUSHp>.
3310 void PUSHp(char* str, STRLEN len)
3318 Push an SV onto the stack. The stack must have room for this element.
3319 Does not handle 'set' magic. Does not use C<TARG>. See also C<PUSHmortal>,
3320 C<XPUSHs> and C<XPUSHmortal>.
3330 Push an unsigned integer onto the stack. The stack must have room for this
3331 element. Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG>
3332 should be called to declare it. Do not call multiple C<TARG>-oriented
3333 macros to return lists from XSUB's - see C<mPUSHu> instead. See also
3334 C<XPUSHu> and C<mXPUSHu>.
3344 Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
3345 See C<PUSHMARK> and L<perlcall> for other uses.
3355 Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and
3364 Refetch the stack pointer. Used after a callback. See L<perlcall>.
3374 Push an integer onto the stack, extending the stack if necessary. Handles
3375 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
3376 declare it. Do not call multiple C<TARG>-oriented macros to return lists
3377 from XSUB's - see C<mXPUSHi> instead. See also C<PUSHi> and C<mPUSHi>.
3387 Push a new mortal SV onto the stack, extending the stack if necessary. Does
3388 not handle 'set' magic. Does not use C<TARG>. See also C<XPUSHs>,
3389 C<PUSHmortal> and C<PUSHs>.
3399 Push a double onto the stack, extending the stack if necessary. Handles
3400 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
3401 declare it. Do not call multiple C<TARG>-oriented macros to return lists
3402 from XSUB's - see C<mXPUSHn> instead. See also C<PUSHn> and C<mPUSHn>.
3412 Push a string onto the stack, extending the stack if necessary. The C<len>
3413 indicates the length of the string. Handles 'set' magic. Uses C<TARG>, so
3414 C<dTARGET> or C<dXSTARG> should be called to declare it. Do not call
3415 multiple C<TARG>-oriented macros to return lists from XSUB's - see
3416 C<mXPUSHp> instead. See also C<PUSHp> and C<mPUSHp>.
3418 void XPUSHp(char* str, STRLEN len)
3426 Push an SV onto the stack, extending the stack if necessary. Does not
3427 handle 'set' magic. Does not use C<TARG>. See also C<XPUSHmortal>,
3428 C<PUSHs> and C<PUSHmortal>.
3438 Push an unsigned integer onto the stack, extending the stack if necessary.
3439 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3440 called to declare it. Do not call multiple C<TARG>-oriented macros to
3441 return lists from XSUB's - see C<mXPUSHu> instead. See also C<PUSHu> and
3452 Return from XSUB, indicating number of items on the stack. This is usually
3453 handled by C<xsubpp>.
3455 void XSRETURN(int nitems)
3458 Found in file XSUB.h
3460 =item XSRETURN_EMPTY
3463 Return an empty list from an XSUB immediately.
3468 Found in file XSUB.h
3473 Return an integer from an XSUB immediately. Uses C<XST_mIV>.
3475 void XSRETURN_IV(IV iv)
3478 Found in file XSUB.h
3483 Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
3488 Found in file XSUB.h
3493 Return a double from an XSUB immediately. Uses C<XST_mNV>.
3495 void XSRETURN_NV(NV nv)
3498 Found in file XSUB.h
3503 Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
3505 void XSRETURN_PV(char* str)
3508 Found in file XSUB.h
3510 =item XSRETURN_UNDEF
3513 Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
3518 Found in file XSUB.h
3523 Return an integer from an XSUB immediately. Uses C<XST_mUV>.
3525 void XSRETURN_UV(IV uv)
3528 Found in file XSUB.h
3533 Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
3538 Found in file XSUB.h
3543 Place an integer into the specified position C<pos> on the stack. The
3544 value is stored in a new mortal SV.
3546 void XST_mIV(int pos, IV iv)
3549 Found in file XSUB.h
3554 Place C<&PL_sv_no> into the specified position C<pos> on the
3557 void XST_mNO(int pos)
3560 Found in file XSUB.h
3565 Place a double into the specified position C<pos> on the stack. The value
3566 is stored in a new mortal SV.
3568 void XST_mNV(int pos, NV nv)
3571 Found in file XSUB.h
3576 Place a copy of a string into the specified position C<pos> on the stack.
3577 The value is stored in a new mortal SV.
3579 void XST_mPV(int pos, char* str)
3582 Found in file XSUB.h
3587 Place C<&PL_sv_undef> into the specified position C<pos> on the
3590 void XST_mUNDEF(int pos)
3593 Found in file XSUB.h
3598 Place C<&PL_sv_yes> into the specified position C<pos> on the
3601 void XST_mYES(int pos)
3604 Found in file XSUB.h
3616 An enum of flags for Perl types. These are found in the file B<sv.h>
3617 in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
3625 Integer type flag for scalars. See C<svtype>.
3633 Double type flag for scalars. See C<svtype>.
3641 Pointer type flag for scalars. See C<svtype>.
3649 Type flag for arrays. See C<svtype>.
3657 Type flag for code refs. See C<svtype>.
3665 Type flag for hashes. See C<svtype>.
3673 Type flag for blessed scalars. See C<svtype>.
3681 =head1 SV Manipulation Functions
3688 Returns the SV of the specified Perl scalar. If C<create> is set and the
3689 Perl variable does not exist then it will be created. If C<create> is not
3690 set and the variable does not exist then NULL is returned.
3692 NOTE: the perl_ form of this function is deprecated.
3694 SV* get_sv(const char* name, I32 create)
3697 Found in file perl.c
3702 Creates an RV wrapper for an SV. The reference count for the original SV is
3705 SV* newRV_inc(SV* sv)
3713 Returns the length of the string which is in the SV. See C<SvLEN>.
3715 STRLEN SvCUR(SV* sv)
3723 Set the current length of the string which is in the SV. See C<SvCUR>
3726 void SvCUR_set(SV* sv, STRLEN len)
3734 Returns a pointer to the last character in the string which is in the SV.
3735 See C<SvCUR>. Access the character as *(SvEND(sv)).
3745 Returns true if the SV has get magic or overloading. If either is true then
3746 the scalar is active data, and has the potential to return a new value every
3747 time it is accessed. Hence you must be careful to only read it once per user
3748 logical operation and work with that returned value. If neither is true then
3749 the scalar's value cannot change unless written to.
3751 char* SvGAMAGIC(SV* sv)
3759 Expands the character buffer in the SV so that it has room for the
3760 indicated number of bytes (remember to reserve space for an extra trailing
3761 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
3762 Returns a pointer to the character buffer.
3764 char * SvGROW(SV* sv, STRLEN len)
3772 Returns a U32 value indicating whether the SV contains an integer.
3782 Returns a U32 value indicating whether the SV contains an integer. Checks
3783 the B<private> setting. Use C<SvIOK>.
3793 Returns a boolean indicating whether the SV contains a signed integer.
3795 bool SvIOK_notUV(SV* sv)
3803 Unsets the IV status of an SV.
3805 void SvIOK_off(SV* sv)
3813 Tells an SV that it is an integer.
3815 void SvIOK_on(SV* sv)
3823 Tells an SV that it is an integer and disables all other OK bits.
3825 void SvIOK_only(SV* sv)
3833 Tells and SV that it is an unsigned integer and disables all other OK bits.
3835 void SvIOK_only_UV(SV* sv)
3843 Returns a boolean indicating whether the SV contains an unsigned integer.
3845 bool SvIOK_UV(SV* sv)
3853 Returns a boolean indicating whether the SV is Copy-On-Write. (either shared
3854 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
3857 bool SvIsCOW(SV* sv)
3862 =item SvIsCOW_shared_hash
3863 X<SvIsCOW_shared_hash>
3865 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
3868 bool SvIsCOW_shared_hash(SV* sv)
3876 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
3877 version which guarantees to evaluate sv only once.
3887 Returns the raw value in the SV's IV slot, without checks or conversions.
3888 Only use when you are sure SvIOK is true. See also C<SvIV()>.
3898 Coerces the given SV to an integer and returns it. Guarantees to evaluate
3899 sv only once. Use the more efficient C<SvIV> otherwise.
3909 Like C<SvIV> but doesn't process magic.
3911 IV SvIV_nomg(SV* sv)
3919 Set the value of the IV pointer in sv to val. It is possible to perform
3920 the same function of this macro with an lvalue assignment to C<SvIVX>.
3921 With future Perls, however, it will be more efficient to use
3922 C<SvIV_set> instead of the lvalue assignment to C<SvIVX>.
3924 void SvIV_set(SV* sv, IV val)
3932 Returns the size of the string buffer in the SV, not including any part
3933 attributable to C<SvOOK>. See C<SvCUR>.
3935 STRLEN SvLEN(SV* sv)
3943 Set the actual length of the string which is in the SV. See C<SvIV_set>.
3945 void SvLEN_set(SV* sv, STRLEN len)
3953 Set the value of the MAGIC pointer in sv to val. See C<SvIV_set>.
3955 void SvMAGIC_set(SV* sv, MAGIC* val)
3963 Returns a U32 value indicating whether the SV contains a number, integer or
3974 Returns a U32 value indicating whether the SV contains a number, integer or
3975 double. Checks the B<private> setting. Use C<SvNIOK>.
3985 Unsets the NV/IV status of an SV.
3987 void SvNIOK_off(SV* sv)
3995 Returns a U32 value indicating whether the SV contains a double.
4005 Returns a U32 value indicating whether the SV contains a double. Checks the
4006 B<private> setting. Use C<SvNOK>.
4016 Unsets the NV status of an SV.
4018 void SvNOK_off(SV* sv)
4026 Tells an SV that it is a double.
4028 void SvNOK_on(SV* sv)
4036 Tells an SV that it is a double and disables all other OK bits.
4038 void SvNOK_only(SV* sv)
4046 Coerce the given SV to a double and return it. See C<SvNVx> for a version
4047 which guarantees to evaluate sv only once.
4057 Returns the raw value in the SV's NV slot, without checks or conversions.
4058 Only use when you are sure SvNOK is true. See also C<SvNV()>.
4068 Coerces the given SV to a double and returns it. Guarantees to evaluate
4069 sv only once. Use the more efficient C<SvNV> otherwise.
4079 Set the value of the NV pointer in sv to val. See C<SvIV_set>.
4081 void SvNV_set(SV* sv, NV val)
4089 Returns a U32 value indicating whether the value is an SV. It also tells
4090 whether the value is defined or not.
4100 Returns a U32 indicating whether the SvIVX is a valid offset value for
4101 the SvPVX. This hack is used internally to speed up removal of characters
4102 from the beginning of a SvPV. When SvOOK is true, then the start of the
4103 allocated string buffer is really (SvPVX - SvIVX).
4113 Returns a U32 value indicating whether the SV contains a character
4124 Returns a U32 value indicating whether the SV contains a character string.
4125 Checks the B<private> setting. Use C<SvPOK>.
4135 Unsets the PV status of an SV.
4137 void SvPOK_off(SV* sv)
4145 Tells an SV that it is a string.
4147 void SvPOK_on(SV* sv)
4155 Tells an SV that it is a string and disables all other OK bits.
4156 Will also turn off the UTF-8 status.
4158 void SvPOK_only(SV* sv)
4163 =item SvPOK_only_UTF8
4166 Tells an SV that it is a string and disables all other OK bits,
4167 and leaves the UTF-8 status as it was.
4169 void SvPOK_only_UTF8(SV* sv)
4177 Returns a pointer to the string in the SV, or a stringified form of
4178 the SV if the SV does not contain a string. The SV may cache the
4179 stringified version becoming C<SvPOK>. Handles 'get' magic. See also
4180 C<SvPVx> for a version which guarantees to evaluate sv only once.
4182 char* SvPV(SV* sv, STRLEN len)
4190 Like C<SvPV>, but converts sv to byte representation first if necessary.
4192 char* SvPVbyte(SV* sv, STRLEN len)
4200 Like C<SvPV>, but converts sv to byte representation first if necessary.
4201 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
4204 char* SvPVbytex(SV* sv, STRLEN len)
4209 =item SvPVbytex_force
4212 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
4213 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
4216 char* SvPVbytex_force(SV* sv, STRLEN len)
4221 =item SvPVbyte_force
4224 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
4226 char* SvPVbyte_force(SV* sv, STRLEN len)
4231 =item SvPVbyte_nolen
4234 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
4236 char* SvPVbyte_nolen(SV* sv)
4244 Like C<SvPV>, but converts sv to utf8 first if necessary.
4246 char* SvPVutf8(SV* sv, STRLEN len)
4254 Like C<SvPV>, but converts sv to utf8 first if necessary.
4255 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
4258 char* SvPVutf8x(SV* sv, STRLEN len)
4263 =item SvPVutf8x_force
4266 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
4267 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
4270 char* SvPVutf8x_force(SV* sv, STRLEN len)
4275 =item SvPVutf8_force
4278 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
4280 char* SvPVutf8_force(SV* sv, STRLEN len)
4285 =item SvPVutf8_nolen
4288 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
4290 char* SvPVutf8_nolen(SV* sv)
4298 Returns a pointer to the physical string in the SV. The SV must contain a
4309 A version of C<SvPV> which guarantees to evaluate sv only once.
4311 char* SvPVx(SV* sv, STRLEN len)
4319 Like C<SvPV> but will force the SV into containing just a string
4320 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
4323 char* SvPV_force(SV* sv, STRLEN len)
4328 =item SvPV_force_nomg
4331 Like C<SvPV> but will force the SV into containing just a string
4332 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
4333 directly. Doesn't process magic.
4335 char* SvPV_force_nomg(SV* sv, STRLEN len)
4343 Returns a pointer to the string in the SV, or a stringified form of
4344 the SV if the SV does not contain a string. The SV may cache the
4345 stringified form becoming C<SvPOK>. Handles 'get' magic.
4347 char* SvPV_nolen(SV* sv)
4355 Like C<SvPV> but doesn't process magic.
4357 char* SvPV_nomg(SV* sv, STRLEN len)
4365 Set the value of the PV pointer in sv to val. See C<SvIV_set>.
4367 void SvPV_set(SV* sv, char* val)
4375 Returns the value of the object's reference count.
4377 U32 SvREFCNT(SV* sv)
4385 Decrements the reference count of the given SV.
4387 void SvREFCNT_dec(SV* sv)
4395 Increments the reference count of the given SV.
4397 All of the following SvREFCNT_inc* macros are optimized versions of
4398 SvREFCNT_inc, and can be replaced with SvREFCNT_inc.
4400 SV* SvREFCNT_inc(SV* sv)
4405 =item SvREFCNT_inc_NN
4408 Same as SvREFCNT_inc, but can only be used if you know I<sv>
4409 is not NULL. Since we don't have to check the NULLness, it's faster
4412 SV* SvREFCNT_inc_NN(SV* sv)
4417 =item SvREFCNT_inc_simple
4418 X<SvREFCNT_inc_simple>
4420 Same as SvREFCNT_inc, but can only be used with simple variables, not
4421 expressions or pointer dereferences. Since we don't have to store a
4422 temporary value, it's faster.
4424 SV* SvREFCNT_inc_simple(SV* sv)
4429 =item SvREFCNT_inc_simple_NN
4430 X<SvREFCNT_inc_simple_NN>
4432 Same as SvREFCNT_inc_simple, but can only be used if you know I<sv>
4433 is not NULL. Since we don't have to check the NULLness, it's faster
4436 SV* SvREFCNT_inc_simple_NN(SV* sv)
4441 =item SvREFCNT_inc_simple_void
4442 X<SvREFCNT_inc_simple_void>
4444 Same as SvREFCNT_inc_simple, but can only be used if you don't need the
4445 return value. The macro doesn't need to return a meaningful value.
4447 void SvREFCNT_inc_simple_void(SV* sv)
4452 =item SvREFCNT_inc_simple_void_NN
4453 X<SvREFCNT_inc_simple_void_NN>
4455 Same as SvREFCNT_inc, but can only be used if you don't need the return
4456 value, and you know that I<sv> is not NULL. The macro doesn't need
4457 to return a meaningful value, or check for NULLness, so it's smaller
4460 void SvREFCNT_inc_simple_void_NN(SV* sv)
4465 =item SvREFCNT_inc_void
4466 X<SvREFCNT_inc_void>
4468 Same as SvREFCNT_inc, but can only be used if you don't need the
4469 return value. The macro doesn't need to return a meaningful value.
4471 void SvREFCNT_inc_void(SV* sv)
4476 =item SvREFCNT_inc_void_NN
4477 X<SvREFCNT_inc_void_NN>
4479 Same as SvREFCNT_inc, but can only be used if you don't need the return
4480 value, and you know that I<sv> is not NULL. The macro doesn't need
4481 to return a meaningful value, or check for NULLness, so it's smaller
4484 void SvREFCNT_inc_void_NN(SV* sv)
4492 Tests if the SV is an RV.
4502 Unsets the RV status of an SV.
4504 void SvROK_off(SV* sv)
4512 Tells an SV that it is an RV.
4514 void SvROK_on(SV* sv)
4522 Dereferences an RV to return the SV.
4532 Set the value of the RV pointer in sv to val. See C<SvIV_set>.
4534 void SvRV_set(SV* sv, SV* val)
4542 Returns the stash of the SV.
4552 Set the value of the STASH pointer in sv to val. See C<SvIV_set>.
4554 void SvSTASH_set(SV* sv, HV* val)
4562 Taints an SV if tainting is enabled.
4564 void SvTAINT(SV* sv)
4572 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
4575 bool SvTAINTED(SV* sv)
4583 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
4584 some of Perl's fundamental security features. XS module authors should not
4585 use this function unless they fully understand all the implications of
4586 unconditionally untainting the value. Untainting should be done in the
4587 standard perl fashion, via a carefully crafted regexp, rather than directly
4588 untainting variables.
4590 void SvTAINTED_off(SV* sv)
4598 Marks an SV as tainted if tainting is enabled.
4600 void SvTAINTED_on(SV* sv)
4608 Returns a boolean indicating whether Perl would evaluate the SV as true or
4609 false, defined or undefined. Does not handle 'get' magic.
4619 Returns the type of the SV. See C<svtype>.
4621 svtype SvTYPE(SV* sv)
4629 Returns a boolean indicating whether the SV contains an unsigned integer.
4639 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
4640 perform the upgrade if necessary. See C<svtype>.
4642 void SvUPGRADE(SV* sv, svtype type)
4650 Returns a U32 value indicating whether the SV contains UTF-8 encoded data.
4651 Call this after SvPV() in case any call to string overloading updates the
4662 Unsets the UTF-8 status of an SV.
4664 void SvUTF8_off(SV *sv)
4672 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
4673 Do not use frivolously.
4675 void SvUTF8_on(SV *sv)
4683 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
4684 for a version which guarantees to evaluate sv only once.
4694 Returns the raw value in the SV's UV slot, without checks or conversions.
4695 Only use when you are sure SvIOK is true. See also C<SvUV()>.
4705 Coerces the given SV to an unsigned integer and returns it. Guarantees to
4706 evaluate sv only once. Use the more efficient C<SvUV> otherwise.
4716 Like C<SvUV> but doesn't process magic.
4718 UV SvUV_nomg(SV* sv)
4726 Set the value of the UV pointer in sv to val. See C<SvIV_set>.
4728 void SvUV_set(SV* sv, UV val)
4736 Returns a boolean indicating whether the SV contains a v-string.
4743 =item sv_catpvn_nomg
4746 Like C<sv_catpvn> but doesn't process magic.
4748 void sv_catpvn_nomg(SV* sv, const char* ptr, STRLEN len)
4756 Like C<sv_catsv> but doesn't process magic.
4758 void sv_catsv_nomg(SV* dsv, SV* ssv)
4763 =item sv_derived_from
4766 Returns a boolean indicating whether the SV is derived from the specified class
4767 I<at the C level>. To check derivation at the Perl level, call C<isa()> as a
4770 bool sv_derived_from(SV* sv, const char* name)
4773 Found in file universal.c
4778 Returns a boolean indicating whether the SV performs a specific, named role.
4779 The SV can be a Perl object or the name of a Perl class.
4781 bool sv_does(SV* sv, const char* name)
4784 Found in file universal.c
4786 =item sv_report_used
4789 Dump the contents of all SVs not yet freed. (Debugging aid).
4791 void sv_report_used()
4799 Like C<sv_setsv> but doesn't process magic.
4801 void sv_setsv_nomg(SV* dsv, SV* ssv)
4809 =head1 SV-Body Allocation
4813 =item looks_like_number
4814 X<looks_like_number>
4816 Test if the content of an SV looks like a number (or is a number).
4817 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
4818 non-numeric warning), even if your atof() doesn't grok them.
4820 I32 looks_like_number(SV* sv)
4828 Creates an RV wrapper for an SV. The reference count for the original
4829 SV is B<not> incremented.
4831 SV* newRV_noinc(SV* sv)
4839 Creates a new SV. A non-zero C<len> parameter indicates the number of
4840 bytes of preallocated string space the SV should have. An extra byte for a
4841 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4842 space is allocated.) The reference count for the new SV is set to 1.
4844 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4845 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4846 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4847 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4848 modules supporting older perls.
4850 SV* newSV(STRLEN len)
4858 Creates a new SV from the hash key structure. It will generate scalars that
4859 point to the shared string table where possible. Returns a new (undefined)
4860 SV if the hek is NULL.
4862 SV* newSVhek(const HEK *hek)
4870 Creates a new SV and copies an integer into it. The reference count for the
4881 Creates a new SV and copies a floating point value into it.
4882 The reference count for the SV is set to 1.
4892 Creates a new SV and copies a string into it. The reference count for the
4893 SV is set to 1. If C<len> is zero, Perl will compute the length using
4894 strlen(). For efficiency, consider using C<newSVpvn> instead.
4896 SV* newSVpv(const char* s, STRLEN len)
4904 Creates a new SV and initializes it with the string formatted like
4907 SV* newSVpvf(const char* pat, ...)
4915 Creates a new SV and copies a string into it. The reference count for the
4916 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
4917 string. You are responsible for ensuring that the source string is at least
4918 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
4920 SV* newSVpvn(const char* s, STRLEN len)
4925 =item newSVpvn_share
4928 Creates a new SV with its SvPVX_const pointing to a shared string in the string
4929 table. If the string does not already exist in the table, it is created
4930 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
4931 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
4932 otherwise the hash is computed. The idea here is that as the string table
4933 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
4934 hash lookup will avoid string compare.
4936 SV* newSVpvn_share(const char* s, I32 len, U32 hash)
4944 Like C<newSVpvn>, but takes a literal string instead of a string/length pair.
4946 SV* newSVpvs(const char* s)
4949 Found in file handy.h
4951 =item newSVpvs_share
4954 Like C<newSVpvn_share>, but takes a literal string instead of a string/length
4955 pair and omits the hash parameter.
4957 SV* newSVpvs_share(const char* s)
4960 Found in file handy.h
4965 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
4966 it will be upgraded to one. If C<classname> is non-null then the new SV will
4967 be blessed in the specified package. The new SV is returned and its
4968 reference count is 1.
4970 SV* newSVrv(SV* rv, const char* classname)
4978 Creates a new SV which is an exact duplicate of the original SV.
4981 SV* newSVsv(SV* old)
4989 Creates a new SV and copies an unsigned integer into it.
4990 The reference count for the SV is set to 1.
5000 This function is only called on magical items, and is only used by
5001 sv_true() or its macro equivalent.
5003 bool sv_2bool(SV* sv)
5011 Using various gambits, try to get a CV from an SV; in addition, try if
5012 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
5013 The flags in C<lref> are passed to sv_fetchsv.
5015 CV* sv_2cv(SV* sv, HV** st, GV** gvp, I32 lref)
5023 Using various gambits, try to get an IO from an SV: the IO slot if its a
5024 GV; or the recursive result if we're an RV; or the IO slot of the symbol
5025 named after the PV if we're a string.
5035 Return the integer value of an SV, doing any necessary string
5036 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
5037 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
5039 IV sv_2iv_flags(SV* sv, I32 flags)
5047 Marks an existing SV as mortal. The SV will be destroyed "soon", either
5048 by an explicit call to FREETMPS, or by an implicit call at places such as
5049 statement boundaries. SvTEMP() is turned on which means that the SV's
5050 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
5051 and C<sv_mortalcopy>.
5053 SV* sv_2mortal(SV* sv)
5061 Return the num value of an SV, doing any necessary string or integer
5062 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
5073 Return a pointer to the byte-encoded representation of the SV, and set *lp
5074 to its length. May cause the SV to be downgraded from UTF-8 as a
5077 Usually accessed via the C<SvPVbyte> macro.
5079 char* sv_2pvbyte(SV* sv, STRLEN* lp)
5087 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
5088 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
5090 Usually accessed via the C<SvPVutf8> macro.
5092 char* sv_2pvutf8(SV* sv, STRLEN* lp)
5100 Returns a pointer to the string value of an SV, and sets *lp to its length.
5101 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
5103 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
5104 usually end up here too.
5106 char* sv_2pv_flags(SV* sv, STRLEN* lp, I32 flags)
5114 Return the unsigned integer value of an SV, doing any necessary string
5115 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
5116 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
5118 UV sv_2uv_flags(SV* sv, I32 flags)
5126 Remove any string offset. You should normally use the C<SvOOK_off> macro
5129 int sv_backoff(SV* sv)
5137 Blesses an SV into a specified package. The SV must be an RV. The package
5138 must be designated by its stash (see C<gv_stashpv()>). The reference count
5139 of the SV is unaffected.
5141 SV* sv_bless(SV* sv, HV* stash)
5149 Concatenates the string onto the end of the string which is in the SV.
5150 If the SV has the UTF-8 status set, then the bytes appended should be
5151 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
5153 void sv_catpv(SV* sv, const char* ptr)
5161 Processes its arguments like C<sprintf> and appends the formatted
5162 output to an SV. If the appended data contains "wide" characters
5163 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
5164 and characters >255 formatted with %c), the original SV might get
5165 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
5166 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
5167 valid UTF-8; if the original SV was bytes, the pattern should be too.
5169 void sv_catpvf(SV* sv, const char* pat, ...)
5177 Like C<sv_catpvf>, but also handles 'set' magic.
5179 void sv_catpvf_mg(SV *sv, const char* pat, ...)
5187 Concatenates the string onto the end of the string which is in the SV. The
5188 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5189 status set, then the bytes appended should be valid UTF-8.
5190 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
5192 void sv_catpvn(SV* sv, const char* ptr, STRLEN len)
5197 =item sv_catpvn_flags
5200 Concatenates the string onto the end of the string which is in the SV. The
5201 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5202 status set, then the bytes appended should be valid UTF-8.
5203 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
5204 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
5205 in terms of this function.
5207 void sv_catpvn_flags(SV* sv, const char* ptr, STRLEN len, I32 flags)
5215 Like C<sv_catpvn>, but takes a literal string instead of a string/length pair.
5217 void sv_catpvs(SV* sv, const char* s)
5220 Found in file handy.h
5225 Like C<sv_catpv>, but also handles 'set' magic.
5227 void sv_catpv_mg(SV *sv, const char *ptr)
5235 Concatenates the string from SV C<ssv> onto the end of the string in
5236 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
5237 not 'set' magic. See C<sv_catsv_mg>.
5239 void sv_catsv(SV* dsv, SV* ssv)
5244 =item sv_catsv_flags
5247 Concatenates the string from SV C<ssv> onto the end of the string in
5248 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
5249 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
5250 and C<sv_catsv_nomg> are implemented in terms of this function.
5252 void sv_catsv_flags(SV* dsv, SV* ssv, I32 flags)
5260 Efficient removal of characters from the beginning of the string buffer.
5261 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
5262 the string buffer. The C<ptr> becomes the first character of the adjusted
5263 string. Uses the "OOK hack".
5264 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
5265 refer to the same chunk of data.
5267 void sv_chop(SV* sv, const char* ptr)
5275 Clear an SV: call any destructors, free up any memory used by the body,
5276 and free the body itself. The SV's head is I<not> freed, although
5277 its type is set to all 1's so that it won't inadvertently be assumed
5278 to be live during global destruction etc.
5279 This function should only be called when REFCNT is zero. Most of the time
5280 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5283 void sv_clear(SV* sv)
5291 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5292 string in C<sv1> is less than, equal to, or greater than the string in
5293 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5294 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
5296 I32 sv_cmp(SV* sv1, SV* sv2)
5304 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
5305 'use bytes' aware, handles get magic, and will coerce its args to strings
5306 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
5308 I32 sv_cmp_locale(SV* sv1, SV* sv2)
5316 Add Collate Transform magic to an SV if it doesn't already have it.
5318 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
5319 scalar data of the variable, but transformed to such a format that a normal
5320 memory comparison can be used to compare the data according to the locale
5323 char* sv_collxfrm(SV* sv, STRLEN* nxp)
5331 Copies a stringified representation of the source SV into the
5332 destination SV. Automatically performs any necessary mg_get and
5333 coercion of numeric values into strings. Guaranteed to preserve
5334 UTF-8 flag even from overloaded objects. Similar in nature to
5335 sv_2pv[_flags] but operates directly on an SV instead of just the
5336 string. Mostly uses sv_2pv_flags to do its work, except when that
5337 would lose the UTF-8'ness of the PV.
5339 void sv_copypv(SV* dsv, SV* ssv)
5347 Auto-decrement of the value in the SV, doing string to numeric conversion
5348 if necessary. Handles 'get' magic.
5358 Returns a boolean indicating whether the strings in the two SVs are
5359 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5360 coerce its args to strings if necessary.
5362 I32 sv_eq(SV* sv1, SV* sv2)
5367 =item sv_force_normal_flags
5368 X<sv_force_normal_flags>
5370 Undo various types of fakery on an SV: if the PV is a shared string, make
5371 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
5372 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
5373 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
5374 then a copy-on-write scalar drops its PV buffer (if any) and becomes
5375 SvPOK_off rather than making a copy. (Used where this scalar is about to be
5376 set to some other value.) In addition, the C<flags> parameter gets passed to
5377 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
5378 with flags set to 0.
5380 void sv_force_normal_flags(SV *sv, U32 flags)
5388 Decrement an SV's reference count, and if it drops to zero, call
5389 C<sv_clear> to invoke destructors and free up any memory used by
5390 the body; finally, deallocate the SV's head itself.
5391 Normally called via a wrapper macro C<SvREFCNT_dec>.
5393 void sv_free(SV* sv)
5401 Get a line from the filehandle and store it into the SV, optionally
5402 appending to the currently-stored string.
5404 char* sv_gets(SV* sv, PerlIO* fp, I32 append)
5412 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
5413 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
5414 Use the C<SvGROW> wrapper instead.
5416 char* sv_grow(SV* sv, STRLEN newlen)
5424 Auto-increment of the value in the SV, doing string to numeric conversion
5425 if necessary. Handles 'get' magic.
5435 Inserts a string at the specified offset/length within the SV. Similar to
5436 the Perl substr() function.
5438 void sv_insert(SV* bigsv, STRLEN offset, STRLEN len, const char* little, STRLEN littlelen)
5446 Returns a boolean indicating whether the SV is blessed into the specified
5447 class. This does not check for subtypes; use C<sv_derived_from> to verify
5448 an inheritance relationship.
5450 int sv_isa(SV* sv, const char* name)
5458 Returns a boolean indicating whether the SV is an RV pointing to a blessed
5459 object. If the SV is not an RV, or if the object is not blessed, then this
5462 int sv_isobject(SV* sv)
5470 Returns the length of the string in the SV. Handles magic and type
5471 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5473 STRLEN sv_len(SV* sv)
5481 Returns the number of characters in the string in an SV, counting wide
5482 UTF-8 bytes as a single character. Handles magic and type coercion.
5484 STRLEN sv_len_utf8(SV* sv)
5492 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
5493 then adds a new magic item of type C<how> to the head of the magic list.
5495 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
5496 handling of the C<name> and C<namlen> arguments.
5498 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
5499 to add more than one instance of the same 'how'.
5501 void sv_magic(SV* sv, SV* obj, int how, const char* name, I32 namlen)
5509 Adds magic to an SV, upgrading it if necessary. Applies the
5510 supplied vtable and returns a pointer to the magic added.
5512 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
5513 In particular, you can add magic to SvREADONLY SVs, and add more than
5514 one instance of the same 'how'.
5516 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
5517 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
5518 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
5519 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
5521 (This is now used as a subroutine by C<sv_magic>.)
5523 MAGIC * sv_magicext(SV* sv, SV* obj, int how, const MGVTBL *vtbl, const char* name, I32 namlen)
5531 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
5532 The new SV is marked as mortal. It will be destroyed "soon", either by an
5533 explicit call to FREETMPS, or by an implicit call at places such as
5534 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
5536 SV* sv_mortalcopy(SV* oldsv)
5544 Creates a new null SV which is mortal. The reference count of the SV is
5545 set to 1. It will be destroyed "soon", either by an explicit call to
5546 FREETMPS, or by an implicit call at places such as statement boundaries.
5547 See also C<sv_mortalcopy> and C<sv_2mortal>.
5557 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5560 SV* sv_newref(SV* sv)
5568 Converts the value pointed to by offsetp from a count of bytes from the
5569 start of the string, to a count of the equivalent number of UTF-8 chars.
5570 Handles magic and type coercion.
5572 void sv_pos_b2u(SV* sv, I32* offsetp)
5580 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5581 the start of the string, to a count of the equivalent number of bytes; if
5582 lenp is non-zero, it does the same to lenp, but this time starting from
5583 the offset, rather than from the start of the string. Handles magic and
5586 void sv_pos_u2b(SV* sv, I32* offsetp, I32* lenp)
5591 =item sv_pvbyten_force
5594 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
5596 char* sv_pvbyten_force(SV* sv, STRLEN* lp)
5604 Get a sensible string out of the SV somehow.
5605 A private implementation of the C<SvPV_force> macro for compilers which
5606 can't cope with complex macro expressions. Always use the macro instead.
5608 char* sv_pvn_force(SV* sv, STRLEN* lp)
5613 =item sv_pvn_force_flags
5614 X<sv_pvn_force_flags>
5616 Get a sensible string out of the SV somehow.
5617 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
5618 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
5619 implemented in terms of this function.
5620 You normally want to use the various wrapper macros instead: see
5621 C<SvPV_force> and C<SvPV_force_nomg>
5623 char* sv_pvn_force_flags(SV* sv, STRLEN* lp, I32 flags)
5628 =item sv_pvutf8n_force
5631 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
5633 char* sv_pvutf8n_force(SV* sv, STRLEN* lp)
5641 Returns a string describing what the SV is a reference to.
5643 const char* sv_reftype(const SV* sv, int ob)
5651 Make the first argument a copy of the second, then delete the original.
5652 The target SV physically takes over ownership of the body of the source SV
5653 and inherits its flags; however, the target keeps any magic it owns,
5654 and any magic in the source is discarded.
5655 Note that this is a rather specialist SV copying operation; most of the
5656 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5658 void sv_replace(SV* sv, SV* nsv)
5666 Underlying implementation for the C<reset> Perl function.
5667 Note that the perl-level function is vaguely deprecated.
5669 void sv_reset(const char* s, HV* stash)
5677 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
5678 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
5679 push a back-reference to this RV onto the array of backreferences
5680 associated with that magic. If the RV is magical, set magic will be
5681 called after the RV is cleared.
5683 SV* sv_rvweaken(SV *sv)
5691 Copies an integer into the given SV, upgrading first if necessary.
5692 Does not handle 'set' magic. See also C<sv_setiv_mg>.
5694 void sv_setiv(SV* sv, IV num)
5702 Like C<sv_setiv>, but also handles 'set' magic.
5704 void sv_setiv_mg(SV *sv, IV i)
5712 Copies a double into the given SV, upgrading first if necessary.
5713 Does not handle 'set' magic. See also C<sv_setnv_mg>.
5715 void sv_setnv(SV* sv, NV num)
5723 Like C<sv_setnv>, but also handles 'set' magic.
5725 void sv_setnv_mg(SV *sv, NV num)
5733 Copies a string into an SV. The string must be null-terminated. Does not
5734 handle 'set' magic. See C<sv_setpv_mg>.
5736 void sv_setpv(SV* sv, const char* ptr)
5744 Works like C<sv_catpvf> but copies the text into the SV instead of
5745 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
5747 void sv_setpvf(SV* sv, const char* pat, ...)
5755 Like C<sv_setpvf>, but also handles 'set' magic.
5757 void sv_setpvf_mg(SV *sv, const char* pat, ...)
5765 Copies an integer into the given SV, also updating its string value.
5766 Does not handle 'set' magic. See C<sv_setpviv_mg>.
5768 void sv_setpviv(SV* sv, IV num)
5776 Like C<sv_setpviv>, but also handles 'set' magic.
5778 void sv_setpviv_mg(SV *sv, IV iv)
5786 Copies a string into an SV. The C<len> parameter indicates the number of
5787 bytes to be copied. If the C<ptr> argument is NULL the SV will become
5788 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
5790 void sv_setpvn(SV* sv, const char* ptr, STRLEN len)
5798 Like C<sv_setpvn>, but also handles 'set' magic.
5800 void sv_setpvn_mg(SV *sv, const char *ptr, STRLEN len)
5808 Like C<sv_setpvn>, but takes a literal string instead of a string/length pair.
5810 void sv_setpvs(SV* sv, const char* s)
5813 Found in file handy.h
5818 Like C<sv_setpv>, but also handles 'set' magic.
5820 void sv_setpv_mg(SV *sv, const char *ptr)
5828 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
5829 argument will be upgraded to an RV. That RV will be modified to point to
5830 the new SV. The C<classname> argument indicates the package for the
5831 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
5832 will have a reference count of 1, and the RV will be returned.
5834 SV* sv_setref_iv(SV* rv, const char* classname, IV iv)
5842 Copies a double into a new SV, optionally blessing the SV. The C<rv>
5843 argument will be upgraded to an RV. That RV will be modified to point to
5844 the new SV. The C<classname> argument indicates the package for the
5845 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
5846 will have a reference count of 1, and the RV will be returned.
5848 SV* sv_setref_nv(SV* rv, const char* classname, NV nv)
5856 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
5857 argument will be upgraded to an RV. That RV will be modified to point to
5858 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
5859 into the SV. The C<classname> argument indicates the package for the
5860 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
5861 will have a reference count of 1, and the RV will be returned.
5863 Do not use with other Perl types such as HV, AV, SV, CV, because those
5864 objects will become corrupted by the pointer copy process.
5866 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
5868 SV* sv_setref_pv(SV* rv, const char* classname, void* pv)
5876 Copies a string into a new SV, optionally blessing the SV. The length of the
5877 string must be specified with C<n>. The C<rv> argument will be upgraded to
5878 an RV. That RV will be modified to point to the new SV. The C<classname>
5879 argument indicates the package for the blessing. Set C<classname> to
5880 C<NULL> to avoid the blessing. The new SV will have a reference count
5881 of 1, and the RV will be returned.
5883 Note that C<sv_setref_pv> copies the pointer while this copies the string.
5885 SV* sv_setref_pvn(SV* rv, const char* classname, const char* pv, STRLEN n)
5893 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
5894 argument will be upgraded to an RV. That RV will be modified to point to
5895 the new SV. The C<classname> argument indicates the package for the
5896 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
5897 will have a reference count of 1, and the RV will be returned.
5899 SV* sv_setref_uv(SV* rv, const char* classname, UV uv)
5907 Copies the contents of the source SV C<ssv> into the destination SV
5908 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
5909 function if the source SV needs to be reused. Does not handle 'set' magic.
5910 Loosely speaking, it performs a copy-by-value, obliterating any previous
5911 content of the destination.
5913 You probably want to use one of the assortment of wrappers, such as
5914 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
5915 C<SvSetMagicSV_nosteal>.
5917 void sv_setsv(SV* dsv, SV* ssv)
5922 =item sv_setsv_flags
5925 Copies the contents of the source SV C<ssv> into the destination SV
5926 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
5927 function if the source SV needs to be reused. Does not handle 'set' magic.
5928 Loosely speaking, it performs a copy-by-value, obliterating any previous
5929 content of the destination.
5930 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
5931 C<ssv> if appropriate, else not. If the C<flags> parameter has the
5932 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
5933 and C<sv_setsv_nomg> are implemented in terms of this function.
5935 You probably want to use one of the assortment of wrappers, such as
5936 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
5937 C<SvSetMagicSV_nosteal>.
5939 This is the primary function for copying scalars, and most other
5940 copy-ish functions and macros use this underneath.
5942 void sv_setsv_flags(SV* dsv, SV* ssv, I32 flags)
5950 Like C<sv_setsv>, but also handles 'set' magic.
5952 void sv_setsv_mg(SV *dstr, SV *sstr)
5960 Copies an unsigned integer into the given SV, upgrading first if necessary.
5961 Does not handle 'set' magic. See also C<sv_setuv_mg>.
5963 void sv_setuv(SV* sv, UV num)
5971 Like C<sv_setuv>, but also handles 'set' magic.
5973 void sv_setuv_mg(SV *sv, UV u)
5981 Test an SV for taintedness. Use C<SvTAINTED> instead.
5982 bool sv_tainted(SV* sv)
5990 Returns true if the SV has a true value by Perl's rules.
5991 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
5992 instead use an in-line version.
6002 Removes all magic of type C<type> from an SV.
6004 int sv_unmagic(SV* sv, int type)
6009 =item sv_unref_flags
6012 Unsets the RV status of the SV, and decrements the reference count of
6013 whatever was being referenced by the RV. This can almost be thought of
6014 as a reversal of C<newSVrv>. The C<cflags> argument can contain
6015 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
6016 (otherwise the decrementing is conditional on the reference count being
6017 different from one or the reference being a readonly SV).
6020 void sv_unref_flags(SV* sv, U32 flags)
6028 Untaint an SV. Use C<SvTAINTED_off> instead.
6029 void sv_untaint(SV* sv)
6037 Upgrade an SV to a more complex form. Generally adds a new body type to the
6038 SV, then copies across as much information as possible from the old body.
6039 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
6041 void sv_upgrade(SV* sv, svtype new_type)
6046 =item sv_usepvn_flags
6049 Tells an SV to use C<ptr> to find its string value. Normally the
6050 string is stored inside the SV but sv_usepvn allows the SV to use an
6051 outside string. The C<ptr> should point to memory that was allocated
6052 by C<malloc>. The string length, C<len>, must be supplied. By default
6053 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
6054 so that pointer should not be freed or used by the programmer after
6055 giving it to sv_usepvn, and neither should any pointers from "behind"
6056 that pointer (e.g. ptr + 1) be used.
6058 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
6059 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
6060 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
6061 C<len>, and already meets the requirements for storing in C<SvPVX>)
6063 void sv_usepvn_flags(SV* sv, char* ptr, STRLEN len, U32 flags)
6068 =item sv_utf8_decode
6071 If the PV of the SV is an octet sequence in UTF-8
6072 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
6073 so that it looks like a character. If the PV contains only single-byte
6074 characters, the C<SvUTF8> flag stays being off.
6075 Scans PV for validity and returns false if the PV is invalid UTF-8.
6077 NOTE: this function is experimental and may change or be
6078 removed without notice.
6080 bool sv_utf8_decode(SV *sv)
6085 =item sv_utf8_downgrade
6086 X<sv_utf8_downgrade>
6088 Attempts to convert the PV of an SV from characters to bytes.
6089 If the PV contains a character beyond byte, this conversion will fail;
6090 in this case, either returns false or, if C<fail_ok> is not
6093 This is not as a general purpose Unicode to byte encoding interface:
6094 use the Encode extension for that.
6096 NOTE: this function is experimental and may change or be
6097 removed without notice.
6099 bool sv_utf8_downgrade(SV *sv, bool fail_ok)
6104 =item sv_utf8_encode
6107 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
6108 flag off so that it looks like octets again.
6110 void sv_utf8_encode(SV *sv)
6115 =item sv_utf8_upgrade
6118 Converts the PV of an SV to its UTF-8-encoded form.
6119 Forces the SV to string form if it is not already.
6120 Always sets the SvUTF8 flag to avoid future validity checks even
6121 if all the bytes have hibit clear.
6123 This is not as a general purpose byte encoding to Unicode interface:
6124 use the Encode extension for that.
6126 STRLEN sv_utf8_upgrade(SV *sv)
6131 =item sv_utf8_upgrade_flags
6132 X<sv_utf8_upgrade_flags>
6134 Converts the PV of an SV to its UTF-8-encoded form.
6135 Forces the SV to string form if it is not already.
6136 Always sets the SvUTF8 flag to avoid future validity checks even
6137 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
6138 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
6139 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
6141 This is not as a general purpose byte encoding to Unicode interface:
6142 use the Encode extension for that.
6144 STRLEN sv_utf8_upgrade_flags(SV *sv, I32 flags)
6152 Processes its arguments like C<vsprintf> and appends the formatted output
6153 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
6155 Usually used via its frontend C<sv_catpvf>.
6157 void sv_vcatpvf(SV* sv, const char* pat, va_list* args)
6165 Processes its arguments like C<vsprintf> and appends the formatted output
6166 to an SV. Uses an array of SVs if the C style variable argument list is
6167 missing (NULL). When running with taint checks enabled, indicates via
6168 C<maybe_tainted> if results are untrustworthy (often due to the use of
6171 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
6173 void sv_vcatpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
6181 Like C<sv_vcatpvf>, but also handles 'set' magic.
6183 Usually used via its frontend C<sv_catpvf_mg>.
6185 void sv_vcatpvf_mg(SV* sv, const char* pat, va_list* args)
6193 Works like C<sv_vcatpvf> but copies the text into the SV instead of
6194 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
6196 Usually used via its frontend C<sv_setpvf>.
6198 void sv_vsetpvf(SV* sv, const char* pat, va_list* args)
6206 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
6209 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
6211 void sv_vsetpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
6219 Like C<sv_vsetpvf>, but also handles 'set' magic.
6221 Usually used via its frontend C<sv_setpvf_mg>.
6223 void sv_vsetpvf_mg(SV* sv, const char* pat, va_list* args)
6231 =head1 Unicode Support
6235 =item bytes_from_utf8
6238 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
6239 Unlike C<utf8_to_bytes> but like C<bytes_to_utf8>, returns a pointer to
6240 the newly-created string, and updates C<len> to contain the new
6241 length. Returns the original string if no conversion occurs, C<len>
6242 is unchanged. Do nothing if C<is_utf8> points to 0. Sets C<is_utf8> to
6243 0 if C<s> is converted or contains all 7bit characters.
6245 NOTE: this function is experimental and may change or be
6246 removed without notice.
6248 U8* bytes_from_utf8(const U8 *s, STRLEN *len, bool *is_utf8)
6251 Found in file utf8.c
6256 Converts a string C<s> of length C<len> from ASCII into UTF-8 encoding.
6257 Returns a pointer to the newly-created string, and sets C<len> to
6258 reflect the new length.
6260 If you want to convert to UTF-8 from other encodings than ASCII,
6261 see sv_recode_to_utf8().
6263 NOTE: this function is experimental and may change or be
6264 removed without notice.
6266 U8* bytes_to_utf8(const U8 *s, STRLEN *len)
6269 Found in file utf8.c
6274 Return true if the strings s1 and s2 differ case-insensitively, false
6275 if not (if they are equal case-insensitively). If u1 is true, the
6276 string s1 is assumed to be in UTF-8-encoded Unicode. If u2 is true,
6277 the string s2 is assumed to be in UTF-8-encoded Unicode. If u1 or u2
6278 are false, the respective string is assumed to be in native 8-bit
6281 If the pe1 and pe2 are non-NULL, the scanning pointers will be copied
6282 in there (they will point at the beginning of the I<next> character).
6283 If the pointers behind pe1 or pe2 are non-NULL, they are the end
6284 pointers beyond which scanning will not continue under any
6285 circumstances. If the byte lengths l1 and l2 are non-zero, s1+l1 and
6286 s2+l2 will be used as goal end pointers that will also stop the scan,
6287 and which qualify towards defining a successful match: all the scans
6288 that define an explicit length must reach their goal pointers for
6289 a match to succeed).
6291 For case-insensitiveness, the "casefolding" of Unicode is used
6292 instead of upper/lowercasing both the characters, see
6293 http://www.unicode.org/unicode/reports/tr21/ (Case Mappings).
6295 I32 ibcmp_utf8(const char* a, char **pe1, UV l1, bool u1, const char* b, char **pe2, UV l2, bool u2)
6298 Found in file utf8.c
6303 Tests if some arbitrary number of bytes begins in a valid UTF-8
6304 character. Note that an INVARIANT (i.e. ASCII) character is a valid
6305 UTF-8 character. The actual number of bytes in the UTF-8 character
6306 will be returned if it is valid, otherwise 0.
6308 STRLEN is_utf8_char(const U8 *p)
6311 Found in file utf8.c
6313 =item is_utf8_string
6316 Returns true if first C<len> bytes of the given string form a valid
6317 UTF-8 string, false otherwise. Note that 'a valid UTF-8 string' does
6318 not mean 'a string that contains code points above 0x7F encoded in UTF-8'
6319 because a valid ASCII string is a valid UTF-8 string.
6321 See also is_utf8_string_loclen() and is_utf8_string_loc().
6323 bool is_utf8_string(const U8 *s, STRLEN len)
6326 Found in file utf8.c
6328 =item is_utf8_string_loc
6329 X<is_utf8_string_loc>
6331 Like is_utf8_string() but stores the location of the failure (in the
6332 case of "utf8ness failure") or the location s+len (in the case of
6333 "utf8ness success") in the C<ep>.
6335 See also is_utf8_string_loclen() and is_utf8_string().
6337 bool is_utf8_string_loc(const U8 *s, STRLEN len, const U8 **p)
6340 Found in file utf8.c
6342 =item is_utf8_string_loclen
6343 X<is_utf8_string_loclen>
6345 Like is_utf8_string() but stores the location of the failure (in the
6346 case of "utf8ness failure") or the location s+len (in the case of
6347 "utf8ness success") in the C<ep>, and the number of UTF-8
6348 encoded characters in the C<el>.
6350 See also is_utf8_string_loc() and is_utf8_string().
6352 bool is_utf8_string_loclen(const U8 *s, STRLEN len, const U8 **ep, STRLEN *el)
6355 Found in file utf8.c
6357 =item pv_uni_display
6360 Build to the scalar dsv a displayable version of the string spv,
6361 length len, the displayable version being at most pvlim bytes long
6362 (if longer, the rest is truncated and "..." will be appended).
6364 The flags argument can have UNI_DISPLAY_ISPRINT set to display
6365 isPRINT()able characters as themselves, UNI_DISPLAY_BACKSLASH
6366 to display the \\[nrfta\\] as the backslashed versions (like '\n')
6367 (UNI_DISPLAY_BACKSLASH is preferred over UNI_DISPLAY_ISPRINT for \\).
6368 UNI_DISPLAY_QQ (and its alias UNI_DISPLAY_REGEX) have both
6369 UNI_DISPLAY_BACKSLASH and UNI_DISPLAY_ISPRINT turned on.
6371 The pointer to the PV of the dsv is returned.
6373 char* pv_uni_display(SV *dsv, const U8 *spv, STRLEN len, STRLEN pvlim, UV flags)
6376 Found in file utf8.c
6381 The encoding is assumed to be an Encode object, the PV of the ssv is
6382 assumed to be octets in that encoding and decoding the input starts
6383 from the position which (PV + *offset) pointed to. The dsv will be
6384 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
6385 when the string tstr appears in decoding output or the input ends on
6386 the PV of the ssv. The value which the offset points will be modified
6387 to the last input position on the ssv.
6389 Returns TRUE if the terminator was found, else returns FALSE.
6391 bool sv_cat_decode(SV* dsv, SV *encoding, SV *ssv, int *offset, char* tstr, int tlen)
6396 =item sv_recode_to_utf8
6397 X<sv_recode_to_utf8>
6399 The encoding is assumed to be an Encode object, on entry the PV
6400 of the sv is assumed to be octets in that encoding, and the sv
6401 will be converted into Unicode (and UTF-8).
6403 If the sv already is UTF-8 (or if it is not POK), or if the encoding
6404 is not a reference, nothing is done to the sv. If the encoding is not
6405 an C<Encode::XS> Encoding object, bad things will happen.
6406 (See F<lib/encoding.pm> and L<Encode>).
6408 The PV of the sv is returned.
6410 char* sv_recode_to_utf8(SV* sv, SV *encoding)
6415 =item sv_uni_display
6418 Build to the scalar dsv a displayable version of the scalar sv,
6419 the displayable version being at most pvlim bytes long
6420 (if longer, the rest is truncated and "..." will be appended).
6422 The flags argument is as in pv_uni_display().
6424 The pointer to the PV of the dsv is returned.
6426 char* sv_uni_display(SV *dsv, SV *ssv, STRLEN pvlim, UV flags)
6429 Found in file utf8.c
6434 The "p" contains the pointer to the UTF-8 string encoding
6435 the character that is being converted.
6437 The "ustrp" is a pointer to the character buffer to put the
6438 conversion result to. The "lenp" is a pointer to the length
6441 The "swashp" is a pointer to the swash to use.
6443 Both the special and normal mappings are stored lib/unicore/To/Foo.pl,
6444 and loaded by SWASHNEW, using lib/utf8_heavy.pl. The special (usually,
6445 but not always, a multicharacter mapping), is tried first.
6447 The "special" is a string like "utf8::ToSpecLower", which means the
6448 hash %utf8::ToSpecLower. The access to the hash is through
6449 Perl_to_utf8_case().
6451 The "normal" is a string like "ToLower" which means the swash
6454 UV to_utf8_case(const U8 *p, U8* ustrp, STRLEN *lenp, SV **swashp, const char *normal, const char *special)
6457 Found in file utf8.c
6462 Convert the UTF-8 encoded character at p to its foldcase version and
6463 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6464 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6465 foldcase version may be longer than the original character (up to
6468 The first character of the foldcased version is returned
6469 (but note, as explained above, that there may be more.)
6471 UV to_utf8_fold(const U8 *p, U8* ustrp, STRLEN *lenp)
6474 Found in file utf8.c
6479 Convert the UTF-8 encoded character at p to its lowercase version and
6480 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6481 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6482 lowercase version may be longer than the original character.
6484 The first character of the lowercased version is returned
6485 (but note, as explained above, that there may be more.)
6487 UV to_utf8_lower(const U8 *p, U8* ustrp, STRLEN *lenp)
6490 Found in file utf8.c
6495 Convert the UTF-8 encoded character at p to its titlecase version and
6496 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6497 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6498 titlecase version may be longer than the original character.
6500 The first character of the titlecased version is returned
6501 (but note, as explained above, that there may be more.)
6503 UV to_utf8_title(const U8 *p, U8* ustrp, STRLEN *lenp)
6506 Found in file utf8.c
6511 Convert the UTF-8 encoded character at p to its uppercase version and
6512 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6513 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since
6514 the uppercase version may be longer than the original character.
6516 The first character of the uppercased version is returned
6517 (but note, as explained above, that there may be more.)
6519 UV to_utf8_upper(const U8 *p, U8* ustrp, STRLEN *lenp)
6522 Found in file utf8.c
6524 =item utf8n_to_uvchr
6529 Returns the native character value of the first character in the string
6531 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6532 length, in bytes, of that character.
6534 Allows length and flags to be passed to low level routine.
6536 UV utf8n_to_uvchr(const U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags)
6539 Found in file utf8.c
6541 =item utf8n_to_uvuni
6544 Bottom level UTF-8 decode routine.
6545 Returns the unicode code point value of the first character in the string C<s>
6546 which is assumed to be in UTF-8 encoding and no longer than C<curlen>;
6547 C<retlen> will be set to the length, in bytes, of that character.
6549 If C<s> does not point to a well-formed UTF-8 character, the behaviour
6550 is dependent on the value of C<flags>: if it contains UTF8_CHECK_ONLY,
6551 it is assumed that the caller will raise a warning, and this function
6552 will silently just set C<retlen> to C<-1> and return zero. If the
6553 C<flags> does not contain UTF8_CHECK_ONLY, warnings about
6554 malformations will be given, C<retlen> will be set to the expected
6555 length of the UTF-8 character in bytes, and zero will be returned.
6557 The C<flags> can also contain various flags to allow deviations from
6558 the strict UTF-8 encoding (see F<utf8.h>).
6560 Most code should use utf8_to_uvchr() rather than call this directly.
6562 UV utf8n_to_uvuni(const U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags)
6565 Found in file utf8.c
6570 Returns the number of UTF-8 characters between the UTF-8 pointers C<a>
6573 WARNING: use only if you *know* that the pointers point inside the
6576 IV utf8_distance(const U8 *a, const U8 *b)
6579 Found in file utf8.c
6584 Return the UTF-8 pointer C<s> displaced by C<off> characters, either
6585 forward or backward.
6587 WARNING: do not use the following unless you *know* C<off> is within
6588 the UTF-8 data pointed to by C<s> *and* that on entry C<s> is aligned
6589 on the first byte of character or just after the last byte of a character.
6591 U8* utf8_hop(const U8 *s, I32 off)
6594 Found in file utf8.c
6599 Return the length of the UTF-8 char encoded string C<s> in characters.
6600 Stops at C<e> (inclusive). If C<e E<lt> s> or if the scan would end
6601 up past C<e>, croaks.
6603 STRLEN utf8_length(const U8* s, const U8 *e)
6606 Found in file utf8.c
6611 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
6612 Unlike C<bytes_to_utf8>, this over-writes the original string, and
6613 updates len to contain the new length.
6614 Returns zero on failure, setting C<len> to -1.
6616 If you need a copy of the string, see C<bytes_from_utf8>.
6618 NOTE: this function is experimental and may change or be
6619 removed without notice.
6621 U8* utf8_to_bytes(U8 *s, STRLEN *len)
6624 Found in file utf8.c
6629 Returns the native character value of the first character in the string C<s>
6630 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6631 length, in bytes, of that character.
6633 If C<s> does not point to a well-formed UTF-8 character, zero is
6634 returned and retlen is set, if possible, to -1.
6636 UV utf8_to_uvchr(const U8 *s, STRLEN *retlen)
6639 Found in file utf8.c
6644 Returns the Unicode code point of the first character in the string C<s>
6645 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6646 length, in bytes, of that character.
6648 This function should only be used when returned UV is considered
6649 an index into the Unicode semantic tables (e.g. swashes).
6651 If C<s> does not point to a well-formed UTF-8 character, zero is
6652 returned and retlen is set, if possible, to -1.
6654 UV utf8_to_uvuni(const U8 *s, STRLEN *retlen)
6657 Found in file utf8.c
6662 Adds the UTF-8 representation of the Native codepoint C<uv> to the end
6663 of the string C<d>; C<d> should be have at least C<UTF8_MAXBYTES+1> free
6664 bytes available. The return value is the pointer to the byte after the
6665 end of the new character. In other words,
6667 d = uvchr_to_utf8(d, uv);
6669 is the recommended wide native character-aware way of saying
6673 U8* uvchr_to_utf8(U8 *d, UV uv)
6676 Found in file utf8.c
6678 =item uvuni_to_utf8_flags
6679 X<uvuni_to_utf8_flags>
6681 Adds the UTF-8 representation of the Unicode codepoint C<uv> to the end
6682 of the string C<d>; C<d> should be have at least C<UTF8_MAXBYTES+1> free
6683 bytes available. The return value is the pointer to the byte after the
6684 end of the new character. In other words,
6686 d = uvuni_to_utf8_flags(d, uv, flags);
6690 d = uvuni_to_utf8(d, uv);
6692 (which is equivalent to)
6694 d = uvuni_to_utf8_flags(d, uv, 0);
6696 is the recommended Unicode-aware way of saying
6700 U8* uvuni_to_utf8_flags(U8 *d, UV uv, UV flags)
6703 Found in file utf8.c
6708 =head1 Variables created by C<xsubpp> and C<xsubpp> internal functions
6715 Variable which is setup by C<xsubpp> to indicate the stack base offset,
6716 used by the C<ST>, C<XSprePUSH> and C<XSRETURN> macros. The C<dMARK> macro
6717 must be called prior to setup the C<MARK> variable.
6722 Found in file XSUB.h
6727 Variable which is setup by C<xsubpp> to indicate the
6728 class name for a C++ XS constructor. This is always a C<char*>. See C<THIS>.
6733 Found in file XSUB.h
6738 Sets up the C<ax> variable.
6739 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
6744 Found in file XSUB.h
6749 Sets up the C<ax> variable and stack marker variable C<mark>.
6750 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
6755 Found in file XSUB.h
6760 Sets up the C<items> variable.
6761 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
6766 Found in file XSUB.h
6771 Sets up the C<padoff_du> variable for an XSUB that wishes to use
6777 Found in file XSUB.h
6782 Sets up stack and mark pointers for an XSUB, calling dSP and dMARK.
6783 Sets up the C<ax> and C<items> variables by calling C<dAX> and C<dITEMS>.
6784 This is usually handled automatically by C<xsubpp>.
6789 Found in file XSUB.h
6794 Sets up the C<ix> variable for an XSUB which has aliases. This is usually
6795 handled automatically by C<xsubpp>.
6800 Found in file XSUB.h
6805 Variable which is setup by C<xsubpp> to indicate the number of
6806 items on the stack. See L<perlxs/"Variable-length Parameter Lists">.
6811 Found in file XSUB.h
6816 Variable which is setup by C<xsubpp> to indicate which of an
6817 XSUB's aliases was used to invoke it. See L<perlxs/"The ALIAS: Keyword">.
6822 Found in file XSUB.h
6827 Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
6831 Found in file XSUB.h
6836 Variable which is setup by C<xsubpp> to hold the return value for an
6837 XSUB. This is always the proper type for the XSUB. See
6838 L<perlxs/"The RETVAL Variable">.
6843 Found in file XSUB.h
6848 Used to access elements on the XSUB's stack.
6853 Found in file XSUB.h
6858 Variable which is setup by C<xsubpp> to designate the object in a C++
6859 XSUB. This is always the proper type for the C++ object. See C<CLASS> and
6860 L<perlxs/"Using XS With C++">.
6865 Found in file XSUB.h
6870 The SV* corresponding to the $_ variable. Works even if there
6871 is a lexical $_ in scope.
6874 Found in file XSUB.h
6879 Macro to declare an XSUB and its C parameter list. This is handled by
6883 Found in file XSUB.h
6888 The version identifier for an XS module. This is usually
6889 handled automatically by C<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>.
6892 Found in file XSUB.h
6894 =item XS_VERSION_BOOTCHECK
6895 X<XS_VERSION_BOOTCHECK>
6897 Macro to verify that a PM module's $VERSION variable matches the XS
6898 module's C<XS_VERSION> variable. This is usually handled automatically by
6899 C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">.
6901 XS_VERSION_BOOTCHECK;
6904 Found in file XSUB.h
6909 =head1 Warning and Dieing
6916 This is the XSUB-writer's interface to Perl's C<die> function.
6917 Normally call this function the same way you call the C C<printf>
6918 function. Calling C<croak> returns control directly to Perl,
6919 sidestepping the normal C order of execution. See C<warn>.
6921 If you want to throw an exception object, assign the object to
6922 C<$@> and then pass C<NULL> to croak():
6924 errsv = get_sv("@", TRUE);
6925 sv_setsv(errsv, exception_object);
6928 void croak(const char* pat, ...)
6931 Found in file util.c
6936 This is the XSUB-writer's interface to Perl's C<warn> function. Call this
6937 function the same way you call the C C<printf> function. See C<croak>.
6939 void warn(const char* pat, ...)
6942 Found in file util.c
6949 Until May 1997, this document was maintained by Jeff Okamoto
6950 <okamoto@corp.hp.com>. It is now maintained as part of Perl itself.
6952 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
6953 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
6954 Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
6955 Stephen McCamant, and Gurusamy Sarathy.
6957 API Listing originally by Dean Roehrich <roehrich@cray.com>.
6959 Updated to be autogenerated from comments in the source by Benjamin Stuhl.
6963 perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
projects / p5sagit/p5-mst-13.2.git / blob