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 perl_clone takes these flags as parameters:
517 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
518 without it we only clone the data and zero the stacks,
519 with it we copy the stacks and the new perl interpreter is
520 ready to run at the exact same point as the previous one.
521 The pseudo-fork code uses COPY_STACKS while the
522 threads->new doesn't.
524 CLONEf_KEEP_PTR_TABLE
525 perl_clone keeps a ptr_table with the pointer of the old
526 variable as a key and the new variable as a value,
527 this allows it to check if something has been cloned and not
528 clone it again but rather just use the value and increase the
529 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
530 the ptr_table using the function
531 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
532 reason to keep it around is if you want to dup some of your own
533 variable who are outside the graph perl scans, example of this
534 code is in threads.xs create
537 This is a win32 thing, it is ignored on unix, it tells perls
538 win32host code (which is c++) to clone itself, this is needed on
539 win32 if you want to run two threads at the same time,
540 if you just want to do some stuff in a separate perl interpreter
541 and then throw it away and return to the original one,
542 you don't need to do anything.
544 PerlInterpreter* perl_clone(PerlInterpreter* interp, UV flags)
552 =head1 CV Manipulation Functions
558 Returns the stash of the CV.
567 Returns the CV of the specified Perl subroutine. If C<create> is set and
568 the Perl subroutine does not exist then it will be declared (which has the
569 same effect as saying C<sub name;>). If C<create> is not set and the
570 subroutine does not exist then NULL is returned.
572 NOTE: the perl_ form of this function is deprecated.
574 CV* get_cv(const char* name, I32 create)
590 =head1 Embedding Functions
596 Clear out all the active components of a CV. This can happen either
597 by an explicit C<undef &foo>, or by the reference count going to zero.
598 In the former case, we keep the CvOUTSIDE pointer, so that any anonymous
599 children can still follow the full lexical scope chain.
601 void cv_undef(CV* cv)
608 Loads the module whose name is pointed to by the string part of name.
609 Note that the actual module name, not its filename, should be given.
610 Eg, "Foo::Bar" instead of "Foo/Bar.pm". flags can be any of
611 PERL_LOADMOD_DENY, PERL_LOADMOD_NOIMPORT, or PERL_LOADMOD_IMPORT_OPS
612 (or 0 for no flags). ver, if specified, provides version semantics
613 similar to C<use Foo::Bar VERSION>. The optional trailing SV*
614 arguments can be used to specify arguments to the module's import()
615 method, similar to C<use Foo::Bar VERSION LIST>.
617 void load_module(U32 flags, SV* name, SV* ver, ...)
624 Stub that provides thread hook for perl_destruct when there are
634 Allocates a new Perl interpreter. See L<perlembed>.
636 PerlInterpreter* perl_alloc()
643 Initializes a new Perl interpreter. See L<perlembed>.
645 void perl_construct(PerlInterpreter* interp)
652 Shuts down a Perl interpreter. See L<perlembed>.
654 int perl_destruct(PerlInterpreter* interp)
661 Releases a Perl interpreter. See L<perlembed>.
663 void perl_free(PerlInterpreter* interp)
670 Tells a Perl interpreter to parse a Perl script. See L<perlembed>.
672 int perl_parse(PerlInterpreter* interp, XSINIT_t xsinit, int argc, char** argv, char** env)
679 Tells a Perl interpreter to run. See L<perlembed>.
681 int perl_run(PerlInterpreter* interp)
688 Tells Perl to C<require> the file named by the string argument. It is
689 analogous to the Perl code C<eval "require '$file'">. It's even
690 implemented that way; consider using load_module instead.
692 NOTE: the perl_ form of this function is deprecated.
694 void require_pv(const char* pv)
702 =head1 Functions in file pp_pack.c
709 The engine implementing pack() Perl function.
711 void packlist(SV *cat, char *pat, char *patend, SV **beglist, SV **endlist)
714 Found in file pp_pack.c
718 The engine implementing pack() Perl function. Note: parameters next_in_list and
719 flags are not used. This call should not be used; use packlist instead.
721 void pack_cat(SV *cat, char *pat, char *patend, SV **beglist, SV **endlist, SV ***next_in_list, U32 flags)
724 Found in file pp_pack.c
728 The engine implementing unpack() Perl function. C<unpackstring> puts the
729 extracted list items on the stack and returns the number of elements.
730 Issue C<PUTBACK> before and C<SPAGAIN> after the call to this function.
732 I32 unpackstring(char *pat, char *patend, char *s, char *strend, U32 flags)
735 Found in file pp_pack.c
739 The engine implementing unpack() Perl function. Note: parameters strbeg, new_s
740 and ocnt are not used. This call should not be used, use unpackstring instead.
742 I32 unpack_str(char *pat, char *patend, char *s, char *strbeg, char *strend, char **new_s, I32 ocnt, U32 flags)
745 Found in file pp_pack.c
750 =head1 Global Variables
756 C<PL_modglobal> is a general purpose, interpreter global HV for use by
757 extensions that need to keep information on a per-interpreter basis.
758 In a pinch, it can also be used as a symbol table for extensions
759 to share data among each other. It is a good idea to use keys
760 prefixed by the package name of the extension that owns the data.
765 Found in file intrpvar.h
769 A convenience variable which is typically used with C<SvPV> when one
770 doesn't care about the length of the string. It is usually more efficient
771 to either declare a local variable and use that instead or to use the
777 Found in file thrdvar.h
781 This is the C<false> SV. See C<PL_sv_yes>. Always refer to this as
787 Found in file intrpvar.h
791 This is the C<undef> SV. Always refer to this as C<&PL_sv_undef>.
796 Found in file intrpvar.h
800 This is the C<true> SV. See C<PL_sv_no>. Always refer to this as
806 Found in file intrpvar.h
817 Return the SV from the GV.
826 Returns the glob with the given C<name> and a defined subroutine or
827 C<NULL>. The glob lives in the given C<stash>, or in the stashes
828 accessible via @ISA and UNIVERSAL::.
830 The argument C<level> should be either 0 or -1. If C<level==0>, as a
831 side-effect creates a glob with the given C<name> in the given C<stash>
832 which in the case of success contains an alias for the subroutine, and sets
833 up caching info for this glob. Similarly for all the searched stashes.
835 This function grants C<"SUPER"> token as a postfix of the stash name. The
836 GV returned from C<gv_fetchmeth> may be a method cache entry, which is not
837 visible to Perl code. So when calling C<call_sv>, you should not use
838 the GV directly; instead, you should use the method's CV, which can be
839 obtained from the GV with the C<GvCV> macro.
841 GV* gv_fetchmeth(HV* stash, const char* name, STRLEN len, I32 level)
848 See L<gv_fetchmethod_autoload>.
850 GV* gv_fetchmethod(HV* stash, const char* name)
855 =item gv_fetchmethod_autoload
857 Returns the glob which contains the subroutine to call to invoke the method
858 on the C<stash>. In fact in the presence of autoloading this may be the
859 glob for "AUTOLOAD". In this case the corresponding variable $AUTOLOAD is
862 The third parameter of C<gv_fetchmethod_autoload> determines whether
863 AUTOLOAD lookup is performed if the given method is not present: non-zero
864 means yes, look for AUTOLOAD; zero means no, don't look for AUTOLOAD.
865 Calling C<gv_fetchmethod> is equivalent to calling C<gv_fetchmethod_autoload>
866 with a non-zero C<autoload> parameter.
868 These functions grant C<"SUPER"> token as a prefix of the method name. Note
869 that if you want to keep the returned glob for a long time, you need to
870 check for it being "AUTOLOAD", since at the later time the call may load a
871 different subroutine due to $AUTOLOAD changing its value. Use the glob
872 created via a side effect to do this.
874 These functions have the same side-effects and as C<gv_fetchmeth> with
875 C<level==0>. C<name> should be writable if contains C<':'> or C<'
876 ''>. The warning against passing the GV returned by C<gv_fetchmeth> to
877 C<call_sv> apply equally to these functions.
879 GV* gv_fetchmethod_autoload(HV* stash, const char* name, I32 autoload)
884 =item gv_fetchmeth_autoload
886 Same as gv_fetchmeth(), but looks for autoloaded subroutines too.
887 Returns a glob for the subroutine.
889 For an autoloaded subroutine without a GV, will create a GV even
890 if C<level < 0>. For an autoloaded subroutine without a stub, GvCV()
891 of the result may be zero.
893 GV* gv_fetchmeth_autoload(HV* stash, const char* name, STRLEN len, I32 level)
900 Returns a pointer to the stash for a specified package. C<name> should
901 be a valid UTF-8 string. If C<create> is set then the package will be
902 created if it does not already exist. If C<create> is not set and the
903 package does not exist then NULL is returned.
905 HV* gv_stashpv(const char* name, I32 create)
912 Returns a pointer to the stash for a specified package, which must be a
913 valid UTF-8 string. See C<gv_stashpv>.
915 HV* gv_stashsv(SV* sv, I32 create)
929 This flag, used in the length slot of hash entries and magic structures,
930 specifies the structure contains an C<SV*> pointer where a C<char*> pointer
931 is to be expected. (For information only--not to be used).
939 Null character pointer.
942 Found in file handy.h
949 Found in file handy.h
954 =head1 Hash Manipulation Functions
960 Returns the HV of the specified Perl hash. If C<create> is set and the
961 Perl variable does not exist then it will be created. If C<create> is not
962 set and the variable does not exist then NULL is returned.
964 NOTE: the perl_ form of this function is deprecated.
966 HV* get_hv(const char* name, I32 create)
973 Returns the computed hash stored in the hash entry.
982 Returns the actual pointer stored in the key slot of the hash entry. The
983 pointer may be either C<char*> or C<SV*>, depending on the value of
984 C<HeKLEN()>. Can be assigned to. The C<HePV()> or C<HeSVKEY()> macros are
985 usually preferable for finding the value of a key.
994 If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry
995 holds an C<SV*> key. Otherwise, holds the actual length of the key. Can
996 be assigned to. The C<HePV()> macro is usually preferable for finding key
999 STRLEN HeKLEN(HE* he)
1006 Returns the key slot of the hash entry as a C<char*> value, doing any
1007 necessary dereferencing of possibly C<SV*> keys. The length of the string
1008 is placed in C<len> (this is a macro, so do I<not> use C<&len>). If you do
1009 not care about what the length of the key is, you may use the global
1010 variable C<PL_na>, though this is rather less efficient than using a local
1011 variable. Remember though, that hash keys in perl are free to contain
1012 embedded nulls, so using C<strlen()> or similar is not a good way to find
1013 the length of hash keys. This is very similar to the C<SvPV()> macro
1014 described elsewhere in this document.
1016 char* HePV(HE* he, STRLEN len)
1023 Returns the key as an C<SV*>, or C<Nullsv> if the hash entry does not
1024 contain an C<SV*> key.
1033 Returns the key as an C<SV*>. Will create and return a temporary mortal
1034 C<SV*> if the hash entry contains only a C<char*> key.
1036 SV* HeSVKEY_force(HE* he)
1043 Sets the key to a given C<SV*>, taking care to set the appropriate flags to
1044 indicate the presence of an C<SV*> key, and returns the same
1047 SV* HeSVKEY_set(HE* he, SV* sv)
1054 Returns the value slot (type C<SV*>) stored in the hash entry.
1063 Returns the package name of a stash. See C<SvSTASH>, C<CvSTASH>.
1065 char* HvNAME(HV* stash)
1072 Check that a hash is in an internally consistent state.
1074 void hv_assert(HV* tb)
1081 Clears a hash, making it empty.
1083 void hv_clear(HV* tb)
1088 =item hv_clear_placeholders
1090 Clears any placeholders from a hash. If a restricted hash has any of its keys
1091 marked as readonly and the key is subsequently deleted, the key is not actually
1092 deleted but is marked by assigning it a value of &PL_sv_placeholder. This tags
1093 it so it will be ignored by future operations such as iterating over the hash,
1094 but will still allow the hash to have a value reaasigned to the key at some
1095 future point. This function clears any such placeholder keys from the hash.
1096 See Hash::Util::lock_keys() for an example of its use.
1098 void hv_clear_placeholders(HV* hb)
1105 Deletes a key/value pair in the hash. The value SV is removed from the
1106 hash and returned to the caller. The C<klen> is the length of the key.
1107 The C<flags> value will normally be zero; if set to G_DISCARD then NULL
1110 SV* hv_delete(HV* tb, const char* key, I32 klen, I32 flags)
1117 Deletes a key/value pair in the hash. The value SV is removed from the
1118 hash and returned to the caller. The C<flags> value will normally be zero;
1119 if set to G_DISCARD then NULL will be returned. C<hash> can be a valid
1120 precomputed hash value, or 0 to ask for it to be computed.
1122 SV* hv_delete_ent(HV* tb, SV* key, I32 flags, U32 hash)
1129 Returns a boolean indicating whether the specified hash key exists. The
1130 C<klen> is the length of the key.
1132 bool hv_exists(HV* tb, const char* key, I32 klen)
1139 Returns a boolean indicating whether the specified hash key exists. C<hash>
1140 can be a valid precomputed hash value, or 0 to ask for it to be
1143 bool hv_exists_ent(HV* tb, SV* key, U32 hash)
1150 Returns the SV which corresponds to the specified key in the hash. The
1151 C<klen> is the length of the key. If C<lval> is set then the fetch will be
1152 part of a store. Check that the return value is non-null before
1153 dereferencing it to an C<SV*>.
1155 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1156 information on how to use this function on tied hashes.
1158 SV** hv_fetch(HV* tb, const char* key, I32 klen, I32 lval)
1165 Returns the hash entry which corresponds to the specified key in the hash.
1166 C<hash> must be a valid precomputed hash number for the given C<key>, or 0
1167 if you want the function to compute it. IF C<lval> is set then the fetch
1168 will be part of a store. Make sure the return value is non-null before
1169 accessing it. The return value when C<tb> is a tied hash is a pointer to a
1170 static location, so be sure to make a copy of the structure if you need to
1173 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1174 information on how to use this function on tied hashes.
1176 HE* hv_fetch_ent(HV* tb, SV* key, I32 lval, U32 hash)
1183 Prepares a starting point to traverse a hash table. Returns the number of
1184 keys in the hash (i.e. the same as C<HvKEYS(tb)>). The return value is
1185 currently only meaningful for hashes without tie magic.
1187 NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
1188 hash buckets that happen to be in use. If you still need that esoteric
1189 value, you can get it through the macro C<HvFILL(tb)>.
1192 I32 hv_iterinit(HV* tb)
1199 Returns the key from the current position of the hash iterator. See
1202 char* hv_iterkey(HE* entry, I32* retlen)
1209 Returns the key as an C<SV*> from the current position of the hash
1210 iterator. The return value will always be a mortal copy of the key. Also
1213 SV* hv_iterkeysv(HE* entry)
1220 Returns entries from a hash iterator. See C<hv_iterinit>.
1222 You may call C<hv_delete> or C<hv_delete_ent> on the hash entry that the
1223 iterator currently points to, without losing your place or invalidating your
1224 iterator. Note that in this case the current entry is deleted from the hash
1225 with your iterator holding the last reference to it. Your iterator is flagged
1226 to free the entry on the next call to C<hv_iternext>, so you must not discard
1227 your iterator immediately else the entry will leak - call C<hv_iternext> to
1228 trigger the resource deallocation.
1230 HE* hv_iternext(HV* tb)
1237 Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
1240 SV* hv_iternextsv(HV* hv, char** key, I32* retlen)
1245 =item hv_iternext_flags
1247 Returns entries from a hash iterator. See C<hv_iterinit> and C<hv_iternext>.
1248 The C<flags> value will normally be zero; if HV_ITERNEXT_WANTPLACEHOLDERS is
1249 set the placeholders keys (for restricted hashes) will be returned in addition
1250 to normal keys. By default placeholders are automatically skipped over.
1251 Currently a placeholder is implemented with a value that is
1252 C<&Perl_sv_placeholder>. Note that the implementation of placeholders and
1253 restricted hashes may change, and the implementation currently is
1254 insufficiently abstracted for any change to be tidy.
1256 NOTE: this function is experimental and may change or be
1257 removed without notice.
1259 HE* hv_iternext_flags(HV* tb, I32 flags)
1266 Returns the value from the current position of the hash iterator. See
1269 SV* hv_iterval(HV* tb, HE* entry)
1276 Adds magic to a hash. See C<sv_magic>.
1278 void hv_magic(HV* hv, GV* gv, int how)
1285 Stores an SV in a hash. The hash key is specified as C<key> and C<klen> is
1286 the length of the key. The C<hash> parameter is the precomputed hash
1287 value; if it is zero then Perl will compute it. The return value will be
1288 NULL if the operation failed or if the value did not need to be actually
1289 stored within the hash (as in the case of tied hashes). Otherwise it can
1290 be dereferenced to get the original C<SV*>. Note that the caller is
1291 responsible for suitably incrementing the reference count of C<val> before
1292 the call, and decrementing it if the function returned NULL. Effectively
1293 a successful hv_store takes ownership of one reference to C<val>. This is
1294 usually what you want; a newly created SV has a reference count of one, so
1295 if all your code does is create SVs then store them in a hash, hv_store
1296 will own the only reference to the new SV, and your code doesn't need to do
1297 anything further to tidy up. hv_store is not implemented as a call to
1298 hv_store_ent, and does not create a temporary SV for the key, so if your
1299 key data is not already in SV form then use hv_store in preference to
1302 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1303 information on how to use this function on tied hashes.
1305 SV** hv_store(HV* tb, const char* key, I32 klen, SV* val, U32 hash)
1312 Stores C<val> in a hash. The hash key is specified as C<key>. The C<hash>
1313 parameter is the precomputed hash value; if it is zero then Perl will
1314 compute it. The return value is the new hash entry so created. It will be
1315 NULL if the operation failed or if the value did not need to be actually
1316 stored within the hash (as in the case of tied hashes). Otherwise the
1317 contents of the return value can be accessed using the C<He?> macros
1318 described here. Note that the caller is responsible for suitably
1319 incrementing the reference count of C<val> before the call, and
1320 decrementing it if the function returned NULL. Effectively a successful
1321 hv_store_ent takes ownership of one reference to C<val>. This is
1322 usually what you want; a newly created SV has a reference count of one, so
1323 if all your code does is create SVs then store them in a hash, hv_store
1324 will own the only reference to the new SV, and your code doesn't need to do
1325 anything further to tidy up. Note that hv_store_ent only reads the C<key>;
1326 unlike C<val> it does not take ownership of it, so maintaining the correct
1327 reference count on C<key> is entirely the caller's responsibility. hv_store
1328 is not implemented as a call to hv_store_ent, and does not create a temporary
1329 SV for the key, so if your key data is not already in SV form then use
1330 hv_store in preference to hv_store_ent.
1332 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1333 information on how to use this function on tied hashes.
1335 HE* hv_store_ent(HV* tb, SV* key, SV* val, U32 hash)
1344 void hv_undef(HV* tb)
1351 Creates a new HV. The reference count is set to 1.
1369 =head1 Magical Functions
1375 Clear something magical that the SV represents. See C<sv_magic>.
1377 int mg_clear(SV* sv)
1384 Copies the magic from one SV to another. See C<sv_magic>.
1386 int mg_copy(SV* sv, SV* nsv, const char* key, I32 klen)
1393 Finds the magic pointer for type matching the SV. See C<sv_magic>.
1395 MAGIC* mg_find(SV* sv, int type)
1402 Free any magic storage used by the SV. See C<sv_magic>.
1411 Do magic after a value is retrieved from the SV. See C<sv_magic>.
1420 Report on the SV's length. See C<sv_magic>.
1422 U32 mg_length(SV* sv)
1429 Turns on the magical status of an SV. See C<sv_magic>.
1431 void mg_magical(SV* sv)
1438 Do magic after a value is assigned to the SV. See C<sv_magic>.
1447 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
1448 argument more than once.
1450 void SvGETMAGIC(SV* sv)
1457 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
1467 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
1468 argument more than once.
1470 void SvSETMAGIC(SV* sv)
1477 Like C<SvSetSV>, but does any set magic required afterwards.
1479 void SvSetMagicSV(SV* dsb, SV* ssv)
1484 =item SvSetMagicSV_nosteal
1486 Like C<SvSetMagicSV>, but does any set magic required afterwards.
1488 void SvSetMagicSV_nosteal(SV* dsv, SV* ssv)
1495 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
1498 void SvSetSV(SV* dsb, SV* ssv)
1503 =item SvSetSV_nosteal
1505 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
1506 ssv. May evaluate arguments more than once.
1508 void SvSetSV_nosteal(SV* dsv, SV* ssv)
1515 Arranges for sv to be shared between threads if a suitable module
1518 void SvSHARE(SV* sv)
1526 =head1 Memory Management
1532 The XSUB-writer's interface to the C C<memcpy> function. The C<src> is the
1533 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1534 the type. May fail on overlapping copies. See also C<Move>.
1536 void Copy(void* src, void* dest, int nitems, type)
1539 Found in file handy.h
1543 The XSUB-writer's interface to the C C<memmove> function. The C<src> is the
1544 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1545 the type. Can do overlapping moves. See also C<Copy>.
1547 void Move(void* src, void* dest, int nitems, type)
1550 Found in file handy.h
1554 The XSUB-writer's interface to the C C<malloc> function.
1556 void New(int id, void* ptr, int nitems, type)
1559 Found in file handy.h
1563 The XSUB-writer's interface to the C C<malloc> function, with
1566 void Newc(int id, void* ptr, int nitems, type, cast)
1569 Found in file handy.h
1573 Creates a new SV. A non-zero C<len> parameter indicates the number of
1574 bytes of preallocated string space the SV should have. An extra byte for a
1575 tailing NUL is also reserved. (SvPOK is not set for the SV even if string
1576 space is allocated.) The reference count for the new SV is set to 1.
1577 C<id> is an integer id between 0 and 1299 (used to identify leaks).
1580 SV* NEWSV(int id, STRLEN len)
1583 Found in file handy.h
1587 The XSUB-writer's interface to the C C<malloc> function. The allocated
1588 memory is zeroed with C<memzero>.
1590 void Newz(int id, void* ptr, int nitems, type)
1593 Found in file handy.h
1597 Fill up memory with a pattern (byte 0xAB over and over again) that
1598 hopefully catches attempts to access uninitialized memory.
1600 void Poison(void* dest, int nitems, type)
1603 Found in file handy.h
1607 The XSUB-writer's interface to the C C<realloc> function.
1609 void Renew(void* ptr, int nitems, type)
1612 Found in file handy.h
1616 The XSUB-writer's interface to the C C<realloc> function, with
1619 void Renewc(void* ptr, int nitems, type, cast)
1622 Found in file handy.h
1626 The XSUB-writer's interface to the C C<free> function.
1628 void Safefree(void* ptr)
1631 Found in file handy.h
1635 Perl's version of C<strdup()>. Returns a pointer to a newly allocated
1636 string which is a duplicate of C<pv>. The size of the string is
1637 determined by C<strlen()>. The memory allocated for the new string can
1638 be freed with the C<Safefree()> function.
1640 char* savepv(const char* pv)
1643 Found in file util.c
1647 Perl's version of what C<strndup()> would be if it existed. Returns a
1648 pointer to a newly allocated string which is a duplicate of the first
1649 C<len> bytes from C<pv>. The memory allocated for the new string can be
1650 freed with the C<Safefree()> function.
1652 char* savepvn(const char* pv, I32 len)
1655 Found in file util.c
1659 A version of C<savepv()> which allocates the duplicate string in memory
1660 which is shared between threads.
1662 char* savesharedpv(const char* pv)
1665 Found in file util.c
1669 This is an architecture-independent macro to copy one structure to another.
1671 void StructCopy(type src, type dest, type)
1674 Found in file handy.h
1678 The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the
1679 destination, C<nitems> is the number of items, and C<type> is the type.
1681 void Zero(void* dest, int nitems, type)
1684 Found in file handy.h
1689 =head1 Miscellaneous Functions
1695 Analyses the string in order to make fast searches on it using fbm_instr()
1696 -- the Boyer-Moore algorithm.
1698 void fbm_compile(SV* sv, U32 flags)
1701 Found in file util.c
1705 Returns the location of the SV in the string delimited by C<str> and
1706 C<strend>. It returns C<Nullch> if the string can't be found. The C<sv>
1707 does not have to be fbm_compiled, but the search will not be as fast
1710 char* fbm_instr(unsigned char* big, unsigned char* bigend, SV* littlesv, U32 flags)
1713 Found in file util.c
1717 Takes a sprintf-style format pattern and conventional
1718 (non-SV) arguments and returns the formatted string.
1720 (char *) Perl_form(pTHX_ const char* pat, ...)
1722 can be used any place a string (char *) is required:
1724 char * s = Perl_form("%d.%d",major,minor);
1726 Uses a single private buffer so if you want to format several strings you
1727 must explicitly copy the earlier strings away (and free the copies when you
1730 char* form(const char* pat, ...)
1733 Found in file util.c
1737 Fill the sv with current working directory
1739 int getcwd_sv(SV* sv)
1742 Found in file util.c
1746 Returns a new version object based on the passed in SV:
1748 SV *sv = new_version(SV *ver);
1750 Does not alter the passed in ver SV. See "upg_version" if you
1751 want to upgrade the SV.
1753 SV* new_version(SV *ver)
1756 Found in file util.c
1760 Returns a pointer to the next character after the parsed
1761 version string, as well as upgrading the passed in SV to
1764 Function must be called with an already existing SV like
1767 s = scan_version(s,sv);
1769 Performs some preprocessing to the string to ensure that
1770 it has the correct characteristics of a version. Flags the
1771 object if it contains an underscore (which denotes this
1774 char* scan_version(char *vstr, SV *sv)
1777 Found in file util.c
1781 Test two strings to see if they are equal. Returns true or false.
1783 bool strEQ(char* s1, char* s2)
1786 Found in file handy.h
1790 Test two strings to see if the first, C<s1>, is greater than or equal to
1791 the second, C<s2>. Returns true or false.
1793 bool strGE(char* s1, char* s2)
1796 Found in file handy.h
1800 Test two strings to see if the first, C<s1>, is greater than the second,
1801 C<s2>. Returns true or false.
1803 bool strGT(char* s1, char* s2)
1806 Found in file handy.h
1810 Test two strings to see if the first, C<s1>, is less than or equal to the
1811 second, C<s2>. Returns true or false.
1813 bool strLE(char* s1, char* s2)
1816 Found in file handy.h
1820 Test two strings to see if the first, C<s1>, is less than the second,
1821 C<s2>. Returns true or false.
1823 bool strLT(char* s1, char* s2)
1826 Found in file handy.h
1830 Test two strings to see if they are different. Returns true or
1833 bool strNE(char* s1, char* s2)
1836 Found in file handy.h
1840 Test two strings to see if they are equal. The C<len> parameter indicates
1841 the number of bytes to compare. Returns true or false. (A wrapper for
1844 bool strnEQ(char* s1, char* s2, STRLEN len)
1847 Found in file handy.h
1851 Test two strings to see if they are different. The C<len> parameter
1852 indicates the number of bytes to compare. Returns true or false. (A
1853 wrapper for C<strncmp>).
1855 bool strnNE(char* s1, char* s2, STRLEN len)
1858 Found in file handy.h
1862 Dummy routine which "locks" an SV when there is no locking module present.
1863 Exists to avoid test for a NULL function pointer and because it could potentially warn under
1864 some level of strict-ness.
1866 void sv_nolocking(SV *)
1869 Found in file util.c
1873 Dummy routine which "shares" an SV when there is no sharing module present.
1874 Exists to avoid test for a NULL function pointer and because it could potentially warn under
1875 some level of strict-ness.
1877 void sv_nosharing(SV *)
1880 Found in file util.c
1882 =item sv_nounlocking
1884 Dummy routine which "unlocks" an SV when there is no locking module present.
1885 Exists to avoid test for a NULL function pointer and because it could potentially warn under
1886 some level of strict-ness.
1888 void sv_nounlocking(SV *)
1891 Found in file util.c
1895 In-place upgrade of the supplied SV to a version object.
1897 SV *sv = upg_version(SV *sv);
1899 Returns a pointer to the upgraded SV.
1901 SV* upg_version(SV *ver)
1904 Found in file util.c
1908 Version object aware cmp. Both operands must already have been
1909 converted into version objects.
1911 int vcmp(SV *lvs, SV *rvs)
1914 Found in file util.c
1918 Accepts a version object and returns the normalized floating
1919 point representation. Call like:
1923 NOTE: you can pass either the object directly or the SV
1924 contained within the RV.
1929 Found in file util.c
1933 Accepts a version object and returns the normalized string
1934 representation. Call like:
1936 sv = vstringify(rv);
1938 NOTE: you can pass either the object directly or the SV
1939 contained within the RV.
1941 SV* vstringify(SV *vs)
1944 Found in file util.c
1949 =head1 Numeric functions
1955 converts a string representing a binary number to numeric form.
1957 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
1958 conversion flags, and I<result> should be NULL or a pointer to an NV.
1959 The scan stops at the end of the string, or the first invalid character.
1960 On return I<*len> is set to the length scanned string, and I<*flags> gives
1963 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
1964 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_bin>
1965 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
1966 and writes the value to I<*result> (or the value is discarded if I<result>
1969 The hex number may optionally be prefixed with "0b" or "b" unless
1970 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
1971 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the binary
1972 number may use '_' characters to separate digits.
1974 UV grok_bin(char* start, STRLEN* len, I32* flags, NV *result)
1977 Found in file numeric.c
1981 converts a string representing a hex number to numeric form.
1983 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
1984 conversion flags, and I<result> should be NULL or a pointer to an NV.
1985 The scan stops at the end of the string, or the first non-hex-digit character.
1986 On return I<*len> is set to the length scanned string, and I<*flags> gives
1989 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
1990 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_hex>
1991 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
1992 and writes the value to I<*result> (or the value is discarded if I<result>
1995 The hex number may optionally be prefixed with "0x" or "x" unless
1996 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
1997 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the hex
1998 number may use '_' characters to separate digits.
2000 UV grok_hex(char* start, STRLEN* len, I32* flags, NV *result)
2003 Found in file numeric.c
2007 Recognise (or not) a number. The type of the number is returned
2008 (0 if unrecognised), otherwise it is a bit-ORed combination of
2009 IS_NUMBER_IN_UV, IS_NUMBER_GREATER_THAN_UV_MAX, IS_NUMBER_NOT_INT,
2010 IS_NUMBER_NEG, IS_NUMBER_INFINITY, IS_NUMBER_NAN (defined in perl.h).
2012 If the value of the number can fit an in UV, it is returned in the *valuep
2013 IS_NUMBER_IN_UV will be set to indicate that *valuep is valid, IS_NUMBER_IN_UV
2014 will never be set unless *valuep is valid, but *valuep may have been assigned
2015 to during processing even though IS_NUMBER_IN_UV is not set on return.
2016 If valuep is NULL, IS_NUMBER_IN_UV will be set for the same cases as when
2017 valuep is non-NULL, but no actual assignment (or SEGV) will occur.
2019 IS_NUMBER_NOT_INT will be set with IS_NUMBER_IN_UV if trailing decimals were
2020 seen (in which case *valuep gives the true value truncated to an integer), and
2021 IS_NUMBER_NEG if the number is negative (in which case *valuep holds the
2022 absolute value). IS_NUMBER_IN_UV is not set if e notation was used or the
2023 number is larger than a UV.
2025 int grok_number(const char *pv, STRLEN len, UV *valuep)
2028 Found in file numeric.c
2030 =item grok_numeric_radix
2032 Scan and skip for a numeric decimal separator (radix).
2034 bool grok_numeric_radix(const char **sp, const char *send)
2037 Found in file numeric.c
2042 UV grok_oct(char* start, STRLEN* len, I32* flags, NV *result)
2045 Found in file numeric.c
2049 For backwards compatibility. Use C<grok_bin> instead.
2051 NV scan_bin(char* start, STRLEN len, STRLEN* retlen)
2054 Found in file numeric.c
2058 For backwards compatibility. Use C<grok_hex> instead.
2060 NV scan_hex(char* start, STRLEN len, STRLEN* retlen)
2063 Found in file numeric.c
2067 For backwards compatibility. Use C<grok_oct> instead.
2069 NV scan_oct(char* start, STRLEN len, STRLEN* retlen)
2072 Found in file numeric.c
2077 =head1 Optree Manipulation Functions
2083 If C<cv> is a constant sub eligible for inlining. returns the constant
2084 value returned by the sub. Otherwise, returns NULL.
2086 Constant subs can be created with C<newCONSTSUB> or as described in
2087 L<perlsub/"Constant Functions">.
2089 SV* cv_const_sv(CV* cv)
2096 Creates a constant sub equivalent to Perl C<sub FOO () { 123 }> which is
2097 eligible for inlining at compile-time.
2099 CV* newCONSTSUB(HV* stash, char* name, SV* sv)
2106 Used by C<xsubpp> to hook up XSUBs as Perl subs.
2114 =head1 Pad Data Structures
2120 Get the value at offset po in the current pad.
2121 Use macro PAD_SV instead of calling this function directly.
2123 SV* pad_sv(PADOFFSET po)
2131 =head1 Stack Manipulation Macros
2137 Declare a stack marker variable, C<mark>, for the XSUB. See C<MARK> and
2147 Saves the original stack mark for the XSUB. See C<ORIGMARK>.
2156 Declares a local copy of perl's stack pointer for the XSUB, available via
2157 the C<SP> macro. See C<SP>.
2166 Used to extend the argument stack for an XSUB's return values. Once
2167 used, guarantees that there is room for at least C<nitems> to be pushed
2170 void EXTEND(SP, int nitems)
2177 Stack marker variable for the XSUB. See C<dMARK>.
2184 The original stack mark for the XSUB. See C<dORIGMARK>.
2191 Pops an integer off the stack.
2200 Pops a long off the stack.
2209 Pops a double off the stack.
2218 Pops a string off the stack. Deprecated. New code should provide
2219 a STRLEN n_a and use POPpx.
2228 Pops a string off the stack which must consist of bytes i.e. characters < 256.
2229 Requires a variable STRLEN n_a in scope.
2238 Pops a string off the stack.
2239 Requires a variable STRLEN n_a in scope.
2248 Pops an SV off the stack.
2257 Push an integer onto the stack. The stack must have room for this element.
2258 Handles 'set' magic. See C<XPUSHi>.
2267 Opening bracket for arguments on a callback. See C<PUTBACK> and
2277 Push a double onto the stack. The stack must have room for this element.
2278 Handles 'set' magic. See C<XPUSHn>.
2287 Push a string onto the stack. The stack must have room for this element.
2288 The C<len> indicates the length of the string. Handles 'set' magic. See
2291 void PUSHp(char* str, STRLEN len)
2298 Push an SV onto the stack. The stack must have room for this element.
2299 Does not handle 'set' magic. See C<XPUSHs>.
2308 Push an unsigned integer onto the stack. The stack must have room for this
2309 element. See C<XPUSHu>.
2318 Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
2319 See C<PUSHMARK> and L<perlcall> for other uses.
2328 Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and
2336 Refetch the stack pointer. Used after a callback. See L<perlcall>.
2345 Push an integer onto the stack, extending the stack if necessary. Handles
2346 'set' magic. See C<PUSHi>.
2355 Push a double onto the stack, extending the stack if necessary. Handles
2356 'set' magic. See C<PUSHn>.
2365 Push a string onto the stack, extending the stack if necessary. The C<len>
2366 indicates the length of the string. Handles 'set' magic. See
2369 void XPUSHp(char* str, STRLEN len)
2376 Push an SV onto the stack, extending the stack if necessary. Does not
2377 handle 'set' magic. See C<PUSHs>.
2386 Push an unsigned integer onto the stack, extending the stack if necessary.
2396 Return from XSUB, indicating number of items on the stack. This is usually
2397 handled by C<xsubpp>.
2399 void XSRETURN(int nitems)
2402 Found in file XSUB.h
2406 Return an integer from an XSUB immediately. Uses C<XST_mIV>.
2408 void XSRETURN_IV(IV iv)
2411 Found in file XSUB.h
2415 Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
2420 Found in file XSUB.h
2424 Return a double from an XSUB immediately. Uses C<XST_mNV>.
2426 void XSRETURN_NV(NV nv)
2429 Found in file XSUB.h
2433 Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
2435 void XSRETURN_PV(char* str)
2438 Found in file XSUB.h
2440 =item XSRETURN_UNDEF
2442 Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
2447 Found in file XSUB.h
2451 Return an integer from an XSUB immediately. Uses C<XST_mUV>.
2453 void XSRETURN_UV(IV uv)
2456 Found in file XSUB.h
2460 Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
2465 Found in file XSUB.h
2469 Place an integer into the specified position C<pos> on the stack. The
2470 value is stored in a new mortal SV.
2472 void XST_mIV(int pos, IV iv)
2475 Found in file XSUB.h
2479 Place C<&PL_sv_no> into the specified position C<pos> on the
2482 void XST_mNO(int pos)
2485 Found in file XSUB.h
2489 Place a double into the specified position C<pos> on the stack. The value
2490 is stored in a new mortal SV.
2492 void XST_mNV(int pos, NV nv)
2495 Found in file XSUB.h
2499 Place a copy of a string into the specified position C<pos> on the stack.
2500 The value is stored in a new mortal SV.
2502 void XST_mPV(int pos, char* str)
2505 Found in file XSUB.h
2509 Place C<&PL_sv_undef> into the specified position C<pos> on the
2512 void XST_mUNDEF(int pos)
2515 Found in file XSUB.h
2519 Place C<&PL_sv_yes> into the specified position C<pos> on the
2522 void XST_mYES(int pos)
2525 Found in file XSUB.h
2536 An enum of flags for Perl types. These are found in the file B<sv.h>
2537 in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
2544 Integer type flag for scalars. See C<svtype>.
2551 Double type flag for scalars. See C<svtype>.
2558 Pointer type flag for scalars. See C<svtype>.
2565 Type flag for arrays. See C<svtype>.
2572 Type flag for code refs. See C<svtype>.
2579 Type flag for hashes. See C<svtype>.
2586 Type flag for blessed scalars. See C<svtype>.
2594 =head1 SV Manipulation Functions
2600 Returns the SV of the specified Perl scalar. If C<create> is set and the
2601 Perl variable does not exist then it will be created. If C<create> is not
2602 set and the variable does not exist then NULL is returned.
2604 NOTE: the perl_ form of this function is deprecated.
2606 SV* get_sv(const char* name, I32 create)
2609 Found in file perl.c
2611 =item looks_like_number
2613 Test if the content of an SV looks like a number (or is a number).
2614 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
2615 non-numeric warning), even if your atof() doesn't grok them.
2617 I32 looks_like_number(SV* sv)
2624 Creates an RV wrapper for an SV. The reference count for the original SV is
2627 SV* newRV_inc(SV* sv)
2634 Creates an RV wrapper for an SV. The reference count for the original
2635 SV is B<not> incremented.
2637 SV* newRV_noinc(SV *sv)
2644 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
2645 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
2648 SV* newSV(STRLEN len)
2655 Creates a new SV and copies an integer into it. The reference count for the
2665 Creates a new SV and copies a floating point value into it.
2666 The reference count for the SV is set to 1.
2675 Creates a new SV and copies a string into it. The reference count for the
2676 SV is set to 1. If C<len> is zero, Perl will compute the length using
2677 strlen(). For efficiency, consider using C<newSVpvn> instead.
2679 SV* newSVpv(const char* s, STRLEN len)
2686 Creates a new SV and initializes it with the string formatted like
2689 SV* newSVpvf(const char* pat, ...)
2696 Creates a new SV and copies a string into it. The reference count for the
2697 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
2698 string. You are responsible for ensuring that the source string is at least
2701 SV* newSVpvn(const char* s, STRLEN len)
2706 =item newSVpvn_share
2708 Creates a new SV with its SvPVX pointing to a shared string in the string
2709 table. If the string does not already exist in the table, it is created
2710 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
2711 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
2712 otherwise the hash is computed. The idea here is that as the string table
2713 is used for shared hash keys these strings will have SvPVX == HeKEY and
2714 hash lookup will avoid string compare.
2716 SV* newSVpvn_share(const char* s, I32 len, U32 hash)
2723 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
2724 it will be upgraded to one. If C<classname> is non-null then the new SV will
2725 be blessed in the specified package. The new SV is returned and its
2726 reference count is 1.
2728 SV* newSVrv(SV* rv, const char* classname)
2735 Creates a new SV which is an exact duplicate of the original SV.
2738 SV* newSVsv(SV* old)
2745 Creates a new SV and copies an unsigned integer into it.
2746 The reference count for the SV is set to 1.
2755 Returns the length of the string which is in the SV. See C<SvLEN>.
2757 STRLEN SvCUR(SV* sv)
2764 Set the length of the string which is in the SV. See C<SvCUR>.
2766 void SvCUR_set(SV* sv, STRLEN len)
2773 Returns a pointer to the last character in the string which is in the SV.
2774 See C<SvCUR>. Access the character as *(SvEND(sv)).
2783 Expands the character buffer in the SV so that it has room for the
2784 indicated number of bytes (remember to reserve space for an extra trailing
2785 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
2786 Returns a pointer to the character buffer.
2788 char * SvGROW(SV* sv, STRLEN len)
2795 Returns a boolean indicating whether the SV contains an integer.
2804 Returns a boolean indicating whether the SV contains an integer. Checks
2805 the B<private> setting. Use C<SvIOK>.
2814 Returns a boolean indicating whether the SV contains a signed integer.
2816 void SvIOK_notUV(SV* sv)
2823 Unsets the IV status of an SV.
2825 void SvIOK_off(SV* sv)
2832 Tells an SV that it is an integer.
2834 void SvIOK_on(SV* sv)
2841 Tells an SV that it is an integer and disables all other OK bits.
2843 void SvIOK_only(SV* sv)
2850 Tells and SV that it is an unsigned integer and disables all other OK bits.
2852 void SvIOK_only_UV(SV* sv)
2859 Returns a boolean indicating whether the SV contains an unsigned integer.
2861 void SvIOK_UV(SV* sv)
2868 Returns a boolean indicating whether the SV is Copy-On-Write. (either shared
2869 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
2872 bool SvIsCOW(SV* sv)
2877 =item SvIsCOW_shared_hash
2879 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
2882 bool SvIsCOW_shared_hash(SV* sv)
2889 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
2890 version which guarantees to evaluate sv only once.
2899 Coerces the given SV to an integer and returns it. Guarantees to evaluate
2900 sv only once. Use the more efficient C<SvIV> otherwise.
2909 Returns the raw value in the SV's IV slot, without checks or conversions.
2910 Only use when you are sure SvIOK is true. See also C<SvIV()>.
2919 Returns the size of the string buffer in the SV, not including any part
2920 attributable to C<SvOOK>. See C<SvCUR>.
2922 STRLEN SvLEN(SV* sv)
2929 Returns a boolean indicating whether the SV contains a number, integer or
2939 Returns a boolean indicating whether the SV contains a number, integer or
2940 double. Checks the B<private> setting. Use C<SvNIOK>.
2942 bool SvNIOKp(SV* sv)
2949 Unsets the NV/IV status of an SV.
2951 void SvNIOK_off(SV* sv)
2958 Returns a boolean indicating whether the SV contains a double.
2967 Returns a boolean indicating whether the SV contains a double. Checks the
2968 B<private> setting. Use C<SvNOK>.
2977 Unsets the NV status of an SV.
2979 void SvNOK_off(SV* sv)
2986 Tells an SV that it is a double.
2988 void SvNOK_on(SV* sv)
2995 Tells an SV that it is a double and disables all other OK bits.
2997 void SvNOK_only(SV* sv)
3004 Coerce the given SV to a double and return it. See C<SvNVx> for a version
3005 which guarantees to evaluate sv only once.
3014 Returns the raw value in the SV's NV slot, without checks or conversions.
3015 Only use when you are sure SvNOK is true. See also C<SvNV()>.
3024 Coerces the given SV to a double and returns it. Guarantees to evaluate
3025 sv only once. Use the more efficient C<SvNV> otherwise.
3034 Returns a boolean indicating whether the value is an SV.
3043 Returns a boolean indicating whether the SvIVX is a valid offset value for
3044 the SvPVX. This hack is used internally to speed up removal of characters
3045 from the beginning of a SvPV. When SvOOK is true, then the start of the
3046 allocated string buffer is really (SvPVX - SvIVX).
3055 Returns a boolean indicating whether the SV contains a character
3065 Returns a boolean indicating whether the SV contains a character string.
3066 Checks the B<private> setting. Use C<SvPOK>.
3075 Unsets the PV status of an SV.
3077 void SvPOK_off(SV* sv)
3084 Tells an SV that it is a string.
3086 void SvPOK_on(SV* sv)
3093 Tells an SV that it is a string and disables all other OK bits.
3094 Will also turn off the UTF-8 status.
3096 void SvPOK_only(SV* sv)
3101 =item SvPOK_only_UTF8
3103 Tells an SV that it is a string and disables all other OK bits,
3104 and leaves the UTF-8 status as it was.
3106 void SvPOK_only_UTF8(SV* sv)
3113 Returns a pointer to the string in the SV, or a stringified form of
3114 the SV if the SV does not contain a string. The SV may cache the
3115 stringified version becoming C<SvPOK>. Handles 'get' magic. See also
3116 C<SvPVx> for a version which guarantees to evaluate sv only once.
3118 char* SvPV(SV* sv, STRLEN len)
3125 Like C<SvPV>, but converts sv to byte representation first if necessary.
3127 char* SvPVbyte(SV* sv, STRLEN len)
3134 Like C<SvPV>, but converts sv to byte representation first if necessary.
3135 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
3138 char* SvPVbytex(SV* sv, STRLEN len)
3143 =item SvPVbytex_force
3145 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
3146 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
3149 char* SvPVbytex_force(SV* sv, STRLEN len)
3154 =item SvPVbyte_force
3156 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
3158 char* SvPVbyte_force(SV* sv, STRLEN len)
3163 =item SvPVbyte_nolen
3165 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
3167 char* SvPVbyte_nolen(SV* sv)
3174 Like C<SvPV>, but converts sv to utf8 first if necessary.
3176 char* SvPVutf8(SV* sv, STRLEN len)
3183 Like C<SvPV>, but converts sv to utf8 first if necessary.
3184 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
3187 char* SvPVutf8x(SV* sv, STRLEN len)
3192 =item SvPVutf8x_force
3194 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
3195 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
3198 char* SvPVutf8x_force(SV* sv, STRLEN len)
3203 =item SvPVutf8_force
3205 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
3207 char* SvPVutf8_force(SV* sv, STRLEN len)
3212 =item SvPVutf8_nolen
3214 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
3216 char* SvPVutf8_nolen(SV* sv)
3223 A version of C<SvPV> which guarantees to evaluate sv only once.
3225 char* SvPVx(SV* sv, STRLEN len)
3232 Returns a pointer to the physical string in the SV. The SV must contain a
3242 Like C<SvPV> but will force the SV into containing just a string
3243 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
3246 char* SvPV_force(SV* sv, STRLEN len)
3251 =item SvPV_force_nomg
3253 Like C<SvPV> but will force the SV into containing just a string
3254 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
3255 directly. Doesn't process magic.
3257 char* SvPV_force_nomg(SV* sv, STRLEN len)
3264 Returns a pointer to the string in the SV, or a stringified form of
3265 the SV if the SV does not contain a string. The SV may cache the
3266 stringified form becoming C<SvPOK>. Handles 'get' magic.
3268 char* SvPV_nolen(SV* sv)
3275 Returns the value of the object's reference count.
3277 U32 SvREFCNT(SV* sv)
3284 Decrements the reference count of the given SV.
3286 void SvREFCNT_dec(SV* sv)
3293 Increments the reference count of the given SV.
3295 SV* SvREFCNT_inc(SV* sv)
3302 Tests if the SV is an RV.
3311 Unsets the RV status of an SV.
3313 void SvROK_off(SV* sv)
3320 Tells an SV that it is an RV.
3322 void SvROK_on(SV* sv)
3329 Dereferences an RV to return the SV.
3338 Returns the stash of the SV.
3347 Taints an SV if tainting is enabled.
3349 void SvTAINT(SV* sv)
3356 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
3359 bool SvTAINTED(SV* sv)
3366 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
3367 some of Perl's fundamental security features. XS module authors should not
3368 use this function unless they fully understand all the implications of
3369 unconditionally untainting the value. Untainting should be done in the
3370 standard perl fashion, via a carefully crafted regexp, rather than directly
3371 untainting variables.
3373 void SvTAINTED_off(SV* sv)
3380 Marks an SV as tainted if tainting is enabled.
3382 void SvTAINTED_on(SV* sv)
3389 Returns a boolean indicating whether Perl would evaluate the SV as true or
3390 false, defined or undefined. Does not handle 'get' magic.
3399 Returns the type of the SV. See C<svtype>.
3401 svtype SvTYPE(SV* sv)
3408 Releases a mutual exclusion lock on sv if a suitable module
3412 void SvUNLOCK(SV* sv)
3419 Returns a boolean indicating whether the SV contains an unsigned integer.
3428 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
3429 perform the upgrade if necessary. See C<svtype>.
3431 void SvUPGRADE(SV* sv, svtype type)
3438 Returns a boolean indicating whether the SV contains UTF-8 encoded data.
3447 Unsets the UTF-8 status of an SV.
3449 void SvUTF8_off(SV *sv)
3456 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
3457 Do not use frivolously.
3459 void SvUTF8_on(SV *sv)
3466 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
3467 for a version which guarantees to evaluate sv only once.
3476 Returns the raw value in the SV's UV slot, without checks or conversions.
3477 Only use when you are sure SvIOK is true. See also C<SvUV()>.
3486 Coerces the given SV to an unsigned integer and returns it. Guarantees to
3487 evaluate sv only once. Use the more efficient C<SvUV> otherwise.
3496 Returns a boolean indicating whether the SV contains a v-string.
3505 This function is only called on magical items, and is only used by
3506 sv_true() or its macro equivalent.
3508 bool sv_2bool(SV* sv)
3515 Using various gambits, try to get a CV from an SV; in addition, try if
3516 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
3518 CV* sv_2cv(SV* sv, HV** st, GV** gvp, I32 lref)
3525 Using various gambits, try to get an IO from an SV: the IO slot if its a
3526 GV; or the recursive result if we're an RV; or the IO slot of the symbol
3527 named after the PV if we're a string.
3536 Return the integer value of an SV, doing any necessary string conversion,
3537 magic etc. Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
3546 Marks an existing SV as mortal. The SV will be destroyed "soon", either
3547 by an explicit call to FREETMPS, or by an implicit call at places such as
3548 statement boundaries. See also C<sv_newmortal> and C<sv_mortalcopy>.
3550 SV* sv_2mortal(SV* sv)
3557 Return the num value of an SV, doing any necessary string or integer
3558 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
3568 Return a pointer to the byte-encoded representation of the SV, and set *lp
3569 to its length. May cause the SV to be downgraded from UTF-8 as a
3572 Usually accessed via the C<SvPVbyte> macro.
3574 char* sv_2pvbyte(SV* sv, STRLEN* lp)
3579 =item sv_2pvbyte_nolen
3581 Return a pointer to the byte-encoded representation of the SV.
3582 May cause the SV to be downgraded from UTF-8 as a side-effect.
3584 Usually accessed via the C<SvPVbyte_nolen> macro.
3586 char* sv_2pvbyte_nolen(SV* sv)
3593 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3594 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
3596 Usually accessed via the C<SvPVutf8> macro.
3598 char* sv_2pvutf8(SV* sv, STRLEN* lp)
3603 =item sv_2pvutf8_nolen
3605 Return a pointer to the UTF-8-encoded representation of the SV.
3606 May cause the SV to be upgraded to UTF-8 as a side-effect.
3608 Usually accessed via the C<SvPVutf8_nolen> macro.
3610 char* sv_2pvutf8_nolen(SV* sv)
3617 Returns a pointer to the string value of an SV, and sets *lp to its length.
3618 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
3620 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
3621 usually end up here too.
3623 char* sv_2pv_flags(SV* sv, STRLEN* lp, I32 flags)
3630 Like C<sv_2pv()>, but doesn't return the length too. You should usually
3631 use the macro wrapper C<SvPV_nolen(sv)> instead.
3632 char* sv_2pv_nolen(SV* sv)
3639 Return the unsigned integer value of an SV, doing any necessary string
3640 conversion, magic etc. Normally used via the C<SvUV(sv)> and C<SvUVx(sv)>
3650 Remove any string offset. You should normally use the C<SvOOK_off> macro
3653 int sv_backoff(SV* sv)
3660 Blesses an SV into a specified package. The SV must be an RV. The package
3661 must be designated by its stash (see C<gv_stashpv()>). The reference count
3662 of the SV is unaffected.
3664 SV* sv_bless(SV* sv, HV* stash)
3671 Concatenates the string onto the end of the string which is in the SV.
3672 If the SV has the UTF-8 status set, then the bytes appended should be
3673 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
3675 void sv_catpv(SV* sv, const char* ptr)
3682 Processes its arguments like C<sprintf> and appends the formatted
3683 output to an SV. If the appended data contains "wide" characters
3684 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
3685 and characters >255 formatted with %c), the original SV might get
3686 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic.
3687 C<SvSETMAGIC()> must typically be called after calling this function
3688 to handle 'set' magic.
3690 void sv_catpvf(SV* sv, const char* pat, ...)
3697 Like C<sv_catpvf>, but also handles 'set' magic.
3699 void sv_catpvf_mg(SV *sv, const char* pat, ...)
3706 Concatenates the string onto the end of the string which is in the SV. The
3707 C<len> indicates number of bytes to copy. If the SV has the UTF-8
3708 status set, then the bytes appended should be valid UTF-8.
3709 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
3711 void sv_catpvn(SV* sv, const char* ptr, STRLEN len)
3716 =item sv_catpvn_flags
3718 Concatenates the string onto the end of the string which is in the SV. The
3719 C<len> indicates number of bytes to copy. If the SV has the UTF-8
3720 status set, then the bytes appended should be valid UTF-8.
3721 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
3722 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
3723 in terms of this function.
3725 void sv_catpvn_flags(SV* sv, const char* ptr, STRLEN len, I32 flags)
3732 Like C<sv_catpvn>, but also handles 'set' magic.
3734 void sv_catpvn_mg(SV *sv, const char *ptr, STRLEN len)
3741 Like C<sv_catpv>, but also handles 'set' magic.
3743 void sv_catpv_mg(SV *sv, const char *ptr)
3750 Concatenates the string from SV C<ssv> onto the end of the string in
3751 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
3752 not 'set' magic. See C<sv_catsv_mg>.
3754 void sv_catsv(SV* dsv, SV* ssv)
3759 =item sv_catsv_flags
3761 Concatenates the string from SV C<ssv> onto the end of the string in
3762 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
3763 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
3764 and C<sv_catsv_nomg> are implemented in terms of this function.
3766 void sv_catsv_flags(SV* dsv, SV* ssv, I32 flags)
3773 Like C<sv_catsv>, but also handles 'set' magic.
3775 void sv_catsv_mg(SV *dstr, SV *sstr)
3782 Efficient removal of characters from the beginning of the string buffer.
3783 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
3784 the string buffer. The C<ptr> becomes the first character of the adjusted
3785 string. Uses the "OOK hack".
3786 Beware: after this function returns, C<ptr> and SvPVX(sv) may no longer
3787 refer to the same chunk of data.
3789 void sv_chop(SV* sv, char* ptr)
3796 Clear an SV: call any destructors, free up any memory used by the body,
3797 and free the body itself. The SV's head is I<not> freed, although
3798 its type is set to all 1's so that it won't inadvertently be assumed
3799 to be live during global destruction etc.
3800 This function should only be called when REFCNT is zero. Most of the time
3801 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
3804 void sv_clear(SV* sv)
3811 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
3812 string in C<sv1> is less than, equal to, or greater than the string in
3813 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
3814 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
3816 I32 sv_cmp(SV* sv1, SV* sv2)
3823 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
3824 'use bytes' aware, handles get magic, and will coerce its args to strings
3825 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
3827 I32 sv_cmp_locale(SV* sv1, SV* sv2)
3834 Add Collate Transform magic to an SV if it doesn't already have it.
3836 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
3837 scalar data of the variable, but transformed to such a format that a normal
3838 memory comparison can be used to compare the data according to the locale
3841 char* sv_collxfrm(SV* sv, STRLEN* nxp)
3848 Copies a stringified representation of the source SV into the
3849 destination SV. Automatically performs any necessary mg_get and
3850 coercion of numeric values into strings. Guaranteed to preserve
3851 UTF-8 flag even from overloaded objects. Similar in nature to
3852 sv_2pv[_flags] but operates directly on an SV instead of just the
3853 string. Mostly uses sv_2pv_flags to do its work, except when that
3854 would lose the UTF-8'ness of the PV.
3856 void sv_copypv(SV* dsv, SV* ssv)
3863 Auto-decrement of the value in the SV, doing string to numeric conversion
3864 if necessary. Handles 'get' magic.
3871 =item sv_derived_from
3873 Returns a boolean indicating whether the SV is derived from the specified
3874 class. This is the function that implements C<UNIVERSAL::isa>. It works
3875 for class names as well as for objects.
3877 bool sv_derived_from(SV* sv, const char* name)
3880 Found in file universal.c
3884 Returns a boolean indicating whether the strings in the two SVs are
3885 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
3886 coerce its args to strings if necessary.
3888 I32 sv_eq(SV* sv1, SV* sv2)
3893 =item sv_force_normal
3895 Undo various types of fakery on an SV: if the PV is a shared string, make
3896 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3897 an xpvmg. See also C<sv_force_normal_flags>.
3899 void sv_force_normal(SV *sv)
3904 =item sv_force_normal_flags
3906 Undo various types of fakery on an SV: if the PV is a shared string, make
3907 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3908 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
3909 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
3910 then a copy-on-write scalar drops its PV buffer (if any) and becomes
3911 SvPOK_off rather than making a copy. (Used where this scalar is about to be
3912 set to some other value.) In addition, the C<flags> parameter gets passed to
3913 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
3914 with flags set to 0.
3916 void sv_force_normal_flags(SV *sv, U32 flags)
3923 Decrement an SV's reference count, and if it drops to zero, call
3924 C<sv_clear> to invoke destructors and free up any memory used by
3925 the body; finally, deallocate the SV's head itself.
3926 Normally called via a wrapper macro C<SvREFCNT_dec>.
3928 void sv_free(SV* sv)
3935 Get a line from the filehandle and store it into the SV, optionally
3936 appending to the currently-stored string.
3938 char* sv_gets(SV* sv, PerlIO* fp, I32 append)
3945 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
3946 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
3947 Use the C<SvGROW> wrapper instead.
3949 char* sv_grow(SV* sv, STRLEN newlen)
3956 Auto-increment of the value in the SV, doing string to numeric conversion
3957 if necessary. Handles 'get' magic.
3966 Inserts a string at the specified offset/length within the SV. Similar to
3967 the Perl substr() function.
3969 void sv_insert(SV* bigsv, STRLEN offset, STRLEN len, char* little, STRLEN littlelen)
3976 Returns a boolean indicating whether the SV is blessed into the specified
3977 class. This does not check for subtypes; use C<sv_derived_from> to verify
3978 an inheritance relationship.
3980 int sv_isa(SV* sv, const char* name)
3987 Returns a boolean indicating whether the SV is an RV pointing to a blessed
3988 object. If the SV is not an RV, or if the object is not blessed, then this
3991 int sv_isobject(SV* sv)
3998 A private implementation of the C<SvIVx> macro for compilers which can't
3999 cope with complex macro expressions. Always use the macro instead.
4008 Returns the length of the string in the SV. Handles magic and type
4009 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
4011 STRLEN sv_len(SV* sv)
4018 Returns the number of characters in the string in an SV, counting wide
4019 UTF-8 bytes as a single character. Handles magic and type coercion.
4021 STRLEN sv_len_utf8(SV* sv)
4028 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4029 then adds a new magic item of type C<how> to the head of the magic list.
4031 void sv_magic(SV* sv, SV* obj, int how, const char* name, I32 namlen)
4038 Adds magic to an SV, upgrading it if necessary. Applies the
4039 supplied vtable and returns pointer to the magic added.
4041 Note that sv_magicext will allow things that sv_magic will not.
4042 In particular you can add magic to SvREADONLY SVs and and more than
4043 one instance of the same 'how'
4045 I C<namelen> is greater then zero then a savepvn() I<copy> of C<name> is stored,
4046 if C<namelen> is zero then C<name> is stored as-is and - as another special
4047 case - if C<(name && namelen == HEf_SVKEY)> then C<name> is assumed to contain
4048 an C<SV*> and has its REFCNT incremented
4050 (This is now used as a subroutine by sv_magic.)
4052 MAGIC * sv_magicext(SV* sv, SV* obj, int how, MGVTBL *vtbl, const char* name, I32 namlen )
4059 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
4060 The new SV is marked as mortal. It will be destroyed "soon", either by an
4061 explicit call to FREETMPS, or by an implicit call at places such as
4062 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
4064 SV* sv_mortalcopy(SV* oldsv)
4071 Creates a new null SV which is mortal. The reference count of the SV is
4072 set to 1. It will be destroyed "soon", either by an explicit call to
4073 FREETMPS, or by an implicit call at places such as statement boundaries.
4074 See also C<sv_mortalcopy> and C<sv_2mortal>.
4083 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
4086 SV* sv_newref(SV* sv)
4093 A private implementation of the C<SvNVx> macro for compilers which can't
4094 cope with complex macro expressions. Always use the macro instead.
4103 Converts the value pointed to by offsetp from a count of bytes from the
4104 start of the string, to a count of the equivalent number of UTF-8 chars.
4105 Handles magic and type coercion.
4107 void sv_pos_b2u(SV* sv, I32* offsetp)
4114 Converts the value pointed to by offsetp from a count of UTF-8 chars from
4115 the start of the string, to a count of the equivalent number of bytes; if
4116 lenp is non-zero, it does the same to lenp, but this time starting from
4117 the offset, rather than from the start of the string. Handles magic and
4120 void sv_pos_u2b(SV* sv, I32* offsetp, I32* lenp)
4127 Use the C<SvPV_nolen> macro instead
4136 Use C<SvPVbyte_nolen> instead.
4138 char* sv_pvbyte(SV *sv)
4145 A private implementation of the C<SvPVbyte> macro for compilers
4146 which can't cope with complex macro expressions. Always use the macro
4149 char* sv_pvbyten(SV *sv, STRLEN *len)
4154 =item sv_pvbyten_force
4156 A private implementation of the C<SvPVbytex_force> macro for compilers
4157 which can't cope with complex macro expressions. Always use the macro
4160 char* sv_pvbyten_force(SV* sv, STRLEN* lp)
4167 A private implementation of the C<SvPV> macro for compilers which can't
4168 cope with complex macro expressions. Always use the macro instead.
4170 char* sv_pvn(SV *sv, STRLEN *len)
4177 Get a sensible string out of the SV somehow.
4178 A private implementation of the C<SvPV_force> macro for compilers which
4179 can't cope with complex macro expressions. Always use the macro instead.
4181 char* sv_pvn_force(SV* sv, STRLEN* lp)
4186 =item sv_pvn_force_flags
4188 Get a sensible string out of the SV somehow.
4189 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
4190 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
4191 implemented in terms of this function.
4192 You normally want to use the various wrapper macros instead: see
4193 C<SvPV_force> and C<SvPV_force_nomg>
4195 char* sv_pvn_force_flags(SV* sv, STRLEN* lp, I32 flags)
4202 Use the C<SvPVutf8_nolen> macro instead
4204 char* sv_pvutf8(SV *sv)
4211 A private implementation of the C<SvPVutf8> macro for compilers
4212 which can't cope with complex macro expressions. Always use the macro
4215 char* sv_pvutf8n(SV *sv, STRLEN *len)
4220 =item sv_pvutf8n_force
4222 A private implementation of the C<SvPVutf8_force> macro for compilers
4223 which can't cope with complex macro expressions. Always use the macro
4226 char* sv_pvutf8n_force(SV* sv, STRLEN* lp)
4233 Returns a string describing what the SV is a reference to.
4235 char* sv_reftype(SV* sv, int ob)
4242 Make the first argument a copy of the second, then delete the original.
4243 The target SV physically takes over ownership of the body of the source SV
4244 and inherits its flags; however, the target keeps any magic it owns,
4245 and any magic in the source is discarded.
4246 Note that this is a rather specialist SV copying operation; most of the
4247 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4249 void sv_replace(SV* sv, SV* nsv)
4254 =item sv_report_used
4256 Dump the contents of all SVs not yet freed. (Debugging aid).
4258 void sv_report_used()
4265 Underlying implementation for the C<reset> Perl function.
4266 Note that the perl-level function is vaguely deprecated.
4268 void sv_reset(char* s, HV* stash)
4275 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4276 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4277 push a back-reference to this RV onto the array of backreferences
4278 associated with that magic.
4280 SV* sv_rvweaken(SV *sv)
4287 Copies an integer into the given SV, upgrading first if necessary.
4288 Does not handle 'set' magic. See also C<sv_setiv_mg>.
4290 void sv_setiv(SV* sv, IV num)
4297 Like C<sv_setiv>, but also handles 'set' magic.
4299 void sv_setiv_mg(SV *sv, IV i)
4306 Copies a double into the given SV, upgrading first if necessary.
4307 Does not handle 'set' magic. See also C<sv_setnv_mg>.
4309 void sv_setnv(SV* sv, NV num)
4316 Like C<sv_setnv>, but also handles 'set' magic.
4318 void sv_setnv_mg(SV *sv, NV num)
4325 Copies a string into an SV. The string must be null-terminated. Does not
4326 handle 'set' magic. See C<sv_setpv_mg>.
4328 void sv_setpv(SV* sv, const char* ptr)
4335 Processes its arguments like C<sprintf> and sets an SV to the formatted
4336 output. Does not handle 'set' magic. See C<sv_setpvf_mg>.
4338 void sv_setpvf(SV* sv, const char* pat, ...)
4345 Like C<sv_setpvf>, but also handles 'set' magic.
4347 void sv_setpvf_mg(SV *sv, const char* pat, ...)
4354 Copies an integer into the given SV, also updating its string value.
4355 Does not handle 'set' magic. See C<sv_setpviv_mg>.
4357 void sv_setpviv(SV* sv, IV num)
4364 Like C<sv_setpviv>, but also handles 'set' magic.
4366 void sv_setpviv_mg(SV *sv, IV iv)
4373 Copies a string into an SV. The C<len> parameter indicates the number of
4374 bytes to be copied. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4376 void sv_setpvn(SV* sv, const char* ptr, STRLEN len)
4383 Like C<sv_setpvn>, but also handles 'set' magic.
4385 void sv_setpvn_mg(SV *sv, const char *ptr, STRLEN len)
4392 Like C<sv_setpv>, but also handles 'set' magic.
4394 void sv_setpv_mg(SV *sv, const char *ptr)
4401 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
4402 argument will be upgraded to an RV. That RV will be modified to point to
4403 the new SV. The C<classname> argument indicates the package for the
4404 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4405 will have a reference count of 1, and the RV will be returned.
4407 SV* sv_setref_iv(SV* rv, const char* classname, IV iv)
4414 Copies a double into a new SV, optionally blessing the SV. The C<rv>
4415 argument will be upgraded to an RV. That RV will be modified to point to
4416 the new SV. The C<classname> argument indicates the package for the
4417 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4418 will have a reference count of 1, and the RV will be returned.
4420 SV* sv_setref_nv(SV* rv, const char* classname, NV nv)
4427 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
4428 argument will be upgraded to an RV. That RV will be modified to point to
4429 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
4430 into the SV. The C<classname> argument indicates the package for the
4431 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4432 will have a reference count of 1, and the RV will be returned.
4434 Do not use with other Perl types such as HV, AV, SV, CV, because those
4435 objects will become corrupted by the pointer copy process.
4437 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
4439 SV* sv_setref_pv(SV* rv, const char* classname, void* pv)
4446 Copies a string into a new SV, optionally blessing the SV. The length of the
4447 string must be specified with C<n>. The C<rv> argument will be upgraded to
4448 an RV. That RV will be modified to point to the new SV. The C<classname>
4449 argument indicates the package for the blessing. Set C<classname> to
4450 C<Nullch> to avoid the blessing. The new SV will have a reference count
4451 of 1, and the RV will be returned.
4453 Note that C<sv_setref_pv> copies the pointer while this copies the string.
4455 SV* sv_setref_pvn(SV* rv, const char* classname, char* pv, STRLEN n)
4462 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
4463 argument will be upgraded to an RV. That RV will be modified to point to
4464 the new SV. The C<classname> argument indicates the package for the
4465 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4466 will have a reference count of 1, and the RV will be returned.
4468 SV* sv_setref_uv(SV* rv, const char* classname, UV uv)
4475 Copies the contents of the source SV C<ssv> into the destination SV
4476 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4477 function if the source SV needs to be reused. Does not handle 'set' magic.
4478 Loosely speaking, it performs a copy-by-value, obliterating any previous
4479 content of the destination.
4481 You probably want to use one of the assortment of wrappers, such as
4482 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4483 C<SvSetMagicSV_nosteal>.
4485 void sv_setsv(SV* dsv, SV* ssv)
4490 =item sv_setsv_flags
4492 Copies the contents of the source SV C<ssv> into the destination SV
4493 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4494 function if the source SV needs to be reused. Does not handle 'set' magic.
4495 Loosely speaking, it performs a copy-by-value, obliterating any previous
4496 content of the destination.
4497 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
4498 C<ssv> if appropriate, else not. C<sv_setsv> and C<sv_setsv_nomg> are
4499 implemented in terms of this function.
4501 You probably want to use one of the assortment of wrappers, such as
4502 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4503 C<SvSetMagicSV_nosteal>.
4505 This is the primary function for copying scalars, and most other
4506 copy-ish functions and macros use this underneath.
4508 void sv_setsv_flags(SV* dsv, SV* ssv, I32 flags)
4515 Like C<sv_setsv>, but also handles 'set' magic.
4517 void sv_setsv_mg(SV *dstr, SV *sstr)
4524 Copies an unsigned integer into the given SV, upgrading first if necessary.
4525 Does not handle 'set' magic. See also C<sv_setuv_mg>.
4527 void sv_setuv(SV* sv, UV num)
4534 Like C<sv_setuv>, but also handles 'set' magic.
4536 void sv_setuv_mg(SV *sv, UV u)
4543 Taint an SV. Use C<SvTAINTED_on> instead.
4544 void sv_taint(SV* sv)
4551 Test an SV for taintedness. Use C<SvTAINTED> instead.
4552 bool sv_tainted(SV* sv)
4559 Returns true if the SV has a true value by Perl's rules.
4560 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
4561 instead use an in-line version.
4570 Removes all magic of type C<type> from an SV.
4572 int sv_unmagic(SV* sv, int type)
4579 Unsets the RV status of the SV, and decrements the reference count of
4580 whatever was being referenced by the RV. This can almost be thought of
4581 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
4582 being zero. See C<SvROK_off>.
4584 void sv_unref(SV* sv)
4589 =item sv_unref_flags
4591 Unsets the RV status of the SV, and decrements the reference count of
4592 whatever was being referenced by the RV. This can almost be thought of
4593 as a reversal of C<newSVrv>. The C<cflags> argument can contain
4594 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
4595 (otherwise the decrementing is conditional on the reference count being
4596 different from one or the reference being a readonly SV).
4599 void sv_unref_flags(SV* sv, U32 flags)
4606 Untaint an SV. Use C<SvTAINTED_off> instead.
4607 void sv_untaint(SV* sv)
4614 Upgrade an SV to a more complex form. Generally adds a new body type to the
4615 SV, then copies across as much information as possible from the old body.
4616 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
4618 bool sv_upgrade(SV* sv, U32 mt)
4625 Tells an SV to use C<ptr> to find its string value. Normally the string is
4626 stored inside the SV but sv_usepvn allows the SV to use an outside string.
4627 The C<ptr> should point to memory that was allocated by C<malloc>. The
4628 string length, C<len>, must be supplied. This function will realloc the
4629 memory pointed to by C<ptr>, so that pointer should not be freed or used by
4630 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
4631 See C<sv_usepvn_mg>.
4633 void sv_usepvn(SV* sv, char* ptr, STRLEN len)
4640 Like C<sv_usepvn>, but also handles 'set' magic.
4642 void sv_usepvn_mg(SV *sv, char *ptr, STRLEN len)
4647 =item sv_utf8_decode
4649 Convert the octets in the PV from UTF-8 to chars. Scan for validity and then
4650 turn off SvUTF8 if needed so that we see characters. Used as a building block
4651 for decode_utf8 in Encode.xs
4653 NOTE: this function is experimental and may change or be
4654 removed without notice.
4656 bool sv_utf8_decode(SV *sv)
4661 =item sv_utf8_downgrade
4663 Attempt to convert the PV of an SV from UTF-8-encoded to byte encoding.
4664 This may not be possible if the PV contains non-byte encoding characters;
4665 if this is the case, either returns false or, if C<fail_ok> is not
4668 This is not as a general purpose Unicode to byte encoding interface:
4669 use the Encode extension for that.
4671 NOTE: this function is experimental and may change or be
4672 removed without notice.
4674 bool sv_utf8_downgrade(SV *sv, bool fail_ok)
4679 =item sv_utf8_encode
4681 Convert the PV of an SV to UTF-8-encoded, but then turn off the C<SvUTF8>
4682 flag so that it looks like octets again. Used as a building block
4683 for encode_utf8 in Encode.xs
4685 void sv_utf8_encode(SV *sv)
4690 =item sv_utf8_upgrade
4692 Convert the PV of an SV to its UTF-8-encoded form.
4693 Forces the SV to string form if it is not already.
4694 Always sets the SvUTF8 flag to avoid future validity checks even
4695 if all the bytes have hibit clear.
4697 This is not as a general purpose byte encoding to Unicode interface:
4698 use the Encode extension for that.
4700 STRLEN sv_utf8_upgrade(SV *sv)
4705 =item sv_utf8_upgrade_flags
4707 Convert the PV of an SV to its UTF-8-encoded form.
4708 Forces the SV to string form if it is not already.
4709 Always sets the SvUTF8 flag to avoid future validity checks even
4710 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
4711 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
4712 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
4714 This is not as a general purpose byte encoding to Unicode interface:
4715 use the Encode extension for that.
4717 STRLEN sv_utf8_upgrade_flags(SV *sv, I32 flags)
4724 A private implementation of the C<SvUVx> macro for compilers which can't
4725 cope with complex macro expressions. Always use the macro instead.
4734 Processes its arguments like C<vsprintf> and appends the formatted output
4735 to an SV. Uses an array of SVs if the C style variable argument list is
4736 missing (NULL). When running with taint checks enabled, indicates via
4737 C<maybe_tainted> if results are untrustworthy (often due to the use of
4740 Usually used via one of its frontends C<sv_catpvf> and C<sv_catpvf_mg>.
4742 void sv_vcatpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
4749 Works like C<vcatpvfn> but copies the text into the SV instead of
4752 Usually used via one of its frontends C<sv_setpvf> and C<sv_setpvf_mg>.
4754 void sv_vsetpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
4762 =head1 Unicode Support
4766 =item bytes_from_utf8
4768 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
4769 Unlike <utf8_to_bytes> but like C<bytes_to_utf8>, returns a pointer to
4770 the newly-created string, and updates C<len> to contain the new
4771 length. Returns the original string if no conversion occurs, C<len>
4772 is unchanged. Do nothing if C<is_utf8> points to 0. Sets C<is_utf8> to
4773 0 if C<s> is converted or contains all 7bit characters.
4775 NOTE: this function is experimental and may change or be
4776 removed without notice.
4778 U8* bytes_from_utf8(U8 *s, STRLEN *len, bool *is_utf8)
4781 Found in file utf8.c
4785 Converts a string C<s> of length C<len> from ASCII into UTF-8 encoding.
4786 Returns a pointer to the newly-created string, and sets C<len> to
4787 reflect the new length.
4789 If you want to convert to UTF-8 from other encodings than ASCII,
4790 see sv_recode_to_utf8().
4792 NOTE: this function is experimental and may change or be
4793 removed without notice.
4795 U8* bytes_to_utf8(U8 *s, STRLEN *len)
4798 Found in file utf8.c
4802 Return true if the strings s1 and s2 differ case-insensitively, false
4803 if not (if they are equal case-insensitively). If u1 is true, the
4804 string s1 is assumed to be in UTF-8-encoded Unicode. If u2 is true,
4805 the string s2 is assumed to be in UTF-8-encoded Unicode. If u1 or u2
4806 are false, the respective string is assumed to be in native 8-bit
4809 If the pe1 and pe2 are non-NULL, the scanning pointers will be copied
4810 in there (they will point at the beginning of the I<next> character).
4811 If the pointers behind pe1 or pe2 are non-NULL, they are the end
4812 pointers beyond which scanning will not continue under any
4813 circustances. If the byte lengths l1 and l2 are non-zero, s1+l1 and
4814 s2+l2 will be used as goal end pointers that will also stop the scan,
4815 and which qualify towards defining a successful match: all the scans
4816 that define an explicit length must reach their goal pointers for
4817 a match to succeed).
4819 For case-insensitiveness, the "casefolding" of Unicode is used
4820 instead of upper/lowercasing both the characters, see
4821 http://www.unicode.org/unicode/reports/tr21/ (Case Mappings).
4823 I32 ibcmp_utf8(const char* a, char **pe1, UV l1, bool u1, const char* b, char **pe2, UV l2, bool u2)
4826 Found in file utf8.c
4830 Tests if some arbitrary number of bytes begins in a valid UTF-8
4831 character. Note that an INVARIANT (i.e. ASCII) character is a valid
4832 UTF-8 character. The actual number of bytes in the UTF-8 character
4833 will be returned if it is valid, otherwise 0.
4835 STRLEN is_utf8_char(U8 *p)
4838 Found in file utf8.c
4840 =item is_utf8_string
4842 Returns true if first C<len> bytes of the given string form a valid
4843 UTF-8 string, false otherwise. Note that 'a valid UTF-8 string' does
4844 not mean 'a string that contains code points above 0x7F encoded in UTF-8'
4845 because a valid ASCII string is a valid UTF-8 string.
4847 bool is_utf8_string(U8 *s, STRLEN len)
4850 Found in file utf8.c
4852 =item is_utf8_string_loc
4854 Like is_ut8_string but store the location of the failure in
4857 bool is_utf8_string_loc(U8 *s, STRLEN len, U8 **p)
4860 Found in file utf8.c
4862 =item pv_uni_display
4864 Build to the scalar dsv a displayable version of the string spv,
4865 length len, the displayable version being at most pvlim bytes long
4866 (if longer, the rest is truncated and "..." will be appended).
4868 The flags argument can have UNI_DISPLAY_ISPRINT set to display
4869 isPRINT()able characters as themselves, UNI_DISPLAY_BACKSLASH
4870 to display the \\[nrfta\\] as the backslashed versions (like '\n')
4871 (UNI_DISPLAY_BACKSLASH is preferred over UNI_DISPLAY_ISPRINT for \\).
4872 UNI_DISPLAY_QQ (and its alias UNI_DISPLAY_REGEX) have both
4873 UNI_DISPLAY_BACKSLASH and UNI_DISPLAY_ISPRINT turned on.
4875 The pointer to the PV of the dsv is returned.
4877 char* pv_uni_display(SV *dsv, U8 *spv, STRLEN len, STRLEN pvlim, UV flags)
4880 Found in file utf8.c
4884 The encoding is assumed to be an Encode object, the PV of the ssv is
4885 assumed to be octets in that encoding and decoding the input starts
4886 from the position which (PV + *offset) pointed to. The dsv will be
4887 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
4888 when the string tstr appears in decoding output or the input ends on
4889 the PV of the ssv. The value which the offset points will be modified
4890 to the last input position on the ssv.
4892 Returns TRUE if the terminator was found, else returns FALSE.
4894 bool sv_cat_decode(SV* dsv, SV *encoding, SV *ssv, int *offset, char* tstr, int tlen)
4899 =item sv_recode_to_utf8
4901 The encoding is assumed to be an Encode object, on entry the PV
4902 of the sv is assumed to be octets in that encoding, and the sv
4903 will be converted into Unicode (and UTF-8).
4905 If the sv already is UTF-8 (or if it is not POK), or if the encoding
4906 is not a reference, nothing is done to the sv. If the encoding is not
4907 an C<Encode::XS> Encoding object, bad things will happen.
4908 (See F<lib/encoding.pm> and L<Encode>).
4910 The PV of the sv is returned.
4912 char* sv_recode_to_utf8(SV* sv, SV *encoding)
4917 =item sv_uni_display
4919 Build to the scalar dsv a displayable version of the scalar sv,
4920 the displayable version being at most pvlim bytes long
4921 (if longer, the rest is truncated and "..." will be appended).
4923 The flags argument is as in pv_uni_display().
4925 The pointer to the PV of the dsv is returned.
4927 char* sv_uni_display(SV *dsv, SV *ssv, STRLEN pvlim, UV flags)
4930 Found in file utf8.c
4934 The "p" contains the pointer to the UTF-8 string encoding
4935 the character that is being converted.
4937 The "ustrp" is a pointer to the character buffer to put the
4938 conversion result to. The "lenp" is a pointer to the length
4941 The "swashp" is a pointer to the swash to use.
4943 Both the special and normal mappings are stored lib/unicore/To/Foo.pl,
4944 and loaded by SWASHGET, using lib/utf8_heavy.pl. The special (usually,
4945 but not always, a multicharacter mapping), is tried first.
4947 The "special" is a string like "utf8::ToSpecLower", which means the
4948 hash %utf8::ToSpecLower. The access to the hash is through
4949 Perl_to_utf8_case().
4951 The "normal" is a string like "ToLower" which means the swash
4954 UV to_utf8_case(U8 *p, U8* ustrp, STRLEN *lenp, SV **swash, char *normal, char *special)
4957 Found in file utf8.c
4961 Convert the UTF-8 encoded character at p to its foldcase version and
4962 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
4963 that the ustrp needs to be at least UTF8_MAXLEN_FOLD+1 bytes since the
4964 foldcase version may be longer than the original character (up to
4967 The first character of the foldcased version is returned
4968 (but note, as explained above, that there may be more.)
4970 UV to_utf8_fold(U8 *p, U8* ustrp, STRLEN *lenp)
4973 Found in file utf8.c
4977 Convert the UTF-8 encoded character at p to its lowercase version and
4978 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
4979 that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the
4980 lowercase version may be longer than the original character (up to two
4983 The first character of the lowercased version is returned
4984 (but note, as explained above, that there may be more.)
4986 UV to_utf8_lower(U8 *p, U8* ustrp, STRLEN *lenp)
4989 Found in file utf8.c
4993 Convert the UTF-8 encoded character at p to its titlecase version and
4994 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
4995 that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the
4996 titlecase version may be longer than the original character (up to two
4999 The first character of the titlecased version is returned
5000 (but note, as explained above, that there may be more.)
5002 UV to_utf8_title(U8 *p, U8* ustrp, STRLEN *lenp)
5005 Found in file utf8.c
5009 Convert the UTF-8 encoded character at p to its uppercase version and
5010 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
5011 that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the
5012 uppercase version may be longer than the original character (up to two
5015 The first character of the uppercased version is returned
5016 (but note, as explained above, that there may be more.)
5018 UV to_utf8_upper(U8 *p, U8* ustrp, STRLEN *lenp)
5021 Found in file utf8.c
5023 =item utf8n_to_uvchr
5025 Returns the native character value of the first character in the string C<s>
5026 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
5027 length, in bytes, of that character.
5029 Allows length and flags to be passed to low level routine.
5031 UV utf8n_to_uvchr(U8 *s, STRLEN curlen, STRLEN* retlen, U32 flags)
5034 Found in file utf8.c
5036 =item utf8n_to_uvuni
5038 Bottom level UTF-8 decode routine.
5039 Returns the unicode code point value of the first character in the string C<s>
5040 which is assumed to be in UTF-8 encoding and no longer than C<curlen>;
5041 C<retlen> will be set to the length, in bytes, of that character.
5043 If C<s> does not point to a well-formed UTF-8 character, the behaviour
5044 is dependent on the value of C<flags>: if it contains UTF8_CHECK_ONLY,
5045 it is assumed that the caller will raise a warning, and this function
5046 will silently just set C<retlen> to C<-1> and return zero. If the
5047 C<flags> does not contain UTF8_CHECK_ONLY, warnings about
5048 malformations will be given, C<retlen> will be set to the expected
5049 length of the UTF-8 character in bytes, and zero will be returned.
5051 The C<flags> can also contain various flags to allow deviations from
5052 the strict UTF-8 encoding (see F<utf8.h>).
5054 Most code should use utf8_to_uvchr() rather than call this directly.
5056 UV utf8n_to_uvuni(U8 *s, STRLEN curlen, STRLEN* retlen, U32 flags)
5059 Found in file utf8.c
5063 Returns the number of UTF-8 characters between the UTF-8 pointers C<a>
5066 WARNING: use only if you *know* that the pointers point inside the
5069 IV utf8_distance(U8 *a, U8 *b)
5072 Found in file utf8.c
5076 Return the UTF-8 pointer C<s> displaced by C<off> characters, either
5077 forward or backward.
5079 WARNING: do not use the following unless you *know* C<off> is within
5080 the UTF-8 data pointed to by C<s> *and* that on entry C<s> is aligned
5081 on the first byte of character or just after the last byte of a character.
5083 U8* utf8_hop(U8 *s, I32 off)
5086 Found in file utf8.c
5090 Return the length of the UTF-8 char encoded string C<s> in characters.
5091 Stops at C<e> (inclusive). If C<e E<lt> s> or if the scan would end
5092 up past C<e>, croaks.
5094 STRLEN utf8_length(U8* s, U8 *e)
5097 Found in file utf8.c
5101 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
5102 Unlike C<bytes_to_utf8>, this over-writes the original string, and
5103 updates len to contain the new length.
5104 Returns zero on failure, setting C<len> to -1.
5106 NOTE: this function is experimental and may change or be
5107 removed without notice.
5109 U8* utf8_to_bytes(U8 *s, STRLEN *len)
5112 Found in file utf8.c
5116 Returns the native character value of the first character in the string C<s>
5117 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
5118 length, in bytes, of that character.
5120 If C<s> does not point to a well-formed UTF-8 character, zero is
5121 returned and retlen is set, if possible, to -1.
5123 UV utf8_to_uvchr(U8 *s, STRLEN* retlen)
5126 Found in file utf8.c
5130 Returns the Unicode code point of the first character in the string C<s>
5131 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
5132 length, in bytes, of that character.
5134 This function should only be used when returned UV is considered
5135 an index into the Unicode semantic tables (e.g. swashes).
5137 If C<s> does not point to a well-formed UTF-8 character, zero is
5138 returned and retlen is set, if possible, to -1.
5140 UV utf8_to_uvuni(U8 *s, STRLEN* retlen)
5143 Found in file utf8.c
5147 Adds the UTF-8 representation of the Native codepoint C<uv> to the end
5148 of the string C<d>; C<d> should be have at least C<UTF8_MAXLEN+1> free
5149 bytes available. The return value is the pointer to the byte after the
5150 end of the new character. In other words,
5152 d = uvchr_to_utf8(d, uv);
5154 is the recommended wide native character-aware way of saying
5158 U8* uvchr_to_utf8(U8 *d, UV uv)
5161 Found in file utf8.c
5163 =item uvuni_to_utf8_flags
5165 Adds the UTF-8 representation of the Unicode codepoint C<uv> to the end
5166 of the string C<d>; C<d> should be have at least C<UTF8_MAXLEN+1> free
5167 bytes available. The return value is the pointer to the byte after the
5168 end of the new character. In other words,
5170 d = uvuni_to_utf8_flags(d, uv, flags);
5174 d = uvuni_to_utf8(d, uv);
5176 (which is equivalent to)
5178 d = uvuni_to_utf8_flags(d, uv, 0);
5180 is the recommended Unicode-aware way of saying
5184 U8* uvuni_to_utf8_flags(U8 *d, UV uv, UV flags)
5187 Found in file utf8.c
5192 =head1 Variables created by C<xsubpp> and C<xsubpp> internal functions
5198 Variable which is setup by C<xsubpp> to indicate the stack base offset,
5199 used by the C<ST>, C<XSprePUSH> and C<XSRETURN> macros. The C<dMARK> macro
5200 must be called prior to setup the C<MARK> variable.
5205 Found in file XSUB.h
5209 Variable which is setup by C<xsubpp> to indicate the
5210 class name for a C++ XS constructor. This is always a C<char*>. See C<THIS>.
5215 Found in file XSUB.h
5219 Sets up the C<ax> variable.
5220 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
5225 Found in file XSUB.h
5229 Sets up the C<items> variable.
5230 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
5235 Found in file XSUB.h
5239 Sets up stack and mark pointers for an XSUB, calling dSP and dMARK.
5240 Sets up the C<ax> and C<items> variables by calling C<dAX> and C<dITEMS>.
5241 This is usually handled automatically by C<xsubpp>.
5246 Found in file XSUB.h
5250 Sets up the C<ix> variable for an XSUB which has aliases. This is usually
5251 handled automatically by C<xsubpp>.
5256 Found in file XSUB.h
5260 Variable which is setup by C<xsubpp> to indicate the number of
5261 items on the stack. See L<perlxs/"Variable-length Parameter Lists">.
5266 Found in file XSUB.h
5270 Variable which is setup by C<xsubpp> to indicate which of an
5271 XSUB's aliases was used to invoke it. See L<perlxs/"The ALIAS: Keyword">.
5276 Found in file XSUB.h
5280 Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
5284 Found in file XSUB.h
5288 Variable which is setup by C<xsubpp> to hold the return value for an
5289 XSUB. This is always the proper type for the XSUB. See
5290 L<perlxs/"The RETVAL Variable">.
5295 Found in file XSUB.h
5299 Used to access elements on the XSUB's stack.
5304 Found in file XSUB.h
5308 Variable which is setup by C<xsubpp> to designate the object in a C++
5309 XSUB. This is always the proper type for the C++ object. See C<CLASS> and
5310 L<perlxs/"Using XS With C++">.
5315 Found in file XSUB.h
5319 Macro to declare an XSUB and its C parameter list. This is handled by
5323 Found in file XSUB.h
5325 =item XSRETURN_EMPTY
5327 Return an empty list from an XSUB immediately.
5333 Found in file XSUB.h
5337 The version identifier for an XS module. This is usually
5338 handled automatically by C<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>.
5341 Found in file XSUB.h
5343 =item XS_VERSION_BOOTCHECK
5345 Macro to verify that a PM module's $VERSION variable matches the XS
5346 module's C<XS_VERSION> variable. This is usually handled automatically by
5347 C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">.
5349 XS_VERSION_BOOTCHECK;
5352 Found in file XSUB.h
5357 =head1 Warning and Dieing
5363 This is the XSUB-writer's interface to Perl's C<die> function.
5364 Normally use this function the same way you use the C C<printf>
5365 function. See C<warn>.
5367 If you want to throw an exception object, assign the object to
5368 C<$@> and then pass C<Nullch> to croak():
5370 errsv = get_sv("@", TRUE);
5371 sv_setsv(errsv, exception_object);
5374 void croak(const char* pat, ...)
5377 Found in file util.c
5381 This is the XSUB-writer's interface to Perl's C<warn> function. Use this
5382 function the same way you use the C C<printf> function. See
5385 void warn(const char* pat, ...)
5388 Found in file util.c
5395 Until May 1997, this document was maintained by Jeff Okamoto
5396 <okamoto@corp.hp.com>. It is now maintained as part of Perl itself.
5398 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
5399 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
5400 Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
5401 Stephen McCamant, and Gurusamy Sarathy.
5403 API Listing originally by Dean Roehrich <roehrich@cray.com>.
5405 Updated to be autogenerated from comments in the source by Benjamin Stuhl.
5409 perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
projects / p5sagit/p5-mst-13.2.git / blob