3 perlapi - autogenerated documentation for the perl public API
6 X<Perl API> X<API> X<api>
8 This file contains the documentation of the perl public API generated by
9 embed.pl, specifically a listing of functions, macros, flags, and variables
10 that may be used by extension writers. The interfaces of any functions that
11 are not listed here are subject to change without notice. For this reason,
12 blindly using functions listed in proto.h is to be avoided when writing
15 Note that all Perl API global variables must be referenced with the C<PL_>
16 prefix. Some macros are provided for compatibility with the older,
17 unadorned names, but this support may be disabled in a future release.
19 The listing is alphabetical, case insensitive.
29 A backward-compatible version of C<GIMME_V> which can only return
30 C<G_SCALAR> or C<G_ARRAY>; in a void context, it returns C<G_SCALAR>.
31 Deprecated. Use C<GIMME_V> instead.
41 The XSUB-writer's equivalent to Perl's C<wantarray>. Returns C<G_VOID>,
42 C<G_SCALAR> or C<G_ARRAY> for void, scalar or list context,
53 Used to indicate list context. See C<GIMME_V>, C<GIMME> and
62 Indicates that arguments returned from a callback should be discarded. See
71 Used to force a Perl C<eval> wrapper around a callback. See
80 Indicates that no arguments are being sent to a callback. See
89 Used to indicate scalar context. See C<GIMME_V>, C<GIMME>, and
98 Used to indicate void context. See C<GIMME_V> and L<perlcall>.
106 =head1 Array Manipulation Functions
113 Same as C<av_len()>. Deprecated, use C<av_len()> instead.
123 Clears an array, making it empty. Does not free the memory used by the
126 void av_clear(AV* ar)
134 Deletes the element indexed by C<key> from the array. Returns the
135 deleted element. If C<flags> equals C<G_DISCARD>, the element is freed
136 and null is returned.
138 SV* av_delete(AV* ar, I32 key, I32 flags)
146 Returns true if the element indexed by C<key> has been initialized.
148 This relies on the fact that uninitialized array elements are set to
151 bool av_exists(AV* ar, I32 key)
159 Pre-extend an array. The C<key> is the index to which the array should be
162 void av_extend(AV* ar, I32 key)
170 Returns the SV at the specified index in the array. The C<key> is the
171 index. If C<lval> is set then the fetch will be part of a store. Check
172 that the return value is non-null before dereferencing it to a C<SV*>.
174 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for
175 more information on how to use this function on tied arrays.
177 SV** av_fetch(AV* ar, I32 key, I32 lval)
185 Ensure than an array has a given number of elements, equivalent to
186 Perl's C<$#array = $fill;>.
188 void av_fill(AV* ar, I32 fill)
196 Returns the highest index in the array. Returns -1 if the array is
207 Creates a new AV and populates it with a list of SVs. The SVs are copied
208 into the array, so they may be freed after the call to av_make. The new AV
209 will have a reference count of 1.
211 AV* av_make(I32 size, SV** svp)
219 Pops an SV off the end of the array. Returns C<&PL_sv_undef> if the array
230 Pushes an SV onto the end of the array. The array will grow automatically
231 to accommodate the addition.
233 void av_push(AV* ar, SV* val)
241 Shifts an SV off the beginning of the array.
251 Stores an SV in an array. The array index is specified as C<key>. The
252 return value will be NULL if the operation failed or if the value did not
253 need to be actually stored within the array (as in the case of tied
254 arrays). Otherwise it can be dereferenced to get the original C<SV*>. Note
255 that the caller is responsible for suitably incrementing the reference
256 count of C<val> before the call, and decrementing it if the function
259 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for
260 more information on how to use this function on tied arrays.
262 SV** av_store(AV* ar, I32 key, SV* val)
270 Undefines the array. Frees the memory used by the array itself.
272 void av_undef(AV* ar)
280 Unshift the given number of C<undef> values onto the beginning of the
281 array. The array will grow automatically to accommodate the addition. You
282 must then use C<av_store> to assign values to these new elements.
284 void av_unshift(AV* ar, I32 num)
292 Returns the AV of the specified Perl array. If C<create> is set and the
293 Perl variable does not exist then it will be created. If C<create> is not
294 set and the variable does not exist then NULL is returned.
296 NOTE: the perl_ form of this function is deprecated.
298 AV* get_av(const char* name, I32 create)
306 Creates a new AV. The reference count is set to 1.
316 Sort an array. Here is an example:
318 sortsv(AvARRAY(av), av_len(av)+1, Perl_sv_cmp_locale);
320 See lib/sort.pm for details about controlling the sorting algorithm.
322 void sortsv(SV** array, size_t num_elts, SVCOMPARE_t cmp)
325 Found in file pp_sort.c
330 =head1 Callback Functions
337 Performs a callback to the specified Perl sub. See L<perlcall>.
339 NOTE: the perl_ form of this function is deprecated.
341 I32 call_argv(const char* sub_name, I32 flags, char** argv)
349 Performs a callback to the specified Perl method. The blessed object must
350 be on the stack. See L<perlcall>.
352 NOTE: the perl_ form of this function is deprecated.
354 I32 call_method(const char* methname, I32 flags)
362 Performs a callback to the specified Perl sub. See L<perlcall>.
364 NOTE: the perl_ form of this function is deprecated.
366 I32 call_pv(const char* sub_name, I32 flags)
374 Performs a callback to the Perl sub whose name is in the SV. See
377 NOTE: the perl_ form of this function is deprecated.
379 I32 call_sv(SV* sv, I32 flags)
387 Opening bracket on a callback. See C<LEAVE> and L<perlcall>.
392 Found in file scope.h
397 Tells Perl to C<eval> the given string and return an SV* result.
399 NOTE: the perl_ form of this function is deprecated.
401 SV* eval_pv(const char* p, I32 croak_on_error)
409 Tells Perl to C<eval> the string in the SV.
411 NOTE: the perl_ form of this function is deprecated.
413 I32 eval_sv(SV* sv, I32 flags)
421 Closing bracket for temporaries on a callback. See C<SAVETMPS> and
427 Found in file scope.h
432 Closing bracket on a callback. See C<ENTER> and L<perlcall>.
437 Found in file scope.h
442 Opening bracket for temporaries on a callback. See C<FREETMPS> and
448 Found in file scope.h
453 =head1 Character classes
460 Returns a boolean indicating whether the C C<char> is an ASCII alphanumeric
461 character (including underscore) or digit.
463 bool isALNUM(char ch)
466 Found in file handy.h
471 Returns a boolean indicating whether the C C<char> is an ASCII alphabetic
474 bool isALPHA(char ch)
477 Found in file handy.h
482 Returns a boolean indicating whether the C C<char> is an ASCII
485 bool isDIGIT(char ch)
488 Found in file handy.h
493 Returns a boolean indicating whether the C C<char> is a lowercase
496 bool isLOWER(char ch)
499 Found in file handy.h
504 Returns a boolean indicating whether the C C<char> is whitespace.
506 bool isSPACE(char ch)
509 Found in file handy.h
514 Returns a boolean indicating whether the C C<char> is an uppercase
517 bool isUPPER(char ch)
520 Found in file handy.h
525 Converts the specified character to lowercase.
527 char toLOWER(char ch)
530 Found in file handy.h
535 Converts the specified character to uppercase.
537 char toUPPER(char ch)
540 Found in file handy.h
545 =head1 Cloning an interpreter
552 Create and return a new interpreter by cloning the current one.
554 perl_clone takes these flags as parameters:
556 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
557 without it we only clone the data and zero the stacks,
558 with it we copy the stacks and the new perl interpreter is
559 ready to run at the exact same point as the previous one.
560 The pseudo-fork code uses COPY_STACKS while the
561 threads->new doesn't.
563 CLONEf_KEEP_PTR_TABLE
564 perl_clone keeps a ptr_table with the pointer of the old
565 variable as a key and the new variable as a value,
566 this allows it to check if something has been cloned and not
567 clone it again but rather just use the value and increase the
568 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
569 the ptr_table using the function
570 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
571 reason to keep it around is if you want to dup some of your own
572 variable who are outside the graph perl scans, example of this
573 code is in threads.xs create
576 This is a win32 thing, it is ignored on unix, it tells perls
577 win32host code (which is c++) to clone itself, this is needed on
578 win32 if you want to run two threads at the same time,
579 if you just want to do some stuff in a separate perl interpreter
580 and then throw it away and return to the original one,
581 you don't need to do anything.
583 PerlInterpreter* perl_clone(PerlInterpreter* interp, UV flags)
591 =head1 CV Manipulation Functions
598 Returns the stash of the CV.
608 Returns the CV of the specified Perl subroutine. If C<create> is set and
609 the Perl subroutine does not exist then it will be declared (which has the
610 same effect as saying C<sub name;>). If C<create> is not set and the
611 subroutine does not exist then NULL is returned.
613 NOTE: the perl_ form of this function is deprecated.
615 CV* get_cv(const char* name, I32 create)
623 =head1 Embedding Functions
630 Clear out all the active components of a CV. This can happen either
631 by an explicit C<undef &foo>, or by the reference count going to zero.
632 In the former case, we keep the CvOUTSIDE pointer, so that any anonymous
633 children can still follow the full lexical scope chain.
635 void cv_undef(CV* cv)
643 Loads the module whose name is pointed to by the string part of name.
644 Note that the actual module name, not its filename, should be given.
645 Eg, "Foo::Bar" instead of "Foo/Bar.pm". flags can be any of
646 PERL_LOADMOD_DENY, PERL_LOADMOD_NOIMPORT, or PERL_LOADMOD_IMPORT_OPS
647 (or 0 for no flags). ver, if specified, provides version semantics
648 similar to C<use Foo::Bar VERSION>. The optional trailing SV*
649 arguments can be used to specify arguments to the module's import()
650 method, similar to C<use Foo::Bar VERSION LIST>.
652 void load_module(U32 flags, SV* name, SV* ver, ...)
660 Stub that provides thread hook for perl_destruct when there are
671 Allocates a new Perl interpreter. See L<perlembed>.
673 PerlInterpreter* perl_alloc()
681 Initializes a new Perl interpreter. See L<perlembed>.
683 void perl_construct(PerlInterpreter* interp)
691 Shuts down a Perl interpreter. See L<perlembed>.
693 int perl_destruct(PerlInterpreter* interp)
701 Releases a Perl interpreter. See L<perlembed>.
703 void perl_free(PerlInterpreter* interp)
711 Tells a Perl interpreter to parse a Perl script. See L<perlembed>.
713 int perl_parse(PerlInterpreter* interp, XSINIT_t xsinit, int argc, char** argv, char** env)
721 Tells a Perl interpreter to run. See L<perlembed>.
723 int perl_run(PerlInterpreter* interp)
731 Tells Perl to C<require> the file named by the string argument. It is
732 analogous to the Perl code C<eval "require '$file'">. It's even
733 implemented that way; consider using load_module instead.
735 NOTE: the perl_ form of this function is deprecated.
737 void require_pv(const char* pv)
745 =head1 Functions in file pp_pack.c
753 The engine implementing pack() Perl function.
755 void packlist(SV *cat, char *pat, char *patend, SV **beglist, SV **endlist)
758 Found in file pp_pack.c
763 The engine implementing pack() Perl function. Note: parameters next_in_list and
764 flags are not used. This call should not be used; use packlist instead.
766 void pack_cat(SV *cat, char *pat, char *patend, SV **beglist, SV **endlist, SV ***next_in_list, U32 flags)
769 Found in file pp_pack.c
774 The engine implementing unpack() Perl function. C<unpackstring> puts the
775 extracted list items on the stack and returns the number of elements.
776 Issue C<PUTBACK> before and C<SPAGAIN> after the call to this function.
778 I32 unpackstring(char *pat, char *patend, char *s, char *strend, U32 flags)
781 Found in file pp_pack.c
786 The engine implementing unpack() Perl function. Note: parameters strbeg, new_s
787 and ocnt are not used. This call should not be used, use unpackstring instead.
789 I32 unpack_str(char *pat, char *patend, char *s, char *strbeg, char *strend, char **new_s, I32 ocnt, U32 flags)
792 Found in file pp_pack.c
797 =head1 Global Variables
804 C<PL_modglobal> is a general purpose, interpreter global HV for use by
805 extensions that need to keep information on a per-interpreter basis.
806 In a pinch, it can also be used as a symbol table for extensions
807 to share data among each other. It is a good idea to use keys
808 prefixed by the package name of the extension that owns the data.
813 Found in file intrpvar.h
818 A convenience variable which is typically used with C<SvPV> when one
819 doesn't care about the length of the string. It is usually more efficient
820 to either declare a local variable and use that instead or to use the
826 Found in file thrdvar.h
831 This is the C<false> SV. See C<PL_sv_yes>. Always refer to this as
837 Found in file intrpvar.h
842 This is the C<undef> SV. Always refer to this as C<&PL_sv_undef>.
847 Found in file intrpvar.h
852 This is the C<true> SV. See C<PL_sv_no>. Always refer to this as
858 Found in file intrpvar.h
870 Return the SV from the GV.
880 Returns the glob with the given C<name> and a defined subroutine or
881 C<NULL>. The glob lives in the given C<stash>, or in the stashes
882 accessible via @ISA and UNIVERSAL::.
884 The argument C<level> should be either 0 or -1. If C<level==0>, as a
885 side-effect creates a glob with the given C<name> in the given C<stash>
886 which in the case of success contains an alias for the subroutine, and sets
887 up caching info for this glob. Similarly for all the searched stashes.
889 This function grants C<"SUPER"> token as a postfix of the stash name. The
890 GV returned from C<gv_fetchmeth> may be a method cache entry, which is not
891 visible to Perl code. So when calling C<call_sv>, you should not use
892 the GV directly; instead, you should use the method's CV, which can be
893 obtained from the GV with the C<GvCV> macro.
895 GV* gv_fetchmeth(HV* stash, const char* name, STRLEN len, I32 level)
903 See L<gv_fetchmethod_autoload>.
905 GV* gv_fetchmethod(HV* stash, const char* name)
910 =item gv_fetchmethod_autoload
911 X<gv_fetchmethod_autoload>
913 Returns the glob which contains the subroutine to call to invoke the method
914 on the C<stash>. In fact in the presence of autoloading this may be the
915 glob for "AUTOLOAD". In this case the corresponding variable $AUTOLOAD is
918 The third parameter of C<gv_fetchmethod_autoload> determines whether
919 AUTOLOAD lookup is performed if the given method is not present: non-zero
920 means yes, look for AUTOLOAD; zero means no, don't look for AUTOLOAD.
921 Calling C<gv_fetchmethod> is equivalent to calling C<gv_fetchmethod_autoload>
922 with a non-zero C<autoload> parameter.
924 These functions grant C<"SUPER"> token as a prefix of the method name. Note
925 that if you want to keep the returned glob for a long time, you need to
926 check for it being "AUTOLOAD", since at the later time the call may load a
927 different subroutine due to $AUTOLOAD changing its value. Use the glob
928 created via a side effect to do this.
930 These functions have the same side-effects and as C<gv_fetchmeth> with
931 C<level==0>. C<name> should be writable if contains C<':'> or C<'
932 ''>. The warning against passing the GV returned by C<gv_fetchmeth> to
933 C<call_sv> apply equally to these functions.
935 GV* gv_fetchmethod_autoload(HV* stash, const char* name, I32 autoload)
940 =item gv_fetchmeth_autoload
941 X<gv_fetchmeth_autoload>
943 Same as gv_fetchmeth(), but looks for autoloaded subroutines too.
944 Returns a glob for the subroutine.
946 For an autoloaded subroutine without a GV, will create a GV even
947 if C<level < 0>. For an autoloaded subroutine without a stub, GvCV()
948 of the result may be zero.
950 GV* gv_fetchmeth_autoload(HV* stash, const char* name, STRLEN len, I32 level)
958 Returns a pointer to the stash for a specified package. C<name> should
959 be a valid UTF-8 string and must be null-terminated. If C<create> is set
960 then the package will be created if it does not already exist. If C<create>
961 is not set and the package does not exist then NULL is returned.
963 HV* gv_stashpv(const char* name, I32 create)
971 Returns a pointer to the stash for a specified package. C<name> should
972 be a valid UTF-8 string. The C<namelen> parameter indicates the length of
973 the C<name>, in bytes. If C<create> is set then the package will be
974 created if it does not already exist. If C<create> is not set and the
975 package does not exist then NULL is returned.
977 HV* gv_stashpvn(const char* name, U32 namelen, I32 create)
985 Returns a pointer to the stash for a specified package, which must be a
986 valid UTF-8 string. See C<gv_stashpv>.
988 HV* gv_stashsv(SV* sv, I32 create)
1011 Null character pointer.
1014 Found in file handy.h
1038 Found in file handy.h
1043 =head1 Hash Manipulation Functions
1050 Returns the HV of the specified Perl hash. If C<create> is set and the
1051 Perl variable does not exist then it will be created. If C<create> is not
1052 set and the variable does not exist then NULL is returned.
1054 NOTE: the perl_ form of this function is deprecated.
1056 HV* get_hv(const char* name, I32 create)
1059 Found in file perl.c
1064 This flag, used in the length slot of hash entries and magic structures,
1065 specifies the structure contains an C<SV*> pointer where a C<char*> pointer
1066 is to be expected. (For information only--not to be used).
1074 Returns the computed hash stored in the hash entry.
1084 Returns the actual pointer stored in the key slot of the hash entry. The
1085 pointer may be either C<char*> or C<SV*>, depending on the value of
1086 C<HeKLEN()>. Can be assigned to. The C<HePV()> or C<HeSVKEY()> macros are
1087 usually preferable for finding the value of a key.
1097 If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry
1098 holds an C<SV*> key. Otherwise, holds the actual length of the key. Can
1099 be assigned to. The C<HePV()> macro is usually preferable for finding key
1102 STRLEN HeKLEN(HE* he)
1110 Returns the key slot of the hash entry as a C<char*> value, doing any
1111 necessary dereferencing of possibly C<SV*> keys. The length of the string
1112 is placed in C<len> (this is a macro, so do I<not> use C<&len>). If you do
1113 not care about what the length of the key is, you may use the global
1114 variable C<PL_na>, though this is rather less efficient than using a local
1115 variable. Remember though, that hash keys in perl are free to contain
1116 embedded nulls, so using C<strlen()> or similar is not a good way to find
1117 the length of hash keys. This is very similar to the C<SvPV()> macro
1118 described elsewhere in this document.
1120 char* HePV(HE* he, STRLEN len)
1128 Returns the key as an C<SV*>, or C<Nullsv> if the hash entry does not
1129 contain an C<SV*> key.
1139 Returns the key as an C<SV*>. Will create and return a temporary mortal
1140 C<SV*> if the hash entry contains only a C<char*> key.
1142 SV* HeSVKEY_force(HE* he)
1150 Sets the key to a given C<SV*>, taking care to set the appropriate flags to
1151 indicate the presence of an C<SV*> key, and returns the same
1154 SV* HeSVKEY_set(HE* he, SV* sv)
1162 Returns the value slot (type C<SV*>) stored in the hash entry.
1172 Returns the package name of a stash. See C<SvSTASH>, C<CvSTASH>.
1174 char* HvNAME(HV* stash)
1182 Clears a hash, making it empty.
1184 void hv_clear(HV* tb)
1189 =item hv_clear_placeholders
1190 X<hv_clear_placeholders>
1192 Clears any placeholders from a hash. If a restricted hash has any of its keys
1193 marked as readonly and the key is subsequently deleted, the key is not actually
1194 deleted but is marked by assigning it a value of &PL_sv_placeholder. This tags
1195 it so it will be ignored by future operations such as iterating over the hash,
1196 but will still allow the hash to have a value reassigned to the key at some
1197 future point. This function clears any such placeholder keys from the hash.
1198 See Hash::Util::lock_keys() for an example of its use.
1200 void hv_clear_placeholders(HV* hb)
1208 Deletes a key/value pair in the hash. The value SV is removed from the
1209 hash and returned to the caller. The C<klen> is the length of the key.
1210 The C<flags> value will normally be zero; if set to G_DISCARD then NULL
1213 SV* hv_delete(HV* tb, const char* key, I32 klen, I32 flags)
1221 Deletes a key/value pair in the hash. The value SV is removed from the
1222 hash and returned to the caller. The C<flags> value will normally be zero;
1223 if set to G_DISCARD then NULL will be returned. C<hash> can be a valid
1224 precomputed hash value, or 0 to ask for it to be computed.
1226 SV* hv_delete_ent(HV* tb, SV* key, I32 flags, U32 hash)
1234 Returns a boolean indicating whether the specified hash key exists. The
1235 C<klen> is the length of the key.
1237 bool hv_exists(HV* tb, const char* key, I32 klen)
1245 Returns a boolean indicating whether the specified hash key exists. C<hash>
1246 can be a valid precomputed hash value, or 0 to ask for it to be
1249 bool hv_exists_ent(HV* tb, SV* key, U32 hash)
1257 Returns the SV which corresponds to the specified key in the hash. The
1258 C<klen> is the length of the key. If C<lval> is set then the fetch will be
1259 part of a store. Check that the return value is non-null before
1260 dereferencing it to an C<SV*>.
1262 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1263 information on how to use this function on tied hashes.
1265 SV** hv_fetch(HV* tb, const char* key, I32 klen, I32 lval)
1273 Returns the hash entry which corresponds to the specified key in the hash.
1274 C<hash> must be a valid precomputed hash number for the given C<key>, or 0
1275 if you want the function to compute it. IF C<lval> is set then the fetch
1276 will be part of a store. Make sure the return value is non-null before
1277 accessing it. The return value when C<tb> is a tied hash is a pointer to a
1278 static location, so be sure to make a copy of the structure if you need to
1281 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1282 information on how to use this function on tied hashes.
1284 HE* hv_fetch_ent(HV* tb, SV* key, I32 lval, U32 hash)
1292 Prepares a starting point to traverse a hash table. Returns the number of
1293 keys in the hash (i.e. the same as C<HvKEYS(tb)>). The return value is
1294 currently only meaningful for hashes without tie magic.
1296 NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
1297 hash buckets that happen to be in use. If you still need that esoteric
1298 value, you can get it through the macro C<HvFILL(tb)>.
1301 I32 hv_iterinit(HV* tb)
1309 Returns the key from the current position of the hash iterator. See
1312 char* hv_iterkey(HE* entry, I32* retlen)
1320 Returns the key as an C<SV*> from the current position of the hash
1321 iterator. The return value will always be a mortal copy of the key. Also
1324 SV* hv_iterkeysv(HE* entry)
1332 Returns entries from a hash iterator. See C<hv_iterinit>.
1334 You may call C<hv_delete> or C<hv_delete_ent> on the hash entry that the
1335 iterator currently points to, without losing your place or invalidating your
1336 iterator. Note that in this case the current entry is deleted from the hash
1337 with your iterator holding the last reference to it. Your iterator is flagged
1338 to free the entry on the next call to C<hv_iternext>, so you must not discard
1339 your iterator immediately else the entry will leak - call C<hv_iternext> to
1340 trigger the resource deallocation.
1342 HE* hv_iternext(HV* tb)
1350 Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
1353 SV* hv_iternextsv(HV* hv, char** key, I32* retlen)
1358 =item hv_iternext_flags
1359 X<hv_iternext_flags>
1361 Returns entries from a hash iterator. See C<hv_iterinit> and C<hv_iternext>.
1362 The C<flags> value will normally be zero; if HV_ITERNEXT_WANTPLACEHOLDERS is
1363 set the placeholders keys (for restricted hashes) will be returned in addition
1364 to normal keys. By default placeholders are automatically skipped over.
1365 Currently a placeholder is implemented with a value that is
1366 C<&Perl_sv_placeholder>. Note that the implementation of placeholders and
1367 restricted hashes may change, and the implementation currently is
1368 insufficiently abstracted for any change to be tidy.
1370 NOTE: this function is experimental and may change or be
1371 removed without notice.
1373 HE* hv_iternext_flags(HV* tb, I32 flags)
1381 Returns the value from the current position of the hash iterator. See
1384 SV* hv_iterval(HV* tb, HE* entry)
1392 Adds magic to a hash. See C<sv_magic>.
1394 void hv_magic(HV* hv, GV* gv, int how)
1402 Evaluates the hash in scalar context and returns the result. Handles magic when the hash is tied.
1404 SV* hv_scalar(HV* hv)
1412 Stores an SV in a hash. The hash key is specified as C<key> and C<klen> is
1413 the length of the key. The C<hash> parameter is the precomputed hash
1414 value; if it is zero then Perl will compute it. The return value will be
1415 NULL if the operation failed or if the value did not need to be actually
1416 stored within the hash (as in the case of tied hashes). Otherwise it can
1417 be dereferenced to get the original C<SV*>. Note that the caller is
1418 responsible for suitably incrementing the reference count of C<val> before
1419 the call, and decrementing it if the function returned NULL. Effectively
1420 a successful hv_store takes ownership of one reference to C<val>. This is
1421 usually what you want; a newly created SV has a reference count of one, so
1422 if all your code does is create SVs then store them in a hash, hv_store
1423 will own the only reference to the new SV, and your code doesn't need to do
1424 anything further to tidy up. hv_store is not implemented as a call to
1425 hv_store_ent, and does not create a temporary SV for the key, so if your
1426 key data is not already in SV form then use hv_store in preference to
1429 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1430 information on how to use this function on tied hashes.
1432 SV** hv_store(HV* tb, const char* key, I32 klen, SV* val, U32 hash)
1440 Stores C<val> in a hash. The hash key is specified as C<key>. The C<hash>
1441 parameter is the precomputed hash value; if it is zero then Perl will
1442 compute it. The return value is the new hash entry so created. It will be
1443 NULL if the operation failed or if the value did not need to be actually
1444 stored within the hash (as in the case of tied hashes). Otherwise the
1445 contents of the return value can be accessed using the C<He?> macros
1446 described here. Note that the caller is responsible for suitably
1447 incrementing the reference count of C<val> before the call, and
1448 decrementing it if the function returned NULL. Effectively a successful
1449 hv_store_ent takes ownership of one reference to C<val>. This is
1450 usually what you want; a newly created SV has a reference count of one, so
1451 if all your code does is create SVs then store them in a hash, hv_store
1452 will own the only reference to the new SV, and your code doesn't need to do
1453 anything further to tidy up. Note that hv_store_ent only reads the C<key>;
1454 unlike C<val> it does not take ownership of it, so maintaining the correct
1455 reference count on C<key> is entirely the caller's responsibility. hv_store
1456 is not implemented as a call to hv_store_ent, and does not create a temporary
1457 SV for the key, so if your key data is not already in SV form then use
1458 hv_store in preference to hv_store_ent.
1460 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1461 information on how to use this function on tied hashes.
1463 HE* hv_store_ent(HV* tb, SV* key, SV* val, U32 hash)
1473 void hv_undef(HV* tb)
1481 Creates a new HV. The reference count is set to 1.
1491 =head1 Magical Functions
1498 Clear something magical that the SV represents. See C<sv_magic>.
1500 int mg_clear(SV* sv)
1508 Copies the magic from one SV to another. See C<sv_magic>.
1510 int mg_copy(SV* sv, SV* nsv, const char* key, I32 klen)
1518 Finds the magic pointer for type matching the SV. See C<sv_magic>.
1520 MAGIC* mg_find(SV* sv, int type)
1528 Free any magic storage used by the SV. See C<sv_magic>.
1538 Do magic after a value is retrieved from the SV. See C<sv_magic>.
1548 Report on the SV's length. See C<sv_magic>.
1550 U32 mg_length(SV* sv)
1558 Turns on the magical status of an SV. See C<sv_magic>.
1560 void mg_magical(SV* sv)
1568 Do magic after a value is assigned to the SV. See C<sv_magic>.
1578 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
1579 argument more than once.
1581 void SvGETMAGIC(SV* sv)
1589 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
1600 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
1601 argument more than once.
1603 void SvSETMAGIC(SV* sv)
1611 Like C<SvSetSV>, but does any set magic required afterwards.
1613 void SvSetMagicSV(SV* dsb, SV* ssv)
1618 =item SvSetMagicSV_nosteal
1619 X<SvSetMagicSV_nosteal>
1621 Like C<SvSetSV_nosteal>, but does any set magic required afterwards.
1623 void SvSetMagicSV_nosteal(SV* dsv, SV* ssv)
1631 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
1634 void SvSetSV(SV* dsb, SV* ssv)
1639 =item SvSetSV_nosteal
1642 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
1643 ssv. May evaluate arguments more than once.
1645 void SvSetSV_nosteal(SV* dsv, SV* ssv)
1653 Arranges for sv to be shared between threads if a suitable module
1656 void SvSHARE(SV* sv)
1664 Releases a mutual exclusion lock on sv if a suitable module
1667 void SvUNLOCK(SV* sv)
1675 =head1 Memory Management
1682 The XSUB-writer's interface to the C C<memcpy> function. The C<src> is the
1683 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1684 the type. May fail on overlapping copies. See also C<Move>.
1686 void Copy(void* src, void* dest, int nitems, type)
1689 Found in file handy.h
1694 Like C<Copy> but returns dest. Useful for encouraging compilers to tail-call
1697 void * CopyD(void* src, void* dest, int nitems, type)
1700 Found in file handy.h
1705 The XSUB-writer's interface to the C C<memmove> function. The C<src> is the
1706 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1707 the type. Can do overlapping moves. See also C<Copy>.
1709 void Move(void* src, void* dest, int nitems, type)
1712 Found in file handy.h
1717 Like C<Move> but returns dest. Useful for encouraging compilers to tail-call
1720 void * MoveD(void* src, void* dest, int nitems, type)
1723 Found in file handy.h
1728 The XSUB-writer's interface to the C C<malloc> function.
1730 void Newx(void* ptr, int nitems, type)
1733 Found in file handy.h
1738 The XSUB-writer's interface to the C C<malloc> function, with
1741 void Newxc(void* ptr, int nitems, type, cast)
1744 Found in file handy.h
1749 The XSUB-writer's interface to the C C<malloc> function. The allocated
1750 memory is zeroed with C<memzero>.
1752 In 5.9.3, we removed the 1st parameter, a debug aid, from the api. It
1753 was used to uniquely identify each usage of these allocation
1754 functions, but was deemed unnecessary with the availability of better
1755 memory tracking tools, valgrind for example.
1757 void Newxz(void* ptr, int nitems, type)
1760 Found in file handy.h
1765 Fill up memory with a pattern (byte 0xAB over and over again) that
1766 hopefully catches attempts to access uninitialized memory.
1768 void Poison(void* dest, int nitems, type)
1771 Found in file handy.h
1776 The XSUB-writer's interface to the C C<realloc> function.
1778 void Renew(void* ptr, int nitems, type)
1781 Found in file handy.h
1786 The XSUB-writer's interface to the C C<realloc> function, with
1789 void Renewc(void* ptr, int nitems, type, cast)
1792 Found in file handy.h
1797 The XSUB-writer's interface to the C C<free> function.
1799 void Safefree(void* ptr)
1802 Found in file handy.h
1807 Perl's version of C<strdup()>. Returns a pointer to a newly allocated
1808 string which is a duplicate of C<pv>. The size of the string is
1809 determined by C<strlen()>. The memory allocated for the new string can
1810 be freed with the C<Safefree()> function.
1812 char* savepv(const char* pv)
1815 Found in file util.c
1820 Perl's version of what C<strndup()> would be if it existed. Returns a
1821 pointer to a newly allocated string which is a duplicate of the first
1822 C<len> bytes from C<pv>. The memory allocated for the new string can be
1823 freed with the C<Safefree()> function.
1825 char* savepvn(const char* pv, I32 len)
1828 Found in file util.c
1833 A version of C<savepv()> which allocates the duplicate string in memory
1834 which is shared between threads.
1836 char* savesharedpv(const char* pv)
1839 Found in file util.c
1844 A version of C<savepv()>/C<savepvn()> which gets the string to duplicate from
1845 the passed in SV using C<SvPV()>
1847 char* savesvpv(SV* sv)
1850 Found in file util.c
1855 This is an architecture-independent macro to copy one structure to another.
1857 void StructCopy(type src, type dest, type)
1860 Found in file handy.h
1865 The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the
1866 destination, C<nitems> is the number of items, and C<type> is the type.
1868 void Zero(void* dest, int nitems, type)
1871 Found in file handy.h
1876 Like C<Zero> but returns dest. Useful for encouraging compilers to tail-call
1879 void * ZeroD(void* dest, int nitems, type)
1882 Found in file handy.h
1887 =head1 Miscellaneous Functions
1894 Analyses the string in order to make fast searches on it using fbm_instr()
1895 -- the Boyer-Moore algorithm.
1897 void fbm_compile(SV* sv, U32 flags)
1900 Found in file util.c
1905 Returns the location of the SV in the string delimited by C<str> and
1906 C<strend>. It returns C<Nullch> if the string can't be found. The C<sv>
1907 does not have to be fbm_compiled, but the search will not be as fast
1910 char* fbm_instr(unsigned char* big, unsigned char* bigend, SV* littlesv, U32 flags)
1913 Found in file util.c
1918 Takes a sprintf-style format pattern and conventional
1919 (non-SV) arguments and returns the formatted string.
1921 (char *) Perl_form(pTHX_ const char* pat, ...)
1923 can be used any place a string (char *) is required:
1925 char * s = Perl_form("%d.%d",major,minor);
1927 Uses a single private buffer so if you want to format several strings you
1928 must explicitly copy the earlier strings away (and free the copies when you
1931 char* form(const char* pat, ...)
1934 Found in file util.c
1939 Fill the sv with current working directory
1941 int getcwd_sv(SV* sv)
1944 Found in file util.c
1949 Test two strings to see if they are equal. Returns true or false.
1951 bool strEQ(char* s1, char* s2)
1954 Found in file handy.h
1959 Test two strings to see if the first, C<s1>, is greater than or equal to
1960 the second, C<s2>. Returns true or false.
1962 bool strGE(char* s1, char* s2)
1965 Found in file handy.h
1970 Test two strings to see if the first, C<s1>, is greater than the second,
1971 C<s2>. Returns true or false.
1973 bool strGT(char* s1, char* s2)
1976 Found in file handy.h
1981 Test two strings to see if the first, C<s1>, is less than or equal to the
1982 second, C<s2>. Returns true or false.
1984 bool strLE(char* s1, char* s2)
1987 Found in file handy.h
1992 Test two strings to see if the first, C<s1>, is less than the second,
1993 C<s2>. Returns true or false.
1995 bool strLT(char* s1, char* s2)
1998 Found in file handy.h
2003 Test two strings to see if they are different. Returns true or
2006 bool strNE(char* s1, char* s2)
2009 Found in file handy.h
2014 Test two strings to see if they are equal. The C<len> parameter indicates
2015 the number of bytes to compare. Returns true or false. (A wrapper for
2018 bool strnEQ(char* s1, char* s2, STRLEN len)
2021 Found in file handy.h
2026 Test two strings to see if they are different. The C<len> parameter
2027 indicates the number of bytes to compare. Returns true or false. (A
2028 wrapper for C<strncmp>).
2030 bool strnNE(char* s1, char* s2, STRLEN len)
2033 Found in file handy.h
2038 Dummy routine which "locks" an SV when there is no locking module present.
2039 Exists to avoid test for a NULL function pointer and because it could potentially warn under
2040 some level of strict-ness.
2042 void sv_nolocking(SV *)
2045 Found in file util.c
2050 Dummy routine which "shares" an SV when there is no sharing module present.
2051 Exists to avoid test for a NULL function pointer and because it could potentially warn under
2052 some level of strict-ness.
2054 void sv_nosharing(SV *)
2057 Found in file util.c
2059 =item sv_nounlocking
2062 Dummy routine which "unlocks" an SV when there is no locking module present.
2063 Exists to avoid test for a NULL function pointer and because it could potentially warn under
2064 some level of strict-ness.
2066 void sv_nounlocking(SV *)
2069 Found in file util.c
2074 =head1 Numeric functions
2081 converts a string representing a binary number to numeric form.
2083 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2084 conversion flags, and I<result> should be NULL or a pointer to an NV.
2085 The scan stops at the end of the string, or the first invalid character.
2086 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2087 invalid character will also trigger a warning.
2088 On return I<*len> is set to the length of the scanned string,
2089 and I<*flags> gives output flags.
2091 If the value is <= C<UV_MAX> it is returned as a UV, the output flags are clear,
2092 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_bin>
2093 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2094 and writes the value to I<*result> (or the value is discarded if I<result>
2097 The binary number may optionally be prefixed with "0b" or "b" unless
2098 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
2099 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the binary
2100 number may use '_' characters to separate digits.
2102 UV grok_bin(char* start, STRLEN* len, I32* flags, NV *result)
2105 Found in file numeric.c
2110 converts a string representing a hex number to numeric form.
2112 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2113 conversion flags, and I<result> should be NULL or a pointer to an NV.
2114 The scan stops at the end of the string, or the first invalid character.
2115 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2116 invalid character will also trigger a warning.
2117 On return I<*len> is set to the length of the scanned string,
2118 and I<*flags> gives output flags.
2120 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2121 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_hex>
2122 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2123 and writes the value to I<*result> (or the value is discarded if I<result>
2126 The hex number may optionally be prefixed with "0x" or "x" unless
2127 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
2128 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the hex
2129 number may use '_' characters to separate digits.
2131 UV grok_hex(char* start, STRLEN* len, I32* flags, NV *result)
2134 Found in file numeric.c
2139 Recognise (or not) a number. The type of the number is returned
2140 (0 if unrecognised), otherwise it is a bit-ORed combination of
2141 IS_NUMBER_IN_UV, IS_NUMBER_GREATER_THAN_UV_MAX, IS_NUMBER_NOT_INT,
2142 IS_NUMBER_NEG, IS_NUMBER_INFINITY, IS_NUMBER_NAN (defined in perl.h).
2144 If the value of the number can fit an in UV, it is returned in the *valuep
2145 IS_NUMBER_IN_UV will be set to indicate that *valuep is valid, IS_NUMBER_IN_UV
2146 will never be set unless *valuep is valid, but *valuep may have been assigned
2147 to during processing even though IS_NUMBER_IN_UV is not set on return.
2148 If valuep is NULL, IS_NUMBER_IN_UV will be set for the same cases as when
2149 valuep is non-NULL, but no actual assignment (or SEGV) will occur.
2151 IS_NUMBER_NOT_INT will be set with IS_NUMBER_IN_UV if trailing decimals were
2152 seen (in which case *valuep gives the true value truncated to an integer), and
2153 IS_NUMBER_NEG if the number is negative (in which case *valuep holds the
2154 absolute value). IS_NUMBER_IN_UV is not set if e notation was used or the
2155 number is larger than a UV.
2157 int grok_number(const char *pv, STRLEN len, UV *valuep)
2160 Found in file numeric.c
2162 =item grok_numeric_radix
2163 X<grok_numeric_radix>
2165 Scan and skip for a numeric decimal separator (radix).
2167 bool grok_numeric_radix(const char **sp, const char *send)
2170 Found in file numeric.c
2175 converts a string representing an octal number to numeric form.
2177 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2178 conversion flags, and I<result> should be NULL or a pointer to an NV.
2179 The scan stops at the end of the string, or the first invalid character.
2180 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2181 invalid character will also trigger a warning.
2182 On return I<*len> is set to the length of the scanned string,
2183 and I<*flags> gives output flags.
2185 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2186 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_oct>
2187 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2188 and writes the value to I<*result> (or the value is discarded if I<result>
2191 If C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the octal
2192 number may use '_' characters to separate digits.
2194 UV grok_oct(char* start, STRLEN* len_p, I32* flags, NV *result)
2197 Found in file numeric.c
2202 For backwards compatibility. Use C<grok_bin> instead.
2204 NV scan_bin(char* start, STRLEN len, STRLEN* retlen)
2207 Found in file numeric.c
2212 For backwards compatibility. Use C<grok_hex> instead.
2214 NV scan_hex(char* start, STRLEN len, STRLEN* retlen)
2217 Found in file numeric.c
2222 For backwards compatibility. Use C<grok_oct> instead.
2224 NV scan_oct(char* start, STRLEN len, STRLEN* retlen)
2227 Found in file numeric.c
2232 =head1 Optree Manipulation Functions
2239 If C<cv> is a constant sub eligible for inlining. returns the constant
2240 value returned by the sub. Otherwise, returns NULL.
2242 Constant subs can be created with C<newCONSTSUB> or as described in
2243 L<perlsub/"Constant Functions">.
2245 SV* cv_const_sv(CV* cv)
2253 Creates a constant sub equivalent to Perl C<sub FOO () { 123 }> which is
2254 eligible for inlining at compile-time.
2256 CV* newCONSTSUB(HV* stash, char* name, SV* sv)
2264 Used by C<xsubpp> to hook up XSUBs as Perl subs.
2272 =head1 Pad Data Structures
2279 Get the value at offset po in the current pad.
2280 Use macro PAD_SV instead of calling this function directly.
2282 SV* pad_sv(PADOFFSET po)
2290 =head1 Stack Manipulation Macros
2297 Declare a stack marker variable, C<mark>, for the XSUB. See C<MARK> and
2308 Saves the original stack mark for the XSUB. See C<ORIGMARK>.
2318 Declares a local copy of perl's stack pointer for the XSUB, available via
2319 the C<SP> macro. See C<SP>.
2329 Used to extend the argument stack for an XSUB's return values. Once
2330 used, guarantees that there is room for at least C<nitems> to be pushed
2333 void EXTEND(SP, int nitems)
2341 Stack marker variable for the XSUB. See C<dMARK>.
2349 Push an integer onto the stack. The stack must have room for this element.
2350 Handles 'set' magic. Does not use C<TARG>. See also C<PUSHi>, C<mXPUSHi>
2361 Push a double onto the stack. The stack must have room for this element.
2362 Handles 'set' magic. Does not use C<TARG>. See also C<PUSHn>, C<mXPUSHn>
2373 Push a string onto the stack. The stack must have room for this element.
2374 The C<len> indicates the length of the string. Handles 'set' magic. Does
2375 not use C<TARG>. See also C<PUSHp>, C<mXPUSHp> and C<XPUSHp>.
2377 void mPUSHp(char* str, STRLEN len)
2385 Push an unsigned integer onto the stack. The stack must have room for this
2386 element. Handles 'set' magic. Does not use C<TARG>. See also C<PUSHu>,
2387 C<mXPUSHu> and C<XPUSHu>.
2397 Push an integer onto the stack, extending the stack if necessary. Handles
2398 'set' magic. Does not use C<TARG>. See also C<XPUSHi>, C<mPUSHi> and
2409 Push a double onto the stack, extending the stack if necessary. Handles
2410 'set' magic. Does not use C<TARG>. See also C<XPUSHn>, C<mPUSHn> and
2421 Push a string onto the stack, extending the stack if necessary. The C<len>
2422 indicates the length of the string. Handles 'set' magic. Does not use
2423 C<TARG>. See also C<XPUSHp>, C<mPUSHp> and C<PUSHp>.
2425 void mXPUSHp(char* str, STRLEN len)
2433 Push an unsigned integer onto the stack, extending the stack if necessary.
2434 Handles 'set' magic. Does not use C<TARG>. See also C<XPUSHu>, C<mPUSHu>
2445 The original stack mark for the XSUB. See C<dORIGMARK>.
2453 Pops an integer off the stack.
2463 Pops a long off the stack.
2473 Pops a double off the stack.
2483 Pops a string off the stack. Deprecated. New code should use POPpx.
2493 Pops a string off the stack which must consist of bytes i.e. characters < 256.
2503 Pops a string off the stack.
2513 Pops an SV off the stack.
2523 Push an integer onto the stack. The stack must have room for this element.
2524 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
2525 called to declare it. Do not call multiple C<TARG>-oriented macros to
2526 return lists from XSUB's - see C<mPUSHi> instead. See also C<XPUSHi> and
2537 Opening bracket for arguments on a callback. See C<PUTBACK> and
2548 Push a new mortal SV onto the stack. The stack must have room for this
2549 element. Does not handle 'set' magic. Does not use C<TARG>. See also
2550 C<PUSHs>, C<XPUSHmortal> and C<XPUSHs>.
2560 Push a double onto the stack. The stack must have room for this element.
2561 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
2562 called to declare it. Do not call multiple C<TARG>-oriented macros to
2563 return lists from XSUB's - see C<mPUSHn> instead. See also C<XPUSHn> and
2574 Push a string onto the stack. The stack must have room for this element.
2575 The C<len> indicates the length of the string. Handles 'set' magic. Uses
2576 C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to declare it. Do not
2577 call multiple C<TARG>-oriented macros to return lists from XSUB's - see
2578 C<mPUSHp> instead. See also C<XPUSHp> and C<mXPUSHp>.
2580 void PUSHp(char* str, STRLEN len)
2588 Push an SV onto the stack. The stack must have room for this element.
2589 Does not handle 'set' magic. Does not use C<TARG>. See also C<PUSHmortal>,
2590 C<XPUSHs> and C<XPUSHmortal>.
2600 Push an unsigned integer onto the stack. The stack must have room for this
2601 element. Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG>
2602 should be called to declare it. Do not call multiple C<TARG>-oriented
2603 macros to return lists from XSUB's - see C<mPUSHu> instead. See also
2604 C<XPUSHu> and C<mXPUSHu>.
2614 Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
2615 See C<PUSHMARK> and L<perlcall> for other uses.
2625 Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and
2634 Refetch the stack pointer. Used after a callback. See L<perlcall>.
2644 Push an integer onto the stack, extending the stack if necessary. Handles
2645 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
2646 declare it. Do not call multiple C<TARG>-oriented macros to return lists
2647 from XSUB's - see C<mXPUSHi> instead. See also C<PUSHi> and C<mPUSHi>.
2657 Push a new mortal SV onto the stack, extending the stack if necessary. Does
2658 not handle 'set' magic. Does not use C<TARG>. See also C<XPUSHs>,
2659 C<PUSHmortal> and C<PUSHs>.
2669 Push a double onto the stack, extending the stack if necessary. Handles
2670 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
2671 declare it. Do not call multiple C<TARG>-oriented macros to return lists
2672 from XSUB's - see C<mXPUSHn> instead. See also C<PUSHn> and C<mPUSHn>.
2682 Push a string onto the stack, extending the stack if necessary. The C<len>
2683 indicates the length of the string. Handles 'set' magic. Uses C<TARG>, so
2684 C<dTARGET> or C<dXSTARG> should be called to declare it. Do not call
2685 multiple C<TARG>-oriented macros to return lists from XSUB's - see
2686 C<mXPUSHp> instead. See also C<PUSHp> and C<mPUSHp>.
2688 void XPUSHp(char* str, STRLEN len)
2696 Push an SV onto the stack, extending the stack if necessary. Does not
2697 handle 'set' magic. Does not use C<TARG>. See also C<XPUSHmortal>,
2698 C<PUSHs> and C<PUSHmortal>.
2708 Push an unsigned integer onto the stack, extending the stack if necessary.
2709 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
2710 called to declare it. Do not call multiple C<TARG>-oriented macros to
2711 return lists from XSUB's - see C<mXPUSHu> instead. See also C<PUSHu> and
2722 Return from XSUB, indicating number of items on the stack. This is usually
2723 handled by C<xsubpp>.
2725 void XSRETURN(int nitems)
2728 Found in file XSUB.h
2730 =item XSRETURN_EMPTY
2733 Return an empty list from an XSUB immediately.
2738 Found in file XSUB.h
2743 Return an integer from an XSUB immediately. Uses C<XST_mIV>.
2745 void XSRETURN_IV(IV iv)
2748 Found in file XSUB.h
2753 Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
2758 Found in file XSUB.h
2763 Return a double from an XSUB immediately. Uses C<XST_mNV>.
2765 void XSRETURN_NV(NV nv)
2768 Found in file XSUB.h
2773 Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
2775 void XSRETURN_PV(char* str)
2778 Found in file XSUB.h
2780 =item XSRETURN_UNDEF
2783 Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
2788 Found in file XSUB.h
2793 Return an integer from an XSUB immediately. Uses C<XST_mUV>.
2795 void XSRETURN_UV(IV uv)
2798 Found in file XSUB.h
2803 Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
2808 Found in file XSUB.h
2813 Place an integer into the specified position C<pos> on the stack. The
2814 value is stored in a new mortal SV.
2816 void XST_mIV(int pos, IV iv)
2819 Found in file XSUB.h
2824 Place C<&PL_sv_no> into the specified position C<pos> on the
2827 void XST_mNO(int pos)
2830 Found in file XSUB.h
2835 Place a double into the specified position C<pos> on the stack. The value
2836 is stored in a new mortal SV.
2838 void XST_mNV(int pos, NV nv)
2841 Found in file XSUB.h
2846 Place a copy of a string into the specified position C<pos> on the stack.
2847 The value is stored in a new mortal SV.
2849 void XST_mPV(int pos, char* str)
2852 Found in file XSUB.h
2857 Place C<&PL_sv_undef> into the specified position C<pos> on the
2860 void XST_mUNDEF(int pos)
2863 Found in file XSUB.h
2868 Place C<&PL_sv_yes> into the specified position C<pos> on the
2871 void XST_mYES(int pos)
2874 Found in file XSUB.h
2886 An enum of flags for Perl types. These are found in the file B<sv.h>
2887 in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
2895 Integer type flag for scalars. See C<svtype>.
2903 Double type flag for scalars. See C<svtype>.
2911 Pointer type flag for scalars. See C<svtype>.
2919 Type flag for arrays. See C<svtype>.
2927 Type flag for code refs. See C<svtype>.
2935 Type flag for hashes. See C<svtype>.
2943 Type flag for blessed scalars. See C<svtype>.
2951 =head1 SV Manipulation Functions
2958 Returns the SV of the specified Perl scalar. If C<create> is set and the
2959 Perl variable does not exist then it will be created. If C<create> is not
2960 set and the variable does not exist then NULL is returned.
2962 NOTE: the perl_ form of this function is deprecated.
2964 SV* get_sv(const char* name, I32 create)
2967 Found in file perl.c
2969 =item looks_like_number
2970 X<looks_like_number>
2972 Test if the content of an SV looks like a number (or is a number).
2973 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
2974 non-numeric warning), even if your atof() doesn't grok them.
2976 I32 looks_like_number(SV* sv)
2984 Creates an RV wrapper for an SV. The reference count for the original SV is
2987 SV* newRV_inc(SV* sv)
2995 Creates an RV wrapper for an SV. The reference count for the original
2996 SV is B<not> incremented.
2998 SV* newRV_noinc(SV *sv)
3006 Creates a new SV. A non-zero C<len> parameter indicates the number of
3007 bytes of preallocated string space the SV should have. An extra byte for a
3008 tailing NUL is also reserved. (SvPOK is not set for the SV even if string
3009 space is allocated.) The reference count for the new SV is set to 1.
3010 C<id> is an integer id between 0 and 1299 (used to identify leaks).
3012 SV* NEWSV(int id, STRLEN len)
3015 Found in file handy.h
3020 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
3021 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
3024 SV* newSV(STRLEN len)
3032 Creates a new SV from the hash key structure. It will generate scalars that
3033 point to the shared string table where possible. Returns a new (undefined)
3034 SV if the hek is NULL.
3036 SV* newSVhek(const HEK *hek)
3044 Creates a new SV and copies an integer into it. The reference count for the
3055 Creates a new SV and copies a floating point value into it.
3056 The reference count for the SV is set to 1.
3066 Creates a new SV and copies a string into it. The reference count for the
3067 SV is set to 1. If C<len> is zero, Perl will compute the length using
3068 strlen(). For efficiency, consider using C<newSVpvn> instead.
3070 SV* newSVpv(const char* s, STRLEN len)
3078 Creates a new SV and initializes it with the string formatted like
3081 SV* newSVpvf(const char* pat, ...)
3089 Creates a new SV and copies a string into it. The reference count for the
3090 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
3091 string. You are responsible for ensuring that the source string is at least
3092 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
3094 SV* newSVpvn(const char* s, STRLEN len)
3099 =item newSVpvn_share
3102 Creates a new SV with its SvPVX_const pointing to a shared string in the string
3103 table. If the string does not already exist in the table, it is created
3104 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
3105 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
3106 otherwise the hash is computed. The idea here is that as the string table
3107 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
3108 hash lookup will avoid string compare.
3110 SV* newSVpvn_share(const char* s, I32 len, U32 hash)
3118 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
3119 it will be upgraded to one. If C<classname> is non-null then the new SV will
3120 be blessed in the specified package. The new SV is returned and its
3121 reference count is 1.
3123 SV* newSVrv(SV* rv, const char* classname)
3131 Creates a new SV which is an exact duplicate of the original SV.
3134 SV* newSVsv(SV* old)
3142 Creates a new SV and copies an unsigned integer into it.
3143 The reference count for the SV is set to 1.
3153 Returns the length of the string which is in the SV. See C<SvLEN>.
3155 STRLEN SvCUR(SV* sv)
3163 Set the current length of the string which is in the SV. See C<SvCUR>
3166 void SvCUR_set(SV* sv, STRLEN len)
3174 Returns a pointer to the last character in the string which is in the SV.
3175 See C<SvCUR>. Access the character as *(SvEND(sv)).
3185 Expands the character buffer in the SV so that it has room for the
3186 indicated number of bytes (remember to reserve space for an extra trailing
3187 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
3188 Returns a pointer to the character buffer.
3190 char * SvGROW(SV* sv, STRLEN len)
3198 Returns a boolean indicating whether the SV contains an integer.
3208 Returns a boolean indicating whether the SV contains an integer. Checks
3209 the B<private> setting. Use C<SvIOK>.
3219 Returns a boolean indicating whether the SV contains a signed integer.
3221 bool SvIOK_notUV(SV* sv)
3229 Unsets the IV status of an SV.
3231 void SvIOK_off(SV* sv)
3239 Tells an SV that it is an integer.
3241 void SvIOK_on(SV* sv)
3249 Tells an SV that it is an integer and disables all other OK bits.
3251 void SvIOK_only(SV* sv)
3259 Tells and SV that it is an unsigned integer and disables all other OK bits.
3261 void SvIOK_only_UV(SV* sv)
3269 Returns a boolean indicating whether the SV contains an unsigned integer.
3271 bool SvIOK_UV(SV* sv)
3279 Returns a boolean indicating whether the SV is Copy-On-Write. (either shared
3280 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
3283 bool SvIsCOW(SV* sv)
3288 =item SvIsCOW_shared_hash
3289 X<SvIsCOW_shared_hash>
3291 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
3294 bool SvIsCOW_shared_hash(SV* sv)
3302 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
3303 version which guarantees to evaluate sv only once.
3313 Returns the raw value in the SV's IV slot, without checks or conversions.
3314 Only use when you are sure SvIOK is true. See also C<SvIV()>.
3324 Coerces the given SV to an integer and returns it. Guarantees to evaluate
3325 sv only once. Use the more efficient C<SvIV> otherwise.
3335 Set the value of the IV pointer in sv to val. It is possible to perform
3336 the same function of this macro with an lvalue assignment to C<SvIVX>.
3337 With future Perls, however, it will be more efficient to use
3338 C<SvIV_set> instead of the lvalue assignment to C<SvIVX>.
3340 void SvIV_set(SV* sv, IV val)
3348 Returns the size of the string buffer in the SV, not including any part
3349 attributable to C<SvOOK>. See C<SvCUR>.
3351 STRLEN SvLEN(SV* sv)
3359 Set the actual length of the string which is in the SV. See C<SvIV_set>.
3361 void SvLEN_set(SV* sv, STRLEN len)
3369 Set the value of the MAGIC pointer in sv to val. See C<SvIV_set>.
3371 void SvMAGIC_set(SV* sv, MAGIC* val)
3379 Returns a boolean indicating whether the SV contains a number, integer or
3390 Returns a boolean indicating whether the SV contains a number, integer or
3391 double. Checks the B<private> setting. Use C<SvNIOK>.
3393 bool SvNIOKp(SV* sv)
3401 Unsets the NV/IV status of an SV.
3403 void SvNIOK_off(SV* sv)
3411 Returns a boolean indicating whether the SV contains a double.
3421 Returns a boolean indicating whether the SV contains a double. Checks the
3422 B<private> setting. Use C<SvNOK>.
3432 Unsets the NV status of an SV.
3434 void SvNOK_off(SV* sv)
3442 Tells an SV that it is a double.
3444 void SvNOK_on(SV* sv)
3452 Tells an SV that it is a double and disables all other OK bits.
3454 void SvNOK_only(SV* sv)
3462 Coerce the given SV to a double and return it. See C<SvNVx> for a version
3463 which guarantees to evaluate sv only once.
3473 Returns the raw value in the SV's NV slot, without checks or conversions.
3474 Only use when you are sure SvNOK is true. See also C<SvNV()>.
3484 Coerces the given SV to a double and returns it. Guarantees to evaluate
3485 sv only once. Use the more efficient C<SvNV> otherwise.
3495 Set the value of the NV pointer in sv to val. See C<SvIV_set>.
3497 void SvNV_set(SV* sv, NV val)
3505 Returns a boolean indicating whether the value is an SV. It also tells
3506 whether the value is defined or not.
3516 Returns a boolean indicating whether the SvIVX is a valid offset value for
3517 the SvPVX. This hack is used internally to speed up removal of characters
3518 from the beginning of a SvPV. When SvOOK is true, then the start of the
3519 allocated string buffer is really (SvPVX - SvIVX).
3529 Returns a boolean indicating whether the SV contains a character
3540 Returns a boolean indicating whether the SV contains a character string.
3541 Checks the B<private> setting. Use C<SvPOK>.
3551 Unsets the PV status of an SV.
3553 void SvPOK_off(SV* sv)
3561 Tells an SV that it is a string.
3563 void SvPOK_on(SV* sv)
3571 Tells an SV that it is a string and disables all other OK bits.
3572 Will also turn off the UTF-8 status.
3574 void SvPOK_only(SV* sv)
3579 =item SvPOK_only_UTF8
3582 Tells an SV that it is a string and disables all other OK bits,
3583 and leaves the UTF-8 status as it was.
3585 void SvPOK_only_UTF8(SV* sv)
3593 Returns a pointer to the string in the SV, or a stringified form of
3594 the SV if the SV does not contain a string. The SV may cache the
3595 stringified version becoming C<SvPOK>. Handles 'get' magic. See also
3596 C<SvPVx> for a version which guarantees to evaluate sv only once.
3598 char* SvPV(SV* sv, STRLEN len)
3606 Like C<SvPV>, but converts sv to byte representation first if necessary.
3608 char* SvPVbyte(SV* sv, STRLEN len)
3616 Like C<SvPV>, but converts sv to byte representation first if necessary.
3617 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
3620 char* SvPVbytex(SV* sv, STRLEN len)
3625 =item SvPVbytex_force
3628 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
3629 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
3632 char* SvPVbytex_force(SV* sv, STRLEN len)
3637 =item SvPVbyte_force
3640 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
3642 char* SvPVbyte_force(SV* sv, STRLEN len)
3647 =item SvPVbyte_nolen
3650 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
3652 char* SvPVbyte_nolen(SV* sv)
3660 Like C<SvPV>, but converts sv to utf8 first if necessary.
3662 char* SvPVutf8(SV* sv, STRLEN len)
3670 Like C<SvPV>, but converts sv to utf8 first if necessary.
3671 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
3674 char* SvPVutf8x(SV* sv, STRLEN len)
3679 =item SvPVutf8x_force
3682 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
3683 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
3686 char* SvPVutf8x_force(SV* sv, STRLEN len)
3691 =item SvPVutf8_force
3694 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
3696 char* SvPVutf8_force(SV* sv, STRLEN len)
3701 =item SvPVutf8_nolen
3704 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
3706 char* SvPVutf8_nolen(SV* sv)
3714 Returns a pointer to the physical string in the SV. The SV must contain a
3725 A version of C<SvPV> which guarantees to evaluate sv only once.
3727 char* SvPVx(SV* sv, STRLEN len)
3735 Like C<SvPV> but will force the SV into containing just a string
3736 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
3739 char* SvPV_force(SV* sv, STRLEN len)
3744 =item SvPV_force_nomg
3747 Like C<SvPV> but will force the SV into containing just a string
3748 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
3749 directly. Doesn't process magic.
3751 char* SvPV_force_nomg(SV* sv, STRLEN len)
3759 Returns a pointer to the string in the SV, or a stringified form of
3760 the SV if the SV does not contain a string. The SV may cache the
3761 stringified form becoming C<SvPOK>. Handles 'get' magic.
3763 char* SvPV_nolen(SV* sv)
3771 Set the value of the PV pointer in sv to val. See C<SvIV_set>.
3773 void SvPV_set(SV* sv, char* val)
3781 Returns the value of the object's reference count.
3783 U32 SvREFCNT(SV* sv)
3791 Decrements the reference count of the given SV.
3793 void SvREFCNT_dec(SV* sv)
3801 Increments the reference count of the given SV.
3803 SV* SvREFCNT_inc(SV* sv)
3811 Tests if the SV is an RV.
3821 Unsets the RV status of an SV.
3823 void SvROK_off(SV* sv)
3831 Tells an SV that it is an RV.
3833 void SvROK_on(SV* sv)
3841 Dereferences an RV to return the SV.
3851 Set the value of the RV pointer in sv to val. See C<SvIV_set>.
3853 void SvRV_set(SV* sv, SV* val)
3861 Returns the stash of the SV.
3871 Set the value of the STASH pointer in sv to val. See C<SvIV_set>.
3873 void SvSTASH_set(SV* sv, STASH* val)
3881 Taints an SV if tainting is enabled.
3883 void SvTAINT(SV* sv)
3891 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
3894 bool SvTAINTED(SV* sv)
3902 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
3903 some of Perl's fundamental security features. XS module authors should not
3904 use this function unless they fully understand all the implications of
3905 unconditionally untainting the value. Untainting should be done in the
3906 standard perl fashion, via a carefully crafted regexp, rather than directly
3907 untainting variables.
3909 void SvTAINTED_off(SV* sv)
3917 Marks an SV as tainted if tainting is enabled.
3919 void SvTAINTED_on(SV* sv)
3927 Returns a boolean indicating whether Perl would evaluate the SV as true or
3928 false, defined or undefined. Does not handle 'get' magic.
3938 Returns the type of the SV. See C<svtype>.
3940 svtype SvTYPE(SV* sv)
3948 Returns a boolean indicating whether the SV contains an unsigned integer.
3958 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
3959 perform the upgrade if necessary. See C<svtype>.
3961 void SvUPGRADE(SV* sv, svtype type)
3969 Returns a boolean indicating whether the SV contains UTF-8 encoded data.
3979 Unsets the UTF-8 status of an SV.
3981 void SvUTF8_off(SV *sv)
3989 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
3990 Do not use frivolously.
3992 void SvUTF8_on(SV *sv)
4000 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
4001 for a version which guarantees to evaluate sv only once.
4011 Returns the raw value in the SV's UV slot, without checks or conversions.
4012 Only use when you are sure SvIOK is true. See also C<SvUV()>.
4022 Coerces the given SV to an unsigned integer and returns it. Guarantees to
4023 evaluate sv only once. Use the more efficient C<SvUV> otherwise.
4033 Set the value of the UV pointer in sv to val. See C<SvIV_set>.
4035 void SvUV_set(SV* sv, UV val)
4043 This function is only called on magical items, and is only used by
4044 sv_true() or its macro equivalent.
4046 bool sv_2bool(SV* sv)
4054 Using various gambits, try to get a CV from an SV; in addition, try if
4055 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
4057 CV* sv_2cv(SV* sv, HV** st, GV** gvp, I32 lref)
4065 Using various gambits, try to get an IO from an SV: the IO slot if its a
4066 GV; or the recursive result if we're an RV; or the IO slot of the symbol
4067 named after the PV if we're a string.
4077 Return the integer value of an SV, doing any necessary string conversion,
4078 magic etc. Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
4088 Marks an existing SV as mortal. The SV will be destroyed "soon", either
4089 by an explicit call to FREETMPS, or by an implicit call at places such as
4090 statement boundaries. SvTEMP() is turned on which means that the SV's
4091 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
4092 and C<sv_mortalcopy>.
4094 SV* sv_2mortal(SV* sv)
4102 Return the num value of an SV, doing any necessary string or integer
4103 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
4114 Return a pointer to the byte-encoded representation of the SV, and set *lp
4115 to its length. May cause the SV to be downgraded from UTF-8 as a
4118 Usually accessed via the C<SvPVbyte> macro.
4120 char* sv_2pvbyte(SV* sv, STRLEN* lp)
4125 =item sv_2pvbyte_nolen
4128 Return a pointer to the byte-encoded representation of the SV.
4129 May cause the SV to be downgraded from UTF-8 as a side-effect.
4131 Usually accessed via the C<SvPVbyte_nolen> macro.
4133 char* sv_2pvbyte_nolen(SV* sv)
4141 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
4142 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
4144 Usually accessed via the C<SvPVutf8> macro.
4146 char* sv_2pvutf8(SV* sv, STRLEN* lp)
4151 =item sv_2pvutf8_nolen
4154 Return a pointer to the UTF-8-encoded representation of the SV.
4155 May cause the SV to be upgraded to UTF-8 as a side-effect.
4157 Usually accessed via the C<SvPVutf8_nolen> macro.
4159 char* sv_2pvutf8_nolen(SV* sv)
4167 Returns a pointer to the string value of an SV, and sets *lp to its length.
4168 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
4170 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
4171 usually end up here too.
4173 char* sv_2pv_flags(SV* sv, STRLEN* lp, I32 flags)
4181 Like C<sv_2pv()>, but doesn't return the length too. You should usually
4182 use the macro wrapper C<SvPV_nolen(sv)> instead.
4183 char* sv_2pv_nolen(SV* sv)
4191 Return the unsigned integer value of an SV, doing any necessary string
4192 conversion, magic etc. Normally used via the C<SvUV(sv)> and C<SvUVx(sv)>
4203 Remove any string offset. You should normally use the C<SvOOK_off> macro
4206 int sv_backoff(SV* sv)
4214 Blesses an SV into a specified package. The SV must be an RV. The package
4215 must be designated by its stash (see C<gv_stashpv()>). The reference count
4216 of the SV is unaffected.
4218 SV* sv_bless(SV* sv, HV* stash)
4226 Concatenates the string onto the end of the string which is in the SV.
4227 If the SV has the UTF-8 status set, then the bytes appended should be
4228 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4230 void sv_catpv(SV* sv, const char* ptr)
4238 Processes its arguments like C<sprintf> and appends the formatted
4239 output to an SV. If the appended data contains "wide" characters
4240 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
4241 and characters >255 formatted with %c), the original SV might get
4242 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
4243 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
4244 valid UTF-8; if the original SV was bytes, the pattern should be too.
4246 void sv_catpvf(SV* sv, const char* pat, ...)
4254 Like C<sv_catpvf>, but also handles 'set' magic.
4256 void sv_catpvf_mg(SV *sv, const char* pat, ...)
4264 Concatenates the string onto the end of the string which is in the SV. The
4265 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4266 status set, then the bytes appended should be valid UTF-8.
4267 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4269 void sv_catpvn(SV* sv, const char* ptr, STRLEN len)
4274 =item sv_catpvn_flags
4277 Concatenates the string onto the end of the string which is in the SV. The
4278 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4279 status set, then the bytes appended should be valid UTF-8.
4280 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4281 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4282 in terms of this function.
4284 void sv_catpvn_flags(SV* sv, const char* ptr, STRLEN len, I32 flags)
4292 Like C<sv_catpvn>, but also handles 'set' magic.
4294 void sv_catpvn_mg(SV *sv, const char *ptr, STRLEN len)
4299 =item sv_catpvn_nomg
4302 Like C<sv_catpvn> but doesn't process magic.
4304 void sv_catpvn_nomg(SV* sv, const char* ptr, STRLEN len)
4312 Like C<sv_catpv>, but also handles 'set' magic.
4314 void sv_catpv_mg(SV *sv, const char *ptr)
4322 Concatenates the string from SV C<ssv> onto the end of the string in
4323 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4324 not 'set' magic. See C<sv_catsv_mg>.
4326 void sv_catsv(SV* dsv, SV* ssv)
4331 =item sv_catsv_flags
4334 Concatenates the string from SV C<ssv> onto the end of the string in
4335 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4336 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4337 and C<sv_catsv_nomg> are implemented in terms of this function.
4339 void sv_catsv_flags(SV* dsv, SV* ssv, I32 flags)
4347 Like C<sv_catsv>, but also handles 'set' magic.
4349 void sv_catsv_mg(SV *dstr, SV *sstr)
4357 Like C<sv_catsv> but doesn't process magic.
4359 void sv_catsv_nomg(SV* dsv, SV* ssv)
4367 Efficient removal of characters from the beginning of the string buffer.
4368 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4369 the string buffer. The C<ptr> becomes the first character of the adjusted
4370 string. Uses the "OOK hack".
4371 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4372 refer to the same chunk of data.
4374 void sv_chop(SV* sv, char* ptr)
4382 Clear an SV: call any destructors, free up any memory used by the body,
4383 and free the body itself. The SV's head is I<not> freed, although
4384 its type is set to all 1's so that it won't inadvertently be assumed
4385 to be live during global destruction etc.
4386 This function should only be called when REFCNT is zero. Most of the time
4387 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
4390 void sv_clear(SV* sv)
4398 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
4399 string in C<sv1> is less than, equal to, or greater than the string in
4400 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
4401 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
4403 I32 sv_cmp(SV* sv1, SV* sv2)
4411 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
4412 'use bytes' aware, handles get magic, and will coerce its args to strings
4413 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
4415 I32 sv_cmp_locale(SV* sv1, SV* sv2)
4423 Add Collate Transform magic to an SV if it doesn't already have it.
4425 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
4426 scalar data of the variable, but transformed to such a format that a normal
4427 memory comparison can be used to compare the data according to the locale
4430 char* sv_collxfrm(SV* sv, STRLEN* nxp)
4438 Copies a stringified representation of the source SV into the
4439 destination SV. Automatically performs any necessary mg_get and
4440 coercion of numeric values into strings. Guaranteed to preserve
4441 UTF-8 flag even from overloaded objects. Similar in nature to
4442 sv_2pv[_flags] but operates directly on an SV instead of just the
4443 string. Mostly uses sv_2pv_flags to do its work, except when that
4444 would lose the UTF-8'ness of the PV.
4446 void sv_copypv(SV* dsv, SV* ssv)
4454 Auto-decrement of the value in the SV, doing string to numeric conversion
4455 if necessary. Handles 'get' magic.
4462 =item sv_derived_from
4465 Returns a boolean indicating whether the SV is derived from the specified
4466 class. This is the function that implements C<UNIVERSAL::isa>. It works
4467 for class names as well as for objects.
4469 bool sv_derived_from(SV* sv, const char* name)
4472 Found in file universal.c
4477 Returns a boolean indicating whether the strings in the two SVs are
4478 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
4479 coerce its args to strings if necessary.
4481 I32 sv_eq(SV* sv1, SV* sv2)
4486 =item sv_force_normal
4489 Undo various types of fakery on an SV: if the PV is a shared string, make
4490 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4491 an xpvmg. See also C<sv_force_normal_flags>.
4493 void sv_force_normal(SV *sv)
4498 =item sv_force_normal_flags
4499 X<sv_force_normal_flags>
4501 Undo various types of fakery on an SV: if the PV is a shared string, make
4502 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4503 an xpvmg. The C<flags> parameter gets passed to C<sv_unref_flags()>
4504 when unrefing. C<sv_force_normal> calls this function with flags set to 0.
4506 void sv_force_normal_flags(SV *sv, U32 flags)
4514 Decrement an SV's reference count, and if it drops to zero, call
4515 C<sv_clear> to invoke destructors and free up any memory used by
4516 the body; finally, deallocate the SV's head itself.
4517 Normally called via a wrapper macro C<SvREFCNT_dec>.
4519 void sv_free(SV* sv)
4527 Get a line from the filehandle and store it into the SV, optionally
4528 appending to the currently-stored string.
4530 char* sv_gets(SV* sv, PerlIO* fp, I32 append)
4538 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
4539 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
4540 Use the C<SvGROW> wrapper instead.
4542 char* sv_grow(SV* sv, STRLEN newlen)
4550 Auto-increment of the value in the SV, doing string to numeric conversion
4551 if necessary. Handles 'get' magic.
4561 Inserts a string at the specified offset/length within the SV. Similar to
4562 the Perl substr() function.
4564 void sv_insert(SV* bigsv, STRLEN offset, STRLEN len, char* little, STRLEN littlelen)
4572 Returns a boolean indicating whether the SV is blessed into the specified
4573 class. This does not check for subtypes; use C<sv_derived_from> to verify
4574 an inheritance relationship.
4576 int sv_isa(SV* sv, const char* name)
4584 Returns a boolean indicating whether the SV is an RV pointing to a blessed
4585 object. If the SV is not an RV, or if the object is not blessed, then this
4588 int sv_isobject(SV* sv)
4596 A private implementation of the C<SvIVx> macro for compilers which can't
4597 cope with complex macro expressions. Always use the macro instead.
4607 Returns the length of the string in the SV. Handles magic and type
4608 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
4610 STRLEN sv_len(SV* sv)
4618 Returns the number of characters in the string in an SV, counting wide
4619 UTF-8 bytes as a single character. Handles magic and type coercion.
4621 STRLEN sv_len_utf8(SV* sv)
4629 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4630 then adds a new magic item of type C<how> to the head of the magic list.
4632 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4633 handling of the C<name> and C<namlen> arguments.
4635 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4636 to add more than one instance of the same 'how'.
4638 void sv_magic(SV* sv, SV* obj, int how, const char* name, I32 namlen)
4646 Adds magic to an SV, upgrading it if necessary. Applies the
4647 supplied vtable and returns a pointer to the magic added.
4649 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4650 In particular, you can add magic to SvREADONLY SVs, and add more than
4651 one instance of the same 'how'.
4653 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4654 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4655 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4656 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4658 (This is now used as a subroutine by C<sv_magic>.)
4660 MAGIC * sv_magicext(SV* sv, SV* obj, int how, MGVTBL *vtbl, const char* name, I32 namlen)
4668 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
4669 The new SV is marked as mortal. It will be destroyed "soon", either by an
4670 explicit call to FREETMPS, or by an implicit call at places such as
4671 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
4673 SV* sv_mortalcopy(SV* oldsv)
4681 Creates a new null SV which is mortal. The reference count of the SV is
4682 set to 1. It will be destroyed "soon", either by an explicit call to
4683 FREETMPS, or by an implicit call at places such as statement boundaries.
4684 See also C<sv_mortalcopy> and C<sv_2mortal>.
4694 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
4697 SV* sv_newref(SV* sv)
4705 A private implementation of the C<SvNVx> macro for compilers which can't
4706 cope with complex macro expressions. Always use the macro instead.
4716 Converts the value pointed to by offsetp from a count of bytes from the
4717 start of the string, to a count of the equivalent number of UTF-8 chars.
4718 Handles magic and type coercion.
4720 void sv_pos_b2u(SV* sv, I32* offsetp)
4728 Converts the value pointed to by offsetp from a count of UTF-8 chars from
4729 the start of the string, to a count of the equivalent number of bytes; if
4730 lenp is non-zero, it does the same to lenp, but this time starting from
4731 the offset, rather than from the start of the string. Handles magic and
4734 void sv_pos_u2b(SV* sv, I32* offsetp, I32* lenp)
4742 Use the C<SvPV_nolen> macro instead
4752 Use C<SvPVbyte_nolen> instead.
4754 char* sv_pvbyte(SV *sv)
4762 A private implementation of the C<SvPVbyte> macro for compilers
4763 which can't cope with complex macro expressions. Always use the macro
4766 char* sv_pvbyten(SV *sv, STRLEN *len)
4771 =item sv_pvbyten_force
4774 A private implementation of the C<SvPVbytex_force> macro for compilers
4775 which can't cope with complex macro expressions. Always use the macro
4778 char* sv_pvbyten_force(SV* sv, STRLEN* lp)
4786 A private implementation of the C<SvPV> macro for compilers which can't
4787 cope with complex macro expressions. Always use the macro instead.
4789 char* sv_pvn(SV *sv, STRLEN *len)
4797 Get a sensible string out of the SV somehow.
4798 A private implementation of the C<SvPV_force> macro for compilers which
4799 can't cope with complex macro expressions. Always use the macro instead.
4801 char* sv_pvn_force(SV* sv, STRLEN* lp)
4806 =item sv_pvn_force_flags
4807 X<sv_pvn_force_flags>
4809 Get a sensible string out of the SV somehow.
4810 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
4811 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
4812 implemented in terms of this function.
4813 You normally want to use the various wrapper macros instead: see
4814 C<SvPV_force> and C<SvPV_force_nomg>
4816 char* sv_pvn_force_flags(SV* sv, STRLEN* lp, I32 flags)
4824 Use the C<SvPVutf8_nolen> macro instead
4826 char* sv_pvutf8(SV *sv)
4834 A private implementation of the C<SvPVutf8> macro for compilers
4835 which can't cope with complex macro expressions. Always use the macro
4838 char* sv_pvutf8n(SV *sv, STRLEN *len)
4843 =item sv_pvutf8n_force
4846 A private implementation of the C<SvPVutf8_force> macro for compilers
4847 which can't cope with complex macro expressions. Always use the macro
4850 char* sv_pvutf8n_force(SV* sv, STRLEN* lp)
4858 Returns a string describing what the SV is a reference to.
4860 char* sv_reftype(SV* sv, int ob)
4868 Make the first argument a copy of the second, then delete the original.
4869 The target SV physically takes over ownership of the body of the source SV
4870 and inherits its flags; however, the target keeps any magic it owns,
4871 and any magic in the source is discarded.
4872 Note that this is a rather specialist SV copying operation; most of the
4873 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4875 void sv_replace(SV* sv, SV* nsv)
4880 =item sv_report_used
4883 Dump the contents of all SVs not yet freed. (Debugging aid).
4885 void sv_report_used()
4893 Underlying implementation for the C<reset> Perl function.
4894 Note that the perl-level function is vaguely deprecated.
4896 void sv_reset(char* s, HV* stash)
4904 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4905 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4906 push a back-reference to this RV onto the array of backreferences
4907 associated with that magic.
4909 SV* sv_rvweaken(SV *sv)
4917 Copies an integer into the given SV, upgrading first if necessary.
4918 Does not handle 'set' magic. See also C<sv_setiv_mg>.
4920 void sv_setiv(SV* sv, IV num)
4928 Like C<sv_setiv>, but also handles 'set' magic.
4930 void sv_setiv_mg(SV *sv, IV i)
4938 Copies a double into the given SV, upgrading first if necessary.
4939 Does not handle 'set' magic. See also C<sv_setnv_mg>.
4941 void sv_setnv(SV* sv, NV num)
4949 Like C<sv_setnv>, but also handles 'set' magic.
4951 void sv_setnv_mg(SV *sv, NV num)
4959 Copies a string into an SV. The string must be null-terminated. Does not
4960 handle 'set' magic. See C<sv_setpv_mg>.
4962 void sv_setpv(SV* sv, const char* ptr)
4970 Works like C<sv_catpvf> but copies the text into the SV instead of
4971 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
4973 void sv_setpvf(SV* sv, const char* pat, ...)
4981 Like C<sv_setpvf>, but also handles 'set' magic.
4983 void sv_setpvf_mg(SV *sv, const char* pat, ...)
4991 Copies an integer into the given SV, also updating its string value.
4992 Does not handle 'set' magic. See C<sv_setpviv_mg>.
4994 void sv_setpviv(SV* sv, IV num)
5002 Like C<sv_setpviv>, but also handles 'set' magic.
5004 void sv_setpviv_mg(SV *sv, IV iv)
5012 Copies a string into an SV. The C<len> parameter indicates the number of
5013 bytes to be copied. If the C<ptr> argument is NULL the SV will become
5014 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
5016 void sv_setpvn(SV* sv, const char* ptr, STRLEN len)
5024 Like C<sv_setpvn>, but also handles 'set' magic.
5026 void sv_setpvn_mg(SV *sv, const char *ptr, STRLEN len)
5034 Like C<sv_setpv>, but also handles 'set' magic.
5036 void sv_setpv_mg(SV *sv, const char *ptr)
5044 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
5045 argument will be upgraded to an RV. That RV will be modified to point to
5046 the new SV. The C<classname> argument indicates the package for the
5047 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
5048 will have a reference count of 1, and the RV will be returned.
5050 SV* sv_setref_iv(SV* rv, const char* classname, IV iv)
5058 Copies a double into a new SV, optionally blessing the SV. The C<rv>
5059 argument will be upgraded to an RV. That RV will be modified to point to
5060 the new SV. The C<classname> argument indicates the package for the
5061 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
5062 will have a reference count of 1, and the RV will be returned.
5064 SV* sv_setref_nv(SV* rv, const char* classname, NV nv)
5072 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
5073 argument will be upgraded to an RV. That RV will be modified to point to
5074 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
5075 into the SV. The C<classname> argument indicates the package for the
5076 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
5077 will have a reference count of 1, and the RV will be returned.
5079 Do not use with other Perl types such as HV, AV, SV, CV, because those
5080 objects will become corrupted by the pointer copy process.
5082 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
5084 SV* sv_setref_pv(SV* rv, const char* classname, void* pv)
5092 Copies a string into a new SV, optionally blessing the SV. The length of the
5093 string must be specified with C<n>. The C<rv> argument will be upgraded to
5094 an RV. That RV will be modified to point to the new SV. The C<classname>
5095 argument indicates the package for the blessing. Set C<classname> to
5096 C<Nullch> to avoid the blessing. The new SV will have a reference count
5097 of 1, and the RV will be returned.
5099 Note that C<sv_setref_pv> copies the pointer while this copies the string.
5101 SV* sv_setref_pvn(SV* rv, const char* classname, char* pv, STRLEN n)
5109 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
5110 argument will be upgraded to an RV. That RV will be modified to point to
5111 the new SV. The C<classname> argument indicates the package for the
5112 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
5113 will have a reference count of 1, and the RV will be returned.
5115 SV* sv_setref_uv(SV* rv, const char* classname, UV uv)
5123 Copies the contents of the source SV C<ssv> into the destination SV
5124 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
5125 function if the source SV needs to be reused. Does not handle 'set' magic.
5126 Loosely speaking, it performs a copy-by-value, obliterating any previous
5127 content of the destination.
5129 You probably want to use one of the assortment of wrappers, such as
5130 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
5131 C<SvSetMagicSV_nosteal>.
5133 void sv_setsv(SV* dsv, SV* ssv)
5138 =item sv_setsv_flags
5141 Copies the contents of the source SV C<ssv> into the destination SV
5142 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
5143 function if the source SV needs to be reused. Does not handle 'set' magic.
5144 Loosely speaking, it performs a copy-by-value, obliterating any previous
5145 content of the destination.
5146 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
5147 C<ssv> if appropriate, else not. If the C<flags> parameter has the
5148 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
5149 and C<sv_setsv_nomg> are implemented in terms of this function.
5151 You probably want to use one of the assortment of wrappers, such as
5152 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
5153 C<SvSetMagicSV_nosteal>.
5155 This is the primary function for copying scalars, and most other
5156 copy-ish functions and macros use this underneath.
5158 void sv_setsv_flags(SV* dsv, SV* ssv, I32 flags)
5166 Like C<sv_setsv>, but also handles 'set' magic.
5168 void sv_setsv_mg(SV *dstr, SV *sstr)
5176 Like C<sv_setsv> but doesn't process magic.
5178 void sv_setsv_nomg(SV* dsv, SV* ssv)
5186 Copies an unsigned integer into the given SV, upgrading first if necessary.
5187 Does not handle 'set' magic. See also C<sv_setuv_mg>.
5189 void sv_setuv(SV* sv, UV num)
5197 Like C<sv_setuv>, but also handles 'set' magic.
5199 void sv_setuv_mg(SV *sv, UV u)
5207 Taint an SV. Use C<SvTAINTED_on> instead.
5208 void sv_taint(SV* sv)
5216 Test an SV for taintedness. Use C<SvTAINTED> instead.
5217 bool sv_tainted(SV* sv)
5225 Returns true if the SV has a true value by Perl's rules.
5226 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
5227 instead use an in-line version.
5237 Removes all magic of type C<type> from an SV.
5239 int sv_unmagic(SV* sv, int type)
5247 Unsets the RV status of the SV, and decrements the reference count of
5248 whatever was being referenced by the RV. This can almost be thought of
5249 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
5250 being zero. See C<SvROK_off>.
5252 void sv_unref(SV* sv)
5257 =item sv_unref_flags
5260 Unsets the RV status of the SV, and decrements the reference count of
5261 whatever was being referenced by the RV. This can almost be thought of
5262 as a reversal of C<newSVrv>. The C<cflags> argument can contain
5263 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
5264 (otherwise the decrementing is conditional on the reference count being
5265 different from one or the reference being a readonly SV).
5268 void sv_unref_flags(SV* sv, U32 flags)
5276 Untaint an SV. Use C<SvTAINTED_off> instead.
5277 void sv_untaint(SV* sv)
5285 Upgrade an SV to a more complex form. Generally adds a new body type to the
5286 SV, then copies across as much information as possible from the old body.
5287 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
5289 bool sv_upgrade(SV* sv, U32 mt)
5297 Tells an SV to use C<ptr> to find its string value. Normally the string is
5298 stored inside the SV but sv_usepvn allows the SV to use an outside string.
5299 The C<ptr> should point to memory that was allocated by C<malloc>. The
5300 string length, C<len>, must be supplied. This function will realloc the
5301 memory pointed to by C<ptr>, so that pointer should not be freed or used by
5302 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
5303 See C<sv_usepvn_mg>.
5305 void sv_usepvn(SV* sv, char* ptr, STRLEN len)
5313 Like C<sv_usepvn>, but also handles 'set' magic.
5315 void sv_usepvn_mg(SV *sv, char *ptr, STRLEN len)
5320 =item sv_utf8_decode
5323 If the PV of the SV is an octet sequence in UTF-8
5324 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
5325 so that it looks like a character. If the PV contains only single-byte
5326 characters, the C<SvUTF8> flag stays being off.
5327 Scans PV for validity and returns false if the PV is invalid UTF-8.
5329 NOTE: this function is experimental and may change or be
5330 removed without notice.
5332 bool sv_utf8_decode(SV *sv)
5337 =item sv_utf8_downgrade
5338 X<sv_utf8_downgrade>
5340 Attempts to convert the PV of an SV from characters to bytes.
5341 If the PV contains a character beyond byte, this conversion will fail;
5342 in this case, either returns false or, if C<fail_ok> is not
5345 This is not as a general purpose Unicode to byte encoding interface:
5346 use the Encode extension for that.
5348 NOTE: this function is experimental and may change or be
5349 removed without notice.
5351 bool sv_utf8_downgrade(SV *sv, bool fail_ok)
5356 =item sv_utf8_encode
5359 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
5360 flag off so that it looks like octets again.
5362 void sv_utf8_encode(SV *sv)
5367 =item sv_utf8_upgrade
5370 Converts the PV of an SV to its UTF-8-encoded form.
5371 Forces the SV to string form if it is not already.
5372 Always sets the SvUTF8 flag to avoid future validity checks even
5373 if all the bytes have hibit clear.
5375 This is not as a general purpose byte encoding to Unicode interface:
5376 use the Encode extension for that.
5378 STRLEN sv_utf8_upgrade(SV *sv)
5383 =item sv_utf8_upgrade_flags
5384 X<sv_utf8_upgrade_flags>
5386 Converts the PV of an SV to its UTF-8-encoded form.
5387 Forces the SV to string form if it is not already.
5388 Always sets the SvUTF8 flag to avoid future validity checks even
5389 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
5390 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
5391 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
5393 This is not as a general purpose byte encoding to Unicode interface:
5394 use the Encode extension for that.
5396 STRLEN sv_utf8_upgrade_flags(SV *sv, I32 flags)
5404 A private implementation of the C<SvUVx> macro for compilers which can't
5405 cope with complex macro expressions. Always use the macro instead.
5415 Processes its arguments like C<vsprintf> and appends the formatted output
5416 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
5418 Usually used via its frontend C<sv_catpvf>.
5420 void sv_vcatpvf(SV* sv, const char* pat, va_list* args)
5428 Processes its arguments like C<vsprintf> and appends the formatted output
5429 to an SV. Uses an array of SVs if the C style variable argument list is
5430 missing (NULL). When running with taint checks enabled, indicates via
5431 C<maybe_tainted> if results are untrustworthy (often due to the use of
5434 XXX Except that it maybe_tainted is never assigned to.
5436 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
5438 void sv_vcatpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
5446 Like C<sv_vcatpvf>, but also handles 'set' magic.
5448 Usually used via its frontend C<sv_catpvf_mg>.
5450 void sv_vcatpvf_mg(SV* sv, const char* pat, va_list* args)
5458 Works like C<sv_vcatpvf> but copies the text into the SV instead of
5459 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
5461 Usually used via its frontend C<sv_setpvf>.
5463 void sv_vsetpvf(SV* sv, const char* pat, va_list* args)
5471 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
5474 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
5476 void sv_vsetpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
5484 Like C<sv_vsetpvf>, but also handles 'set' magic.
5486 Usually used via its frontend C<sv_setpvf_mg>.
5488 void sv_vsetpvf_mg(SV* sv, const char* pat, va_list* args)
5496 =head1 Unicode Support
5500 =item bytes_from_utf8
5503 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
5504 Unlike C<utf8_to_bytes> but like C<bytes_to_utf8>, returns a pointer to
5505 the newly-created string, and updates C<len> to contain the new
5506 length. Returns the original string if no conversion occurs, C<len>
5507 is unchanged. Do nothing if C<is_utf8> points to 0. Sets C<is_utf8> to
5508 0 if C<s> is converted or contains all 7bit characters.
5510 NOTE: this function is experimental and may change or be
5511 removed without notice.
5513 U8* bytes_from_utf8(U8 *s, STRLEN *len, bool *is_utf8)
5516 Found in file utf8.c
5521 Converts a string C<s> of length C<len> from ASCII into UTF-8 encoding.
5522 Returns a pointer to the newly-created string, and sets C<len> to
5523 reflect the new length.
5525 If you want to convert to UTF-8 from other encodings than ASCII,
5526 see sv_recode_to_utf8().
5528 NOTE: this function is experimental and may change or be
5529 removed without notice.
5531 U8* bytes_to_utf8(U8 *s, STRLEN *len)
5534 Found in file utf8.c
5539 Return true if the strings s1 and s2 differ case-insensitively, false
5540 if not (if they are equal case-insensitively). If u1 is true, the
5541 string s1 is assumed to be in UTF-8-encoded Unicode. If u2 is true,
5542 the string s2 is assumed to be in UTF-8-encoded Unicode. If u1 or u2
5543 are false, the respective string is assumed to be in native 8-bit
5546 If the pe1 and pe2 are non-NULL, the scanning pointers will be copied
5547 in there (they will point at the beginning of the I<next> character).
5548 If the pointers behind pe1 or pe2 are non-NULL, they are the end
5549 pointers beyond which scanning will not continue under any
5550 circumstances. If the byte lengths l1 and l2 are non-zero, s1+l1 and
5551 s2+l2 will be used as goal end pointers that will also stop the scan,
5552 and which qualify towards defining a successful match: all the scans
5553 that define an explicit length must reach their goal pointers for
5554 a match to succeed).
5556 For case-insensitiveness, the "casefolding" of Unicode is used
5557 instead of upper/lowercasing both the characters, see
5558 http://www.unicode.org/unicode/reports/tr21/ (Case Mappings).
5560 I32 ibcmp_utf8(const char* a, char **pe1, UV l1, bool u1, const char* b, char **pe2, UV l2, bool u2)
5563 Found in file utf8.c
5568 Tests if some arbitrary number of bytes begins in a valid UTF-8
5569 character. Note that an INVARIANT (i.e. ASCII) character is a valid
5570 UTF-8 character. The actual number of bytes in the UTF-8 character
5571 will be returned if it is valid, otherwise 0.
5573 STRLEN is_utf8_char(U8 *p)
5576 Found in file utf8.c
5578 =item is_utf8_string
5581 Returns true if first C<len> bytes of the given string form a valid
5582 UTF-8 string, false otherwise. Note that 'a valid UTF-8 string' does
5583 not mean 'a string that contains code points above 0x7F encoded in UTF-8'
5584 because a valid ASCII string is a valid UTF-8 string.
5586 See also is_utf8_string_loclen() and is_utf8_string_loc().
5588 bool is_utf8_string(U8 *s, STRLEN len)
5591 Found in file utf8.c
5593 =item is_utf8_string_loc
5594 X<is_utf8_string_loc>
5596 Like is_utf8_string() but stores the location of the failure (in the
5597 case of "utf8ness failure") or the location s+len (in the case of
5598 "utf8ness success") in the C<ep>.
5600 See also is_utf8_string_loclen() and is_utf8_string().
5602 bool is_utf8_string_loc(U8 *s, STRLEN len, U8 **p)
5605 Found in file utf8.c
5607 =item is_utf8_string_loclen
5608 X<is_utf8_string_loclen>
5610 Like is_utf8_string() but stores the location of the failure (in the
5611 case of "utf8ness failure") or the location s+len (in the case of
5612 "utf8ness success") in the C<ep>, and the number of UTF-8
5613 encoded characters in the C<el>.
5615 See also is_utf8_string_loc() and is_utf8_string().
5617 bool is_utf8_string_loclen(const U8 *s, STRLEN len, const U8 **ep, STRLEN *el)
5620 Found in file utf8.c
5622 =item pv_uni_display
5625 Build to the scalar dsv a displayable version of the string spv,
5626 length len, the displayable version being at most pvlim bytes long
5627 (if longer, the rest is truncated and "..." will be appended).
5629 The flags argument can have UNI_DISPLAY_ISPRINT set to display
5630 isPRINT()able characters as themselves, UNI_DISPLAY_BACKSLASH
5631 to display the \\[nrfta\\] as the backslashed versions (like '\n')
5632 (UNI_DISPLAY_BACKSLASH is preferred over UNI_DISPLAY_ISPRINT for \\).
5633 UNI_DISPLAY_QQ (and its alias UNI_DISPLAY_REGEX) have both
5634 UNI_DISPLAY_BACKSLASH and UNI_DISPLAY_ISPRINT turned on.
5636 The pointer to the PV of the dsv is returned.
5638 char* pv_uni_display(SV *dsv, U8 *spv, STRLEN len, STRLEN pvlim, UV flags)
5641 Found in file utf8.c
5646 The encoding is assumed to be an Encode object, the PV of the ssv is
5647 assumed to be octets in that encoding and decoding the input starts
5648 from the position which (PV + *offset) pointed to. The dsv will be
5649 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
5650 when the string tstr appears in decoding output or the input ends on
5651 the PV of the ssv. The value which the offset points will be modified
5652 to the last input position on the ssv.
5654 Returns TRUE if the terminator was found, else returns FALSE.
5656 bool sv_cat_decode(SV* dsv, SV *encoding, SV *ssv, int *offset, char* tstr, int tlen)
5661 =item sv_recode_to_utf8
5662 X<sv_recode_to_utf8>
5664 The encoding is assumed to be an Encode object, on entry the PV
5665 of the sv is assumed to be octets in that encoding, and the sv
5666 will be converted into Unicode (and UTF-8).
5668 If the sv already is UTF-8 (or if it is not POK), or if the encoding
5669 is not a reference, nothing is done to the sv. If the encoding is not
5670 an C<Encode::XS> Encoding object, bad things will happen.
5671 (See F<lib/encoding.pm> and L<Encode>).
5673 The PV of the sv is returned.
5675 char* sv_recode_to_utf8(SV* sv, SV *encoding)
5680 =item sv_uni_display
5683 Build to the scalar dsv a displayable version of the scalar sv,
5684 the displayable version being at most pvlim bytes long
5685 (if longer, the rest is truncated and "..." will be appended).
5687 The flags argument is as in pv_uni_display().
5689 The pointer to the PV of the dsv is returned.
5691 char* sv_uni_display(SV *dsv, SV *ssv, STRLEN pvlim, UV flags)
5694 Found in file utf8.c
5699 The "p" contains the pointer to the UTF-8 string encoding
5700 the character that is being converted.
5702 The "ustrp" is a pointer to the character buffer to put the
5703 conversion result to. The "lenp" is a pointer to the length
5706 The "swashp" is a pointer to the swash to use.
5708 Both the special and normal mappings are stored lib/unicore/To/Foo.pl,
5709 and loaded by SWASHGET, using lib/utf8_heavy.pl. The special (usually,
5710 but not always, a multicharacter mapping), is tried first.
5712 The "special" is a string like "utf8::ToSpecLower", which means the
5713 hash %utf8::ToSpecLower. The access to the hash is through
5714 Perl_to_utf8_case().
5716 The "normal" is a string like "ToLower" which means the swash
5719 UV to_utf8_case(U8 *p, U8* ustrp, STRLEN *lenp, SV **swashp, char *normal, char *special)
5722 Found in file utf8.c
5727 Convert the UTF-8 encoded character at p to its foldcase version and
5728 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
5729 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
5730 foldcase version may be longer than the original character (up to
5733 The first character of the foldcased version is returned
5734 (but note, as explained above, that there may be more.)
5736 UV to_utf8_fold(U8 *p, U8* ustrp, STRLEN *lenp)
5739 Found in file utf8.c
5744 Convert the UTF-8 encoded character at p to its lowercase version and
5745 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
5746 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
5747 lowercase version may be longer than the original character.
5749 The first character of the lowercased version is returned
5750 (but note, as explained above, that there may be more.)
5752 UV to_utf8_lower(U8 *p, U8* ustrp, STRLEN *lenp)
5755 Found in file utf8.c
5760 Convert the UTF-8 encoded character at p to its titlecase version and
5761 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
5762 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
5763 titlecase version may be longer than the original character.
5765 The first character of the titlecased version is returned
5766 (but note, as explained above, that there may be more.)
5768 UV to_utf8_title(U8 *p, U8* ustrp, STRLEN *lenp)
5771 Found in file utf8.c
5776 Convert the UTF-8 encoded character at p to its uppercase version and
5777 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
5778 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since
5779 the uppercase version may be longer than the original character.
5781 The first character of the uppercased version is returned
5782 (but note, as explained above, that there may be more.)
5784 UV to_utf8_upper(U8 *p, U8* ustrp, STRLEN *lenp)
5787 Found in file utf8.c
5789 =item utf8n_to_uvchr
5792 Returns the native character value of the first character in the string C<s>
5793 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
5794 length, in bytes, of that character.
5796 Allows length and flags to be passed to low level routine.
5798 UV utf8n_to_uvchr(U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags)
5801 Found in file utf8.c
5803 =item utf8n_to_uvuni
5806 Bottom level UTF-8 decode routine.
5807 Returns the unicode code point value of the first character in the string C<s>
5808 which is assumed to be in UTF-8 encoding and no longer than C<curlen>;
5809 C<retlen> will be set to the length, in bytes, of that character.
5811 If C<s> does not point to a well-formed UTF-8 character, the behaviour
5812 is dependent on the value of C<flags>: if it contains UTF8_CHECK_ONLY,
5813 it is assumed that the caller will raise a warning, and this function
5814 will silently just set C<retlen> to C<-1> and return zero. If the
5815 C<flags> does not contain UTF8_CHECK_ONLY, warnings about
5816 malformations will be given, C<retlen> will be set to the expected
5817 length of the UTF-8 character in bytes, and zero will be returned.
5819 The C<flags> can also contain various flags to allow deviations from
5820 the strict UTF-8 encoding (see F<utf8.h>).
5822 Most code should use utf8_to_uvchr() rather than call this directly.
5824 UV utf8n_to_uvuni(U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags)
5827 Found in file utf8.c
5832 Returns the number of UTF-8 characters between the UTF-8 pointers C<a>
5835 WARNING: use only if you *know* that the pointers point inside the
5838 IV utf8_distance(U8 *a, U8 *b)
5841 Found in file utf8.c
5846 Return the UTF-8 pointer C<s> displaced by C<off> characters, either
5847 forward or backward.
5849 WARNING: do not use the following unless you *know* C<off> is within
5850 the UTF-8 data pointed to by C<s> *and* that on entry C<s> is aligned
5851 on the first byte of character or just after the last byte of a character.
5853 U8* utf8_hop(U8 *s, I32 off)
5856 Found in file utf8.c
5861 Return the length of the UTF-8 char encoded string C<s> in characters.
5862 Stops at C<e> (inclusive). If C<e E<lt> s> or if the scan would end
5863 up past C<e>, croaks.
5865 STRLEN utf8_length(U8* s, U8 *e)
5868 Found in file utf8.c
5873 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
5874 Unlike C<bytes_to_utf8>, this over-writes the original string, and
5875 updates len to contain the new length.
5876 Returns zero on failure, setting C<len> to -1.
5878 NOTE: this function is experimental and may change or be
5879 removed without notice.
5881 U8* utf8_to_bytes(U8 *s, STRLEN *len)
5884 Found in file utf8.c
5889 Returns the native character value of the first character in the string C<s>
5890 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
5891 length, in bytes, of that character.
5893 If C<s> does not point to a well-formed UTF-8 character, zero is
5894 returned and retlen is set, if possible, to -1.
5896 UV utf8_to_uvchr(U8 *s, STRLEN *retlen)
5899 Found in file utf8.c
5904 Returns the Unicode code point of the first character in the string C<s>
5905 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
5906 length, in bytes, of that character.
5908 This function should only be used when returned UV is considered
5909 an index into the Unicode semantic tables (e.g. swashes).
5911 If C<s> does not point to a well-formed UTF-8 character, zero is
5912 returned and retlen is set, if possible, to -1.
5914 UV utf8_to_uvuni(U8 *s, STRLEN *retlen)
5917 Found in file utf8.c
5922 Adds the UTF-8 representation of the Native codepoint C<uv> to the end
5923 of the string C<d>; C<d> should be have at least C<UTF8_MAXBYTES+1> free
5924 bytes available. The return value is the pointer to the byte after the
5925 end of the new character. In other words,
5927 d = uvchr_to_utf8(d, uv);
5929 is the recommended wide native character-aware way of saying
5933 U8* uvchr_to_utf8(U8 *d, UV uv)
5936 Found in file utf8.c
5938 =item uvuni_to_utf8_flags
5939 X<uvuni_to_utf8_flags>
5941 Adds the UTF-8 representation of the Unicode codepoint C<uv> to the end
5942 of the string C<d>; C<d> should be have at least C<UTF8_MAXBYTES+1> free
5943 bytes available. The return value is the pointer to the byte after the
5944 end of the new character. In other words,
5946 d = uvuni_to_utf8_flags(d, uv, flags);
5950 d = uvuni_to_utf8(d, uv);
5952 (which is equivalent to)
5954 d = uvuni_to_utf8_flags(d, uv, 0);
5956 is the recommended Unicode-aware way of saying
5960 U8* uvuni_to_utf8_flags(U8 *d, UV uv, UV flags)
5963 Found in file utf8.c
5968 =head1 Variables created by C<xsubpp> and C<xsubpp> internal functions
5975 Variable which is setup by C<xsubpp> to indicate the stack base offset,
5976 used by the C<ST>, C<XSprePUSH> and C<XSRETURN> macros. The C<dMARK> macro
5977 must be called prior to setup the C<MARK> variable.
5982 Found in file XSUB.h
5987 Variable which is setup by C<xsubpp> to indicate the
5988 class name for a C++ XS constructor. This is always a C<char*>. See C<THIS>.
5993 Found in file XSUB.h
5998 Sets up the C<ax> variable.
5999 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
6004 Found in file XSUB.h
6009 Sets up the C<ax> variable and stack marker variable C<mark>.
6010 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
6015 Found in file XSUB.h
6020 Sets up the C<items> variable.
6021 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
6026 Found in file XSUB.h
6031 Sets up stack and mark pointers for an XSUB, calling dSP and dMARK.
6032 Sets up the C<ax> and C<items> variables by calling C<dAX> and C<dITEMS>.
6033 This is usually handled automatically by C<xsubpp>.
6038 Found in file XSUB.h
6043 Sets up the C<ix> variable for an XSUB which has aliases. This is usually
6044 handled automatically by C<xsubpp>.
6049 Found in file XSUB.h
6054 Variable which is setup by C<xsubpp> to indicate the number of
6055 items on the stack. See L<perlxs/"Variable-length Parameter Lists">.
6060 Found in file XSUB.h
6065 Variable which is setup by C<xsubpp> to indicate which of an
6066 XSUB's aliases was used to invoke it. See L<perlxs/"The ALIAS: Keyword">.
6071 Found in file XSUB.h
6076 Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
6080 Found in file XSUB.h
6085 Variable which is setup by C<xsubpp> to hold the return value for an
6086 XSUB. This is always the proper type for the XSUB. See
6087 L<perlxs/"The RETVAL Variable">.
6092 Found in file XSUB.h
6097 Used to access elements on the XSUB's stack.
6102 Found in file XSUB.h
6107 Variable which is setup by C<xsubpp> to designate the object in a C++
6108 XSUB. This is always the proper type for the C++ object. See C<CLASS> and
6109 L<perlxs/"Using XS With C++">.
6114 Found in file XSUB.h
6119 Macro to declare an XSUB and its C parameter list. This is handled by
6123 Found in file XSUB.h
6128 The version identifier for an XS module. This is usually
6129 handled automatically by C<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>.
6132 Found in file XSUB.h
6134 =item XS_VERSION_BOOTCHECK
6135 X<XS_VERSION_BOOTCHECK>
6137 Macro to verify that a PM module's $VERSION variable matches the XS
6138 module's C<XS_VERSION> variable. This is usually handled automatically by
6139 C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">.
6141 XS_VERSION_BOOTCHECK;
6144 Found in file XSUB.h
6149 =head1 Warning and Dieing
6156 This is the XSUB-writer's interface to Perl's C<die> function.
6157 Normally call this function the same way you call the C C<printf>
6158 function. Calling C<croak> returns control directly to Perl,
6159 sidestepping the normal C order of execution. See C<warn>.
6161 If you want to throw an exception object, assign the object to
6162 C<$@> and then pass C<Nullch> to croak():
6164 errsv = get_sv("@", TRUE);
6165 sv_setsv(errsv, exception_object);
6168 void croak(const char* pat, ...)
6171 Found in file util.c
6176 This is the XSUB-writer's interface to Perl's C<warn> function. Call this
6177 function the same way you call the C C<printf> function. See C<croak>.
6179 void warn(const char* pat, ...)
6182 Found in file util.c
6189 Until May 1997, this document was maintained by Jeff Okamoto
6190 <okamoto@corp.hp.com>. It is now maintained as part of Perl itself.
6192 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
6193 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
6194 Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
6195 Stephen McCamant, and Gurusamy Sarathy.
6197 API Listing originally by Dean Roehrich <roehrich@cray.com>.
6199 Updated to be autogenerated from comments in the source by Benjamin Stuhl.
6203 perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
https://perl5.git.perl.org / perl5.git / blob