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
182 I32 av_len(const AV* ar)
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, const char *pat, const 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, const char *pat, const 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(const char *pat, const char *patend, const char *s, const 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(const char *pat, const char *patend, const char *s, const char *strbeg, const 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, or NULL if C<stash> isn't a stash.
1082 See C<SvSTASH>, C<CvSTASH>.
1084 char* HvNAME(HV* stash)
1091 Check that a hash is in an internally consistent state.
1093 void hv_assert(HV* tb)
1100 Clears a hash, making it empty.
1102 void hv_clear(HV* tb)
1107 =item hv_clear_placeholders
1109 Clears any placeholders from a hash. If a restricted hash has any of its keys
1110 marked as readonly and the key is subsequently deleted, the key is not actually
1111 deleted but is marked by assigning it a value of &PL_sv_placeholder. This tags
1112 it so it will be ignored by future operations such as iterating over the hash,
1113 but will still allow the hash to have a value reassigned to the key at some
1114 future point. This function clears any such placeholder keys from the hash.
1115 See Hash::Util::lock_keys() for an example of its use.
1117 void hv_clear_placeholders(HV* hb)
1124 Deletes a key/value pair in the hash. The value SV is removed from the
1125 hash and returned to the caller. The C<klen> is the length of the key.
1126 The C<flags> value will normally be zero; if set to G_DISCARD then NULL
1129 SV* hv_delete(HV* tb, const char* key, I32 klen, I32 flags)
1136 Deletes a key/value pair in the hash. The value SV is removed from the
1137 hash and returned to the caller. The C<flags> value will normally be zero;
1138 if set to G_DISCARD then NULL will be returned. C<hash> can be a valid
1139 precomputed hash value, or 0 to ask for it to be computed.
1141 SV* hv_delete_ent(HV* tb, SV* key, I32 flags, U32 hash)
1148 Returns a boolean indicating whether the specified hash key exists. The
1149 C<klen> is the length of the key.
1151 bool hv_exists(HV* tb, const char* key, I32 klen)
1158 Returns a boolean indicating whether the specified hash key exists. C<hash>
1159 can be a valid precomputed hash value, or 0 to ask for it to be
1162 bool hv_exists_ent(HV* tb, SV* key, U32 hash)
1169 Returns the SV which corresponds to the specified key in the hash. The
1170 C<klen> is the length of the key. If C<lval> is set then the fetch will be
1171 part of a store. Check that the return value is non-null before
1172 dereferencing it to an C<SV*>.
1174 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1175 information on how to use this function on tied hashes.
1177 SV** hv_fetch(HV* tb, const char* key, I32 klen, I32 lval)
1184 Returns the hash entry which corresponds to the specified key in the hash.
1185 C<hash> must be a valid precomputed hash number for the given C<key>, or 0
1186 if you want the function to compute it. IF C<lval> is set then the fetch
1187 will be part of a store. Make sure the return value is non-null before
1188 accessing it. The return value when C<tb> is a tied hash is a pointer to a
1189 static location, so be sure to make a copy of the structure if you need to
1192 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1193 information on how to use this function on tied hashes.
1195 HE* hv_fetch_ent(HV* tb, SV* key, I32 lval, U32 hash)
1202 Prepares a starting point to traverse a hash table. Returns the number of
1203 keys in the hash (i.e. the same as C<HvKEYS(tb)>). The return value is
1204 currently only meaningful for hashes without tie magic.
1206 NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
1207 hash buckets that happen to be in use. If you still need that esoteric
1208 value, you can get it through the macro C<HvFILL(tb)>.
1211 I32 hv_iterinit(HV* tb)
1218 Returns the key from the current position of the hash iterator. See
1221 char* hv_iterkey(HE* entry, I32* retlen)
1228 Returns the key as an C<SV*> from the current position of the hash
1229 iterator. The return value will always be a mortal copy of the key. Also
1232 SV* hv_iterkeysv(HE* entry)
1239 Returns entries from a hash iterator. See C<hv_iterinit>.
1241 You may call C<hv_delete> or C<hv_delete_ent> on the hash entry that the
1242 iterator currently points to, without losing your place or invalidating your
1243 iterator. Note that in this case the current entry is deleted from the hash
1244 with your iterator holding the last reference to it. Your iterator is flagged
1245 to free the entry on the next call to C<hv_iternext>, so you must not discard
1246 your iterator immediately else the entry will leak - call C<hv_iternext> to
1247 trigger the resource deallocation.
1249 HE* hv_iternext(HV* tb)
1256 Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
1259 SV* hv_iternextsv(HV* hv, char** key, I32* retlen)
1264 =item hv_iternext_flags
1266 Returns entries from a hash iterator. See C<hv_iterinit> and C<hv_iternext>.
1267 The C<flags> value will normally be zero; if HV_ITERNEXT_WANTPLACEHOLDERS is
1268 set the placeholders keys (for restricted hashes) will be returned in addition
1269 to normal keys. By default placeholders are automatically skipped over.
1270 Currently a placeholder is implemented with a value that is
1271 C<&Perl_sv_placeholder>. Note that the implementation of placeholders and
1272 restricted hashes may change, and the implementation currently is
1273 insufficiently abstracted for any change to be tidy.
1275 NOTE: this function is experimental and may change or be
1276 removed without notice.
1278 HE* hv_iternext_flags(HV* tb, I32 flags)
1285 Returns the value from the current position of the hash iterator. See
1288 SV* hv_iterval(HV* tb, HE* entry)
1295 Adds magic to a hash. See C<sv_magic>.
1297 void hv_magic(HV* hv, GV* gv, int how)
1304 Evaluates the hash in scalar context and returns the result. Handles magic when the hash is tied.
1306 SV* hv_scalar(HV* hv)
1313 Stores an SV in a hash. The hash key is specified as C<key> and C<klen> is
1314 the length of the key. The C<hash> parameter is the precomputed hash
1315 value; if it is zero then Perl will compute it. The return value will be
1316 NULL if the operation failed or if the value did not need to be actually
1317 stored within the hash (as in the case of tied hashes). Otherwise it can
1318 be dereferenced to get the original C<SV*>. Note that the caller is
1319 responsible for suitably incrementing the reference count of C<val> before
1320 the call, and decrementing it if the function returned NULL. Effectively
1321 a successful hv_store takes ownership of one reference to C<val>. This is
1322 usually what you want; a newly created SV has a reference count of one, so
1323 if all your code does is create SVs then store them in a hash, hv_store
1324 will own the only reference to the new SV, and your code doesn't need to do
1325 anything further to tidy up. hv_store is not implemented as a call to
1326 hv_store_ent, and does not create a temporary SV for the key, so if your
1327 key data is not already in SV form then use hv_store in preference to
1330 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1331 information on how to use this function on tied hashes.
1333 SV** hv_store(HV* tb, const char* key, I32 klen, SV* val, U32 hash)
1340 Stores C<val> in a hash. The hash key is specified as C<key>. The C<hash>
1341 parameter is the precomputed hash value; if it is zero then Perl will
1342 compute it. The return value is the new hash entry so created. It will be
1343 NULL if the operation failed or if the value did not need to be actually
1344 stored within the hash (as in the case of tied hashes). Otherwise the
1345 contents of the return value can be accessed using the C<He?> macros
1346 described here. Note that the caller is responsible for suitably
1347 incrementing the reference count of C<val> before the call, and
1348 decrementing it if the function returned NULL. Effectively a successful
1349 hv_store_ent takes ownership of one reference to C<val>. This is
1350 usually what you want; a newly created SV has a reference count of one, so
1351 if all your code does is create SVs then store them in a hash, hv_store
1352 will own the only reference to the new SV, and your code doesn't need to do
1353 anything further to tidy up. Note that hv_store_ent only reads the C<key>;
1354 unlike C<val> it does not take ownership of it, so maintaining the correct
1355 reference count on C<key> is entirely the caller's responsibility. hv_store
1356 is not implemented as a call to hv_store_ent, and does not create a temporary
1357 SV for the key, so if your key data is not already in SV form then use
1358 hv_store in preference to hv_store_ent.
1360 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1361 information on how to use this function on tied hashes.
1363 HE* hv_store_ent(HV* tb, SV* key, SV* val, U32 hash)
1372 void hv_undef(HV* tb)
1379 Creates a new HV. The reference count is set to 1.
1389 =head1 Magical Functions
1395 Clear something magical that the SV represents. See C<sv_magic>.
1397 int mg_clear(SV* sv)
1404 Copies the magic from one SV to another. See C<sv_magic>.
1406 int mg_copy(SV* sv, SV* nsv, const char* key, I32 klen)
1413 Finds the magic pointer for type matching the SV. See C<sv_magic>.
1415 MAGIC* mg_find(const SV* sv, int type)
1422 Free any magic storage used by the SV. See C<sv_magic>.
1431 Do magic after a value is retrieved from the SV. See C<sv_magic>.
1440 Report on the SV's length. See C<sv_magic>.
1442 U32 mg_length(SV* sv)
1449 Turns on the magical status of an SV. See C<sv_magic>.
1451 void mg_magical(SV* sv)
1458 Do magic after a value is assigned to the SV. See C<sv_magic>.
1467 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
1468 argument more than once.
1470 void SvGETMAGIC(SV* sv)
1477 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
1487 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
1488 argument more than once.
1490 void SvSETMAGIC(SV* sv)
1497 Like C<SvSetSV>, but does any set magic required afterwards.
1499 void SvSetMagicSV(SV* dsb, SV* ssv)
1504 =item SvSetMagicSV_nosteal
1506 Like C<SvSetSV_nosteal>, but does any set magic required afterwards.
1508 void SvSetMagicSV_nosteal(SV* dsv, SV* ssv)
1515 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
1518 void SvSetSV(SV* dsb, SV* ssv)
1523 =item SvSetSV_nosteal
1525 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
1526 ssv. May evaluate arguments more than once.
1528 void SvSetSV_nosteal(SV* dsv, SV* ssv)
1535 Arranges for sv to be shared between threads if a suitable module
1538 void SvSHARE(SV* sv)
1545 Releases a mutual exclusion lock on sv if a suitable module
1548 void SvUNLOCK(SV* sv)
1556 =head1 Memory Management
1562 The XSUB-writer's interface to the C C<memcpy> function. The C<src> is the
1563 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1564 the type. May fail on overlapping copies. See also C<Move>.
1566 void Copy(void* src, void* dest, int nitems, type)
1569 Found in file handy.h
1573 Like C<Copy> but returns dest. Useful for encouraging compilers to tail-call
1576 void * CopyD(void* src, void* dest, int nitems, type)
1579 Found in file handy.h
1583 The XSUB-writer's interface to the C C<memmove> function. The C<src> is the
1584 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1585 the type. Can do overlapping moves. See also C<Copy>.
1587 void Move(void* src, void* dest, int nitems, type)
1590 Found in file handy.h
1594 Like C<Move> but returns dest. Useful for encouraging compilers to tail-call
1597 void * MoveD(void* src, void* dest, int nitems, type)
1600 Found in file handy.h
1604 The XSUB-writer's interface to the C C<malloc> function.
1606 void Newx(void* ptr, int nitems, type)
1609 Found in file handy.h
1613 The XSUB-writer's interface to the C C<malloc> function, with
1616 void Newxc(void* ptr, int nitems, type, cast)
1619 Found in file handy.h
1623 The XSUB-writer's interface to the C C<malloc> function. The allocated
1624 memory is zeroed with C<memzero>.
1626 In 5.9.3, we removed the 1st parameter, a debug aid, from the api. It
1627 was used to uniquely identify each usage of these allocation
1628 functions, but was deemed unnecessary with the availability of better
1629 memory tracking tools, valgrind for example.
1631 void Newxz(void* ptr, int nitems, type)
1634 Found in file handy.h
1638 Fill up memory with a pattern (byte 0xAB over and over again) that
1639 hopefully catches attempts to access uninitialized memory.
1641 void Poison(void* dest, int nitems, type)
1644 Found in file handy.h
1648 The XSUB-writer's interface to the C C<realloc> function.
1650 void Renew(void* ptr, int nitems, type)
1653 Found in file handy.h
1657 The XSUB-writer's interface to the C C<realloc> function, with
1660 void Renewc(void* ptr, int nitems, type, cast)
1663 Found in file handy.h
1667 The XSUB-writer's interface to the C C<free> function.
1669 void Safefree(void* ptr)
1672 Found in file handy.h
1676 Perl's version of C<strdup()>. Returns a pointer to a newly allocated
1677 string which is a duplicate of C<pv>. The size of the string is
1678 determined by C<strlen()>. The memory allocated for the new string can
1679 be freed with the C<Safefree()> function.
1681 char* savepv(const char* pv)
1684 Found in file util.c
1688 Perl's version of what C<strndup()> would be if it existed. Returns a
1689 pointer to a newly allocated string which is a duplicate of the first
1690 C<len> bytes from C<pv>. The memory allocated for the new string can be
1691 freed with the C<Safefree()> function.
1693 char* savepvn(const char* pv, I32 len)
1696 Found in file util.c
1700 A version of C<savepv()> which allocates the duplicate string in memory
1701 which is shared between threads.
1703 char* savesharedpv(const char* pv)
1706 Found in file util.c
1710 A version of C<savepv()>/C<savepvn()> which gets the string to duplicate from
1711 the passed in SV using C<SvPV()>
1713 char* savesvpv(SV* sv)
1716 Found in file util.c
1720 This is an architecture-independent macro to copy one structure to another.
1722 void StructCopy(type src, type dest, type)
1725 Found in file handy.h
1729 The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the
1730 destination, C<nitems> is the number of items, and C<type> is the type.
1732 void Zero(void* dest, int nitems, type)
1735 Found in file handy.h
1739 Like C<Zero> but returns dest. Useful for encouraging compilers to tail-call
1742 void * ZeroD(void* dest, int nitems, type)
1745 Found in file handy.h
1750 =head1 Miscellaneous Functions
1756 Analyses the string in order to make fast searches on it using fbm_instr()
1757 -- the Boyer-Moore algorithm.
1759 void fbm_compile(SV* sv, U32 flags)
1762 Found in file util.c
1766 Returns the location of the SV in the string delimited by C<str> and
1767 C<strend>. It returns C<Nullch> if the string can't be found. The C<sv>
1768 does not have to be fbm_compiled, but the search will not be as fast
1771 char* fbm_instr(unsigned char* big, unsigned char* bigend, SV* littlesv, U32 flags)
1774 Found in file util.c
1778 Takes a sprintf-style format pattern and conventional
1779 (non-SV) arguments and returns the formatted string.
1781 (char *) Perl_form(pTHX_ const char* pat, ...)
1783 can be used any place a string (char *) is required:
1785 char * s = Perl_form("%d.%d",major,minor);
1787 Uses a single private buffer so if you want to format several strings you
1788 must explicitly copy the earlier strings away (and free the copies when you
1791 char* form(const char* pat, ...)
1794 Found in file util.c
1798 Fill the sv with current working directory
1800 int getcwd_sv(SV* sv)
1803 Found in file util.c
1807 Returns a new version object based on the passed in SV:
1809 SV *sv = new_version(SV *ver);
1811 Does not alter the passed in ver SV. See "upg_version" if you
1812 want to upgrade the SV.
1814 SV* new_version(SV *ver)
1817 Found in file util.c
1821 Returns a pointer to the next character after the parsed
1822 version string, as well as upgrading the passed in SV to
1825 Function must be called with an already existing SV like
1828 s = scan_version(s,SV *sv, bool qv);
1830 Performs some preprocessing to the string to ensure that
1831 it has the correct characteristics of a version. Flags the
1832 object if it contains an underscore (which denotes this
1833 is a alpha version). The boolean qv denotes that the version
1834 should be interpreted as if it had multiple decimals, even if
1837 const char* scan_version(const char *vstr, SV *sv, bool qv)
1840 Found in file util.c
1844 Test two strings to see if they are equal. Returns true or false.
1846 bool strEQ(char* s1, char* s2)
1849 Found in file handy.h
1853 Test two strings to see if the first, C<s1>, is greater than or equal to
1854 the second, C<s2>. Returns true or false.
1856 bool strGE(char* s1, char* s2)
1859 Found in file handy.h
1863 Test two strings to see if the first, C<s1>, is greater than the second,
1864 C<s2>. Returns true or false.
1866 bool strGT(char* s1, char* s2)
1869 Found in file handy.h
1873 Test two strings to see if the first, C<s1>, is less than or equal to the
1874 second, C<s2>. Returns true or false.
1876 bool strLE(char* s1, char* s2)
1879 Found in file handy.h
1883 Test two strings to see if the first, C<s1>, is less than the second,
1884 C<s2>. Returns true or false.
1886 bool strLT(char* s1, char* s2)
1889 Found in file handy.h
1893 Test two strings to see if they are different. Returns true or
1896 bool strNE(char* s1, char* s2)
1899 Found in file handy.h
1903 Test two strings to see if they are equal. The C<len> parameter indicates
1904 the number of bytes to compare. Returns true or false. (A wrapper for
1907 bool strnEQ(char* s1, char* s2, STRLEN len)
1910 Found in file handy.h
1914 Test two strings to see if they are different. The C<len> parameter
1915 indicates the number of bytes to compare. Returns true or false. (A
1916 wrapper for C<strncmp>).
1918 bool strnNE(char* s1, char* s2, STRLEN len)
1921 Found in file handy.h
1925 Dummy routine which "locks" an SV when there is no locking module present.
1926 Exists to avoid test for a NULL function pointer and because it could potentially warn under
1927 some level of strict-ness.
1929 void sv_nolocking(SV *)
1932 Found in file util.c
1936 Dummy routine which "shares" an SV when there is no sharing module present.
1937 Exists to avoid test for a NULL function pointer and because it could potentially warn under
1938 some level of strict-ness.
1940 void sv_nosharing(SV *)
1943 Found in file util.c
1945 =item sv_nounlocking
1947 Dummy routine which "unlocks" an SV when there is no locking module present.
1948 Exists to avoid test for a NULL function pointer and because it could potentially warn under
1949 some level of strict-ness.
1951 void sv_nounlocking(SV *)
1954 Found in file util.c
1958 In-place upgrade of the supplied SV to a version object.
1960 SV *sv = upg_version(SV *sv);
1962 Returns a pointer to the upgraded SV.
1964 SV* upg_version(SV *ver)
1967 Found in file util.c
1971 Version object aware cmp. Both operands must already have been
1972 converted into version objects.
1974 int vcmp(SV *lvs, SV *rvs)
1977 Found in file util.c
1981 Accepts a version object and returns the normalized string
1982 representation. Call like:
1986 NOTE: you can pass either the object directly or the SV
1987 contained within the RV.
1992 Found in file util.c
1996 Accepts a version object and returns the normalized floating
1997 point representation. Call like:
2001 NOTE: you can pass either the object directly or the SV
2002 contained within the RV.
2007 Found in file util.c
2011 In order to maintain maximum compatibility with earlier versions
2012 of Perl, this function will return either the floating point
2013 notation or the multiple dotted notation, depending on whether
2014 the original version contained 1 or more dots, respectively
2016 SV* vstringify(SV *vs)
2019 Found in file util.c
2024 =head1 Numeric functions
2030 converts a string representing a binary number to numeric form.
2032 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2033 conversion flags, and I<result> should be NULL or a pointer to an NV.
2034 The scan stops at the end of the string, or the first invalid character.
2035 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2036 invalid character will also trigger a warning.
2037 On return I<*len> is set to the length of the scanned string,
2038 and I<*flags> gives output flags.
2040 If the value is <= C<UV_MAX> it is returned as a UV, the output flags are clear,
2041 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_bin>
2042 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2043 and writes the value to I<*result> (or the value is discarded if I<result>
2046 The binary number may optionally be prefixed with "0b" or "b" unless
2047 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
2048 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the binary
2049 number may use '_' characters to separate digits.
2051 UV grok_bin(const char* start, STRLEN* len_p, I32* flags, NV *result)
2054 Found in file numeric.c
2058 converts a string representing a hex number to numeric form.
2060 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2061 conversion flags, and I<result> should be NULL or a pointer to an NV.
2062 The scan stops at the end of the string, or the first invalid character.
2063 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2064 invalid character will also trigger a warning.
2065 On return I<*len> is set to the length of the scanned string,
2066 and I<*flags> gives output flags.
2068 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2069 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_hex>
2070 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2071 and writes the value to I<*result> (or the value is discarded if I<result>
2074 The hex number may optionally be prefixed with "0x" or "x" unless
2075 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
2076 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the hex
2077 number may use '_' characters to separate digits.
2079 UV grok_hex(const char* start, STRLEN* len_p, I32* flags, NV *result)
2082 Found in file numeric.c
2086 Recognise (or not) a number. The type of the number is returned
2087 (0 if unrecognised), otherwise it is a bit-ORed combination of
2088 IS_NUMBER_IN_UV, IS_NUMBER_GREATER_THAN_UV_MAX, IS_NUMBER_NOT_INT,
2089 IS_NUMBER_NEG, IS_NUMBER_INFINITY, IS_NUMBER_NAN (defined in perl.h).
2091 If the value of the number can fit an in UV, it is returned in the *valuep
2092 IS_NUMBER_IN_UV will be set to indicate that *valuep is valid, IS_NUMBER_IN_UV
2093 will never be set unless *valuep is valid, but *valuep may have been assigned
2094 to during processing even though IS_NUMBER_IN_UV is not set on return.
2095 If valuep is NULL, IS_NUMBER_IN_UV will be set for the same cases as when
2096 valuep is non-NULL, but no actual assignment (or SEGV) will occur.
2098 IS_NUMBER_NOT_INT will be set with IS_NUMBER_IN_UV if trailing decimals were
2099 seen (in which case *valuep gives the true value truncated to an integer), and
2100 IS_NUMBER_NEG if the number is negative (in which case *valuep holds the
2101 absolute value). IS_NUMBER_IN_UV is not set if e notation was used or the
2102 number is larger than a UV.
2104 int grok_number(const char *pv, STRLEN len, UV *valuep)
2107 Found in file numeric.c
2109 =item grok_numeric_radix
2111 Scan and skip for a numeric decimal separator (radix).
2113 bool grok_numeric_radix(const char **sp, const char *send)
2116 Found in file numeric.c
2120 converts a string representing an octal number to numeric form.
2122 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2123 conversion flags, and I<result> should be NULL or a pointer to an NV.
2124 The scan stops at the end of the string, or the first invalid character.
2125 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2126 invalid character will also trigger a warning.
2127 On return I<*len> is set to the length of the scanned string,
2128 and I<*flags> gives output flags.
2130 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2131 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_oct>
2132 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2133 and writes the value to I<*result> (or the value is discarded if I<result>
2136 If C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the octal
2137 number may use '_' characters to separate digits.
2139 UV grok_oct(const char* start, STRLEN* len_p, I32* flags, NV *result)
2142 Found in file numeric.c
2146 For backwards compatibility. Use C<grok_bin> instead.
2148 NV scan_bin(const char* start, STRLEN len, STRLEN* retlen)
2151 Found in file numeric.c
2155 For backwards compatibility. Use C<grok_hex> instead.
2157 NV scan_hex(const char* start, STRLEN len, STRLEN* retlen)
2160 Found in file numeric.c
2164 For backwards compatibility. Use C<grok_oct> instead.
2166 NV scan_oct(const char* start, STRLEN len, STRLEN* retlen)
2169 Found in file numeric.c
2174 =head1 Optree Manipulation Functions
2180 If C<cv> is a constant sub eligible for inlining. returns the constant
2181 value returned by the sub. Otherwise, returns NULL.
2183 Constant subs can be created with C<newCONSTSUB> or as described in
2184 L<perlsub/"Constant Functions">.
2186 SV* cv_const_sv(CV* cv)
2193 Creates a constant sub equivalent to Perl C<sub FOO () { 123 }> which is
2194 eligible for inlining at compile-time.
2196 CV* newCONSTSUB(HV* stash, const char* name, SV* sv)
2203 Used by C<xsubpp> to hook up XSUBs as Perl subs.
2211 =head1 Pad Data Structures
2217 Get the value at offset po in the current pad.
2218 Use macro PAD_SV instead of calling this function directly.
2220 SV* pad_sv(PADOFFSET po)
2228 =head1 Simple Exception Handling Macros
2234 Set up neccessary local variables for exception handling.
2235 See L<perlguts/"Exception Handling">.
2240 Found in file XSUB.h
2244 Introduces a catch block. See L<perlguts/"Exception Handling">.
2247 Found in file XSUB.h
2251 Rethrows a previously caught exception. See L<perlguts/"Exception Handling">.
2256 Found in file XSUB.h
2260 Ends a try block. See L<perlguts/"Exception Handling">.
2263 Found in file XSUB.h
2265 =item XCPT_TRY_START
2267 Starts a try block. See L<perlguts/"Exception Handling">.
2270 Found in file XSUB.h
2275 =head1 Stack Manipulation Macros
2281 Declare a stack marker variable, C<mark>, for the XSUB. See C<MARK> and
2291 Saves the original stack mark for the XSUB. See C<ORIGMARK>.
2300 Declares a local copy of perl's stack pointer for the XSUB, available via
2301 the C<SP> macro. See C<SP>.
2310 Used to extend the argument stack for an XSUB's return values. Once
2311 used, guarantees that there is room for at least C<nitems> to be pushed
2314 void EXTEND(SP, int nitems)
2321 Stack marker variable for the XSUB. See C<dMARK>.
2328 Push an integer onto the stack. The stack must have room for this element.
2329 Handles 'set' magic. Does not use C<TARG>. See also C<PUSHi>, C<mXPUSHi>
2339 Push a double onto the stack. The stack must have room for this element.
2340 Handles 'set' magic. Does not use C<TARG>. See also C<PUSHn>, C<mXPUSHn>
2350 Push a string onto the stack. The stack must have room for this element.
2351 The C<len> indicates the length of the string. Handles 'set' magic. Does
2352 not use C<TARG>. See also C<PUSHp>, C<mXPUSHp> and C<XPUSHp>.
2354 void mPUSHp(char* str, STRLEN len)
2361 Push an unsigned integer onto the stack. The stack must have room for this
2362 element. Handles 'set' magic. Does not use C<TARG>. See also C<PUSHu>,
2363 C<mXPUSHu> and C<XPUSHu>.
2372 Push an integer onto the stack, extending the stack if necessary. Handles
2373 'set' magic. Does not use C<TARG>. See also C<XPUSHi>, C<mPUSHi> and
2383 Push a double onto the stack, extending the stack if necessary. Handles
2384 'set' magic. Does not use C<TARG>. See also C<XPUSHn>, C<mPUSHn> and
2394 Push a string onto the stack, extending the stack if necessary. The C<len>
2395 indicates the length of the string. Handles 'set' magic. Does not use
2396 C<TARG>. See also C<XPUSHp>, C<mPUSHp> and C<PUSHp>.
2398 void mXPUSHp(char* str, STRLEN len)
2405 Push an unsigned integer onto the stack, extending the stack if necessary.
2406 Handles 'set' magic. Does not use C<TARG>. See also C<XPUSHu>, C<mPUSHu>
2416 The original stack mark for the XSUB. See C<dORIGMARK>.
2423 Pops an integer off the stack.
2432 Pops a long off the stack.
2441 Pops a double off the stack.
2450 Pops a string off the stack. Deprecated. New code should use POPpx.
2459 Pops a string off the stack which must consist of bytes i.e. characters < 256.
2468 Pops a string off the stack.
2477 Pops an SV off the stack.
2486 Push an integer onto the stack. The stack must have room for this element.
2487 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
2488 called to declare it. Do not call multiple C<TARG>-oriented macros to
2489 return lists from XSUB's - see C<mPUSHi> instead. See also C<XPUSHi> and
2499 Opening bracket for arguments on a callback. See C<PUTBACK> and
2509 Push a new mortal SV onto the stack. The stack must have room for this
2510 element. Does not handle 'set' magic. Does not use C<TARG>. See also
2511 C<PUSHs>, C<XPUSHmortal> and C<XPUSHs>.
2520 Push a double onto the stack. The stack must have room for this element.
2521 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
2522 called to declare it. Do not call multiple C<TARG>-oriented macros to
2523 return lists from XSUB's - see C<mPUSHn> instead. See also C<XPUSHn> and
2533 Push a string onto the stack. The stack must have room for this element.
2534 The C<len> indicates the length of the string. Handles 'set' magic. Uses
2535 C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to declare it. Do not
2536 call multiple C<TARG>-oriented macros to return lists from XSUB's - see
2537 C<mPUSHp> instead. See also C<XPUSHp> and C<mXPUSHp>.
2539 void PUSHp(char* str, STRLEN len)
2546 Push an SV onto the stack. The stack must have room for this element.
2547 Does not handle 'set' magic. Does not use C<TARG>. See also C<PUSHmortal>,
2548 C<XPUSHs> and C<XPUSHmortal>.
2557 Push an unsigned integer onto the stack. The stack must have room for this
2558 element. Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG>
2559 should be called to declare it. Do not call multiple C<TARG>-oriented
2560 macros to return lists from XSUB's - see C<mPUSHu> instead. See also
2561 C<XPUSHu> and C<mXPUSHu>.
2570 Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
2571 See C<PUSHMARK> and L<perlcall> for other uses.
2580 Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and
2588 Refetch the stack pointer. Used after a callback. See L<perlcall>.
2597 Push an integer onto the stack, extending the stack if necessary. Handles
2598 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
2599 declare it. Do not call multiple C<TARG>-oriented macros to return lists
2600 from XSUB's - see C<mXPUSHi> instead. See also C<PUSHi> and C<mPUSHi>.
2609 Push a new mortal SV onto the stack, extending the stack if necessary. Does
2610 not handle 'set' magic. Does not use C<TARG>. See also C<XPUSHs>,
2611 C<PUSHmortal> and C<PUSHs>.
2620 Push a double onto the stack, extending the stack if necessary. Handles
2621 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
2622 declare it. Do not call multiple C<TARG>-oriented macros to return lists
2623 from XSUB's - see C<mXPUSHn> instead. See also C<PUSHn> and C<mPUSHn>.
2632 Push a string onto the stack, extending the stack if necessary. The C<len>
2633 indicates the length of the string. Handles 'set' magic. Uses C<TARG>, so
2634 C<dTARGET> or C<dXSTARG> should be called to declare it. Do not call
2635 multiple C<TARG>-oriented macros to return lists from XSUB's - see
2636 C<mXPUSHp> instead. See also C<PUSHp> and C<mPUSHp>.
2638 void XPUSHp(char* str, STRLEN len)
2645 Push an SV onto the stack, extending the stack if necessary. Does not
2646 handle 'set' magic. Does not use C<TARG>. See also C<XPUSHmortal>,
2647 C<PUSHs> and C<PUSHmortal>.
2656 Push an unsigned integer onto the stack, extending the stack if necessary.
2657 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
2658 called to declare it. Do not call multiple C<TARG>-oriented macros to
2659 return lists from XSUB's - see C<mXPUSHu> instead. See also C<PUSHu> and
2669 Return from XSUB, indicating number of items on the stack. This is usually
2670 handled by C<xsubpp>.
2672 void XSRETURN(int nitems)
2675 Found in file XSUB.h
2677 =item XSRETURN_EMPTY
2679 Return an empty list from an XSUB immediately.
2684 Found in file XSUB.h
2688 Return an integer from an XSUB immediately. Uses C<XST_mIV>.
2690 void XSRETURN_IV(IV iv)
2693 Found in file XSUB.h
2697 Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
2702 Found in file XSUB.h
2706 Return a double from an XSUB immediately. Uses C<XST_mNV>.
2708 void XSRETURN_NV(NV nv)
2711 Found in file XSUB.h
2715 Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
2717 void XSRETURN_PV(char* str)
2720 Found in file XSUB.h
2722 =item XSRETURN_UNDEF
2724 Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
2729 Found in file XSUB.h
2733 Return an integer from an XSUB immediately. Uses C<XST_mUV>.
2735 void XSRETURN_UV(IV uv)
2738 Found in file XSUB.h
2742 Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
2747 Found in file XSUB.h
2751 Place an integer into the specified position C<pos> on the stack. The
2752 value is stored in a new mortal SV.
2754 void XST_mIV(int pos, IV iv)
2757 Found in file XSUB.h
2761 Place C<&PL_sv_no> into the specified position C<pos> on the
2764 void XST_mNO(int pos)
2767 Found in file XSUB.h
2771 Place a double into the specified position C<pos> on the stack. The value
2772 is stored in a new mortal SV.
2774 void XST_mNV(int pos, NV nv)
2777 Found in file XSUB.h
2781 Place a copy of a string into the specified position C<pos> on the stack.
2782 The value is stored in a new mortal SV.
2784 void XST_mPV(int pos, char* str)
2787 Found in file XSUB.h
2791 Place C<&PL_sv_undef> into the specified position C<pos> on the
2794 void XST_mUNDEF(int pos)
2797 Found in file XSUB.h
2801 Place C<&PL_sv_yes> into the specified position C<pos> on the
2804 void XST_mYES(int pos)
2807 Found in file XSUB.h
2818 An enum of flags for Perl types. These are found in the file B<sv.h>
2819 in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
2826 Integer type flag for scalars. See C<svtype>.
2833 Double type flag for scalars. See C<svtype>.
2840 Pointer type flag for scalars. See C<svtype>.
2847 Type flag for arrays. See C<svtype>.
2854 Type flag for code refs. See C<svtype>.
2861 Type flag for hashes. See C<svtype>.
2868 Type flag for blessed scalars. See C<svtype>.
2876 =head1 SV Manipulation Functions
2882 Returns the SV of the specified Perl scalar. If C<create> is set and the
2883 Perl variable does not exist then it will be created. If C<create> is not
2884 set and the variable does not exist then NULL is returned.
2886 NOTE: the perl_ form of this function is deprecated.
2888 SV* get_sv(const char* name, I32 create)
2891 Found in file perl.c
2893 =item looks_like_number
2895 Test if the content of an SV looks like a number (or is a number).
2896 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
2897 non-numeric warning), even if your atof() doesn't grok them.
2899 I32 looks_like_number(SV* sv)
2906 Creates an RV wrapper for an SV. The reference count for the original SV is
2909 SV* newRV_inc(SV* sv)
2916 Creates an RV wrapper for an SV. The reference count for the original
2917 SV is B<not> incremented.
2919 SV* newRV_noinc(SV *sv)
2926 Creates a new SV. A non-zero C<len> parameter indicates the number of
2927 bytes of preallocated string space the SV should have. An extra byte for a
2928 tailing NUL is also reserved. (SvPOK is not set for the SV even if string
2929 space is allocated.) The reference count for the new SV is set to 1.
2930 C<id> is an integer id between 0 and 1299 (used to identify leaks).
2932 SV* NEWSV(int id, STRLEN len)
2935 Found in file handy.h
2939 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
2940 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
2943 SV* newSV(STRLEN len)
2950 Creates a new SV from the hash key structure. It will generate scalars that
2951 point to the shared string table where possible. Returns a new (undefined)
2952 SV if the hek is NULL.
2954 SV* newSVhek(const HEK *hek)
2961 Creates a new SV and copies an integer into it. The reference count for the
2971 Creates a new SV and copies a floating point value into it.
2972 The reference count for the SV is set to 1.
2981 Creates a new SV and copies a string into it. The reference count for the
2982 SV is set to 1. If C<len> is zero, Perl will compute the length using
2983 strlen(). For efficiency, consider using C<newSVpvn> instead.
2985 SV* newSVpv(const char* s, STRLEN len)
2992 Creates a new SV and initializes it with the string formatted like
2995 SV* newSVpvf(const char* pat, ...)
3002 Creates a new SV and copies a string into it. The reference count for the
3003 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
3004 string. You are responsible for ensuring that the source string is at least
3005 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
3007 SV* newSVpvn(const char* s, STRLEN len)
3012 =item newSVpvn_share
3014 Creates a new SV with its SvPVX_const pointing to a shared string in the string
3015 table. If the string does not already exist in the table, it is created
3016 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
3017 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
3018 otherwise the hash is computed. The idea here is that as the string table
3019 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
3020 hash lookup will avoid string compare.
3022 SV* newSVpvn_share(const char* s, I32 len, U32 hash)
3029 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
3030 it will be upgraded to one. If C<classname> is non-null then the new SV will
3031 be blessed in the specified package. The new SV is returned and its
3032 reference count is 1.
3034 SV* newSVrv(SV* rv, const char* classname)
3041 Creates a new SV which is an exact duplicate of the original SV.
3044 SV* newSVsv(SV* old)
3051 Creates a new SV and copies an unsigned integer into it.
3052 The reference count for the SV is set to 1.
3061 Returns the length of the string which is in the SV. See C<SvLEN>.
3063 STRLEN SvCUR(SV* sv)
3070 Set the current length of the string which is in the SV. See C<SvCUR>
3073 void SvCUR_set(SV* sv, STRLEN len)
3080 Returns a pointer to the last character in the string which is in the SV.
3081 See C<SvCUR>. Access the character as *(SvEND(sv)).
3090 Expands the character buffer in the SV so that it has room for the
3091 indicated number of bytes (remember to reserve space for an extra trailing
3092 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
3093 Returns a pointer to the character buffer.
3095 char * SvGROW(SV* sv, STRLEN len)
3102 Returns a boolean indicating whether the SV contains an integer.
3111 Returns a boolean indicating whether the SV contains an integer. Checks
3112 the B<private> setting. Use C<SvIOK>.
3121 Returns a boolean indicating whether the SV contains a signed integer.
3123 bool SvIOK_notUV(SV* sv)
3130 Unsets the IV status of an SV.
3132 void SvIOK_off(SV* sv)
3139 Tells an SV that it is an integer.
3141 void SvIOK_on(SV* sv)
3148 Tells an SV that it is an integer and disables all other OK bits.
3150 void SvIOK_only(SV* sv)
3157 Tells and SV that it is an unsigned integer and disables all other OK bits.
3159 void SvIOK_only_UV(SV* sv)
3166 Returns a boolean indicating whether the SV contains an unsigned integer.
3168 bool SvIOK_UV(SV* sv)
3175 Returns a boolean indicating whether the SV is Copy-On-Write. (either shared
3176 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
3179 bool SvIsCOW(SV* sv)
3184 =item SvIsCOW_shared_hash
3186 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
3189 bool SvIsCOW_shared_hash(SV* sv)
3196 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
3197 version which guarantees to evaluate sv only once.
3206 Returns the raw value in the SV's IV slot, without checks or conversions.
3207 Only use when you are sure SvIOK is true. See also C<SvIV()>.
3216 Coerces the given SV to an integer and returns it. Guarantees to evaluate
3217 sv only once. Use the more efficient C<SvIV> otherwise.
3226 Like C<SvIV> but doesn't process magic.
3228 IV SvIV_nomg(SV* sv)
3235 Set the value of the IV pointer in sv to val. It is possible to perform
3236 the same function of this macro with an lvalue assignment to C<SvIVX>.
3237 With future Perls, however, it will be more efficient to use
3238 C<SvIV_set> instead of the lvalue assignment to C<SvIVX>.
3240 void SvIV_set(SV* sv, IV val)
3247 Returns the size of the string buffer in the SV, not including any part
3248 attributable to C<SvOOK>. See C<SvCUR>.
3250 STRLEN SvLEN(SV* sv)
3257 Set the actual length of the string which is in the SV. See C<SvIV_set>.
3259 void SvLEN_set(SV* sv, STRLEN len)
3266 Set the value of the MAGIC pointer in sv to val. See C<SvIV_set>.
3268 void SvMAGIC_set(SV* sv, MAGIC* val)
3275 Returns a boolean indicating whether the SV contains a number, integer or
3285 Returns a boolean indicating whether the SV contains a number, integer or
3286 double. Checks the B<private> setting. Use C<SvNIOK>.
3288 bool SvNIOKp(SV* sv)
3295 Unsets the NV/IV status of an SV.
3297 void SvNIOK_off(SV* sv)
3304 Returns a boolean indicating whether the SV contains a double.
3313 Returns a boolean indicating whether the SV contains a double. Checks the
3314 B<private> setting. Use C<SvNOK>.
3323 Unsets the NV status of an SV.
3325 void SvNOK_off(SV* sv)
3332 Tells an SV that it is a double.
3334 void SvNOK_on(SV* sv)
3341 Tells an SV that it is a double and disables all other OK bits.
3343 void SvNOK_only(SV* sv)
3350 Coerce the given SV to a double and return it. See C<SvNVx> for a version
3351 which guarantees to evaluate sv only once.
3360 Returns the raw value in the SV's NV slot, without checks or conversions.
3361 Only use when you are sure SvNOK is true. See also C<SvNV()>.
3370 Coerces the given SV to a double and returns it. Guarantees to evaluate
3371 sv only once. Use the more efficient C<SvNV> otherwise.
3380 Set the value of the NV pointer in sv to val. See C<SvIV_set>.
3382 void SvNV_set(SV* sv, NV val)
3389 Returns a boolean indicating whether the value is an SV. It also tells
3390 whether the value is defined or not.
3399 Returns a boolean indicating whether the SvIVX is a valid offset value for
3400 the SvPVX. This hack is used internally to speed up removal of characters
3401 from the beginning of a SvPV. When SvOOK is true, then the start of the
3402 allocated string buffer is really (SvPVX - SvIVX).
3411 Returns a boolean indicating whether the SV contains a character
3421 Returns a boolean indicating whether the SV contains a character string.
3422 Checks the B<private> setting. Use C<SvPOK>.
3431 Unsets the PV status of an SV.
3433 void SvPOK_off(SV* sv)
3440 Tells an SV that it is a string.
3442 void SvPOK_on(SV* sv)
3449 Tells an SV that it is a string and disables all other OK bits.
3450 Will also turn off the UTF-8 status.
3452 void SvPOK_only(SV* sv)
3457 =item SvPOK_only_UTF8
3459 Tells an SV that it is a string and disables all other OK bits,
3460 and leaves the UTF-8 status as it was.
3462 void SvPOK_only_UTF8(SV* sv)
3469 Returns a pointer to the string in the SV, or a stringified form of
3470 the SV if the SV does not contain a string. The SV may cache the
3471 stringified version becoming C<SvPOK>. Handles 'get' magic. See also
3472 C<SvPVx> for a version which guarantees to evaluate sv only once.
3474 char* SvPV(SV* sv, STRLEN len)
3481 Like C<SvPV>, but converts sv to byte representation first if necessary.
3483 char* SvPVbyte(SV* sv, STRLEN len)
3490 Like C<SvPV>, but converts sv to byte representation first if necessary.
3491 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
3494 char* SvPVbytex(SV* sv, STRLEN len)
3499 =item SvPVbytex_force
3501 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
3502 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
3505 char* SvPVbytex_force(SV* sv, STRLEN len)
3510 =item SvPVbyte_force
3512 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
3514 char* SvPVbyte_force(SV* sv, STRLEN len)
3519 =item SvPVbyte_nolen
3521 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
3523 char* SvPVbyte_nolen(SV* sv)
3530 Like C<SvPV>, but converts sv to utf8 first if necessary.
3532 char* SvPVutf8(SV* sv, STRLEN len)
3539 Like C<SvPV>, but converts sv to utf8 first if necessary.
3540 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
3543 char* SvPVutf8x(SV* sv, STRLEN len)
3548 =item SvPVutf8x_force
3550 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
3551 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
3554 char* SvPVutf8x_force(SV* sv, STRLEN len)
3559 =item SvPVutf8_force
3561 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
3563 char* SvPVutf8_force(SV* sv, STRLEN len)
3568 =item SvPVutf8_nolen
3570 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
3572 char* SvPVutf8_nolen(SV* sv)
3579 Returns a pointer to the physical string in the SV. The SV must contain a
3589 A version of C<SvPV> which guarantees to evaluate sv only once.
3591 char* SvPVx(SV* sv, STRLEN len)
3598 Like C<SvPV> but will force the SV into containing just a string
3599 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
3602 char* SvPV_force(SV* sv, STRLEN len)
3607 =item SvPV_force_nomg
3609 Like C<SvPV> but will force the SV into containing just a string
3610 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
3611 directly. Doesn't process magic.
3613 char* SvPV_force_nomg(SV* sv, STRLEN len)
3620 Returns a pointer to the string in the SV, or a stringified form of
3621 the SV if the SV does not contain a string. The SV may cache the
3622 stringified form becoming C<SvPOK>. Handles 'get' magic.
3624 char* SvPV_nolen(SV* sv)
3631 Like C<SvPV> but doesn't process magic.
3633 char* SvPV_nomg(SV* sv, STRLEN len)
3640 Set the value of the PV pointer in sv to val. See C<SvIV_set>.
3642 void SvPV_set(SV* sv, char* val)
3649 Returns the value of the object's reference count.
3651 U32 SvREFCNT(SV* sv)
3658 Decrements the reference count of the given SV.
3660 void SvREFCNT_dec(SV* sv)
3667 Increments the reference count of the given SV.
3669 SV* SvREFCNT_inc(SV* sv)
3676 Tests if the SV is an RV.
3685 Unsets the RV status of an SV.
3687 void SvROK_off(SV* sv)
3694 Tells an SV that it is an RV.
3696 void SvROK_on(SV* sv)
3703 Dereferences an RV to return the SV.
3712 Set the value of the RV pointer in sv to val. See C<SvIV_set>.
3714 void SvRV_set(SV* sv, SV* val)
3721 Returns the stash of the SV.
3730 Set the value of the STASH pointer in sv to val. See C<SvIV_set>.
3732 void SvSTASH_set(SV* sv, STASH* val)
3739 Taints an SV if tainting is enabled.
3741 void SvTAINT(SV* sv)
3748 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
3751 bool SvTAINTED(SV* sv)
3758 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
3759 some of Perl's fundamental security features. XS module authors should not
3760 use this function unless they fully understand all the implications of
3761 unconditionally untainting the value. Untainting should be done in the
3762 standard perl fashion, via a carefully crafted regexp, rather than directly
3763 untainting variables.
3765 void SvTAINTED_off(SV* sv)
3772 Marks an SV as tainted if tainting is enabled.
3774 void SvTAINTED_on(SV* sv)
3781 Returns a boolean indicating whether Perl would evaluate the SV as true or
3782 false, defined or undefined. Does not handle 'get' magic.
3791 Returns the type of the SV. See C<svtype>.
3793 svtype SvTYPE(SV* sv)
3800 Returns a boolean indicating whether the SV contains an unsigned integer.
3809 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
3810 perform the upgrade if necessary. See C<svtype>.
3812 void SvUPGRADE(SV* sv, svtype type)
3819 Returns a boolean indicating whether the SV contains UTF-8 encoded data.
3828 Unsets the UTF-8 status of an SV.
3830 void SvUTF8_off(SV *sv)
3837 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
3838 Do not use frivolously.
3840 void SvUTF8_on(SV *sv)
3847 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
3848 for a version which guarantees to evaluate sv only once.
3857 Returns the raw value in the SV's UV slot, without checks or conversions.
3858 Only use when you are sure SvIOK is true. See also C<SvUV()>.
3867 Coerces the given SV to an unsigned integer and returns it. Guarantees to
3868 evaluate sv only once. Use the more efficient C<SvUV> otherwise.
3877 Like C<SvUV> but doesn't process magic.
3879 UV SvUV_nomg(SV* sv)
3886 Set the value of the UV pointer in sv to val. See C<SvIV_set>.
3888 void SvUV_set(SV* sv, UV val)
3895 Returns a boolean indicating whether the SV contains a v-string.
3904 This function is only called on magical items, and is only used by
3905 sv_true() or its macro equivalent.
3907 bool sv_2bool(SV* sv)
3914 Using various gambits, try to get a CV from an SV; in addition, try if
3915 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
3917 CV* sv_2cv(SV* sv, HV** st, GV** gvp, I32 lref)
3924 Using various gambits, try to get an IO from an SV: the IO slot if its a
3925 GV; or the recursive result if we're an RV; or the IO slot of the symbol
3926 named after the PV if we're a string.
3935 Return the integer value of an SV, doing any necessary string
3936 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
3937 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
3939 IV sv_2iv_flags(SV* sv, I32 flags)
3946 Marks an existing SV as mortal. The SV will be destroyed "soon", either
3947 by an explicit call to FREETMPS, or by an implicit call at places such as
3948 statement boundaries. SvTEMP() is turned on which means that the SV's
3949 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
3950 and C<sv_mortalcopy>.
3952 SV* sv_2mortal(SV* sv)
3959 Return the num value of an SV, doing any necessary string or integer
3960 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
3970 Return a pointer to the byte-encoded representation of the SV, and set *lp
3971 to its length. May cause the SV to be downgraded from UTF-8 as a
3974 Usually accessed via the C<SvPVbyte> macro.
3976 char* sv_2pvbyte(SV* sv, STRLEN* lp)
3981 =item sv_2pvbyte_nolen
3983 Return a pointer to the byte-encoded representation of the SV.
3984 May cause the SV to be downgraded from UTF-8 as a side-effect.
3986 Usually accessed via the C<SvPVbyte_nolen> macro.
3988 char* sv_2pvbyte_nolen(SV* sv)
3995 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3996 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
3998 Usually accessed via the C<SvPVutf8> macro.
4000 char* sv_2pvutf8(SV* sv, STRLEN* lp)
4005 =item sv_2pvutf8_nolen
4007 Return a pointer to the UTF-8-encoded representation of the SV.
4008 May cause the SV to be upgraded to UTF-8 as a side-effect.
4010 Usually accessed via the C<SvPVutf8_nolen> macro.
4012 char* sv_2pvutf8_nolen(SV* sv)
4019 Returns a pointer to the string value of an SV, and sets *lp to its length.
4020 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
4022 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
4023 usually end up here too.
4025 char* sv_2pv_flags(SV* sv, STRLEN* lp, I32 flags)
4032 Like C<sv_2pv()>, but doesn't return the length too. You should usually
4033 use the macro wrapper C<SvPV_nolen(sv)> instead.
4034 char* sv_2pv_nolen(SV* sv)
4041 Return the unsigned integer value of an SV, doing any necessary string
4042 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
4043 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
4045 UV sv_2uv_flags(SV* sv, I32 flags)
4052 Remove any string offset. You should normally use the C<SvOOK_off> macro
4055 int sv_backoff(SV* sv)
4062 Blesses an SV into a specified package. The SV must be an RV. The package
4063 must be designated by its stash (see C<gv_stashpv()>). The reference count
4064 of the SV is unaffected.
4066 SV* sv_bless(SV* sv, HV* stash)
4073 Concatenates the string onto the end of the string which is in the SV.
4074 If the SV has the UTF-8 status set, then the bytes appended should be
4075 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4077 void sv_catpv(SV* sv, const char* ptr)
4084 Processes its arguments like C<sprintf> and appends the formatted
4085 output to an SV. If the appended data contains "wide" characters
4086 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
4087 and characters >255 formatted with %c), the original SV might get
4088 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
4089 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
4090 valid UTF-8; if the original SV was bytes, the pattern should be too.
4092 void sv_catpvf(SV* sv, const char* pat, ...)
4099 Like C<sv_catpvf>, but also handles 'set' magic.
4101 void sv_catpvf_mg(SV *sv, const char* pat, ...)
4108 Concatenates the string onto the end of the string which is in the SV. The
4109 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4110 status set, then the bytes appended should be valid UTF-8.
4111 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4113 void sv_catpvn(SV* sv, const char* ptr, STRLEN len)
4118 =item sv_catpvn_flags
4120 Concatenates the string onto the end of the string which is in the SV. The
4121 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4122 status set, then the bytes appended should be valid UTF-8.
4123 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4124 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4125 in terms of this function.
4127 void sv_catpvn_flags(SV* sv, const char* ptr, STRLEN len, I32 flags)
4134 Like C<sv_catpvn>, but also handles 'set' magic.
4136 void sv_catpvn_mg(SV *sv, const char *ptr, STRLEN len)
4141 =item sv_catpvn_nomg
4143 Like C<sv_catpvn> but doesn't process magic.
4145 void sv_catpvn_nomg(SV* sv, const char* ptr, STRLEN len)
4152 Like C<sv_catpv>, but also handles 'set' magic.
4154 void sv_catpv_mg(SV *sv, const char *ptr)
4161 Concatenates the string from SV C<ssv> onto the end of the string in
4162 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4163 not 'set' magic. See C<sv_catsv_mg>.
4165 void sv_catsv(SV* dsv, SV* ssv)
4170 =item sv_catsv_flags
4172 Concatenates the string from SV C<ssv> onto the end of the string in
4173 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4174 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4175 and C<sv_catsv_nomg> are implemented in terms of this function.
4177 void sv_catsv_flags(SV* dsv, SV* ssv, I32 flags)
4184 Like C<sv_catsv>, but also handles 'set' magic.
4186 void sv_catsv_mg(SV *dstr, SV *sstr)
4193 Like C<sv_catsv> but doesn't process magic.
4195 void sv_catsv_nomg(SV* dsv, SV* ssv)
4202 Efficient removal of characters from the beginning of the string buffer.
4203 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4204 the string buffer. The C<ptr> becomes the first character of the adjusted
4205 string. Uses the "OOK hack".
4206 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4207 refer to the same chunk of data.
4209 void sv_chop(SV* sv, const char* ptr)
4216 Clear an SV: call any destructors, free up any memory used by the body,
4217 and free the body itself. The SV's head is I<not> freed, although
4218 its type is set to all 1's so that it won't inadvertently be assumed
4219 to be live during global destruction etc.
4220 This function should only be called when REFCNT is zero. Most of the time
4221 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
4224 void sv_clear(SV* sv)
4231 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
4232 string in C<sv1> is less than, equal to, or greater than the string in
4233 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
4234 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
4236 I32 sv_cmp(SV* sv1, SV* sv2)
4243 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
4244 'use bytes' aware, handles get magic, and will coerce its args to strings
4245 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
4247 I32 sv_cmp_locale(SV* sv1, SV* sv2)
4254 Add Collate Transform magic to an SV if it doesn't already have it.
4256 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
4257 scalar data of the variable, but transformed to such a format that a normal
4258 memory comparison can be used to compare the data according to the locale
4261 char* sv_collxfrm(SV* sv, STRLEN* nxp)
4268 Copies a stringified representation of the source SV into the
4269 destination SV. Automatically performs any necessary mg_get and
4270 coercion of numeric values into strings. Guaranteed to preserve
4271 UTF-8 flag even from overloaded objects. Similar in nature to
4272 sv_2pv[_flags] but operates directly on an SV instead of just the
4273 string. Mostly uses sv_2pv_flags to do its work, except when that
4274 would lose the UTF-8'ness of the PV.
4276 void sv_copypv(SV* dsv, SV* ssv)
4283 Auto-decrement of the value in the SV, doing string to numeric conversion
4284 if necessary. Handles 'get' magic.
4291 =item sv_derived_from
4293 Returns a boolean indicating whether the SV is derived from the specified
4294 class. This is the function that implements C<UNIVERSAL::isa>. It works
4295 for class names as well as for objects.
4297 bool sv_derived_from(SV* sv, const char* name)
4300 Found in file universal.c
4304 Returns a boolean indicating whether the strings in the two SVs are
4305 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
4306 coerce its args to strings if necessary.
4308 I32 sv_eq(SV* sv1, SV* sv2)
4313 =item sv_force_normal
4315 Undo various types of fakery on an SV: if the PV is a shared string, make
4316 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4317 an xpvmg. See also C<sv_force_normal_flags>.
4319 void sv_force_normal(SV *sv)
4324 =item sv_force_normal_flags
4326 Undo various types of fakery on an SV: if the PV is a shared string, make
4327 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4328 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4329 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4330 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4331 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4332 set to some other value.) In addition, the C<flags> parameter gets passed to
4333 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4334 with flags set to 0.
4336 void sv_force_normal_flags(SV *sv, U32 flags)
4343 Decrement an SV's reference count, and if it drops to zero, call
4344 C<sv_clear> to invoke destructors and free up any memory used by
4345 the body; finally, deallocate the SV's head itself.
4346 Normally called via a wrapper macro C<SvREFCNT_dec>.
4348 void sv_free(SV* sv)
4355 Get a line from the filehandle and store it into the SV, optionally
4356 appending to the currently-stored string.
4358 char* sv_gets(SV* sv, PerlIO* fp, I32 append)
4365 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
4366 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
4367 Use the C<SvGROW> wrapper instead.
4369 char* sv_grow(SV* sv, STRLEN newlen)
4376 Auto-increment of the value in the SV, doing string to numeric conversion
4377 if necessary. Handles 'get' magic.
4386 Inserts a string at the specified offset/length within the SV. Similar to
4387 the Perl substr() function.
4389 void sv_insert(SV* bigsv, STRLEN offset, STRLEN len, const char* little, STRLEN littlelen)
4396 Returns a boolean indicating whether the SV is blessed into the specified
4397 class. This does not check for subtypes; use C<sv_derived_from> to verify
4398 an inheritance relationship.
4400 int sv_isa(SV* sv, const char* name)
4407 Returns a boolean indicating whether the SV is an RV pointing to a blessed
4408 object. If the SV is not an RV, or if the object is not blessed, then this
4411 int sv_isobject(SV* sv)
4418 A private implementation of the C<SvIVx> macro for compilers which can't
4419 cope with complex macro expressions. Always use the macro instead.
4428 Returns the length of the string in the SV. Handles magic and type
4429 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
4431 STRLEN sv_len(SV* sv)
4438 Returns the number of characters in the string in an SV, counting wide
4439 UTF-8 bytes as a single character. Handles magic and type coercion.
4441 STRLEN sv_len_utf8(SV* sv)
4448 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4449 then adds a new magic item of type C<how> to the head of the magic list.
4451 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4452 handling of the C<name> and C<namlen> arguments.
4454 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4455 to add more than one instance of the same 'how'.
4457 void sv_magic(SV* sv, SV* obj, int how, const char* name, I32 namlen)
4464 Adds magic to an SV, upgrading it if necessary. Applies the
4465 supplied vtable and returns a pointer to the magic added.
4467 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4468 In particular, you can add magic to SvREADONLY SVs, and add more than
4469 one instance of the same 'how'.
4471 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4472 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4473 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4474 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4476 (This is now used as a subroutine by C<sv_magic>.)
4478 MAGIC * sv_magicext(SV* sv, SV* obj, int how, const MGVTBL *vtbl, const char* name, I32 namlen)
4485 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
4486 The new SV is marked as mortal. It will be destroyed "soon", either by an
4487 explicit call to FREETMPS, or by an implicit call at places such as
4488 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
4490 SV* sv_mortalcopy(SV* oldsv)
4497 Creates a new null SV which is mortal. The reference count of the SV is
4498 set to 1. It will be destroyed "soon", either by an explicit call to
4499 FREETMPS, or by an implicit call at places such as statement boundaries.
4500 See also C<sv_mortalcopy> and C<sv_2mortal>.
4509 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
4512 SV* sv_newref(SV* sv)
4519 A private implementation of the C<SvNVx> macro for compilers which can't
4520 cope with complex macro expressions. Always use the macro instead.
4529 Converts the value pointed to by offsetp from a count of bytes from the
4530 start of the string, to a count of the equivalent number of UTF-8 chars.
4531 Handles magic and type coercion.
4533 void sv_pos_b2u(SV* sv, I32* offsetp)
4540 Converts the value pointed to by offsetp from a count of UTF-8 chars from
4541 the start of the string, to a count of the equivalent number of bytes; if
4542 lenp is non-zero, it does the same to lenp, but this time starting from
4543 the offset, rather than from the start of the string. Handles magic and
4546 void sv_pos_u2b(SV* sv, I32* offsetp, I32* lenp)
4553 Use the C<SvPV_nolen> macro instead
4562 Use C<SvPVbyte_nolen> instead.
4564 char* sv_pvbyte(SV *sv)
4571 A private implementation of the C<SvPVbyte> macro for compilers
4572 which can't cope with complex macro expressions. Always use the macro
4575 char* sv_pvbyten(SV *sv, STRLEN *len)
4580 =item sv_pvbyten_force
4582 A private implementation of the C<SvPVbytex_force> macro for compilers
4583 which can't cope with complex macro expressions. Always use the macro
4586 char* sv_pvbyten_force(SV* sv, STRLEN* lp)
4593 A private implementation of the C<SvPV> macro for compilers which can't
4594 cope with complex macro expressions. Always use the macro instead.
4596 char* sv_pvn(SV *sv, STRLEN *len)
4603 Get a sensible string out of the SV somehow.
4604 A private implementation of the C<SvPV_force> macro for compilers which
4605 can't cope with complex macro expressions. Always use the macro instead.
4607 char* sv_pvn_force(SV* sv, STRLEN* lp)
4612 =item sv_pvn_force_flags
4614 Get a sensible string out of the SV somehow.
4615 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
4616 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
4617 implemented in terms of this function.
4618 You normally want to use the various wrapper macros instead: see
4619 C<SvPV_force> and C<SvPV_force_nomg>
4621 char* sv_pvn_force_flags(SV* sv, STRLEN* lp, I32 flags)
4628 Use the C<SvPVutf8_nolen> macro instead
4630 char* sv_pvutf8(SV *sv)
4637 A private implementation of the C<SvPVutf8> macro for compilers
4638 which can't cope with complex macro expressions. Always use the macro
4641 char* sv_pvutf8n(SV *sv, STRLEN *len)
4646 =item sv_pvutf8n_force
4648 A private implementation of the C<SvPVutf8_force> macro for compilers
4649 which can't cope with complex macro expressions. Always use the macro
4652 char* sv_pvutf8n_force(SV* sv, STRLEN* lp)
4659 Returns a string describing what the SV is a reference to.
4661 char* sv_reftype(const SV* sv, int ob)
4668 Make the first argument a copy of the second, then delete the original.
4669 The target SV physically takes over ownership of the body of the source SV
4670 and inherits its flags; however, the target keeps any magic it owns,
4671 and any magic in the source is discarded.
4672 Note that this is a rather specialist SV copying operation; most of the
4673 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4675 void sv_replace(SV* sv, SV* nsv)
4680 =item sv_report_used
4682 Dump the contents of all SVs not yet freed. (Debugging aid).
4684 void sv_report_used()
4691 Underlying implementation for the C<reset> Perl function.
4692 Note that the perl-level function is vaguely deprecated.
4694 void sv_reset(const char* s, HV* stash)
4701 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4702 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4703 push a back-reference to this RV onto the array of backreferences
4704 associated with that magic.
4706 SV* sv_rvweaken(SV *sv)
4713 Copies an integer into the given SV, upgrading first if necessary.
4714 Does not handle 'set' magic. See also C<sv_setiv_mg>.
4716 void sv_setiv(SV* sv, IV num)
4723 Like C<sv_setiv>, but also handles 'set' magic.
4725 void sv_setiv_mg(SV *sv, IV i)
4732 Copies a double into the given SV, upgrading first if necessary.
4733 Does not handle 'set' magic. See also C<sv_setnv_mg>.
4735 void sv_setnv(SV* sv, NV num)
4742 Like C<sv_setnv>, but also handles 'set' magic.
4744 void sv_setnv_mg(SV *sv, NV num)
4751 Copies a string into an SV. The string must be null-terminated. Does not
4752 handle 'set' magic. See C<sv_setpv_mg>.
4754 void sv_setpv(SV* sv, const char* ptr)
4761 Works like C<sv_catpvf> but copies the text into the SV instead of
4762 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
4764 void sv_setpvf(SV* sv, const char* pat, ...)
4771 Like C<sv_setpvf>, but also handles 'set' magic.
4773 void sv_setpvf_mg(SV *sv, const char* pat, ...)
4780 Copies an integer into the given SV, also updating its string value.
4781 Does not handle 'set' magic. See C<sv_setpviv_mg>.
4783 void sv_setpviv(SV* sv, IV num)
4790 Like C<sv_setpviv>, but also handles 'set' magic.
4792 void sv_setpviv_mg(SV *sv, IV iv)
4799 Copies a string into an SV. The C<len> parameter indicates the number of
4800 bytes to be copied. If the C<ptr> argument is NULL the SV will become
4801 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4803 void sv_setpvn(SV* sv, const char* ptr, STRLEN len)
4810 Like C<sv_setpvn>, but also handles 'set' magic.
4812 void sv_setpvn_mg(SV *sv, const char *ptr, STRLEN len)
4819 Like C<sv_setpv>, but also handles 'set' magic.
4821 void sv_setpv_mg(SV *sv, const char *ptr)
4828 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
4829 argument will be upgraded to an RV. That RV will be modified to point to
4830 the new SV. The C<classname> argument indicates the package for the
4831 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4832 will have a reference count of 1, and the RV will be returned.
4834 SV* sv_setref_iv(SV* rv, const char* classname, IV iv)
4841 Copies a double into a new SV, optionally blessing the SV. The C<rv>
4842 argument will be upgraded to an RV. That RV will be modified to point to
4843 the new SV. The C<classname> argument indicates the package for the
4844 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4845 will have a reference count of 1, and the RV will be returned.
4847 SV* sv_setref_nv(SV* rv, const char* classname, NV nv)
4854 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
4855 argument will be upgraded to an RV. That RV will be modified to point to
4856 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
4857 into the SV. The C<classname> argument indicates the package for the
4858 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4859 will have a reference count of 1, and the RV will be returned.
4861 Do not use with other Perl types such as HV, AV, SV, CV, because those
4862 objects will become corrupted by the pointer copy process.
4864 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
4866 SV* sv_setref_pv(SV* rv, const char* classname, void* pv)
4873 Copies a string into a new SV, optionally blessing the SV. The length of the
4874 string must be specified with C<n>. The C<rv> argument will be upgraded to
4875 an RV. That RV will be modified to point to the new SV. The C<classname>
4876 argument indicates the package for the blessing. Set C<classname> to
4877 C<Nullch> to avoid the blessing. The new SV will have a reference count
4878 of 1, and the RV will be returned.
4880 Note that C<sv_setref_pv> copies the pointer while this copies the string.
4882 SV* sv_setref_pvn(SV* rv, const char* classname, const char* pv, STRLEN n)
4889 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
4890 argument will be upgraded to an RV. That RV will be modified to point to
4891 the new SV. The C<classname> argument indicates the package for the
4892 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4893 will have a reference count of 1, and the RV will be returned.
4895 SV* sv_setref_uv(SV* rv, const char* classname, UV uv)
4902 Copies the contents of the source SV C<ssv> into the destination SV
4903 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4904 function if the source SV needs to be reused. Does not handle 'set' magic.
4905 Loosely speaking, it performs a copy-by-value, obliterating any previous
4906 content of the destination.
4908 You probably want to use one of the assortment of wrappers, such as
4909 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4910 C<SvSetMagicSV_nosteal>.
4912 void sv_setsv(SV* dsv, SV* ssv)
4917 =item sv_setsv_flags
4919 Copies the contents of the source SV C<ssv> into the destination SV
4920 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4921 function if the source SV needs to be reused. Does not handle 'set' magic.
4922 Loosely speaking, it performs a copy-by-value, obliterating any previous
4923 content of the destination.
4924 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
4925 C<ssv> if appropriate, else not. If the C<flags> parameter has the
4926 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
4927 and C<sv_setsv_nomg> are implemented in terms of this function.
4929 You probably want to use one of the assortment of wrappers, such as
4930 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4931 C<SvSetMagicSV_nosteal>.
4933 This is the primary function for copying scalars, and most other
4934 copy-ish functions and macros use this underneath.
4936 void sv_setsv_flags(SV* dsv, SV* ssv, I32 flags)
4943 Like C<sv_setsv>, but also handles 'set' magic.
4945 void sv_setsv_mg(SV *dstr, SV *sstr)
4952 Like C<sv_setsv> but doesn't process magic.
4954 void sv_setsv_nomg(SV* dsv, SV* ssv)
4961 Copies an unsigned integer into the given SV, upgrading first if necessary.
4962 Does not handle 'set' magic. See also C<sv_setuv_mg>.
4964 void sv_setuv(SV* sv, UV num)
4971 Like C<sv_setuv>, but also handles 'set' magic.
4973 void sv_setuv_mg(SV *sv, UV u)
4980 Taint an SV. Use C<SvTAINTED_on> instead.
4981 void sv_taint(SV* sv)
4988 Test an SV for taintedness. Use C<SvTAINTED> instead.
4989 bool sv_tainted(SV* sv)
4996 Returns true if the SV has a true value by Perl's rules.
4997 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
4998 instead use an in-line version.
5007 Removes all magic of type C<type> from an SV.
5009 int sv_unmagic(SV* sv, int type)
5016 Unsets the RV status of the SV, and decrements the reference count of
5017 whatever was being referenced by the RV. This can almost be thought of
5018 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
5019 being zero. See C<SvROK_off>.
5021 void sv_unref(SV* sv)
5026 =item sv_unref_flags
5028 Unsets the RV status of the SV, and decrements the reference count of
5029 whatever was being referenced by the RV. This can almost be thought of
5030 as a reversal of C<newSVrv>. The C<cflags> argument can contain
5031 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
5032 (otherwise the decrementing is conditional on the reference count being
5033 different from one or the reference being a readonly SV).
5036 void sv_unref_flags(SV* sv, U32 flags)
5043 Untaint an SV. Use C<SvTAINTED_off> instead.
5044 void sv_untaint(SV* sv)
5051 Upgrade an SV to a more complex form. Generally adds a new body type to the
5052 SV, then copies across as much information as possible from the old body.
5053 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
5055 void sv_upgrade(SV* sv, U32 mt)
5062 Tells an SV to use C<ptr> to find its string value. Normally the string is
5063 stored inside the SV but sv_usepvn allows the SV to use an outside string.
5064 The C<ptr> should point to memory that was allocated by C<malloc>. The
5065 string length, C<len>, must be supplied. This function will realloc the
5066 memory pointed to by C<ptr>, so that pointer should not be freed or used by
5067 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
5068 See C<sv_usepvn_mg>.
5070 void sv_usepvn(SV* sv, char* ptr, STRLEN len)
5077 Like C<sv_usepvn>, but also handles 'set' magic.
5079 void sv_usepvn_mg(SV *sv, char *ptr, STRLEN len)
5084 =item sv_utf8_decode
5086 If the PV of the SV is an octet sequence in UTF-8
5087 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
5088 so that it looks like a character. If the PV contains only single-byte
5089 characters, the C<SvUTF8> flag stays being off.
5090 Scans PV for validity and returns false if the PV is invalid UTF-8.
5092 NOTE: this function is experimental and may change or be
5093 removed without notice.
5095 bool sv_utf8_decode(SV *sv)
5100 =item sv_utf8_downgrade
5102 Attempts to convert the PV of an SV from characters to bytes.
5103 If the PV contains a character beyond byte, this conversion will fail;
5104 in this case, either returns false or, if C<fail_ok> is not
5107 This is not as a general purpose Unicode to byte encoding interface:
5108 use the Encode extension for that.
5110 NOTE: this function is experimental and may change or be
5111 removed without notice.
5113 bool sv_utf8_downgrade(SV *sv, bool fail_ok)
5118 =item sv_utf8_encode
5120 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
5121 flag off so that it looks like octets again.
5123 void sv_utf8_encode(SV *sv)
5128 =item sv_utf8_upgrade
5130 Converts the PV of an SV to its UTF-8-encoded form.
5131 Forces the SV to string form if it is not already.
5132 Always sets the SvUTF8 flag to avoid future validity checks even
5133 if all the bytes have hibit clear.
5135 This is not as a general purpose byte encoding to Unicode interface:
5136 use the Encode extension for that.
5138 STRLEN sv_utf8_upgrade(SV *sv)
5143 =item sv_utf8_upgrade_flags
5145 Converts the PV of an SV to its UTF-8-encoded form.
5146 Forces the SV to string form if it is not already.
5147 Always sets the SvUTF8 flag to avoid future validity checks even
5148 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
5149 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
5150 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
5152 This is not as a general purpose byte encoding to Unicode interface:
5153 use the Encode extension for that.
5155 STRLEN sv_utf8_upgrade_flags(SV *sv, I32 flags)
5162 A private implementation of the C<SvUVx> macro for compilers which can't
5163 cope with complex macro expressions. Always use the macro instead.
5172 Processes its arguments like C<vsprintf> and appends the formatted output
5173 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
5175 Usually used via its frontend C<sv_catpvf>.
5177 void sv_vcatpvf(SV* sv, const char* pat, va_list* args)
5184 Processes its arguments like C<vsprintf> and appends the formatted output
5185 to an SV. Uses an array of SVs if the C style variable argument list is
5186 missing (NULL). When running with taint checks enabled, indicates via
5187 C<maybe_tainted> if results are untrustworthy (often due to the use of
5190 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
5192 void sv_vcatpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
5199 Like C<sv_vcatpvf>, but also handles 'set' magic.
5201 Usually used via its frontend C<sv_catpvf_mg>.
5203 void sv_vcatpvf_mg(SV* sv, const char* pat, va_list* args)
5210 Works like C<sv_vcatpvf> but copies the text into the SV instead of
5211 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
5213 Usually used via its frontend C<sv_setpvf>.
5215 void sv_vsetpvf(SV* sv, const char* pat, va_list* args)
5222 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
5225 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
5227 void sv_vsetpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
5234 Like C<sv_vsetpvf>, but also handles 'set' magic.
5236 Usually used via its frontend C<sv_setpvf_mg>.
5238 void sv_vsetpvf_mg(SV* sv, const char* pat, va_list* args)
5246 =head1 Unicode Support
5250 =item bytes_from_utf8
5252 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
5253 Unlike C<utf8_to_bytes> but like C<bytes_to_utf8>, returns a pointer to
5254 the newly-created string, and updates C<len> to contain the new
5255 length. Returns the original string if no conversion occurs, C<len>
5256 is unchanged. Do nothing if C<is_utf8> points to 0. Sets C<is_utf8> to
5257 0 if C<s> is converted or contains all 7bit characters.
5259 NOTE: this function is experimental and may change or be
5260 removed without notice.
5262 U8* bytes_from_utf8(const U8 *s, STRLEN *len, bool *is_utf8)
5265 Found in file utf8.c
5269 Converts a string C<s> of length C<len> from ASCII into UTF-8 encoding.
5270 Returns a pointer to the newly-created string, and sets C<len> to
5271 reflect the new length.
5273 If you want to convert to UTF-8 from other encodings than ASCII,
5274 see sv_recode_to_utf8().
5276 NOTE: this function is experimental and may change or be
5277 removed without notice.
5279 U8* bytes_to_utf8(const U8 *s, STRLEN *len)
5282 Found in file utf8.c
5286 Return true if the strings s1 and s2 differ case-insensitively, false
5287 if not (if they are equal case-insensitively). If u1 is true, the
5288 string s1 is assumed to be in UTF-8-encoded Unicode. If u2 is true,
5289 the string s2 is assumed to be in UTF-8-encoded Unicode. If u1 or u2
5290 are false, the respective string is assumed to be in native 8-bit
5293 If the pe1 and pe2 are non-NULL, the scanning pointers will be copied
5294 in there (they will point at the beginning of the I<next> character).
5295 If the pointers behind pe1 or pe2 are non-NULL, they are the end
5296 pointers beyond which scanning will not continue under any
5297 circumstances. If the byte lengths l1 and l2 are non-zero, s1+l1 and
5298 s2+l2 will be used as goal end pointers that will also stop the scan,
5299 and which qualify towards defining a successful match: all the scans
5300 that define an explicit length must reach their goal pointers for
5301 a match to succeed).
5303 For case-insensitiveness, the "casefolding" of Unicode is used
5304 instead of upper/lowercasing both the characters, see
5305 http://www.unicode.org/unicode/reports/tr21/ (Case Mappings).
5307 I32 ibcmp_utf8(const char* a, char **pe1, UV l1, bool u1, const char* b, char **pe2, UV l2, bool u2)
5310 Found in file utf8.c
5314 Tests if some arbitrary number of bytes begins in a valid UTF-8
5315 character. Note that an INVARIANT (i.e. ASCII) character is a valid
5316 UTF-8 character. The actual number of bytes in the UTF-8 character
5317 will be returned if it is valid, otherwise 0.
5319 STRLEN is_utf8_char(const U8 *p)
5322 Found in file utf8.c
5324 =item is_utf8_string
5326 Returns true if first C<len> bytes of the given string form a valid
5327 UTF-8 string, false otherwise. Note that 'a valid UTF-8 string' does
5328 not mean 'a string that contains code points above 0x7F encoded in UTF-8'
5329 because a valid ASCII string is a valid UTF-8 string.
5331 See also is_utf8_string_loclen() and is_utf8_string_loc().
5333 bool is_utf8_string(const U8 *s, STRLEN len)
5336 Found in file utf8.c
5338 =item is_utf8_string_loc
5340 Like is_ut8_string() but stores the location of the failure (in the
5341 case of "utf8ness failure") or the location s+len (in the case of
5342 "utf8ness success") in the C<ep>.
5344 See also is_utf8_string_loclen() and is_utf8_string().
5346 bool is_utf8_string_loc(const U8 *s, STRLEN len, const U8 **p)
5349 Found in file utf8.c
5351 =item is_utf8_string_loclen
5353 Like is_ut8_string() but stores the location of the failure (in the
5354 case of "utf8ness failure") or the location s+len (in the case of
5355 "utf8ness success") in the C<ep>, and the number of UTF-8
5356 encoded characters in the C<el>.
5358 See also is_utf8_string_loc() and is_utf8_string().
5360 bool is_utf8_string_loclen(const U8 *s, STRLEN len, const U8 **ep, STRLEN *el)
5363 Found in file utf8.c
5365 =item pv_uni_display
5367 Build to the scalar dsv a displayable version of the string spv,
5368 length len, the displayable version being at most pvlim bytes long
5369 (if longer, the rest is truncated and "..." will be appended).
5371 The flags argument can have UNI_DISPLAY_ISPRINT set to display
5372 isPRINT()able characters as themselves, UNI_DISPLAY_BACKSLASH
5373 to display the \\[nrfta\\] as the backslashed versions (like '\n')
5374 (UNI_DISPLAY_BACKSLASH is preferred over UNI_DISPLAY_ISPRINT for \\).
5375 UNI_DISPLAY_QQ (and its alias UNI_DISPLAY_REGEX) have both
5376 UNI_DISPLAY_BACKSLASH and UNI_DISPLAY_ISPRINT turned on.
5378 The pointer to the PV of the dsv is returned.
5380 char* pv_uni_display(SV *dsv, const U8 *spv, STRLEN len, STRLEN pvlim, UV flags)
5383 Found in file utf8.c
5387 The encoding is assumed to be an Encode object, the PV of the ssv is
5388 assumed to be octets in that encoding and decoding the input starts
5389 from the position which (PV + *offset) pointed to. The dsv will be
5390 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
5391 when the string tstr appears in decoding output or the input ends on
5392 the PV of the ssv. The value which the offset points will be modified
5393 to the last input position on the ssv.
5395 Returns TRUE if the terminator was found, else returns FALSE.
5397 bool sv_cat_decode(SV* dsv, SV *encoding, SV *ssv, int *offset, char* tstr, int tlen)
5402 =item sv_recode_to_utf8
5404 The encoding is assumed to be an Encode object, on entry the PV
5405 of the sv is assumed to be octets in that encoding, and the sv
5406 will be converted into Unicode (and UTF-8).
5408 If the sv already is UTF-8 (or if it is not POK), or if the encoding
5409 is not a reference, nothing is done to the sv. If the encoding is not
5410 an C<Encode::XS> Encoding object, bad things will happen.
5411 (See F<lib/encoding.pm> and L<Encode>).
5413 The PV of the sv is returned.
5415 char* sv_recode_to_utf8(SV* sv, SV *encoding)
https://perl5.git.perl.org / perl5.git / blob