3 perlapi - autogenerated documentation for the perl public API
7 This file contains the documentation of the perl public API generated by
8 embed.pl, specifically a listing of functions, macros, flags, and variables
9 that may be used by extension writers. The interfaces of any functions that
10 are not listed here are subject to change without notice. For this reason,
11 blindly using functions listed in proto.h is to be avoided when writing
14 Note that all Perl API global variables must be referenced with the C<PL_>
15 prefix. Some macros are provided for compatibility with the older,
16 unadorned names, but this support may be disabled in a future release.
18 The listing is alphabetical, case insensitive.
27 A backward-compatible version of C<GIMME_V> which can only return
28 C<G_SCALAR> or C<G_ARRAY>; in a void context, it returns C<G_SCALAR>.
29 Deprecated. Use C<GIMME_V> instead.
38 The XSUB-writer's equivalent to Perl's C<wantarray>. Returns C<G_VOID>,
39 C<G_SCALAR> or C<G_ARRAY> for void, scalar or list context,
49 Used to indicate list context. See C<GIMME_V>, C<GIMME> and
57 Indicates that arguments returned from a callback should be discarded. See
65 Used to force a Perl C<eval> wrapper around a callback. See
73 Indicates that no arguments are being sent to a callback. See
81 Used to indicate scalar context. See C<GIMME_V>, C<GIMME>, and
89 Used to indicate void context. See C<GIMME_V> and L<perlcall>.
97 =head1 Array Manipulation Functions
103 Same as C<av_len()>. Deprecated, use C<av_len()> instead.
112 Clears an array, making it empty. Does not free the memory used by the
115 void av_clear(AV* ar)
122 Deletes the element indexed by C<key> from the array. Returns the
123 deleted element. If C<flags> equals C<G_DISCARD>, the element is freed
124 and null is returned.
126 SV* av_delete(AV* ar, I32 key, I32 flags)
133 Returns true if the element indexed by C<key> has been initialized.
135 This relies on the fact that uninitialized array elements are set to
138 bool av_exists(AV* ar, I32 key)
145 Pre-extend an array. The C<key> is the index to which the array should be
148 void av_extend(AV* ar, I32 key)
155 Returns the SV at the specified index in the array. The C<key> is the
156 index. If C<lval> is set then the fetch will be part of a store. Check
157 that the return value is non-null before dereferencing it to a C<SV*>.
159 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for
160 more information on how to use this function on tied arrays.
162 SV** av_fetch(AV* ar, I32 key, I32 lval)
169 Ensure than an array has a given number of elements, equivalent to
170 Perl's C<$#array = $fill;>.
172 void av_fill(AV* ar, I32 fill)
179 Returns the highest index in the array. Returns -1 if the array is
189 Creates a new AV and populates it with a list of SVs. The SVs are copied
190 into the array, so they may be freed after the call to av_make. The new AV
191 will have a reference count of 1.
193 AV* av_make(I32 size, SV** svp)
200 Pops an SV off the end of the array. Returns C<&PL_sv_undef> if the array
210 Pushes an SV onto the end of the array. The array will grow automatically
211 to accommodate the addition.
213 void av_push(AV* ar, SV* val)
220 Shifts an SV off the beginning of the array.
229 Stores an SV in an array. The array index is specified as C<key>. The
230 return value will be NULL if the operation failed or if the value did not
231 need to be actually stored within the array (as in the case of tied
232 arrays). Otherwise it can be dereferenced to get the original C<SV*>. Note
233 that the caller is responsible for suitably incrementing the reference
234 count of C<val> before the call, and decrementing it if the function
237 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for
238 more information on how to use this function on tied arrays.
240 SV** av_store(AV* ar, I32 key, SV* val)
247 Undefines the array. Frees the memory used by the array itself.
249 void av_undef(AV* ar)
256 Unshift the given number of C<undef> values onto the beginning of the
257 array. The array will grow automatically to accommodate the addition. You
258 must then use C<av_store> to assign values to these new elements.
260 void av_unshift(AV* ar, I32 num)
267 Returns the AV of the specified Perl array. If C<create> is set and the
268 Perl variable does not exist then it will be created. If C<create> is not
269 set and the variable does not exist then NULL is returned.
271 NOTE: the perl_ form of this function is deprecated.
273 AV* get_av(const char* name, I32 create)
280 Creates a new AV. The reference count is set to 1.
289 Sort an array. Here is an example:
291 sortsv(AvARRAY(av), av_len(av)+1, Perl_sv_cmp_locale);
293 See lib/sort.pm for details about controlling the sorting algorithm.
295 void sortsv(SV ** array, size_t num_elts, SVCOMPARE_t cmp)
298 Found in file pp_sort.c
303 =head1 Callback Functions
309 Performs a callback to the specified Perl sub. See L<perlcall>.
311 NOTE: the perl_ form of this function is deprecated.
313 I32 call_argv(const char* sub_name, I32 flags, char** argv)
320 Performs a callback to the specified Perl method. The blessed object must
321 be on the stack. See L<perlcall>.
323 NOTE: the perl_ form of this function is deprecated.
325 I32 call_method(const char* methname, I32 flags)
332 Performs a callback to the specified Perl sub. See L<perlcall>.
334 NOTE: the perl_ form of this function is deprecated.
336 I32 call_pv(const char* sub_name, I32 flags)
343 Performs a callback to the Perl sub whose name is in the SV. See
346 NOTE: the perl_ form of this function is deprecated.
348 I32 call_sv(SV* sv, I32 flags)
355 Opening bracket on a callback. See C<LEAVE> and L<perlcall>.
360 Found in file scope.h
364 Tells Perl to C<eval> the given string and return an SV* result.
366 NOTE: the perl_ form of this function is deprecated.
368 SV* eval_pv(const char* p, I32 croak_on_error)
375 Tells Perl to C<eval> the string in the SV.
377 NOTE: the perl_ form of this function is deprecated.
379 I32 eval_sv(SV* sv, I32 flags)
386 Closing bracket for temporaries on a callback. See C<SAVETMPS> and
392 Found in file scope.h
396 Closing bracket on a callback. See C<ENTER> and L<perlcall>.
401 Found in file scope.h
405 Opening bracket for temporaries on a callback. See C<FREETMPS> and
411 Found in file scope.h
416 =head1 Character classes
422 Returns a boolean indicating whether the C C<char> is an ASCII alphanumeric
423 character (including underscore) or digit.
425 bool isALNUM(char ch)
428 Found in file handy.h
432 Returns a boolean indicating whether the C C<char> is an ASCII alphabetic
435 bool isALPHA(char ch)
438 Found in file handy.h
442 Returns a boolean indicating whether the C C<char> is an ASCII
445 bool isDIGIT(char ch)
448 Found in file handy.h
452 Returns a boolean indicating whether the C C<char> is a lowercase
455 bool isLOWER(char ch)
458 Found in file handy.h
462 Returns a boolean indicating whether the C C<char> is whitespace.
464 bool isSPACE(char ch)
467 Found in file handy.h
471 Returns a boolean indicating whether the C C<char> is an uppercase
474 bool isUPPER(char ch)
477 Found in file handy.h
481 Converts the specified character to lowercase.
483 char toLOWER(char ch)
486 Found in file handy.h
490 Converts the specified character to uppercase.
492 char toUPPER(char ch)
495 Found in file handy.h
500 =head1 Cloning an interpreter
506 Create and return a new interpreter by cloning the current one.
508 perl_clone takes these flags as parameters:
510 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
511 without it we only clone the data and zero the stacks,
512 with it we copy the stacks and the new perl interpreter is
513 ready to run at the exact same point as the previous one.
514 The pseudo-fork code uses COPY_STACKS while the
515 threads->new doesn't.
517 CLONEf_KEEP_PTR_TABLE
518 perl_clone keeps a ptr_table with the pointer of the old
519 variable as a key and the new variable as a value,
520 this allows it to check if something has been cloned and not
521 clone it again but rather just use the value and increase the
522 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
523 the ptr_table using the function
524 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
525 reason to keep it around is if you want to dup some of your own
526 variable who are outside the graph perl scans, example of this
527 code is in threads.xs create
530 This is a win32 thing, it is ignored on unix, it tells perls
531 win32host code (which is c++) to clone itself, this is needed on
532 win32 if you want to run two threads at the same time,
533 if you just want to do some stuff in a separate perl interpreter
534 and then throw it away and return to the original one,
535 you don't need to do anything.
537 PerlInterpreter* perl_clone(PerlInterpreter* interp, UV flags)
545 =head1 CV Manipulation Functions
551 Returns the stash of the CV.
560 Returns the CV of the specified Perl subroutine. If C<create> is set and
561 the Perl subroutine does not exist then it will be declared (which has the
562 same effect as saying C<sub name;>). If C<create> is not set and the
563 subroutine does not exist then NULL is returned.
565 NOTE: the perl_ form of this function is deprecated.
567 CV* get_cv(const char* name, I32 create)
575 =head1 Embedding Functions
581 Clear out all the active components of a CV. This can happen either
582 by an explicit C<undef &foo>, or by the reference count going to zero.
583 In the former case, we keep the CvOUTSIDE pointer, so that any anonymous
584 children can still follow the full lexical scope chain.
586 void cv_undef(CV* cv)
593 Loads the module whose name is pointed to by the string part of name.
594 Note that the actual module name, not its filename, should be given.
595 Eg, "Foo::Bar" instead of "Foo/Bar.pm". flags can be any of
596 PERL_LOADMOD_DENY, PERL_LOADMOD_NOIMPORT, or PERL_LOADMOD_IMPORT_OPS
597 (or 0 for no flags). ver, if specified, provides version semantics
598 similar to C<use Foo::Bar VERSION>. The optional trailing SV*
599 arguments can be used to specify arguments to the module's import()
600 method, similar to C<use Foo::Bar VERSION LIST>.
602 void load_module(U32 flags, SV* name, SV* ver, ...)
609 Stub that provides thread hook for perl_destruct when there are
619 Allocates a new Perl interpreter. See L<perlembed>.
621 PerlInterpreter* perl_alloc()
628 Initializes a new Perl interpreter. See L<perlembed>.
630 void perl_construct(PerlInterpreter* interp)
637 Shuts down a Perl interpreter. See L<perlembed>.
639 int perl_destruct(PerlInterpreter* interp)
646 Releases a Perl interpreter. See L<perlembed>.
648 void perl_free(PerlInterpreter* interp)
655 Tells a Perl interpreter to parse a Perl script. See L<perlembed>.
657 int perl_parse(PerlInterpreter* interp, XSINIT_t xsinit, int argc, char** argv, char** env)
664 Tells a Perl interpreter to run. See L<perlembed>.
666 int perl_run(PerlInterpreter* interp)
673 Tells Perl to C<require> the file named by the string argument. It is
674 analogous to the Perl code C<eval "require '$file'">. It's even
675 implemented that way; consider using load_module instead.
677 NOTE: the perl_ form of this function is deprecated.
679 void require_pv(const char* pv)
687 =head1 Functions in file pp_pack.c
694 The engine implementing pack() Perl function.
696 void packlist(SV *cat, char *pat, char *patend, SV **beglist, SV **endlist)
699 Found in file pp_pack.c
703 The engine implementing pack() Perl function. Note: parameters next_in_list and
704 flags are not used. This call should not be used; use packlist instead.
706 void pack_cat(SV *cat, char *pat, char *patend, SV **beglist, SV **endlist, SV ***next_in_list, U32 flags)
709 Found in file pp_pack.c
713 The engine implementing unpack() Perl function. C<unpackstring> puts the
714 extracted list items on the stack and returns the number of elements.
715 Issue C<PUTBACK> before and C<SPAGAIN> after the call to this function.
717 I32 unpackstring(char *pat, char *patend, char *s, char *strend, U32 flags)
720 Found in file pp_pack.c
724 The engine implementing unpack() Perl function. Note: parameters strbeg, new_s
725 and ocnt are not used. This call should not be used, use unpackstring instead.
727 I32 unpack_str(char *pat, char *patend, char *s, char *strbeg, char *strend, char **new_s, I32 ocnt, U32 flags)
730 Found in file pp_pack.c
735 =head1 Global Variables
741 C<PL_modglobal> is a general purpose, interpreter global HV for use by
742 extensions that need to keep information on a per-interpreter basis.
743 In a pinch, it can also be used as a symbol table for extensions
744 to share data among each other. It is a good idea to use keys
745 prefixed by the package name of the extension that owns the data.
750 Found in file intrpvar.h
754 A convenience variable which is typically used with C<SvPV> when one
755 doesn't care about the length of the string. It is usually more efficient
756 to either declare a local variable and use that instead or to use the
762 Found in file thrdvar.h
766 This is the C<false> SV. See C<PL_sv_yes>. Always refer to this as
772 Found in file intrpvar.h
776 This is the C<undef> SV. Always refer to this as C<&PL_sv_undef>.
781 Found in file intrpvar.h
785 This is the C<true> SV. See C<PL_sv_no>. Always refer to this as
791 Found in file intrpvar.h
802 Return the SV from the GV.
811 Returns the glob with the given C<name> and a defined subroutine or
812 C<NULL>. The glob lives in the given C<stash>, or in the stashes
813 accessible via @ISA and UNIVERSAL::.
815 The argument C<level> should be either 0 or -1. If C<level==0>, as a
816 side-effect creates a glob with the given C<name> in the given C<stash>
817 which in the case of success contains an alias for the subroutine, and sets
818 up caching info for this glob. Similarly for all the searched stashes.
820 This function grants C<"SUPER"> token as a postfix of the stash name. The
821 GV returned from C<gv_fetchmeth> may be a method cache entry, which is not
822 visible to Perl code. So when calling C<call_sv>, you should not use
823 the GV directly; instead, you should use the method's CV, which can be
824 obtained from the GV with the C<GvCV> macro.
826 GV* gv_fetchmeth(HV* stash, const char* name, STRLEN len, I32 level)
833 See L<gv_fetchmethod_autoload>.
835 GV* gv_fetchmethod(HV* stash, const char* name)
840 =item gv_fetchmethod_autoload
842 Returns the glob which contains the subroutine to call to invoke the method
843 on the C<stash>. In fact in the presence of autoloading this may be the
844 glob for "AUTOLOAD". In this case the corresponding variable $AUTOLOAD is
847 The third parameter of C<gv_fetchmethod_autoload> determines whether
848 AUTOLOAD lookup is performed if the given method is not present: non-zero
849 means yes, look for AUTOLOAD; zero means no, don't look for AUTOLOAD.
850 Calling C<gv_fetchmethod> is equivalent to calling C<gv_fetchmethod_autoload>
851 with a non-zero C<autoload> parameter.
853 These functions grant C<"SUPER"> token as a prefix of the method name. Note
854 that if you want to keep the returned glob for a long time, you need to
855 check for it being "AUTOLOAD", since at the later time the call may load a
856 different subroutine due to $AUTOLOAD changing its value. Use the glob
857 created via a side effect to do this.
859 These functions have the same side-effects and as C<gv_fetchmeth> with
860 C<level==0>. C<name> should be writable if contains C<':'> or C<'
861 ''>. The warning against passing the GV returned by C<gv_fetchmeth> to
862 C<call_sv> apply equally to these functions.
864 GV* gv_fetchmethod_autoload(HV* stash, const char* name, I32 autoload)
869 =item gv_fetchmeth_autoload
871 Same as gv_fetchmeth(), but looks for autoloaded subroutines too.
872 Returns a glob for the subroutine.
874 For an autoloaded subroutine without a GV, will create a GV even
875 if C<level < 0>. For an autoloaded subroutine without a stub, GvCV()
876 of the result may be zero.
878 GV* gv_fetchmeth_autoload(HV* stash, const char* name, STRLEN len, I32 level)
885 Returns a pointer to the stash for a specified package. C<name> should
886 be a valid UTF-8 string and must be null-terminated. If C<create> is set
887 then the package will be created if it does not already exist. If C<create>
888 is not set and the package does not exist then NULL is returned.
890 HV* gv_stashpv(const char* name, I32 create)
897 Returns a pointer to the stash for a specified package. C<name> should
898 be a valid UTF-8 string. The C<namelen> parameter indicates the length of
899 the C<name>, in bytes. If C<create> is set then the package will be
900 created if it does not already exist. If C<create> is not set and the
901 package does not exist then NULL is returned.
903 HV* gv_stashpvn(const char* name, U32 namelen, I32 create)
910 Returns a pointer to the stash for a specified package, which must be a
911 valid UTF-8 string. See C<gv_stashpv>.
913 HV* gv_stashsv(SV* sv, I32 create)
934 Null character pointer.
937 Found in file handy.h
958 Found in file handy.h
963 =head1 Hash Manipulation Functions
969 Returns the HV of the specified Perl hash. If C<create> is set and the
970 Perl variable does not exist then it will be created. If C<create> is not
971 set and the variable does not exist then NULL is returned.
973 NOTE: the perl_ form of this function is deprecated.
975 HV* get_hv(const char* name, I32 create)
982 This flag, used in the length slot of hash entries and magic structures,
983 specifies the structure contains an C<SV*> pointer where a C<char*> pointer
984 is to be expected. (For information only--not to be used).
991 Returns the computed hash stored in the hash entry.
1000 Returns the actual pointer stored in the key slot of the hash entry. The
1001 pointer may be either C<char*> or C<SV*>, depending on the value of
1002 C<HeKLEN()>. Can be assigned to. The C<HePV()> or C<HeSVKEY()> macros are
1003 usually preferable for finding the value of a key.
1012 If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry
1013 holds an C<SV*> key. Otherwise, holds the actual length of the key. Can
1014 be assigned to. The C<HePV()> macro is usually preferable for finding key
1017 STRLEN HeKLEN(HE* he)
1024 Returns the key slot of the hash entry as a C<char*> value, doing any
1025 necessary dereferencing of possibly C<SV*> keys. The length of the string
1026 is placed in C<len> (this is a macro, so do I<not> use C<&len>). If you do
1027 not care about what the length of the key is, you may use the global
1028 variable C<PL_na>, though this is rather less efficient than using a local
1029 variable. Remember though, that hash keys in perl are free to contain
1030 embedded nulls, so using C<strlen()> or similar is not a good way to find
1031 the length of hash keys. This is very similar to the C<SvPV()> macro
1032 described elsewhere in this document.
1034 char* HePV(HE* he, STRLEN len)
1041 Returns the key as an C<SV*>, or C<Nullsv> if the hash entry does not
1042 contain an C<SV*> key.
1051 Returns the key as an C<SV*>. Will create and return a temporary mortal
1052 C<SV*> if the hash entry contains only a C<char*> key.
1054 SV* HeSVKEY_force(HE* he)
1061 Sets the key to a given C<SV*>, taking care to set the appropriate flags to
1062 indicate the presence of an C<SV*> key, and returns the same
1065 SV* HeSVKEY_set(HE* he, SV* sv)
1072 Returns the value slot (type C<SV*>) stored in the hash entry.
1081 Returns the package name of a stash. See C<SvSTASH>, C<CvSTASH>.
1083 char* HvNAME(HV* stash)
1090 Clears a hash, making it empty.
1092 void hv_clear(HV* tb)
1097 =item hv_clear_placeholders
1099 Clears any placeholders from a hash. If a restricted hash has any of its keys
1100 marked as readonly and the key is subsequently deleted, the key is not actually
1101 deleted but is marked by assigning it a value of &PL_sv_placeholder. This tags
1102 it so it will be ignored by future operations such as iterating over the hash,
1103 but will still allow the hash to have a value reassigned to the key at some
1104 future point. This function clears any such placeholder keys from the hash.
1105 See Hash::Util::lock_keys() for an example of its use.
1107 void hv_clear_placeholders(HV* hb)
1114 Deletes a key/value pair in the hash. The value SV is removed from the
1115 hash and returned to the caller. The C<klen> is the length of the key.
1116 The C<flags> value will normally be zero; if set to G_DISCARD then NULL
1119 SV* hv_delete(HV* tb, const char* key, I32 klen, I32 flags)
1126 Deletes a key/value pair in the hash. The value SV is removed from the
1127 hash and returned to the caller. The C<flags> value will normally be zero;
1128 if set to G_DISCARD then NULL will be returned. C<hash> can be a valid
1129 precomputed hash value, or 0 to ask for it to be computed.
1131 SV* hv_delete_ent(HV* tb, SV* key, I32 flags, U32 hash)
1138 Returns a boolean indicating whether the specified hash key exists. The
1139 C<klen> is the length of the key.
1141 bool hv_exists(HV* tb, const char* key, I32 klen)
1148 Returns a boolean indicating whether the specified hash key exists. C<hash>
1149 can be a valid precomputed hash value, or 0 to ask for it to be
1152 bool hv_exists_ent(HV* tb, SV* key, U32 hash)
1159 Returns the SV which corresponds to the specified key in the hash. The
1160 C<klen> is the length of the key. If C<lval> is set then the fetch will be
1161 part of a store. Check that the return value is non-null before
1162 dereferencing it to an C<SV*>.
1164 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1165 information on how to use this function on tied hashes.
1167 SV** hv_fetch(HV* tb, const char* key, I32 klen, I32 lval)
1174 Returns the hash entry which corresponds to the specified key in the hash.
1175 C<hash> must be a valid precomputed hash number for the given C<key>, or 0
1176 if you want the function to compute it. IF C<lval> is set then the fetch
1177 will be part of a store. Make sure the return value is non-null before
1178 accessing it. The return value when C<tb> is a tied hash is a pointer to a
1179 static location, so be sure to make a copy of the structure if you need to
1182 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1183 information on how to use this function on tied hashes.
1185 HE* hv_fetch_ent(HV* tb, SV* key, I32 lval, U32 hash)
1192 Prepares a starting point to traverse a hash table. Returns the number of
1193 keys in the hash (i.e. the same as C<HvKEYS(tb)>). The return value is
1194 currently only meaningful for hashes without tie magic.
1196 NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
1197 hash buckets that happen to be in use. If you still need that esoteric
1198 value, you can get it through the macro C<HvFILL(tb)>.
1201 I32 hv_iterinit(HV* tb)
1208 Returns the key from the current position of the hash iterator. See
1211 char* hv_iterkey(HE* entry, I32* retlen)
1218 Returns the key as an C<SV*> from the current position of the hash
1219 iterator. The return value will always be a mortal copy of the key. Also
1222 SV* hv_iterkeysv(HE* entry)
1229 Returns entries from a hash iterator. See C<hv_iterinit>.
1231 You may call C<hv_delete> or C<hv_delete_ent> on the hash entry that the
1232 iterator currently points to, without losing your place or invalidating your
1233 iterator. Note that in this case the current entry is deleted from the hash
1234 with your iterator holding the last reference to it. Your iterator is flagged
1235 to free the entry on the next call to C<hv_iternext>, so you must not discard
1236 your iterator immediately else the entry will leak - call C<hv_iternext> to
1237 trigger the resource deallocation.
1239 HE* hv_iternext(HV* tb)
1246 Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
1249 SV* hv_iternextsv(HV* hv, char** key, I32* retlen)
1254 =item hv_iternext_flags
1256 Returns entries from a hash iterator. See C<hv_iterinit> and C<hv_iternext>.
1257 The C<flags> value will normally be zero; if HV_ITERNEXT_WANTPLACEHOLDERS is
1258 set the placeholders keys (for restricted hashes) will be returned in addition
1259 to normal keys. By default placeholders are automatically skipped over.
1260 Currently a placeholder is implemented with a value that is
1261 C<&Perl_sv_placeholder>. Note that the implementation of placeholders and
1262 restricted hashes may change, and the implementation currently is
1263 insufficiently abstracted for any change to be tidy.
1265 NOTE: this function is experimental and may change or be
1266 removed without notice.
1268 HE* hv_iternext_flags(HV* tb, I32 flags)
1275 Returns the value from the current position of the hash iterator. See
1278 SV* hv_iterval(HV* tb, HE* entry)
1285 Adds magic to a hash. See C<sv_magic>.
1287 void hv_magic(HV* hv, GV* gv, int how)
1294 Evaluates the hash in scalar context and returns the result. Handles magic when the hash is tied.
1296 SV* hv_scalar(HV* hv)
1303 Stores an SV in a hash. The hash key is specified as C<key> and C<klen> is
1304 the length of the key. The C<hash> parameter is the precomputed hash
1305 value; if it is zero then Perl will compute it. The return value will be
1306 NULL if the operation failed or if the value did not need to be actually
1307 stored within the hash (as in the case of tied hashes). Otherwise it can
1308 be dereferenced to get the original C<SV*>. Note that the caller is
1309 responsible for suitably incrementing the reference count of C<val> before
1310 the call, and decrementing it if the function returned NULL. Effectively
1311 a successful hv_store takes ownership of one reference to C<val>. This is
1312 usually what you want; a newly created SV has a reference count of one, so
1313 if all your code does is create SVs then store them in a hash, hv_store
1314 will own the only reference to the new SV, and your code doesn't need to do
1315 anything further to tidy up. hv_store is not implemented as a call to
1316 hv_store_ent, and does not create a temporary SV for the key, so if your
1317 key data is not already in SV form then use hv_store in preference to
1320 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1321 information on how to use this function on tied hashes.
1323 SV** hv_store(HV* tb, const char* key, I32 klen, SV* val, U32 hash)
1330 Stores C<val> in a hash. The hash key is specified as C<key>. The C<hash>
1331 parameter is the precomputed hash value; if it is zero then Perl will
1332 compute it. The return value is the new hash entry so created. It will be
1333 NULL if the operation failed or if the value did not need to be actually
1334 stored within the hash (as in the case of tied hashes). Otherwise the
1335 contents of the return value can be accessed using the C<He?> macros
1336 described here. Note that the caller is responsible for suitably
1337 incrementing the reference count of C<val> before the call, and
1338 decrementing it if the function returned NULL. Effectively a successful
1339 hv_store_ent takes ownership of one reference to C<val>. This is
1340 usually what you want; a newly created SV has a reference count of one, so
1341 if all your code does is create SVs then store them in a hash, hv_store
1342 will own the only reference to the new SV, and your code doesn't need to do
1343 anything further to tidy up. Note that hv_store_ent only reads the C<key>;
1344 unlike C<val> it does not take ownership of it, so maintaining the correct
1345 reference count on C<key> is entirely the caller's responsibility. hv_store
1346 is not implemented as a call to hv_store_ent, and does not create a temporary
1347 SV for the key, so if your key data is not already in SV form then use
1348 hv_store in preference to hv_store_ent.
1350 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1351 information on how to use this function on tied hashes.
1353 HE* hv_store_ent(HV* tb, SV* key, SV* val, U32 hash)
1362 void hv_undef(HV* tb)
1369 Creates a new HV. The reference count is set to 1.
1379 =head1 Magical Functions
1385 Clear something magical that the SV represents. See C<sv_magic>.
1387 int mg_clear(SV* sv)
1394 Copies the magic from one SV to another. See C<sv_magic>.
1396 int mg_copy(SV* sv, SV* nsv, const char* key, I32 klen)
1403 Finds the magic pointer for type matching the SV. See C<sv_magic>.
1405 MAGIC* mg_find(SV* sv, int type)
1412 Free any magic storage used by the SV. See C<sv_magic>.
1421 Do magic after a value is retrieved from the SV. See C<sv_magic>.
1430 Report on the SV's length. See C<sv_magic>.
1432 U32 mg_length(SV* sv)
1439 Turns on the magical status of an SV. See C<sv_magic>.
1441 void mg_magical(SV* sv)
1448 Do magic after a value is assigned to the SV. See C<sv_magic>.
1457 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
1458 argument more than once.
1460 void SvGETMAGIC(SV* sv)
1467 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
1477 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
1478 argument more than once.
1480 void SvSETMAGIC(SV* sv)
1487 Like C<SvSetSV>, but does any set magic required afterwards.
1489 void SvSetMagicSV(SV* dsb, SV* ssv)
1494 =item SvSetMagicSV_nosteal
1496 Like C<SvSetSV_nosteal>, but does any set magic required afterwards.
1498 void SvSetMagicSV_nosteal(SV* dsv, SV* ssv)
1505 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
1508 void SvSetSV(SV* dsb, SV* ssv)
1513 =item SvSetSV_nosteal
1515 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
1516 ssv. May evaluate arguments more than once.
1518 void SvSetSV_nosteal(SV* dsv, SV* ssv)
1525 Arranges for sv to be shared between threads if a suitable module
1528 void SvSHARE(SV* sv)
1535 Releases a mutual exclusion lock on sv if a suitable module
1538 void SvUNLOCK(SV* sv)
1546 =head1 Memory Management
1552 The XSUB-writer's interface to the C C<memcpy> function. The C<src> is the
1553 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1554 the type. May fail on overlapping copies. See also C<Move>.
1556 void Copy(void* src, void* dest, int nitems, type)
1559 Found in file handy.h
1563 Like C<Copy> but returns dest. Useful for encouraging compilers to tail-call
1566 void * CopyD(void* src, void* dest, int nitems, type)
1569 Found in file handy.h
1573 The XSUB-writer's interface to the C C<memmove> function. The C<src> is the
1574 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1575 the type. Can do overlapping moves. See also C<Copy>.
1577 void Move(void* src, void* dest, int nitems, type)
1580 Found in file handy.h
1584 Like C<Move> but returns dest. Useful for encouraging compilers to tail-call
1587 void * MoveD(void* src, void* dest, int nitems, type)
1590 Found in file handy.h
1594 The XSUB-writer's interface to the C C<malloc> function.
1596 void New(int id, void* ptr, int nitems, type)
1599 Found in file handy.h
1603 The XSUB-writer's interface to the C C<malloc> function, with
1606 void Newc(int id, void* ptr, int nitems, type, cast)
1609 Found in file handy.h
1613 The XSUB-writer's interface to the C C<malloc> function. The allocated
1614 memory is zeroed with C<memzero>.
1616 void Newz(int id, void* ptr, int nitems, type)
1619 Found in file handy.h
1623 Fill up memory with a pattern (byte 0xAB over and over again) that
1624 hopefully catches attempts to access uninitialized memory.
1626 void Poison(void* dest, int nitems, type)
1629 Found in file handy.h
1633 The XSUB-writer's interface to the C C<realloc> function.
1635 void Renew(void* ptr, int nitems, type)
1638 Found in file handy.h
1642 The XSUB-writer's interface to the C C<realloc> function, with
1645 void Renewc(void* ptr, int nitems, type, cast)
1648 Found in file handy.h
1652 The XSUB-writer's interface to the C C<free> function.
1654 void Safefree(void* ptr)
1657 Found in file handy.h
1661 Perl's version of C<strdup()>. Returns a pointer to a newly allocated
1662 string which is a duplicate of C<pv>. The size of the string is
1663 determined by C<strlen()>. The memory allocated for the new string can
1664 be freed with the C<Safefree()> function.
1666 char* savepv(const char* pv)
1669 Found in file util.c
1673 Perl's version of what C<strndup()> would be if it existed. Returns a
1674 pointer to a newly allocated string which is a duplicate of the first
1675 C<len> bytes from C<pv>. The memory allocated for the new string can be
1676 freed with the C<Safefree()> function.
1678 char* savepvn(const char* pv, I32 len)
1681 Found in file util.c
1685 A version of C<savepv()> which allocates the duplicate string in memory
1686 which is shared between threads.
1688 char* savesharedpv(const char* pv)
1691 Found in file util.c
1695 A version of C<savepv()>/C<savepvn()> which gets the string to duplicate from
1696 the passed in SV using C<SvPV()>
1698 char* savesvpv(SV* sv)
1701 Found in file util.c
1705 This is an architecture-independent macro to copy one structure to another.
1707 void StructCopy(type src, type dest, type)
1710 Found in file handy.h
1714 The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the
1715 destination, C<nitems> is the number of items, and C<type> is the type.
1717 void Zero(void* dest, int nitems, type)
1720 Found in file handy.h
1724 Like C<Zero> but returns dest. Useful for encouraging compilers to tail-call
1727 void * ZeroD(void* dest, int nitems, type)
1730 Found in file handy.h
1735 =head1 Miscellaneous Functions
1741 Analyses the string in order to make fast searches on it using fbm_instr()
1742 -- the Boyer-Moore algorithm.
1744 void fbm_compile(SV* sv, U32 flags)
1747 Found in file util.c
1751 Returns the location of the SV in the string delimited by C<str> and
1752 C<strend>. It returns C<Nullch> if the string can't be found. The C<sv>
1753 does not have to be fbm_compiled, but the search will not be as fast
1756 char* fbm_instr(unsigned char* big, unsigned char* bigend, SV* littlesv, U32 flags)
1759 Found in file util.c
1763 Takes a sprintf-style format pattern and conventional
1764 (non-SV) arguments and returns the formatted string.
1766 (char *) Perl_form(pTHX_ const char* pat, ...)
1768 can be used any place a string (char *) is required:
1770 char * s = Perl_form("%d.%d",major,minor);
1772 Uses a single private buffer so if you want to format several strings you
1773 must explicitly copy the earlier strings away (and free the copies when you
1776 char* form(const char* pat, ...)
1779 Found in file util.c
1783 Fill the sv with current working directory
1785 int getcwd_sv(SV* sv)
1788 Found in file util.c
1792 Test two strings to see if they are equal. Returns true or false.
1794 bool strEQ(char* s1, char* s2)
1797 Found in file handy.h
1801 Test two strings to see if the first, C<s1>, is greater than or equal to
1802 the second, C<s2>. Returns true or false.
1804 bool strGE(char* s1, char* s2)
1807 Found in file handy.h
1811 Test two strings to see if the first, C<s1>, is greater than the second,
1812 C<s2>. Returns true or false.
1814 bool strGT(char* s1, char* s2)
1817 Found in file handy.h
1821 Test two strings to see if the first, C<s1>, is less than or equal to the
1822 second, C<s2>. Returns true or false.
1824 bool strLE(char* s1, char* s2)
1827 Found in file handy.h
1831 Test two strings to see if the first, C<s1>, is less than the second,
1832 C<s2>. Returns true or false.
1834 bool strLT(char* s1, char* s2)
1837 Found in file handy.h
1841 Test two strings to see if they are different. Returns true or
1844 bool strNE(char* s1, char* s2)
1847 Found in file handy.h
1851 Test two strings to see if they are equal. The C<len> parameter indicates
1852 the number of bytes to compare. Returns true or false. (A wrapper for
1855 bool strnEQ(char* s1, char* s2, STRLEN len)
1858 Found in file handy.h
1862 Test two strings to see if they are different. The C<len> parameter
1863 indicates the number of bytes to compare. Returns true or false. (A
1864 wrapper for C<strncmp>).
1866 bool strnNE(char* s1, char* s2, STRLEN len)
1869 Found in file handy.h
1873 Dummy routine which "locks" an SV when there is no locking module present.
1874 Exists to avoid test for a NULL function pointer and because it could potentially warn under
1875 some level of strict-ness.
1877 void sv_nolocking(SV *)
1880 Found in file util.c
1884 Dummy routine which "shares" an SV when there is no sharing module present.
1885 Exists to avoid test for a NULL function pointer and because it could potentially warn under
1886 some level of strict-ness.
1888 void sv_nosharing(SV *)
1891 Found in file util.c
1893 =item sv_nounlocking
1895 Dummy routine which "unlocks" an SV when there is no locking module present.
1896 Exists to avoid test for a NULL function pointer and because it could potentially warn under
1897 some level of strict-ness.
1899 void sv_nounlocking(SV *)
1902 Found in file util.c
1907 =head1 Numeric functions
1913 converts a string representing a binary number to numeric form.
1915 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
1916 conversion flags, and I<result> should be NULL or a pointer to an NV.
1917 The scan stops at the end of the string, or the first invalid character.
1918 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
1919 invalid character will also trigger a warning.
1920 On return I<*len> is set to the length of the scanned string,
1921 and I<*flags> gives output flags.
1923 If the value is <= C<UV_MAX> it is returned as a UV, the output flags are clear,
1924 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_bin>
1925 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
1926 and writes the value to I<*result> (or the value is discarded if I<result>
1929 The binary number may optionally be prefixed with "0b" or "b" unless
1930 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
1931 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the binary
1932 number may use '_' characters to separate digits.
1934 UV grok_bin(char* start, STRLEN* len, I32* flags, NV *result)
1937 Found in file numeric.c
1941 converts a string representing a hex number to numeric form.
1943 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
1944 conversion flags, and I<result> should be NULL or a pointer to an NV.
1945 The scan stops at the end of the string, or the first invalid character.
1946 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
1947 invalid character will also trigger a warning.
1948 On return I<*len> is set to the length of the scanned string,
1949 and I<*flags> gives output flags.
1951 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
1952 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_hex>
1953 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
1954 and writes the value to I<*result> (or the value is discarded if I<result>
1957 The hex number may optionally be prefixed with "0x" or "x" unless
1958 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
1959 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the hex
1960 number may use '_' characters to separate digits.
1962 UV grok_hex(char* start, STRLEN* len, I32* flags, NV *result)
1965 Found in file numeric.c
1969 Recognise (or not) a number. The type of the number is returned
1970 (0 if unrecognised), otherwise it is a bit-ORed combination of
1971 IS_NUMBER_IN_UV, IS_NUMBER_GREATER_THAN_UV_MAX, IS_NUMBER_NOT_INT,
1972 IS_NUMBER_NEG, IS_NUMBER_INFINITY, IS_NUMBER_NAN (defined in perl.h).
1974 If the value of the number can fit an in UV, it is returned in the *valuep
1975 IS_NUMBER_IN_UV will be set to indicate that *valuep is valid, IS_NUMBER_IN_UV
1976 will never be set unless *valuep is valid, but *valuep may have been assigned
1977 to during processing even though IS_NUMBER_IN_UV is not set on return.
1978 If valuep is NULL, IS_NUMBER_IN_UV will be set for the same cases as when
1979 valuep is non-NULL, but no actual assignment (or SEGV) will occur.
1981 IS_NUMBER_NOT_INT will be set with IS_NUMBER_IN_UV if trailing decimals were
1982 seen (in which case *valuep gives the true value truncated to an integer), and
1983 IS_NUMBER_NEG if the number is negative (in which case *valuep holds the
1984 absolute value). IS_NUMBER_IN_UV is not set if e notation was used or the
1985 number is larger than a UV.
1987 int grok_number(const char *pv, STRLEN len, UV *valuep)
1990 Found in file numeric.c
1992 =item grok_numeric_radix
1994 Scan and skip for a numeric decimal separator (radix).
1996 bool grok_numeric_radix(const char **sp, const char *send)
1999 Found in file numeric.c
2003 converts a string representing an octal number to numeric form.
2005 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2006 conversion flags, and I<result> should be NULL or a pointer to an NV.
2007 The scan stops at the end of the string, or the first invalid character.
2008 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2009 invalid character will also trigger a warning.
2010 On return I<*len> is set to the length of the scanned string,
2011 and I<*flags> gives output flags.
2013 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2014 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_oct>
2015 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2016 and writes the value to I<*result> (or the value is discarded if I<result>
2019 If C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the octal
2020 number may use '_' characters to separate digits.
2022 UV grok_oct(char* start, STRLEN* len, I32* flags, NV *result)
2025 Found in file numeric.c
2029 For backwards compatibility. Use C<grok_bin> instead.
2031 NV scan_bin(char* start, STRLEN len, STRLEN* retlen)
2034 Found in file numeric.c
2038 For backwards compatibility. Use C<grok_hex> instead.
2040 NV scan_hex(char* start, STRLEN len, STRLEN* retlen)
2043 Found in file numeric.c
2047 For backwards compatibility. Use C<grok_oct> instead.
2049 NV scan_oct(char* start, STRLEN len, STRLEN* retlen)
2052 Found in file numeric.c
2057 =head1 Optree Manipulation Functions
2063 If C<cv> is a constant sub eligible for inlining. returns the constant
2064 value returned by the sub. Otherwise, returns NULL.
2066 Constant subs can be created with C<newCONSTSUB> or as described in
2067 L<perlsub/"Constant Functions">.
2069 SV* cv_const_sv(CV* cv)
2076 Creates a constant sub equivalent to Perl C<sub FOO () { 123 }> which is
2077 eligible for inlining at compile-time.
2079 CV* newCONSTSUB(HV* stash, char* name, SV* sv)
2086 Used by C<xsubpp> to hook up XSUBs as Perl subs.
2094 =head1 Pad Data Structures
2100 Get the value at offset po in the current pad.
2101 Use macro PAD_SV instead of calling this function directly.
2103 SV* pad_sv(PADOFFSET po)
2111 =head1 Stack Manipulation Macros
2117 Declare a stack marker variable, C<mark>, for the XSUB. See C<MARK> and
2127 Saves the original stack mark for the XSUB. See C<ORIGMARK>.
2136 Declares a local copy of perl's stack pointer for the XSUB, available via
2137 the C<SP> macro. See C<SP>.
2146 Used to extend the argument stack for an XSUB's return values. Once
2147 used, guarantees that there is room for at least C<nitems> to be pushed
2150 void EXTEND(SP, int nitems)
2157 Stack marker variable for the XSUB. See C<dMARK>.
2164 Push an integer onto the stack. The stack must have room for this element.
2165 Handles 'set' magic. Does not use C<TARG>. See also C<PUSHi>, C<mXPUSHi>
2175 Push a double onto the stack. The stack must have room for this element.
2176 Handles 'set' magic. Does not use C<TARG>. See also C<PUSHn>, C<mXPUSHn>
2186 Push a string onto the stack. The stack must have room for this element.
2187 The C<len> indicates the length of the string. Handles 'set' magic. Does
2188 not use C<TARG>. See also C<PUSHp>, C<mXPUSHp> and C<XPUSHp>.
2190 void mPUSHp(char* str, STRLEN len)
2197 Push an unsigned integer onto the stack. The stack must have room for this
2198 element. Handles 'set' magic. Does not use C<TARG>. See also C<PUSHu>,
2199 C<mXPUSHu> and C<XPUSHu>.
2208 Push an integer onto the stack, extending the stack if necessary. Handles
2209 'set' magic. Does not use C<TARG>. See also C<XPUSHi>, C<mPUSHi> and
2219 Push a double onto the stack, extending the stack if necessary. Handles
2220 'set' magic. Does not use C<TARG>. See also C<XPUSHn>, C<mPUSHn> and
2230 Push a string onto the stack, extending the stack if necessary. The C<len>
2231 indicates the length of the string. Handles 'set' magic. Does not use
2232 C<TARG>. See also C<XPUSHp>, C<mPUSHp> and C<PUSHp>.
2234 void mXPUSHp(char* str, STRLEN len)
2241 Push an unsigned integer onto the stack, extending the stack if necessary.
2242 Handles 'set' magic. Does not use C<TARG>. See also C<XPUSHu>, C<mPUSHu>
2252 The original stack mark for the XSUB. See C<dORIGMARK>.
2259 Pops an integer off the stack.
2268 Pops a long off the stack.
2277 Pops a double off the stack.
2286 Pops a string off the stack. Deprecated. New code should provide
2287 a STRLEN n_a and use POPpx.
2296 Pops a string off the stack which must consist of bytes i.e. characters < 256.
2297 Requires a variable STRLEN n_a in scope.
2306 Pops a string off the stack.
2307 Requires a variable STRLEN n_a in scope.
2316 Pops an SV off the stack.
2325 Push an integer onto the stack. The stack must have room for this element.
2326 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
2327 called to declare it. Do not call multiple C<TARG>-oriented macros to
2328 return lists from XSUB's - see C<mPUSHi> instead. See also C<XPUSHi> and
2338 Opening bracket for arguments on a callback. See C<PUTBACK> and
2348 Push a new mortal SV onto the stack. The stack must have room for this
2349 element. Does not handle 'set' magic. Does not use C<TARG>. See also
2350 C<PUSHs>, C<XPUSHmortal> and C<XPUSHs>.
2359 Push a double onto the stack. The stack must have room for this element.
2360 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
2361 called to declare it. Do not call multiple C<TARG>-oriented macros to
2362 return lists from XSUB's - see C<mPUSHn> instead. See also C<XPUSHn> and
2372 Push a string onto the stack. The stack must have room for this element.
2373 The C<len> indicates the length of the string. Handles 'set' magic. Uses
2374 C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to declare it. Do not
2375 call multiple C<TARG>-oriented macros to return lists from XSUB's - see
2376 C<mPUSHp> instead. See also C<XPUSHp> and C<mXPUSHp>.
2378 void PUSHp(char* str, STRLEN len)
2385 Push an SV onto the stack. The stack must have room for this element.
2386 Does not handle 'set' magic. Does not use C<TARG>. See also C<PUSHmortal>,
2387 C<XPUSHs> and C<XPUSHmortal>.
2396 Push an unsigned integer onto the stack. The stack must have room for this
2397 element. Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG>
2398 should be called to declare it. Do not call multiple C<TARG>-oriented
2399 macros to return lists from XSUB's - see C<mPUSHu> instead. See also
2400 C<XPUSHu> and C<mXPUSHu>.
2409 Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
2410 See C<PUSHMARK> and L<perlcall> for other uses.
2419 Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and
2427 Refetch the stack pointer. Used after a callback. See L<perlcall>.
2436 Push an integer onto the stack, extending the stack if necessary. Handles
2437 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
2438 declare it. Do not call multiple C<TARG>-oriented macros to return lists
2439 from XSUB's - see C<mXPUSHi> instead. See also C<PUSHi> and C<mPUSHi>.
2448 Push a new mortal SV onto the stack, extending the stack if necessary. Does
2449 not handle 'set' magic. Does not use C<TARG>. See also C<XPUSHs>,
2450 C<PUSHmortal> and C<PUSHs>.
2459 Push a double onto the stack, extending the stack if necessary. Handles
2460 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
2461 declare it. Do not call multiple C<TARG>-oriented macros to return lists
2462 from XSUB's - see C<mXPUSHn> instead. See also C<PUSHn> and C<mPUSHn>.
2471 Push a string onto the stack, extending the stack if necessary. The C<len>
2472 indicates the length of the string. Handles 'set' magic. Uses C<TARG>, so
2473 C<dTARGET> or C<dXSTARG> should be called to declare it. Do not call
2474 multiple C<TARG>-oriented macros to return lists from XSUB's - see
2475 C<mXPUSHp> instead. See also C<PUSHp> and C<mPUSHp>.
2477 void XPUSHp(char* str, STRLEN len)
2484 Push an SV onto the stack, extending the stack if necessary. Does not
2485 handle 'set' magic. Does not use C<TARG>. See also C<XPUSHmortal>,
2486 C<PUSHs> and C<PUSHmortal>.
2495 Push an unsigned integer onto the stack, extending the stack if necessary.
2496 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
2497 called to declare it. Do not call multiple C<TARG>-oriented macros to
2498 return lists from XSUB's - see C<mXPUSHu> instead. See also C<PUSHu> and
2508 Return from XSUB, indicating number of items on the stack. This is usually
2509 handled by C<xsubpp>.
2511 void XSRETURN(int nitems)
2514 Found in file XSUB.h
2516 =item XSRETURN_EMPTY
2518 Return an empty list from an XSUB immediately.
2523 Found in file XSUB.h
2527 Return an integer from an XSUB immediately. Uses C<XST_mIV>.
2529 void XSRETURN_IV(IV iv)
2532 Found in file XSUB.h
2536 Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
2541 Found in file XSUB.h
2545 Return a double from an XSUB immediately. Uses C<XST_mNV>.
2547 void XSRETURN_NV(NV nv)
2550 Found in file XSUB.h
2554 Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
2556 void XSRETURN_PV(char* str)
2559 Found in file XSUB.h
2561 =item XSRETURN_UNDEF
2563 Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
2568 Found in file XSUB.h
2572 Return an integer from an XSUB immediately. Uses C<XST_mUV>.
2574 void XSRETURN_UV(IV uv)
2577 Found in file XSUB.h
2581 Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
2586 Found in file XSUB.h
2590 Place an integer into the specified position C<pos> on the stack. The
2591 value is stored in a new mortal SV.
2593 void XST_mIV(int pos, IV iv)
2596 Found in file XSUB.h
2600 Place C<&PL_sv_no> into the specified position C<pos> on the
2603 void XST_mNO(int pos)
2606 Found in file XSUB.h
2610 Place a double into the specified position C<pos> on the stack. The value
2611 is stored in a new mortal SV.
2613 void XST_mNV(int pos, NV nv)
2616 Found in file XSUB.h
2620 Place a copy of a string into the specified position C<pos> on the stack.
2621 The value is stored in a new mortal SV.
2623 void XST_mPV(int pos, char* str)
2626 Found in file XSUB.h
2630 Place C<&PL_sv_undef> into the specified position C<pos> on the
2633 void XST_mUNDEF(int pos)
2636 Found in file XSUB.h
2640 Place C<&PL_sv_yes> into the specified position C<pos> on the
2643 void XST_mYES(int pos)
2646 Found in file XSUB.h
2657 An enum of flags for Perl types. These are found in the file B<sv.h>
2658 in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
2665 Integer type flag for scalars. See C<svtype>.
2672 Double type flag for scalars. See C<svtype>.
2679 Pointer type flag for scalars. See C<svtype>.
2686 Type flag for arrays. See C<svtype>.
2693 Type flag for code refs. See C<svtype>.
2700 Type flag for hashes. See C<svtype>.
2707 Type flag for blessed scalars. See C<svtype>.
2715 =head1 SV Manipulation Functions
2721 Returns the SV of the specified Perl scalar. If C<create> is set and the
2722 Perl variable does not exist then it will be created. If C<create> is not
2723 set and the variable does not exist then NULL is returned.
2725 NOTE: the perl_ form of this function is deprecated.
2727 SV* get_sv(const char* name, I32 create)
2730 Found in file perl.c
2732 =item looks_like_number
2734 Test if the content of an SV looks like a number (or is a number).
2735 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
2736 non-numeric warning), even if your atof() doesn't grok them.
2738 I32 looks_like_number(SV* sv)
2745 Creates an RV wrapper for an SV. The reference count for the original SV is
2748 SV* newRV_inc(SV* sv)
2755 Creates an RV wrapper for an SV. The reference count for the original
2756 SV is B<not> incremented.
2758 SV* newRV_noinc(SV *sv)
2765 Creates a new SV. A non-zero C<len> parameter indicates the number of
2766 bytes of preallocated string space the SV should have. An extra byte for a
2767 tailing NUL is also reserved. (SvPOK is not set for the SV even if string
2768 space is allocated.) The reference count for the new SV is set to 1.
2769 C<id> is an integer id between 0 and 1299 (used to identify leaks).
2771 SV* NEWSV(int id, STRLEN len)
2774 Found in file handy.h
2778 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
2779 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
2782 SV* newSV(STRLEN len)
2789 Creates a new SV and copies an integer into it. The reference count for the
2799 Creates a new SV and copies a floating point value into it.
2800 The reference count for the SV is set to 1.
2809 Creates a new SV and copies a string into it. The reference count for the
2810 SV is set to 1. If C<len> is zero, Perl will compute the length using
2811 strlen(). For efficiency, consider using C<newSVpvn> instead.
2813 SV* newSVpv(const char* s, STRLEN len)
2820 Creates a new SV and initializes it with the string formatted like
2823 SV* newSVpvf(const char* pat, ...)
2830 Creates a new SV and copies a string into it. The reference count for the
2831 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
2832 string. You are responsible for ensuring that the source string is at least
2833 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
2835 SV* newSVpvn(const char* s, STRLEN len)
2840 =item newSVpvn_share
2842 Creates a new SV with its SvPVX pointing to a shared string in the string
2843 table. If the string does not already exist in the table, it is created
2844 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
2845 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
2846 otherwise the hash is computed. The idea here is that as the string table
2847 is used for shared hash keys these strings will have SvPVX == HeKEY and
2848 hash lookup will avoid string compare.
2850 SV* newSVpvn_share(const char* s, I32 len, U32 hash)
2857 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
2858 it will be upgraded to one. If C<classname> is non-null then the new SV will
2859 be blessed in the specified package. The new SV is returned and its
2860 reference count is 1.
2862 SV* newSVrv(SV* rv, const char* classname)
2869 Creates a new SV which is an exact duplicate of the original SV.
2872 SV* newSVsv(SV* old)
2879 Creates a new SV and copies an unsigned integer into it.
2880 The reference count for the SV is set to 1.
2889 Returns the length of the string which is in the SV. See C<SvLEN>.
2891 STRLEN SvCUR(SV* sv)
2898 Set the length of the string which is in the SV. See C<SvCUR>.
2900 void SvCUR_set(SV* sv, STRLEN len)
2907 Returns a pointer to the last character in the string which is in the SV.
2908 See C<SvCUR>. Access the character as *(SvEND(sv)).
2917 Expands the character buffer in the SV so that it has room for the
2918 indicated number of bytes (remember to reserve space for an extra trailing
2919 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
2920 Returns a pointer to the character buffer.
2922 char * SvGROW(SV* sv, STRLEN len)
2929 Returns a boolean indicating whether the SV contains an integer.
2938 Returns a boolean indicating whether the SV contains an integer. Checks
2939 the B<private> setting. Use C<SvIOK>.
2948 Returns a boolean indicating whether the SV contains a signed integer.
2950 bool SvIOK_notUV(SV* sv)
2957 Unsets the IV status of an SV.
2959 void SvIOK_off(SV* sv)
2966 Tells an SV that it is an integer.
2968 void SvIOK_on(SV* sv)
2975 Tells an SV that it is an integer and disables all other OK bits.
2977 void SvIOK_only(SV* sv)
2984 Tells and SV that it is an unsigned integer and disables all other OK bits.
2986 void SvIOK_only_UV(SV* sv)
2993 Returns a boolean indicating whether the SV contains an unsigned integer.
2995 bool SvIOK_UV(SV* sv)
3002 Returns a boolean indicating whether the SV is Copy-On-Write. (either shared
3003 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
3006 bool SvIsCOW(SV* sv)
3011 =item SvIsCOW_shared_hash
3013 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
3016 bool SvIsCOW_shared_hash(SV* sv)
3023 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
3024 version which guarantees to evaluate sv only once.
3033 Returns the raw value in the SV's IV slot, without checks or conversions.
3034 Only use when you are sure SvIOK is true. See also C<SvIV()>.
3043 Coerces the given SV to an integer and returns it. Guarantees to evaluate
3044 sv only once. Use the more efficient C<SvIV> otherwise.
3053 Returns the size of the string buffer in the SV, not including any part
3054 attributable to C<SvOOK>. See C<SvCUR>.
3056 STRLEN SvLEN(SV* sv)
3063 Returns a boolean indicating whether the SV contains a number, integer or
3073 Returns a boolean indicating whether the SV contains a number, integer or
3074 double. Checks the B<private> setting. Use C<SvNIOK>.
3076 bool SvNIOKp(SV* sv)
3083 Unsets the NV/IV status of an SV.
3085 void SvNIOK_off(SV* sv)
3092 Returns a boolean indicating whether the SV contains a double.
3101 Returns a boolean indicating whether the SV contains a double. Checks the
3102 B<private> setting. Use C<SvNOK>.
3111 Unsets the NV status of an SV.
3113 void SvNOK_off(SV* sv)
3120 Tells an SV that it is a double.
3122 void SvNOK_on(SV* sv)
3129 Tells an SV that it is a double and disables all other OK bits.
3131 void SvNOK_only(SV* sv)
3138 Coerce the given SV to a double and return it. See C<SvNVx> for a version
3139 which guarantees to evaluate sv only once.
3148 Returns the raw value in the SV's NV slot, without checks or conversions.
3149 Only use when you are sure SvNOK is true. See also C<SvNV()>.
3158 Coerces the given SV to a double and returns it. Guarantees to evaluate
3159 sv only once. Use the more efficient C<SvNV> otherwise.
3168 Returns a boolean indicating whether the value is an SV. It also tells
3169 whether the value is defined or not.
3178 Returns a boolean indicating whether the SvIVX is a valid offset value for
3179 the SvPVX. This hack is used internally to speed up removal of characters
3180 from the beginning of a SvPV. When SvOOK is true, then the start of the
3181 allocated string buffer is really (SvPVX - SvIVX).
3190 Returns a boolean indicating whether the SV contains a character
3200 Returns a boolean indicating whether the SV contains a character string.
3201 Checks the B<private> setting. Use C<SvPOK>.
3210 Unsets the PV status of an SV.
3212 void SvPOK_off(SV* sv)
3219 Tells an SV that it is a string.
3221 void SvPOK_on(SV* sv)
3228 Tells an SV that it is a string and disables all other OK bits.
3229 Will also turn off the UTF-8 status.
3231 void SvPOK_only(SV* sv)
3236 =item SvPOK_only_UTF8
3238 Tells an SV that it is a string and disables all other OK bits,
3239 and leaves the UTF-8 status as it was.
3241 void SvPOK_only_UTF8(SV* sv)
3248 Returns a pointer to the string in the SV, or a stringified form of
3249 the SV if the SV does not contain a string. The SV may cache the
3250 stringified version becoming C<SvPOK>. Handles 'get' magic. See also
3251 C<SvPVx> for a version which guarantees to evaluate sv only once.
3253 char* SvPV(SV* sv, STRLEN len)
3260 Like C<SvPV>, but converts sv to byte representation first if necessary.
3262 char* SvPVbyte(SV* sv, STRLEN len)
3269 Like C<SvPV>, but converts sv to byte representation first if necessary.
3270 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
3273 char* SvPVbytex(SV* sv, STRLEN len)
3278 =item SvPVbytex_force
3280 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
3281 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
3284 char* SvPVbytex_force(SV* sv, STRLEN len)
3289 =item SvPVbyte_force
3291 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
3293 char* SvPVbyte_force(SV* sv, STRLEN len)
3298 =item SvPVbyte_nolen
3300 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
3302 char* SvPVbyte_nolen(SV* sv)
3309 Like C<SvPV>, but converts sv to utf8 first if necessary.
3311 char* SvPVutf8(SV* sv, STRLEN len)
3318 Like C<SvPV>, but converts sv to utf8 first if necessary.
3319 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
3322 char* SvPVutf8x(SV* sv, STRLEN len)
3327 =item SvPVutf8x_force
3329 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
3330 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
3333 char* SvPVutf8x_force(SV* sv, STRLEN len)
3338 =item SvPVutf8_force
3340 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
3342 char* SvPVutf8_force(SV* sv, STRLEN len)
3347 =item SvPVutf8_nolen
3349 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
3351 char* SvPVutf8_nolen(SV* sv)
3358 Returns a pointer to the physical string in the SV. The SV must contain a
3368 A version of C<SvPV> which guarantees to evaluate sv only once.
3370 char* SvPVx(SV* sv, STRLEN len)
3377 Like C<SvPV> but will force the SV into containing just a string
3378 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
3381 char* SvPV_force(SV* sv, STRLEN len)
3386 =item SvPV_force_nomg
3388 Like C<SvPV> but will force the SV into containing just a string
3389 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
3390 directly. Doesn't process magic.
3392 char* SvPV_force_nomg(SV* sv, STRLEN len)
3399 Returns a pointer to the string in the SV, or a stringified form of
3400 the SV if the SV does not contain a string. The SV may cache the
3401 stringified form becoming C<SvPOK>. Handles 'get' magic.
3403 char* SvPV_nolen(SV* sv)
3410 Returns the value of the object's reference count.
3412 U32 SvREFCNT(SV* sv)
3419 Decrements the reference count of the given SV.
3421 void SvREFCNT_dec(SV* sv)
3428 Increments the reference count of the given SV.
3430 SV* SvREFCNT_inc(SV* sv)
3437 Tests if the SV is an RV.
3446 Unsets the RV status of an SV.
3448 void SvROK_off(SV* sv)
3455 Tells an SV that it is an RV.
3457 void SvROK_on(SV* sv)
3464 Dereferences an RV to return the SV.
3473 Returns the stash of the SV.
3482 Taints an SV if tainting is enabled.
3484 void SvTAINT(SV* sv)
3491 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
3494 bool SvTAINTED(SV* sv)
3501 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
3502 some of Perl's fundamental security features. XS module authors should not
3503 use this function unless they fully understand all the implications of
3504 unconditionally untainting the value. Untainting should be done in the
3505 standard perl fashion, via a carefully crafted regexp, rather than directly
3506 untainting variables.
3508 void SvTAINTED_off(SV* sv)
3515 Marks an SV as tainted if tainting is enabled.
3517 void SvTAINTED_on(SV* sv)
3524 Returns a boolean indicating whether Perl would evaluate the SV as true or
3525 false, defined or undefined. Does not handle 'get' magic.
3534 Returns the type of the SV. See C<svtype>.
3536 svtype SvTYPE(SV* sv)
3543 Returns a boolean indicating whether the SV contains an unsigned integer.
3552 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
3553 perform the upgrade if necessary. See C<svtype>.
3555 void SvUPGRADE(SV* sv, svtype type)
3562 Returns a boolean indicating whether the SV contains UTF-8 encoded data.
3571 Unsets the UTF-8 status of an SV.
3573 void SvUTF8_off(SV *sv)
3580 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
3581 Do not use frivolously.
3583 void SvUTF8_on(SV *sv)
3590 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
3591 for a version which guarantees to evaluate sv only once.
3600 Returns the raw value in the SV's UV slot, without checks or conversions.
3601 Only use when you are sure SvIOK is true. See also C<SvUV()>.
3610 Coerces the given SV to an unsigned integer and returns it. Guarantees to
3611 evaluate sv only once. Use the more efficient C<SvUV> otherwise.
3620 This function is only called on magical items, and is only used by
3621 sv_true() or its macro equivalent.
3623 bool sv_2bool(SV* sv)
3630 Using various gambits, try to get a CV from an SV; in addition, try if
3631 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
3633 CV* sv_2cv(SV* sv, HV** st, GV** gvp, I32 lref)
3640 Using various gambits, try to get an IO from an SV: the IO slot if its a
3641 GV; or the recursive result if we're an RV; or the IO slot of the symbol
3642 named after the PV if we're a string.
3651 Return the integer value of an SV, doing any necessary string conversion,
3652 magic etc. Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
3661 Marks an existing SV as mortal. The SV will be destroyed "soon", either
3662 by an explicit call to FREETMPS, or by an implicit call at places such as
3663 statement boundaries. SvTEMP() is turned on which means that the SV's
3664 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
3665 and C<sv_mortalcopy>.
3667 SV* sv_2mortal(SV* sv)
3674 Return the num value of an SV, doing any necessary string or integer
3675 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
3685 Return a pointer to the byte-encoded representation of the SV, and set *lp
3686 to its length. May cause the SV to be downgraded from UTF-8 as a
3689 Usually accessed via the C<SvPVbyte> macro.
3691 char* sv_2pvbyte(SV* sv, STRLEN* lp)
3696 =item sv_2pvbyte_nolen
3698 Return a pointer to the byte-encoded representation of the SV.
3699 May cause the SV to be downgraded from UTF-8 as a side-effect.
3701 Usually accessed via the C<SvPVbyte_nolen> macro.
3703 char* sv_2pvbyte_nolen(SV* sv)
3710 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3711 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
3713 Usually accessed via the C<SvPVutf8> macro.
3715 char* sv_2pvutf8(SV* sv, STRLEN* lp)
3720 =item sv_2pvutf8_nolen
3722 Return a pointer to the UTF-8-encoded representation of the SV.
3723 May cause the SV to be upgraded to UTF-8 as a side-effect.
3725 Usually accessed via the C<SvPVutf8_nolen> macro.
3727 char* sv_2pvutf8_nolen(SV* sv)
3734 Returns a pointer to the string value of an SV, and sets *lp to its length.
3735 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
3737 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
3738 usually end up here too.
3740 char* sv_2pv_flags(SV* sv, STRLEN* lp, I32 flags)
3747 Like C<sv_2pv()>, but doesn't return the length too. You should usually
3748 use the macro wrapper C<SvPV_nolen(sv)> instead.
3749 char* sv_2pv_nolen(SV* sv)
3756 Return the unsigned integer value of an SV, doing any necessary string
3757 conversion, magic etc. Normally used via the C<SvUV(sv)> and C<SvUVx(sv)>
3767 Remove any string offset. You should normally use the C<SvOOK_off> macro
3770 int sv_backoff(SV* sv)
3777 Blesses an SV into a specified package. The SV must be an RV. The package
3778 must be designated by its stash (see C<gv_stashpv()>). The reference count
3779 of the SV is unaffected.
3781 SV* sv_bless(SV* sv, HV* stash)
3788 Concatenates the string onto the end of the string which is in the SV.
3789 If the SV has the UTF-8 status set, then the bytes appended should be
3790 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
3792 void sv_catpv(SV* sv, const char* ptr)
3799 Processes its arguments like C<sprintf> and appends the formatted
3800 output to an SV. If the appended data contains "wide" characters
3801 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
3802 and characters >255 formatted with %c), the original SV might get
3803 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
3804 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
3805 valid UTF-8; if the original SV was bytes, the pattern should be too.
3807 void sv_catpvf(SV* sv, const char* pat, ...)
3814 Like C<sv_catpvf>, but also handles 'set' magic.
3816 void sv_catpvf_mg(SV *sv, const char* pat, ...)
3823 Concatenates the string onto the end of the string which is in the SV. The
3824 C<len> indicates number of bytes to copy. If the SV has the UTF-8
3825 status set, then the bytes appended should be valid UTF-8.
3826 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
3828 void sv_catpvn(SV* sv, const char* ptr, STRLEN len)
3833 =item sv_catpvn_flags
3835 Concatenates the string onto the end of the string which is in the SV. The
3836 C<len> indicates number of bytes to copy. If the SV has the UTF-8
3837 status set, then the bytes appended should be valid UTF-8.
3838 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
3839 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
3840 in terms of this function.
3842 void sv_catpvn_flags(SV* sv, const char* ptr, STRLEN len, I32 flags)
3849 Like C<sv_catpvn>, but also handles 'set' magic.
3851 void sv_catpvn_mg(SV *sv, const char *ptr, STRLEN len)
3856 =item sv_catpvn_nomg
3858 Like C<sv_catpvn> but doesn't process magic.
3860 void sv_catpvn_nomg(SV* sv, const char* ptr, STRLEN len)
3867 Like C<sv_catpv>, but also handles 'set' magic.
3869 void sv_catpv_mg(SV *sv, const char *ptr)
3876 Concatenates the string from SV C<ssv> onto the end of the string in
3877 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
3878 not 'set' magic. See C<sv_catsv_mg>.
3880 void sv_catsv(SV* dsv, SV* ssv)
3885 =item sv_catsv_flags
3887 Concatenates the string from SV C<ssv> onto the end of the string in
3888 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
3889 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
3890 and C<sv_catsv_nomg> are implemented in terms of this function.
3892 void sv_catsv_flags(SV* dsv, SV* ssv, I32 flags)
3899 Like C<sv_catsv>, but also handles 'set' magic.
3901 void sv_catsv_mg(SV *dstr, SV *sstr)
3908 Like C<sv_catsv> but doesn't process magic.
3910 void sv_catsv_nomg(SV* dsv, SV* ssv)
3917 Efficient removal of characters from the beginning of the string buffer.
3918 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
3919 the string buffer. The C<ptr> becomes the first character of the adjusted
3920 string. Uses the "OOK hack".
3921 Beware: after this function returns, C<ptr> and SvPVX(sv) may no longer
3922 refer to the same chunk of data.
3924 void sv_chop(SV* sv, char* ptr)
3931 Clear an SV: call any destructors, free up any memory used by the body,
3932 and free the body itself. The SV's head is I<not> freed, although
3933 its type is set to all 1's so that it won't inadvertently be assumed
3934 to be live during global destruction etc.
3935 This function should only be called when REFCNT is zero. Most of the time
3936 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
3939 void sv_clear(SV* sv)
3946 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
3947 string in C<sv1> is less than, equal to, or greater than the string in
3948 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
3949 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
3951 I32 sv_cmp(SV* sv1, SV* sv2)
3958 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
3959 'use bytes' aware, handles get magic, and will coerce its args to strings
3960 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
3962 I32 sv_cmp_locale(SV* sv1, SV* sv2)
3969 Add Collate Transform magic to an SV if it doesn't already have it.
3971 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
3972 scalar data of the variable, but transformed to such a format that a normal
3973 memory comparison can be used to compare the data according to the locale
3976 char* sv_collxfrm(SV* sv, STRLEN* nxp)
3983 Copies a stringified representation of the source SV into the
3984 destination SV. Automatically performs any necessary mg_get and
3985 coercion of numeric values into strings. Guaranteed to preserve
3986 UTF-8 flag even from overloaded objects. Similar in nature to
3987 sv_2pv[_flags] but operates directly on an SV instead of just the
3988 string. Mostly uses sv_2pv_flags to do its work, except when that
3989 would lose the UTF-8'ness of the PV.
3991 void sv_copypv(SV* dsv, SV* ssv)
3998 Auto-decrement of the value in the SV, doing string to numeric conversion
3999 if necessary. Handles 'get' magic.
4006 =item sv_derived_from
4008 Returns a boolean indicating whether the SV is derived from the specified
4009 class. This is the function that implements C<UNIVERSAL::isa>. It works
4010 for class names as well as for objects.
4012 bool sv_derived_from(SV* sv, const char* name)
4015 Found in file universal.c
4019 Returns a boolean indicating whether the strings in the two SVs are
4020 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
4021 coerce its args to strings if necessary.
4023 I32 sv_eq(SV* sv1, SV* sv2)
4028 =item sv_force_normal
4030 Undo various types of fakery on an SV: if the PV is a shared string, make
4031 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4032 an xpvmg. See also C<sv_force_normal_flags>.
4034 void sv_force_normal(SV *sv)
4039 =item sv_force_normal_flags
4041 Undo various types of fakery on an SV: if the PV is a shared string, make
4042 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4043 an xpvmg. The C<flags> parameter gets passed to C<sv_unref_flags()>
4044 when unrefing. C<sv_force_normal> calls this function with flags set to 0.
4046 void sv_force_normal_flags(SV *sv, U32 flags)
4053 Decrement an SV's reference count, and if it drops to zero, call
4054 C<sv_clear> to invoke destructors and free up any memory used by
4055 the body; finally, deallocate the SV's head itself.
4056 Normally called via a wrapper macro C<SvREFCNT_dec>.
4058 void sv_free(SV* sv)
4065 Get a line from the filehandle and store it into the SV, optionally
4066 appending to the currently-stored string.
4068 char* sv_gets(SV* sv, PerlIO* fp, I32 append)
4075 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
4076 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
4077 Use the C<SvGROW> wrapper instead.
4079 char* sv_grow(SV* sv, STRLEN newlen)
4086 Auto-increment of the value in the SV, doing string to numeric conversion
4087 if necessary. Handles 'get' magic.
4096 Inserts a string at the specified offset/length within the SV. Similar to
4097 the Perl substr() function.
4099 void sv_insert(SV* bigsv, STRLEN offset, STRLEN len, char* little, STRLEN littlelen)
4106 Returns a boolean indicating whether the SV is blessed into the specified
4107 class. This does not check for subtypes; use C<sv_derived_from> to verify
4108 an inheritance relationship.
4110 int sv_isa(SV* sv, const char* name)
4117 Returns a boolean indicating whether the SV is an RV pointing to a blessed
4118 object. If the SV is not an RV, or if the object is not blessed, then this
4121 int sv_isobject(SV* sv)
4128 A private implementation of the C<SvIVx> macro for compilers which can't
4129 cope with complex macro expressions. Always use the macro instead.
4138 Returns the length of the string in the SV. Handles magic and type
4139 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
4141 STRLEN sv_len(SV* sv)
4148 Returns the number of characters in the string in an SV, counting wide
4149 UTF-8 bytes as a single character. Handles magic and type coercion.
4151 STRLEN sv_len_utf8(SV* sv)
4158 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4159 then adds a new magic item of type C<how> to the head of the magic list.
4161 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4162 handling of the C<name> and C<namlen> arguments.
4164 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4165 to add more than one instance of the same 'how'.
4167 void sv_magic(SV* sv, SV* obj, int how, const char* name, I32 namlen)
4174 Adds magic to an SV, upgrading it if necessary. Applies the
4175 supplied vtable and returns a pointer to the magic added.
4177 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4178 In particular, you can add magic to SvREADONLY SVs, and add more than
4179 one instance of the same 'how'.
4181 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4182 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4183 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4184 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4186 (This is now used as a subroutine by C<sv_magic>.)
4188 MAGIC * sv_magicext(SV* sv, SV* obj, int how, MGVTBL *vtbl, const char* name, I32 namlen)
4195 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
4196 The new SV is marked as mortal. It will be destroyed "soon", either by an
4197 explicit call to FREETMPS, or by an implicit call at places such as
4198 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
4200 SV* sv_mortalcopy(SV* oldsv)
4207 Creates a new null SV which is mortal. The reference count of the SV is
4208 set to 1. It will be destroyed "soon", either by an explicit call to
4209 FREETMPS, or by an implicit call at places such as statement boundaries.
4210 See also C<sv_mortalcopy> and C<sv_2mortal>.
4219 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
4222 SV* sv_newref(SV* sv)
4229 A private implementation of the C<SvNVx> macro for compilers which can't
4230 cope with complex macro expressions. Always use the macro instead.
4239 Converts the value pointed to by offsetp from a count of bytes from the
4240 start of the string, to a count of the equivalent number of UTF-8 chars.
4241 Handles magic and type coercion.
4243 void sv_pos_b2u(SV* sv, I32* offsetp)
4250 Converts the value pointed to by offsetp from a count of UTF-8 chars from
4251 the start of the string, to a count of the equivalent number of bytes; if
4252 lenp is non-zero, it does the same to lenp, but this time starting from
4253 the offset, rather than from the start of the string. Handles magic and
4256 void sv_pos_u2b(SV* sv, I32* offsetp, I32* lenp)
4263 Use the C<SvPV_nolen> macro instead
4272 Use C<SvPVbyte_nolen> instead.
4274 char* sv_pvbyte(SV *sv)
4281 A private implementation of the C<SvPVbyte> macro for compilers
4282 which can't cope with complex macro expressions. Always use the macro
4285 char* sv_pvbyten(SV *sv, STRLEN *len)
4290 =item sv_pvbyten_force
4292 A private implementation of the C<SvPVbytex_force> macro for compilers
4293 which can't cope with complex macro expressions. Always use the macro
4296 char* sv_pvbyten_force(SV* sv, STRLEN* lp)
4303 A private implementation of the C<SvPV> macro for compilers which can't
4304 cope with complex macro expressions. Always use the macro instead.
4306 char* sv_pvn(SV *sv, STRLEN *len)
4313 Get a sensible string out of the SV somehow.
4314 A private implementation of the C<SvPV_force> macro for compilers which
4315 can't cope with complex macro expressions. Always use the macro instead.
4317 char* sv_pvn_force(SV* sv, STRLEN* lp)
4322 =item sv_pvn_force_flags
4324 Get a sensible string out of the SV somehow.
4325 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
4326 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
4327 implemented in terms of this function.
4328 You normally want to use the various wrapper macros instead: see
4329 C<SvPV_force> and C<SvPV_force_nomg>
4331 char* sv_pvn_force_flags(SV* sv, STRLEN* lp, I32 flags)
4338 Use the C<SvPVutf8_nolen> macro instead
4340 char* sv_pvutf8(SV *sv)
4347 A private implementation of the C<SvPVutf8> macro for compilers
4348 which can't cope with complex macro expressions. Always use the macro
4351 char* sv_pvutf8n(SV *sv, STRLEN *len)
4356 =item sv_pvutf8n_force
4358 A private implementation of the C<SvPVutf8_force> macro for compilers
4359 which can't cope with complex macro expressions. Always use the macro
4362 char* sv_pvutf8n_force(SV* sv, STRLEN* lp)
4369 Returns a string describing what the SV is a reference to.
4371 char* sv_reftype(SV* sv, int ob)
4378 Make the first argument a copy of the second, then delete the original.
4379 The target SV physically takes over ownership of the body of the source SV
4380 and inherits its flags; however, the target keeps any magic it owns,
4381 and any magic in the source is discarded.
4382 Note that this is a rather specialist SV copying operation; most of the
4383 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4385 void sv_replace(SV* sv, SV* nsv)
4390 =item sv_report_used
4392 Dump the contents of all SVs not yet freed. (Debugging aid).
4394 void sv_report_used()
4401 Underlying implementation for the C<reset> Perl function.
4402 Note that the perl-level function is vaguely deprecated.
4404 void sv_reset(char* s, HV* stash)
4411 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4412 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4413 push a back-reference to this RV onto the array of backreferences
4414 associated with that magic.
4416 SV* sv_rvweaken(SV *sv)
4423 Copies an integer into the given SV, upgrading first if necessary.
4424 Does not handle 'set' magic. See also C<sv_setiv_mg>.
4426 void sv_setiv(SV* sv, IV num)
4433 Like C<sv_setiv>, but also handles 'set' magic.
4435 void sv_setiv_mg(SV *sv, IV i)
4442 Copies a double into the given SV, upgrading first if necessary.
4443 Does not handle 'set' magic. See also C<sv_setnv_mg>.
4445 void sv_setnv(SV* sv, NV num)
4452 Like C<sv_setnv>, but also handles 'set' magic.
4454 void sv_setnv_mg(SV *sv, NV num)
4461 Copies a string into an SV. The string must be null-terminated. Does not
4462 handle 'set' magic. See C<sv_setpv_mg>.
4464 void sv_setpv(SV* sv, const char* ptr)
4471 Works like C<sv_catpvf> but copies the text into the SV instead of
4472 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
4474 void sv_setpvf(SV* sv, const char* pat, ...)
4481 Like C<sv_setpvf>, but also handles 'set' magic.
4483 void sv_setpvf_mg(SV *sv, const char* pat, ...)
4490 Copies an integer into the given SV, also updating its string value.
4491 Does not handle 'set' magic. See C<sv_setpviv_mg>.
4493 void sv_setpviv(SV* sv, IV num)
4500 Like C<sv_setpviv>, but also handles 'set' magic.
4502 void sv_setpviv_mg(SV *sv, IV iv)
4509 Copies a string into an SV. The C<len> parameter indicates the number of
4510 bytes to be copied. If the C<ptr> argument is NULL the SV will become
4511 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4513 void sv_setpvn(SV* sv, const char* ptr, STRLEN len)
4520 Like C<sv_setpvn>, but also handles 'set' magic.
4522 void sv_setpvn_mg(SV *sv, const char *ptr, STRLEN len)
4529 Like C<sv_setpv>, but also handles 'set' magic.
4531 void sv_setpv_mg(SV *sv, const char *ptr)
4538 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
4539 argument will be upgraded to an RV. That RV will be modified to point to
4540 the new SV. The C<classname> argument indicates the package for the
4541 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4542 will have a reference count of 1, and the RV will be returned.
4544 SV* sv_setref_iv(SV* rv, const char* classname, IV iv)
4551 Copies a double into a new SV, optionally blessing the SV. The C<rv>
4552 argument will be upgraded to an RV. That RV will be modified to point to
4553 the new SV. The C<classname> argument indicates the package for the
4554 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4555 will have a reference count of 1, and the RV will be returned.
4557 SV* sv_setref_nv(SV* rv, const char* classname, NV nv)
4564 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
4565 argument will be upgraded to an RV. That RV will be modified to point to
4566 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
4567 into the SV. The C<classname> argument indicates the package for the
4568 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4569 will have a reference count of 1, and the RV will be returned.
4571 Do not use with other Perl types such as HV, AV, SV, CV, because those
4572 objects will become corrupted by the pointer copy process.
4574 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
4576 SV* sv_setref_pv(SV* rv, const char* classname, void* pv)
4583 Copies a string into a new SV, optionally blessing the SV. The length of the
4584 string must be specified with C<n>. The C<rv> argument will be upgraded to
4585 an RV. That RV will be modified to point to the new SV. The C<classname>
4586 argument indicates the package for the blessing. Set C<classname> to
4587 C<Nullch> to avoid the blessing. The new SV will have a reference count
4588 of 1, and the RV will be returned.
4590 Note that C<sv_setref_pv> copies the pointer while this copies the string.
4592 SV* sv_setref_pvn(SV* rv, const char* classname, char* pv, STRLEN n)
4599 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
4600 argument will be upgraded to an RV. That RV will be modified to point to
4601 the new SV. The C<classname> argument indicates the package for the
4602 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4603 will have a reference count of 1, and the RV will be returned.
4605 SV* sv_setref_uv(SV* rv, const char* classname, UV uv)
4612 Copies the contents of the source SV C<ssv> into the destination SV
4613 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4614 function if the source SV needs to be reused. Does not handle 'set' magic.
4615 Loosely speaking, it performs a copy-by-value, obliterating any previous
4616 content of the destination.
4618 You probably want to use one of the assortment of wrappers, such as
4619 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4620 C<SvSetMagicSV_nosteal>.
4622 void sv_setsv(SV* dsv, SV* ssv)
4627 =item sv_setsv_flags
4629 Copies the contents of the source SV C<ssv> into the destination SV
4630 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4631 function if the source SV needs to be reused. Does not handle 'set' magic.
4632 Loosely speaking, it performs a copy-by-value, obliterating any previous
4633 content of the destination.
4634 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
4635 C<ssv> if appropriate, else not. If the C<flags> parameter has the
4636 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
4637 and C<sv_setsv_nomg> are implemented in terms of this function.
4639 You probably want to use one of the assortment of wrappers, such as
4640 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4641 C<SvSetMagicSV_nosteal>.
4643 This is the primary function for copying scalars, and most other
4644 copy-ish functions and macros use this underneath.
4646 void sv_setsv_flags(SV* dsv, SV* ssv, I32 flags)
4653 Like C<sv_setsv>, but also handles 'set' magic.
4655 void sv_setsv_mg(SV *dstr, SV *sstr)
4662 Like C<sv_setsv> but doesn't process magic.
4664 void sv_setsv_nomg(SV* dsv, SV* ssv)
4671 Copies an unsigned integer into the given SV, upgrading first if necessary.
4672 Does not handle 'set' magic. See also C<sv_setuv_mg>.
4674 void sv_setuv(SV* sv, UV num)
4681 Like C<sv_setuv>, but also handles 'set' magic.
4683 void sv_setuv_mg(SV *sv, UV u)
4690 Taint an SV. Use C<SvTAINTED_on> instead.
4691 void sv_taint(SV* sv)
4698 Test an SV for taintedness. Use C<SvTAINTED> instead.
4699 bool sv_tainted(SV* sv)
4706 Returns true if the SV has a true value by Perl's rules.
4707 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
4708 instead use an in-line version.
4717 Removes all magic of type C<type> from an SV.
4719 int sv_unmagic(SV* sv, int type)
4726 Unsets the RV status of the SV, and decrements the reference count of
4727 whatever was being referenced by the RV. This can almost be thought of
4728 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
4729 being zero. See C<SvROK_off>.
4731 void sv_unref(SV* sv)
4736 =item sv_unref_flags
4738 Unsets the RV status of the SV, and decrements the reference count of
4739 whatever was being referenced by the RV. This can almost be thought of
4740 as a reversal of C<newSVrv>. The C<cflags> argument can contain
4741 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
4742 (otherwise the decrementing is conditional on the reference count being
4743 different from one or the reference being a readonly SV).
4746 void sv_unref_flags(SV* sv, U32 flags)
4753 Untaint an SV. Use C<SvTAINTED_off> instead.
4754 void sv_untaint(SV* sv)
4761 Upgrade an SV to a more complex form. Generally adds a new body type to the
4762 SV, then copies across as much information as possible from the old body.
4763 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
4765 bool sv_upgrade(SV* sv, U32 mt)
4772 Tells an SV to use C<ptr> to find its string value. Normally the string is
4773 stored inside the SV but sv_usepvn allows the SV to use an outside string.
4774 The C<ptr> should point to memory that was allocated by C<malloc>. The
4775 string length, C<len>, must be supplied. This function will realloc the
4776 memory pointed to by C<ptr>, so that pointer should not be freed or used by
4777 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
4778 See C<sv_usepvn_mg>.
4780 void sv_usepvn(SV* sv, char* ptr, STRLEN len)
4787 Like C<sv_usepvn>, but also handles 'set' magic.
4789 void sv_usepvn_mg(SV *sv, char *ptr, STRLEN len)
4794 =item sv_utf8_decode
4796 If the PV of the SV is an octet sequence in UTF-8
4797 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
4798 so that it looks like a character. If the PV contains only single-byte
4799 characters, the C<SvUTF8> flag stays being off.
4800 Scans PV for validity and returns false if the PV is invalid UTF-8.
4802 NOTE: this function is experimental and may change or be
4803 removed without notice.
4805 bool sv_utf8_decode(SV *sv)
4810 =item sv_utf8_downgrade
4812 Attempts to convert the PV of an SV from characters to bytes.
4813 If the PV contains a character beyond byte, this conversion will fail;
4814 in this case, either returns false or, if C<fail_ok> is not
4817 This is not as a general purpose Unicode to byte encoding interface:
4818 use the Encode extension for that.
4820 NOTE: this function is experimental and may change or be
4821 removed without notice.
4823 bool sv_utf8_downgrade(SV *sv, bool fail_ok)
4828 =item sv_utf8_encode
4830 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
4831 flag off so that it looks like octets again.
4833 void sv_utf8_encode(SV *sv)
4838 =item sv_utf8_upgrade
4840 Converts the PV of an SV to its UTF-8-encoded form.
4841 Forces the SV to string form if it is not already.
4842 Always sets the SvUTF8 flag to avoid future validity checks even
4843 if all the bytes have hibit clear.
4845 This is not as a general purpose byte encoding to Unicode interface:
4846 use the Encode extension for that.
4848 STRLEN sv_utf8_upgrade(SV *sv)
4853 =item sv_utf8_upgrade_flags
4855 Converts the PV of an SV to its UTF-8-encoded form.
4856 Forces the SV to string form if it is not already.
4857 Always sets the SvUTF8 flag to avoid future validity checks even
4858 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
4859 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
4860 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
4862 This is not as a general purpose byte encoding to Unicode interface:
4863 use the Encode extension for that.
4865 STRLEN sv_utf8_upgrade_flags(SV *sv, I32 flags)
4872 A private implementation of the C<SvUVx> macro for compilers which can't
4873 cope with complex macro expressions. Always use the macro instead.
4882 Processes its arguments like C<vsprintf> and appends the formatted output
4883 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
4885 Usually used via its frontend C<sv_catpvf>.
4887 void sv_vcatpvf(SV* sv, const char* pat, va_list* args)
4894 Processes its arguments like C<vsprintf> and appends the formatted output
4895 to an SV. Uses an array of SVs if the C style variable argument list is
4896 missing (NULL). When running with taint checks enabled, indicates via
4897 C<maybe_tainted> if results are untrustworthy (often due to the use of
4900 XXX Except that it maybe_tainted is never assigned to.
4902 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
4904 void sv_vcatpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
4911 Like C<sv_vcatpvf>, but also handles 'set' magic.
4913 Usually used via its frontend C<sv_catpvf_mg>.
4915 void sv_vcatpvf_mg(SV* sv, const char* pat, va_list* args)
4922 Works like C<sv_vcatpvf> but copies the text into the SV instead of
4923 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
4925 Usually used via its frontend C<sv_setpvf>.
4927 void sv_vsetpvf(SV* sv, const char* pat, va_list* args)
4934 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
4937 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
4939 void sv_vsetpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
4946 Like C<sv_vsetpvf>, but also handles 'set' magic.
4948 Usually used via its frontend C<sv_setpvf_mg>.
4950 void sv_vsetpvf_mg(SV* sv, const char* pat, va_list* args)
4958 =head1 Unicode Support
4962 =item bytes_from_utf8
4964 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
4965 Unlike C<utf8_to_bytes> but like C<bytes_to_utf8>, returns a pointer to
4966 the newly-created string, and updates C<len> to contain the new
4967 length. Returns the original string if no conversion occurs, C<len>
4968 is unchanged. Do nothing if C<is_utf8> points to 0. Sets C<is_utf8> to
4969 0 if C<s> is converted or contains all 7bit characters.
4971 NOTE: this function is experimental and may change or be
4972 removed without notice.
4974 U8* bytes_from_utf8(U8 *s, STRLEN *len, bool *is_utf8)
4977 Found in file utf8.c
4981 Converts a string C<s> of length C<len> from ASCII into UTF-8 encoding.
4982 Returns a pointer to the newly-created string, and sets C<len> to
4983 reflect the new length.
4985 If you want to convert to UTF-8 from other encodings than ASCII,
4986 see sv_recode_to_utf8().
4988 NOTE: this function is experimental and may change or be
4989 removed without notice.
4991 U8* bytes_to_utf8(U8 *s, STRLEN *len)
4994 Found in file utf8.c
4998 Return true if the strings s1 and s2 differ case-insensitively, false
4999 if not (if they are equal case-insensitively). If u1 is true, the
5000 string s1 is assumed to be in UTF-8-encoded Unicode. If u2 is true,
5001 the string s2 is assumed to be in UTF-8-encoded Unicode. If u1 or u2
5002 are false, the respective string is assumed to be in native 8-bit
5005 If the pe1 and pe2 are non-NULL, the scanning pointers will be copied
5006 in there (they will point at the beginning of the I<next> character).
5007 If the pointers behind pe1 or pe2 are non-NULL, they are the end
5008 pointers beyond which scanning will not continue under any
5009 circumstances. If the byte lengths l1 and l2 are non-zero, s1+l1 and
5010 s2+l2 will be used as goal end pointers that will also stop the scan,
5011 and which qualify towards defining a successful match: all the scans
5012 that define an explicit length must reach their goal pointers for
5013 a match to succeed).
5015 For case-insensitiveness, the "casefolding" of Unicode is used
5016 instead of upper/lowercasing both the characters, see
5017 http://www.unicode.org/unicode/reports/tr21/ (Case Mappings).
5019 I32 ibcmp_utf8(const char* a, char **pe1, UV l1, bool u1, const char* b, char **pe2, UV l2, bool u2)
5022 Found in file utf8.c
5026 Tests if some arbitrary number of bytes begins in a valid UTF-8
5027 character. Note that an INVARIANT (i.e. ASCII) character is a valid
5028 UTF-8 character. The actual number of bytes in the UTF-8 character
5029 will be returned if it is valid, otherwise 0.
5031 STRLEN is_utf8_char(U8 *p)
5034 Found in file utf8.c
5036 =item is_utf8_string
5038 Returns true if first C<len> bytes of the given string form a valid
5039 UTF-8 string, false otherwise. Note that 'a valid UTF-8 string' does
5040 not mean 'a string that contains code points above 0x7F encoded in UTF-8'
5041 because a valid ASCII string is a valid UTF-8 string.
5043 bool is_utf8_string(U8 *s, STRLEN len)
5046 Found in file utf8.c
5048 =item is_utf8_string_loc
5050 Like is_ut8_string but store the location of the failure in
5053 bool is_utf8_string_loc(U8 *s, STRLEN len, U8 **p)
5056 Found in file utf8.c
5058 =item pv_uni_display
5060 Build to the scalar dsv a displayable version of the string spv,
5061 length len, the displayable version being at most pvlim bytes long
5062 (if longer, the rest is truncated and "..." will be appended).
5064 The flags argument can have UNI_DISPLAY_ISPRINT set to display
5065 isPRINT()able characters as themselves, UNI_DISPLAY_BACKSLASH
5066 to display the \\[nrfta\\] as the backslashed versions (like '\n')
5067 (UNI_DISPLAY_BACKSLASH is preferred over UNI_DISPLAY_ISPRINT for \\).
5068 UNI_DISPLAY_QQ (and its alias UNI_DISPLAY_REGEX) have both
5069 UNI_DISPLAY_BACKSLASH and UNI_DISPLAY_ISPRINT turned on.
5071 The pointer to the PV of the dsv is returned.
5073 char* pv_uni_display(SV *dsv, U8 *spv, STRLEN len, STRLEN pvlim, UV flags)
5076 Found in file utf8.c
5080 The encoding is assumed to be an Encode object, the PV of the ssv is
5081 assumed to be octets in that encoding and decoding the input starts
5082 from the position which (PV + *offset) pointed to. The dsv will be
5083 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
5084 when the string tstr appears in decoding output or the input ends on
5085 the PV of the ssv. The value which the offset points will be modified
5086 to the last input position on the ssv.
5088 Returns TRUE if the terminator was found, else returns FALSE.
5090 bool sv_cat_decode(SV* dsv, SV *encoding, SV *ssv, int *offset, char* tstr, int tlen)
5095 =item sv_recode_to_utf8
5097 The encoding is assumed to be an Encode object, on entry the PV
5098 of the sv is assumed to be octets in that encoding, and the sv
5099 will be converted into Unicode (and UTF-8).
5101 If the sv already is UTF-8 (or if it is not POK), or if the encoding
5102 is not a reference, nothing is done to the sv. If the encoding is not
5103 an C<Encode::XS> Encoding object, bad things will happen.
5104 (See F<lib/encoding.pm> and L<Encode>).
5106 The PV of the sv is returned.
5108 char* sv_recode_to_utf8(SV* sv, SV *encoding)
5113 =item sv_uni_display
5115 Build to the scalar dsv a displayable version of the scalar sv,
5116 the displayable version being at most pvlim bytes long
5117 (if longer, the rest is truncated and "..." will be appended).
5119 The flags argument is as in pv_uni_display().
5121 The pointer to the PV of the dsv is returned.
5123 char* sv_uni_display(SV *dsv, SV *ssv, STRLEN pvlim, UV flags)
5126 Found in file utf8.c
5130 The "p" contains the pointer to the UTF-8 string encoding
5131 the character that is being converted.
5133 The "ustrp" is a pointer to the character buffer to put the
5134 conversion result to. The "lenp" is a pointer to the length
5137 The "swashp" is a pointer to the swash to use.
5139 Both the special and normal mappings are stored lib/unicore/To/Foo.pl,
5140 and loaded by SWASHGET, using lib/utf8_heavy.pl. The special (usually,
5141 but not always, a multicharacter mapping), is tried first.
5143 The "special" is a string like "utf8::ToSpecLower", which means the
5144 hash %utf8::ToSpecLower. The access to the hash is through
5145 Perl_to_utf8_case().
5147 The "normal" is a string like "ToLower" which means the swash
5150 UV to_utf8_case(U8 *p, U8* ustrp, STRLEN *lenp, SV **swash, char *normal, char *special)
5153 Found in file utf8.c
5157 Convert the UTF-8 encoded character at p to its foldcase version and
5158 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
5159 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
5160 foldcase version may be longer than the original character (up to
5163 The first character of the foldcased version is returned
5164 (but note, as explained above, that there may be more.)
5166 UV to_utf8_fold(U8 *p, U8* ustrp, STRLEN *lenp)
5169 Found in file utf8.c
5173 Convert the UTF-8 encoded character at p to its lowercase version and
5174 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
5175 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
5176 lowercase version may be longer than the original character.
5178 The first character of the lowercased version is returned
5179 (but note, as explained above, that there may be more.)
5181 UV to_utf8_lower(U8 *p, U8* ustrp, STRLEN *lenp)
5184 Found in file utf8.c
5188 Convert the UTF-8 encoded character at p to its titlecase version and
5189 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
5190 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
5191 titlecase version may be longer than the original character.
5193 The first character of the titlecased version is returned
5194 (but note, as explained above, that there may be more.)
5196 UV to_utf8_title(U8 *p, U8* ustrp, STRLEN *lenp)
5199 Found in file utf8.c
5203 Convert the UTF-8 encoded character at p to its uppercase version and
5204 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
5205 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since
5206 the uppercase version may be longer than the original character.
5208 The first character of the uppercased version is returned
5209 (but note, as explained above, that there may be more.)
5211 UV to_utf8_upper(U8 *p, U8* ustrp, STRLEN *lenp)
5214 Found in file utf8.c
5216 =item utf8n_to_uvchr
5218 Returns the native character value of the first character in the string C<s>
5219 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
5220 length, in bytes, of that character.
5222 Allows length and flags to be passed to low level routine.
5224 UV utf8n_to_uvchr(U8 *s, STRLEN curlen, STRLEN* retlen, U32 flags)
5227 Found in file utf8.c
5229 =item utf8n_to_uvuni
5231 Bottom level UTF-8 decode routine.
5232 Returns the unicode code point value of the first character in the string C<s>
5233 which is assumed to be in UTF-8 encoding and no longer than C<curlen>;
5234 C<retlen> will be set to the length, in bytes, of that character.
5236 If C<s> does not point to a well-formed UTF-8 character, the behaviour
5237 is dependent on the value of C<flags>: if it contains UTF8_CHECK_ONLY,
5238 it is assumed that the caller will raise a warning, and this function
5239 will silently just set C<retlen> to C<-1> and return zero. If the
5240 C<flags> does not contain UTF8_CHECK_ONLY, warnings about
5241 malformations will be given, C<retlen> will be set to the expected
5242 length of the UTF-8 character in bytes, and zero will be returned.
5244 The C<flags> can also contain various flags to allow deviations from
5245 the strict UTF-8 encoding (see F<utf8.h>).
5247 Most code should use utf8_to_uvchr() rather than call this directly.
5249 UV utf8n_to_uvuni(U8 *s, STRLEN curlen, STRLEN* retlen, U32 flags)
5252 Found in file utf8.c
5256 Returns the number of UTF-8 characters between the UTF-8 pointers C<a>
5259 WARNING: use only if you *know* that the pointers point inside the
5262 IV utf8_distance(U8 *a, U8 *b)
5265 Found in file utf8.c
5269 Return the UTF-8 pointer C<s> displaced by C<off> characters, either
5270 forward or backward.
5272 WARNING: do not use the following unless you *know* C<off> is within
5273 the UTF-8 data pointed to by C<s> *and* that on entry C<s> is aligned
5274 on the first byte of character or just after the last byte of a character.
5276 U8* utf8_hop(U8 *s, I32 off)
5279 Found in file utf8.c
5283 Return the length of the UTF-8 char encoded string C<s> in characters.
5284 Stops at C<e> (inclusive). If C<e E<lt> s> or if the scan would end
5285 up past C<e>, croaks.
5287 STRLEN utf8_length(U8* s, U8 *e)
5290 Found in file utf8.c
5294 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
5295 Unlike C<bytes_to_utf8>, this over-writes the original string, and
5296 updates len to contain the new length.
5297 Returns zero on failure, setting C<len> to -1.
5299 NOTE: this function is experimental and may change or be
5300 removed without notice.
5302 U8* utf8_to_bytes(U8 *s, STRLEN *len)
5305 Found in file utf8.c
5309 Returns the native character value of the first character in the string C<s>
5310 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
5311 length, in bytes, of that character.
5313 If C<s> does not point to a well-formed UTF-8 character, zero is
5314 returned and retlen is set, if possible, to -1.
5316 UV utf8_to_uvchr(U8 *s, STRLEN* retlen)
5319 Found in file utf8.c
5323 Returns the Unicode code point of the first character in the string C<s>
5324 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
5325 length, in bytes, of that character.
5327 This function should only be used when returned UV is considered
5328 an index into the Unicode semantic tables (e.g. swashes).
5330 If C<s> does not point to a well-formed UTF-8 character, zero is
5331 returned and retlen is set, if possible, to -1.
5333 UV utf8_to_uvuni(U8 *s, STRLEN* retlen)
5336 Found in file utf8.c
5340 Adds the UTF-8 representation of the Native codepoint C<uv> to the end
5341 of the string C<d>; C<d> should be have at least C<UTF8_MAXBYTES+1> free
5342 bytes available. The return value is the pointer to the byte after the
5343 end of the new character. In other words,
5345 d = uvchr_to_utf8(d, uv);
5347 is the recommended wide native character-aware way of saying
5351 U8* uvchr_to_utf8(U8 *d, UV uv)
5354 Found in file utf8.c
5356 =item uvuni_to_utf8_flags
5358 Adds the UTF-8 representation of the Unicode codepoint C<uv> to the end
5359 of the string C<d>; C<d> should be have at least C<UTF8_MAXBYTES+1> free
5360 bytes available. The return value is the pointer to the byte after the
5361 end of the new character. In other words,
5363 d = uvuni_to_utf8_flags(d, uv, flags);
5367 d = uvuni_to_utf8(d, uv);
5369 (which is equivalent to)
5371 d = uvuni_to_utf8_flags(d, uv, 0);
5373 is the recommended Unicode-aware way of saying
5377 U8* uvuni_to_utf8_flags(U8 *d, UV uv, UV flags)
5380 Found in file utf8.c
5385 =head1 Variables created by C<xsubpp> and C<xsubpp> internal functions
5391 Variable which is setup by C<xsubpp> to indicate the stack base offset,
5392 used by the C<ST>, C<XSprePUSH> and C<XSRETURN> macros. The C<dMARK> macro
5393 must be called prior to setup the C<MARK> variable.
5398 Found in file XSUB.h
5402 Variable which is setup by C<xsubpp> to indicate the
5403 class name for a C++ XS constructor. This is always a C<char*>. See C<THIS>.
5408 Found in file XSUB.h
5412 Sets up the C<ax> variable.
5413 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
5418 Found in file XSUB.h
5422 Sets up the C<ax> variable and stack marker variable C<mark>.
5423 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
5428 Found in file XSUB.h
5432 Sets up the C<items> variable.
5433 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
5438 Found in file XSUB.h
5442 Sets up stack and mark pointers for an XSUB, calling dSP and dMARK.
5443 Sets up the C<ax> and C<items> variables by calling C<dAX> and C<dITEMS>.
5444 This is usually handled automatically by C<xsubpp>.
5449 Found in file XSUB.h
5453 Sets up the C<ix> variable for an XSUB which has aliases. This is usually
5454 handled automatically by C<xsubpp>.
5459 Found in file XSUB.h
5463 Variable which is setup by C<xsubpp> to indicate the number of
5464 items on the stack. See L<perlxs/"Variable-length Parameter Lists">.
5469 Found in file XSUB.h
5473 Variable which is setup by C<xsubpp> to indicate which of an
5474 XSUB's aliases was used to invoke it. See L<perlxs/"The ALIAS: Keyword">.
5479 Found in file XSUB.h
5483 Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
5487 Found in file XSUB.h
5491 Variable which is setup by C<xsubpp> to hold the return value for an
5492 XSUB. This is always the proper type for the XSUB. See
5493 L<perlxs/"The RETVAL Variable">.
5498 Found in file XSUB.h
5502 Used to access elements on the XSUB's stack.
5507 Found in file XSUB.h
5511 Variable which is setup by C<xsubpp> to designate the object in a C++
5512 XSUB. This is always the proper type for the C++ object. See C<CLASS> and
5513 L<perlxs/"Using XS With C++">.
5518 Found in file XSUB.h
5522 Macro to declare an XSUB and its C parameter list. This is handled by
5526 Found in file XSUB.h
5530 The version identifier for an XS module. This is usually
5531 handled automatically by C<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>.
5534 Found in file XSUB.h
5536 =item XS_VERSION_BOOTCHECK
5538 Macro to verify that a PM module's $VERSION variable matches the XS
5539 module's C<XS_VERSION> variable. This is usually handled automatically by
5540 C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">.
5542 XS_VERSION_BOOTCHECK;
5545 Found in file XSUB.h
5550 =head1 Warning and Dieing
5556 This is the XSUB-writer's interface to Perl's C<die> function.
5557 Normally call this function the same way you call the C C<printf>
5558 function. Calling C<croak> returns control directly to Perl,
5559 sidestepping the normal C order of execution. See C<warn>.
5561 If you want to throw an exception object, assign the object to
5562 C<$@> and then pass C<Nullch> to croak():
5564 errsv = get_sv("@", TRUE);
5565 sv_setsv(errsv, exception_object);
5568 void croak(const char* pat, ...)
5571 Found in file util.c
5575 This is the XSUB-writer's interface to Perl's C<warn> function. Call this
5576 function the same way you call the C C<printf> function. See C<croak>.
5578 void warn(const char* pat, ...)
5581 Found in file util.c
5588 Until May 1997, this document was maintained by Jeff Okamoto
5589 <okamoto@corp.hp.com>. It is now maintained as part of Perl itself.
5591 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
5592 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
5593 Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
5594 Stephen McCamant, and Gurusamy Sarathy.
5596 API Listing originally by Dean Roehrich <roehrich@cray.com>.
5598 Updated to be autogenerated from comments in the source by Benjamin Stuhl.
5602 perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
https://perl5.git.perl.org / perl5.git / blob