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 and must be null-terminated. If C<create> is set
887 then the package will be created if it does not already exist. If C<create>
888 is not set and the 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. C<name> should
898 be a valid UTF-8 string. The C<namelen> parameter indicates the length of
899 the C<name>, in bytes. If C<create> is set then the package will be
900 created if it does not already exist. If C<create> is not set and the
901 package does not exist then NULL is returned.
903 HV* gv_stashpvn(const char* name, U32 namelen, I32 create)
910 Returns a pointer to the stash for a specified package, which must be a
911 valid UTF-8 string. See C<gv_stashpv>.
913 HV* gv_stashsv(SV* sv, I32 create)
934 Null character pointer.
937 Found in file handy.h
958 Found in file handy.h
963 =head1 Hash Manipulation Functions
969 Returns the HV of the specified Perl hash. If C<create> is set and the
970 Perl variable does not exist then it will be created. If C<create> is not
971 set and the variable does not exist then NULL is returned.
973 NOTE: the perl_ form of this function is deprecated.
975 HV* get_hv(const char* name, I32 create)
982 This flag, used in the length slot of hash entries and magic structures,
983 specifies the structure contains an C<SV*> pointer where a C<char*> pointer
984 is to be expected. (For information only--not to be used).
991 Returns the computed hash stored in the hash entry.
1000 Returns the actual pointer stored in the key slot of the hash entry. The
1001 pointer may be either C<char*> or C<SV*>, depending on the value of
1002 C<HeKLEN()>. Can be assigned to. The C<HePV()> or C<HeSVKEY()> macros are
1003 usually preferable for finding the value of a key.
1012 If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry
1013 holds an C<SV*> key. Otherwise, holds the actual length of the key. Can
1014 be assigned to. The C<HePV()> macro is usually preferable for finding key
1017 STRLEN HeKLEN(HE* he)
1024 Returns the key slot of the hash entry as a C<char*> value, doing any
1025 necessary dereferencing of possibly C<SV*> keys. The length of the string
1026 is placed in C<len> (this is a macro, so do I<not> use C<&len>). If you do
1027 not care about what the length of the key is, you may use the global
1028 variable C<PL_na>, though this is rather less efficient than using a local
1029 variable. Remember though, that hash keys in perl are free to contain
1030 embedded nulls, so using C<strlen()> or similar is not a good way to find
1031 the length of hash keys. This is very similar to the C<SvPV()> macro
1032 described elsewhere in this document.
1034 char* HePV(HE* he, STRLEN len)
1041 Returns the key as an C<SV*>, or C<Nullsv> if the hash entry does not
1042 contain an C<SV*> key.
1051 Returns the key as an C<SV*>. Will create and return a temporary mortal
1052 C<SV*> if the hash entry contains only a C<char*> key.
1054 SV* HeSVKEY_force(HE* he)
1061 Sets the key to a given C<SV*>, taking care to set the appropriate flags to
1062 indicate the presence of an C<SV*> key, and returns the same
1065 SV* HeSVKEY_set(HE* he, SV* sv)
1072 Returns the value slot (type C<SV*>) stored in the hash entry.
1081 Returns the package name of a stash. See C<SvSTASH>, C<CvSTASH>.
1083 char* HvNAME(HV* stash)
1090 Check that a hash is in an internally consistent state.
1092 void hv_assert(HV* tb)
1099 Clears a hash, making it empty.
1101 void hv_clear(HV* tb)
1106 =item hv_clear_placeholders
1108 Clears any placeholders from a hash. If a restricted hash has any of its keys
1109 marked as readonly and the key is subsequently deleted, the key is not actually
1110 deleted but is marked by assigning it a value of &PL_sv_placeholder. This tags
1111 it so it will be ignored by future operations such as iterating over the hash,
1112 but will still allow the hash to have a value reassigned to the key at some
1113 future point. This function clears any such placeholder keys from the hash.
1114 See Hash::Util::lock_keys() for an example of its use.
1116 void hv_clear_placeholders(HV* hb)
1123 Deletes a key/value pair in the hash. The value SV is removed from the
1124 hash and returned to the caller. The C<klen> is the length of the key.
1125 The C<flags> value will normally be zero; if set to G_DISCARD then NULL
1128 SV* hv_delete(HV* tb, const char* key, I32 klen, I32 flags)
1135 Deletes a key/value pair in the hash. The value SV is removed from the
1136 hash and returned to the caller. The C<flags> value will normally be zero;
1137 if set to G_DISCARD then NULL will be returned. C<hash> can be a valid
1138 precomputed hash value, or 0 to ask for it to be computed.
1140 SV* hv_delete_ent(HV* tb, SV* key, I32 flags, U32 hash)
1147 Returns a boolean indicating whether the specified hash key exists. The
1148 C<klen> is the length of the key.
1150 bool hv_exists(HV* tb, const char* key, I32 klen)
1157 Returns a boolean indicating whether the specified hash key exists. C<hash>
1158 can be a valid precomputed hash value, or 0 to ask for it to be
1161 bool hv_exists_ent(HV* tb, SV* key, U32 hash)
1168 Returns the SV which corresponds to the specified key in the hash. The
1169 C<klen> is the length of the key. If C<lval> is set then the fetch will be
1170 part of a store. Check that the return value is non-null before
1171 dereferencing it to an C<SV*>.
1173 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1174 information on how to use this function on tied hashes.
1176 SV** hv_fetch(HV* tb, const char* key, I32 klen, I32 lval)
1183 Returns the hash entry which corresponds to the specified key in the hash.
1184 C<hash> must be a valid precomputed hash number for the given C<key>, or 0
1185 if you want the function to compute it. IF C<lval> is set then the fetch
1186 will be part of a store. Make sure the return value is non-null before
1187 accessing it. The return value when C<tb> is a tied hash is a pointer to a
1188 static location, so be sure to make a copy of the structure if you need to
1191 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1192 information on how to use this function on tied hashes.
1194 HE* hv_fetch_ent(HV* tb, SV* key, I32 lval, U32 hash)
1201 Prepares a starting point to traverse a hash table. Returns the number of
1202 keys in the hash (i.e. the same as C<HvKEYS(tb)>). The return value is
1203 currently only meaningful for hashes without tie magic.
1205 NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
1206 hash buckets that happen to be in use. If you still need that esoteric
1207 value, you can get it through the macro C<HvFILL(tb)>.
1210 I32 hv_iterinit(HV* tb)
1217 Returns the key from the current position of the hash iterator. See
1220 char* hv_iterkey(HE* entry, I32* retlen)
1227 Returns the key as an C<SV*> from the current position of the hash
1228 iterator. The return value will always be a mortal copy of the key. Also
1231 SV* hv_iterkeysv(HE* entry)
1238 Returns entries from a hash iterator. See C<hv_iterinit>.
1240 You may call C<hv_delete> or C<hv_delete_ent> on the hash entry that the
1241 iterator currently points to, without losing your place or invalidating your
1242 iterator. Note that in this case the current entry is deleted from the hash
1243 with your iterator holding the last reference to it. Your iterator is flagged
1244 to free the entry on the next call to C<hv_iternext>, so you must not discard
1245 your iterator immediately else the entry will leak - call C<hv_iternext> to
1246 trigger the resource deallocation.
1248 HE* hv_iternext(HV* tb)
1255 Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
1258 SV* hv_iternextsv(HV* hv, char** key, I32* retlen)
1263 =item hv_iternext_flags
1265 Returns entries from a hash iterator. See C<hv_iterinit> and C<hv_iternext>.
1266 The C<flags> value will normally be zero; if HV_ITERNEXT_WANTPLACEHOLDERS is
1267 set the placeholders keys (for restricted hashes) will be returned in addition
1268 to normal keys. By default placeholders are automatically skipped over.
1269 Currently a placeholder is implemented with a value that is
1270 C<&Perl_sv_placeholder>. Note that the implementation of placeholders and
1271 restricted hashes may change, and the implementation currently is
1272 insufficiently abstracted for any change to be tidy.
1274 NOTE: this function is experimental and may change or be
1275 removed without notice.
1277 HE* hv_iternext_flags(HV* tb, I32 flags)
1284 Returns the value from the current position of the hash iterator. See
1287 SV* hv_iterval(HV* tb, HE* entry)
1294 Adds magic to a hash. See C<sv_magic>.
1296 void hv_magic(HV* hv, GV* gv, int how)
1303 Evaluates the hash in scalar context and returns the result. Handles magic when the hash is tied.
1305 SV* hv_scalar(HV* hv)
1312 Stores an SV in a hash. The hash key is specified as C<key> and C<klen> is
1313 the length of the key. The C<hash> parameter is the precomputed hash
1314 value; if it is zero then Perl will compute it. The return value will be
1315 NULL if the operation failed or if the value did not need to be actually
1316 stored within the hash (as in the case of tied hashes). Otherwise it can
1317 be dereferenced to get the original C<SV*>. Note that the caller is
1318 responsible for suitably incrementing the reference count of C<val> before
1319 the call, and decrementing it if the function returned NULL. Effectively
1320 a successful hv_store takes ownership of one reference to C<val>. This is
1321 usually what you want; a newly created SV has a reference count of one, so
1322 if all your code does is create SVs then store them in a hash, hv_store
1323 will own the only reference to the new SV, and your code doesn't need to do
1324 anything further to tidy up. hv_store is not implemented as a call to
1325 hv_store_ent, and does not create a temporary SV for the key, so if your
1326 key data is not already in SV form then use hv_store in preference to
1329 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1330 information on how to use this function on tied hashes.
1332 SV** hv_store(HV* tb, const char* key, I32 klen, SV* val, U32 hash)
1339 Stores C<val> in a hash. The hash key is specified as C<key>. The C<hash>
1340 parameter is the precomputed hash value; if it is zero then Perl will
1341 compute it. The return value is the new hash entry so created. It will be
1342 NULL if the operation failed or if the value did not need to be actually
1343 stored within the hash (as in the case of tied hashes). Otherwise the
1344 contents of the return value can be accessed using the C<He?> macros
1345 described here. Note that the caller is responsible for suitably
1346 incrementing the reference count of C<val> before the call, and
1347 decrementing it if the function returned NULL. Effectively a successful
1348 hv_store_ent takes ownership of one reference to C<val>. This is
1349 usually what you want; a newly created SV has a reference count of one, so
1350 if all your code does is create SVs then store them in a hash, hv_store
1351 will own the only reference to the new SV, and your code doesn't need to do
1352 anything further to tidy up. Note that hv_store_ent only reads the C<key>;
1353 unlike C<val> it does not take ownership of it, so maintaining the correct
1354 reference count on C<key> is entirely the caller's responsibility. hv_store
1355 is not implemented as a call to hv_store_ent, and does not create a temporary
1356 SV for the key, so if your key data is not already in SV form then use
1357 hv_store in preference to hv_store_ent.
1359 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1360 information on how to use this function on tied hashes.
1362 HE* hv_store_ent(HV* tb, SV* key, SV* val, U32 hash)
1371 void hv_undef(HV* tb)
1378 Creates a new HV. The reference count is set to 1.
1388 =head1 Magical Functions
1394 Clear something magical that the SV represents. See C<sv_magic>.
1396 int mg_clear(SV* sv)
1403 Copies the magic from one SV to another. See C<sv_magic>.
1405 int mg_copy(SV* sv, SV* nsv, const char* key, I32 klen)
1412 Finds the magic pointer for type matching the SV. See C<sv_magic>.
1414 MAGIC* mg_find(SV* sv, int type)
1421 Free any magic storage used by the SV. See C<sv_magic>.
1430 Do magic after a value is retrieved from the SV. See C<sv_magic>.
1439 Report on the SV's length. See C<sv_magic>.
1441 U32 mg_length(SV* sv)
1448 Turns on the magical status of an SV. See C<sv_magic>.
1450 void mg_magical(SV* sv)
1457 Do magic after a value is assigned to the SV. See C<sv_magic>.
1466 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
1467 argument more than once.
1469 void SvGETMAGIC(SV* sv)
1476 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
1486 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
1487 argument more than once.
1489 void SvSETMAGIC(SV* sv)
1496 Like C<SvSetSV>, but does any set magic required afterwards.
1498 void SvSetMagicSV(SV* dsb, SV* ssv)
1503 =item SvSetMagicSV_nosteal
1505 Like C<SvSetSV_nosteal>, but does any set magic required afterwards.
1507 void SvSetMagicSV_nosteal(SV* dsv, SV* ssv)
1514 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
1517 void SvSetSV(SV* dsb, SV* ssv)
1522 =item SvSetSV_nosteal
1524 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
1525 ssv. May evaluate arguments more than once.
1527 void SvSetSV_nosteal(SV* dsv, SV* ssv)
1534 Arranges for sv to be shared between threads if a suitable module
1537 void SvSHARE(SV* sv)
1544 Releases a mutual exclusion lock on sv if a suitable module
1547 void SvUNLOCK(SV* sv)
1555 =head1 Memory Management
1561 The XSUB-writer's interface to the C C<memcpy> function. The C<src> is the
1562 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1563 the type. May fail on overlapping copies. See also C<Move>.
1565 void Copy(void* src, void* dest, int nitems, type)
1568 Found in file handy.h
1572 Like C<Copy> but returns dest. Useful for encouraging compilers to tail-call
1575 void * CopyD(void* src, void* dest, int nitems, type)
1578 Found in file handy.h
1582 The XSUB-writer's interface to the C C<memmove> function. The C<src> is the
1583 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1584 the type. Can do overlapping moves. See also C<Copy>.
1586 void Move(void* src, void* dest, int nitems, type)
1589 Found in file handy.h
1593 Like C<Move> but returns dest. Useful for encouraging compilers to tail-call
1596 void * MoveD(void* src, void* dest, int nitems, type)
1599 Found in file handy.h
1603 The XSUB-writer's interface to the C C<malloc> function.
1605 void New(int id, void* ptr, int nitems, type)
1608 Found in file handy.h
1612 The XSUB-writer's interface to the C C<malloc> function, with
1615 void Newc(int id, void* ptr, int nitems, type, cast)
1618 Found in file handy.h
1622 The XSUB-writer's interface to the C C<malloc> function. The allocated
1623 memory is zeroed with C<memzero>.
1625 void Newz(int id, void* ptr, int nitems, type)
1628 Found in file handy.h
1632 Fill up memory with a pattern (byte 0xAB over and over again) that
1633 hopefully catches attempts to access uninitialized memory.
1635 void Poison(void* dest, int nitems, type)
1638 Found in file handy.h
1642 The XSUB-writer's interface to the C C<realloc> function.
1644 void Renew(void* ptr, int nitems, type)
1647 Found in file handy.h
1651 The XSUB-writer's interface to the C C<realloc> function, with
1654 void Renewc(void* ptr, int nitems, type, cast)
1657 Found in file handy.h
1661 The XSUB-writer's interface to the C C<free> function.
1663 void Safefree(void* ptr)
1666 Found in file handy.h
1670 Perl's version of C<strdup()>. Returns a pointer to a newly allocated
1671 string which is a duplicate of C<pv>. The size of the string is
1672 determined by C<strlen()>. The memory allocated for the new string can
1673 be freed with the C<Safefree()> function.
1675 char* savepv(const char* pv)
1678 Found in file util.c
1682 Perl's version of what C<strndup()> would be if it existed. Returns a
1683 pointer to a newly allocated string which is a duplicate of the first
1684 C<len> bytes from C<pv>. The memory allocated for the new string can be
1685 freed with the C<Safefree()> function.
1687 char* savepvn(const char* pv, I32 len)
1690 Found in file util.c
1694 A version of C<savepv()> which allocates the duplicate string in memory
1695 which is shared between threads.
1697 char* savesharedpv(const char* pv)
1700 Found in file util.c
1704 This is an architecture-independent macro to copy one structure to another.
1706 void StructCopy(type src, type dest, type)
1709 Found in file handy.h
1713 The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the
1714 destination, C<nitems> is the number of items, and C<type> is the type.
1716 void Zero(void* dest, int nitems, type)
1719 Found in file handy.h
1723 Like C<Zero> but returns dest. Useful for encouraging compilers to tail-call
1726 void * ZeroD(void* dest, int nitems, type)
1729 Found in file handy.h
1734 =head1 Miscellaneous Functions
1740 Analyses the string in order to make fast searches on it using fbm_instr()
1741 -- the Boyer-Moore algorithm.
1743 void fbm_compile(SV* sv, U32 flags)
1746 Found in file util.c
1750 Returns the location of the SV in the string delimited by C<str> and
1751 C<strend>. It returns C<Nullch> if the string can't be found. The C<sv>
1752 does not have to be fbm_compiled, but the search will not be as fast
1755 char* fbm_instr(unsigned char* big, unsigned char* bigend, SV* littlesv, U32 flags)
1758 Found in file util.c
1762 Takes a sprintf-style format pattern and conventional
1763 (non-SV) arguments and returns the formatted string.
1765 (char *) Perl_form(pTHX_ const char* pat, ...)
1767 can be used any place a string (char *) is required:
1769 char * s = Perl_form("%d.%d",major,minor);
1771 Uses a single private buffer so if you want to format several strings you
1772 must explicitly copy the earlier strings away (and free the copies when you
1775 char* form(const char* pat, ...)
1778 Found in file util.c
1782 Fill the sv with current working directory
1784 int getcwd_sv(SV* sv)
1787 Found in file util.c
1791 Returns a new version object based on the passed in SV:
1793 SV *sv = new_version(SV *ver);
1795 Does not alter the passed in ver SV. See "upg_version" if you
1796 want to upgrade the SV.
1798 SV* new_version(SV *ver)
1801 Found in file util.c
1805 Returns a pointer to the next character after the parsed
1806 version string, as well as upgrading the passed in SV to
1809 Function must be called with an already existing SV like
1812 s = scan_version(s,SV *sv, bool qv);
1814 Performs some preprocessing to the string to ensure that
1815 it has the correct characteristics of a version. Flags the
1816 object if it contains an underscore (which denotes this
1817 is a alpha version). The boolean qv denotes that the version
1818 should be interpreted as if it had multiple decimals, even if
1821 char* scan_version(char *vstr, SV *sv, bool qv)
1824 Found in file util.c
1828 Test two strings to see if they are equal. Returns true or false.
1830 bool strEQ(char* s1, char* s2)
1833 Found in file handy.h
1837 Test two strings to see if the first, C<s1>, is greater than or equal to
1838 the second, C<s2>. Returns true or false.
1840 bool strGE(char* s1, char* s2)
1843 Found in file handy.h
1847 Test two strings to see if the first, C<s1>, is greater than the second,
1848 C<s2>. Returns true or false.
1850 bool strGT(char* s1, char* s2)
1853 Found in file handy.h
1857 Test two strings to see if the first, C<s1>, is less than or equal to the
1858 second, C<s2>. Returns true or false.
1860 bool strLE(char* s1, char* s2)
1863 Found in file handy.h
1867 Test two strings to see if the first, C<s1>, is less than the second,
1868 C<s2>. Returns true or false.
1870 bool strLT(char* s1, char* s2)
1873 Found in file handy.h
1877 Test two strings to see if they are different. Returns true or
1880 bool strNE(char* s1, char* s2)
1883 Found in file handy.h
1887 Test two strings to see if they are equal. The C<len> parameter indicates
1888 the number of bytes to compare. Returns true or false. (A wrapper for
1891 bool strnEQ(char* s1, char* s2, STRLEN len)
1894 Found in file handy.h
1898 Test two strings to see if they are different. The C<len> parameter
1899 indicates the number of bytes to compare. Returns true or false. (A
1900 wrapper for C<strncmp>).
1902 bool strnNE(char* s1, char* s2, STRLEN len)
1905 Found in file handy.h
1909 Dummy routine which "locks" an SV when there is no locking module present.
1910 Exists to avoid test for a NULL function pointer and because it could potentially warn under
1911 some level of strict-ness.
1913 void sv_nolocking(SV *)
1916 Found in file util.c
1920 Dummy routine which "shares" an SV when there is no sharing module present.
1921 Exists to avoid test for a NULL function pointer and because it could potentially warn under
1922 some level of strict-ness.
1924 void sv_nosharing(SV *)
1927 Found in file util.c
1929 =item sv_nounlocking
1931 Dummy routine which "unlocks" an SV when there is no locking module present.
1932 Exists to avoid test for a NULL function pointer and because it could potentially warn under
1933 some level of strict-ness.
1935 void sv_nounlocking(SV *)
1938 Found in file util.c
1942 In-place upgrade of the supplied SV to a version object.
1944 SV *sv = upg_version(SV *sv);
1946 Returns a pointer to the upgraded SV.
1948 SV* upg_version(SV *ver)
1951 Found in file util.c
1955 Version object aware cmp. Both operands must already have been
1956 converted into version objects.
1958 int vcmp(SV *lvs, SV *rvs)
1961 Found in file util.c
1965 Accepts a version object and returns the normalized string
1966 representation. Call like:
1970 NOTE: you can pass either the object directly or the SV
1971 contained within the RV.
1976 Found in file util.c
1980 Accepts a version object and returns the normalized floating
1981 point representation. Call like:
1985 NOTE: you can pass either the object directly or the SV
1986 contained within the RV.
1991 Found in file util.c
1995 In order to maintain maximum compatibility with earlier versions
1996 of Perl, this function will return either the floating point
1997 notation or the multiple dotted notation, depending on whether
1998 the original version contained 1 or more dots, respectively
2000 SV* vstringify(SV *vs)
2003 Found in file util.c
2008 =head1 Numeric functions
2014 converts a string representing a binary number to numeric form.
2016 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2017 conversion flags, and I<result> should be NULL or a pointer to an NV.
2018 The scan stops at the end of the string, or the first invalid character.
2019 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2020 invalid character will also trigger a warning.
2021 On return I<*len> is set to the length of the scanned string,
2022 and I<*flags> gives output flags.
2024 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2025 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_bin>
2026 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2027 and writes the value to I<*result> (or the value is discarded if I<result>
2030 The binary number may optionally be prefixed with "0b" or "b" unless
2031 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
2032 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the binary
2033 number may use '_' characters to separate digits.
2035 UV grok_bin(char* start, STRLEN* len, I32* flags, NV *result)
2038 Found in file numeric.c
2042 converts a string representing a hex number to numeric form.
2044 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2045 conversion flags, and I<result> should be NULL or a pointer to an NV.
2046 The scan stops at the end of the string, or the first invalid character.
2047 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2048 invalid character will also trigger a warning.
2049 On return I<*len> is set to the length of the scanned string,
2050 and I<*flags> gives output flags.
2052 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2053 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_hex>
2054 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2055 and writes the value to I<*result> (or the value is discarded if I<result>
2058 The hex number may optionally be prefixed with "0x" or "x" unless
2059 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
2060 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the hex
2061 number may use '_' characters to separate digits.
2063 UV grok_hex(char* start, STRLEN* len, I32* flags, NV *result)
2066 Found in file numeric.c
2070 Recognise (or not) a number. The type of the number is returned
2071 (0 if unrecognised), otherwise it is a bit-ORed combination of
2072 IS_NUMBER_IN_UV, IS_NUMBER_GREATER_THAN_UV_MAX, IS_NUMBER_NOT_INT,
2073 IS_NUMBER_NEG, IS_NUMBER_INFINITY, IS_NUMBER_NAN (defined in perl.h).
2075 If the value of the number can fit an in UV, it is returned in the *valuep
2076 IS_NUMBER_IN_UV will be set to indicate that *valuep is valid, IS_NUMBER_IN_UV
2077 will never be set unless *valuep is valid, but *valuep may have been assigned
2078 to during processing even though IS_NUMBER_IN_UV is not set on return.
2079 If valuep is NULL, IS_NUMBER_IN_UV will be set for the same cases as when
2080 valuep is non-NULL, but no actual assignment (or SEGV) will occur.
2082 IS_NUMBER_NOT_INT will be set with IS_NUMBER_IN_UV if trailing decimals were
2083 seen (in which case *valuep gives the true value truncated to an integer), and
2084 IS_NUMBER_NEG if the number is negative (in which case *valuep holds the
2085 absolute value). IS_NUMBER_IN_UV is not set if e notation was used or the
2086 number is larger than a UV.
2088 int grok_number(const char *pv, STRLEN len, UV *valuep)
2091 Found in file numeric.c
2093 =item grok_numeric_radix
2095 Scan and skip for a numeric decimal separator (radix).
2097 bool grok_numeric_radix(const char **sp, const char *send)
2100 Found in file numeric.c
2104 converts a string representing an octal number to numeric form.
2106 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2107 conversion flags, and I<result> should be NULL or a pointer to an NV.
2108 The scan stops at the end of the string, or the first invalid character.
2109 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2110 invalid character will also trigger a warning.
2111 On return I<*len> is set to the length of the scanned string,
2112 and I<*flags> gives output flags.
2114 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2115 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_oct>
2116 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2117 and writes the value to I<*result> (or the value is discarded if I<result>
2120 If C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the octal
2121 number may use '_' characters to separate digits.
2123 UV grok_oct(char* start, STRLEN* len, I32* flags, NV *result)
2126 Found in file numeric.c
2130 For backwards compatibility. Use C<grok_bin> instead.
2132 NV scan_bin(char* start, STRLEN len, STRLEN* retlen)
2135 Found in file numeric.c
2139 For backwards compatibility. Use C<grok_hex> instead.
2141 NV scan_hex(char* start, STRLEN len, STRLEN* retlen)
2144 Found in file numeric.c
2148 For backwards compatibility. Use C<grok_oct> instead.
2150 NV scan_oct(char* start, STRLEN len, STRLEN* retlen)
2153 Found in file numeric.c
2158 =head1 Optree Manipulation Functions
2164 If C<cv> is a constant sub eligible for inlining. returns the constant
2165 value returned by the sub. Otherwise, returns NULL.
2167 Constant subs can be created with C<newCONSTSUB> or as described in
2168 L<perlsub/"Constant Functions">.
2170 SV* cv_const_sv(CV* cv)
2177 Creates a constant sub equivalent to Perl C<sub FOO () { 123 }> which is
2178 eligible for inlining at compile-time.
2180 CV* newCONSTSUB(HV* stash, char* name, SV* sv)
2187 Used by C<xsubpp> to hook up XSUBs as Perl subs.
2195 =head1 Pad Data Structures
2201 Get the value at offset po in the current pad.
2202 Use macro PAD_SV instead of calling this function directly.
2204 SV* pad_sv(PADOFFSET po)
2212 =head1 Stack Manipulation Macros
2218 Declare a stack marker variable, C<mark>, for the XSUB. See C<MARK> and
2228 Saves the original stack mark for the XSUB. See C<ORIGMARK>.
2237 Declares a local copy of perl's stack pointer for the XSUB, available via
2238 the C<SP> macro. See C<SP>.
2247 Used to extend the argument stack for an XSUB's return values. Once
2248 used, guarantees that there is room for at least C<nitems> to be pushed
2251 void EXTEND(SP, int nitems)
2258 Stack marker variable for the XSUB. See C<dMARK>.
2265 Push an integer onto the stack. The stack must have room for this element.
2266 Handles 'set' magic. Does not use C<TARG>. See also C<PUSHi>, C<mXPUSHi>
2276 Push a double onto the stack. The stack must have room for this element.
2277 Handles 'set' magic. Does not use C<TARG>. See also C<PUSHn>, C<mXPUSHn>
2287 Push a string onto the stack. The stack must have room for this element.
2288 The C<len> indicates the length of the string. Handles 'set' magic. Does
2289 not use C<TARG>. See also C<PUSHp>, C<mXPUSHp> and C<XPUSHp>.
2291 void mPUSHp(char* str, STRLEN len)
2298 Push an unsigned integer onto the stack. The stack must have room for this
2299 element. Handles 'set' magic. Does not use C<TARG>. See also C<PUSHu>,
2300 C<mXPUSHu> and C<XPUSHu>.
2309 Push an integer onto the stack, extending the stack if necessary. Handles
2310 'set' magic. Does not use C<TARG>. See also C<XPUSHi>, C<mPUSHi> and
2320 Push a double onto the stack, extending the stack if necessary. Handles
2321 'set' magic. Does not use C<TARG>. See also C<XPUSHn>, C<mPUSHn> and
2331 Push a string onto the stack, extending the stack if necessary. The C<len>
2332 indicates the length of the string. Handles 'set' magic. Does not use
2333 C<TARG>. See also C<XPUSHp>, C<mPUSHp> and C<PUSHp>.
2335 void mXPUSHp(char* str, STRLEN len)
2342 Push an unsigned integer onto the stack, extending the stack if necessary.
2343 Handles 'set' magic. Does not use C<TARG>. See also C<XPUSHu>, C<mPUSHu>
2353 The original stack mark for the XSUB. See C<dORIGMARK>.
2360 Pops an integer off the stack.
2369 Pops a long off the stack.
2378 Pops a double off the stack.
2387 Pops a string off the stack. Deprecated. New code should provide
2388 a STRLEN n_a and use POPpx.
2397 Pops a string off the stack which must consist of bytes i.e. characters < 256.
2398 Requires a variable STRLEN n_a in scope.
2407 Pops a string off the stack.
2408 Requires a variable STRLEN n_a in scope.
2417 Pops an SV off the stack.
2426 Push an integer onto the stack. The stack must have room for this element.
2427 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
2428 called to declare it. Do not call multiple C<TARG>-oriented macros to
2429 return lists from XSUB's - see C<mPUSHi> instead. See also C<XPUSHi> and
2439 Opening bracket for arguments on a callback. See C<PUTBACK> and
2449 Push a new mortal SV onto the stack. The stack must have room for this
2450 element. Does not handle 'set' magic. Does not use C<TARG>. See also
2451 C<PUSHs>, C<XPUSHmortal> and C<XPUSHs>.
2460 Push a double onto the stack. The stack must have room for this element.
2461 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
2462 called to declare it. Do not call multiple C<TARG>-oriented macros to
2463 return lists from XSUB's - see C<mPUSHn> instead. See also C<XPUSHn> and
2473 Push a string onto the stack. The stack must have room for this element.
2474 The C<len> indicates the length of the string. Handles 'set' magic. Uses
2475 C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to declare it. Do not
2476 call multiple C<TARG>-oriented macros to return lists from XSUB's - see
2477 C<mPUSHp> instead. See also C<XPUSHp> and C<mXPUSHp>.
2479 void PUSHp(char* str, STRLEN len)
2486 Push an SV onto the stack. The stack must have room for this element.
2487 Does not handle 'set' magic. Does not use C<TARG>. See also C<PUSHmortal>,
2488 C<XPUSHs> and C<XPUSHmortal>.
2497 Push an unsigned integer onto the stack. The stack must have room for this
2498 element. Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG>
2499 should be called to declare it. Do not call multiple C<TARG>-oriented
2500 macros to return lists from XSUB's - see C<mPUSHu> instead. See also
2501 C<XPUSHu> and C<mXPUSHu>.
2510 Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
2511 See C<PUSHMARK> and L<perlcall> for other uses.
2520 Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and
2528 Refetch the stack pointer. Used after a callback. See L<perlcall>.
2537 Push an integer onto the stack, extending the stack if necessary. Handles
2538 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
2539 declare it. Do not call multiple C<TARG>-oriented macros to return lists
2540 from XSUB's - see C<mXPUSHi> instead. See also C<PUSHi> and C<mPUSHi>.
2549 Push a new mortal SV onto the stack, extending the stack if necessary. Does
2550 not handle 'set' magic. Does not use C<TARG>. See also C<XPUSHs>,
2551 C<PUSHmortal> and C<PUSHs>.
2560 Push a double onto the stack, extending the stack if necessary. Handles
2561 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
2562 declare it. Do not call multiple C<TARG>-oriented macros to return lists
2563 from XSUB's - see C<mXPUSHn> instead. See also C<PUSHn> and C<mPUSHn>.
2572 Push a string onto the stack, extending the stack if necessary. The C<len>
2573 indicates the length of the string. Handles 'set' magic. Uses C<TARG>, so
2574 C<dTARGET> or C<dXSTARG> should be called to declare it. Do not call
2575 multiple C<TARG>-oriented macros to return lists from XSUB's - see
2576 C<mXPUSHp> instead. See also C<PUSHp> and C<mPUSHp>.
2578 void XPUSHp(char* str, STRLEN len)
2585 Push an SV onto the stack, extending the stack if necessary. Does not
2586 handle 'set' magic. Does not use C<TARG>. See also C<XPUSHmortal>,
2587 C<PUSHs> and C<PUSHmortal>.
2596 Push an unsigned integer onto the stack, extending the stack if necessary.
2597 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
2598 called to declare it. Do not call multiple C<TARG>-oriented macros to
2599 return lists from XSUB's - see C<mXPUSHu> instead. See also C<PUSHu> and
2609 Return from XSUB, indicating number of items on the stack. This is usually
2610 handled by C<xsubpp>.
2612 void XSRETURN(int nitems)
2615 Found in file XSUB.h
2617 =item XSRETURN_EMPTY
2619 Return an empty list from an XSUB immediately.
2624 Found in file XSUB.h
2628 Return an integer from an XSUB immediately. Uses C<XST_mIV>.
2630 void XSRETURN_IV(IV iv)
2633 Found in file XSUB.h
2637 Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
2642 Found in file XSUB.h
2646 Return a double from an XSUB immediately. Uses C<XST_mNV>.
2648 void XSRETURN_NV(NV nv)
2651 Found in file XSUB.h
2655 Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
2657 void XSRETURN_PV(char* str)
2660 Found in file XSUB.h
2662 =item XSRETURN_UNDEF
2664 Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
2669 Found in file XSUB.h
2673 Return an integer from an XSUB immediately. Uses C<XST_mUV>.
2675 void XSRETURN_UV(IV uv)
2678 Found in file XSUB.h
2682 Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
2687 Found in file XSUB.h
2691 Place an integer into the specified position C<pos> on the stack. The
2692 value is stored in a new mortal SV.
2694 void XST_mIV(int pos, IV iv)
2697 Found in file XSUB.h
2701 Place C<&PL_sv_no> into the specified position C<pos> on the
2704 void XST_mNO(int pos)
2707 Found in file XSUB.h
2711 Place a double into the specified position C<pos> on the stack. The value
2712 is stored in a new mortal SV.
2714 void XST_mNV(int pos, NV nv)
2717 Found in file XSUB.h
2721 Place a copy of a string into the specified position C<pos> on the stack.
2722 The value is stored in a new mortal SV.
2724 void XST_mPV(int pos, char* str)
2727 Found in file XSUB.h
2731 Place C<&PL_sv_undef> into the specified position C<pos> on the
2734 void XST_mUNDEF(int pos)
2737 Found in file XSUB.h
2741 Place C<&PL_sv_yes> into the specified position C<pos> on the
2744 void XST_mYES(int pos)
2747 Found in file XSUB.h
2758 An enum of flags for Perl types. These are found in the file B<sv.h>
2759 in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
2766 Integer type flag for scalars. See C<svtype>.
2773 Double type flag for scalars. See C<svtype>.
2780 Pointer type flag for scalars. See C<svtype>.
2787 Type flag for arrays. See C<svtype>.
2794 Type flag for code refs. See C<svtype>.
2801 Type flag for hashes. See C<svtype>.
2808 Type flag for blessed scalars. See C<svtype>.
2816 =head1 SV Manipulation Functions
2822 Returns the SV of the specified Perl scalar. If C<create> is set and the
2823 Perl variable does not exist then it will be created. If C<create> is not
2824 set and the variable does not exist then NULL is returned.
2826 NOTE: the perl_ form of this function is deprecated.
2828 SV* get_sv(const char* name, I32 create)
2831 Found in file perl.c
2833 =item looks_like_number
2835 Test if the content of an SV looks like a number (or is a number).
2836 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
2837 non-numeric warning), even if your atof() doesn't grok them.
2839 I32 looks_like_number(SV* sv)
2846 Creates an RV wrapper for an SV. The reference count for the original SV is
2849 SV* newRV_inc(SV* sv)
2856 Creates an RV wrapper for an SV. The reference count for the original
2857 SV is B<not> incremented.
2859 SV* newRV_noinc(SV *sv)
2866 Creates a new SV. A non-zero C<len> parameter indicates the number of
2867 bytes of preallocated string space the SV should have. An extra byte for a
2868 tailing NUL is also reserved. (SvPOK is not set for the SV even if string
2869 space is allocated.) The reference count for the new SV is set to 1.
2870 C<id> is an integer id between 0 and 1299 (used to identify leaks).
2872 SV* NEWSV(int id, STRLEN len)
2875 Found in file handy.h
2879 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
2880 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
2883 SV* newSV(STRLEN len)
2890 Creates a new SV and copies an integer into it. The reference count for the
2900 Creates a new SV and copies a floating point value into it.
2901 The reference count for the SV is set to 1.
2910 Creates a new SV and copies a string into it. The reference count for the
2911 SV is set to 1. If C<len> is zero, Perl will compute the length using
2912 strlen(). For efficiency, consider using C<newSVpvn> instead.
2914 SV* newSVpv(const char* s, STRLEN len)
2921 Creates a new SV and initializes it with the string formatted like
2924 SV* newSVpvf(const char* pat, ...)
2931 Creates a new SV and copies a string into it. The reference count for the
2932 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
2933 string. You are responsible for ensuring that the source string is at least
2934 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
2936 SV* newSVpvn(const char* s, STRLEN len)
2941 =item newSVpvn_share
2943 Creates a new SV with its SvPVX pointing to a shared string in the string
2944 table. If the string does not already exist in the table, it is created
2945 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
2946 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
2947 otherwise the hash is computed. The idea here is that as the string table
2948 is used for shared hash keys these strings will have SvPVX == HeKEY and
2949 hash lookup will avoid string compare.
2951 SV* newSVpvn_share(const char* s, I32 len, U32 hash)
2958 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
2959 it will be upgraded to one. If C<classname> is non-null then the new SV will
2960 be blessed in the specified package. The new SV is returned and its
2961 reference count is 1.
2963 SV* newSVrv(SV* rv, const char* classname)
2970 Creates a new SV which is an exact duplicate of the original SV.
2973 SV* newSVsv(SV* old)
2980 Creates a new SV and copies an unsigned integer into it.
2981 The reference count for the SV is set to 1.
2990 Returns the length of the string which is in the SV. See C<SvLEN>.
2992 STRLEN SvCUR(SV* sv)
2999 Set the length of the string which is in the SV. See C<SvCUR>.
3001 void SvCUR_set(SV* sv, STRLEN len)
3008 Returns a pointer to the last character in the string which is in the SV.
3009 See C<SvCUR>. Access the character as *(SvEND(sv)).
3018 Expands the character buffer in the SV so that it has room for the
3019 indicated number of bytes (remember to reserve space for an extra trailing
3020 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
3021 Returns a pointer to the character buffer.
3023 char * SvGROW(SV* sv, STRLEN len)
3030 Returns a boolean indicating whether the SV contains an integer.
3039 Returns a boolean indicating whether the SV contains an integer. Checks
3040 the B<private> setting. Use C<SvIOK>.
3049 Returns a boolean indicating whether the SV contains a signed integer.
3051 bool SvIOK_notUV(SV* sv)
3058 Unsets the IV status of an SV.
3060 void SvIOK_off(SV* sv)
3067 Tells an SV that it is an integer.
3069 void SvIOK_on(SV* sv)
3076 Tells an SV that it is an integer and disables all other OK bits.
3078 void SvIOK_only(SV* sv)
3085 Tells and SV that it is an unsigned integer and disables all other OK bits.
3087 void SvIOK_only_UV(SV* sv)
3094 Returns a boolean indicating whether the SV contains an unsigned integer.
3096 bool SvIOK_UV(SV* sv)
3103 Returns a boolean indicating whether the SV is Copy-On-Write. (either shared
3104 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
3107 bool SvIsCOW(SV* sv)
3112 =item SvIsCOW_shared_hash
3114 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
3117 bool SvIsCOW_shared_hash(SV* sv)
3124 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
3125 version which guarantees to evaluate sv only once.
3134 Coerces the given SV to an integer and returns it. Guarantees to evaluate
3135 sv only once. Use the more efficient C<SvIV> otherwise.
3144 Returns the raw value in the SV's IV slot, without checks or conversions.
3145 Only use when you are sure SvIOK is true. See also C<SvIV()>.
3154 Like C<SvIV> but doesn't process magic.
3156 IV SvIV_nomg(SV* sv)
3163 Returns the size of the string buffer in the SV, not including any part
3164 attributable to C<SvOOK>. See C<SvCUR>.
3166 STRLEN SvLEN(SV* sv)
3173 Returns a boolean indicating whether the SV contains a number, integer or
3183 Returns a boolean indicating whether the SV contains a number, integer or
3184 double. Checks the B<private> setting. Use C<SvNIOK>.
3186 bool SvNIOKp(SV* sv)
3193 Unsets the NV/IV status of an SV.
3195 void SvNIOK_off(SV* sv)
3202 Returns a boolean indicating whether the SV contains a double.
3211 Returns a boolean indicating whether the SV contains a double. Checks the
3212 B<private> setting. Use C<SvNOK>.
3221 Unsets the NV status of an SV.
3223 void SvNOK_off(SV* sv)
3230 Tells an SV that it is a double.
3232 void SvNOK_on(SV* sv)
3239 Tells an SV that it is a double and disables all other OK bits.
3241 void SvNOK_only(SV* sv)
3248 Coerce the given SV to a double and return it. See C<SvNVx> for a version
3249 which guarantees to evaluate sv only once.
3258 Returns the raw value in the SV's NV slot, without checks or conversions.
3259 Only use when you are sure SvNOK is true. See also C<SvNV()>.
3268 Coerces the given SV to a double and returns it. Guarantees to evaluate
3269 sv only once. Use the more efficient C<SvNV> otherwise.
3278 Returns a boolean indicating whether the value is an SV. It also tells
3279 whether the value is defined or not.
3288 Returns a boolean indicating whether the SvIVX is a valid offset value for
3289 the SvPVX. This hack is used internally to speed up removal of characters
3290 from the beginning of a SvPV. When SvOOK is true, then the start of the
3291 allocated string buffer is really (SvPVX - SvIVX).
3300 Returns a boolean indicating whether the SV contains a character
3310 Returns a boolean indicating whether the SV contains a character string.
3311 Checks the B<private> setting. Use C<SvPOK>.
3320 Unsets the PV status of an SV.
3322 void SvPOK_off(SV* sv)
3329 Tells an SV that it is a string.
3331 void SvPOK_on(SV* sv)
3338 Tells an SV that it is a string and disables all other OK bits.
3339 Will also turn off the UTF-8 status.
3341 void SvPOK_only(SV* sv)
3346 =item SvPOK_only_UTF8
3348 Tells an SV that it is a string and disables all other OK bits,
3349 and leaves the UTF-8 status as it was.
3351 void SvPOK_only_UTF8(SV* sv)
3358 Returns a pointer to the string in the SV, or a stringified form of
3359 the SV if the SV does not contain a string. The SV may cache the
3360 stringified version becoming C<SvPOK>. Handles 'get' magic. See also
3361 C<SvPVx> for a version which guarantees to evaluate sv only once.
3363 char* SvPV(SV* sv, STRLEN len)
3370 Like C<SvPV>, but converts sv to byte representation first if necessary.
3372 char* SvPVbyte(SV* sv, STRLEN len)
3379 Like C<SvPV>, but converts sv to byte representation first if necessary.
3380 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
3383 char* SvPVbytex(SV* sv, STRLEN len)
3388 =item SvPVbytex_force
3390 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
3391 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
3394 char* SvPVbytex_force(SV* sv, STRLEN len)
3399 =item SvPVbyte_force
3401 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
3403 char* SvPVbyte_force(SV* sv, STRLEN len)
3408 =item SvPVbyte_nolen
3410 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
3412 char* SvPVbyte_nolen(SV* sv)
3419 Like C<SvPV>, but converts sv to utf8 first if necessary.
3421 char* SvPVutf8(SV* sv, STRLEN len)
3428 Like C<SvPV>, but converts sv to utf8 first if necessary.
3429 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
3432 char* SvPVutf8x(SV* sv, STRLEN len)
3437 =item SvPVutf8x_force
3439 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
3440 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
3443 char* SvPVutf8x_force(SV* sv, STRLEN len)
3448 =item SvPVutf8_force
3450 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
3452 char* SvPVutf8_force(SV* sv, STRLEN len)
3457 =item SvPVutf8_nolen
3459 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
3461 char* SvPVutf8_nolen(SV* sv)
3468 A version of C<SvPV> which guarantees to evaluate sv only once.
3470 char* SvPVx(SV* sv, STRLEN len)
3477 Returns a pointer to the physical string in the SV. The SV must contain a
3487 Like C<SvPV> but will force the SV into containing just a string
3488 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
3491 char* SvPV_force(SV* sv, STRLEN len)
3496 =item SvPV_force_nomg
3498 Like C<SvPV> but will force the SV into containing just a string
3499 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
3500 directly. Doesn't process magic.
3502 char* SvPV_force_nomg(SV* sv, STRLEN len)
3509 Returns a pointer to the string in the SV, or a stringified form of
3510 the SV if the SV does not contain a string. The SV may cache the
3511 stringified form becoming C<SvPOK>. Handles 'get' magic.
3513 char* SvPV_nolen(SV* sv)
3520 Like C<SvPV> but doesn't process magic.
3522 char* SvPV_nomg(SV* sv, STRLEN len)
3529 Returns the value of the object's reference count.
3531 U32 SvREFCNT(SV* sv)
3538 Decrements the reference count of the given SV.
3540 void SvREFCNT_dec(SV* sv)
3547 Increments the reference count of the given SV.
3549 SV* SvREFCNT_inc(SV* sv)
3556 Tests if the SV is an RV.
3565 Unsets the RV status of an SV.
3567 void SvROK_off(SV* sv)
3574 Tells an SV that it is an RV.
3576 void SvROK_on(SV* sv)
3583 Dereferences an RV to return the SV.
3592 Returns the stash of the SV.
3601 Taints an SV if tainting is enabled.
3603 void SvTAINT(SV* sv)
3610 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
3613 bool SvTAINTED(SV* sv)
3620 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
3621 some of Perl's fundamental security features. XS module authors should not
3622 use this function unless they fully understand all the implications of
3623 unconditionally untainting the value. Untainting should be done in the
3624 standard perl fashion, via a carefully crafted regexp, rather than directly
3625 untainting variables.
3627 void SvTAINTED_off(SV* sv)
3634 Marks an SV as tainted if tainting is enabled.
3636 void SvTAINTED_on(SV* sv)
3643 Returns a boolean indicating whether Perl would evaluate the SV as true or
3644 false, defined or undefined. Does not handle 'get' magic.
3653 Returns the type of the SV. See C<svtype>.
3655 svtype SvTYPE(SV* sv)
3662 Returns a boolean indicating whether the SV contains an unsigned integer.
3671 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
3672 perform the upgrade if necessary. See C<svtype>.
3674 void SvUPGRADE(SV* sv, svtype type)
3681 Returns a boolean indicating whether the SV contains UTF-8 encoded data.
3690 Unsets the UTF-8 status of an SV.
3692 void SvUTF8_off(SV *sv)
3699 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
3700 Do not use frivolously.
3702 void SvUTF8_on(SV *sv)
3709 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
3710 for a version which guarantees to evaluate sv only once.
3719 Returns the raw value in the SV's UV slot, without checks or conversions.
3720 Only use when you are sure SvIOK is true. See also C<SvUV()>.
3729 Coerces the given SV to an unsigned integer and returns it. Guarantees to
3730 evaluate sv only once. Use the more efficient C<SvUV> otherwise.
3739 Like C<SvUV> but doesn't process magic.
3741 UV SvUV_nomg(SV* sv)
3748 Returns a boolean indicating whether the SV contains a v-string.
3757 This function is only called on magical items, and is only used by
3758 sv_true() or its macro equivalent.
3760 bool sv_2bool(SV* sv)
3767 Using various gambits, try to get a CV from an SV; in addition, try if
3768 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
3770 CV* sv_2cv(SV* sv, HV** st, GV** gvp, I32 lref)
3777 Using various gambits, try to get an IO from an SV: the IO slot if its a
3778 GV; or the recursive result if we're an RV; or the IO slot of the symbol
3779 named after the PV if we're a string.
3788 Return the integer value of an SV, doing any necessary string
3789 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
3790 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
3792 IV sv_2iv_flags(SV* sv, I32 flags)
3799 Marks an existing SV as mortal. The SV will be destroyed "soon", either
3800 by an explicit call to FREETMPS, or by an implicit call at places such as
3801 statement boundaries. SvTEMP() is turned on which means that the SV's
3802 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
3803 and C<sv_mortalcopy>.
3805 SV* sv_2mortal(SV* sv)
3812 Return the num value of an SV, doing any necessary string or integer
3813 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
3823 Return a pointer to the byte-encoded representation of the SV, and set *lp
3824 to its length. May cause the SV to be downgraded from UTF-8 as a
3827 Usually accessed via the C<SvPVbyte> macro.
3829 char* sv_2pvbyte(SV* sv, STRLEN* lp)
3834 =item sv_2pvbyte_nolen
3836 Return a pointer to the byte-encoded representation of the SV.
3837 May cause the SV to be downgraded from UTF-8 as a side-effect.
3839 Usually accessed via the C<SvPVbyte_nolen> macro.
3841 char* sv_2pvbyte_nolen(SV* sv)
3848 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3849 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
3851 Usually accessed via the C<SvPVutf8> macro.
3853 char* sv_2pvutf8(SV* sv, STRLEN* lp)
3858 =item sv_2pvutf8_nolen
3860 Return a pointer to the UTF-8-encoded representation of the SV.
3861 May cause the SV to be upgraded to UTF-8 as a side-effect.
3863 Usually accessed via the C<SvPVutf8_nolen> macro.
3865 char* sv_2pvutf8_nolen(SV* sv)
3872 Returns a pointer to the string value of an SV, and sets *lp to its length.
3873 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
3875 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
3876 usually end up here too.
3878 char* sv_2pv_flags(SV* sv, STRLEN* lp, I32 flags)
3885 Like C<sv_2pv()>, but doesn't return the length too. You should usually
3886 use the macro wrapper C<SvPV_nolen(sv)> instead.
3887 char* sv_2pv_nolen(SV* sv)
3894 Return the unsigned integer value of an SV, doing any necessary string
3895 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
3896 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
3898 UV sv_2uv_flags(SV* sv, I32 flags)
3905 Remove any string offset. You should normally use the C<SvOOK_off> macro
3908 int sv_backoff(SV* sv)
3915 Blesses an SV into a specified package. The SV must be an RV. The package
3916 must be designated by its stash (see C<gv_stashpv()>). The reference count
3917 of the SV is unaffected.
3919 SV* sv_bless(SV* sv, HV* stash)
3926 Concatenates the string onto the end of the string which is in the SV.
3927 If the SV has the UTF-8 status set, then the bytes appended should be
3928 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
3930 void sv_catpv(SV* sv, const char* ptr)
3937 Processes its arguments like C<sprintf> and appends the formatted
3938 output to an SV. If the appended data contains "wide" characters
3939 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
3940 and characters >255 formatted with %c), the original SV might get
3941 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
3944 void sv_catpvf(SV* sv, const char* pat, ...)
3951 Like C<sv_catpvf>, but also handles 'set' magic.
3953 void sv_catpvf_mg(SV *sv, const char* pat, ...)
3960 Concatenates the string onto the end of the string which is in the SV. The
3961 C<len> indicates number of bytes to copy. If the SV has the UTF-8
3962 status set, then the bytes appended should be valid UTF-8.
3963 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
3965 void sv_catpvn(SV* sv, const char* ptr, STRLEN len)
3970 =item sv_catpvn_flags
3972 Concatenates the string onto the end of the string which is in the SV. The
3973 C<len> indicates number of bytes to copy. If the SV has the UTF-8
3974 status set, then the bytes appended should be valid UTF-8.
3975 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
3976 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
3977 in terms of this function.
3979 void sv_catpvn_flags(SV* sv, const char* ptr, STRLEN len, I32 flags)
3986 Like C<sv_catpvn>, but also handles 'set' magic.
3988 void sv_catpvn_mg(SV *sv, const char *ptr, STRLEN len)
3993 =item sv_catpvn_nomg
3995 Like C<sv_catpvn> but doesn't process magic.
3997 void sv_catpvn_nomg(SV* sv, const char* ptr, STRLEN len)
4004 Like C<sv_catpv>, but also handles 'set' magic.
4006 void sv_catpv_mg(SV *sv, const char *ptr)
4013 Concatenates the string from SV C<ssv> onto the end of the string in
4014 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4015 not 'set' magic. See C<sv_catsv_mg>.
4017 void sv_catsv(SV* dsv, SV* ssv)
4022 =item sv_catsv_flags
4024 Concatenates the string from SV C<ssv> onto the end of the string in
4025 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4026 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4027 and C<sv_catsv_nomg> are implemented in terms of this function.
4029 void sv_catsv_flags(SV* dsv, SV* ssv, I32 flags)
4036 Like C<sv_catsv>, but also handles 'set' magic.
4038 void sv_catsv_mg(SV *dstr, SV *sstr)
4045 Like C<sv_catsv> but doesn't process magic.
4047 void sv_catsv_nomg(SV* dsv, SV* ssv)
4054 Efficient removal of characters from the beginning of the string buffer.
4055 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4056 the string buffer. The C<ptr> becomes the first character of the adjusted
4057 string. Uses the "OOK hack".
4058 Beware: after this function returns, C<ptr> and SvPVX(sv) may no longer
4059 refer to the same chunk of data.
4061 void sv_chop(SV* sv, char* ptr)
4068 Clear an SV: call any destructors, free up any memory used by the body,
4069 and free the body itself. The SV's head is I<not> freed, although
4070 its type is set to all 1's so that it won't inadvertently be assumed
4071 to be live during global destruction etc.
4072 This function should only be called when REFCNT is zero. Most of the time
4073 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
4076 void sv_clear(SV* sv)
4083 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
4084 string in C<sv1> is less than, equal to, or greater than the string in
4085 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
4086 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
4088 I32 sv_cmp(SV* sv1, SV* sv2)
4095 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
4096 'use bytes' aware, handles get magic, and will coerce its args to strings
4097 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
4099 I32 sv_cmp_locale(SV* sv1, SV* sv2)
4106 Add Collate Transform magic to an SV if it doesn't already have it.
4108 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
4109 scalar data of the variable, but transformed to such a format that a normal
4110 memory comparison can be used to compare the data according to the locale
4113 char* sv_collxfrm(SV* sv, STRLEN* nxp)
4120 Copies a stringified representation of the source SV into the
4121 destination SV. Automatically performs any necessary mg_get and
4122 coercion of numeric values into strings. Guaranteed to preserve
4123 UTF-8 flag even from overloaded objects. Similar in nature to
4124 sv_2pv[_flags] but operates directly on an SV instead of just the
4125 string. Mostly uses sv_2pv_flags to do its work, except when that
4126 would lose the UTF-8'ness of the PV.
4128 void sv_copypv(SV* dsv, SV* ssv)
4135 Auto-decrement of the value in the SV, doing string to numeric conversion
4136 if necessary. Handles 'get' magic.
4143 =item sv_derived_from
4145 Returns a boolean indicating whether the SV is derived from the specified
4146 class. This is the function that implements C<UNIVERSAL::isa>. It works
4147 for class names as well as for objects.
4149 bool sv_derived_from(SV* sv, const char* name)
4152 Found in file universal.c
4156 Returns a boolean indicating whether the strings in the two SVs are
4157 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
4158 coerce its args to strings if necessary.
4160 I32 sv_eq(SV* sv1, SV* sv2)
4165 =item sv_force_normal
4167 Undo various types of fakery on an SV: if the PV is a shared string, make
4168 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4169 an xpvmg. See also C<sv_force_normal_flags>.
4171 void sv_force_normal(SV *sv)
4176 =item sv_force_normal_flags
4178 Undo various types of fakery on an SV: if the PV is a shared string, make
4179 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4180 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4181 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4182 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4183 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4184 set to some other value.) In addition, the C<flags> parameter gets passed to
4185 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4186 with flags set to 0.
4188 void sv_force_normal_flags(SV *sv, U32 flags)
4195 Decrement an SV's reference count, and if it drops to zero, call
4196 C<sv_clear> to invoke destructors and free up any memory used by
4197 the body; finally, deallocate the SV's head itself.
4198 Normally called via a wrapper macro C<SvREFCNT_dec>.
4200 void sv_free(SV* sv)
4207 Get a line from the filehandle and store it into the SV, optionally
4208 appending to the currently-stored string.
4210 char* sv_gets(SV* sv, PerlIO* fp, I32 append)
4217 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
4218 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
4219 Use the C<SvGROW> wrapper instead.
4221 char* sv_grow(SV* sv, STRLEN newlen)
4228 Auto-increment of the value in the SV, doing string to numeric conversion
4229 if necessary. Handles 'get' magic.
4238 Inserts a string at the specified offset/length within the SV. Similar to
4239 the Perl substr() function.
4241 void sv_insert(SV* bigsv, STRLEN offset, STRLEN len, char* little, STRLEN littlelen)
4248 Returns a boolean indicating whether the SV is blessed into the specified
4249 class. This does not check for subtypes; use C<sv_derived_from> to verify
4250 an inheritance relationship.
4252 int sv_isa(SV* sv, const char* name)
4259 Returns a boolean indicating whether the SV is an RV pointing to a blessed
4260 object. If the SV is not an RV, or if the object is not blessed, then this
4263 int sv_isobject(SV* sv)
4270 A private implementation of the C<SvIVx> macro for compilers which can't
4271 cope with complex macro expressions. Always use the macro instead.
4280 Returns the length of the string in the SV. Handles magic and type
4281 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
4283 STRLEN sv_len(SV* sv)
4290 Returns the number of characters in the string in an SV, counting wide
4291 UTF-8 bytes as a single character. Handles magic and type coercion.
4293 STRLEN sv_len_utf8(SV* sv)
4300 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4301 then adds a new magic item of type C<how> to the head of the magic list.
4303 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4304 handling of the C<name> and C<namlen> arguments.
4306 void sv_magic(SV* sv, SV* obj, int how, const char* name, I32 namlen)
4313 Adds magic to an SV, upgrading it if necessary. Applies the
4314 supplied vtable and returns a pointer to the magic added.
4316 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4317 In particular, you can add magic to SvREADONLY SVs, and add more than
4318 one instance of the same 'how'.
4320 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4321 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4322 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4323 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4325 (This is now used as a subroutine by C<sv_magic>.)
4327 MAGIC * sv_magicext(SV* sv, SV* obj, int how, MGVTBL *vtbl, const char* name, I32 namlen)
4334 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
4335 The new SV is marked as mortal. It will be destroyed "soon", either by an
4336 explicit call to FREETMPS, or by an implicit call at places such as
4337 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
4339 SV* sv_mortalcopy(SV* oldsv)
4346 Creates a new null SV which is mortal. The reference count of the SV is
4347 set to 1. It will be destroyed "soon", either by an explicit call to
4348 FREETMPS, or by an implicit call at places such as statement boundaries.
4349 See also C<sv_mortalcopy> and C<sv_2mortal>.
4358 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
4361 SV* sv_newref(SV* sv)
4368 A private implementation of the C<SvNVx> macro for compilers which can't
4369 cope with complex macro expressions. Always use the macro instead.
4378 Converts the value pointed to by offsetp from a count of bytes from the
4379 start of the string, to a count of the equivalent number of UTF-8 chars.
4380 Handles magic and type coercion.
4382 void sv_pos_b2u(SV* sv, I32* offsetp)
4389 Converts the value pointed to by offsetp from a count of UTF-8 chars from
4390 the start of the string, to a count of the equivalent number of bytes; if
4391 lenp is non-zero, it does the same to lenp, but this time starting from
4392 the offset, rather than from the start of the string. Handles magic and
4395 void sv_pos_u2b(SV* sv, I32* offsetp, I32* lenp)
4402 Use the C<SvPV_nolen> macro instead
4411 Use C<SvPVbyte_nolen> instead.
4413 char* sv_pvbyte(SV *sv)
4420 A private implementation of the C<SvPVbyte> macro for compilers
4421 which can't cope with complex macro expressions. Always use the macro
4424 char* sv_pvbyten(SV *sv, STRLEN *len)
4429 =item sv_pvbyten_force
4431 A private implementation of the C<SvPVbytex_force> macro for compilers
4432 which can't cope with complex macro expressions. Always use the macro
4435 char* sv_pvbyten_force(SV* sv, STRLEN* lp)
4442 A private implementation of the C<SvPV> macro for compilers which can't
4443 cope with complex macro expressions. Always use the macro instead.
4445 char* sv_pvn(SV *sv, STRLEN *len)
4452 Get a sensible string out of the SV somehow.
4453 A private implementation of the C<SvPV_force> macro for compilers which
4454 can't cope with complex macro expressions. Always use the macro instead.
4456 char* sv_pvn_force(SV* sv, STRLEN* lp)
4461 =item sv_pvn_force_flags
4463 Get a sensible string out of the SV somehow.
4464 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
4465 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
4466 implemented in terms of this function.
4467 You normally want to use the various wrapper macros instead: see
4468 C<SvPV_force> and C<SvPV_force_nomg>
4470 char* sv_pvn_force_flags(SV* sv, STRLEN* lp, I32 flags)
4477 Use the C<SvPVutf8_nolen> macro instead
4479 char* sv_pvutf8(SV *sv)
4486 A private implementation of the C<SvPVutf8> macro for compilers
4487 which can't cope with complex macro expressions. Always use the macro
4490 char* sv_pvutf8n(SV *sv, STRLEN *len)
4495 =item sv_pvutf8n_force
4497 A private implementation of the C<SvPVutf8_force> macro for compilers
4498 which can't cope with complex macro expressions. Always use the macro
4501 char* sv_pvutf8n_force(SV* sv, STRLEN* lp)
4508 Returns a string describing what the SV is a reference to.
4510 char* sv_reftype(SV* sv, int ob)
4517 Make the first argument a copy of the second, then delete the original.
4518 The target SV physically takes over ownership of the body of the source SV
4519 and inherits its flags; however, the target keeps any magic it owns,
4520 and any magic in the source is discarded.
4521 Note that this is a rather specialist SV copying operation; most of the
4522 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4524 void sv_replace(SV* sv, SV* nsv)
4529 =item sv_report_used
4531 Dump the contents of all SVs not yet freed. (Debugging aid).
4533 void sv_report_used()
4540 Underlying implementation for the C<reset> Perl function.
4541 Note that the perl-level function is vaguely deprecated.
4543 void sv_reset(char* s, HV* stash)
4550 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4551 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4552 push a back-reference to this RV onto the array of backreferences
4553 associated with that magic.
4555 SV* sv_rvweaken(SV *sv)
4562 Copies an integer into the given SV, upgrading first if necessary.
4563 Does not handle 'set' magic. See also C<sv_setiv_mg>.
4565 void sv_setiv(SV* sv, IV num)
4572 Like C<sv_setiv>, but also handles 'set' magic.
4574 void sv_setiv_mg(SV *sv, IV i)
4581 Copies a double into the given SV, upgrading first if necessary.
4582 Does not handle 'set' magic. See also C<sv_setnv_mg>.
4584 void sv_setnv(SV* sv, NV num)
4591 Like C<sv_setnv>, but also handles 'set' magic.
4593 void sv_setnv_mg(SV *sv, NV num)
4600 Copies a string into an SV. The string must be null-terminated. Does not
4601 handle 'set' magic. See C<sv_setpv_mg>.
4603 void sv_setpv(SV* sv, const char* ptr)
4610 Works like C<sv_catpvf> but copies the text into the SV instead of
4611 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
4613 void sv_setpvf(SV* sv, const char* pat, ...)
4620 Like C<sv_setpvf>, but also handles 'set' magic.
4622 void sv_setpvf_mg(SV *sv, const char* pat, ...)
4629 Copies an integer into the given SV, also updating its string value.
4630 Does not handle 'set' magic. See C<sv_setpviv_mg>.
4632 void sv_setpviv(SV* sv, IV num)
4639 Like C<sv_setpviv>, but also handles 'set' magic.
4641 void sv_setpviv_mg(SV *sv, IV iv)
4648 Copies a string into an SV. The C<len> parameter indicates the number of
4649 bytes to be copied. If the C<ptr> argument is NULL the SV will become
4650 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4652 void sv_setpvn(SV* sv, const char* ptr, STRLEN len)
4659 Like C<sv_setpvn>, but also handles 'set' magic.
4661 void sv_setpvn_mg(SV *sv, const char *ptr, STRLEN len)
4668 Like C<sv_setpv>, but also handles 'set' magic.
4670 void sv_setpv_mg(SV *sv, const char *ptr)
4677 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
4678 argument will be upgraded to an RV. That RV will be modified to point to
4679 the new SV. The C<classname> argument indicates the package for the
4680 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4681 will have a reference count of 1, and the RV will be returned.
4683 SV* sv_setref_iv(SV* rv, const char* classname, IV iv)
4690 Copies a double into a new SV, optionally blessing the SV. The C<rv>
4691 argument will be upgraded to an RV. That RV will be modified to point to
4692 the new SV. The C<classname> argument indicates the package for the
4693 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4694 will have a reference count of 1, and the RV will be returned.
4696 SV* sv_setref_nv(SV* rv, const char* classname, NV nv)
4703 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
4704 argument will be upgraded to an RV. That RV will be modified to point to
4705 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
4706 into the SV. The C<classname> argument indicates the package for the
4707 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4708 will have a reference count of 1, and the RV will be returned.
4710 Do not use with other Perl types such as HV, AV, SV, CV, because those
4711 objects will become corrupted by the pointer copy process.
4713 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
4715 SV* sv_setref_pv(SV* rv, const char* classname, void* pv)
4722 Copies a string into a new SV, optionally blessing the SV. The length of the
4723 string must be specified with C<n>. The C<rv> argument will be upgraded to
4724 an RV. That RV will be modified to point to the new SV. The C<classname>
4725 argument indicates the package for the blessing. Set C<classname> to
4726 C<Nullch> to avoid the blessing. The new SV will have a reference count
4727 of 1, and the RV will be returned.
4729 Note that C<sv_setref_pv> copies the pointer while this copies the string.
4731 SV* sv_setref_pvn(SV* rv, const char* classname, char* pv, STRLEN n)
4738 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
4739 argument will be upgraded to an RV. That RV will be modified to point to
4740 the new SV. The C<classname> argument indicates the package for the
4741 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4742 will have a reference count of 1, and the RV will be returned.
4744 SV* sv_setref_uv(SV* rv, const char* classname, UV uv)
4751 Copies the contents of the source SV C<ssv> into the destination SV
4752 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4753 function if the source SV needs to be reused. Does not handle 'set' magic.
4754 Loosely speaking, it performs a copy-by-value, obliterating any previous
4755 content of the destination.
4757 You probably want to use one of the assortment of wrappers, such as
4758 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4759 C<SvSetMagicSV_nosteal>.
4761 void sv_setsv(SV* dsv, SV* ssv)
4766 =item sv_setsv_flags
4768 Copies the contents of the source SV C<ssv> into the destination SV
4769 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4770 function if the source SV needs to be reused. Does not handle 'set' magic.
4771 Loosely speaking, it performs a copy-by-value, obliterating any previous
4772 content of the destination.
4773 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
4774 C<ssv> if appropriate, else not. If the C<flags> parameter has the
4775 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
4776 and C<sv_setsv_nomg> are implemented in terms of this function.
4778 You probably want to use one of the assortment of wrappers, such as
4779 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4780 C<SvSetMagicSV_nosteal>.
4782 This is the primary function for copying scalars, and most other
4783 copy-ish functions and macros use this underneath.
4785 void sv_setsv_flags(SV* dsv, SV* ssv, I32 flags)
4792 Like C<sv_setsv>, but also handles 'set' magic.
4794 void sv_setsv_mg(SV *dstr, SV *sstr)
4801 Like C<sv_setsv> but doesn't process magic.
4803 void sv_setsv_nomg(SV* dsv, SV* ssv)
4810 Copies an unsigned integer into the given SV, upgrading first if necessary.
4811 Does not handle 'set' magic. See also C<sv_setuv_mg>.
4813 void sv_setuv(SV* sv, UV num)
4820 Like C<sv_setuv>, but also handles 'set' magic.
4822 void sv_setuv_mg(SV *sv, UV u)
4829 Taint an SV. Use C<SvTAINTED_on> instead.
4830 void sv_taint(SV* sv)
4837 Test an SV for taintedness. Use C<SvTAINTED> instead.
4838 bool sv_tainted(SV* sv)
4845 Returns true if the SV has a true value by Perl's rules.
4846 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
4847 instead use an in-line version.
4856 Removes all magic of type C<type> from an SV.
4858 int sv_unmagic(SV* sv, int type)
4865 Unsets the RV status of the SV, and decrements the reference count of
4866 whatever was being referenced by the RV. This can almost be thought of
4867 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
4868 being zero. See C<SvROK_off>.
4870 void sv_unref(SV* sv)
4875 =item sv_unref_flags
4877 Unsets the RV status of the SV, and decrements the reference count of
4878 whatever was being referenced by the RV. This can almost be thought of
4879 as a reversal of C<newSVrv>. The C<cflags> argument can contain
4880 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
4881 (otherwise the decrementing is conditional on the reference count being
4882 different from one or the reference being a readonly SV).
4885 void sv_unref_flags(SV* sv, U32 flags)
4892 Untaint an SV. Use C<SvTAINTED_off> instead.
4893 void sv_untaint(SV* sv)
4900 Upgrade an SV to a more complex form. Generally adds a new body type to the
4901 SV, then copies across as much information as possible from the old body.
4902 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
4904 bool sv_upgrade(SV* sv, U32 mt)
4911 Tells an SV to use C<ptr> to find its string value. Normally the string is
4912 stored inside the SV but sv_usepvn allows the SV to use an outside string.
4913 The C<ptr> should point to memory that was allocated by C<malloc>. The
4914 string length, C<len>, must be supplied. This function will realloc the
4915 memory pointed to by C<ptr>, so that pointer should not be freed or used by
4916 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
4917 See C<sv_usepvn_mg>.
4919 void sv_usepvn(SV* sv, char* ptr, STRLEN len)
4926 Like C<sv_usepvn>, but also handles 'set' magic.
4928 void sv_usepvn_mg(SV *sv, char *ptr, STRLEN len)
4933 =item sv_utf8_decode
4935 If the PV of the SV is an octet sequence in UTF-8
4936 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
4937 so that it looks like a character. If the PV contains only single-byte
4938 characters, the C<SvUTF8> flag stays being off.
4939 Scans PV for validity and returns false if the PV is invalid UTF-8.
4941 NOTE: this function is experimental and may change or be
4942 removed without notice.
4944 bool sv_utf8_decode(SV *sv)
4949 =item sv_utf8_downgrade
4951 Attempts to convert the PV of an SV from characters to bytes.
4952 If the PV contains a character beyond byte, this conversion will fail;
4953 in this case, either returns false or, if C<fail_ok> is not
4956 This is not as a general purpose Unicode to byte encoding interface:
4957 use the Encode extension for that.
4959 NOTE: this function is experimental and may change or be
4960 removed without notice.
4962 bool sv_utf8_downgrade(SV *sv, bool fail_ok)
4967 =item sv_utf8_encode
4969 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
4970 flag off so that it looks like octets again.
4972 void sv_utf8_encode(SV *sv)
4977 =item sv_utf8_upgrade
4979 Converts the PV of an SV to its UTF-8-encoded form.
4980 Forces the SV to string form if it is not already.
4981 Always sets the SvUTF8 flag to avoid future validity checks even
4982 if all the bytes have hibit clear.
4984 This is not as a general purpose byte encoding to Unicode interface:
4985 use the Encode extension for that.
4987 STRLEN sv_utf8_upgrade(SV *sv)
4992 =item sv_utf8_upgrade_flags
4994 Converts the PV of an SV to its UTF-8-encoded form.
4995 Forces the SV to string form if it is not already.
4996 Always sets the SvUTF8 flag to avoid future validity checks even
4997 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
4998 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
4999 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
5001 This is not as a general purpose byte encoding to Unicode interface:
5002 use the Encode extension for that.
5004 STRLEN sv_utf8_upgrade_flags(SV *sv, I32 flags)
5011 A private implementation of the C<SvUVx> macro for compilers which can't
5012 cope with complex macro expressions. Always use the macro instead.
5021 Processes its arguments like C<vsprintf> and appends the formatted output
5022 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
5024 Usually used via its frontend C<sv_catpvf>.
5026 void sv_vcatpvf(SV* sv, const char* pat, va_list* args)
5033 Processes its arguments like C<vsprintf> and appends the formatted output
5034 to an SV. Uses an array of SVs if the C style variable argument list is
5035 missing (NULL). When running with taint checks enabled, indicates via
5036 C<maybe_tainted> if results are untrustworthy (often due to the use of
5039 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
5041 void sv_vcatpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
5048 Like C<sv_vcatpvf>, but also handles 'set' magic.
5050 Usually used via its frontend C<sv_catpvf_mg>.
5052 void sv_vcatpvf_mg(SV* sv, const char* pat, va_list* args)
5059 Works like C<sv_vcatpvf> but copies the text into the SV instead of
5060 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
5062 Usually used via its frontend C<sv_setpvf>.
5064 void sv_vsetpvf(SV* sv, const char* pat, va_list* args)
5071 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
5074 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
5076 void sv_vsetpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
5083 Like C<sv_vsetpvf>, but also handles 'set' magic.
5085 Usually used via its frontend C<sv_setpvf_mg>.
5087 void sv_vsetpvf_mg(SV* sv, const char* pat, va_list* args)
5095 =head1 Unicode Support
5099 =item bytes_from_utf8
5101 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
5102 Unlike <utf8_to_bytes> but like C<bytes_to_utf8>, returns a pointer to
5103 the newly-created string, and updates C<len> to contain the new
5104 length. Returns the original string if no conversion occurs, C<len>
5105 is unchanged. Do nothing if C<is_utf8> points to 0. Sets C<is_utf8> to
5106 0 if C<s> is converted or contains all 7bit characters.
5108 NOTE: this function is experimental and may change or be
5109 removed without notice.
5111 U8* bytes_from_utf8(U8 *s, STRLEN *len, bool *is_utf8)
5114 Found in file utf8.c
5118 Converts a string C<s> of length C<len> from ASCII into UTF-8 encoding.
5119 Returns a pointer to the newly-created string, and sets C<len> to
5120 reflect the new length.
5122 If you want to convert to UTF-8 from other encodings than ASCII,
5123 see sv_recode_to_utf8().
5125 NOTE: this function is experimental and may change or be
5126 removed without notice.
5128 U8* bytes_to_utf8(U8 *s, STRLEN *len)
5131 Found in file utf8.c
5135 Return true if the strings s1 and s2 differ case-insensitively, false
5136 if not (if they are equal case-insensitively). If u1 is true, the
5137 string s1 is assumed to be in UTF-8-encoded Unicode. If u2 is true,
5138 the string s2 is assumed to be in UTF-8-encoded Unicode. If u1 or u2
5139 are false, the respective string is assumed to be in native 8-bit
5142 If the pe1 and pe2 are non-NULL, the scanning pointers will be copied
5143 in there (they will point at the beginning of the I<next> character).
5144 If the pointers behind pe1 or pe2 are non-NULL, they are the end
5145 pointers beyond which scanning will not continue under any
5146 circumstances. If the byte lengths l1 and l2 are non-zero, s1+l1 and
5147 s2+l2 will be used as goal end pointers that will also stop the scan,
5148 and which qualify towards defining a successful match: all the scans
5149 that define an explicit length must reach their goal pointers for
5150 a match to succeed).
5152 For case-insensitiveness, the "casefolding" of Unicode is used
5153 instead of upper/lowercasing both the characters, see
5154 http://www.unicode.org/unicode/reports/tr21/ (Case Mappings).
5156 I32 ibcmp_utf8(const char* a, char **pe1, UV l1, bool u1, const char* b, char **pe2, UV l2, bool u2)
5159 Found in file utf8.c
5163 Tests if some arbitrary number of bytes begins in a valid UTF-8
5164 character. Note that an INVARIANT (i.e. ASCII) character is a valid
5165 UTF-8 character. The actual number of bytes in the UTF-8 character
5166 will be returned if it is valid, otherwise 0.
5168 STRLEN is_utf8_char(U8 *p)
5171 Found in file utf8.c
5173 =item is_utf8_string
5175 Returns true if first C<len> bytes of the given string form a valid
5176 UTF-8 string, false otherwise. Note that 'a valid UTF-8 string' does
5177 not mean 'a string that contains code points above 0x7F encoded in UTF-8'
5178 because a valid ASCII string is a valid UTF-8 string.
5180 bool is_utf8_string(U8 *s, STRLEN len)
5183 Found in file utf8.c
5185 =item is_utf8_string_loc
5187 Like is_ut8_string but store the location of the failure in
5190 bool is_utf8_string_loc(U8 *s, STRLEN len, U8 **p)
5193 Found in file utf8.c
5195 =item pv_uni_display
5197 Build to the scalar dsv a displayable version of the string spv,
5198 length len, the displayable version being at most pvlim bytes long
5199 (if longer, the rest is truncated and "..." will be appended).
5201 The flags argument can have UNI_DISPLAY_ISPRINT set to display
5202 isPRINT()able characters as themselves, UNI_DISPLAY_BACKSLASH
5203 to display the \\[nrfta\\] as the backslashed versions (like '\n')
5204 (UNI_DISPLAY_BACKSLASH is preferred over UNI_DISPLAY_ISPRINT for \\).
5205 UNI_DISPLAY_QQ (and its alias UNI_DISPLAY_REGEX) have both
5206 UNI_DISPLAY_BACKSLASH and UNI_DISPLAY_ISPRINT turned on.
5208 The pointer to the PV of the dsv is returned.
5210 char* pv_uni_display(SV *dsv, U8 *spv, STRLEN len, STRLEN pvlim, UV flags)
5213 Found in file utf8.c
5217 The encoding is assumed to be an Encode object, the PV of the ssv is
5218 assumed to be octets in that encoding and decoding the input starts
5219 from the position which (PV + *offset) pointed to. The dsv will be
5220 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
5221 when the string tstr appears in decoding output or the input ends on
5222 the PV of the ssv. The value which the offset points will be modified
5223 to the last input position on the ssv.
5225 Returns TRUE if the terminator was found, else returns FALSE.
5227 bool sv_cat_decode(SV* dsv, SV *encoding, SV *ssv, int *offset, char* tstr, int tlen)
5232 =item sv_recode_to_utf8
5234 The encoding is assumed to be an Encode object, on entry the PV
5235 of the sv is assumed to be octets in that encoding, and the sv
5236 will be converted into Unicode (and UTF-8).
5238 If the sv already is UTF-8 (or if it is not POK), or if the encoding
5239 is not a reference, nothing is done to the sv. If the encoding is not
5240 an C<Encode::XS> Encoding object, bad things will happen.
5241 (See F<lib/encoding.pm> and L<Encode>).
5243 The PV of the sv is returned.
5245 char* sv_recode_to_utf8(SV* sv, SV *encoding)
5250 =item sv_uni_display
5252 Build to the scalar dsv a displayable version of the scalar sv,
5253 the displayable version being at most pvlim bytes long
5254 (if longer, the rest is truncated and "..." will be appended).
5256 The flags argument is as in pv_uni_display().
5258 The pointer to the PV of the dsv is returned.
5260 char* sv_uni_display(SV *dsv, SV *ssv, STRLEN pvlim, UV flags)
5263 Found in file utf8.c
5267 The "p" contains the pointer to the UTF-8 string encoding
5268 the character that is being converted.
5270 The "ustrp" is a pointer to the character buffer to put the
5271 conversion result to. The "lenp" is a pointer to the length
5274 The "swashp" is a pointer to the swash to use.
5276 Both the special and normal mappings are stored lib/unicore/To/Foo.pl,
5277 and loaded by SWASHGET, using lib/utf8_heavy.pl. The special (usually,
5278 but not always, a multicharacter mapping), is tried first.
5280 The "special" is a string like "utf8::ToSpecLower", which means the
5281 hash %utf8::ToSpecLower. The access to the hash is through
5282 Perl_to_utf8_case().
5284 The "normal" is a string like "ToLower" which means the swash
5287 UV to_utf8_case(U8 *p, U8* ustrp, STRLEN *lenp, SV **swash, char *normal, char *special)
5290 Found in file utf8.c
5294 Convert the UTF-8 encoded character at p to its foldcase version and
5295 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
5296 that the ustrp needs to be at least UTF8_MAXLEN_FOLD+1 bytes since the
5297 foldcase version may be longer than the original character (up to
5300 The first character of the foldcased version is returned
5301 (but note, as explained above, that there may be more.)
5303 UV to_utf8_fold(U8 *p, U8* ustrp, STRLEN *lenp)
5306 Found in file utf8.c
5310 Convert the UTF-8 encoded character at p to its lowercase version and
5311 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
5312 that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the
5313 lowercase version may be longer than the original character (up to two
5316 The first character of the lowercased version is returned
5317 (but note, as explained above, that there may be more.)
5319 UV to_utf8_lower(U8 *p, U8* ustrp, STRLEN *lenp)
5322 Found in file utf8.c
5326 Convert the UTF-8 encoded character at p to its titlecase version and
5327 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
5328 that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the
5329 titlecase version may be longer than the original character (up to two
5332 The first character of the titlecased version is returned
5333 (but note, as explained above, that there may be more.)
5335 UV to_utf8_title(U8 *p, U8* ustrp, STRLEN *lenp)
5338 Found in file utf8.c
5342 Convert the UTF-8 encoded character at p to its uppercase version and
5343 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
5344 that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the
5345 uppercase version may be longer than the original character (up to two
5348 The first character of the uppercased version is returned
5349 (but note, as explained above, that there may be more.)
5351 UV to_utf8_upper(U8 *p, U8* ustrp, STRLEN *lenp)
5354 Found in file utf8.c
5356 =item utf8n_to_uvchr
5358 Returns the native character value of the first character in the string C<s>
5359 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
5360 length, in bytes, of that character.
5362 Allows length and flags to be passed to low level routine.
5364 UV utf8n_to_uvchr(U8 *s, STRLEN curlen, STRLEN* retlen, U32 flags)
5367 Found in file utf8.c
5369 =item utf8n_to_uvuni
5371 Bottom level UTF-8 decode routine.
5372 Returns the unicode code point value of the first character in the string C<s>
5373 which is assumed to be in UTF-8 encoding and no longer than C<curlen>;
5374 C<retlen> will be set to the length, in bytes, of that character.
5376 If C<s> does not point to a well-formed UTF-8 character, the behaviour
5377 is dependent on the value of C<flags>: if it contains UTF8_CHECK_ONLY,
5378 it is assumed that the caller will raise a warning, and this function
5379 will silently just set C<retlen> to C<-1> and return zero. If the
5380 C<flags> does not contain UTF8_CHECK_ONLY, warnings about
5381 malformations will be given, C<retlen> will be set to the expected
5382 length of the UTF-8 character in bytes, and zero will be returned.
5384 The C<flags> can also contain various flags to allow deviations from
5385 the strict UTF-8 encoding (see F<utf8.h>).
5387 Most code should use utf8_to_uvchr() rather than call this directly.
5389 UV utf8n_to_uvuni(U8 *s, STRLEN curlen, STRLEN* retlen, U32 flags)
5392 Found in file utf8.c
5396 Returns the number of UTF-8 characters between the UTF-8 pointers C<a>
5399 WARNING: use only if you *know* that the pointers point inside the
5402 IV utf8_distance(U8 *a, U8 *b)
5405 Found in file utf8.c
5409 Return the UTF-8 pointer C<s> displaced by C<off> characters, either
5410 forward or backward.
5412 WARNING: do not use the following unless you *know* C<off> is within
5413 the UTF-8 data pointed to by C<s> *and* that on entry C<s> is aligned
5414 on the first byte of character or just after the last byte of a character.
5416 U8* utf8_hop(U8 *s, I32 off)
5419 Found in file utf8.c
5423 Return the length of the UTF-8 char encoded string C<s> in characters.
5424 Stops at C<e> (inclusive). If C<e E<lt> s> or if the scan would end
5425 up past C<e>, croaks.
5427 STRLEN utf8_length(U8* s, U8 *e)
5430 Found in file utf8.c
5434 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
5435 Unlike C<bytes_to_utf8>, this over-writes the original string, and
5436 updates len to contain the new length.
5437 Returns zero on failure, setting C<len> to -1.
5439 NOTE: this function is experimental and may change or be
5440 removed without notice.
5442 U8* utf8_to_bytes(U8 *s, STRLEN *len)
5445 Found in file utf8.c
5449 Returns the native character value of the first character in the string C<s>
5450 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
5451 length, in bytes, of that character.
5453 If C<s> does not point to a well-formed UTF-8 character, zero is
5454 returned and retlen is set, if possible, to -1.
5456 UV utf8_to_uvchr(U8 *s, STRLEN* retlen)
5459 Found in file utf8.c
5463 Returns the Unicode code point of the first character in the string C<s>
5464 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
5465 length, in bytes, of that character.
5467 This function should only be used when returned UV is considered
5468 an index into the Unicode semantic tables (e.g. swashes).
5470 If C<s> does not point to a well-formed UTF-8 character, zero is
5471 returned and retlen is set, if possible, to -1.
5473 UV utf8_to_uvuni(U8 *s, STRLEN* retlen)
5476 Found in file utf8.c
5480 Adds the UTF-8 representation of the Native codepoint C<uv> to the end
5481 of the string C<d>; C<d> should be have at least C<UTF8_MAXLEN+1> free
5482 bytes available. The return value is the pointer to the byte after the
5483 end of the new character. In other words,
5485 d = uvchr_to_utf8(d, uv);
5487 is the recommended wide native character-aware way of saying
5491 U8* uvchr_to_utf8(U8 *d, UV uv)
5494 Found in file utf8.c
5496 =item uvuni_to_utf8_flags
5498 Adds the UTF-8 representation of the Unicode codepoint C<uv> to the end
5499 of the string C<d>; C<d> should be have at least C<UTF8_MAXLEN+1> free
5500 bytes available. The return value is the pointer to the byte after the
5501 end of the new character. In other words,
5503 d = uvuni_to_utf8_flags(d, uv, flags);
5507 d = uvuni_to_utf8(d, uv);
5509 (which is equivalent to)
5511 d = uvuni_to_utf8_flags(d, uv, 0);
5513 is the recommended Unicode-aware way of saying
5517 U8* uvuni_to_utf8_flags(U8 *d, UV uv, UV flags)
5520 Found in file utf8.c
5525 =head1 Variables created by C<xsubpp> and C<xsubpp> internal functions
5531 Variable which is setup by C<xsubpp> to indicate the stack base offset,
5532 used by the C<ST>, C<XSprePUSH> and C<XSRETURN> macros. The C<dMARK> macro
5533 must be called prior to setup the C<MARK> variable.
5538 Found in file XSUB.h
5542 Variable which is setup by C<xsubpp> to indicate the
5543 class name for a C++ XS constructor. This is always a C<char*>. See C<THIS>.
5548 Found in file XSUB.h
5552 Sets up the C<ax> variable.
5553 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
5558 Found in file XSUB.h
5562 Sets up the C<items> variable.
5563 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
5568 Found in file XSUB.h
5572 Sets up the C<padoff_du> variable for an XSUB that wishes to use
5578 Found in file XSUB.h
5582 Sets up stack and mark pointers for an XSUB, calling dSP and dMARK.
5583 Sets up the C<ax> and C<items> variables by calling C<dAX> and C<dITEMS>.
5584 This is usually handled automatically by C<xsubpp>.
5589 Found in file XSUB.h
5593 Sets up the C<ix> variable for an XSUB which has aliases. This is usually
5594 handled automatically by C<xsubpp>.
5599 Found in file XSUB.h
5603 Variable which is setup by C<xsubpp> to indicate the number of
5604 items on the stack. See L<perlxs/"Variable-length Parameter Lists">.
5609 Found in file XSUB.h
5613 Variable which is setup by C<xsubpp> to indicate which of an
5614 XSUB's aliases was used to invoke it. See L<perlxs/"The ALIAS: Keyword">.
5619 Found in file XSUB.h
5623 Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
5627 Found in file XSUB.h
5631 Variable which is setup by C<xsubpp> to hold the return value for an
5632 XSUB. This is always the proper type for the XSUB. See
5633 L<perlxs/"The RETVAL Variable">.
5638 Found in file XSUB.h
5642 Used to access elements on the XSUB's stack.
5647 Found in file XSUB.h
5651 Variable which is setup by C<xsubpp> to designate the object in a C++
5652 XSUB. This is always the proper type for the C++ object. See C<CLASS> and
5653 L<perlxs/"Using XS With C++">.
5658 Found in file XSUB.h
5662 The SV* corresponding to the $_ variable. Works even if there
5663 is a lexical $_ in scope.
5666 Found in file XSUB.h
5670 Macro to declare an XSUB and its C parameter list. This is handled by
5674 Found in file XSUB.h
5678 The version identifier for an XS module. This is usually
5679 handled automatically by C<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>.
5682 Found in file XSUB.h
5684 =item XS_VERSION_BOOTCHECK
5686 Macro to verify that a PM module's $VERSION variable matches the XS
5687 module's C<XS_VERSION> variable. This is usually handled automatically by
5688 C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">.
5690 XS_VERSION_BOOTCHECK;
5693 Found in file XSUB.h
5698 =head1 Warning and Dieing
5704 This is the XSUB-writer's interface to Perl's C<die> function.
5705 Normally call this function the same way you call the C C<printf>
5706 function. Calling C<croak> returns control directly to Perl,
5707 sidestepping the normal C order of execution. See C<warn>.
5709 If you want to throw an exception object, assign the object to
5710 C<$@> and then pass C<Nullch> to croak():
5712 errsv = get_sv("@", TRUE);
5713 sv_setsv(errsv, exception_object);
5716 void croak(const char* pat, ...)
5719 Found in file util.c
5723 This is the XSUB-writer's interface to Perl's C<warn> function. Call this
5724 function the same way you call the C C<printf> function. See C<croak>.
5726 void warn(const char* pat, ...)
5729 Found in file util.c
5736 Until May 1997, this document was maintained by Jeff Okamoto
5737 <okamoto@corp.hp.com>. It is now maintained as part of Perl itself.
5739 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
5740 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
5741 Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
5742 Stephen McCamant, and Gurusamy Sarathy.
5744 API Listing originally by Dean Roehrich <roehrich@cray.com>.
5746 Updated to be autogenerated from comments in the source by Benjamin Stuhl.
5750 perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
projects / p5sagit/p5-mst-13.2.git / blob