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 reaasigned 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<SvSetMagicSV>, 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 On return I<*len> is set to the length scanned string, and I<*flags> gives
2009 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2010 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_bin>
2011 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2012 and writes the value to I<*result> (or the value is discarded if I<result>
2015 The hex number may optionally be prefixed with "0b" or "b" unless
2016 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
2017 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the binary
2018 number may use '_' characters to separate digits.
2020 UV grok_bin(char* start, STRLEN* len, I32* flags, NV *result)
2023 Found in file numeric.c
2027 converts a string representing a hex number to numeric form.
2029 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2030 conversion flags, and I<result> should be NULL or a pointer to an NV.
2031 The scan stops at the end of the string, or the first non-hex-digit character.
2032 On return I<*len> is set to the length scanned string, and I<*flags> gives
2035 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2036 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_hex>
2037 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2038 and writes the value to I<*result> (or the value is discarded if I<result>
2041 The hex number may optionally be prefixed with "0x" or "x" unless
2042 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
2043 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the hex
2044 number may use '_' characters to separate digits.
2046 UV grok_hex(char* start, STRLEN* len, I32* flags, NV *result)
2049 Found in file numeric.c
2053 Recognise (or not) a number. The type of the number is returned
2054 (0 if unrecognised), otherwise it is a bit-ORed combination of
2055 IS_NUMBER_IN_UV, IS_NUMBER_GREATER_THAN_UV_MAX, IS_NUMBER_NOT_INT,
2056 IS_NUMBER_NEG, IS_NUMBER_INFINITY, IS_NUMBER_NAN (defined in perl.h).
2058 If the value of the number can fit an in UV, it is returned in the *valuep
2059 IS_NUMBER_IN_UV will be set to indicate that *valuep is valid, IS_NUMBER_IN_UV
2060 will never be set unless *valuep is valid, but *valuep may have been assigned
2061 to during processing even though IS_NUMBER_IN_UV is not set on return.
2062 If valuep is NULL, IS_NUMBER_IN_UV will be set for the same cases as when
2063 valuep is non-NULL, but no actual assignment (or SEGV) will occur.
2065 IS_NUMBER_NOT_INT will be set with IS_NUMBER_IN_UV if trailing decimals were
2066 seen (in which case *valuep gives the true value truncated to an integer), and
2067 IS_NUMBER_NEG if the number is negative (in which case *valuep holds the
2068 absolute value). IS_NUMBER_IN_UV is not set if e notation was used or the
2069 number is larger than a UV.
2071 int grok_number(const char *pv, STRLEN len, UV *valuep)
2074 Found in file numeric.c
2076 =item grok_numeric_radix
2078 Scan and skip for a numeric decimal separator (radix).
2080 bool grok_numeric_radix(const char **sp, const char *send)
2083 Found in file numeric.c
2088 UV grok_oct(char* start, STRLEN* len, I32* flags, NV *result)
2091 Found in file numeric.c
2095 For backwards compatibility. Use C<grok_bin> instead.
2097 NV scan_bin(char* start, STRLEN len, STRLEN* retlen)
2100 Found in file numeric.c
2104 For backwards compatibility. Use C<grok_hex> instead.
2106 NV scan_hex(char* start, STRLEN len, STRLEN* retlen)
2109 Found in file numeric.c
2113 For backwards compatibility. Use C<grok_oct> instead.
2115 NV scan_oct(char* start, STRLEN len, STRLEN* retlen)
2118 Found in file numeric.c
2123 =head1 Optree Manipulation Functions
2129 If C<cv> is a constant sub eligible for inlining. returns the constant
2130 value returned by the sub. Otherwise, returns NULL.
2132 Constant subs can be created with C<newCONSTSUB> or as described in
2133 L<perlsub/"Constant Functions">.
2135 SV* cv_const_sv(CV* cv)
2142 Creates a constant sub equivalent to Perl C<sub FOO () { 123 }> which is
2143 eligible for inlining at compile-time.
2145 CV* newCONSTSUB(HV* stash, char* name, SV* sv)
2152 Used by C<xsubpp> to hook up XSUBs as Perl subs.
2160 =head1 Pad Data Structures
2166 Get the value at offset po in the current pad.
2167 Use macro PAD_SV instead of calling this function directly.
2169 SV* pad_sv(PADOFFSET po)
2177 =head1 Stack Manipulation Macros
2183 Declare a stack marker variable, C<mark>, for the XSUB. See C<MARK> and
2193 Saves the original stack mark for the XSUB. See C<ORIGMARK>.
2202 Declares a local copy of perl's stack pointer for the XSUB, available via
2203 the C<SP> macro. See C<SP>.
2212 Used to extend the argument stack for an XSUB's return values. Once
2213 used, guarantees that there is room for at least C<nitems> to be pushed
2216 void EXTEND(SP, int nitems)
2223 Stack marker variable for the XSUB. See C<dMARK>.
2230 Push an integer onto the stack. The stack must have room for this element.
2231 Handles 'set' magic. Does not use C<TARG>. See also C<PUSHi>, C<mXPUSHi>
2241 Push a double onto the stack. The stack must have room for this element.
2242 Handles 'set' magic. Does not use C<TARG>. See also C<PUSHn>, C<mXPUSHn>
2252 Push a string onto the stack. The stack must have room for this element.
2253 The C<len> indicates the length of the string. Handles 'set' magic. Does
2254 not use C<TARG>. See also C<PUSHp>, C<mXPUSHp> and C<XPUSHp>.
2256 void mPUSHp(char* str, STRLEN len)
2263 Push an unsigned integer onto the stack. The stack must have room for this
2264 element. Handles 'set' magic. Does not use C<TARG>. See also C<PUSHu>,
2265 C<mXPUSHu> and C<XPUSHu>.
2274 Push an integer onto the stack, extending the stack if necessary. Handles
2275 'set' magic. Does not use C<TARG>. See also C<XPUSHi>, C<mPUSHi> and
2285 Push a double onto the stack, extending the stack if necessary. Handles
2286 'set' magic. Does not use C<TARG>. See also C<XPUSHn>, C<mPUSHn> and
2296 Push a string onto the stack, extending the stack if necessary. The C<len>
2297 indicates the length of the string. Handles 'set' magic. Does not use
2298 C<TARG>. See also C<XPUSHp>, C<mPUSHp> and C<PUSHp>.
2300 void mXPUSHp(char* str, STRLEN len)
2307 Push an unsigned integer onto the stack, extending the stack if necessary.
2308 Handles 'set' magic. Does not use C<TARG>. See also C<XPUSHu>, C<mPUSHu>
2318 The original stack mark for the XSUB. See C<dORIGMARK>.
2325 Pops an integer off the stack.
2334 Pops a long off the stack.
2343 Pops a double off the stack.
2352 Pops a string off the stack. Deprecated. New code should provide
2353 a STRLEN n_a and use POPpx.
2362 Pops a string off the stack which must consist of bytes i.e. characters < 256.
2363 Requires a variable STRLEN n_a in scope.
2372 Pops a string off the stack.
2373 Requires a variable STRLEN n_a in scope.
2382 Pops an SV off the stack.
2391 Push an integer onto the stack. The stack must have room for this element.
2392 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
2393 called to declare it. Do not call multiple C<TARG>-oriented macros to
2394 return lists from XSUB's - see C<mPUSHi> instead. See also C<XPUSHi> and
2404 Opening bracket for arguments on a callback. See C<PUTBACK> and
2414 Push a new mortal SV onto the stack. The stack must have room for this
2415 element. Does not handle 'set' magic. Does not use C<TARG>. See also
2416 C<PUSHs>, C<XPUSHmortal> and C<XPUSHs>.
2425 Push a double onto the stack. The stack must have room for this element.
2426 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
2427 called to declare it. Do not call multiple C<TARG>-oriented macros to
2428 return lists from XSUB's - see C<mPUSHn> instead. See also C<XPUSHn> and
2438 Push a string onto the stack. The stack must have room for this element.
2439 The C<len> indicates the length of the string. Handles 'set' magic. Uses
2440 C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to declare it. Do not
2441 call multiple C<TARG>-oriented macros to return lists from XSUB's - see
2442 C<mPUSHp> instead. See also C<XPUSHp> and C<mXPUSHp>.
2444 void PUSHp(char* str, STRLEN len)
2451 Push an SV onto the stack. The stack must have room for this element.
2452 Does not handle 'set' magic. Does not use C<TARG>. See also C<PUSHmortal>,
2453 C<XPUSHs> and C<XPUSHmortal>.
2462 Push an unsigned integer onto the stack. The stack must have room for this
2463 element. Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG>
2464 should be called to declare it. Do not call multiple C<TARG>-oriented
2465 macros to return lists from XSUB's - see C<mPUSHu> instead. See also
2466 C<XPUSHu> and C<mXPUSHu>.
2475 Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
2476 See C<PUSHMARK> and L<perlcall> for other uses.
2485 Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and
2493 Refetch the stack pointer. Used after a callback. See L<perlcall>.
2502 Push an integer onto the stack, extending the stack if necessary. Handles
2503 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
2504 declare it. Do not call multiple C<TARG>-oriented macros to return lists
2505 from XSUB's - see C<mXPUSHi> instead. See also C<PUSHi> and C<mPUSHi>.
2514 Push a new mortal SV onto the stack, extending the stack if necessary. Does
2515 not handle 'set' magic. Does not use C<TARG>. See also C<XPUSHs>,
2516 C<PUSHmortal> and C<PUSHs>.
2525 Push a double onto the stack, extending the stack if necessary. Handles
2526 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
2527 declare it. Do not call multiple C<TARG>-oriented macros to return lists
2528 from XSUB's - see C<mXPUSHn> instead. See also C<PUSHn> and C<mPUSHn>.
2537 Push a string onto the stack, extending the stack if necessary. The C<len>
2538 indicates the length of the string. Handles 'set' magic. Uses C<TARG>, so
2539 C<dTARGET> or C<dXSTARG> should be called to declare it. Do not call
2540 multiple C<TARG>-oriented macros to return lists from XSUB's - see
2541 C<mXPUSHp> instead. See also C<PUSHp> and C<mPUSHp>.
2543 void XPUSHp(char* str, STRLEN len)
2550 Push an SV onto the stack, extending the stack if necessary. Does not
2551 handle 'set' magic. Does not use C<TARG>. See also C<XPUSHmortal>,
2552 C<PUSHs> and C<PUSHmortal>.
2561 Push an unsigned integer onto the stack, extending the stack if necessary.
2562 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
2563 called to declare it. Do not call multiple C<TARG>-oriented macros to
2564 return lists from XSUB's - see C<mXPUSHu> instead. See also C<PUSHu> and
2574 Return from XSUB, indicating number of items on the stack. This is usually
2575 handled by C<xsubpp>.
2577 void XSRETURN(int nitems)
2580 Found in file XSUB.h
2582 =item XSRETURN_EMPTY
2584 Return an empty list from an XSUB immediately.
2589 Found in file XSUB.h
2593 Return an integer from an XSUB immediately. Uses C<XST_mIV>.
2595 void XSRETURN_IV(IV iv)
2598 Found in file XSUB.h
2602 Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
2607 Found in file XSUB.h
2611 Return a double from an XSUB immediately. Uses C<XST_mNV>.
2613 void XSRETURN_NV(NV nv)
2616 Found in file XSUB.h
2620 Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
2622 void XSRETURN_PV(char* str)
2625 Found in file XSUB.h
2627 =item XSRETURN_UNDEF
2629 Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
2634 Found in file XSUB.h
2638 Return an integer from an XSUB immediately. Uses C<XST_mUV>.
2640 void XSRETURN_UV(IV uv)
2643 Found in file XSUB.h
2647 Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
2652 Found in file XSUB.h
2656 Place an integer into the specified position C<pos> on the stack. The
2657 value is stored in a new mortal SV.
2659 void XST_mIV(int pos, IV iv)
2662 Found in file XSUB.h
2666 Place C<&PL_sv_no> into the specified position C<pos> on the
2669 void XST_mNO(int pos)
2672 Found in file XSUB.h
2676 Place a double into the specified position C<pos> on the stack. The value
2677 is stored in a new mortal SV.
2679 void XST_mNV(int pos, NV nv)
2682 Found in file XSUB.h
2686 Place a copy of a string into the specified position C<pos> on the stack.
2687 The value is stored in a new mortal SV.
2689 void XST_mPV(int pos, char* str)
2692 Found in file XSUB.h
2696 Place C<&PL_sv_undef> into the specified position C<pos> on the
2699 void XST_mUNDEF(int pos)
2702 Found in file XSUB.h
2706 Place C<&PL_sv_yes> into the specified position C<pos> on the
2709 void XST_mYES(int pos)
2712 Found in file XSUB.h
2723 An enum of flags for Perl types. These are found in the file B<sv.h>
2724 in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
2731 Integer type flag for scalars. See C<svtype>.
2738 Double type flag for scalars. See C<svtype>.
2745 Pointer type flag for scalars. See C<svtype>.
2752 Type flag for arrays. See C<svtype>.
2759 Type flag for code refs. See C<svtype>.
2766 Type flag for hashes. See C<svtype>.
2773 Type flag for blessed scalars. See C<svtype>.
2781 =head1 SV Manipulation Functions
2787 Returns the SV of the specified Perl scalar. If C<create> is set and the
2788 Perl variable does not exist then it will be created. If C<create> is not
2789 set and the variable does not exist then NULL is returned.
2791 NOTE: the perl_ form of this function is deprecated.
2793 SV* get_sv(const char* name, I32 create)
2796 Found in file perl.c
2798 =item looks_like_number
2800 Test if the content of an SV looks like a number (or is a number).
2801 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
2802 non-numeric warning), even if your atof() doesn't grok them.
2804 I32 looks_like_number(SV* sv)
2811 Creates an RV wrapper for an SV. The reference count for the original SV is
2814 SV* newRV_inc(SV* sv)
2821 Creates an RV wrapper for an SV. The reference count for the original
2822 SV is B<not> incremented.
2824 SV* newRV_noinc(SV *sv)
2831 Creates a new SV. A non-zero C<len> parameter indicates the number of
2832 bytes of preallocated string space the SV should have. An extra byte for a
2833 tailing NUL is also reserved. (SvPOK is not set for the SV even if string
2834 space is allocated.) The reference count for the new SV is set to 1.
2835 C<id> is an integer id between 0 and 1299 (used to identify leaks).
2837 SV* NEWSV(int id, STRLEN len)
2840 Found in file handy.h
2844 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
2845 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
2848 SV* newSV(STRLEN len)
2855 Creates a new SV and copies an integer into it. The reference count for the
2865 Creates a new SV and copies a floating point value into it.
2866 The reference count for the SV is set to 1.
2875 Creates a new SV and copies a string into it. The reference count for the
2876 SV is set to 1. If C<len> is zero, Perl will compute the length using
2877 strlen(). For efficiency, consider using C<newSVpvn> instead.
2879 SV* newSVpv(const char* s, STRLEN len)
2886 Creates a new SV and initializes it with the string formatted like
2889 SV* newSVpvf(const char* pat, ...)
2896 Creates a new SV and copies a string into it. The reference count for the
2897 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
2898 string. You are responsible for ensuring that the source string is at least
2899 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
2901 SV* newSVpvn(const char* s, STRLEN len)
2906 =item newSVpvn_share
2908 Creates a new SV with its SvPVX pointing to a shared string in the string
2909 table. If the string does not already exist in the table, it is created
2910 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
2911 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
2912 otherwise the hash is computed. The idea here is that as the string table
2913 is used for shared hash keys these strings will have SvPVX == HeKEY and
2914 hash lookup will avoid string compare.
2916 SV* newSVpvn_share(const char* s, I32 len, U32 hash)
2923 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
2924 it will be upgraded to one. If C<classname> is non-null then the new SV will
2925 be blessed in the specified package. The new SV is returned and its
2926 reference count is 1.
2928 SV* newSVrv(SV* rv, const char* classname)
2935 Creates a new SV which is an exact duplicate of the original SV.
2938 SV* newSVsv(SV* old)
2945 Creates a new SV and copies an unsigned integer into it.
2946 The reference count for the SV is set to 1.
2955 Returns the length of the string which is in the SV. See C<SvLEN>.
2957 STRLEN SvCUR(SV* sv)
2964 Set the length of the string which is in the SV. See C<SvCUR>.
2966 void SvCUR_set(SV* sv, STRLEN len)
2973 Returns a pointer to the last character in the string which is in the SV.
2974 See C<SvCUR>. Access the character as *(SvEND(sv)).
2983 Expands the character buffer in the SV so that it has room for the
2984 indicated number of bytes (remember to reserve space for an extra trailing
2985 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
2986 Returns a pointer to the character buffer.
2988 char * SvGROW(SV* sv, STRLEN len)
2995 Returns a boolean indicating whether the SV contains an integer.
3004 Returns a boolean indicating whether the SV contains an integer. Checks
3005 the B<private> setting. Use C<SvIOK>.
3014 Returns a boolean indicating whether the SV contains a signed integer.
3016 bool SvIOK_notUV(SV* sv)
3023 Unsets the IV status of an SV.
3025 void SvIOK_off(SV* sv)
3032 Tells an SV that it is an integer.
3034 void SvIOK_on(SV* sv)
3041 Tells an SV that it is an integer and disables all other OK bits.
3043 void SvIOK_only(SV* sv)
3050 Tells and SV that it is an unsigned integer and disables all other OK bits.
3052 void SvIOK_only_UV(SV* sv)
3059 Returns a boolean indicating whether the SV contains an unsigned integer.
3061 bool SvIOK_UV(SV* sv)
3068 Returns a boolean indicating whether the SV is Copy-On-Write. (either shared
3069 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
3072 bool SvIsCOW(SV* sv)
3077 =item SvIsCOW_shared_hash
3079 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
3082 bool SvIsCOW_shared_hash(SV* sv)
3089 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
3090 version which guarantees to evaluate sv only once.
3099 Coerces the given SV to an integer and returns it. Guarantees to evaluate
3100 sv only once. Use the more efficient C<SvIV> otherwise.
3109 Returns the raw value in the SV's IV slot, without checks or conversions.
3110 Only use when you are sure SvIOK is true. See also C<SvIV()>.
3119 Like C<SvIV> but doesn't process magic.
3121 IV SvIV_nomg(SV* sv)
3128 Returns the size of the string buffer in the SV, not including any part
3129 attributable to C<SvOOK>. See C<SvCUR>.
3131 STRLEN SvLEN(SV* sv)
3138 Returns a boolean indicating whether the SV contains a number, integer or
3148 Returns a boolean indicating whether the SV contains a number, integer or
3149 double. Checks the B<private> setting. Use C<SvNIOK>.
3151 bool SvNIOKp(SV* sv)
3158 Unsets the NV/IV status of an SV.
3160 void SvNIOK_off(SV* sv)
3167 Returns a boolean indicating whether the SV contains a double.
3176 Returns a boolean indicating whether the SV contains a double. Checks the
3177 B<private> setting. Use C<SvNOK>.
3186 Unsets the NV status of an SV.
3188 void SvNOK_off(SV* sv)
3195 Tells an SV that it is a double.
3197 void SvNOK_on(SV* sv)
3204 Tells an SV that it is a double and disables all other OK bits.
3206 void SvNOK_only(SV* sv)
3213 Coerce the given SV to a double and return it. See C<SvNVx> for a version
3214 which guarantees to evaluate sv only once.
3223 Returns the raw value in the SV's NV slot, without checks or conversions.
3224 Only use when you are sure SvNOK is true. See also C<SvNV()>.
3233 Coerces the given SV to a double and returns it. Guarantees to evaluate
3234 sv only once. Use the more efficient C<SvNV> otherwise.
3243 Returns a boolean indicating whether the value is an SV. It also tells
3244 whether the value is defined or not.
3253 Returns a boolean indicating whether the SvIVX is a valid offset value for
3254 the SvPVX. This hack is used internally to speed up removal of characters
3255 from the beginning of a SvPV. When SvOOK is true, then the start of the
3256 allocated string buffer is really (SvPVX - SvIVX).
3265 Returns a boolean indicating whether the SV contains a character
3275 Returns a boolean indicating whether the SV contains a character string.
3276 Checks the B<private> setting. Use C<SvPOK>.
3285 Unsets the PV status of an SV.
3287 void SvPOK_off(SV* sv)
3294 Tells an SV that it is a string.
3296 void SvPOK_on(SV* sv)
3303 Tells an SV that it is a string and disables all other OK bits.
3304 Will also turn off the UTF-8 status.
3306 void SvPOK_only(SV* sv)
3311 =item SvPOK_only_UTF8
3313 Tells an SV that it is a string and disables all other OK bits,
3314 and leaves the UTF-8 status as it was.
3316 void SvPOK_only_UTF8(SV* sv)
3323 Returns a pointer to the string in the SV, or a stringified form of
3324 the SV if the SV does not contain a string. The SV may cache the
3325 stringified version becoming C<SvPOK>. Handles 'get' magic. See also
3326 C<SvPVx> for a version which guarantees to evaluate sv only once.
3328 char* SvPV(SV* sv, STRLEN len)
3335 Like C<SvPV>, but converts sv to byte representation first if necessary.
3337 char* SvPVbyte(SV* sv, STRLEN len)
3344 Like C<SvPV>, but converts sv to byte representation first if necessary.
3345 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
3348 char* SvPVbytex(SV* sv, STRLEN len)
3353 =item SvPVbytex_force
3355 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
3356 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
3359 char* SvPVbytex_force(SV* sv, STRLEN len)
3364 =item SvPVbyte_force
3366 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
3368 char* SvPVbyte_force(SV* sv, STRLEN len)
3373 =item SvPVbyte_nolen
3375 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
3377 char* SvPVbyte_nolen(SV* sv)
3384 Like C<SvPV>, but converts sv to utf8 first if necessary.
3386 char* SvPVutf8(SV* sv, STRLEN len)
3393 Like C<SvPV>, but converts sv to utf8 first if necessary.
3394 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
3397 char* SvPVutf8x(SV* sv, STRLEN len)
3402 =item SvPVutf8x_force
3404 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
3405 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
3408 char* SvPVutf8x_force(SV* sv, STRLEN len)
3413 =item SvPVutf8_force
3415 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
3417 char* SvPVutf8_force(SV* sv, STRLEN len)
3422 =item SvPVutf8_nolen
3424 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
3426 char* SvPVutf8_nolen(SV* sv)
3433 A version of C<SvPV> which guarantees to evaluate sv only once.
3435 char* SvPVx(SV* sv, STRLEN len)
3442 Returns a pointer to the physical string in the SV. The SV must contain a
3452 Like C<SvPV> but will force the SV into containing just a string
3453 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
3456 char* SvPV_force(SV* sv, STRLEN len)
3461 =item SvPV_force_nomg
3463 Like C<SvPV> but will force the SV into containing just a string
3464 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
3465 directly. Doesn't process magic.
3467 char* SvPV_force_nomg(SV* sv, STRLEN len)
3474 Returns a pointer to the string in the SV, or a stringified form of
3475 the SV if the SV does not contain a string. The SV may cache the
3476 stringified form becoming C<SvPOK>. Handles 'get' magic.
3478 char* SvPV_nolen(SV* sv)
3485 Like C<SvPV> but doesn't process magic.
3487 char* SvPV_nomg(SV* sv, STRLEN len)
3494 Returns the value of the object's reference count.
3496 U32 SvREFCNT(SV* sv)
3503 Decrements the reference count of the given SV.
3505 void SvREFCNT_dec(SV* sv)
3512 Increments the reference count of the given SV.
3514 SV* SvREFCNT_inc(SV* sv)
3521 Tests if the SV is an RV.
3530 Unsets the RV status of an SV.
3532 void SvROK_off(SV* sv)
3539 Tells an SV that it is an RV.
3541 void SvROK_on(SV* sv)
3548 Dereferences an RV to return the SV.
3557 Returns the stash of the SV.
3566 Taints an SV if tainting is enabled.
3568 void SvTAINT(SV* sv)
3575 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
3578 bool SvTAINTED(SV* sv)
3585 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
3586 some of Perl's fundamental security features. XS module authors should not
3587 use this function unless they fully understand all the implications of
3588 unconditionally untainting the value. Untainting should be done in the
3589 standard perl fashion, via a carefully crafted regexp, rather than directly
3590 untainting variables.
3592 void SvTAINTED_off(SV* sv)
3599 Marks an SV as tainted if tainting is enabled.
3601 void SvTAINTED_on(SV* sv)
3608 Returns a boolean indicating whether Perl would evaluate the SV as true or
3609 false, defined or undefined. Does not handle 'get' magic.
3618 Returns the type of the SV. See C<svtype>.
3620 svtype SvTYPE(SV* sv)
3627 Returns a boolean indicating whether the SV contains an unsigned integer.
3636 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
3637 perform the upgrade if necessary. See C<svtype>.
3639 void SvUPGRADE(SV* sv, svtype type)
3646 Returns a boolean indicating whether the SV contains UTF-8 encoded data.
3655 Unsets the UTF-8 status of an SV.
3657 void SvUTF8_off(SV *sv)
3664 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
3665 Do not use frivolously.
3667 void SvUTF8_on(SV *sv)
3674 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
3675 for a version which guarantees to evaluate sv only once.
3684 Returns the raw value in the SV's UV slot, without checks or conversions.
3685 Only use when you are sure SvIOK is true. See also C<SvUV()>.
3694 Coerces the given SV to an unsigned integer and returns it. Guarantees to
3695 evaluate sv only once. Use the more efficient C<SvUV> otherwise.
3704 Like C<SvUV> but doesn't process magic.
3706 UV SvUV_nomg(SV* sv)
3713 Returns a boolean indicating whether the SV contains a v-string.
3722 This function is only called on magical items, and is only used by
3723 sv_true() or its macro equivalent.
3725 bool sv_2bool(SV* sv)
3732 Using various gambits, try to get a CV from an SV; in addition, try if
3733 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
3735 CV* sv_2cv(SV* sv, HV** st, GV** gvp, I32 lref)
3742 Using various gambits, try to get an IO from an SV: the IO slot if its a
3743 GV; or the recursive result if we're an RV; or the IO slot of the symbol
3744 named after the PV if we're a string.
3753 Return the integer value of an SV, doing any necessary string
3754 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
3755 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
3757 IV sv_2iv_flags(SV* sv, I32 flags)
3764 Marks an existing SV as mortal. The SV will be destroyed "soon", either
3765 by an explicit call to FREETMPS, or by an implicit call at places such as
3766 statement boundaries. SvTEMP() is turned on which means that the SV's
3767 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
3768 and C<sv_mortalcopy>.
3770 SV* sv_2mortal(SV* sv)
3777 Return the num value of an SV, doing any necessary string or integer
3778 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
3788 Return a pointer to the byte-encoded representation of the SV, and set *lp
3789 to its length. May cause the SV to be downgraded from UTF-8 as a
3792 Usually accessed via the C<SvPVbyte> macro.
3794 char* sv_2pvbyte(SV* sv, STRLEN* lp)
3799 =item sv_2pvbyte_nolen
3801 Return a pointer to the byte-encoded representation of the SV.
3802 May cause the SV to be downgraded from UTF-8 as a side-effect.
3804 Usually accessed via the C<SvPVbyte_nolen> macro.
3806 char* sv_2pvbyte_nolen(SV* sv)
3813 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3814 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
3816 Usually accessed via the C<SvPVutf8> macro.
3818 char* sv_2pvutf8(SV* sv, STRLEN* lp)
3823 =item sv_2pvutf8_nolen
3825 Return a pointer to the UTF-8-encoded representation of the SV.
3826 May cause the SV to be upgraded to UTF-8 as a side-effect.
3828 Usually accessed via the C<SvPVutf8_nolen> macro.
3830 char* sv_2pvutf8_nolen(SV* sv)
3837 Returns a pointer to the string value of an SV, and sets *lp to its length.
3838 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
3840 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
3841 usually end up here too.
3843 char* sv_2pv_flags(SV* sv, STRLEN* lp, I32 flags)
3850 Like C<sv_2pv()>, but doesn't return the length too. You should usually
3851 use the macro wrapper C<SvPV_nolen(sv)> instead.
3852 char* sv_2pv_nolen(SV* sv)
3859 Return the unsigned integer value of an SV, doing any necessary string
3860 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
3861 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
3863 UV sv_2uv_flags(SV* sv, I32 flags)
3870 Remove any string offset. You should normally use the C<SvOOK_off> macro
3873 int sv_backoff(SV* sv)
3880 Blesses an SV into a specified package. The SV must be an RV. The package
3881 must be designated by its stash (see C<gv_stashpv()>). The reference count
3882 of the SV is unaffected.
3884 SV* sv_bless(SV* sv, HV* stash)
3891 Concatenates the string onto the end of the string which is in the SV.
3892 If the SV has the UTF-8 status set, then the bytes appended should be
3893 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
3895 void sv_catpv(SV* sv, const char* ptr)
3902 Processes its arguments like C<sprintf> and appends the formatted
3903 output to an SV. If the appended data contains "wide" characters
3904 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
3905 and characters >255 formatted with %c), the original SV might get
3906 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic.
3907 C<SvSETMAGIC()> must typically be called after calling this function
3908 to handle 'set' magic.
3910 void sv_catpvf(SV* sv, const char* pat, ...)
3917 Like C<sv_catpvf>, but also handles 'set' magic.
3919 void sv_catpvf_mg(SV *sv, const char* pat, ...)
3926 Concatenates the string onto the end of the string which is in the SV. The
3927 C<len> indicates number of bytes to copy. If the SV has the UTF-8
3928 status set, then the bytes appended should be valid UTF-8.
3929 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
3931 void sv_catpvn(SV* sv, const char* ptr, STRLEN len)
3936 =item sv_catpvn_flags
3938 Concatenates the string onto the end of the string which is in the SV. The
3939 C<len> indicates number of bytes to copy. If the SV has the UTF-8
3940 status set, then the bytes appended should be valid UTF-8.
3941 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
3942 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
3943 in terms of this function.
3945 void sv_catpvn_flags(SV* sv, const char* ptr, STRLEN len, I32 flags)
3952 Like C<sv_catpvn>, but also handles 'set' magic.
3954 void sv_catpvn_mg(SV *sv, const char *ptr, STRLEN len)
3961 Like C<sv_catpv>, but also handles 'set' magic.
3963 void sv_catpv_mg(SV *sv, const char *ptr)
3970 Concatenates the string from SV C<ssv> onto the end of the string in
3971 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
3972 not 'set' magic. See C<sv_catsv_mg>.
3974 void sv_catsv(SV* dsv, SV* ssv)
3979 =item sv_catsv_flags
3981 Concatenates the string from SV C<ssv> onto the end of the string in
3982 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
3983 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
3984 and C<sv_catsv_nomg> are implemented in terms of this function.
3986 void sv_catsv_flags(SV* dsv, SV* ssv, I32 flags)
3993 Like C<sv_catsv>, but also handles 'set' magic.
3995 void sv_catsv_mg(SV *dstr, SV *sstr)
4002 Efficient removal of characters from the beginning of the string buffer.
4003 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4004 the string buffer. The C<ptr> becomes the first character of the adjusted
4005 string. Uses the "OOK hack".
4006 Beware: after this function returns, C<ptr> and SvPVX(sv) may no longer
4007 refer to the same chunk of data.
4009 void sv_chop(SV* sv, char* ptr)
4016 Clear an SV: call any destructors, free up any memory used by the body,
4017 and free the body itself. The SV's head is I<not> freed, although
4018 its type is set to all 1's so that it won't inadvertently be assumed
4019 to be live during global destruction etc.
4020 This function should only be called when REFCNT is zero. Most of the time
4021 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
4024 void sv_clear(SV* sv)
4031 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
4032 string in C<sv1> is less than, equal to, or greater than the string in
4033 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
4034 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
4036 I32 sv_cmp(SV* sv1, SV* sv2)
4043 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
4044 'use bytes' aware, handles get magic, and will coerce its args to strings
4045 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
4047 I32 sv_cmp_locale(SV* sv1, SV* sv2)
4054 Add Collate Transform magic to an SV if it doesn't already have it.
4056 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
4057 scalar data of the variable, but transformed to such a format that a normal
4058 memory comparison can be used to compare the data according to the locale
4061 char* sv_collxfrm(SV* sv, STRLEN* nxp)
4068 Copies a stringified representation of the source SV into the
4069 destination SV. Automatically performs any necessary mg_get and
4070 coercion of numeric values into strings. Guaranteed to preserve
4071 UTF-8 flag even from overloaded objects. Similar in nature to
4072 sv_2pv[_flags] but operates directly on an SV instead of just the
4073 string. Mostly uses sv_2pv_flags to do its work, except when that
4074 would lose the UTF-8'ness of the PV.
4076 void sv_copypv(SV* dsv, SV* ssv)
4083 Auto-decrement of the value in the SV, doing string to numeric conversion
4084 if necessary. Handles 'get' magic.
4091 =item sv_derived_from
4093 Returns a boolean indicating whether the SV is derived from the specified
4094 class. This is the function that implements C<UNIVERSAL::isa>. It works
4095 for class names as well as for objects.
4097 bool sv_derived_from(SV* sv, const char* name)
4100 Found in file universal.c
4104 Returns a boolean indicating whether the strings in the two SVs are
4105 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
4106 coerce its args to strings if necessary.
4108 I32 sv_eq(SV* sv1, SV* sv2)
4113 =item sv_force_normal
4115 Undo various types of fakery on an SV: if the PV is a shared string, make
4116 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4117 an xpvmg. See also C<sv_force_normal_flags>.
4119 void sv_force_normal(SV *sv)
4124 =item sv_force_normal_flags
4126 Undo various types of fakery on an SV: if the PV is a shared string, make
4127 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4128 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4129 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4130 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4131 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4132 set to some other value.) In addition, the C<flags> parameter gets passed to
4133 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4134 with flags set to 0.
4136 void sv_force_normal_flags(SV *sv, U32 flags)
4143 Decrement an SV's reference count, and if it drops to zero, call
4144 C<sv_clear> to invoke destructors and free up any memory used by
4145 the body; finally, deallocate the SV's head itself.
4146 Normally called via a wrapper macro C<SvREFCNT_dec>.
4148 void sv_free(SV* sv)
4155 Get a line from the filehandle and store it into the SV, optionally
4156 appending to the currently-stored string.
4158 char* sv_gets(SV* sv, PerlIO* fp, I32 append)
4165 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
4166 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
4167 Use the C<SvGROW> wrapper instead.
4169 char* sv_grow(SV* sv, STRLEN newlen)
4176 Auto-increment of the value in the SV, doing string to numeric conversion
4177 if necessary. Handles 'get' magic.
4186 Inserts a string at the specified offset/length within the SV. Similar to
4187 the Perl substr() function.
4189 void sv_insert(SV* bigsv, STRLEN offset, STRLEN len, char* little, STRLEN littlelen)
4196 Returns a boolean indicating whether the SV is blessed into the specified
4197 class. This does not check for subtypes; use C<sv_derived_from> to verify
4198 an inheritance relationship.
4200 int sv_isa(SV* sv, const char* name)
4207 Returns a boolean indicating whether the SV is an RV pointing to a blessed
4208 object. If the SV is not an RV, or if the object is not blessed, then this
4211 int sv_isobject(SV* sv)
4218 A private implementation of the C<SvIVx> macro for compilers which can't
4219 cope with complex macro expressions. Always use the macro instead.
4228 Returns the length of the string in the SV. Handles magic and type
4229 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
4231 STRLEN sv_len(SV* sv)
4238 Returns the number of characters in the string in an SV, counting wide
4239 UTF-8 bytes as a single character. Handles magic and type coercion.
4241 STRLEN sv_len_utf8(SV* sv)
4248 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4249 then adds a new magic item of type C<how> to the head of the magic list.
4251 void sv_magic(SV* sv, SV* obj, int how, const char* name, I32 namlen)
4258 Adds magic to an SV, upgrading it if necessary. Applies the
4259 supplied vtable and returns pointer to the magic added.
4261 Note that sv_magicext will allow things that sv_magic will not.
4262 In particular you can add magic to SvREADONLY SVs and and more than
4263 one instance of the same 'how'
4265 I C<namelen> is greater then zero then a savepvn() I<copy> of C<name> is stored,
4266 if C<namelen> is zero then C<name> is stored as-is and - as another special
4267 case - if C<(name && namelen == HEf_SVKEY)> then C<name> is assumed to contain
4268 an C<SV*> and has its REFCNT incremented
4270 (This is now used as a subroutine by sv_magic.)
4272 MAGIC * sv_magicext(SV* sv, SV* obj, int how, MGVTBL *vtbl, const char* name, I32 namlen )
4279 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
4280 The new SV is marked as mortal. It will be destroyed "soon", either by an
4281 explicit call to FREETMPS, or by an implicit call at places such as
4282 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
4284 SV* sv_mortalcopy(SV* oldsv)
4291 Creates a new null SV which is mortal. The reference count of the SV is
4292 set to 1. It will be destroyed "soon", either by an explicit call to
4293 FREETMPS, or by an implicit call at places such as statement boundaries.
4294 See also C<sv_mortalcopy> and C<sv_2mortal>.
4303 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
4306 SV* sv_newref(SV* sv)
4313 A private implementation of the C<SvNVx> macro for compilers which can't
4314 cope with complex macro expressions. Always use the macro instead.
4323 Converts the value pointed to by offsetp from a count of bytes from the
4324 start of the string, to a count of the equivalent number of UTF-8 chars.
4325 Handles magic and type coercion.
4327 void sv_pos_b2u(SV* sv, I32* offsetp)
4334 Converts the value pointed to by offsetp from a count of UTF-8 chars from
4335 the start of the string, to a count of the equivalent number of bytes; if
4336 lenp is non-zero, it does the same to lenp, but this time starting from
4337 the offset, rather than from the start of the string. Handles magic and
4340 void sv_pos_u2b(SV* sv, I32* offsetp, I32* lenp)
4347 Use the C<SvPV_nolen> macro instead
4356 Use C<SvPVbyte_nolen> instead.
4358 char* sv_pvbyte(SV *sv)
4365 A private implementation of the C<SvPVbyte> macro for compilers
4366 which can't cope with complex macro expressions. Always use the macro
4369 char* sv_pvbyten(SV *sv, STRLEN *len)
4374 =item sv_pvbyten_force
4376 A private implementation of the C<SvPVbytex_force> macro for compilers
4377 which can't cope with complex macro expressions. Always use the macro
4380 char* sv_pvbyten_force(SV* sv, STRLEN* lp)
4387 A private implementation of the C<SvPV> macro for compilers which can't
4388 cope with complex macro expressions. Always use the macro instead.
4390 char* sv_pvn(SV *sv, STRLEN *len)
4397 Get a sensible string out of the SV somehow.
4398 A private implementation of the C<SvPV_force> macro for compilers which
4399 can't cope with complex macro expressions. Always use the macro instead.
4401 char* sv_pvn_force(SV* sv, STRLEN* lp)
4406 =item sv_pvn_force_flags
4408 Get a sensible string out of the SV somehow.
4409 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
4410 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
4411 implemented in terms of this function.
4412 You normally want to use the various wrapper macros instead: see
4413 C<SvPV_force> and C<SvPV_force_nomg>
4415 char* sv_pvn_force_flags(SV* sv, STRLEN* lp, I32 flags)
4422 Use the C<SvPVutf8_nolen> macro instead
4424 char* sv_pvutf8(SV *sv)
4431 A private implementation of the C<SvPVutf8> macro for compilers
4432 which can't cope with complex macro expressions. Always use the macro
4435 char* sv_pvutf8n(SV *sv, STRLEN *len)
4440 =item sv_pvutf8n_force
4442 A private implementation of the C<SvPVutf8_force> macro for compilers
4443 which can't cope with complex macro expressions. Always use the macro
4446 char* sv_pvutf8n_force(SV* sv, STRLEN* lp)
4453 Returns a string describing what the SV is a reference to.
4455 char* sv_reftype(SV* sv, int ob)
4462 Make the first argument a copy of the second, then delete the original.
4463 The target SV physically takes over ownership of the body of the source SV
4464 and inherits its flags; however, the target keeps any magic it owns,
4465 and any magic in the source is discarded.
4466 Note that this is a rather specialist SV copying operation; most of the
4467 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4469 void sv_replace(SV* sv, SV* nsv)
4474 =item sv_report_used
4476 Dump the contents of all SVs not yet freed. (Debugging aid).
4478 void sv_report_used()
4485 Underlying implementation for the C<reset> Perl function.
4486 Note that the perl-level function is vaguely deprecated.
4488 void sv_reset(char* s, HV* stash)
4495 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4496 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4497 push a back-reference to this RV onto the array of backreferences
4498 associated with that magic.
4500 SV* sv_rvweaken(SV *sv)
4507 Copies an integer into the given SV, upgrading first if necessary.
4508 Does not handle 'set' magic. See also C<sv_setiv_mg>.
4510 void sv_setiv(SV* sv, IV num)
4517 Like C<sv_setiv>, but also handles 'set' magic.
4519 void sv_setiv_mg(SV *sv, IV i)
4526 Copies a double into the given SV, upgrading first if necessary.
4527 Does not handle 'set' magic. See also C<sv_setnv_mg>.
4529 void sv_setnv(SV* sv, NV num)
4536 Like C<sv_setnv>, but also handles 'set' magic.
4538 void sv_setnv_mg(SV *sv, NV num)
4545 Copies a string into an SV. The string must be null-terminated. Does not
4546 handle 'set' magic. See C<sv_setpv_mg>.
4548 void sv_setpv(SV* sv, const char* ptr)
4555 Processes its arguments like C<sprintf> and sets an SV to the formatted
4556 output. Does not handle 'set' magic. See C<sv_setpvf_mg>.
4558 void sv_setpvf(SV* sv, const char* pat, ...)
4565 Like C<sv_setpvf>, but also handles 'set' magic.
4567 void sv_setpvf_mg(SV *sv, const char* pat, ...)
4574 Copies an integer into the given SV, also updating its string value.
4575 Does not handle 'set' magic. See C<sv_setpviv_mg>.
4577 void sv_setpviv(SV* sv, IV num)
4584 Like C<sv_setpviv>, but also handles 'set' magic.
4586 void sv_setpviv_mg(SV *sv, IV iv)
4593 Copies a string into an SV. The C<len> parameter indicates the number of
4594 bytes to be copied. If the C<ptr> argument is NULL the SV will become
4595 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4597 void sv_setpvn(SV* sv, const char* ptr, STRLEN len)
4604 Like C<sv_setpvn>, but also handles 'set' magic.
4606 void sv_setpvn_mg(SV *sv, const char *ptr, STRLEN len)
4613 Like C<sv_setpv>, but also handles 'set' magic.
4615 void sv_setpv_mg(SV *sv, const char *ptr)
4622 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
4623 argument will be upgraded to an RV. That RV will be modified to point to
4624 the new SV. The C<classname> argument indicates the package for the
4625 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4626 will have a reference count of 1, and the RV will be returned.
4628 SV* sv_setref_iv(SV* rv, const char* classname, IV iv)
4635 Copies a double into a new SV, optionally blessing the SV. The C<rv>
4636 argument will be upgraded to an RV. That RV will be modified to point to
4637 the new SV. The C<classname> argument indicates the package for the
4638 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4639 will have a reference count of 1, and the RV will be returned.
4641 SV* sv_setref_nv(SV* rv, const char* classname, NV nv)
4648 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
4649 argument will be upgraded to an RV. That RV will be modified to point to
4650 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
4651 into the SV. The C<classname> argument indicates the package for the
4652 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4653 will have a reference count of 1, and the RV will be returned.
4655 Do not use with other Perl types such as HV, AV, SV, CV, because those
4656 objects will become corrupted by the pointer copy process.
4658 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
4660 SV* sv_setref_pv(SV* rv, const char* classname, void* pv)
4667 Copies a string into a new SV, optionally blessing the SV. The length of the
4668 string must be specified with C<n>. The C<rv> argument will be upgraded to
4669 an RV. That RV will be modified to point to the new SV. The C<classname>
4670 argument indicates the package for the blessing. Set C<classname> to
4671 C<Nullch> to avoid the blessing. The new SV will have a reference count
4672 of 1, and the RV will be returned.
4674 Note that C<sv_setref_pv> copies the pointer while this copies the string.
4676 SV* sv_setref_pvn(SV* rv, const char* classname, char* pv, STRLEN n)
4683 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
4684 argument will be upgraded to an RV. That RV will be modified to point to
4685 the new SV. The C<classname> argument indicates the package for the
4686 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4687 will have a reference count of 1, and the RV will be returned.
4689 SV* sv_setref_uv(SV* rv, const char* classname, UV uv)
4696 Copies the contents of the source SV C<ssv> into the destination SV
4697 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4698 function if the source SV needs to be reused. Does not handle 'set' magic.
4699 Loosely speaking, it performs a copy-by-value, obliterating any previous
4700 content of the destination.
4702 You probably want to use one of the assortment of wrappers, such as
4703 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4704 C<SvSetMagicSV_nosteal>.
4706 void sv_setsv(SV* dsv, SV* ssv)
4711 =item sv_setsv_flags
4713 Copies the contents of the source SV C<ssv> into the destination SV
4714 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4715 function if the source SV needs to be reused. Does not handle 'set' magic.
4716 Loosely speaking, it performs a copy-by-value, obliterating any previous
4717 content of the destination.
4718 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
4719 C<ssv> if appropriate, else not. C<sv_setsv> and C<sv_setsv_nomg> are
4720 implemented in terms of this function.
4722 You probably want to use one of the assortment of wrappers, such as
4723 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4724 C<SvSetMagicSV_nosteal>.
4726 This is the primary function for copying scalars, and most other
4727 copy-ish functions and macros use this underneath.
4729 void sv_setsv_flags(SV* dsv, SV* ssv, I32 flags)
4736 Like C<sv_setsv>, but also handles 'set' magic.
4738 void sv_setsv_mg(SV *dstr, SV *sstr)
4745 Copies an unsigned integer into the given SV, upgrading first if necessary.
4746 Does not handle 'set' magic. See also C<sv_setuv_mg>.
4748 void sv_setuv(SV* sv, UV num)
4755 Like C<sv_setuv>, but also handles 'set' magic.
4757 void sv_setuv_mg(SV *sv, UV u)
4764 Taint an SV. Use C<SvTAINTED_on> instead.
4765 void sv_taint(SV* sv)
4772 Test an SV for taintedness. Use C<SvTAINTED> instead.
4773 bool sv_tainted(SV* sv)
4780 Returns true if the SV has a true value by Perl's rules.
4781 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
4782 instead use an in-line version.
4791 Removes all magic of type C<type> from an SV.
4793 int sv_unmagic(SV* sv, int type)
4800 Unsets the RV status of the SV, and decrements the reference count of
4801 whatever was being referenced by the RV. This can almost be thought of
4802 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
4803 being zero. See C<SvROK_off>.
4805 void sv_unref(SV* sv)
4810 =item sv_unref_flags
4812 Unsets the RV status of the SV, and decrements the reference count of
4813 whatever was being referenced by the RV. This can almost be thought of
4814 as a reversal of C<newSVrv>. The C<cflags> argument can contain
4815 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
4816 (otherwise the decrementing is conditional on the reference count being
4817 different from one or the reference being a readonly SV).
4820 void sv_unref_flags(SV* sv, U32 flags)
4827 Untaint an SV. Use C<SvTAINTED_off> instead.
4828 void sv_untaint(SV* sv)
4835 Upgrade an SV to a more complex form. Generally adds a new body type to the
4836 SV, then copies across as much information as possible from the old body.
4837 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
4839 bool sv_upgrade(SV* sv, U32 mt)
4846 Tells an SV to use C<ptr> to find its string value. Normally the string is
4847 stored inside the SV but sv_usepvn allows the SV to use an outside string.
4848 The C<ptr> should point to memory that was allocated by C<malloc>. The
4849 string length, C<len>, must be supplied. This function will realloc the
4850 memory pointed to by C<ptr>, so that pointer should not be freed or used by
4851 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
4852 See C<sv_usepvn_mg>.
4854 void sv_usepvn(SV* sv, char* ptr, STRLEN len)
4861 Like C<sv_usepvn>, but also handles 'set' magic.
4863 void sv_usepvn_mg(SV *sv, char *ptr, STRLEN len)
4868 =item sv_utf8_decode
4870 If the PV of the SV is an octet sequence in UTF-8
4871 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
4872 so that it looks like a character. If the PV contains only single-byte
4873 characters, the C<SvUTF8> flag stays being off.
4874 Scans PV for validity and returns false if the PV is invalid UTF-8.
4876 NOTE: this function is experimental and may change or be
4877 removed without notice.
4879 bool sv_utf8_decode(SV *sv)
4884 =item sv_utf8_downgrade
4886 Attempts to convert the PV of an SV from characters to bytes.
4887 If the PV contains a character beyond byte, this conversion will fail;
4888 in this case, either returns false or, if C<fail_ok> is not
4891 This is not as a general purpose Unicode to byte encoding interface:
4892 use the Encode extension for that.
4894 NOTE: this function is experimental and may change or be
4895 removed without notice.
4897 bool sv_utf8_downgrade(SV *sv, bool fail_ok)
4902 =item sv_utf8_encode
4904 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
4905 flag off so that it looks like octets again.
4907 void sv_utf8_encode(SV *sv)
4912 =item sv_utf8_upgrade
4914 Converts the PV of an SV to its UTF-8-encoded form.
4915 Forces the SV to string form if it is not already.
4916 Always sets the SvUTF8 flag to avoid future validity checks even
4917 if all the bytes have hibit clear.
4919 This is not as a general purpose byte encoding to Unicode interface:
4920 use the Encode extension for that.
4922 STRLEN sv_utf8_upgrade(SV *sv)
4927 =item sv_utf8_upgrade_flags
4929 Converts the PV of an SV to its UTF-8-encoded form.
4930 Forces the SV to string form if it is not already.
4931 Always sets the SvUTF8 flag to avoid future validity checks even
4932 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
4933 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
4934 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
4936 This is not as a general purpose byte encoding to Unicode interface:
4937 use the Encode extension for that.
4939 STRLEN sv_utf8_upgrade_flags(SV *sv, I32 flags)
4946 A private implementation of the C<SvUVx> macro for compilers which can't
4947 cope with complex macro expressions. Always use the macro instead.
4956 Processes its arguments like C<vsprintf> and appends the formatted output
4957 to an SV. Uses an array of SVs if the C style variable argument list is
4958 missing (NULL). When running with taint checks enabled, indicates via
4959 C<maybe_tainted> if results are untrustworthy (often due to the use of
4962 Usually used via one of its frontends C<sv_catpvf> and C<sv_catpvf_mg>.
4964 void sv_vcatpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
4971 Works like C<vcatpvfn> but copies the text into the SV instead of
4974 Usually used via one of its frontends C<sv_setpvf> and C<sv_setpvf_mg>.
4976 void sv_vsetpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
4984 =head1 Unicode Support
4988 =item bytes_from_utf8
4990 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
4991 Unlike <utf8_to_bytes> but like C<bytes_to_utf8>, returns a pointer to
4992 the newly-created string, and updates C<len> to contain the new
4993 length. Returns the original string if no conversion occurs, C<len>
4994 is unchanged. Do nothing if C<is_utf8> points to 0. Sets C<is_utf8> to
4995 0 if C<s> is converted or contains all 7bit characters.
4997 NOTE: this function is experimental and may change or be
4998 removed without notice.
5000 U8* bytes_from_utf8(U8 *s, STRLEN *len, bool *is_utf8)
5003 Found in file utf8.c
5007 Converts a string C<s> of length C<len> from ASCII into UTF-8 encoding.
5008 Returns a pointer to the newly-created string, and sets C<len> to
5009 reflect the new length.
5011 If you want to convert to UTF-8 from other encodings than ASCII,
5012 see sv_recode_to_utf8().
5014 NOTE: this function is experimental and may change or be
5015 removed without notice.
5017 U8* bytes_to_utf8(U8 *s, STRLEN *len)
5020 Found in file utf8.c
5024 Return true if the strings s1 and s2 differ case-insensitively, false
5025 if not (if they are equal case-insensitively). If u1 is true, the
5026 string s1 is assumed to be in UTF-8-encoded Unicode. If u2 is true,
5027 the string s2 is assumed to be in UTF-8-encoded Unicode. If u1 or u2
5028 are false, the respective string is assumed to be in native 8-bit
5031 If the pe1 and pe2 are non-NULL, the scanning pointers will be copied
5032 in there (they will point at the beginning of the I<next> character).
5033 If the pointers behind pe1 or pe2 are non-NULL, they are the end
5034 pointers beyond which scanning will not continue under any
5035 circustances. If the byte lengths l1 and l2 are non-zero, s1+l1 and
5036 s2+l2 will be used as goal end pointers that will also stop the scan,
5037 and which qualify towards defining a successful match: all the scans
5038 that define an explicit length must reach their goal pointers for
5039 a match to succeed).
5041 For case-insensitiveness, the "casefolding" of Unicode is used
5042 instead of upper/lowercasing both the characters, see
5043 http://www.unicode.org/unicode/reports/tr21/ (Case Mappings).
5045 I32 ibcmp_utf8(const char* a, char **pe1, UV l1, bool u1, const char* b, char **pe2, UV l2, bool u2)
5048 Found in file utf8.c
5052 Tests if some arbitrary number of bytes begins in a valid UTF-8
5053 character. Note that an INVARIANT (i.e. ASCII) character is a valid
5054 UTF-8 character. The actual number of bytes in the UTF-8 character
5055 will be returned if it is valid, otherwise 0.
5057 STRLEN is_utf8_char(U8 *p)
5060 Found in file utf8.c
5062 =item is_utf8_string
5064 Returns true if first C<len> bytes of the given string form a valid
5065 UTF-8 string, false otherwise. Note that 'a valid UTF-8 string' does
5066 not mean 'a string that contains code points above 0x7F encoded in UTF-8'
5067 because a valid ASCII string is a valid UTF-8 string.
5069 bool is_utf8_string(U8 *s, STRLEN len)
5072 Found in file utf8.c
5074 =item is_utf8_string_loc
5076 Like is_ut8_string but store the location of the failure in
5079 bool is_utf8_string_loc(U8 *s, STRLEN len, U8 **p)
5082 Found in file utf8.c
5084 =item pv_uni_display
5086 Build to the scalar dsv a displayable version of the string spv,
5087 length len, the displayable version being at most pvlim bytes long
5088 (if longer, the rest is truncated and "..." will be appended).
5090 The flags argument can have UNI_DISPLAY_ISPRINT set to display
5091 isPRINT()able characters as themselves, UNI_DISPLAY_BACKSLASH
5092 to display the \\[nrfta\\] as the backslashed versions (like '\n')
5093 (UNI_DISPLAY_BACKSLASH is preferred over UNI_DISPLAY_ISPRINT for \\).
5094 UNI_DISPLAY_QQ (and its alias UNI_DISPLAY_REGEX) have both
5095 UNI_DISPLAY_BACKSLASH and UNI_DISPLAY_ISPRINT turned on.
5097 The pointer to the PV of the dsv is returned.
5099 char* pv_uni_display(SV *dsv, U8 *spv, STRLEN len, STRLEN pvlim, UV flags)
5102 Found in file utf8.c
5106 The encoding is assumed to be an Encode object, the PV of the ssv is
5107 assumed to be octets in that encoding and decoding the input starts
5108 from the position which (PV + *offset) pointed to. The dsv will be
5109 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
5110 when the string tstr appears in decoding output or the input ends on
5111 the PV of the ssv. The value which the offset points will be modified
5112 to the last input position on the ssv.
5114 Returns TRUE if the terminator was found, else returns FALSE.
5116 bool sv_cat_decode(SV* dsv, SV *encoding, SV *ssv, int *offset, char* tstr, int tlen)
5121 =item sv_recode_to_utf8
5123 The encoding is assumed to be an Encode object, on entry the PV
5124 of the sv is assumed to be octets in that encoding, and the sv
5125 will be converted into Unicode (and UTF-8).
5127 If the sv already is UTF-8 (or if it is not POK), or if the encoding
5128 is not a reference, nothing is done to the sv. If the encoding is not
5129 an C<Encode::XS> Encoding object, bad things will happen.
5130 (See F<lib/encoding.pm> and L<Encode>).
5132 The PV of the sv is returned.
5134 char* sv_recode_to_utf8(SV* sv, SV *encoding)
5139 =item sv_uni_display
5141 Build to the scalar dsv a displayable version of the scalar sv,
5142 the displayable version being at most pvlim bytes long
5143 (if longer, the rest is truncated and "..." will be appended).
5145 The flags argument is as in pv_uni_display().
5147 The pointer to the PV of the dsv is returned.
5149 char* sv_uni_display(SV *dsv, SV *ssv, STRLEN pvlim, UV flags)
5152 Found in file utf8.c
5156 The "p" contains the pointer to the UTF-8 string encoding
5157 the character that is being converted.
5159 The "ustrp" is a pointer to the character buffer to put the
5160 conversion result to. The "lenp" is a pointer to the length
5163 The "swashp" is a pointer to the swash to use.
5165 Both the special and normal mappings are stored lib/unicore/To/Foo.pl,
5166 and loaded by SWASHGET, using lib/utf8_heavy.pl. The special (usually,
5167 but not always, a multicharacter mapping), is tried first.
5169 The "special" is a string like "utf8::ToSpecLower", which means the
5170 hash %utf8::ToSpecLower. The access to the hash is through
5171 Perl_to_utf8_case().
5173 The "normal" is a string like "ToLower" which means the swash
5176 UV to_utf8_case(U8 *p, U8* ustrp, STRLEN *lenp, SV **swash, char *normal, char *special)
5179 Found in file utf8.c
5183 Convert the UTF-8 encoded character at p to its foldcase version and
5184 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
5185 that the ustrp needs to be at least UTF8_MAXLEN_FOLD+1 bytes since the
5186 foldcase version may be longer than the original character (up to
5189 The first character of the foldcased version is returned
5190 (but note, as explained above, that there may be more.)
5192 UV to_utf8_fold(U8 *p, U8* ustrp, STRLEN *lenp)
5195 Found in file utf8.c
5199 Convert the UTF-8 encoded character at p to its lowercase version and
5200 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
5201 that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the
5202 lowercase version may be longer than the original character (up to two
5205 The first character of the lowercased version is returned
5206 (but note, as explained above, that there may be more.)
5208 UV to_utf8_lower(U8 *p, U8* ustrp, STRLEN *lenp)
5211 Found in file utf8.c
5215 Convert the UTF-8 encoded character at p to its titlecase version and
5216 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
5217 that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the
5218 titlecase version may be longer than the original character (up to two
5221 The first character of the titlecased version is returned
5222 (but note, as explained above, that there may be more.)
5224 UV to_utf8_title(U8 *p, U8* ustrp, STRLEN *lenp)
5227 Found in file utf8.c
5231 Convert the UTF-8 encoded character at p to its uppercase version and
5232 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
5233 that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the
5234 uppercase version may be longer than the original character (up to two
5237 The first character of the uppercased version is returned
5238 (but note, as explained above, that there may be more.)
5240 UV to_utf8_upper(U8 *p, U8* ustrp, STRLEN *lenp)
5243 Found in file utf8.c
5245 =item utf8n_to_uvchr
5247 Returns the native character value of the first character in the string C<s>
5248 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
5249 length, in bytes, of that character.
5251 Allows length and flags to be passed to low level routine.
5253 UV utf8n_to_uvchr(U8 *s, STRLEN curlen, STRLEN* retlen, U32 flags)
5256 Found in file utf8.c
5258 =item utf8n_to_uvuni
5260 Bottom level UTF-8 decode routine.
5261 Returns the unicode code point value of the first character in the string C<s>
5262 which is assumed to be in UTF-8 encoding and no longer than C<curlen>;
5263 C<retlen> will be set to the length, in bytes, of that character.
5265 If C<s> does not point to a well-formed UTF-8 character, the behaviour
5266 is dependent on the value of C<flags>: if it contains UTF8_CHECK_ONLY,
5267 it is assumed that the caller will raise a warning, and this function
5268 will silently just set C<retlen> to C<-1> and return zero. If the
5269 C<flags> does not contain UTF8_CHECK_ONLY, warnings about
5270 malformations will be given, C<retlen> will be set to the expected
5271 length of the UTF-8 character in bytes, and zero will be returned.
5273 The C<flags> can also contain various flags to allow deviations from
5274 the strict UTF-8 encoding (see F<utf8.h>).
5276 Most code should use utf8_to_uvchr() rather than call this directly.
5278 UV utf8n_to_uvuni(U8 *s, STRLEN curlen, STRLEN* retlen, U32 flags)
5281 Found in file utf8.c
5285 Returns the number of UTF-8 characters between the UTF-8 pointers C<a>
5288 WARNING: use only if you *know* that the pointers point inside the
5291 IV utf8_distance(U8 *a, U8 *b)
5294 Found in file utf8.c
5298 Return the UTF-8 pointer C<s> displaced by C<off> characters, either
5299 forward or backward.
5301 WARNING: do not use the following unless you *know* C<off> is within
5302 the UTF-8 data pointed to by C<s> *and* that on entry C<s> is aligned
5303 on the first byte of character or just after the last byte of a character.
5305 U8* utf8_hop(U8 *s, I32 off)
5308 Found in file utf8.c
5312 Return the length of the UTF-8 char encoded string C<s> in characters.
5313 Stops at C<e> (inclusive). If C<e E<lt> s> or if the scan would end
5314 up past C<e>, croaks.
5316 STRLEN utf8_length(U8* s, U8 *e)
5319 Found in file utf8.c
5323 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
5324 Unlike C<bytes_to_utf8>, this over-writes the original string, and
5325 updates len to contain the new length.
5326 Returns zero on failure, setting C<len> to -1.
5328 NOTE: this function is experimental and may change or be
5329 removed without notice.
5331 U8* utf8_to_bytes(U8 *s, STRLEN *len)
5334 Found in file utf8.c
5338 Returns the native character value of the first character in the string C<s>
5339 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
5340 length, in bytes, of that character.
5342 If C<s> does not point to a well-formed UTF-8 character, zero is
5343 returned and retlen is set, if possible, to -1.
5345 UV utf8_to_uvchr(U8 *s, STRLEN* retlen)
5348 Found in file utf8.c
5352 Returns the Unicode code point of the first character in the string C<s>
5353 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
5354 length, in bytes, of that character.
5356 This function should only be used when returned UV is considered
5357 an index into the Unicode semantic tables (e.g. swashes).
5359 If C<s> does not point to a well-formed UTF-8 character, zero is
5360 returned and retlen is set, if possible, to -1.
5362 UV utf8_to_uvuni(U8 *s, STRLEN* retlen)
5365 Found in file utf8.c
5369 Adds the UTF-8 representation of the Native codepoint C<uv> to the end
5370 of the string C<d>; C<d> should be have at least C<UTF8_MAXLEN+1> free
5371 bytes available. The return value is the pointer to the byte after the
5372 end of the new character. In other words,
5374 d = uvchr_to_utf8(d, uv);
5376 is the recommended wide native character-aware way of saying
5380 U8* uvchr_to_utf8(U8 *d, UV uv)
5383 Found in file utf8.c
5385 =item uvuni_to_utf8_flags
5387 Adds the UTF-8 representation of the Unicode codepoint C<uv> to the end
5388 of the string C<d>; C<d> should be have at least C<UTF8_MAXLEN+1> free
5389 bytes available. The return value is the pointer to the byte after the
5390 end of the new character. In other words,
5392 d = uvuni_to_utf8_flags(d, uv, flags);
5396 d = uvuni_to_utf8(d, uv);
5398 (which is equivalent to)
5400 d = uvuni_to_utf8_flags(d, uv, 0);
5402 is the recommended Unicode-aware way of saying
5406 U8* uvuni_to_utf8_flags(U8 *d, UV uv, UV flags)
5409 Found in file utf8.c
5414 =head1 Variables created by C<xsubpp> and C<xsubpp> internal functions
5420 Variable which is setup by C<xsubpp> to indicate the stack base offset,
5421 used by the C<ST>, C<XSprePUSH> and C<XSRETURN> macros. The C<dMARK> macro
5422 must be called prior to setup the C<MARK> variable.
5427 Found in file XSUB.h
5431 Variable which is setup by C<xsubpp> to indicate the
5432 class name for a C++ XS constructor. This is always a C<char*>. See C<THIS>.
5437 Found in file XSUB.h
5441 Sets up the C<ax> variable.
5442 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
5447 Found in file XSUB.h
5451 Sets up the C<items> variable.
5452 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
5457 Found in file XSUB.h
5461 Sets up the C<padoff_du> variable for an XSUB that wishes to use
5467 Found in file XSUB.h
5471 Sets up stack and mark pointers for an XSUB, calling dSP and dMARK.
5472 Sets up the C<ax> and C<items> variables by calling C<dAX> and C<dITEMS>.
5473 This is usually handled automatically by C<xsubpp>.
5478 Found in file XSUB.h
5482 Sets up the C<ix> variable for an XSUB which has aliases. This is usually
5483 handled automatically by C<xsubpp>.
5488 Found in file XSUB.h
5492 Variable which is setup by C<xsubpp> to indicate the number of
5493 items on the stack. See L<perlxs/"Variable-length Parameter Lists">.
5498 Found in file XSUB.h
5502 Variable which is setup by C<xsubpp> to indicate which of an
5503 XSUB's aliases was used to invoke it. See L<perlxs/"The ALIAS: Keyword">.
5508 Found in file XSUB.h
5512 Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
5516 Found in file XSUB.h
5520 Variable which is setup by C<xsubpp> to hold the return value for an
5521 XSUB. This is always the proper type for the XSUB. See
5522 L<perlxs/"The RETVAL Variable">.
5527 Found in file XSUB.h
5531 Used to access elements on the XSUB's stack.
5536 Found in file XSUB.h
5540 Variable which is setup by C<xsubpp> to designate the object in a C++
5541 XSUB. This is always the proper type for the C++ object. See C<CLASS> and
5542 L<perlxs/"Using XS With C++">.
5547 Found in file XSUB.h
5551 The SV* corresponding to the $_ variable. Works even if there
5552 is a lexical $_ in scope.
5555 Found in file XSUB.h
5559 Macro to declare an XSUB and its C parameter list. This is handled by
5563 Found in file XSUB.h
5567 The version identifier for an XS module. This is usually
5568 handled automatically by C<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>.
5571 Found in file XSUB.h
5573 =item XS_VERSION_BOOTCHECK
5575 Macro to verify that a PM module's $VERSION variable matches the XS
5576 module's C<XS_VERSION> variable. This is usually handled automatically by
5577 C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">.
5579 XS_VERSION_BOOTCHECK;
5582 Found in file XSUB.h
5587 =head1 Warning and Dieing
5593 This is the XSUB-writer's interface to Perl's C<die> function.
5594 Normally call this function the same way you call the C C<printf>
5595 function. Calling C<croak> returns control directly to Perl,
5596 sidestepping the normal C order of execution. See C<warn>.
5598 If you want to throw an exception object, assign the object to
5599 C<$@> and then pass C<Nullch> to croak():
5601 errsv = get_sv("@", TRUE);
5602 sv_setsv(errsv, exception_object);
5605 void croak(const char* pat, ...)
5608 Found in file util.c
5612 This is the XSUB-writer's interface to Perl's C<warn> function. Call this
5613 function the same way you call the C C<printf> function. See C<croak>.
5615 void warn(const char* pat, ...)
5618 Found in file util.c
5625 Until May 1997, this document was maintained by Jeff Okamoto
5626 <okamoto@corp.hp.com>. It is now maintained as part of Perl itself.
5628 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
5629 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
5630 Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
5631 Stephen McCamant, and Gurusamy Sarathy.
5633 API Listing originally by Dean Roehrich <roehrich@cray.com>.
5635 Updated to be autogenerated from comments in the source by Benjamin Stuhl.
5639 perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
projects / p5sagit/p5-mst-13.2.git / blob