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 Ensure than an array has a given number of elements, equivalent to
192 Perl's C<$#array = $fill;>.
194 void av_fill(AV* ar, I32 fill)
202 Returns the highest index in the array. Returns -1 if the array is
205 I32 av_len(const AV* ar)
213 Creates a new AV and populates it with a list of SVs. The SVs are copied
214 into the array, so they may be freed after the call to av_make. The new AV
215 will have a reference count of 1.
217 AV* av_make(I32 size, SV** svp)
225 Pops an SV off the end of the array. Returns C<&PL_sv_undef> if the array
236 Pushes an SV onto the end of the array. The array will grow automatically
237 to accommodate the addition.
239 void av_push(AV* ar, SV* val)
247 Shifts an SV off the beginning of the array.
257 Stores an SV in an array. The array index is specified as C<key>. The
258 return value will be NULL if the operation failed or if the value did not
259 need to be actually stored within the array (as in the case of tied
260 arrays). Otherwise it can be dereferenced to get the original C<SV*>. Note
261 that the caller is responsible for suitably incrementing the reference
262 count of C<val> before the call, and decrementing it if the function
265 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for
266 more information on how to use this function on tied arrays.
268 SV** av_store(AV* ar, I32 key, SV* val)
276 Undefines the array. Frees the memory used by the array itself.
278 void av_undef(AV* ar)
286 Unshift the given number of C<undef> values onto the beginning of the
287 array. The array will grow automatically to accommodate the addition. You
288 must then use C<av_store> to assign values to these new elements.
290 void av_unshift(AV* ar, I32 num)
298 Returns the AV of the specified Perl array. If C<create> is set and the
299 Perl variable does not exist then it will be created. If C<create> is not
300 set and the variable does not exist then NULL is returned.
302 NOTE: the perl_ form of this function is deprecated.
304 AV* get_av(const char* name, I32 create)
312 Creates a new AV. The reference count is set to 1.
322 Sort an array. Here is an example:
324 sortsv(AvARRAY(av), av_len(av)+1, Perl_sv_cmp_locale);
326 Currently this always uses mergesort. See sortsv_flags for a more
329 void sortsv(SV** array, size_t num_elts, SVCOMPARE_t cmp)
332 Found in file pp_sort.c
337 Sort an array, with various options.
339 void sortsv_flags(SV** array, size_t num_elts, SVCOMPARE_t cmp, U32 flags)
342 Found in file pp_sort.c
347 =head1 Callback Functions
354 Performs a callback to the specified Perl sub. See L<perlcall>.
356 NOTE: the perl_ form of this function is deprecated.
358 I32 call_argv(const char* sub_name, I32 flags, char** argv)
366 Performs a callback to the specified Perl method. The blessed object must
367 be on the stack. See L<perlcall>.
369 NOTE: the perl_ form of this function is deprecated.
371 I32 call_method(const char* methname, I32 flags)
379 Performs a callback to the specified Perl sub. See L<perlcall>.
381 NOTE: the perl_ form of this function is deprecated.
383 I32 call_pv(const char* sub_name, I32 flags)
391 Performs a callback to the Perl sub whose name is in the SV. See
394 NOTE: the perl_ form of this function is deprecated.
396 I32 call_sv(SV* sv, I32 flags)
404 Opening bracket on a callback. See C<LEAVE> and L<perlcall>.
409 Found in file scope.h
414 Tells Perl to C<eval> the given string and return an SV* result.
416 NOTE: the perl_ form of this function is deprecated.
418 SV* eval_pv(const char* p, I32 croak_on_error)
426 Tells Perl to C<eval> the string in the SV.
428 NOTE: the perl_ form of this function is deprecated.
430 I32 eval_sv(SV* sv, I32 flags)
438 Closing bracket for temporaries on a callback. See C<SAVETMPS> and
444 Found in file scope.h
449 Closing bracket on a callback. See C<ENTER> and L<perlcall>.
454 Found in file scope.h
459 Opening bracket for temporaries on a callback. See C<FREETMPS> and
465 Found in file scope.h
470 =head1 Character classes
477 Returns a boolean indicating whether the C C<char> is an ASCII alphanumeric
478 character (including underscore) or digit.
480 bool isALNUM(char ch)
483 Found in file handy.h
488 Returns a boolean indicating whether the C C<char> is an ASCII alphabetic
491 bool isALPHA(char ch)
494 Found in file handy.h
499 Returns a boolean indicating whether the C C<char> is an ASCII
502 bool isDIGIT(char ch)
505 Found in file handy.h
510 Returns a boolean indicating whether the C C<char> is a lowercase
513 bool isLOWER(char ch)
516 Found in file handy.h
521 Returns a boolean indicating whether the C C<char> is whitespace.
523 bool isSPACE(char ch)
526 Found in file handy.h
531 Returns a boolean indicating whether the C C<char> is an uppercase
534 bool isUPPER(char ch)
537 Found in file handy.h
542 Converts the specified character to lowercase.
544 char toLOWER(char ch)
547 Found in file handy.h
552 Converts the specified character to uppercase.
554 char toUPPER(char ch)
557 Found in file handy.h
562 =head1 Cloning an interpreter
569 Create and return a new interpreter by cloning the current one.
571 perl_clone takes these flags as parameters:
573 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
574 without it we only clone the data and zero the stacks,
575 with it we copy the stacks and the new perl interpreter is
576 ready to run at the exact same point as the previous one.
577 The pseudo-fork code uses COPY_STACKS while the
578 threads->new doesn't.
580 CLONEf_KEEP_PTR_TABLE
581 perl_clone keeps a ptr_table with the pointer of the old
582 variable as a key and the new variable as a value,
583 this allows it to check if something has been cloned and not
584 clone it again but rather just use the value and increase the
585 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
586 the ptr_table using the function
587 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
588 reason to keep it around is if you want to dup some of your own
589 variable who are outside the graph perl scans, example of this
590 code is in threads.xs create
593 This is a win32 thing, it is ignored on unix, it tells perls
594 win32host code (which is c++) to clone itself, this is needed on
595 win32 if you want to run two threads at the same time,
596 if you just want to do some stuff in a separate perl interpreter
597 and then throw it away and return to the original one,
598 you don't need to do anything.
600 PerlInterpreter* perl_clone(PerlInterpreter* interp, UV flags)
608 =head1 CV Manipulation Functions
615 Returns the stash of the CV.
625 Returns the CV of the specified Perl subroutine. If C<create> is set and
626 the Perl subroutine does not exist then it will be declared (which has the
627 same effect as saying C<sub name;>). If C<create> is not set and the
628 subroutine does not exist then NULL is returned.
630 NOTE: the perl_ form of this function is deprecated.
632 CV* get_cv(const char* name, I32 create)
640 =head1 Embedding Functions
647 Clear out all the active components of a CV. This can happen either
648 by an explicit C<undef &foo>, or by the reference count going to zero.
649 In the former case, we keep the CvOUTSIDE pointer, so that any anonymous
650 children can still follow the full lexical scope chain.
652 void cv_undef(CV* cv)
660 Loads the module whose name is pointed to by the string part of name.
661 Note that the actual module name, not its filename, should be given.
662 Eg, "Foo::Bar" instead of "Foo/Bar.pm". flags can be any of
663 PERL_LOADMOD_DENY, PERL_LOADMOD_NOIMPORT, or PERL_LOADMOD_IMPORT_OPS
664 (or 0 for no flags). ver, if specified, provides version semantics
665 similar to C<use Foo::Bar VERSION>. The optional trailing SV*
666 arguments can be used to specify arguments to the module's import()
667 method, similar to C<use Foo::Bar VERSION LIST>.
669 void load_module(U32 flags, SV* name, SV* ver, ...)
677 Stub that provides thread hook for perl_destruct when there are
688 Allocates a new Perl interpreter. See L<perlembed>.
690 PerlInterpreter* perl_alloc()
698 Initializes a new Perl interpreter. See L<perlembed>.
700 void perl_construct(PerlInterpreter* interp)
708 Shuts down a Perl interpreter. See L<perlembed>.
710 int perl_destruct(PerlInterpreter* interp)
718 Releases a Perl interpreter. See L<perlembed>.
720 void perl_free(PerlInterpreter* interp)
728 Tells a Perl interpreter to parse a Perl script. See L<perlembed>.
730 int perl_parse(PerlInterpreter* interp, XSINIT_t xsinit, int argc, char** argv, char** env)
738 Tells a Perl interpreter to run. See L<perlembed>.
740 int perl_run(PerlInterpreter* interp)
748 Tells Perl to C<require> the file named by the string argument. It is
749 analogous to the Perl code C<eval "require '$file'">. It's even
750 implemented that way; consider using load_module instead.
752 NOTE: the perl_ form of this function is deprecated.
754 void require_pv(const char* pv)
762 =head1 Functions in file dump.c
770 char *pv_display(SV *dsv, const char *pv, STRLEN cur, STRLEN len,
771 STRLEN pvlim, U32 flags)
775 pv_escape(dsv,pv,cur,pvlim,PERL_PV_ESCAPE_QUOTE);
777 except that an additional "\0" will be appended to the string when
778 len > cur and pv[cur] is "\0".
780 Note that the final string may be up to 7 chars longer than pvlim.
782 char* pv_display(SV *dsv, const char *pv, STRLEN cur, STRLEN len, STRLEN pvlim)
790 |const STRLEN count|const STRLEN max
791 |STRLEN const *escaped, const U32 flags
793 Escapes at most the first "count" chars of pv and puts the results into
794 dsv such that the size of the escaped string will not exceed "max" chars
795 and will not contain any incomplete escape sequences.
797 If flags contains PERL_PV_ESCAPE_QUOTE then any double quotes in the string
798 will also be escaped.
800 Normally the SV will be cleared before the escaped string is prepared,
801 but when PERL_PV_ESCAPE_NOCLEAR is set this will not occur.
803 If PERL_PV_ESCAPE_UNI is set then the input string is treated as unicode,
804 if PERL_PV_ESCAPE_UNI_DETECT is set then the input string is scanned
805 using C<is_utf8_string()> to determine if it is unicode.
807 If PERL_PV_ESCAPE_ALL is set then all input chars will be output
808 using C<\x01F1> style escapes, otherwise only chars above 255 will be
809 escaped using this style, other non printable chars will use octal or
810 common escaped patterns like C<\n>. If PERL_PV_ESCAPE_NOBACKSLASH
811 then all chars below 255 will be treated as printable and
812 will be output as literals.
814 If PERL_PV_ESCAPE_FIRSTCHAR is set then only the first char of the
815 string will be escaped, regardles of max. If the string is utf8 and
816 the chars value is >255 then it will be returned as a plain hex
817 sequence. Thus the output will either be a single char,
818 an octal escape sequence, a special escape like C<\n> or a 3 or
819 more digit hex value.
821 Returns a pointer to the escaped text as held by dsv.
823 NOTE: the perl_ form of this function is deprecated.
825 char* pv_escape(SV *dsv, char const * const str, const STRLEN count, const STRLEN max, STRLEN * const escaped, const U32 flags)
833 |const STRLEN count|const STRLEN max\
834 |const char const *start_color| const char const *end_color\
837 Converts a string into something presentable, handling escaping via
838 pv_escape() and supporting quoting and elipses.
840 If the PERL_PV_PRETTY_QUOTE flag is set then the result will be
841 double quoted with any double quotes in the string escaped. Otherwise
842 if the PERL_PV_PRETTY_LTGT flag is set then the result be wrapped in
845 If the PERL_PV_PRETTY_ELIPSES flag is set and not all characters in
846 string were output then an elipses C<...> will be appended to the
847 string. Note that this happens AFTER it has been quoted.
849 If start_color is non-null then it will be inserted after the opening
850 quote (if there is one) but before the escaped text. If end_color
851 is non-null then it will be inserted after the escaped text but before
852 any quotes or elipses.
854 Returns a pointer to the prettified text as held by dsv.
856 NOTE: the perl_ form of this function is deprecated.
858 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)
866 =head1 Functions in file mathoms.c
874 See L<gv_fetchmethod_autoload>.
876 GV* gv_fetchmethod(HV* stash, const char* name)
879 Found in file mathoms.c
884 The engine implementing pack() Perl function. Note: parameters next_in_list and
885 flags are not used. This call should not be used; use packlist instead.
887 void pack_cat(SV *cat, const char *pat, const char *patend, SV **beglist, SV **endlist, SV ***next_in_list, U32 flags)
890 Found in file mathoms.c
892 =item sv_2pvbyte_nolen
895 Return a pointer to the byte-encoded representation of the SV.
896 May cause the SV to be downgraded from UTF-8 as a side-effect.
898 Usually accessed via the C<SvPVbyte_nolen> macro.
900 char* sv_2pvbyte_nolen(SV* sv)
903 Found in file mathoms.c
905 =item sv_2pvutf8_nolen
908 Return a pointer to the UTF-8-encoded representation of the SV.
909 May cause the SV to be upgraded to UTF-8 as a side-effect.
911 Usually accessed via the C<SvPVutf8_nolen> macro.
913 char* sv_2pvutf8_nolen(SV* sv)
916 Found in file mathoms.c
921 Like C<sv_2pv()>, but doesn't return the length too. You should usually
922 use the macro wrapper C<SvPV_nolen(sv)> instead.
923 char* sv_2pv_nolen(SV* sv)
926 Found in file mathoms.c
931 Like C<sv_catpvn>, but also handles 'set' magic.
933 void sv_catpvn_mg(SV *sv, const char *ptr, STRLEN len)
936 Found in file mathoms.c
941 Like C<sv_catsv>, but also handles 'set' magic.
943 void sv_catsv_mg(SV *dstr, SV *sstr)
946 Found in file mathoms.c
948 =item sv_force_normal
951 Undo various types of fakery on an SV: if the PV is a shared string, make
952 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
953 an xpvmg. See also C<sv_force_normal_flags>.
955 void sv_force_normal(SV *sv)
958 Found in file mathoms.c
963 A private implementation of the C<SvIVx> macro for compilers which can't
964 cope with complex macro expressions. Always use the macro instead.
969 Found in file mathoms.c
974 Dummy routine which "locks" an SV when there is no locking module present.
975 Exists to avoid test for a NULL function pointer and because it could
976 potentially warn under some level of strict-ness.
978 "Superseded" by sv_nosharing().
980 void sv_nolocking(SV *sv)
983 Found in file mathoms.c
988 Dummy routine which "unlocks" an SV when there is no locking module present.
989 Exists to avoid test for a NULL function pointer and because it could
990 potentially warn under some level of strict-ness.
992 "Superseded" by sv_nosharing().
994 void sv_nounlocking(SV *sv)
997 Found in file mathoms.c
1002 A private implementation of the C<SvNVx> macro for compilers which can't
1003 cope with complex macro expressions. Always use the macro instead.
1008 Found in file mathoms.c
1013 Use the C<SvPV_nolen> macro instead
1018 Found in file mathoms.c
1023 Use C<SvPVbyte_nolen> instead.
1025 char* sv_pvbyte(SV *sv)
1028 Found in file mathoms.c
1033 A private implementation of the C<SvPVbyte> macro for compilers
1034 which can't cope with complex macro expressions. Always use the macro
1037 char* sv_pvbyten(SV *sv, STRLEN *len)
1040 Found in file mathoms.c
1045 A private implementation of the C<SvPV> macro for compilers which can't
1046 cope with complex macro expressions. Always use the macro instead.
1048 char* sv_pvn(SV *sv, STRLEN *len)
1051 Found in file mathoms.c
1056 Use the C<SvPVutf8_nolen> macro instead
1058 char* sv_pvutf8(SV *sv)
1061 Found in file mathoms.c
1066 A private implementation of the C<SvPVutf8> macro for compilers
1067 which can't cope with complex macro expressions. Always use the macro
1070 char* sv_pvutf8n(SV *sv, STRLEN *len)
1073 Found in file mathoms.c
1078 Taint an SV. Use C<SvTAINTED_on> instead.
1079 void sv_taint(SV* sv)
1082 Found in file mathoms.c
1087 Unsets the RV status of the SV, and decrements the reference count of
1088 whatever was being referenced by the RV. This can almost be thought of
1089 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
1090 being zero. See C<SvROK_off>.
1092 void sv_unref(SV* sv)
1095 Found in file mathoms.c
1100 Tells an SV to use C<ptr> to find its string value. Implemented by
1101 calling C<sv_usepvn_flags> with C<flags> of 0, hence does not handle 'set'
1102 magic. See C<sv_usepvn_flags>.
1104 void sv_usepvn(SV* sv, char* ptr, STRLEN len)
1107 Found in file mathoms.c
1112 Like C<sv_usepvn>, but also handles 'set' magic.
1114 void sv_usepvn_mg(SV *sv, char *ptr, STRLEN len)
1117 Found in file mathoms.c
1122 A private implementation of the C<SvUVx> macro for compilers which can't
1123 cope with complex macro expressions. Always use the macro instead.
1128 Found in file mathoms.c
1133 The engine implementing unpack() Perl function. Note: parameters strbeg, new_s
1134 and ocnt are not used. This call should not be used, use unpackstring instead.
1136 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)
1139 Found in file mathoms.c
1144 =head1 Functions in file pp_pack.c
1152 The engine implementing pack() Perl function.
1154 void packlist(SV *cat, const char *pat, const char *patend, SV **beglist, SV **endlist)
1157 Found in file pp_pack.c
1162 The engine implementing unpack() Perl function. C<unpackstring> puts the
1163 extracted list items on the stack and returns the number of elements.
1164 Issue C<PUTBACK> before and C<SPAGAIN> after the call to this function.
1166 I32 unpackstring(const char *pat, const char *patend, const char *s, const char *strend, U32 flags)
1169 Found in file pp_pack.c
1174 =head1 Global Variables
1181 C<PL_modglobal> is a general purpose, interpreter global HV for use by
1182 extensions that need to keep information on a per-interpreter basis.
1183 In a pinch, it can also be used as a symbol table for extensions
1184 to share data among each other. It is a good idea to use keys
1185 prefixed by the package name of the extension that owns the data.
1190 Found in file intrpvar.h
1195 A convenience variable which is typically used with C<SvPV> when one
1196 doesn't care about the length of the string. It is usually more efficient
1197 to either declare a local variable and use that instead or to use the
1198 C<SvPV_nolen> macro.
1203 Found in file thrdvar.h
1208 This is the C<false> SV. See C<PL_sv_yes>. Always refer to this as
1214 Found in file intrpvar.h
1219 This is the C<undef> SV. Always refer to this as C<&PL_sv_undef>.
1224 Found in file intrpvar.h
1229 This is the C<true> SV. See C<PL_sv_no>. Always refer to this as
1235 Found in file intrpvar.h
1247 Return the SV from the GV.
1257 If C<gv> is a typeglob whose subroutine entry is a constant sub eligible for
1258 inlining, or C<gv> is a placeholder reference that would be promoted to such
1259 a typeglob, then returns the value returned by the sub. Otherwise, returns
1262 SV* gv_const_sv(GV* gv)
1270 Returns the glob with the given C<name> and a defined subroutine or
1271 C<NULL>. The glob lives in the given C<stash>, or in the stashes
1272 accessible via @ISA and UNIVERSAL::.
1274 The argument C<level> should be either 0 or -1. If C<level==0>, as a
1275 side-effect creates a glob with the given C<name> in the given C<stash>
1276 which in the case of success contains an alias for the subroutine, and sets
1277 up caching info for this glob. Similarly for all the searched stashes.
1279 This function grants C<"SUPER"> token as a postfix of the stash name. The
1280 GV returned from C<gv_fetchmeth> may be a method cache entry, which is not
1281 visible to Perl code. So when calling C<call_sv>, you should not use
1282 the GV directly; instead, you should use the method's CV, which can be
1283 obtained from the GV with the C<GvCV> macro.
1285 GV* gv_fetchmeth(HV* stash, const char* name, STRLEN len, I32 level)
1290 =item gv_fetchmethod_autoload
1291 X<gv_fetchmethod_autoload>
1293 Returns the glob which contains the subroutine to call to invoke the method
1294 on the C<stash>. In fact in the presence of autoloading this may be the
1295 glob for "AUTOLOAD". In this case the corresponding variable $AUTOLOAD is
1298 The third parameter of C<gv_fetchmethod_autoload> determines whether
1299 AUTOLOAD lookup is performed if the given method is not present: non-zero
1300 means yes, look for AUTOLOAD; zero means no, don't look for AUTOLOAD.
1301 Calling C<gv_fetchmethod> is equivalent to calling C<gv_fetchmethod_autoload>
1302 with a non-zero C<autoload> parameter.
1304 These functions grant C<"SUPER"> token as a prefix of the method name. Note
1305 that if you want to keep the returned glob for a long time, you need to
1306 check for it being "AUTOLOAD", since at the later time the call may load a
1307 different subroutine due to $AUTOLOAD changing its value. Use the glob
1308 created via a side effect to do this.
1310 These functions have the same side-effects and as C<gv_fetchmeth> with
1311 C<level==0>. C<name> should be writable if contains C<':'> or C<'
1312 ''>. The warning against passing the GV returned by C<gv_fetchmeth> to
1313 C<call_sv> apply equally to these functions.
1315 GV* gv_fetchmethod_autoload(HV* stash, const char* name, I32 autoload)
1320 =item gv_fetchmeth_autoload
1321 X<gv_fetchmeth_autoload>
1323 Same as gv_fetchmeth(), but looks for autoloaded subroutines too.
1324 Returns a glob for the subroutine.
1326 For an autoloaded subroutine without a GV, will create a GV even
1327 if C<level < 0>. For an autoloaded subroutine without a stub, GvCV()
1328 of the result may be zero.
1330 GV* gv_fetchmeth_autoload(HV* stash, const char* name, STRLEN len, I32 level)
1338 Returns a pointer to the stash for a specified package. C<name> should
1339 be a valid UTF-8 string and must be null-terminated. If C<create> is set
1340 then the package will be created if it does not already exist. If C<create>
1341 is not set and the package does not exist then NULL is returned.
1343 HV* gv_stashpv(const char* name, I32 create)
1351 Returns a pointer to the stash for a specified package. C<name> should
1352 be a valid UTF-8 string. The C<namelen> parameter indicates the length of
1353 the C<name>, in bytes. If C<create> is set then the package will be
1354 created if it does not already exist. If C<create> is not set and the
1355 package does not exist then NULL is returned.
1357 HV* gv_stashpvn(const char* name, U32 namelen, I32 create)
1365 Like C<gv_stashpvn>, but takes a literal string instead of a string/length pair.
1367 HV* gv_stashpvs(const char* name, I32 create)
1370 Found in file handy.h
1375 Returns a pointer to the stash for a specified package, which must be a
1376 valid UTF-8 string. See C<gv_stashpv>.
1378 HV* gv_stashsv(SV* sv, I32 create)
1401 Null character pointer.
1404 Found in file handy.h
1428 Found in file handy.h
1433 =head1 Hash Manipulation Functions
1440 Returns the HV of the specified Perl hash. If C<create> is set and the
1441 Perl variable does not exist then it will be created. If C<create> is not
1442 set and the variable does not exist then NULL is returned.
1444 NOTE: the perl_ form of this function is deprecated.
1446 HV* get_hv(const char* name, I32 create)
1449 Found in file perl.c
1454 This flag, used in the length slot of hash entries and magic structures,
1455 specifies the structure contains an C<SV*> pointer where a C<char*> pointer
1456 is to be expected. (For information only--not to be used).
1464 Returns the computed hash stored in the hash entry.
1474 Returns the actual pointer stored in the key slot of the hash entry. The
1475 pointer may be either C<char*> or C<SV*>, depending on the value of
1476 C<HeKLEN()>. Can be assigned to. The C<HePV()> or C<HeSVKEY()> macros are
1477 usually preferable for finding the value of a key.
1487 If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry
1488 holds an C<SV*> key. Otherwise, holds the actual length of the key. Can
1489 be assigned to. The C<HePV()> macro is usually preferable for finding key
1492 STRLEN HeKLEN(HE* he)
1500 Returns the key slot of the hash entry as a C<char*> value, doing any
1501 necessary dereferencing of possibly C<SV*> keys. The length of the string
1502 is placed in C<len> (this is a macro, so do I<not> use C<&len>). If you do
1503 not care about what the length of the key is, you may use the global
1504 variable C<PL_na>, though this is rather less efficient than using a local
1505 variable. Remember though, that hash keys in perl are free to contain
1506 embedded nulls, so using C<strlen()> or similar is not a good way to find
1507 the length of hash keys. This is very similar to the C<SvPV()> macro
1508 described elsewhere in this document.
1510 char* HePV(HE* he, STRLEN len)
1518 Returns the key as an C<SV*>, or C<NULL> if the hash entry does not
1519 contain an C<SV*> key.
1529 Returns the key as an C<SV*>. Will create and return a temporary mortal
1530 C<SV*> if the hash entry contains only a C<char*> key.
1532 SV* HeSVKEY_force(HE* he)
1540 Sets the key to a given C<SV*>, taking care to set the appropriate flags to
1541 indicate the presence of an C<SV*> key, and returns the same
1544 SV* HeSVKEY_set(HE* he, SV* sv)
1552 Returns the value slot (type C<SV*>) stored in the hash entry.
1562 Returns the package name of a stash, or NULL if C<stash> isn't a stash.
1563 See C<SvSTASH>, C<CvSTASH>.
1565 char* HvNAME(HV* stash)
1573 Check that a hash is in an internally consistent state.
1575 void hv_assert(HV* tb)
1583 Clears a hash, making it empty.
1585 void hv_clear(HV* tb)
1590 =item hv_clear_placeholders
1591 X<hv_clear_placeholders>
1593 Clears any placeholders from a hash. If a restricted hash has any of its keys
1594 marked as readonly and the key is subsequently deleted, the key is not actually
1595 deleted but is marked by assigning it a value of &PL_sv_placeholder. This tags
1596 it so it will be ignored by future operations such as iterating over the hash,
1597 but will still allow the hash to have a value reassigned to the key at some
1598 future point. This function clears any such placeholder keys from the hash.
1599 See Hash::Util::lock_keys() for an example of its use.
1601 void hv_clear_placeholders(HV* hb)
1609 Deletes a key/value pair in the hash. The value SV is removed from the
1610 hash and returned to the caller. The C<klen> is the length of the key.
1611 The C<flags> value will normally be zero; if set to G_DISCARD then NULL
1614 SV* hv_delete(HV* tb, const char* key, I32 klen, I32 flags)
1622 Deletes a key/value pair in the hash. The value SV is removed from the
1623 hash and returned to the caller. The C<flags> value will normally be zero;
1624 if set to G_DISCARD then NULL will be returned. C<hash> can be a valid
1625 precomputed hash value, or 0 to ask for it to be computed.
1627 SV* hv_delete_ent(HV* tb, SV* key, I32 flags, U32 hash)
1635 Returns a boolean indicating whether the specified hash key exists. The
1636 C<klen> is the length of the key.
1638 bool hv_exists(HV* tb, const char* key, I32 klen)
1646 Returns a boolean indicating whether the specified hash key exists. C<hash>
1647 can be a valid precomputed hash value, or 0 to ask for it to be
1650 bool hv_exists_ent(HV* tb, SV* key, U32 hash)
1658 Returns the SV which corresponds to the specified key in the hash. The
1659 C<klen> is the length of the key. If C<lval> is set then the fetch will be
1660 part of a store. Check that the return value is non-null before
1661 dereferencing it to an C<SV*>.
1663 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1664 information on how to use this function on tied hashes.
1666 SV** hv_fetch(HV* tb, const char* key, I32 klen, I32 lval)
1674 Like C<hv_fetch>, but takes a literal string instead of a string/length pair.
1676 SV** hv_fetchs(HV* tb, const char* key, I32 lval)
1679 Found in file handy.h
1684 Returns the hash entry which corresponds to the specified key in the hash.
1685 C<hash> must be a valid precomputed hash number for the given C<key>, or 0
1686 if you want the function to compute it. IF C<lval> is set then the fetch
1687 will be part of a store. Make sure the return value is non-null before
1688 accessing it. The return value when C<tb> is a tied hash is a pointer to a
1689 static location, so be sure to make a copy of the structure if you need to
1692 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1693 information on how to use this function on tied hashes.
1695 HE* hv_fetch_ent(HV* tb, SV* key, I32 lval, U32 hash)
1703 Prepares a starting point to traverse a hash table. Returns the number of
1704 keys in the hash (i.e. the same as C<HvKEYS(tb)>). The return value is
1705 currently only meaningful for hashes without tie magic.
1707 NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
1708 hash buckets that happen to be in use. If you still need that esoteric
1709 value, you can get it through the macro C<HvFILL(tb)>.
1712 I32 hv_iterinit(HV* tb)
1720 Returns the key from the current position of the hash iterator. See
1723 char* hv_iterkey(HE* entry, I32* retlen)
1731 Returns the key as an C<SV*> from the current position of the hash
1732 iterator. The return value will always be a mortal copy of the key. Also
1735 SV* hv_iterkeysv(HE* entry)
1743 Returns entries from a hash iterator. See C<hv_iterinit>.
1745 You may call C<hv_delete> or C<hv_delete_ent> on the hash entry that the
1746 iterator currently points to, without losing your place or invalidating your
1747 iterator. Note that in this case the current entry is deleted from the hash
1748 with your iterator holding the last reference to it. Your iterator is flagged
1749 to free the entry on the next call to C<hv_iternext>, so you must not discard
1750 your iterator immediately else the entry will leak - call C<hv_iternext> to
1751 trigger the resource deallocation.
1753 HE* hv_iternext(HV* tb)
1761 Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
1764 SV* hv_iternextsv(HV* hv, char** key, I32* retlen)
1769 =item hv_iternext_flags
1770 X<hv_iternext_flags>
1772 Returns entries from a hash iterator. See C<hv_iterinit> and C<hv_iternext>.
1773 The C<flags> value will normally be zero; if HV_ITERNEXT_WANTPLACEHOLDERS is
1774 set the placeholders keys (for restricted hashes) will be returned in addition
1775 to normal keys. By default placeholders are automatically skipped over.
1776 Currently a placeholder is implemented with a value that is
1777 C<&Perl_sv_placeholder>. Note that the implementation of placeholders and
1778 restricted hashes may change, and the implementation currently is
1779 insufficiently abstracted for any change to be tidy.
1781 NOTE: this function is experimental and may change or be
1782 removed without notice.
1784 HE* hv_iternext_flags(HV* tb, I32 flags)
1792 Returns the value from the current position of the hash iterator. See
1795 SV* hv_iterval(HV* tb, HE* entry)
1803 Adds magic to a hash. See C<sv_magic>.
1805 void hv_magic(HV* hv, GV* gv, int how)
1813 Evaluates the hash in scalar context and returns the result. Handles magic when the hash is tied.
1815 SV* hv_scalar(HV* hv)
1823 Stores an SV in a hash. The hash key is specified as C<key> and C<klen> is
1824 the length of the key. The C<hash> parameter is the precomputed hash
1825 value; if it is zero then Perl will compute it. The return value will be
1826 NULL if the operation failed or if the value did not need to be actually
1827 stored within the hash (as in the case of tied hashes). Otherwise it can
1828 be dereferenced to get the original C<SV*>. Note that the caller is
1829 responsible for suitably incrementing the reference count of C<val> before
1830 the call, and decrementing it if the function returned NULL. Effectively
1831 a successful hv_store takes ownership of one reference to C<val>. This is
1832 usually what you want; a newly created SV has a reference count of one, so
1833 if all your code does is create SVs then store them in a hash, hv_store
1834 will own the only reference to the new SV, and your code doesn't need to do
1835 anything further to tidy up. hv_store is not implemented as a call to
1836 hv_store_ent, and does not create a temporary SV for the key, so if your
1837 key data is not already in SV form then use hv_store in preference to
1840 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1841 information on how to use this function on tied hashes.
1843 SV** hv_store(HV* tb, const char* key, I32 klen, SV* val, U32 hash)
1851 Like C<hv_store>, but takes a literal string instead of a string/length pair
1852 and omits the hash parameter.
1854 SV** hv_stores(HV* tb, const char* key, NULLOK SV* val)
1857 Found in file handy.h
1862 Stores C<val> in a hash. The hash key is specified as C<key>. The C<hash>
1863 parameter is the precomputed hash value; if it is zero then Perl will
1864 compute it. The return value is the new hash entry so created. It will be
1865 NULL if the operation failed or if the value did not need to be actually
1866 stored within the hash (as in the case of tied hashes). Otherwise the
1867 contents of the return value can be accessed using the C<He?> macros
1868 described here. Note that the caller is responsible for suitably
1869 incrementing the reference count of C<val> before the call, and
1870 decrementing it if the function returned NULL. Effectively a successful
1871 hv_store_ent takes ownership of one reference to C<val>. This is
1872 usually what you want; a newly created SV has a reference count of one, so
1873 if all your code does is create SVs then store them in a hash, hv_store
1874 will own the only reference to the new SV, and your code doesn't need to do
1875 anything further to tidy up. Note that hv_store_ent only reads the C<key>;
1876 unlike C<val> it does not take ownership of it, so maintaining the correct
1877 reference count on C<key> is entirely the caller's responsibility. hv_store
1878 is not implemented as a call to hv_store_ent, and does not create a temporary
1879 SV for the key, so if your key data is not already in SV form then use
1880 hv_store in preference to hv_store_ent.
1882 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1883 information on how to use this function on tied hashes.
1885 HE* hv_store_ent(HV* tb, SV* key, SV* val, U32 hash)
1895 void hv_undef(HV* tb)
1903 Creates a new HV. The reference count is set to 1.
1913 =head1 Magical Functions
1920 Clear something magical that the SV represents. See C<sv_magic>.
1922 int mg_clear(SV* sv)
1930 Copies the magic from one SV to another. See C<sv_magic>.
1932 int mg_copy(SV* sv, SV* nsv, const char* key, I32 klen)
1940 Finds the magic pointer for type matching the SV. See C<sv_magic>.
1942 MAGIC* mg_find(const SV* sv, int type)
1950 Free any magic storage used by the SV. See C<sv_magic>.
1960 Do magic after a value is retrieved from the SV. See C<sv_magic>.
1970 Report on the SV's length. See C<sv_magic>.
1972 U32 mg_length(SV* sv)
1980 Turns on the magical status of an SV. See C<sv_magic>.
1982 void mg_magical(SV* sv)
1990 Do magic after a value is assigned to the SV. See C<sv_magic>.
2000 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
2001 argument more than once.
2003 void SvGETMAGIC(SV* sv)
2011 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
2022 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
2023 argument more than once.
2025 void SvSETMAGIC(SV* sv)
2033 Like C<SvSetSV>, but does any set magic required afterwards.
2035 void SvSetMagicSV(SV* dsb, SV* ssv)
2040 =item SvSetMagicSV_nosteal
2041 X<SvSetMagicSV_nosteal>
2043 Like C<SvSetSV_nosteal>, but does any set magic required afterwards.
2045 void SvSetMagicSV_nosteal(SV* dsv, SV* ssv)
2053 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
2056 void SvSetSV(SV* dsb, SV* ssv)
2061 =item SvSetSV_nosteal
2064 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
2065 ssv. May evaluate arguments more than once.
2067 void SvSetSV_nosteal(SV* dsv, SV* ssv)
2075 Arranges for sv to be shared between threads if a suitable module
2078 void SvSHARE(SV* sv)
2086 Releases a mutual exclusion lock on sv if a suitable module
2089 void SvUNLOCK(SV* sv)
2097 =head1 Memory Management
2104 The XSUB-writer's interface to the C C<memcpy> function. The C<src> is the
2105 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
2106 the type. May fail on overlapping copies. See also C<Move>.
2108 void Copy(void* src, void* dest, int nitems, type)
2111 Found in file handy.h
2116 Like C<Copy> but returns dest. Useful for encouraging compilers to tail-call
2119 void * CopyD(void* src, void* dest, int nitems, type)
2122 Found in file handy.h
2127 The XSUB-writer's interface to the C C<memmove> 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. Can do overlapping moves. See also C<Copy>.
2131 void Move(void* src, void* dest, int nitems, type)
2134 Found in file handy.h
2139 Like C<Move> but returns dest. Useful for encouraging compilers to tail-call
2142 void * MoveD(void* src, void* dest, int nitems, type)
2145 Found in file handy.h
2150 The XSUB-writer's interface to the C C<malloc> function.
2152 In 5.9.3, Newx() and friends replace the older New() API, and drops
2153 the first parameter, I<x>, a debug aid which allowed callers to identify
2154 themselves. This aid has been superseded by a new build option,
2155 PERL_MEM_LOG (see L<perlhack/PERL_MEM_LOG>). The older API is still
2156 there for use in XS modules supporting older perls.
2158 void Newx(void* ptr, int nitems, type)
2161 Found in file handy.h
2166 The XSUB-writer's interface to the C C<malloc> function, with
2167 cast. See also C<Newx>.
2169 void Newxc(void* ptr, int nitems, type, cast)
2172 Found in file handy.h
2177 The XSUB-writer's interface to the C C<malloc> function. The allocated
2178 memory is zeroed with C<memzero>. See also C<Newx>.
2180 void Newxz(void* ptr, int nitems, type)
2183 Found in file handy.h
2188 PoisonWith(0xEF) for catching access to freed memory.
2190 void Poison(void* dest, int nitems, type)
2193 Found in file handy.h
2198 PoisonWith(0xEF) for catching access to freed memory.
2200 void PoisonFree(void* dest, int nitems, type)
2203 Found in file handy.h
2208 PoisonWith(0xAB) for catching access to allocated but uninitialized memory.
2210 void PoisonNew(void* dest, int nitems, type)
2213 Found in file handy.h
2218 Fill up memory with a byte pattern (a byte repeated over and over
2219 again) that hopefully catches attempts to access uninitialized memory.
2221 void PoisonWith(void* dest, int nitems, type, U8 byte)
2224 Found in file handy.h
2229 The XSUB-writer's interface to the C C<realloc> function.
2231 void Renew(void* ptr, int nitems, type)
2234 Found in file handy.h
2239 The XSUB-writer's interface to the C C<realloc> function, with
2242 void Renewc(void* ptr, int nitems, type, cast)
2245 Found in file handy.h
2250 The XSUB-writer's interface to the C C<free> function.
2252 void Safefree(void* ptr)
2255 Found in file handy.h
2260 Perl's version of C<strdup()>. Returns a pointer to a newly allocated
2261 string which is a duplicate of C<pv>. The size of the string is
2262 determined by C<strlen()>. The memory allocated for the new string can
2263 be freed with the C<Safefree()> function.
2265 char* savepv(const char* pv)
2268 Found in file util.c
2273 Perl's version of what C<strndup()> would be if it existed. Returns a
2274 pointer to a newly allocated string which is a duplicate of the first
2275 C<len> bytes from C<pv>, plus a trailing NUL byte. The memory allocated for
2276 the new string can be freed with the C<Safefree()> function.
2278 char* savepvn(const char* pv, I32 len)
2281 Found in file util.c
2286 Like C<savepvn>, but takes a literal string instead of a string/length pair.
2288 char* savepvs(const char* s)
2291 Found in file handy.h
2296 A version of C<savepv()> which allocates the duplicate string in memory
2297 which is shared between threads.
2299 char* savesharedpv(const char* pv)
2302 Found in file util.c
2307 A version of C<savepv()>/C<savepvn()> which gets the string to duplicate from
2308 the passed in SV using C<SvPV()>
2310 char* savesvpv(SV* sv)
2313 Found in file util.c
2318 This is an architecture-independent macro to copy one structure to another.
2320 void StructCopy(type src, type dest, type)
2323 Found in file handy.h
2328 The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the
2329 destination, C<nitems> is the number of items, and C<type> is the type.
2331 void Zero(void* dest, int nitems, type)
2334 Found in file handy.h
2339 Like C<Zero> but returns dest. Useful for encouraging compilers to tail-call
2342 void * ZeroD(void* dest, int nitems, type)
2345 Found in file handy.h
2350 =head1 Miscellaneous Functions
2357 Analyses the string in order to make fast searches on it using fbm_instr()
2358 -- the Boyer-Moore algorithm.
2360 void fbm_compile(SV* sv, U32 flags)
2363 Found in file util.c
2368 Returns the location of the SV in the string delimited by C<str> and
2369 C<strend>. It returns C<NULL> if the string can't be found. The C<sv>
2370 does not have to be fbm_compiled, but the search will not be as fast
2373 char* fbm_instr(unsigned char* big, unsigned char* bigend, SV* littlesv, U32 flags)
2376 Found in file util.c
2381 Takes a sprintf-style format pattern and conventional
2382 (non-SV) arguments and returns the formatted string.
2384 (char *) Perl_form(pTHX_ const char* pat, ...)
2386 can be used any place a string (char *) is required:
2388 char * s = Perl_form("%d.%d",major,minor);
2390 Uses a single private buffer so if you want to format several strings you
2391 must explicitly copy the earlier strings away (and free the copies when you
2394 char* form(const char* pat, ...)
2397 Found in file util.c
2402 Fill the sv with current working directory
2404 int getcwd_sv(SV* sv)
2407 Found in file util.c
2412 The C library C<snprintf> functionality, if available and
2413 standards-compliant (uses C<vsnprintf>, actually). However, if the
2414 C<vsnprintf> is not available, will unfortunately use the unsafe
2415 C<vsprintf> which can overrun the buffer (there is an overrun check,
2416 but that may be too late). Consider using C<sv_vcatpvf> instead, or
2417 getting C<vsnprintf>.
2419 int my_snprintf(char *buffer, const Size_t len, const char *format, ...)
2422 Found in file util.c
2427 The C library C<sprintf>, wrapped if necessary, to ensure that it will return
2428 the length of the string written to the buffer. Only rare pre-ANSI systems
2429 need the wrapper function - usually this is a direct call to C<sprintf>.
2431 int my_sprintf(char *buffer, const char *pat, ...)
2434 Found in file util.c
2439 The C library C<vsnprintf> if available and standards-compliant.
2440 However, if if the C<vsnprintf> is not available, will unfortunately
2441 use the unsafe C<vsprintf> which can overrun the buffer (there is an
2442 overrun check, but that may be too late). Consider using
2443 C<sv_vcatpvf> instead, or getting C<vsnprintf>.
2445 int my_vsnprintf(char *buffer, const Size_t len, const char *format, va_list ap)
2448 Found in file util.c
2453 Returns a new version object based on the passed in SV:
2455 SV *sv = new_version(SV *ver);
2457 Does not alter the passed in ver SV. See "upg_version" if you
2458 want to upgrade the SV.
2460 SV* new_version(SV *ver)
2463 Found in file util.c
2468 Returns a pointer to the next character after the parsed
2469 version string, as well as upgrading the passed in SV to
2472 Function must be called with an already existing SV like
2475 s = scan_version(s,SV *sv, bool qv);
2477 Performs some preprocessing to the string to ensure that
2478 it has the correct characteristics of a version. Flags the
2479 object if it contains an underscore (which denotes this
2480 is a alpha version). The boolean qv denotes that the version
2481 should be interpreted as if it had multiple decimals, even if
2484 const char* scan_version(const char *vstr, SV *sv, bool qv)
2487 Found in file util.c
2492 Test two strings to see if they are equal. Returns true or false.
2494 bool strEQ(char* s1, char* s2)
2497 Found in file handy.h
2502 Test two strings to see if the first, C<s1>, is greater than or equal to
2503 the second, C<s2>. Returns true or false.
2505 bool strGE(char* s1, char* s2)
2508 Found in file handy.h
2513 Test two strings to see if the first, C<s1>, is greater than the second,
2514 C<s2>. Returns true or false.
2516 bool strGT(char* s1, char* s2)
2519 Found in file handy.h
2524 Test two strings to see if the first, C<s1>, is less than or equal to the
2525 second, C<s2>. Returns true or false.
2527 bool strLE(char* s1, char* s2)
2530 Found in file handy.h
2535 Test two strings to see if the first, C<s1>, is less than the second,
2536 C<s2>. Returns true or false.
2538 bool strLT(char* s1, char* s2)
2541 Found in file handy.h
2546 Test two strings to see if they are different. Returns true or
2549 bool strNE(char* s1, char* s2)
2552 Found in file handy.h
2557 Test two strings to see if they are equal. The C<len> parameter indicates
2558 the number of bytes to compare. Returns true or false. (A wrapper for
2561 bool strnEQ(char* s1, char* s2, STRLEN len)
2564 Found in file handy.h
2569 Test two strings to see if they are different. The C<len> parameter
2570 indicates the number of bytes to compare. Returns true or false. (A
2571 wrapper for C<strncmp>).
2573 bool strnNE(char* s1, char* s2, STRLEN len)
2576 Found in file handy.h
2581 Dummy routine which "shares" an SV when there is no sharing module present.
2582 Or "locks" it. Or "unlocks" it. In other words, ignores its single SV argument.
2583 Exists to avoid test for a NULL function pointer and because it could
2584 potentially warn under some level of strict-ness.
2586 void sv_nosharing(SV *sv)
2589 Found in file util.c
2594 In-place upgrade of the supplied SV to a version object.
2596 SV *sv = upg_version(SV *sv);
2598 Returns a pointer to the upgraded SV.
2600 SV* upg_version(SV *ver)
2603 Found in file util.c
2608 Version object aware cmp. Both operands must already have been
2609 converted into version objects.
2611 int vcmp(SV *lvs, SV *rvs)
2614 Found in file util.c
2619 Accepts a version object and returns the normalized string
2620 representation. Call like:
2624 NOTE: you can pass either the object directly or the SV
2625 contained within the RV.
2630 Found in file util.c
2635 Accepts a version object and returns the normalized floating
2636 point representation. Call like:
2640 NOTE: you can pass either the object directly or the SV
2641 contained within the RV.
2646 Found in file util.c
2651 In order to maintain maximum compatibility with earlier versions
2652 of Perl, this function will return either the floating point
2653 notation or the multiple dotted notation, depending on whether
2654 the original version contained 1 or more dots, respectively
2656 SV* vstringify(SV *vs)
2659 Found in file util.c
2664 Validates that the SV contains a valid version object.
2666 bool vverify(SV *vobj);
2668 Note that it only confirms the bare minimum structure (so as not to get
2669 confused by derived classes which may contain additional hash entries):
2671 bool vverify(SV *vs)
2674 Found in file util.c
2679 =head1 Multicall Functions
2686 Declare local variables for a multicall. See L<perlcall/Lightweight Callbacks>.
2696 Make a lightweight callback. See L<perlcall/Lightweight Callbacks>.
2706 Closing bracket for a lightweight callback.
2707 See L<perlcall/Lightweight Callbacks>.
2714 =item PUSH_MULTICALL
2717 Opening bracket for a lightweight callback.
2718 See L<perlcall/Lightweight Callbacks>.
2728 =head1 Numeric functions
2735 converts a string representing a binary number to numeric form.
2737 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2738 conversion flags, and I<result> should be NULL or a pointer to an NV.
2739 The scan stops at the end of the string, or the first invalid character.
2740 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2741 invalid character will also trigger a warning.
2742 On return I<*len> is set to the length of the scanned string,
2743 and I<*flags> gives output flags.
2745 If the value is <= C<UV_MAX> it is returned as a UV, the output flags are clear,
2746 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_bin>
2747 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2748 and writes the value to I<*result> (or the value is discarded if I<result>
2751 The binary number may optionally be prefixed with "0b" or "b" unless
2752 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
2753 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the binary
2754 number may use '_' characters to separate digits.
2756 UV grok_bin(const char* start, STRLEN* len_p, I32* flags, NV *result)
2759 Found in file numeric.c
2764 converts a string representing a hex number to numeric form.
2766 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2767 conversion flags, and I<result> should be NULL or a pointer to an NV.
2768 The scan stops at the end of the string, or the first invalid character.
2769 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2770 invalid character will also trigger a warning.
2771 On return I<*len> is set to the length of the scanned string,
2772 and I<*flags> gives output flags.
2774 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2775 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_hex>
2776 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2777 and writes the value to I<*result> (or the value is discarded if I<result>
2780 The hex number may optionally be prefixed with "0x" or "x" unless
2781 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
2782 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the hex
2783 number may use '_' characters to separate digits.
2785 UV grok_hex(const char* start, STRLEN* len_p, I32* flags, NV *result)
2788 Found in file numeric.c
2793 Recognise (or not) a number. The type of the number is returned
2794 (0 if unrecognised), otherwise it is a bit-ORed combination of
2795 IS_NUMBER_IN_UV, IS_NUMBER_GREATER_THAN_UV_MAX, IS_NUMBER_NOT_INT,
2796 IS_NUMBER_NEG, IS_NUMBER_INFINITY, IS_NUMBER_NAN (defined in perl.h).
2798 If the value of the number can fit an in UV, it is returned in the *valuep
2799 IS_NUMBER_IN_UV will be set to indicate that *valuep is valid, IS_NUMBER_IN_UV
2800 will never be set unless *valuep is valid, but *valuep may have been assigned
2801 to during processing even though IS_NUMBER_IN_UV is not set on return.
2802 If valuep is NULL, IS_NUMBER_IN_UV will be set for the same cases as when
2803 valuep is non-NULL, but no actual assignment (or SEGV) will occur.
2805 IS_NUMBER_NOT_INT will be set with IS_NUMBER_IN_UV if trailing decimals were
2806 seen (in which case *valuep gives the true value truncated to an integer), and
2807 IS_NUMBER_NEG if the number is negative (in which case *valuep holds the
2808 absolute value). IS_NUMBER_IN_UV is not set if e notation was used or the
2809 number is larger than a UV.
2811 int grok_number(const char *pv, STRLEN len, UV *valuep)
2814 Found in file numeric.c
2816 =item grok_numeric_radix
2817 X<grok_numeric_radix>
2819 Scan and skip for a numeric decimal separator (radix).
2821 bool grok_numeric_radix(const char **sp, const char *send)
2824 Found in file numeric.c
2829 converts a string representing an octal number to numeric form.
2831 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2832 conversion flags, and I<result> should be NULL or a pointer to an NV.
2833 The scan stops at the end of the string, or the first invalid character.
2834 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2835 invalid character will also trigger a warning.
2836 On return I<*len> is set to the length of the scanned string,
2837 and I<*flags> gives output flags.
2839 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2840 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_oct>
2841 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2842 and writes the value to I<*result> (or the value is discarded if I<result>
2845 If C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the octal
2846 number may use '_' characters to separate digits.
2848 UV grok_oct(const char* start, STRLEN* len_p, I32* flags, NV *result)
2851 Found in file numeric.c
2856 For backwards compatibility. Use C<grok_bin> instead.
2858 NV scan_bin(const char* start, STRLEN len, STRLEN* retlen)
2861 Found in file numeric.c
2866 For backwards compatibility. Use C<grok_hex> instead.
2868 NV scan_hex(const char* start, STRLEN len, STRLEN* retlen)
2871 Found in file numeric.c
2876 For backwards compatibility. Use C<grok_oct> instead.
2878 NV scan_oct(const char* start, STRLEN len, STRLEN* retlen)
2881 Found in file numeric.c
2886 =head1 Optree Manipulation Functions
2893 If C<cv> is a constant sub eligible for inlining. returns the constant
2894 value returned by the sub. Otherwise, returns NULL.
2896 Constant subs can be created with C<newCONSTSUB> or as described in
2897 L<perlsub/"Constant Functions">.
2899 SV* cv_const_sv(CV* cv)
2907 Creates a constant sub equivalent to Perl C<sub FOO () { 123 }> which is
2908 eligible for inlining at compile-time.
2910 CV* newCONSTSUB(HV* stash, const char* name, SV* sv)
2918 Used by C<xsubpp> to hook up XSUBs as Perl subs. I<filename> needs to be
2919 static storage, as it is used directly as CvFILE(), without a copy being made.
2927 =head1 Pad Data Structures
2934 Get the value at offset po in the current pad.
2935 Use macro PAD_SV instead of calling this function directly.
2937 SV* pad_sv(PADOFFSET po)
2945 =head1 Simple Exception Handling Macros
2952 Set up necessary local variables for exception handling.
2953 See L<perlguts/"Exception Handling">.
2958 Found in file XSUB.h
2963 Introduces a catch block. See L<perlguts/"Exception Handling">.
2966 Found in file XSUB.h
2971 Rethrows a previously caught exception. See L<perlguts/"Exception Handling">.
2976 Found in file XSUB.h
2981 Ends a try block. See L<perlguts/"Exception Handling">.
2984 Found in file XSUB.h
2986 =item XCPT_TRY_START
2989 Starts a try block. See L<perlguts/"Exception Handling">.
2992 Found in file XSUB.h
2997 =head1 Stack Manipulation Macros
3004 Declare a stack marker variable, C<mark>, for the XSUB. See C<MARK> and
3015 Saves the original stack mark for the XSUB. See C<ORIGMARK>.
3025 Declares a local copy of perl's stack pointer for the XSUB, available via
3026 the C<SP> macro. See C<SP>.
3036 Used to extend the argument stack for an XSUB's return values. Once
3037 used, guarantees that there is room for at least C<nitems> to be pushed
3040 void EXTEND(SP, int nitems)
3048 Stack marker variable for the XSUB. See C<dMARK>.
3056 Push an integer onto the stack. The stack must have room for this element.
3057 Handles 'set' magic. Does not use C<TARG>. See also C<PUSHi>, C<mXPUSHi>
3068 Push a double onto the stack. The stack must have room for this element.
3069 Handles 'set' magic. Does not use C<TARG>. See also C<PUSHn>, C<mXPUSHn>
3080 Push a string onto the stack. The stack must have room for this element.
3081 The C<len> indicates the length of the string. Handles 'set' magic. Does
3082 not use C<TARG>. See also C<PUSHp>, C<mXPUSHp> and C<XPUSHp>.
3084 void mPUSHp(char* str, STRLEN len)
3092 Push an unsigned integer onto the stack. The stack must have room for this
3093 element. Handles 'set' magic. Does not use C<TARG>. See also C<PUSHu>,
3094 C<mXPUSHu> and C<XPUSHu>.
3104 Push an integer onto the stack, extending the stack if necessary. Handles
3105 'set' magic. Does not use C<TARG>. See also C<XPUSHi>, C<mPUSHi> and
3116 Push a double onto the stack, extending the stack if necessary. Handles
3117 'set' magic. Does not use C<TARG>. See also C<XPUSHn>, C<mPUSHn> and
3128 Push a string onto the stack, extending the stack if necessary. The C<len>
3129 indicates the length of the string. Handles 'set' magic. Does not use
3130 C<TARG>. See also C<XPUSHp>, C<mPUSHp> and C<PUSHp>.
3132 void mXPUSHp(char* str, STRLEN len)
3140 Push an unsigned integer onto the stack, extending the stack if necessary.
3141 Handles 'set' magic. Does not use C<TARG>. See also C<XPUSHu>, C<mPUSHu>
3152 The original stack mark for the XSUB. See C<dORIGMARK>.
3160 Pops an integer off the stack.
3170 Pops a long off the stack.
3180 Pops a double off the stack.
3190 Pops a string off the stack. Deprecated. New code should use POPpx.
3200 Pops a string off the stack which must consist of bytes i.e. characters < 256.
3210 Pops a string off the stack.
3220 Pops an SV off the stack.
3230 Push an integer onto the stack. The stack must have room for this element.
3231 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3232 called to declare it. Do not call multiple C<TARG>-oriented macros to
3233 return lists from XSUB's - see C<mPUSHi> instead. See also C<XPUSHi> and
3244 Opening bracket for arguments on a callback. See C<PUTBACK> and
3255 Push a new mortal SV onto the stack. The stack must have room for this
3256 element. Does not handle 'set' magic. Does not use C<TARG>. See also
3257 C<PUSHs>, C<XPUSHmortal> and C<XPUSHs>.
3267 Push a double onto the stack. The stack must have room for this element.
3268 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3269 called to declare it. Do not call multiple C<TARG>-oriented macros to
3270 return lists from XSUB's - see C<mPUSHn> instead. See also C<XPUSHn> and
3281 Push a string onto the stack. The stack must have room for this element.
3282 The C<len> indicates the length of the string. Handles 'set' magic. Uses
3283 C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to declare it. Do not
3284 call multiple C<TARG>-oriented macros to return lists from XSUB's - see
3285 C<mPUSHp> instead. See also C<XPUSHp> and C<mXPUSHp>.
3287 void PUSHp(char* str, STRLEN len)
3295 Push an SV onto the stack. The stack must have room for this element.
3296 Does not handle 'set' magic. Does not use C<TARG>. See also C<PUSHmortal>,
3297 C<XPUSHs> and C<XPUSHmortal>.
3307 Push an unsigned integer onto the stack. The stack must have room for this
3308 element. Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG>
3309 should be called to declare it. Do not call multiple C<TARG>-oriented
3310 macros to return lists from XSUB's - see C<mPUSHu> instead. See also
3311 C<XPUSHu> and C<mXPUSHu>.
3321 Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
3322 See C<PUSHMARK> and L<perlcall> for other uses.
3332 Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and
3341 Refetch the stack pointer. Used after a callback. See L<perlcall>.
3351 Push an integer onto the stack, extending the stack if necessary. Handles
3352 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
3353 declare it. Do not call multiple C<TARG>-oriented macros to return lists
3354 from XSUB's - see C<mXPUSHi> instead. See also C<PUSHi> and C<mPUSHi>.
3364 Push a new mortal SV onto the stack, extending the stack if necessary. Does
3365 not handle 'set' magic. Does not use C<TARG>. See also C<XPUSHs>,
3366 C<PUSHmortal> and C<PUSHs>.
3376 Push a double onto the stack, extending the stack if necessary. Handles
3377 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
3378 declare it. Do not call multiple C<TARG>-oriented macros to return lists
3379 from XSUB's - see C<mXPUSHn> instead. See also C<PUSHn> and C<mPUSHn>.
3389 Push a string onto the stack, extending the stack if necessary. The C<len>
3390 indicates the length of the string. Handles 'set' magic. Uses C<TARG>, so
3391 C<dTARGET> or C<dXSTARG> should be called to declare it. Do not call
3392 multiple C<TARG>-oriented macros to return lists from XSUB's - see
3393 C<mXPUSHp> instead. See also C<PUSHp> and C<mPUSHp>.
3395 void XPUSHp(char* str, STRLEN len)
3403 Push an SV onto the stack, extending the stack if necessary. Does not
3404 handle 'set' magic. Does not use C<TARG>. See also C<XPUSHmortal>,
3405 C<PUSHs> and C<PUSHmortal>.
3415 Push an unsigned integer onto the stack, extending the stack if necessary.
3416 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3417 called to declare it. Do not call multiple C<TARG>-oriented macros to
3418 return lists from XSUB's - see C<mXPUSHu> instead. See also C<PUSHu> and
3429 Return from XSUB, indicating number of items on the stack. This is usually
3430 handled by C<xsubpp>.
3432 void XSRETURN(int nitems)
3435 Found in file XSUB.h
3437 =item XSRETURN_EMPTY
3440 Return an empty list from an XSUB immediately.
3445 Found in file XSUB.h
3450 Return an integer from an XSUB immediately. Uses C<XST_mIV>.
3452 void XSRETURN_IV(IV iv)
3455 Found in file XSUB.h
3460 Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
3465 Found in file XSUB.h
3470 Return a double from an XSUB immediately. Uses C<XST_mNV>.
3472 void XSRETURN_NV(NV nv)
3475 Found in file XSUB.h
3480 Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
3482 void XSRETURN_PV(char* str)
3485 Found in file XSUB.h
3487 =item XSRETURN_UNDEF
3490 Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
3495 Found in file XSUB.h
3500 Return an integer from an XSUB immediately. Uses C<XST_mUV>.
3502 void XSRETURN_UV(IV uv)
3505 Found in file XSUB.h
3510 Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
3515 Found in file XSUB.h
3520 Place an integer into the specified position C<pos> on the stack. The
3521 value is stored in a new mortal SV.
3523 void XST_mIV(int pos, IV iv)
3526 Found in file XSUB.h
3531 Place C<&PL_sv_no> into the specified position C<pos> on the
3534 void XST_mNO(int pos)
3537 Found in file XSUB.h
3542 Place a double into the specified position C<pos> on the stack. The value
3543 is stored in a new mortal SV.
3545 void XST_mNV(int pos, NV nv)
3548 Found in file XSUB.h
3553 Place a copy of a string into the specified position C<pos> on the stack.
3554 The value is stored in a new mortal SV.
3556 void XST_mPV(int pos, char* str)
3559 Found in file XSUB.h
3564 Place C<&PL_sv_undef> into the specified position C<pos> on the
3567 void XST_mUNDEF(int pos)
3570 Found in file XSUB.h
3575 Place C<&PL_sv_yes> into the specified position C<pos> on the
3578 void XST_mYES(int pos)
3581 Found in file XSUB.h
3593 An enum of flags for Perl types. These are found in the file B<sv.h>
3594 in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
3602 Integer type flag for scalars. See C<svtype>.
3610 Double type flag for scalars. See C<svtype>.
3618 Pointer type flag for scalars. See C<svtype>.
3626 Type flag for arrays. See C<svtype>.
3634 Type flag for code refs. See C<svtype>.
3642 Type flag for hashes. See C<svtype>.
3650 Type flag for blessed scalars. See C<svtype>.
3658 =head1 SV Manipulation Functions
3665 Returns the SV of the specified Perl scalar. If C<create> is set and the
3666 Perl variable does not exist then it will be created. If C<create> is not
3667 set and the variable does not exist then NULL is returned.
3669 NOTE: the perl_ form of this function is deprecated.
3671 SV* get_sv(const char* name, I32 create)
3674 Found in file perl.c
3679 Creates an RV wrapper for an SV. The reference count for the original SV is
3682 SV* newRV_inc(SV* sv)
3690 Returns the length of the string which is in the SV. See C<SvLEN>.
3692 STRLEN SvCUR(SV* sv)
3700 Set the current length of the string which is in the SV. See C<SvCUR>
3703 void SvCUR_set(SV* sv, STRLEN len)
3711 Returns a pointer to the last character in the string which is in the SV.
3712 See C<SvCUR>. Access the character as *(SvEND(sv)).
3722 Returns true if the SV has get magic or overloading. If either is true then
3723 the scalar is active data, and has the potential to return a new value every
3724 time it is accessed. Hence you must be careful to only read it once per user
3725 logical operation and work with that returned value. If neither is true then
3726 the scalar's value cannot change unless written to.
3728 char* SvGAMAGIC(SV* sv)
3736 Expands the character buffer in the SV so that it has room for the
3737 indicated number of bytes (remember to reserve space for an extra trailing
3738 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
3739 Returns a pointer to the character buffer.
3741 char * SvGROW(SV* sv, STRLEN len)
3749 Returns a boolean indicating whether the SV contains an integer.
3759 Returns a boolean indicating whether the SV contains an integer. Checks
3760 the B<private> setting. Use C<SvIOK>.
3770 Returns a boolean indicating whether the SV contains a signed integer.
3772 bool SvIOK_notUV(SV* sv)
3780 Unsets the IV status of an SV.
3782 void SvIOK_off(SV* sv)
3790 Tells an SV that it is an integer.
3792 void SvIOK_on(SV* sv)
3800 Tells an SV that it is an integer and disables all other OK bits.
3802 void SvIOK_only(SV* sv)
3810 Tells and SV that it is an unsigned integer and disables all other OK bits.
3812 void SvIOK_only_UV(SV* sv)
3820 Returns a boolean indicating whether the SV contains an unsigned integer.
3822 bool SvIOK_UV(SV* sv)
3830 Returns a boolean indicating whether the SV is Copy-On-Write. (either shared
3831 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
3834 bool SvIsCOW(SV* sv)
3839 =item SvIsCOW_shared_hash
3840 X<SvIsCOW_shared_hash>
3842 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
3845 bool SvIsCOW_shared_hash(SV* sv)
3853 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
3854 version which guarantees to evaluate sv only once.
3864 Returns the raw value in the SV's IV slot, without checks or conversions.
3865 Only use when you are sure SvIOK is true. See also C<SvIV()>.
3875 Coerces the given SV to an integer and returns it. Guarantees to evaluate
3876 sv only once. Use the more efficient C<SvIV> otherwise.
3886 Like C<SvIV> but doesn't process magic.
3888 IV SvIV_nomg(SV* sv)
3896 Set the value of the IV pointer in sv to val. It is possible to perform
3897 the same function of this macro with an lvalue assignment to C<SvIVX>.
3898 With future Perls, however, it will be more efficient to use
3899 C<SvIV_set> instead of the lvalue assignment to C<SvIVX>.
3901 void SvIV_set(SV* sv, IV val)
3909 Returns the size of the string buffer in the SV, not including any part
3910 attributable to C<SvOOK>. See C<SvCUR>.
3912 STRLEN SvLEN(SV* sv)
3920 Set the actual length of the string which is in the SV. See C<SvIV_set>.
3922 void SvLEN_set(SV* sv, STRLEN len)
3930 Set the value of the MAGIC pointer in sv to val. See C<SvIV_set>.
3932 void SvMAGIC_set(SV* sv, MAGIC* val)
3940 Returns a boolean indicating whether the SV contains a number, integer or
3951 Returns a boolean indicating whether the SV contains a number, integer or
3952 double. Checks the B<private> setting. Use C<SvNIOK>.
3954 bool SvNIOKp(SV* sv)
3962 Unsets the NV/IV status of an SV.
3964 void SvNIOK_off(SV* sv)
3972 Returns a boolean indicating whether the SV contains a double.
3982 Returns a boolean indicating whether the SV contains a double. Checks the
3983 B<private> setting. Use C<SvNOK>.
3993 Unsets the NV status of an SV.
3995 void SvNOK_off(SV* sv)
4003 Tells an SV that it is a double.
4005 void SvNOK_on(SV* sv)
4013 Tells an SV that it is a double and disables all other OK bits.
4015 void SvNOK_only(SV* sv)
4023 Coerce the given SV to a double and return it. See C<SvNVx> for a version
4024 which guarantees to evaluate sv only once.
4034 Returns the raw value in the SV's NV slot, without checks or conversions.
4035 Only use when you are sure SvNOK is true. See also C<SvNV()>.
4045 Coerces the given SV to a double and returns it. Guarantees to evaluate
4046 sv only once. Use the more efficient C<SvNV> otherwise.
4056 Set the value of the NV pointer in sv to val. See C<SvIV_set>.
4058 void SvNV_set(SV* sv, NV val)
4066 Returns a boolean indicating whether the value is an SV. It also tells
4067 whether the value is defined or not.
4077 Returns a boolean indicating whether the SvIVX is a valid offset value for
4078 the SvPVX. This hack is used internally to speed up removal of characters
4079 from the beginning of a SvPV. When SvOOK is true, then the start of the
4080 allocated string buffer is really (SvPVX - SvIVX).
4090 Returns a boolean indicating whether the SV contains a character
4101 Returns a boolean indicating whether the SV contains a character string.
4102 Checks the B<private> setting. Use C<SvPOK>.
4112 Unsets the PV status of an SV.
4114 void SvPOK_off(SV* sv)
4122 Tells an SV that it is a string.
4124 void SvPOK_on(SV* sv)
4132 Tells an SV that it is a string and disables all other OK bits.
4133 Will also turn off the UTF-8 status.
4135 void SvPOK_only(SV* sv)
4140 =item SvPOK_only_UTF8
4143 Tells an SV that it is a string and disables all other OK bits,
4144 and leaves the UTF-8 status as it was.
4146 void SvPOK_only_UTF8(SV* sv)
4154 Returns a pointer to the string in the SV, or a stringified form of
4155 the SV if the SV does not contain a string. The SV may cache the
4156 stringified version becoming C<SvPOK>. Handles 'get' magic. See also
4157 C<SvPVx> for a version which guarantees to evaluate sv only once.
4159 char* SvPV(SV* sv, STRLEN len)
4167 Like C<SvPV>, but converts sv to byte representation first if necessary.
4169 char* SvPVbyte(SV* sv, STRLEN len)
4177 Like C<SvPV>, but converts sv to byte representation first if necessary.
4178 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
4181 char* SvPVbytex(SV* sv, STRLEN len)
4186 =item SvPVbytex_force
4189 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
4190 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
4193 char* SvPVbytex_force(SV* sv, STRLEN len)
4198 =item SvPVbyte_force
4201 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
4203 char* SvPVbyte_force(SV* sv, STRLEN len)
4208 =item SvPVbyte_nolen
4211 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
4213 char* SvPVbyte_nolen(SV* sv)
4221 Like C<SvPV>, but converts sv to utf8 first if necessary.
4223 char* SvPVutf8(SV* sv, STRLEN len)
4231 Like C<SvPV>, but converts sv to utf8 first if necessary.
4232 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
4235 char* SvPVutf8x(SV* sv, STRLEN len)
4240 =item SvPVutf8x_force
4243 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
4244 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
4247 char* SvPVutf8x_force(SV* sv, STRLEN len)
4252 =item SvPVutf8_force
4255 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
4257 char* SvPVutf8_force(SV* sv, STRLEN len)
4262 =item SvPVutf8_nolen
4265 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
4267 char* SvPVutf8_nolen(SV* sv)
4275 Returns a pointer to the physical string in the SV. The SV must contain a
4286 A version of C<SvPV> which guarantees to evaluate sv only once.
4288 char* SvPVx(SV* sv, STRLEN len)
4296 Like C<SvPV> but will force the SV into containing just a string
4297 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
4300 char* SvPV_force(SV* sv, STRLEN len)
4305 =item SvPV_force_nomg
4308 Like C<SvPV> but will force the SV into containing just a string
4309 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
4310 directly. Doesn't process magic.
4312 char* SvPV_force_nomg(SV* sv, STRLEN len)
4320 Returns a pointer to the string in the SV, or a stringified form of
4321 the SV if the SV does not contain a string. The SV may cache the
4322 stringified form becoming C<SvPOK>. Handles 'get' magic.
4324 char* SvPV_nolen(SV* sv)
4332 Like C<SvPV> but doesn't process magic.
4334 char* SvPV_nomg(SV* sv, STRLEN len)
4342 Set the value of the PV pointer in sv to val. See C<SvIV_set>.
4344 void SvPV_set(SV* sv, char* val)
4352 Returns the value of the object's reference count.
4354 U32 SvREFCNT(SV* sv)
4362 Decrements the reference count of the given SV.
4364 void SvREFCNT_dec(SV* sv)
4372 Increments the reference count of the given SV.
4374 All of the following SvREFCNT_inc* macros are optimized versions of
4375 SvREFCNT_inc, and can be replaced with SvREFCNT_inc.
4377 SV* SvREFCNT_inc(SV* sv)
4382 =item SvREFCNT_inc_NN
4385 Same as SvREFCNT_inc, but can only be used if you know I<sv>
4386 is not NULL. Since we don't have to check the NULLness, it's faster
4389 SV* SvREFCNT_inc_NN(SV* sv)
4394 =item SvREFCNT_inc_simple
4395 X<SvREFCNT_inc_simple>
4397 Same as SvREFCNT_inc, but can only be used with simple variables, not
4398 expressions or pointer dereferences. Since we don't have to store a
4399 temporary value, it's faster.
4401 SV* SvREFCNT_inc_simple(SV* sv)
4406 =item SvREFCNT_inc_simple_NN
4407 X<SvREFCNT_inc_simple_NN>
4409 Same as SvREFCNT_inc_simple, but can only be used if you know I<sv>
4410 is not NULL. Since we don't have to check the NULLness, it's faster
4413 SV* SvREFCNT_inc_simple_NN(SV* sv)
4418 =item SvREFCNT_inc_simple_void
4419 X<SvREFCNT_inc_simple_void>
4421 Same as SvREFCNT_inc_simple, but can only be used if you don't need the
4422 return value. The macro doesn't need to return a meaningful value.
4424 void SvREFCNT_inc_simple_void(SV* sv)
4429 =item SvREFCNT_inc_simple_void_NN
4430 X<SvREFCNT_inc_simple_void_NN>
4432 Same as SvREFCNT_inc, but can only be used if you don't need the return
4433 value, and you know that I<sv> is not NULL. The macro doesn't need
4434 to return a meaningful value, or check for NULLness, so it's smaller
4437 void SvREFCNT_inc_simple_void_NN(SV* sv)
4442 =item SvREFCNT_inc_void
4443 X<SvREFCNT_inc_void>
4445 Same as SvREFCNT_inc, but can only be used if you don't need the
4446 return value. The macro doesn't need to return a meaningful value.
4448 void SvREFCNT_inc_void(SV* sv)
4453 =item SvREFCNT_inc_void_NN
4454 X<SvREFCNT_inc_void_NN>
4456 Same as SvREFCNT_inc, but can only be used if you don't need the return
4457 value, and you know that I<sv> is not NULL. The macro doesn't need
4458 to return a meaningful value, or check for NULLness, so it's smaller
4461 void SvREFCNT_inc_void_NN(SV* sv)
4469 Tests if the SV is an RV.
4479 Unsets the RV status of an SV.
4481 void SvROK_off(SV* sv)
4489 Tells an SV that it is an RV.
4491 void SvROK_on(SV* sv)
4499 Dereferences an RV to return the SV.
4509 Set the value of the RV pointer in sv to val. See C<SvIV_set>.
4511 void SvRV_set(SV* sv, SV* val)
4519 Returns the stash of the SV.
4529 Set the value of the STASH pointer in sv to val. See C<SvIV_set>.
4531 void SvSTASH_set(SV* sv, HV* val)
4539 Taints an SV if tainting is enabled.
4541 void SvTAINT(SV* sv)
4549 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
4552 bool SvTAINTED(SV* sv)
4560 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
4561 some of Perl's fundamental security features. XS module authors should not
4562 use this function unless they fully understand all the implications of
4563 unconditionally untainting the value. Untainting should be done in the
4564 standard perl fashion, via a carefully crafted regexp, rather than directly
4565 untainting variables.
4567 void SvTAINTED_off(SV* sv)
4575 Marks an SV as tainted if tainting is enabled.
4577 void SvTAINTED_on(SV* sv)
4585 Returns a boolean indicating whether Perl would evaluate the SV as true or
4586 false, defined or undefined. Does not handle 'get' magic.
4596 Returns the type of the SV. See C<svtype>.
4598 svtype SvTYPE(SV* sv)
4606 Returns a boolean indicating whether the SV contains an unsigned integer.
4616 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
4617 perform the upgrade if necessary. See C<svtype>.
4619 void SvUPGRADE(SV* sv, svtype type)
4627 Returns a boolean indicating whether the SV contains UTF-8 encoded data.
4637 Unsets the UTF-8 status of an SV.
4639 void SvUTF8_off(SV *sv)
4647 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
4648 Do not use frivolously.
4650 void SvUTF8_on(SV *sv)
4658 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
4659 for a version which guarantees to evaluate sv only once.
4669 Returns the raw value in the SV's UV slot, without checks or conversions.
4670 Only use when you are sure SvIOK is true. See also C<SvUV()>.
4680 Coerces the given SV to an unsigned integer and returns it. Guarantees to
4681 evaluate sv only once. Use the more efficient C<SvUV> otherwise.
4691 Like C<SvUV> but doesn't process magic.
4693 UV SvUV_nomg(SV* sv)
4701 Set the value of the UV pointer in sv to val. See C<SvIV_set>.
4703 void SvUV_set(SV* sv, UV val)
4711 Returns a boolean indicating whether the SV contains a v-string.
4718 =item sv_catpvn_nomg
4721 Like C<sv_catpvn> but doesn't process magic.
4723 void sv_catpvn_nomg(SV* sv, const char* ptr, STRLEN len)
4731 Like C<sv_catsv> but doesn't process magic.
4733 void sv_catsv_nomg(SV* dsv, SV* ssv)
4738 =item sv_derived_from
4741 Returns a boolean indicating whether the SV is derived from the specified class
4742 I<at the C level>. To check derivation at the Perl level, call C<isa()> as a
4745 bool sv_derived_from(SV* sv, const char* name)
4748 Found in file universal.c
4753 Returns a boolean indicating whether the SV performs a specific, named role.
4754 The SV can be a Perl object or the name of a Perl class.
4756 bool sv_does(SV* sv, const char* name)
4759 Found in file universal.c
4761 =item sv_report_used
4764 Dump the contents of all SVs not yet freed. (Debugging aid).
4766 void sv_report_used()
4774 Like C<sv_setsv> but doesn't process magic.
4776 void sv_setsv_nomg(SV* dsv, SV* ssv)
4784 =head1 SV-Body Allocation
4788 =item looks_like_number
4789 X<looks_like_number>
4791 Test if the content of an SV looks like a number (or is a number).
4792 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
4793 non-numeric warning), even if your atof() doesn't grok them.
4795 I32 looks_like_number(SV* sv)
4803 Creates an RV wrapper for an SV. The reference count for the original
4804 SV is B<not> incremented.
4806 SV* newRV_noinc(SV* sv)
4814 Creates a new SV. A non-zero C<len> parameter indicates the number of
4815 bytes of preallocated string space the SV should have. An extra byte for a
4816 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4817 space is allocated.) The reference count for the new SV is set to 1.
4819 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4820 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4821 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4822 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4823 modules supporting older perls.
4825 SV* newSV(STRLEN len)
4833 Creates a new SV from the hash key structure. It will generate scalars that
4834 point to the shared string table where possible. Returns a new (undefined)
4835 SV if the hek is NULL.
4837 SV* newSVhek(const HEK *hek)
4845 Creates a new SV and copies an integer into it. The reference count for the
4856 Creates a new SV and copies a floating point value into it.
4857 The reference count for the SV is set to 1.
4867 Creates a new SV and copies a string into it. The reference count for the
4868 SV is set to 1. If C<len> is zero, Perl will compute the length using
4869 strlen(). For efficiency, consider using C<newSVpvn> instead.
4871 SV* newSVpv(const char* s, STRLEN len)
4879 Creates a new SV and initializes it with the string formatted like
4882 SV* newSVpvf(const char* pat, ...)
4890 Creates a new SV and copies a string into it. The reference count for the
4891 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
4892 string. You are responsible for ensuring that the source string is at least
4893 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
4895 SV* newSVpvn(const char* s, STRLEN len)
4900 =item newSVpvn_share
4903 Creates a new SV with its SvPVX_const pointing to a shared string in the string
4904 table. If the string does not already exist in the table, it is created
4905 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
4906 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
4907 otherwise the hash is computed. The idea here is that as the string table
4908 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
4909 hash lookup will avoid string compare.
4911 SV* newSVpvn_share(const char* s, I32 len, U32 hash)
4919 Like C<newSVpvn>, but takes a literal string instead of a string/length pair.
4921 SV* newSVpvs(const char* s)
4924 Found in file handy.h
4926 =item newSVpvs_share
4929 Like C<newSVpvn_share>, but takes a literal string instead of a string/length
4930 pair and omits the hash parameter.
4932 SV* newSVpvs_share(const char* s)
4935 Found in file handy.h
4940 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
4941 it will be upgraded to one. If C<classname> is non-null then the new SV will
4942 be blessed in the specified package. The new SV is returned and its
4943 reference count is 1.
4945 SV* newSVrv(SV* rv, const char* classname)
4953 Creates a new SV which is an exact duplicate of the original SV.
4956 SV* newSVsv(SV* old)
4964 Creates a new SV and copies an unsigned integer into it.
4965 The reference count for the SV is set to 1.
4975 This function is only called on magical items, and is only used by
4976 sv_true() or its macro equivalent.
4978 bool sv_2bool(SV* sv)
4986 Using various gambits, try to get a CV from an SV; in addition, try if
4987 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
4988 The flags in C<lref> are passed to sv_fetchsv.
4990 CV* sv_2cv(SV* sv, HV** st, GV** gvp, I32 lref)
4998 Using various gambits, try to get an IO from an SV: the IO slot if its a
4999 GV; or the recursive result if we're an RV; or the IO slot of the symbol
5000 named after the PV if we're a string.
5010 Return the integer value of an SV, doing any necessary string
5011 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
5012 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
5014 IV sv_2iv_flags(SV* sv, I32 flags)
5022 Marks an existing SV as mortal. The SV will be destroyed "soon", either
5023 by an explicit call to FREETMPS, or by an implicit call at places such as
5024 statement boundaries. SvTEMP() is turned on which means that the SV's
5025 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
5026 and C<sv_mortalcopy>.
5028 SV* sv_2mortal(SV* sv)
5036 Return the num value of an SV, doing any necessary string or integer
5037 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
5048 Return a pointer to the byte-encoded representation of the SV, and set *lp
5049 to its length. May cause the SV to be downgraded from UTF-8 as a
5052 Usually accessed via the C<SvPVbyte> macro.
5054 char* sv_2pvbyte(SV* sv, STRLEN* lp)
5062 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
5063 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
5065 Usually accessed via the C<SvPVutf8> macro.
5067 char* sv_2pvutf8(SV* sv, STRLEN* lp)
5075 Returns a pointer to the string value of an SV, and sets *lp to its length.
5076 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
5078 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
5079 usually end up here too.
5081 char* sv_2pv_flags(SV* sv, STRLEN* lp, I32 flags)
5089 Return the unsigned integer value of an SV, doing any necessary string
5090 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
5091 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
5093 UV sv_2uv_flags(SV* sv, I32 flags)
5101 Remove any string offset. You should normally use the C<SvOOK_off> macro
5104 int sv_backoff(SV* sv)
5112 Blesses an SV into a specified package. The SV must be an RV. The package
5113 must be designated by its stash (see C<gv_stashpv()>). The reference count
5114 of the SV is unaffected.
5116 SV* sv_bless(SV* sv, HV* stash)
5124 Concatenates the string onto the end of the string which is in the SV.
5125 If the SV has the UTF-8 status set, then the bytes appended should be
5126 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
5128 void sv_catpv(SV* sv, const char* ptr)
5136 Processes its arguments like C<sprintf> and appends the formatted
5137 output to an SV. If the appended data contains "wide" characters
5138 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
5139 and characters >255 formatted with %c), the original SV might get
5140 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
5141 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
5142 valid UTF-8; if the original SV was bytes, the pattern should be too.
5144 void sv_catpvf(SV* sv, const char* pat, ...)
5152 Like C<sv_catpvf>, but also handles 'set' magic.
5154 void sv_catpvf_mg(SV *sv, const char* pat, ...)
5162 Concatenates the string onto the end of the string which is in the SV. The
5163 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5164 status set, then the bytes appended should be valid UTF-8.
5165 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
5167 void sv_catpvn(SV* sv, const char* ptr, STRLEN len)
5172 =item sv_catpvn_flags
5175 Concatenates the string onto the end of the string which is in the SV. The
5176 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5177 status set, then the bytes appended should be valid UTF-8.
5178 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
5179 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
5180 in terms of this function.
5182 void sv_catpvn_flags(SV* sv, const char* ptr, STRLEN len, I32 flags)
5190 Like C<sv_catpvn>, but takes a literal string instead of a string/length pair.
5192 void sv_catpvs(SV* sv, const char* s)
5195 Found in file handy.h
5200 Like C<sv_catpv>, but also handles 'set' magic.
5202 void sv_catpv_mg(SV *sv, const char *ptr)
5210 Concatenates the string from SV C<ssv> onto the end of the string in
5211 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
5212 not 'set' magic. See C<sv_catsv_mg>.
5214 void sv_catsv(SV* dsv, SV* ssv)
5219 =item sv_catsv_flags
5222 Concatenates the string from SV C<ssv> onto the end of the string in
5223 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
5224 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
5225 and C<sv_catsv_nomg> are implemented in terms of this function.
5227 void sv_catsv_flags(SV* dsv, SV* ssv, I32 flags)
5235 Efficient removal of characters from the beginning of the string buffer.
5236 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
5237 the string buffer. The C<ptr> becomes the first character of the adjusted
5238 string. Uses the "OOK hack".
5239 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
5240 refer to the same chunk of data.
5242 void sv_chop(SV* sv, const char* ptr)
5250 Clear an SV: call any destructors, free up any memory used by the body,
5251 and free the body itself. The SV's head is I<not> freed, although
5252 its type is set to all 1's so that it won't inadvertently be assumed
5253 to be live during global destruction etc.
5254 This function should only be called when REFCNT is zero. Most of the time
5255 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5258 void sv_clear(SV* sv)
5266 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5267 string in C<sv1> is less than, equal to, or greater than the string in
5268 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5269 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
5271 I32 sv_cmp(SV* sv1, SV* sv2)
5279 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
5280 'use bytes' aware, handles get magic, and will coerce its args to strings
5281 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
5283 I32 sv_cmp_locale(SV* sv1, SV* sv2)
5291 Add Collate Transform magic to an SV if it doesn't already have it.
5293 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
5294 scalar data of the variable, but transformed to such a format that a normal
5295 memory comparison can be used to compare the data according to the locale
5298 char* sv_collxfrm(SV* sv, STRLEN* nxp)
5306 Copies a stringified representation of the source SV into the
5307 destination SV. Automatically performs any necessary mg_get and
5308 coercion of numeric values into strings. Guaranteed to preserve
5309 UTF-8 flag even from overloaded objects. Similar in nature to
5310 sv_2pv[_flags] but operates directly on an SV instead of just the
5311 string. Mostly uses sv_2pv_flags to do its work, except when that
5312 would lose the UTF-8'ness of the PV.
5314 void sv_copypv(SV* dsv, SV* ssv)
5322 Auto-decrement of the value in the SV, doing string to numeric conversion
5323 if necessary. Handles 'get' magic.
5333 Returns a boolean indicating whether the strings in the two SVs are
5334 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5335 coerce its args to strings if necessary.
5337 I32 sv_eq(SV* sv1, SV* sv2)
5342 =item sv_force_normal_flags
5343 X<sv_force_normal_flags>
5345 Undo various types of fakery on an SV: if the PV is a shared string, make
5346 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
5347 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
5348 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
5349 then a copy-on-write scalar drops its PV buffer (if any) and becomes
5350 SvPOK_off rather than making a copy. (Used where this scalar is about to be
5351 set to some other value.) In addition, the C<flags> parameter gets passed to
5352 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
5353 with flags set to 0.
5355 void sv_force_normal_flags(SV *sv, U32 flags)
5363 Decrement an SV's reference count, and if it drops to zero, call
5364 C<sv_clear> to invoke destructors and free up any memory used by
5365 the body; finally, deallocate the SV's head itself.
5366 Normally called via a wrapper macro C<SvREFCNT_dec>.
5368 void sv_free(SV* sv)
5376 Get a line from the filehandle and store it into the SV, optionally
5377 appending to the currently-stored string.
5379 char* sv_gets(SV* sv, PerlIO* fp, I32 append)
5387 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
5388 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
5389 Use the C<SvGROW> wrapper instead.
5391 char* sv_grow(SV* sv, STRLEN newlen)
5399 Auto-increment of the value in the SV, doing string to numeric conversion
5400 if necessary. Handles 'get' magic.
5410 Inserts a string at the specified offset/length within the SV. Similar to
5411 the Perl substr() function.
5413 void sv_insert(SV* bigsv, STRLEN offset, STRLEN len, const char* little, STRLEN littlelen)
5421 Returns a boolean indicating whether the SV is blessed into the specified
5422 class. This does not check for subtypes; use C<sv_derived_from> to verify
5423 an inheritance relationship.
5425 int sv_isa(SV* sv, const char* name)
5433 Returns a boolean indicating whether the SV is an RV pointing to a blessed
5434 object. If the SV is not an RV, or if the object is not blessed, then this
5437 int sv_isobject(SV* sv)
5445 Returns the length of the string in the SV. Handles magic and type
5446 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5448 STRLEN sv_len(SV* sv)
5456 Returns the number of characters in the string in an SV, counting wide
5457 UTF-8 bytes as a single character. Handles magic and type coercion.
5459 STRLEN sv_len_utf8(SV* sv)
5467 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
5468 then adds a new magic item of type C<how> to the head of the magic list.
5470 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
5471 handling of the C<name> and C<namlen> arguments.
5473 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
5474 to add more than one instance of the same 'how'.
5476 void sv_magic(SV* sv, SV* obj, int how, const char* name, I32 namlen)
5484 Adds magic to an SV, upgrading it if necessary. Applies the
5485 supplied vtable and returns a pointer to the magic added.
5487 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
5488 In particular, you can add magic to SvREADONLY SVs, and add more than
5489 one instance of the same 'how'.
5491 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
5492 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
5493 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
5494 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
5496 (This is now used as a subroutine by C<sv_magic>.)
5498 MAGIC * sv_magicext(SV* sv, SV* obj, int how, MGVTBL *vtbl, const char* name, I32 namlen)
5506 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
5507 The new SV is marked as mortal. It will be destroyed "soon", either by an
5508 explicit call to FREETMPS, or by an implicit call at places such as
5509 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
5511 SV* sv_mortalcopy(SV* oldsv)
5519 Creates a new null SV which is mortal. The reference count of the SV is
5520 set to 1. It will be destroyed "soon", either by an explicit call to
5521 FREETMPS, or by an implicit call at places such as statement boundaries.
5522 See also C<sv_mortalcopy> and C<sv_2mortal>.
5532 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5535 SV* sv_newref(SV* sv)
5543 Converts the value pointed to by offsetp from a count of bytes from the
5544 start of the string, to a count of the equivalent number of UTF-8 chars.
5545 Handles magic and type coercion.
5547 void sv_pos_b2u(SV* sv, I32* offsetp)
5555 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5556 the start of the string, to a count of the equivalent number of bytes; if
5557 lenp is non-zero, it does the same to lenp, but this time starting from
5558 the offset, rather than from the start of the string. Handles magic and
5561 void sv_pos_u2b(SV* sv, I32* offsetp, I32* lenp)
5566 =item sv_pvbyten_force
5569 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
5571 char* sv_pvbyten_force(SV* sv, STRLEN* lp)
5579 Get a sensible string out of the SV somehow.
5580 A private implementation of the C<SvPV_force> macro for compilers which
5581 can't cope with complex macro expressions. Always use the macro instead.
5583 char* sv_pvn_force(SV* sv, STRLEN* lp)
5588 =item sv_pvn_force_flags
5589 X<sv_pvn_force_flags>
5591 Get a sensible string out of the SV somehow.
5592 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
5593 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
5594 implemented in terms of this function.
5595 You normally want to use the various wrapper macros instead: see
5596 C<SvPV_force> and C<SvPV_force_nomg>
5598 char* sv_pvn_force_flags(SV* sv, STRLEN* lp, I32 flags)
5603 =item sv_pvutf8n_force
5606 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
5608 char* sv_pvutf8n_force(SV* sv, STRLEN* lp)
5616 Returns a string describing what the SV is a reference to.
5618 const char* sv_reftype(const SV* sv, int ob)
5626 Make the first argument a copy of the second, then delete the original.
5627 The target SV physically takes over ownership of the body of the source SV
5628 and inherits its flags; however, the target keeps any magic it owns,
5629 and any magic in the source is discarded.
5630 Note that this is a rather specialist SV copying operation; most of the
5631 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5633 void sv_replace(SV* sv, SV* nsv)
5641 Underlying implementation for the C<reset> Perl function.
5642 Note that the perl-level function is vaguely deprecated.
5644 void sv_reset(const char* s, HV* stash)
5652 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
5653 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
5654 push a back-reference to this RV onto the array of backreferences
5655 associated with that magic. If the RV is magical, set magic will be
5656 called after the RV is cleared.
5658 SV* sv_rvweaken(SV *sv)
5666 Copies an integer into the given SV, upgrading first if necessary.
5667 Does not handle 'set' magic. See also C<sv_setiv_mg>.
5669 void sv_setiv(SV* sv, IV num)
5677 Like C<sv_setiv>, but also handles 'set' magic.
5679 void sv_setiv_mg(SV *sv, IV i)
5687 Copies a double into the given SV, upgrading first if necessary.
5688 Does not handle 'set' magic. See also C<sv_setnv_mg>.
5690 void sv_setnv(SV* sv, NV num)
5698 Like C<sv_setnv>, but also handles 'set' magic.
5700 void sv_setnv_mg(SV *sv, NV num)
5708 Copies a string into an SV. The string must be null-terminated. Does not
5709 handle 'set' magic. See C<sv_setpv_mg>.
5711 void sv_setpv(SV* sv, const char* ptr)
5719 Works like C<sv_catpvf> but copies the text into the SV instead of
5720 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
5722 void sv_setpvf(SV* sv, const char* pat, ...)
5730 Like C<sv_setpvf>, but also handles 'set' magic.
5732 void sv_setpvf_mg(SV *sv, const char* pat, ...)
5740 Copies an integer into the given SV, also updating its string value.
5741 Does not handle 'set' magic. See C<sv_setpviv_mg>.
5743 void sv_setpviv(SV* sv, IV num)
5751 Like C<sv_setpviv>, but also handles 'set' magic.
5753 void sv_setpviv_mg(SV *sv, IV iv)
5761 Copies a string into an SV. The C<len> parameter indicates the number of
5762 bytes to be copied. If the C<ptr> argument is NULL the SV will become
5763 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
5765 void sv_setpvn(SV* sv, const char* ptr, STRLEN len)
5773 Like C<sv_setpvn>, but also handles 'set' magic.
5775 void sv_setpvn_mg(SV *sv, const char *ptr, STRLEN len)
5783 Like C<sv_setpvn>, but takes a literal string instead of a string/length pair.
5785 void sv_setpvs(SV* sv, const char* s)
5788 Found in file handy.h
5793 Like C<sv_setpv>, but also handles 'set' magic.
5795 void sv_setpv_mg(SV *sv, const char *ptr)
5803 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
5804 argument will be upgraded to an RV. That RV will be modified to point to
5805 the new SV. The C<classname> argument indicates the package for the
5806 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
5807 will have a reference count of 1, and the RV will be returned.
5809 SV* sv_setref_iv(SV* rv, const char* classname, IV iv)
5817 Copies a double into a new SV, optionally blessing the SV. The C<rv>
5818 argument will be upgraded to an RV. That RV will be modified to point to
5819 the new SV. The C<classname> argument indicates the package for the
5820 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
5821 will have a reference count of 1, and the RV will be returned.
5823 SV* sv_setref_nv(SV* rv, const char* classname, NV nv)
5831 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
5832 argument will be upgraded to an RV. That RV will be modified to point to
5833 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
5834 into the SV. The C<classname> argument indicates the package for the
5835 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
5836 will have a reference count of 1, and the RV will be returned.
5838 Do not use with other Perl types such as HV, AV, SV, CV, because those
5839 objects will become corrupted by the pointer copy process.
5841 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
5843 SV* sv_setref_pv(SV* rv, const char* classname, void* pv)
5851 Copies a string into a new SV, optionally blessing the SV. The length of the
5852 string must be specified with C<n>. The C<rv> argument will be upgraded to
5853 an RV. That RV will be modified to point to the new SV. The C<classname>
5854 argument indicates the package for the blessing. Set C<classname> to
5855 C<NULL> to avoid the blessing. The new SV will have a reference count
5856 of 1, and the RV will be returned.
5858 Note that C<sv_setref_pv> copies the pointer while this copies the string.
5860 SV* sv_setref_pvn(SV* rv, const char* classname, const char* pv, STRLEN n)
5868 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
5869 argument will be upgraded to an RV. That RV will be modified to point to
5870 the new SV. The C<classname> argument indicates the package for the
5871 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
5872 will have a reference count of 1, and the RV will be returned.
5874 SV* sv_setref_uv(SV* rv, const char* classname, UV uv)
5882 Copies the contents of the source SV C<ssv> into the destination SV
5883 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
5884 function if the source SV needs to be reused. Does not handle 'set' magic.
5885 Loosely speaking, it performs a copy-by-value, obliterating any previous
5886 content of the destination.
5888 You probably want to use one of the assortment of wrappers, such as
5889 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
5890 C<SvSetMagicSV_nosteal>.
5892 void sv_setsv(SV* dsv, SV* ssv)
5897 =item sv_setsv_flags
5900 Copies the contents of the source SV C<ssv> into the destination SV
5901 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
5902 function if the source SV needs to be reused. Does not handle 'set' magic.
5903 Loosely speaking, it performs a copy-by-value, obliterating any previous
5904 content of the destination.
5905 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
5906 C<ssv> if appropriate, else not. If the C<flags> parameter has the
5907 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
5908 and C<sv_setsv_nomg> are implemented in terms of this function.
5910 You probably want to use one of the assortment of wrappers, such as
5911 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
5912 C<SvSetMagicSV_nosteal>.
5914 This is the primary function for copying scalars, and most other
5915 copy-ish functions and macros use this underneath.
5917 void sv_setsv_flags(SV* dsv, SV* ssv, I32 flags)
5925 Like C<sv_setsv>, but also handles 'set' magic.
5927 void sv_setsv_mg(SV *dstr, SV *sstr)
5935 Copies an unsigned integer into the given SV, upgrading first if necessary.
5936 Does not handle 'set' magic. See also C<sv_setuv_mg>.
5938 void sv_setuv(SV* sv, UV num)
5946 Like C<sv_setuv>, but also handles 'set' magic.
5948 void sv_setuv_mg(SV *sv, UV u)
5956 Test an SV for taintedness. Use C<SvTAINTED> instead.
5957 bool sv_tainted(SV* sv)
5965 Returns true if the SV has a true value by Perl's rules.
5966 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
5967 instead use an in-line version.
5977 Removes all magic of type C<type> from an SV.
5979 int sv_unmagic(SV* sv, int type)
5984 =item sv_unref_flags
5987 Unsets the RV status of the SV, and decrements the reference count of
5988 whatever was being referenced by the RV. This can almost be thought of
5989 as a reversal of C<newSVrv>. The C<cflags> argument can contain
5990 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
5991 (otherwise the decrementing is conditional on the reference count being
5992 different from one or the reference being a readonly SV).
5995 void sv_unref_flags(SV* sv, U32 flags)
6003 Untaint an SV. Use C<SvTAINTED_off> instead.
6004 void sv_untaint(SV* sv)
6012 Upgrade an SV to a more complex form. Generally adds a new body type to the
6013 SV, then copies across as much information as possible from the old body.
6014 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
6016 void sv_upgrade(SV* sv, svtype new_type)
6021 =item sv_usepvn_flags
6024 Tells an SV to use C<ptr> to find its string value. Normally the
6025 string is stored inside the SV but sv_usepvn allows the SV to use an
6026 outside string. The C<ptr> should point to memory that was allocated
6027 by C<malloc>. The string length, C<len>, must be supplied. By default
6028 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
6029 so that pointer should not be freed or used by the programmer after
6030 giving it to sv_usepvn, and neither should any pointers from "behind"
6031 that pointer (e.g. ptr + 1) be used.
6033 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
6034 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
6035 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
6036 C<len>, and already meets the requirements for storing in C<SvPVX>)
6038 void sv_usepvn_flags(SV* sv, char* ptr, STRLEN len, U32 flags)
6043 =item sv_utf8_decode
6046 If the PV of the SV is an octet sequence in UTF-8
6047 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
6048 so that it looks like a character. If the PV contains only single-byte
6049 characters, the C<SvUTF8> flag stays being off.
6050 Scans PV for validity and returns false if the PV is invalid UTF-8.
6052 NOTE: this function is experimental and may change or be
6053 removed without notice.
6055 bool sv_utf8_decode(SV *sv)
6060 =item sv_utf8_downgrade
6061 X<sv_utf8_downgrade>
6063 Attempts to convert the PV of an SV from characters to bytes.
6064 If the PV contains a character beyond byte, this conversion will fail;
6065 in this case, either returns false or, if C<fail_ok> is not
6068 This is not as a general purpose Unicode to byte encoding interface:
6069 use the Encode extension for that.
6071 NOTE: this function is experimental and may change or be
6072 removed without notice.
6074 bool sv_utf8_downgrade(SV *sv, bool fail_ok)
6079 =item sv_utf8_encode
6082 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
6083 flag off so that it looks like octets again.
6085 void sv_utf8_encode(SV *sv)
6090 =item sv_utf8_upgrade
6093 Converts the PV of an SV to its UTF-8-encoded form.
6094 Forces the SV to string form if it is not already.
6095 Always sets the SvUTF8 flag to avoid future validity checks even
6096 if all the bytes have hibit clear.
6098 This is not as a general purpose byte encoding to Unicode interface:
6099 use the Encode extension for that.
6101 STRLEN sv_utf8_upgrade(SV *sv)
6106 =item sv_utf8_upgrade_flags
6107 X<sv_utf8_upgrade_flags>
6109 Converts the PV of an SV to its UTF-8-encoded form.
6110 Forces the SV to string form if it is not already.
6111 Always sets the SvUTF8 flag to avoid future validity checks even
6112 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
6113 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
6114 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
6116 This is not as a general purpose byte encoding to Unicode interface:
6117 use the Encode extension for that.
6119 STRLEN sv_utf8_upgrade_flags(SV *sv, I32 flags)
6127 Processes its arguments like C<vsprintf> and appends the formatted output
6128 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
6130 Usually used via its frontend C<sv_catpvf>.
6132 void sv_vcatpvf(SV* sv, const char* pat, va_list* args)
6140 Processes its arguments like C<vsprintf> and appends the formatted output
6141 to an SV. Uses an array of SVs if the C style variable argument list is
6142 missing (NULL). When running with taint checks enabled, indicates via
6143 C<maybe_tainted> if results are untrustworthy (often due to the use of
6146 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
6148 void sv_vcatpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
6156 Like C<sv_vcatpvf>, but also handles 'set' magic.
6158 Usually used via its frontend C<sv_catpvf_mg>.
6160 void sv_vcatpvf_mg(SV* sv, const char* pat, va_list* args)
6168 Works like C<sv_vcatpvf> but copies the text into the SV instead of
6169 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
6171 Usually used via its frontend C<sv_setpvf>.
6173 void sv_vsetpvf(SV* sv, const char* pat, va_list* args)
6181 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
6184 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
6186 void sv_vsetpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
6194 Like C<sv_vsetpvf>, but also handles 'set' magic.
6196 Usually used via its frontend C<sv_setpvf_mg>.
6198 void sv_vsetpvf_mg(SV* sv, const char* pat, va_list* args)
6206 =head1 Unicode Support
6210 =item bytes_from_utf8
6213 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
6214 Unlike C<utf8_to_bytes> but like C<bytes_to_utf8>, returns a pointer to
6215 the newly-created string, and updates C<len> to contain the new
6216 length. Returns the original string if no conversion occurs, C<len>
6217 is unchanged. Do nothing if C<is_utf8> points to 0. Sets C<is_utf8> to
6218 0 if C<s> is converted or contains all 7bit characters.
6220 NOTE: this function is experimental and may change or be
6221 removed without notice.
6223 U8* bytes_from_utf8(const U8 *s, STRLEN *len, bool *is_utf8)
6226 Found in file utf8.c
6231 Converts a string C<s> of length C<len> from ASCII into UTF-8 encoding.
6232 Returns a pointer to the newly-created string, and sets C<len> to
6233 reflect the new length.
6235 If you want to convert to UTF-8 from other encodings than ASCII,
6236 see sv_recode_to_utf8().
6238 NOTE: this function is experimental and may change or be
6239 removed without notice.
6241 U8* bytes_to_utf8(const U8 *s, STRLEN *len)
6244 Found in file utf8.c
6249 Return true if the strings s1 and s2 differ case-insensitively, false
6250 if not (if they are equal case-insensitively). If u1 is true, the
6251 string s1 is assumed to be in UTF-8-encoded Unicode. If u2 is true,
6252 the string s2 is assumed to be in UTF-8-encoded Unicode. If u1 or u2
6253 are false, the respective string is assumed to be in native 8-bit
6256 If the pe1 and pe2 are non-NULL, the scanning pointers will be copied
6257 in there (they will point at the beginning of the I<next> character).
6258 If the pointers behind pe1 or pe2 are non-NULL, they are the end
6259 pointers beyond which scanning will not continue under any
6260 circumstances. If the byte lengths l1 and l2 are non-zero, s1+l1 and
6261 s2+l2 will be used as goal end pointers that will also stop the scan,
6262 and which qualify towards defining a successful match: all the scans
6263 that define an explicit length must reach their goal pointers for
6264 a match to succeed).
6266 For case-insensitiveness, the "casefolding" of Unicode is used
6267 instead of upper/lowercasing both the characters, see
6268 http://www.unicode.org/unicode/reports/tr21/ (Case Mappings).
6270 I32 ibcmp_utf8(const char* a, char **pe1, UV l1, bool u1, const char* b, char **pe2, UV l2, bool u2)
6273 Found in file utf8.c
6278 Tests if some arbitrary number of bytes begins in a valid UTF-8
6279 character. Note that an INVARIANT (i.e. ASCII) character is a valid
6280 UTF-8 character. The actual number of bytes in the UTF-8 character
6281 will be returned if it is valid, otherwise 0.
6283 STRLEN is_utf8_char(const U8 *p)
6286 Found in file utf8.c
6288 =item is_utf8_string
6291 Returns true if first C<len> bytes of the given string form a valid
6292 UTF-8 string, false otherwise. Note that 'a valid UTF-8 string' does
6293 not mean 'a string that contains code points above 0x7F encoded in UTF-8'
6294 because a valid ASCII string is a valid UTF-8 string.
6296 See also is_utf8_string_loclen() and is_utf8_string_loc().
6298 bool is_utf8_string(const U8 *s, STRLEN len)
6301 Found in file utf8.c
6303 =item is_utf8_string_loc
6304 X<is_utf8_string_loc>
6306 Like is_utf8_string() but stores the location of the failure (in the
6307 case of "utf8ness failure") or the location s+len (in the case of
6308 "utf8ness success") in the C<ep>.
6310 See also is_utf8_string_loclen() and is_utf8_string().
6312 bool is_utf8_string_loc(const U8 *s, STRLEN len, const U8 **p)
6315 Found in file utf8.c
6317 =item is_utf8_string_loclen
6318 X<is_utf8_string_loclen>
6320 Like is_utf8_string() but stores the location of the failure (in the
6321 case of "utf8ness failure") or the location s+len (in the case of
6322 "utf8ness success") in the C<ep>, and the number of UTF-8
6323 encoded characters in the C<el>.
6325 See also is_utf8_string_loc() and is_utf8_string().
6327 bool is_utf8_string_loclen(const U8 *s, STRLEN len, const U8 **ep, STRLEN *el)
6330 Found in file utf8.c
6332 =item pv_uni_display
6335 Build to the scalar dsv a displayable version of the string spv,
6336 length len, the displayable version being at most pvlim bytes long
6337 (if longer, the rest is truncated and "..." will be appended).
6339 The flags argument can have UNI_DISPLAY_ISPRINT set to display
6340 isPRINT()able characters as themselves, UNI_DISPLAY_BACKSLASH
6341 to display the \\[nrfta\\] as the backslashed versions (like '\n')
6342 (UNI_DISPLAY_BACKSLASH is preferred over UNI_DISPLAY_ISPRINT for \\).
6343 UNI_DISPLAY_QQ (and its alias UNI_DISPLAY_REGEX) have both
6344 UNI_DISPLAY_BACKSLASH and UNI_DISPLAY_ISPRINT turned on.
6346 The pointer to the PV of the dsv is returned.
6348 char* pv_uni_display(SV *dsv, const U8 *spv, STRLEN len, STRLEN pvlim, UV flags)
6351 Found in file utf8.c
6356 The encoding is assumed to be an Encode object, the PV of the ssv is
6357 assumed to be octets in that encoding and decoding the input starts
6358 from the position which (PV + *offset) pointed to. The dsv will be
6359 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
6360 when the string tstr appears in decoding output or the input ends on
6361 the PV of the ssv. The value which the offset points will be modified
6362 to the last input position on the ssv.
6364 Returns TRUE if the terminator was found, else returns FALSE.
6366 bool sv_cat_decode(SV* dsv, SV *encoding, SV *ssv, int *offset, char* tstr, int tlen)
6371 =item sv_recode_to_utf8
6372 X<sv_recode_to_utf8>
6374 The encoding is assumed to be an Encode object, on entry the PV
6375 of the sv is assumed to be octets in that encoding, and the sv
6376 will be converted into Unicode (and UTF-8).
6378 If the sv already is UTF-8 (or if it is not POK), or if the encoding
6379 is not a reference, nothing is done to the sv. If the encoding is not
6380 an C<Encode::XS> Encoding object, bad things will happen.
6381 (See F<lib/encoding.pm> and L<Encode>).
6383 The PV of the sv is returned.
6385 char* sv_recode_to_utf8(SV* sv, SV *encoding)
6390 =item sv_uni_display
6393 Build to the scalar dsv a displayable version of the scalar sv,
6394 the displayable version being at most pvlim bytes long
6395 (if longer, the rest is truncated and "..." will be appended).
6397 The flags argument is as in pv_uni_display().
6399 The pointer to the PV of the dsv is returned.
6401 char* sv_uni_display(SV *dsv, SV *ssv, STRLEN pvlim, UV flags)
6404 Found in file utf8.c
6409 The "p" contains the pointer to the UTF-8 string encoding
6410 the character that is being converted.
6412 The "ustrp" is a pointer to the character buffer to put the
6413 conversion result to. The "lenp" is a pointer to the length
6416 The "swashp" is a pointer to the swash to use.
6418 Both the special and normal mappings are stored lib/unicore/To/Foo.pl,
6419 and loaded by SWASHNEW, using lib/utf8_heavy.pl. The special (usually,
6420 but not always, a multicharacter mapping), is tried first.
6422 The "special" is a string like "utf8::ToSpecLower", which means the
6423 hash %utf8::ToSpecLower. The access to the hash is through
6424 Perl_to_utf8_case().
6426 The "normal" is a string like "ToLower" which means the swash
6429 UV to_utf8_case(const U8 *p, U8* ustrp, STRLEN *lenp, SV **swashp, const char *normal, const char *special)
6432 Found in file utf8.c
6437 Convert the UTF-8 encoded character at p to its foldcase version and
6438 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6439 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6440 foldcase version may be longer than the original character (up to
6443 The first character of the foldcased version is returned
6444 (but note, as explained above, that there may be more.)
6446 UV to_utf8_fold(const U8 *p, U8* ustrp, STRLEN *lenp)
6449 Found in file utf8.c
6454 Convert the UTF-8 encoded character at p to its lowercase version and
6455 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6456 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6457 lowercase version may be longer than the original character.
6459 The first character of the lowercased version is returned
6460 (but note, as explained above, that there may be more.)
6462 UV to_utf8_lower(const U8 *p, U8* ustrp, STRLEN *lenp)
6465 Found in file utf8.c
6470 Convert the UTF-8 encoded character at p to its titlecase version and
6471 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6472 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6473 titlecase version may be longer than the original character.
6475 The first character of the titlecased version is returned
6476 (but note, as explained above, that there may be more.)
6478 UV to_utf8_title(const U8 *p, U8* ustrp, STRLEN *lenp)
6481 Found in file utf8.c
6486 Convert the UTF-8 encoded character at p to its uppercase version and
6487 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6488 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since
6489 the uppercase version may be longer than the original character.
6491 The first character of the uppercased version is returned
6492 (but note, as explained above, that there may be more.)
6494 UV to_utf8_upper(const U8 *p, U8* ustrp, STRLEN *lenp)
6497 Found in file utf8.c
6499 =item utf8n_to_uvchr
6504 Returns the native character value of the first character in the string
6506 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6507 length, in bytes, of that character.
6509 Allows length and flags to be passed to low level routine.
6511 UV utf8n_to_uvchr(const U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags)
6514 Found in file utf8.c
6516 =item utf8n_to_uvuni
6519 Bottom level UTF-8 decode routine.
6520 Returns the unicode code point value of the first character in the string C<s>
6521 which is assumed to be in UTF-8 encoding and no longer than C<curlen>;
6522 C<retlen> will be set to the length, in bytes, of that character.
6524 If C<s> does not point to a well-formed UTF-8 character, the behaviour
6525 is dependent on the value of C<flags>: if it contains UTF8_CHECK_ONLY,
6526 it is assumed that the caller will raise a warning, and this function
6527 will silently just set C<retlen> to C<-1> and return zero. If the
6528 C<flags> does not contain UTF8_CHECK_ONLY, warnings about
6529 malformations will be given, C<retlen> will be set to the expected
6530 length of the UTF-8 character in bytes, and zero will be returned.
6532 The C<flags> can also contain various flags to allow deviations from
6533 the strict UTF-8 encoding (see F<utf8.h>).
6535 Most code should use utf8_to_uvchr() rather than call this directly.
6537 UV utf8n_to_uvuni(const U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags)
6540 Found in file utf8.c
6545 Returns the number of UTF-8 characters between the UTF-8 pointers C<a>
6548 WARNING: use only if you *know* that the pointers point inside the
6551 IV utf8_distance(const U8 *a, const U8 *b)
6554 Found in file utf8.c
6559 Return the UTF-8 pointer C<s> displaced by C<off> characters, either
6560 forward or backward.
6562 WARNING: do not use the following unless you *know* C<off> is within
6563 the UTF-8 data pointed to by C<s> *and* that on entry C<s> is aligned
6564 on the first byte of character or just after the last byte of a character.
6566 U8* utf8_hop(const U8 *s, I32 off)
6569 Found in file utf8.c
6574 Return the length of the UTF-8 char encoded string C<s> in characters.
6575 Stops at C<e> (inclusive). If C<e E<lt> s> or if the scan would end
6576 up past C<e>, croaks.
6578 STRLEN utf8_length(const U8* s, const U8 *e)
6581 Found in file utf8.c
6586 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
6587 Unlike C<bytes_to_utf8>, this over-writes the original string, and
6588 updates len to contain the new length.
6589 Returns zero on failure, setting C<len> to -1.
6591 If you need a copy of the string, see C<bytes_from_utf8>.
6593 NOTE: this function is experimental and may change or be
6594 removed without notice.
6596 U8* utf8_to_bytes(U8 *s, STRLEN *len)
6599 Found in file utf8.c
6604 Returns the native character value of the first character in the string C<s>
6605 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6606 length, in bytes, of that character.
6608 If C<s> does not point to a well-formed UTF-8 character, zero is
6609 returned and retlen is set, if possible, to -1.
6611 UV utf8_to_uvchr(const U8 *s, STRLEN *retlen)
6614 Found in file utf8.c
6619 Returns the Unicode code point of the first character in the string C<s>
6620 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6621 length, in bytes, of that character.
6623 This function should only be used when returned UV is considered
6624 an index into the Unicode semantic tables (e.g. swashes).
6626 If C<s> does not point to a well-formed UTF-8 character, zero is
6627 returned and retlen is set, if possible, to -1.
6629 UV utf8_to_uvuni(const U8 *s, STRLEN *retlen)
6632 Found in file utf8.c
6637 Adds the UTF-8 representation of the Native codepoint C<uv> to the end
6638 of the string C<d>; C<d> should be have at least C<UTF8_MAXBYTES+1> free
6639 bytes available. The return value is the pointer to the byte after the
6640 end of the new character. In other words,
6642 d = uvchr_to_utf8(d, uv);
6644 is the recommended wide native character-aware way of saying
6648 U8* uvchr_to_utf8(U8 *d, UV uv)
6651 Found in file utf8.c
6653 =item uvuni_to_utf8_flags
6654 X<uvuni_to_utf8_flags>
6656 Adds the UTF-8 representation of the Unicode codepoint C<uv> to the end
6657 of the string C<d>; C<d> should be have at least C<UTF8_MAXBYTES+1> free
6658 bytes available. The return value is the pointer to the byte after the
6659 end of the new character. In other words,
6661 d = uvuni_to_utf8_flags(d, uv, flags);
6665 d = uvuni_to_utf8(d, uv);
6667 (which is equivalent to)
6669 d = uvuni_to_utf8_flags(d, uv, 0);
6671 is the recommended Unicode-aware way of saying
6675 U8* uvuni_to_utf8_flags(U8 *d, UV uv, UV flags)
6678 Found in file utf8.c
6683 =head1 Variables created by C<xsubpp> and C<xsubpp> internal functions
6690 Variable which is setup by C<xsubpp> to indicate the stack base offset,
6691 used by the C<ST>, C<XSprePUSH> and C<XSRETURN> macros. The C<dMARK> macro
6692 must be called prior to setup the C<MARK> variable.
6697 Found in file XSUB.h
6702 Variable which is setup by C<xsubpp> to indicate the
6703 class name for a C++ XS constructor. This is always a C<char*>. See C<THIS>.
6708 Found in file XSUB.h
6713 Sets up the C<ax> variable.
6714 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
6719 Found in file XSUB.h
6724 Sets up the C<ax> variable and stack marker variable C<mark>.
6725 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
6730 Found in file XSUB.h
6735 Sets up the C<items> variable.
6736 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
6741 Found in file XSUB.h
6746 Sets up the C<padoff_du> variable for an XSUB that wishes to use
6752 Found in file XSUB.h
6757 Sets up stack and mark pointers for an XSUB, calling dSP and dMARK.
6758 Sets up the C<ax> and C<items> variables by calling C<dAX> and C<dITEMS>.
6759 This is usually handled automatically by C<xsubpp>.
6764 Found in file XSUB.h
6769 Sets up the C<ix> variable for an XSUB which has aliases. This is usually
6770 handled automatically by C<xsubpp>.
6775 Found in file XSUB.h
6780 Variable which is setup by C<xsubpp> to indicate the number of
6781 items on the stack. See L<perlxs/"Variable-length Parameter Lists">.
6786 Found in file XSUB.h
6791 Variable which is setup by C<xsubpp> to indicate which of an
6792 XSUB's aliases was used to invoke it. See L<perlxs/"The ALIAS: Keyword">.
6797 Found in file XSUB.h
6802 Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
6806 Found in file XSUB.h
6811 Variable which is setup by C<xsubpp> to hold the return value for an
6812 XSUB. This is always the proper type for the XSUB. See
6813 L<perlxs/"The RETVAL Variable">.
6818 Found in file XSUB.h
6823 Used to access elements on the XSUB's stack.
6828 Found in file XSUB.h
6833 Variable which is setup by C<xsubpp> to designate the object in a C++
6834 XSUB. This is always the proper type for the C++ object. See C<CLASS> and
6835 L<perlxs/"Using XS With C++">.
6840 Found in file XSUB.h
6845 The SV* corresponding to the $_ variable. Works even if there
6846 is a lexical $_ in scope.
6849 Found in file XSUB.h
6854 Macro to declare an XSUB and its C parameter list. This is handled by
6858 Found in file XSUB.h
6863 The version identifier for an XS module. This is usually
6864 handled automatically by C<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>.
6867 Found in file XSUB.h
6869 =item XS_VERSION_BOOTCHECK
6870 X<XS_VERSION_BOOTCHECK>
6872 Macro to verify that a PM module's $VERSION variable matches the XS
6873 module's C<XS_VERSION> variable. This is usually handled automatically by
6874 C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">.
6876 XS_VERSION_BOOTCHECK;
6879 Found in file XSUB.h
6884 =head1 Warning and Dieing
6891 This is the XSUB-writer's interface to Perl's C<die> function.
6892 Normally call this function the same way you call the C C<printf>
6893 function. Calling C<croak> returns control directly to Perl,
6894 sidestepping the normal C order of execution. See C<warn>.
6896 If you want to throw an exception object, assign the object to
6897 C<$@> and then pass C<NULL> to croak():
6899 errsv = get_sv("@", TRUE);
6900 sv_setsv(errsv, exception_object);
6903 void croak(const char* pat, ...)
6906 Found in file util.c
6911 This is the XSUB-writer's interface to Perl's C<warn> function. Call this
6912 function the same way you call the C C<printf> function. See C<croak>.
6914 void warn(const char* pat, ...)
6917 Found in file util.c
6924 Until May 1997, this document was maintained by Jeff Okamoto
6925 <okamoto@corp.hp.com>. It is now maintained as part of Perl itself.
6927 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
6928 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
6929 Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
6930 Stephen McCamant, and Gurusamy Sarathy.
6932 API Listing originally by Dean Roehrich <roehrich@cray.com>.
6934 Updated to be autogenerated from comments in the source by Benjamin Stuhl.
6938 perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
projects / p5sagit/p5-mst-13.2.git / blob