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. If C<flags> equals C<G_DISCARD>, the element is freed
124 and null is returned.
126 SV* av_delete(AV* ar, I32 key, I32 flags)
133 Returns true if the element indexed by C<key> has been initialized.
135 This relies on the fact that uninitialized array elements are set to
138 bool av_exists(AV* ar, I32 key)
145 Pre-extend an array. The C<key> is the index to which the array should be
148 void av_extend(AV* ar, I32 key)
155 Returns the SV at the specified index in the array. The C<key> is the
156 index. If C<lval> is set then the fetch will be part of a store. Check
157 that the return value is non-null before dereferencing it to a C<SV*>.
159 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for
160 more information on how to use this function on tied arrays.
162 SV** av_fetch(AV* ar, I32 key, I32 lval)
169 Ensure than an array has a given number of elements, equivalent to
170 Perl's C<$#array = $fill;>.
172 void av_fill(AV* ar, I32 fill)
179 Returns the highest index in the array. Returns -1 if the array is
189 Creates a new AV and populates it with a list of SVs. The SVs are copied
190 into the array, so they may be freed after the call to av_make. The new AV
191 will have a reference count of 1.
193 AV* av_make(I32 size, SV** svp)
200 Pops an SV off the end of the array. Returns C<&PL_sv_undef> if the array
210 Pushes an SV onto the end of the array. The array will grow automatically
211 to accommodate the addition.
213 void av_push(AV* ar, SV* val)
220 Shifts an SV off the beginning of the array.
229 Stores an SV in an array. The array index is specified as C<key>. The
230 return value will be NULL if the operation failed or if the value did not
231 need to be actually stored within the array (as in the case of tied
232 arrays). Otherwise it can be dereferenced to get the original C<SV*>. Note
233 that the caller is responsible for suitably incrementing the reference
234 count of C<val> before the call, and decrementing it if the function
237 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for
238 more information on how to use this function on tied arrays.
240 SV** av_store(AV* ar, I32 key, SV* val)
247 Undefines the array. Frees the memory used by the array itself.
249 void av_undef(AV* ar)
256 Unshift the given number of C<undef> values onto the beginning of the
257 array. The array will grow automatically to accommodate the addition. You
258 must then use C<av_store> to assign values to these new elements.
260 void av_unshift(AV* ar, I32 num)
267 Returns the AV of the specified Perl array. If C<create> is set and the
268 Perl variable does not exist then it will be created. If C<create> is not
269 set and the variable does not exist then NULL is returned.
271 NOTE: the perl_ form of this function is deprecated.
273 AV* get_av(const char* name, I32 create)
280 Creates a new AV. The reference count is set to 1.
289 Sort an array. Here is an example:
291 sortsv(AvARRAY(av), av_len(av)+1, Perl_sv_cmp_locale);
293 See lib/sort.pm for details about controlling the sorting algorithm.
295 void sortsv(SV ** array, size_t num_elts, SVCOMPARE_t cmp)
298 Found in file pp_sort.c
303 =head1 Callback Functions
309 Performs a callback to the specified Perl sub. See L<perlcall>.
311 NOTE: the perl_ form of this function is deprecated.
313 I32 call_argv(const char* sub_name, I32 flags, char** argv)
320 Performs a callback to the specified Perl method. The blessed object must
321 be on the stack. See L<perlcall>.
323 NOTE: the perl_ form of this function is deprecated.
325 I32 call_method(const char* methname, I32 flags)
332 Performs a callback to the specified Perl sub. See L<perlcall>.
334 NOTE: the perl_ form of this function is deprecated.
336 I32 call_pv(const char* sub_name, I32 flags)
343 Performs a callback to the Perl sub whose name is in the SV. See
346 NOTE: the perl_ form of this function is deprecated.
348 I32 call_sv(SV* sv, I32 flags)
355 Opening bracket on a callback. See C<LEAVE> and L<perlcall>.
360 Found in file scope.h
364 Tells Perl to C<eval> the given string and return an SV* result.
366 NOTE: the perl_ form of this function is deprecated.
368 SV* eval_pv(const char* p, I32 croak_on_error)
375 Tells Perl to C<eval> the string in the SV.
377 NOTE: the perl_ form of this function is deprecated.
379 I32 eval_sv(SV* sv, I32 flags)
386 Closing bracket for temporaries on a callback. See C<SAVETMPS> and
392 Found in file scope.h
396 Closing bracket on a callback. See C<ENTER> and L<perlcall>.
401 Found in file scope.h
405 Opening bracket for temporaries on a callback. See C<FREETMPS> and
411 Found in file scope.h
416 =head1 Character classes
422 Returns a boolean indicating whether the C C<char> is an ASCII alphanumeric
423 character (including underscore) or digit.
425 bool isALNUM(char ch)
428 Found in file handy.h
432 Returns a boolean indicating whether the C C<char> is an ASCII alphabetic
435 bool isALPHA(char ch)
438 Found in file handy.h
442 Returns a boolean indicating whether the C C<char> is an ASCII
445 bool isDIGIT(char ch)
448 Found in file handy.h
452 Returns a boolean indicating whether the C C<char> is a lowercase
455 bool isLOWER(char ch)
458 Found in file handy.h
462 Returns a boolean indicating whether the C C<char> is whitespace.
464 bool isSPACE(char ch)
467 Found in file handy.h
471 Returns a boolean indicating whether the C C<char> is an uppercase
474 bool isUPPER(char ch)
477 Found in file handy.h
481 Converts the specified character to lowercase.
483 char toLOWER(char ch)
486 Found in file handy.h
490 Converts the specified character to uppercase.
492 char toUPPER(char ch)
495 Found in file handy.h
500 =head1 Cloning an interpreter
506 Create and return a new interpreter by cloning the current one.
508 perl_clone takes these flags as parameters:
510 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
511 without it we only clone the data and zero the stacks,
512 with it we copy the stacks and the new perl interpreter is
513 ready to run at the exact same point as the previous one.
514 The pseudo-fork code uses COPY_STACKS while the
515 threads->new doesn't.
517 CLONEf_KEEP_PTR_TABLE
518 perl_clone keeps a ptr_table with the pointer of the old
519 variable as a key and the new variable as a value,
520 this allows it to check if something has been cloned and not
521 clone it again but rather just use the value and increase the
522 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
523 the ptr_table using the function
524 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
525 reason to keep it around is if you want to dup some of your own
526 variable who are outside the graph perl scans, example of this
527 code is in threads.xs create
530 This is a win32 thing, it is ignored on unix, it tells perls
531 win32host code (which is c++) to clone itself, this is needed on
532 win32 if you want to run two threads at the same time,
533 if you just want to do some stuff in a separate perl interpreter
534 and then throw it away and return to the original one,
535 you don't need to do anything.
537 PerlInterpreter* perl_clone(PerlInterpreter* interp, UV flags)
545 =head1 CV Manipulation Functions
551 Returns the stash of the CV.
560 Returns the CV of the specified Perl subroutine. If C<create> is set and
561 the Perl subroutine does not exist then it will be declared (which has the
562 same effect as saying C<sub name;>). If C<create> is not set and the
563 subroutine does not exist then NULL is returned.
565 NOTE: the perl_ form of this function is deprecated.
567 CV* get_cv(const char* name, I32 create)
575 =head1 Embedding Functions
581 Clear out all the active components of a CV. This can happen either
582 by an explicit C<undef &foo>, or by the reference count going to zero.
583 In the former case, we keep the CvOUTSIDE pointer, so that any anonymous
584 children can still follow the full lexical scope chain.
586 void cv_undef(CV* cv)
593 Loads the module whose name is pointed to by the string part of name.
594 Note that the actual module name, not its filename, should be given.
595 Eg, "Foo::Bar" instead of "Foo/Bar.pm". flags can be any of
596 PERL_LOADMOD_DENY, PERL_LOADMOD_NOIMPORT, or PERL_LOADMOD_IMPORT_OPS
597 (or 0 for no flags). ver, if specified, provides version semantics
598 similar to C<use Foo::Bar VERSION>. The optional trailing SV*
599 arguments can be used to specify arguments to the module's import()
600 method, similar to C<use Foo::Bar VERSION LIST>.
602 void load_module(U32 flags, SV* name, SV* ver, ...)
609 Stub that provides thread hook for perl_destruct when there are
619 Allocates a new Perl interpreter. See L<perlembed>.
621 PerlInterpreter* perl_alloc()
628 Initializes a new Perl interpreter. See L<perlembed>.
630 void perl_construct(PerlInterpreter* interp)
637 Shuts down a Perl interpreter. See L<perlembed>.
639 int perl_destruct(PerlInterpreter* interp)
646 Releases a Perl interpreter. See L<perlembed>.
648 void perl_free(PerlInterpreter* interp)
655 Tells a Perl interpreter to parse a Perl script. See L<perlembed>.
657 int perl_parse(PerlInterpreter* interp, XSINIT_t xsinit, int argc, char** argv, char** env)
664 Tells a Perl interpreter to run. See L<perlembed>.
666 int perl_run(PerlInterpreter* interp)
673 Tells Perl to C<require> the file named by the string argument. It is
674 analogous to the Perl code C<eval "require '$file'">. It's even
675 implemented that way; consider using load_module instead.
677 NOTE: the perl_ form of this function is deprecated.
679 void require_pv(const char* pv)
687 =head1 Functions in file pp_pack.c
694 The engine implementing pack() Perl function.
696 void packlist(SV *cat, char *pat, char *patend, SV **beglist, SV **endlist)
699 Found in file pp_pack.c
703 The engine implementing pack() Perl function. Note: parameters next_in_list and
704 flags are not used. This call should not be used; use packlist instead.
706 void pack_cat(SV *cat, char *pat, char *patend, SV **beglist, SV **endlist, SV ***next_in_list, U32 flags)
709 Found in file pp_pack.c
713 The engine implementing unpack() Perl function. C<unpackstring> puts the
714 extracted list items on the stack and returns the number of elements.
715 Issue C<PUTBACK> before and C<SPAGAIN> after the call to this function.
717 I32 unpackstring(char *pat, char *patend, char *s, char *strend, U32 flags)
720 Found in file pp_pack.c
724 The engine implementing unpack() Perl function. Note: parameters strbeg, new_s
725 and ocnt are not used. This call should not be used, use unpackstring instead.
727 I32 unpack_str(char *pat, char *patend, char *s, char *strbeg, char *strend, char **new_s, I32 ocnt, U32 flags)
730 Found in file pp_pack.c
735 =head1 Global Variables
741 C<PL_modglobal> is a general purpose, interpreter global HV for use by
742 extensions that need to keep information on a per-interpreter basis.
743 In a pinch, it can also be used as a symbol table for extensions
744 to share data among each other. It is a good idea to use keys
745 prefixed by the package name of the extension that owns the data.
750 Found in file intrpvar.h
754 A convenience variable which is typically used with C<SvPV> when one
755 doesn't care about the length of the string. It is usually more efficient
756 to either declare a local variable and use that instead or to use the
762 Found in file thrdvar.h
766 This is the C<false> SV. See C<PL_sv_yes>. Always refer to this as
772 Found in file intrpvar.h
776 This is the C<undef> SV. Always refer to this as C<&PL_sv_undef>.
781 Found in file intrpvar.h
785 This is the C<true> SV. See C<PL_sv_no>. Always refer to this as
791 Found in file intrpvar.h
802 Return the SV from the GV.
811 Returns the glob with the given C<name> and a defined subroutine or
812 C<NULL>. The glob lives in the given C<stash>, or in the stashes
813 accessible via @ISA and UNIVERSAL::.
815 The argument C<level> should be either 0 or -1. If C<level==0>, as a
816 side-effect creates a glob with the given C<name> in the given C<stash>
817 which in the case of success contains an alias for the subroutine, and sets
818 up caching info for this glob. Similarly for all the searched stashes.
820 This function grants C<"SUPER"> token as a postfix of the stash name. The
821 GV returned from C<gv_fetchmeth> may be a method cache entry, which is not
822 visible to Perl code. So when calling C<call_sv>, you should not use
823 the GV directly; instead, you should use the method's CV, which can be
824 obtained from the GV with the C<GvCV> macro.
826 GV* gv_fetchmeth(HV* stash, const char* name, STRLEN len, I32 level)
833 See L<gv_fetchmethod_autoload>.
835 GV* gv_fetchmethod(HV* stash, const char* name)
840 =item gv_fetchmethod_autoload
842 Returns the glob which contains the subroutine to call to invoke the method
843 on the C<stash>. In fact in the presence of autoloading this may be the
844 glob for "AUTOLOAD". In this case the corresponding variable $AUTOLOAD is
847 The third parameter of C<gv_fetchmethod_autoload> determines whether
848 AUTOLOAD lookup is performed if the given method is not present: non-zero
849 means yes, look for AUTOLOAD; zero means no, don't look for AUTOLOAD.
850 Calling C<gv_fetchmethod> is equivalent to calling C<gv_fetchmethod_autoload>
851 with a non-zero C<autoload> parameter.
853 These functions grant C<"SUPER"> token as a prefix of the method name. Note
854 that if you want to keep the returned glob for a long time, you need to
855 check for it being "AUTOLOAD", since at the later time the call may load a
856 different subroutine due to $AUTOLOAD changing its value. Use the glob
857 created via a side effect to do this.
859 These functions have the same side-effects and as C<gv_fetchmeth> with
860 C<level==0>. C<name> should be writable if contains C<':'> or C<'
861 ''>. The warning against passing the GV returned by C<gv_fetchmeth> to
862 C<call_sv> apply equally to these functions.
864 GV* gv_fetchmethod_autoload(HV* stash, const char* name, I32 autoload)
869 =item gv_fetchmeth_autoload
871 Same as gv_fetchmeth(), but looks for autoloaded subroutines too.
872 Returns a glob for the subroutine.
874 For an autoloaded subroutine without a GV, will create a GV even
875 if C<level < 0>. For an autoloaded subroutine without a stub, GvCV()
876 of the result may be zero.
878 GV* gv_fetchmeth_autoload(HV* stash, const char* name, STRLEN len, I32 level)
885 Returns a pointer to the stash for a specified package. C<name> should
886 be a valid UTF-8 string. If C<create> is set then the package will be
887 created if it does not already exist. If C<create> is not set and the
888 package does not exist then NULL is returned.
890 HV* gv_stashpv(const char* name, I32 create)
897 Returns a pointer to the stash for a specified package, which must be a
898 valid UTF-8 string. See C<gv_stashpv>.
900 HV* gv_stashsv(SV* sv, I32 create)
921 Null character pointer.
924 Found in file handy.h
945 Found in file handy.h
950 =head1 Hash Manipulation Functions
956 Returns the HV of the specified Perl hash. If C<create> is set and the
957 Perl variable does not exist then it will be created. If C<create> is not
958 set and the variable does not exist then NULL is returned.
960 NOTE: the perl_ form of this function is deprecated.
962 HV* get_hv(const char* name, I32 create)
969 This flag, used in the length slot of hash entries and magic structures,
970 specifies the structure contains an C<SV*> pointer where a C<char*> pointer
971 is to be expected. (For information only--not to be used).
978 Returns the computed hash stored in the hash entry.
987 Returns the actual pointer stored in the key slot of the hash entry. The
988 pointer may be either C<char*> or C<SV*>, depending on the value of
989 C<HeKLEN()>. Can be assigned to. The C<HePV()> or C<HeSVKEY()> macros are
990 usually preferable for finding the value of a key.
999 If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry
1000 holds an C<SV*> key. Otherwise, holds the actual length of the key. Can
1001 be assigned to. The C<HePV()> macro is usually preferable for finding key
1004 STRLEN HeKLEN(HE* he)
1011 Returns the key slot of the hash entry as a C<char*> value, doing any
1012 necessary dereferencing of possibly C<SV*> keys. The length of the string
1013 is placed in C<len> (this is a macro, so do I<not> use C<&len>). If you do
1014 not care about what the length of the key is, you may use the global
1015 variable C<PL_na>, though this is rather less efficient than using a local
1016 variable. Remember though, that hash keys in perl are free to contain
1017 embedded nulls, so using C<strlen()> or similar is not a good way to find
1018 the length of hash keys. This is very similar to the C<SvPV()> macro
1019 described elsewhere in this document.
1021 char* HePV(HE* he, STRLEN len)
1028 Returns the key as an C<SV*>, or C<Nullsv> if the hash entry does not
1029 contain an C<SV*> key.
1038 Returns the key as an C<SV*>. Will create and return a temporary mortal
1039 C<SV*> if the hash entry contains only a C<char*> key.
1041 SV* HeSVKEY_force(HE* he)
1048 Sets the key to a given C<SV*>, taking care to set the appropriate flags to
1049 indicate the presence of an C<SV*> key, and returns the same
1052 SV* HeSVKEY_set(HE* he, SV* sv)
1059 Returns the value slot (type C<SV*>) stored in the hash entry.
1068 Returns the package name of a stash. See C<SvSTASH>, C<CvSTASH>.
1070 char* HvNAME(HV* stash)
1077 Check that a hash is in an internally consistent state.
1079 void hv_assert(HV* tb)
1086 Clears a hash, making it empty.
1088 void hv_clear(HV* tb)
1093 =item hv_clear_placeholders
1095 Clears any placeholders from a hash. If a restricted hash has any of its keys
1096 marked as readonly and the key is subsequently deleted, the key is not actually
1097 deleted but is marked by assigning it a value of &PL_sv_placeholder. This tags
1098 it so it will be ignored by future operations such as iterating over the hash,
1099 but will still allow the hash to have a value reassigned to the key at some
1100 future point. This function clears any such placeholder keys from the hash.
1101 See Hash::Util::lock_keys() for an example of its use.
1103 void hv_clear_placeholders(HV* hb)
1110 Deletes a key/value pair in the hash. The value SV is removed from the
1111 hash and returned to the caller. The C<klen> is the length of the key.
1112 The C<flags> value will normally be zero; if set to G_DISCARD then NULL
1115 SV* hv_delete(HV* tb, const char* key, I32 klen, I32 flags)
1122 Deletes a key/value pair in the hash. The value SV is removed from the
1123 hash and returned to the caller. The C<flags> value will normally be zero;
1124 if set to G_DISCARD then NULL will be returned. C<hash> can be a valid
1125 precomputed hash value, or 0 to ask for it to be computed.
1127 SV* hv_delete_ent(HV* tb, SV* key, I32 flags, U32 hash)
1134 Returns a boolean indicating whether the specified hash key exists. The
1135 C<klen> is the length of the key.
1137 bool hv_exists(HV* tb, const char* key, I32 klen)
1144 Returns a boolean indicating whether the specified hash key exists. C<hash>
1145 can be a valid precomputed hash value, or 0 to ask for it to be
1148 bool hv_exists_ent(HV* tb, SV* key, U32 hash)
1155 Returns the SV which corresponds to the specified key in the hash. The
1156 C<klen> is the length of the key. If C<lval> is set then the fetch will be
1157 part of a store. Check that the return value is non-null before
1158 dereferencing it to an C<SV*>.
1160 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1161 information on how to use this function on tied hashes.
1163 SV** hv_fetch(HV* tb, const char* key, I32 klen, I32 lval)
1170 Returns the hash entry which corresponds to the specified key in the hash.
1171 C<hash> must be a valid precomputed hash number for the given C<key>, or 0
1172 if you want the function to compute it. IF C<lval> is set then the fetch
1173 will be part of a store. Make sure the return value is non-null before
1174 accessing it. The return value when C<tb> is a tied hash is a pointer to a
1175 static location, so be sure to make a copy of the structure if you need to
1178 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1179 information on how to use this function on tied hashes.
1181 HE* hv_fetch_ent(HV* tb, SV* key, I32 lval, U32 hash)
1188 Prepares a starting point to traverse a hash table. Returns the number of
1189 keys in the hash (i.e. the same as C<HvKEYS(tb)>). The return value is
1190 currently only meaningful for hashes without tie magic.
1192 NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
1193 hash buckets that happen to be in use. If you still need that esoteric
1194 value, you can get it through the macro C<HvFILL(tb)>.
1197 I32 hv_iterinit(HV* tb)
1204 Returns the key from the current position of the hash iterator. See
1207 char* hv_iterkey(HE* entry, I32* retlen)
1214 Returns the key as an C<SV*> from the current position of the hash
1215 iterator. The return value will always be a mortal copy of the key. Also
1218 SV* hv_iterkeysv(HE* entry)
1225 Returns entries from a hash iterator. See C<hv_iterinit>.
1227 You may call C<hv_delete> or C<hv_delete_ent> on the hash entry that the
1228 iterator currently points to, without losing your place or invalidating your
1229 iterator. Note that in this case the current entry is deleted from the hash
1230 with your iterator holding the last reference to it. Your iterator is flagged
1231 to free the entry on the next call to C<hv_iternext>, so you must not discard
1232 your iterator immediately else the entry will leak - call C<hv_iternext> to
1233 trigger the resource deallocation.
1235 HE* hv_iternext(HV* tb)
1242 Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
1245 SV* hv_iternextsv(HV* hv, char** key, I32* retlen)
1250 =item hv_iternext_flags
1252 Returns entries from a hash iterator. See C<hv_iterinit> and C<hv_iternext>.
1253 The C<flags> value will normally be zero; if HV_ITERNEXT_WANTPLACEHOLDERS is
1254 set the placeholders keys (for restricted hashes) will be returned in addition
1255 to normal keys. By default placeholders are automatically skipped over.
1256 Currently a placeholder is implemented with a value that is
1257 C<&Perl_sv_placeholder>. Note that the implementation of placeholders and
1258 restricted hashes may change, and the implementation currently is
1259 insufficiently abstracted for any change to be tidy.
1261 NOTE: this function is experimental and may change or be
1262 removed without notice.
1264 HE* hv_iternext_flags(HV* tb, I32 flags)
1271 Returns the value from the current position of the hash iterator. See
1274 SV* hv_iterval(HV* tb, HE* entry)
1281 Adds magic to a hash. See C<sv_magic>.
1283 void hv_magic(HV* hv, GV* gv, int how)
1290 Evaluates the hash in scalar context and returns the result. Handles magic when the hash is tied.
1292 SV* hv_scalar(HV* hv)
1299 Stores an SV in a hash. The hash key is specified as C<key> and C<klen> is
1300 the length of the key. The C<hash> parameter is the precomputed hash
1301 value; if it is zero then Perl will compute it. The return value will be
1302 NULL if the operation failed or if the value did not need to be actually
1303 stored within the hash (as in the case of tied hashes). Otherwise it can
1304 be dereferenced to get the original C<SV*>. Note that the caller is
1305 responsible for suitably incrementing the reference count of C<val> before
1306 the call, and decrementing it if the function returned NULL. Effectively
1307 a successful hv_store takes ownership of one reference to C<val>. This is
1308 usually what you want; a newly created SV has a reference count of one, so
1309 if all your code does is create SVs then store them in a hash, hv_store
1310 will own the only reference to the new SV, and your code doesn't need to do
1311 anything further to tidy up. hv_store is not implemented as a call to
1312 hv_store_ent, and does not create a temporary SV for the key, so if your
1313 key data is not already in SV form then use hv_store in preference to
1316 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1317 information on how to use this function on tied hashes.
1319 SV** hv_store(HV* tb, const char* key, I32 klen, SV* val, U32 hash)
1326 Stores C<val> in a hash. The hash key is specified as C<key>. The C<hash>
1327 parameter is the precomputed hash value; if it is zero then Perl will
1328 compute it. The return value is the new hash entry so created. It will be
1329 NULL if the operation failed or if the value did not need to be actually
1330 stored within the hash (as in the case of tied hashes). Otherwise the
1331 contents of the return value can be accessed using the C<He?> macros
1332 described here. Note that the caller is responsible for suitably
1333 incrementing the reference count of C<val> before the call, and
1334 decrementing it if the function returned NULL. Effectively a successful
1335 hv_store_ent takes ownership of one reference to C<val>. This is
1336 usually what you want; a newly created SV has a reference count of one, so
1337 if all your code does is create SVs then store them in a hash, hv_store
1338 will own the only reference to the new SV, and your code doesn't need to do
1339 anything further to tidy up. Note that hv_store_ent only reads the C<key>;
1340 unlike C<val> it does not take ownership of it, so maintaining the correct
1341 reference count on C<key> is entirely the caller's responsibility. hv_store
1342 is not implemented as a call to hv_store_ent, and does not create a temporary
1343 SV for the key, so if your key data is not already in SV form then use
1344 hv_store in preference to hv_store_ent.
1346 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1347 information on how to use this function on tied hashes.
1349 HE* hv_store_ent(HV* tb, SV* key, SV* val, U32 hash)
1358 void hv_undef(HV* tb)
1365 Creates a new HV. The reference count is set to 1.
1375 =head1 Magical Functions
1381 Clear something magical that the SV represents. See C<sv_magic>.
1383 int mg_clear(SV* sv)
1390 Copies the magic from one SV to another. See C<sv_magic>.
1392 int mg_copy(SV* sv, SV* nsv, const char* key, I32 klen)
1399 Finds the magic pointer for type matching the SV. See C<sv_magic>.
1401 MAGIC* mg_find(SV* sv, int type)
1408 Free any magic storage used by the SV. See C<sv_magic>.
1417 Do magic after a value is retrieved from the SV. See C<sv_magic>.
1426 Report on the SV's length. See C<sv_magic>.
1428 U32 mg_length(SV* sv)
1435 Turns on the magical status of an SV. See C<sv_magic>.
1437 void mg_magical(SV* sv)
1444 Do magic after a value is assigned to the SV. See C<sv_magic>.
1453 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
1454 argument more than once.
1456 void SvGETMAGIC(SV* sv)
1463 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
1473 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
1474 argument more than once.
1476 void SvSETMAGIC(SV* sv)
1483 Like C<SvSetSV>, but does any set magic required afterwards.
1485 void SvSetMagicSV(SV* dsb, SV* ssv)
1490 =item SvSetMagicSV_nosteal
1492 Like C<SvSetSV_nosteal>, but does any set magic required afterwards.
1494 void SvSetMagicSV_nosteal(SV* dsv, SV* ssv)
1501 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
1504 void SvSetSV(SV* dsb, SV* ssv)
1509 =item SvSetSV_nosteal
1511 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
1512 ssv. May evaluate arguments more than once.
1514 void SvSetSV_nosteal(SV* dsv, SV* ssv)
1521 Arranges for sv to be shared between threads if a suitable module
1524 void SvSHARE(SV* sv)
1531 Releases a mutual exclusion lock on sv if a suitable module
1534 void SvUNLOCK(SV* sv)
1542 =head1 Memory Management
1548 The XSUB-writer's interface to the C C<memcpy> function. The C<src> is the
1549 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1550 the type. May fail on overlapping copies. See also C<Move>.
1552 void Copy(void* src, void* dest, int nitems, type)
1555 Found in file handy.h
1559 Like C<Copy> but returns dest. Useful for encouraging compilers to tail-call
1562 void * CopyD(void* src, void* dest, int nitems, type)
1565 Found in file handy.h
1569 The XSUB-writer's interface to the C C<memmove> function. The C<src> is the
1570 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1571 the type. Can do overlapping moves. See also C<Copy>.
1573 void Move(void* src, void* dest, int nitems, type)
1576 Found in file handy.h
1580 Like C<Move> but returns dest. Useful for encouraging compilers to tail-call
1583 void * MoveD(void* src, void* dest, int nitems, type)
1586 Found in file handy.h
1590 The XSUB-writer's interface to the C C<malloc> function.
1592 void New(int id, void* ptr, int nitems, type)
1595 Found in file handy.h
1599 The XSUB-writer's interface to the C C<malloc> function, with
1602 void Newc(int id, void* ptr, int nitems, type, cast)
1605 Found in file handy.h
1609 The XSUB-writer's interface to the C C<malloc> function. The allocated
1610 memory is zeroed with C<memzero>.
1612 void Newz(int id, void* ptr, int nitems, type)
1615 Found in file handy.h
1619 Fill up memory with a pattern (byte 0xAB over and over again) that
1620 hopefully catches attempts to access uninitialized memory.
1622 void Poison(void* dest, int nitems, type)
1625 Found in file handy.h
1629 The XSUB-writer's interface to the C C<realloc> function.
1631 void Renew(void* ptr, int nitems, type)
1634 Found in file handy.h
1638 The XSUB-writer's interface to the C C<realloc> function, with
1641 void Renewc(void* ptr, int nitems, type, cast)
1644 Found in file handy.h
1648 The XSUB-writer's interface to the C C<free> function.
1650 void Safefree(void* ptr)
1653 Found in file handy.h
1657 Perl's version of C<strdup()>. Returns a pointer to a newly allocated
1658 string which is a duplicate of C<pv>. The size of the string is
1659 determined by C<strlen()>. The memory allocated for the new string can
1660 be freed with the C<Safefree()> function.
1662 char* savepv(const char* pv)
1665 Found in file util.c
1669 Perl's version of what C<strndup()> would be if it existed. Returns a
1670 pointer to a newly allocated string which is a duplicate of the first
1671 C<len> bytes from C<pv>. The memory allocated for the new string can be
1672 freed with the C<Safefree()> function.
1674 char* savepvn(const char* pv, I32 len)
1677 Found in file util.c
1681 A version of C<savepv()> which allocates the duplicate string in memory
1682 which is shared between threads.
1684 char* savesharedpv(const char* pv)
1687 Found in file util.c
1691 This is an architecture-independent macro to copy one structure to another.
1693 void StructCopy(type src, type dest, type)
1696 Found in file handy.h
1700 The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the
1701 destination, C<nitems> is the number of items, and C<type> is the type.
1703 void Zero(void* dest, int nitems, type)
1706 Found in file handy.h
1710 Like C<Zero> but returns dest. Useful for encouraging compilers to tail-call
1713 void * ZeroD(void* dest, int nitems, type)
1716 Found in file handy.h
1721 =head1 Miscellaneous Functions
1727 Analyses the string in order to make fast searches on it using fbm_instr()
1728 -- the Boyer-Moore algorithm.
1730 void fbm_compile(SV* sv, U32 flags)
1733 Found in file util.c
1737 Returns the location of the SV in the string delimited by C<str> and
1738 C<strend>. It returns C<Nullch> if the string can't be found. The C<sv>
1739 does not have to be fbm_compiled, but the search will not be as fast
1742 char* fbm_instr(unsigned char* big, unsigned char* bigend, SV* littlesv, U32 flags)
1745 Found in file util.c
1749 Takes a sprintf-style format pattern and conventional
1750 (non-SV) arguments and returns the formatted string.
1752 (char *) Perl_form(pTHX_ const char* pat, ...)
1754 can be used any place a string (char *) is required:
1756 char * s = Perl_form("%d.%d",major,minor);
1758 Uses a single private buffer so if you want to format several strings you
1759 must explicitly copy the earlier strings away (and free the copies when you
1762 char* form(const char* pat, ...)
1765 Found in file util.c
1769 Fill the sv with current working directory
1771 int getcwd_sv(SV* sv)
1774 Found in file util.c
1778 Returns a new version object based on the passed in SV:
1780 SV *sv = new_version(SV *ver);
1782 Does not alter the passed in ver SV. See "upg_version" if you
1783 want to upgrade the SV.
1785 SV* new_version(SV *ver)
1788 Found in file util.c
1792 Returns a pointer to the next character after the parsed
1793 version string, as well as upgrading the passed in SV to
1796 Function must be called with an already existing SV like
1799 s = scan_version(s,SV *sv, bool qv);
1801 Performs some preprocessing to the string to ensure that
1802 it has the correct characteristics of a version. Flags the
1803 object if it contains an underscore (which denotes this
1804 is a alpha version). The boolean qv denotes that the version
1805 should be interpreted as if it had multiple decimals, even if
1808 char* scan_version(char *vstr, SV *sv, bool qv)
1811 Found in file util.c
1815 Test two strings to see if they are equal. Returns true or false.
1817 bool strEQ(char* s1, char* s2)
1820 Found in file handy.h
1824 Test two strings to see if the first, C<s1>, is greater than or equal to
1825 the second, C<s2>. Returns true or false.
1827 bool strGE(char* s1, char* s2)
1830 Found in file handy.h
1834 Test two strings to see if the first, C<s1>, is greater than the second,
1835 C<s2>. Returns true or false.
1837 bool strGT(char* s1, char* s2)
1840 Found in file handy.h
1844 Test two strings to see if the first, C<s1>, is less than or equal to the
1845 second, C<s2>. Returns true or false.
1847 bool strLE(char* s1, char* s2)
1850 Found in file handy.h
1854 Test two strings to see if the first, C<s1>, is less than the second,
1855 C<s2>. Returns true or false.
1857 bool strLT(char* s1, char* s2)
1860 Found in file handy.h
1864 Test two strings to see if they are different. Returns true or
1867 bool strNE(char* s1, char* s2)
1870 Found in file handy.h
1874 Test two strings to see if they are equal. The C<len> parameter indicates
1875 the number of bytes to compare. Returns true or false. (A wrapper for
1878 bool strnEQ(char* s1, char* s2, STRLEN len)
1881 Found in file handy.h
1885 Test two strings to see if they are different. The C<len> parameter
1886 indicates the number of bytes to compare. Returns true or false. (A
1887 wrapper for C<strncmp>).
1889 bool strnNE(char* s1, char* s2, STRLEN len)
1892 Found in file handy.h
1896 Dummy routine which "locks" an SV when there is no locking module present.
1897 Exists to avoid test for a NULL function pointer and because it could potentially warn under
1898 some level of strict-ness.
1900 void sv_nolocking(SV *)
1903 Found in file util.c
1907 Dummy routine which "shares" an SV when there is no sharing module present.
1908 Exists to avoid test for a NULL function pointer and because it could potentially warn under
1909 some level of strict-ness.
1911 void sv_nosharing(SV *)
1914 Found in file util.c
1916 =item sv_nounlocking
1918 Dummy routine which "unlocks" an SV when there is no locking module present.
1919 Exists to avoid test for a NULL function pointer and because it could potentially warn under
1920 some level of strict-ness.
1922 void sv_nounlocking(SV *)
1925 Found in file util.c
1929 In-place upgrade of the supplied SV to a version object.
1931 SV *sv = upg_version(SV *sv);
1933 Returns a pointer to the upgraded SV.
1935 SV* upg_version(SV *ver)
1938 Found in file util.c
1942 Version object aware cmp. Both operands must already have been
1943 converted into version objects.
1945 int vcmp(SV *lvs, SV *rvs)
1948 Found in file util.c
1952 Accepts a version object and returns the normalized string
1953 representation. Call like:
1957 NOTE: you can pass either the object directly or the SV
1958 contained within the RV.
1963 Found in file util.c
1967 Accepts a version object and returns the normalized floating
1968 point representation. Call like:
1972 NOTE: you can pass either the object directly or the SV
1973 contained within the RV.
1978 Found in file util.c
1982 In order to maintain maximum compatibility with earlier versions
1983 of Perl, this function will return either the floating point
1984 notation or the multiple dotted notation, depending on whether
1985 the original version contained 1 or more dots, respectively
1987 SV* vstringify(SV *vs)
1990 Found in file util.c
1995 =head1 Numeric functions
2001 converts a string representing a binary number to numeric form.
2003 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2004 conversion flags, and I<result> should be NULL or a pointer to an NV.
2005 The scan stops at the end of the string, or the first invalid character.
2006 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2007 invalid character will also trigger a warning.
2008 On return I<*len> is set to the length of the scanned string,
2009 and I<*flags> gives output flags.
2011 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2012 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_bin>
2013 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2014 and writes the value to I<*result> (or the value is discarded if I<result>
2017 The binary number may optionally be prefixed with "0b" or "b" unless
2018 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
2019 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the binary
2020 number may use '_' characters to separate digits.
2022 UV grok_bin(char* start, STRLEN* len, I32* flags, NV *result)
2025 Found in file numeric.c
2029 converts a string representing a hex number to numeric form.
2031 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2032 conversion flags, and I<result> should be NULL or a pointer to an NV.
2033 The scan stops at the end of the string, or the first invalid character.
2034 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2035 invalid character will also trigger a warning.
2036 On return I<*len> is set to the length of the scanned string,
2037 and I<*flags> gives output flags.
2039 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2040 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_hex>
2041 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2042 and writes the value to I<*result> (or the value is discarded if I<result>
2045 The hex number may optionally be prefixed with "0x" or "x" unless
2046 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
2047 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the hex
2048 number may use '_' characters to separate digits.
2050 UV grok_hex(char* start, STRLEN* len, I32* flags, NV *result)
2053 Found in file numeric.c
2057 Recognise (or not) a number. The type of the number is returned
2058 (0 if unrecognised), otherwise it is a bit-ORed combination of
2059 IS_NUMBER_IN_UV, IS_NUMBER_GREATER_THAN_UV_MAX, IS_NUMBER_NOT_INT,
2060 IS_NUMBER_NEG, IS_NUMBER_INFINITY, IS_NUMBER_NAN (defined in perl.h).
2062 If the value of the number can fit an in UV, it is returned in the *valuep
2063 IS_NUMBER_IN_UV will be set to indicate that *valuep is valid, IS_NUMBER_IN_UV
2064 will never be set unless *valuep is valid, but *valuep may have been assigned
2065 to during processing even though IS_NUMBER_IN_UV is not set on return.
2066 If valuep is NULL, IS_NUMBER_IN_UV will be set for the same cases as when
2067 valuep is non-NULL, but no actual assignment (or SEGV) will occur.
2069 IS_NUMBER_NOT_INT will be set with IS_NUMBER_IN_UV if trailing decimals were
2070 seen (in which case *valuep gives the true value truncated to an integer), and
2071 IS_NUMBER_NEG if the number is negative (in which case *valuep holds the
2072 absolute value). IS_NUMBER_IN_UV is not set if e notation was used or the
2073 number is larger than a UV.
2075 int grok_number(const char *pv, STRLEN len, UV *valuep)
2078 Found in file numeric.c
2080 =item grok_numeric_radix
2082 Scan and skip for a numeric decimal separator (radix).
2084 bool grok_numeric_radix(const char **sp, const char *send)
2087 Found in file numeric.c
2091 converts a string representing an octal number to numeric form.
2093 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2094 conversion flags, and I<result> should be NULL or a pointer to an NV.
2095 The scan stops at the end of the string, or the first invalid character.
2096 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2097 invalid character will also trigger a warning.
2098 On return I<*len> is set to the length of the scanned string,
2099 and I<*flags> gives output flags.
2101 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2102 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_oct>
2103 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2104 and writes the value to I<*result> (or the value is discarded if I<result>
2107 If C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the octal
2108 number may use '_' characters to separate digits.
2110 UV grok_oct(char* start, STRLEN* len, I32* flags, NV *result)
2113 Found in file numeric.c
2117 For backwards compatibility. Use C<grok_bin> instead.
2119 NV scan_bin(char* start, STRLEN len, STRLEN* retlen)
2122 Found in file numeric.c
2126 For backwards compatibility. Use C<grok_hex> instead.
2128 NV scan_hex(char* start, STRLEN len, STRLEN* retlen)
2131 Found in file numeric.c
2135 For backwards compatibility. Use C<grok_oct> instead.
2137 NV scan_oct(char* start, STRLEN len, STRLEN* retlen)
2140 Found in file numeric.c
2145 =head1 Optree Manipulation Functions
2151 If C<cv> is a constant sub eligible for inlining. returns the constant
2152 value returned by the sub. Otherwise, returns NULL.
2154 Constant subs can be created with C<newCONSTSUB> or as described in
2155 L<perlsub/"Constant Functions">.
2157 SV* cv_const_sv(CV* cv)
2164 Creates a constant sub equivalent to Perl C<sub FOO () { 123 }> which is
2165 eligible for inlining at compile-time.
2167 CV* newCONSTSUB(HV* stash, char* name, SV* sv)
2174 Used by C<xsubpp> to hook up XSUBs as Perl subs.
2182 =head1 Pad Data Structures
2188 Get the value at offset po in the current pad.
2189 Use macro PAD_SV instead of calling this function directly.
2191 SV* pad_sv(PADOFFSET po)
2199 =head1 Stack Manipulation Macros
2205 Declare a stack marker variable, C<mark>, for the XSUB. See C<MARK> and
2215 Saves the original stack mark for the XSUB. See C<ORIGMARK>.
2224 Declares a local copy of perl's stack pointer for the XSUB, available via
2225 the C<SP> macro. See C<SP>.
2234 Used to extend the argument stack for an XSUB's return values. Once
2235 used, guarantees that there is room for at least C<nitems> to be pushed
2238 void EXTEND(SP, int nitems)
2245 Stack marker variable for the XSUB. See C<dMARK>.
2252 Push an integer onto the stack. The stack must have room for this element.
2253 Handles 'set' magic. Does not use C<TARG>. See also C<PUSHi>, C<mXPUSHi>
2263 Push a double onto the stack. The stack must have room for this element.
2264 Handles 'set' magic. Does not use C<TARG>. See also C<PUSHn>, C<mXPUSHn>
2274 Push a string onto the stack. The stack must have room for this element.
2275 The C<len> indicates the length of the string. Handles 'set' magic. Does
2276 not use C<TARG>. See also C<PUSHp>, C<mXPUSHp> and C<XPUSHp>.
2278 void mPUSHp(char* str, STRLEN len)
2285 Push an unsigned integer onto the stack. The stack must have room for this
2286 element. Handles 'set' magic. Does not use C<TARG>. See also C<PUSHu>,
2287 C<mXPUSHu> and C<XPUSHu>.
2296 Push an integer onto the stack, extending the stack if necessary. Handles
2297 'set' magic. Does not use C<TARG>. See also C<XPUSHi>, C<mPUSHi> and
2307 Push a double onto the stack, extending the stack if necessary. Handles
2308 'set' magic. Does not use C<TARG>. See also C<XPUSHn>, C<mPUSHn> and
2318 Push a string onto the stack, extending the stack if necessary. The C<len>
2319 indicates the length of the string. Handles 'set' magic. Does not use
2320 C<TARG>. See also C<XPUSHp>, C<mPUSHp> and C<PUSHp>.
2322 void mXPUSHp(char* str, STRLEN len)
2329 Push an unsigned integer onto the stack, extending the stack if necessary.
2330 Handles 'set' magic. Does not use C<TARG>. See also C<XPUSHu>, C<mPUSHu>
2340 The original stack mark for the XSUB. See C<dORIGMARK>.
2347 Pops an integer off the stack.
2356 Pops a long off the stack.
2365 Pops a double off the stack.
2374 Pops a string off the stack. Deprecated. New code should provide
2375 a STRLEN n_a and use POPpx.
2384 Pops a string off the stack which must consist of bytes i.e. characters < 256.
2385 Requires a variable STRLEN n_a in scope.
2394 Pops a string off the stack.
2395 Requires a variable STRLEN n_a in scope.
2404 Pops an SV off the stack.
2413 Push an integer onto the stack. The stack must have room for this element.
2414 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
2415 called to declare it. Do not call multiple C<TARG>-oriented macros to
2416 return lists from XSUB's - see C<mPUSHi> instead. See also C<XPUSHi> and
2426 Opening bracket for arguments on a callback. See C<PUTBACK> and
2436 Push a new mortal SV onto the stack. The stack must have room for this
2437 element. Does not handle 'set' magic. Does not use C<TARG>. See also
2438 C<PUSHs>, C<XPUSHmortal> and C<XPUSHs>.
2447 Push a double onto the stack. The stack must have room for this element.
2448 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
2449 called to declare it. Do not call multiple C<TARG>-oriented macros to
2450 return lists from XSUB's - see C<mPUSHn> instead. See also C<XPUSHn> and
2460 Push a string onto the stack. The stack must have room for this element.
2461 The C<len> indicates the length of the string. Handles 'set' magic. Uses
2462 C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to declare it. Do not
2463 call multiple C<TARG>-oriented macros to return lists from XSUB's - see
2464 C<mPUSHp> instead. See also C<XPUSHp> and C<mXPUSHp>.
2466 void PUSHp(char* str, STRLEN len)
2473 Push an SV onto the stack. The stack must have room for this element.
2474 Does not handle 'set' magic. Does not use C<TARG>. See also C<PUSHmortal>,
2475 C<XPUSHs> and C<XPUSHmortal>.
2484 Push an unsigned integer onto the stack. The stack must have room for this
2485 element. Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG>
2486 should be called to declare it. Do not call multiple C<TARG>-oriented
2487 macros to return lists from XSUB's - see C<mPUSHu> instead. See also
2488 C<XPUSHu> and C<mXPUSHu>.
2497 Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
2498 See C<PUSHMARK> and L<perlcall> for other uses.
2507 Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and
2515 Refetch the stack pointer. Used after a callback. See L<perlcall>.
2524 Push an integer onto the stack, extending the stack if necessary. Handles
2525 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
2526 declare it. Do not call multiple C<TARG>-oriented macros to return lists
2527 from XSUB's - see C<mXPUSHi> instead. See also C<PUSHi> and C<mPUSHi>.
2536 Push a new mortal SV onto the stack, extending the stack if necessary. Does
2537 not handle 'set' magic. Does not use C<TARG>. See also C<XPUSHs>,
2538 C<PUSHmortal> and C<PUSHs>.
2547 Push a double onto the stack, extending the stack if necessary. Handles
2548 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
2549 declare it. Do not call multiple C<TARG>-oriented macros to return lists
2550 from XSUB's - see C<mXPUSHn> instead. See also C<PUSHn> and C<mPUSHn>.
2559 Push a string onto the stack, extending the stack if necessary. The C<len>
2560 indicates the length of the string. Handles 'set' magic. Uses C<TARG>, so
2561 C<dTARGET> or C<dXSTARG> should be called to declare it. Do not call
2562 multiple C<TARG>-oriented macros to return lists from XSUB's - see
2563 C<mXPUSHp> instead. See also C<PUSHp> and C<mPUSHp>.
2565 void XPUSHp(char* str, STRLEN len)
2572 Push an SV onto the stack, extending the stack if necessary. Does not
2573 handle 'set' magic. Does not use C<TARG>. See also C<XPUSHmortal>,
2574 C<PUSHs> and C<PUSHmortal>.
2583 Push an unsigned integer onto the stack, extending the stack if necessary.
2584 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
2585 called to declare it. Do not call multiple C<TARG>-oriented macros to
2586 return lists from XSUB's - see C<mXPUSHu> instead. See also C<PUSHu> and
2596 Return from XSUB, indicating number of items on the stack. This is usually
2597 handled by C<xsubpp>.
2599 void XSRETURN(int nitems)
2602 Found in file XSUB.h
2604 =item XSRETURN_EMPTY
2606 Return an empty list from an XSUB immediately.
2611 Found in file XSUB.h
2615 Return an integer from an XSUB immediately. Uses C<XST_mIV>.
2617 void XSRETURN_IV(IV iv)
2620 Found in file XSUB.h
2624 Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
2629 Found in file XSUB.h
2633 Return a double from an XSUB immediately. Uses C<XST_mNV>.
2635 void XSRETURN_NV(NV nv)
2638 Found in file XSUB.h
2642 Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
2644 void XSRETURN_PV(char* str)
2647 Found in file XSUB.h
2649 =item XSRETURN_UNDEF
2651 Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
2656 Found in file XSUB.h
2660 Return an integer from an XSUB immediately. Uses C<XST_mUV>.
2662 void XSRETURN_UV(IV uv)
2665 Found in file XSUB.h
2669 Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
2674 Found in file XSUB.h
2678 Place an integer into the specified position C<pos> on the stack. The
2679 value is stored in a new mortal SV.
2681 void XST_mIV(int pos, IV iv)
2684 Found in file XSUB.h
2688 Place C<&PL_sv_no> into the specified position C<pos> on the
2691 void XST_mNO(int pos)
2694 Found in file XSUB.h
2698 Place a double into the specified position C<pos> on the stack. The value
2699 is stored in a new mortal SV.
2701 void XST_mNV(int pos, NV nv)
2704 Found in file XSUB.h
2708 Place a copy of a string into the specified position C<pos> on the stack.
2709 The value is stored in a new mortal SV.
2711 void XST_mPV(int pos, char* str)
2714 Found in file XSUB.h
2718 Place C<&PL_sv_undef> into the specified position C<pos> on the
2721 void XST_mUNDEF(int pos)
2724 Found in file XSUB.h
2728 Place C<&PL_sv_yes> into the specified position C<pos> on the
2731 void XST_mYES(int pos)
2734 Found in file XSUB.h
2745 An enum of flags for Perl types. These are found in the file B<sv.h>
2746 in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
2753 Integer type flag for scalars. See C<svtype>.
2760 Double type flag for scalars. See C<svtype>.
2767 Pointer type flag for scalars. See C<svtype>.
2774 Type flag for arrays. See C<svtype>.
2781 Type flag for code refs. See C<svtype>.
2788 Type flag for hashes. See C<svtype>.
2795 Type flag for blessed scalars. See C<svtype>.
2803 =head1 SV Manipulation Functions
2809 Returns the SV of the specified Perl scalar. If C<create> is set and the
2810 Perl variable does not exist then it will be created. If C<create> is not
2811 set and the variable does not exist then NULL is returned.
2813 NOTE: the perl_ form of this function is deprecated.
2815 SV* get_sv(const char* name, I32 create)
2818 Found in file perl.c
2820 =item looks_like_number
2822 Test if the content of an SV looks like a number (or is a number).
2823 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
2824 non-numeric warning), even if your atof() doesn't grok them.
2826 I32 looks_like_number(SV* sv)
2833 Creates an RV wrapper for an SV. The reference count for the original SV is
2836 SV* newRV_inc(SV* sv)
2843 Creates an RV wrapper for an SV. The reference count for the original
2844 SV is B<not> incremented.
2846 SV* newRV_noinc(SV *sv)
2853 Creates a new SV. A non-zero C<len> parameter indicates the number of
2854 bytes of preallocated string space the SV should have. An extra byte for a
2855 tailing NUL is also reserved. (SvPOK is not set for the SV even if string
2856 space is allocated.) The reference count for the new SV is set to 1.
2857 C<id> is an integer id between 0 and 1299 (used to identify leaks).
2859 SV* NEWSV(int id, STRLEN len)
2862 Found in file handy.h
2866 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
2867 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
2870 SV* newSV(STRLEN len)
2877 Creates a new SV and copies an integer into it. The reference count for the
2887 Creates a new SV and copies a floating point value into it.
2888 The reference count for the SV is set to 1.
2897 Creates a new SV and copies a string into it. The reference count for the
2898 SV is set to 1. If C<len> is zero, Perl will compute the length using
2899 strlen(). For efficiency, consider using C<newSVpvn> instead.
2901 SV* newSVpv(const char* s, STRLEN len)
2908 Creates a new SV and initializes it with the string formatted like
2911 SV* newSVpvf(const char* pat, ...)
2918 Creates a new SV and copies a string into it. The reference count for the
2919 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
2920 string. You are responsible for ensuring that the source string is at least
2921 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
2923 SV* newSVpvn(const char* s, STRLEN len)
2928 =item newSVpvn_share
2930 Creates a new SV with its SvPVX pointing to a shared string in the string
2931 table. If the string does not already exist in the table, it is created
2932 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
2933 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
2934 otherwise the hash is computed. The idea here is that as the string table
2935 is used for shared hash keys these strings will have SvPVX == HeKEY and
2936 hash lookup will avoid string compare.
2938 SV* newSVpvn_share(const char* s, I32 len, U32 hash)
2945 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
2946 it will be upgraded to one. If C<classname> is non-null then the new SV will
2947 be blessed in the specified package. The new SV is returned and its
2948 reference count is 1.
2950 SV* newSVrv(SV* rv, const char* classname)
2957 Creates a new SV which is an exact duplicate of the original SV.
2960 SV* newSVsv(SV* old)
2967 Creates a new SV and copies an unsigned integer into it.
2968 The reference count for the SV is set to 1.
2977 Returns the length of the string which is in the SV. See C<SvLEN>.
2979 STRLEN SvCUR(SV* sv)
2986 Set the length of the string which is in the SV. See C<SvCUR>.
2988 void SvCUR_set(SV* sv, STRLEN len)
2995 Returns a pointer to the last character in the string which is in the SV.
2996 See C<SvCUR>. Access the character as *(SvEND(sv)).
3005 Expands the character buffer in the SV so that it has room for the
3006 indicated number of bytes (remember to reserve space for an extra trailing
3007 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
3008 Returns a pointer to the character buffer.
3010 char * SvGROW(SV* sv, STRLEN len)
3017 Returns a boolean indicating whether the SV contains an integer.
3026 Returns a boolean indicating whether the SV contains an integer. Checks
3027 the B<private> setting. Use C<SvIOK>.
3036 Returns a boolean indicating whether the SV contains a signed integer.
3038 bool SvIOK_notUV(SV* sv)
3045 Unsets the IV status of an SV.
3047 void SvIOK_off(SV* sv)
3054 Tells an SV that it is an integer.
3056 void SvIOK_on(SV* sv)
3063 Tells an SV that it is an integer and disables all other OK bits.
3065 void SvIOK_only(SV* sv)
3072 Tells and SV that it is an unsigned integer and disables all other OK bits.
3074 void SvIOK_only_UV(SV* sv)
3081 Returns a boolean indicating whether the SV contains an unsigned integer.
3083 bool SvIOK_UV(SV* sv)
3090 Returns a boolean indicating whether the SV is Copy-On-Write. (either shared
3091 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
3094 bool SvIsCOW(SV* sv)
3099 =item SvIsCOW_shared_hash
3101 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
3104 bool SvIsCOW_shared_hash(SV* sv)
3111 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
3112 version which guarantees to evaluate sv only once.
3121 Coerces the given SV to an integer and returns it. Guarantees to evaluate
3122 sv only once. Use the more efficient C<SvIV> otherwise.
3131 Returns the raw value in the SV's IV slot, without checks or conversions.
3132 Only use when you are sure SvIOK is true. See also C<SvIV()>.
3141 Like C<SvIV> but doesn't process magic.
3143 IV SvIV_nomg(SV* sv)
3150 Returns the size of the string buffer in the SV, not including any part
3151 attributable to C<SvOOK>. See C<SvCUR>.
3153 STRLEN SvLEN(SV* sv)
3160 Returns a boolean indicating whether the SV contains a number, integer or
3170 Returns a boolean indicating whether the SV contains a number, integer or
3171 double. Checks the B<private> setting. Use C<SvNIOK>.
3173 bool SvNIOKp(SV* sv)
3180 Unsets the NV/IV status of an SV.
3182 void SvNIOK_off(SV* sv)
3189 Returns a boolean indicating whether the SV contains a double.
3198 Returns a boolean indicating whether the SV contains a double. Checks the
3199 B<private> setting. Use C<SvNOK>.
3208 Unsets the NV status of an SV.
3210 void SvNOK_off(SV* sv)
3217 Tells an SV that it is a double.
3219 void SvNOK_on(SV* sv)
3226 Tells an SV that it is a double and disables all other OK bits.
3228 void SvNOK_only(SV* sv)
3235 Coerce the given SV to a double and return it. See C<SvNVx> for a version
3236 which guarantees to evaluate sv only once.
3245 Returns the raw value in the SV's NV slot, without checks or conversions.
3246 Only use when you are sure SvNOK is true. See also C<SvNV()>.
3255 Coerces the given SV to a double and returns it. Guarantees to evaluate
3256 sv only once. Use the more efficient C<SvNV> otherwise.
3265 Returns a boolean indicating whether the value is an SV. It also tells
3266 whether the value is defined or not.
3275 Returns a boolean indicating whether the SvIVX is a valid offset value for
3276 the SvPVX. This hack is used internally to speed up removal of characters
3277 from the beginning of a SvPV. When SvOOK is true, then the start of the
3278 allocated string buffer is really (SvPVX - SvIVX).
3287 Returns a boolean indicating whether the SV contains a character
3297 Returns a boolean indicating whether the SV contains a character string.
3298 Checks the B<private> setting. Use C<SvPOK>.
3307 Unsets the PV status of an SV.
3309 void SvPOK_off(SV* sv)
3316 Tells an SV that it is a string.
3318 void SvPOK_on(SV* sv)
3325 Tells an SV that it is a string and disables all other OK bits.
3326 Will also turn off the UTF-8 status.
3328 void SvPOK_only(SV* sv)
3333 =item SvPOK_only_UTF8
3335 Tells an SV that it is a string and disables all other OK bits,
3336 and leaves the UTF-8 status as it was.
3338 void SvPOK_only_UTF8(SV* sv)
3345 Returns a pointer to the string in the SV, or a stringified form of
3346 the SV if the SV does not contain a string. The SV may cache the
3347 stringified version becoming C<SvPOK>. Handles 'get' magic. See also
3348 C<SvPVx> for a version which guarantees to evaluate sv only once.
3350 char* SvPV(SV* sv, STRLEN len)
3357 Like C<SvPV>, but converts sv to byte representation first if necessary.
3359 char* SvPVbyte(SV* sv, STRLEN len)
3366 Like C<SvPV>, but converts sv to byte representation first if necessary.
3367 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
3370 char* SvPVbytex(SV* sv, STRLEN len)
3375 =item SvPVbytex_force
3377 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
3378 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
3381 char* SvPVbytex_force(SV* sv, STRLEN len)
3386 =item SvPVbyte_force
3388 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
3390 char* SvPVbyte_force(SV* sv, STRLEN len)
3395 =item SvPVbyte_nolen
3397 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
3399 char* SvPVbyte_nolen(SV* sv)
3406 Like C<SvPV>, but converts sv to utf8 first if necessary.
3408 char* SvPVutf8(SV* sv, STRLEN len)
3415 Like C<SvPV>, but converts sv to utf8 first if necessary.
3416 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
3419 char* SvPVutf8x(SV* sv, STRLEN len)
3424 =item SvPVutf8x_force
3426 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
3427 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
3430 char* SvPVutf8x_force(SV* sv, STRLEN len)
3435 =item SvPVutf8_force
3437 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
3439 char* SvPVutf8_force(SV* sv, STRLEN len)
3444 =item SvPVutf8_nolen
3446 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
3448 char* SvPVutf8_nolen(SV* sv)
3455 A version of C<SvPV> which guarantees to evaluate sv only once.
3457 char* SvPVx(SV* sv, STRLEN len)
3464 Returns a pointer to the physical string in the SV. The SV must contain a
3474 Like C<SvPV> but will force the SV into containing just a string
3475 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
3478 char* SvPV_force(SV* sv, STRLEN len)
3483 =item SvPV_force_nomg
3485 Like C<SvPV> but will force the SV into containing just a string
3486 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
3487 directly. Doesn't process magic.
3489 char* SvPV_force_nomg(SV* sv, STRLEN len)
3496 Returns a pointer to the string in the SV, or a stringified form of
3497 the SV if the SV does not contain a string. The SV may cache the
3498 stringified form becoming C<SvPOK>. Handles 'get' magic.
3500 char* SvPV_nolen(SV* sv)
3507 Like C<SvPV> but doesn't process magic.
3509 char* SvPV_nomg(SV* sv, STRLEN len)
3516 Returns the value of the object's reference count.
3518 U32 SvREFCNT(SV* sv)
3525 Decrements the reference count of the given SV.
3527 void SvREFCNT_dec(SV* sv)
3534 Increments the reference count of the given SV.
3536 SV* SvREFCNT_inc(SV* sv)
3543 Tests if the SV is an RV.
3552 Unsets the RV status of an SV.
3554 void SvROK_off(SV* sv)
3561 Tells an SV that it is an RV.
3563 void SvROK_on(SV* sv)
3570 Dereferences an RV to return the SV.
3579 Returns the stash of the SV.
3588 Taints an SV if tainting is enabled.
3590 void SvTAINT(SV* sv)
3597 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
3600 bool SvTAINTED(SV* sv)
3607 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
3608 some of Perl's fundamental security features. XS module authors should not
3609 use this function unless they fully understand all the implications of
3610 unconditionally untainting the value. Untainting should be done in the
3611 standard perl fashion, via a carefully crafted regexp, rather than directly
3612 untainting variables.
3614 void SvTAINTED_off(SV* sv)
3621 Marks an SV as tainted if tainting is enabled.
3623 void SvTAINTED_on(SV* sv)
3630 Returns a boolean indicating whether Perl would evaluate the SV as true or
3631 false, defined or undefined. Does not handle 'get' magic.
3640 Returns the type of the SV. See C<svtype>.
3642 svtype SvTYPE(SV* sv)
3649 Returns a boolean indicating whether the SV contains an unsigned integer.
3658 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
3659 perform the upgrade if necessary. See C<svtype>.
3661 void SvUPGRADE(SV* sv, svtype type)
3668 Returns a boolean indicating whether the SV contains UTF-8 encoded data.
3677 Unsets the UTF-8 status of an SV.
3679 void SvUTF8_off(SV *sv)
3686 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
3687 Do not use frivolously.
3689 void SvUTF8_on(SV *sv)
3696 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
3697 for a version which guarantees to evaluate sv only once.
3706 Returns the raw value in the SV's UV slot, without checks or conversions.
3707 Only use when you are sure SvIOK is true. See also C<SvUV()>.
3716 Coerces the given SV to an unsigned integer and returns it. Guarantees to
3717 evaluate sv only once. Use the more efficient C<SvUV> otherwise.
3726 Like C<SvUV> but doesn't process magic.
3728 UV SvUV_nomg(SV* sv)
3735 Returns a boolean indicating whether the SV contains a v-string.
3744 This function is only called on magical items, and is only used by
3745 sv_true() or its macro equivalent.
3747 bool sv_2bool(SV* sv)
3754 Using various gambits, try to get a CV from an SV; in addition, try if
3755 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
3757 CV* sv_2cv(SV* sv, HV** st, GV** gvp, I32 lref)
3764 Using various gambits, try to get an IO from an SV: the IO slot if its a
3765 GV; or the recursive result if we're an RV; or the IO slot of the symbol
3766 named after the PV if we're a string.
3775 Return the integer value of an SV, doing any necessary string
3776 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
3777 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
3779 IV sv_2iv_flags(SV* sv, I32 flags)
3786 Marks an existing SV as mortal. The SV will be destroyed "soon", either
3787 by an explicit call to FREETMPS, or by an implicit call at places such as
3788 statement boundaries. SvTEMP() is turned on which means that the SV's
3789 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
3790 and C<sv_mortalcopy>.
3792 SV* sv_2mortal(SV* sv)
3799 Return the num value of an SV, doing any necessary string or integer
3800 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
3810 Return a pointer to the byte-encoded representation of the SV, and set *lp
3811 to its length. May cause the SV to be downgraded from UTF-8 as a
3814 Usually accessed via the C<SvPVbyte> macro.
3816 char* sv_2pvbyte(SV* sv, STRLEN* lp)
3821 =item sv_2pvbyte_nolen
3823 Return a pointer to the byte-encoded representation of the SV.
3824 May cause the SV to be downgraded from UTF-8 as a side-effect.
3826 Usually accessed via the C<SvPVbyte_nolen> macro.
3828 char* sv_2pvbyte_nolen(SV* sv)
3835 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3836 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
3838 Usually accessed via the C<SvPVutf8> macro.
3840 char* sv_2pvutf8(SV* sv, STRLEN* lp)
3845 =item sv_2pvutf8_nolen
3847 Return a pointer to the UTF-8-encoded representation of the SV.
3848 May cause the SV to be upgraded to UTF-8 as a side-effect.
3850 Usually accessed via the C<SvPVutf8_nolen> macro.
3852 char* sv_2pvutf8_nolen(SV* sv)
3859 Returns a pointer to the string value of an SV, and sets *lp to its length.
3860 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
3862 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
3863 usually end up here too.
3865 char* sv_2pv_flags(SV* sv, STRLEN* lp, I32 flags)
3872 Like C<sv_2pv()>, but doesn't return the length too. You should usually
3873 use the macro wrapper C<SvPV_nolen(sv)> instead.
3874 char* sv_2pv_nolen(SV* sv)
3881 Return the unsigned integer value of an SV, doing any necessary string
3882 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
3883 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
3885 UV sv_2uv_flags(SV* sv, I32 flags)
3892 Remove any string offset. You should normally use the C<SvOOK_off> macro
3895 int sv_backoff(SV* sv)
3902 Blesses an SV into a specified package. The SV must be an RV. The package
3903 must be designated by its stash (see C<gv_stashpv()>). The reference count
3904 of the SV is unaffected.
3906 SV* sv_bless(SV* sv, HV* stash)
3913 Concatenates the string onto the end of the string which is in the SV.
3914 If the SV has the UTF-8 status set, then the bytes appended should be
3915 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
3917 void sv_catpv(SV* sv, const char* ptr)
3924 Processes its arguments like C<sprintf> and appends the formatted
3925 output to an SV. If the appended data contains "wide" characters
3926 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
3927 and characters >255 formatted with %c), the original SV might get
3928 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
3931 void sv_catpvf(SV* sv, const char* pat, ...)
3938 Like C<sv_catpvf>, but also handles 'set' magic.
3940 void sv_catpvf_mg(SV *sv, const char* pat, ...)
3947 Concatenates the string onto the end of the string which is in the SV. The
3948 C<len> indicates number of bytes to copy. If the SV has the UTF-8
3949 status set, then the bytes appended should be valid UTF-8.
3950 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
3952 void sv_catpvn(SV* sv, const char* ptr, STRLEN len)
3957 =item sv_catpvn_flags
3959 Concatenates the string onto the end of the string which is in the SV. The
3960 C<len> indicates number of bytes to copy. If the SV has the UTF-8
3961 status set, then the bytes appended should be valid UTF-8.
3962 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
3963 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
3964 in terms of this function.
3966 void sv_catpvn_flags(SV* sv, const char* ptr, STRLEN len, I32 flags)
3973 Like C<sv_catpvn>, but also handles 'set' magic.
3975 void sv_catpvn_mg(SV *sv, const char *ptr, STRLEN len)
3980 =item sv_catpvn_nomg
3982 Like C<sv_catpvn> but doesn't process magic.
3984 void sv_catpvn_nomg(SV* sv, const char* ptr, STRLEN len)
3991 Like C<sv_catpv>, but also handles 'set' magic.
3993 void sv_catpv_mg(SV *sv, const char *ptr)
4000 Concatenates the string from SV C<ssv> onto the end of the string in
4001 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4002 not 'set' magic. See C<sv_catsv_mg>.
4004 void sv_catsv(SV* dsv, SV* ssv)
4009 =item sv_catsv_flags
4011 Concatenates the string from SV C<ssv> onto the end of the string in
4012 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4013 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4014 and C<sv_catsv_nomg> are implemented in terms of this function.
4016 void sv_catsv_flags(SV* dsv, SV* ssv, I32 flags)
4023 Like C<sv_catsv>, but also handles 'set' magic.
4025 void sv_catsv_mg(SV *dstr, SV *sstr)
4032 Like C<sv_catsv> but doesn't process magic.
4034 void sv_catsv_nomg(SV* dsv, SV* ssv)
4041 Efficient removal of characters from the beginning of the string buffer.
4042 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4043 the string buffer. The C<ptr> becomes the first character of the adjusted
4044 string. Uses the "OOK hack".
4045 Beware: after this function returns, C<ptr> and SvPVX(sv) may no longer
4046 refer to the same chunk of data.
4048 void sv_chop(SV* sv, char* ptr)
4055 Clear an SV: call any destructors, free up any memory used by the body,
4056 and free the body itself. The SV's head is I<not> freed, although
4057 its type is set to all 1's so that it won't inadvertently be assumed
4058 to be live during global destruction etc.
4059 This function should only be called when REFCNT is zero. Most of the time
4060 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
4063 void sv_clear(SV* sv)
4070 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
4071 string in C<sv1> is less than, equal to, or greater than the string in
4072 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
4073 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
4075 I32 sv_cmp(SV* sv1, SV* sv2)
4082 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
4083 'use bytes' aware, handles get magic, and will coerce its args to strings
4084 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
4086 I32 sv_cmp_locale(SV* sv1, SV* sv2)
4093 Add Collate Transform magic to an SV if it doesn't already have it.
4095 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
4096 scalar data of the variable, but transformed to such a format that a normal
4097 memory comparison can be used to compare the data according to the locale
4100 char* sv_collxfrm(SV* sv, STRLEN* nxp)
4107 Copies a stringified representation of the source SV into the
4108 destination SV. Automatically performs any necessary mg_get and
4109 coercion of numeric values into strings. Guaranteed to preserve
4110 UTF-8 flag even from overloaded objects. Similar in nature to
4111 sv_2pv[_flags] but operates directly on an SV instead of just the
4112 string. Mostly uses sv_2pv_flags to do its work, except when that
4113 would lose the UTF-8'ness of the PV.
4115 void sv_copypv(SV* dsv, SV* ssv)
4122 Auto-decrement of the value in the SV, doing string to numeric conversion
4123 if necessary. Handles 'get' magic.
4130 =item sv_derived_from
4132 Returns a boolean indicating whether the SV is derived from the specified
4133 class. This is the function that implements C<UNIVERSAL::isa>. It works
4134 for class names as well as for objects.
4136 bool sv_derived_from(SV* sv, const char* name)
4139 Found in file universal.c
4143 Returns a boolean indicating whether the strings in the two SVs are
4144 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
4145 coerce its args to strings if necessary.
4147 I32 sv_eq(SV* sv1, SV* sv2)
4152 =item sv_force_normal
4154 Undo various types of fakery on an SV: if the PV is a shared string, make
4155 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4156 an xpvmg. See also C<sv_force_normal_flags>.
4158 void sv_force_normal(SV *sv)
4163 =item sv_force_normal_flags
4165 Undo various types of fakery on an SV: if the PV is a shared string, make
4166 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4167 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4168 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4169 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4170 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4171 set to some other value.) In addition, the C<flags> parameter gets passed to
4172 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4173 with flags set to 0.
4175 void sv_force_normal_flags(SV *sv, U32 flags)
4182 Decrement an SV's reference count, and if it drops to zero, call
4183 C<sv_clear> to invoke destructors and free up any memory used by
4184 the body; finally, deallocate the SV's head itself.
4185 Normally called via a wrapper macro C<SvREFCNT_dec>.
4187 void sv_free(SV* sv)
4194 Get a line from the filehandle and store it into the SV, optionally
4195 appending to the currently-stored string.
4197 char* sv_gets(SV* sv, PerlIO* fp, I32 append)
4204 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
4205 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
4206 Use the C<SvGROW> wrapper instead.
4208 char* sv_grow(SV* sv, STRLEN newlen)
4215 Auto-increment of the value in the SV, doing string to numeric conversion
4216 if necessary. Handles 'get' magic.
4225 Inserts a string at the specified offset/length within the SV. Similar to
4226 the Perl substr() function.
4228 void sv_insert(SV* bigsv, STRLEN offset, STRLEN len, char* little, STRLEN littlelen)
4235 Returns a boolean indicating whether the SV is blessed into the specified
4236 class. This does not check for subtypes; use C<sv_derived_from> to verify
4237 an inheritance relationship.
4239 int sv_isa(SV* sv, const char* name)
4246 Returns a boolean indicating whether the SV is an RV pointing to a blessed
4247 object. If the SV is not an RV, or if the object is not blessed, then this
4250 int sv_isobject(SV* sv)
4257 A private implementation of the C<SvIVx> macro for compilers which can't
4258 cope with complex macro expressions. Always use the macro instead.
4267 Returns the length of the string in the SV. Handles magic and type
4268 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
4270 STRLEN sv_len(SV* sv)
4277 Returns the number of characters in the string in an SV, counting wide
4278 UTF-8 bytes as a single character. Handles magic and type coercion.
4280 STRLEN sv_len_utf8(SV* sv)
4287 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4288 then adds a new magic item of type C<how> to the head of the magic list.
4290 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4291 handling of the C<name> and C<namlen> arguments.
4293 void sv_magic(SV* sv, SV* obj, int how, const char* name, I32 namlen)
4300 Adds magic to an SV, upgrading it if necessary. Applies the
4301 supplied vtable and returns a pointer to the magic added.
4303 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4304 In particular, you can add magic to SvREADONLY SVs, and add more than
4305 one instance of the same 'how'.
4307 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4308 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4309 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4310 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4312 (This is now used as a subroutine by C<sv_magic>.)
4314 MAGIC * sv_magicext(SV* sv, SV* obj, int how, MGVTBL *vtbl, const char* name, I32 namlen )
4321 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
4322 The new SV is marked as mortal. It will be destroyed "soon", either by an
4323 explicit call to FREETMPS, or by an implicit call at places such as
4324 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
4326 SV* sv_mortalcopy(SV* oldsv)
4333 Creates a new null SV which is mortal. The reference count of the SV is
4334 set to 1. It will be destroyed "soon", either by an explicit call to
4335 FREETMPS, or by an implicit call at places such as statement boundaries.
4336 See also C<sv_mortalcopy> and C<sv_2mortal>.
4345 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
4348 SV* sv_newref(SV* sv)
4355 A private implementation of the C<SvNVx> macro for compilers which can't
4356 cope with complex macro expressions. Always use the macro instead.
4365 Converts the value pointed to by offsetp from a count of bytes from the
4366 start of the string, to a count of the equivalent number of UTF-8 chars.
4367 Handles magic and type coercion.
4369 void sv_pos_b2u(SV* sv, I32* offsetp)
4376 Converts the value pointed to by offsetp from a count of UTF-8 chars from
4377 the start of the string, to a count of the equivalent number of bytes; if
4378 lenp is non-zero, it does the same to lenp, but this time starting from
4379 the offset, rather than from the start of the string. Handles magic and
4382 void sv_pos_u2b(SV* sv, I32* offsetp, I32* lenp)
4389 Use the C<SvPV_nolen> macro instead
4398 Use C<SvPVbyte_nolen> instead.
4400 char* sv_pvbyte(SV *sv)
4407 A private implementation of the C<SvPVbyte> macro for compilers
4408 which can't cope with complex macro expressions. Always use the macro
4411 char* sv_pvbyten(SV *sv, STRLEN *len)
4416 =item sv_pvbyten_force
4418 A private implementation of the C<SvPVbytex_force> macro for compilers
4419 which can't cope with complex macro expressions. Always use the macro
4422 char* sv_pvbyten_force(SV* sv, STRLEN* lp)
4429 A private implementation of the C<SvPV> macro for compilers which can't
4430 cope with complex macro expressions. Always use the macro instead.
4432 char* sv_pvn(SV *sv, STRLEN *len)
4439 Get a sensible string out of the SV somehow.
4440 A private implementation of the C<SvPV_force> macro for compilers which
4441 can't cope with complex macro expressions. Always use the macro instead.
4443 char* sv_pvn_force(SV* sv, STRLEN* lp)
4448 =item sv_pvn_force_flags
4450 Get a sensible string out of the SV somehow.
4451 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
4452 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
4453 implemented in terms of this function.
4454 You normally want to use the various wrapper macros instead: see
4455 C<SvPV_force> and C<SvPV_force_nomg>
4457 char* sv_pvn_force_flags(SV* sv, STRLEN* lp, I32 flags)
4464 Use the C<SvPVutf8_nolen> macro instead
4466 char* sv_pvutf8(SV *sv)
4473 A private implementation of the C<SvPVutf8> macro for compilers
4474 which can't cope with complex macro expressions. Always use the macro
4477 char* sv_pvutf8n(SV *sv, STRLEN *len)
4482 =item sv_pvutf8n_force
4484 A private implementation of the C<SvPVutf8_force> macro for compilers
4485 which can't cope with complex macro expressions. Always use the macro
4488 char* sv_pvutf8n_force(SV* sv, STRLEN* lp)
4495 Returns a string describing what the SV is a reference to.
4497 char* sv_reftype(SV* sv, int ob)
4504 Make the first argument a copy of the second, then delete the original.
4505 The target SV physically takes over ownership of the body of the source SV
4506 and inherits its flags; however, the target keeps any magic it owns,
4507 and any magic in the source is discarded.
4508 Note that this is a rather specialist SV copying operation; most of the
4509 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4511 void sv_replace(SV* sv, SV* nsv)
4516 =item sv_report_used
4518 Dump the contents of all SVs not yet freed. (Debugging aid).
4520 void sv_report_used()
4527 Underlying implementation for the C<reset> Perl function.
4528 Note that the perl-level function is vaguely deprecated.
4530 void sv_reset(char* s, HV* stash)
4537 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4538 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4539 push a back-reference to this RV onto the array of backreferences
4540 associated with that magic.
4542 SV* sv_rvweaken(SV *sv)
4549 Copies an integer into the given SV, upgrading first if necessary.
4550 Does not handle 'set' magic. See also C<sv_setiv_mg>.
4552 void sv_setiv(SV* sv, IV num)
4559 Like C<sv_setiv>, but also handles 'set' magic.
4561 void sv_setiv_mg(SV *sv, IV i)
4568 Copies a double into the given SV, upgrading first if necessary.
4569 Does not handle 'set' magic. See also C<sv_setnv_mg>.
4571 void sv_setnv(SV* sv, NV num)
4578 Like C<sv_setnv>, but also handles 'set' magic.
4580 void sv_setnv_mg(SV *sv, NV num)
4587 Copies a string into an SV. The string must be null-terminated. Does not
4588 handle 'set' magic. See C<sv_setpv_mg>.
4590 void sv_setpv(SV* sv, const char* ptr)
4597 Works like C<sv_catpvf> but copies the text into the SV instead of
4598 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
4600 void sv_setpvf(SV* sv, const char* pat, ...)
4607 Like C<sv_setpvf>, but also handles 'set' magic.
4609 void sv_setpvf_mg(SV *sv, const char* pat, ...)
4616 Copies an integer into the given SV, also updating its string value.
4617 Does not handle 'set' magic. See C<sv_setpviv_mg>.
4619 void sv_setpviv(SV* sv, IV num)
4626 Like C<sv_setpviv>, but also handles 'set' magic.
4628 void sv_setpviv_mg(SV *sv, IV iv)
4635 Copies a string into an SV. The C<len> parameter indicates the number of
4636 bytes to be copied. If the C<ptr> argument is NULL the SV will become
4637 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4639 void sv_setpvn(SV* sv, const char* ptr, STRLEN len)
4646 Like C<sv_setpvn>, but also handles 'set' magic.
4648 void sv_setpvn_mg(SV *sv, const char *ptr, STRLEN len)
4655 Like C<sv_setpv>, but also handles 'set' magic.
4657 void sv_setpv_mg(SV *sv, const char *ptr)
4664 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
4665 argument will be upgraded to an RV. That RV will be modified to point to
4666 the new SV. The C<classname> argument indicates the package for the
4667 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4668 will have a reference count of 1, and the RV will be returned.
4670 SV* sv_setref_iv(SV* rv, const char* classname, IV iv)
4677 Copies a double into a new SV, optionally blessing the SV. The C<rv>
4678 argument will be upgraded to an RV. That RV will be modified to point to
4679 the new SV. The C<classname> argument indicates the package for the
4680 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4681 will have a reference count of 1, and the RV will be returned.
4683 SV* sv_setref_nv(SV* rv, const char* classname, NV nv)
4690 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
4691 argument will be upgraded to an RV. That RV will be modified to point to
4692 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
4693 into the SV. The C<classname> argument indicates the package for the
4694 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4695 will have a reference count of 1, and the RV will be returned.
4697 Do not use with other Perl types such as HV, AV, SV, CV, because those
4698 objects will become corrupted by the pointer copy process.
4700 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
4702 SV* sv_setref_pv(SV* rv, const char* classname, void* pv)
4709 Copies a string into a new SV, optionally blessing the SV. The length of the
4710 string must be specified with C<n>. The C<rv> argument will be upgraded to
4711 an RV. That RV will be modified to point to the new SV. The C<classname>
4712 argument indicates the package for the blessing. Set C<classname> to
4713 C<Nullch> to avoid the blessing. The new SV will have a reference count
4714 of 1, and the RV will be returned.
4716 Note that C<sv_setref_pv> copies the pointer while this copies the string.
4718 SV* sv_setref_pvn(SV* rv, const char* classname, char* pv, STRLEN n)
4725 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
4726 argument will be upgraded to an RV. That RV will be modified to point to
4727 the new SV. The C<classname> argument indicates the package for the
4728 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4729 will have a reference count of 1, and the RV will be returned.
4731 SV* sv_setref_uv(SV* rv, const char* classname, UV uv)
4738 Copies the contents of the source SV C<ssv> into the destination SV
4739 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4740 function if the source SV needs to be reused. Does not handle 'set' magic.
4741 Loosely speaking, it performs a copy-by-value, obliterating any previous
4742 content of the destination.
4744 You probably want to use one of the assortment of wrappers, such as
4745 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4746 C<SvSetMagicSV_nosteal>.
4748 void sv_setsv(SV* dsv, SV* ssv)
4753 =item sv_setsv_flags
4755 Copies the contents of the source SV C<ssv> into the destination SV
4756 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4757 function if the source SV needs to be reused. Does not handle 'set' magic.
4758 Loosely speaking, it performs a copy-by-value, obliterating any previous
4759 content of the destination.
4760 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
4761 C<ssv> if appropriate, else not. If the C<flags> parameter has the
4762 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
4763 and C<sv_setsv_nomg> are implemented in terms of this function.
4765 You probably want to use one of the assortment of wrappers, such as
4766 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4767 C<SvSetMagicSV_nosteal>.
4769 This is the primary function for copying scalars, and most other
4770 copy-ish functions and macros use this underneath.
4772 void sv_setsv_flags(SV* dsv, SV* ssv, I32 flags)
4779 Like C<sv_setsv>, but also handles 'set' magic.
4781 void sv_setsv_mg(SV *dstr, SV *sstr)
4788 Like C<sv_setsv> but doesn't process magic.
4790 void sv_setsv_nomg(SV* dsv, SV* ssv)
4797 Copies an unsigned integer into the given SV, upgrading first if necessary.
4798 Does not handle 'set' magic. See also C<sv_setuv_mg>.
4800 void sv_setuv(SV* sv, UV num)
4807 Like C<sv_setuv>, but also handles 'set' magic.
4809 void sv_setuv_mg(SV *sv, UV u)
4816 Taint an SV. Use C<SvTAINTED_on> instead.
4817 void sv_taint(SV* sv)
4824 Test an SV for taintedness. Use C<SvTAINTED> instead.
4825 bool sv_tainted(SV* sv)
4832 Returns true if the SV has a true value by Perl's rules.
4833 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
4834 instead use an in-line version.
4843 Removes all magic of type C<type> from an SV.
4845 int sv_unmagic(SV* sv, int type)
4852 Unsets the RV status of the SV, and decrements the reference count of
4853 whatever was being referenced by the RV. This can almost be thought of
4854 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
4855 being zero. See C<SvROK_off>.
4857 void sv_unref(SV* sv)
4862 =item sv_unref_flags
4864 Unsets the RV status of the SV, and decrements the reference count of
4865 whatever was being referenced by the RV. This can almost be thought of
4866 as a reversal of C<newSVrv>. The C<cflags> argument can contain
4867 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
4868 (otherwise the decrementing is conditional on the reference count being
4869 different from one or the reference being a readonly SV).
4872 void sv_unref_flags(SV* sv, U32 flags)
4879 Untaint an SV. Use C<SvTAINTED_off> instead.
4880 void sv_untaint(SV* sv)
4887 Upgrade an SV to a more complex form. Generally adds a new body type to the
4888 SV, then copies across as much information as possible from the old body.
4889 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
4891 bool sv_upgrade(SV* sv, U32 mt)
4898 Tells an SV to use C<ptr> to find its string value. Normally the string is
4899 stored inside the SV but sv_usepvn allows the SV to use an outside string.
4900 The C<ptr> should point to memory that was allocated by C<malloc>. The
4901 string length, C<len>, must be supplied. This function will realloc the
4902 memory pointed to by C<ptr>, so that pointer should not be freed or used by
4903 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
4904 See C<sv_usepvn_mg>.
4906 void sv_usepvn(SV* sv, char* ptr, STRLEN len)
4913 Like C<sv_usepvn>, but also handles 'set' magic.
4915 void sv_usepvn_mg(SV *sv, char *ptr, STRLEN len)
4920 =item sv_utf8_decode
4922 If the PV of the SV is an octet sequence in UTF-8
4923 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
4924 so that it looks like a character. If the PV contains only single-byte
4925 characters, the C<SvUTF8> flag stays being off.
4926 Scans PV for validity and returns false if the PV is invalid UTF-8.
4928 NOTE: this function is experimental and may change or be
4929 removed without notice.
4931 bool sv_utf8_decode(SV *sv)
4936 =item sv_utf8_downgrade
4938 Attempts to convert the PV of an SV from characters to bytes.
4939 If the PV contains a character beyond byte, this conversion will fail;
4940 in this case, either returns false or, if C<fail_ok> is not
4943 This is not as a general purpose Unicode to byte encoding interface:
4944 use the Encode extension for that.
4946 NOTE: this function is experimental and may change or be
4947 removed without notice.
4949 bool sv_utf8_downgrade(SV *sv, bool fail_ok)
4954 =item sv_utf8_encode
4956 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
4957 flag off so that it looks like octets again.
4959 void sv_utf8_encode(SV *sv)
4964 =item sv_utf8_upgrade
4966 Converts the PV of an SV to its UTF-8-encoded form.
4967 Forces the SV to string form if it is not already.
4968 Always sets the SvUTF8 flag to avoid future validity checks even
4969 if all the bytes have hibit clear.
4971 This is not as a general purpose byte encoding to Unicode interface:
4972 use the Encode extension for that.
4974 STRLEN sv_utf8_upgrade(SV *sv)
4979 =item sv_utf8_upgrade_flags
4981 Converts the PV of an SV to its UTF-8-encoded form.
4982 Forces the SV to string form if it is not already.
4983 Always sets the SvUTF8 flag to avoid future validity checks even
4984 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
4985 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
4986 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
4988 This is not as a general purpose byte encoding to Unicode interface:
4989 use the Encode extension for that.
4991 STRLEN sv_utf8_upgrade_flags(SV *sv, I32 flags)
4998 A private implementation of the C<SvUVx> macro for compilers which can't
4999 cope with complex macro expressions. Always use the macro instead.
5008 Processes its arguments like C<vsprintf> and appends the formatted output
5009 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
5011 Usually used via its frontend C<sv_catpvf>.
5013 void sv_vcatpvf(SV* sv, const char* pat, va_list* args)
5020 Processes its arguments like C<vsprintf> and appends the formatted output
5021 to an SV. Uses an array of SVs if the C style variable argument list is
5022 missing (NULL). When running with taint checks enabled, indicates via
5023 C<maybe_tainted> if results are untrustworthy (often due to the use of
5026 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
5028 void sv_vcatpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
5035 Like C<sv_vcatpvf>, but also handles 'set' magic.
5037 Usually used via its frontend C<sv_catpvf_mg>.
5039 void sv_vcatpvf_mg(SV* sv, const char* pat, va_list* args)
5046 Works like C<sv_vcatpvf> but copies the text into the SV instead of
5047 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
5049 Usually used via its frontend C<sv_setpvf>.
5051 void sv_vsetpvf(SV* sv, const char* pat, va_list* args)
5058 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
5061 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
5063 void sv_vsetpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
5070 Like C<sv_vsetpvf>, but also handles 'set' magic.
5072 Usually used via its frontend C<sv_setpvf_mg>.
5074 void sv_vsetpvf_mg(SV* sv, const char* pat, va_list* args)
5082 =head1 Unicode Support
5086 =item bytes_from_utf8
5088 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
5089 Unlike <utf8_to_bytes> but like C<bytes_to_utf8>, returns a pointer to
5090 the newly-created string, and updates C<len> to contain the new
5091 length. Returns the original string if no conversion occurs, C<len>
5092 is unchanged. Do nothing if C<is_utf8> points to 0. Sets C<is_utf8> to
5093 0 if C<s> is converted or contains all 7bit characters.
5095 NOTE: this function is experimental and may change or be
5096 removed without notice.
5098 U8* bytes_from_utf8(U8 *s, STRLEN *len, bool *is_utf8)
5101 Found in file utf8.c
5105 Converts a string C<s> of length C<len> from ASCII into UTF-8 encoding.
5106 Returns a pointer to the newly-created string, and sets C<len> to
5107 reflect the new length.
5109 If you want to convert to UTF-8 from other encodings than ASCII,
5110 see sv_recode_to_utf8().
5112 NOTE: this function is experimental and may change or be
5113 removed without notice.
5115 U8* bytes_to_utf8(U8 *s, STRLEN *len)
5118 Found in file utf8.c
5122 Return true if the strings s1 and s2 differ case-insensitively, false
5123 if not (if they are equal case-insensitively). If u1 is true, the
5124 string s1 is assumed to be in UTF-8-encoded Unicode. If u2 is true,
5125 the string s2 is assumed to be in UTF-8-encoded Unicode. If u1 or u2
5126 are false, the respective string is assumed to be in native 8-bit
5129 If the pe1 and pe2 are non-NULL, the scanning pointers will be copied
5130 in there (they will point at the beginning of the I<next> character).
5131 If the pointers behind pe1 or pe2 are non-NULL, they are the end
5132 pointers beyond which scanning will not continue under any
5133 circumstances. If the byte lengths l1 and l2 are non-zero, s1+l1 and
5134 s2+l2 will be used as goal end pointers that will also stop the scan,
5135 and which qualify towards defining a successful match: all the scans
5136 that define an explicit length must reach their goal pointers for
5137 a match to succeed).
5139 For case-insensitiveness, the "casefolding" of Unicode is used
5140 instead of upper/lowercasing both the characters, see
5141 http://www.unicode.org/unicode/reports/tr21/ (Case Mappings).
5143 I32 ibcmp_utf8(const char* a, char **pe1, UV l1, bool u1, const char* b, char **pe2, UV l2, bool u2)
5146 Found in file utf8.c
5150 Tests if some arbitrary number of bytes begins in a valid UTF-8
5151 character. Note that an INVARIANT (i.e. ASCII) character is a valid
5152 UTF-8 character. The actual number of bytes in the UTF-8 character
5153 will be returned if it is valid, otherwise 0.
5155 STRLEN is_utf8_char(U8 *p)
5158 Found in file utf8.c
5160 =item is_utf8_string
5162 Returns true if first C<len> bytes of the given string form a valid
5163 UTF-8 string, false otherwise. Note that 'a valid UTF-8 string' does
5164 not mean 'a string that contains code points above 0x7F encoded in UTF-8'
5165 because a valid ASCII string is a valid UTF-8 string.
5167 bool is_utf8_string(U8 *s, STRLEN len)
5170 Found in file utf8.c
5172 =item is_utf8_string_loc
5174 Like is_ut8_string but store the location of the failure in
5177 bool is_utf8_string_loc(U8 *s, STRLEN len, U8 **p)
5180 Found in file utf8.c
5182 =item pv_uni_display
5184 Build to the scalar dsv a displayable version of the string spv,
5185 length len, the displayable version being at most pvlim bytes long
5186 (if longer, the rest is truncated and "..." will be appended).
5188 The flags argument can have UNI_DISPLAY_ISPRINT set to display
5189 isPRINT()able characters as themselves, UNI_DISPLAY_BACKSLASH
5190 to display the \\[nrfta\\] as the backslashed versions (like '\n')
5191 (UNI_DISPLAY_BACKSLASH is preferred over UNI_DISPLAY_ISPRINT for \\).
5192 UNI_DISPLAY_QQ (and its alias UNI_DISPLAY_REGEX) have both
5193 UNI_DISPLAY_BACKSLASH and UNI_DISPLAY_ISPRINT turned on.
5195 The pointer to the PV of the dsv is returned.
5197 char* pv_uni_display(SV *dsv, U8 *spv, STRLEN len, STRLEN pvlim, UV flags)
5200 Found in file utf8.c
5204 The encoding is assumed to be an Encode object, the PV of the ssv is
5205 assumed to be octets in that encoding and decoding the input starts
5206 from the position which (PV + *offset) pointed to. The dsv will be
5207 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
5208 when the string tstr appears in decoding output or the input ends on
5209 the PV of the ssv. The value which the offset points will be modified
5210 to the last input position on the ssv.
5212 Returns TRUE if the terminator was found, else returns FALSE.
5214 bool sv_cat_decode(SV* dsv, SV *encoding, SV *ssv, int *offset, char* tstr, int tlen)
5219 =item sv_recode_to_utf8
5221 The encoding is assumed to be an Encode object, on entry the PV
5222 of the sv is assumed to be octets in that encoding, and the sv
5223 will be converted into Unicode (and UTF-8).
5225 If the sv already is UTF-8 (or if it is not POK), or if the encoding
5226 is not a reference, nothing is done to the sv. If the encoding is not
5227 an C<Encode::XS> Encoding object, bad things will happen.
5228 (See F<lib/encoding.pm> and L<Encode>).
5230 The PV of the sv is returned.
5232 char* sv_recode_to_utf8(SV* sv, SV *encoding)
5237 =item sv_uni_display
5239 Build to the scalar dsv a displayable version of the scalar sv,
5240 the displayable version being at most pvlim bytes long
5241 (if longer, the rest is truncated and "..." will be appended).
5243 The flags argument is as in pv_uni_display().
5245 The pointer to the PV of the dsv is returned.
5247 char* sv_uni_display(SV *dsv, SV *ssv, STRLEN pvlim, UV flags)
5250 Found in file utf8.c
5254 The "p" contains the pointer to the UTF-8 string encoding
5255 the character that is being converted.
5257 The "ustrp" is a pointer to the character buffer to put the
5258 conversion result to. The "lenp" is a pointer to the length
5261 The "swashp" is a pointer to the swash to use.
5263 Both the special and normal mappings are stored lib/unicore/To/Foo.pl,
5264 and loaded by SWASHGET, using lib/utf8_heavy.pl. The special (usually,
5265 but not always, a multicharacter mapping), is tried first.
5267 The "special" is a string like "utf8::ToSpecLower", which means the
5268 hash %utf8::ToSpecLower. The access to the hash is through
5269 Perl_to_utf8_case().
5271 The "normal" is a string like "ToLower" which means the swash
5274 UV to_utf8_case(U8 *p, U8* ustrp, STRLEN *lenp, SV **swash, char *normal, char *special)
5277 Found in file utf8.c
5281 Convert the UTF-8 encoded character at p to its foldcase version and
5282 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
5283 that the ustrp needs to be at least UTF8_MAXLEN_FOLD+1 bytes since the
5284 foldcase version may be longer than the original character (up to
5287 The first character of the foldcased version is returned
5288 (but note, as explained above, that there may be more.)
5290 UV to_utf8_fold(U8 *p, U8* ustrp, STRLEN *lenp)
5293 Found in file utf8.c
5297 Convert the UTF-8 encoded character at p to its lowercase version and
5298 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
5299 that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the
5300 lowercase version may be longer than the original character (up to two
5303 The first character of the lowercased version is returned
5304 (but note, as explained above, that there may be more.)
5306 UV to_utf8_lower(U8 *p, U8* ustrp, STRLEN *lenp)
5309 Found in file utf8.c
5313 Convert the UTF-8 encoded character at p to its titlecase version and
5314 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
5315 that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the
5316 titlecase version may be longer than the original character (up to two
5319 The first character of the titlecased version is returned
5320 (but note, as explained above, that there may be more.)
5322 UV to_utf8_title(U8 *p, U8* ustrp, STRLEN *lenp)
5325 Found in file utf8.c
5329 Convert the UTF-8 encoded character at p to its uppercase version and
5330 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
5331 that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the
5332 uppercase version may be longer than the original character (up to two
5335 The first character of the uppercased version is returned
5336 (but note, as explained above, that there may be more.)
5338 UV to_utf8_upper(U8 *p, U8* ustrp, STRLEN *lenp)
5341 Found in file utf8.c
5343 =item utf8n_to_uvchr
5345 Returns the native character value of the first character in the string C<s>
5346 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
5347 length, in bytes, of that character.
5349 Allows length and flags to be passed to low level routine.
5351 UV utf8n_to_uvchr(U8 *s, STRLEN curlen, STRLEN* retlen, U32 flags)
5354 Found in file utf8.c
5356 =item utf8n_to_uvuni
5358 Bottom level UTF-8 decode routine.
5359 Returns the unicode code point value of the first character in the string C<s>
5360 which is assumed to be in UTF-8 encoding and no longer than C<curlen>;
5361 C<retlen> will be set to the length, in bytes, of that character.
5363 If C<s> does not point to a well-formed UTF-8 character, the behaviour
5364 is dependent on the value of C<flags>: if it contains UTF8_CHECK_ONLY,
5365 it is assumed that the caller will raise a warning, and this function
5366 will silently just set C<retlen> to C<-1> and return zero. If the
5367 C<flags> does not contain UTF8_CHECK_ONLY, warnings about
5368 malformations will be given, C<retlen> will be set to the expected
5369 length of the UTF-8 character in bytes, and zero will be returned.
5371 The C<flags> can also contain various flags to allow deviations from
5372 the strict UTF-8 encoding (see F<utf8.h>).
5374 Most code should use utf8_to_uvchr() rather than call this directly.
5376 UV utf8n_to_uvuni(U8 *s, STRLEN curlen, STRLEN* retlen, U32 flags)
5379 Found in file utf8.c
5383 Returns the number of UTF-8 characters between the UTF-8 pointers C<a>
5386 WARNING: use only if you *know* that the pointers point inside the
5389 IV utf8_distance(U8 *a, U8 *b)
5392 Found in file utf8.c
5396 Return the UTF-8 pointer C<s> displaced by C<off> characters, either
5397 forward or backward.
5399 WARNING: do not use the following unless you *know* C<off> is within
5400 the UTF-8 data pointed to by C<s> *and* that on entry C<s> is aligned
5401 on the first byte of character or just after the last byte of a character.
5403 U8* utf8_hop(U8 *s, I32 off)
5406 Found in file utf8.c
5410 Return the length of the UTF-8 char encoded string C<s> in characters.
5411 Stops at C<e> (inclusive). If C<e E<lt> s> or if the scan would end
5412 up past C<e>, croaks.
5414 STRLEN utf8_length(U8* s, U8 *e)
5417 Found in file utf8.c
5421 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
5422 Unlike C<bytes_to_utf8>, this over-writes the original string, and
5423 updates len to contain the new length.
5424 Returns zero on failure, setting C<len> to -1.
5426 NOTE: this function is experimental and may change or be
5427 removed without notice.
5429 U8* utf8_to_bytes(U8 *s, STRLEN *len)
5432 Found in file utf8.c
5436 Returns the native character value of the first character in the string C<s>
5437 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
5438 length, in bytes, of that character.
5440 If C<s> does not point to a well-formed UTF-8 character, zero is
5441 returned and retlen is set, if possible, to -1.
5443 UV utf8_to_uvchr(U8 *s, STRLEN* retlen)
5446 Found in file utf8.c
5450 Returns the Unicode code point of the first character in the string C<s>
5451 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
5452 length, in bytes, of that character.
5454 This function should only be used when returned UV is considered
5455 an index into the Unicode semantic tables (e.g. swashes).
5457 If C<s> does not point to a well-formed UTF-8 character, zero is
5458 returned and retlen is set, if possible, to -1.
5460 UV utf8_to_uvuni(U8 *s, STRLEN* retlen)
5463 Found in file utf8.c
5467 Adds the UTF-8 representation of the Native codepoint C<uv> to the end
5468 of the string C<d>; C<d> should be have at least C<UTF8_MAXLEN+1> free
5469 bytes available. The return value is the pointer to the byte after the
5470 end of the new character. In other words,
5472 d = uvchr_to_utf8(d, uv);
5474 is the recommended wide native character-aware way of saying
5478 U8* uvchr_to_utf8(U8 *d, UV uv)
5481 Found in file utf8.c
5483 =item uvuni_to_utf8_flags
5485 Adds the UTF-8 representation of the Unicode codepoint C<uv> to the end
5486 of the string C<d>; C<d> should be have at least C<UTF8_MAXLEN+1> free
5487 bytes available. The return value is the pointer to the byte after the
5488 end of the new character. In other words,
5490 d = uvuni_to_utf8_flags(d, uv, flags);
5494 d = uvuni_to_utf8(d, uv);
5496 (which is equivalent to)
5498 d = uvuni_to_utf8_flags(d, uv, 0);
5500 is the recommended Unicode-aware way of saying
5504 U8* uvuni_to_utf8_flags(U8 *d, UV uv, UV flags)
5507 Found in file utf8.c
5512 =head1 Variables created by C<xsubpp> and C<xsubpp> internal functions
5518 Variable which is setup by C<xsubpp> to indicate the stack base offset,
5519 used by the C<ST>, C<XSprePUSH> and C<XSRETURN> macros. The C<dMARK> macro
5520 must be called prior to setup the C<MARK> variable.
5525 Found in file XSUB.h
5529 Variable which is setup by C<xsubpp> to indicate the
5530 class name for a C++ XS constructor. This is always a C<char*>. See C<THIS>.
5535 Found in file XSUB.h
5539 Sets up the C<ax> variable.
5540 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
5545 Found in file XSUB.h
5549 Sets up the C<items> variable.
5550 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
5555 Found in file XSUB.h
5559 Sets up the C<padoff_du> variable for an XSUB that wishes to use
5565 Found in file XSUB.h
5569 Sets up stack and mark pointers for an XSUB, calling dSP and dMARK.
5570 Sets up the C<ax> and C<items> variables by calling C<dAX> and C<dITEMS>.
5571 This is usually handled automatically by C<xsubpp>.
5576 Found in file XSUB.h
5580 Sets up the C<ix> variable for an XSUB which has aliases. This is usually
5581 handled automatically by C<xsubpp>.
5586 Found in file XSUB.h
5590 Variable which is setup by C<xsubpp> to indicate the number of
5591 items on the stack. See L<perlxs/"Variable-length Parameter Lists">.
5596 Found in file XSUB.h
5600 Variable which is setup by C<xsubpp> to indicate which of an
5601 XSUB's aliases was used to invoke it. See L<perlxs/"The ALIAS: Keyword">.
5606 Found in file XSUB.h
5610 Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
5614 Found in file XSUB.h
5618 Variable which is setup by C<xsubpp> to hold the return value for an
5619 XSUB. This is always the proper type for the XSUB. See
5620 L<perlxs/"The RETVAL Variable">.
5625 Found in file XSUB.h
5629 Used to access elements on the XSUB's stack.
5634 Found in file XSUB.h
5638 Variable which is setup by C<xsubpp> to designate the object in a C++
5639 XSUB. This is always the proper type for the C++ object. See C<CLASS> and
5640 L<perlxs/"Using XS With C++">.
5645 Found in file XSUB.h
5649 The SV* corresponding to the $_ variable. Works even if there
5650 is a lexical $_ in scope.
5653 Found in file XSUB.h
5657 Macro to declare an XSUB and its C parameter list. This is handled by
5661 Found in file XSUB.h
5665 The version identifier for an XS module. This is usually
5666 handled automatically by C<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>.
5669 Found in file XSUB.h
5671 =item XS_VERSION_BOOTCHECK
5673 Macro to verify that a PM module's $VERSION variable matches the XS
5674 module's C<XS_VERSION> variable. This is usually handled automatically by
5675 C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">.
5677 XS_VERSION_BOOTCHECK;
5680 Found in file XSUB.h
5685 =head1 Warning and Dieing
5691 This is the XSUB-writer's interface to Perl's C<die> function.
5692 Normally call this function the same way you call the C C<printf>
5693 function. Calling C<croak> returns control directly to Perl,
5694 sidestepping the normal C order of execution. See C<warn>.
5696 If you want to throw an exception object, assign the object to
5697 C<$@> and then pass C<Nullch> to croak():
5699 errsv = get_sv("@", TRUE);
5700 sv_setsv(errsv, exception_object);
5703 void croak(const char* pat, ...)
5706 Found in file util.c
5710 This is the XSUB-writer's interface to Perl's C<warn> function. Call this
5711 function the same way you call the C C<printf> function. See C<croak>.
5713 void warn(const char* pat, ...)
5716 Found in file util.c
5723 Until May 1997, this document was maintained by Jeff Okamoto
5724 <okamoto@corp.hp.com>. It is now maintained as part of Perl itself.
5726 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
5727 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
5728 Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
5729 Stephen McCamant, and Gurusamy Sarathy.
5731 API Listing originally by Dean Roehrich <roehrich@cray.com>.
5733 Updated to be autogenerated from comments in the source by Benjamin Stuhl.
5737 perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
projects / p5sagit/p5-mst-13.2.git / blob