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 Evaluates the hash in scalar context and returns the result. Handles magic when the hash is tied.
1287 SV* hv_scalar(HV* hv)
1294 Stores an SV in a hash. The hash key is specified as C<key> and C<klen> is
1295 the length of the key. The C<hash> parameter is the precomputed hash
1296 value; if it is zero then Perl will compute it. The return value will be
1297 NULL if the operation failed or if the value did not need to be actually
1298 stored within the hash (as in the case of tied hashes). Otherwise it can
1299 be dereferenced to get the original C<SV*>. Note that the caller is
1300 responsible for suitably incrementing the reference count of C<val> before
1301 the call, and decrementing it if the function returned NULL. Effectively
1302 a successful hv_store takes ownership of one reference to C<val>. This is
1303 usually what you want; a newly created SV has a reference count of one, so
1304 if all your code does is create SVs then store them in a hash, hv_store
1305 will own the only reference to the new SV, and your code doesn't need to do
1306 anything further to tidy up. hv_store is not implemented as a call to
1307 hv_store_ent, and does not create a temporary SV for the key, so if your
1308 key data is not already in SV form then use hv_store in preference to
1311 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1312 information on how to use this function on tied hashes.
1314 SV** hv_store(HV* tb, const char* key, I32 klen, SV* val, U32 hash)
1321 Stores C<val> in a hash. The hash key is specified as C<key>. The C<hash>
1322 parameter is the precomputed hash value; if it is zero then Perl will
1323 compute it. The return value is the new hash entry so created. It will be
1324 NULL if the operation failed or if the value did not need to be actually
1325 stored within the hash (as in the case of tied hashes). Otherwise the
1326 contents of the return value can be accessed using the C<He?> macros
1327 described here. Note that the caller is responsible for suitably
1328 incrementing the reference count of C<val> before the call, and
1329 decrementing it if the function returned NULL. Effectively a successful
1330 hv_store_ent takes ownership of one reference to C<val>. This is
1331 usually what you want; a newly created SV has a reference count of one, so
1332 if all your code does is create SVs then store them in a hash, hv_store
1333 will own the only reference to the new SV, and your code doesn't need to do
1334 anything further to tidy up. Note that hv_store_ent only reads the C<key>;
1335 unlike C<val> it does not take ownership of it, so maintaining the correct
1336 reference count on C<key> is entirely the caller's responsibility. hv_store
1337 is not implemented as a call to hv_store_ent, and does not create a temporary
1338 SV for the key, so if your key data is not already in SV form then use
1339 hv_store in preference to hv_store_ent.
1341 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1342 information on how to use this function on tied hashes.
1344 HE* hv_store_ent(HV* tb, SV* key, SV* val, U32 hash)
1353 void hv_undef(HV* tb)
1360 Creates a new HV. The reference count is set to 1.
1378 =head1 Magical Functions
1384 Clear something magical that the SV represents. See C<sv_magic>.
1386 int mg_clear(SV* sv)
1393 Copies the magic from one SV to another. See C<sv_magic>.
1395 int mg_copy(SV* sv, SV* nsv, const char* key, I32 klen)
1402 Finds the magic pointer for type matching the SV. See C<sv_magic>.
1404 MAGIC* mg_find(SV* sv, int type)
1411 Free any magic storage used by the SV. See C<sv_magic>.
1420 Do magic after a value is retrieved from the SV. See C<sv_magic>.
1429 Report on the SV's length. See C<sv_magic>.
1431 U32 mg_length(SV* sv)
1438 Turns on the magical status of an SV. See C<sv_magic>.
1440 void mg_magical(SV* sv)
1447 Do magic after a value is assigned to the SV. See C<sv_magic>.
1456 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
1457 argument more than once.
1459 void SvGETMAGIC(SV* sv)
1466 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
1476 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
1477 argument more than once.
1479 void SvSETMAGIC(SV* sv)
1486 Like C<SvSetSV>, but does any set magic required afterwards.
1488 void SvSetMagicSV(SV* dsb, SV* ssv)
1493 =item SvSetMagicSV_nosteal
1495 Like C<SvSetMagicSV>, but does any set magic required afterwards.
1497 void SvSetMagicSV_nosteal(SV* dsv, SV* ssv)
1504 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
1507 void SvSetSV(SV* dsb, SV* ssv)
1512 =item SvSetSV_nosteal
1514 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
1515 ssv. May evaluate arguments more than once.
1517 void SvSetSV_nosteal(SV* dsv, SV* ssv)
1524 Arranges for sv to be shared between threads if a suitable module
1527 void SvSHARE(SV* sv)
1535 =head1 Memory Management
1541 The XSUB-writer's interface to the C C<memcpy> function. The C<src> is the
1542 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1543 the type. May fail on overlapping copies. See also C<Move>.
1545 void Copy(void* src, void* dest, int nitems, type)
1548 Found in file handy.h
1552 The XSUB-writer's interface to the C C<memmove> function. The C<src> is the
1553 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1554 the type. Can do overlapping moves. See also C<Copy>.
1556 void Move(void* src, void* dest, int nitems, type)
1559 Found in file handy.h
1563 The XSUB-writer's interface to the C C<malloc> function.
1565 void New(int id, void* ptr, int nitems, type)
1568 Found in file handy.h
1572 The XSUB-writer's interface to the C C<malloc> function, with
1575 void Newc(int id, void* ptr, int nitems, type, cast)
1578 Found in file handy.h
1582 Creates a new SV. A non-zero C<len> parameter indicates the number of
1583 bytes of preallocated string space the SV should have. An extra byte for a
1584 tailing NUL is also reserved. (SvPOK is not set for the SV even if string
1585 space is allocated.) The reference count for the new SV is set to 1.
1586 C<id> is an integer id between 0 and 1299 (used to identify leaks).
1589 SV* NEWSV(int id, STRLEN len)
1592 Found in file handy.h
1596 The XSUB-writer's interface to the C C<malloc> function. The allocated
1597 memory is zeroed with C<memzero>.
1599 void Newz(int id, void* ptr, int nitems, type)
1602 Found in file handy.h
1606 Fill up memory with a pattern (byte 0xAB over and over again) that
1607 hopefully catches attempts to access uninitialized memory.
1609 void Poison(void* dest, int nitems, type)
1612 Found in file handy.h
1616 The XSUB-writer's interface to the C C<realloc> function.
1618 void Renew(void* ptr, int nitems, type)
1621 Found in file handy.h
1625 The XSUB-writer's interface to the C C<realloc> function, with
1628 void Renewc(void* ptr, int nitems, type, cast)
1631 Found in file handy.h
1635 The XSUB-writer's interface to the C C<free> function.
1637 void Safefree(void* ptr)
1640 Found in file handy.h
1644 Perl's version of C<strdup()>. Returns a pointer to a newly allocated
1645 string which is a duplicate of C<pv>. The size of the string is
1646 determined by C<strlen()>. The memory allocated for the new string can
1647 be freed with the C<Safefree()> function.
1649 char* savepv(const char* pv)
1652 Found in file util.c
1656 Perl's version of what C<strndup()> would be if it existed. Returns a
1657 pointer to a newly allocated string which is a duplicate of the first
1658 C<len> bytes from C<pv>. The memory allocated for the new string can be
1659 freed with the C<Safefree()> function.
1661 char* savepvn(const char* pv, I32 len)
1664 Found in file util.c
1668 A version of C<savepv()> which allocates the duplicate string in memory
1669 which is shared between threads.
1671 char* savesharedpv(const char* pv)
1674 Found in file util.c
1678 This is an architecture-independent macro to copy one structure to another.
1680 void StructCopy(type src, type dest, type)
1683 Found in file handy.h
1687 The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the
1688 destination, C<nitems> is the number of items, and C<type> is the type.
1690 void Zero(void* dest, int nitems, type)
1693 Found in file handy.h
1698 =head1 Miscellaneous Functions
1704 Analyses the string in order to make fast searches on it using fbm_instr()
1705 -- the Boyer-Moore algorithm.
1707 void fbm_compile(SV* sv, U32 flags)
1710 Found in file util.c
1714 Returns the location of the SV in the string delimited by C<str> and
1715 C<strend>. It returns C<Nullch> if the string can't be found. The C<sv>
1716 does not have to be fbm_compiled, but the search will not be as fast
1719 char* fbm_instr(unsigned char* big, unsigned char* bigend, SV* littlesv, U32 flags)
1722 Found in file util.c
1726 Takes a sprintf-style format pattern and conventional
1727 (non-SV) arguments and returns the formatted string.
1729 (char *) Perl_form(pTHX_ const char* pat, ...)
1731 can be used any place a string (char *) is required:
1733 char * s = Perl_form("%d.%d",major,minor);
1735 Uses a single private buffer so if you want to format several strings you
1736 must explicitly copy the earlier strings away (and free the copies when you
1739 char* form(const char* pat, ...)
1742 Found in file util.c
1746 Fill the sv with current working directory
1748 int getcwd_sv(SV* sv)
1751 Found in file util.c
1755 Returns a new version object based on the passed in SV:
1757 SV *sv = new_version(SV *ver);
1759 Does not alter the passed in ver SV. See "upg_version" if you
1760 want to upgrade the SV.
1762 SV* new_version(SV *ver)
1765 Found in file util.c
1769 Returns a pointer to the next character after the parsed
1770 version string, as well as upgrading the passed in SV to
1773 Function must be called with an already existing SV like
1776 s = scan_version(s,SV *sv, bool qv);
1778 Performs some preprocessing to the string to ensure that
1779 it has the correct characteristics of a version. Flags the
1780 object if it contains an underscore (which denotes this
1781 is a alpha version). The boolean qv denotes that the version
1782 should be interpreted as if it had multiple decimals, even if
1785 char* scan_version(char *vstr, SV *sv, bool qv)
1788 Found in file util.c
1792 Test two strings to see if they are equal. Returns true or false.
1794 bool strEQ(char* s1, char* s2)
1797 Found in file handy.h
1801 Test two strings to see if the first, C<s1>, is greater than or equal to
1802 the second, C<s2>. Returns true or false.
1804 bool strGE(char* s1, char* s2)
1807 Found in file handy.h
1811 Test two strings to see if the first, C<s1>, is greater than the second,
1812 C<s2>. Returns true or false.
1814 bool strGT(char* s1, char* s2)
1817 Found in file handy.h
1821 Test two strings to see if the first, C<s1>, is less than or equal to the
1822 second, C<s2>. Returns true or false.
1824 bool strLE(char* s1, char* s2)
1827 Found in file handy.h
1831 Test two strings to see if the first, C<s1>, is less than the second,
1832 C<s2>. Returns true or false.
1834 bool strLT(char* s1, char* s2)
1837 Found in file handy.h
1841 Test two strings to see if they are different. Returns true or
1844 bool strNE(char* s1, char* s2)
1847 Found in file handy.h
1851 Test two strings to see if they are equal. The C<len> parameter indicates
1852 the number of bytes to compare. Returns true or false. (A wrapper for
1855 bool strnEQ(char* s1, char* s2, STRLEN len)
1858 Found in file handy.h
1862 Test two strings to see if they are different. The C<len> parameter
1863 indicates the number of bytes to compare. Returns true or false. (A
1864 wrapper for C<strncmp>).
1866 bool strnNE(char* s1, char* s2, STRLEN len)
1869 Found in file handy.h
1873 Dummy routine which "locks" an SV when there is no locking 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_nolocking(SV *)
1880 Found in file util.c
1884 Dummy routine which "shares" an SV when there is no sharing 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_nosharing(SV *)
1891 Found in file util.c
1893 =item sv_nounlocking
1895 Dummy routine which "unlocks" an SV when there is no locking module present.
1896 Exists to avoid test for a NULL function pointer and because it could potentially warn under
1897 some level of strict-ness.
1899 void sv_nounlocking(SV *)
1902 Found in file util.c
1906 In-place upgrade of the supplied SV to a version object.
1908 SV *sv = upg_version(SV *sv);
1910 Returns a pointer to the upgraded SV.
1912 SV* upg_version(SV *ver)
1915 Found in file util.c
1919 Version object aware cmp. Both operands must already have been
1920 converted into version objects.
1922 int vcmp(SV *lvs, SV *rvs)
1925 Found in file util.c
1929 Accepts a version object and returns the normalized floating
1930 point representation. Call like:
1934 NOTE: you can pass either the object directly or the SV
1935 contained within the RV.
1940 Found in file util.c
1944 Accepts a version object and returns the normalized string
1945 representation. Call like:
1947 sv = vstringify(rv);
1949 NOTE: you can pass either the object directly or the SV
1950 contained within the RV.
1952 SV* vstringify(SV *vs)
1955 Found in file util.c
1960 =head1 Numeric functions
1966 converts a string representing a binary number to numeric form.
1968 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
1969 conversion flags, and I<result> should be NULL or a pointer to an NV.
1970 The scan stops at the end of the string, or the first invalid character.
1971 On return I<*len> is set to the length scanned string, and I<*flags> gives
1974 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
1975 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_bin>
1976 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
1977 and writes the value to I<*result> (or the value is discarded if I<result>
1980 The hex number may optionally be prefixed with "0b" or "b" unless
1981 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
1982 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the binary
1983 number may use '_' characters to separate digits.
1985 UV grok_bin(char* start, STRLEN* len, I32* flags, NV *result)
1988 Found in file numeric.c
1992 converts a string representing a hex number to numeric form.
1994 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
1995 conversion flags, and I<result> should be NULL or a pointer to an NV.
1996 The scan stops at the end of the string, or the first non-hex-digit character.
1997 On return I<*len> is set to the length scanned string, and I<*flags> gives
2000 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2001 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_hex>
2002 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2003 and writes the value to I<*result> (or the value is discarded if I<result>
2006 The hex number may optionally be prefixed with "0x" or "x" unless
2007 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
2008 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the hex
2009 number may use '_' characters to separate digits.
2011 UV grok_hex(char* start, STRLEN* len, I32* flags, NV *result)
2014 Found in file numeric.c
2018 Recognise (or not) a number. The type of the number is returned
2019 (0 if unrecognised), otherwise it is a bit-ORed combination of
2020 IS_NUMBER_IN_UV, IS_NUMBER_GREATER_THAN_UV_MAX, IS_NUMBER_NOT_INT,
2021 IS_NUMBER_NEG, IS_NUMBER_INFINITY, IS_NUMBER_NAN (defined in perl.h).
2023 If the value of the number can fit an in UV, it is returned in the *valuep
2024 IS_NUMBER_IN_UV will be set to indicate that *valuep is valid, IS_NUMBER_IN_UV
2025 will never be set unless *valuep is valid, but *valuep may have been assigned
2026 to during processing even though IS_NUMBER_IN_UV is not set on return.
2027 If valuep is NULL, IS_NUMBER_IN_UV will be set for the same cases as when
2028 valuep is non-NULL, but no actual assignment (or SEGV) will occur.
2030 IS_NUMBER_NOT_INT will be set with IS_NUMBER_IN_UV if trailing decimals were
2031 seen (in which case *valuep gives the true value truncated to an integer), and
2032 IS_NUMBER_NEG if the number is negative (in which case *valuep holds the
2033 absolute value). IS_NUMBER_IN_UV is not set if e notation was used or the
2034 number is larger than a UV.
2036 int grok_number(const char *pv, STRLEN len, UV *valuep)
2039 Found in file numeric.c
2041 =item grok_numeric_radix
2043 Scan and skip for a numeric decimal separator (radix).
2045 bool grok_numeric_radix(const char **sp, const char *send)
2048 Found in file numeric.c
2053 UV grok_oct(char* start, STRLEN* len, I32* flags, NV *result)
2056 Found in file numeric.c
2060 For backwards compatibility. Use C<grok_bin> instead.
2062 NV scan_bin(char* start, STRLEN len, STRLEN* retlen)
2065 Found in file numeric.c
2069 For backwards compatibility. Use C<grok_hex> instead.
2071 NV scan_hex(char* start, STRLEN len, STRLEN* retlen)
2074 Found in file numeric.c
2078 For backwards compatibility. Use C<grok_oct> instead.
2080 NV scan_oct(char* start, STRLEN len, STRLEN* retlen)
2083 Found in file numeric.c
2088 =head1 Optree Manipulation Functions
2094 If C<cv> is a constant sub eligible for inlining. returns the constant
2095 value returned by the sub. Otherwise, returns NULL.
2097 Constant subs can be created with C<newCONSTSUB> or as described in
2098 L<perlsub/"Constant Functions">.
2100 SV* cv_const_sv(CV* cv)
2107 Creates a constant sub equivalent to Perl C<sub FOO () { 123 }> which is
2108 eligible for inlining at compile-time.
2110 CV* newCONSTSUB(HV* stash, char* name, SV* sv)
2117 Used by C<xsubpp> to hook up XSUBs as Perl subs.
2125 =head1 Pad Data Structures
2131 Get the value at offset po in the current pad.
2132 Use macro PAD_SV instead of calling this function directly.
2134 SV* pad_sv(PADOFFSET po)
2142 =head1 Stack Manipulation Macros
2148 Declare a stack marker variable, C<mark>, for the XSUB. See C<MARK> and
2158 Saves the original stack mark for the XSUB. See C<ORIGMARK>.
2167 Declares a local copy of perl's stack pointer for the XSUB, available via
2168 the C<SP> macro. See C<SP>.
2177 Used to extend the argument stack for an XSUB's return values. Once
2178 used, guarantees that there is room for at least C<nitems> to be pushed
2181 void EXTEND(SP, int nitems)
2188 Stack marker variable for the XSUB. See C<dMARK>.
2195 The original stack mark for the XSUB. See C<dORIGMARK>.
2202 Pops an integer off the stack.
2211 Pops a long off the stack.
2220 Pops a double off the stack.
2229 Pops a string off the stack. Deprecated. New code should provide
2230 a STRLEN n_a and use POPpx.
2239 Pops a string off the stack which must consist of bytes i.e. characters < 256.
2240 Requires a variable STRLEN n_a in scope.
2249 Pops a string off the stack.
2250 Requires a variable STRLEN n_a in scope.
2259 Pops an SV off the stack.
2268 Push an integer onto the stack. The stack must have room for this element.
2269 Handles 'set' magic. See C<XPUSHi>.
2278 Opening bracket for arguments on a callback. See C<PUTBACK> and
2288 Push a double onto the stack. The stack must have room for this element.
2289 Handles 'set' magic. See C<XPUSHn>.
2298 Push a string onto the stack. The stack must have room for this element.
2299 The C<len> indicates the length of the string. Handles 'set' magic. See
2302 void PUSHp(char* str, STRLEN len)
2309 Push an SV onto the stack. The stack must have room for this element.
2310 Does not handle 'set' magic. See C<XPUSHs>.
2319 Push an unsigned integer onto the stack. The stack must have room for this
2320 element. See C<XPUSHu>.
2329 Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
2330 See C<PUSHMARK> and L<perlcall> for other uses.
2339 Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and
2347 Refetch the stack pointer. Used after a callback. See L<perlcall>.
2356 Push an integer onto the stack, extending the stack if necessary. Handles
2357 'set' magic. See C<PUSHi>.
2366 Push a double onto the stack, extending the stack if necessary. Handles
2367 'set' magic. See C<PUSHn>.
2376 Push a string onto the stack, extending the stack if necessary. The C<len>
2377 indicates the length of the string. Handles 'set' magic. See
2380 void XPUSHp(char* str, STRLEN len)
2387 Push an SV onto the stack, extending the stack if necessary. Does not
2388 handle 'set' magic. See C<PUSHs>.
2397 Push an unsigned integer onto the stack, extending the stack if necessary.
2407 Return from XSUB, indicating number of items on the stack. This is usually
2408 handled by C<xsubpp>.
2410 void XSRETURN(int nitems)
2413 Found in file XSUB.h
2417 Return an integer from an XSUB immediately. Uses C<XST_mIV>.
2419 void XSRETURN_IV(IV iv)
2422 Found in file XSUB.h
2426 Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
2431 Found in file XSUB.h
2435 Return a double from an XSUB immediately. Uses C<XST_mNV>.
2437 void XSRETURN_NV(NV nv)
2440 Found in file XSUB.h
2444 Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
2446 void XSRETURN_PV(char* str)
2449 Found in file XSUB.h
2451 =item XSRETURN_UNDEF
2453 Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
2458 Found in file XSUB.h
2462 Return an integer from an XSUB immediately. Uses C<XST_mUV>.
2464 void XSRETURN_UV(IV uv)
2467 Found in file XSUB.h
2471 Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
2476 Found in file XSUB.h
2480 Place an integer into the specified position C<pos> on the stack. The
2481 value is stored in a new mortal SV.
2483 void XST_mIV(int pos, IV iv)
2486 Found in file XSUB.h
2490 Place C<&PL_sv_no> into the specified position C<pos> on the
2493 void XST_mNO(int pos)
2496 Found in file XSUB.h
2500 Place a double into the specified position C<pos> on the stack. The value
2501 is stored in a new mortal SV.
2503 void XST_mNV(int pos, NV nv)
2506 Found in file XSUB.h
2510 Place a copy of a string into the specified position C<pos> on the stack.
2511 The value is stored in a new mortal SV.
2513 void XST_mPV(int pos, char* str)
2516 Found in file XSUB.h
2520 Place C<&PL_sv_undef> into the specified position C<pos> on the
2523 void XST_mUNDEF(int pos)
2526 Found in file XSUB.h
2530 Place C<&PL_sv_yes> into the specified position C<pos> on the
2533 void XST_mYES(int pos)
2536 Found in file XSUB.h
2547 An enum of flags for Perl types. These are found in the file B<sv.h>
2548 in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
2555 Integer type flag for scalars. See C<svtype>.
2562 Double type flag for scalars. See C<svtype>.
2569 Pointer type flag for scalars. See C<svtype>.
2576 Type flag for arrays. See C<svtype>.
2583 Type flag for code refs. See C<svtype>.
2590 Type flag for hashes. See C<svtype>.
2597 Type flag for blessed scalars. See C<svtype>.
2605 =head1 SV Manipulation Functions
2611 Returns the SV of the specified Perl scalar. If C<create> is set and the
2612 Perl variable does not exist then it will be created. If C<create> is not
2613 set and the variable does not exist then NULL is returned.
2615 NOTE: the perl_ form of this function is deprecated.
2617 SV* get_sv(const char* name, I32 create)
2620 Found in file perl.c
2622 =item looks_like_number
2624 Test if the content of an SV looks like a number (or is a number).
2625 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
2626 non-numeric warning), even if your atof() doesn't grok them.
2628 I32 looks_like_number(SV* sv)
2635 Creates an RV wrapper for an SV. The reference count for the original SV is
2638 SV* newRV_inc(SV* sv)
2645 Creates an RV wrapper for an SV. The reference count for the original
2646 SV is B<not> incremented.
2648 SV* newRV_noinc(SV *sv)
2655 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
2656 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
2659 SV* newSV(STRLEN len)
2666 Creates a new SV and copies an integer into it. The reference count for the
2676 Creates a new SV and copies a floating point value into it.
2677 The reference count for the SV is set to 1.
2686 Creates a new SV and copies a string into it. The reference count for the
2687 SV is set to 1. If C<len> is zero, Perl will compute the length using
2688 strlen(). For efficiency, consider using C<newSVpvn> instead.
2690 SV* newSVpv(const char* s, STRLEN len)
2697 Creates a new SV and initializes it with the string formatted like
2700 SV* newSVpvf(const char* pat, ...)
2707 Creates a new SV and copies a string into it. The reference count for the
2708 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
2709 string. You are responsible for ensuring that the source string is at least
2712 SV* newSVpvn(const char* s, STRLEN len)
2717 =item newSVpvn_share
2719 Creates a new SV with its SvPVX pointing to a shared string in the string
2720 table. If the string does not already exist in the table, it is created
2721 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
2722 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
2723 otherwise the hash is computed. The idea here is that as the string table
2724 is used for shared hash keys these strings will have SvPVX == HeKEY and
2725 hash lookup will avoid string compare.
2727 SV* newSVpvn_share(const char* s, I32 len, U32 hash)
2734 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
2735 it will be upgraded to one. If C<classname> is non-null then the new SV will
2736 be blessed in the specified package. The new SV is returned and its
2737 reference count is 1.
2739 SV* newSVrv(SV* rv, const char* classname)
2746 Creates a new SV which is an exact duplicate of the original SV.
2749 SV* newSVsv(SV* old)
2756 Creates a new SV and copies an unsigned integer into it.
2757 The reference count for the SV is set to 1.
2766 Returns the length of the string which is in the SV. See C<SvLEN>.
2768 STRLEN SvCUR(SV* sv)
2775 Set the length of the string which is in the SV. See C<SvCUR>.
2777 void SvCUR_set(SV* sv, STRLEN len)
2784 Returns a pointer to the last character in the string which is in the SV.
2785 See C<SvCUR>. Access the character as *(SvEND(sv)).
2794 Expands the character buffer in the SV so that it has room for the
2795 indicated number of bytes (remember to reserve space for an extra trailing
2796 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
2797 Returns a pointer to the character buffer.
2799 char * SvGROW(SV* sv, STRLEN len)
2806 Returns a boolean indicating whether the SV contains an integer.
2815 Returns a boolean indicating whether the SV contains an integer. Checks
2816 the B<private> setting. Use C<SvIOK>.
2825 Returns a boolean indicating whether the SV contains a signed integer.
2827 bool SvIOK_notUV(SV* sv)
2834 Unsets the IV status of an SV.
2836 void SvIOK_off(SV* sv)
2843 Tells an SV that it is an integer.
2845 void SvIOK_on(SV* sv)
2852 Tells an SV that it is an integer and disables all other OK bits.
2854 void SvIOK_only(SV* sv)
2861 Tells and SV that it is an unsigned integer and disables all other OK bits.
2863 void SvIOK_only_UV(SV* sv)
2870 Returns a boolean indicating whether the SV contains an unsigned integer.
2872 bool SvIOK_UV(SV* sv)
2879 Returns a boolean indicating whether the SV is Copy-On-Write. (either shared
2880 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
2883 bool SvIsCOW(SV* sv)
2888 =item SvIsCOW_shared_hash
2890 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
2893 bool SvIsCOW_shared_hash(SV* sv)
2900 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
2901 version which guarantees to evaluate sv only once.
2910 Coerces the given SV to an integer and returns it. Guarantees to evaluate
2911 sv only once. Use the more efficient C<SvIV> otherwise.
2920 Returns the raw value in the SV's IV slot, without checks or conversions.
2921 Only use when you are sure SvIOK is true. See also C<SvIV()>.
2930 Like C<SvIV> but doesn't process magic.
2932 IV SvIV_nomg(SV* sv)
2939 Returns the size of the string buffer in the SV, not including any part
2940 attributable to C<SvOOK>. See C<SvCUR>.
2942 STRLEN SvLEN(SV* sv)
2949 Returns a boolean indicating whether the SV contains a number, integer or
2959 Returns a boolean indicating whether the SV contains a number, integer or
2960 double. Checks the B<private> setting. Use C<SvNIOK>.
2962 bool SvNIOKp(SV* sv)
2969 Unsets the NV/IV status of an SV.
2971 void SvNIOK_off(SV* sv)
2978 Returns a boolean indicating whether the SV contains a double.
2987 Returns a boolean indicating whether the SV contains a double. Checks the
2988 B<private> setting. Use C<SvNOK>.
2997 Unsets the NV status of an SV.
2999 void SvNOK_off(SV* sv)
3006 Tells an SV that it is a double.
3008 void SvNOK_on(SV* sv)
3015 Tells an SV that it is a double and disables all other OK bits.
3017 void SvNOK_only(SV* sv)
3024 Coerce the given SV to a double and return it. See C<SvNVx> for a version
3025 which guarantees to evaluate sv only once.
3034 Coerces the given SV to a double and returns it. Guarantees to evaluate
3035 sv only once. Use the more efficient C<SvNV> otherwise.
3044 Returns the raw value in the SV's NV slot, without checks or conversions.
3045 Only use when you are sure SvNOK is true. See also C<SvNV()>.
3054 Returns a boolean indicating whether the value is an SV.
3063 Returns a boolean indicating whether the SvIVX is a valid offset value for
3064 the SvPVX. This hack is used internally to speed up removal of characters
3065 from the beginning of a SvPV. When SvOOK is true, then the start of the
3066 allocated string buffer is really (SvPVX - SvIVX).
3075 Returns a boolean indicating whether the SV contains a character
3085 Returns a boolean indicating whether the SV contains a character string.
3086 Checks the B<private> setting. Use C<SvPOK>.
3095 Unsets the PV status of an SV.
3097 void SvPOK_off(SV* sv)
3104 Tells an SV that it is a string.
3106 void SvPOK_on(SV* sv)
3113 Tells an SV that it is a string and disables all other OK bits.
3114 Will also turn off the UTF-8 status.
3116 void SvPOK_only(SV* sv)
3121 =item SvPOK_only_UTF8
3123 Tells an SV that it is a string and disables all other OK bits,
3124 and leaves the UTF-8 status as it was.
3126 void SvPOK_only_UTF8(SV* sv)
3133 Returns a pointer to the string in the SV, or a stringified form of
3134 the SV if the SV does not contain a string. The SV may cache the
3135 stringified version becoming C<SvPOK>. Handles 'get' magic. See also
3136 C<SvPVx> for a version which guarantees to evaluate sv only once.
3138 char* SvPV(SV* sv, STRLEN len)
3145 Like C<SvPV>, but converts sv to byte representation first if necessary.
3147 char* SvPVbyte(SV* sv, STRLEN len)
3154 Like C<SvPV>, but converts sv to byte representation first if necessary.
3155 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
3158 char* SvPVbytex(SV* sv, STRLEN len)
3163 =item SvPVbytex_force
3165 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
3166 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
3169 char* SvPVbytex_force(SV* sv, STRLEN len)
3174 =item SvPVbyte_force
3176 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
3178 char* SvPVbyte_force(SV* sv, STRLEN len)
3183 =item SvPVbyte_nolen
3185 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
3187 char* SvPVbyte_nolen(SV* sv)
3194 Like C<SvPV>, but converts sv to utf8 first if necessary.
3196 char* SvPVutf8(SV* sv, STRLEN len)
3203 Like C<SvPV>, but converts sv to utf8 first if necessary.
3204 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
3207 char* SvPVutf8x(SV* sv, STRLEN len)
3212 =item SvPVutf8x_force
3214 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
3215 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
3218 char* SvPVutf8x_force(SV* sv, STRLEN len)
3223 =item SvPVutf8_force
3225 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
3227 char* SvPVutf8_force(SV* sv, STRLEN len)
3232 =item SvPVutf8_nolen
3234 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
3236 char* SvPVutf8_nolen(SV* sv)
3243 Returns a pointer to the physical string in the SV. The SV must contain a
3253 A version of C<SvPV> which guarantees to evaluate sv only once.
3255 char* SvPVx(SV* sv, STRLEN len)
3262 Like C<SvPV> but will force the SV into containing just a string
3263 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
3266 char* SvPV_force(SV* sv, STRLEN len)
3271 =item SvPV_force_nomg
3273 Like C<SvPV> but will force the SV into containing just a string
3274 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
3275 directly. Doesn't process magic.
3277 char* SvPV_force_nomg(SV* sv, STRLEN len)
3284 Returns a pointer to the string in the SV, or a stringified form of
3285 the SV if the SV does not contain a string. The SV may cache the
3286 stringified form becoming C<SvPOK>. Handles 'get' magic.
3288 char* SvPV_nolen(SV* sv)
3295 Like C<SvPV> but doesn't process magic.
3297 char* SvPV_nomg(SV* sv, STRLEN len)
3304 Returns the value of the object's reference count.
3306 U32 SvREFCNT(SV* sv)
3313 Decrements the reference count of the given SV.
3315 void SvREFCNT_dec(SV* sv)
3322 Increments the reference count of the given SV.
3324 SV* SvREFCNT_inc(SV* sv)
3331 Tests if the SV is an RV.
3340 Unsets the RV status of an SV.
3342 void SvROK_off(SV* sv)
3349 Tells an SV that it is an RV.
3351 void SvROK_on(SV* sv)
3358 Dereferences an RV to return the SV.
3367 Returns the stash of the SV.
3376 Taints an SV if tainting is enabled.
3378 void SvTAINT(SV* sv)
3385 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
3388 bool SvTAINTED(SV* sv)
3395 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
3396 some of Perl's fundamental security features. XS module authors should not
3397 use this function unless they fully understand all the implications of
3398 unconditionally untainting the value. Untainting should be done in the
3399 standard perl fashion, via a carefully crafted regexp, rather than directly
3400 untainting variables.
3402 void SvTAINTED_off(SV* sv)
3409 Marks an SV as tainted if tainting is enabled.
3411 void SvTAINTED_on(SV* sv)
3418 Returns a boolean indicating whether Perl would evaluate the SV as true or
3419 false, defined or undefined. Does not handle 'get' magic.
3428 Returns the type of the SV. See C<svtype>.
3430 svtype SvTYPE(SV* sv)
3437 Releases a mutual exclusion lock on sv if a suitable module
3441 void SvUNLOCK(SV* sv)
3448 Returns a boolean indicating whether the SV contains an unsigned integer.
3457 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
3458 perform the upgrade if necessary. See C<svtype>.
3460 void SvUPGRADE(SV* sv, svtype type)
3467 Returns a boolean indicating whether the SV contains UTF-8 encoded data.
3476 Unsets the UTF-8 status of an SV.
3478 void SvUTF8_off(SV *sv)
3485 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
3486 Do not use frivolously.
3488 void SvUTF8_on(SV *sv)
3495 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
3496 for a version which guarantees to evaluate sv only once.
3505 Coerces the given SV to an unsigned integer and returns it. Guarantees to
3506 evaluate sv only once. Use the more efficient C<SvUV> otherwise.
3515 Returns the raw value in the SV's UV slot, without checks or conversions.
3516 Only use when you are sure SvIOK is true. See also C<SvUV()>.
3525 Like C<SvUV> but doesn't process magic.
3527 UV SvUV_nomg(SV* sv)
3534 Returns a boolean indicating whether the SV contains a v-string.
3543 This function is only called on magical items, and is only used by
3544 sv_true() or its macro equivalent.
3546 bool sv_2bool(SV* sv)
3553 Using various gambits, try to get a CV from an SV; in addition, try if
3554 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
3556 CV* sv_2cv(SV* sv, HV** st, GV** gvp, I32 lref)
3563 Using various gambits, try to get an IO from an SV: the IO slot if its a
3564 GV; or the recursive result if we're an RV; or the IO slot of the symbol
3565 named after the PV if we're a string.
3574 Return the integer value of an SV, doing any necessary string
3575 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
3576 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
3578 IV sv_2iv_flags(SV* sv, I32 flags)
3585 Marks an existing SV as mortal. The SV will be destroyed "soon", either
3586 by an explicit call to FREETMPS, or by an implicit call at places such as
3587 statement boundaries. See also C<sv_newmortal> and C<sv_mortalcopy>.
3589 SV* sv_2mortal(SV* sv)
3596 Return the num value of an SV, doing any necessary string or integer
3597 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
3607 Return a pointer to the byte-encoded representation of the SV, and set *lp
3608 to its length. May cause the SV to be downgraded from UTF-8 as a
3611 Usually accessed via the C<SvPVbyte> macro.
3613 char* sv_2pvbyte(SV* sv, STRLEN* lp)
3618 =item sv_2pvbyte_nolen
3620 Return a pointer to the byte-encoded representation of the SV.
3621 May cause the SV to be downgraded from UTF-8 as a side-effect.
3623 Usually accessed via the C<SvPVbyte_nolen> macro.
3625 char* sv_2pvbyte_nolen(SV* sv)
3632 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3633 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
3635 Usually accessed via the C<SvPVutf8> macro.
3637 char* sv_2pvutf8(SV* sv, STRLEN* lp)
3642 =item sv_2pvutf8_nolen
3644 Return a pointer to the UTF-8-encoded representation of the SV.
3645 May cause the SV to be upgraded to UTF-8 as a side-effect.
3647 Usually accessed via the C<SvPVutf8_nolen> macro.
3649 char* sv_2pvutf8_nolen(SV* sv)
3656 Returns a pointer to the string value of an SV, and sets *lp to its length.
3657 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
3659 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
3660 usually end up here too.
3662 char* sv_2pv_flags(SV* sv, STRLEN* lp, I32 flags)
3669 Like C<sv_2pv()>, but doesn't return the length too. You should usually
3670 use the macro wrapper C<SvPV_nolen(sv)> instead.
3671 char* sv_2pv_nolen(SV* sv)
3678 Return the unsigned integer value of an SV, doing any necessary string
3679 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
3680 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
3682 UV sv_2uv_flags(SV* sv, I32 flags)
3689 Remove any string offset. You should normally use the C<SvOOK_off> macro
3692 int sv_backoff(SV* sv)
3699 Blesses an SV into a specified package. The SV must be an RV. The package
3700 must be designated by its stash (see C<gv_stashpv()>). The reference count
3701 of the SV is unaffected.
3703 SV* sv_bless(SV* sv, HV* stash)
3710 Concatenates the string onto the end of the string which is in the SV.
3711 If the SV has the UTF-8 status set, then the bytes appended should be
3712 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
3714 void sv_catpv(SV* sv, const char* ptr)
3721 Processes its arguments like C<sprintf> and appends the formatted
3722 output to an SV. If the appended data contains "wide" characters
3723 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
3724 and characters >255 formatted with %c), the original SV might get
3725 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic.
3726 C<SvSETMAGIC()> must typically be called after calling this function
3727 to handle 'set' magic.
3729 void sv_catpvf(SV* sv, const char* pat, ...)
3736 Like C<sv_catpvf>, but also handles 'set' magic.
3738 void sv_catpvf_mg(SV *sv, const char* pat, ...)
3745 Concatenates the string onto the end of the string which is in the SV. The
3746 C<len> indicates number of bytes to copy. If the SV has the UTF-8
3747 status set, then the bytes appended should be valid UTF-8.
3748 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
3750 void sv_catpvn(SV* sv, const char* ptr, STRLEN len)
3755 =item sv_catpvn_flags
3757 Concatenates the string onto the end of the string which is in the SV. The
3758 C<len> indicates number of bytes to copy. If the SV has the UTF-8
3759 status set, then the bytes appended should be valid UTF-8.
3760 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
3761 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
3762 in terms of this function.
3764 void sv_catpvn_flags(SV* sv, const char* ptr, STRLEN len, I32 flags)
3771 Like C<sv_catpvn>, but also handles 'set' magic.
3773 void sv_catpvn_mg(SV *sv, const char *ptr, STRLEN len)
3780 Like C<sv_catpv>, but also handles 'set' magic.
3782 void sv_catpv_mg(SV *sv, const char *ptr)
3789 Concatenates the string from SV C<ssv> onto the end of the string in
3790 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
3791 not 'set' magic. See C<sv_catsv_mg>.
3793 void sv_catsv(SV* dsv, SV* ssv)
3798 =item sv_catsv_flags
3800 Concatenates the string from SV C<ssv> onto the end of the string in
3801 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
3802 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
3803 and C<sv_catsv_nomg> are implemented in terms of this function.
3805 void sv_catsv_flags(SV* dsv, SV* ssv, I32 flags)
3812 Like C<sv_catsv>, but also handles 'set' magic.
3814 void sv_catsv_mg(SV *dstr, SV *sstr)
3821 Efficient removal of characters from the beginning of the string buffer.
3822 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
3823 the string buffer. The C<ptr> becomes the first character of the adjusted
3824 string. Uses the "OOK hack".
3825 Beware: after this function returns, C<ptr> and SvPVX(sv) may no longer
3826 refer to the same chunk of data.
3828 void sv_chop(SV* sv, char* ptr)
3835 Clear an SV: call any destructors, free up any memory used by the body,
3836 and free the body itself. The SV's head is I<not> freed, although
3837 its type is set to all 1's so that it won't inadvertently be assumed
3838 to be live during global destruction etc.
3839 This function should only be called when REFCNT is zero. Most of the time
3840 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
3843 void sv_clear(SV* sv)
3850 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
3851 string in C<sv1> is less than, equal to, or greater than the string in
3852 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
3853 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
3855 I32 sv_cmp(SV* sv1, SV* sv2)
3862 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
3863 'use bytes' aware, handles get magic, and will coerce its args to strings
3864 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
3866 I32 sv_cmp_locale(SV* sv1, SV* sv2)
3873 Add Collate Transform magic to an SV if it doesn't already have it.
3875 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
3876 scalar data of the variable, but transformed to such a format that a normal
3877 memory comparison can be used to compare the data according to the locale
3880 char* sv_collxfrm(SV* sv, STRLEN* nxp)
3887 Copies a stringified representation of the source SV into the
3888 destination SV. Automatically performs any necessary mg_get and
3889 coercion of numeric values into strings. Guaranteed to preserve
3890 UTF-8 flag even from overloaded objects. Similar in nature to
3891 sv_2pv[_flags] but operates directly on an SV instead of just the
3892 string. Mostly uses sv_2pv_flags to do its work, except when that
3893 would lose the UTF-8'ness of the PV.
3895 void sv_copypv(SV* dsv, SV* ssv)
3902 Auto-decrement of the value in the SV, doing string to numeric conversion
3903 if necessary. Handles 'get' magic.
3910 =item sv_derived_from
3912 Returns a boolean indicating whether the SV is derived from the specified
3913 class. This is the function that implements C<UNIVERSAL::isa>. It works
3914 for class names as well as for objects.
3916 bool sv_derived_from(SV* sv, const char* name)
3919 Found in file universal.c
3923 Returns a boolean indicating whether the strings in the two SVs are
3924 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
3925 coerce its args to strings if necessary.
3927 I32 sv_eq(SV* sv1, SV* sv2)
3932 =item sv_force_normal
3934 Undo various types of fakery on an SV: if the PV is a shared string, make
3935 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3936 an xpvmg. See also C<sv_force_normal_flags>.
3938 void sv_force_normal(SV *sv)
3943 =item sv_force_normal_flags
3945 Undo various types of fakery on an SV: if the PV is a shared string, make
3946 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3947 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
3948 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
3949 then a copy-on-write scalar drops its PV buffer (if any) and becomes
3950 SvPOK_off rather than making a copy. (Used where this scalar is about to be
3951 set to some other value.) In addition, the C<flags> parameter gets passed to
3952 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
3953 with flags set to 0.
3955 void sv_force_normal_flags(SV *sv, U32 flags)
3962 Decrement an SV's reference count, and if it drops to zero, call
3963 C<sv_clear> to invoke destructors and free up any memory used by
3964 the body; finally, deallocate the SV's head itself.
3965 Normally called via a wrapper macro C<SvREFCNT_dec>.
3967 void sv_free(SV* sv)
3974 Get a line from the filehandle and store it into the SV, optionally
3975 appending to the currently-stored string.
3977 char* sv_gets(SV* sv, PerlIO* fp, I32 append)
3984 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
3985 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
3986 Use the C<SvGROW> wrapper instead.
3988 char* sv_grow(SV* sv, STRLEN newlen)
3995 Auto-increment of the value in the SV, doing string to numeric conversion
3996 if necessary. Handles 'get' magic.
4005 Inserts a string at the specified offset/length within the SV. Similar to
4006 the Perl substr() function.
4008 void sv_insert(SV* bigsv, STRLEN offset, STRLEN len, char* little, STRLEN littlelen)
4015 Returns a boolean indicating whether the SV is blessed into the specified
4016 class. This does not check for subtypes; use C<sv_derived_from> to verify
4017 an inheritance relationship.
4019 int sv_isa(SV* sv, const char* name)
4026 Returns a boolean indicating whether the SV is an RV pointing to a blessed
4027 object. If the SV is not an RV, or if the object is not blessed, then this
4030 int sv_isobject(SV* sv)
4037 A private implementation of the C<SvIVx> macro for compilers which can't
4038 cope with complex macro expressions. Always use the macro instead.
4047 Returns the length of the string in the SV. Handles magic and type
4048 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
4050 STRLEN sv_len(SV* sv)
4057 Returns the number of characters in the string in an SV, counting wide
4058 UTF-8 bytes as a single character. Handles magic and type coercion.
4060 STRLEN sv_len_utf8(SV* sv)
4067 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4068 then adds a new magic item of type C<how> to the head of the magic list.
4070 void sv_magic(SV* sv, SV* obj, int how, const char* name, I32 namlen)
4077 Adds magic to an SV, upgrading it if necessary. Applies the
4078 supplied vtable and returns pointer to the magic added.
4080 Note that sv_magicext will allow things that sv_magic will not.
4081 In particular you can add magic to SvREADONLY SVs and and more than
4082 one instance of the same 'how'
4084 I C<namelen> is greater then zero then a savepvn() I<copy> of C<name> is stored,
4085 if C<namelen> is zero then C<name> is stored as-is and - as another special
4086 case - if C<(name && namelen == HEf_SVKEY)> then C<name> is assumed to contain
4087 an C<SV*> and has its REFCNT incremented
4089 (This is now used as a subroutine by sv_magic.)
4091 MAGIC * sv_magicext(SV* sv, SV* obj, int how, MGVTBL *vtbl, const char* name, I32 namlen )
4098 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
4099 The new SV is marked as mortal. It will be destroyed "soon", either by an
4100 explicit call to FREETMPS, or by an implicit call at places such as
4101 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
4103 SV* sv_mortalcopy(SV* oldsv)
4110 Creates a new null SV which is mortal. The reference count of the SV is
4111 set to 1. It will be destroyed "soon", either by an explicit call to
4112 FREETMPS, or by an implicit call at places such as statement boundaries.
4113 See also C<sv_mortalcopy> and C<sv_2mortal>.
4122 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
4125 SV* sv_newref(SV* sv)
4132 A private implementation of the C<SvNVx> macro for compilers which can't
4133 cope with complex macro expressions. Always use the macro instead.
4142 Converts the value pointed to by offsetp from a count of bytes from the
4143 start of the string, to a count of the equivalent number of UTF-8 chars.
4144 Handles magic and type coercion.
4146 void sv_pos_b2u(SV* sv, I32* offsetp)
4153 Converts the value pointed to by offsetp from a count of UTF-8 chars from
4154 the start of the string, to a count of the equivalent number of bytes; if
4155 lenp is non-zero, it does the same to lenp, but this time starting from
4156 the offset, rather than from the start of the string. Handles magic and
4159 void sv_pos_u2b(SV* sv, I32* offsetp, I32* lenp)
4166 Use the C<SvPV_nolen> macro instead
4175 Use C<SvPVbyte_nolen> instead.
4177 char* sv_pvbyte(SV *sv)
4184 A private implementation of the C<SvPVbyte> macro for compilers
4185 which can't cope with complex macro expressions. Always use the macro
4188 char* sv_pvbyten(SV *sv, STRLEN *len)
4193 =item sv_pvbyten_force
4195 A private implementation of the C<SvPVbytex_force> macro for compilers
4196 which can't cope with complex macro expressions. Always use the macro
4199 char* sv_pvbyten_force(SV* sv, STRLEN* lp)
4206 A private implementation of the C<SvPV> macro for compilers which can't
4207 cope with complex macro expressions. Always use the macro instead.
4209 char* sv_pvn(SV *sv, STRLEN *len)
4216 Get a sensible string out of the SV somehow.
4217 A private implementation of the C<SvPV_force> macro for compilers which
4218 can't cope with complex macro expressions. Always use the macro instead.
4220 char* sv_pvn_force(SV* sv, STRLEN* lp)
4225 =item sv_pvn_force_flags
4227 Get a sensible string out of the SV somehow.
4228 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
4229 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
4230 implemented in terms of this function.
4231 You normally want to use the various wrapper macros instead: see
4232 C<SvPV_force> and C<SvPV_force_nomg>
4234 char* sv_pvn_force_flags(SV* sv, STRLEN* lp, I32 flags)
4241 Use the C<SvPVutf8_nolen> macro instead
4243 char* sv_pvutf8(SV *sv)
4250 A private implementation of the C<SvPVutf8> macro for compilers
4251 which can't cope with complex macro expressions. Always use the macro
4254 char* sv_pvutf8n(SV *sv, STRLEN *len)
4259 =item sv_pvutf8n_force
4261 A private implementation of the C<SvPVutf8_force> macro for compilers
4262 which can't cope with complex macro expressions. Always use the macro
4265 char* sv_pvutf8n_force(SV* sv, STRLEN* lp)
4272 Returns a string describing what the SV is a reference to.
4274 char* sv_reftype(SV* sv, int ob)
4281 Make the first argument a copy of the second, then delete the original.
4282 The target SV physically takes over ownership of the body of the source SV
4283 and inherits its flags; however, the target keeps any magic it owns,
4284 and any magic in the source is discarded.
4285 Note that this is a rather specialist SV copying operation; most of the
4286 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4288 void sv_replace(SV* sv, SV* nsv)
4293 =item sv_report_used
4295 Dump the contents of all SVs not yet freed. (Debugging aid).
4297 void sv_report_used()
4304 Underlying implementation for the C<reset> Perl function.
4305 Note that the perl-level function is vaguely deprecated.
4307 void sv_reset(char* s, HV* stash)
4314 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4315 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4316 push a back-reference to this RV onto the array of backreferences
4317 associated with that magic.
4319 SV* sv_rvweaken(SV *sv)
4326 Copies an integer into the given SV, upgrading first if necessary.
4327 Does not handle 'set' magic. See also C<sv_setiv_mg>.
4329 void sv_setiv(SV* sv, IV num)
4336 Like C<sv_setiv>, but also handles 'set' magic.
4338 void sv_setiv_mg(SV *sv, IV i)
4345 Copies a double into the given SV, upgrading first if necessary.
4346 Does not handle 'set' magic. See also C<sv_setnv_mg>.
4348 void sv_setnv(SV* sv, NV num)
4355 Like C<sv_setnv>, but also handles 'set' magic.
4357 void sv_setnv_mg(SV *sv, NV num)
4364 Copies a string into an SV. The string must be null-terminated. Does not
4365 handle 'set' magic. See C<sv_setpv_mg>.
4367 void sv_setpv(SV* sv, const char* ptr)
4374 Processes its arguments like C<sprintf> and sets an SV to the formatted
4375 output. Does not handle 'set' magic. See C<sv_setpvf_mg>.
4377 void sv_setpvf(SV* sv, const char* pat, ...)
4384 Like C<sv_setpvf>, but also handles 'set' magic.
4386 void sv_setpvf_mg(SV *sv, const char* pat, ...)
4393 Copies an integer into the given SV, also updating its string value.
4394 Does not handle 'set' magic. See C<sv_setpviv_mg>.
4396 void sv_setpviv(SV* sv, IV num)
4403 Like C<sv_setpviv>, but also handles 'set' magic.
4405 void sv_setpviv_mg(SV *sv, IV iv)
4412 Copies a string into an SV. The C<len> parameter indicates the number of
4413 bytes to be copied. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4415 void sv_setpvn(SV* sv, const char* ptr, STRLEN len)
4422 Like C<sv_setpvn>, but also handles 'set' magic.
4424 void sv_setpvn_mg(SV *sv, const char *ptr, STRLEN len)
4431 Like C<sv_setpv>, but also handles 'set' magic.
4433 void sv_setpv_mg(SV *sv, const char *ptr)
4440 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
4441 argument will be upgraded to an RV. That RV will be modified to point to
4442 the new SV. The C<classname> argument indicates the package for the
4443 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4444 will have a reference count of 1, and the RV will be returned.
4446 SV* sv_setref_iv(SV* rv, const char* classname, IV iv)
4453 Copies a double into a new SV, optionally blessing the SV. The C<rv>
4454 argument will be upgraded to an RV. That RV will be modified to point to
4455 the new SV. The C<classname> argument indicates the package for the
4456 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4457 will have a reference count of 1, and the RV will be returned.
4459 SV* sv_setref_nv(SV* rv, const char* classname, NV nv)
4466 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
4467 argument will be upgraded to an RV. That RV will be modified to point to
4468 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
4469 into the SV. The C<classname> argument indicates the package for the
4470 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4471 will have a reference count of 1, and the RV will be returned.
4473 Do not use with other Perl types such as HV, AV, SV, CV, because those
4474 objects will become corrupted by the pointer copy process.
4476 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
4478 SV* sv_setref_pv(SV* rv, const char* classname, void* pv)
4485 Copies a string into a new SV, optionally blessing the SV. The length of the
4486 string must be specified with C<n>. The C<rv> argument will be upgraded to
4487 an RV. That RV will be modified to point to the new SV. The C<classname>
4488 argument indicates the package for the blessing. Set C<classname> to
4489 C<Nullch> to avoid the blessing. The new SV will have a reference count
4490 of 1, and the RV will be returned.
4492 Note that C<sv_setref_pv> copies the pointer while this copies the string.
4494 SV* sv_setref_pvn(SV* rv, const char* classname, char* pv, STRLEN n)
4501 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
4502 argument will be upgraded to an RV. That RV will be modified to point to
4503 the new SV. The C<classname> argument indicates the package for the
4504 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4505 will have a reference count of 1, and the RV will be returned.
4507 SV* sv_setref_uv(SV* rv, const char* classname, UV uv)
4514 Copies the contents of the source SV C<ssv> into the destination SV
4515 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4516 function if the source SV needs to be reused. Does not handle 'set' magic.
4517 Loosely speaking, it performs a copy-by-value, obliterating any previous
4518 content of the destination.
4520 You probably want to use one of the assortment of wrappers, such as
4521 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4522 C<SvSetMagicSV_nosteal>.
4524 void sv_setsv(SV* dsv, SV* ssv)
4529 =item sv_setsv_flags
4531 Copies the contents of the source SV C<ssv> into the destination SV
4532 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4533 function if the source SV needs to be reused. Does not handle 'set' magic.
4534 Loosely speaking, it performs a copy-by-value, obliterating any previous
4535 content of the destination.
4536 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
4537 C<ssv> if appropriate, else not. C<sv_setsv> and C<sv_setsv_nomg> are
4538 implemented in terms of this function.
4540 You probably want to use one of the assortment of wrappers, such as
4541 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4542 C<SvSetMagicSV_nosteal>.
4544 This is the primary function for copying scalars, and most other
4545 copy-ish functions and macros use this underneath.
4547 void sv_setsv_flags(SV* dsv, SV* ssv, I32 flags)
4554 Like C<sv_setsv>, but also handles 'set' magic.
4556 void sv_setsv_mg(SV *dstr, SV *sstr)
4563 Copies an unsigned integer into the given SV, upgrading first if necessary.
4564 Does not handle 'set' magic. See also C<sv_setuv_mg>.
4566 void sv_setuv(SV* sv, UV num)
4573 Like C<sv_setuv>, but also handles 'set' magic.
4575 void sv_setuv_mg(SV *sv, UV u)
4582 Taint an SV. Use C<SvTAINTED_on> instead.
4583 void sv_taint(SV* sv)
4590 Test an SV for taintedness. Use C<SvTAINTED> instead.
4591 bool sv_tainted(SV* sv)
4598 Returns true if the SV has a true value by Perl's rules.
4599 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
4600 instead use an in-line version.
4609 Removes all magic of type C<type> from an SV.
4611 int sv_unmagic(SV* sv, int type)
4618 Unsets the RV status of the SV, and decrements the reference count of
4619 whatever was being referenced by the RV. This can almost be thought of
4620 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
4621 being zero. See C<SvROK_off>.
4623 void sv_unref(SV* sv)
4628 =item sv_unref_flags
4630 Unsets the RV status of the SV, and decrements the reference count of
4631 whatever was being referenced by the RV. This can almost be thought of
4632 as a reversal of C<newSVrv>. The C<cflags> argument can contain
4633 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
4634 (otherwise the decrementing is conditional on the reference count being
4635 different from one or the reference being a readonly SV).
4638 void sv_unref_flags(SV* sv, U32 flags)
4645 Untaint an SV. Use C<SvTAINTED_off> instead.
4646 void sv_untaint(SV* sv)
4653 Upgrade an SV to a more complex form. Generally adds a new body type to the
4654 SV, then copies across as much information as possible from the old body.
4655 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
4657 bool sv_upgrade(SV* sv, U32 mt)
4664 Tells an SV to use C<ptr> to find its string value. Normally the string is
4665 stored inside the SV but sv_usepvn allows the SV to use an outside string.
4666 The C<ptr> should point to memory that was allocated by C<malloc>. The
4667 string length, C<len>, must be supplied. This function will realloc the
4668 memory pointed to by C<ptr>, so that pointer should not be freed or used by
4669 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
4670 See C<sv_usepvn_mg>.
4672 void sv_usepvn(SV* sv, char* ptr, STRLEN len)
4679 Like C<sv_usepvn>, but also handles 'set' magic.
4681 void sv_usepvn_mg(SV *sv, char *ptr, STRLEN len)
4686 =item sv_utf8_decode
4688 Convert the octets in the PV from UTF-8 to chars. Scan for validity and then
4689 turn off SvUTF8 if needed so that we see characters. Used as a building block
4690 for decode_utf8 in Encode.xs
4692 NOTE: this function is experimental and may change or be
4693 removed without notice.
4695 bool sv_utf8_decode(SV *sv)
4700 =item sv_utf8_downgrade
4702 Attempt to convert the PV of an SV from UTF-8-encoded to byte encoding.
4703 This may not be possible if the PV contains non-byte encoding characters;
4704 if this is the case, either returns false or, if C<fail_ok> is not
4707 This is not as a general purpose Unicode to byte encoding interface:
4708 use the Encode extension for that.
4710 NOTE: this function is experimental and may change or be
4711 removed without notice.
4713 bool sv_utf8_downgrade(SV *sv, bool fail_ok)
4718 =item sv_utf8_encode
4720 Convert the PV of an SV to UTF-8-encoded, but then turn off the C<SvUTF8>
4721 flag so that it looks like octets again. Used as a building block
4722 for encode_utf8 in Encode.xs
4724 void sv_utf8_encode(SV *sv)
4729 =item sv_utf8_upgrade
4731 Convert the PV of an SV to its UTF-8-encoded form.
4732 Forces the SV to string form if it is not already.
4733 Always sets the SvUTF8 flag to avoid future validity checks even
4734 if all the bytes have hibit clear.
4736 This is not as a general purpose byte encoding to Unicode interface:
4737 use the Encode extension for that.
4739 STRLEN sv_utf8_upgrade(SV *sv)
4744 =item sv_utf8_upgrade_flags
4746 Convert the PV of an SV to its UTF-8-encoded form.
4747 Forces the SV to string form if it is not already.
4748 Always sets the SvUTF8 flag to avoid future validity checks even
4749 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
4750 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
4751 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
4753 This is not as a general purpose byte encoding to Unicode interface:
4754 use the Encode extension for that.
4756 STRLEN sv_utf8_upgrade_flags(SV *sv, I32 flags)
4763 A private implementation of the C<SvUVx> macro for compilers which can't
4764 cope with complex macro expressions. Always use the macro instead.
4773 Processes its arguments like C<vsprintf> and appends the formatted output
4774 to an SV. Uses an array of SVs if the C style variable argument list is
4775 missing (NULL). When running with taint checks enabled, indicates via
4776 C<maybe_tainted> if results are untrustworthy (often due to the use of
4779 Usually used via one of its frontends C<sv_catpvf> and C<sv_catpvf_mg>.
4781 void sv_vcatpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
4788 Works like C<vcatpvfn> but copies the text into the SV instead of
4791 Usually used via one of its frontends C<sv_setpvf> and C<sv_setpvf_mg>.
4793 void sv_vsetpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
4801 =head1 Unicode Support
4805 =item bytes_from_utf8
4807 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
4808 Unlike <utf8_to_bytes> but like C<bytes_to_utf8>, returns a pointer to
4809 the newly-created string, and updates C<len> to contain the new
4810 length. Returns the original string if no conversion occurs, C<len>
4811 is unchanged. Do nothing if C<is_utf8> points to 0. Sets C<is_utf8> to
4812 0 if C<s> is converted or contains all 7bit characters.
4814 NOTE: this function is experimental and may change or be
4815 removed without notice.
4817 U8* bytes_from_utf8(U8 *s, STRLEN *len, bool *is_utf8)
4820 Found in file utf8.c
4824 Converts a string C<s> of length C<len> from ASCII into UTF-8 encoding.
4825 Returns a pointer to the newly-created string, and sets C<len> to
4826 reflect the new length.
4828 If you want to convert to UTF-8 from other encodings than ASCII,
4829 see sv_recode_to_utf8().
4831 NOTE: this function is experimental and may change or be
4832 removed without notice.
4834 U8* bytes_to_utf8(U8 *s, STRLEN *len)
4837 Found in file utf8.c
4841 Return true if the strings s1 and s2 differ case-insensitively, false
4842 if not (if they are equal case-insensitively). If u1 is true, the
4843 string s1 is assumed to be in UTF-8-encoded Unicode. If u2 is true,
4844 the string s2 is assumed to be in UTF-8-encoded Unicode. If u1 or u2
4845 are false, the respective string is assumed to be in native 8-bit
4848 If the pe1 and pe2 are non-NULL, the scanning pointers will be copied
4849 in there (they will point at the beginning of the I<next> character).
4850 If the pointers behind pe1 or pe2 are non-NULL, they are the end
4851 pointers beyond which scanning will not continue under any
4852 circustances. If the byte lengths l1 and l2 are non-zero, s1+l1 and
4853 s2+l2 will be used as goal end pointers that will also stop the scan,
4854 and which qualify towards defining a successful match: all the scans
4855 that define an explicit length must reach their goal pointers for
4856 a match to succeed).
4858 For case-insensitiveness, the "casefolding" of Unicode is used
4859 instead of upper/lowercasing both the characters, see
4860 http://www.unicode.org/unicode/reports/tr21/ (Case Mappings).
4862 I32 ibcmp_utf8(const char* a, char **pe1, UV l1, bool u1, const char* b, char **pe2, UV l2, bool u2)
4865 Found in file utf8.c
4869 Tests if some arbitrary number of bytes begins in a valid UTF-8
4870 character. Note that an INVARIANT (i.e. ASCII) character is a valid
4871 UTF-8 character. The actual number of bytes in the UTF-8 character
4872 will be returned if it is valid, otherwise 0.
4874 STRLEN is_utf8_char(U8 *p)
4877 Found in file utf8.c
4879 =item is_utf8_string
4881 Returns true if first C<len> bytes of the given string form a valid
4882 UTF-8 string, false otherwise. Note that 'a valid UTF-8 string' does
4883 not mean 'a string that contains code points above 0x7F encoded in UTF-8'
4884 because a valid ASCII string is a valid UTF-8 string.
4886 bool is_utf8_string(U8 *s, STRLEN len)
4889 Found in file utf8.c
4891 =item is_utf8_string_loc
4893 Like is_ut8_string but store the location of the failure in
4896 bool is_utf8_string_loc(U8 *s, STRLEN len, U8 **p)
4899 Found in file utf8.c
4901 =item pv_uni_display
4903 Build to the scalar dsv a displayable version of the string spv,
4904 length len, the displayable version being at most pvlim bytes long
4905 (if longer, the rest is truncated and "..." will be appended).
4907 The flags argument can have UNI_DISPLAY_ISPRINT set to display
4908 isPRINT()able characters as themselves, UNI_DISPLAY_BACKSLASH
4909 to display the \\[nrfta\\] as the backslashed versions (like '\n')
4910 (UNI_DISPLAY_BACKSLASH is preferred over UNI_DISPLAY_ISPRINT for \\).
4911 UNI_DISPLAY_QQ (and its alias UNI_DISPLAY_REGEX) have both
4912 UNI_DISPLAY_BACKSLASH and UNI_DISPLAY_ISPRINT turned on.
4914 The pointer to the PV of the dsv is returned.
4916 char* pv_uni_display(SV *dsv, U8 *spv, STRLEN len, STRLEN pvlim, UV flags)
4919 Found in file utf8.c
4923 The encoding is assumed to be an Encode object, the PV of the ssv is
4924 assumed to be octets in that encoding and decoding the input starts
4925 from the position which (PV + *offset) pointed to. The dsv will be
4926 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
4927 when the string tstr appears in decoding output or the input ends on
4928 the PV of the ssv. The value which the offset points will be modified
4929 to the last input position on the ssv.
4931 Returns TRUE if the terminator was found, else returns FALSE.
4933 bool sv_cat_decode(SV* dsv, SV *encoding, SV *ssv, int *offset, char* tstr, int tlen)
4938 =item sv_recode_to_utf8
4940 The encoding is assumed to be an Encode object, on entry the PV
4941 of the sv is assumed to be octets in that encoding, and the sv
4942 will be converted into Unicode (and UTF-8).
4944 If the sv already is UTF-8 (or if it is not POK), or if the encoding
4945 is not a reference, nothing is done to the sv. If the encoding is not
4946 an C<Encode::XS> Encoding object, bad things will happen.
4947 (See F<lib/encoding.pm> and L<Encode>).
4949 The PV of the sv is returned.
4951 char* sv_recode_to_utf8(SV* sv, SV *encoding)
4956 =item sv_uni_display
4958 Build to the scalar dsv a displayable version of the scalar sv,
4959 the displayable version being at most pvlim bytes long
4960 (if longer, the rest is truncated and "..." will be appended).
4962 The flags argument is as in pv_uni_display().
4964 The pointer to the PV of the dsv is returned.
4966 char* sv_uni_display(SV *dsv, SV *ssv, STRLEN pvlim, UV flags)
4969 Found in file utf8.c
4973 The "p" contains the pointer to the UTF-8 string encoding
4974 the character that is being converted.
4976 The "ustrp" is a pointer to the character buffer to put the
4977 conversion result to. The "lenp" is a pointer to the length
4980 The "swashp" is a pointer to the swash to use.
4982 Both the special and normal mappings are stored lib/unicore/To/Foo.pl,
4983 and loaded by SWASHGET, using lib/utf8_heavy.pl. The special (usually,
4984 but not always, a multicharacter mapping), is tried first.
4986 The "special" is a string like "utf8::ToSpecLower", which means the
4987 hash %utf8::ToSpecLower. The access to the hash is through
4988 Perl_to_utf8_case().
4990 The "normal" is a string like "ToLower" which means the swash
4993 UV to_utf8_case(U8 *p, U8* ustrp, STRLEN *lenp, SV **swash, char *normal, char *special)
4996 Found in file utf8.c
5000 Convert the UTF-8 encoded character at p to its foldcase version and
5001 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
5002 that the ustrp needs to be at least UTF8_MAXLEN_FOLD+1 bytes since the
5003 foldcase version may be longer than the original character (up to
5006 The first character of the foldcased version is returned
5007 (but note, as explained above, that there may be more.)
5009 UV to_utf8_fold(U8 *p, U8* ustrp, STRLEN *lenp)
5012 Found in file utf8.c
5016 Convert the UTF-8 encoded character at p to its lowercase version and
5017 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
5018 that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the
5019 lowercase version may be longer than the original character (up to two
5022 The first character of the lowercased version is returned
5023 (but note, as explained above, that there may be more.)
5025 UV to_utf8_lower(U8 *p, U8* ustrp, STRLEN *lenp)
5028 Found in file utf8.c
5032 Convert the UTF-8 encoded character at p to its titlecase version and
5033 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
5034 that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the
5035 titlecase version may be longer than the original character (up to two
5038 The first character of the titlecased version is returned
5039 (but note, as explained above, that there may be more.)
5041 UV to_utf8_title(U8 *p, U8* ustrp, STRLEN *lenp)
5044 Found in file utf8.c
5048 Convert the UTF-8 encoded character at p to its uppercase version and
5049 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
5050 that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the
5051 uppercase version may be longer than the original character (up to two
5054 The first character of the uppercased version is returned
5055 (but note, as explained above, that there may be more.)
5057 UV to_utf8_upper(U8 *p, U8* ustrp, STRLEN *lenp)
5060 Found in file utf8.c
5062 =item utf8n_to_uvchr
5064 Returns the native character value of the first character in the string C<s>
5065 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
5066 length, in bytes, of that character.
5068 Allows length and flags to be passed to low level routine.
5070 UV utf8n_to_uvchr(U8 *s, STRLEN curlen, STRLEN* retlen, U32 flags)
5073 Found in file utf8.c
5075 =item utf8n_to_uvuni
5077 Bottom level UTF-8 decode routine.
5078 Returns the unicode code point value of the first character in the string C<s>
5079 which is assumed to be in UTF-8 encoding and no longer than C<curlen>;
5080 C<retlen> will be set to the length, in bytes, of that character.
5082 If C<s> does not point to a well-formed UTF-8 character, the behaviour
5083 is dependent on the value of C<flags>: if it contains UTF8_CHECK_ONLY,
5084 it is assumed that the caller will raise a warning, and this function
5085 will silently just set C<retlen> to C<-1> and return zero. If the
5086 C<flags> does not contain UTF8_CHECK_ONLY, warnings about
5087 malformations will be given, C<retlen> will be set to the expected
5088 length of the UTF-8 character in bytes, and zero will be returned.
5090 The C<flags> can also contain various flags to allow deviations from
5091 the strict UTF-8 encoding (see F<utf8.h>).
5093 Most code should use utf8_to_uvchr() rather than call this directly.
5095 UV utf8n_to_uvuni(U8 *s, STRLEN curlen, STRLEN* retlen, U32 flags)
5098 Found in file utf8.c
5102 Returns the number of UTF-8 characters between the UTF-8 pointers C<a>
5105 WARNING: use only if you *know* that the pointers point inside the
5108 IV utf8_distance(U8 *a, U8 *b)
5111 Found in file utf8.c
5115 Return the UTF-8 pointer C<s> displaced by C<off> characters, either
5116 forward or backward.
5118 WARNING: do not use the following unless you *know* C<off> is within
5119 the UTF-8 data pointed to by C<s> *and* that on entry C<s> is aligned
5120 on the first byte of character or just after the last byte of a character.
5122 U8* utf8_hop(U8 *s, I32 off)
5125 Found in file utf8.c
5129 Return the length of the UTF-8 char encoded string C<s> in characters.
5130 Stops at C<e> (inclusive). If C<e E<lt> s> or if the scan would end
5131 up past C<e>, croaks.
5133 STRLEN utf8_length(U8* s, U8 *e)
5136 Found in file utf8.c
5140 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
5141 Unlike C<bytes_to_utf8>, this over-writes the original string, and
5142 updates len to contain the new length.
5143 Returns zero on failure, setting C<len> to -1.
5145 NOTE: this function is experimental and may change or be
5146 removed without notice.
5148 U8* utf8_to_bytes(U8 *s, STRLEN *len)
5151 Found in file utf8.c
5155 Returns the native character value of the first character in the string C<s>
5156 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
5157 length, in bytes, of that character.
5159 If C<s> does not point to a well-formed UTF-8 character, zero is
5160 returned and retlen is set, if possible, to -1.
5162 UV utf8_to_uvchr(U8 *s, STRLEN* retlen)
5165 Found in file utf8.c
5169 Returns the Unicode code point of the first character in the string C<s>
5170 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
5171 length, in bytes, of that character.
5173 This function should only be used when returned UV is considered
5174 an index into the Unicode semantic tables (e.g. swashes).
5176 If C<s> does not point to a well-formed UTF-8 character, zero is
5177 returned and retlen is set, if possible, to -1.
5179 UV utf8_to_uvuni(U8 *s, STRLEN* retlen)
5182 Found in file utf8.c
5186 Adds the UTF-8 representation of the Native codepoint C<uv> to the end
5187 of the string C<d>; C<d> should be have at least C<UTF8_MAXLEN+1> free
5188 bytes available. The return value is the pointer to the byte after the
5189 end of the new character. In other words,
5191 d = uvchr_to_utf8(d, uv);
5193 is the recommended wide native character-aware way of saying
5197 U8* uvchr_to_utf8(U8 *d, UV uv)
5200 Found in file utf8.c
5202 =item uvuni_to_utf8_flags
5204 Adds the UTF-8 representation of the Unicode codepoint C<uv> to the end
5205 of the string C<d>; C<d> should be have at least C<UTF8_MAXLEN+1> free
5206 bytes available. The return value is the pointer to the byte after the
5207 end of the new character. In other words,
5209 d = uvuni_to_utf8_flags(d, uv, flags);
5213 d = uvuni_to_utf8(d, uv);
5215 (which is equivalent to)
5217 d = uvuni_to_utf8_flags(d, uv, 0);
5219 is the recommended Unicode-aware way of saying
5223 U8* uvuni_to_utf8_flags(U8 *d, UV uv, UV flags)
5226 Found in file utf8.c
5231 =head1 Variables created by C<xsubpp> and C<xsubpp> internal functions
5237 Variable which is setup by C<xsubpp> to indicate the stack base offset,
5238 used by the C<ST>, C<XSprePUSH> and C<XSRETURN> macros. The C<dMARK> macro
5239 must be called prior to setup the C<MARK> variable.
5244 Found in file XSUB.h
5248 Variable which is setup by C<xsubpp> to indicate the
5249 class name for a C++ XS constructor. This is always a C<char*>. See C<THIS>.
5254 Found in file XSUB.h
5258 Sets up the C<ax> variable.
5259 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
5264 Found in file XSUB.h
5268 Sets up the C<items> variable.
5269 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
5274 Found in file XSUB.h
5278 Sets up stack and mark pointers for an XSUB, calling dSP and dMARK.
5279 Sets up the C<ax> and C<items> variables by calling C<dAX> and C<dITEMS>.
5280 This is usually handled automatically by C<xsubpp>.
5285 Found in file XSUB.h
5289 Sets up the C<ix> variable for an XSUB which has aliases. This is usually
5290 handled automatically by C<xsubpp>.
5295 Found in file XSUB.h
5299 Variable which is setup by C<xsubpp> to indicate the number of
5300 items on the stack. See L<perlxs/"Variable-length Parameter Lists">.
5305 Found in file XSUB.h
5309 Variable which is setup by C<xsubpp> to indicate which of an
5310 XSUB's aliases was used to invoke it. See L<perlxs/"The ALIAS: Keyword">.
5315 Found in file XSUB.h
5319 Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
5323 Found in file XSUB.h
5327 Variable which is setup by C<xsubpp> to hold the return value for an
5328 XSUB. This is always the proper type for the XSUB. See
5329 L<perlxs/"The RETVAL Variable">.
5334 Found in file XSUB.h
5338 Used to access elements on the XSUB's stack.
5343 Found in file XSUB.h
5347 Variable which is setup by C<xsubpp> to designate the object in a C++
5348 XSUB. This is always the proper type for the C++ object. See C<CLASS> and
5349 L<perlxs/"Using XS With C++">.
5354 Found in file XSUB.h
5358 Macro to declare an XSUB and its C parameter list. This is handled by
5362 Found in file XSUB.h
5364 =item XSRETURN_EMPTY
5366 Return an empty list from an XSUB immediately.
5372 Found in file XSUB.h
5376 The version identifier for an XS module. This is usually
5377 handled automatically by C<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>.
5380 Found in file XSUB.h
5382 =item XS_VERSION_BOOTCHECK
5384 Macro to verify that a PM module's $VERSION variable matches the XS
5385 module's C<XS_VERSION> variable. This is usually handled automatically by
5386 C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">.
5388 XS_VERSION_BOOTCHECK;
5391 Found in file XSUB.h
5396 =head1 Warning and Dieing
5402 This is the XSUB-writer's interface to Perl's C<die> function.
5403 Normally call this function the same way you call the C C<printf>
5404 function. Calling C<croak> returns control directly to Perl,
5405 sidestepping the normal C order of execution. See C<warn>.
5407 If you want to throw an exception object, assign the object to
5408 C<$@> and then pass C<Nullch> to croak():
5410 errsv = get_sv("@", TRUE);
5411 sv_setsv(errsv, exception_object);
5414 void croak(const char* pat, ...)
5417 Found in file util.c
5421 This is the XSUB-writer's interface to Perl's C<warn> function. Call this
5422 function the same way you call the C C<printf> function. See C<croak>.
5424 void warn(const char* pat, ...)
5427 Found in file util.c
5434 Until May 1997, this document was maintained by Jeff Okamoto
5435 <okamoto@corp.hp.com>. It is now maintained as part of Perl itself.
5437 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
5438 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
5439 Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
5440 Stephen McCamant, and Gurusamy Sarathy.
5442 API Listing originally by Dean Roehrich <roehrich@cray.com>.
5444 Updated to be autogenerated from comments in the source by Benjamin Stuhl.
5448 perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
projects / p5sagit/p5-mst-13.2.git / blob