3 perlapi - autogenerated documentation for the perl public API
7 This file contains the documentation of the perl public API generated by
8 embed.pl, specifically a listing of functions, macros, flags, and variables
9 that may be used by extension writers. The interfaces of any functions that
10 are not listed here are subject to change without notice. For this reason,
11 blindly using functions listed in proto.h is to be avoided when writing
14 Note that all Perl API global variables must be referenced with the C<PL_>
15 prefix. Some macros are provided for compatibility with the older,
16 unadorned names, but this support may be disabled in a future release.
18 The listing is alphabetical, case insensitive.
27 A backward-compatible version of C<GIMME_V> which can only return
28 C<G_SCALAR> or C<G_ARRAY>; in a void context, it returns C<G_SCALAR>.
29 Deprecated. Use C<GIMME_V> instead.
38 The XSUB-writer's equivalent to Perl's C<wantarray>. Returns C<G_VOID>,
39 C<G_SCALAR> or C<G_ARRAY> for void, scalar or list context,
49 Used to indicate list context. See C<GIMME_V>, C<GIMME> and
57 Indicates that arguments returned from a callback should be discarded. See
65 Used to force a Perl C<eval> wrapper around a callback. See
73 Indicates that no arguments are being sent to a callback. See
81 Used to indicate scalar context. See C<GIMME_V>, C<GIMME>, and
89 Used to indicate void context. See C<GIMME_V> and L<perlcall>.
97 =head1 Array Manipulation Functions
103 Same as C<av_len()>. Deprecated, use C<av_len()> instead.
112 Clears an array, making it empty. Does not free the memory used by the
115 void av_clear(AV* ar)
122 Deletes the element indexed by C<key> from the array. Returns the
123 deleted element. C<flags> is currently ignored.
125 SV* av_delete(AV* ar, I32 key, I32 flags)
132 Returns true if the element indexed by C<key> has been initialized.
134 This relies on the fact that uninitialized array elements are set to
137 bool av_exists(AV* ar, I32 key)
144 Pre-extend an array. The C<key> is the index to which the array should be
147 void av_extend(AV* ar, I32 key)
154 Returns the SV at the specified index in the array. The C<key> is the
155 index. If C<lval> is set then the fetch will be part of a store. Check
156 that the return value is non-null before dereferencing it to a C<SV*>.
158 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for
159 more information on how to use this function on tied arrays.
161 SV** av_fetch(AV* ar, I32 key, I32 lval)
168 Ensure than an array has a given number of elements, equivalent to
169 Perl's C<$#array = $fill;>.
171 void av_fill(AV* ar, I32 fill)
178 Returns the highest index in the array. Returns -1 if the array is
188 Creates a new AV and populates it with a list of SVs. The SVs are copied
189 into the array, so they may be freed after the call to av_make. The new AV
190 will have a reference count of 1.
192 AV* av_make(I32 size, SV** svp)
199 Pops an SV off the end of the array. Returns C<&PL_sv_undef> if the array
209 Pushes an SV onto the end of the array. The array will grow automatically
210 to accommodate the addition.
212 void av_push(AV* ar, SV* val)
219 Shifts an SV off the beginning of the array.
228 Stores an SV in an array. The array index is specified as C<key>. The
229 return value will be NULL if the operation failed or if the value did not
230 need to be actually stored within the array (as in the case of tied
231 arrays). Otherwise it can be dereferenced to get the original C<SV*>. Note
232 that the caller is responsible for suitably incrementing the reference
233 count of C<val> before the call, and decrementing it if the function
236 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for
237 more information on how to use this function on tied arrays.
239 SV** av_store(AV* ar, I32 key, SV* val)
246 Undefines the array. Frees the memory used by the array itself.
248 void av_undef(AV* ar)
255 Unshift the given number of C<undef> values onto the beginning of the
256 array. The array will grow automatically to accommodate the addition. You
257 must then use C<av_store> to assign values to these new elements.
259 void av_unshift(AV* ar, I32 num)
266 Returns the AV of the specified Perl array. If C<create> is set and the
267 Perl variable does not exist then it will be created. If C<create> is not
268 set and the variable does not exist then NULL is returned.
270 NOTE: the perl_ form of this function is deprecated.
272 AV* get_av(const char* name, I32 create)
279 Creates a new AV. The reference count is set to 1.
296 Sort an array. Here is an example:
298 sortsv(AvARRAY(av), av_len(av)+1, Perl_sv_cmp_locale);
300 See lib/sort.pm for details about controlling the sorting algorithm.
302 void sortsv(SV ** array, size_t num_elts, SVCOMPARE_t cmp)
305 Found in file pp_sort.c
310 =head1 Callback Functions
316 Performs a callback to the specified Perl sub. See L<perlcall>.
318 NOTE: the perl_ form of this function is deprecated.
320 I32 call_argv(const char* sub_name, I32 flags, char** argv)
327 Performs a callback to the specified Perl method. The blessed object must
328 be on the stack. See L<perlcall>.
330 NOTE: the perl_ form of this function is deprecated.
332 I32 call_method(const char* methname, I32 flags)
339 Performs a callback to the specified Perl sub. See L<perlcall>.
341 NOTE: the perl_ form of this function is deprecated.
343 I32 call_pv(const char* sub_name, I32 flags)
350 Performs a callback to the Perl sub whose name is in the SV. See
353 NOTE: the perl_ form of this function is deprecated.
355 I32 call_sv(SV* sv, I32 flags)
362 Opening bracket on a callback. See C<LEAVE> and L<perlcall>.
367 Found in file scope.h
371 Tells Perl to C<eval> the given string and return an SV* result.
373 NOTE: the perl_ form of this function is deprecated.
375 SV* eval_pv(const char* p, I32 croak_on_error)
382 Tells Perl to C<eval> the string in the SV.
384 NOTE: the perl_ form of this function is deprecated.
386 I32 eval_sv(SV* sv, I32 flags)
393 Closing bracket for temporaries on a callback. See C<SAVETMPS> and
399 Found in file scope.h
403 Closing bracket on a callback. See C<ENTER> and L<perlcall>.
408 Found in file scope.h
412 Opening bracket for temporaries on a callback. See C<FREETMPS> and
418 Found in file scope.h
423 =head1 Character classes
429 Returns a boolean indicating whether the C C<char> is an ASCII alphanumeric
430 character (including underscore) or digit.
432 bool isALNUM(char ch)
435 Found in file handy.h
439 Returns a boolean indicating whether the C C<char> is an ASCII alphabetic
442 bool isALPHA(char ch)
445 Found in file handy.h
449 Returns a boolean indicating whether the C C<char> is an ASCII
452 bool isDIGIT(char ch)
455 Found in file handy.h
459 Returns a boolean indicating whether the C C<char> is a lowercase
462 bool isLOWER(char ch)
465 Found in file handy.h
469 Returns a boolean indicating whether the C C<char> is whitespace.
471 bool isSPACE(char ch)
474 Found in file handy.h
478 Returns a boolean indicating whether the C C<char> is an uppercase
481 bool isUPPER(char ch)
484 Found in file handy.h
488 Converts the specified character to lowercase.
490 char toLOWER(char ch)
493 Found in file handy.h
497 Converts the specified character to uppercase.
499 char toUPPER(char ch)
502 Found in file handy.h
507 =head1 Cloning an interpreter
513 Create and return a new interpreter by cloning the current one.
515 PerlInterpreter* perl_clone(PerlInterpreter* interp, UV flags)
523 =head1 CV Manipulation Functions
529 Returns the stash of the CV.
538 Returns the CV of the specified Perl subroutine. If C<create> is set and
539 the Perl subroutine does not exist then it will be declared (which has the
540 same effect as saying C<sub name;>). If C<create> is not set and the
541 subroutine does not exist then NULL is returned.
543 NOTE: the perl_ form of this function is deprecated.
545 CV* get_cv(const char* name, I32 create)
561 =head1 Embedding Functions
567 Loads the module whose name is pointed to by the string part of name.
568 Note that the actual module name, not its filename, should be given.
569 Eg, "Foo::Bar" instead of "Foo/Bar.pm". flags can be any of
570 PERL_LOADMOD_DENY, PERL_LOADMOD_NOIMPORT, or PERL_LOADMOD_IMPORT_OPS
571 (or 0 for no flags). ver, if specified, provides version semantics
572 similar to C<use Foo::Bar VERSION>. The optional trailing SV*
573 arguments can be used to specify arguments to the module's import()
574 method, similar to C<use Foo::Bar VERSION LIST>.
576 void load_module(U32 flags, SV* name, SV* ver, ...)
583 Stub that provides thread hook for perl_destruct when there are
593 Allocates a new Perl interpreter. See L<perlembed>.
595 PerlInterpreter* perl_alloc()
602 Initializes a new Perl interpreter. See L<perlembed>.
604 void perl_construct(PerlInterpreter* interp)
611 Shuts down a Perl interpreter. See L<perlembed>.
613 int perl_destruct(PerlInterpreter* interp)
620 Releases a Perl interpreter. See L<perlembed>.
622 void perl_free(PerlInterpreter* interp)
629 Tells a Perl interpreter to parse a Perl script. See L<perlembed>.
631 int perl_parse(PerlInterpreter* interp, XSINIT_t xsinit, int argc, char** argv, char** env)
638 Tells a Perl interpreter to run. See L<perlembed>.
640 int perl_run(PerlInterpreter* interp)
647 Tells Perl to C<require> the file named by the string argument. It is
648 analogous to the Perl code C<eval "require '$file'">. It's even
649 implemented that way; consider using Perl_load_module instead.
651 NOTE: the perl_ form of this function is deprecated.
653 void require_pv(const char* pv)
661 =head1 Functions in file pp_pack.c
668 The engine implementing pack() Perl function.
670 void pack_cat(SV *cat, char *pat, char *patend, SV **beglist, SV **endlist, SV ***next_in_list, U32 flags)
673 Found in file pp_pack.c
677 The engine implementing unpack() Perl function.
679 I32 unpack_str(char *pat, char *patend, char *s, char *strbeg, char *strend, char **new_s, I32 ocnt, U32 flags)
682 Found in file pp_pack.c
687 =head1 Global Variables
693 C<PL_modglobal> is a general purpose, interpreter global HV for use by
694 extensions that need to keep information on a per-interpreter basis.
695 In a pinch, it can also be used as a symbol table for extensions
696 to share data among each other. It is a good idea to use keys
697 prefixed by the package name of the extension that owns the data.
702 Found in file intrpvar.h
706 A convenience variable which is typically used with C<SvPV> when one
707 doesn't care about the length of the string. It is usually more efficient
708 to either declare a local variable and use that instead or to use the
714 Found in file thrdvar.h
718 This is the C<false> SV. See C<PL_sv_yes>. Always refer to this as
724 Found in file intrpvar.h
728 This is the C<undef> SV. Always refer to this as C<&PL_sv_undef>.
733 Found in file intrpvar.h
737 This is the C<true> SV. See C<PL_sv_no>. Always refer to this as
743 Found in file intrpvar.h
754 Return the SV from the GV.
763 Returns the glob with the given C<name> and a defined subroutine or
764 C<NULL>. The glob lives in the given C<stash>, or in the stashes
765 accessible via @ISA and UNIVERSAL::.
767 The argument C<level> should be either 0 or -1. If C<level==0>, as a
768 side-effect creates a glob with the given C<name> in the given C<stash>
769 which in the case of success contains an alias for the subroutine, and sets
770 up caching info for this glob. Similarly for all the searched stashes.
772 This function grants C<"SUPER"> token as a postfix of the stash name. The
773 GV returned from C<gv_fetchmeth> may be a method cache entry, which is not
774 visible to Perl code. So when calling C<call_sv>, you should not use
775 the GV directly; instead, you should use the method's CV, which can be
776 obtained from the GV with the C<GvCV> macro.
778 GV* gv_fetchmeth(HV* stash, const char* name, STRLEN len, I32 level)
785 See L<gv_fetchmethod_autoload>.
787 GV* gv_fetchmethod(HV* stash, const char* name)
792 =item gv_fetchmethod_autoload
794 Returns the glob which contains the subroutine to call to invoke the method
795 on the C<stash>. In fact in the presence of autoloading this may be the
796 glob for "AUTOLOAD". In this case the corresponding variable $AUTOLOAD is
799 The third parameter of C<gv_fetchmethod_autoload> determines whether
800 AUTOLOAD lookup is performed if the given method is not present: non-zero
801 means yes, look for AUTOLOAD; zero means no, don't look for AUTOLOAD.
802 Calling C<gv_fetchmethod> is equivalent to calling C<gv_fetchmethod_autoload>
803 with a non-zero C<autoload> parameter.
805 These functions grant C<"SUPER"> token as a prefix of the method name. Note
806 that if you want to keep the returned glob for a long time, you need to
807 check for it being "AUTOLOAD", since at the later time the call may load a
808 different subroutine due to $AUTOLOAD changing its value. Use the glob
809 created via a side effect to do this.
811 These functions have the same side-effects and as C<gv_fetchmeth> with
812 C<level==0>. C<name> should be writable if contains C<':'> or C<'
813 ''>. The warning against passing the GV returned by C<gv_fetchmeth> to
814 C<call_sv> apply equally to these functions.
816 GV* gv_fetchmethod_autoload(HV* stash, const char* name, I32 autoload)
821 =item gv_fetchmeth_autoload
823 Same as gv_fetchmeth(), but looks for autoloaded subroutines too.
824 Returns a glob for the subroutine.
826 For an autoloaded subroutine without a GV, will create a GV even
827 if C<level < 0>. For an autoloaded subroutine without a stub, GvCV()
828 of the result may be zero.
830 GV* gv_fetchmeth_autoload(HV* stash, const char* name, STRLEN len, I32 level)
837 Returns a pointer to the stash for a specified package. C<name> should
838 be a valid UTF-8 string. If C<create> is set then the package will be
839 created if it does not already exist. If C<create> is not set and the
840 package does not exist then NULL is returned.
842 HV* gv_stashpv(const char* name, I32 create)
849 Returns a pointer to the stash for a specified package, which must be a
850 valid UTF-8 string. See C<gv_stashpv>.
852 HV* gv_stashsv(SV* sv, I32 create)
866 This flag, used in the length slot of hash entries and magic structures,
867 specifies the structure contains an C<SV*> pointer where a C<char*> pointer
868 is to be expected. (For information only--not to be used).
876 Null character pointer.
878 Found in file handy.h
885 Found in file handy.h
890 =head1 Hash Manipulation Functions
896 Returns the HV of the specified Perl hash. If C<create> is set and the
897 Perl variable does not exist then it will be created. If C<create> is not
898 set and the variable does not exist then NULL is returned.
900 NOTE: the perl_ form of this function is deprecated.
902 HV* get_hv(const char* name, I32 create)
909 Returns the computed hash stored in the hash entry.
918 Returns the actual pointer stored in the key slot of the hash entry. The
919 pointer may be either C<char*> or C<SV*>, depending on the value of
920 C<HeKLEN()>. Can be assigned to. The C<HePV()> or C<HeSVKEY()> macros are
921 usually preferable for finding the value of a key.
930 If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry
931 holds an C<SV*> key. Otherwise, holds the actual length of the key. Can
932 be assigned to. The C<HePV()> macro is usually preferable for finding key
935 STRLEN HeKLEN(HE* he)
942 Returns the key slot of the hash entry as a C<char*> value, doing any
943 necessary dereferencing of possibly C<SV*> keys. The length of the string
944 is placed in C<len> (this is a macro, so do I<not> use C<&len>). If you do
945 not care about what the length of the key is, you may use the global
946 variable C<PL_na>, though this is rather less efficient than using a local
947 variable. Remember though, that hash keys in perl are free to contain
948 embedded nulls, so using C<strlen()> or similar is not a good way to find
949 the length of hash keys. This is very similar to the C<SvPV()> macro
950 described elsewhere in this document.
952 char* HePV(HE* he, STRLEN len)
959 Returns the key as an C<SV*>, or C<Nullsv> if the hash entry does not
960 contain an C<SV*> key.
969 Returns the key as an C<SV*>. Will create and return a temporary mortal
970 C<SV*> if the hash entry contains only a C<char*> key.
972 SV* HeSVKEY_force(HE* he)
979 Sets the key to a given C<SV*>, taking care to set the appropriate flags to
980 indicate the presence of an C<SV*> key, and returns the same
983 SV* HeSVKEY_set(HE* he, SV* sv)
990 Returns the value slot (type C<SV*>) stored in the hash entry.
999 Returns the package name of a stash. See C<SvSTASH>, C<CvSTASH>.
1001 char* HvNAME(HV* stash)
1008 Clears a hash, making it empty.
1010 void hv_clear(HV* tb)
1017 Deletes a key/value pair in the hash. The value SV is removed from the
1018 hash and returned to the caller. The C<klen> is the length of the key.
1019 The C<flags> value will normally be zero; if set to G_DISCARD then NULL
1022 SV* hv_delete(HV* tb, const char* key, I32 klen, I32 flags)
1029 Deletes a key/value pair in the hash. The value SV is removed from the
1030 hash and returned to the caller. The C<flags> value will normally be zero;
1031 if set to G_DISCARD then NULL will be returned. C<hash> can be a valid
1032 precomputed hash value, or 0 to ask for it to be computed.
1034 SV* hv_delete_ent(HV* tb, SV* key, I32 flags, U32 hash)
1041 Returns a boolean indicating whether the specified hash key exists. The
1042 C<klen> is the length of the key.
1044 bool hv_exists(HV* tb, const char* key, I32 klen)
1051 Returns a boolean indicating whether the specified hash key exists. C<hash>
1052 can be a valid precomputed hash value, or 0 to ask for it to be
1055 bool hv_exists_ent(HV* tb, SV* key, U32 hash)
1062 Returns the SV which corresponds to the specified key in the hash. The
1063 C<klen> is the length of the key. If C<lval> is set then the fetch will be
1064 part of a store. Check that the return value is non-null before
1065 dereferencing it to an C<SV*>.
1067 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1068 information on how to use this function on tied hashes.
1070 SV** hv_fetch(HV* tb, const char* key, I32 klen, I32 lval)
1077 Returns the hash entry which corresponds to the specified key in the hash.
1078 C<hash> must be a valid precomputed hash number for the given C<key>, or 0
1079 if you want the function to compute it. IF C<lval> is set then the fetch
1080 will be part of a store. Make sure the return value is non-null before
1081 accessing it. The return value when C<tb> is a tied hash is a pointer to a
1082 static location, so be sure to make a copy of the structure if you need to
1085 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1086 information on how to use this function on tied hashes.
1088 HE* hv_fetch_ent(HV* tb, SV* key, I32 lval, U32 hash)
1095 Prepares a starting point to traverse a hash table. Returns the number of
1096 keys in the hash (i.e. the same as C<HvKEYS(tb)>). The return value is
1097 currently only meaningful for hashes without tie magic.
1099 NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
1100 hash buckets that happen to be in use. If you still need that esoteric
1101 value, you can get it through the macro C<HvFILL(tb)>.
1104 I32 hv_iterinit(HV* tb)
1111 Returns the key from the current position of the hash iterator. See
1114 char* hv_iterkey(HE* entry, I32* retlen)
1121 Returns the key as an C<SV*> from the current position of the hash
1122 iterator. The return value will always be a mortal copy of the key. Also
1125 SV* hv_iterkeysv(HE* entry)
1132 Returns entries from a hash iterator. See C<hv_iterinit>.
1134 You may call C<hv_delete> or C<hv_delete_ent> on the hash entry that the
1135 iterator currently points to, without losing your place or invalidating your
1136 iterator. Note that in this case the current entry is deleted from the hash
1137 with your iterator holding the last reference to it. Your iterator is flagged
1138 to free the entry on the next call to C<hv_iternext>, so you must not discard
1139 your iterator immediately else the entry will leak - call C<hv_iternext> to
1140 trigger the resource deallocation.
1142 HE* hv_iternext(HV* tb)
1149 Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
1152 SV* hv_iternextsv(HV* hv, char** key, I32* retlen)
1157 =item hv_iternext_flags
1159 Returns entries from a hash iterator. See C<hv_iterinit> and C<hv_iternext>.
1160 The C<flags> value will normally be zero; if HV_ITERNEXT_WANTPLACEHOLDERS is
1161 set the placeholders keys (for restricted hashes) will be returned in addition
1162 to normal keys. By default placeholders are automatically skipped over.
1163 Currently a placeholder is implemented with a value that is literally
1164 <&Perl_sv_undef> (a regular C<undef> value is a normal read-write SV for which
1165 C<!SvOK> is false). Note that the implementation of placeholders and
1166 restricted hashes may change, and the implementation currently is
1167 insufficiently abstracted for any change to be tidy.
1169 NOTE: this function is experimental and may change or be
1170 removed without notice.
1172 HE* hv_iternext_flags(HV* tb, I32 flags)
1179 Returns the value from the current position of the hash iterator. See
1182 SV* hv_iterval(HV* tb, HE* entry)
1189 Adds magic to a hash. See C<sv_magic>.
1191 void hv_magic(HV* hv, GV* gv, int how)
1198 Stores an SV in a hash. The hash key is specified as C<key> and C<klen> is
1199 the length of the key. The C<hash> parameter is the precomputed hash
1200 value; if it is zero then Perl will compute it. The return value will be
1201 NULL if the operation failed or if the value did not need to be actually
1202 stored within the hash (as in the case of tied hashes). Otherwise it can
1203 be dereferenced to get the original C<SV*>. Note that the caller is
1204 responsible for suitably incrementing the reference count of C<val> before
1205 the call, and decrementing it if the function returned NULL.
1207 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1208 information on how to use this function on tied hashes.
1210 SV** hv_store(HV* tb, const char* key, I32 klen, SV* val, U32 hash)
1217 Stores C<val> in a hash. The hash key is specified as C<key>. The C<hash>
1218 parameter is the precomputed hash value; if it is zero then Perl will
1219 compute it. The return value is the new hash entry so created. It will be
1220 NULL if the operation failed or if the value did not need to be actually
1221 stored within the hash (as in the case of tied hashes). Otherwise the
1222 contents of the return value can be accessed using the C<He?> macros
1223 described here. Note that the caller is responsible for suitably
1224 incrementing the reference count of C<val> before the call, and
1225 decrementing it if the function returned NULL.
1227 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1228 information on how to use this function on tied hashes.
1230 HE* hv_store_ent(HV* tb, SV* key, SV* val, U32 hash)
1239 void hv_undef(HV* tb)
1246 Creates a new HV. The reference count is set to 1.
1264 =head1 Magical Functions
1270 Clear something magical that the SV represents. See C<sv_magic>.
1272 int mg_clear(SV* sv)
1279 Copies the magic from one SV to another. See C<sv_magic>.
1281 int mg_copy(SV* sv, SV* nsv, const char* key, I32 klen)
1288 Finds the magic pointer for type matching the SV. See C<sv_magic>.
1290 MAGIC* mg_find(SV* sv, int type)
1297 Free any magic storage used by the SV. See C<sv_magic>.
1306 Do magic after a value is retrieved from the SV. See C<sv_magic>.
1315 Report on the SV's length. See C<sv_magic>.
1317 U32 mg_length(SV* sv)
1324 Turns on the magical status of an SV. See C<sv_magic>.
1326 void mg_magical(SV* sv)
1333 Do magic after a value is assigned to the SV. See C<sv_magic>.
1342 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
1343 argument more than once.
1345 void SvGETMAGIC(SV* sv)
1352 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
1362 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
1363 argument more than once.
1365 void SvSETMAGIC(SV* sv)
1372 Like C<SvSetSV>, but does any set magic required afterwards.
1374 void SvSetMagicSV(SV* dsb, SV* ssv)
1379 =item SvSetMagicSV_nosteal
1381 Like C<SvSetMagicSV>, but does any set magic required afterwards.
1383 void SvSetMagicSV_nosteal(SV* dsv, SV* ssv)
1390 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
1393 void SvSetSV(SV* dsb, SV* ssv)
1398 =item SvSetSV_nosteal
1400 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
1401 ssv. May evaluate arguments more than once.
1403 void SvSetSV_nosteal(SV* dsv, SV* ssv)
1410 Arranges for sv to be shared between threads if a suitable module
1413 void SvSHARE(SV* sv)
1421 =head1 Memory Management
1427 The XSUB-writer's interface to the C C<memcpy> function. The C<src> is the
1428 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1429 the type. May fail on overlapping copies. See also C<Move>.
1431 void Copy(void* src, void* dest, int nitems, type)
1434 Found in file handy.h
1438 The XSUB-writer's interface to the C C<memmove> function. The C<src> is the
1439 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1440 the type. Can do overlapping moves. See also C<Copy>.
1442 void Move(void* src, void* dest, int nitems, type)
1445 Found in file handy.h
1449 The XSUB-writer's interface to the C C<malloc> function.
1451 void New(int id, void* ptr, int nitems, type)
1454 Found in file handy.h
1458 The XSUB-writer's interface to the C C<malloc> function, with
1461 void Newc(int id, void* ptr, int nitems, type, cast)
1464 Found in file handy.h
1468 Creates a new SV. A non-zero C<len> parameter indicates the number of
1469 bytes of preallocated string space the SV should have. An extra byte for a
1470 tailing NUL is also reserved. (SvPOK is not set for the SV even if string
1471 space is allocated.) The reference count for the new SV is set to 1.
1472 C<id> is an integer id between 0 and 1299 (used to identify leaks).
1475 SV* NEWSV(int id, STRLEN len)
1478 Found in file handy.h
1482 The XSUB-writer's interface to the C C<malloc> function. The allocated
1483 memory is zeroed with C<memzero>.
1485 void Newz(int id, void* ptr, int nitems, type)
1488 Found in file handy.h
1492 Fill up memory with a pattern (byte 0xAB over and over again) that
1493 hopefully catches attempts to access uninitialized memory.
1495 void Poison(void* dest, int nitems, type)
1498 Found in file handy.h
1502 The XSUB-writer's interface to the C C<realloc> function.
1504 void Renew(void* ptr, int nitems, type)
1507 Found in file handy.h
1511 The XSUB-writer's interface to the C C<realloc> function, with
1514 void Renewc(void* ptr, int nitems, type, cast)
1517 Found in file handy.h
1521 The XSUB-writer's interface to the C C<free> function.
1523 void Safefree(void* ptr)
1526 Found in file handy.h
1530 Perl's version of C<strdup()>. Returns a pointer to a newly allocated
1531 string which is a duplicate of C<pv>. The size of the string is
1532 determined by C<strlen()>. The memory allocated for the new string can
1533 be freed with the C<Safefree()> function.
1535 char* savepv(const char* pv)
1538 Found in file util.c
1542 Perl's version of what C<strndup()> would be if it existed. Returns a
1543 pointer to a newly allocated string which is a duplicate of the first
1544 C<len> bytes from C<pv>. The memory allocated for the new string can be
1545 freed with the C<Safefree()> function.
1547 char* savepvn(const char* pv, I32 len)
1550 Found in file util.c
1554 A version of C<savepv()> which allocates the duplicate string in memory
1555 which is shared between threads.
1557 char* savesharedpv(const char* pv)
1560 Found in file util.c
1564 This is an architecture-independent macro to copy one structure to another.
1566 void StructCopy(type src, type dest, type)
1569 Found in file handy.h
1573 The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the
1574 destination, C<nitems> is the number of items, and C<type> is the type.
1576 void Zero(void* dest, int nitems, type)
1579 Found in file handy.h
1584 =head1 Miscellaneous Functions
1590 Analyses the string in order to make fast searches on it using fbm_instr()
1591 -- the Boyer-Moore algorithm.
1593 void fbm_compile(SV* sv, U32 flags)
1596 Found in file util.c
1600 Returns the location of the SV in the string delimited by C<str> and
1601 C<strend>. It returns C<Nullch> if the string can't be found. The C<sv>
1602 does not have to be fbm_compiled, but the search will not be as fast
1605 char* fbm_instr(unsigned char* big, unsigned char* bigend, SV* littlesv, U32 flags)
1608 Found in file util.c
1612 Takes a sprintf-style format pattern and conventional
1613 (non-SV) arguments and returns the formatted string.
1615 (char *) Perl_form(pTHX_ const char* pat, ...)
1617 can be used any place a string (char *) is required:
1619 char * s = Perl_form("%d.%d",major,minor);
1621 Uses a single private buffer so if you want to format several strings you
1622 must explicitly copy the earlier strings away (and free the copies when you
1625 char* form(const char* pat, ...)
1628 Found in file util.c
1632 Fill the sv with current working directory
1634 int getcwd_sv(SV* sv)
1637 Found in file util.c
1641 Test two strings to see if they are equal. Returns true or false.
1643 bool strEQ(char* s1, char* s2)
1646 Found in file handy.h
1650 Test two strings to see if the first, C<s1>, is greater than or equal to
1651 the second, C<s2>. Returns true or false.
1653 bool strGE(char* s1, char* s2)
1656 Found in file handy.h
1660 Test two strings to see if the first, C<s1>, is greater than the second,
1661 C<s2>. Returns true or false.
1663 bool strGT(char* s1, char* s2)
1666 Found in file handy.h
1670 Test two strings to see if the first, C<s1>, is less than or equal to the
1671 second, C<s2>. Returns true or false.
1673 bool strLE(char* s1, char* s2)
1676 Found in file handy.h
1680 Test two strings to see if the first, C<s1>, is less than the second,
1681 C<s2>. Returns true or false.
1683 bool strLT(char* s1, char* s2)
1686 Found in file handy.h
1690 Test two strings to see if they are different. Returns true or
1693 bool strNE(char* s1, char* s2)
1696 Found in file handy.h
1700 Test two strings to see if they are equal. The C<len> parameter indicates
1701 the number of bytes to compare. Returns true or false. (A wrapper for
1704 bool strnEQ(char* s1, char* s2, STRLEN len)
1707 Found in file handy.h
1711 Test two strings to see if they are different. The C<len> parameter
1712 indicates the number of bytes to compare. Returns true or false. (A
1713 wrapper for C<strncmp>).
1715 bool strnNE(char* s1, char* s2, STRLEN len)
1718 Found in file handy.h
1723 =head1 Numeric functions
1729 converts a string representing a binary number to numeric form.
1731 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
1732 conversion flags, and I<result> should be NULL or a pointer to an NV.
1733 The scan stops at the end of the string, or the first invalid character.
1734 On return I<*len> is set to the length scanned string, and I<*flags> gives
1737 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
1738 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_bin>
1739 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
1740 and writes the value to I<*result> (or the value is discarded if I<result>
1743 The hex number may optionally be prefixed with "0b" or "b" unless
1744 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
1745 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the binary
1746 number may use '_' characters to separate digits.
1748 UV grok_bin(char* start, STRLEN* len, I32* flags, NV *result)
1751 Found in file numeric.c
1755 converts a string representing a hex number to numeric form.
1757 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
1758 conversion flags, and I<result> should be NULL or a pointer to an NV.
1759 The scan stops at the end of the string, or the first non-hex-digit character.
1760 On return I<*len> is set to the length scanned string, and I<*flags> gives
1763 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
1764 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_hex>
1765 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
1766 and writes the value to I<*result> (or the value is discarded if I<result>
1769 The hex number may optionally be prefixed with "0x" or "x" unless
1770 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
1771 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the hex
1772 number may use '_' characters to separate digits.
1774 UV grok_hex(char* start, STRLEN* len, I32* flags, NV *result)
1777 Found in file numeric.c
1781 Recognise (or not) a number. The type of the number is returned
1782 (0 if unrecognised), otherwise it is a bit-ORed combination of
1783 IS_NUMBER_IN_UV, IS_NUMBER_GREATER_THAN_UV_MAX, IS_NUMBER_NOT_INT,
1784 IS_NUMBER_NEG, IS_NUMBER_INFINITY, IS_NUMBER_NAN (defined in perl.h).
1786 If the value of the number can fit an in UV, it is returned in the *valuep
1787 IS_NUMBER_IN_UV will be set to indicate that *valuep is valid, IS_NUMBER_IN_UV
1788 will never be set unless *valuep is valid, but *valuep may have been assigned
1789 to during processing even though IS_NUMBER_IN_UV is not set on return.
1790 If valuep is NULL, IS_NUMBER_IN_UV will be set for the same cases as when
1791 valuep is non-NULL, but no actual assignment (or SEGV) will occur.
1793 IS_NUMBER_NOT_INT will be set with IS_NUMBER_IN_UV if trailing decimals were
1794 seen (in which case *valuep gives the true value truncated to an integer), and
1795 IS_NUMBER_NEG if the number is negative (in which case *valuep holds the
1796 absolute value). IS_NUMBER_IN_UV is not set if e notation was used or the
1797 number is larger than a UV.
1799 int grok_number(const char *pv, STRLEN len, UV *valuep)
1802 Found in file numeric.c
1804 =item grok_numeric_radix
1806 Scan and skip for a numeric decimal separator (radix).
1808 bool grok_numeric_radix(const char **sp, const char *send)
1811 Found in file numeric.c
1816 UV grok_oct(char* start, STRLEN* len, I32* flags, NV *result)
1819 Found in file numeric.c
1823 For backwards compatibility. Use C<grok_bin> instead.
1825 NV scan_bin(char* start, STRLEN len, STRLEN* retlen)
1828 Found in file numeric.c
1832 For backwards compatibility. Use C<grok_hex> instead.
1834 NV scan_hex(char* start, STRLEN len, STRLEN* retlen)
1837 Found in file numeric.c
1841 For backwards compatibility. Use C<grok_oct> instead.
1843 NV scan_oct(char* start, STRLEN len, STRLEN* retlen)
1846 Found in file numeric.c
1851 =head1 Optree Manipulation Functions
1857 If C<cv> is a constant sub eligible for inlining. returns the constant
1858 value returned by the sub. Otherwise, returns NULL.
1860 Constant subs can be created with C<newCONSTSUB> or as described in
1861 L<perlsub/"Constant Functions">.
1863 SV* cv_const_sv(CV* cv)
1870 Creates a constant sub equivalent to Perl C<sub FOO () { 123 }> which is
1871 eligible for inlining at compile-time.
1873 CV* newCONSTSUB(HV* stash, char* name, SV* sv)
1880 Used by C<xsubpp> to hook up XSUBs as Perl subs.
1888 =head1 Pad Data Structures
1894 Get the value at offset po in the current pad.
1895 Use macro PAD_SV instead of calling this function directly.
1897 SV* pad_sv(PADOFFSET po)
1905 =head1 Stack Manipulation Macros
1911 Declare a stack marker variable, C<mark>, for the XSUB. See C<MARK> and
1921 Saves the original stack mark for the XSUB. See C<ORIGMARK>.
1930 Declares a local copy of perl's stack pointer for the XSUB, available via
1931 the C<SP> macro. See C<SP>.
1940 Used to extend the argument stack for an XSUB's return values. Once
1941 used, guarantees that there is room for at least C<nitems> to be pushed
1944 void EXTEND(SP, int nitems)
1951 Stack marker variable for the XSUB. See C<dMARK>.
1958 The original stack mark for the XSUB. See C<dORIGMARK>.
1965 Pops an integer off the stack.
1974 Pops a long off the stack.
1983 Pops a double off the stack.
1992 Pops a string off the stack. Deprecated. New code should provide
1993 a STRLEN n_a and use POPpx.
2002 Pops a string off the stack which must consist of bytes i.e. characters < 256.
2003 Requires a variable STRLEN n_a in scope.
2012 Pops a string off the stack.
2013 Requires a variable STRLEN n_a in scope.
2022 Pops an SV off the stack.
2031 Push an integer onto the stack. The stack must have room for this element.
2032 Handles 'set' magic. See C<XPUSHi>.
2041 Opening bracket for arguments on a callback. See C<PUTBACK> and
2051 Push a double onto the stack. The stack must have room for this element.
2052 Handles 'set' magic. See C<XPUSHn>.
2061 Push a string onto the stack. The stack must have room for this element.
2062 The C<len> indicates the length of the string. Handles 'set' magic. See
2065 void PUSHp(char* str, STRLEN len)
2072 Push an SV onto the stack. The stack must have room for this element.
2073 Does not handle 'set' magic. See C<XPUSHs>.
2082 Push an unsigned integer onto the stack. The stack must have room for this
2083 element. See C<XPUSHu>.
2092 Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
2093 See C<PUSHMARK> and L<perlcall> for other uses.
2102 Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and
2110 Refetch the stack pointer. Used after a callback. See L<perlcall>.
2119 Push an integer onto the stack, extending the stack if necessary. Handles
2120 'set' magic. See C<PUSHi>.
2129 Push a double onto the stack, extending the stack if necessary. Handles
2130 'set' magic. See C<PUSHn>.
2139 Push a string onto the stack, extending the stack if necessary. The C<len>
2140 indicates the length of the string. Handles 'set' magic. See
2143 void XPUSHp(char* str, STRLEN len)
2150 Push an SV onto the stack, extending the stack if necessary. Does not
2151 handle 'set' magic. See C<PUSHs>.
2160 Push an unsigned integer onto the stack, extending the stack if necessary.
2170 Return from XSUB, indicating number of items on the stack. This is usually
2171 handled by C<xsubpp>.
2173 void XSRETURN(int nitems)
2176 Found in file XSUB.h
2180 Return an integer from an XSUB immediately. Uses C<XST_mIV>.
2182 void XSRETURN_IV(IV iv)
2185 Found in file XSUB.h
2189 Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
2194 Found in file XSUB.h
2198 Return a double from an XSUB immediately. Uses C<XST_mNV>.
2200 void XSRETURN_NV(NV nv)
2203 Found in file XSUB.h
2207 Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
2209 void XSRETURN_PV(char* str)
2212 Found in file XSUB.h
2214 =item XSRETURN_UNDEF
2216 Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
2221 Found in file XSUB.h
2225 Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
2230 Found in file XSUB.h
2234 Place an integer into the specified position C<pos> on the stack. The
2235 value is stored in a new mortal SV.
2237 void XST_mIV(int pos, IV iv)
2240 Found in file XSUB.h
2244 Place C<&PL_sv_no> into the specified position C<pos> on the
2247 void XST_mNO(int pos)
2250 Found in file XSUB.h
2254 Place a double into the specified position C<pos> on the stack. The value
2255 is stored in a new mortal SV.
2257 void XST_mNV(int pos, NV nv)
2260 Found in file XSUB.h
2264 Place a copy of a string into the specified position C<pos> on the stack.
2265 The value is stored in a new mortal SV.
2267 void XST_mPV(int pos, char* str)
2270 Found in file XSUB.h
2274 Place C<&PL_sv_undef> into the specified position C<pos> on the
2277 void XST_mUNDEF(int pos)
2280 Found in file XSUB.h
2284 Place C<&PL_sv_yes> into the specified position C<pos> on the
2287 void XST_mYES(int pos)
2290 Found in file XSUB.h
2301 An enum of flags for Perl types. These are found in the file B<sv.h>
2302 in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
2309 Integer type flag for scalars. See C<svtype>.
2316 Double type flag for scalars. See C<svtype>.
2323 Pointer type flag for scalars. See C<svtype>.
2330 Type flag for arrays. See C<svtype>.
2337 Type flag for code refs. See C<svtype>.
2344 Type flag for hashes. See C<svtype>.
2351 Type flag for blessed scalars. See C<svtype>.
2359 =head1 SV Manipulation Functions
2365 Returns the SV of the specified Perl scalar. If C<create> is set and the
2366 Perl variable does not exist then it will be created. If C<create> is not
2367 set and the variable does not exist then NULL is returned.
2369 NOTE: the perl_ form of this function is deprecated.
2371 SV* get_sv(const char* name, I32 create)
2374 Found in file perl.c
2376 =item looks_like_number
2378 Test if the content of an SV looks like a number (or is a number).
2379 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
2380 non-numeric warning), even if your atof() doesn't grok them.
2382 I32 looks_like_number(SV* sv)
2389 Creates an RV wrapper for an SV. The reference count for the original SV is
2392 SV* newRV_inc(SV* sv)
2399 Creates an RV wrapper for an SV. The reference count for the original
2400 SV is B<not> incremented.
2402 SV* newRV_noinc(SV *sv)
2409 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
2410 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
2413 SV* newSV(STRLEN len)
2420 Creates a new SV and copies an integer into it. The reference count for the
2430 Creates a new SV and copies a floating point value into it.
2431 The reference count for the SV is set to 1.
2440 Creates a new SV and copies a string into it. The reference count for the
2441 SV is set to 1. If C<len> is zero, Perl will compute the length using
2442 strlen(). For efficiency, consider using C<newSVpvn> instead.
2444 SV* newSVpv(const char* s, STRLEN len)
2451 Creates a new SV and initializes it with the string formatted like
2454 SV* newSVpvf(const char* pat, ...)
2461 Creates a new SV and copies a string into it. The reference count for the
2462 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
2463 string. You are responsible for ensuring that the source string is at least
2466 SV* newSVpvn(const char* s, STRLEN len)
2471 =item newSVpvn_share
2473 Creates a new SV with its SvPVX pointing to a shared string in the string
2474 table. If the string does not already exist in the table, it is created
2475 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
2476 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
2477 otherwise the hash is computed. The idea here is that as the string table
2478 is used for shared hash keys these strings will have SvPVX == HeKEY and
2479 hash lookup will avoid string compare.
2481 SV* newSVpvn_share(const char* s, I32 len, U32 hash)
2488 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
2489 it will be upgraded to one. If C<classname> is non-null then the new SV will
2490 be blessed in the specified package. The new SV is returned and its
2491 reference count is 1.
2493 SV* newSVrv(SV* rv, const char* classname)
2500 Creates a new SV which is an exact duplicate of the original SV.
2503 SV* newSVsv(SV* old)
2510 Creates a new SV and copies an unsigned integer into it.
2511 The reference count for the SV is set to 1.
2520 Returns a new version object based on the passed in SV:
2522 SV *sv = new_version(SV *ver);
2524 Does not alter the passed in ver SV. See "upg_version" if you
2525 want to upgrade the SV.
2527 SV* new_version(SV *ver)
2530 Found in file util.c
2534 Returns a pointer to the next character after the parsed
2535 version string, as well as upgrading the passed in SV to
2538 Function must be called with an already existing SV like
2541 s = scan_version(s,sv);
2543 Performs some preprocessing to the string to ensure that
2544 it has the correct characteristics of a version. Flags the
2545 object if it contains an underscore (which denotes this
2548 char* scan_version(char *vstr, SV *sv)
2551 Found in file util.c
2555 Returns a pointer to the next character after the parsed
2556 vstring, as well as updating the passed in sv.
2558 Function must be called like
2561 s = scan_vstring(s,sv);
2563 The sv should already be large enough to store the vstring
2564 passed in, for performance reasons.
2566 char* scan_vstring(char *vstr, SV *sv)
2569 Found in file util.c
2573 Returns the length of the string which is in the SV. See C<SvLEN>.
2575 STRLEN SvCUR(SV* sv)
2582 Set the length of the string which is in the SV. See C<SvCUR>.
2584 void SvCUR_set(SV* sv, STRLEN len)
2591 Returns a pointer to the last character in the string which is in the SV.
2592 See C<SvCUR>. Access the character as *(SvEND(sv)).
2601 Expands the character buffer in the SV so that it has room for the
2602 indicated number of bytes (remember to reserve space for an extra trailing
2603 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
2604 Returns a pointer to the character buffer.
2606 char * SvGROW(SV* sv, STRLEN len)
2613 Returns a boolean indicating whether the SV contains an integer.
2622 Returns a boolean indicating whether the SV contains an integer. Checks
2623 the B<private> setting. Use C<SvIOK>.
2632 Returns a boolean indicating whether the SV contains a signed integer.
2634 void SvIOK_notUV(SV* sv)
2641 Unsets the IV status of an SV.
2643 void SvIOK_off(SV* sv)
2650 Tells an SV that it is an integer.
2652 void SvIOK_on(SV* sv)
2659 Tells an SV that it is an integer and disables all other OK bits.
2661 void SvIOK_only(SV* sv)
2668 Tells and SV that it is an unsigned integer and disables all other OK bits.
2670 void SvIOK_only_UV(SV* sv)
2677 Returns a boolean indicating whether the SV contains an unsigned integer.
2679 void SvIOK_UV(SV* sv)
2686 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
2687 version which guarantees to evaluate sv only once.
2696 Coerces the given SV to an integer and returns it. Guarantees to evaluate
2697 sv only once. Use the more efficient C<SvIV> otherwise.
2706 Returns the raw value in the SV's IV slot, without checks or conversions.
2707 Only use when you are sure SvIOK is true. See also C<SvIV()>.
2716 Returns the size of the string buffer in the SV, not including any part
2717 attributable to C<SvOOK>. See C<SvCUR>.
2719 STRLEN SvLEN(SV* sv)
2726 Returns a boolean indicating whether the SV contains a number, integer or
2736 Returns a boolean indicating whether the SV contains a number, integer or
2737 double. Checks the B<private> setting. Use C<SvNIOK>.
2739 bool SvNIOKp(SV* sv)
2746 Unsets the NV/IV status of an SV.
2748 void SvNIOK_off(SV* sv)
2755 Returns a boolean indicating whether the SV contains a double.
2764 Returns a boolean indicating whether the SV contains a double. Checks the
2765 B<private> setting. Use C<SvNOK>.
2774 Unsets the NV status of an SV.
2776 void SvNOK_off(SV* sv)
2783 Tells an SV that it is a double.
2785 void SvNOK_on(SV* sv)
2792 Tells an SV that it is a double and disables all other OK bits.
2794 void SvNOK_only(SV* sv)
2801 Coerce the given SV to a double and return it. See C<SvNVx> for a version
2802 which guarantees to evaluate sv only once.
2811 Returns the raw value in the SV's NV slot, without checks or conversions.
2812 Only use when you are sure SvNOK is true. See also C<SvNV()>.
2821 Coerces the given SV to a double and returns it. Guarantees to evaluate
2822 sv only once. Use the more efficient C<SvNV> otherwise.
2831 Returns a boolean indicating whether the value is an SV.
2840 Returns a boolean indicating whether the SvIVX is a valid offset value for
2841 the SvPVX. This hack is used internally to speed up removal of characters
2842 from the beginning of a SvPV. When SvOOK is true, then the start of the
2843 allocated string buffer is really (SvPVX - SvIVX).
2852 Returns a boolean indicating whether the SV contains a character
2862 Returns a boolean indicating whether the SV contains a character string.
2863 Checks the B<private> setting. Use C<SvPOK>.
2872 Unsets the PV status of an SV.
2874 void SvPOK_off(SV* sv)
2881 Tells an SV that it is a string.
2883 void SvPOK_on(SV* sv)
2890 Tells an SV that it is a string and disables all other OK bits.
2891 Will also turn off the UTF8 status.
2893 void SvPOK_only(SV* sv)
2898 =item SvPOK_only_UTF8
2900 Tells an SV that it is a string and disables all other OK bits,
2901 and leaves the UTF8 status as it was.
2903 void SvPOK_only_UTF8(SV* sv)
2910 Returns a pointer to the string in the SV, or a stringified form of
2911 the SV if the SV does not contain a string. The SV may cache the
2912 stringified version becoming C<SvPOK>. Handles 'get' magic. See also
2913 C<SvPVx> for a version which guarantees to evaluate sv only once.
2915 char* SvPV(SV* sv, STRLEN len)
2922 Like C<SvPV>, but converts sv to byte representation first if necessary.
2924 char* SvPVbyte(SV* sv, STRLEN len)
2931 Like C<SvPV>, but converts sv to byte representation first if necessary.
2932 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
2936 char* SvPVbytex(SV* sv, STRLEN len)
2941 =item SvPVbytex_force
2943 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
2944 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
2947 char* SvPVbytex_force(SV* sv, STRLEN len)
2952 =item SvPVbyte_force
2954 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
2956 char* SvPVbyte_force(SV* sv, STRLEN len)
2961 =item SvPVbyte_nolen
2963 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
2965 char* SvPVbyte_nolen(SV* sv)
2972 Like C<SvPV>, but converts sv to utf8 first if necessary.
2974 char* SvPVutf8(SV* sv, STRLEN len)
2981 Like C<SvPV>, but converts sv to utf8 first if necessary.
2982 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
2985 char* SvPVutf8x(SV* sv, STRLEN len)
2990 =item SvPVutf8x_force
2992 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
2993 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
2996 char* SvPVutf8x_force(SV* sv, STRLEN len)
3001 =item SvPVutf8_force
3003 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
3005 char* SvPVutf8_force(SV* sv, STRLEN len)
3010 =item SvPVutf8_nolen
3012 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
3014 char* SvPVutf8_nolen(SV* sv)
3021 A version of C<SvPV> which guarantees to evaluate sv only once.
3023 char* SvPVx(SV* sv, STRLEN len)
3030 Returns a pointer to the physical string in the SV. The SV must contain a
3040 Like C<SvPV> but will force the SV into containing just a string
3041 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
3044 char* SvPV_force(SV* sv, STRLEN len)
3049 =item SvPV_force_nomg
3051 Like C<SvPV> but will force the SV into containing just a string
3052 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
3053 directly. Doesn't process magic.
3055 char* SvPV_force_nomg(SV* sv, STRLEN len)
3062 Returns a pointer to the string in the SV, or a stringified form of
3063 the SV if the SV does not contain a string. The SV may cache the
3064 stringified form becoming C<SvPOK>. Handles 'get' magic.
3066 char* SvPV_nolen(SV* sv)
3073 Returns the value of the object's reference count.
3075 U32 SvREFCNT(SV* sv)
3082 Decrements the reference count of the given SV.
3084 void SvREFCNT_dec(SV* sv)
3091 Increments the reference count of the given SV.
3093 SV* SvREFCNT_inc(SV* sv)
3100 Tests if the SV is an RV.
3109 Unsets the RV status of an SV.
3111 void SvROK_off(SV* sv)
3118 Tells an SV that it is an RV.
3120 void SvROK_on(SV* sv)
3127 Dereferences an RV to return the SV.
3136 Returns the stash of the SV.
3145 Taints an SV if tainting is enabled
3147 void SvTAINT(SV* sv)
3154 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
3157 bool SvTAINTED(SV* sv)
3164 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
3165 some of Perl's fundamental security features. XS module authors should not
3166 use this function unless they fully understand all the implications of
3167 unconditionally untainting the value. Untainting should be done in the
3168 standard perl fashion, via a carefully crafted regexp, rather than directly
3169 untainting variables.
3171 void SvTAINTED_off(SV* sv)
3178 Marks an SV as tainted.
3180 void SvTAINTED_on(SV* sv)
3187 Returns a boolean indicating whether Perl would evaluate the SV as true or
3188 false, defined or undefined. Does not handle 'get' magic.
3197 Returns the type of the SV. See C<svtype>.
3199 svtype SvTYPE(SV* sv)
3206 Releases a mutual exclusion lock on sv if a suitable module
3210 void SvUNLOCK(SV* sv)
3217 Returns a boolean indicating whether the SV contains an unsigned integer.
3226 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
3227 perform the upgrade if necessary. See C<svtype>.
3229 void SvUPGRADE(SV* sv, svtype type)
3236 Returns a boolean indicating whether the SV contains UTF-8 encoded data.
3245 Unsets the UTF8 status of an SV.
3247 void SvUTF8_off(SV *sv)
3254 Turn on the UTF8 status of an SV (the data is not changed, just the flag).
3255 Do not use frivolously.
3257 void SvUTF8_on(SV *sv)
3264 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
3265 for a version which guarantees to evaluate sv only once.
3274 Returns the raw value in the SV's UV slot, without checks or conversions.
3275 Only use when you are sure SvIOK is true. See also C<SvUV()>.
3284 Coerces the given SV to an unsigned integer and returns it. Guarantees to
3285 evaluate sv only once. Use the more efficient C<SvUV> otherwise.
3294 Returns a boolean indicating whether the SV contains a v-string.
3303 This function is only called on magical items, and is only used by
3304 sv_true() or its macro equivalent.
3306 bool sv_2bool(SV* sv)
3313 Using various gambits, try to get a CV from an SV; in addition, try if
3314 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
3316 CV* sv_2cv(SV* sv, HV** st, GV** gvp, I32 lref)
3323 Using various gambits, try to get an IO from an SV: the IO slot if its a
3324 GV; or the recursive result if we're an RV; or the IO slot of the symbol
3325 named after the PV if we're a string.
3334 Return the integer value of an SV, doing any necessary string conversion,
3335 magic etc. Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
3344 Marks an existing SV as mortal. The SV will be destroyed "soon", either
3345 by an explicit call to FREETMPS, or by an implicit call at places such as
3346 statement boundaries. See also C<sv_newmortal> and C<sv_mortalcopy>.
3348 SV* sv_2mortal(SV* sv)
3355 Return the num value of an SV, doing any necessary string or integer
3356 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
3366 Return a pointer to the byte-encoded representation of the SV, and set *lp
3367 to its length. May cause the SV to be downgraded from UTF8 as a
3370 Usually accessed via the C<SvPVbyte> macro.
3372 char* sv_2pvbyte(SV* sv, STRLEN* lp)
3377 =item sv_2pvbyte_nolen
3379 Return a pointer to the byte-encoded representation of the SV.
3380 May cause the SV to be downgraded from UTF8 as a side-effect.
3382 Usually accessed via the C<SvPVbyte_nolen> macro.
3384 char* sv_2pvbyte_nolen(SV* sv)
3391 Return a pointer to the UTF8-encoded representation of the SV, and set *lp
3392 to its length. May cause the SV to be upgraded to UTF8 as a side-effect.
3394 Usually accessed via the C<SvPVutf8> macro.
3396 char* sv_2pvutf8(SV* sv, STRLEN* lp)
3401 =item sv_2pvutf8_nolen
3403 Return a pointer to the UTF8-encoded representation of the SV.
3404 May cause the SV to be upgraded to UTF8 as a side-effect.
3406 Usually accessed via the C<SvPVutf8_nolen> macro.
3408 char* sv_2pvutf8_nolen(SV* sv)
3415 Returns a pointer to the string value of an SV, and sets *lp to its length.
3416 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
3418 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
3419 usually end up here too.
3421 char* sv_2pv_flags(SV* sv, STRLEN* lp, I32 flags)
3428 Like C<sv_2pv()>, but doesn't return the length too. You should usually
3429 use the macro wrapper C<SvPV_nolen(sv)> instead.
3430 char* sv_2pv_nolen(SV* sv)
3437 Return the unsigned integer value of an SV, doing any necessary string
3438 conversion, magic etc. Normally used via the C<SvUV(sv)> and C<SvUVx(sv)>
3448 Remove any string offset. You should normally use the C<SvOOK_off> macro
3451 int sv_backoff(SV* sv)
3458 Blesses an SV into a specified package. The SV must be an RV. The package
3459 must be designated by its stash (see C<gv_stashpv()>). The reference count
3460 of the SV is unaffected.
3462 SV* sv_bless(SV* sv, HV* stash)
3469 Concatenates the string onto the end of the string which is in the SV.
3470 If the SV has the UTF8 status set, then the bytes appended should be
3471 valid UTF8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
3473 void sv_catpv(SV* sv, const char* ptr)
3480 Processes its arguments like C<sprintf> and appends the formatted
3481 output to an SV. If the appended data contains "wide" characters
3482 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
3483 and characters >255 formatted with %c), the original SV might get
3484 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic.
3485 C<SvSETMAGIC()> must typically be called after calling this function
3486 to handle 'set' magic.
3488 void sv_catpvf(SV* sv, const char* pat, ...)
3495 Like C<sv_catpvf>, but also handles 'set' magic.
3497 void sv_catpvf_mg(SV *sv, const char* pat, ...)
3504 Concatenates the string onto the end of the string which is in the SV. The
3505 C<len> indicates number of bytes to copy. If the SV has the UTF8
3506 status set, then the bytes appended should be valid UTF8.
3507 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
3509 void sv_catpvn(SV* sv, const char* ptr, STRLEN len)
3514 =item sv_catpvn_flags
3516 Concatenates the string onto the end of the string which is in the SV. The
3517 C<len> indicates number of bytes to copy. If the SV has the UTF8
3518 status set, then the bytes appended should be valid UTF8.
3519 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
3520 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
3521 in terms of this function.
3523 void sv_catpvn_flags(SV* sv, const char* ptr, STRLEN len, I32 flags)
3530 Like C<sv_catpvn>, but also handles 'set' magic.
3532 void sv_catpvn_mg(SV *sv, const char *ptr, STRLEN len)
3539 Like C<sv_catpv>, but also handles 'set' magic.
3541 void sv_catpv_mg(SV *sv, const char *ptr)
3548 Concatenates the string from SV C<ssv> onto the end of the string in
3549 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
3550 not 'set' magic. See C<sv_catsv_mg>.
3552 void sv_catsv(SV* dsv, SV* ssv)
3557 =item sv_catsv_flags
3559 Concatenates the string from SV C<ssv> onto the end of the string in
3560 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
3561 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
3562 and C<sv_catsv_nomg> are implemented in terms of this function.
3564 void sv_catsv_flags(SV* dsv, SV* ssv, I32 flags)
3571 Like C<sv_catsv>, but also handles 'set' magic.
3573 void sv_catsv_mg(SV *dstr, SV *sstr)
3580 Efficient removal of characters from the beginning of the string buffer.
3581 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
3582 the string buffer. The C<ptr> becomes the first character of the adjusted
3583 string. Uses the "OOK hack".
3585 void sv_chop(SV* sv, char* ptr)
3592 Clear an SV: call any destructors, free up any memory used by the body,
3593 and free the body itself. The SV's head is I<not> freed, although
3594 its type is set to all 1's so that it won't inadvertently be assumed
3595 to be live during global destruction etc.
3596 This function should only be called when REFCNT is zero. Most of the time
3597 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
3600 void sv_clear(SV* sv)
3607 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
3608 string in C<sv1> is less than, equal to, or greater than the string in
3609 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
3610 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
3612 I32 sv_cmp(SV* sv1, SV* sv2)
3619 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
3620 'use bytes' aware, handles get magic, and will coerce its args to strings
3621 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
3623 I32 sv_cmp_locale(SV* sv1, SV* sv2)
3630 Add Collate Transform magic to an SV if it doesn't already have it.
3632 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
3633 scalar data of the variable, but transformed to such a format that a normal
3634 memory comparison can be used to compare the data according to the locale
3637 char* sv_collxfrm(SV* sv, STRLEN* nxp)
3644 Copies a stringified representation of the source SV into the
3645 destination SV. Automatically performs any necessary mg_get and
3646 coercion of numeric values into strings. Guaranteed to preserve
3647 UTF-8 flag even from overloaded objects. Similar in nature to
3648 sv_2pv[_flags] but operates directly on an SV instead of just the
3649 string. Mostly uses sv_2pv_flags to do its work, except when that
3650 would lose the UTF-8'ness of the PV.
3652 void sv_copypv(SV* dsv, SV* ssv)
3659 Auto-decrement of the value in the SV, doing string to numeric conversion
3660 if necessary. Handles 'get' magic.
3667 =item sv_derived_from
3669 Returns a boolean indicating whether the SV is derived from the specified
3670 class. This is the function that implements C<UNIVERSAL::isa>. It works
3671 for class names as well as for objects.
3673 bool sv_derived_from(SV* sv, const char* name)
3676 Found in file universal.c
3680 Returns a boolean indicating whether the strings in the two SVs are
3681 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
3682 coerce its args to strings if necessary.
3684 I32 sv_eq(SV* sv1, SV* sv2)
3689 =item sv_force_normal
3691 Undo various types of fakery on an SV: if the PV is a shared string, make
3692 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3693 an xpvmg. See also C<sv_force_normal_flags>.
3695 void sv_force_normal(SV *sv)
3700 =item sv_force_normal_flags
3702 Undo various types of fakery on an SV: if the PV is a shared string, make
3703 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3704 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
3705 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
3706 then a copy-on-write scalar drops its PV buffer (if any) and becomes
3707 SvPOK_off rather than making a copy. (Used where this scalar is about to be
3708 set to some other value. In addtion, the C<flags> parameter gets passed to
3709 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
3710 with flags set to 0.
3712 void sv_force_normal_flags(SV *sv, U32 flags)
3719 Decrement an SV's reference count, and if it drops to zero, call
3720 C<sv_clear> to invoke destructors and free up any memory used by
3721 the body; finally, deallocate the SV's head itself.
3722 Normally called via a wrapper macro C<SvREFCNT_dec>.
3724 void sv_free(SV* sv)
3731 Get a line from the filehandle and store it into the SV, optionally
3732 appending to the currently-stored string.
3734 char* sv_gets(SV* sv, PerlIO* fp, I32 append)
3741 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
3742 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
3743 Use the C<SvGROW> wrapper instead.
3745 char* sv_grow(SV* sv, STRLEN newlen)
3752 Auto-increment of the value in the SV, doing string to numeric conversion
3753 if necessary. Handles 'get' magic.
3762 Inserts a string at the specified offset/length within the SV. Similar to
3763 the Perl substr() function.
3765 void sv_insert(SV* bigsv, STRLEN offset, STRLEN len, char* little, STRLEN littlelen)
3772 Returns a boolean indicating whether the SV is blessed into the specified
3773 class. This does not check for subtypes; use C<sv_derived_from> to verify
3774 an inheritance relationship.
3776 int sv_isa(SV* sv, const char* name)
3783 Returns a boolean indicating whether the SV is an RV pointing to a blessed
3784 object. If the SV is not an RV, or if the object is not blessed, then this
3787 int sv_isobject(SV* sv)
3794 A private implementation of the C<SvIVx> macro for compilers which can't
3795 cope with complex macro expressions. Always use the macro instead.
3804 Returns the length of the string in the SV. Handles magic and type
3805 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
3807 STRLEN sv_len(SV* sv)
3814 Returns the number of characters in the string in an SV, counting wide
3815 UTF8 bytes as a single character. Handles magic and type coercion.
3817 STRLEN sv_len_utf8(SV* sv)
3824 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
3825 then adds a new magic item of type C<how> to the head of the magic list.
3827 void sv_magic(SV* sv, SV* obj, int how, const char* name, I32 namlen)
3834 Adds magic to an SV, upgrading it if necessary. Applies the
3835 supplied vtable and returns pointer to the magic added.
3837 Note that sv_magicext will allow things that sv_magic will not.
3838 In particular you can add magic to SvREADONLY SVs and and more than
3839 one instance of the same 'how'
3841 I C<namelen> is greater then zero then a savepvn() I<copy> of C<name> is stored,
3842 if C<namelen> is zero then C<name> is stored as-is and - as another special
3843 case - if C<(name && namelen == HEf_SVKEY)> then C<name> is assumed to contain
3844 an C<SV*> and has its REFCNT incremented
3846 (This is now used as a subroutine by sv_magic.)
3848 MAGIC * sv_magicext(SV* sv, SV* obj, int how, MGVTBL *vtbl, const char* name, I32 namlen )
3855 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
3856 The new SV is marked as mortal. It will be destroyed "soon", either by an
3857 explicit call to FREETMPS, or by an implicit call at places such as
3858 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
3860 SV* sv_mortalcopy(SV* oldsv)
3867 Creates a new null SV which is mortal. The reference count of the SV is
3868 set to 1. It will be destroyed "soon", either by an explicit call to
3869 FREETMPS, or by an implicit call at places such as statement boundaries.
3870 See also C<sv_mortalcopy> and C<sv_2mortal>.
3879 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
3882 SV* sv_newref(SV* sv)
3889 Dummy routine which "locks" an SV when there is no locking module present.
3890 Exists to avoid test for a NULL function pointer and because it could potentially warn under
3891 some level of strict-ness.
3893 void sv_nolocking(SV *)
3896 Found in file util.c
3900 Dummy routine which "shares" an SV when there is no sharing module present.
3901 Exists to avoid test for a NULL function pointer and because it could potentially warn under
3902 some level of strict-ness.
3904 void sv_nosharing(SV *)
3907 Found in file util.c
3909 =item sv_nounlocking
3911 Dummy routine which "unlocks" an SV when there is no locking module present.
3912 Exists to avoid test for a NULL function pointer and because it could potentially warn under
3913 some level of strict-ness.
3915 void sv_nounlocking(SV *)
3918 Found in file util.c
3922 A private implementation of the C<SvNVx> macro for compilers which can't
3923 cope with complex macro expressions. Always use the macro instead.
3932 Converts the value pointed to by offsetp from a count of bytes from the
3933 start of the string, to a count of the equivalent number of UTF8 chars.
3934 Handles magic and type coercion.
3936 void sv_pos_b2u(SV* sv, I32* offsetp)
3943 Converts the value pointed to by offsetp from a count of UTF8 chars from
3944 the start of the string, to a count of the equivalent number of bytes; if
3945 lenp is non-zero, it does the same to lenp, but this time starting from
3946 the offset, rather than from the start of the string. Handles magic and
3949 void sv_pos_u2b(SV* sv, I32* offsetp, I32* lenp)
3956 Use the C<SvPV_nolen> macro instead
3965 Use C<SvPVbyte_nolen> instead.
3967 char* sv_pvbyte(SV *sv)
3974 A private implementation of the C<SvPVbyte> macro for compilers
3975 which can't cope with complex macro expressions. Always use the macro
3978 char* sv_pvbyten(SV *sv, STRLEN *len)
3983 =item sv_pvbyten_force
3985 A private implementation of the C<SvPVbytex_force> macro for compilers
3986 which can't cope with complex macro expressions. Always use the macro
3989 char* sv_pvbyten_force(SV* sv, STRLEN* lp)
3996 A private implementation of the C<SvPV> macro for compilers which can't
3997 cope with complex macro expressions. Always use the macro instead.
3999 char* sv_pvn(SV *sv, STRLEN *len)
4006 Get a sensible string out of the SV somehow.
4007 A private implementation of the C<SvPV_force> macro for compilers which
4008 can't cope with complex macro expressions. Always use the macro instead.
4010 char* sv_pvn_force(SV* sv, STRLEN* lp)
4015 =item sv_pvn_force_flags
4017 Get a sensible string out of the SV somehow.
4018 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
4019 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
4020 implemented in terms of this function.
4021 You normally want to use the various wrapper macros instead: see
4022 C<SvPV_force> and C<SvPV_force_nomg>
4024 char* sv_pvn_force_flags(SV* sv, STRLEN* lp, I32 flags)
4031 Use the C<SvPVutf8_nolen> macro instead
4033 char* sv_pvutf8(SV *sv)
4040 A private implementation of the C<SvPVutf8> macro for compilers
4041 which can't cope with complex macro expressions. Always use the macro
4044 char* sv_pvutf8n(SV *sv, STRLEN *len)
4049 =item sv_pvutf8n_force
4051 A private implementation of the C<SvPVutf8_force> macro for compilers
4052 which can't cope with complex macro expressions. Always use the macro
4055 char* sv_pvutf8n_force(SV* sv, STRLEN* lp)
4062 Returns a string describing what the SV is a reference to.
4064 char* sv_reftype(SV* sv, int ob)
4071 Make the first argument a copy of the second, then delete the original.
4072 The target SV physically takes over ownership of the body of the source SV
4073 and inherits its flags; however, the target keeps any magic it owns,
4074 and any magic in the source is discarded.
4075 Note that this is a rather specialist SV copying operation; most of the
4076 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4078 void sv_replace(SV* sv, SV* nsv)
4083 =item sv_report_used
4085 Dump the contents of all SVs not yet freed. (Debugging aid).
4087 void sv_report_used()
4094 Underlying implementation for the C<reset> Perl function.
4095 Note that the perl-level function is vaguely deprecated.
4097 void sv_reset(char* s, HV* stash)
4104 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4105 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4106 push a back-reference to this RV onto the array of backreferences
4107 associated with that magic.
4109 SV* sv_rvweaken(SV *sv)
4116 Copies an integer into the given SV, upgrading first if necessary.
4117 Does not handle 'set' magic. See also C<sv_setiv_mg>.
4119 void sv_setiv(SV* sv, IV num)
4126 Like C<sv_setiv>, but also handles 'set' magic.
4128 void sv_setiv_mg(SV *sv, IV i)
4135 Copies a double into the given SV, upgrading first if necessary.
4136 Does not handle 'set' magic. See also C<sv_setnv_mg>.
4138 void sv_setnv(SV* sv, NV num)
4145 Like C<sv_setnv>, but also handles 'set' magic.
4147 void sv_setnv_mg(SV *sv, NV num)
4154 Copies a string into an SV. The string must be null-terminated. Does not
4155 handle 'set' magic. See C<sv_setpv_mg>.
4157 void sv_setpv(SV* sv, const char* ptr)
4164 Processes its arguments like C<sprintf> and sets an SV to the formatted
4165 output. Does not handle 'set' magic. See C<sv_setpvf_mg>.
4167 void sv_setpvf(SV* sv, const char* pat, ...)
4174 Like C<sv_setpvf>, but also handles 'set' magic.
4176 void sv_setpvf_mg(SV *sv, const char* pat, ...)
4183 Copies a string into an SV. The C<len> parameter indicates the number of
4184 bytes to be copied. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4186 void sv_setpvn(SV* sv, const char* ptr, STRLEN len)
4193 Like C<sv_setpvn>, but also handles 'set' magic.
4195 void sv_setpvn_mg(SV *sv, const char *ptr, STRLEN len)
4202 Like C<sv_setpv>, but also handles 'set' magic.
4204 void sv_setpv_mg(SV *sv, const char *ptr)
4211 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
4212 argument will be upgraded to an RV. That RV will be modified to point to
4213 the new SV. The C<classname> argument indicates the package for the
4214 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4215 will be returned and will have a reference count of 1.
4217 SV* sv_setref_iv(SV* rv, const char* classname, IV iv)
4224 Copies a double into a new SV, optionally blessing the SV. The C<rv>
4225 argument will be upgraded to an RV. That RV will be modified to point to
4226 the new SV. The C<classname> argument indicates the package for the
4227 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4228 will be returned and will have a reference count of 1.
4230 SV* sv_setref_nv(SV* rv, const char* classname, NV nv)
4237 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
4238 argument will be upgraded to an RV. That RV will be modified to point to
4239 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
4240 into the SV. The C<classname> argument indicates the package for the
4241 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4242 will be returned and will have a reference count of 1.
4244 Do not use with other Perl types such as HV, AV, SV, CV, because those
4245 objects will become corrupted by the pointer copy process.
4247 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
4249 SV* sv_setref_pv(SV* rv, const char* classname, void* pv)
4256 Copies a string into a new SV, optionally blessing the SV. The length of the
4257 string must be specified with C<n>. The C<rv> argument will be upgraded to
4258 an RV. That RV will be modified to point to the new SV. The C<classname>
4259 argument indicates the package for the blessing. Set C<classname> to
4260 C<Nullch> to avoid the blessing. The new SV will be returned and will have
4261 a reference count of 1.
4263 Note that C<sv_setref_pv> copies the pointer while this copies the string.
4265 SV* sv_setref_pvn(SV* rv, const char* classname, char* pv, STRLEN n)
4272 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
4273 argument will be upgraded to an RV. That RV will be modified to point to
4274 the new SV. The C<classname> argument indicates the package for the
4275 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4276 will be returned and will have a reference count of 1.
4278 SV* sv_setref_uv(SV* rv, const char* classname, UV uv)
4285 Copies the contents of the source SV C<ssv> into the destination SV
4286 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4287 function if the source SV needs to be reused. Does not handle 'set' magic.
4288 Loosely speaking, it performs a copy-by-value, obliterating any previous
4289 content of the destination.
4291 You probably want to use one of the assortment of wrappers, such as
4292 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4293 C<SvSetMagicSV_nosteal>.
4295 void sv_setsv(SV* dsv, SV* ssv)
4300 =item sv_setsv_flags
4302 Copies the contents of the source SV C<ssv> into the destination SV
4303 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4304 function if the source SV needs to be reused. Does not handle 'set' magic.
4305 Loosely speaking, it performs a copy-by-value, obliterating any previous
4306 content of the destination.
4307 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
4308 C<ssv> if appropriate, else not. C<sv_setsv> and C<sv_setsv_nomg> are
4309 implemented in terms of this function.
4311 You probably want to use one of the assortment of wrappers, such as
4312 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4313 C<SvSetMagicSV_nosteal>.
4315 This is the primary function for copying scalars, and most other
4316 copy-ish functions and macros use this underneath.
4318 void sv_setsv_flags(SV* dsv, SV* ssv, I32 flags)
4325 Like C<sv_setsv>, but also handles 'set' magic.
4327 void sv_setsv_mg(SV *dstr, SV *sstr)
4334 Copies an unsigned integer into the given SV, upgrading first if necessary.
4335 Does not handle 'set' magic. See also C<sv_setuv_mg>.
4337 void sv_setuv(SV* sv, UV num)
4344 Like C<sv_setuv>, but also handles 'set' magic.
4346 void sv_setuv_mg(SV *sv, UV u)
4353 Taint an SV. Use C<SvTAINTED_on> instead.
4354 void sv_taint(SV* sv)
4361 Test an SV for taintedness. Use C<SvTAINTED> instead.
4362 bool sv_tainted(SV* sv)
4369 Returns true if the SV has a true value by Perl's rules.
4370 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
4371 instead use an in-line version.
4380 Removes all magic of type C<type> from an SV.
4382 int sv_unmagic(SV* sv, int type)
4389 Unsets the RV status of the SV, and decrements the reference count of
4390 whatever was being referenced by the RV. This can almost be thought of
4391 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
4392 being zero. See C<SvROK_off>.
4394 void sv_unref(SV* sv)
4399 =item sv_unref_flags
4401 Unsets the RV status of the SV, and decrements the reference count of
4402 whatever was being referenced by the RV. This can almost be thought of
4403 as a reversal of C<newSVrv>. The C<cflags> argument can contain
4404 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
4405 (otherwise the decrementing is conditional on the reference count being
4406 different from one or the reference being a readonly SV).
4409 void sv_unref_flags(SV* sv, U32 flags)
4416 Untaint an SV. Use C<SvTAINTED_off> instead.
4417 void sv_untaint(SV* sv)
4424 Upgrade an SV to a more complex form. Generally adds a new body type to the
4425 SV, then copies across as much information as possible from the old body.
4426 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
4428 bool sv_upgrade(SV* sv, U32 mt)
4435 Tells an SV to use C<ptr> to find its string value. Normally the string is
4436 stored inside the SV but sv_usepvn allows the SV to use an outside string.
4437 The C<ptr> should point to memory that was allocated by C<malloc>. The
4438 string length, C<len>, must be supplied. This function will realloc the
4439 memory pointed to by C<ptr>, so that pointer should not be freed or used by
4440 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
4441 See C<sv_usepvn_mg>.
4443 void sv_usepvn(SV* sv, char* ptr, STRLEN len)
4450 Like C<sv_usepvn>, but also handles 'set' magic.
4452 void sv_usepvn_mg(SV *sv, char *ptr, STRLEN len)
4457 =item sv_utf8_decode
4459 Convert the octets in the PV from UTF-8 to chars. Scan for validity and then
4460 turn off SvUTF8 if needed so that we see characters. Used as a building block
4461 for decode_utf8 in Encode.xs
4463 NOTE: this function is experimental and may change or be
4464 removed without notice.
4466 bool sv_utf8_decode(SV *sv)
4471 =item sv_utf8_downgrade
4473 Attempt to convert the PV of an SV from UTF8-encoded to byte encoding.
4474 This may not be possible if the PV contains non-byte encoding characters;
4475 if this is the case, either returns false or, if C<fail_ok> is not
4478 This is not as a general purpose Unicode to byte encoding interface:
4479 use the Encode extension for that.
4481 NOTE: this function is experimental and may change or be
4482 removed without notice.
4484 bool sv_utf8_downgrade(SV *sv, bool fail_ok)
4489 =item sv_utf8_encode
4491 Convert the PV of an SV to UTF8-encoded, but then turn off the C<SvUTF8>
4492 flag so that it looks like octets again. Used as a building block
4493 for encode_utf8 in Encode.xs
4495 void sv_utf8_encode(SV *sv)
4500 =item sv_utf8_upgrade
4502 Convert the PV of an SV to its UTF8-encoded form.
4503 Forces the SV to string form if it is not already.
4504 Always sets the SvUTF8 flag to avoid future validity checks even
4505 if all the bytes have hibit clear.
4507 This is not as a general purpose byte encoding to Unicode interface:
4508 use the Encode extension for that.
4510 STRLEN sv_utf8_upgrade(SV *sv)
4515 =item sv_utf8_upgrade_flags
4517 Convert the PV of an SV to its UTF8-encoded form.
4518 Forces the SV to string form if it is not already.
4519 Always sets the SvUTF8 flag to avoid future validity checks even
4520 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
4521 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
4522 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
4524 This is not as a general purpose byte encoding to Unicode interface:
4525 use the Encode extension for that.
4527 STRLEN sv_utf8_upgrade_flags(SV *sv, I32 flags)
4534 A private implementation of the C<SvUVx> macro for compilers which can't
4535 cope with complex macro expressions. Always use the macro instead.
4544 Processes its arguments like C<vsprintf> and appends the formatted output
4545 to an SV. Uses an array of SVs if the C style variable argument list is
4546 missing (NULL). When running with taint checks enabled, indicates via
4547 C<maybe_tainted> if results are untrustworthy (often due to the use of
4550 Usually used via one of its frontends C<sv_catpvf> and C<sv_catpvf_mg>.
4552 void sv_vcatpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
4559 Works like C<vcatpvfn> but copies the text into the SV instead of
4562 Usually used via one of its frontends C<sv_setpvf> and C<sv_setpvf_mg>.
4564 void sv_vsetpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
4571 In-place upgrade of the supplied SV to a version object.
4573 SV *sv = upg_version(SV *sv);
4575 Returns a pointer to the upgraded SV.
4577 SV* upg_version(SV *ver)
4580 Found in file util.c
4584 Version object aware cmp. Both operands must already have been
4585 converted into version objects.
4587 int vcmp(SV *lvs, SV *rvs)
4590 Found in file util.c
4594 Accepts a version object and returns the normalized floating
4595 point representation. Call like:
4599 NOTE: you can pass either the object directly or the SV
4600 contained within the RV.
4605 Found in file util.c
4609 Accepts a version object and returns the normalized string
4610 representation. Call like:
4612 sv = vstringify(rv);
4614 NOTE: you can pass either the object directly or the SV
4615 contained within the RV.
4617 SV* vstringify(SV *vs)
4620 Found in file util.c
4625 =head1 Unicode Support
4629 =item bytes_from_utf8
4631 Converts a string C<s> of length C<len> from UTF8 into byte encoding.
4632 Unlike <utf8_to_bytes> but like C<bytes_to_utf8>, returns a pointer to
4633 the newly-created string, and updates C<len> to contain the new
4634 length. Returns the original string if no conversion occurs, C<len>
4635 is unchanged. Do nothing if C<is_utf8> points to 0. Sets C<is_utf8> to
4636 0 if C<s> is converted or contains all 7bit characters.
4638 NOTE: this function is experimental and may change or be
4639 removed without notice.
4641 U8* bytes_from_utf8(U8 *s, STRLEN *len, bool *is_utf8)
4644 Found in file utf8.c
4648 Converts a string C<s> of length C<len> from ASCII into UTF8 encoding.
4649 Returns a pointer to the newly-created string, and sets C<len> to
4650 reflect the new length.
4652 NOTE: this function is experimental and may change or be
4653 removed without notice.
4655 U8* bytes_to_utf8(U8 *s, STRLEN *len)
4658 Found in file utf8.c
4662 Return true if the strings s1 and s2 differ case-insensitively, false
4663 if not (if they are equal case-insensitively). If u1 is true, the
4664 string s1 is assumed to be in UTF-8-encoded Unicode. If u2 is true,
4665 the string s2 is assumed to be in UTF-8-encoded Unicode. If u1 or u2
4666 are false, the respective string is assumed to be in native 8-bit
4669 If the pe1 and pe2 are non-NULL, the scanning pointers will be copied
4670 in there (they will point at the beginning of the I<next> character).
4671 If the pointers behind pe1 or pe2 are non-NULL, they are the end
4672 pointers beyond which scanning will not continue under any
4673 circustances. If the byte lengths l1 and l2 are non-zero, s1+l1 and
4674 s2+l2 will be used as goal end pointers that will also stop the scan,
4675 and which qualify towards defining a successful match: all the scans
4676 that define an explicit length must reach their goal pointers for
4677 a match to succeed).
4679 For case-insensitiveness, the "casefolding" of Unicode is used
4680 instead of upper/lowercasing both the characters, see
4681 http://www.unicode.org/unicode/reports/tr21/ (Case Mappings).
4683 I32 ibcmp_utf8(const char* a, char **pe1, UV l1, bool u1, const char* b, char **pe2, UV l2, bool u2)
4686 Found in file utf8.c
4690 Tests if some arbitrary number of bytes begins in a valid UTF-8
4691 character. Note that an INVARIANT (i.e. ASCII) character is a valid
4692 UTF-8 character. The actual number of bytes in the UTF-8 character
4693 will be returned if it is valid, otherwise 0.
4695 STRLEN is_utf8_char(U8 *p)
4698 Found in file utf8.c
4700 =item is_utf8_string
4702 Returns true if first C<len> bytes of the given string form a valid UTF8
4703 string, false otherwise. Note that 'a valid UTF8 string' does not mean
4704 'a string that contains UTF8' because a valid ASCII string is a valid
4707 bool is_utf8_string(U8 *s, STRLEN len)
4710 Found in file utf8.c
4712 =item pv_uni_display
4714 Build to the scalar dsv a displayable version of the string spv,
4715 length len, the displayable version being at most pvlim bytes long
4716 (if longer, the rest is truncated and "..." will be appended).
4718 The flags argument can have UNI_DISPLAY_ISPRINT set to display
4719 isPRINT()able characters as themselves, UNI_DISPLAY_BACKSLASH
4720 to display the \\[nrfta\\] as the backslashed versions (like '\n')
4721 (UNI_DISPLAY_BACKSLASH is preferred over UNI_DISPLAY_ISPRINT for \\).
4722 UNI_DISPLAY_QQ (and its alias UNI_DISPLAY_REGEX) have both
4723 UNI_DISPLAY_BACKSLASH and UNI_DISPLAY_ISPRINT turned on.
4725 The pointer to the PV of the dsv is returned.
4727 char* pv_uni_display(SV *dsv, U8 *spv, STRLEN len, STRLEN pvlim, UV flags)
4730 Found in file utf8.c
4732 =item sv_recode_to_utf8
4734 The encoding is assumed to be an Encode object, on entry the PV
4735 of the sv is assumed to be octets in that encoding, and the sv
4736 will be converted into Unicode (and UTF-8).
4738 If the sv already is UTF-8 (or if it is not POK), or if the encoding
4739 is not a reference, nothing is done to the sv. If the encoding is not
4740 an C<Encode::XS> Encoding object, bad things will happen.
4741 (See F<lib/encoding.pm> and L<Encode>).
4743 The PV of the sv is returned.
4745 char* sv_recode_to_utf8(SV* sv, SV *encoding)
4750 =item sv_uni_display
4752 Build to the scalar dsv a displayable version of the scalar sv,
4753 the displayable version being at most pvlim bytes long
4754 (if longer, the rest is truncated and "..." will be appended).
4756 The flags argument is as in pv_uni_display().
4758 The pointer to the PV of the dsv is returned.
4760 char* sv_uni_display(SV *dsv, SV *ssv, STRLEN pvlim, UV flags)
4763 Found in file utf8.c
4767 The "p" contains the pointer to the UTF-8 string encoding
4768 the character that is being converted.
4770 The "ustrp" is a pointer to the character buffer to put the
4771 conversion result to. The "lenp" is a pointer to the length
4774 The "swashp" is a pointer to the swash to use.
4776 Both the special and normal mappings are stored lib/unicore/To/Foo.pl,
4777 and loaded by SWASHGET, using lib/utf8_heavy.pl. The special (usually,
4778 but not always, a multicharacter mapping), is tried first.
4780 The "special" is a string like "utf8::ToSpecLower", which means the
4781 hash %utf8::ToSpecLower. The access to the hash is through
4782 Perl_to_utf8_case().
4784 The "normal" is a string like "ToLower" which means the swash
4787 UV to_utf8_case(U8 *p, U8* ustrp, STRLEN *lenp, SV **swash, char *normal, char *special)
4790 Found in file utf8.c
4794 Convert the UTF-8 encoded character at p to its foldcase version and
4795 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
4796 that the ustrp needs to be at least UTF8_MAXLEN_FOLD+1 bytes since the
4797 foldcase version may be longer than the original character (up to
4800 The first character of the foldcased version is returned
4801 (but note, as explained above, that there may be more.)
4803 UV to_utf8_fold(U8 *p, U8* ustrp, STRLEN *lenp)
4806 Found in file utf8.c
4810 Convert the UTF-8 encoded character at p to its lowercase version and
4811 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
4812 that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the
4813 lowercase version may be longer than the original character (up to two
4816 The first character of the lowercased version is returned
4817 (but note, as explained above, that there may be more.)
4819 UV to_utf8_lower(U8 *p, U8* ustrp, STRLEN *lenp)
4822 Found in file utf8.c
4826 Convert the UTF-8 encoded character at p to its titlecase version and
4827 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
4828 that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the
4829 titlecase version may be longer than the original character (up to two
4832 The first character of the titlecased version is returned
4833 (but note, as explained above, that there may be more.)
4835 UV to_utf8_title(U8 *p, U8* ustrp, STRLEN *lenp)
4838 Found in file utf8.c
4842 Convert the UTF-8 encoded character at p to its uppercase version and
4843 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
4844 that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the
4845 uppercase version may be longer than the original character (up to two
4848 The first character of the uppercased version is returned
4849 (but note, as explained above, that there may be more.)
4851 UV to_utf8_upper(U8 *p, U8* ustrp, STRLEN *lenp)
4854 Found in file utf8.c
4856 =item utf8n_to_uvchr
4858 Returns the native character value of the first character in the string C<s>
4859 which is assumed to be in UTF8 encoding; C<retlen> will be set to the
4860 length, in bytes, of that character.
4862 Allows length and flags to be passed to low level routine.
4864 UV utf8n_to_uvchr(U8 *s, STRLEN curlen, STRLEN* retlen, U32 flags)
4867 Found in file utf8.c
4869 =item utf8n_to_uvuni
4871 Bottom level UTF-8 decode routine.
4872 Returns the unicode code point value of the first character in the string C<s>
4873 which is assumed to be in UTF8 encoding and no longer than C<curlen>;
4874 C<retlen> will be set to the length, in bytes, of that character.
4876 If C<s> does not point to a well-formed UTF8 character, the behaviour
4877 is dependent on the value of C<flags>: if it contains UTF8_CHECK_ONLY,
4878 it is assumed that the caller will raise a warning, and this function
4879 will silently just set C<retlen> to C<-1> and return zero. If the
4880 C<flags> does not contain UTF8_CHECK_ONLY, warnings about
4881 malformations will be given, C<retlen> will be set to the expected
4882 length of the UTF-8 character in bytes, and zero will be returned.
4884 The C<flags> can also contain various flags to allow deviations from
4885 the strict UTF-8 encoding (see F<utf8.h>).
4887 Most code should use utf8_to_uvchr() rather than call this directly.
4889 UV utf8n_to_uvuni(U8 *s, STRLEN curlen, STRLEN* retlen, U32 flags)
4892 Found in file utf8.c
4896 Returns the number of UTF8 characters between the UTF-8 pointers C<a>
4899 WARNING: use only if you *know* that the pointers point inside the
4902 IV utf8_distance(U8 *a, U8 *b)
4905 Found in file utf8.c
4909 Return the UTF-8 pointer C<s> displaced by C<off> characters, either
4910 forward or backward.
4912 WARNING: do not use the following unless you *know* C<off> is within
4913 the UTF-8 data pointed to by C<s> *and* that on entry C<s> is aligned
4914 on the first byte of character or just after the last byte of a character.
4916 U8* utf8_hop(U8 *s, I32 off)
4919 Found in file utf8.c
4923 Return the length of the UTF-8 char encoded string C<s> in characters.
4924 Stops at C<e> (inclusive). If C<e E<lt> s> or if the scan would end
4925 up past C<e>, croaks.
4927 STRLEN utf8_length(U8* s, U8 *e)
4930 Found in file utf8.c
4934 Converts a string C<s> of length C<len> from UTF8 into byte encoding.
4935 Unlike C<bytes_to_utf8>, this over-writes the original string, and
4936 updates len to contain the new length.
4937 Returns zero on failure, setting C<len> to -1.
4939 NOTE: this function is experimental and may change or be
4940 removed without notice.
4942 U8* utf8_to_bytes(U8 *s, STRLEN *len)
4945 Found in file utf8.c
4949 Returns the native character value of the first character in the string C<s>
4950 which is assumed to be in UTF8 encoding; C<retlen> will be set to the
4951 length, in bytes, of that character.
4953 If C<s> does not point to a well-formed UTF8 character, zero is
4954 returned and retlen is set, if possible, to -1.
4956 UV utf8_to_uvchr(U8 *s, STRLEN* retlen)
4959 Found in file utf8.c
4963 Returns the Unicode code point of the first character in the string C<s>
4964 which is assumed to be in UTF8 encoding; C<retlen> will be set to the
4965 length, in bytes, of that character.
4967 This function should only be used when returned UV is considered
4968 an index into the Unicode semantic tables (e.g. swashes).
4970 If C<s> does not point to a well-formed UTF8 character, zero is
4971 returned and retlen is set, if possible, to -1.
4973 UV utf8_to_uvuni(U8 *s, STRLEN* retlen)
4976 Found in file utf8.c
4980 Adds the UTF8 representation of the Native codepoint C<uv> to the end
4981 of the string C<d>; C<d> should be have at least C<UTF8_MAXLEN+1> free
4982 bytes available. The return value is the pointer to the byte after the
4983 end of the new character. In other words,
4985 d = uvchr_to_utf8(d, uv);
4987 is the recommended wide native character-aware way of saying
4991 U8* uvchr_to_utf8(U8 *d, UV uv)
4994 Found in file utf8.c
4996 =item uvuni_to_utf8_flags
4998 Adds the UTF8 representation of the Unicode codepoint C<uv> to the end
4999 of the string C<d>; C<d> should be have at least C<UTF8_MAXLEN+1> free
5000 bytes available. The return value is the pointer to the byte after the
5001 end of the new character. In other words,
5003 d = uvuni_to_utf8_flags(d, uv, flags);
5007 d = uvuni_to_utf8(d, uv);
5009 (which is equivalent to)
5011 d = uvuni_to_utf8_flags(d, uv, 0);
5013 is the recommended Unicode-aware way of saying
5017 U8* uvuni_to_utf8_flags(U8 *d, UV uv, UV flags)
5020 Found in file utf8.c
5025 =head1 Variables created by C<xsubpp> and C<xsubpp> internal functions
5031 Variable which is setup by C<xsubpp> to indicate the stack base offset,
5032 used by the C<ST>, C<XSprePUSH> and C<XSRETURN> macros. The C<dMARK> macro
5033 must be called prior to setup the C<MARK> variable.
5038 Found in file XSUB.h
5042 Variable which is setup by C<xsubpp> to indicate the
5043 class name for a C++ XS constructor. This is always a C<char*>. See C<THIS>.
5048 Found in file XSUB.h
5052 Sets up the C<ax> variable.
5053 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
5058 Found in file XSUB.h
5062 Sets up the C<items> variable.
5063 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
5068 Found in file XSUB.h
5072 Sets up stack and mark pointers for an XSUB, calling dSP and dMARK.
5073 Sets up the C<ax> and C<items> variables by calling C<dAX> and C<dITEMS>.
5074 This is usually handled automatically by C<xsubpp>.
5079 Found in file XSUB.h
5083 Sets up the C<ix> variable for an XSUB which has aliases. This is usually
5084 handled automatically by C<xsubpp>.
5089 Found in file XSUB.h
5093 Variable which is setup by C<xsubpp> to indicate the number of
5094 items on the stack. See L<perlxs/"Variable-length Parameter Lists">.
5099 Found in file XSUB.h
5103 Variable which is setup by C<xsubpp> to indicate which of an
5104 XSUB's aliases was used to invoke it. See L<perlxs/"The ALIAS: Keyword">.
5109 Found in file XSUB.h
5113 Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
5117 Found in file XSUB.h
5121 Variable which is setup by C<xsubpp> to hold the return value for an
5122 XSUB. This is always the proper type for the XSUB. See
5123 L<perlxs/"The RETVAL Variable">.
5128 Found in file XSUB.h
5132 Used to access elements on the XSUB's stack.
5137 Found in file XSUB.h
5141 Variable which is setup by C<xsubpp> to designate the object in a C++
5142 XSUB. This is always the proper type for the C++ object. See C<CLASS> and
5143 L<perlxs/"Using XS With C++">.
5148 Found in file XSUB.h
5152 Macro to declare an XSUB and its C parameter list. This is handled by
5156 Found in file XSUB.h
5158 =item XSRETURN_EMPTY
5160 Return an empty list from an XSUB immediately.
5166 Found in file XSUB.h
5170 The version identifier for an XS module. This is usually
5171 handled automatically by C<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>.
5174 Found in file XSUB.h
5176 =item XS_VERSION_BOOTCHECK
5178 Macro to verify that a PM module's $VERSION variable matches the XS
5179 module's C<XS_VERSION> variable. This is usually handled automatically by
5180 C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">.
5182 XS_VERSION_BOOTCHECK;
5185 Found in file XSUB.h
5190 =head1 Warning and Dieing
5196 This is the XSUB-writer's interface to Perl's C<die> function.
5197 Normally use this function the same way you use the C C<printf>
5198 function. See C<warn>.
5200 If you want to throw an exception object, assign the object to
5201 C<$@> and then pass C<Nullch> to croak():
5203 errsv = get_sv("@", TRUE);
5204 sv_setsv(errsv, exception_object);
5207 void croak(const char* pat, ...)
5210 Found in file util.c
5214 This is the XSUB-writer's interface to Perl's C<warn> function. Use this
5215 function the same way you use the C C<printf> function. See
5218 void warn(const char* pat, ...)
5221 Found in file util.c
5228 Until May 1997, this document was maintained by Jeff Okamoto
5229 <okamoto@corp.hp.com>. It is now maintained as part of Perl itself.
5231 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
5232 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
5233 Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
5234 Stephen McCamant, and Gurusamy Sarathy.
5236 API Listing originally by Dean Roehrich <roehrich@cray.com>.
5238 Updated to be autogenerated from comments in the source by Benjamin Stuhl.
5242 perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
https://perl5.git.perl.org / perl5.git / blob