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);
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
1783 char* scan_version(char *vstr, SV *sv)
1786 Found in file util.c
1790 Test two strings to see if they are equal. Returns true or false.
1792 bool strEQ(char* s1, char* s2)
1795 Found in file handy.h
1799 Test two strings to see if the first, C<s1>, is greater than or equal to
1800 the second, C<s2>. Returns true or false.
1802 bool strGE(char* s1, char* s2)
1805 Found in file handy.h
1809 Test two strings to see if the first, C<s1>, is greater than the second,
1810 C<s2>. Returns true or false.
1812 bool strGT(char* s1, char* s2)
1815 Found in file handy.h
1819 Test two strings to see if the first, C<s1>, is less than or equal to the
1820 second, C<s2>. Returns true or false.
1822 bool strLE(char* s1, char* s2)
1825 Found in file handy.h
1829 Test two strings to see if the first, C<s1>, is less than the second,
1830 C<s2>. Returns true or false.
1832 bool strLT(char* s1, char* s2)
1835 Found in file handy.h
1839 Test two strings to see if they are different. Returns true or
1842 bool strNE(char* s1, char* s2)
1845 Found in file handy.h
1849 Test two strings to see if they are equal. The C<len> parameter indicates
1850 the number of bytes to compare. Returns true or false. (A wrapper for
1853 bool strnEQ(char* s1, char* s2, STRLEN len)
1856 Found in file handy.h
1860 Test two strings to see if they are different. The C<len> parameter
1861 indicates the number of bytes to compare. Returns true or false. (A
1862 wrapper for C<strncmp>).
1864 bool strnNE(char* s1, char* s2, STRLEN len)
1867 Found in file handy.h
1871 Dummy routine which "locks" an SV when there is no locking module present.
1872 Exists to avoid test for a NULL function pointer and because it could potentially warn under
1873 some level of strict-ness.
1875 void sv_nolocking(SV *)
1878 Found in file util.c
1882 Dummy routine which "shares" an SV when there is no sharing module present.
1883 Exists to avoid test for a NULL function pointer and because it could potentially warn under
1884 some level of strict-ness.
1886 void sv_nosharing(SV *)
1889 Found in file util.c
1891 =item sv_nounlocking
1893 Dummy routine which "unlocks" an SV when there is no locking module present.
1894 Exists to avoid test for a NULL function pointer and because it could potentially warn under
1895 some level of strict-ness.
1897 void sv_nounlocking(SV *)
1900 Found in file util.c
1904 In-place upgrade of the supplied SV to a version object.
1906 SV *sv = upg_version(SV *sv);
1908 Returns a pointer to the upgraded SV.
1910 SV* upg_version(SV *ver)
1913 Found in file util.c
1917 Version object aware cmp. Both operands must already have been
1918 converted into version objects.
1920 int vcmp(SV *lvs, SV *rvs)
1923 Found in file util.c
1927 Accepts a version object and returns the normalized floating
1928 point representation. Call like:
1932 NOTE: you can pass either the object directly or the SV
1933 contained within the RV.
1938 Found in file util.c
1942 Accepts a version object and returns the normalized string
1943 representation. Call like:
1945 sv = vstringify(rv);
1947 NOTE: you can pass either the object directly or the SV
1948 contained within the RV.
1950 SV* vstringify(SV *vs)
1953 Found in file util.c
1958 =head1 Numeric functions
1964 converts a string representing a binary number to numeric form.
1966 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
1967 conversion flags, and I<result> should be NULL or a pointer to an NV.
1968 The scan stops at the end of the string, or the first invalid character.
1969 On return I<*len> is set to the length scanned string, and I<*flags> gives
1972 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
1973 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_bin>
1974 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
1975 and writes the value to I<*result> (or the value is discarded if I<result>
1978 The hex number may optionally be prefixed with "0b" or "b" unless
1979 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
1980 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the binary
1981 number may use '_' characters to separate digits.
1983 UV grok_bin(char* start, STRLEN* len, I32* flags, NV *result)
1986 Found in file numeric.c
1990 converts a string representing a hex number to numeric form.
1992 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
1993 conversion flags, and I<result> should be NULL or a pointer to an NV.
1994 The scan stops at the end of the string, or the first non-hex-digit character.
1995 On return I<*len> is set to the length scanned string, and I<*flags> gives
1998 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
1999 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_hex>
2000 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2001 and writes the value to I<*result> (or the value is discarded if I<result>
2004 The hex number may optionally be prefixed with "0x" or "x" unless
2005 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
2006 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the hex
2007 number may use '_' characters to separate digits.
2009 UV grok_hex(char* start, STRLEN* len, I32* flags, NV *result)
2012 Found in file numeric.c
2016 Recognise (or not) a number. The type of the number is returned
2017 (0 if unrecognised), otherwise it is a bit-ORed combination of
2018 IS_NUMBER_IN_UV, IS_NUMBER_GREATER_THAN_UV_MAX, IS_NUMBER_NOT_INT,
2019 IS_NUMBER_NEG, IS_NUMBER_INFINITY, IS_NUMBER_NAN (defined in perl.h).
2021 If the value of the number can fit an in UV, it is returned in the *valuep
2022 IS_NUMBER_IN_UV will be set to indicate that *valuep is valid, IS_NUMBER_IN_UV
2023 will never be set unless *valuep is valid, but *valuep may have been assigned
2024 to during processing even though IS_NUMBER_IN_UV is not set on return.
2025 If valuep is NULL, IS_NUMBER_IN_UV will be set for the same cases as when
2026 valuep is non-NULL, but no actual assignment (or SEGV) will occur.
2028 IS_NUMBER_NOT_INT will be set with IS_NUMBER_IN_UV if trailing decimals were
2029 seen (in which case *valuep gives the true value truncated to an integer), and
2030 IS_NUMBER_NEG if the number is negative (in which case *valuep holds the
2031 absolute value). IS_NUMBER_IN_UV is not set if e notation was used or the
2032 number is larger than a UV.
2034 int grok_number(const char *pv, STRLEN len, UV *valuep)
2037 Found in file numeric.c
2039 =item grok_numeric_radix
2041 Scan and skip for a numeric decimal separator (radix).
2043 bool grok_numeric_radix(const char **sp, const char *send)
2046 Found in file numeric.c
2051 UV grok_oct(char* start, STRLEN* len, I32* flags, NV *result)
2054 Found in file numeric.c
2058 For backwards compatibility. Use C<grok_bin> instead.
2060 NV scan_bin(char* start, STRLEN len, STRLEN* retlen)
2063 Found in file numeric.c
2067 For backwards compatibility. Use C<grok_hex> instead.
2069 NV scan_hex(char* start, STRLEN len, STRLEN* retlen)
2072 Found in file numeric.c
2076 For backwards compatibility. Use C<grok_oct> instead.
2078 NV scan_oct(char* start, STRLEN len, STRLEN* retlen)
2081 Found in file numeric.c
2086 =head1 Optree Manipulation Functions
2092 If C<cv> is a constant sub eligible for inlining. returns the constant
2093 value returned by the sub. Otherwise, returns NULL.
2095 Constant subs can be created with C<newCONSTSUB> or as described in
2096 L<perlsub/"Constant Functions">.
2098 SV* cv_const_sv(CV* cv)
2105 Creates a constant sub equivalent to Perl C<sub FOO () { 123 }> which is
2106 eligible for inlining at compile-time.
2108 CV* newCONSTSUB(HV* stash, char* name, SV* sv)
2115 Used by C<xsubpp> to hook up XSUBs as Perl subs.
2123 =head1 Pad Data Structures
2129 Get the value at offset po in the current pad.
2130 Use macro PAD_SV instead of calling this function directly.
2132 SV* pad_sv(PADOFFSET po)
2140 =head1 Stack Manipulation Macros
2146 Declare a stack marker variable, C<mark>, for the XSUB. See C<MARK> and
2156 Saves the original stack mark for the XSUB. See C<ORIGMARK>.
2165 Declares a local copy of perl's stack pointer for the XSUB, available via
2166 the C<SP> macro. See C<SP>.
2175 Used to extend the argument stack for an XSUB's return values. Once
2176 used, guarantees that there is room for at least C<nitems> to be pushed
2179 void EXTEND(SP, int nitems)
2186 Stack marker variable for the XSUB. See C<dMARK>.
2193 The original stack mark for the XSUB. See C<dORIGMARK>.
2200 Pops an integer off the stack.
2209 Pops a long off the stack.
2218 Pops a double off the stack.
2227 Pops a string off the stack. Deprecated. New code should provide
2228 a STRLEN n_a and use POPpx.
2237 Pops a string off the stack which must consist of bytes i.e. characters < 256.
2238 Requires a variable STRLEN n_a in scope.
2247 Pops a string off the stack.
2248 Requires a variable STRLEN n_a in scope.
2257 Pops an SV off the stack.
2266 Push an integer onto the stack. The stack must have room for this element.
2267 Handles 'set' magic. See C<XPUSHi>.
2276 Opening bracket for arguments on a callback. See C<PUTBACK> and
2286 Push a double onto the stack. The stack must have room for this element.
2287 Handles 'set' magic. See C<XPUSHn>.
2296 Push a string onto the stack. The stack must have room for this element.
2297 The C<len> indicates the length of the string. Handles 'set' magic. See
2300 void PUSHp(char* str, STRLEN len)
2307 Push an SV onto the stack. The stack must have room for this element.
2308 Does not handle 'set' magic. See C<XPUSHs>.
2317 Push an unsigned integer onto the stack. The stack must have room for this
2318 element. See C<XPUSHu>.
2327 Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
2328 See C<PUSHMARK> and L<perlcall> for other uses.
2337 Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and
2345 Refetch the stack pointer. Used after a callback. See L<perlcall>.
2354 Push an integer onto the stack, extending the stack if necessary. Handles
2355 'set' magic. See C<PUSHi>.
2364 Push a double onto the stack, extending the stack if necessary. Handles
2365 'set' magic. See C<PUSHn>.
2374 Push a string onto the stack, extending the stack if necessary. The C<len>
2375 indicates the length of the string. Handles 'set' magic. See
2378 void XPUSHp(char* str, STRLEN len)
2385 Push an SV onto the stack, extending the stack if necessary. Does not
2386 handle 'set' magic. See C<PUSHs>.
2395 Push an unsigned integer onto the stack, extending the stack if necessary.
2405 Return from XSUB, indicating number of items on the stack. This is usually
2406 handled by C<xsubpp>.
2408 void XSRETURN(int nitems)
2411 Found in file XSUB.h
2415 Return an integer from an XSUB immediately. Uses C<XST_mIV>.
2417 void XSRETURN_IV(IV iv)
2420 Found in file XSUB.h
2424 Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
2429 Found in file XSUB.h
2433 Return a double from an XSUB immediately. Uses C<XST_mNV>.
2435 void XSRETURN_NV(NV nv)
2438 Found in file XSUB.h
2442 Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
2444 void XSRETURN_PV(char* str)
2447 Found in file XSUB.h
2449 =item XSRETURN_UNDEF
2451 Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
2456 Found in file XSUB.h
2460 Return an integer from an XSUB immediately. Uses C<XST_mUV>.
2462 void XSRETURN_UV(IV uv)
2465 Found in file XSUB.h
2469 Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
2474 Found in file XSUB.h
2478 Place an integer into the specified position C<pos> on the stack. The
2479 value is stored in a new mortal SV.
2481 void XST_mIV(int pos, IV iv)
2484 Found in file XSUB.h
2488 Place C<&PL_sv_no> into the specified position C<pos> on the
2491 void XST_mNO(int pos)
2494 Found in file XSUB.h
2498 Place a double into the specified position C<pos> on the stack. The value
2499 is stored in a new mortal SV.
2501 void XST_mNV(int pos, NV nv)
2504 Found in file XSUB.h
2508 Place a copy of a string into the specified position C<pos> on the stack.
2509 The value is stored in a new mortal SV.
2511 void XST_mPV(int pos, char* str)
2514 Found in file XSUB.h
2518 Place C<&PL_sv_undef> into the specified position C<pos> on the
2521 void XST_mUNDEF(int pos)
2524 Found in file XSUB.h
2528 Place C<&PL_sv_yes> into the specified position C<pos> on the
2531 void XST_mYES(int pos)
2534 Found in file XSUB.h
2545 An enum of flags for Perl types. These are found in the file B<sv.h>
2546 in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
2553 Integer type flag for scalars. See C<svtype>.
2560 Double type flag for scalars. See C<svtype>.
2567 Pointer type flag for scalars. See C<svtype>.
2574 Type flag for arrays. See C<svtype>.
2581 Type flag for code refs. See C<svtype>.
2588 Type flag for hashes. See C<svtype>.
2595 Type flag for blessed scalars. See C<svtype>.
2603 =head1 SV Manipulation Functions
2609 Returns the SV of the specified Perl scalar. If C<create> is set and the
2610 Perl variable does not exist then it will be created. If C<create> is not
2611 set and the variable does not exist then NULL is returned.
2613 NOTE: the perl_ form of this function is deprecated.
2615 SV* get_sv(const char* name, I32 create)
2618 Found in file perl.c
2620 =item looks_like_number
2622 Test if the content of an SV looks like a number (or is a number).
2623 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
2624 non-numeric warning), even if your atof() doesn't grok them.
2626 I32 looks_like_number(SV* sv)
2633 Creates an RV wrapper for an SV. The reference count for the original SV is
2636 SV* newRV_inc(SV* sv)
2643 Creates an RV wrapper for an SV. The reference count for the original
2644 SV is B<not> incremented.
2646 SV* newRV_noinc(SV *sv)
2653 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
2654 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
2657 SV* newSV(STRLEN len)
2664 Creates a new SV and copies an integer into it. The reference count for the
2674 Creates a new SV and copies a floating point value into it.
2675 The reference count for the SV is set to 1.
2684 Creates a new SV and copies a string into it. The reference count for the
2685 SV is set to 1. If C<len> is zero, Perl will compute the length using
2686 strlen(). For efficiency, consider using C<newSVpvn> instead.
2688 SV* newSVpv(const char* s, STRLEN len)
2695 Creates a new SV and initializes it with the string formatted like
2698 SV* newSVpvf(const char* pat, ...)
2705 Creates a new SV and copies a string into it. The reference count for the
2706 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
2707 string. You are responsible for ensuring that the source string is at least
2710 SV* newSVpvn(const char* s, STRLEN len)
2715 =item newSVpvn_share
2717 Creates a new SV with its SvPVX pointing to a shared string in the string
2718 table. If the string does not already exist in the table, it is created
2719 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
2720 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
2721 otherwise the hash is computed. The idea here is that as the string table
2722 is used for shared hash keys these strings will have SvPVX == HeKEY and
2723 hash lookup will avoid string compare.
2725 SV* newSVpvn_share(const char* s, I32 len, U32 hash)
2732 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
2733 it will be upgraded to one. If C<classname> is non-null then the new SV will
2734 be blessed in the specified package. The new SV is returned and its
2735 reference count is 1.
2737 SV* newSVrv(SV* rv, const char* classname)
2744 Creates a new SV which is an exact duplicate of the original SV.
2747 SV* newSVsv(SV* old)
2754 Creates a new SV and copies an unsigned integer into it.
2755 The reference count for the SV is set to 1.
2764 Returns the length of the string which is in the SV. See C<SvLEN>.
2766 STRLEN SvCUR(SV* sv)
2773 Set the length of the string which is in the SV. See C<SvCUR>.
2775 void SvCUR_set(SV* sv, STRLEN len)
2782 Returns a pointer to the last character in the string which is in the SV.
2783 See C<SvCUR>. Access the character as *(SvEND(sv)).
2792 Expands the character buffer in the SV so that it has room for the
2793 indicated number of bytes (remember to reserve space for an extra trailing
2794 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
2795 Returns a pointer to the character buffer.
2797 char * SvGROW(SV* sv, STRLEN len)
2804 Returns a boolean indicating whether the SV contains an integer.
2813 Returns a boolean indicating whether the SV contains an integer. Checks
2814 the B<private> setting. Use C<SvIOK>.
2823 Returns a boolean indicating whether the SV contains a signed integer.
2825 void SvIOK_notUV(SV* sv)
2832 Unsets the IV status of an SV.
2834 void SvIOK_off(SV* sv)
2841 Tells an SV that it is an integer.
2843 void SvIOK_on(SV* sv)
2850 Tells an SV that it is an integer and disables all other OK bits.
2852 void SvIOK_only(SV* sv)
2859 Tells and SV that it is an unsigned integer and disables all other OK bits.
2861 void SvIOK_only_UV(SV* sv)
2868 Returns a boolean indicating whether the SV contains an unsigned integer.
2870 void SvIOK_UV(SV* sv)
2877 Returns a boolean indicating whether the SV is Copy-On-Write. (either shared
2878 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
2881 bool SvIsCOW(SV* sv)
2886 =item SvIsCOW_shared_hash
2888 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
2891 bool SvIsCOW_shared_hash(SV* sv)
2898 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
2899 version which guarantees to evaluate sv only once.
2908 Coerces the given SV to an integer and returns it. Guarantees to evaluate
2909 sv only once. Use the more efficient C<SvIV> otherwise.
2918 Returns the raw value in the SV's IV slot, without checks or conversions.
2919 Only use when you are sure SvIOK is true. See also C<SvIV()>.
2928 Like C<SvIV> but doesn't process magic.
2930 IV SvIV_nomg(SV* sv)
2937 Returns the size of the string buffer in the SV, not including any part
2938 attributable to C<SvOOK>. See C<SvCUR>.
2940 STRLEN SvLEN(SV* sv)
2947 Returns a boolean indicating whether the SV contains a number, integer or
2957 Returns a boolean indicating whether the SV contains a number, integer or
2958 double. Checks the B<private> setting. Use C<SvNIOK>.
2960 bool SvNIOKp(SV* sv)
2967 Unsets the NV/IV status of an SV.
2969 void SvNIOK_off(SV* sv)
2976 Returns a boolean indicating whether the SV contains a double.
2985 Returns a boolean indicating whether the SV contains a double. Checks the
2986 B<private> setting. Use C<SvNOK>.
2995 Unsets the NV status of an SV.
2997 void SvNOK_off(SV* sv)
3004 Tells an SV that it is a double.
3006 void SvNOK_on(SV* sv)
3013 Tells an SV that it is a double and disables all other OK bits.
3015 void SvNOK_only(SV* sv)
3022 Coerce the given SV to a double and return it. See C<SvNVx> for a version
3023 which guarantees to evaluate sv only once.
3032 Returns the raw value in the SV's NV slot, without checks or conversions.
3033 Only use when you are sure SvNOK is true. See also C<SvNV()>.
3042 Coerces the given SV to a double and returns it. Guarantees to evaluate
3043 sv only once. Use the more efficient C<SvNV> otherwise.
3052 Returns a boolean indicating whether the value is an SV.
3061 Returns a boolean indicating whether the SvIVX is a valid offset value for
3062 the SvPVX. This hack is used internally to speed up removal of characters
3063 from the beginning of a SvPV. When SvOOK is true, then the start of the
3064 allocated string buffer is really (SvPVX - SvIVX).
3073 Returns a boolean indicating whether the SV contains a character
3083 Returns a boolean indicating whether the SV contains a character string.
3084 Checks the B<private> setting. Use C<SvPOK>.
3093 Unsets the PV status of an SV.
3095 void SvPOK_off(SV* sv)
3102 Tells an SV that it is a string.
3104 void SvPOK_on(SV* sv)
3111 Tells an SV that it is a string and disables all other OK bits.
3112 Will also turn off the UTF-8 status.
3114 void SvPOK_only(SV* sv)
3119 =item SvPOK_only_UTF8
3121 Tells an SV that it is a string and disables all other OK bits,
3122 and leaves the UTF-8 status as it was.
3124 void SvPOK_only_UTF8(SV* sv)
3131 Returns a pointer to the string in the SV, or a stringified form of
3132 the SV if the SV does not contain a string. The SV may cache the
3133 stringified version becoming C<SvPOK>. Handles 'get' magic. See also
3134 C<SvPVx> for a version which guarantees to evaluate sv only once.
3136 char* SvPV(SV* sv, STRLEN len)
3143 Like C<SvPV>, but converts sv to byte representation first if necessary.
3145 char* SvPVbyte(SV* sv, STRLEN len)
3152 Like C<SvPV>, but converts sv to byte representation first if necessary.
3153 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
3156 char* SvPVbytex(SV* sv, STRLEN len)
3161 =item SvPVbytex_force
3163 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
3164 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
3167 char* SvPVbytex_force(SV* sv, STRLEN len)
3172 =item SvPVbyte_force
3174 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
3176 char* SvPVbyte_force(SV* sv, STRLEN len)
3181 =item SvPVbyte_nolen
3183 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
3185 char* SvPVbyte_nolen(SV* sv)
3192 Like C<SvPV>, but converts sv to utf8 first if necessary.
3194 char* SvPVutf8(SV* sv, STRLEN len)
3201 Like C<SvPV>, but converts sv to utf8 first if necessary.
3202 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
3205 char* SvPVutf8x(SV* sv, STRLEN len)
3210 =item SvPVutf8x_force
3212 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
3213 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
3216 char* SvPVutf8x_force(SV* sv, STRLEN len)
3221 =item SvPVutf8_force
3223 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
3225 char* SvPVutf8_force(SV* sv, STRLEN len)
3230 =item SvPVutf8_nolen
3232 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
3234 char* SvPVutf8_nolen(SV* sv)
3241 A version of C<SvPV> which guarantees to evaluate sv only once.
3243 char* SvPVx(SV* sv, STRLEN len)
3250 Returns a pointer to the physical string in the SV. The SV must contain a
3260 Like C<SvPV> but will force the SV into containing just a string
3261 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
3264 char* SvPV_force(SV* sv, STRLEN len)
3269 =item SvPV_force_nomg
3271 Like C<SvPV> but will force the SV into containing just a string
3272 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
3273 directly. Doesn't process magic.
3275 char* SvPV_force_nomg(SV* sv, STRLEN len)
3282 Returns a pointer to the string in the SV, or a stringified form of
3283 the SV if the SV does not contain a string. The SV may cache the
3284 stringified form becoming C<SvPOK>. Handles 'get' magic.
3286 char* SvPV_nolen(SV* sv)
3293 Like C<SvPV> but doesn't process magic.
3295 char* SvPV_nomg(SV* sv, STRLEN len)
3302 Returns the value of the object's reference count.
3304 U32 SvREFCNT(SV* sv)
3311 Decrements the reference count of the given SV.
3313 void SvREFCNT_dec(SV* sv)
3320 Increments the reference count of the given SV.
3322 SV* SvREFCNT_inc(SV* sv)
3329 Tests if the SV is an RV.
3338 Unsets the RV status of an SV.
3340 void SvROK_off(SV* sv)
3347 Tells an SV that it is an RV.
3349 void SvROK_on(SV* sv)
3356 Dereferences an RV to return the SV.
3365 Returns the stash of the SV.
3374 Taints an SV if tainting is enabled.
3376 void SvTAINT(SV* sv)
3383 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
3386 bool SvTAINTED(SV* sv)
3393 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
3394 some of Perl's fundamental security features. XS module authors should not
3395 use this function unless they fully understand all the implications of
3396 unconditionally untainting the value. Untainting should be done in the
3397 standard perl fashion, via a carefully crafted regexp, rather than directly
3398 untainting variables.
3400 void SvTAINTED_off(SV* sv)
3407 Marks an SV as tainted if tainting is enabled.
3409 void SvTAINTED_on(SV* sv)
3416 Returns a boolean indicating whether Perl would evaluate the SV as true or
3417 false, defined or undefined. Does not handle 'get' magic.
3426 Returns the type of the SV. See C<svtype>.
3428 svtype SvTYPE(SV* sv)
3435 Releases a mutual exclusion lock on sv if a suitable module
3439 void SvUNLOCK(SV* sv)
3446 Returns a boolean indicating whether the SV contains an unsigned integer.
3455 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
3456 perform the upgrade if necessary. See C<svtype>.
3458 void SvUPGRADE(SV* sv, svtype type)
3465 Returns a boolean indicating whether the SV contains UTF-8 encoded data.
3474 Unsets the UTF-8 status of an SV.
3476 void SvUTF8_off(SV *sv)
3483 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
3484 Do not use frivolously.
3486 void SvUTF8_on(SV *sv)
3493 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
3494 for a version which guarantees to evaluate sv only once.
3503 Returns the raw value in the SV's UV slot, without checks or conversions.
3504 Only use when you are sure SvIOK is true. See also C<SvUV()>.
3513 Coerces the given SV to an unsigned integer and returns it. Guarantees to
3514 evaluate sv only once. Use the more efficient C<SvUV> otherwise.
3523 Like C<SvUV> but doesn't process magic.
3525 UV SvUV_nomg(SV* sv)
3532 Returns a boolean indicating whether the SV contains a v-string.
3541 This function is only called on magical items, and is only used by
3542 sv_true() or its macro equivalent.
3544 bool sv_2bool(SV* sv)
3551 Using various gambits, try to get a CV from an SV; in addition, try if
3552 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
3554 CV* sv_2cv(SV* sv, HV** st, GV** gvp, I32 lref)
3561 Using various gambits, try to get an IO from an SV: the IO slot if its a
3562 GV; or the recursive result if we're an RV; or the IO slot of the symbol
3563 named after the PV if we're a string.
3572 Return the integer value of an SV, doing any necessary string
3573 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
3574 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
3576 IV sv_2iv_flags(SV* sv, I32 flags)
3583 Marks an existing SV as mortal. The SV will be destroyed "soon", either
3584 by an explicit call to FREETMPS, or by an implicit call at places such as
3585 statement boundaries. See also C<sv_newmortal> and C<sv_mortalcopy>.
3587 SV* sv_2mortal(SV* sv)
3594 Return the num value of an SV, doing any necessary string or integer
3595 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
3605 Return a pointer to the byte-encoded representation of the SV, and set *lp
3606 to its length. May cause the SV to be downgraded from UTF-8 as a
3609 Usually accessed via the C<SvPVbyte> macro.
3611 char* sv_2pvbyte(SV* sv, STRLEN* lp)
3616 =item sv_2pvbyte_nolen
3618 Return a pointer to the byte-encoded representation of the SV.
3619 May cause the SV to be downgraded from UTF-8 as a side-effect.
3621 Usually accessed via the C<SvPVbyte_nolen> macro.
3623 char* sv_2pvbyte_nolen(SV* sv)
3630 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3631 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
3633 Usually accessed via the C<SvPVutf8> macro.
3635 char* sv_2pvutf8(SV* sv, STRLEN* lp)
3640 =item sv_2pvutf8_nolen
3642 Return a pointer to the UTF-8-encoded representation of the SV.
3643 May cause the SV to be upgraded to UTF-8 as a side-effect.
3645 Usually accessed via the C<SvPVutf8_nolen> macro.
3647 char* sv_2pvutf8_nolen(SV* sv)
3654 Returns a pointer to the string value of an SV, and sets *lp to its length.
3655 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
3657 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
3658 usually end up here too.
3660 char* sv_2pv_flags(SV* sv, STRLEN* lp, I32 flags)
3667 Like C<sv_2pv()>, but doesn't return the length too. You should usually
3668 use the macro wrapper C<SvPV_nolen(sv)> instead.
3669 char* sv_2pv_nolen(SV* sv)
3676 Return the unsigned integer value of an SV, doing any necessary string
3677 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
3678 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
3680 UV sv_2uv_flags(SV* sv, I32 flags)
3687 Remove any string offset. You should normally use the C<SvOOK_off> macro
3690 int sv_backoff(SV* sv)
3697 Blesses an SV into a specified package. The SV must be an RV. The package
3698 must be designated by its stash (see C<gv_stashpv()>). The reference count
3699 of the SV is unaffected.
3701 SV* sv_bless(SV* sv, HV* stash)
3708 Concatenates the string onto the end of the string which is in the SV.
3709 If the SV has the UTF-8 status set, then the bytes appended should be
3710 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
3712 void sv_catpv(SV* sv, const char* ptr)
3719 Processes its arguments like C<sprintf> and appends the formatted
3720 output to an SV. If the appended data contains "wide" characters
3721 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
3722 and characters >255 formatted with %c), the original SV might get
3723 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic.
3724 C<SvSETMAGIC()> must typically be called after calling this function
3725 to handle 'set' magic.
3727 void sv_catpvf(SV* sv, const char* pat, ...)
3734 Like C<sv_catpvf>, but also handles 'set' magic.
3736 void sv_catpvf_mg(SV *sv, const char* pat, ...)
3743 Concatenates the string onto the end of the string which is in the SV. The
3744 C<len> indicates number of bytes to copy. If the SV has the UTF-8
3745 status set, then the bytes appended should be valid UTF-8.
3746 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
3748 void sv_catpvn(SV* sv, const char* ptr, STRLEN len)
3753 =item sv_catpvn_flags
3755 Concatenates the string onto the end of the string which is in the SV. The
3756 C<len> indicates number of bytes to copy. If the SV has the UTF-8
3757 status set, then the bytes appended should be valid UTF-8.
3758 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
3759 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
3760 in terms of this function.
3762 void sv_catpvn_flags(SV* sv, const char* ptr, STRLEN len, I32 flags)
3769 Like C<sv_catpvn>, but also handles 'set' magic.
3771 void sv_catpvn_mg(SV *sv, const char *ptr, STRLEN len)
3778 Like C<sv_catpv>, but also handles 'set' magic.
3780 void sv_catpv_mg(SV *sv, const char *ptr)
3787 Concatenates the string from SV C<ssv> onto the end of the string in
3788 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
3789 not 'set' magic. See C<sv_catsv_mg>.
3791 void sv_catsv(SV* dsv, SV* ssv)
3796 =item sv_catsv_flags
3798 Concatenates the string from SV C<ssv> onto the end of the string in
3799 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
3800 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
3801 and C<sv_catsv_nomg> are implemented in terms of this function.
3803 void sv_catsv_flags(SV* dsv, SV* ssv, I32 flags)
3810 Like C<sv_catsv>, but also handles 'set' magic.
3812 void sv_catsv_mg(SV *dstr, SV *sstr)
3819 Efficient removal of characters from the beginning of the string buffer.
3820 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
3821 the string buffer. The C<ptr> becomes the first character of the adjusted
3822 string. Uses the "OOK hack".
3823 Beware: after this function returns, C<ptr> and SvPVX(sv) may no longer
3824 refer to the same chunk of data.
3826 void sv_chop(SV* sv, char* ptr)
3833 Clear an SV: call any destructors, free up any memory used by the body,
3834 and free the body itself. The SV's head is I<not> freed, although
3835 its type is set to all 1's so that it won't inadvertently be assumed
3836 to be live during global destruction etc.
3837 This function should only be called when REFCNT is zero. Most of the time
3838 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
3841 void sv_clear(SV* sv)
3848 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
3849 string in C<sv1> is less than, equal to, or greater than the string in
3850 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
3851 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
3853 I32 sv_cmp(SV* sv1, SV* sv2)
3860 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
3861 'use bytes' aware, handles get magic, and will coerce its args to strings
3862 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
3864 I32 sv_cmp_locale(SV* sv1, SV* sv2)
3871 Add Collate Transform magic to an SV if it doesn't already have it.
3873 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
3874 scalar data of the variable, but transformed to such a format that a normal
3875 memory comparison can be used to compare the data according to the locale
3878 char* sv_collxfrm(SV* sv, STRLEN* nxp)
3885 Copies a stringified representation of the source SV into the
3886 destination SV. Automatically performs any necessary mg_get and
3887 coercion of numeric values into strings. Guaranteed to preserve
3888 UTF-8 flag even from overloaded objects. Similar in nature to
3889 sv_2pv[_flags] but operates directly on an SV instead of just the
3890 string. Mostly uses sv_2pv_flags to do its work, except when that
3891 would lose the UTF-8'ness of the PV.
3893 void sv_copypv(SV* dsv, SV* ssv)
3900 Auto-decrement of the value in the SV, doing string to numeric conversion
3901 if necessary. Handles 'get' magic.
3908 =item sv_derived_from
3910 Returns a boolean indicating whether the SV is derived from the specified
3911 class. This is the function that implements C<UNIVERSAL::isa>. It works
3912 for class names as well as for objects.
3914 bool sv_derived_from(SV* sv, const char* name)
3917 Found in file universal.c
3921 Returns a boolean indicating whether the strings in the two SVs are
3922 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
3923 coerce its args to strings if necessary.
3925 I32 sv_eq(SV* sv1, SV* sv2)
3930 =item sv_force_normal
3932 Undo various types of fakery on an SV: if the PV is a shared string, make
3933 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3934 an xpvmg. See also C<sv_force_normal_flags>.
3936 void sv_force_normal(SV *sv)
3941 =item sv_force_normal_flags
3943 Undo various types of fakery on an SV: if the PV is a shared string, make
3944 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3945 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
3946 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
3947 then a copy-on-write scalar drops its PV buffer (if any) and becomes
3948 SvPOK_off rather than making a copy. (Used where this scalar is about to be
3949 set to some other value.) In addition, the C<flags> parameter gets passed to
3950 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
3951 with flags set to 0.
3953 void sv_force_normal_flags(SV *sv, U32 flags)
3960 Decrement an SV's reference count, and if it drops to zero, call
3961 C<sv_clear> to invoke destructors and free up any memory used by
3962 the body; finally, deallocate the SV's head itself.
3963 Normally called via a wrapper macro C<SvREFCNT_dec>.
3965 void sv_free(SV* sv)
3972 Get a line from the filehandle and store it into the SV, optionally
3973 appending to the currently-stored string.
3975 char* sv_gets(SV* sv, PerlIO* fp, I32 append)
3982 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
3983 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
3984 Use the C<SvGROW> wrapper instead.
3986 char* sv_grow(SV* sv, STRLEN newlen)
3993 Auto-increment of the value in the SV, doing string to numeric conversion
3994 if necessary. Handles 'get' magic.
4003 Inserts a string at the specified offset/length within the SV. Similar to
4004 the Perl substr() function.
4006 void sv_insert(SV* bigsv, STRLEN offset, STRLEN len, char* little, STRLEN littlelen)
4013 Returns a boolean indicating whether the SV is blessed into the specified
4014 class. This does not check for subtypes; use C<sv_derived_from> to verify
4015 an inheritance relationship.
4017 int sv_isa(SV* sv, const char* name)
4024 Returns a boolean indicating whether the SV is an RV pointing to a blessed
4025 object. If the SV is not an RV, or if the object is not blessed, then this
4028 int sv_isobject(SV* sv)
4035 A private implementation of the C<SvIVx> macro for compilers which can't
4036 cope with complex macro expressions. Always use the macro instead.
4045 Returns the length of the string in the SV. Handles magic and type
4046 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
4048 STRLEN sv_len(SV* sv)
4055 Returns the number of characters in the string in an SV, counting wide
4056 UTF-8 bytes as a single character. Handles magic and type coercion.
4058 STRLEN sv_len_utf8(SV* sv)
4065 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4066 then adds a new magic item of type C<how> to the head of the magic list.
4068 void sv_magic(SV* sv, SV* obj, int how, const char* name, I32 namlen)
4075 Adds magic to an SV, upgrading it if necessary. Applies the
4076 supplied vtable and returns pointer to the magic added.
4078 Note that sv_magicext will allow things that sv_magic will not.
4079 In particular you can add magic to SvREADONLY SVs and and more than
4080 one instance of the same 'how'
4082 I C<namelen> is greater then zero then a savepvn() I<copy> of C<name> is stored,
4083 if C<namelen> is zero then C<name> is stored as-is and - as another special
4084 case - if C<(name && namelen == HEf_SVKEY)> then C<name> is assumed to contain
4085 an C<SV*> and has its REFCNT incremented
4087 (This is now used as a subroutine by sv_magic.)
4089 MAGIC * sv_magicext(SV* sv, SV* obj, int how, MGVTBL *vtbl, const char* name, I32 namlen )
4096 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
4097 The new SV is marked as mortal. It will be destroyed "soon", either by an
4098 explicit call to FREETMPS, or by an implicit call at places such as
4099 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
4101 SV* sv_mortalcopy(SV* oldsv)
4108 Creates a new null SV which is mortal. The reference count of the SV is
4109 set to 1. It will be destroyed "soon", either by an explicit call to
4110 FREETMPS, or by an implicit call at places such as statement boundaries.
4111 See also C<sv_mortalcopy> and C<sv_2mortal>.
4120 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
4123 SV* sv_newref(SV* sv)
4130 A private implementation of the C<SvNVx> macro for compilers which can't
4131 cope with complex macro expressions. Always use the macro instead.
4140 Converts the value pointed to by offsetp from a count of bytes from the
4141 start of the string, to a count of the equivalent number of UTF-8 chars.
4142 Handles magic and type coercion.
4144 void sv_pos_b2u(SV* sv, I32* offsetp)
4151 Converts the value pointed to by offsetp from a count of UTF-8 chars from
4152 the start of the string, to a count of the equivalent number of bytes; if
4153 lenp is non-zero, it does the same to lenp, but this time starting from
4154 the offset, rather than from the start of the string. Handles magic and
4157 void sv_pos_u2b(SV* sv, I32* offsetp, I32* lenp)
4164 Use the C<SvPV_nolen> macro instead
4173 Use C<SvPVbyte_nolen> instead.
4175 char* sv_pvbyte(SV *sv)
4182 A private implementation of the C<SvPVbyte> macro for compilers
4183 which can't cope with complex macro expressions. Always use the macro
4186 char* sv_pvbyten(SV *sv, STRLEN *len)
4191 =item sv_pvbyten_force
4193 A private implementation of the C<SvPVbytex_force> macro for compilers
4194 which can't cope with complex macro expressions. Always use the macro
4197 char* sv_pvbyten_force(SV* sv, STRLEN* lp)
4204 A private implementation of the C<SvPV> macro for compilers which can't
4205 cope with complex macro expressions. Always use the macro instead.
4207 char* sv_pvn(SV *sv, STRLEN *len)
4214 Get a sensible string out of the SV somehow.
4215 A private implementation of the C<SvPV_force> macro for compilers which
4216 can't cope with complex macro expressions. Always use the macro instead.
4218 char* sv_pvn_force(SV* sv, STRLEN* lp)
4223 =item sv_pvn_force_flags
4225 Get a sensible string out of the SV somehow.
4226 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
4227 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
4228 implemented in terms of this function.
4229 You normally want to use the various wrapper macros instead: see
4230 C<SvPV_force> and C<SvPV_force_nomg>
4232 char* sv_pvn_force_flags(SV* sv, STRLEN* lp, I32 flags)
4239 Use the C<SvPVutf8_nolen> macro instead
4241 char* sv_pvutf8(SV *sv)
4248 A private implementation of the C<SvPVutf8> macro for compilers
4249 which can't cope with complex macro expressions. Always use the macro
4252 char* sv_pvutf8n(SV *sv, STRLEN *len)
4257 =item sv_pvutf8n_force
4259 A private implementation of the C<SvPVutf8_force> macro for compilers
4260 which can't cope with complex macro expressions. Always use the macro
4263 char* sv_pvutf8n_force(SV* sv, STRLEN* lp)
4270 Returns a string describing what the SV is a reference to.
4272 char* sv_reftype(SV* sv, int ob)
4279 Make the first argument a copy of the second, then delete the original.
4280 The target SV physically takes over ownership of the body of the source SV
4281 and inherits its flags; however, the target keeps any magic it owns,
4282 and any magic in the source is discarded.
4283 Note that this is a rather specialist SV copying operation; most of the
4284 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4286 void sv_replace(SV* sv, SV* nsv)
4291 =item sv_report_used
4293 Dump the contents of all SVs not yet freed. (Debugging aid).
4295 void sv_report_used()
4302 Underlying implementation for the C<reset> Perl function.
4303 Note that the perl-level function is vaguely deprecated.
4305 void sv_reset(char* s, HV* stash)
4312 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4313 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4314 push a back-reference to this RV onto the array of backreferences
4315 associated with that magic.
4317 SV* sv_rvweaken(SV *sv)
4324 Copies an integer into the given SV, upgrading first if necessary.
4325 Does not handle 'set' magic. See also C<sv_setiv_mg>.
4327 void sv_setiv(SV* sv, IV num)
4334 Like C<sv_setiv>, but also handles 'set' magic.
4336 void sv_setiv_mg(SV *sv, IV i)
4343 Copies a double into the given SV, upgrading first if necessary.
4344 Does not handle 'set' magic. See also C<sv_setnv_mg>.
4346 void sv_setnv(SV* sv, NV num)
4353 Like C<sv_setnv>, but also handles 'set' magic.
4355 void sv_setnv_mg(SV *sv, NV num)
4362 Copies a string into an SV. The string must be null-terminated. Does not
4363 handle 'set' magic. See C<sv_setpv_mg>.
4365 void sv_setpv(SV* sv, const char* ptr)
4372 Processes its arguments like C<sprintf> and sets an SV to the formatted
4373 output. Does not handle 'set' magic. See C<sv_setpvf_mg>.
4375 void sv_setpvf(SV* sv, const char* pat, ...)
4382 Like C<sv_setpvf>, but also handles 'set' magic.
4384 void sv_setpvf_mg(SV *sv, const char* pat, ...)
4391 Copies an integer into the given SV, also updating its string value.
4392 Does not handle 'set' magic. See C<sv_setpviv_mg>.
4394 void sv_setpviv(SV* sv, IV num)
4401 Like C<sv_setpviv>, but also handles 'set' magic.
4403 void sv_setpviv_mg(SV *sv, IV iv)
4410 Copies a string into an SV. The C<len> parameter indicates the number of
4411 bytes to be copied. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4413 void sv_setpvn(SV* sv, const char* ptr, STRLEN len)
4420 Like C<sv_setpvn>, but also handles 'set' magic.
4422 void sv_setpvn_mg(SV *sv, const char *ptr, STRLEN len)
4429 Like C<sv_setpv>, but also handles 'set' magic.
4431 void sv_setpv_mg(SV *sv, const char *ptr)
4438 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
4439 argument will be upgraded to an RV. That RV will be modified to point to
4440 the new SV. The C<classname> argument indicates the package for the
4441 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4442 will have a reference count of 1, and the RV will be returned.
4444 SV* sv_setref_iv(SV* rv, const char* classname, IV iv)
4451 Copies a double into a new SV, optionally blessing the SV. The C<rv>
4452 argument will be upgraded to an RV. That RV will be modified to point to
4453 the new SV. The C<classname> argument indicates the package for the
4454 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4455 will have a reference count of 1, and the RV will be returned.
4457 SV* sv_setref_nv(SV* rv, const char* classname, NV nv)
4464 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
4465 argument will be upgraded to an RV. That RV will be modified to point to
4466 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
4467 into the SV. The C<classname> argument indicates the package for the
4468 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4469 will have a reference count of 1, and the RV will be returned.
4471 Do not use with other Perl types such as HV, AV, SV, CV, because those
4472 objects will become corrupted by the pointer copy process.
4474 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
4476 SV* sv_setref_pv(SV* rv, const char* classname, void* pv)
4483 Copies a string into a new SV, optionally blessing the SV. The length of the
4484 string must be specified with C<n>. The C<rv> argument will be upgraded to
4485 an RV. That RV will be modified to point to the new SV. The C<classname>
4486 argument indicates the package for the blessing. Set C<classname> to
4487 C<Nullch> to avoid the blessing. The new SV will have a reference count
4488 of 1, and the RV will be returned.
4490 Note that C<sv_setref_pv> copies the pointer while this copies the string.
4492 SV* sv_setref_pvn(SV* rv, const char* classname, char* pv, STRLEN n)
4499 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
4500 argument will be upgraded to an RV. That RV will be modified to point to
4501 the new SV. The C<classname> argument indicates the package for the
4502 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4503 will have a reference count of 1, and the RV will be returned.
4505 SV* sv_setref_uv(SV* rv, const char* classname, UV uv)
4512 Copies the contents of the source SV C<ssv> into the destination SV
4513 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4514 function if the source SV needs to be reused. Does not handle 'set' magic.
4515 Loosely speaking, it performs a copy-by-value, obliterating any previous
4516 content of the destination.
4518 You probably want to use one of the assortment of wrappers, such as
4519 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4520 C<SvSetMagicSV_nosteal>.
4522 void sv_setsv(SV* dsv, SV* ssv)
4527 =item sv_setsv_flags
4529 Copies the contents of the source SV C<ssv> into the destination SV
4530 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4531 function if the source SV needs to be reused. Does not handle 'set' magic.
4532 Loosely speaking, it performs a copy-by-value, obliterating any previous
4533 content of the destination.
4534 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
4535 C<ssv> if appropriate, else not. C<sv_setsv> and C<sv_setsv_nomg> are
4536 implemented in terms of this function.
4538 You probably want to use one of the assortment of wrappers, such as
4539 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4540 C<SvSetMagicSV_nosteal>.
4542 This is the primary function for copying scalars, and most other
4543 copy-ish functions and macros use this underneath.
4545 void sv_setsv_flags(SV* dsv, SV* ssv, I32 flags)
4552 Like C<sv_setsv>, but also handles 'set' magic.
4554 void sv_setsv_mg(SV *dstr, SV *sstr)
4561 Copies an unsigned integer into the given SV, upgrading first if necessary.
4562 Does not handle 'set' magic. See also C<sv_setuv_mg>.
4564 void sv_setuv(SV* sv, UV num)
4571 Like C<sv_setuv>, but also handles 'set' magic.
4573 void sv_setuv_mg(SV *sv, UV u)
4580 Taint an SV. Use C<SvTAINTED_on> instead.
4581 void sv_taint(SV* sv)
4588 Test an SV for taintedness. Use C<SvTAINTED> instead.
4589 bool sv_tainted(SV* sv)
4596 Returns true if the SV has a true value by Perl's rules.
4597 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
4598 instead use an in-line version.
4607 Removes all magic of type C<type> from an SV.
4609 int sv_unmagic(SV* sv, int type)
4616 Unsets the RV status of the SV, and decrements the reference count of
4617 whatever was being referenced by the RV. This can almost be thought of
4618 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
4619 being zero. See C<SvROK_off>.
4621 void sv_unref(SV* sv)
4626 =item sv_unref_flags
4628 Unsets the RV status of the SV, and decrements the reference count of
4629 whatever was being referenced by the RV. This can almost be thought of
4630 as a reversal of C<newSVrv>. The C<cflags> argument can contain
4631 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
4632 (otherwise the decrementing is conditional on the reference count being
4633 different from one or the reference being a readonly SV).
4636 void sv_unref_flags(SV* sv, U32 flags)
4643 Untaint an SV. Use C<SvTAINTED_off> instead.
4644 void sv_untaint(SV* sv)
4651 Upgrade an SV to a more complex form. Generally adds a new body type to the
4652 SV, then copies across as much information as possible from the old body.
4653 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
4655 bool sv_upgrade(SV* sv, U32 mt)
4662 Tells an SV to use C<ptr> to find its string value. Normally the string is
4663 stored inside the SV but sv_usepvn allows the SV to use an outside string.
4664 The C<ptr> should point to memory that was allocated by C<malloc>. The
4665 string length, C<len>, must be supplied. This function will realloc the
4666 memory pointed to by C<ptr>, so that pointer should not be freed or used by
4667 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
4668 See C<sv_usepvn_mg>.
4670 void sv_usepvn(SV* sv, char* ptr, STRLEN len)
4677 Like C<sv_usepvn>, but also handles 'set' magic.
4679 void sv_usepvn_mg(SV *sv, char *ptr, STRLEN len)
4684 =item sv_utf8_decode
4686 Convert the octets in the PV from UTF-8 to chars. Scan for validity and then
4687 turn off SvUTF8 if needed so that we see characters. Used as a building block
4688 for decode_utf8 in Encode.xs
4690 NOTE: this function is experimental and may change or be
4691 removed without notice.
4693 bool sv_utf8_decode(SV *sv)
4698 =item sv_utf8_downgrade
4700 Attempt to convert the PV of an SV from UTF-8-encoded to byte encoding.
4701 This may not be possible if the PV contains non-byte encoding characters;
4702 if this is the case, either returns false or, if C<fail_ok> is not
4705 This is not as a general purpose Unicode to byte encoding interface:
4706 use the Encode extension for that.
4708 NOTE: this function is experimental and may change or be
4709 removed without notice.
4711 bool sv_utf8_downgrade(SV *sv, bool fail_ok)
4716 =item sv_utf8_encode
4718 Convert the PV of an SV to UTF-8-encoded, but then turn off the C<SvUTF8>
4719 flag so that it looks like octets again. Used as a building block
4720 for encode_utf8 in Encode.xs
4722 void sv_utf8_encode(SV *sv)
4727 =item sv_utf8_upgrade
4729 Convert the PV of an SV to its UTF-8-encoded form.
4730 Forces the SV to string form if it is not already.
4731 Always sets the SvUTF8 flag to avoid future validity checks even
4732 if all the bytes have hibit clear.
4734 This is not as a general purpose byte encoding to Unicode interface:
4735 use the Encode extension for that.
4737 STRLEN sv_utf8_upgrade(SV *sv)
4742 =item sv_utf8_upgrade_flags
4744 Convert the PV of an SV to its UTF-8-encoded form.
4745 Forces the SV to string form if it is not already.
4746 Always sets the SvUTF8 flag to avoid future validity checks even
4747 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
4748 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
4749 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
4751 This is not as a general purpose byte encoding to Unicode interface:
4752 use the Encode extension for that.
4754 STRLEN sv_utf8_upgrade_flags(SV *sv, I32 flags)
4761 A private implementation of the C<SvUVx> macro for compilers which can't
4762 cope with complex macro expressions. Always use the macro instead.
4771 Processes its arguments like C<vsprintf> and appends the formatted output
4772 to an SV. Uses an array of SVs if the C style variable argument list is
4773 missing (NULL). When running with taint checks enabled, indicates via
4774 C<maybe_tainted> if results are untrustworthy (often due to the use of
4777 Usually used via one of its frontends C<sv_catpvf> and C<sv_catpvf_mg>.
4779 void sv_vcatpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
4786 Works like C<vcatpvfn> but copies the text into the SV instead of
4789 Usually used via one of its frontends C<sv_setpvf> and C<sv_setpvf_mg>.
4791 void sv_vsetpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
4799 =head1 Unicode Support
4803 =item bytes_from_utf8
4805 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
4806 Unlike <utf8_to_bytes> but like C<bytes_to_utf8>, returns a pointer to
4807 the newly-created string, and updates C<len> to contain the new
4808 length. Returns the original string if no conversion occurs, C<len>
4809 is unchanged. Do nothing if C<is_utf8> points to 0. Sets C<is_utf8> to
4810 0 if C<s> is converted or contains all 7bit characters.
4812 NOTE: this function is experimental and may change or be
4813 removed without notice.
4815 U8* bytes_from_utf8(U8 *s, STRLEN *len, bool *is_utf8)
4818 Found in file utf8.c
4822 Converts a string C<s> of length C<len> from ASCII into UTF-8 encoding.
4823 Returns a pointer to the newly-created string, and sets C<len> to
4824 reflect the new length.
4826 If you want to convert to UTF-8 from other encodings than ASCII,
4827 see sv_recode_to_utf8().
4829 NOTE: this function is experimental and may change or be
4830 removed without notice.
4832 U8* bytes_to_utf8(U8 *s, STRLEN *len)
4835 Found in file utf8.c
4839 Return true if the strings s1 and s2 differ case-insensitively, false
4840 if not (if they are equal case-insensitively). If u1 is true, the
4841 string s1 is assumed to be in UTF-8-encoded Unicode. If u2 is true,
4842 the string s2 is assumed to be in UTF-8-encoded Unicode. If u1 or u2
4843 are false, the respective string is assumed to be in native 8-bit
4846 If the pe1 and pe2 are non-NULL, the scanning pointers will be copied
4847 in there (they will point at the beginning of the I<next> character).
4848 If the pointers behind pe1 or pe2 are non-NULL, they are the end
4849 pointers beyond which scanning will not continue under any
4850 circustances. If the byte lengths l1 and l2 are non-zero, s1+l1 and
4851 s2+l2 will be used as goal end pointers that will also stop the scan,
4852 and which qualify towards defining a successful match: all the scans
4853 that define an explicit length must reach their goal pointers for
4854 a match to succeed).
4856 For case-insensitiveness, the "casefolding" of Unicode is used
4857 instead of upper/lowercasing both the characters, see
4858 http://www.unicode.org/unicode/reports/tr21/ (Case Mappings).
4860 I32 ibcmp_utf8(const char* a, char **pe1, UV l1, bool u1, const char* b, char **pe2, UV l2, bool u2)
4863 Found in file utf8.c
4867 Tests if some arbitrary number of bytes begins in a valid UTF-8
4868 character. Note that an INVARIANT (i.e. ASCII) character is a valid
4869 UTF-8 character. The actual number of bytes in the UTF-8 character
4870 will be returned if it is valid, otherwise 0.
4872 STRLEN is_utf8_char(U8 *p)
4875 Found in file utf8.c
4877 =item is_utf8_string
4879 Returns true if first C<len> bytes of the given string form a valid
4880 UTF-8 string, false otherwise. Note that 'a valid UTF-8 string' does
4881 not mean 'a string that contains code points above 0x7F encoded in UTF-8'
4882 because a valid ASCII string is a valid UTF-8 string.
4884 bool is_utf8_string(U8 *s, STRLEN len)
4887 Found in file utf8.c
4889 =item is_utf8_string_loc
4891 Like is_ut8_string but store the location of the failure in
4894 bool is_utf8_string_loc(U8 *s, STRLEN len, U8 **p)
4897 Found in file utf8.c
4899 =item pv_uni_display
4901 Build to the scalar dsv a displayable version of the string spv,
4902 length len, the displayable version being at most pvlim bytes long
4903 (if longer, the rest is truncated and "..." will be appended).
4905 The flags argument can have UNI_DISPLAY_ISPRINT set to display
4906 isPRINT()able characters as themselves, UNI_DISPLAY_BACKSLASH
4907 to display the \\[nrfta\\] as the backslashed versions (like '\n')
4908 (UNI_DISPLAY_BACKSLASH is preferred over UNI_DISPLAY_ISPRINT for \\).
4909 UNI_DISPLAY_QQ (and its alias UNI_DISPLAY_REGEX) have both
4910 UNI_DISPLAY_BACKSLASH and UNI_DISPLAY_ISPRINT turned on.
4912 The pointer to the PV of the dsv is returned.
4914 char* pv_uni_display(SV *dsv, U8 *spv, STRLEN len, STRLEN pvlim, UV flags)
4917 Found in file utf8.c
4921 The encoding is assumed to be an Encode object, the PV of the ssv is
4922 assumed to be octets in that encoding and decoding the input starts
4923 from the position which (PV + *offset) pointed to. The dsv will be
4924 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
4925 when the string tstr appears in decoding output or the input ends on
4926 the PV of the ssv. The value which the offset points will be modified
4927 to the last input position on the ssv.
4929 Returns TRUE if the terminator was found, else returns FALSE.
4931 bool sv_cat_decode(SV* dsv, SV *encoding, SV *ssv, int *offset, char* tstr, int tlen)
4936 =item sv_recode_to_utf8
4938 The encoding is assumed to be an Encode object, on entry the PV
4939 of the sv is assumed to be octets in that encoding, and the sv
4940 will be converted into Unicode (and UTF-8).
4942 If the sv already is UTF-8 (or if it is not POK), or if the encoding
4943 is not a reference, nothing is done to the sv. If the encoding is not
4944 an C<Encode::XS> Encoding object, bad things will happen.
4945 (See F<lib/encoding.pm> and L<Encode>).
4947 The PV of the sv is returned.
4949 char* sv_recode_to_utf8(SV* sv, SV *encoding)
4954 =item sv_uni_display
4956 Build to the scalar dsv a displayable version of the scalar sv,
4957 the displayable version being at most pvlim bytes long
4958 (if longer, the rest is truncated and "..." will be appended).
4960 The flags argument is as in pv_uni_display().
4962 The pointer to the PV of the dsv is returned.
4964 char* sv_uni_display(SV *dsv, SV *ssv, STRLEN pvlim, UV flags)
4967 Found in file utf8.c
4971 The "p" contains the pointer to the UTF-8 string encoding
4972 the character that is being converted.
4974 The "ustrp" is a pointer to the character buffer to put the
4975 conversion result to. The "lenp" is a pointer to the length
4978 The "swashp" is a pointer to the swash to use.
4980 Both the special and normal mappings are stored lib/unicore/To/Foo.pl,
4981 and loaded by SWASHGET, using lib/utf8_heavy.pl. The special (usually,
4982 but not always, a multicharacter mapping), is tried first.
4984 The "special" is a string like "utf8::ToSpecLower", which means the
4985 hash %utf8::ToSpecLower. The access to the hash is through
4986 Perl_to_utf8_case().
4988 The "normal" is a string like "ToLower" which means the swash
4991 UV to_utf8_case(U8 *p, U8* ustrp, STRLEN *lenp, SV **swash, char *normal, char *special)
4994 Found in file utf8.c
4998 Convert the UTF-8 encoded character at p to its foldcase version and
4999 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
5000 that the ustrp needs to be at least UTF8_MAXLEN_FOLD+1 bytes since the
5001 foldcase version may be longer than the original character (up to
5004 The first character of the foldcased version is returned
5005 (but note, as explained above, that there may be more.)
5007 UV to_utf8_fold(U8 *p, U8* ustrp, STRLEN *lenp)
5010 Found in file utf8.c
5014 Convert the UTF-8 encoded character at p to its lowercase version and
5015 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
5016 that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the
5017 lowercase version may be longer than the original character (up to two
5020 The first character of the lowercased version is returned
5021 (but note, as explained above, that there may be more.)
5023 UV to_utf8_lower(U8 *p, U8* ustrp, STRLEN *lenp)
5026 Found in file utf8.c
5030 Convert the UTF-8 encoded character at p to its titlecase version and
5031 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
5032 that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the
5033 titlecase version may be longer than the original character (up to two
5036 The first character of the titlecased version is returned
5037 (but note, as explained above, that there may be more.)
5039 UV to_utf8_title(U8 *p, U8* ustrp, STRLEN *lenp)
5042 Found in file utf8.c
5046 Convert the UTF-8 encoded character at p to its uppercase version and
5047 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
5048 that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the
5049 uppercase version may be longer than the original character (up to two
5052 The first character of the uppercased version is returned
5053 (but note, as explained above, that there may be more.)
5055 UV to_utf8_upper(U8 *p, U8* ustrp, STRLEN *lenp)
5058 Found in file utf8.c
5060 =item utf8n_to_uvchr
5062 Returns the native character value of the first character in the string C<s>
5063 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
5064 length, in bytes, of that character.
5066 Allows length and flags to be passed to low level routine.
5068 UV utf8n_to_uvchr(U8 *s, STRLEN curlen, STRLEN* retlen, U32 flags)
5071 Found in file utf8.c
5073 =item utf8n_to_uvuni
5075 Bottom level UTF-8 decode routine.
5076 Returns the unicode code point value of the first character in the string C<s>
5077 which is assumed to be in UTF-8 encoding and no longer than C<curlen>;
5078 C<retlen> will be set to the length, in bytes, of that character.
5080 If C<s> does not point to a well-formed UTF-8 character, the behaviour
5081 is dependent on the value of C<flags>: if it contains UTF8_CHECK_ONLY,
5082 it is assumed that the caller will raise a warning, and this function
5083 will silently just set C<retlen> to C<-1> and return zero. If the
5084 C<flags> does not contain UTF8_CHECK_ONLY, warnings about
5085 malformations will be given, C<retlen> will be set to the expected
5086 length of the UTF-8 character in bytes, and zero will be returned.
5088 The C<flags> can also contain various flags to allow deviations from
5089 the strict UTF-8 encoding (see F<utf8.h>).
5091 Most code should use utf8_to_uvchr() rather than call this directly.
5093 UV utf8n_to_uvuni(U8 *s, STRLEN curlen, STRLEN* retlen, U32 flags)
5096 Found in file utf8.c
5100 Returns the number of UTF-8 characters between the UTF-8 pointers C<a>
5103 WARNING: use only if you *know* that the pointers point inside the
5106 IV utf8_distance(U8 *a, U8 *b)
5109 Found in file utf8.c
5113 Return the UTF-8 pointer C<s> displaced by C<off> characters, either
5114 forward or backward.
5116 WARNING: do not use the following unless you *know* C<off> is within
5117 the UTF-8 data pointed to by C<s> *and* that on entry C<s> is aligned
5118 on the first byte of character or just after the last byte of a character.
5120 U8* utf8_hop(U8 *s, I32 off)
5123 Found in file utf8.c
5127 Return the length of the UTF-8 char encoded string C<s> in characters.
5128 Stops at C<e> (inclusive). If C<e E<lt> s> or if the scan would end
5129 up past C<e>, croaks.
5131 STRLEN utf8_length(U8* s, U8 *e)
5134 Found in file utf8.c
5138 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
5139 Unlike C<bytes_to_utf8>, this over-writes the original string, and
5140 updates len to contain the new length.
5141 Returns zero on failure, setting C<len> to -1.
5143 NOTE: this function is experimental and may change or be
5144 removed without notice.
5146 U8* utf8_to_bytes(U8 *s, STRLEN *len)
5149 Found in file utf8.c
5153 Returns the native character value of the first character in the string C<s>
5154 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
5155 length, in bytes, of that character.
5157 If C<s> does not point to a well-formed UTF-8 character, zero is
5158 returned and retlen is set, if possible, to -1.
5160 UV utf8_to_uvchr(U8 *s, STRLEN* retlen)
5163 Found in file utf8.c
5167 Returns the Unicode code point of the first character in the string C<s>
5168 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
5169 length, in bytes, of that character.
5171 This function should only be used when returned UV is considered
5172 an index into the Unicode semantic tables (e.g. swashes).
5174 If C<s> does not point to a well-formed UTF-8 character, zero is
5175 returned and retlen is set, if possible, to -1.
5177 UV utf8_to_uvuni(U8 *s, STRLEN* retlen)
5180 Found in file utf8.c
5184 Adds the UTF-8 representation of the Native codepoint C<uv> to the end
5185 of the string C<d>; C<d> should be have at least C<UTF8_MAXLEN+1> free
5186 bytes available. The return value is the pointer to the byte after the
5187 end of the new character. In other words,
5189 d = uvchr_to_utf8(d, uv);
5191 is the recommended wide native character-aware way of saying
5195 U8* uvchr_to_utf8(U8 *d, UV uv)
5198 Found in file utf8.c
5200 =item uvuni_to_utf8_flags
5202 Adds the UTF-8 representation of the Unicode codepoint C<uv> to the end
5203 of the string C<d>; C<d> should be have at least C<UTF8_MAXLEN+1> free
5204 bytes available. The return value is the pointer to the byte after the
5205 end of the new character. In other words,
5207 d = uvuni_to_utf8_flags(d, uv, flags);
5211 d = uvuni_to_utf8(d, uv);
5213 (which is equivalent to)
5215 d = uvuni_to_utf8_flags(d, uv, 0);
5217 is the recommended Unicode-aware way of saying
5221 U8* uvuni_to_utf8_flags(U8 *d, UV uv, UV flags)
5224 Found in file utf8.c
5229 =head1 Variables created by C<xsubpp> and C<xsubpp> internal functions
5235 Variable which is setup by C<xsubpp> to indicate the stack base offset,
5236 used by the C<ST>, C<XSprePUSH> and C<XSRETURN> macros. The C<dMARK> macro
5237 must be called prior to setup the C<MARK> variable.
5242 Found in file XSUB.h
5246 Variable which is setup by C<xsubpp> to indicate the
5247 class name for a C++ XS constructor. This is always a C<char*>. See C<THIS>.
5252 Found in file XSUB.h
5256 Sets up the C<ax> variable.
5257 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
5262 Found in file XSUB.h
5266 Sets up the C<items> variable.
5267 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
5272 Found in file XSUB.h
5276 Sets up stack and mark pointers for an XSUB, calling dSP and dMARK.
5277 Sets up the C<ax> and C<items> variables by calling C<dAX> and C<dITEMS>.
5278 This is usually handled automatically by C<xsubpp>.
5283 Found in file XSUB.h
5287 Sets up the C<ix> variable for an XSUB which has aliases. This is usually
5288 handled automatically by C<xsubpp>.
5293 Found in file XSUB.h
5297 Variable which is setup by C<xsubpp> to indicate the number of
5298 items on the stack. See L<perlxs/"Variable-length Parameter Lists">.
5303 Found in file XSUB.h
5307 Variable which is setup by C<xsubpp> to indicate which of an
5308 XSUB's aliases was used to invoke it. See L<perlxs/"The ALIAS: Keyword">.
5313 Found in file XSUB.h
5317 Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
5321 Found in file XSUB.h
5325 Variable which is setup by C<xsubpp> to hold the return value for an
5326 XSUB. This is always the proper type for the XSUB. See
5327 L<perlxs/"The RETVAL Variable">.
5332 Found in file XSUB.h
5336 Used to access elements on the XSUB's stack.
5341 Found in file XSUB.h
5345 Variable which is setup by C<xsubpp> to designate the object in a C++
5346 XSUB. This is always the proper type for the C++ object. See C<CLASS> and
5347 L<perlxs/"Using XS With C++">.
5352 Found in file XSUB.h
5356 Macro to declare an XSUB and its C parameter list. This is handled by
5360 Found in file XSUB.h
5362 =item XSRETURN_EMPTY
5364 Return an empty list from an XSUB immediately.
5370 Found in file XSUB.h
5374 The version identifier for an XS module. This is usually
5375 handled automatically by C<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>.
5378 Found in file XSUB.h
5380 =item XS_VERSION_BOOTCHECK
5382 Macro to verify that a PM module's $VERSION variable matches the XS
5383 module's C<XS_VERSION> variable. This is usually handled automatically by
5384 C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">.
5386 XS_VERSION_BOOTCHECK;
5389 Found in file XSUB.h
5394 =head1 Warning and Dieing
5400 This is the XSUB-writer's interface to Perl's C<die> function.
5401 Normally use this function the same way you use the C C<printf>
5402 function. See C<warn>.
5404 If you want to throw an exception object, assign the object to
5405 C<$@> and then pass C<Nullch> to croak():
5407 errsv = get_sv("@", TRUE);
5408 sv_setsv(errsv, exception_object);
5411 void croak(const char* pat, ...)
5414 Found in file util.c
5418 This is the XSUB-writer's interface to Perl's C<warn> function. Use this
5419 function the same way you use the C C<printf> function. See
5422 void warn(const char* pat, ...)
5425 Found in file util.c
5432 Until May 1997, this document was maintained by Jeff Okamoto
5433 <okamoto@corp.hp.com>. It is now maintained as part of Perl itself.
5435 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
5436 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
5437 Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
5438 Stephen McCamant, and Gurusamy Sarathy.
5440 API Listing originally by Dean Roehrich <roehrich@cray.com>.
5442 Updated to be autogenerated from comments in the source by Benjamin Stuhl.
5446 perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
projects / p5sagit/p5-mst-13.2.git / blob