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 In 5.9.3, Newx() and friends replace the older New() API, and drops
1607 the first parameter, I<x>, a debug aid which allowed callers to identify
1608 themselves. This aid has been superceded by a new build option,
1609 PERL_MEM_LOG (see L<perlhack/PERL_MEM_LOG>). The older API is still
1610 there for use in XS modules supporting older perls.
1612 void Newx(void* ptr, int nitems, type)
1615 Found in file handy.h
1619 The XSUB-writer's interface to the C C<malloc> function, with
1620 cast. See also C<Newx>.
1622 void Newxc(void* ptr, int nitems, type, cast)
1625 Found in file handy.h
1629 The XSUB-writer's interface to the C C<malloc> function. The allocated
1630 memory is zeroed with C<memzero>. See also C<Newx>.
1632 void Newxz(void* ptr, int nitems, type)
1635 Found in file handy.h
1639 Fill up memory with a pattern (byte 0xAB over and over again) that
1640 hopefully catches attempts to access uninitialized memory.
1642 void Poison(void* dest, int nitems, type)
1645 Found in file handy.h
1649 The XSUB-writer's interface to the C C<realloc> function.
1651 void Renew(void* ptr, int nitems, type)
1654 Found in file handy.h
1658 The XSUB-writer's interface to the C C<realloc> function, with
1661 void Renewc(void* ptr, int nitems, type, cast)
1664 Found in file handy.h
1668 The XSUB-writer's interface to the C C<free> function.
1670 void Safefree(void* ptr)
1673 Found in file handy.h
1677 Perl's version of C<strdup()>. Returns a pointer to a newly allocated
1678 string which is a duplicate of C<pv>. The size of the string is
1679 determined by C<strlen()>. The memory allocated for the new string can
1680 be freed with the C<Safefree()> function.
1682 char* savepv(const char* pv)
1685 Found in file util.c
1689 Perl's version of what C<strndup()> would be if it existed. Returns a
1690 pointer to a newly allocated string which is a duplicate of the first
1691 C<len> bytes from C<pv>. The memory allocated for the new string can be
1692 freed with the C<Safefree()> function.
1694 char* savepvn(const char* pv, I32 len)
1697 Found in file util.c
1701 A version of C<savepv()> which allocates the duplicate string in memory
1702 which is shared between threads.
1704 char* savesharedpv(const char* pv)
1707 Found in file util.c
1711 A version of C<savepv()>/C<savepvn()> which gets the string to duplicate from
1712 the passed in SV using C<SvPV()>
1714 char* savesvpv(SV* sv)
1717 Found in file util.c
1721 This is an architecture-independent macro to copy one structure to another.
1723 void StructCopy(type src, type dest, type)
1726 Found in file handy.h
1730 The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the
1731 destination, C<nitems> is the number of items, and C<type> is the type.
1733 void Zero(void* dest, int nitems, type)
1736 Found in file handy.h
1740 Like C<Zero> but returns dest. Useful for encouraging compilers to tail-call
1743 void * ZeroD(void* dest, int nitems, type)
1746 Found in file handy.h
1751 =head1 Miscellaneous Functions
1757 Analyses the string in order to make fast searches on it using fbm_instr()
1758 -- the Boyer-Moore algorithm.
1760 void fbm_compile(SV* sv, U32 flags)
1763 Found in file util.c
1767 Returns the location of the SV in the string delimited by C<str> and
1768 C<strend>. It returns C<Nullch> if the string can't be found. The C<sv>
1769 does not have to be fbm_compiled, but the search will not be as fast
1772 char* fbm_instr(unsigned char* big, unsigned char* bigend, SV* littlesv, U32 flags)
1775 Found in file util.c
1779 Takes a sprintf-style format pattern and conventional
1780 (non-SV) arguments and returns the formatted string.
1782 (char *) Perl_form(pTHX_ const char* pat, ...)
1784 can be used any place a string (char *) is required:
1786 char * s = Perl_form("%d.%d",major,minor);
1788 Uses a single private buffer so if you want to format several strings you
1789 must explicitly copy the earlier strings away (and free the copies when you
1792 char* form(const char* pat, ...)
1795 Found in file util.c
1799 Fill the sv with current working directory
1801 int getcwd_sv(SV* sv)
1804 Found in file util.c
1808 Returns a new version object based on the passed in SV:
1810 SV *sv = new_version(SV *ver);
1812 Does not alter the passed in ver SV. See "upg_version" if you
1813 want to upgrade the SV.
1815 SV* new_version(SV *ver)
1818 Found in file util.c
1822 Returns a pointer to the next character after the parsed
1823 version string, as well as upgrading the passed in SV to
1826 Function must be called with an already existing SV like
1829 s = scan_version(s,SV *sv, bool qv);
1831 Performs some preprocessing to the string to ensure that
1832 it has the correct characteristics of a version. Flags the
1833 object if it contains an underscore (which denotes this
1834 is a alpha version). The boolean qv denotes that the version
1835 should be interpreted as if it had multiple decimals, even if
1838 const char* scan_version(const char *vstr, SV *sv, bool qv)
1841 Found in file util.c
1845 Test two strings to see if they are equal. Returns true or false.
1847 bool strEQ(char* s1, char* s2)
1850 Found in file handy.h
1854 Test two strings to see if the first, C<s1>, is greater than or equal to
1855 the second, C<s2>. Returns true or false.
1857 bool strGE(char* s1, char* s2)
1860 Found in file handy.h
1864 Test two strings to see if the first, C<s1>, is greater than the second,
1865 C<s2>. Returns true or false.
1867 bool strGT(char* s1, char* s2)
1870 Found in file handy.h
1874 Test two strings to see if the first, C<s1>, is less than or equal to the
1875 second, C<s2>. Returns true or false.
1877 bool strLE(char* s1, char* s2)
1880 Found in file handy.h
1884 Test two strings to see if the first, C<s1>, is less than the second,
1885 C<s2>. Returns true or false.
1887 bool strLT(char* s1, char* s2)
1890 Found in file handy.h
1894 Test two strings to see if they are different. Returns true or
1897 bool strNE(char* s1, char* s2)
1900 Found in file handy.h
1904 Test two strings to see if they are equal. The C<len> parameter indicates
1905 the number of bytes to compare. Returns true or false. (A wrapper for
1908 bool strnEQ(char* s1, char* s2, STRLEN len)
1911 Found in file handy.h
1915 Test two strings to see if they are different. The C<len> parameter
1916 indicates the number of bytes to compare. Returns true or false. (A
1917 wrapper for C<strncmp>).
1919 bool strnNE(char* s1, char* s2, STRLEN len)
1922 Found in file handy.h
1926 Dummy routine which "locks" an SV when there is no locking module present.
1927 Exists to avoid test for a NULL function pointer and because it could potentially warn under
1928 some level of strict-ness.
1930 void sv_nolocking(SV *)
1933 Found in file util.c
1937 Dummy routine which "shares" an SV when there is no sharing module present.
1938 Exists to avoid test for a NULL function pointer and because it could potentially warn under
1939 some level of strict-ness.
1941 void sv_nosharing(SV *)
1944 Found in file util.c
1946 =item sv_nounlocking
1948 Dummy routine which "unlocks" an SV when there is no locking module present.
1949 Exists to avoid test for a NULL function pointer and because it could potentially warn under
1950 some level of strict-ness.
1952 void sv_nounlocking(SV *)
1955 Found in file util.c
1959 In-place upgrade of the supplied SV to a version object.
1961 SV *sv = upg_version(SV *sv);
1963 Returns a pointer to the upgraded SV.
1965 SV* upg_version(SV *ver)
1968 Found in file util.c
1972 Version object aware cmp. Both operands must already have been
1973 converted into version objects.
1975 int vcmp(SV *lvs, SV *rvs)
1978 Found in file util.c
1982 Accepts a version object and returns the normalized string
1983 representation. Call like:
1987 NOTE: you can pass either the object directly or the SV
1988 contained within the RV.
1993 Found in file util.c
1997 Accepts a version object and returns the normalized floating
1998 point representation. Call like:
2002 NOTE: you can pass either the object directly or the SV
2003 contained within the RV.
2008 Found in file util.c
2012 In order to maintain maximum compatibility with earlier versions
2013 of Perl, this function will return either the floating point
2014 notation or the multiple dotted notation, depending on whether
2015 the original version contained 1 or more dots, respectively
2017 SV* vstringify(SV *vs)
2020 Found in file util.c
2025 =head1 Numeric functions
2031 converts a string representing a binary number to numeric form.
2033 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2034 conversion flags, and I<result> should be NULL or a pointer to an NV.
2035 The scan stops at the end of the string, or the first invalid character.
2036 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2037 invalid character will also trigger a warning.
2038 On return I<*len> is set to the length of the scanned string,
2039 and I<*flags> gives output flags.
2041 If the value is <= C<UV_MAX> it is returned as a UV, the output flags are clear,
2042 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_bin>
2043 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2044 and writes the value to I<*result> (or the value is discarded if I<result>
2047 The binary number may optionally be prefixed with "0b" or "b" unless
2048 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
2049 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the binary
2050 number may use '_' characters to separate digits.
2052 UV grok_bin(const char* start, STRLEN* len_p, I32* flags, NV *result)
2055 Found in file numeric.c
2059 converts a string representing a hex number to numeric form.
2061 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2062 conversion flags, and I<result> should be NULL or a pointer to an NV.
2063 The scan stops at the end of the string, or the first invalid character.
2064 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2065 invalid character will also trigger a warning.
2066 On return I<*len> is set to the length of the scanned string,
2067 and I<*flags> gives output flags.
2069 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2070 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_hex>
2071 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2072 and writes the value to I<*result> (or the value is discarded if I<result>
2075 The hex number may optionally be prefixed with "0x" or "x" unless
2076 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
2077 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the hex
2078 number may use '_' characters to separate digits.
2080 UV grok_hex(const char* start, STRLEN* len_p, I32* flags, NV *result)
2083 Found in file numeric.c
2087 Recognise (or not) a number. The type of the number is returned
2088 (0 if unrecognised), otherwise it is a bit-ORed combination of
2089 IS_NUMBER_IN_UV, IS_NUMBER_GREATER_THAN_UV_MAX, IS_NUMBER_NOT_INT,
2090 IS_NUMBER_NEG, IS_NUMBER_INFINITY, IS_NUMBER_NAN (defined in perl.h).
2092 If the value of the number can fit an in UV, it is returned in the *valuep
2093 IS_NUMBER_IN_UV will be set to indicate that *valuep is valid, IS_NUMBER_IN_UV
2094 will never be set unless *valuep is valid, but *valuep may have been assigned
2095 to during processing even though IS_NUMBER_IN_UV is not set on return.
2096 If valuep is NULL, IS_NUMBER_IN_UV will be set for the same cases as when
2097 valuep is non-NULL, but no actual assignment (or SEGV) will occur.
2099 IS_NUMBER_NOT_INT will be set with IS_NUMBER_IN_UV if trailing decimals were
2100 seen (in which case *valuep gives the true value truncated to an integer), and
2101 IS_NUMBER_NEG if the number is negative (in which case *valuep holds the
2102 absolute value). IS_NUMBER_IN_UV is not set if e notation was used or the
2103 number is larger than a UV.
2105 int grok_number(const char *pv, STRLEN len, UV *valuep)
2108 Found in file numeric.c
2110 =item grok_numeric_radix
2112 Scan and skip for a numeric decimal separator (radix).
2114 bool grok_numeric_radix(const char **sp, const char *send)
2117 Found in file numeric.c
2121 converts a string representing an octal number to numeric form.
2123 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2124 conversion flags, and I<result> should be NULL or a pointer to an NV.
2125 The scan stops at the end of the string, or the first invalid character.
2126 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2127 invalid character will also trigger a warning.
2128 On return I<*len> is set to the length of the scanned string,
2129 and I<*flags> gives output flags.
2131 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2132 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_oct>
2133 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2134 and writes the value to I<*result> (or the value is discarded if I<result>
2137 If C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the octal
2138 number may use '_' characters to separate digits.
2140 UV grok_oct(const char* start, STRLEN* len_p, I32* flags, NV *result)
2143 Found in file numeric.c
2147 For backwards compatibility. Use C<grok_bin> instead.
2149 NV scan_bin(const char* start, STRLEN len, STRLEN* retlen)
2152 Found in file numeric.c
2156 For backwards compatibility. Use C<grok_hex> instead.
2158 NV scan_hex(const char* start, STRLEN len, STRLEN* retlen)
2161 Found in file numeric.c
2165 For backwards compatibility. Use C<grok_oct> instead.
2167 NV scan_oct(const char* start, STRLEN len, STRLEN* retlen)
2170 Found in file numeric.c
2175 =head1 Optree Manipulation Functions
2181 If C<cv> is a constant sub eligible for inlining. returns the constant
2182 value returned by the sub. Otherwise, returns NULL.
2184 Constant subs can be created with C<newCONSTSUB> or as described in
2185 L<perlsub/"Constant Functions">.
2187 SV* cv_const_sv(CV* cv)
2194 Creates a constant sub equivalent to Perl C<sub FOO () { 123 }> which is
2195 eligible for inlining at compile-time.
2197 CV* newCONSTSUB(HV* stash, const char* name, SV* sv)
2204 Used by C<xsubpp> to hook up XSUBs as Perl subs.
2212 =head1 Pad Data Structures
2218 Get the value at offset po in the current pad.
2219 Use macro PAD_SV instead of calling this function directly.
2221 SV* pad_sv(PADOFFSET po)
2229 =head1 Simple Exception Handling Macros
2235 Set up necessary local variables for exception handling.
2236 See L<perlguts/"Exception Handling">.
2241 Found in file XSUB.h
2245 Introduces a catch block. See L<perlguts/"Exception Handling">.
2248 Found in file XSUB.h
2252 Rethrows a previously caught exception. See L<perlguts/"Exception Handling">.
2257 Found in file XSUB.h
2261 Ends a try block. See L<perlguts/"Exception Handling">.
2264 Found in file XSUB.h
2266 =item XCPT_TRY_START
2268 Starts a try block. See L<perlguts/"Exception Handling">.
2271 Found in file XSUB.h
2276 =head1 Stack Manipulation Macros
2282 Declare a stack marker variable, C<mark>, for the XSUB. See C<MARK> and
2292 Saves the original stack mark for the XSUB. See C<ORIGMARK>.
2301 Declares a local copy of perl's stack pointer for the XSUB, available via
2302 the C<SP> macro. See C<SP>.
2311 Used to extend the argument stack for an XSUB's return values. Once
2312 used, guarantees that there is room for at least C<nitems> to be pushed
2315 void EXTEND(SP, int nitems)
2322 Stack marker variable for the XSUB. See C<dMARK>.
2329 Push an integer onto the stack. The stack must have room for this element.
2330 Handles 'set' magic. Does not use C<TARG>. See also C<PUSHi>, C<mXPUSHi>
2340 Push a double onto the stack. The stack must have room for this element.
2341 Handles 'set' magic. Does not use C<TARG>. See also C<PUSHn>, C<mXPUSHn>
2351 Push a string onto the stack. The stack must have room for this element.
2352 The C<len> indicates the length of the string. Handles 'set' magic. Does
2353 not use C<TARG>. See also C<PUSHp>, C<mXPUSHp> and C<XPUSHp>.
2355 void mPUSHp(char* str, STRLEN len)
2362 Push an unsigned integer onto the stack. The stack must have room for this
2363 element. Handles 'set' magic. Does not use C<TARG>. See also C<PUSHu>,
2364 C<mXPUSHu> and C<XPUSHu>.
2373 Push an integer onto the stack, extending the stack if necessary. Handles
2374 'set' magic. Does not use C<TARG>. See also C<XPUSHi>, C<mPUSHi> and
2384 Push a double onto the stack, extending the stack if necessary. Handles
2385 'set' magic. Does not use C<TARG>. See also C<XPUSHn>, C<mPUSHn> and
2395 Push a string onto the stack, extending the stack if necessary. The C<len>
2396 indicates the length of the string. Handles 'set' magic. Does not use
2397 C<TARG>. See also C<XPUSHp>, C<mPUSHp> and C<PUSHp>.
2399 void mXPUSHp(char* str, STRLEN len)
2406 Push an unsigned integer onto the stack, extending the stack if necessary.
2407 Handles 'set' magic. Does not use C<TARG>. See also C<XPUSHu>, C<mPUSHu>
2417 The original stack mark for the XSUB. See C<dORIGMARK>.
2424 Pops an integer off the stack.
2433 Pops a long off the stack.
2442 Pops a double off the stack.
2451 Pops a string off the stack. Deprecated. New code should use POPpx.
2460 Pops a string off the stack which must consist of bytes i.e. characters < 256.
2469 Pops a string off the stack.
2478 Pops an SV off the stack.
2487 Push an integer onto the stack. The stack must have room for this element.
2488 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
2489 called to declare it. Do not call multiple C<TARG>-oriented macros to
2490 return lists from XSUB's - see C<mPUSHi> instead. See also C<XPUSHi> and
2500 Opening bracket for arguments on a callback. See C<PUTBACK> and
2510 Push a new mortal SV onto the stack. The stack must have room for this
2511 element. Does not handle 'set' magic. Does not use C<TARG>. See also
2512 C<PUSHs>, C<XPUSHmortal> and C<XPUSHs>.
2521 Push a double onto the stack. The stack must have room for this element.
2522 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
2523 called to declare it. Do not call multiple C<TARG>-oriented macros to
2524 return lists from XSUB's - see C<mPUSHn> instead. See also C<XPUSHn> and
2534 Push a string onto the stack. The stack must have room for this element.
2535 The C<len> indicates the length of the string. Handles 'set' magic. Uses
2536 C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to declare it. Do not
2537 call multiple C<TARG>-oriented macros to return lists from XSUB's - see
2538 C<mPUSHp> instead. See also C<XPUSHp> and C<mXPUSHp>.
2540 void PUSHp(char* str, STRLEN len)
2547 Push an SV onto the stack. The stack must have room for this element.
2548 Does not handle 'set' magic. Does not use C<TARG>. See also C<PUSHmortal>,
2549 C<XPUSHs> and C<XPUSHmortal>.
2558 Push an unsigned integer onto the stack. The stack must have room for this
2559 element. Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG>
2560 should be called to declare it. Do not call multiple C<TARG>-oriented
2561 macros to return lists from XSUB's - see C<mPUSHu> instead. See also
2562 C<XPUSHu> and C<mXPUSHu>.
2571 Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
2572 See C<PUSHMARK> and L<perlcall> for other uses.
2581 Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and
2589 Refetch the stack pointer. Used after a callback. See L<perlcall>.
2598 Push an integer onto the stack, extending the stack if necessary. Handles
2599 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
2600 declare it. Do not call multiple C<TARG>-oriented macros to return lists
2601 from XSUB's - see C<mXPUSHi> instead. See also C<PUSHi> and C<mPUSHi>.
2610 Push a new mortal SV onto the stack, extending the stack if necessary. Does
2611 not handle 'set' magic. Does not use C<TARG>. See also C<XPUSHs>,
2612 C<PUSHmortal> and C<PUSHs>.
2621 Push a double onto the stack, extending the stack if necessary. Handles
2622 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
2623 declare it. Do not call multiple C<TARG>-oriented macros to return lists
2624 from XSUB's - see C<mXPUSHn> instead. See also C<PUSHn> and C<mPUSHn>.
2633 Push a string onto the stack, extending the stack if necessary. The C<len>
2634 indicates the length of the string. Handles 'set' magic. Uses C<TARG>, so
2635 C<dTARGET> or C<dXSTARG> should be called to declare it. Do not call
2636 multiple C<TARG>-oriented macros to return lists from XSUB's - see
2637 C<mXPUSHp> instead. See also C<PUSHp> and C<mPUSHp>.
2639 void XPUSHp(char* str, STRLEN len)
2646 Push an SV onto the stack, extending the stack if necessary. Does not
2647 handle 'set' magic. Does not use C<TARG>. See also C<XPUSHmortal>,
2648 C<PUSHs> and C<PUSHmortal>.
2657 Push an unsigned integer onto the stack, extending the stack if necessary.
2658 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
2659 called to declare it. Do not call multiple C<TARG>-oriented macros to
2660 return lists from XSUB's - see C<mXPUSHu> instead. See also C<PUSHu> and
2670 Return from XSUB, indicating number of items on the stack. This is usually
2671 handled by C<xsubpp>.
2673 void XSRETURN(int nitems)
2676 Found in file XSUB.h
2678 =item XSRETURN_EMPTY
2680 Return an empty list from an XSUB immediately.
2685 Found in file XSUB.h
2689 Return an integer from an XSUB immediately. Uses C<XST_mIV>.
2691 void XSRETURN_IV(IV iv)
2694 Found in file XSUB.h
2698 Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
2703 Found in file XSUB.h
2707 Return a double from an XSUB immediately. Uses C<XST_mNV>.
2709 void XSRETURN_NV(NV nv)
2712 Found in file XSUB.h
2716 Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
2718 void XSRETURN_PV(char* str)
2721 Found in file XSUB.h
2723 =item XSRETURN_UNDEF
2725 Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
2730 Found in file XSUB.h
2734 Return an integer from an XSUB immediately. Uses C<XST_mUV>.
2736 void XSRETURN_UV(IV uv)
2739 Found in file XSUB.h
2743 Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
2748 Found in file XSUB.h
2752 Place an integer into the specified position C<pos> on the stack. The
2753 value is stored in a new mortal SV.
2755 void XST_mIV(int pos, IV iv)
2758 Found in file XSUB.h
2762 Place C<&PL_sv_no> into the specified position C<pos> on the
2765 void XST_mNO(int pos)
2768 Found in file XSUB.h
2772 Place a double into the specified position C<pos> on the stack. The value
2773 is stored in a new mortal SV.
2775 void XST_mNV(int pos, NV nv)
2778 Found in file XSUB.h
2782 Place a copy of a string into the specified position C<pos> on the stack.
2783 The value is stored in a new mortal SV.
2785 void XST_mPV(int pos, char* str)
2788 Found in file XSUB.h
2792 Place C<&PL_sv_undef> into the specified position C<pos> on the
2795 void XST_mUNDEF(int pos)
2798 Found in file XSUB.h
2802 Place C<&PL_sv_yes> into the specified position C<pos> on the
2805 void XST_mYES(int pos)
2808 Found in file XSUB.h
2819 An enum of flags for Perl types. These are found in the file B<sv.h>
2820 in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
2827 Integer type flag for scalars. See C<svtype>.
2834 Double type flag for scalars. See C<svtype>.
2841 Pointer type flag for scalars. See C<svtype>.
2848 Type flag for arrays. See C<svtype>.
2855 Type flag for code refs. See C<svtype>.
2862 Type flag for hashes. See C<svtype>.
2869 Type flag for blessed scalars. See C<svtype>.
2877 =head1 SV Manipulation Functions
2883 Returns the SV of the specified Perl scalar. If C<create> is set and the
2884 Perl variable does not exist then it will be created. If C<create> is not
2885 set and the variable does not exist then NULL is returned.
2887 NOTE: the perl_ form of this function is deprecated.
2889 SV* get_sv(const char* name, I32 create)
2892 Found in file perl.c
2894 =item looks_like_number
2896 Test if the content of an SV looks like a number (or is a number).
2897 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
2898 non-numeric warning), even if your atof() doesn't grok them.
2900 I32 looks_like_number(SV* sv)
2907 Creates an RV wrapper for an SV. The reference count for the original SV is
2910 SV* newRV_inc(SV* sv)
2917 Creates an RV wrapper for an SV. The reference count for the original
2918 SV is B<not> incremented.
2920 SV* newRV_noinc(SV *sv)
2927 Creates a new SV. A non-zero C<len> parameter indicates the number of
2928 bytes of preallocated string space the SV should have. An extra byte for a
2929 tailing NUL is also reserved. (SvPOK is not set for the SV even if string
2930 space is allocated.) The reference count for the new SV is set to 1.
2931 C<id> is an integer id between 0 and 1299 (used to identify leaks).
2933 SV* NEWSV(int id, STRLEN len)
2936 Found in file handy.h
2940 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
2941 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
2944 SV* newSV(STRLEN len)
2951 Creates a new SV from the hash key structure. It will generate scalars that
2952 point to the shared string table where possible. Returns a new (undefined)
2953 SV if the hek is NULL.
2955 SV* newSVhek(const HEK *hek)
2962 Creates a new SV and copies an integer into it. The reference count for the
2972 Creates a new SV and copies a floating point value into it.
2973 The reference count for the SV is set to 1.
2982 Creates a new SV and copies a string into it. The reference count for the
2983 SV is set to 1. If C<len> is zero, Perl will compute the length using
2984 strlen(). For efficiency, consider using C<newSVpvn> instead.
2986 SV* newSVpv(const char* s, STRLEN len)
2993 Creates a new SV and initializes it with the string formatted like
2996 SV* newSVpvf(const char* pat, ...)
3003 Creates a new SV and copies a string into it. The reference count for the
3004 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
3005 string. You are responsible for ensuring that the source string is at least
3006 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
3008 SV* newSVpvn(const char* s, STRLEN len)
3013 =item newSVpvn_share
3015 Creates a new SV with its SvPVX_const pointing to a shared string in the string
3016 table. If the string does not already exist in the table, it is created
3017 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
3018 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
3019 otherwise the hash is computed. The idea here is that as the string table
3020 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
3021 hash lookup will avoid string compare.
3023 SV* newSVpvn_share(const char* s, I32 len, U32 hash)
3030 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
3031 it will be upgraded to one. If C<classname> is non-null then the new SV will
3032 be blessed in the specified package. The new SV is returned and its
3033 reference count is 1.
3035 SV* newSVrv(SV* rv, const char* classname)
3042 Creates a new SV which is an exact duplicate of the original SV.
3045 SV* newSVsv(SV* old)
3052 Creates a new SV and copies an unsigned integer into it.
3053 The reference count for the SV is set to 1.
3062 Returns the length of the string which is in the SV. See C<SvLEN>.
3064 STRLEN SvCUR(SV* sv)
3071 Set the current length of the string which is in the SV. See C<SvCUR>
3074 void SvCUR_set(SV* sv, STRLEN len)
3081 Returns a pointer to the last character in the string which is in the SV.
3082 See C<SvCUR>. Access the character as *(SvEND(sv)).
3091 Expands the character buffer in the SV so that it has room for the
3092 indicated number of bytes (remember to reserve space for an extra trailing
3093 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
3094 Returns a pointer to the character buffer.
3096 char * SvGROW(SV* sv, STRLEN len)
3103 Returns a boolean indicating whether the SV contains an integer.
3112 Returns a boolean indicating whether the SV contains an integer. Checks
3113 the B<private> setting. Use C<SvIOK>.
3122 Returns a boolean indicating whether the SV contains a signed integer.
3124 bool SvIOK_notUV(SV* sv)
3131 Unsets the IV status of an SV.
3133 void SvIOK_off(SV* sv)
3140 Tells an SV that it is an integer.
3142 void SvIOK_on(SV* sv)
3149 Tells an SV that it is an integer and disables all other OK bits.
3151 void SvIOK_only(SV* sv)
3158 Tells and SV that it is an unsigned integer and disables all other OK bits.
3160 void SvIOK_only_UV(SV* sv)
3167 Returns a boolean indicating whether the SV contains an unsigned integer.
3169 bool SvIOK_UV(SV* sv)
3176 Returns a boolean indicating whether the SV is Copy-On-Write. (either shared
3177 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
3180 bool SvIsCOW(SV* sv)
3185 =item SvIsCOW_shared_hash
3187 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
3190 bool SvIsCOW_shared_hash(SV* sv)
3197 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
3198 version which guarantees to evaluate sv only once.
3207 Returns the raw value in the SV's IV slot, without checks or conversions.
3208 Only use when you are sure SvIOK is true. See also C<SvIV()>.
3217 Coerces the given SV to an integer and returns it. Guarantees to evaluate
3218 sv only once. Use the more efficient C<SvIV> otherwise.
3227 Like C<SvIV> but doesn't process magic.
3229 IV SvIV_nomg(SV* sv)
3236 Set the value of the IV pointer in sv to val. It is possible to perform
3237 the same function of this macro with an lvalue assignment to C<SvIVX>.
3238 With future Perls, however, it will be more efficient to use
3239 C<SvIV_set> instead of the lvalue assignment to C<SvIVX>.
3241 void SvIV_set(SV* sv, IV val)
3248 Returns the size of the string buffer in the SV, not including any part
3249 attributable to C<SvOOK>. See C<SvCUR>.
3251 STRLEN SvLEN(SV* sv)
3258 Set the actual length of the string which is in the SV. See C<SvIV_set>.
3260 void SvLEN_set(SV* sv, STRLEN len)
3267 Set the value of the MAGIC pointer in sv to val. See C<SvIV_set>.
3269 void SvMAGIC_set(SV* sv, MAGIC* val)
3276 Returns a boolean indicating whether the SV contains a number, integer or
3286 Returns a boolean indicating whether the SV contains a number, integer or
3287 double. Checks the B<private> setting. Use C<SvNIOK>.
3289 bool SvNIOKp(SV* sv)
3296 Unsets the NV/IV status of an SV.
3298 void SvNIOK_off(SV* sv)
3305 Returns a boolean indicating whether the SV contains a double.
3314 Returns a boolean indicating whether the SV contains a double. Checks the
3315 B<private> setting. Use C<SvNOK>.
3324 Unsets the NV status of an SV.
3326 void SvNOK_off(SV* sv)
3333 Tells an SV that it is a double.
3335 void SvNOK_on(SV* sv)
3342 Tells an SV that it is a double and disables all other OK bits.
3344 void SvNOK_only(SV* sv)
3351 Coerce the given SV to a double and return it. See C<SvNVx> for a version
3352 which guarantees to evaluate sv only once.
3361 Returns the raw value in the SV's NV slot, without checks or conversions.
3362 Only use when you are sure SvNOK is true. See also C<SvNV()>.
3371 Coerces the given SV to a double and returns it. Guarantees to evaluate
3372 sv only once. Use the more efficient C<SvNV> otherwise.
3381 Set the value of the NV pointer in sv to val. See C<SvIV_set>.
3383 void SvNV_set(SV* sv, NV val)
3390 Returns a boolean indicating whether the value is an SV. It also tells
3391 whether the value is defined or not.
3400 Returns a boolean indicating whether the SvIVX is a valid offset value for
3401 the SvPVX. This hack is used internally to speed up removal of characters
3402 from the beginning of a SvPV. When SvOOK is true, then the start of the
3403 allocated string buffer is really (SvPVX - SvIVX).
3412 Returns a boolean indicating whether the SV contains a character
3422 Returns a boolean indicating whether the SV contains a character string.
3423 Checks the B<private> setting. Use C<SvPOK>.
3432 Unsets the PV status of an SV.
3434 void SvPOK_off(SV* sv)
3441 Tells an SV that it is a string.
3443 void SvPOK_on(SV* sv)
3450 Tells an SV that it is a string and disables all other OK bits.
3451 Will also turn off the UTF-8 status.
3453 void SvPOK_only(SV* sv)
3458 =item SvPOK_only_UTF8
3460 Tells an SV that it is a string and disables all other OK bits,
3461 and leaves the UTF-8 status as it was.
3463 void SvPOK_only_UTF8(SV* sv)
3470 Returns a pointer to the string in the SV, or a stringified form of
3471 the SV if the SV does not contain a string. The SV may cache the
3472 stringified version becoming C<SvPOK>. Handles 'get' magic. See also
3473 C<SvPVx> for a version which guarantees to evaluate sv only once.
3475 char* SvPV(SV* sv, STRLEN len)
3482 Like C<SvPV>, but converts sv to byte representation first if necessary.
3484 char* SvPVbyte(SV* sv, STRLEN len)
3491 Like C<SvPV>, but converts sv to byte representation first if necessary.
3492 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
3495 char* SvPVbytex(SV* sv, STRLEN len)
3500 =item SvPVbytex_force
3502 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
3503 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
3506 char* SvPVbytex_force(SV* sv, STRLEN len)
3511 =item SvPVbyte_force
3513 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
3515 char* SvPVbyte_force(SV* sv, STRLEN len)
3520 =item SvPVbyte_nolen
3522 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
3524 char* SvPVbyte_nolen(SV* sv)
3531 Like C<SvPV>, but converts sv to utf8 first if necessary.
3533 char* SvPVutf8(SV* sv, STRLEN len)
3540 Like C<SvPV>, but converts sv to utf8 first if necessary.
3541 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
3544 char* SvPVutf8x(SV* sv, STRLEN len)
3549 =item SvPVutf8x_force
3551 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
3552 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
3555 char* SvPVutf8x_force(SV* sv, STRLEN len)
3560 =item SvPVutf8_force
3562 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
3564 char* SvPVutf8_force(SV* sv, STRLEN len)
3569 =item SvPVutf8_nolen
3571 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
3573 char* SvPVutf8_nolen(SV* sv)
3580 Returns a pointer to the physical string in the SV. The SV must contain a
3590 A version of C<SvPV> which guarantees to evaluate sv only once.
3592 char* SvPVx(SV* sv, STRLEN len)
3599 Like C<SvPV> but will force the SV into containing just a string
3600 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
3603 char* SvPV_force(SV* sv, STRLEN len)
3608 =item SvPV_force_nomg
3610 Like C<SvPV> but will force the SV into containing just a string
3611 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
3612 directly. Doesn't process magic.
3614 char* SvPV_force_nomg(SV* sv, STRLEN len)
3621 Returns a pointer to the string in the SV, or a stringified form of
3622 the SV if the SV does not contain a string. The SV may cache the
3623 stringified form becoming C<SvPOK>. Handles 'get' magic.
3625 char* SvPV_nolen(SV* sv)
3632 Like C<SvPV> but doesn't process magic.
3634 char* SvPV_nomg(SV* sv, STRLEN len)
3641 Set the value of the PV pointer in sv to val. See C<SvIV_set>.
3643 void SvPV_set(SV* sv, char* val)
3650 Returns the value of the object's reference count.
3652 U32 SvREFCNT(SV* sv)
3659 Decrements the reference count of the given SV.
3661 void SvREFCNT_dec(SV* sv)
3668 Increments the reference count of the given SV.
3670 SV* SvREFCNT_inc(SV* sv)
3677 Tests if the SV is an RV.
3686 Unsets the RV status of an SV.
3688 void SvROK_off(SV* sv)
3695 Tells an SV that it is an RV.
3697 void SvROK_on(SV* sv)
3704 Dereferences an RV to return the SV.
3713 Set the value of the RV pointer in sv to val. See C<SvIV_set>.
3715 void SvRV_set(SV* sv, SV* val)
3722 Returns the stash of the SV.
3731 Set the value of the STASH pointer in sv to val. See C<SvIV_set>.
3733 void SvSTASH_set(SV* sv, STASH* val)
3740 Taints an SV if tainting is enabled.
3742 void SvTAINT(SV* sv)
3749 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
3752 bool SvTAINTED(SV* sv)
3759 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
3760 some of Perl's fundamental security features. XS module authors should not
3761 use this function unless they fully understand all the implications of
3762 unconditionally untainting the value. Untainting should be done in the
3763 standard perl fashion, via a carefully crafted regexp, rather than directly
3764 untainting variables.
3766 void SvTAINTED_off(SV* sv)
3773 Marks an SV as tainted if tainting is enabled.
3775 void SvTAINTED_on(SV* sv)
3782 Returns a boolean indicating whether Perl would evaluate the SV as true or
3783 false, defined or undefined. Does not handle 'get' magic.
3792 Returns the type of the SV. See C<svtype>.
3794 svtype SvTYPE(SV* sv)
3801 Returns a boolean indicating whether the SV contains an unsigned integer.
3810 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
3811 perform the upgrade if necessary. See C<svtype>.
3813 void SvUPGRADE(SV* sv, svtype type)
3820 Returns a boolean indicating whether the SV contains UTF-8 encoded data.
3829 Unsets the UTF-8 status of an SV.
3831 void SvUTF8_off(SV *sv)
3838 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
3839 Do not use frivolously.
3841 void SvUTF8_on(SV *sv)
3848 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
3849 for a version which guarantees to evaluate sv only once.
3858 Returns the raw value in the SV's UV slot, without checks or conversions.
3859 Only use when you are sure SvIOK is true. See also C<SvUV()>.
3868 Coerces the given SV to an unsigned integer and returns it. Guarantees to
3869 evaluate sv only once. Use the more efficient C<SvUV> otherwise.
3878 Like C<SvUV> but doesn't process magic.
3880 UV SvUV_nomg(SV* sv)
3887 Set the value of the UV pointer in sv to val. See C<SvIV_set>.
3889 void SvUV_set(SV* sv, UV val)
3896 Returns a boolean indicating whether the SV contains a v-string.
3905 This function is only called on magical items, and is only used by
3906 sv_true() or its macro equivalent.
3908 bool sv_2bool(SV* sv)
3915 Using various gambits, try to get a CV from an SV; in addition, try if
3916 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
3918 CV* sv_2cv(SV* sv, HV** st, GV** gvp, I32 lref)
3925 Using various gambits, try to get an IO from an SV: the IO slot if its a
3926 GV; or the recursive result if we're an RV; or the IO slot of the symbol
3927 named after the PV if we're a string.
3936 Return the integer value of an SV, doing any necessary string
3937 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
3938 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
3940 IV sv_2iv_flags(SV* sv, I32 flags)
3947 Marks an existing SV as mortal. The SV will be destroyed "soon", either
3948 by an explicit call to FREETMPS, or by an implicit call at places such as
3949 statement boundaries. SvTEMP() is turned on which means that the SV's
3950 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
3951 and C<sv_mortalcopy>.
3953 SV* sv_2mortal(SV* sv)
3960 Return the num value of an SV, doing any necessary string or integer
3961 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
3971 Return a pointer to the byte-encoded representation of the SV, and set *lp
3972 to its length. May cause the SV to be downgraded from UTF-8 as a
3975 Usually accessed via the C<SvPVbyte> macro.
3977 char* sv_2pvbyte(SV* sv, STRLEN* lp)
3982 =item sv_2pvbyte_nolen
3984 Return a pointer to the byte-encoded representation of the SV.
3985 May cause the SV to be downgraded from UTF-8 as a side-effect.
3987 Usually accessed via the C<SvPVbyte_nolen> macro.
3989 char* sv_2pvbyte_nolen(SV* sv)
3996 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3997 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
3999 Usually accessed via the C<SvPVutf8> macro.
4001 char* sv_2pvutf8(SV* sv, STRLEN* lp)
4006 =item sv_2pvutf8_nolen
4008 Return a pointer to the UTF-8-encoded representation of the SV.
4009 May cause the SV to be upgraded to UTF-8 as a side-effect.
4011 Usually accessed via the C<SvPVutf8_nolen> macro.
4013 char* sv_2pvutf8_nolen(SV* sv)
4020 Returns a pointer to the string value of an SV, and sets *lp to its length.
4021 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
4023 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
4024 usually end up here too.
4026 char* sv_2pv_flags(SV* sv, STRLEN* lp, I32 flags)
4033 Like C<sv_2pv()>, but doesn't return the length too. You should usually
4034 use the macro wrapper C<SvPV_nolen(sv)> instead.
4035 char* sv_2pv_nolen(SV* sv)
4042 Return the unsigned integer value of an SV, doing any necessary string
4043 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
4044 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
4046 UV sv_2uv_flags(SV* sv, I32 flags)
4053 Remove any string offset. You should normally use the C<SvOOK_off> macro
4056 int sv_backoff(SV* sv)
4063 Blesses an SV into a specified package. The SV must be an RV. The package
4064 must be designated by its stash (see C<gv_stashpv()>). The reference count
4065 of the SV is unaffected.
4067 SV* sv_bless(SV* sv, HV* stash)
4074 Concatenates the string onto the end of the string which is in the SV.
4075 If the SV has the UTF-8 status set, then the bytes appended should be
4076 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4078 void sv_catpv(SV* sv, const char* ptr)
4085 Processes its arguments like C<sprintf> and appends the formatted
4086 output to an SV. If the appended data contains "wide" characters
4087 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
4088 and characters >255 formatted with %c), the original SV might get
4089 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
4090 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
4091 valid UTF-8; if the original SV was bytes, the pattern should be too.
4093 void sv_catpvf(SV* sv, const char* pat, ...)
4100 Like C<sv_catpvf>, but also handles 'set' magic.
4102 void sv_catpvf_mg(SV *sv, const char* pat, ...)
4109 Concatenates the string onto the end of the string which is in the SV. The
4110 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4111 status set, then the bytes appended should be valid UTF-8.
4112 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4114 void sv_catpvn(SV* sv, const char* ptr, STRLEN len)
4119 =item sv_catpvn_flags
4121 Concatenates the string onto the end of the string which is in the SV. The
4122 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4123 status set, then the bytes appended should be valid UTF-8.
4124 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4125 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4126 in terms of this function.
4128 void sv_catpvn_flags(SV* sv, const char* ptr, STRLEN len, I32 flags)
4135 Like C<sv_catpvn>, but also handles 'set' magic.
4137 void sv_catpvn_mg(SV *sv, const char *ptr, STRLEN len)
4142 =item sv_catpvn_nomg
4144 Like C<sv_catpvn> but doesn't process magic.
4146 void sv_catpvn_nomg(SV* sv, const char* ptr, STRLEN len)
4153 Like C<sv_catpv>, but also handles 'set' magic.
4155 void sv_catpv_mg(SV *sv, const char *ptr)
4162 Concatenates the string from SV C<ssv> onto the end of the string in
4163 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4164 not 'set' magic. See C<sv_catsv_mg>.
4166 void sv_catsv(SV* dsv, SV* ssv)
4171 =item sv_catsv_flags
4173 Concatenates the string from SV C<ssv> onto the end of the string in
4174 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4175 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4176 and C<sv_catsv_nomg> are implemented in terms of this function.
4178 void sv_catsv_flags(SV* dsv, SV* ssv, I32 flags)
4185 Like C<sv_catsv>, but also handles 'set' magic.
4187 void sv_catsv_mg(SV *dstr, SV *sstr)
4194 Like C<sv_catsv> but doesn't process magic.
4196 void sv_catsv_nomg(SV* dsv, SV* ssv)
4203 Efficient removal of characters from the beginning of the string buffer.
4204 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4205 the string buffer. The C<ptr> becomes the first character of the adjusted
4206 string. Uses the "OOK hack".
4207 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4208 refer to the same chunk of data.
4210 void sv_chop(SV* sv, const char* ptr)
4217 Clear an SV: call any destructors, free up any memory used by the body,
4218 and free the body itself. The SV's head is I<not> freed, although
4219 its type is set to all 1's so that it won't inadvertently be assumed
4220 to be live during global destruction etc.
4221 This function should only be called when REFCNT is zero. Most of the time
4222 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
4225 void sv_clear(SV* sv)
4232 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
4233 string in C<sv1> is less than, equal to, or greater than the string in
4234 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
4235 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
4237 I32 sv_cmp(SV* sv1, SV* sv2)
4244 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
4245 'use bytes' aware, handles get magic, and will coerce its args to strings
4246 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
4248 I32 sv_cmp_locale(SV* sv1, SV* sv2)
4255 Add Collate Transform magic to an SV if it doesn't already have it.
4257 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
4258 scalar data of the variable, but transformed to such a format that a normal
4259 memory comparison can be used to compare the data according to the locale
4262 char* sv_collxfrm(SV* sv, STRLEN* nxp)
4269 Copies a stringified representation of the source SV into the
4270 destination SV. Automatically performs any necessary mg_get and
4271 coercion of numeric values into strings. Guaranteed to preserve
4272 UTF-8 flag even from overloaded objects. Similar in nature to
4273 sv_2pv[_flags] but operates directly on an SV instead of just the
4274 string. Mostly uses sv_2pv_flags to do its work, except when that
4275 would lose the UTF-8'ness of the PV.
4277 void sv_copypv(SV* dsv, SV* ssv)
4284 Auto-decrement of the value in the SV, doing string to numeric conversion
4285 if necessary. Handles 'get' magic.
4292 =item sv_derived_from
4294 Returns a boolean indicating whether the SV is derived from the specified
4295 class. This is the function that implements C<UNIVERSAL::isa>. It works
4296 for class names as well as for objects.
4298 bool sv_derived_from(SV* sv, const char* name)
4301 Found in file universal.c
4305 Returns a boolean indicating whether the strings in the two SVs are
4306 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
4307 coerce its args to strings if necessary.
4309 I32 sv_eq(SV* sv1, SV* sv2)
4314 =item sv_force_normal
4316 Undo various types of fakery on an SV: if the PV is a shared string, make
4317 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4318 an xpvmg. See also C<sv_force_normal_flags>.
4320 void sv_force_normal(SV *sv)
4325 =item sv_force_normal_flags
4327 Undo various types of fakery on an SV: if the PV is a shared string, make
4328 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4329 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4330 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4331 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4332 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4333 set to some other value.) In addition, the C<flags> parameter gets passed to
4334 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4335 with flags set to 0.
4337 void sv_force_normal_flags(SV *sv, U32 flags)
4344 Decrement an SV's reference count, and if it drops to zero, call
4345 C<sv_clear> to invoke destructors and free up any memory used by
4346 the body; finally, deallocate the SV's head itself.
4347 Normally called via a wrapper macro C<SvREFCNT_dec>.
4349 void sv_free(SV* sv)
4356 Get a line from the filehandle and store it into the SV, optionally
4357 appending to the currently-stored string.
4359 char* sv_gets(SV* sv, PerlIO* fp, I32 append)
4366 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
4367 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
4368 Use the C<SvGROW> wrapper instead.
4370 char* sv_grow(SV* sv, STRLEN newlen)
4377 Auto-increment of the value in the SV, doing string to numeric conversion
4378 if necessary. Handles 'get' magic.
4387 Inserts a string at the specified offset/length within the SV. Similar to
4388 the Perl substr() function.
4390 void sv_insert(SV* bigsv, STRLEN offset, STRLEN len, const char* little, STRLEN littlelen)
4397 Returns a boolean indicating whether the SV is blessed into the specified
4398 class. This does not check for subtypes; use C<sv_derived_from> to verify
4399 an inheritance relationship.
4401 int sv_isa(SV* sv, const char* name)
4408 Returns a boolean indicating whether the SV is an RV pointing to a blessed
4409 object. If the SV is not an RV, or if the object is not blessed, then this
4412 int sv_isobject(SV* sv)
4419 A private implementation of the C<SvIVx> macro for compilers which can't
4420 cope with complex macro expressions. Always use the macro instead.
4429 Returns the length of the string in the SV. Handles magic and type
4430 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
4432 STRLEN sv_len(SV* sv)
4439 Returns the number of characters in the string in an SV, counting wide
4440 UTF-8 bytes as a single character. Handles magic and type coercion.
4442 STRLEN sv_len_utf8(SV* sv)
4449 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4450 then adds a new magic item of type C<how> to the head of the magic list.
4452 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4453 handling of the C<name> and C<namlen> arguments.
4455 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4456 to add more than one instance of the same 'how'.
4458 void sv_magic(SV* sv, SV* obj, int how, const char* name, I32 namlen)
4465 Adds magic to an SV, upgrading it if necessary. Applies the
4466 supplied vtable and returns a pointer to the magic added.
4468 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4469 In particular, you can add magic to SvREADONLY SVs, and add more than
4470 one instance of the same 'how'.
4472 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4473 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4474 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4475 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4477 (This is now used as a subroutine by C<sv_magic>.)
4479 MAGIC * sv_magicext(SV* sv, SV* obj, int how, const MGVTBL *vtbl, const char* name, I32 namlen)
4486 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
4487 The new SV is marked as mortal. It will be destroyed "soon", either by an
4488 explicit call to FREETMPS, or by an implicit call at places such as
4489 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
4491 SV* sv_mortalcopy(SV* oldsv)
4498 Creates a new null SV which is mortal. The reference count of the SV is
4499 set to 1. It will be destroyed "soon", either by an explicit call to
4500 FREETMPS, or by an implicit call at places such as statement boundaries.
4501 See also C<sv_mortalcopy> and C<sv_2mortal>.
4510 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
4513 SV* sv_newref(SV* sv)
4520 A private implementation of the C<SvNVx> macro for compilers which can't
4521 cope with complex macro expressions. Always use the macro instead.
4530 Converts the value pointed to by offsetp from a count of bytes from the
4531 start of the string, to a count of the equivalent number of UTF-8 chars.
4532 Handles magic and type coercion.
4534 void sv_pos_b2u(SV* sv, I32* offsetp)
4541 Converts the value pointed to by offsetp from a count of UTF-8 chars from
4542 the start of the string, to a count of the equivalent number of bytes; if
4543 lenp is non-zero, it does the same to lenp, but this time starting from
4544 the offset, rather than from the start of the string. Handles magic and
4547 void sv_pos_u2b(SV* sv, I32* offsetp, I32* lenp)
4554 Use the C<SvPV_nolen> macro instead
4563 Use C<SvPVbyte_nolen> instead.
4565 char* sv_pvbyte(SV *sv)
4572 A private implementation of the C<SvPVbyte> macro for compilers
4573 which can't cope with complex macro expressions. Always use the macro
4576 char* sv_pvbyten(SV *sv, STRLEN *len)
4581 =item sv_pvbyten_force
4583 A private implementation of the C<SvPVbytex_force> macro for compilers
4584 which can't cope with complex macro expressions. Always use the macro
4587 char* sv_pvbyten_force(SV* sv, STRLEN* lp)
4594 A private implementation of the C<SvPV> macro for compilers which can't
4595 cope with complex macro expressions. Always use the macro instead.
4597 char* sv_pvn(SV *sv, STRLEN *len)
4604 Get a sensible string out of the SV somehow.
4605 A private implementation of the C<SvPV_force> macro for compilers which
4606 can't cope with complex macro expressions. Always use the macro instead.
4608 char* sv_pvn_force(SV* sv, STRLEN* lp)
4613 =item sv_pvn_force_flags
4615 Get a sensible string out of the SV somehow.
4616 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
4617 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
4618 implemented in terms of this function.
4619 You normally want to use the various wrapper macros instead: see
4620 C<SvPV_force> and C<SvPV_force_nomg>
4622 char* sv_pvn_force_flags(SV* sv, STRLEN* lp, I32 flags)
4629 Use the C<SvPVutf8_nolen> macro instead
4631 char* sv_pvutf8(SV *sv)
4638 A private implementation of the C<SvPVutf8> macro for compilers
4639 which can't cope with complex macro expressions. Always use the macro
4642 char* sv_pvutf8n(SV *sv, STRLEN *len)
4647 =item sv_pvutf8n_force
4649 A private implementation of the C<SvPVutf8_force> macro for compilers
4650 which can't cope with complex macro expressions. Always use the macro
4653 char* sv_pvutf8n_force(SV* sv, STRLEN* lp)
4660 Returns a string describing what the SV is a reference to.
4662 char* sv_reftype(const SV* sv, int ob)
4669 Make the first argument a copy of the second, then delete the original.
4670 The target SV physically takes over ownership of the body of the source SV
4671 and inherits its flags; however, the target keeps any magic it owns,
4672 and any magic in the source is discarded.
4673 Note that this is a rather specialist SV copying operation; most of the
4674 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4676 void sv_replace(SV* sv, SV* nsv)
4681 =item sv_report_used
4683 Dump the contents of all SVs not yet freed. (Debugging aid).
4685 void sv_report_used()
4692 Underlying implementation for the C<reset> Perl function.
4693 Note that the perl-level function is vaguely deprecated.
4695 void sv_reset(const char* s, HV* stash)
4702 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4703 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4704 push a back-reference to this RV onto the array of backreferences
4705 associated with that magic.
4707 SV* sv_rvweaken(SV *sv)
4714 Copies an integer into the given SV, upgrading first if necessary.
4715 Does not handle 'set' magic. See also C<sv_setiv_mg>.
4717 void sv_setiv(SV* sv, IV num)
4724 Like C<sv_setiv>, but also handles 'set' magic.
4726 void sv_setiv_mg(SV *sv, IV i)
4733 Copies a double into the given SV, upgrading first if necessary.
4734 Does not handle 'set' magic. See also C<sv_setnv_mg>.
4736 void sv_setnv(SV* sv, NV num)
4743 Like C<sv_setnv>, but also handles 'set' magic.
4745 void sv_setnv_mg(SV *sv, NV num)
4752 Copies a string into an SV. The string must be null-terminated. Does not
4753 handle 'set' magic. See C<sv_setpv_mg>.
4755 void sv_setpv(SV* sv, const char* ptr)
4762 Works like C<sv_catpvf> but copies the text into the SV instead of
4763 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
4765 void sv_setpvf(SV* sv, const char* pat, ...)
4772 Like C<sv_setpvf>, but also handles 'set' magic.
4774 void sv_setpvf_mg(SV *sv, const char* pat, ...)
4781 Copies an integer into the given SV, also updating its string value.
4782 Does not handle 'set' magic. See C<sv_setpviv_mg>.
4784 void sv_setpviv(SV* sv, IV num)
4791 Like C<sv_setpviv>, but also handles 'set' magic.
4793 void sv_setpviv_mg(SV *sv, IV iv)
4800 Copies a string into an SV. The C<len> parameter indicates the number of
4801 bytes to be copied. If the C<ptr> argument is NULL the SV will become
4802 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4804 void sv_setpvn(SV* sv, const char* ptr, STRLEN len)
4811 Like C<sv_setpvn>, but also handles 'set' magic.
4813 void sv_setpvn_mg(SV *sv, const char *ptr, STRLEN len)
4820 Like C<sv_setpv>, but also handles 'set' magic.
4822 void sv_setpv_mg(SV *sv, const char *ptr)
4829 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
4830 argument will be upgraded to an RV. That RV will be modified to point to
4831 the new SV. The C<classname> argument indicates the package for the
4832 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4833 will have a reference count of 1, and the RV will be returned.
4835 SV* sv_setref_iv(SV* rv, const char* classname, IV iv)
4842 Copies a double into a new SV, optionally blessing the SV. The C<rv>
4843 argument will be upgraded to an RV. That RV will be modified to point to
4844 the new SV. The C<classname> argument indicates the package for the
4845 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4846 will have a reference count of 1, and the RV will be returned.
4848 SV* sv_setref_nv(SV* rv, const char* classname, NV nv)
4855 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
4856 argument will be upgraded to an RV. That RV will be modified to point to
4857 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
4858 into the SV. The C<classname> argument indicates the package for the
4859 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4860 will have a reference count of 1, and the RV will be returned.
4862 Do not use with other Perl types such as HV, AV, SV, CV, because those
4863 objects will become corrupted by the pointer copy process.
4865 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
4867 SV* sv_setref_pv(SV* rv, const char* classname, void* pv)
4874 Copies a string into a new SV, optionally blessing the SV. The length of the
4875 string must be specified with C<n>. The C<rv> argument will be upgraded to
4876 an RV. That RV will be modified to point to the new SV. The C<classname>
4877 argument indicates the package for the blessing. Set C<classname> to
4878 C<Nullch> to avoid the blessing. The new SV will have a reference count
4879 of 1, and the RV will be returned.
4881 Note that C<sv_setref_pv> copies the pointer while this copies the string.
4883 SV* sv_setref_pvn(SV* rv, const char* classname, const char* pv, STRLEN n)
4890 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
4891 argument will be upgraded to an RV. That RV will be modified to point to
4892 the new SV. The C<classname> argument indicates the package for the
4893 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4894 will have a reference count of 1, and the RV will be returned.
4896 SV* sv_setref_uv(SV* rv, const char* classname, UV uv)
4903 Copies the contents of the source SV C<ssv> into the destination SV
4904 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4905 function if the source SV needs to be reused. Does not handle 'set' magic.
4906 Loosely speaking, it performs a copy-by-value, obliterating any previous
4907 content of the destination.
4909 You probably want to use one of the assortment of wrappers, such as
4910 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4911 C<SvSetMagicSV_nosteal>.
4913 void sv_setsv(SV* dsv, SV* ssv)
4918 =item sv_setsv_flags
4920 Copies the contents of the source SV C<ssv> into the destination SV
4921 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4922 function if the source SV needs to be reused. Does not handle 'set' magic.
4923 Loosely speaking, it performs a copy-by-value, obliterating any previous
4924 content of the destination.
4925 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
4926 C<ssv> if appropriate, else not. If the C<flags> parameter has the
4927 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
4928 and C<sv_setsv_nomg> are implemented in terms of this function.
4930 You probably want to use one of the assortment of wrappers, such as
4931 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4932 C<SvSetMagicSV_nosteal>.
4934 This is the primary function for copying scalars, and most other
4935 copy-ish functions and macros use this underneath.
4937 void sv_setsv_flags(SV* dsv, SV* ssv, I32 flags)
4944 Like C<sv_setsv>, but also handles 'set' magic.
4946 void sv_setsv_mg(SV *dstr, SV *sstr)
4953 Like C<sv_setsv> but doesn't process magic.
4955 void sv_setsv_nomg(SV* dsv, SV* ssv)
4962 Copies an unsigned integer into the given SV, upgrading first if necessary.
4963 Does not handle 'set' magic. See also C<sv_setuv_mg>.
4965 void sv_setuv(SV* sv, UV num)
4972 Like C<sv_setuv>, but also handles 'set' magic.
4974 void sv_setuv_mg(SV *sv, UV u)
4981 Taint an SV. Use C<SvTAINTED_on> instead.
4982 void sv_taint(SV* sv)
4989 Test an SV for taintedness. Use C<SvTAINTED> instead.
4990 bool sv_tainted(SV* sv)
4997 Returns true if the SV has a true value by Perl's rules.
4998 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
4999 instead use an in-line version.
5008 Removes all magic of type C<type> from an SV.
5010 int sv_unmagic(SV* sv, int type)
5017 Unsets the RV status of the SV, and decrements the reference count of
5018 whatever was being referenced by the RV. This can almost be thought of
5019 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
5020 being zero. See C<SvROK_off>.
5022 void sv_unref(SV* sv)
5027 =item sv_unref_flags
5029 Unsets the RV status of the SV, and decrements the reference count of
5030 whatever was being referenced by the RV. This can almost be thought of
5031 as a reversal of C<newSVrv>. The C<cflags> argument can contain
5032 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
5033 (otherwise the decrementing is conditional on the reference count being
5034 different from one or the reference being a readonly SV).
5037 void sv_unref_flags(SV* sv, U32 flags)
5044 Untaint an SV. Use C<SvTAINTED_off> instead.
5045 void sv_untaint(SV* sv)
5052 Upgrade an SV to a more complex form. Generally adds a new body type to the
5053 SV, then copies across as much information as possible from the old body.
5054 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
5056 void sv_upgrade(SV* sv, U32 mt)
5063 Tells an SV to use C<ptr> to find its string value. Normally the string is
5064 stored inside the SV but sv_usepvn allows the SV to use an outside string.
5065 The C<ptr> should point to memory that was allocated by C<malloc>. The
5066 string length, C<len>, must be supplied. This function will realloc the
5067 memory pointed to by C<ptr>, so that pointer should not be freed or used by
5068 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
5069 See C<sv_usepvn_mg>.
5071 void sv_usepvn(SV* sv, char* ptr, STRLEN len)
5078 Like C<sv_usepvn>, but also handles 'set' magic.
5080 void sv_usepvn_mg(SV *sv, char *ptr, STRLEN len)
5085 =item sv_utf8_decode
5087 If the PV of the SV is an octet sequence in UTF-8
5088 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
5089 so that it looks like a character. If the PV contains only single-byte
5090 characters, the C<SvUTF8> flag stays being off.
5091 Scans PV for validity and returns false if the PV is invalid UTF-8.
5093 NOTE: this function is experimental and may change or be
5094 removed without notice.
5096 bool sv_utf8_decode(SV *sv)
5101 =item sv_utf8_downgrade
5103 Attempts to convert the PV of an SV from characters to bytes.
5104 If the PV contains a character beyond byte, this conversion will fail;
5105 in this case, either returns false or, if C<fail_ok> is not
5108 This is not as a general purpose Unicode to byte encoding interface:
5109 use the Encode extension for that.
5111 NOTE: this function is experimental and may change or be
5112 removed without notice.
5114 bool sv_utf8_downgrade(SV *sv, bool fail_ok)
5119 =item sv_utf8_encode
5121 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
5122 flag off so that it looks like octets again.
5124 void sv_utf8_encode(SV *sv)
5129 =item sv_utf8_upgrade
5131 Converts the PV of an SV to its UTF-8-encoded form.
5132 Forces the SV to string form if it is not already.
5133 Always sets the SvUTF8 flag to avoid future validity checks even
5134 if all the bytes have hibit clear.
5136 This is not as a general purpose byte encoding to Unicode interface:
5137 use the Encode extension for that.
5139 STRLEN sv_utf8_upgrade(SV *sv)
5144 =item sv_utf8_upgrade_flags
5146 Converts the PV of an SV to its UTF-8-encoded form.
5147 Forces the SV to string form if it is not already.
5148 Always sets the SvUTF8 flag to avoid future validity checks even
5149 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
5150 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
5151 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
5153 This is not as a general purpose byte encoding to Unicode interface:
5154 use the Encode extension for that.
5156 STRLEN sv_utf8_upgrade_flags(SV *sv, I32 flags)
5163 A private implementation of the C<SvUVx> macro for compilers which can't
5164 cope with complex macro expressions. Always use the macro instead.
5173 Processes its arguments like C<vsprintf> and appends the formatted output
5174 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
5176 Usually used via its frontend C<sv_catpvf>.
5178 void sv_vcatpvf(SV* sv, const char* pat, va_list* args)
5185 Processes its arguments like C<vsprintf> and appends the formatted output
5186 to an SV. Uses an array of SVs if the C style variable argument list is
5187 missing (NULL). When running with taint checks enabled, indicates via
5188 C<maybe_tainted> if results are untrustworthy (often due to the use of
5191 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
5193 void sv_vcatpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
5200 Like C<sv_vcatpvf>, but also handles 'set' magic.
5202 Usually used via its frontend C<sv_catpvf_mg>.
5204 void sv_vcatpvf_mg(SV* sv, const char* pat, va_list* args)
5211 Works like C<sv_vcatpvf> but copies the text into the SV instead of
5212 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
5214 Usually used via its frontend C<sv_setpvf>.
5216 void sv_vsetpvf(SV* sv, const char* pat, va_list* args)
5223 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
5226 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
5228 void sv_vsetpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
5235 Like C<sv_vsetpvf>, but also handles 'set' magic.
5237 Usually used via its frontend C<sv_setpvf_mg>.
5239 void sv_vsetpvf_mg(SV* sv, const char* pat, va_list* args)
5247 =head1 Unicode Support
5251 =item bytes_from_utf8
5253 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
5254 Unlike C<utf8_to_bytes> but like C<bytes_to_utf8>, returns a pointer to
5255 the newly-created string, and updates C<len> to contain the new
5256 length. Returns the original string if no conversion occurs, C<len>
5257 is unchanged. Do nothing if C<is_utf8> points to 0. Sets C<is_utf8> to
5258 0 if C<s> is converted or contains all 7bit characters.
5260 NOTE: this function is experimental and may change or be
5261 removed without notice.
5263 U8* bytes_from_utf8(const U8 *s, STRLEN *len, bool *is_utf8)
5266 Found in file utf8.c
5270 Converts a string C<s> of length C<len> from ASCII into UTF-8 encoding.
5271 Returns a pointer to the newly-created string, and sets C<len> to
5272 reflect the new length.
5274 If you want to convert to UTF-8 from other encodings than ASCII,
5275 see sv_recode_to_utf8().
5277 NOTE: this function is experimental and may change or be
5278 removed without notice.
5280 U8* bytes_to_utf8(const U8 *s, STRLEN *len)
5283 Found in file utf8.c
5287 Return true if the strings s1 and s2 differ case-insensitively, false
5288 if not (if they are equal case-insensitively). If u1 is true, the
5289 string s1 is assumed to be in UTF-8-encoded Unicode. If u2 is true,
5290 the string s2 is assumed to be in UTF-8-encoded Unicode. If u1 or u2
5291 are false, the respective string is assumed to be in native 8-bit
5294 If the pe1 and pe2 are non-NULL, the scanning pointers will be copied
5295 in there (they will point at the beginning of the I<next> character).
5296 If the pointers behind pe1 or pe2 are non-NULL, they are the end
5297 pointers beyond which scanning will not continue under any
5298 circumstances. If the byte lengths l1 and l2 are non-zero, s1+l1 and
5299 s2+l2 will be used as goal end pointers that will also stop the scan,
5300 and which qualify towards defining a successful match: all the scans
5301 that define an explicit length must reach their goal pointers for
5302 a match to succeed).
5304 For case-insensitiveness, the "casefolding" of Unicode is used
5305 instead of upper/lowercasing both the characters, see
5306 http://www.unicode.org/unicode/reports/tr21/ (Case Mappings).
5308 I32 ibcmp_utf8(const char* a, char **pe1, UV l1, bool u1, const char* b, char **pe2, UV l2, bool u2)
5311 Found in file utf8.c
5315 Tests if some arbitrary number of bytes begins in a valid UTF-8
5316 character. Note that an INVARIANT (i.e. ASCII) character is a valid
5317 UTF-8 character. The actual number of bytes in the UTF-8 character
5318 will be returned if it is valid, otherwise 0.
5320 STRLEN is_utf8_char(const U8 *p)
5323 Found in file utf8.c
5325 =item is_utf8_string
5327 Returns true if first C<len> bytes of the given string form a valid
5328 UTF-8 string, false otherwise. Note that 'a valid UTF-8 string' does
5329 not mean 'a string that contains code points above 0x7F encoded in UTF-8'
5330 because a valid ASCII string is a valid UTF-8 string.
5332 See also is_utf8_string_loclen() and is_utf8_string_loc().
5334 bool is_utf8_string(const U8 *s, STRLEN len)
5337 Found in file utf8.c
5339 =item is_utf8_string_loc
5341 Like is_ut8_string() but stores the location of the failure (in the
5342 case of "utf8ness failure") or the location s+len (in the case of
5343 "utf8ness success") in the C<ep>.
5345 See also is_utf8_string_loclen() and is_utf8_string().
5347 bool is_utf8_string_loc(const U8 *s, STRLEN len, const U8 **p)
5350 Found in file utf8.c
5352 =item is_utf8_string_loclen
5354 Like is_ut8_string() but stores the location of the failure (in the
5355 case of "utf8ness failure") or the location s+len (in the case of
5356 "utf8ness success") in the C<ep>, and the number of UTF-8
5357 encoded characters in the C<el>.
5359 See also is_utf8_string_loc() and is_utf8_string().
5361 bool is_utf8_string_loclen(const U8 *s, STRLEN len, const U8 **ep, STRLEN *el)
5364 Found in file utf8.c
5366 =item pv_uni_display
5368 Build to the scalar dsv a displayable version of the string spv,
5369 length len, the displayable version being at most pvlim bytes long
5370 (if longer, the rest is truncated and "..." will be appended).
5372 The flags argument can have UNI_DISPLAY_ISPRINT set to display
5373 isPRINT()able characters as themselves, UNI_DISPLAY_BACKSLASH
5374 to display the \\[nrfta\\] as the backslashed versions (like '\n')
5375 (UNI_DISPLAY_BACKSLASH is preferred over UNI_DISPLAY_ISPRINT for \\).
5376 UNI_DISPLAY_QQ (and its alias UNI_DISPLAY_REGEX) have both
5377 UNI_DISPLAY_BACKSLASH and UNI_DISPLAY_ISPRINT turned on.
5379 The pointer to the PV of the dsv is returned.
5381 char* pv_uni_display(SV *dsv, const U8 *spv, STRLEN len, STRLEN pvlim, UV flags)
5384 Found in file utf8.c
5388 The encoding is assumed to be an Encode object, the PV of the ssv is
5389 assumed to be octets in that encoding and decoding the input starts
5390 from the position which (PV + *offset) pointed to. The dsv will be
5391 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
5392 when the string tstr appears in decoding output or the input ends on
5393 the PV of the ssv. The value which the offset points will be modified
5394 to the last input position on the ssv.
5396 Returns TRUE if the terminator was found, else returns FALSE.
5398 bool sv_cat_decode(SV* dsv, SV *encoding, SV *ssv, int *offset, char* tstr, int tlen)
5403 =item sv_recode_to_utf8
5405 The encoding is assumed to be an Encode object, on entry the PV
5406 of the sv is assumed to be octets in that encoding, and the sv
5407 will be converted into Unicode (and UTF-8).
5409 If the sv already is UTF-8 (or if it is not POK), or if the encoding
5410 is not a reference, nothing is done to the sv. If the encoding is not
5411 an C<Encode::XS> Encoding object, bad things will happen.
5412 (See F<lib/encoding.pm> and L<Encode>).
5414 The PV of the sv is returned.
5416 char* sv_recode_to_utf8(SV* sv, SV *encoding)
https://perl5.git.perl.org / perl5.git / blob