3 perlapi - autogenerated documentation for the perl public API
6 X<Perl API> X<API> X<api>
8 This file contains the documentation of the perl public API generated by
9 embed.pl, specifically a listing of functions, macros, flags, and variables
10 that may be used by extension writers. The interfaces of any functions that
11 are not listed here are subject to change without notice. For this reason,
12 blindly using functions listed in proto.h is to be avoided when writing
15 Note that all Perl API global variables must be referenced with the C<PL_>
16 prefix. Some macros are provided for compatibility with the older,
17 unadorned names, but this support may be disabled in a future release.
19 The listing is alphabetical, case insensitive.
29 A backward-compatible version of C<GIMME_V> which can only return
30 C<G_SCALAR> or C<G_ARRAY>; in a void context, it returns C<G_SCALAR>.
31 Deprecated. Use C<GIMME_V> instead.
41 The XSUB-writer's equivalent to Perl's C<wantarray>. Returns C<G_VOID>,
42 C<G_SCALAR> or C<G_ARRAY> for void, scalar or list context,
53 Used to indicate list context. See C<GIMME_V>, C<GIMME> and
62 Indicates that arguments returned from a callback should be discarded. See
71 Used to force a Perl C<eval> wrapper around a callback. See
80 Indicates that no arguments are being sent to a callback. See
89 Used to indicate scalar context. See C<GIMME_V>, C<GIMME>, and
98 Used to indicate void context. See C<GIMME_V> and L<perlcall>.
106 =head1 Array Manipulation Functions
113 Same as C<av_len()>. Deprecated, use C<av_len()> instead.
123 Clears an array, making it empty. Does not free the memory used by the
126 void av_clear(AV* ar)
134 Deletes the element indexed by C<key> from the array. Returns the
135 deleted element. If C<flags> equals C<G_DISCARD>, the element is freed
136 and null is returned.
138 SV* av_delete(AV* ar, I32 key, I32 flags)
146 Returns true if the element indexed by C<key> has been initialized.
148 This relies on the fact that uninitialized array elements are set to
151 bool av_exists(AV* ar, I32 key)
159 Pre-extend an array. The C<key> is the index to which the array should be
162 void av_extend(AV* ar, I32 key)
170 Returns the SV at the specified index in the array. The C<key> is the
171 index. If C<lval> is set then the fetch will be part of a store. Check
172 that the return value is non-null before dereferencing it to a C<SV*>.
174 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for
175 more information on how to use this function on tied arrays.
177 SV** av_fetch(AV* ar, I32 key, I32 lval)
185 Ensure than an array has a given number of elements, equivalent to
186 Perl's C<$#array = $fill;>.
188 void av_fill(AV* ar, I32 fill)
196 Returns the highest index in the array. Returns -1 if the array is
199 I32 av_len(const AV* ar)
207 Creates a new AV and populates it with a list of SVs. The SVs are copied
208 into the array, so they may be freed after the call to av_make. The new AV
209 will have a reference count of 1.
211 AV* av_make(I32 size, SV** svp)
219 Pops an SV off the end of the array. Returns C<&PL_sv_undef> if the array
230 Pushes an SV onto the end of the array. The array will grow automatically
231 to accommodate the addition.
233 void av_push(AV* ar, SV* val)
241 Shifts an SV off the beginning of the array.
251 Stores an SV in an array. The array index is specified as C<key>. The
252 return value will be NULL if the operation failed or if the value did not
253 need to be actually stored within the array (as in the case of tied
254 arrays). Otherwise it can be dereferenced to get the original C<SV*>. Note
255 that the caller is responsible for suitably incrementing the reference
256 count of C<val> before the call, and decrementing it if the function
259 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for
260 more information on how to use this function on tied arrays.
262 SV** av_store(AV* ar, I32 key, SV* val)
270 Undefines the array. Frees the memory used by the array itself.
272 void av_undef(AV* ar)
280 Unshift the given number of C<undef> values onto the beginning of the
281 array. The array will grow automatically to accommodate the addition. You
282 must then use C<av_store> to assign values to these new elements.
284 void av_unshift(AV* ar, I32 num)
292 Returns the AV of the specified Perl array. If C<create> is set and the
293 Perl variable does not exist then it will be created. If C<create> is not
294 set and the variable does not exist then NULL is returned.
296 NOTE: the perl_ form of this function is deprecated.
298 AV* get_av(const char* name, I32 create)
306 Creates a new AV. The reference count is set to 1.
316 Sort an array. Here is an example:
318 sortsv(AvARRAY(av), av_len(av)+1, Perl_sv_cmp_locale);
320 Currently this always uses mergesort. See sortsv_flags for a more
323 void sortsv(SV** array, size_t num_elts, SVCOMPARE_t cmp)
326 Found in file pp_sort.c
331 Sort an array, with various options.
333 void sortsv_flags(SV** array, size_t num_elts, SVCOMPARE_t cmp, U32 flags)
336 Found in file pp_sort.c
341 =head1 Callback Functions
348 Performs a callback to the specified Perl sub. See L<perlcall>.
350 NOTE: the perl_ form of this function is deprecated.
352 I32 call_argv(const char* sub_name, I32 flags, char** argv)
360 Performs a callback to the specified Perl method. The blessed object must
361 be on the stack. See L<perlcall>.
363 NOTE: the perl_ form of this function is deprecated.
365 I32 call_method(const char* methname, I32 flags)
373 Performs a callback to the specified Perl sub. See L<perlcall>.
375 NOTE: the perl_ form of this function is deprecated.
377 I32 call_pv(const char* sub_name, I32 flags)
385 Performs a callback to the Perl sub whose name is in the SV. See
388 NOTE: the perl_ form of this function is deprecated.
390 I32 call_sv(SV* sv, I32 flags)
398 Opening bracket on a callback. See C<LEAVE> and L<perlcall>.
403 Found in file scope.h
408 Tells Perl to C<eval> the given string and return an SV* result.
410 NOTE: the perl_ form of this function is deprecated.
412 SV* eval_pv(const char* p, I32 croak_on_error)
420 Tells Perl to C<eval> the string in the SV.
422 NOTE: the perl_ form of this function is deprecated.
424 I32 eval_sv(SV* sv, I32 flags)
432 Closing bracket for temporaries on a callback. See C<SAVETMPS> and
438 Found in file scope.h
443 Closing bracket on a callback. See C<ENTER> and L<perlcall>.
448 Found in file scope.h
453 Opening bracket for temporaries on a callback. See C<FREETMPS> and
459 Found in file scope.h
464 =head1 Character classes
471 Returns a boolean indicating whether the C C<char> is an ASCII alphanumeric
472 character (including underscore) or digit.
474 bool isALNUM(char ch)
477 Found in file handy.h
482 Returns a boolean indicating whether the C C<char> is an ASCII alphabetic
485 bool isALPHA(char ch)
488 Found in file handy.h
493 Returns a boolean indicating whether the C C<char> is an ASCII
496 bool isDIGIT(char ch)
499 Found in file handy.h
504 Returns a boolean indicating whether the C C<char> is a lowercase
507 bool isLOWER(char ch)
510 Found in file handy.h
515 Returns a boolean indicating whether the C C<char> is whitespace.
517 bool isSPACE(char ch)
520 Found in file handy.h
525 Returns a boolean indicating whether the C C<char> is an uppercase
528 bool isUPPER(char ch)
531 Found in file handy.h
536 Converts the specified character to lowercase.
538 char toLOWER(char ch)
541 Found in file handy.h
546 Converts the specified character to uppercase.
548 char toUPPER(char ch)
551 Found in file handy.h
556 =head1 Cloning an interpreter
563 Create and return a new interpreter by cloning the current one.
565 perl_clone takes these flags as parameters:
567 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
568 without it we only clone the data and zero the stacks,
569 with it we copy the stacks and the new perl interpreter is
570 ready to run at the exact same point as the previous one.
571 The pseudo-fork code uses COPY_STACKS while the
572 threads->new doesn't.
574 CLONEf_KEEP_PTR_TABLE
575 perl_clone keeps a ptr_table with the pointer of the old
576 variable as a key and the new variable as a value,
577 this allows it to check if something has been cloned and not
578 clone it again but rather just use the value and increase the
579 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
580 the ptr_table using the function
581 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
582 reason to keep it around is if you want to dup some of your own
583 variable who are outside the graph perl scans, example of this
584 code is in threads.xs create
587 This is a win32 thing, it is ignored on unix, it tells perls
588 win32host code (which is c++) to clone itself, this is needed on
589 win32 if you want to run two threads at the same time,
590 if you just want to do some stuff in a separate perl interpreter
591 and then throw it away and return to the original one,
592 you don't need to do anything.
594 PerlInterpreter* perl_clone(PerlInterpreter* interp, UV flags)
602 =head1 CV Manipulation Functions
609 Returns the stash of the CV.
619 Returns the CV of the specified Perl subroutine. If C<create> is set and
620 the Perl subroutine does not exist then it will be declared (which has the
621 same effect as saying C<sub name;>). If C<create> is not set and the
622 subroutine does not exist then NULL is returned.
624 NOTE: the perl_ form of this function is deprecated.
626 CV* get_cv(const char* name, I32 create)
634 =head1 Embedding Functions
641 Clear out all the active components of a CV. This can happen either
642 by an explicit C<undef &foo>, or by the reference count going to zero.
643 In the former case, we keep the CvOUTSIDE pointer, so that any anonymous
644 children can still follow the full lexical scope chain.
646 void cv_undef(CV* cv)
654 Loads the module whose name is pointed to by the string part of name.
655 Note that the actual module name, not its filename, should be given.
656 Eg, "Foo::Bar" instead of "Foo/Bar.pm". flags can be any of
657 PERL_LOADMOD_DENY, PERL_LOADMOD_NOIMPORT, or PERL_LOADMOD_IMPORT_OPS
658 (or 0 for no flags). ver, if specified, provides version semantics
659 similar to C<use Foo::Bar VERSION>. The optional trailing SV*
660 arguments can be used to specify arguments to the module's import()
661 method, similar to C<use Foo::Bar VERSION LIST>.
663 void load_module(U32 flags, SV* name, SV* ver, ...)
671 Stub that provides thread hook for perl_destruct when there are
682 Allocates a new Perl interpreter. See L<perlembed>.
684 PerlInterpreter* perl_alloc()
692 Initializes a new Perl interpreter. See L<perlembed>.
694 void perl_construct(PerlInterpreter* interp)
702 Shuts down a Perl interpreter. See L<perlembed>.
704 int perl_destruct(PerlInterpreter* interp)
712 Releases a Perl interpreter. See L<perlembed>.
714 void perl_free(PerlInterpreter* interp)
722 Tells a Perl interpreter to parse a Perl script. See L<perlembed>.
724 int perl_parse(PerlInterpreter* interp, XSINIT_t xsinit, int argc, char** argv, char** env)
732 Tells a Perl interpreter to run. See L<perlembed>.
734 int perl_run(PerlInterpreter* interp)
742 Tells Perl to C<require> the file named by the string argument. It is
743 analogous to the Perl code C<eval "require '$file'">. It's even
744 implemented that way; consider using load_module instead.
746 NOTE: the perl_ form of this function is deprecated.
748 void require_pv(const char* pv)
756 =head1 Functions in file dump.c
764 char *pv_display(SV *dsv, const char *pv, STRLEN cur, STRLEN len,
765 STRLEN pvlim, U32 flags)
769 pv_escape(dsv,pv,cur,pvlim,PERL_PV_ESCAPE_QUOTE);
771 except that an additional "\0" will be appended to the string when
772 len > cur and pv[cur] is "\0".
774 Note that the final string may be up to 7 chars longer than pvlim.
776 char* pv_display(SV *dsv, const char *pv, STRLEN cur, STRLEN len, STRLEN pvlim)
784 |const STRLEN count|const STRLEN max
785 |STRLEN const *escaped, const U32 flags
787 Escapes at most the first "count" chars of pv and puts the results into
788 dsv such that the size of the escaped string will not exceed "max" chars
789 and will not contain any incomplete escape sequences.
791 If flags contains PERL_PV_ESCAPE_QUOTE then any double quotes in the string
792 will also be escaped.
794 Normally the SV will be cleared before the escaped string is prepared,
795 but when PERL_PV_ESCAPE_NOCLEAR is set this will not occur.
797 If PERL_PV_ESCAPE_UNI is set then the input string is treated as unicode,
798 if PERL_PV_ESCAPE_UNI_DETECT is set then the input string is scanned
799 using C<is_utf8_string()> to determine if it is unicode.
801 If PERL_PV_ESCAPE_ALL is set then all input chars will be output
802 using C<\x01F1> style escapes, otherwise only chars above 255 will be
803 escaped using this style, other non printable chars will use octal or
804 common escaped patterns like C<\n>. If PERL_PV_ESCAPE_NOBACKSLASH
805 then all chars below 255 will be treated as printable and
806 will be output as literals.
808 If PERL_PV_ESCAPE_FIRSTCHAR is set then only the first char of the
809 string will be escaped, regardles of max. If the string is utf8 and
810 the chars value is >255 then it will be returned as a plain hex
811 sequence. Thus the output will either be a single char,
812 an octal escape sequence, a special escape like C<\n> or a 3 or
813 more digit hex value.
815 Returns a pointer to the escaped text as held by dsv.
817 NOTE: the perl_ form of this function is deprecated.
819 char* pv_escape(SV *dsv, char const * const str, const STRLEN count, const STRLEN max, STRLEN * const escaped, const U32 flags)
827 |const STRLEN count|const STRLEN max\
828 |const char const *start_color| const char const *end_color\
831 Converts a string into something presentable, handling escaping via
832 pv_escape() and supporting quoting and elipses.
834 If the PERL_PV_PRETTY_QUOTE flag is set then the result will be
835 double quoted with any double quotes in the string escaped. Otherwise
836 if the PERL_PV_PRETTY_LTGT flag is set then the result be wrapped in
839 If the PERL_PV_PRETTY_ELIPSES flag is set and not all characters in
840 string were output then an elipses C<...> will be appended to the
841 string. Note that this happens AFTER it has been quoted.
843 If start_color is non-null then it will be inserted after the opening
844 quote (if there is one) but before the escaped text. If end_color
845 is non-null then it will be inserted after the escaped text but before
846 any quotes or elipses.
848 Returns a pointer to the prettified text as held by dsv.
850 NOTE: the perl_ form of this function is deprecated.
852 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)
860 =head1 Functions in file mathoms.c
868 See L<gv_fetchmethod_autoload>.
870 GV* gv_fetchmethod(HV* stash, const char* name)
873 Found in file mathoms.c
878 The engine implementing pack() Perl function. Note: parameters next_in_list and
879 flags are not used. This call should not be used; use packlist instead.
881 void pack_cat(SV *cat, const char *pat, const char *patend, SV **beglist, SV **endlist, SV ***next_in_list, U32 flags)
884 Found in file mathoms.c
886 =item sv_2pvbyte_nolen
889 Return a pointer to the byte-encoded representation of the SV.
890 May cause the SV to be downgraded from UTF-8 as a side-effect.
892 Usually accessed via the C<SvPVbyte_nolen> macro.
894 char* sv_2pvbyte_nolen(SV* sv)
897 Found in file mathoms.c
899 =item sv_2pvutf8_nolen
902 Return a pointer to the UTF-8-encoded representation of the SV.
903 May cause the SV to be upgraded to UTF-8 as a side-effect.
905 Usually accessed via the C<SvPVutf8_nolen> macro.
907 char* sv_2pvutf8_nolen(SV* sv)
910 Found in file mathoms.c
915 Like C<sv_2pv()>, but doesn't return the length too. You should usually
916 use the macro wrapper C<SvPV_nolen(sv)> instead.
917 char* sv_2pv_nolen(SV* sv)
920 Found in file mathoms.c
925 Like C<sv_catpvn>, but also handles 'set' magic.
927 void sv_catpvn_mg(SV *sv, const char *ptr, STRLEN len)
930 Found in file mathoms.c
935 Like C<sv_catsv>, but also handles 'set' magic.
937 void sv_catsv_mg(SV *dstr, SV *sstr)
940 Found in file mathoms.c
942 =item sv_force_normal
945 Undo various types of fakery on an SV: if the PV is a shared string, make
946 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
947 an xpvmg. See also C<sv_force_normal_flags>.
949 void sv_force_normal(SV *sv)
952 Found in file mathoms.c
957 A private implementation of the C<SvIVx> macro for compilers which can't
958 cope with complex macro expressions. Always use the macro instead.
963 Found in file mathoms.c
968 Dummy routine which "locks" an SV when there is no locking module present.
969 Exists to avoid test for a NULL function pointer and because it could
970 potentially warn under some level of strict-ness.
972 "Superseded" by sv_nosharing().
974 void sv_nolocking(SV *sv)
977 Found in file mathoms.c
982 Dummy routine which "unlocks" an SV when there is no locking module present.
983 Exists to avoid test for a NULL function pointer and because it could
984 potentially warn under some level of strict-ness.
986 "Superseded" by sv_nosharing().
988 void sv_nounlocking(SV *sv)
991 Found in file mathoms.c
996 A private implementation of the C<SvNVx> macro for compilers which can't
997 cope with complex macro expressions. Always use the macro instead.
1002 Found in file mathoms.c
1007 Use the C<SvPV_nolen> macro instead
1012 Found in file mathoms.c
1017 Use C<SvPVbyte_nolen> instead.
1019 char* sv_pvbyte(SV *sv)
1022 Found in file mathoms.c
1027 A private implementation of the C<SvPVbyte> macro for compilers
1028 which can't cope with complex macro expressions. Always use the macro
1031 char* sv_pvbyten(SV *sv, STRLEN *len)
1034 Found in file mathoms.c
1039 A private implementation of the C<SvPV> macro for compilers which can't
1040 cope with complex macro expressions. Always use the macro instead.
1042 char* sv_pvn(SV *sv, STRLEN *len)
1045 Found in file mathoms.c
1050 Use the C<SvPVutf8_nolen> macro instead
1052 char* sv_pvutf8(SV *sv)
1055 Found in file mathoms.c
1060 A private implementation of the C<SvPVutf8> macro for compilers
1061 which can't cope with complex macro expressions. Always use the macro
1064 char* sv_pvutf8n(SV *sv, STRLEN *len)
1067 Found in file mathoms.c
1072 Taint an SV. Use C<SvTAINTED_on> instead.
1073 void sv_taint(SV* sv)
1076 Found in file mathoms.c
1081 Unsets the RV status of the SV, and decrements the reference count of
1082 whatever was being referenced by the RV. This can almost be thought of
1083 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
1084 being zero. See C<SvROK_off>.
1086 void sv_unref(SV* sv)
1089 Found in file mathoms.c
1094 Tells an SV to use C<ptr> to find its string value. Implemented by
1095 calling C<sv_usepvn_flags> with C<flags> of 0, hence does not handle 'set'
1096 magic. See C<sv_usepvn_flags>.
1098 void sv_usepvn(SV* sv, char* ptr, STRLEN len)
1101 Found in file mathoms.c
1106 Like C<sv_usepvn>, but also handles 'set' magic.
1108 void sv_usepvn_mg(SV *sv, char *ptr, STRLEN len)
1111 Found in file mathoms.c
1116 A private implementation of the C<SvUVx> macro for compilers which can't
1117 cope with complex macro expressions. Always use the macro instead.
1122 Found in file mathoms.c
1127 The engine implementing unpack() Perl function. Note: parameters strbeg, new_s
1128 and ocnt are not used. This call should not be used, use unpackstring instead.
1130 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)
1133 Found in file mathoms.c
1138 =head1 Functions in file pp_pack.c
1146 The engine implementing pack() Perl function.
1148 void packlist(SV *cat, const char *pat, const char *patend, SV **beglist, SV **endlist)
1151 Found in file pp_pack.c
1156 The engine implementing unpack() Perl function. C<unpackstring> puts the
1157 extracted list items on the stack and returns the number of elements.
1158 Issue C<PUTBACK> before and C<SPAGAIN> after the call to this function.
1160 I32 unpackstring(const char *pat, const char *patend, const char *s, const char *strend, U32 flags)
1163 Found in file pp_pack.c
1168 =head1 Global Variables
1175 C<PL_modglobal> is a general purpose, interpreter global HV for use by
1176 extensions that need to keep information on a per-interpreter basis.
1177 In a pinch, it can also be used as a symbol table for extensions
1178 to share data among each other. It is a good idea to use keys
1179 prefixed by the package name of the extension that owns the data.
1184 Found in file intrpvar.h
1189 A convenience variable which is typically used with C<SvPV> when one
1190 doesn't care about the length of the string. It is usually more efficient
1191 to either declare a local variable and use that instead or to use the
1192 C<SvPV_nolen> macro.
1197 Found in file thrdvar.h
1202 This is the C<false> SV. See C<PL_sv_yes>. Always refer to this as
1208 Found in file intrpvar.h
1213 This is the C<undef> SV. Always refer to this as C<&PL_sv_undef>.
1218 Found in file intrpvar.h
1223 This is the C<true> SV. See C<PL_sv_no>. Always refer to this as
1229 Found in file intrpvar.h
1241 Return the SV from the GV.
1251 If C<gv> is a typeglob whose subroutine entry is a constant sub eligible for
1252 inlining, or C<gv> is a placeholder reference that would be promoted to such
1253 a typeglob, then returns the value returned by the sub. Otherwise, returns
1256 SV* gv_const_sv(GV* gv)
1264 Returns the glob with the given C<name> and a defined subroutine or
1265 C<NULL>. The glob lives in the given C<stash>, or in the stashes
1266 accessible via @ISA and UNIVERSAL::.
1268 The argument C<level> should be either 0 or -1. If C<level==0>, as a
1269 side-effect creates a glob with the given C<name> in the given C<stash>
1270 which in the case of success contains an alias for the subroutine, and sets
1271 up caching info for this glob. Similarly for all the searched stashes.
1273 This function grants C<"SUPER"> token as a postfix of the stash name. The
1274 GV returned from C<gv_fetchmeth> may be a method cache entry, which is not
1275 visible to Perl code. So when calling C<call_sv>, you should not use
1276 the GV directly; instead, you should use the method's CV, which can be
1277 obtained from the GV with the C<GvCV> macro.
1279 GV* gv_fetchmeth(HV* stash, const char* name, STRLEN len, I32 level)
1284 =item gv_fetchmethod_autoload
1285 X<gv_fetchmethod_autoload>
1287 Returns the glob which contains the subroutine to call to invoke the method
1288 on the C<stash>. In fact in the presence of autoloading this may be the
1289 glob for "AUTOLOAD". In this case the corresponding variable $AUTOLOAD is
1292 The third parameter of C<gv_fetchmethod_autoload> determines whether
1293 AUTOLOAD lookup is performed if the given method is not present: non-zero
1294 means yes, look for AUTOLOAD; zero means no, don't look for AUTOLOAD.
1295 Calling C<gv_fetchmethod> is equivalent to calling C<gv_fetchmethod_autoload>
1296 with a non-zero C<autoload> parameter.
1298 These functions grant C<"SUPER"> token as a prefix of the method name. Note
1299 that if you want to keep the returned glob for a long time, you need to
1300 check for it being "AUTOLOAD", since at the later time the call may load a
1301 different subroutine due to $AUTOLOAD changing its value. Use the glob
1302 created via a side effect to do this.
1304 These functions have the same side-effects and as C<gv_fetchmeth> with
1305 C<level==0>. C<name> should be writable if contains C<':'> or C<'
1306 ''>. The warning against passing the GV returned by C<gv_fetchmeth> to
1307 C<call_sv> apply equally to these functions.
1309 GV* gv_fetchmethod_autoload(HV* stash, const char* name, I32 autoload)
1314 =item gv_fetchmeth_autoload
1315 X<gv_fetchmeth_autoload>
1317 Same as gv_fetchmeth(), but looks for autoloaded subroutines too.
1318 Returns a glob for the subroutine.
1320 For an autoloaded subroutine without a GV, will create a GV even
1321 if C<level < 0>. For an autoloaded subroutine without a stub, GvCV()
1322 of the result may be zero.
1324 GV* gv_fetchmeth_autoload(HV* stash, const char* name, STRLEN len, I32 level)
1332 Returns a pointer to the stash for a specified package. C<name> should
1333 be a valid UTF-8 string and must be null-terminated. If C<create> is set
1334 then the package will be created if it does not already exist. If C<create>
1335 is not set and the package does not exist then NULL is returned.
1337 HV* gv_stashpv(const char* name, I32 create)
1345 Returns a pointer to the stash for a specified package. C<name> should
1346 be a valid UTF-8 string. The C<namelen> parameter indicates the length of
1347 the C<name>, in bytes. If C<create> is set then the package will be
1348 created if it does not already exist. If C<create> is not set and the
1349 package does not exist then NULL is returned.
1351 HV* gv_stashpvn(const char* name, U32 namelen, I32 create)
1359 Like C<gv_stashpvn>, but takes a literal string instead of a string/length pair.
1361 HV* gv_stashpvs(const char* name, I32 create)
1364 Found in file handy.h
1369 Returns a pointer to the stash for a specified package, which must be a
1370 valid UTF-8 string. See C<gv_stashpv>.
1372 HV* gv_stashsv(SV* sv, I32 create)
1395 Null character pointer.
1398 Found in file handy.h
1422 Found in file handy.h
1427 =head1 Hash Manipulation Functions
1434 Returns the HV of the specified Perl hash. If C<create> is set and the
1435 Perl variable does not exist then it will be created. If C<create> is not
1436 set and the variable does not exist then NULL is returned.
1438 NOTE: the perl_ form of this function is deprecated.
1440 HV* get_hv(const char* name, I32 create)
1443 Found in file perl.c
1448 This flag, used in the length slot of hash entries and magic structures,
1449 specifies the structure contains an C<SV*> pointer where a C<char*> pointer
1450 is to be expected. (For information only--not to be used).
1458 Returns the computed hash stored in the hash entry.
1468 Returns the actual pointer stored in the key slot of the hash entry. The
1469 pointer may be either C<char*> or C<SV*>, depending on the value of
1470 C<HeKLEN()>. Can be assigned to. The C<HePV()> or C<HeSVKEY()> macros are
1471 usually preferable for finding the value of a key.
1481 If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry
1482 holds an C<SV*> key. Otherwise, holds the actual length of the key. Can
1483 be assigned to. The C<HePV()> macro is usually preferable for finding key
1486 STRLEN HeKLEN(HE* he)
1494 Returns the key slot of the hash entry as a C<char*> value, doing any
1495 necessary dereferencing of possibly C<SV*> keys. The length of the string
1496 is placed in C<len> (this is a macro, so do I<not> use C<&len>). If you do
1497 not care about what the length of the key is, you may use the global
1498 variable C<PL_na>, though this is rather less efficient than using a local
1499 variable. Remember though, that hash keys in perl are free to contain
1500 embedded nulls, so using C<strlen()> or similar is not a good way to find
1501 the length of hash keys. This is very similar to the C<SvPV()> macro
1502 described elsewhere in this document.
1504 char* HePV(HE* he, STRLEN len)
1512 Returns the key as an C<SV*>, or C<NULL> if the hash entry does not
1513 contain an C<SV*> key.
1523 Returns the key as an C<SV*>. Will create and return a temporary mortal
1524 C<SV*> if the hash entry contains only a C<char*> key.
1526 SV* HeSVKEY_force(HE* he)
1534 Sets the key to a given C<SV*>, taking care to set the appropriate flags to
1535 indicate the presence of an C<SV*> key, and returns the same
1538 SV* HeSVKEY_set(HE* he, SV* sv)
1546 Returns the value slot (type C<SV*>) stored in the hash entry.
1556 Returns the package name of a stash, or NULL if C<stash> isn't a stash.
1557 See C<SvSTASH>, C<CvSTASH>.
1559 char* HvNAME(HV* stash)
1567 Check that a hash is in an internally consistent state.
1569 void hv_assert(HV* tb)
1577 Clears a hash, making it empty.
1579 void hv_clear(HV* tb)
1584 =item hv_clear_placeholders
1585 X<hv_clear_placeholders>
1587 Clears any placeholders from a hash. If a restricted hash has any of its keys
1588 marked as readonly and the key is subsequently deleted, the key is not actually
1589 deleted but is marked by assigning it a value of &PL_sv_placeholder. This tags
1590 it so it will be ignored by future operations such as iterating over the hash,
1591 but will still allow the hash to have a value reassigned to the key at some
1592 future point. This function clears any such placeholder keys from the hash.
1593 See Hash::Util::lock_keys() for an example of its use.
1595 void hv_clear_placeholders(HV* hb)
1603 Deletes a key/value pair in the hash. The value SV is removed from the
1604 hash and returned to the caller. The C<klen> is the length of the key.
1605 The C<flags> value will normally be zero; if set to G_DISCARD then NULL
1608 SV* hv_delete(HV* tb, const char* key, I32 klen, I32 flags)
1616 Deletes a key/value pair in the hash. The value SV is removed from the
1617 hash and returned to the caller. The C<flags> value will normally be zero;
1618 if set to G_DISCARD then NULL will be returned. C<hash> can be a valid
1619 precomputed hash value, or 0 to ask for it to be computed.
1621 SV* hv_delete_ent(HV* tb, SV* key, I32 flags, U32 hash)
1629 Returns a boolean indicating whether the specified hash key exists. The
1630 C<klen> is the length of the key.
1632 bool hv_exists(HV* tb, const char* key, I32 klen)
1640 Returns a boolean indicating whether the specified hash key exists. C<hash>
1641 can be a valid precomputed hash value, or 0 to ask for it to be
1644 bool hv_exists_ent(HV* tb, SV* key, U32 hash)
1652 Returns the SV which corresponds to the specified key in the hash. The
1653 C<klen> is the length of the key. If C<lval> is set then the fetch will be
1654 part of a store. Check that the return value is non-null before
1655 dereferencing it to an C<SV*>.
1657 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1658 information on how to use this function on tied hashes.
1660 SV** hv_fetch(HV* tb, const char* key, I32 klen, I32 lval)
1668 Like C<hv_fetch>, but takes a literal string instead of a string/length pair.
1670 SV** hv_fetchs(HV* tb, const char* key, I32 lval)
1673 Found in file handy.h
1678 Returns the hash entry which corresponds to the specified key in the hash.
1679 C<hash> must be a valid precomputed hash number for the given C<key>, or 0
1680 if you want the function to compute it. IF C<lval> is set then the fetch
1681 will be part of a store. Make sure the return value is non-null before
1682 accessing it. The return value when C<tb> is a tied hash is a pointer to a
1683 static location, so be sure to make a copy of the structure if you need to
1686 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1687 information on how to use this function on tied hashes.
1689 HE* hv_fetch_ent(HV* tb, SV* key, I32 lval, U32 hash)
1697 Prepares a starting point to traverse a hash table. Returns the number of
1698 keys in the hash (i.e. the same as C<HvKEYS(tb)>). The return value is
1699 currently only meaningful for hashes without tie magic.
1701 NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
1702 hash buckets that happen to be in use. If you still need that esoteric
1703 value, you can get it through the macro C<HvFILL(tb)>.
1706 I32 hv_iterinit(HV* tb)
1714 Returns the key from the current position of the hash iterator. See
1717 char* hv_iterkey(HE* entry, I32* retlen)
1725 Returns the key as an C<SV*> from the current position of the hash
1726 iterator. The return value will always be a mortal copy of the key. Also
1729 SV* hv_iterkeysv(HE* entry)
1737 Returns entries from a hash iterator. See C<hv_iterinit>.
1739 You may call C<hv_delete> or C<hv_delete_ent> on the hash entry that the
1740 iterator currently points to, without losing your place or invalidating your
1741 iterator. Note that in this case the current entry is deleted from the hash
1742 with your iterator holding the last reference to it. Your iterator is flagged
1743 to free the entry on the next call to C<hv_iternext>, so you must not discard
1744 your iterator immediately else the entry will leak - call C<hv_iternext> to
1745 trigger the resource deallocation.
1747 HE* hv_iternext(HV* tb)
1755 Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
1758 SV* hv_iternextsv(HV* hv, char** key, I32* retlen)
1763 =item hv_iternext_flags
1764 X<hv_iternext_flags>
1766 Returns entries from a hash iterator. See C<hv_iterinit> and C<hv_iternext>.
1767 The C<flags> value will normally be zero; if HV_ITERNEXT_WANTPLACEHOLDERS is
1768 set the placeholders keys (for restricted hashes) will be returned in addition
1769 to normal keys. By default placeholders are automatically skipped over.
1770 Currently a placeholder is implemented with a value that is
1771 C<&Perl_sv_placeholder>. Note that the implementation of placeholders and
1772 restricted hashes may change, and the implementation currently is
1773 insufficiently abstracted for any change to be tidy.
1775 NOTE: this function is experimental and may change or be
1776 removed without notice.
1778 HE* hv_iternext_flags(HV* tb, I32 flags)
1786 Returns the value from the current position of the hash iterator. See
1789 SV* hv_iterval(HV* tb, HE* entry)
1797 Adds magic to a hash. See C<sv_magic>.
1799 void hv_magic(HV* hv, GV* gv, int how)
1807 Evaluates the hash in scalar context and returns the result. Handles magic when the hash is tied.
1809 SV* hv_scalar(HV* hv)
1817 Stores an SV in a hash. The hash key is specified as C<key> and C<klen> is
1818 the length of the key. The C<hash> parameter is the precomputed hash
1819 value; if it is zero then Perl will compute it. The return value will be
1820 NULL if the operation failed or if the value did not need to be actually
1821 stored within the hash (as in the case of tied hashes). Otherwise it can
1822 be dereferenced to get the original C<SV*>. Note that the caller is
1823 responsible for suitably incrementing the reference count of C<val> before
1824 the call, and decrementing it if the function returned NULL. Effectively
1825 a successful hv_store takes ownership of one reference to C<val>. This is
1826 usually what you want; a newly created SV has a reference count of one, so
1827 if all your code does is create SVs then store them in a hash, hv_store
1828 will own the only reference to the new SV, and your code doesn't need to do
1829 anything further to tidy up. hv_store is not implemented as a call to
1830 hv_store_ent, and does not create a temporary SV for the key, so if your
1831 key data is not already in SV form then use hv_store in preference to
1834 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1835 information on how to use this function on tied hashes.
1837 SV** hv_store(HV* tb, const char* key, I32 klen, SV* val, U32 hash)
1845 Like C<hv_store>, but takes a literal string instead of a string/length pair
1846 and omits the hash parameter.
1848 SV** hv_stores(HV* tb, const char* key, NULLOK SV* val)
1851 Found in file handy.h
1856 Stores C<val> in a hash. The hash key is specified as C<key>. The C<hash>
1857 parameter is the precomputed hash value; if it is zero then Perl will
1858 compute it. The return value is the new hash entry so created. It will be
1859 NULL if the operation failed or if the value did not need to be actually
1860 stored within the hash (as in the case of tied hashes). Otherwise the
1861 contents of the return value can be accessed using the C<He?> macros
1862 described here. Note that the caller is responsible for suitably
1863 incrementing the reference count of C<val> before the call, and
1864 decrementing it if the function returned NULL. Effectively a successful
1865 hv_store_ent takes ownership of one reference to C<val>. This is
1866 usually what you want; a newly created SV has a reference count of one, so
1867 if all your code does is create SVs then store them in a hash, hv_store
1868 will own the only reference to the new SV, and your code doesn't need to do
1869 anything further to tidy up. Note that hv_store_ent only reads the C<key>;
1870 unlike C<val> it does not take ownership of it, so maintaining the correct
1871 reference count on C<key> is entirely the caller's responsibility. hv_store
1872 is not implemented as a call to hv_store_ent, and does not create a temporary
1873 SV for the key, so if your key data is not already in SV form then use
1874 hv_store in preference to hv_store_ent.
1876 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1877 information on how to use this function on tied hashes.
1879 HE* hv_store_ent(HV* tb, SV* key, SV* val, U32 hash)
1889 void hv_undef(HV* tb)
1897 Creates a new HV. The reference count is set to 1.
1907 =head1 Magical Functions
1914 Clear something magical that the SV represents. See C<sv_magic>.
1916 int mg_clear(SV* sv)
1924 Copies the magic from one SV to another. See C<sv_magic>.
1926 int mg_copy(SV* sv, SV* nsv, const char* key, I32 klen)
1934 Finds the magic pointer for type matching the SV. See C<sv_magic>.
1936 MAGIC* mg_find(const SV* sv, int type)
1944 Free any magic storage used by the SV. See C<sv_magic>.
1954 Do magic after a value is retrieved from the SV. See C<sv_magic>.
1964 Report on the SV's length. See C<sv_magic>.
1966 U32 mg_length(SV* sv)
1974 Turns on the magical status of an SV. See C<sv_magic>.
1976 void mg_magical(SV* sv)
1984 Do magic after a value is assigned to the SV. See C<sv_magic>.
1994 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
1995 argument more than once.
1997 void SvGETMAGIC(SV* sv)
2005 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
2016 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
2017 argument more than once.
2019 void SvSETMAGIC(SV* sv)
2027 Like C<SvSetSV>, but does any set magic required afterwards.
2029 void SvSetMagicSV(SV* dsb, SV* ssv)
2034 =item SvSetMagicSV_nosteal
2035 X<SvSetMagicSV_nosteal>
2037 Like C<SvSetSV_nosteal>, but does any set magic required afterwards.
2039 void SvSetMagicSV_nosteal(SV* dsv, SV* ssv)
2047 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
2050 void SvSetSV(SV* dsb, SV* ssv)
2055 =item SvSetSV_nosteal
2058 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
2059 ssv. May evaluate arguments more than once.
2061 void SvSetSV_nosteal(SV* dsv, SV* ssv)
2069 Arranges for sv to be shared between threads if a suitable module
2072 void SvSHARE(SV* sv)
2080 Releases a mutual exclusion lock on sv if a suitable module
2083 void SvUNLOCK(SV* sv)
2091 =head1 Memory Management
2098 The XSUB-writer's interface to the C C<memcpy> function. The C<src> is the
2099 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
2100 the type. May fail on overlapping copies. See also C<Move>.
2102 void Copy(void* src, void* dest, int nitems, type)
2105 Found in file handy.h
2110 Like C<Copy> but returns dest. Useful for encouraging compilers to tail-call
2113 void * CopyD(void* src, void* dest, int nitems, type)
2116 Found in file handy.h
2121 The XSUB-writer's interface to the C C<memmove> function. The C<src> is the
2122 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
2123 the type. Can do overlapping moves. See also C<Copy>.
2125 void Move(void* src, void* dest, int nitems, type)
2128 Found in file handy.h
2133 Like C<Move> but returns dest. Useful for encouraging compilers to tail-call
2136 void * MoveD(void* src, void* dest, int nitems, type)
2139 Found in file handy.h
2144 The XSUB-writer's interface to the C C<malloc> function.
2146 In 5.9.3, Newx() and friends replace the older New() API, and drops
2147 the first parameter, I<x>, a debug aid which allowed callers to identify
2148 themselves. This aid has been superseded by a new build option,
2149 PERL_MEM_LOG (see L<perlhack/PERL_MEM_LOG>). The older API is still
2150 there for use in XS modules supporting older perls.
2152 void Newx(void* ptr, int nitems, type)
2155 Found in file handy.h
2160 The XSUB-writer's interface to the C C<malloc> function, with
2161 cast. See also C<Newx>.
2163 void Newxc(void* ptr, int nitems, type, cast)
2166 Found in file handy.h
2171 The XSUB-writer's interface to the C C<malloc> function. The allocated
2172 memory is zeroed with C<memzero>. See also C<Newx>.
2174 void Newxz(void* ptr, int nitems, type)
2177 Found in file handy.h
2182 PoisonWith(0xEF) for catching access to freed memory.
2184 void Poison(void* dest, int nitems, type)
2187 Found in file handy.h
2192 PoisonWith(0xEF) for catching access to freed memory.
2194 void PoisonFree(void* dest, int nitems, type)
2197 Found in file handy.h
2202 PoisonWith(0xAB) for catching access to allocated but uninitialized memory.
2204 void PoisonNew(void* dest, int nitems, type)
2207 Found in file handy.h
2212 Fill up memory with a byte pattern (a byte repeated over and over
2213 again) that hopefully catches attempts to access uninitialized memory.
2215 void PoisonWith(void* dest, int nitems, type, U8 byte)
2218 Found in file handy.h
2223 The XSUB-writer's interface to the C C<realloc> function.
2225 void Renew(void* ptr, int nitems, type)
2228 Found in file handy.h
2233 The XSUB-writer's interface to the C C<realloc> function, with
2236 void Renewc(void* ptr, int nitems, type, cast)
2239 Found in file handy.h
2244 The XSUB-writer's interface to the C C<free> function.
2246 void Safefree(void* ptr)
2249 Found in file handy.h
2254 Perl's version of C<strdup()>. Returns a pointer to a newly allocated
2255 string which is a duplicate of C<pv>. The size of the string is
2256 determined by C<strlen()>. The memory allocated for the new string can
2257 be freed with the C<Safefree()> function.
2259 char* savepv(const char* pv)
2262 Found in file util.c
2267 Perl's version of what C<strndup()> would be if it existed. Returns a
2268 pointer to a newly allocated string which is a duplicate of the first
2269 C<len> bytes from C<pv>, plus a trailing NUL byte. The memory allocated for
2270 the new string can be freed with the C<Safefree()> function.
2272 char* savepvn(const char* pv, I32 len)
2275 Found in file util.c
2280 Like C<savepvn>, but takes a literal string instead of a string/length pair.
2282 char* savepvs(const char* s)
2285 Found in file handy.h
2290 A version of C<savepv()> which allocates the duplicate string in memory
2291 which is shared between threads.
2293 char* savesharedpv(const char* pv)
2296 Found in file util.c
2301 A version of C<savepv()>/C<savepvn()> which gets the string to duplicate from
2302 the passed in SV using C<SvPV()>
2304 char* savesvpv(SV* sv)
2307 Found in file util.c
2312 This is an architecture-independent macro to copy one structure to another.
2314 void StructCopy(type src, type dest, type)
2317 Found in file handy.h
2322 The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the
2323 destination, C<nitems> is the number of items, and C<type> is the type.
2325 void Zero(void* dest, int nitems, type)
2328 Found in file handy.h
2333 Like C<Zero> but returns dest. Useful for encouraging compilers to tail-call
2336 void * ZeroD(void* dest, int nitems, type)
2339 Found in file handy.h
2344 =head1 Miscellaneous Functions
2351 Analyses the string in order to make fast searches on it using fbm_instr()
2352 -- the Boyer-Moore algorithm.
2354 void fbm_compile(SV* sv, U32 flags)
2357 Found in file util.c
2362 Returns the location of the SV in the string delimited by C<str> and
2363 C<strend>. It returns C<NULL> if the string can't be found. The C<sv>
2364 does not have to be fbm_compiled, but the search will not be as fast
2367 char* fbm_instr(unsigned char* big, unsigned char* bigend, SV* littlesv, U32 flags)
2370 Found in file util.c
2375 Takes a sprintf-style format pattern and conventional
2376 (non-SV) arguments and returns the formatted string.
2378 (char *) Perl_form(pTHX_ const char* pat, ...)
2380 can be used any place a string (char *) is required:
2382 char * s = Perl_form("%d.%d",major,minor);
2384 Uses a single private buffer so if you want to format several strings you
2385 must explicitly copy the earlier strings away (and free the copies when you
2388 char* form(const char* pat, ...)
2391 Found in file util.c
2396 Fill the sv with current working directory
2398 int getcwd_sv(SV* sv)
2401 Found in file util.c
2406 The C library C<snprintf> functionality, if available and
2407 standards-compliant (uses C<vsnprintf>, actually). However, if the
2408 C<vsnprintf> is not available, will unfortunately use the unsafe
2409 C<vsprintf> which can overrun the buffer (there is an overrun check,
2410 but that may be too late). Consider using C<sv_vcatpvf> instead, or
2411 getting C<vsnprintf>.
2413 int my_snprintf(char *buffer, const Size_t len, const char *format, ...)
2416 Found in file util.c
2421 The C library C<sprintf>, wrapped if necessary, to ensure that it will return
2422 the length of the string written to the buffer. Only rare pre-ANSI systems
2423 need the wrapper function - usually this is a direct call to C<sprintf>.
2425 int my_sprintf(char *buffer, const char *pat, ...)
2428 Found in file util.c
2433 The C library C<vsnprintf> if available and standards-compliant.
2434 However, if if the C<vsnprintf> is not available, will unfortunately
2435 use the unsafe C<vsprintf> which can overrun the buffer (there is an
2436 overrun check, but that may be too late). Consider using
2437 C<sv_vcatpvf> instead, or getting C<vsnprintf>.
2439 int my_vsnprintf(char *buffer, const Size_t len, const char *format, va_list ap)
2442 Found in file util.c
2447 Returns a new version object based on the passed in SV:
2449 SV *sv = new_version(SV *ver);
2451 Does not alter the passed in ver SV. See "upg_version" if you
2452 want to upgrade the SV.
2454 SV* new_version(SV *ver)
2457 Found in file util.c
2462 Returns a pointer to the next character after the parsed
2463 version string, as well as upgrading the passed in SV to
2466 Function must be called with an already existing SV like
2469 s = scan_version(s,SV *sv, bool qv);
2471 Performs some preprocessing to the string to ensure that
2472 it has the correct characteristics of a version. Flags the
2473 object if it contains an underscore (which denotes this
2474 is a alpha version). The boolean qv denotes that the version
2475 should be interpreted as if it had multiple decimals, even if
2478 const char* scan_version(const char *vstr, SV *sv, bool qv)
2481 Found in file util.c
2486 Test two strings to see if they are equal. Returns true or false.
2488 bool strEQ(char* s1, char* s2)
2491 Found in file handy.h
2496 Test two strings to see if the first, C<s1>, is greater than or equal to
2497 the second, C<s2>. Returns true or false.
2499 bool strGE(char* s1, char* s2)
2502 Found in file handy.h
2507 Test two strings to see if the first, C<s1>, is greater than the second,
2508 C<s2>. Returns true or false.
2510 bool strGT(char* s1, char* s2)
2513 Found in file handy.h
2518 Test two strings to see if the first, C<s1>, is less than or equal to the
2519 second, C<s2>. Returns true or false.
2521 bool strLE(char* s1, char* s2)
2524 Found in file handy.h
2529 Test two strings to see if the first, C<s1>, is less than the second,
2530 C<s2>. Returns true or false.
2532 bool strLT(char* s1, char* s2)
2535 Found in file handy.h
2540 Test two strings to see if they are different. Returns true or
2543 bool strNE(char* s1, char* s2)
2546 Found in file handy.h
2551 Test two strings to see if they are equal. The C<len> parameter indicates
2552 the number of bytes to compare. Returns true or false. (A wrapper for
2555 bool strnEQ(char* s1, char* s2, STRLEN len)
2558 Found in file handy.h
2563 Test two strings to see if they are different. The C<len> parameter
2564 indicates the number of bytes to compare. Returns true or false. (A
2565 wrapper for C<strncmp>).
2567 bool strnNE(char* s1, char* s2, STRLEN len)
2570 Found in file handy.h
2575 Dummy routine which "shares" an SV when there is no sharing module present.
2576 Or "locks" it. Or "unlocks" it. In other words, ignores its single SV argument.
2577 Exists to avoid test for a NULL function pointer and because it could
2578 potentially warn under some level of strict-ness.
2580 void sv_nosharing(SV *sv)
2583 Found in file util.c
2588 In-place upgrade of the supplied SV to a version object.
2590 SV *sv = upg_version(SV *sv);
2592 Returns a pointer to the upgraded SV.
2594 SV* upg_version(SV *ver)
2597 Found in file util.c
2602 Version object aware cmp. Both operands must already have been
2603 converted into version objects.
2605 int vcmp(SV *lvs, SV *rvs)
2608 Found in file util.c
2613 Accepts a version object and returns the normalized string
2614 representation. Call like:
2618 NOTE: you can pass either the object directly or the SV
2619 contained within the RV.
2624 Found in file util.c
2629 Accepts a version object and returns the normalized floating
2630 point representation. Call like:
2634 NOTE: you can pass either the object directly or the SV
2635 contained within the RV.
2640 Found in file util.c
2645 In order to maintain maximum compatibility with earlier versions
2646 of Perl, this function will return either the floating point
2647 notation or the multiple dotted notation, depending on whether
2648 the original version contained 1 or more dots, respectively
2650 SV* vstringify(SV *vs)
2653 Found in file util.c
2658 Validates that the SV contains a valid version object.
2660 bool vverify(SV *vobj);
2662 Note that it only confirms the bare minimum structure (so as not to get
2663 confused by derived classes which may contain additional hash entries):
2665 bool vverify(SV *vs)
2668 Found in file util.c
2673 =head1 Multicall Functions
2680 Declare local variables for a multicall. See L<perlcall/Lightweight Callbacks>.
2690 Make a lightweight callback. See L<perlcall/Lightweight Callbacks>.
2700 Closing bracket for a lightweight callback.
2701 See L<perlcall/Lightweight Callbacks>.
2708 =item PUSH_MULTICALL
2711 Opening bracket for a lightweight callback.
2712 See L<perlcall/Lightweight Callbacks>.
2722 =head1 Numeric functions
2729 converts a string representing a binary number to numeric form.
2731 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2732 conversion flags, and I<result> should be NULL or a pointer to an NV.
2733 The scan stops at the end of the string, or the first invalid character.
2734 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2735 invalid character will also trigger a warning.
2736 On return I<*len> is set to the length of the scanned string,
2737 and I<*flags> gives output flags.
2739 If the value is <= C<UV_MAX> it is returned as a UV, the output flags are clear,
2740 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_bin>
2741 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2742 and writes the value to I<*result> (or the value is discarded if I<result>
2745 The binary number may optionally be prefixed with "0b" or "b" unless
2746 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
2747 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the binary
2748 number may use '_' characters to separate digits.
2750 UV grok_bin(const char* start, STRLEN* len_p, I32* flags, NV *result)
2753 Found in file numeric.c
2758 converts a string representing a hex number to numeric form.
2760 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2761 conversion flags, and I<result> should be NULL or a pointer to an NV.
2762 The scan stops at the end of the string, or the first invalid character.
2763 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2764 invalid character will also trigger a warning.
2765 On return I<*len> is set to the length of the scanned string,
2766 and I<*flags> gives output flags.
2768 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2769 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_hex>
2770 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2771 and writes the value to I<*result> (or the value is discarded if I<result>
2774 The hex number may optionally be prefixed with "0x" or "x" unless
2775 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
2776 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the hex
2777 number may use '_' characters to separate digits.
2779 UV grok_hex(const char* start, STRLEN* len_p, I32* flags, NV *result)
2782 Found in file numeric.c
2787 Recognise (or not) a number. The type of the number is returned
2788 (0 if unrecognised), otherwise it is a bit-ORed combination of
2789 IS_NUMBER_IN_UV, IS_NUMBER_GREATER_THAN_UV_MAX, IS_NUMBER_NOT_INT,
2790 IS_NUMBER_NEG, IS_NUMBER_INFINITY, IS_NUMBER_NAN (defined in perl.h).
2792 If the value of the number can fit an in UV, it is returned in the *valuep
2793 IS_NUMBER_IN_UV will be set to indicate that *valuep is valid, IS_NUMBER_IN_UV
2794 will never be set unless *valuep is valid, but *valuep may have been assigned
2795 to during processing even though IS_NUMBER_IN_UV is not set on return.
2796 If valuep is NULL, IS_NUMBER_IN_UV will be set for the same cases as when
2797 valuep is non-NULL, but no actual assignment (or SEGV) will occur.
2799 IS_NUMBER_NOT_INT will be set with IS_NUMBER_IN_UV if trailing decimals were
2800 seen (in which case *valuep gives the true value truncated to an integer), and
2801 IS_NUMBER_NEG if the number is negative (in which case *valuep holds the
2802 absolute value). IS_NUMBER_IN_UV is not set if e notation was used or the
2803 number is larger than a UV.
2805 int grok_number(const char *pv, STRLEN len, UV *valuep)
2808 Found in file numeric.c
2810 =item grok_numeric_radix
2811 X<grok_numeric_radix>
2813 Scan and skip for a numeric decimal separator (radix).
2815 bool grok_numeric_radix(const char **sp, const char *send)
2818 Found in file numeric.c
2823 converts a string representing an octal number to numeric form.
2825 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2826 conversion flags, and I<result> should be NULL or a pointer to an NV.
2827 The scan stops at the end of the string, or the first invalid character.
2828 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2829 invalid character will also trigger a warning.
2830 On return I<*len> is set to the length of the scanned string,
2831 and I<*flags> gives output flags.
2833 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2834 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_oct>
2835 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2836 and writes the value to I<*result> (or the value is discarded if I<result>
2839 If C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the octal
2840 number may use '_' characters to separate digits.
2842 UV grok_oct(const char* start, STRLEN* len_p, I32* flags, NV *result)
2845 Found in file numeric.c
2850 For backwards compatibility. Use C<grok_bin> instead.
2852 NV scan_bin(const char* start, STRLEN len, STRLEN* retlen)
2855 Found in file numeric.c
2860 For backwards compatibility. Use C<grok_hex> instead.
2862 NV scan_hex(const char* start, STRLEN len, STRLEN* retlen)
2865 Found in file numeric.c
2870 For backwards compatibility. Use C<grok_oct> instead.
2872 NV scan_oct(const char* start, STRLEN len, STRLEN* retlen)
2875 Found in file numeric.c
2880 =head1 Optree Manipulation Functions
2887 If C<cv> is a constant sub eligible for inlining. returns the constant
2888 value returned by the sub. Otherwise, returns NULL.
2890 Constant subs can be created with C<newCONSTSUB> or as described in
2891 L<perlsub/"Constant Functions">.
2893 SV* cv_const_sv(CV* cv)
2901 Creates a constant sub equivalent to Perl C<sub FOO () { 123 }> which is
2902 eligible for inlining at compile-time.
2904 CV* newCONSTSUB(HV* stash, const char* name, SV* sv)
2912 Used by C<xsubpp> to hook up XSUBs as Perl subs. I<filename> needs to be
2913 static storage, as it is used directly as CvFILE(), without a copy being made.
2921 =head1 Pad Data Structures
2928 Get the value at offset po in the current pad.
2929 Use macro PAD_SV instead of calling this function directly.
2931 SV* pad_sv(PADOFFSET po)
2939 =head1 Simple Exception Handling Macros
2946 Set up necessary local variables for exception handling.
2947 See L<perlguts/"Exception Handling">.
2952 Found in file XSUB.h
2957 Introduces a catch block. See L<perlguts/"Exception Handling">.
2960 Found in file XSUB.h
2965 Rethrows a previously caught exception. See L<perlguts/"Exception Handling">.
2970 Found in file XSUB.h
2975 Ends a try block. See L<perlguts/"Exception Handling">.
2978 Found in file XSUB.h
2980 =item XCPT_TRY_START
2983 Starts a try block. See L<perlguts/"Exception Handling">.
2986 Found in file XSUB.h
2991 =head1 Stack Manipulation Macros
2998 Declare a stack marker variable, C<mark>, for the XSUB. See C<MARK> and
3009 Saves the original stack mark for the XSUB. See C<ORIGMARK>.
3019 Declares a local copy of perl's stack pointer for the XSUB, available via
3020 the C<SP> macro. See C<SP>.
3030 Used to extend the argument stack for an XSUB's return values. Once
3031 used, guarantees that there is room for at least C<nitems> to be pushed
3034 void EXTEND(SP, int nitems)
3042 Stack marker variable for the XSUB. See C<dMARK>.
3050 Push an integer onto the stack. The stack must have room for this element.
3051 Handles 'set' magic. Does not use C<TARG>. See also C<PUSHi>, C<mXPUSHi>
3062 Push a double onto the stack. The stack must have room for this element.
3063 Handles 'set' magic. Does not use C<TARG>. See also C<PUSHn>, C<mXPUSHn>
3074 Push a string onto the stack. The stack must have room for this element.
3075 The C<len> indicates the length of the string. Handles 'set' magic. Does
3076 not use C<TARG>. See also C<PUSHp>, C<mXPUSHp> and C<XPUSHp>.
3078 void mPUSHp(char* str, STRLEN len)
3086 Push an unsigned integer onto the stack. The stack must have room for this
3087 element. Handles 'set' magic. Does not use C<TARG>. See also C<PUSHu>,
3088 C<mXPUSHu> and C<XPUSHu>.
3098 Push an integer onto the stack, extending the stack if necessary. Handles
3099 'set' magic. Does not use C<TARG>. See also C<XPUSHi>, C<mPUSHi> and
3110 Push a double onto the stack, extending the stack if necessary. Handles
3111 'set' magic. Does not use C<TARG>. See also C<XPUSHn>, C<mPUSHn> and
3122 Push a string onto the stack, extending the stack if necessary. The C<len>
3123 indicates the length of the string. Handles 'set' magic. Does not use
3124 C<TARG>. See also C<XPUSHp>, C<mPUSHp> and C<PUSHp>.
3126 void mXPUSHp(char* str, STRLEN len)
3134 Push an unsigned integer onto the stack, extending the stack if necessary.
3135 Handles 'set' magic. Does not use C<TARG>. See also C<XPUSHu>, C<mPUSHu>
3146 The original stack mark for the XSUB. See C<dORIGMARK>.
3154 Pops an integer off the stack.
3164 Pops a long off the stack.
3174 Pops a double off the stack.
3184 Pops a string off the stack. Deprecated. New code should use POPpx.
3194 Pops a string off the stack which must consist of bytes i.e. characters < 256.
3204 Pops a string off the stack.
3214 Pops an SV off the stack.
3224 Push an integer onto the stack. The stack must have room for this element.
3225 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3226 called to declare it. Do not call multiple C<TARG>-oriented macros to
3227 return lists from XSUB's - see C<mPUSHi> instead. See also C<XPUSHi> and
3238 Opening bracket for arguments on a callback. See C<PUTBACK> and
3249 Push a new mortal SV onto the stack. The stack must have room for this
3250 element. Does not handle 'set' magic. Does not use C<TARG>. See also
3251 C<PUSHs>, C<XPUSHmortal> and C<XPUSHs>.
3261 Push a double onto the stack. The stack must have room for this element.
3262 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3263 called to declare it. Do not call multiple C<TARG>-oriented macros to
3264 return lists from XSUB's - see C<mPUSHn> instead. See also C<XPUSHn> and
3275 Push a string onto the stack. The stack must have room for this element.
3276 The C<len> indicates the length of the string. Handles 'set' magic. Uses
3277 C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to declare it. Do not
3278 call multiple C<TARG>-oriented macros to return lists from XSUB's - see
3279 C<mPUSHp> instead. See also C<XPUSHp> and C<mXPUSHp>.
3281 void PUSHp(char* str, STRLEN len)
3289 Push an SV onto the stack. The stack must have room for this element.
3290 Does not handle 'set' magic. Does not use C<TARG>. See also C<PUSHmortal>,
3291 C<XPUSHs> and C<XPUSHmortal>.
3301 Push an unsigned integer onto the stack. The stack must have room for this
3302 element. Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG>
3303 should be called to declare it. Do not call multiple C<TARG>-oriented
3304 macros to return lists from XSUB's - see C<mPUSHu> instead. See also
3305 C<XPUSHu> and C<mXPUSHu>.
3315 Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
3316 See C<PUSHMARK> and L<perlcall> for other uses.
3326 Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and
3335 Refetch the stack pointer. Used after a callback. See L<perlcall>.
3345 Push an integer onto the stack, extending the stack if necessary. Handles
3346 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
3347 declare it. Do not call multiple C<TARG>-oriented macros to return lists
3348 from XSUB's - see C<mXPUSHi> instead. See also C<PUSHi> and C<mPUSHi>.
3358 Push a new mortal SV onto the stack, extending the stack if necessary. Does
3359 not handle 'set' magic. Does not use C<TARG>. See also C<XPUSHs>,
3360 C<PUSHmortal> and C<PUSHs>.
3370 Push a double onto the stack, extending the stack if necessary. Handles
3371 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
3372 declare it. Do not call multiple C<TARG>-oriented macros to return lists
3373 from XSUB's - see C<mXPUSHn> instead. See also C<PUSHn> and C<mPUSHn>.
3383 Push a string onto the stack, extending the stack if necessary. The C<len>
3384 indicates the length of the string. Handles 'set' magic. Uses C<TARG>, so
3385 C<dTARGET> or C<dXSTARG> should be called to declare it. Do not call
3386 multiple C<TARG>-oriented macros to return lists from XSUB's - see
3387 C<mXPUSHp> instead. See also C<PUSHp> and C<mPUSHp>.
3389 void XPUSHp(char* str, STRLEN len)
3397 Push an SV onto the stack, extending the stack if necessary. Does not
3398 handle 'set' magic. Does not use C<TARG>. See also C<XPUSHmortal>,
3399 C<PUSHs> and C<PUSHmortal>.
3409 Push an unsigned integer onto the stack, extending the stack if necessary.
3410 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3411 called to declare it. Do not call multiple C<TARG>-oriented macros to
3412 return lists from XSUB's - see C<mXPUSHu> instead. See also C<PUSHu> and
3423 Return from XSUB, indicating number of items on the stack. This is usually
3424 handled by C<xsubpp>.
3426 void XSRETURN(int nitems)
3429 Found in file XSUB.h
3431 =item XSRETURN_EMPTY
3434 Return an empty list from an XSUB immediately.
3439 Found in file XSUB.h
3444 Return an integer from an XSUB immediately. Uses C<XST_mIV>.
3446 void XSRETURN_IV(IV iv)
3449 Found in file XSUB.h
3454 Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
3459 Found in file XSUB.h
3464 Return a double from an XSUB immediately. Uses C<XST_mNV>.
3466 void XSRETURN_NV(NV nv)
3469 Found in file XSUB.h
3474 Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
3476 void XSRETURN_PV(char* str)
3479 Found in file XSUB.h
3481 =item XSRETURN_UNDEF
3484 Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
3489 Found in file XSUB.h
3494 Return an integer from an XSUB immediately. Uses C<XST_mUV>.
3496 void XSRETURN_UV(IV uv)
3499 Found in file XSUB.h
3504 Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
3509 Found in file XSUB.h
3514 Place an integer into the specified position C<pos> on the stack. The
3515 value is stored in a new mortal SV.
3517 void XST_mIV(int pos, IV iv)
3520 Found in file XSUB.h
3525 Place C<&PL_sv_no> into the specified position C<pos> on the
3528 void XST_mNO(int pos)
3531 Found in file XSUB.h
3536 Place a double into the specified position C<pos> on the stack. The value
3537 is stored in a new mortal SV.
3539 void XST_mNV(int pos, NV nv)
3542 Found in file XSUB.h
3547 Place a copy of a string into the specified position C<pos> on the stack.
3548 The value is stored in a new mortal SV.
3550 void XST_mPV(int pos, char* str)
3553 Found in file XSUB.h
3558 Place C<&PL_sv_undef> into the specified position C<pos> on the
3561 void XST_mUNDEF(int pos)
3564 Found in file XSUB.h
3569 Place C<&PL_sv_yes> into the specified position C<pos> on the
3572 void XST_mYES(int pos)
3575 Found in file XSUB.h
3587 An enum of flags for Perl types. These are found in the file B<sv.h>
3588 in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
3596 Integer type flag for scalars. See C<svtype>.
3604 Double type flag for scalars. See C<svtype>.
3612 Pointer type flag for scalars. See C<svtype>.
3620 Type flag for arrays. See C<svtype>.
3628 Type flag for code refs. See C<svtype>.
3636 Type flag for hashes. See C<svtype>.
3644 Type flag for blessed scalars. See C<svtype>.
3652 =head1 SV Manipulation Functions
3659 Returns the SV of the specified Perl scalar. If C<create> is set and the
3660 Perl variable does not exist then it will be created. If C<create> is not
3661 set and the variable does not exist then NULL is returned.
3663 NOTE: the perl_ form of this function is deprecated.
3665 SV* get_sv(const char* name, I32 create)
3668 Found in file perl.c
3673 Creates an RV wrapper for an SV. The reference count for the original SV is
3676 SV* newRV_inc(SV* sv)
3684 Returns the length of the string which is in the SV. See C<SvLEN>.
3686 STRLEN SvCUR(SV* sv)
3694 Set the current length of the string which is in the SV. See C<SvCUR>
3697 void SvCUR_set(SV* sv, STRLEN len)
3705 Returns a pointer to the last character in the string which is in the SV.
3706 See C<SvCUR>. Access the character as *(SvEND(sv)).
3716 Returns true if the SV has get magic or overloading. If either is true then
3717 the scalar is active data, and has the potential to return a new value every
3718 time it is accessed. Hence you must be careful to only read it once per user
3719 logical operation and work with that returned value. If neither is true then
3720 the scalar's value cannot change unless written to.
3722 char* SvGAMAGIC(SV* sv)
3730 Expands the character buffer in the SV so that it has room for the
3731 indicated number of bytes (remember to reserve space for an extra trailing
3732 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
3733 Returns a pointer to the character buffer.
3735 char * SvGROW(SV* sv, STRLEN len)
3743 Returns a boolean indicating whether the SV contains an integer.
3753 Returns a boolean indicating whether the SV contains an integer. Checks
3754 the B<private> setting. Use C<SvIOK>.
3764 Returns a boolean indicating whether the SV contains a signed integer.
3766 bool SvIOK_notUV(SV* sv)
3774 Unsets the IV status of an SV.
3776 void SvIOK_off(SV* sv)
3784 Tells an SV that it is an integer.
3786 void SvIOK_on(SV* sv)
3794 Tells an SV that it is an integer and disables all other OK bits.
3796 void SvIOK_only(SV* sv)
3804 Tells and SV that it is an unsigned integer and disables all other OK bits.
3806 void SvIOK_only_UV(SV* sv)
3814 Returns a boolean indicating whether the SV contains an unsigned integer.
3816 bool SvIOK_UV(SV* sv)
3824 Returns a boolean indicating whether the SV is Copy-On-Write. (either shared
3825 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
3828 bool SvIsCOW(SV* sv)
3833 =item SvIsCOW_shared_hash
3834 X<SvIsCOW_shared_hash>
3836 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
3839 bool SvIsCOW_shared_hash(SV* sv)
3847 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
3848 version which guarantees to evaluate sv only once.
3858 Returns the raw value in the SV's IV slot, without checks or conversions.
3859 Only use when you are sure SvIOK is true. See also C<SvIV()>.
3869 Coerces the given SV to an integer and returns it. Guarantees to evaluate
3870 sv only once. Use the more efficient C<SvIV> otherwise.
3880 Like C<SvIV> but doesn't process magic.
3882 IV SvIV_nomg(SV* sv)
3890 Set the value of the IV pointer in sv to val. It is possible to perform
3891 the same function of this macro with an lvalue assignment to C<SvIVX>.
3892 With future Perls, however, it will be more efficient to use
3893 C<SvIV_set> instead of the lvalue assignment to C<SvIVX>.
3895 void SvIV_set(SV* sv, IV val)
3903 Returns the size of the string buffer in the SV, not including any part
3904 attributable to C<SvOOK>. See C<SvCUR>.
3906 STRLEN SvLEN(SV* sv)
3914 Set the actual length of the string which is in the SV. See C<SvIV_set>.
3916 void SvLEN_set(SV* sv, STRLEN len)
3924 Set the value of the MAGIC pointer in sv to val. See C<SvIV_set>.
3926 void SvMAGIC_set(SV* sv, MAGIC* val)
3934 Returns a boolean indicating whether the SV contains a number, integer or
3945 Returns a boolean indicating whether the SV contains a number, integer or
3946 double. Checks the B<private> setting. Use C<SvNIOK>.
3948 bool SvNIOKp(SV* sv)
3956 Unsets the NV/IV status of an SV.
3958 void SvNIOK_off(SV* sv)
3966 Returns a boolean indicating whether the SV contains a double.
3976 Returns a boolean indicating whether the SV contains a double. Checks the
3977 B<private> setting. Use C<SvNOK>.
3987 Unsets the NV status of an SV.
3989 void SvNOK_off(SV* sv)
3997 Tells an SV that it is a double.
3999 void SvNOK_on(SV* sv)
4007 Tells an SV that it is a double and disables all other OK bits.
4009 void SvNOK_only(SV* sv)
4017 Coerce the given SV to a double and return it. See C<SvNVx> for a version
4018 which guarantees to evaluate sv only once.
4028 Returns the raw value in the SV's NV slot, without checks or conversions.
4029 Only use when you are sure SvNOK is true. See also C<SvNV()>.
4039 Coerces the given SV to a double and returns it. Guarantees to evaluate
4040 sv only once. Use the more efficient C<SvNV> otherwise.
4050 Set the value of the NV pointer in sv to val. See C<SvIV_set>.
4052 void SvNV_set(SV* sv, NV val)
4060 Returns a boolean indicating whether the value is an SV. It also tells
4061 whether the value is defined or not.
4071 Returns a boolean indicating whether the SvIVX is a valid offset value for
4072 the SvPVX. This hack is used internally to speed up removal of characters
4073 from the beginning of a SvPV. When SvOOK is true, then the start of the
4074 allocated string buffer is really (SvPVX - SvIVX).
4084 Returns a boolean indicating whether the SV contains a character
4095 Returns a boolean indicating whether the SV contains a character string.
4096 Checks the B<private> setting. Use C<SvPOK>.
4106 Unsets the PV status of an SV.
4108 void SvPOK_off(SV* sv)
4116 Tells an SV that it is a string.
4118 void SvPOK_on(SV* sv)
4126 Tells an SV that it is a string and disables all other OK bits.
4127 Will also turn off the UTF-8 status.
4129 void SvPOK_only(SV* sv)
4134 =item SvPOK_only_UTF8
4137 Tells an SV that it is a string and disables all other OK bits,
4138 and leaves the UTF-8 status as it was.
4140 void SvPOK_only_UTF8(SV* sv)
4148 Returns a pointer to the string in the SV, or a stringified form of
4149 the SV if the SV does not contain a string. The SV may cache the
4150 stringified version becoming C<SvPOK>. Handles 'get' magic. See also
4151 C<SvPVx> for a version which guarantees to evaluate sv only once.
4153 char* SvPV(SV* sv, STRLEN len)
4161 Like C<SvPV>, but converts sv to byte representation first if necessary.
4163 char* SvPVbyte(SV* sv, STRLEN len)
4171 Like C<SvPV>, but converts sv to byte representation first if necessary.
4172 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
4175 char* SvPVbytex(SV* sv, STRLEN len)
4180 =item SvPVbytex_force
4183 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
4184 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
4187 char* SvPVbytex_force(SV* sv, STRLEN len)
4192 =item SvPVbyte_force
4195 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
4197 char* SvPVbyte_force(SV* sv, STRLEN len)
4202 =item SvPVbyte_nolen
4205 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
4207 char* SvPVbyte_nolen(SV* sv)
4215 Like C<SvPV>, but converts sv to utf8 first if necessary.
4217 char* SvPVutf8(SV* sv, STRLEN len)
4225 Like C<SvPV>, but converts sv to utf8 first if necessary.
4226 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
4229 char* SvPVutf8x(SV* sv, STRLEN len)
4234 =item SvPVutf8x_force
4237 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
4238 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
4241 char* SvPVutf8x_force(SV* sv, STRLEN len)
4246 =item SvPVutf8_force
4249 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
4251 char* SvPVutf8_force(SV* sv, STRLEN len)
4256 =item SvPVutf8_nolen
4259 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
4261 char* SvPVutf8_nolen(SV* sv)
4269 Returns a pointer to the physical string in the SV. The SV must contain a
4280 A version of C<SvPV> which guarantees to evaluate sv only once.
4282 char* SvPVx(SV* sv, STRLEN len)
4290 Like C<SvPV> but will force the SV into containing just a string
4291 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
4294 char* SvPV_force(SV* sv, STRLEN len)
4299 =item SvPV_force_nomg
4302 Like C<SvPV> but will force the SV into containing just a string
4303 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
4304 directly. Doesn't process magic.
4306 char* SvPV_force_nomg(SV* sv, STRLEN len)
4314 Returns a pointer to the string in the SV, or a stringified form of
4315 the SV if the SV does not contain a string. The SV may cache the
4316 stringified form becoming C<SvPOK>. Handles 'get' magic.
4318 char* SvPV_nolen(SV* sv)
4326 Like C<SvPV> but doesn't process magic.
4328 char* SvPV_nomg(SV* sv, STRLEN len)
4336 Set the value of the PV pointer in sv to val. See C<SvIV_set>.
4338 void SvPV_set(SV* sv, char* val)
4346 Returns the value of the object's reference count.
4348 U32 SvREFCNT(SV* sv)
4356 Decrements the reference count of the given SV.
4358 void SvREFCNT_dec(SV* sv)
4366 Increments the reference count of the given SV.
4368 All of the following SvREFCNT_inc* macros are optimized versions of
4369 SvREFCNT_inc, and can be replaced with SvREFCNT_inc.
4371 SV* SvREFCNT_inc(SV* sv)
4376 =item SvREFCNT_inc_NN
4379 Same as SvREFCNT_inc, but can only be used if you know I<sv>
4380 is not NULL. Since we don't have to check the NULLness, it's faster
4383 SV* SvREFCNT_inc_NN(SV* sv)
4388 =item SvREFCNT_inc_simple
4389 X<SvREFCNT_inc_simple>
4391 Same as SvREFCNT_inc, but can only be used with simple variables, not
4392 expressions or pointer dereferences. Since we don't have to store a
4393 temporary value, it's faster.
4395 SV* SvREFCNT_inc_simple(SV* sv)
4400 =item SvREFCNT_inc_simple_NN
4401 X<SvREFCNT_inc_simple_NN>
4403 Same as SvREFCNT_inc_simple, but can only be used if you know I<sv>
4404 is not NULL. Since we don't have to check the NULLness, it's faster
4407 SV* SvREFCNT_inc_simple_NN(SV* sv)
4412 =item SvREFCNT_inc_simple_void
4413 X<SvREFCNT_inc_simple_void>
4415 Same as SvREFCNT_inc_simple, but can only be used if you don't need the
4416 return value. The macro doesn't need to return a meaningful value.
4418 void SvREFCNT_inc_simple_void(SV* sv)
4423 =item SvREFCNT_inc_simple_void_NN
4424 X<SvREFCNT_inc_simple_void_NN>
4426 Same as SvREFCNT_inc, but can only be used if you don't need the return
4427 value, and you know that I<sv> is not NULL. The macro doesn't need
4428 to return a meaningful value, or check for NULLness, so it's smaller
4431 void SvREFCNT_inc_simple_void_NN(SV* sv)
4436 =item SvREFCNT_inc_void
4437 X<SvREFCNT_inc_void>
4439 Same as SvREFCNT_inc, but can only be used if you don't need the
4440 return value. The macro doesn't need to return a meaningful value.
4442 void SvREFCNT_inc_void(SV* sv)
4447 =item SvREFCNT_inc_void_NN
4448 X<SvREFCNT_inc_void_NN>
4450 Same as SvREFCNT_inc, but can only be used if you don't need the return
4451 value, and you know that I<sv> is not NULL. The macro doesn't need
4452 to return a meaningful value, or check for NULLness, so it's smaller
4455 void SvREFCNT_inc_void_NN(SV* sv)
4463 Tests if the SV is an RV.
4473 Unsets the RV status of an SV.
4475 void SvROK_off(SV* sv)
4483 Tells an SV that it is an RV.
4485 void SvROK_on(SV* sv)
4493 Dereferences an RV to return the SV.
4503 Set the value of the RV pointer in sv to val. See C<SvIV_set>.
4505 void SvRV_set(SV* sv, SV* val)
4513 Returns the stash of the SV.
4523 Set the value of the STASH pointer in sv to val. See C<SvIV_set>.
4525 void SvSTASH_set(SV* sv, HV* val)
4533 Taints an SV if tainting is enabled.
4535 void SvTAINT(SV* sv)
4543 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
4546 bool SvTAINTED(SV* sv)
4554 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
4555 some of Perl's fundamental security features. XS module authors should not
4556 use this function unless they fully understand all the implications of
4557 unconditionally untainting the value. Untainting should be done in the
4558 standard perl fashion, via a carefully crafted regexp, rather than directly
4559 untainting variables.
4561 void SvTAINTED_off(SV* sv)
4569 Marks an SV as tainted if tainting is enabled.
4571 void SvTAINTED_on(SV* sv)
4579 Returns a boolean indicating whether Perl would evaluate the SV as true or
4580 false, defined or undefined. Does not handle 'get' magic.
4590 Returns the type of the SV. See C<svtype>.
4592 svtype SvTYPE(SV* sv)
4600 Returns a boolean indicating whether the SV contains an unsigned integer.
4610 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
4611 perform the upgrade if necessary. See C<svtype>.
4613 void SvUPGRADE(SV* sv, svtype type)
4621 Returns a boolean indicating whether the SV contains UTF-8 encoded data.
4631 Unsets the UTF-8 status of an SV.
4633 void SvUTF8_off(SV *sv)
4641 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
4642 Do not use frivolously.
4644 void SvUTF8_on(SV *sv)
4652 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
4653 for a version which guarantees to evaluate sv only once.
4663 Returns the raw value in the SV's UV slot, without checks or conversions.
4664 Only use when you are sure SvIOK is true. See also C<SvUV()>.
4674 Coerces the given SV to an unsigned integer and returns it. Guarantees to
4675 evaluate sv only once. Use the more efficient C<SvUV> otherwise.
4685 Like C<SvUV> but doesn't process magic.
4687 UV SvUV_nomg(SV* sv)
4695 Set the value of the UV pointer in sv to val. See C<SvIV_set>.
4697 void SvUV_set(SV* sv, UV val)
4705 Returns a boolean indicating whether the SV contains a v-string.
4712 =item sv_catpvn_nomg
4715 Like C<sv_catpvn> but doesn't process magic.
4717 void sv_catpvn_nomg(SV* sv, const char* ptr, STRLEN len)
4725 Like C<sv_catsv> but doesn't process magic.
4727 void sv_catsv_nomg(SV* dsv, SV* ssv)
4732 =item sv_derived_from
4735 Returns a boolean indicating whether the SV is derived from the specified class
4736 I<at the C level>. To check derivation at the Perl level, call C<isa()> as a
4739 bool sv_derived_from(SV* sv, const char* name)
4742 Found in file universal.c
4747 Returns a boolean indicating whether the SV performs a specific, named role.
4748 The SV can be a Perl object or the name of a Perl class.
4750 bool sv_does(SV* sv, const char* name)
4753 Found in file universal.c
4755 =item sv_report_used
4758 Dump the contents of all SVs not yet freed. (Debugging aid).
4760 void sv_report_used()
4768 Like C<sv_setsv> but doesn't process magic.
4770 void sv_setsv_nomg(SV* dsv, SV* ssv)
4778 =head1 SV-Body Allocation
4782 =item looks_like_number
4783 X<looks_like_number>
4785 Test if the content of an SV looks like a number (or is a number).
4786 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
4787 non-numeric warning), even if your atof() doesn't grok them.
4789 I32 looks_like_number(SV* sv)
4797 Creates an RV wrapper for an SV. The reference count for the original
4798 SV is B<not> incremented.
4800 SV* newRV_noinc(SV* sv)
4808 Creates a new SV. A non-zero C<len> parameter indicates the number of
4809 bytes of preallocated string space the SV should have. An extra byte for a
4810 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4811 space is allocated.) The reference count for the new SV is set to 1.
4813 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4814 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4815 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4816 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4817 modules supporting older perls.
4819 SV* newSV(STRLEN len)
4827 Creates a new SV from the hash key structure. It will generate scalars that
4828 point to the shared string table where possible. Returns a new (undefined)
4829 SV if the hek is NULL.
4831 SV* newSVhek(const HEK *hek)
4839 Creates a new SV and copies an integer into it. The reference count for the
4850 Creates a new SV and copies a floating point value into it.
4851 The reference count for the SV is set to 1.
4861 Creates a new SV and copies a string into it. The reference count for the
4862 SV is set to 1. If C<len> is zero, Perl will compute the length using
4863 strlen(). For efficiency, consider using C<newSVpvn> instead.
4865 SV* newSVpv(const char* s, STRLEN len)
4873 Creates a new SV and initializes it with the string formatted like
4876 SV* newSVpvf(const char* pat, ...)
4884 Creates a new SV and copies a string into it. The reference count for the
4885 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
4886 string. You are responsible for ensuring that the source string is at least
4887 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
4889 SV* newSVpvn(const char* s, STRLEN len)
4894 =item newSVpvn_share
4897 Creates a new SV with its SvPVX_const pointing to a shared string in the string
4898 table. If the string does not already exist in the table, it is created
4899 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
4900 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
4901 otherwise the hash is computed. The idea here is that as the string table
4902 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
4903 hash lookup will avoid string compare.
4905 SV* newSVpvn_share(const char* s, I32 len, U32 hash)
4913 Like C<newSVpvn>, but takes a literal string instead of a string/length pair.
4915 SV* newSVpvs(const char* s)
4918 Found in file handy.h
4920 =item newSVpvs_share
4923 Like C<newSVpvn_share>, but takes a literal string instead of a string/length
4924 pair and omits the hash parameter.
4926 SV* newSVpvs_share(const char* s)
4929 Found in file handy.h
4934 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
4935 it will be upgraded to one. If C<classname> is non-null then the new SV will
4936 be blessed in the specified package. The new SV is returned and its
4937 reference count is 1.
4939 SV* newSVrv(SV* rv, const char* classname)
4947 Creates a new SV which is an exact duplicate of the original SV.
4950 SV* newSVsv(SV* old)
4958 Creates a new SV and copies an unsigned integer into it.
4959 The reference count for the SV is set to 1.
4969 This function is only called on magical items, and is only used by
4970 sv_true() or its macro equivalent.
4972 bool sv_2bool(SV* sv)
4980 Using various gambits, try to get a CV from an SV; in addition, try if
4981 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
4982 The flags in C<lref> are passed to sv_fetchsv.
4984 CV* sv_2cv(SV* sv, HV** st, GV** gvp, I32 lref)
4992 Using various gambits, try to get an IO from an SV: the IO slot if its a
4993 GV; or the recursive result if we're an RV; or the IO slot of the symbol
4994 named after the PV if we're a string.
5004 Return the integer value of an SV, doing any necessary string
5005 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
5006 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
5008 IV sv_2iv_flags(SV* sv, I32 flags)
5016 Marks an existing SV as mortal. The SV will be destroyed "soon", either
5017 by an explicit call to FREETMPS, or by an implicit call at places such as
5018 statement boundaries. SvTEMP() is turned on which means that the SV's
5019 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
5020 and C<sv_mortalcopy>.
5022 SV* sv_2mortal(SV* sv)
5030 Return the num value of an SV, doing any necessary string or integer
5031 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
5042 Return a pointer to the byte-encoded representation of the SV, and set *lp
5043 to its length. May cause the SV to be downgraded from UTF-8 as a
5046 Usually accessed via the C<SvPVbyte> macro.
5048 char* sv_2pvbyte(SV* sv, STRLEN* lp)
5056 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
5057 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
5059 Usually accessed via the C<SvPVutf8> macro.
5061 char* sv_2pvutf8(SV* sv, STRLEN* lp)
5069 Returns a pointer to the string value of an SV, and sets *lp to its length.
5070 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
5072 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
5073 usually end up here too.
5075 char* sv_2pv_flags(SV* sv, STRLEN* lp, I32 flags)
5083 Return the unsigned integer value of an SV, doing any necessary string
5084 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
5085 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
5087 UV sv_2uv_flags(SV* sv, I32 flags)
5095 Remove any string offset. You should normally use the C<SvOOK_off> macro
5098 int sv_backoff(SV* sv)
5106 Blesses an SV into a specified package. The SV must be an RV. The package
5107 must be designated by its stash (see C<gv_stashpv()>). The reference count
5108 of the SV is unaffected.
5110 SV* sv_bless(SV* sv, HV* stash)
5118 Concatenates the string onto the end of the string which is in the SV.
5119 If the SV has the UTF-8 status set, then the bytes appended should be
5120 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
5122 void sv_catpv(SV* sv, const char* ptr)
5130 Processes its arguments like C<sprintf> and appends the formatted
5131 output to an SV. If the appended data contains "wide" characters
5132 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
5133 and characters >255 formatted with %c), the original SV might get
5134 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
5135 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
5136 valid UTF-8; if the original SV was bytes, the pattern should be too.
5138 void sv_catpvf(SV* sv, const char* pat, ...)
5146 Like C<sv_catpvf>, but also handles 'set' magic.
5148 void sv_catpvf_mg(SV *sv, const char* pat, ...)
5156 Concatenates the string onto the end of the string which is in the SV. The
5157 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5158 status set, then the bytes appended should be valid UTF-8.
5159 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
5161 void sv_catpvn(SV* sv, const char* ptr, STRLEN len)
5166 =item sv_catpvn_flags
5169 Concatenates the string onto the end of the string which is in the SV. The
5170 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5171 status set, then the bytes appended should be valid UTF-8.
5172 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
5173 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
5174 in terms of this function.
5176 void sv_catpvn_flags(SV* sv, const char* ptr, STRLEN len, I32 flags)
5184 Like C<sv_catpvn>, but takes a literal string instead of a string/length pair.
5186 void sv_catpvs(SV* sv, const char* s)
5189 Found in file handy.h
5194 Like C<sv_catpv>, but also handles 'set' magic.
5196 void sv_catpv_mg(SV *sv, const char *ptr)
5204 Concatenates the string from SV C<ssv> onto the end of the string in
5205 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
5206 not 'set' magic. See C<sv_catsv_mg>.
5208 void sv_catsv(SV* dsv, SV* ssv)
5213 =item sv_catsv_flags
5216 Concatenates the string from SV C<ssv> onto the end of the string in
5217 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
5218 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
5219 and C<sv_catsv_nomg> are implemented in terms of this function.
5221 void sv_catsv_flags(SV* dsv, SV* ssv, I32 flags)
5229 Efficient removal of characters from the beginning of the string buffer.
5230 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
5231 the string buffer. The C<ptr> becomes the first character of the adjusted
5232 string. Uses the "OOK hack".
5233 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
5234 refer to the same chunk of data.
5236 void sv_chop(SV* sv, const char* ptr)
5244 Clear an SV: call any destructors, free up any memory used by the body,
5245 and free the body itself. The SV's head is I<not> freed, although
5246 its type is set to all 1's so that it won't inadvertently be assumed
5247 to be live during global destruction etc.
5248 This function should only be called when REFCNT is zero. Most of the time
5249 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5252 void sv_clear(SV* sv)
5260 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5261 string in C<sv1> is less than, equal to, or greater than the string in
5262 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5263 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
5265 I32 sv_cmp(SV* sv1, SV* sv2)
5273 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
5274 'use bytes' aware, handles get magic, and will coerce its args to strings
5275 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
5277 I32 sv_cmp_locale(SV* sv1, SV* sv2)
5285 Add Collate Transform magic to an SV if it doesn't already have it.
5287 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
5288 scalar data of the variable, but transformed to such a format that a normal
5289 memory comparison can be used to compare the data according to the locale
5292 char* sv_collxfrm(SV* sv, STRLEN* nxp)
5300 Copies a stringified representation of the source SV into the
5301 destination SV. Automatically performs any necessary mg_get and
5302 coercion of numeric values into strings. Guaranteed to preserve
5303 UTF-8 flag even from overloaded objects. Similar in nature to
5304 sv_2pv[_flags] but operates directly on an SV instead of just the
5305 string. Mostly uses sv_2pv_flags to do its work, except when that
5306 would lose the UTF-8'ness of the PV.
5308 void sv_copypv(SV* dsv, SV* ssv)
5316 Auto-decrement of the value in the SV, doing string to numeric conversion
5317 if necessary. Handles 'get' magic.
5327 Returns a boolean indicating whether the strings in the two SVs are
5328 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5329 coerce its args to strings if necessary.
5331 I32 sv_eq(SV* sv1, SV* sv2)
5336 =item sv_force_normal_flags
5337 X<sv_force_normal_flags>
5339 Undo various types of fakery on an SV: if the PV is a shared string, make
5340 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
5341 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
5342 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
5343 then a copy-on-write scalar drops its PV buffer (if any) and becomes
5344 SvPOK_off rather than making a copy. (Used where this scalar is about to be
5345 set to some other value.) In addition, the C<flags> parameter gets passed to
5346 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
5347 with flags set to 0.
5349 void sv_force_normal_flags(SV *sv, U32 flags)
5357 Decrement an SV's reference count, and if it drops to zero, call
5358 C<sv_clear> to invoke destructors and free up any memory used by
5359 the body; finally, deallocate the SV's head itself.
5360 Normally called via a wrapper macro C<SvREFCNT_dec>.
5362 void sv_free(SV* sv)
5370 Get a line from the filehandle and store it into the SV, optionally
5371 appending to the currently-stored string.
5373 char* sv_gets(SV* sv, PerlIO* fp, I32 append)
5381 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
5382 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
5383 Use the C<SvGROW> wrapper instead.
5385 char* sv_grow(SV* sv, STRLEN newlen)
5393 Auto-increment of the value in the SV, doing string to numeric conversion
5394 if necessary. Handles 'get' magic.
5404 Inserts a string at the specified offset/length within the SV. Similar to
5405 the Perl substr() function.
5407 void sv_insert(SV* bigsv, STRLEN offset, STRLEN len, const char* little, STRLEN littlelen)
5415 Returns a boolean indicating whether the SV is blessed into the specified
5416 class. This does not check for subtypes; use C<sv_derived_from> to verify
5417 an inheritance relationship.
5419 int sv_isa(SV* sv, const char* name)
5427 Returns a boolean indicating whether the SV is an RV pointing to a blessed
5428 object. If the SV is not an RV, or if the object is not blessed, then this
5431 int sv_isobject(SV* sv)
5439 Returns the length of the string in the SV. Handles magic and type
5440 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5442 STRLEN sv_len(SV* sv)
5450 Returns the number of characters in the string in an SV, counting wide
5451 UTF-8 bytes as a single character. Handles magic and type coercion.
5453 STRLEN sv_len_utf8(SV* sv)
5461 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
5462 then adds a new magic item of type C<how> to the head of the magic list.
5464 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
5465 handling of the C<name> and C<namlen> arguments.
5467 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
5468 to add more than one instance of the same 'how'.
5470 void sv_magic(SV* sv, SV* obj, int how, const char* name, I32 namlen)
5478 Adds magic to an SV, upgrading it if necessary. Applies the
5479 supplied vtable and returns a pointer to the magic added.
5481 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
5482 In particular, you can add magic to SvREADONLY SVs, and add more than
5483 one instance of the same 'how'.
5485 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
5486 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
5487 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
5488 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
5490 (This is now used as a subroutine by C<sv_magic>.)
5492 MAGIC * sv_magicext(SV* sv, SV* obj, int how, MGVTBL *vtbl, const char* name, I32 namlen)
5500 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
5501 The new SV is marked as mortal. It will be destroyed "soon", either by an
5502 explicit call to FREETMPS, or by an implicit call at places such as
5503 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
5505 SV* sv_mortalcopy(SV* oldsv)
5513 Creates a new null SV which is mortal. The reference count of the SV is
5514 set to 1. It will be destroyed "soon", either by an explicit call to
5515 FREETMPS, or by an implicit call at places such as statement boundaries.
5516 See also C<sv_mortalcopy> and C<sv_2mortal>.
5526 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5529 SV* sv_newref(SV* sv)
5537 Converts the value pointed to by offsetp from a count of bytes from the
5538 start of the string, to a count of the equivalent number of UTF-8 chars.
5539 Handles magic and type coercion.
5541 void sv_pos_b2u(SV* sv, I32* offsetp)
5549 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5550 the start of the string, to a count of the equivalent number of bytes; if
5551 lenp is non-zero, it does the same to lenp, but this time starting from
5552 the offset, rather than from the start of the string. Handles magic and
5555 void sv_pos_u2b(SV* sv, I32* offsetp, I32* lenp)
5560 =item sv_pvbyten_force
5563 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
5565 char* sv_pvbyten_force(SV* sv, STRLEN* lp)
5573 Get a sensible string out of the SV somehow.
5574 A private implementation of the C<SvPV_force> macro for compilers which
5575 can't cope with complex macro expressions. Always use the macro instead.
5577 char* sv_pvn_force(SV* sv, STRLEN* lp)
5582 =item sv_pvn_force_flags
5583 X<sv_pvn_force_flags>
5585 Get a sensible string out of the SV somehow.
5586 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
5587 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
5588 implemented in terms of this function.
5589 You normally want to use the various wrapper macros instead: see
5590 C<SvPV_force> and C<SvPV_force_nomg>
5592 char* sv_pvn_force_flags(SV* sv, STRLEN* lp, I32 flags)
5597 =item sv_pvutf8n_force
5600 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
5602 char* sv_pvutf8n_force(SV* sv, STRLEN* lp)
5610 Returns a string describing what the SV is a reference to.
5612 char* sv_reftype(const SV* sv, int ob)
5620 Make the first argument a copy of the second, then delete the original.
5621 The target SV physically takes over ownership of the body of the source SV
5622 and inherits its flags; however, the target keeps any magic it owns,
5623 and any magic in the source is discarded.
5624 Note that this is a rather specialist SV copying operation; most of the
5625 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5627 void sv_replace(SV* sv, SV* nsv)
5635 Underlying implementation for the C<reset> Perl function.
5636 Note that the perl-level function is vaguely deprecated.
5638 void sv_reset(const char* s, HV* stash)
5646 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
5647 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
5648 push a back-reference to this RV onto the array of backreferences
5649 associated with that magic. If the RV is magical, set magic will be
5650 called after the RV is cleared.
5652 SV* sv_rvweaken(SV *sv)
5660 Copies an integer into the given SV, upgrading first if necessary.
5661 Does not handle 'set' magic. See also C<sv_setiv_mg>.
5663 void sv_setiv(SV* sv, IV num)
5671 Like C<sv_setiv>, but also handles 'set' magic.
5673 void sv_setiv_mg(SV *sv, IV i)
5681 Copies a double into the given SV, upgrading first if necessary.
5682 Does not handle 'set' magic. See also C<sv_setnv_mg>.
5684 void sv_setnv(SV* sv, NV num)
5692 Like C<sv_setnv>, but also handles 'set' magic.
5694 void sv_setnv_mg(SV *sv, NV num)
5702 Copies a string into an SV. The string must be null-terminated. Does not
5703 handle 'set' magic. See C<sv_setpv_mg>.
5705 void sv_setpv(SV* sv, const char* ptr)
5713 Works like C<sv_catpvf> but copies the text into the SV instead of
5714 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
5716 void sv_setpvf(SV* sv, const char* pat, ...)
5724 Like C<sv_setpvf>, but also handles 'set' magic.
5726 void sv_setpvf_mg(SV *sv, const char* pat, ...)
5734 Copies an integer into the given SV, also updating its string value.
5735 Does not handle 'set' magic. See C<sv_setpviv_mg>.
5737 void sv_setpviv(SV* sv, IV num)
5745 Like C<sv_setpviv>, but also handles 'set' magic.
5747 void sv_setpviv_mg(SV *sv, IV iv)
5755 Copies a string into an SV. The C<len> parameter indicates the number of
5756 bytes to be copied. If the C<ptr> argument is NULL the SV will become
5757 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
5759 void sv_setpvn(SV* sv, const char* ptr, STRLEN len)
5767 Like C<sv_setpvn>, but also handles 'set' magic.
5769 void sv_setpvn_mg(SV *sv, const char *ptr, STRLEN len)
5777 Like C<sv_setpvn>, but takes a literal string instead of a string/length pair.
5779 void sv_setpvs(SV* sv, const char* s)
5782 Found in file handy.h
5787 Like C<sv_setpv>, but also handles 'set' magic.
5789 void sv_setpv_mg(SV *sv, const char *ptr)
5797 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
5798 argument will be upgraded to an RV. That RV will be modified to point to
5799 the new SV. The C<classname> argument indicates the package for the
5800 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
5801 will have a reference count of 1, and the RV will be returned.
5803 SV* sv_setref_iv(SV* rv, const char* classname, IV iv)
5811 Copies a double into a new SV, optionally blessing the SV. The C<rv>
5812 argument will be upgraded to an RV. That RV will be modified to point to
5813 the new SV. The C<classname> argument indicates the package for the
5814 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
5815 will have a reference count of 1, and the RV will be returned.
5817 SV* sv_setref_nv(SV* rv, const char* classname, NV nv)
5825 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
5826 argument will be upgraded to an RV. That RV will be modified to point to
5827 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
5828 into the SV. The C<classname> argument indicates the package for the
5829 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
5830 will have a reference count of 1, and the RV will be returned.
5832 Do not use with other Perl types such as HV, AV, SV, CV, because those
5833 objects will become corrupted by the pointer copy process.
5835 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
5837 SV* sv_setref_pv(SV* rv, const char* classname, void* pv)
5845 Copies a string into a new SV, optionally blessing the SV. The length of the
5846 string must be specified with C<n>. The C<rv> argument will be upgraded to
5847 an RV. That RV will be modified to point to the new SV. The C<classname>
5848 argument indicates the package for the blessing. Set C<classname> to
5849 C<NULL> to avoid the blessing. The new SV will have a reference count
5850 of 1, and the RV will be returned.
5852 Note that C<sv_setref_pv> copies the pointer while this copies the string.
5854 SV* sv_setref_pvn(SV* rv, const char* classname, const char* pv, STRLEN n)
5862 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
5863 argument will be upgraded to an RV. That RV will be modified to point to
5864 the new SV. The C<classname> argument indicates the package for the
5865 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
5866 will have a reference count of 1, and the RV will be returned.
5868 SV* sv_setref_uv(SV* rv, const char* classname, UV uv)
5876 Copies the contents of the source SV C<ssv> into the destination SV
5877 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
5878 function if the source SV needs to be reused. Does not handle 'set' magic.
5879 Loosely speaking, it performs a copy-by-value, obliterating any previous
5880 content of the destination.
5882 You probably want to use one of the assortment of wrappers, such as
5883 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
5884 C<SvSetMagicSV_nosteal>.
5886 void sv_setsv(SV* dsv, SV* ssv)
5891 =item sv_setsv_flags
5894 Copies the contents of the source SV C<ssv> into the destination SV
5895 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
5896 function if the source SV needs to be reused. Does not handle 'set' magic.
5897 Loosely speaking, it performs a copy-by-value, obliterating any previous
5898 content of the destination.
5899 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
5900 C<ssv> if appropriate, else not. If the C<flags> parameter has the
5901 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
5902 and C<sv_setsv_nomg> are implemented in terms of this function.
5904 You probably want to use one of the assortment of wrappers, such as
5905 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
5906 C<SvSetMagicSV_nosteal>.
5908 This is the primary function for copying scalars, and most other
5909 copy-ish functions and macros use this underneath.
5911 void sv_setsv_flags(SV* dsv, SV* ssv, I32 flags)
5919 Like C<sv_setsv>, but also handles 'set' magic.
5921 void sv_setsv_mg(SV *dstr, SV *sstr)
5929 Copies an unsigned integer into the given SV, upgrading first if necessary.
5930 Does not handle 'set' magic. See also C<sv_setuv_mg>.
5932 void sv_setuv(SV* sv, UV num)
5940 Like C<sv_setuv>, but also handles 'set' magic.
5942 void sv_setuv_mg(SV *sv, UV u)
5950 Test an SV for taintedness. Use C<SvTAINTED> instead.
5951 bool sv_tainted(SV* sv)
5959 Returns true if the SV has a true value by Perl's rules.
5960 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
5961 instead use an in-line version.
5971 Removes all magic of type C<type> from an SV.
5973 int sv_unmagic(SV* sv, int type)
5978 =item sv_unref_flags
5981 Unsets the RV status of the SV, and decrements the reference count of
5982 whatever was being referenced by the RV. This can almost be thought of
5983 as a reversal of C<newSVrv>. The C<cflags> argument can contain
5984 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
5985 (otherwise the decrementing is conditional on the reference count being
5986 different from one or the reference being a readonly SV).
5989 void sv_unref_flags(SV* sv, U32 flags)
5997 Untaint an SV. Use C<SvTAINTED_off> instead.
5998 void sv_untaint(SV* sv)
6006 Upgrade an SV to a more complex form. Generally adds a new body type to the
6007 SV, then copies across as much information as possible from the old body.
6008 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
6010 void sv_upgrade(SV* sv, svtype new_type)
6015 =item sv_usepvn_flags
6018 Tells an SV to use C<ptr> to find its string value. Normally the
6019 string is stored inside the SV but sv_usepvn allows the SV to use an
6020 outside string. The C<ptr> should point to memory that was allocated
6021 by C<malloc>. The string length, C<len>, must be supplied. By default
6022 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
6023 so that pointer should not be freed or used by the programmer after
6024 giving it to sv_usepvn, and neither should any pointers from "behind"
6025 that pointer (e.g. ptr + 1) be used.
6027 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
6028 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
6029 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
6030 C<len>, and already meets the requirements for storing in C<SvPVX>)
6032 void sv_usepvn_flags(SV* sv, char* ptr, STRLEN len, U32 flags)
6037 =item sv_utf8_decode
6040 If the PV of the SV is an octet sequence in UTF-8
6041 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
6042 so that it looks like a character. If the PV contains only single-byte
6043 characters, the C<SvUTF8> flag stays being off.
6044 Scans PV for validity and returns false if the PV is invalid UTF-8.
6046 NOTE: this function is experimental and may change or be
6047 removed without notice.
6049 bool sv_utf8_decode(SV *sv)
6054 =item sv_utf8_downgrade
6055 X<sv_utf8_downgrade>
6057 Attempts to convert the PV of an SV from characters to bytes.
6058 If the PV contains a character beyond byte, this conversion will fail;
6059 in this case, either returns false or, if C<fail_ok> is not
6062 This is not as a general purpose Unicode to byte encoding interface:
6063 use the Encode extension for that.
6065 NOTE: this function is experimental and may change or be
6066 removed without notice.
6068 bool sv_utf8_downgrade(SV *sv, bool fail_ok)
6073 =item sv_utf8_encode
6076 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
6077 flag off so that it looks like octets again.
6079 void sv_utf8_encode(SV *sv)
6084 =item sv_utf8_upgrade
6087 Converts the PV of an SV to its UTF-8-encoded form.
6088 Forces the SV to string form if it is not already.
6089 Always sets the SvUTF8 flag to avoid future validity checks even
6090 if all the bytes have hibit clear.
6092 This is not as a general purpose byte encoding to Unicode interface:
6093 use the Encode extension for that.
6095 STRLEN sv_utf8_upgrade(SV *sv)
6100 =item sv_utf8_upgrade_flags
6101 X<sv_utf8_upgrade_flags>
6103 Converts the PV of an SV to its UTF-8-encoded form.
6104 Forces the SV to string form if it is not already.
6105 Always sets the SvUTF8 flag to avoid future validity checks even
6106 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
6107 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
6108 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
6110 This is not as a general purpose byte encoding to Unicode interface:
6111 use the Encode extension for that.
6113 STRLEN sv_utf8_upgrade_flags(SV *sv, I32 flags)
6121 Processes its arguments like C<vsprintf> and appends the formatted output
6122 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
6124 Usually used via its frontend C<sv_catpvf>.
6126 void sv_vcatpvf(SV* sv, const char* pat, va_list* args)
6134 Processes its arguments like C<vsprintf> and appends the formatted output
6135 to an SV. Uses an array of SVs if the C style variable argument list is
6136 missing (NULL). When running with taint checks enabled, indicates via
6137 C<maybe_tainted> if results are untrustworthy (often due to the use of
6140 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
6142 void sv_vcatpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
6150 Like C<sv_vcatpvf>, but also handles 'set' magic.
6152 Usually used via its frontend C<sv_catpvf_mg>.
6154 void sv_vcatpvf_mg(SV* sv, const char* pat, va_list* args)
6162 Works like C<sv_vcatpvf> but copies the text into the SV instead of
6163 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
6165 Usually used via its frontend C<sv_setpvf>.
6167 void sv_vsetpvf(SV* sv, const char* pat, va_list* args)
6175 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
6178 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
6180 void sv_vsetpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
6188 Like C<sv_vsetpvf>, but also handles 'set' magic.
6190 Usually used via its frontend C<sv_setpvf_mg>.
6192 void sv_vsetpvf_mg(SV* sv, const char* pat, va_list* args)
6200 =head1 Unicode Support
6204 =item bytes_from_utf8
6207 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
6208 Unlike C<utf8_to_bytes> but like C<bytes_to_utf8>, returns a pointer to
6209 the newly-created string, and updates C<len> to contain the new
6210 length. Returns the original string if no conversion occurs, C<len>
6211 is unchanged. Do nothing if C<is_utf8> points to 0. Sets C<is_utf8> to
6212 0 if C<s> is converted or contains all 7bit characters.
6214 NOTE: this function is experimental and may change or be
6215 removed without notice.
6217 U8* bytes_from_utf8(const U8 *s, STRLEN *len, bool *is_utf8)
6220 Found in file utf8.c
6225 Converts a string C<s> of length C<len> from ASCII into UTF-8 encoding.
6226 Returns a pointer to the newly-created string, and sets C<len> to
6227 reflect the new length.
6229 If you want to convert to UTF-8 from other encodings than ASCII,
6230 see sv_recode_to_utf8().
6232 NOTE: this function is experimental and may change or be
6233 removed without notice.
6235 U8* bytes_to_utf8(const U8 *s, STRLEN *len)
6238 Found in file utf8.c
6243 Return true if the strings s1 and s2 differ case-insensitively, false
6244 if not (if they are equal case-insensitively). If u1 is true, the
6245 string s1 is assumed to be in UTF-8-encoded Unicode. If u2 is true,
6246 the string s2 is assumed to be in UTF-8-encoded Unicode. If u1 or u2
6247 are false, the respective string is assumed to be in native 8-bit
6250 If the pe1 and pe2 are non-NULL, the scanning pointers will be copied
6251 in there (they will point at the beginning of the I<next> character).
6252 If the pointers behind pe1 or pe2 are non-NULL, they are the end
6253 pointers beyond which scanning will not continue under any
6254 circumstances. If the byte lengths l1 and l2 are non-zero, s1+l1 and
6255 s2+l2 will be used as goal end pointers that will also stop the scan,
6256 and which qualify towards defining a successful match: all the scans
6257 that define an explicit length must reach their goal pointers for
6258 a match to succeed).
6260 For case-insensitiveness, the "casefolding" of Unicode is used
6261 instead of upper/lowercasing both the characters, see
6262 http://www.unicode.org/unicode/reports/tr21/ (Case Mappings).
6264 I32 ibcmp_utf8(const char* a, char **pe1, UV l1, bool u1, const char* b, char **pe2, UV l2, bool u2)
6267 Found in file utf8.c
6272 Tests if some arbitrary number of bytes begins in a valid UTF-8
6273 character. Note that an INVARIANT (i.e. ASCII) character is a valid
6274 UTF-8 character. The actual number of bytes in the UTF-8 character
6275 will be returned if it is valid, otherwise 0.
6277 STRLEN is_utf8_char(const U8 *p)
6280 Found in file utf8.c
6282 =item is_utf8_string
6285 Returns true if first C<len> bytes of the given string form a valid
6286 UTF-8 string, false otherwise. Note that 'a valid UTF-8 string' does
6287 not mean 'a string that contains code points above 0x7F encoded in UTF-8'
6288 because a valid ASCII string is a valid UTF-8 string.
6290 See also is_utf8_string_loclen() and is_utf8_string_loc().
6292 bool is_utf8_string(const U8 *s, STRLEN len)
6295 Found in file utf8.c
6297 =item is_utf8_string_loc
6298 X<is_utf8_string_loc>
6300 Like is_utf8_string() but stores the location of the failure (in the
6301 case of "utf8ness failure") or the location s+len (in the case of
6302 "utf8ness success") in the C<ep>.
6304 See also is_utf8_string_loclen() and is_utf8_string().
6306 bool is_utf8_string_loc(const U8 *s, STRLEN len, const U8 **p)
6309 Found in file utf8.c
6311 =item is_utf8_string_loclen
6312 X<is_utf8_string_loclen>
6314 Like is_utf8_string() but stores the location of the failure (in the
6315 case of "utf8ness failure") or the location s+len (in the case of
6316 "utf8ness success") in the C<ep>, and the number of UTF-8
6317 encoded characters in the C<el>.
6319 See also is_utf8_string_loc() and is_utf8_string().
6321 bool is_utf8_string_loclen(const U8 *s, STRLEN len, const U8 **ep, STRLEN *el)
6324 Found in file utf8.c
6326 =item pv_uni_display
6329 Build to the scalar dsv a displayable version of the string spv,
6330 length len, the displayable version being at most pvlim bytes long
6331 (if longer, the rest is truncated and "..." will be appended).
6333 The flags argument can have UNI_DISPLAY_ISPRINT set to display
6334 isPRINT()able characters as themselves, UNI_DISPLAY_BACKSLASH
6335 to display the \\[nrfta\\] as the backslashed versions (like '\n')
6336 (UNI_DISPLAY_BACKSLASH is preferred over UNI_DISPLAY_ISPRINT for \\).
6337 UNI_DISPLAY_QQ (and its alias UNI_DISPLAY_REGEX) have both
6338 UNI_DISPLAY_BACKSLASH and UNI_DISPLAY_ISPRINT turned on.
6340 The pointer to the PV of the dsv is returned.
6342 char* pv_uni_display(SV *dsv, const U8 *spv, STRLEN len, STRLEN pvlim, UV flags)
6345 Found in file utf8.c
6350 The encoding is assumed to be an Encode object, the PV of the ssv is
6351 assumed to be octets in that encoding and decoding the input starts
6352 from the position which (PV + *offset) pointed to. The dsv will be
6353 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
6354 when the string tstr appears in decoding output or the input ends on
6355 the PV of the ssv. The value which the offset points will be modified
6356 to the last input position on the ssv.
6358 Returns TRUE if the terminator was found, else returns FALSE.
6360 bool sv_cat_decode(SV* dsv, SV *encoding, SV *ssv, int *offset, char* tstr, int tlen)
6365 =item sv_recode_to_utf8
6366 X<sv_recode_to_utf8>
6368 The encoding is assumed to be an Encode object, on entry the PV
6369 of the sv is assumed to be octets in that encoding, and the sv
6370 will be converted into Unicode (and UTF-8).
6372 If the sv already is UTF-8 (or if it is not POK), or if the encoding
6373 is not a reference, nothing is done to the sv. If the encoding is not
6374 an C<Encode::XS> Encoding object, bad things will happen.
6375 (See F<lib/encoding.pm> and L<Encode>).
6377 The PV of the sv is returned.
6379 char* sv_recode_to_utf8(SV* sv, SV *encoding)
6384 =item sv_uni_display
6387 Build to the scalar dsv a displayable version of the scalar sv,
6388 the displayable version being at most pvlim bytes long
6389 (if longer, the rest is truncated and "..." will be appended).
6391 The flags argument is as in pv_uni_display().
6393 The pointer to the PV of the dsv is returned.
6395 char* sv_uni_display(SV *dsv, SV *ssv, STRLEN pvlim, UV flags)
6398 Found in file utf8.c
6403 The "p" contains the pointer to the UTF-8 string encoding
6404 the character that is being converted.
6406 The "ustrp" is a pointer to the character buffer to put the
6407 conversion result to. The "lenp" is a pointer to the length
6410 The "swashp" is a pointer to the swash to use.
6412 Both the special and normal mappings are stored lib/unicore/To/Foo.pl,
6413 and loaded by SWASHNEW, using lib/utf8_heavy.pl. The special (usually,
6414 but not always, a multicharacter mapping), is tried first.
6416 The "special" is a string like "utf8::ToSpecLower", which means the
6417 hash %utf8::ToSpecLower. The access to the hash is through
6418 Perl_to_utf8_case().
6420 The "normal" is a string like "ToLower" which means the swash
6423 UV to_utf8_case(const U8 *p, U8* ustrp, STRLEN *lenp, SV **swashp, const char *normal, const char *special)
6426 Found in file utf8.c
6431 Convert the UTF-8 encoded character at p to its foldcase version and
6432 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6433 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6434 foldcase version may be longer than the original character (up to
6437 The first character of the foldcased version is returned
6438 (but note, as explained above, that there may be more.)
6440 UV to_utf8_fold(const U8 *p, U8* ustrp, STRLEN *lenp)
6443 Found in file utf8.c
6448 Convert the UTF-8 encoded character at p to its lowercase version and
6449 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6450 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6451 lowercase version may be longer than the original character.
6453 The first character of the lowercased version is returned
6454 (but note, as explained above, that there may be more.)
6456 UV to_utf8_lower(const U8 *p, U8* ustrp, STRLEN *lenp)
6459 Found in file utf8.c
6464 Convert the UTF-8 encoded character at p to its titlecase version and
6465 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6466 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
6467 titlecase version may be longer than the original character.
6469 The first character of the titlecased version is returned
6470 (but note, as explained above, that there may be more.)
6472 UV to_utf8_title(const U8 *p, U8* ustrp, STRLEN *lenp)
6475 Found in file utf8.c
6480 Convert the UTF-8 encoded character at p to its uppercase version and
6481 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6482 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since
6483 the uppercase version may be longer than the original character.
6485 The first character of the uppercased version is returned
6486 (but note, as explained above, that there may be more.)
6488 UV to_utf8_upper(const U8 *p, U8* ustrp, STRLEN *lenp)
6491 Found in file utf8.c
6493 =item utf8n_to_uvchr
6498 Returns the native character value of the first character in the string
6500 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6501 length, in bytes, of that character.
6503 Allows length and flags to be passed to low level routine.
6505 UV utf8n_to_uvchr(const U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags)
6508 Found in file utf8.c
6510 =item utf8n_to_uvuni
6513 Bottom level UTF-8 decode routine.
6514 Returns the unicode code point value of the first character in the string C<s>
6515 which is assumed to be in UTF-8 encoding and no longer than C<curlen>;
6516 C<retlen> will be set to the length, in bytes, of that character.
6518 If C<s> does not point to a well-formed UTF-8 character, the behaviour
6519 is dependent on the value of C<flags>: if it contains UTF8_CHECK_ONLY,
6520 it is assumed that the caller will raise a warning, and this function
6521 will silently just set C<retlen> to C<-1> and return zero. If the
6522 C<flags> does not contain UTF8_CHECK_ONLY, warnings about
6523 malformations will be given, C<retlen> will be set to the expected
6524 length of the UTF-8 character in bytes, and zero will be returned.
6526 The C<flags> can also contain various flags to allow deviations from
6527 the strict UTF-8 encoding (see F<utf8.h>).
6529 Most code should use utf8_to_uvchr() rather than call this directly.
6531 UV utf8n_to_uvuni(const U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags)
6534 Found in file utf8.c
6539 Returns the number of UTF-8 characters between the UTF-8 pointers C<a>
6542 WARNING: use only if you *know* that the pointers point inside the
6545 IV utf8_distance(const U8 *a, const U8 *b)
6548 Found in file utf8.c
6553 Return the UTF-8 pointer C<s> displaced by C<off> characters, either
6554 forward or backward.
6556 WARNING: do not use the following unless you *know* C<off> is within
6557 the UTF-8 data pointed to by C<s> *and* that on entry C<s> is aligned
6558 on the first byte of character or just after the last byte of a character.
6560 U8* utf8_hop(const U8 *s, I32 off)
6563 Found in file utf8.c
6568 Return the length of the UTF-8 char encoded string C<s> in characters.
6569 Stops at C<e> (inclusive). If C<e E<lt> s> or if the scan would end
6570 up past C<e>, croaks.
6572 STRLEN utf8_length(const U8* s, const U8 *e)
6575 Found in file utf8.c
6580 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
6581 Unlike C<bytes_to_utf8>, this over-writes the original string, and
6582 updates len to contain the new length.
6583 Returns zero on failure, setting C<len> to -1.
6585 If you need a copy of the string, see C<bytes_from_utf8>.
6587 NOTE: this function is experimental and may change or be
6588 removed without notice.
6590 U8* utf8_to_bytes(U8 *s, STRLEN *len)
6593 Found in file utf8.c
6598 Returns the native character value of the first character in the string C<s>
6599 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6600 length, in bytes, of that character.
6602 If C<s> does not point to a well-formed UTF-8 character, zero is
6603 returned and retlen is set, if possible, to -1.
6605 UV utf8_to_uvchr(const U8 *s, STRLEN *retlen)
6608 Found in file utf8.c
6613 Returns the Unicode code point of the first character in the string C<s>
6614 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6615 length, in bytes, of that character.
6617 This function should only be used when returned UV is considered
6618 an index into the Unicode semantic tables (e.g. swashes).
6620 If C<s> does not point to a well-formed UTF-8 character, zero is
6621 returned and retlen is set, if possible, to -1.
6623 UV utf8_to_uvuni(const U8 *s, STRLEN *retlen)
6626 Found in file utf8.c
6631 Adds the UTF-8 representation of the Native codepoint C<uv> to the end
6632 of the string C<d>; C<d> should be have at least C<UTF8_MAXBYTES+1> free
6633 bytes available. The return value is the pointer to the byte after the
6634 end of the new character. In other words,
6636 d = uvchr_to_utf8(d, uv);
6638 is the recommended wide native character-aware way of saying
6642 U8* uvchr_to_utf8(U8 *d, UV uv)
6645 Found in file utf8.c
6647 =item uvuni_to_utf8_flags
6648 X<uvuni_to_utf8_flags>
6650 Adds the UTF-8 representation of the Unicode codepoint C<uv> to the end
6651 of the string C<d>; C<d> should be have at least C<UTF8_MAXBYTES+1> free
6652 bytes available. The return value is the pointer to the byte after the
6653 end of the new character. In other words,
6655 d = uvuni_to_utf8_flags(d, uv, flags);
6659 d = uvuni_to_utf8(d, uv);
6661 (which is equivalent to)
6663 d = uvuni_to_utf8_flags(d, uv, 0);
6665 is the recommended Unicode-aware way of saying
6669 U8* uvuni_to_utf8_flags(U8 *d, UV uv, UV flags)
6672 Found in file utf8.c
6677 =head1 Variables created by C<xsubpp> and C<xsubpp> internal functions
6684 Variable which is setup by C<xsubpp> to indicate the stack base offset,
6685 used by the C<ST>, C<XSprePUSH> and C<XSRETURN> macros. The C<dMARK> macro
6686 must be called prior to setup the C<MARK> variable.
6691 Found in file XSUB.h
6696 Variable which is setup by C<xsubpp> to indicate the
6697 class name for a C++ XS constructor. This is always a C<char*>. See C<THIS>.
6702 Found in file XSUB.h
6707 Sets up the C<ax> variable.
6708 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
6713 Found in file XSUB.h
6718 Sets up the C<ax> variable and stack marker variable C<mark>.
6719 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
6724 Found in file XSUB.h
6729 Sets up the C<items> variable.
6730 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
6735 Found in file XSUB.h
6740 Sets up the C<padoff_du> variable for an XSUB that wishes to use
6746 Found in file XSUB.h
6751 Sets up stack and mark pointers for an XSUB, calling dSP and dMARK.
6752 Sets up the C<ax> and C<items> variables by calling C<dAX> and C<dITEMS>.
6753 This is usually handled automatically by C<xsubpp>.
6758 Found in file XSUB.h
6763 Sets up the C<ix> variable for an XSUB which has aliases. This is usually
6764 handled automatically by C<xsubpp>.
6769 Found in file XSUB.h
6774 Variable which is setup by C<xsubpp> to indicate the number of
6775 items on the stack. See L<perlxs/"Variable-length Parameter Lists">.
6780 Found in file XSUB.h
6785 Variable which is setup by C<xsubpp> to indicate which of an
6786 XSUB's aliases was used to invoke it. See L<perlxs/"The ALIAS: Keyword">.
6791 Found in file XSUB.h
6796 Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
6800 Found in file XSUB.h
6805 Variable which is setup by C<xsubpp> to hold the return value for an
6806 XSUB. This is always the proper type for the XSUB. See
6807 L<perlxs/"The RETVAL Variable">.
6812 Found in file XSUB.h
6817 Used to access elements on the XSUB's stack.
6822 Found in file XSUB.h
6827 Variable which is setup by C<xsubpp> to designate the object in a C++
6828 XSUB. This is always the proper type for the C++ object. See C<CLASS> and
6829 L<perlxs/"Using XS With C++">.
6834 Found in file XSUB.h
6839 The SV* corresponding to the $_ variable. Works even if there
6840 is a lexical $_ in scope.
6843 Found in file XSUB.h
6848 Macro to declare an XSUB and its C parameter list. This is handled by
6852 Found in file XSUB.h
6857 The version identifier for an XS module. This is usually
6858 handled automatically by C<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>.
6861 Found in file XSUB.h
6863 =item XS_VERSION_BOOTCHECK
6864 X<XS_VERSION_BOOTCHECK>
6866 Macro to verify that a PM module's $VERSION variable matches the XS
6867 module's C<XS_VERSION> variable. This is usually handled automatically by
6868 C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">.
6870 XS_VERSION_BOOTCHECK;
6873 Found in file XSUB.h
6878 =head1 Warning and Dieing
6885 This is the XSUB-writer's interface to Perl's C<die> function.
6886 Normally call this function the same way you call the C C<printf>
6887 function. Calling C<croak> returns control directly to Perl,
6888 sidestepping the normal C order of execution. See C<warn>.
6890 If you want to throw an exception object, assign the object to
6891 C<$@> and then pass C<NULL> to croak():
6893 errsv = get_sv("@", TRUE);
6894 sv_setsv(errsv, exception_object);
6897 void croak(const char* pat, ...)
6900 Found in file util.c
6905 This is the XSUB-writer's interface to Perl's C<warn> function. Call this
6906 function the same way you call the C C<printf> function. See C<croak>.
6908 void warn(const char* pat, ...)
6911 Found in file util.c
6918 Until May 1997, this document was maintained by Jeff Okamoto
6919 <okamoto@corp.hp.com>. It is now maintained as part of Perl itself.
6921 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
6922 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
6923 Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
6924 Stephen McCamant, and Gurusamy Sarathy.
6926 API Listing originally by Dean Roehrich <roehrich@cray.com>.
6928 Updated to be autogenerated from comments in the source by Benjamin Stuhl.
6932 perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
https://perl5.git.perl.org / perl5.git / blob