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)
1199 =item hv_fetch_flags
1201 Returns the SV which corresponds to the specified key in the hash.
1203 The C<flags> value will normally be zero; if HV_FETCH_WANTPLACEHOLDERS is
1204 set then placeholders keys (for restricted hashes) will be returned in addition
1205 to normal keys. By default placeholders are automatically skipped over.
1206 Currently a placeholder is implemented with a value that is
1207 C<&Perl_sv_placeholder>. Note that the implementation of placeholders and
1208 restricted hashes may change.
1210 NOTE: this function is experimental and may change or be
1211 removed without notice.
1213 SV** hv_fetch_flags(HV* tb, const char* key, I32 klen, I32 lval, I32 flags)
1220 Prepares a starting point to traverse a hash table. Returns the number of
1221 keys in the hash (i.e. the same as C<HvKEYS(tb)>). The return value is
1222 currently only meaningful for hashes without tie magic.
1224 NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
1225 hash buckets that happen to be in use. If you still need that esoteric
1226 value, you can get it through the macro C<HvFILL(tb)>.
1229 I32 hv_iterinit(HV* tb)
1236 Returns the key from the current position of the hash iterator. See
1239 char* hv_iterkey(HE* entry, I32* retlen)
1246 Returns the key as an C<SV*> from the current position of the hash
1247 iterator. The return value will always be a mortal copy of the key. Also
1250 SV* hv_iterkeysv(HE* entry)
1257 Returns entries from a hash iterator. See C<hv_iterinit>.
1259 You may call C<hv_delete> or C<hv_delete_ent> on the hash entry that the
1260 iterator currently points to, without losing your place or invalidating your
1261 iterator. Note that in this case the current entry is deleted from the hash
1262 with your iterator holding the last reference to it. Your iterator is flagged
1263 to free the entry on the next call to C<hv_iternext>, so you must not discard
1264 your iterator immediately else the entry will leak - call C<hv_iternext> to
1265 trigger the resource deallocation.
1267 HE* hv_iternext(HV* tb)
1274 Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
1277 SV* hv_iternextsv(HV* hv, char** key, I32* retlen)
1282 =item hv_iternext_flags
1284 Returns entries from a hash iterator. See C<hv_iterinit> and C<hv_iternext>.
1285 The C<flags> value will normally be zero; if HV_ITERNEXT_WANTPLACEHOLDERS is
1286 set the placeholders keys (for restricted hashes) will be returned in addition
1287 to normal keys. By default placeholders are automatically skipped over.
1288 Currently a placeholder is implemented with a value that is
1289 C<&Perl_sv_placeholder>. Note that the implementation of placeholders and
1290 restricted hashes may change, and the implementation currently is
1291 insufficiently abstracted for any change to be tidy.
1293 NOTE: this function is experimental and may change or be
1294 removed without notice.
1296 HE* hv_iternext_flags(HV* tb, I32 flags)
1303 Returns the value from the current position of the hash iterator. See
1306 SV* hv_iterval(HV* tb, HE* entry)
1313 Adds magic to a hash. See C<sv_magic>.
1315 void hv_magic(HV* hv, GV* gv, int how)
1322 Evaluates the hash in scalar context and returns the result. Handles magic when the hash is tied.
1324 SV* hv_scalar(HV* hv)
1331 Stores an SV in a hash. The hash key is specified as C<key> and C<klen> is
1332 the length of the key. The C<hash> parameter is the precomputed hash
1333 value; if it is zero then Perl will compute it. The return value will be
1334 NULL if the operation failed or if the value did not need to be actually
1335 stored within the hash (as in the case of tied hashes). Otherwise it can
1336 be dereferenced to get the original C<SV*>. Note that the caller is
1337 responsible for suitably incrementing the reference count of C<val> before
1338 the call, and decrementing it if the function returned NULL. Effectively
1339 a successful hv_store takes ownership of one reference to C<val>. This is
1340 usually what you want; a newly created SV has a reference count of one, so
1341 if all your code does is create SVs then store them in a hash, hv_store
1342 will own the only reference to the new SV, and your code doesn't need to do
1343 anything further to tidy up. hv_store is not implemented as a call to
1344 hv_store_ent, and does not create a temporary SV for the key, so if your
1345 key data is not already in SV form then use hv_store in preference to
1348 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1349 information on how to use this function on tied hashes.
1351 SV** hv_store(HV* tb, const char* key, I32 klen, SV* val, U32 hash)
1358 Stores C<val> in a hash. The hash key is specified as C<key>. The C<hash>
1359 parameter is the precomputed hash value; if it is zero then Perl will
1360 compute it. The return value is the new hash entry so created. It will be
1361 NULL if the operation failed or if the value did not need to be actually
1362 stored within the hash (as in the case of tied hashes). Otherwise the
1363 contents of the return value can be accessed using the C<He?> macros
1364 described here. Note that the caller is responsible for suitably
1365 incrementing the reference count of C<val> before the call, and
1366 decrementing it if the function returned NULL. Effectively a successful
1367 hv_store_ent takes ownership of one reference to C<val>. This is
1368 usually what you want; a newly created SV has a reference count of one, so
1369 if all your code does is create SVs then store them in a hash, hv_store
1370 will own the only reference to the new SV, and your code doesn't need to do
1371 anything further to tidy up. Note that hv_store_ent only reads the C<key>;
1372 unlike C<val> it does not take ownership of it, so maintaining the correct
1373 reference count on C<key> is entirely the caller's responsibility. hv_store
1374 is not implemented as a call to hv_store_ent, and does not create a temporary
1375 SV for the key, so if your key data is not already in SV form then use
1376 hv_store in preference to hv_store_ent.
1378 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1379 information on how to use this function on tied hashes.
1381 HE* hv_store_ent(HV* tb, SV* key, SV* val, U32 hash)
1390 void hv_undef(HV* tb)
1397 Creates a new HV. The reference count is set to 1.
1407 =head1 Magical Functions
1413 Clear something magical that the SV represents. See C<sv_magic>.
1415 int mg_clear(SV* sv)
1422 Copies the magic from one SV to another. See C<sv_magic>.
1424 int mg_copy(SV* sv, SV* nsv, const char* key, I32 klen)
1431 Finds the magic pointer for type matching the SV. See C<sv_magic>.
1433 MAGIC* mg_find(SV* sv, int type)
1440 Free any magic storage used by the SV. See C<sv_magic>.
1449 Do magic after a value is retrieved from the SV. See C<sv_magic>.
1458 Report on the SV's length. See C<sv_magic>.
1460 U32 mg_length(SV* sv)
1467 Turns on the magical status of an SV. See C<sv_magic>.
1469 void mg_magical(SV* sv)
1476 Do magic after a value is assigned to the SV. See C<sv_magic>.
1485 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
1486 argument more than once.
1488 void SvGETMAGIC(SV* sv)
1495 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
1505 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
1506 argument more than once.
1508 void SvSETMAGIC(SV* sv)
1515 Like C<SvSetSV>, but does any set magic required afterwards.
1517 void SvSetMagicSV(SV* dsb, SV* ssv)
1522 =item SvSetMagicSV_nosteal
1524 Like C<SvSetSV_nosteal>, but does any set magic required afterwards.
1526 void SvSetMagicSV_nosteal(SV* dsv, SV* ssv)
1533 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
1536 void SvSetSV(SV* dsb, SV* ssv)
1541 =item SvSetSV_nosteal
1543 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
1544 ssv. May evaluate arguments more than once.
1546 void SvSetSV_nosteal(SV* dsv, SV* ssv)
1553 Arranges for sv to be shared between threads if a suitable module
1556 void SvSHARE(SV* sv)
1563 Releases a mutual exclusion lock on sv if a suitable module
1566 void SvUNLOCK(SV* sv)
1574 =head1 Memory Management
1580 The XSUB-writer's interface to the C C<memcpy> function. The C<src> is the
1581 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1582 the type. May fail on overlapping copies. See also C<Move>.
1584 void Copy(void* src, void* dest, int nitems, type)
1587 Found in file handy.h
1591 Like C<Copy> but returns dest. Useful for encouraging compilers to tail-call
1594 void * CopyD(void* src, void* dest, int nitems, type)
1597 Found in file handy.h
1601 The XSUB-writer's interface to the C C<memmove> function. The C<src> is the
1602 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1603 the type. Can do overlapping moves. See also C<Copy>.
1605 void Move(void* src, void* dest, int nitems, type)
1608 Found in file handy.h
1612 Like C<Move> but returns dest. Useful for encouraging compilers to tail-call
1615 void * MoveD(void* src, void* dest, int nitems, type)
1618 Found in file handy.h
1622 The XSUB-writer's interface to the C C<malloc> function.
1624 void New(int id, void* ptr, int nitems, type)
1627 Found in file handy.h
1631 The XSUB-writer's interface to the C C<malloc> function, with
1634 void Newc(int id, void* ptr, int nitems, type, cast)
1637 Found in file handy.h
1641 The XSUB-writer's interface to the C C<malloc> function. The allocated
1642 memory is zeroed with C<memzero>.
1644 void Newz(int id, void* ptr, int nitems, type)
1647 Found in file handy.h
1651 Fill up memory with a pattern (byte 0xAB over and over again) that
1652 hopefully catches attempts to access uninitialized memory.
1654 void Poison(void* dest, int nitems, type)
1657 Found in file handy.h
1661 The XSUB-writer's interface to the C C<realloc> function.
1663 void Renew(void* ptr, int nitems, type)
1666 Found in file handy.h
1670 The XSUB-writer's interface to the C C<realloc> function, with
1673 void Renewc(void* ptr, int nitems, type, cast)
1676 Found in file handy.h
1680 The XSUB-writer's interface to the C C<free> function.
1682 void Safefree(void* ptr)
1685 Found in file handy.h
1689 Perl's version of C<strdup()>. Returns a pointer to a newly allocated
1690 string which is a duplicate of C<pv>. The size of the string is
1691 determined by C<strlen()>. The memory allocated for the new string can
1692 be freed with the C<Safefree()> function.
1694 char* savepv(const char* pv)
1697 Found in file util.c
1701 Perl's version of what C<strndup()> would be if it existed. Returns a
1702 pointer to a newly allocated string which is a duplicate of the first
1703 C<len> bytes from C<pv>. The memory allocated for the new string can be
1704 freed with the C<Safefree()> function.
1706 char* savepvn(const char* pv, I32 len)
1709 Found in file util.c
1713 A version of C<savepv()> which allocates the duplicate string in memory
1714 which is shared between threads.
1716 char* savesharedpv(const char* pv)
1719 Found in file util.c
1723 A version of C<savepv()>/C<savepvn() which gets the string to duplicate from
1724 the passed in SV using C<SvPV()>
1726 char* savesvpv(SV* sv)
1729 Found in file util.c
1733 This is an architecture-independent macro to copy one structure to another.
1735 void StructCopy(type src, type dest, type)
1738 Found in file handy.h
1742 The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the
1743 destination, C<nitems> is the number of items, and C<type> is the type.
1745 void Zero(void* dest, int nitems, type)
1748 Found in file handy.h
1752 Like C<Zero> but returns dest. Useful for encouraging compilers to tail-call
1755 void * ZeroD(void* dest, int nitems, type)
1758 Found in file handy.h
1763 =head1 Miscellaneous Functions
1769 Analyses the string in order to make fast searches on it using fbm_instr()
1770 -- the Boyer-Moore algorithm.
1772 void fbm_compile(SV* sv, U32 flags)
1775 Found in file util.c
1779 Returns the location of the SV in the string delimited by C<str> and
1780 C<strend>. It returns C<Nullch> if the string can't be found. The C<sv>
1781 does not have to be fbm_compiled, but the search will not be as fast
1784 char* fbm_instr(unsigned char* big, unsigned char* bigend, SV* littlesv, U32 flags)
1787 Found in file util.c
1791 Takes a sprintf-style format pattern and conventional
1792 (non-SV) arguments and returns the formatted string.
1794 (char *) Perl_form(pTHX_ const char* pat, ...)
1796 can be used any place a string (char *) is required:
1798 char * s = Perl_form("%d.%d",major,minor);
1800 Uses a single private buffer so if you want to format several strings you
1801 must explicitly copy the earlier strings away (and free the copies when you
1804 char* form(const char* pat, ...)
1807 Found in file util.c
1811 Fill the sv with current working directory
1813 int getcwd_sv(SV* sv)
1816 Found in file util.c
1820 Returns a new version object based on the passed in SV:
1822 SV *sv = new_version(SV *ver);
1824 Does not alter the passed in ver SV. See "upg_version" if you
1825 want to upgrade the SV.
1827 SV* new_version(SV *ver)
1830 Found in file util.c
1834 Returns a pointer to the next character after the parsed
1835 version string, as well as upgrading the passed in SV to
1838 Function must be called with an already existing SV like
1841 s = scan_version(s,SV *sv, bool qv);
1843 Performs some preprocessing to the string to ensure that
1844 it has the correct characteristics of a version. Flags the
1845 object if it contains an underscore (which denotes this
1846 is a alpha version). The boolean qv denotes that the version
1847 should be interpreted as if it had multiple decimals, even if
1850 char* scan_version(char *vstr, SV *sv, bool qv)
1853 Found in file util.c
1857 Test two strings to see if they are equal. Returns true or false.
1859 bool strEQ(char* s1, char* s2)
1862 Found in file handy.h
1866 Test two strings to see if the first, C<s1>, is greater than or equal to
1867 the second, C<s2>. Returns true or false.
1869 bool strGE(char* s1, char* s2)
1872 Found in file handy.h
1876 Test two strings to see if the first, C<s1>, is greater than the second,
1877 C<s2>. Returns true or false.
1879 bool strGT(char* s1, char* s2)
1882 Found in file handy.h
1886 Test two strings to see if the first, C<s1>, is less than or equal to the
1887 second, C<s2>. Returns true or false.
1889 bool strLE(char* s1, char* s2)
1892 Found in file handy.h
1896 Test two strings to see if the first, C<s1>, is less than the second,
1897 C<s2>. Returns true or false.
1899 bool strLT(char* s1, char* s2)
1902 Found in file handy.h
1906 Test two strings to see if they are different. Returns true or
1909 bool strNE(char* s1, char* s2)
1912 Found in file handy.h
1916 Test two strings to see if they are equal. The C<len> parameter indicates
1917 the number of bytes to compare. Returns true or false. (A wrapper for
1920 bool strnEQ(char* s1, char* s2, STRLEN len)
1923 Found in file handy.h
1927 Test two strings to see if they are different. The C<len> parameter
1928 indicates the number of bytes to compare. Returns true or false. (A
1929 wrapper for C<strncmp>).
1931 bool strnNE(char* s1, char* s2, STRLEN len)
1934 Found in file handy.h
1938 Dummy routine which "locks" an SV when there is no locking module present.
1939 Exists to avoid test for a NULL function pointer and because it could potentially warn under
1940 some level of strict-ness.
1942 void sv_nolocking(SV *)
1945 Found in file util.c
1949 Dummy routine which "shares" an SV when there is no sharing module present.
1950 Exists to avoid test for a NULL function pointer and because it could potentially warn under
1951 some level of strict-ness.
1953 void sv_nosharing(SV *)
1956 Found in file util.c
1958 =item sv_nounlocking
1960 Dummy routine which "unlocks" an SV when there is no locking module present.
1961 Exists to avoid test for a NULL function pointer and because it could potentially warn under
1962 some level of strict-ness.
1964 void sv_nounlocking(SV *)
1967 Found in file util.c
1971 In-place upgrade of the supplied SV to a version object.
1973 SV *sv = upg_version(SV *sv);
1975 Returns a pointer to the upgraded SV.
1977 SV* upg_version(SV *ver)
1980 Found in file util.c
1984 Version object aware cmp. Both operands must already have been
1985 converted into version objects.
1987 int vcmp(SV *lvs, SV *rvs)
1990 Found in file util.c
1994 Accepts a version object and returns the normalized string
1995 representation. Call like:
1999 NOTE: you can pass either the object directly or the SV
2000 contained within the RV.
2005 Found in file util.c
2009 Accepts a version object and returns the normalized floating
2010 point representation. Call like:
2014 NOTE: you can pass either the object directly or the SV
2015 contained within the RV.
2020 Found in file util.c
2024 In order to maintain maximum compatibility with earlier versions
2025 of Perl, this function will return either the floating point
2026 notation or the multiple dotted notation, depending on whether
2027 the original version contained 1 or more dots, respectively
2029 SV* vstringify(SV *vs)
2032 Found in file util.c
2037 =head1 Numeric functions
2043 converts a string representing a binary number to numeric form.
2045 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2046 conversion flags, and I<result> should be NULL or a pointer to an NV.
2047 The scan stops at the end of the string, or the first invalid character.
2048 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2049 invalid character will also trigger a warning.
2050 On return I<*len> is set to the length of the scanned string,
2051 and I<*flags> gives output flags.
2053 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2054 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_bin>
2055 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2056 and writes the value to I<*result> (or the value is discarded if I<result>
2059 The binary number may optionally be prefixed with "0b" or "b" unless
2060 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
2061 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the binary
2062 number may use '_' characters to separate digits.
2064 UV grok_bin(char* start, STRLEN* len, I32* flags, NV *result)
2067 Found in file numeric.c
2071 converts a string representing a hex number to numeric form.
2073 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2074 conversion flags, and I<result> should be NULL or a pointer to an NV.
2075 The scan stops at the end of the string, or the first invalid character.
2076 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2077 invalid character will also trigger a warning.
2078 On return I<*len> is set to the length of the scanned string,
2079 and I<*flags> gives output flags.
2081 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2082 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_hex>
2083 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2084 and writes the value to I<*result> (or the value is discarded if I<result>
2087 The hex number may optionally be prefixed with "0x" or "x" unless
2088 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
2089 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the hex
2090 number may use '_' characters to separate digits.
2092 UV grok_hex(char* start, STRLEN* len, I32* flags, NV *result)
2095 Found in file numeric.c
2099 Recognise (or not) a number. The type of the number is returned
2100 (0 if unrecognised), otherwise it is a bit-ORed combination of
2101 IS_NUMBER_IN_UV, IS_NUMBER_GREATER_THAN_UV_MAX, IS_NUMBER_NOT_INT,
2102 IS_NUMBER_NEG, IS_NUMBER_INFINITY, IS_NUMBER_NAN (defined in perl.h).
2104 If the value of the number can fit an in UV, it is returned in the *valuep
2105 IS_NUMBER_IN_UV will be set to indicate that *valuep is valid, IS_NUMBER_IN_UV
2106 will never be set unless *valuep is valid, but *valuep may have been assigned
2107 to during processing even though IS_NUMBER_IN_UV is not set on return.
2108 If valuep is NULL, IS_NUMBER_IN_UV will be set for the same cases as when
2109 valuep is non-NULL, but no actual assignment (or SEGV) will occur.
2111 IS_NUMBER_NOT_INT will be set with IS_NUMBER_IN_UV if trailing decimals were
2112 seen (in which case *valuep gives the true value truncated to an integer), and
2113 IS_NUMBER_NEG if the number is negative (in which case *valuep holds the
2114 absolute value). IS_NUMBER_IN_UV is not set if e notation was used or the
2115 number is larger than a UV.
2117 int grok_number(const char *pv, STRLEN len, UV *valuep)
2120 Found in file numeric.c
2122 =item grok_numeric_radix
2124 Scan and skip for a numeric decimal separator (radix).
2126 bool grok_numeric_radix(const char **sp, const char *send)
2129 Found in file numeric.c
2133 converts a string representing an octal number to numeric form.
2135 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2136 conversion flags, and I<result> should be NULL or a pointer to an NV.
2137 The scan stops at the end of the string, or the first invalid character.
2138 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2139 invalid character will also trigger a warning.
2140 On return I<*len> is set to the length of the scanned string,
2141 and I<*flags> gives output flags.
2143 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2144 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_oct>
2145 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2146 and writes the value to I<*result> (or the value is discarded if I<result>
2149 If C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the octal
2150 number may use '_' characters to separate digits.
2152 UV grok_oct(char* start, STRLEN* len, I32* flags, NV *result)
2155 Found in file numeric.c
2159 For backwards compatibility. Use C<grok_bin> instead.
2161 NV scan_bin(char* start, STRLEN len, STRLEN* retlen)
2164 Found in file numeric.c
2168 For backwards compatibility. Use C<grok_hex> instead.
2170 NV scan_hex(char* start, STRLEN len, STRLEN* retlen)
2173 Found in file numeric.c
2177 For backwards compatibility. Use C<grok_oct> instead.
2179 NV scan_oct(char* start, STRLEN len, STRLEN* retlen)
2182 Found in file numeric.c
2187 =head1 Optree Manipulation Functions
2193 If C<cv> is a constant sub eligible for inlining. returns the constant
2194 value returned by the sub. Otherwise, returns NULL.
2196 Constant subs can be created with C<newCONSTSUB> or as described in
2197 L<perlsub/"Constant Functions">.
2199 SV* cv_const_sv(CV* cv)
2206 Creates a constant sub equivalent to Perl C<sub FOO () { 123 }> which is
2207 eligible for inlining at compile-time.
2209 CV* newCONSTSUB(HV* stash, char* name, SV* sv)
2216 Used by C<xsubpp> to hook up XSUBs as Perl subs.
2224 =head1 Pad Data Structures
2230 Get the value at offset po in the current pad.
2231 Use macro PAD_SV instead of calling this function directly.
2233 SV* pad_sv(PADOFFSET po)
2241 =head1 Stack Manipulation Macros
2247 Declare a stack marker variable, C<mark>, for the XSUB. See C<MARK> and
2257 Saves the original stack mark for the XSUB. See C<ORIGMARK>.
2266 Declares a local copy of perl's stack pointer for the XSUB, available via
2267 the C<SP> macro. See C<SP>.
2276 Used to extend the argument stack for an XSUB's return values. Once
2277 used, guarantees that there is room for at least C<nitems> to be pushed
2280 void EXTEND(SP, int nitems)
2287 Stack marker variable for the XSUB. See C<dMARK>.
2294 Push an integer onto the stack. The stack must have room for this element.
2295 Handles 'set' magic. Does not use C<TARG>. See also C<PUSHi>, C<mXPUSHi>
2305 Push a double onto the stack. The stack must have room for this element.
2306 Handles 'set' magic. Does not use C<TARG>. See also C<PUSHn>, C<mXPUSHn>
2316 Push a string onto the stack. The stack must have room for this element.
2317 The C<len> indicates the length of the string. Handles 'set' magic. Does
2318 not use C<TARG>. See also C<PUSHp>, C<mXPUSHp> and C<XPUSHp>.
2320 void mPUSHp(char* str, STRLEN len)
2327 Push an unsigned integer onto the stack. The stack must have room for this
2328 element. Handles 'set' magic. Does not use C<TARG>. See also C<PUSHu>,
2329 C<mXPUSHu> and C<XPUSHu>.
2338 Push an integer onto the stack, extending the stack if necessary. Handles
2339 'set' magic. Does not use C<TARG>. See also C<XPUSHi>, C<mPUSHi> and
2349 Push a double onto the stack, extending the stack if necessary. Handles
2350 'set' magic. Does not use C<TARG>. See also C<XPUSHn>, C<mPUSHn> and
2360 Push a string onto the stack, extending the stack if necessary. The C<len>
2361 indicates the length of the string. Handles 'set' magic. Does not use
2362 C<TARG>. See also C<XPUSHp>, C<mPUSHp> and C<PUSHp>.
2364 void mXPUSHp(char* str, STRLEN len)
2371 Push an unsigned integer onto the stack, extending the stack if necessary.
2372 Handles 'set' magic. Does not use C<TARG>. See also C<XPUSHu>, C<mPUSHu>
2382 The original stack mark for the XSUB. See C<dORIGMARK>.
2389 Pops an integer off the stack.
2398 Pops a long off the stack.
2407 Pops a double off the stack.
2416 Pops a string off the stack. Deprecated. New code should provide
2417 a STRLEN n_a and use POPpx.
2426 Pops a string off the stack which must consist of bytes i.e. characters < 256.
2427 Requires a variable STRLEN n_a in scope.
2436 Pops a string off the stack.
2437 Requires a variable STRLEN n_a in scope.
2446 Pops an SV off the stack.
2455 Push an integer onto the stack. The stack must have room for this element.
2456 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
2457 called to declare it. Do not call multiple C<TARG>-oriented macros to
2458 return lists from XSUB's - see C<mPUSHi> instead. See also C<XPUSHi> and
2468 Opening bracket for arguments on a callback. See C<PUTBACK> and
2478 Push a new mortal SV onto the stack. The stack must have room for this
2479 element. Does not handle 'set' magic. Does not use C<TARG>. See also
2480 C<PUSHs>, C<XPUSHmortal> and C<XPUSHs>.
2489 Push a double onto the stack. The stack must have room for this element.
2490 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
2491 called to declare it. Do not call multiple C<TARG>-oriented macros to
2492 return lists from XSUB's - see C<mPUSHn> instead. See also C<XPUSHn> and
2502 Push a string onto the stack. The stack must have room for this element.
2503 The C<len> indicates the length of the string. Handles 'set' magic. Uses
2504 C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to declare it. Do not
2505 call multiple C<TARG>-oriented macros to return lists from XSUB's - see
2506 C<mPUSHp> instead. See also C<XPUSHp> and C<mXPUSHp>.
2508 void PUSHp(char* str, STRLEN len)
2515 Push an SV onto the stack. The stack must have room for this element.
2516 Does not handle 'set' magic. Does not use C<TARG>. See also C<PUSHmortal>,
2517 C<XPUSHs> and C<XPUSHmortal>.
2526 Push an unsigned integer onto the stack. The stack must have room for this
2527 element. Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG>
2528 should be called to declare it. Do not call multiple C<TARG>-oriented
2529 macros to return lists from XSUB's - see C<mPUSHu> instead. See also
2530 C<XPUSHu> and C<mXPUSHu>.
2539 Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
2540 See C<PUSHMARK> and L<perlcall> for other uses.
2549 Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and
2557 Refetch the stack pointer. Used after a callback. See L<perlcall>.
2566 Push an integer onto the stack, extending the stack if necessary. Handles
2567 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
2568 declare it. Do not call multiple C<TARG>-oriented macros to return lists
2569 from XSUB's - see C<mXPUSHi> instead. See also C<PUSHi> and C<mPUSHi>.
2578 Push a new mortal SV onto the stack, extending the stack if necessary. Does
2579 not handle 'set' magic. Does not use C<TARG>. See also C<XPUSHs>,
2580 C<PUSHmortal> and C<PUSHs>.
2589 Push a double onto the stack, extending the stack if necessary. Handles
2590 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
2591 declare it. Do not call multiple C<TARG>-oriented macros to return lists
2592 from XSUB's - see C<mXPUSHn> instead. See also C<PUSHn> and C<mPUSHn>.
2601 Push a string onto the stack, extending the stack if necessary. The C<len>
2602 indicates the length of the string. Handles 'set' magic. Uses C<TARG>, so
2603 C<dTARGET> or C<dXSTARG> should be called to declare it. Do not call
2604 multiple C<TARG>-oriented macros to return lists from XSUB's - see
2605 C<mXPUSHp> instead. See also C<PUSHp> and C<mPUSHp>.
2607 void XPUSHp(char* str, STRLEN len)
2614 Push an SV onto the stack, extending the stack if necessary. Does not
2615 handle 'set' magic. Does not use C<TARG>. See also C<XPUSHmortal>,
2616 C<PUSHs> and C<PUSHmortal>.
2625 Push an unsigned integer onto the stack, extending the stack if necessary.
2626 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
2627 called to declare it. Do not call multiple C<TARG>-oriented macros to
2628 return lists from XSUB's - see C<mXPUSHu> instead. See also C<PUSHu> and
2638 Return from XSUB, indicating number of items on the stack. This is usually
2639 handled by C<xsubpp>.
2641 void XSRETURN(int nitems)
2644 Found in file XSUB.h
2646 =item XSRETURN_EMPTY
2648 Return an empty list from an XSUB immediately.
2653 Found in file XSUB.h
2657 Return an integer from an XSUB immediately. Uses C<XST_mIV>.
2659 void XSRETURN_IV(IV iv)
2662 Found in file XSUB.h
2666 Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
2671 Found in file XSUB.h
2675 Return a double from an XSUB immediately. Uses C<XST_mNV>.
2677 void XSRETURN_NV(NV nv)
2680 Found in file XSUB.h
2684 Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
2686 void XSRETURN_PV(char* str)
2689 Found in file XSUB.h
2691 =item XSRETURN_UNDEF
2693 Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
2698 Found in file XSUB.h
2702 Return an integer from an XSUB immediately. Uses C<XST_mUV>.
2704 void XSRETURN_UV(IV uv)
2707 Found in file XSUB.h
2711 Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
2716 Found in file XSUB.h
2720 Place an integer into the specified position C<pos> on the stack. The
2721 value is stored in a new mortal SV.
2723 void XST_mIV(int pos, IV iv)
2726 Found in file XSUB.h
2730 Place C<&PL_sv_no> into the specified position C<pos> on the
2733 void XST_mNO(int pos)
2736 Found in file XSUB.h
2740 Place a double into the specified position C<pos> on the stack. The value
2741 is stored in a new mortal SV.
2743 void XST_mNV(int pos, NV nv)
2746 Found in file XSUB.h
2750 Place a copy of a string into the specified position C<pos> on the stack.
2751 The value is stored in a new mortal SV.
2753 void XST_mPV(int pos, char* str)
2756 Found in file XSUB.h
2760 Place C<&PL_sv_undef> into the specified position C<pos> on the
2763 void XST_mUNDEF(int pos)
2766 Found in file XSUB.h
2770 Place C<&PL_sv_yes> into the specified position C<pos> on the
2773 void XST_mYES(int pos)
2776 Found in file XSUB.h
2787 An enum of flags for Perl types. These are found in the file B<sv.h>
2788 in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
2795 Integer type flag for scalars. See C<svtype>.
2802 Double type flag for scalars. See C<svtype>.
2809 Pointer type flag for scalars. See C<svtype>.
2816 Type flag for arrays. See C<svtype>.
2823 Type flag for code refs. See C<svtype>.
2830 Type flag for hashes. See C<svtype>.
2837 Type flag for blessed scalars. See C<svtype>.
2845 =head1 SV Manipulation Functions
2851 Returns the SV of the specified Perl scalar. If C<create> is set and the
2852 Perl variable does not exist then it will be created. If C<create> is not
2853 set and the variable does not exist then NULL is returned.
2855 NOTE: the perl_ form of this function is deprecated.
2857 SV* get_sv(const char* name, I32 create)
2860 Found in file perl.c
2862 =item looks_like_number
2864 Test if the content of an SV looks like a number (or is a number).
2865 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
2866 non-numeric warning), even if your atof() doesn't grok them.
2868 I32 looks_like_number(SV* sv)
2875 Creates an RV wrapper for an SV. The reference count for the original SV is
2878 SV* newRV_inc(SV* sv)
2885 Creates an RV wrapper for an SV. The reference count for the original
2886 SV is B<not> incremented.
2888 SV* newRV_noinc(SV *sv)
2895 Creates a new SV. A non-zero C<len> parameter indicates the number of
2896 bytes of preallocated string space the SV should have. An extra byte for a
2897 tailing NUL is also reserved. (SvPOK is not set for the SV even if string
2898 space is allocated.) The reference count for the new SV is set to 1.
2899 C<id> is an integer id between 0 and 1299 (used to identify leaks).
2901 SV* NEWSV(int id, STRLEN len)
2904 Found in file handy.h
2908 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
2909 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
2912 SV* newSV(STRLEN len)
2919 Creates a new SV and copies an integer into it. The reference count for the
2929 Creates a new SV and copies a floating point value into it.
2930 The reference count for the SV is set to 1.
2939 Creates a new SV and copies a string into it. The reference count for the
2940 SV is set to 1. If C<len> is zero, Perl will compute the length using
2941 strlen(). For efficiency, consider using C<newSVpvn> instead.
2943 SV* newSVpv(const char* s, STRLEN len)
2950 Creates a new SV and initializes it with the string formatted like
2953 SV* newSVpvf(const char* pat, ...)
2960 Creates a new SV and copies a string into it. The reference count for the
2961 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
2962 string. You are responsible for ensuring that the source string is at least
2963 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
2965 SV* newSVpvn(const char* s, STRLEN len)
2970 =item newSVpvn_share
2972 Creates a new SV with its SvPVX pointing to a shared string in the string
2973 table. If the string does not already exist in the table, it is created
2974 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
2975 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
2976 otherwise the hash is computed. The idea here is that as the string table
2977 is used for shared hash keys these strings will have SvPVX == HeKEY and
2978 hash lookup will avoid string compare.
2980 SV* newSVpvn_share(const char* s, I32 len, U32 hash)
2987 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
2988 it will be upgraded to one. If C<classname> is non-null then the new SV will
2989 be blessed in the specified package. The new SV is returned and its
2990 reference count is 1.
2992 SV* newSVrv(SV* rv, const char* classname)
2999 Creates a new SV which is an exact duplicate of the original SV.
3002 SV* newSVsv(SV* old)
3009 Creates a new SV and copies an unsigned integer into it.
3010 The reference count for the SV is set to 1.
3019 Returns the length of the string which is in the SV. See C<SvLEN>.
3021 STRLEN SvCUR(SV* sv)
3028 Set the length of the string which is in the SV. See C<SvCUR>.
3030 void SvCUR_set(SV* sv, STRLEN len)
3037 Returns a pointer to the last character in the string which is in the SV.
3038 See C<SvCUR>. Access the character as *(SvEND(sv)).
3047 Expands the character buffer in the SV so that it has room for the
3048 indicated number of bytes (remember to reserve space for an extra trailing
3049 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
3050 Returns a pointer to the character buffer.
3052 char * SvGROW(SV* sv, STRLEN len)
3059 Returns a boolean indicating whether the SV contains an integer.
3068 Returns a boolean indicating whether the SV contains an integer. Checks
3069 the B<private> setting. Use C<SvIOK>.
3078 Returns a boolean indicating whether the SV contains a signed integer.
3080 bool SvIOK_notUV(SV* sv)
3087 Unsets the IV status of an SV.
3089 void SvIOK_off(SV* sv)
3096 Tells an SV that it is an integer.
3098 void SvIOK_on(SV* sv)
3105 Tells an SV that it is an integer and disables all other OK bits.
3107 void SvIOK_only(SV* sv)
3114 Tells and SV that it is an unsigned integer and disables all other OK bits.
3116 void SvIOK_only_UV(SV* sv)
3123 Returns a boolean indicating whether the SV contains an unsigned integer.
3125 bool SvIOK_UV(SV* sv)
3132 Returns a boolean indicating whether the SV is Copy-On-Write. (either shared
3133 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
3136 bool SvIsCOW(SV* sv)
3141 =item SvIsCOW_shared_hash
3143 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
3146 bool SvIsCOW_shared_hash(SV* sv)
3153 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
3154 version which guarantees to evaluate sv only once.
3163 Returns the raw value in the SV's IV slot, without checks or conversions.
3164 Only use when you are sure SvIOK is true. See also C<SvIV()>.
3173 Coerces the given SV to an integer and returns it. Guarantees to evaluate
3174 sv only once. Use the more efficient C<SvIV> otherwise.
3183 Like C<SvIV> but doesn't process magic.
3185 IV SvIV_nomg(SV* sv)
3192 Returns the size of the string buffer in the SV, not including any part
3193 attributable to C<SvOOK>. See C<SvCUR>.
3195 STRLEN SvLEN(SV* sv)
3202 Returns a boolean indicating whether the SV contains a number, integer or
3212 Returns a boolean indicating whether the SV contains a number, integer or
3213 double. Checks the B<private> setting. Use C<SvNIOK>.
3215 bool SvNIOKp(SV* sv)
3222 Unsets the NV/IV status of an SV.
3224 void SvNIOK_off(SV* sv)
3231 Returns a boolean indicating whether the SV contains a double.
3240 Returns a boolean indicating whether the SV contains a double. Checks the
3241 B<private> setting. Use C<SvNOK>.
3250 Unsets the NV status of an SV.
3252 void SvNOK_off(SV* sv)
3259 Tells an SV that it is a double.
3261 void SvNOK_on(SV* sv)
3268 Tells an SV that it is a double and disables all other OK bits.
3270 void SvNOK_only(SV* sv)
3277 Coerce the given SV to a double and return it. See C<SvNVx> for a version
3278 which guarantees to evaluate sv only once.
3287 Returns the raw value in the SV's NV slot, without checks or conversions.
3288 Only use when you are sure SvNOK is true. See also C<SvNV()>.
3297 Coerces the given SV to a double and returns it. Guarantees to evaluate
3298 sv only once. Use the more efficient C<SvNV> otherwise.
3307 Returns a boolean indicating whether the value is an SV. It also tells
3308 whether the value is defined or not.
3317 Returns a boolean indicating whether the SvIVX is a valid offset value for
3318 the SvPVX. This hack is used internally to speed up removal of characters
3319 from the beginning of a SvPV. When SvOOK is true, then the start of the
3320 allocated string buffer is really (SvPVX - SvIVX).
3329 Returns a boolean indicating whether the SV contains a character
3339 Returns a boolean indicating whether the SV contains a character string.
3340 Checks the B<private> setting. Use C<SvPOK>.
3349 Unsets the PV status of an SV.
3351 void SvPOK_off(SV* sv)
3358 Tells an SV that it is a string.
3360 void SvPOK_on(SV* sv)
3367 Tells an SV that it is a string and disables all other OK bits.
3368 Will also turn off the UTF-8 status.
3370 void SvPOK_only(SV* sv)
3375 =item SvPOK_only_UTF8
3377 Tells an SV that it is a string and disables all other OK bits,
3378 and leaves the UTF-8 status as it was.
3380 void SvPOK_only_UTF8(SV* sv)
3387 Returns a pointer to the string in the SV, or a stringified form of
3388 the SV if the SV does not contain a string. The SV may cache the
3389 stringified version becoming C<SvPOK>. Handles 'get' magic. See also
3390 C<SvPVx> for a version which guarantees to evaluate sv only once.
3392 char* SvPV(SV* sv, STRLEN len)
3399 Like C<SvPV>, but converts sv to byte representation first if necessary.
3401 char* SvPVbyte(SV* sv, STRLEN len)
3408 Like C<SvPV>, but converts sv to byte representation first if necessary.
3409 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
3412 char* SvPVbytex(SV* sv, STRLEN len)
3417 =item SvPVbytex_force
3419 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
3420 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
3423 char* SvPVbytex_force(SV* sv, STRLEN len)
3428 =item SvPVbyte_force
3430 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
3432 char* SvPVbyte_force(SV* sv, STRLEN len)
3437 =item SvPVbyte_nolen
3439 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
3441 char* SvPVbyte_nolen(SV* sv)
3448 Like C<SvPV>, but converts sv to utf8 first if necessary.
3450 char* SvPVutf8(SV* sv, STRLEN len)
3457 Like C<SvPV>, but converts sv to utf8 first if necessary.
3458 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
3461 char* SvPVutf8x(SV* sv, STRLEN len)
3466 =item SvPVutf8x_force
3468 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
3469 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
3472 char* SvPVutf8x_force(SV* sv, STRLEN len)
3477 =item SvPVutf8_force
3479 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
3481 char* SvPVutf8_force(SV* sv, STRLEN len)
3486 =item SvPVutf8_nolen
3488 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
3490 char* SvPVutf8_nolen(SV* sv)
3497 Returns a pointer to the physical string in the SV. The SV must contain a
3507 A version of C<SvPV> which guarantees to evaluate sv only once.
3509 char* SvPVx(SV* sv, STRLEN len)
3516 Like C<SvPV> but will force the SV into containing just a string
3517 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
3520 char* SvPV_force(SV* sv, STRLEN len)
3525 =item SvPV_force_nomg
3527 Like C<SvPV> but will force the SV into containing just a string
3528 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
3529 directly. Doesn't process magic.
3531 char* SvPV_force_nomg(SV* sv, STRLEN len)
3538 Returns a pointer to the string in the SV, or a stringified form of
3539 the SV if the SV does not contain a string. The SV may cache the
3540 stringified form becoming C<SvPOK>. Handles 'get' magic.
3542 char* SvPV_nolen(SV* sv)
3549 Like C<SvPV> but doesn't process magic.
3551 char* SvPV_nomg(SV* sv, STRLEN len)
3558 Returns the value of the object's reference count.
3560 U32 SvREFCNT(SV* sv)
3567 Decrements the reference count of the given SV.
3569 void SvREFCNT_dec(SV* sv)
3576 Increments the reference count of the given SV.
3578 SV* SvREFCNT_inc(SV* sv)
3585 Tests if the SV is an RV.
3594 Unsets the RV status of an SV.
3596 void SvROK_off(SV* sv)
3603 Tells an SV that it is an RV.
3605 void SvROK_on(SV* sv)
3612 Dereferences an RV to return the SV.
3621 Returns the stash of the SV.
3630 Taints an SV if tainting is enabled.
3632 void SvTAINT(SV* sv)
3639 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
3642 bool SvTAINTED(SV* sv)
3649 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
3650 some of Perl's fundamental security features. XS module authors should not
3651 use this function unless they fully understand all the implications of
3652 unconditionally untainting the value. Untainting should be done in the
3653 standard perl fashion, via a carefully crafted regexp, rather than directly
3654 untainting variables.
3656 void SvTAINTED_off(SV* sv)
3663 Marks an SV as tainted if tainting is enabled.
3665 void SvTAINTED_on(SV* sv)
3672 Returns a boolean indicating whether Perl would evaluate the SV as true or
3673 false, defined or undefined. Does not handle 'get' magic.
3682 Returns the type of the SV. See C<svtype>.
3684 svtype SvTYPE(SV* sv)
3691 Returns a boolean indicating whether the SV contains an unsigned integer.
3700 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
3701 perform the upgrade if necessary. See C<svtype>.
3703 void SvUPGRADE(SV* sv, svtype type)
3710 Returns a boolean indicating whether the SV contains UTF-8 encoded data.
3719 Unsets the UTF-8 status of an SV.
3721 void SvUTF8_off(SV *sv)
3728 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
3729 Do not use frivolously.
3731 void SvUTF8_on(SV *sv)
3738 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
3739 for a version which guarantees to evaluate sv only once.
3748 Returns the raw value in the SV's UV slot, without checks or conversions.
3749 Only use when you are sure SvIOK is true. See also C<SvUV()>.
3758 Coerces the given SV to an unsigned integer and returns it. Guarantees to
3759 evaluate sv only once. Use the more efficient C<SvUV> otherwise.
3768 Like C<SvUV> but doesn't process magic.
3770 UV SvUV_nomg(SV* sv)
3777 Returns a boolean indicating whether the SV contains a v-string.
3786 This function is only called on magical items, and is only used by
3787 sv_true() or its macro equivalent.
3789 bool sv_2bool(SV* sv)
3796 Using various gambits, try to get a CV from an SV; in addition, try if
3797 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
3799 CV* sv_2cv(SV* sv, HV** st, GV** gvp, I32 lref)
3806 Using various gambits, try to get an IO from an SV: the IO slot if its a
3807 GV; or the recursive result if we're an RV; or the IO slot of the symbol
3808 named after the PV if we're a string.
3817 Return the integer value of an SV, doing any necessary string
3818 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
3819 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
3821 IV sv_2iv_flags(SV* sv, I32 flags)
3828 Marks an existing SV as mortal. The SV will be destroyed "soon", either
3829 by an explicit call to FREETMPS, or by an implicit call at places such as
3830 statement boundaries. SvTEMP() is turned on which means that the SV's
3831 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
3832 and C<sv_mortalcopy>.
3834 SV* sv_2mortal(SV* sv)
3841 Return the num value of an SV, doing any necessary string or integer
3842 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
3852 Return a pointer to the byte-encoded representation of the SV, and set *lp
3853 to its length. May cause the SV to be downgraded from UTF-8 as a
3856 Usually accessed via the C<SvPVbyte> macro.
3858 char* sv_2pvbyte(SV* sv, STRLEN* lp)
3863 =item sv_2pvbyte_nolen
3865 Return a pointer to the byte-encoded representation of the SV.
3866 May cause the SV to be downgraded from UTF-8 as a side-effect.
3868 Usually accessed via the C<SvPVbyte_nolen> macro.
3870 char* sv_2pvbyte_nolen(SV* sv)
3877 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3878 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
3880 Usually accessed via the C<SvPVutf8> macro.
3882 char* sv_2pvutf8(SV* sv, STRLEN* lp)
3887 =item sv_2pvutf8_nolen
3889 Return a pointer to the UTF-8-encoded representation of the SV.
3890 May cause the SV to be upgraded to UTF-8 as a side-effect.
3892 Usually accessed via the C<SvPVutf8_nolen> macro.
3894 char* sv_2pvutf8_nolen(SV* sv)
3901 Returns a pointer to the string value of an SV, and sets *lp to its length.
3902 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
3904 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
3905 usually end up here too.
3907 char* sv_2pv_flags(SV* sv, STRLEN* lp, I32 flags)
3914 Like C<sv_2pv()>, but doesn't return the length too. You should usually
3915 use the macro wrapper C<SvPV_nolen(sv)> instead.
3916 char* sv_2pv_nolen(SV* sv)
3923 Return the unsigned integer value of an SV, doing any necessary string
3924 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
3925 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
3927 UV sv_2uv_flags(SV* sv, I32 flags)
3934 Remove any string offset. You should normally use the C<SvOOK_off> macro
3937 int sv_backoff(SV* sv)
3944 Blesses an SV into a specified package. The SV must be an RV. The package
3945 must be designated by its stash (see C<gv_stashpv()>). The reference count
3946 of the SV is unaffected.
3948 SV* sv_bless(SV* sv, HV* stash)
3955 Concatenates the string onto the end of the string which is in the SV.
3956 If the SV has the UTF-8 status set, then the bytes appended should be
3957 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
3959 void sv_catpv(SV* sv, const char* ptr)
3966 Processes its arguments like C<sprintf> and appends the formatted
3967 output to an SV. If the appended data contains "wide" characters
3968 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
3969 and characters >255 formatted with %c), the original SV might get
3970 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
3971 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
3972 valid UTF-8; if the original SV was bytes, the pattern should be too.
3974 void sv_catpvf(SV* sv, const char* pat, ...)
3981 Like C<sv_catpvf>, but also handles 'set' magic.
3983 void sv_catpvf_mg(SV *sv, const char* pat, ...)
3990 Concatenates the string onto the end of the string which is in the SV. The
3991 C<len> indicates number of bytes to copy. If the SV has the UTF-8
3992 status set, then the bytes appended should be valid UTF-8.
3993 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
3995 void sv_catpvn(SV* sv, const char* ptr, STRLEN len)
4000 =item sv_catpvn_flags
4002 Concatenates the string onto the end of the string which is in the SV. The
4003 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4004 status set, then the bytes appended should be valid UTF-8.
4005 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4006 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4007 in terms of this function.
4009 void sv_catpvn_flags(SV* sv, const char* ptr, STRLEN len, I32 flags)
4016 Like C<sv_catpvn>, but also handles 'set' magic.
4018 void sv_catpvn_mg(SV *sv, const char *ptr, STRLEN len)
4023 =item sv_catpvn_nomg
4025 Like C<sv_catpvn> but doesn't process magic.
4027 void sv_catpvn_nomg(SV* sv, const char* ptr, STRLEN len)
4034 Like C<sv_catpv>, but also handles 'set' magic.
4036 void sv_catpv_mg(SV *sv, const char *ptr)
4043 Concatenates the string from SV C<ssv> onto the end of the string in
4044 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4045 not 'set' magic. See C<sv_catsv_mg>.
4047 void sv_catsv(SV* dsv, SV* ssv)
4052 =item sv_catsv_flags
4054 Concatenates the string from SV C<ssv> onto the end of the string in
4055 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4056 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4057 and C<sv_catsv_nomg> are implemented in terms of this function.
4059 void sv_catsv_flags(SV* dsv, SV* ssv, I32 flags)
4066 Like C<sv_catsv>, but also handles 'set' magic.
4068 void sv_catsv_mg(SV *dstr, SV *sstr)
4075 Like C<sv_catsv> but doesn't process magic.
4077 void sv_catsv_nomg(SV* dsv, SV* ssv)
4084 Efficient removal of characters from the beginning of the string buffer.
4085 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4086 the string buffer. The C<ptr> becomes the first character of the adjusted
4087 string. Uses the "OOK hack".
4088 Beware: after this function returns, C<ptr> and SvPVX(sv) may no longer
4089 refer to the same chunk of data.
4091 void sv_chop(SV* sv, char* ptr)
4098 Clear an SV: call any destructors, free up any memory used by the body,
4099 and free the body itself. The SV's head is I<not> freed, although
4100 its type is set to all 1's so that it won't inadvertently be assumed
4101 to be live during global destruction etc.
4102 This function should only be called when REFCNT is zero. Most of the time
4103 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
4106 void sv_clear(SV* sv)
4113 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
4114 string in C<sv1> is less than, equal to, or greater than the string in
4115 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
4116 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
4118 I32 sv_cmp(SV* sv1, SV* sv2)
4125 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
4126 'use bytes' aware, handles get magic, and will coerce its args to strings
4127 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
4129 I32 sv_cmp_locale(SV* sv1, SV* sv2)
4136 Add Collate Transform magic to an SV if it doesn't already have it.
4138 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
4139 scalar data of the variable, but transformed to such a format that a normal
4140 memory comparison can be used to compare the data according to the locale
4143 char* sv_collxfrm(SV* sv, STRLEN* nxp)
4150 Copies a stringified representation of the source SV into the
4151 destination SV. Automatically performs any necessary mg_get and
4152 coercion of numeric values into strings. Guaranteed to preserve
4153 UTF-8 flag even from overloaded objects. Similar in nature to
4154 sv_2pv[_flags] but operates directly on an SV instead of just the
4155 string. Mostly uses sv_2pv_flags to do its work, except when that
4156 would lose the UTF-8'ness of the PV.
4158 void sv_copypv(SV* dsv, SV* ssv)
4165 Auto-decrement of the value in the SV, doing string to numeric conversion
4166 if necessary. Handles 'get' magic.
4173 =item sv_derived_from
4175 Returns a boolean indicating whether the SV is derived from the specified
4176 class. This is the function that implements C<UNIVERSAL::isa>. It works
4177 for class names as well as for objects.
4179 bool sv_derived_from(SV* sv, const char* name)
4182 Found in file universal.c
4186 Returns a boolean indicating whether the strings in the two SVs are
4187 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
4188 coerce its args to strings if necessary.
4190 I32 sv_eq(SV* sv1, SV* sv2)
4195 =item sv_force_normal
4197 Undo various types of fakery on an SV: if the PV is a shared string, make
4198 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4199 an xpvmg. See also C<sv_force_normal_flags>.
4201 void sv_force_normal(SV *sv)
4206 =item sv_force_normal_flags
4208 Undo various types of fakery on an SV: if the PV is a shared string, make
4209 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4210 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4211 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4212 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4213 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4214 set to some other value.) In addition, the C<flags> parameter gets passed to
4215 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4216 with flags set to 0.
4218 void sv_force_normal_flags(SV *sv, U32 flags)
4225 Decrement an SV's reference count, and if it drops to zero, call
4226 C<sv_clear> to invoke destructors and free up any memory used by
4227 the body; finally, deallocate the SV's head itself.
4228 Normally called via a wrapper macro C<SvREFCNT_dec>.
4230 void sv_free(SV* sv)
4237 Get a line from the filehandle and store it into the SV, optionally
4238 appending to the currently-stored string.
4240 char* sv_gets(SV* sv, PerlIO* fp, I32 append)
4247 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
4248 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
4249 Use the C<SvGROW> wrapper instead.
4251 char* sv_grow(SV* sv, STRLEN newlen)
4258 Auto-increment of the value in the SV, doing string to numeric conversion
4259 if necessary. Handles 'get' magic.
4268 Inserts a string at the specified offset/length within the SV. Similar to
4269 the Perl substr() function.
4271 void sv_insert(SV* bigsv, STRLEN offset, STRLEN len, char* little, STRLEN littlelen)
4278 Returns a boolean indicating whether the SV is blessed into the specified
4279 class. This does not check for subtypes; use C<sv_derived_from> to verify
4280 an inheritance relationship.
4282 int sv_isa(SV* sv, const char* name)
4289 Returns a boolean indicating whether the SV is an RV pointing to a blessed
4290 object. If the SV is not an RV, or if the object is not blessed, then this
4293 int sv_isobject(SV* sv)
4300 A private implementation of the C<SvIVx> macro for compilers which can't
4301 cope with complex macro expressions. Always use the macro instead.
4310 Returns the length of the string in the SV. Handles magic and type
4311 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
4313 STRLEN sv_len(SV* sv)
4320 Returns the number of characters in the string in an SV, counting wide
4321 UTF-8 bytes as a single character. Handles magic and type coercion.
4323 STRLEN sv_len_utf8(SV* sv)
4330 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4331 then adds a new magic item of type C<how> to the head of the magic list.
4333 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4334 handling of the C<name> and C<namlen> arguments.
4336 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4337 to add more than one instance of the same 'how'.
4339 void sv_magic(SV* sv, SV* obj, int how, const char* name, I32 namlen)
4346 Adds magic to an SV, upgrading it if necessary. Applies the
4347 supplied vtable and returns a pointer to the magic added.
4349 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4350 In particular, you can add magic to SvREADONLY SVs, and add more than
4351 one instance of the same 'how'.
4353 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4354 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4355 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4356 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4358 (This is now used as a subroutine by C<sv_magic>.)
4360 MAGIC * sv_magicext(SV* sv, SV* obj, int how, MGVTBL *vtbl, const char* name, I32 namlen)
4367 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
4368 The new SV is marked as mortal. It will be destroyed "soon", either by an
4369 explicit call to FREETMPS, or by an implicit call at places such as
4370 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
4372 SV* sv_mortalcopy(SV* oldsv)
4379 Creates a new null SV which is mortal. The reference count of the SV is
4380 set to 1. It will be destroyed "soon", either by an explicit call to
4381 FREETMPS, or by an implicit call at places such as statement boundaries.
4382 See also C<sv_mortalcopy> and C<sv_2mortal>.
4391 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
4394 SV* sv_newref(SV* sv)
4401 A private implementation of the C<SvNVx> macro for compilers which can't
4402 cope with complex macro expressions. Always use the macro instead.
4411 Converts the value pointed to by offsetp from a count of bytes from the
4412 start of the string, to a count of the equivalent number of UTF-8 chars.
4413 Handles magic and type coercion.
4415 void sv_pos_b2u(SV* sv, I32* offsetp)
4422 Converts the value pointed to by offsetp from a count of UTF-8 chars from
4423 the start of the string, to a count of the equivalent number of bytes; if
4424 lenp is non-zero, it does the same to lenp, but this time starting from
4425 the offset, rather than from the start of the string. Handles magic and
4428 void sv_pos_u2b(SV* sv, I32* offsetp, I32* lenp)
4435 Use the C<SvPV_nolen> macro instead
4444 Use C<SvPVbyte_nolen> instead.
4446 char* sv_pvbyte(SV *sv)
4453 A private implementation of the C<SvPVbyte> macro for compilers
4454 which can't cope with complex macro expressions. Always use the macro
4457 char* sv_pvbyten(SV *sv, STRLEN *len)
4462 =item sv_pvbyten_force
4464 A private implementation of the C<SvPVbytex_force> macro for compilers
4465 which can't cope with complex macro expressions. Always use the macro
4468 char* sv_pvbyten_force(SV* sv, STRLEN* lp)
4475 A private implementation of the C<SvPV> macro for compilers which can't
4476 cope with complex macro expressions. Always use the macro instead.
4478 char* sv_pvn(SV *sv, STRLEN *len)
4485 Get a sensible string out of the SV somehow.
4486 A private implementation of the C<SvPV_force> macro for compilers which
4487 can't cope with complex macro expressions. Always use the macro instead.
4489 char* sv_pvn_force(SV* sv, STRLEN* lp)
4494 =item sv_pvn_force_flags
4496 Get a sensible string out of the SV somehow.
4497 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
4498 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
4499 implemented in terms of this function.
4500 You normally want to use the various wrapper macros instead: see
4501 C<SvPV_force> and C<SvPV_force_nomg>
4503 char* sv_pvn_force_flags(SV* sv, STRLEN* lp, I32 flags)
4510 Use the C<SvPVutf8_nolen> macro instead
4512 char* sv_pvutf8(SV *sv)
4519 A private implementation of the C<SvPVutf8> macro for compilers
4520 which can't cope with complex macro expressions. Always use the macro
4523 char* sv_pvutf8n(SV *sv, STRLEN *len)
4528 =item sv_pvutf8n_force
4530 A private implementation of the C<SvPVutf8_force> macro for compilers
4531 which can't cope with complex macro expressions. Always use the macro
4534 char* sv_pvutf8n_force(SV* sv, STRLEN* lp)
4541 Returns a string describing what the SV is a reference to.
4543 char* sv_reftype(SV* sv, int ob)
4550 Make the first argument a copy of the second, then delete the original.
4551 The target SV physically takes over ownership of the body of the source SV
4552 and inherits its flags; however, the target keeps any magic it owns,
4553 and any magic in the source is discarded.
4554 Note that this is a rather specialist SV copying operation; most of the
4555 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4557 void sv_replace(SV* sv, SV* nsv)
4562 =item sv_report_used
4564 Dump the contents of all SVs not yet freed. (Debugging aid).
4566 void sv_report_used()
4573 Underlying implementation for the C<reset> Perl function.
4574 Note that the perl-level function is vaguely deprecated.
4576 void sv_reset(char* s, HV* stash)
4583 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4584 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4585 push a back-reference to this RV onto the array of backreferences
4586 associated with that magic.
4588 SV* sv_rvweaken(SV *sv)
4595 Copies an integer into the given SV, upgrading first if necessary.
4596 Does not handle 'set' magic. See also C<sv_setiv_mg>.
4598 void sv_setiv(SV* sv, IV num)
4605 Like C<sv_setiv>, but also handles 'set' magic.
4607 void sv_setiv_mg(SV *sv, IV i)
4614 Copies a double into the given SV, upgrading first if necessary.
4615 Does not handle 'set' magic. See also C<sv_setnv_mg>.
4617 void sv_setnv(SV* sv, NV num)
4624 Like C<sv_setnv>, but also handles 'set' magic.
4626 void sv_setnv_mg(SV *sv, NV num)
4633 Copies a string into an SV. The string must be null-terminated. Does not
4634 handle 'set' magic. See C<sv_setpv_mg>.
4636 void sv_setpv(SV* sv, const char* ptr)
4643 Works like C<sv_catpvf> but copies the text into the SV instead of
4644 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
4646 void sv_setpvf(SV* sv, const char* pat, ...)
4653 Like C<sv_setpvf>, but also handles 'set' magic.
4655 void sv_setpvf_mg(SV *sv, const char* pat, ...)
4662 Copies an integer into the given SV, also updating its string value.
4663 Does not handle 'set' magic. See C<sv_setpviv_mg>.
4665 void sv_setpviv(SV* sv, IV num)
4672 Like C<sv_setpviv>, but also handles 'set' magic.
4674 void sv_setpviv_mg(SV *sv, IV iv)
4681 Copies a string into an SV. The C<len> parameter indicates the number of
4682 bytes to be copied. If the C<ptr> argument is NULL the SV will become
4683 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4685 void sv_setpvn(SV* sv, const char* ptr, STRLEN len)
4692 Like C<sv_setpvn>, but also handles 'set' magic.
4694 void sv_setpvn_mg(SV *sv, const char *ptr, STRLEN len)
4701 Like C<sv_setpv>, but also handles 'set' magic.
4703 void sv_setpv_mg(SV *sv, const char *ptr)
4710 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
4711 argument will be upgraded to an RV. That RV will be modified to point to
4712 the new SV. The C<classname> argument indicates the package for the
4713 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4714 will have a reference count of 1, and the RV will be returned.
4716 SV* sv_setref_iv(SV* rv, const char* classname, IV iv)
4723 Copies a double into a new SV, optionally blessing the SV. The C<rv>
4724 argument will be upgraded to an RV. That RV will be modified to point to
4725 the new SV. The C<classname> argument indicates the package for the
4726 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4727 will have a reference count of 1, and the RV will be returned.
4729 SV* sv_setref_nv(SV* rv, const char* classname, NV nv)
4736 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
4737 argument will be upgraded to an RV. That RV will be modified to point to
4738 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
4739 into the SV. The C<classname> argument indicates the package for the
4740 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4741 will have a reference count of 1, and the RV will be returned.
4743 Do not use with other Perl types such as HV, AV, SV, CV, because those
4744 objects will become corrupted by the pointer copy process.
4746 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
4748 SV* sv_setref_pv(SV* rv, const char* classname, void* pv)
4755 Copies a string into a new SV, optionally blessing the SV. The length of the
4756 string must be specified with C<n>. The C<rv> argument will be upgraded to
4757 an RV. That RV will be modified to point to the new SV. The C<classname>
4758 argument indicates the package for the blessing. Set C<classname> to
4759 C<Nullch> to avoid the blessing. The new SV will have a reference count
4760 of 1, and the RV will be returned.
4762 Note that C<sv_setref_pv> copies the pointer while this copies the string.
4764 SV* sv_setref_pvn(SV* rv, const char* classname, char* pv, STRLEN n)
4771 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
4772 argument will be upgraded to an RV. That RV will be modified to point to
4773 the new SV. The C<classname> argument indicates the package for the
4774 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4775 will have a reference count of 1, and the RV will be returned.
4777 SV* sv_setref_uv(SV* rv, const char* classname, UV uv)
4784 Copies the contents of the source SV C<ssv> into the destination SV
4785 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4786 function if the source SV needs to be reused. Does not handle 'set' magic.
4787 Loosely speaking, it performs a copy-by-value, obliterating any previous
4788 content of the destination.
4790 You probably want to use one of the assortment of wrappers, such as
4791 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4792 C<SvSetMagicSV_nosteal>.
4794 void sv_setsv(SV* dsv, SV* ssv)
4799 =item sv_setsv_flags
4801 Copies the contents of the source SV C<ssv> into the destination SV
4802 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4803 function if the source SV needs to be reused. Does not handle 'set' magic.
4804 Loosely speaking, it performs a copy-by-value, obliterating any previous
4805 content of the destination.
4806 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
4807 C<ssv> if appropriate, else not. If the C<flags> parameter has the
4808 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
4809 and C<sv_setsv_nomg> are implemented in terms of this function.
4811 You probably want to use one of the assortment of wrappers, such as
4812 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4813 C<SvSetMagicSV_nosteal>.
4815 This is the primary function for copying scalars, and most other
4816 copy-ish functions and macros use this underneath.
4818 void sv_setsv_flags(SV* dsv, SV* ssv, I32 flags)
4825 Like C<sv_setsv>, but also handles 'set' magic.
4827 void sv_setsv_mg(SV *dstr, SV *sstr)
4834 Like C<sv_setsv> but doesn't process magic.
4836 void sv_setsv_nomg(SV* dsv, SV* ssv)
4843 Copies an unsigned integer into the given SV, upgrading first if necessary.
4844 Does not handle 'set' magic. See also C<sv_setuv_mg>.
4846 void sv_setuv(SV* sv, UV num)
4853 Like C<sv_setuv>, but also handles 'set' magic.
4855 void sv_setuv_mg(SV *sv, UV u)
4862 Taint an SV. Use C<SvTAINTED_on> instead.
4863 void sv_taint(SV* sv)
4870 Test an SV for taintedness. Use C<SvTAINTED> instead.
4871 bool sv_tainted(SV* sv)
4878 Returns true if the SV has a true value by Perl's rules.
4879 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
4880 instead use an in-line version.
4889 Removes all magic of type C<type> from an SV.
4891 int sv_unmagic(SV* sv, int type)
4898 Unsets the RV status of the SV, and decrements the reference count of
4899 whatever was being referenced by the RV. This can almost be thought of
4900 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
4901 being zero. See C<SvROK_off>.
4903 void sv_unref(SV* sv)
4908 =item sv_unref_flags
4910 Unsets the RV status of the SV, and decrements the reference count of
4911 whatever was being referenced by the RV. This can almost be thought of
4912 as a reversal of C<newSVrv>. The C<cflags> argument can contain
4913 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
4914 (otherwise the decrementing is conditional on the reference count being
4915 different from one or the reference being a readonly SV).
4918 void sv_unref_flags(SV* sv, U32 flags)
4925 Untaint an SV. Use C<SvTAINTED_off> instead.
4926 void sv_untaint(SV* sv)
4933 Upgrade an SV to a more complex form. Generally adds a new body type to the
4934 SV, then copies across as much information as possible from the old body.
4935 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
4937 bool sv_upgrade(SV* sv, U32 mt)
4944 Tells an SV to use C<ptr> to find its string value. Normally the string is
4945 stored inside the SV but sv_usepvn allows the SV to use an outside string.
4946 The C<ptr> should point to memory that was allocated by C<malloc>. The
4947 string length, C<len>, must be supplied. This function will realloc the
4948 memory pointed to by C<ptr>, so that pointer should not be freed or used by
4949 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
4950 See C<sv_usepvn_mg>.
4952 void sv_usepvn(SV* sv, char* ptr, STRLEN len)
4959 Like C<sv_usepvn>, but also handles 'set' magic.
4961 void sv_usepvn_mg(SV *sv, char *ptr, STRLEN len)
4966 =item sv_utf8_decode
4968 If the PV of the SV is an octet sequence in UTF-8
4969 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
4970 so that it looks like a character. If the PV contains only single-byte
4971 characters, the C<SvUTF8> flag stays being off.
4972 Scans PV for validity and returns false if the PV is invalid UTF-8.
4974 NOTE: this function is experimental and may change or be
4975 removed without notice.
4977 bool sv_utf8_decode(SV *sv)
4982 =item sv_utf8_downgrade
4984 Attempts to convert the PV of an SV from characters to bytes.
4985 If the PV contains a character beyond byte, this conversion will fail;
4986 in this case, either returns false or, if C<fail_ok> is not
4989 This is not as a general purpose Unicode to byte encoding interface:
4990 use the Encode extension for that.
4992 NOTE: this function is experimental and may change or be
4993 removed without notice.
4995 bool sv_utf8_downgrade(SV *sv, bool fail_ok)
5000 =item sv_utf8_encode
5002 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
5003 flag off so that it looks like octets again.
5005 void sv_utf8_encode(SV *sv)
5010 =item sv_utf8_upgrade
5012 Converts the PV of an SV to its UTF-8-encoded form.
5013 Forces the SV to string form if it is not already.
5014 Always sets the SvUTF8 flag to avoid future validity checks even
5015 if all the bytes have hibit clear.
5017 This is not as a general purpose byte encoding to Unicode interface:
5018 use the Encode extension for that.
5020 STRLEN sv_utf8_upgrade(SV *sv)
5025 =item sv_utf8_upgrade_flags
5027 Converts the PV of an SV to its UTF-8-encoded form.
5028 Forces the SV to string form if it is not already.
5029 Always sets the SvUTF8 flag to avoid future validity checks even
5030 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
5031 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
5032 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
5034 This is not as a general purpose byte encoding to Unicode interface:
5035 use the Encode extension for that.
5037 STRLEN sv_utf8_upgrade_flags(SV *sv, I32 flags)
5044 A private implementation of the C<SvUVx> macro for compilers which can't
5045 cope with complex macro expressions. Always use the macro instead.
5054 Processes its arguments like C<vsprintf> and appends the formatted output
5055 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
5057 Usually used via its frontend C<sv_catpvf>.
5059 void sv_vcatpvf(SV* sv, const char* pat, va_list* args)
5066 Processes its arguments like C<vsprintf> and appends the formatted output
5067 to an SV. Uses an array of SVs if the C style variable argument list is
5068 missing (NULL). When running with taint checks enabled, indicates via
5069 C<maybe_tainted> if results are untrustworthy (often due to the use of
5072 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
5074 void sv_vcatpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
5081 Like C<sv_vcatpvf>, but also handles 'set' magic.
5083 Usually used via its frontend C<sv_catpvf_mg>.
5085 void sv_vcatpvf_mg(SV* sv, const char* pat, va_list* args)
5092 Works like C<sv_vcatpvf> but copies the text into the SV instead of
5093 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
5095 Usually used via its frontend C<sv_setpvf>.
5097 void sv_vsetpvf(SV* sv, const char* pat, va_list* args)
5104 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
5107 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
5109 void sv_vsetpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
5116 Like C<sv_vsetpvf>, but also handles 'set' magic.
5118 Usually used via its frontend C<sv_setpvf_mg>.
5120 void sv_vsetpvf_mg(SV* sv, const char* pat, va_list* args)
5128 =head1 Unicode Support
5132 =item bytes_from_utf8
5134 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
5135 Unlike <utf8_to_bytes> but like C<bytes_to_utf8>, returns a pointer to
5136 the newly-created string, and updates C<len> to contain the new
5137 length. Returns the original string if no conversion occurs, C<len>
5138 is unchanged. Do nothing if C<is_utf8> points to 0. Sets C<is_utf8> to
5139 0 if C<s> is converted or contains all 7bit characters.
5141 NOTE: this function is experimental and may change or be
5142 removed without notice.
5144 U8* bytes_from_utf8(U8 *s, STRLEN *len, bool *is_utf8)
5147 Found in file utf8.c
5151 Converts a string C<s> of length C<len> from ASCII into UTF-8 encoding.
5152 Returns a pointer to the newly-created string, and sets C<len> to
5153 reflect the new length.
5155 If you want to convert to UTF-8 from other encodings than ASCII,
5156 see sv_recode_to_utf8().
5158 NOTE: this function is experimental and may change or be
5159 removed without notice.
5161 U8* bytes_to_utf8(U8 *s, STRLEN *len)
5164 Found in file utf8.c
5168 Return true if the strings s1 and s2 differ case-insensitively, false
5169 if not (if they are equal case-insensitively). If u1 is true, the
5170 string s1 is assumed to be in UTF-8-encoded Unicode. If u2 is true,
5171 the string s2 is assumed to be in UTF-8-encoded Unicode. If u1 or u2
5172 are false, the respective string is assumed to be in native 8-bit
5175 If the pe1 and pe2 are non-NULL, the scanning pointers will be copied
5176 in there (they will point at the beginning of the I<next> character).
5177 If the pointers behind pe1 or pe2 are non-NULL, they are the end
5178 pointers beyond which scanning will not continue under any
5179 circumstances. If the byte lengths l1 and l2 are non-zero, s1+l1 and
5180 s2+l2 will be used as goal end pointers that will also stop the scan,
5181 and which qualify towards defining a successful match: all the scans
5182 that define an explicit length must reach their goal pointers for
5183 a match to succeed).
5185 For case-insensitiveness, the "casefolding" of Unicode is used
5186 instead of upper/lowercasing both the characters, see
5187 http://www.unicode.org/unicode/reports/tr21/ (Case Mappings).
5189 I32 ibcmp_utf8(const char* a, char **pe1, UV l1, bool u1, const char* b, char **pe2, UV l2, bool u2)
5192 Found in file utf8.c
5196 Tests if some arbitrary number of bytes begins in a valid UTF-8
5197 character. Note that an INVARIANT (i.e. ASCII) character is a valid
5198 UTF-8 character. The actual number of bytes in the UTF-8 character
5199 will be returned if it is valid, otherwise 0.
5201 STRLEN is_utf8_char(U8 *p)
5204 Found in file utf8.c
5206 =item is_utf8_string
5208 Returns true if first C<len> bytes of the given string form a valid
5209 UTF-8 string, false otherwise. Note that 'a valid UTF-8 string' does
5210 not mean 'a string that contains code points above 0x7F encoded in UTF-8'
5211 because a valid ASCII string is a valid UTF-8 string.
5213 bool is_utf8_string(U8 *s, STRLEN len)
5216 Found in file utf8.c
5218 =item is_utf8_string_loc
5220 Like is_ut8_string but store the location of the failure in
5223 bool is_utf8_string_loc(U8 *s, STRLEN len, U8 **p)
5226 Found in file utf8.c
5228 =item pv_uni_display
5230 Build to the scalar dsv a displayable version of the string spv,
5231 length len, the displayable version being at most pvlim bytes long
5232 (if longer, the rest is truncated and "..." will be appended).
5234 The flags argument can have UNI_DISPLAY_ISPRINT set to display
5235 isPRINT()able characters as themselves, UNI_DISPLAY_BACKSLASH
5236 to display the \\[nrfta\\] as the backslashed versions (like '\n')
5237 (UNI_DISPLAY_BACKSLASH is preferred over UNI_DISPLAY_ISPRINT for \\).
5238 UNI_DISPLAY_QQ (and its alias UNI_DISPLAY_REGEX) have both
5239 UNI_DISPLAY_BACKSLASH and UNI_DISPLAY_ISPRINT turned on.
5241 The pointer to the PV of the dsv is returned.
5243 char* pv_uni_display(SV *dsv, U8 *spv, STRLEN len, STRLEN pvlim, UV flags)
5246 Found in file utf8.c
5250 The encoding is assumed to be an Encode object, the PV of the ssv is
5251 assumed to be octets in that encoding and decoding the input starts
5252 from the position which (PV + *offset) pointed to. The dsv will be
5253 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
5254 when the string tstr appears in decoding output or the input ends on
5255 the PV of the ssv. The value which the offset points will be modified
5256 to the last input position on the ssv.
5258 Returns TRUE if the terminator was found, else returns FALSE.
5260 bool sv_cat_decode(SV* dsv, SV *encoding, SV *ssv, int *offset, char* tstr, int tlen)
5265 =item sv_recode_to_utf8
5267 The encoding is assumed to be an Encode object, on entry the PV
5268 of the sv is assumed to be octets in that encoding, and the sv
5269 will be converted into Unicode (and UTF-8).
5271 If the sv already is UTF-8 (or if it is not POK), or if the encoding
5272 is not a reference, nothing is done to the sv. If the encoding is not
5273 an C<Encode::XS> Encoding object, bad things will happen.
5274 (See F<lib/encoding.pm> and L<Encode>).
5276 The PV of the sv is returned.
5278 char* sv_recode_to_utf8(SV* sv, SV *encoding)
5283 =item sv_uni_display
5285 Build to the scalar dsv a displayable version of the scalar sv,
5286 the displayable version being at most pvlim bytes long
5287 (if longer, the rest is truncated and "..." will be appended).
5289 The flags argument is as in pv_uni_display().
5291 The pointer to the PV of the dsv is returned.
5293 char* sv_uni_display(SV *dsv, SV *ssv, STRLEN pvlim, UV flags)
5296 Found in file utf8.c
5300 The "p" contains the pointer to the UTF-8 string encoding
5301 the character that is being converted.
5303 The "ustrp" is a pointer to the character buffer to put the
5304 conversion result to. The "lenp" is a pointer to the length
5307 The "swashp" is a pointer to the swash to use.
5309 Both the special and normal mappings are stored lib/unicore/To/Foo.pl,
5310 and loaded by SWASHGET, using lib/utf8_heavy.pl. The special (usually,
5311 but not always, a multicharacter mapping), is tried first.
5313 The "special" is a string like "utf8::ToSpecLower", which means the
5314 hash %utf8::ToSpecLower. The access to the hash is through
5315 Perl_to_utf8_case().
5317 The "normal" is a string like "ToLower" which means the swash
5320 UV to_utf8_case(U8 *p, U8* ustrp, STRLEN *lenp, SV **swash, char *normal, char *special)
5323 Found in file utf8.c
5327 Convert the UTF-8 encoded character at p to its foldcase version and
5328 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
5329 that the ustrp needs to be at least UTF8_MAXLEN_FOLD+1 bytes since the
5330 foldcase version may be longer than the original character (up to
5333 The first character of the foldcased version is returned
5334 (but note, as explained above, that there may be more.)
5336 UV to_utf8_fold(U8 *p, U8* ustrp, STRLEN *lenp)
5339 Found in file utf8.c
5343 Convert the UTF-8 encoded character at p to its lowercase version and
5344 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
5345 that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the
5346 lowercase version may be longer than the original character (up to two
5349 The first character of the lowercased version is returned
5350 (but note, as explained above, that there may be more.)
5352 UV to_utf8_lower(U8 *p, U8* ustrp, STRLEN *lenp)
5355 Found in file utf8.c
5359 Convert the UTF-8 encoded character at p to its titlecase version and
5360 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
5361 that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the
5362 titlecase version may be longer than the original character (up to two
5365 The first character of the titlecased version is returned
5366 (but note, as explained above, that there may be more.)
5368 UV to_utf8_title(U8 *p, U8* ustrp, STRLEN *lenp)
5371 Found in file utf8.c
5375 Convert the UTF-8 encoded character at p to its uppercase version and
5376 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
5377 that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the
5378 uppercase version may be longer than the original character (up to two
5381 The first character of the uppercased version is returned
5382 (but note, as explained above, that there may be more.)
5384 UV to_utf8_upper(U8 *p, U8* ustrp, STRLEN *lenp)
5387 Found in file utf8.c
5389 =item utf8n_to_uvchr
5391 Returns the native character value of the first character in the string C<s>
5392 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
5393 length, in bytes, of that character.
5395 Allows length and flags to be passed to low level routine.
5397 UV utf8n_to_uvchr(U8 *s, STRLEN curlen, STRLEN* retlen, U32 flags)
5400 Found in file utf8.c
5402 =item utf8n_to_uvuni
5404 Bottom level UTF-8 decode routine.
5405 Returns the unicode code point value of the first character in the string C<s>
5406 which is assumed to be in UTF-8 encoding and no longer than C<curlen>;
5407 C<retlen> will be set to the length, in bytes, of that character.
5409 If C<s> does not point to a well-formed UTF-8 character, the behaviour
5410 is dependent on the value of C<flags>: if it contains UTF8_CHECK_ONLY,
5411 it is assumed that the caller will raise a warning, and this function
5412 will silently just set C<retlen> to C<-1> and return zero. If the
5413 C<flags> does not contain UTF8_CHECK_ONLY, warnings about
5414 malformations will be given, C<retlen> will be set to the expected
5415 length of the UTF-8 character in bytes, and zero will be returned.
5417 The C<flags> can also contain various flags to allow deviations from
5418 the strict UTF-8 encoding (see F<utf8.h>).
5420 Most code should use utf8_to_uvchr() rather than call this directly.
5422 UV utf8n_to_uvuni(U8 *s, STRLEN curlen, STRLEN* retlen, U32 flags)
5425 Found in file utf8.c
5429 Returns the number of UTF-8 characters between the UTF-8 pointers C<a>
5432 WARNING: use only if you *know* that the pointers point inside the
5435 IV utf8_distance(U8 *a, U8 *b)
5438 Found in file utf8.c
5442 Return the UTF-8 pointer C<s> displaced by C<off> characters, either
5443 forward or backward.
5445 WARNING: do not use the following unless you *know* C<off> is within
5446 the UTF-8 data pointed to by C<s> *and* that on entry C<s> is aligned
5447 on the first byte of character or just after the last byte of a character.
5449 U8* utf8_hop(U8 *s, I32 off)
5452 Found in file utf8.c
5456 Return the length of the UTF-8 char encoded string C<s> in characters.
5457 Stops at C<e> (inclusive). If C<e E<lt> s> or if the scan would end
5458 up past C<e>, croaks.
5460 STRLEN utf8_length(U8* s, U8 *e)
5463 Found in file utf8.c
5467 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
5468 Unlike C<bytes_to_utf8>, this over-writes the original string, and
5469 updates len to contain the new length.
5470 Returns zero on failure, setting C<len> to -1.
5472 NOTE: this function is experimental and may change or be
5473 removed without notice.
5475 U8* utf8_to_bytes(U8 *s, STRLEN *len)
5478 Found in file utf8.c
5482 Returns the native character value of the first character in the string C<s>
5483 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
5484 length, in bytes, of that character.
5486 If C<s> does not point to a well-formed UTF-8 character, zero is
5487 returned and retlen is set, if possible, to -1.
5489 UV utf8_to_uvchr(U8 *s, STRLEN* retlen)
5492 Found in file utf8.c
5496 Returns the Unicode code point of the first character in the string C<s>
5497 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
5498 length, in bytes, of that character.
5500 This function should only be used when returned UV is considered
5501 an index into the Unicode semantic tables (e.g. swashes).
5503 If C<s> does not point to a well-formed UTF-8 character, zero is
5504 returned and retlen is set, if possible, to -1.
5506 UV utf8_to_uvuni(U8 *s, STRLEN* retlen)
5509 Found in file utf8.c
5513 Adds the UTF-8 representation of the Native codepoint C<uv> to the end
5514 of the string C<d>; C<d> should be have at least C<UTF8_MAXLEN+1> free
5515 bytes available. The return value is the pointer to the byte after the
5516 end of the new character. In other words,
5518 d = uvchr_to_utf8(d, uv);
5520 is the recommended wide native character-aware way of saying
5524 U8* uvchr_to_utf8(U8 *d, UV uv)
5527 Found in file utf8.c
5529 =item uvuni_to_utf8_flags
5531 Adds the UTF-8 representation of the Unicode codepoint C<uv> to the end
5532 of the string C<d>; C<d> should be have at least C<UTF8_MAXLEN+1> free
5533 bytes available. The return value is the pointer to the byte after the
5534 end of the new character. In other words,
5536 d = uvuni_to_utf8_flags(d, uv, flags);
5540 d = uvuni_to_utf8(d, uv);
5542 (which is equivalent to)
5544 d = uvuni_to_utf8_flags(d, uv, 0);
5546 is the recommended Unicode-aware way of saying
5550 U8* uvuni_to_utf8_flags(U8 *d, UV uv, UV flags)
5553 Found in file utf8.c
5558 =head1 Variables created by C<xsubpp> and C<xsubpp> internal functions
5564 Variable which is setup by C<xsubpp> to indicate the stack base offset,
5565 used by the C<ST>, C<XSprePUSH> and C<XSRETURN> macros. The C<dMARK> macro
5566 must be called prior to setup the C<MARK> variable.
5571 Found in file XSUB.h
5575 Variable which is setup by C<xsubpp> to indicate the
5576 class name for a C++ XS constructor. This is always a C<char*>. See C<THIS>.
5581 Found in file XSUB.h
5585 Sets up the C<ax> variable.
5586 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
5591 Found in file XSUB.h
5595 Sets up the C<items> variable.
5596 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
5601 Found in file XSUB.h
5605 Sets up the C<padoff_du> variable for an XSUB that wishes to use
5611 Found in file XSUB.h
5615 Sets up stack and mark pointers for an XSUB, calling dSP and dMARK.
5616 Sets up the C<ax> and C<items> variables by calling C<dAX> and C<dITEMS>.
5617 This is usually handled automatically by C<xsubpp>.
5622 Found in file XSUB.h
5626 Sets up the C<ix> variable for an XSUB which has aliases. This is usually
5627 handled automatically by C<xsubpp>.
5632 Found in file XSUB.h
5636 Variable which is setup by C<xsubpp> to indicate the number of
5637 items on the stack. See L<perlxs/"Variable-length Parameter Lists">.
5642 Found in file XSUB.h
5646 Variable which is setup by C<xsubpp> to indicate which of an
5647 XSUB's aliases was used to invoke it. See L<perlxs/"The ALIAS: Keyword">.
5652 Found in file XSUB.h
5656 Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
5660 Found in file XSUB.h
5664 Variable which is setup by C<xsubpp> to hold the return value for an
5665 XSUB. This is always the proper type for the XSUB. See
5666 L<perlxs/"The RETVAL Variable">.
5671 Found in file XSUB.h
5675 Used to access elements on the XSUB's stack.
5680 Found in file XSUB.h
5684 Variable which is setup by C<xsubpp> to designate the object in a C++
5685 XSUB. This is always the proper type for the C++ object. See C<CLASS> and
5686 L<perlxs/"Using XS With C++">.
5691 Found in file XSUB.h
5695 The SV* corresponding to the $_ variable. Works even if there
5696 is a lexical $_ in scope.
5699 Found in file XSUB.h
5703 Macro to declare an XSUB and its C parameter list. This is handled by
5707 Found in file XSUB.h
5711 The version identifier for an XS module. This is usually
5712 handled automatically by C<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>.
5715 Found in file XSUB.h
5717 =item XS_VERSION_BOOTCHECK
5719 Macro to verify that a PM module's $VERSION variable matches the XS
5720 module's C<XS_VERSION> variable. This is usually handled automatically by
5721 C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">.
5723 XS_VERSION_BOOTCHECK;
5726 Found in file XSUB.h
5731 =head1 Warning and Dieing
5737 This is the XSUB-writer's interface to Perl's C<die> function.
5738 Normally call this function the same way you call the C C<printf>
5739 function. Calling C<croak> returns control directly to Perl,
5740 sidestepping the normal C order of execution. See C<warn>.
5742 If you want to throw an exception object, assign the object to
5743 C<$@> and then pass C<Nullch> to croak():
5745 errsv = get_sv("@", TRUE);
5746 sv_setsv(errsv, exception_object);
5749 void croak(const char* pat, ...)
5752 Found in file util.c
5756 This is the XSUB-writer's interface to Perl's C<warn> function. Call this
5757 function the same way you call the C C<printf> function. See C<croak>.
5759 void warn(const char* pat, ...)
5762 Found in file util.c
5769 Until May 1997, this document was maintained by Jeff Okamoto
5770 <okamoto@corp.hp.com>. It is now maintained as part of Perl itself.
5772 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
5773 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
5774 Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
5775 Stephen McCamant, and Gurusamy Sarathy.
5777 API Listing originally by Dean Roehrich <roehrich@cray.com>.
5779 Updated to be autogenerated from comments in the source by Benjamin Stuhl.
5783 perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
projects / p5sagit/p5-mst-13.2.git / blob