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 Stack Manipulation Macros
1894 Declare a stack marker variable, C<mark>, for the XSUB. See C<MARK> and
1904 Saves the original stack mark for the XSUB. See C<ORIGMARK>.
1913 Declares a local copy of perl's stack pointer for the XSUB, available via
1914 the C<SP> macro. See C<SP>.
1923 Used to extend the argument stack for an XSUB's return values. Once
1924 used, guarantees that there is room for at least C<nitems> to be pushed
1927 void EXTEND(SP, int nitems)
1934 Stack marker variable for the XSUB. See C<dMARK>.
1941 The original stack mark for the XSUB. See C<dORIGMARK>.
1948 Pops an integer off the stack.
1957 Pops a long off the stack.
1966 Pops a double off the stack.
1975 Pops a string off the stack. Deprecated. New code should provide
1976 a STRLEN n_a and use POPpx.
1985 Pops a string off the stack which must consist of bytes i.e. characters < 256.
1986 Requires a variable STRLEN n_a in scope.
1995 Pops a string off the stack.
1996 Requires a variable STRLEN n_a in scope.
2005 Pops an SV off the stack.
2014 Push an integer onto the stack. The stack must have room for this element.
2015 Handles 'set' magic. See C<XPUSHi>.
2024 Opening bracket for arguments on a callback. See C<PUTBACK> and
2034 Push a double onto the stack. The stack must have room for this element.
2035 Handles 'set' magic. See C<XPUSHn>.
2044 Push a string onto the stack. The stack must have room for this element.
2045 The C<len> indicates the length of the string. Handles 'set' magic. See
2048 void PUSHp(char* str, STRLEN len)
2055 Push an SV onto the stack. The stack must have room for this element.
2056 Does not handle 'set' magic. See C<XPUSHs>.
2065 Push an unsigned integer onto the stack. The stack must have room for this
2066 element. See C<XPUSHu>.
2075 Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
2076 See C<PUSHMARK> and L<perlcall> for other uses.
2085 Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and
2093 Refetch the stack pointer. Used after a callback. See L<perlcall>.
2102 Push an integer onto the stack, extending the stack if necessary. Handles
2103 'set' magic. See C<PUSHi>.
2112 Push a double onto the stack, extending the stack if necessary. Handles
2113 'set' magic. See C<PUSHn>.
2122 Push a string onto the stack, extending the stack if necessary. The C<len>
2123 indicates the length of the string. Handles 'set' magic. See
2126 void XPUSHp(char* str, STRLEN len)
2133 Push an SV onto the stack, extending the stack if necessary. Does not
2134 handle 'set' magic. See C<PUSHs>.
2143 Push an unsigned integer onto the stack, extending the stack if necessary.
2153 Return from XSUB, indicating number of items on the stack. This is usually
2154 handled by C<xsubpp>.
2156 void XSRETURN(int nitems)
2159 Found in file XSUB.h
2163 Return an integer from an XSUB immediately. Uses C<XST_mIV>.
2165 void XSRETURN_IV(IV iv)
2168 Found in file XSUB.h
2172 Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
2177 Found in file XSUB.h
2181 Return a double from an XSUB immediately. Uses C<XST_mNV>.
2183 void XSRETURN_NV(NV nv)
2186 Found in file XSUB.h
2190 Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
2192 void XSRETURN_PV(char* str)
2195 Found in file XSUB.h
2197 =item XSRETURN_UNDEF
2199 Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
2204 Found in file XSUB.h
2208 Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
2213 Found in file XSUB.h
2217 Place an integer into the specified position C<pos> on the stack. The
2218 value is stored in a new mortal SV.
2220 void XST_mIV(int pos, IV iv)
2223 Found in file XSUB.h
2227 Place C<&PL_sv_no> into the specified position C<pos> on the
2230 void XST_mNO(int pos)
2233 Found in file XSUB.h
2237 Place a double into the specified position C<pos> on the stack. The value
2238 is stored in a new mortal SV.
2240 void XST_mNV(int pos, NV nv)
2243 Found in file XSUB.h
2247 Place a copy of a string into the specified position C<pos> on the stack.
2248 The value is stored in a new mortal SV.
2250 void XST_mPV(int pos, char* str)
2253 Found in file XSUB.h
2257 Place C<&PL_sv_undef> into the specified position C<pos> on the
2260 void XST_mUNDEF(int pos)
2263 Found in file XSUB.h
2267 Place C<&PL_sv_yes> into the specified position C<pos> on the
2270 void XST_mYES(int pos)
2273 Found in file XSUB.h
2284 An enum of flags for Perl types. These are found in the file B<sv.h>
2285 in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
2292 Integer type flag for scalars. See C<svtype>.
2299 Double type flag for scalars. See C<svtype>.
2306 Pointer type flag for scalars. See C<svtype>.
2313 Type flag for arrays. See C<svtype>.
2320 Type flag for code refs. See C<svtype>.
2327 Type flag for hashes. See C<svtype>.
2334 Type flag for blessed scalars. See C<svtype>.
2342 =head1 SV Manipulation Functions
2348 Returns the SV of the specified Perl scalar. If C<create> is set and the
2349 Perl variable does not exist then it will be created. If C<create> is not
2350 set and the variable does not exist then NULL is returned.
2352 NOTE: the perl_ form of this function is deprecated.
2354 SV* get_sv(const char* name, I32 create)
2357 Found in file perl.c
2359 =item looks_like_number
2361 Test if the content of an SV looks like a number (or is a number).
2362 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
2363 non-numeric warning), even if your atof() doesn't grok them.
2365 I32 looks_like_number(SV* sv)
2372 Creates an RV wrapper for an SV. The reference count for the original SV is
2375 SV* newRV_inc(SV* sv)
2382 Creates an RV wrapper for an SV. The reference count for the original
2383 SV is B<not> incremented.
2385 SV* newRV_noinc(SV *sv)
2392 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
2393 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
2396 SV* newSV(STRLEN len)
2403 Creates a new SV and copies an integer into it. The reference count for the
2413 Creates a new SV and copies a floating point value into it.
2414 The reference count for the SV is set to 1.
2423 Creates a new SV and copies a string into it. The reference count for the
2424 SV is set to 1. If C<len> is zero, Perl will compute the length using
2425 strlen(). For efficiency, consider using C<newSVpvn> instead.
2427 SV* newSVpv(const char* s, STRLEN len)
2434 Creates a new SV and initializes it with the string formatted like
2437 SV* newSVpvf(const char* pat, ...)
2444 Creates a new SV and copies a string into it. The reference count for the
2445 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
2446 string. You are responsible for ensuring that the source string is at least
2449 SV* newSVpvn(const char* s, STRLEN len)
2454 =item newSVpvn_share
2456 Creates a new SV with its SvPVX pointing to a shared string in the string
2457 table. If the string does not already exist in the table, it is created
2458 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
2459 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
2460 otherwise the hash is computed. The idea here is that as the string table
2461 is used for shared hash keys these strings will have SvPVX == HeKEY and
2462 hash lookup will avoid string compare.
2464 SV* newSVpvn_share(const char* s, I32 len, U32 hash)
2471 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
2472 it will be upgraded to one. If C<classname> is non-null then the new SV will
2473 be blessed in the specified package. The new SV is returned and its
2474 reference count is 1.
2476 SV* newSVrv(SV* rv, const char* classname)
2483 Creates a new SV which is an exact duplicate of the original SV.
2486 SV* newSVsv(SV* old)
2493 Creates a new SV and copies an unsigned integer into it.
2494 The reference count for the SV is set to 1.
2503 Returns a new version object based on the passed in SV:
2505 SV *sv = new_version(SV *ver);
2507 Does not alter the passed in ver SV. See "upg_version" if you
2508 want to upgrade the SV.
2510 SV* new_version(SV *ver)
2513 Found in file util.c
2517 Returns a pointer to the next character after the parsed
2518 version string, as well as upgrading the passed in SV to
2521 Function must be called with an already existing SV like
2524 s = scan_version(s,sv);
2526 Performs some preprocessing to the string to ensure that
2527 it has the correct characteristics of a version. Flags the
2528 object if it contains an underscore (which denotes this
2531 char* scan_version(char *vstr, SV *sv)
2534 Found in file util.c
2538 Returns a pointer to the next character after the parsed
2539 vstring, as well as updating the passed in sv.
2541 Function must be called like
2544 s = scan_vstring(s,sv);
2546 The sv should already be large enough to store the vstring
2547 passed in, for performance reasons.
2549 char* scan_vstring(char *vstr, SV *sv)
2552 Found in file util.c
2556 Returns the length of the string which is in the SV. See C<SvLEN>.
2558 STRLEN SvCUR(SV* sv)
2565 Set the length of the string which is in the SV. See C<SvCUR>.
2567 void SvCUR_set(SV* sv, STRLEN len)
2574 Returns a pointer to the last character in the string which is in the SV.
2575 See C<SvCUR>. Access the character as *(SvEND(sv)).
2584 Expands the character buffer in the SV so that it has room for the
2585 indicated number of bytes (remember to reserve space for an extra trailing
2586 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
2587 Returns a pointer to the character buffer.
2589 char * SvGROW(SV* sv, STRLEN len)
2596 Returns a boolean indicating whether the SV contains an integer.
2605 Returns a boolean indicating whether the SV contains an integer. Checks
2606 the B<private> setting. Use C<SvIOK>.
2615 Returns a boolean indicating whether the SV contains a signed integer.
2617 void SvIOK_notUV(SV* sv)
2624 Unsets the IV status of an SV.
2626 void SvIOK_off(SV* sv)
2633 Tells an SV that it is an integer.
2635 void SvIOK_on(SV* sv)
2642 Tells an SV that it is an integer and disables all other OK bits.
2644 void SvIOK_only(SV* sv)
2651 Tells and SV that it is an unsigned integer and disables all other OK bits.
2653 void SvIOK_only_UV(SV* sv)
2660 Returns a boolean indicating whether the SV contains an unsigned integer.
2662 void SvIOK_UV(SV* sv)
2669 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
2670 version which guarantees to evaluate sv only once.
2679 Coerces the given SV to an integer and returns it. Guarantees to evaluate
2680 sv only once. Use the more efficient C<SvIV> otherwise.
2689 Returns the raw value in the SV's IV slot, without checks or conversions.
2690 Only use when you are sure SvIOK is true. See also C<SvIV()>.
2699 Returns the size of the string buffer in the SV, not including any part
2700 attributable to C<SvOOK>. See C<SvCUR>.
2702 STRLEN SvLEN(SV* sv)
2709 Returns a boolean indicating whether the SV contains a number, integer or
2719 Returns a boolean indicating whether the SV contains a number, integer or
2720 double. Checks the B<private> setting. Use C<SvNIOK>.
2722 bool SvNIOKp(SV* sv)
2729 Unsets the NV/IV status of an SV.
2731 void SvNIOK_off(SV* sv)
2738 Returns a boolean indicating whether the SV contains a double.
2747 Returns a boolean indicating whether the SV contains a double. Checks the
2748 B<private> setting. Use C<SvNOK>.
2757 Unsets the NV status of an SV.
2759 void SvNOK_off(SV* sv)
2766 Tells an SV that it is a double.
2768 void SvNOK_on(SV* sv)
2775 Tells an SV that it is a double and disables all other OK bits.
2777 void SvNOK_only(SV* sv)
2784 Coerce the given SV to a double and return it. See C<SvNVx> for a version
2785 which guarantees to evaluate sv only once.
2794 Returns the raw value in the SV's NV slot, without checks or conversions.
2795 Only use when you are sure SvNOK is true. See also C<SvNV()>.
2804 Coerces the given SV to a double and returns it. Guarantees to evaluate
2805 sv only once. Use the more efficient C<SvNV> otherwise.
2814 Returns a boolean indicating whether the value is an SV.
2823 Returns a boolean indicating whether the SvIVX is a valid offset value for
2824 the SvPVX. This hack is used internally to speed up removal of characters
2825 from the beginning of a SvPV. When SvOOK is true, then the start of the
2826 allocated string buffer is really (SvPVX - SvIVX).
2835 Returns a boolean indicating whether the SV contains a character
2845 Returns a boolean indicating whether the SV contains a character string.
2846 Checks the B<private> setting. Use C<SvPOK>.
2855 Unsets the PV status of an SV.
2857 void SvPOK_off(SV* sv)
2864 Tells an SV that it is a string.
2866 void SvPOK_on(SV* sv)
2873 Tells an SV that it is a string and disables all other OK bits.
2874 Will also turn off the UTF8 status.
2876 void SvPOK_only(SV* sv)
2881 =item SvPOK_only_UTF8
2883 Tells an SV that it is a string and disables all other OK bits,
2884 and leaves the UTF8 status as it was.
2886 void SvPOK_only_UTF8(SV* sv)
2893 Returns a pointer to the string in the SV, or a stringified form of
2894 the SV if the SV does not contain a string. The SV may cache the
2895 stringified version becoming C<SvPOK>. Handles 'get' magic. See also
2896 C<SvPVx> for a version which guarantees to evaluate sv only once.
2898 char* SvPV(SV* sv, STRLEN len)
2905 Like C<SvPV>, but converts sv to byte representation first if necessary.
2907 char* SvPVbyte(SV* sv, STRLEN len)
2914 Like C<SvPV>, but converts sv to byte representation first if necessary.
2915 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
2919 char* SvPVbytex(SV* sv, STRLEN len)
2924 =item SvPVbytex_force
2926 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
2927 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
2930 char* SvPVbytex_force(SV* sv, STRLEN len)
2935 =item SvPVbyte_force
2937 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
2939 char* SvPVbyte_force(SV* sv, STRLEN len)
2944 =item SvPVbyte_nolen
2946 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
2948 char* SvPVbyte_nolen(SV* sv)
2955 Like C<SvPV>, but converts sv to utf8 first if necessary.
2957 char* SvPVutf8(SV* sv, STRLEN len)
2964 Like C<SvPV>, but converts sv to utf8 first if necessary.
2965 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
2968 char* SvPVutf8x(SV* sv, STRLEN len)
2973 =item SvPVutf8x_force
2975 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
2976 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
2979 char* SvPVutf8x_force(SV* sv, STRLEN len)
2984 =item SvPVutf8_force
2986 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
2988 char* SvPVutf8_force(SV* sv, STRLEN len)
2993 =item SvPVutf8_nolen
2995 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
2997 char* SvPVutf8_nolen(SV* sv)
3004 A version of C<SvPV> which guarantees to evaluate sv only once.
3006 char* SvPVx(SV* sv, STRLEN len)
3013 Returns a pointer to the physical string in the SV. The SV must contain a
3023 Like C<SvPV> but will force the SV into containing just a string
3024 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
3027 char* SvPV_force(SV* sv, STRLEN len)
3032 =item SvPV_force_nomg
3034 Like C<SvPV> but will force the SV into containing just a string
3035 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
3036 directly. Doesn't process magic.
3038 char* SvPV_force_nomg(SV* sv, STRLEN len)
3045 Returns a pointer to the string in the SV, or a stringified form of
3046 the SV if the SV does not contain a string. The SV may cache the
3047 stringified form becoming C<SvPOK>. Handles 'get' magic.
3049 char* SvPV_nolen(SV* sv)
3056 Returns the value of the object's reference count.
3058 U32 SvREFCNT(SV* sv)
3065 Decrements the reference count of the given SV.
3067 void SvREFCNT_dec(SV* sv)
3074 Increments the reference count of the given SV.
3076 SV* SvREFCNT_inc(SV* sv)
3083 Tests if the SV is an RV.
3092 Unsets the RV status of an SV.
3094 void SvROK_off(SV* sv)
3101 Tells an SV that it is an RV.
3103 void SvROK_on(SV* sv)
3110 Dereferences an RV to return the SV.
3119 Returns the stash of the SV.
3128 Taints an SV if tainting is enabled
3130 void SvTAINT(SV* sv)
3137 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
3140 bool SvTAINTED(SV* sv)
3147 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
3148 some of Perl's fundamental security features. XS module authors should not
3149 use this function unless they fully understand all the implications of
3150 unconditionally untainting the value. Untainting should be done in the
3151 standard perl fashion, via a carefully crafted regexp, rather than directly
3152 untainting variables.
3154 void SvTAINTED_off(SV* sv)
3161 Marks an SV as tainted.
3163 void SvTAINTED_on(SV* sv)
3170 Returns a boolean indicating whether Perl would evaluate the SV as true or
3171 false, defined or undefined. Does not handle 'get' magic.
3180 Returns the type of the SV. See C<svtype>.
3182 svtype SvTYPE(SV* sv)
3189 Releases a mutual exclusion lock on sv if a suitable module
3193 void SvUNLOCK(SV* sv)
3200 Returns a boolean indicating whether the SV contains an unsigned integer.
3209 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
3210 perform the upgrade if necessary. See C<svtype>.
3212 void SvUPGRADE(SV* sv, svtype type)
3219 Returns a boolean indicating whether the SV contains UTF-8 encoded data.
3228 Unsets the UTF8 status of an SV.
3230 void SvUTF8_off(SV *sv)
3237 Turn on the UTF8 status of an SV (the data is not changed, just the flag).
3238 Do not use frivolously.
3240 void SvUTF8_on(SV *sv)
3247 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
3248 for a version which guarantees to evaluate sv only once.
3257 Returns the raw value in the SV's UV slot, without checks or conversions.
3258 Only use when you are sure SvIOK is true. See also C<SvUV()>.
3267 Coerces the given SV to an unsigned integer and returns it. Guarantees to
3268 evaluate sv only once. Use the more efficient C<SvUV> otherwise.
3277 Returns a boolean indicating whether the SV contains a v-string.
3286 This function is only called on magical items, and is only used by
3287 sv_true() or its macro equivalent.
3289 bool sv_2bool(SV* sv)
3296 Using various gambits, try to get a CV from an SV; in addition, try if
3297 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
3299 CV* sv_2cv(SV* sv, HV** st, GV** gvp, I32 lref)
3306 Using various gambits, try to get an IO from an SV: the IO slot if its a
3307 GV; or the recursive result if we're an RV; or the IO slot of the symbol
3308 named after the PV if we're a string.
3317 Return the integer value of an SV, doing any necessary string conversion,
3318 magic etc. Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
3327 Marks an existing SV as mortal. The SV will be destroyed "soon", either
3328 by an explicit call to FREETMPS, or by an implicit call at places such as
3329 statement boundaries. See also C<sv_newmortal> and C<sv_mortalcopy>.
3331 SV* sv_2mortal(SV* sv)
3338 Return the num value of an SV, doing any necessary string or integer
3339 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
3349 Return a pointer to the byte-encoded representation of the SV, and set *lp
3350 to its length. May cause the SV to be downgraded from UTF8 as a
3353 Usually accessed via the C<SvPVbyte> macro.
3355 char* sv_2pvbyte(SV* sv, STRLEN* lp)
3360 =item sv_2pvbyte_nolen
3362 Return a pointer to the byte-encoded representation of the SV.
3363 May cause the SV to be downgraded from UTF8 as a side-effect.
3365 Usually accessed via the C<SvPVbyte_nolen> macro.
3367 char* sv_2pvbyte_nolen(SV* sv)
3374 Return a pointer to the UTF8-encoded representation of the SV, and set *lp
3375 to its length. May cause the SV to be upgraded to UTF8 as a side-effect.
3377 Usually accessed via the C<SvPVutf8> macro.
3379 char* sv_2pvutf8(SV* sv, STRLEN* lp)
3384 =item sv_2pvutf8_nolen
3386 Return a pointer to the UTF8-encoded representation of the SV.
3387 May cause the SV to be upgraded to UTF8 as a side-effect.
3389 Usually accessed via the C<SvPVutf8_nolen> macro.
3391 char* sv_2pvutf8_nolen(SV* sv)
3398 Returns a pointer to the string value of an SV, and sets *lp to its length.
3399 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
3401 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
3402 usually end up here too.
3404 char* sv_2pv_flags(SV* sv, STRLEN* lp, I32 flags)
3411 Like C<sv_2pv()>, but doesn't return the length too. You should usually
3412 use the macro wrapper C<SvPV_nolen(sv)> instead.
3413 char* sv_2pv_nolen(SV* sv)
3420 Return the unsigned integer value of an SV, doing any necessary string
3421 conversion, magic etc. Normally used via the C<SvUV(sv)> and C<SvUVx(sv)>
3431 Remove any string offset. You should normally use the C<SvOOK_off> macro
3434 int sv_backoff(SV* sv)
3441 Blesses an SV into a specified package. The SV must be an RV. The package
3442 must be designated by its stash (see C<gv_stashpv()>). The reference count
3443 of the SV is unaffected.
3445 SV* sv_bless(SV* sv, HV* stash)
3452 Concatenates the string onto the end of the string which is in the SV.
3453 If the SV has the UTF8 status set, then the bytes appended should be
3454 valid UTF8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
3456 void sv_catpv(SV* sv, const char* ptr)
3463 Processes its arguments like C<sprintf> and appends the formatted
3464 output to an SV. If the appended data contains "wide" characters
3465 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
3466 and characters >255 formatted with %c), the original SV might get
3467 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic.
3468 C<SvSETMAGIC()> must typically be called after calling this function
3469 to handle 'set' magic.
3471 void sv_catpvf(SV* sv, const char* pat, ...)
3478 Like C<sv_catpvf>, but also handles 'set' magic.
3480 void sv_catpvf_mg(SV *sv, const char* pat, ...)
3487 Concatenates the string onto the end of the string which is in the SV. The
3488 C<len> indicates number of bytes to copy. If the SV has the UTF8
3489 status set, then the bytes appended should be valid UTF8.
3490 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
3492 void sv_catpvn(SV* sv, const char* ptr, STRLEN len)
3497 =item sv_catpvn_flags
3499 Concatenates the string onto the end of the string which is in the SV. The
3500 C<len> indicates number of bytes to copy. If the SV has the UTF8
3501 status set, then the bytes appended should be valid UTF8.
3502 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
3503 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
3504 in terms of this function.
3506 void sv_catpvn_flags(SV* sv, const char* ptr, STRLEN len, I32 flags)
3513 Like C<sv_catpvn>, but also handles 'set' magic.
3515 void sv_catpvn_mg(SV *sv, const char *ptr, STRLEN len)
3522 Like C<sv_catpv>, but also handles 'set' magic.
3524 void sv_catpv_mg(SV *sv, const char *ptr)
3531 Concatenates the string from SV C<ssv> onto the end of the string in
3532 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
3533 not 'set' magic. See C<sv_catsv_mg>.
3535 void sv_catsv(SV* dsv, SV* ssv)
3540 =item sv_catsv_flags
3542 Concatenates the string from SV C<ssv> onto the end of the string in
3543 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
3544 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
3545 and C<sv_catsv_nomg> are implemented in terms of this function.
3547 void sv_catsv_flags(SV* dsv, SV* ssv, I32 flags)
3554 Like C<sv_catsv>, but also handles 'set' magic.
3556 void sv_catsv_mg(SV *dstr, SV *sstr)
3563 Efficient removal of characters from the beginning of the string buffer.
3564 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
3565 the string buffer. The C<ptr> becomes the first character of the adjusted
3566 string. Uses the "OOK hack".
3568 void sv_chop(SV* sv, char* ptr)
3575 Clear an SV: call any destructors, free up any memory used by the body,
3576 and free the body itself. The SV's head is I<not> freed, although
3577 its type is set to all 1's so that it won't inadvertently be assumed
3578 to be live during global destruction etc.
3579 This function should only be called when REFCNT is zero. Most of the time
3580 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
3583 void sv_clear(SV* sv)
3590 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
3591 string in C<sv1> is less than, equal to, or greater than the string in
3592 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
3593 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
3595 I32 sv_cmp(SV* sv1, SV* sv2)
3602 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
3603 'use bytes' aware, handles get magic, and will coerce its args to strings
3604 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
3606 I32 sv_cmp_locale(SV* sv1, SV* sv2)
3613 Add Collate Transform magic to an SV if it doesn't already have it.
3615 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
3616 scalar data of the variable, but transformed to such a format that a normal
3617 memory comparison can be used to compare the data according to the locale
3620 char* sv_collxfrm(SV* sv, STRLEN* nxp)
3627 Copies a stringified representation of the source SV into the
3628 destination SV. Automatically performs any necessary mg_get and
3629 coercion of numeric values into strings. Guaranteed to preserve
3630 UTF-8 flag even from overloaded objects. Similar in nature to
3631 sv_2pv[_flags] but operates directly on an SV instead of just the
3632 string. Mostly uses sv_2pv_flags to do its work, except when that
3633 would lose the UTF-8'ness of the PV.
3635 void sv_copypv(SV* dsv, SV* ssv)
3642 Auto-decrement of the value in the SV, doing string to numeric conversion
3643 if necessary. Handles 'get' magic.
3650 =item sv_derived_from
3652 Returns a boolean indicating whether the SV is derived from the specified
3653 class. This is the function that implements C<UNIVERSAL::isa>. It works
3654 for class names as well as for objects.
3656 bool sv_derived_from(SV* sv, const char* name)
3659 Found in file universal.c
3663 Returns a boolean indicating whether the strings in the two SVs are
3664 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
3665 coerce its args to strings if necessary.
3667 I32 sv_eq(SV* sv1, SV* sv2)
3672 =item sv_force_normal
3674 Undo various types of fakery on an SV: if the PV is a shared string, make
3675 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3676 an xpvmg. See also C<sv_force_normal_flags>.
3678 void sv_force_normal(SV *sv)
3683 =item sv_force_normal_flags
3685 Undo various types of fakery on an SV: if the PV is a shared string, make
3686 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3687 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
3688 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
3689 then a copy-on-write scalar drops its PV buffer (if any) and becomes
3690 SvPOK_off rather than making a copy. (Used where this scalar is about to be
3691 set to some other value. In addtion, the C<flags> parameter gets passed to
3692 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
3693 with flags set to 0.
3695 void sv_force_normal_flags(SV *sv, U32 flags)
3702 Decrement an SV's reference count, and if it drops to zero, call
3703 C<sv_clear> to invoke destructors and free up any memory used by
3704 the body; finally, deallocate the SV's head itself.
3705 Normally called via a wrapper macro C<SvREFCNT_dec>.
3707 void sv_free(SV* sv)
3714 Get a line from the filehandle and store it into the SV, optionally
3715 appending to the currently-stored string.
3717 char* sv_gets(SV* sv, PerlIO* fp, I32 append)
3724 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
3725 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
3726 Use the C<SvGROW> wrapper instead.
3728 char* sv_grow(SV* sv, STRLEN newlen)
3735 Auto-increment of the value in the SV, doing string to numeric conversion
3736 if necessary. Handles 'get' magic.
3745 Inserts a string at the specified offset/length within the SV. Similar to
3746 the Perl substr() function.
3748 void sv_insert(SV* bigsv, STRLEN offset, STRLEN len, char* little, STRLEN littlelen)
3755 Returns a boolean indicating whether the SV is blessed into the specified
3756 class. This does not check for subtypes; use C<sv_derived_from> to verify
3757 an inheritance relationship.
3759 int sv_isa(SV* sv, const char* name)
3766 Returns a boolean indicating whether the SV is an RV pointing to a blessed
3767 object. If the SV is not an RV, or if the object is not blessed, then this
3770 int sv_isobject(SV* sv)
3777 A private implementation of the C<SvIVx> macro for compilers which can't
3778 cope with complex macro expressions. Always use the macro instead.
3787 Returns the length of the string in the SV. Handles magic and type
3788 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
3790 STRLEN sv_len(SV* sv)
3797 Returns the number of characters in the string in an SV, counting wide
3798 UTF8 bytes as a single character. Handles magic and type coercion.
3800 STRLEN sv_len_utf8(SV* sv)
3807 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
3808 then adds a new magic item of type C<how> to the head of the magic list.
3810 void sv_magic(SV* sv, SV* obj, int how, const char* name, I32 namlen)
3817 Adds magic to an SV, upgrading it if necessary. Applies the
3818 supplied vtable and returns pointer to the magic added.
3820 Note that sv_magicext will allow things that sv_magic will not.
3821 In particular you can add magic to SvREADONLY SVs and and more than
3822 one instance of the same 'how'
3824 I C<namelen> is greater then zero then a savepvn() I<copy> of C<name> is stored,
3825 if C<namelen> is zero then C<name> is stored as-is and - as another special
3826 case - if C<(name && namelen == HEf_SVKEY)> then C<name> is assumed to contain
3827 an C<SV*> and has its REFCNT incremented
3829 (This is now used as a subroutine by sv_magic.)
3831 MAGIC * sv_magicext(SV* sv, SV* obj, int how, MGVTBL *vtbl, const char* name, I32 namlen )
3838 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
3839 The new SV is marked as mortal. It will be destroyed "soon", either by an
3840 explicit call to FREETMPS, or by an implicit call at places such as
3841 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
3843 SV* sv_mortalcopy(SV* oldsv)
3850 Creates a new null SV which is mortal. The reference count of the SV is
3851 set to 1. It will be destroyed "soon", either by an explicit call to
3852 FREETMPS, or by an implicit call at places such as statement boundaries.
3853 See also C<sv_mortalcopy> and C<sv_2mortal>.
3862 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
3865 SV* sv_newref(SV* sv)
3872 Dummy routine which "locks" an SV when there is no locking module present.
3873 Exists to avoid test for a NULL function pointer and because it could potentially warn under
3874 some level of strict-ness.
3876 void sv_nolocking(SV *)
3879 Found in file util.c
3883 Dummy routine which "shares" an SV when there is no sharing module present.
3884 Exists to avoid test for a NULL function pointer and because it could potentially warn under
3885 some level of strict-ness.
3887 void sv_nosharing(SV *)
3890 Found in file util.c
3892 =item sv_nounlocking
3894 Dummy routine which "unlocks" an SV when there is no locking module present.
3895 Exists to avoid test for a NULL function pointer and because it could potentially warn under
3896 some level of strict-ness.
3898 void sv_nounlocking(SV *)
3901 Found in file util.c
3905 A private implementation of the C<SvNVx> macro for compilers which can't
3906 cope with complex macro expressions. Always use the macro instead.
3915 Converts the value pointed to by offsetp from a count of bytes from the
3916 start of the string, to a count of the equivalent number of UTF8 chars.
3917 Handles magic and type coercion.
3919 void sv_pos_b2u(SV* sv, I32* offsetp)
3926 Converts the value pointed to by offsetp from a count of UTF8 chars from
3927 the start of the string, to a count of the equivalent number of bytes; if
3928 lenp is non-zero, it does the same to lenp, but this time starting from
3929 the offset, rather than from the start of the string. Handles magic and
3932 void sv_pos_u2b(SV* sv, I32* offsetp, I32* lenp)
3939 Use the C<SvPV_nolen> macro instead
3948 Use C<SvPVbyte_nolen> instead.
3950 char* sv_pvbyte(SV *sv)
3957 A private implementation of the C<SvPVbyte> macro for compilers
3958 which can't cope with complex macro expressions. Always use the macro
3961 char* sv_pvbyten(SV *sv, STRLEN *len)
3966 =item sv_pvbyten_force
3968 A private implementation of the C<SvPVbytex_force> macro for compilers
3969 which can't cope with complex macro expressions. Always use the macro
3972 char* sv_pvbyten_force(SV* sv, STRLEN* lp)
3979 A private implementation of the C<SvPV> macro for compilers which can't
3980 cope with complex macro expressions. Always use the macro instead.
3982 char* sv_pvn(SV *sv, STRLEN *len)
3989 Get a sensible string out of the SV somehow.
3990 A private implementation of the C<SvPV_force> macro for compilers which
3991 can't cope with complex macro expressions. Always use the macro instead.
3993 char* sv_pvn_force(SV* sv, STRLEN* lp)
3998 =item sv_pvn_force_flags
4000 Get a sensible string out of the SV somehow.
4001 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
4002 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
4003 implemented in terms of this function.
4004 You normally want to use the various wrapper macros instead: see
4005 C<SvPV_force> and C<SvPV_force_nomg>
4007 char* sv_pvn_force_flags(SV* sv, STRLEN* lp, I32 flags)
4014 Use the C<SvPVutf8_nolen> macro instead
4016 char* sv_pvutf8(SV *sv)
4023 A private implementation of the C<SvPVutf8> macro for compilers
4024 which can't cope with complex macro expressions. Always use the macro
4027 char* sv_pvutf8n(SV *sv, STRLEN *len)
4032 =item sv_pvutf8n_force
4034 A private implementation of the C<SvPVutf8_force> macro for compilers
4035 which can't cope with complex macro expressions. Always use the macro
4038 char* sv_pvutf8n_force(SV* sv, STRLEN* lp)
4045 Returns a string describing what the SV is a reference to.
4047 char* sv_reftype(SV* sv, int ob)
4054 Make the first argument a copy of the second, then delete the original.
4055 The target SV physically takes over ownership of the body of the source SV
4056 and inherits its flags; however, the target keeps any magic it owns,
4057 and any magic in the source is discarded.
4058 Note that this is a rather specialist SV copying operation; most of the
4059 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4061 void sv_replace(SV* sv, SV* nsv)
4066 =item sv_report_used
4068 Dump the contents of all SVs not yet freed. (Debugging aid).
4070 void sv_report_used()
4077 Underlying implementation for the C<reset> Perl function.
4078 Note that the perl-level function is vaguely deprecated.
4080 void sv_reset(char* s, HV* stash)
4087 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4088 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4089 push a back-reference to this RV onto the array of backreferences
4090 associated with that magic.
4092 SV* sv_rvweaken(SV *sv)
4099 Copies an integer into the given SV, upgrading first if necessary.
4100 Does not handle 'set' magic. See also C<sv_setiv_mg>.
4102 void sv_setiv(SV* sv, IV num)
4109 Like C<sv_setiv>, but also handles 'set' magic.
4111 void sv_setiv_mg(SV *sv, IV i)
4118 Copies a double into the given SV, upgrading first if necessary.
4119 Does not handle 'set' magic. See also C<sv_setnv_mg>.
4121 void sv_setnv(SV* sv, NV num)
4128 Like C<sv_setnv>, but also handles 'set' magic.
4130 void sv_setnv_mg(SV *sv, NV num)
4137 Copies a string into an SV. The string must be null-terminated. Does not
4138 handle 'set' magic. See C<sv_setpv_mg>.
4140 void sv_setpv(SV* sv, const char* ptr)
4147 Processes its arguments like C<sprintf> and sets an SV to the formatted
4148 output. Does not handle 'set' magic. See C<sv_setpvf_mg>.
4150 void sv_setpvf(SV* sv, const char* pat, ...)
4157 Like C<sv_setpvf>, but also handles 'set' magic.
4159 void sv_setpvf_mg(SV *sv, const char* pat, ...)
4166 Copies a string into an SV. The C<len> parameter indicates the number of
4167 bytes to be copied. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4169 void sv_setpvn(SV* sv, const char* ptr, STRLEN len)
4176 Like C<sv_setpvn>, but also handles 'set' magic.
4178 void sv_setpvn_mg(SV *sv, const char *ptr, STRLEN len)
4185 Like C<sv_setpv>, but also handles 'set' magic.
4187 void sv_setpv_mg(SV *sv, const char *ptr)
4194 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
4195 argument will be upgraded to an RV. That RV will be modified to point to
4196 the new SV. The C<classname> argument indicates the package for the
4197 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4198 will be returned and will have a reference count of 1.
4200 SV* sv_setref_iv(SV* rv, const char* classname, IV iv)
4207 Copies a double into a new SV, optionally blessing the SV. The C<rv>
4208 argument will be upgraded to an RV. That RV will be modified to point to
4209 the new SV. The C<classname> argument indicates the package for the
4210 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4211 will be returned and will have a reference count of 1.
4213 SV* sv_setref_nv(SV* rv, const char* classname, NV nv)
4220 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
4221 argument will be upgraded to an RV. That RV will be modified to point to
4222 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
4223 into the SV. The C<classname> argument indicates the package for the
4224 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4225 will be returned and will have a reference count of 1.
4227 Do not use with other Perl types such as HV, AV, SV, CV, because those
4228 objects will become corrupted by the pointer copy process.
4230 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
4232 SV* sv_setref_pv(SV* rv, const char* classname, void* pv)
4239 Copies a string into a new SV, optionally blessing the SV. The length of the
4240 string must be specified with C<n>. The C<rv> argument will be upgraded to
4241 an RV. That RV will be modified to point to the new SV. The C<classname>
4242 argument indicates the package for the blessing. Set C<classname> to
4243 C<Nullch> to avoid the blessing. The new SV will be returned and will have
4244 a reference count of 1.
4246 Note that C<sv_setref_pv> copies the pointer while this copies the string.
4248 SV* sv_setref_pvn(SV* rv, const char* classname, char* pv, STRLEN n)
4255 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
4256 argument will be upgraded to an RV. That RV will be modified to point to
4257 the new SV. The C<classname> argument indicates the package for the
4258 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4259 will be returned and will have a reference count of 1.
4261 SV* sv_setref_uv(SV* rv, const char* classname, UV uv)
4268 Copies the contents of the source SV C<ssv> into the destination SV
4269 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4270 function if the source SV needs to be reused. Does not handle 'set' magic.
4271 Loosely speaking, it performs a copy-by-value, obliterating any previous
4272 content of the destination.
4274 You probably want to use one of the assortment of wrappers, such as
4275 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4276 C<SvSetMagicSV_nosteal>.
4278 void sv_setsv(SV* dsv, SV* ssv)
4283 =item sv_setsv_flags
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.
4290 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
4291 C<ssv> if appropriate, else not. C<sv_setsv> and C<sv_setsv_nomg> are
4292 implemented in terms of this function.
4294 You probably want to use one of the assortment of wrappers, such as
4295 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4296 C<SvSetMagicSV_nosteal>.
4298 This is the primary function for copying scalars, and most other
4299 copy-ish functions and macros use this underneath.
4301 void sv_setsv_flags(SV* dsv, SV* ssv, I32 flags)
4308 Like C<sv_setsv>, but also handles 'set' magic.
4310 void sv_setsv_mg(SV *dstr, SV *sstr)
4317 Copies an unsigned integer into the given SV, upgrading first if necessary.
4318 Does not handle 'set' magic. See also C<sv_setuv_mg>.
4320 void sv_setuv(SV* sv, UV num)
4327 Like C<sv_setuv>, but also handles 'set' magic.
4329 void sv_setuv_mg(SV *sv, UV u)
4336 Taint an SV. Use C<SvTAINTED_on> instead.
4337 void sv_taint(SV* sv)
4344 Test an SV for taintedness. Use C<SvTAINTED> instead.
4345 bool sv_tainted(SV* sv)
4352 Returns true if the SV has a true value by Perl's rules.
4353 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
4354 instead use an in-line version.
4363 Removes all magic of type C<type> from an SV.
4365 int sv_unmagic(SV* sv, int type)
4372 Unsets the RV status of the SV, and decrements the reference count of
4373 whatever was being referenced by the RV. This can almost be thought of
4374 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
4375 being zero. See C<SvROK_off>.
4377 void sv_unref(SV* sv)
4382 =item sv_unref_flags
4384 Unsets the RV status of the SV, and decrements the reference count of
4385 whatever was being referenced by the RV. This can almost be thought of
4386 as a reversal of C<newSVrv>. The C<cflags> argument can contain
4387 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
4388 (otherwise the decrementing is conditional on the reference count being
4389 different from one or the reference being a readonly SV).
4392 void sv_unref_flags(SV* sv, U32 flags)
4399 Untaint an SV. Use C<SvTAINTED_off> instead.
4400 void sv_untaint(SV* sv)
4407 Upgrade an SV to a more complex form. Generally adds a new body type to the
4408 SV, then copies across as much information as possible from the old body.
4409 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
4411 bool sv_upgrade(SV* sv, U32 mt)
4418 Tells an SV to use C<ptr> to find its string value. Normally the string is
4419 stored inside the SV but sv_usepvn allows the SV to use an outside string.
4420 The C<ptr> should point to memory that was allocated by C<malloc>. The
4421 string length, C<len>, must be supplied. This function will realloc the
4422 memory pointed to by C<ptr>, so that pointer should not be freed or used by
4423 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
4424 See C<sv_usepvn_mg>.
4426 void sv_usepvn(SV* sv, char* ptr, STRLEN len)
4433 Like C<sv_usepvn>, but also handles 'set' magic.
4435 void sv_usepvn_mg(SV *sv, char *ptr, STRLEN len)
4440 =item sv_utf8_decode
4442 Convert the octets in the PV from UTF-8 to chars. Scan for validity and then
4443 turn off SvUTF8 if needed so that we see characters. Used as a building block
4444 for decode_utf8 in Encode.xs
4446 NOTE: this function is experimental and may change or be
4447 removed without notice.
4449 bool sv_utf8_decode(SV *sv)
4454 =item sv_utf8_downgrade
4456 Attempt to convert the PV of an SV from UTF8-encoded to byte encoding.
4457 This may not be possible if the PV contains non-byte encoding characters;
4458 if this is the case, either returns false or, if C<fail_ok> is not
4461 This is not as a general purpose Unicode to byte encoding interface:
4462 use the Encode extension for that.
4464 NOTE: this function is experimental and may change or be
4465 removed without notice.
4467 bool sv_utf8_downgrade(SV *sv, bool fail_ok)
4472 =item sv_utf8_encode
4474 Convert the PV of an SV to UTF8-encoded, but then turn off the C<SvUTF8>
4475 flag so that it looks like octets again. Used as a building block
4476 for encode_utf8 in Encode.xs
4478 void sv_utf8_encode(SV *sv)
4483 =item sv_utf8_upgrade
4485 Convert the PV of an SV to its UTF8-encoded form.
4486 Forces the SV to string form if it is not already.
4487 Always sets the SvUTF8 flag to avoid future validity checks even
4488 if all the bytes have hibit clear.
4490 This is not as a general purpose byte encoding to Unicode interface:
4491 use the Encode extension for that.
4493 STRLEN sv_utf8_upgrade(SV *sv)
4498 =item sv_utf8_upgrade_flags
4500 Convert the PV of an SV to its UTF8-encoded form.
4501 Forces the SV to string form if it is not already.
4502 Always sets the SvUTF8 flag to avoid future validity checks even
4503 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
4504 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
4505 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
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_flags(SV *sv, I32 flags)
4517 A private implementation of the C<SvUVx> macro for compilers which can't
4518 cope with complex macro expressions. Always use the macro instead.
4527 Processes its arguments like C<vsprintf> and appends the formatted output
4528 to an SV. Uses an array of SVs if the C style variable argument list is
4529 missing (NULL). When running with taint checks enabled, indicates via
4530 C<maybe_tainted> if results are untrustworthy (often due to the use of
4533 Usually used via one of its frontends C<sv_catpvf> and C<sv_catpvf_mg>.
4535 void sv_vcatpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
4542 Works like C<vcatpvfn> but copies the text into the SV instead of
4545 Usually used via one of its frontends C<sv_setpvf> and C<sv_setpvf_mg>.
4547 void sv_vsetpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
4554 In-place upgrade of the supplied SV to a version object.
4556 SV *sv = upg_version(SV *sv);
4558 Returns a pointer to the upgraded SV.
4560 SV* upg_version(SV *ver)
4563 Found in file util.c
4567 Accepts a version (or vstring) object and returns the
4568 normalized floating point representation. Call like:
4570 sv = vnumify(sv,SvRV(rv));
4572 NOTE: no checking is done to see if the object is of the
4573 correct type (for speed).
4575 SV* vnumify(SV *sv, SV *vs)
4578 Found in file util.c
4582 Accepts a version (or vstring) object and returns the
4583 normalized representation. Call like:
4585 sv = vstringify(sv,SvRV(rv));
4587 NOTE: no checking is done to see if the object is of the
4588 correct type (for speed).
4590 SV* vstringify(SV *sv, SV *vs)
4593 Found in file util.c
4598 =head1 Unicode Support
4602 =item bytes_from_utf8
4604 Converts a string C<s> of length C<len> from UTF8 into byte encoding.
4605 Unlike <utf8_to_bytes> but like C<bytes_to_utf8>, returns a pointer to
4606 the newly-created string, and updates C<len> to contain the new
4607 length. Returns the original string if no conversion occurs, C<len>
4608 is unchanged. Do nothing if C<is_utf8> points to 0. Sets C<is_utf8> to
4609 0 if C<s> is converted or contains all 7bit characters.
4611 NOTE: this function is experimental and may change or be
4612 removed without notice.
4614 U8* bytes_from_utf8(U8 *s, STRLEN *len, bool *is_utf8)
4617 Found in file utf8.c
4621 Converts a string C<s> of length C<len> from ASCII into UTF8 encoding.
4622 Returns a pointer to the newly-created string, and sets C<len> to
4623 reflect the new length.
4625 NOTE: this function is experimental and may change or be
4626 removed without notice.
4628 U8* bytes_to_utf8(U8 *s, STRLEN *len)
4631 Found in file utf8.c
4635 Return true if the strings s1 and s2 differ case-insensitively, false
4636 if not (if they are equal case-insensitively). If u1 is true, the
4637 string s1 is assumed to be in UTF-8-encoded Unicode. If u2 is true,
4638 the string s2 is assumed to be in UTF-8-encoded Unicode. If u1 or u2
4639 are false, the respective string is assumed to be in native 8-bit
4642 If the pe1 and pe2 are non-NULL, the scanning pointers will be copied
4643 in there (they will point at the beginning of the I<next> character).
4644 If the pointers behind pe1 or pe2 are non-NULL, they are the end
4645 pointers beyond which scanning will not continue under any
4646 circustances. If the byte lengths l1 and l2 are non-zero, s1+l1 and
4647 s2+l2 will be used as goal end pointers that will also stop the scan,
4648 and which qualify towards defining a successful match: all the scans
4649 that define an explicit length must reach their goal pointers for
4650 a match to succeed).
4652 For case-insensitiveness, the "casefolding" of Unicode is used
4653 instead of upper/lowercasing both the characters, see
4654 http://www.unicode.org/unicode/reports/tr21/ (Case Mappings).
4656 I32 ibcmp_utf8(const char* a, char **pe1, UV l1, bool u1, const char* b, char **pe2, UV l2, bool u2)
4659 Found in file utf8.c
4663 Tests if some arbitrary number of bytes begins in a valid UTF-8
4664 character. Note that an INVARIANT (i.e. ASCII) character is a valid
4665 UTF-8 character. The actual number of bytes in the UTF-8 character
4666 will be returned if it is valid, otherwise 0.
4668 STRLEN is_utf8_char(U8 *p)
4671 Found in file utf8.c
4673 =item is_utf8_string
4675 Returns true if first C<len> bytes of the given string form a valid UTF8
4676 string, false otherwise. Note that 'a valid UTF8 string' does not mean
4677 'a string that contains UTF8' because a valid ASCII string is a valid
4680 bool is_utf8_string(U8 *s, STRLEN len)
4683 Found in file utf8.c
4685 =item pv_uni_display
4687 Build to the scalar dsv a displayable version of the string spv,
4688 length len, the displayable version being at most pvlim bytes long
4689 (if longer, the rest is truncated and "..." will be appended).
4691 The flags argument can have UNI_DISPLAY_ISPRINT set to display
4692 isPRINT()able characters as themselves, UNI_DISPLAY_BACKSLASH
4693 to display the \\[nrfta\\] as the backslashed versions (like '\n')
4694 (UNI_DISPLAY_BACKSLASH is preferred over UNI_DISPLAY_ISPRINT for \\).
4695 UNI_DISPLAY_QQ (and its alias UNI_DISPLAY_REGEX) have both
4696 UNI_DISPLAY_BACKSLASH and UNI_DISPLAY_ISPRINT turned on.
4698 The pointer to the PV of the dsv is returned.
4700 char* pv_uni_display(SV *dsv, U8 *spv, STRLEN len, STRLEN pvlim, UV flags)
4703 Found in file utf8.c
4705 =item sv_recode_to_utf8
4707 The encoding is assumed to be an Encode object, on entry the PV
4708 of the sv is assumed to be octets in that encoding, and the sv
4709 will be converted into Unicode (and UTF-8).
4711 If the sv already is UTF-8 (or if it is not POK), or if the encoding
4712 is not a reference, nothing is done to the sv. If the encoding is not
4713 an C<Encode::XS> Encoding object, bad things will happen.
4714 (See F<lib/encoding.pm> and L<Encode>).
4716 The PV of the sv is returned.
4718 char* sv_recode_to_utf8(SV* sv, SV *encoding)
4723 =item sv_uni_display
4725 Build to the scalar dsv a displayable version of the scalar sv,
4726 the displayable version being at most pvlim bytes long
4727 (if longer, the rest is truncated and "..." will be appended).
4729 The flags argument is as in pv_uni_display().
4731 The pointer to the PV of the dsv is returned.
4733 char* sv_uni_display(SV *dsv, SV *ssv, STRLEN pvlim, UV flags)
4736 Found in file utf8.c
4740 The "p" contains the pointer to the UTF-8 string encoding
4741 the character that is being converted.
4743 The "ustrp" is a pointer to the character buffer to put the
4744 conversion result to. The "lenp" is a pointer to the length
4747 The "swashp" is a pointer to the swash to use.
4749 Both the special and normal mappings are stored lib/unicore/To/Foo.pl,
4750 and loaded by SWASHGET, using lib/utf8_heavy.pl. The special (usually,
4751 but not always, a multicharacter mapping), is tried first.
4753 The "special" is a string like "utf8::ToSpecLower", which means the
4754 hash %utf8::ToSpecLower. The access to the hash is through
4755 Perl_to_utf8_case().
4757 The "normal" is a string like "ToLower" which means the swash
4760 UV to_utf8_case(U8 *p, U8* ustrp, STRLEN *lenp, SV **swash, char *normal, char *special)
4763 Found in file utf8.c
4767 Convert the UTF-8 encoded character at p to its foldcase version and
4768 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
4769 that the ustrp needs to be at least UTF8_MAXLEN_FOLD+1 bytes since the
4770 foldcase version may be longer than the original character (up to
4773 The first character of the foldcased version is returned
4774 (but note, as explained above, that there may be more.)
4776 UV to_utf8_fold(U8 *p, U8* ustrp, STRLEN *lenp)
4779 Found in file utf8.c
4783 Convert the UTF-8 encoded character at p to its lowercase version and
4784 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
4785 that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the
4786 lowercase version may be longer than the original character (up to two
4789 The first character of the lowercased version is returned
4790 (but note, as explained above, that there may be more.)
4792 UV to_utf8_lower(U8 *p, U8* ustrp, STRLEN *lenp)
4795 Found in file utf8.c
4799 Convert the UTF-8 encoded character at p to its titlecase version and
4800 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
4801 that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the
4802 titlecase version may be longer than the original character (up to two
4805 The first character of the titlecased version is returned
4806 (but note, as explained above, that there may be more.)
4808 UV to_utf8_title(U8 *p, U8* ustrp, STRLEN *lenp)
4811 Found in file utf8.c
4815 Convert the UTF-8 encoded character at p to its uppercase version and
4816 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
4817 that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the
4818 uppercase version may be longer than the original character (up to two
4821 The first character of the uppercased version is returned
4822 (but note, as explained above, that there may be more.)
4824 UV to_utf8_upper(U8 *p, U8* ustrp, STRLEN *lenp)
4827 Found in file utf8.c
4829 =item utf8n_to_uvchr
4831 Returns the native character value of the first character in the string C<s>
4832 which is assumed to be in UTF8 encoding; C<retlen> will be set to the
4833 length, in bytes, of that character.
4835 Allows length and flags to be passed to low level routine.
4837 UV utf8n_to_uvchr(U8 *s, STRLEN curlen, STRLEN* retlen, U32 flags)
4840 Found in file utf8.c
4842 =item utf8n_to_uvuni
4844 Bottom level UTF-8 decode routine.
4845 Returns the unicode code point value of the first character in the string C<s>
4846 which is assumed to be in UTF8 encoding and no longer than C<curlen>;
4847 C<retlen> will be set to the length, in bytes, of that character.
4849 If C<s> does not point to a well-formed UTF8 character, the behaviour
4850 is dependent on the value of C<flags>: if it contains UTF8_CHECK_ONLY,
4851 it is assumed that the caller will raise a warning, and this function
4852 will silently just set C<retlen> to C<-1> and return zero. If the
4853 C<flags> does not contain UTF8_CHECK_ONLY, warnings about
4854 malformations will be given, C<retlen> will be set to the expected
4855 length of the UTF-8 character in bytes, and zero will be returned.
4857 The C<flags> can also contain various flags to allow deviations from
4858 the strict UTF-8 encoding (see F<utf8.h>).
4860 Most code should use utf8_to_uvchr() rather than call this directly.
4862 UV utf8n_to_uvuni(U8 *s, STRLEN curlen, STRLEN* retlen, U32 flags)
4865 Found in file utf8.c
4869 Returns the number of UTF8 characters between the UTF-8 pointers C<a>
4872 WARNING: use only if you *know* that the pointers point inside the
4875 IV utf8_distance(U8 *a, U8 *b)
4878 Found in file utf8.c
4882 Return the UTF-8 pointer C<s> displaced by C<off> characters, either
4883 forward or backward.
4885 WARNING: do not use the following unless you *know* C<off> is within
4886 the UTF-8 data pointed to by C<s> *and* that on entry C<s> is aligned
4887 on the first byte of character or just after the last byte of a character.
4889 U8* utf8_hop(U8 *s, I32 off)
4892 Found in file utf8.c
4896 Return the length of the UTF-8 char encoded string C<s> in characters.
4897 Stops at C<e> (inclusive). If C<e E<lt> s> or if the scan would end
4898 up past C<e>, croaks.
4900 STRLEN utf8_length(U8* s, U8 *e)
4903 Found in file utf8.c
4907 Converts a string C<s> of length C<len> from UTF8 into byte encoding.
4908 Unlike C<bytes_to_utf8>, this over-writes the original string, and
4909 updates len to contain the new length.
4910 Returns zero on failure, setting C<len> to -1.
4912 NOTE: this function is experimental and may change or be
4913 removed without notice.
4915 U8* utf8_to_bytes(U8 *s, STRLEN *len)
4918 Found in file utf8.c
4922 Returns the native character value of the first character in the string C<s>
4923 which is assumed to be in UTF8 encoding; C<retlen> will be set to the
4924 length, in bytes, of that character.
4926 If C<s> does not point to a well-formed UTF8 character, zero is
4927 returned and retlen is set, if possible, to -1.
4929 UV utf8_to_uvchr(U8 *s, STRLEN* retlen)
4932 Found in file utf8.c
4936 Returns the Unicode code point of the first character in the string C<s>
4937 which is assumed to be in UTF8 encoding; C<retlen> will be set to the
4938 length, in bytes, of that character.
4940 This function should only be used when returned UV is considered
4941 an index into the Unicode semantic tables (e.g. swashes).
4943 If C<s> does not point to a well-formed UTF8 character, zero is
4944 returned and retlen is set, if possible, to -1.
4946 UV utf8_to_uvuni(U8 *s, STRLEN* retlen)
4949 Found in file utf8.c
4953 Adds the UTF8 representation of the Native codepoint C<uv> to the end
4954 of the string C<d>; C<d> should be have at least C<UTF8_MAXLEN+1> free
4955 bytes available. The return value is the pointer to the byte after the
4956 end of the new character. In other words,
4958 d = uvchr_to_utf8(d, uv);
4960 is the recommended wide native character-aware way of saying
4964 U8* uvchr_to_utf8(U8 *d, UV uv)
4967 Found in file utf8.c
4969 =item uvuni_to_utf8_flags
4971 Adds the UTF8 representation of the Unicode codepoint C<uv> to the end
4972 of the string C<d>; C<d> should be have at least C<UTF8_MAXLEN+1> free
4973 bytes available. The return value is the pointer to the byte after the
4974 end of the new character. In other words,
4976 d = uvuni_to_utf8_flags(d, uv, flags);
4980 d = uvuni_to_utf8(d, uv);
4982 (which is equivalent to)
4984 d = uvuni_to_utf8_flags(d, uv, 0);
4986 is the recommended Unicode-aware way of saying
4990 U8* uvuni_to_utf8_flags(U8 *d, UV uv, UV flags)
4993 Found in file utf8.c
4998 =head1 Variables created by C<xsubpp> and C<xsubpp> internal functions
5004 Variable which is setup by C<xsubpp> to indicate the stack base offset,
5005 used by the C<ST>, C<XSprePUSH> and C<XSRETURN> macros. The C<dMARK> macro
5006 must be called prior to setup the C<MARK> variable.
5011 Found in file XSUB.h
5015 Variable which is setup by C<xsubpp> to indicate the
5016 class name for a C++ XS constructor. This is always a C<char*>. See C<THIS>.
5021 Found in file XSUB.h
5025 Sets up the C<ax> variable.
5026 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
5031 Found in file XSUB.h
5035 Sets up the C<items> variable.
5036 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
5041 Found in file XSUB.h
5045 Sets up stack and mark pointers for an XSUB, calling dSP and dMARK.
5046 Sets up the C<ax> and C<items> variables by calling C<dAX> and C<dITEMS>.
5047 This is usually handled automatically by C<xsubpp>.
5052 Found in file XSUB.h
5056 Sets up the C<ix> variable for an XSUB which has aliases. This is usually
5057 handled automatically by C<xsubpp>.
5062 Found in file XSUB.h
5066 Variable which is setup by C<xsubpp> to indicate the number of
5067 items on the stack. See L<perlxs/"Variable-length Parameter Lists">.
5072 Found in file XSUB.h
5076 Variable which is setup by C<xsubpp> to indicate which of an
5077 XSUB's aliases was used to invoke it. See L<perlxs/"The ALIAS: Keyword">.
5082 Found in file XSUB.h
5086 Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
5090 Found in file XSUB.h
5094 Variable which is setup by C<xsubpp> to hold the return value for an
5095 XSUB. This is always the proper type for the XSUB. See
5096 L<perlxs/"The RETVAL Variable">.
5101 Found in file XSUB.h
5105 Used to access elements on the XSUB's stack.
5110 Found in file XSUB.h
5114 Variable which is setup by C<xsubpp> to designate the object in a C++
5115 XSUB. This is always the proper type for the C++ object. See C<CLASS> and
5116 L<perlxs/"Using XS With C++">.
5121 Found in file XSUB.h
5125 Macro to declare an XSUB and its C parameter list. This is handled by
5129 Found in file XSUB.h
5131 =item XSRETURN_EMPTY
5133 Return an empty list from an XSUB immediately.
5139 Found in file XSUB.h
5143 The version identifier for an XS module. This is usually
5144 handled automatically by C<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>.
5147 Found in file XSUB.h
5149 =item XS_VERSION_BOOTCHECK
5151 Macro to verify that a PM module's $VERSION variable matches the XS
5152 module's C<XS_VERSION> variable. This is usually handled automatically by
5153 C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">.
5155 XS_VERSION_BOOTCHECK;
5158 Found in file XSUB.h
5163 =head1 Warning and Dieing
5169 This is the XSUB-writer's interface to Perl's C<die> function.
5170 Normally use this function the same way you use the C C<printf>
5171 function. See C<warn>.
5173 If you want to throw an exception object, assign the object to
5174 C<$@> and then pass C<Nullch> to croak():
5176 errsv = get_sv("@", TRUE);
5177 sv_setsv(errsv, exception_object);
5180 void croak(const char* pat, ...)
5183 Found in file util.c
5187 This is the XSUB-writer's interface to Perl's C<warn> function. Use this
5188 function the same way you use the C C<printf> function. See
5191 void warn(const char* pat, ...)
5194 Found in file util.c
5201 Until May 1997, this document was maintained by Jeff Okamoto
5202 <okamoto@corp.hp.com>. It is now maintained as part of Perl itself.
5204 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
5205 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
5206 Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
5207 Stephen McCamant, and Gurusamy Sarathy.
5209 API Listing originally by Dean Roehrich <roehrich@cray.com>.
5211 Updated to be autogenerated from comments in the source by Benjamin Stuhl.
5215 perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
projects / p5sagit/p5-mst-13.2.git / blob