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
199 I32 av_len(const AV* ar)
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, const char *pat, const 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, const char *pat, const 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(const char *pat, const char *patend, const char *s, const 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(const char *pat, const char *patend, const char *s, const char *strbeg, const 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, or NULL if C<stash> isn't a stash.
1173 See C<SvSTASH>, C<CvSTASH>.
1175 char* HvNAME(HV* stash)
1183 Check that a hash is in an internally consistent state.
1185 void hv_assert(HV* tb)
1193 Clears a hash, making it empty.
1195 void hv_clear(HV* tb)
1200 =item hv_clear_placeholders
1201 X<hv_clear_placeholders>
1203 Clears any placeholders from a hash. If a restricted hash has any of its keys
1204 marked as readonly and the key is subsequently deleted, the key is not actually
1205 deleted but is marked by assigning it a value of &PL_sv_placeholder. This tags
1206 it so it will be ignored by future operations such as iterating over the hash,
1207 but will still allow the hash to have a value reassigned to the key at some
1208 future point. This function clears any such placeholder keys from the hash.
1209 See Hash::Util::lock_keys() for an example of its use.
1211 void hv_clear_placeholders(HV* hb)
1219 Deletes a key/value pair in the hash. The value SV is removed from the
1220 hash and returned to the caller. The C<klen> is the length of the key.
1221 The C<flags> value will normally be zero; if set to G_DISCARD then NULL
1224 SV* hv_delete(HV* tb, const char* key, I32 klen, I32 flags)
1232 Deletes a key/value pair in the hash. The value SV is removed from the
1233 hash and returned to the caller. The C<flags> value will normally be zero;
1234 if set to G_DISCARD then NULL will be returned. C<hash> can be a valid
1235 precomputed hash value, or 0 to ask for it to be computed.
1237 SV* hv_delete_ent(HV* tb, SV* key, I32 flags, U32 hash)
1245 Returns a boolean indicating whether the specified hash key exists. The
1246 C<klen> is the length of the key.
1248 bool hv_exists(HV* tb, const char* key, I32 klen)
1256 Returns a boolean indicating whether the specified hash key exists. C<hash>
1257 can be a valid precomputed hash value, or 0 to ask for it to be
1260 bool hv_exists_ent(HV* tb, SV* key, U32 hash)
1268 Returns the SV which corresponds to the specified key in the hash. The
1269 C<klen> is the length of the key. If C<lval> is set then the fetch will be
1270 part of a store. Check that the return value is non-null before
1271 dereferencing it to an C<SV*>.
1273 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1274 information on how to use this function on tied hashes.
1276 SV** hv_fetch(HV* tb, const char* key, I32 klen, I32 lval)
1284 Returns the hash entry which corresponds to the specified key in the hash.
1285 C<hash> must be a valid precomputed hash number for the given C<key>, or 0
1286 if you want the function to compute it. IF C<lval> is set then the fetch
1287 will be part of a store. Make sure the return value is non-null before
1288 accessing it. The return value when C<tb> is a tied hash is a pointer to a
1289 static location, so be sure to make a copy of the structure if you need to
1292 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1293 information on how to use this function on tied hashes.
1295 HE* hv_fetch_ent(HV* tb, SV* key, I32 lval, U32 hash)
1303 Prepares a starting point to traverse a hash table. Returns the number of
1304 keys in the hash (i.e. the same as C<HvKEYS(tb)>). The return value is
1305 currently only meaningful for hashes without tie magic.
1307 NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
1308 hash buckets that happen to be in use. If you still need that esoteric
1309 value, you can get it through the macro C<HvFILL(tb)>.
1312 I32 hv_iterinit(HV* tb)
1320 Returns the key from the current position of the hash iterator. See
1323 char* hv_iterkey(HE* entry, I32* retlen)
1331 Returns the key as an C<SV*> from the current position of the hash
1332 iterator. The return value will always be a mortal copy of the key. Also
1335 SV* hv_iterkeysv(HE* entry)
1343 Returns entries from a hash iterator. See C<hv_iterinit>.
1345 You may call C<hv_delete> or C<hv_delete_ent> on the hash entry that the
1346 iterator currently points to, without losing your place or invalidating your
1347 iterator. Note that in this case the current entry is deleted from the hash
1348 with your iterator holding the last reference to it. Your iterator is flagged
1349 to free the entry on the next call to C<hv_iternext>, so you must not discard
1350 your iterator immediately else the entry will leak - call C<hv_iternext> to
1351 trigger the resource deallocation.
1353 HE* hv_iternext(HV* tb)
1361 Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
1364 SV* hv_iternextsv(HV* hv, char** key, I32* retlen)
1369 =item hv_iternext_flags
1370 X<hv_iternext_flags>
1372 Returns entries from a hash iterator. See C<hv_iterinit> and C<hv_iternext>.
1373 The C<flags> value will normally be zero; if HV_ITERNEXT_WANTPLACEHOLDERS is
1374 set the placeholders keys (for restricted hashes) will be returned in addition
1375 to normal keys. By default placeholders are automatically skipped over.
1376 Currently a placeholder is implemented with a value that is
1377 C<&Perl_sv_placeholder>. Note that the implementation of placeholders and
1378 restricted hashes may change, and the implementation currently is
1379 insufficiently abstracted for any change to be tidy.
1381 NOTE: this function is experimental and may change or be
1382 removed without notice.
1384 HE* hv_iternext_flags(HV* tb, I32 flags)
1392 Returns the value from the current position of the hash iterator. See
1395 SV* hv_iterval(HV* tb, HE* entry)
1403 Adds magic to a hash. See C<sv_magic>.
1405 void hv_magic(HV* hv, GV* gv, int how)
1413 Evaluates the hash in scalar context and returns the result. Handles magic when the hash is tied.
1415 SV* hv_scalar(HV* hv)
1423 Stores an SV in a hash. The hash key is specified as C<key> and C<klen> is
1424 the length of the key. The C<hash> parameter is the precomputed hash
1425 value; if it is zero then Perl will compute it. The return value will be
1426 NULL if the operation failed or if the value did not need to be actually
1427 stored within the hash (as in the case of tied hashes). Otherwise it can
1428 be dereferenced to get the original C<SV*>. Note that the caller is
1429 responsible for suitably incrementing the reference count of C<val> before
1430 the call, and decrementing it if the function returned NULL. Effectively
1431 a successful hv_store takes ownership of one reference to C<val>. This is
1432 usually what you want; a newly created SV has a reference count of one, so
1433 if all your code does is create SVs then store them in a hash, hv_store
1434 will own the only reference to the new SV, and your code doesn't need to do
1435 anything further to tidy up. hv_store is not implemented as a call to
1436 hv_store_ent, and does not create a temporary SV for the key, so if your
1437 key data is not already in SV form then use hv_store in preference to
1440 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1441 information on how to use this function on tied hashes.
1443 SV** hv_store(HV* tb, const char* key, I32 klen, SV* val, U32 hash)
1451 Stores C<val> in a hash. The hash key is specified as C<key>. The C<hash>
1452 parameter is the precomputed hash value; if it is zero then Perl will
1453 compute it. The return value is the new hash entry so created. It will be
1454 NULL if the operation failed or if the value did not need to be actually
1455 stored within the hash (as in the case of tied hashes). Otherwise the
1456 contents of the return value can be accessed using the C<He?> macros
1457 described here. Note that the caller is responsible for suitably
1458 incrementing the reference count of C<val> before the call, and
1459 decrementing it if the function returned NULL. Effectively a successful
1460 hv_store_ent takes ownership of one reference to C<val>. This is
1461 usually what you want; a newly created SV has a reference count of one, so
1462 if all your code does is create SVs then store them in a hash, hv_store
1463 will own the only reference to the new SV, and your code doesn't need to do
1464 anything further to tidy up. Note that hv_store_ent only reads the C<key>;
1465 unlike C<val> it does not take ownership of it, so maintaining the correct
1466 reference count on C<key> is entirely the caller's responsibility. hv_store
1467 is not implemented as a call to hv_store_ent, and does not create a temporary
1468 SV for the key, so if your key data is not already in SV form then use
1469 hv_store in preference to hv_store_ent.
1471 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1472 information on how to use this function on tied hashes.
1474 HE* hv_store_ent(HV* tb, SV* key, SV* val, U32 hash)
1484 void hv_undef(HV* tb)
1492 Creates a new HV. The reference count is set to 1.
1502 =head1 Magical Functions
1509 Clear something magical that the SV represents. See C<sv_magic>.
1511 int mg_clear(SV* sv)
1519 Copies the magic from one SV to another. See C<sv_magic>.
1521 int mg_copy(SV* sv, SV* nsv, const char* key, I32 klen)
1529 Finds the magic pointer for type matching the SV. See C<sv_magic>.
1531 MAGIC* mg_find(const SV* sv, int type)
1539 Free any magic storage used by the SV. See C<sv_magic>.
1549 Do magic after a value is retrieved from the SV. See C<sv_magic>.
1559 Report on the SV's length. See C<sv_magic>.
1561 U32 mg_length(SV* sv)
1569 Turns on the magical status of an SV. See C<sv_magic>.
1571 void mg_magical(SV* sv)
1579 Do magic after a value is assigned to the SV. See C<sv_magic>.
1589 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
1590 argument more than once.
1592 void SvGETMAGIC(SV* sv)
1600 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
1611 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
1612 argument more than once.
1614 void SvSETMAGIC(SV* sv)
1622 Like C<SvSetSV>, but does any set magic required afterwards.
1624 void SvSetMagicSV(SV* dsb, SV* ssv)
1629 =item SvSetMagicSV_nosteal
1630 X<SvSetMagicSV_nosteal>
1632 Like C<SvSetSV_nosteal>, but does any set magic required afterwards.
1634 void SvSetMagicSV_nosteal(SV* dsv, SV* ssv)
1642 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
1645 void SvSetSV(SV* dsb, SV* ssv)
1650 =item SvSetSV_nosteal
1653 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
1654 ssv. May evaluate arguments more than once.
1656 void SvSetSV_nosteal(SV* dsv, SV* ssv)
1664 Arranges for sv to be shared between threads if a suitable module
1667 void SvSHARE(SV* sv)
1675 Releases a mutual exclusion lock on sv if a suitable module
1678 void SvUNLOCK(SV* sv)
1686 =head1 Memory Management
1693 The XSUB-writer's interface to the C C<memcpy> function. The C<src> is the
1694 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1695 the type. May fail on overlapping copies. See also C<Move>.
1697 void Copy(void* src, void* dest, int nitems, type)
1700 Found in file handy.h
1705 Like C<Copy> but returns dest. Useful for encouraging compilers to tail-call
1708 void * CopyD(void* src, void* dest, int nitems, type)
1711 Found in file handy.h
1716 The XSUB-writer's interface to the C C<memmove> function. The C<src> is the
1717 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1718 the type. Can do overlapping moves. See also C<Copy>.
1720 void Move(void* src, void* dest, int nitems, type)
1723 Found in file handy.h
1728 Like C<Move> but returns dest. Useful for encouraging compilers to tail-call
1731 void * MoveD(void* src, void* dest, int nitems, type)
1734 Found in file handy.h
1739 The XSUB-writer's interface to the C C<malloc> function.
1741 In 5.9.3, Newx() and friends replace the older New() API, and drops
1742 the first parameter, I<x>, a debug aid which allowed callers to identify
1743 themselves. This aid has been superceded by a new build option,
1744 PERL_MEM_LOG (see L<perlhack/PERL_MEM_LOG>). The older API is still
1745 there for use in XS modules supporting older perls.
1747 void Newx(void* ptr, int nitems, type)
1750 Found in file handy.h
1755 The XSUB-writer's interface to the C C<malloc> function, with
1756 cast. See also C<Newx>.
1758 void Newxc(void* ptr, int nitems, type, cast)
1761 Found in file handy.h
1766 The XSUB-writer's interface to the C C<malloc> function. The allocated
1767 memory is zeroed with C<memzero>. See also C<Newx>.
1769 void Newxz(void* ptr, int nitems, type)
1772 Found in file handy.h
1777 Fill up memory with a pattern (byte 0xAB over and over again) that
1778 hopefully catches attempts to access uninitialized memory.
1780 void Poison(void* dest, int nitems, type)
1783 Found in file handy.h
1788 The XSUB-writer's interface to the C C<realloc> function.
1790 void Renew(void* ptr, int nitems, type)
1793 Found in file handy.h
1798 The XSUB-writer's interface to the C C<realloc> function, with
1801 void Renewc(void* ptr, int nitems, type, cast)
1804 Found in file handy.h
1809 The XSUB-writer's interface to the C C<free> function.
1811 void Safefree(void* ptr)
1814 Found in file handy.h
1819 Perl's version of C<strdup()>. Returns a pointer to a newly allocated
1820 string which is a duplicate of C<pv>. The size of the string is
1821 determined by C<strlen()>. The memory allocated for the new string can
1822 be freed with the C<Safefree()> function.
1824 char* savepv(const char* pv)
1827 Found in file util.c
1832 Perl's version of what C<strndup()> would be if it existed. Returns a
1833 pointer to a newly allocated string which is a duplicate of the first
1834 C<len> bytes from C<pv>. The memory allocated for the new string can be
1835 freed with the C<Safefree()> function.
1837 char* savepvn(const char* pv, I32 len)
1840 Found in file util.c
1845 A version of C<savepv()> which allocates the duplicate string in memory
1846 which is shared between threads.
1848 char* savesharedpv(const char* pv)
1851 Found in file util.c
1856 A version of C<savepv()>/C<savepvn()> which gets the string to duplicate from
1857 the passed in SV using C<SvPV()>
1859 char* savesvpv(SV* sv)
1862 Found in file util.c
1867 This is an architecture-independent macro to copy one structure to another.
1869 void StructCopy(type src, type dest, type)
1872 Found in file handy.h
1877 The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the
1878 destination, C<nitems> is the number of items, and C<type> is the type.
1880 void Zero(void* dest, int nitems, type)
1883 Found in file handy.h
1888 Like C<Zero> but returns dest. Useful for encouraging compilers to tail-call
1891 void * ZeroD(void* dest, int nitems, type)
1894 Found in file handy.h
1899 =head1 Miscellaneous Functions
1906 Analyses the string in order to make fast searches on it using fbm_instr()
1907 -- the Boyer-Moore algorithm.
1909 void fbm_compile(SV* sv, U32 flags)
1912 Found in file util.c
1917 Returns the location of the SV in the string delimited by C<str> and
1918 C<strend>. It returns C<Nullch> if the string can't be found. The C<sv>
1919 does not have to be fbm_compiled, but the search will not be as fast
1922 char* fbm_instr(unsigned char* big, unsigned char* bigend, SV* littlesv, U32 flags)
1925 Found in file util.c
1930 Takes a sprintf-style format pattern and conventional
1931 (non-SV) arguments and returns the formatted string.
1933 (char *) Perl_form(pTHX_ const char* pat, ...)
1935 can be used any place a string (char *) is required:
1937 char * s = Perl_form("%d.%d",major,minor);
1939 Uses a single private buffer so if you want to format several strings you
1940 must explicitly copy the earlier strings away (and free the copies when you
1943 char* form(const char* pat, ...)
1946 Found in file util.c
1951 Fill the sv with current working directory
1953 int getcwd_sv(SV* sv)
1956 Found in file util.c
1961 Returns a new version object based on the passed in SV:
1963 SV *sv = new_version(SV *ver);
1965 Does not alter the passed in ver SV. See "upg_version" if you
1966 want to upgrade the SV.
1968 SV* new_version(SV *ver)
1971 Found in file util.c
1976 Returns a pointer to the next character after the parsed
1977 version string, as well as upgrading the passed in SV to
1980 Function must be called with an already existing SV like
1983 s = scan_version(s,SV *sv, bool qv);
1985 Performs some preprocessing to the string to ensure that
1986 it has the correct characteristics of a version. Flags the
1987 object if it contains an underscore (which denotes this
1988 is a alpha version). The boolean qv denotes that the version
1989 should be interpreted as if it had multiple decimals, even if
1992 const char* scan_version(const char *vstr, SV *sv, bool qv)
1995 Found in file util.c
2000 Test two strings to see if they are equal. Returns true or false.
2002 bool strEQ(char* s1, char* s2)
2005 Found in file handy.h
2010 Test two strings to see if the first, C<s1>, is greater than or equal to
2011 the second, C<s2>. Returns true or false.
2013 bool strGE(char* s1, char* s2)
2016 Found in file handy.h
2021 Test two strings to see if the first, C<s1>, is greater than the second,
2022 C<s2>. Returns true or false.
2024 bool strGT(char* s1, char* s2)
2027 Found in file handy.h
2032 Test two strings to see if the first, C<s1>, is less than or equal to the
2033 second, C<s2>. Returns true or false.
2035 bool strLE(char* s1, char* s2)
2038 Found in file handy.h
2043 Test two strings to see if the first, C<s1>, is less than the second,
2044 C<s2>. Returns true or false.
2046 bool strLT(char* s1, char* s2)
2049 Found in file handy.h
2054 Test two strings to see if they are different. Returns true or
2057 bool strNE(char* s1, char* s2)
2060 Found in file handy.h
2065 Test two strings to see if they are equal. The C<len> parameter indicates
2066 the number of bytes to compare. Returns true or false. (A wrapper for
2069 bool strnEQ(char* s1, char* s2, STRLEN len)
2072 Found in file handy.h
2077 Test two strings to see if they are different. The C<len> parameter
2078 indicates the number of bytes to compare. Returns true or false. (A
2079 wrapper for C<strncmp>).
2081 bool strnNE(char* s1, char* s2, STRLEN len)
2084 Found in file handy.h
2089 Dummy routine which "locks" an SV when there is no locking module present.
2090 Exists to avoid test for a NULL function pointer and because it could potentially warn under
2091 some level of strict-ness.
2093 void sv_nolocking(SV *)
2096 Found in file util.c
2101 Dummy routine which "shares" an SV when there is no sharing module present.
2102 Exists to avoid test for a NULL function pointer and because it could potentially warn under
2103 some level of strict-ness.
2105 void sv_nosharing(SV *)
2108 Found in file util.c
2110 =item sv_nounlocking
2113 Dummy routine which "unlocks" an SV when there is no locking module present.
2114 Exists to avoid test for a NULL function pointer and because it could potentially warn under
2115 some level of strict-ness.
2117 void sv_nounlocking(SV *)
2120 Found in file util.c
2125 In-place upgrade of the supplied SV to a version object.
2127 SV *sv = upg_version(SV *sv);
2129 Returns a pointer to the upgraded SV.
2131 SV* upg_version(SV *ver)
2134 Found in file util.c
2139 Version object aware cmp. Both operands must already have been
2140 converted into version objects.
2142 int vcmp(SV *lvs, SV *rvs)
2145 Found in file util.c
2150 Accepts a version object and returns the normalized string
2151 representation. Call like:
2155 NOTE: you can pass either the object directly or the SV
2156 contained within the RV.
2161 Found in file util.c
2166 Accepts a version object and returns the normalized floating
2167 point representation. Call like:
2171 NOTE: you can pass either the object directly or the SV
2172 contained within the RV.
2177 Found in file util.c
2182 In order to maintain maximum compatibility with earlier versions
2183 of Perl, this function will return either the floating point
2184 notation or the multiple dotted notation, depending on whether
2185 the original version contained 1 or more dots, respectively
2187 SV* vstringify(SV *vs)
2190 Found in file util.c
2195 Validates that the SV contains a valid version object.
2197 bool vverify(SV *vobj);
2199 Note that it only confirms the bare minimum structure (so as not to get
2200 confused by derived classes which may contain additional hash entries):
2202 bool vverify(SV *vs)
2205 Found in file util.c
2210 =head1 Numeric functions
2217 converts a string representing a binary number to numeric form.
2219 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2220 conversion flags, and I<result> should be NULL or a pointer to an NV.
2221 The scan stops at the end of the string, or the first invalid character.
2222 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2223 invalid character will also trigger a warning.
2224 On return I<*len> is set to the length of the scanned string,
2225 and I<*flags> gives output flags.
2227 If the value is <= C<UV_MAX> it is returned as a UV, the output flags are clear,
2228 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_bin>
2229 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2230 and writes the value to I<*result> (or the value is discarded if I<result>
2233 The binary number may optionally be prefixed with "0b" or "b" unless
2234 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
2235 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the binary
2236 number may use '_' characters to separate digits.
2238 UV grok_bin(const char* start, STRLEN* len_p, I32* flags, NV *result)
2241 Found in file numeric.c
2246 converts a string representing a hex number to numeric form.
2248 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2249 conversion flags, and I<result> should be NULL or a pointer to an NV.
2250 The scan stops at the end of the string, or the first invalid character.
2251 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2252 invalid character will also trigger a warning.
2253 On return I<*len> is set to the length of the scanned string,
2254 and I<*flags> gives output flags.
2256 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2257 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_hex>
2258 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2259 and writes the value to I<*result> (or the value is discarded if I<result>
2262 The hex number may optionally be prefixed with "0x" or "x" unless
2263 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
2264 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the hex
2265 number may use '_' characters to separate digits.
2267 UV grok_hex(const char* start, STRLEN* len_p, I32* flags, NV *result)
2270 Found in file numeric.c
2275 Recognise (or not) a number. The type of the number is returned
2276 (0 if unrecognised), otherwise it is a bit-ORed combination of
2277 IS_NUMBER_IN_UV, IS_NUMBER_GREATER_THAN_UV_MAX, IS_NUMBER_NOT_INT,
2278 IS_NUMBER_NEG, IS_NUMBER_INFINITY, IS_NUMBER_NAN (defined in perl.h).
2280 If the value of the number can fit an in UV, it is returned in the *valuep
2281 IS_NUMBER_IN_UV will be set to indicate that *valuep is valid, IS_NUMBER_IN_UV
2282 will never be set unless *valuep is valid, but *valuep may have been assigned
2283 to during processing even though IS_NUMBER_IN_UV is not set on return.
2284 If valuep is NULL, IS_NUMBER_IN_UV will be set for the same cases as when
2285 valuep is non-NULL, but no actual assignment (or SEGV) will occur.
2287 IS_NUMBER_NOT_INT will be set with IS_NUMBER_IN_UV if trailing decimals were
2288 seen (in which case *valuep gives the true value truncated to an integer), and
2289 IS_NUMBER_NEG if the number is negative (in which case *valuep holds the
2290 absolute value). IS_NUMBER_IN_UV is not set if e notation was used or the
2291 number is larger than a UV.
2293 int grok_number(const char *pv, STRLEN len, UV *valuep)
2296 Found in file numeric.c
2298 =item grok_numeric_radix
2299 X<grok_numeric_radix>
2301 Scan and skip for a numeric decimal separator (radix).
2303 bool grok_numeric_radix(const char **sp, const char *send)
2306 Found in file numeric.c
2311 converts a string representing an octal number to numeric form.
2313 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2314 conversion flags, and I<result> should be NULL or a pointer to an NV.
2315 The scan stops at the end of the string, or the first invalid character.
2316 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2317 invalid character will also trigger a warning.
2318 On return I<*len> is set to the length of the scanned string,
2319 and I<*flags> gives output flags.
2321 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2322 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_oct>
2323 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2324 and writes the value to I<*result> (or the value is discarded if I<result>
2327 If C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the octal
2328 number may use '_' characters to separate digits.
2330 UV grok_oct(const char* start, STRLEN* len_p, I32* flags, NV *result)
2333 Found in file numeric.c
2338 For backwards compatibility. Use C<grok_bin> instead.
2340 NV scan_bin(const char* start, STRLEN len, STRLEN* retlen)
2343 Found in file numeric.c
2348 For backwards compatibility. Use C<grok_hex> instead.
2350 NV scan_hex(const char* start, STRLEN len, STRLEN* retlen)
2353 Found in file numeric.c
2358 For backwards compatibility. Use C<grok_oct> instead.
2360 NV scan_oct(const char* start, STRLEN len, STRLEN* retlen)
2363 Found in file numeric.c
2368 =head1 Optree Manipulation Functions
2375 If C<cv> is a constant sub eligible for inlining. returns the constant
2376 value returned by the sub. Otherwise, returns NULL.
2378 Constant subs can be created with C<newCONSTSUB> or as described in
2379 L<perlsub/"Constant Functions">.
2381 SV* cv_const_sv(CV* cv)
2389 Creates a constant sub equivalent to Perl C<sub FOO () { 123 }> which is
2390 eligible for inlining at compile-time.
2392 CV* newCONSTSUB(HV* stash, const char* name, SV* sv)
2400 Used by C<xsubpp> to hook up XSUBs as Perl subs.
2408 =head1 Pad Data Structures
2415 Get the value at offset po in the current pad.
2416 Use macro PAD_SV instead of calling this function directly.
2418 SV* pad_sv(PADOFFSET po)
2426 =head1 Simple Exception Handling Macros
2433 Set up necessary local variables for exception handling.
2434 See L<perlguts/"Exception Handling">.
2439 Found in file XSUB.h
2444 Introduces a catch block. See L<perlguts/"Exception Handling">.
2447 Found in file XSUB.h
2452 Rethrows a previously caught exception. See L<perlguts/"Exception Handling">.
2457 Found in file XSUB.h
2462 Ends a try block. See L<perlguts/"Exception Handling">.
2465 Found in file XSUB.h
2467 =item XCPT_TRY_START
2470 Starts a try block. See L<perlguts/"Exception Handling">.
2473 Found in file XSUB.h
2478 =head1 Stack Manipulation Macros
2485 Declare a stack marker variable, C<mark>, for the XSUB. See C<MARK> and
2496 Saves the original stack mark for the XSUB. See C<ORIGMARK>.
2506 Declares a local copy of perl's stack pointer for the XSUB, available via
2507 the C<SP> macro. See C<SP>.
2517 Used to extend the argument stack for an XSUB's return values. Once
2518 used, guarantees that there is room for at least C<nitems> to be pushed
2521 void EXTEND(SP, int nitems)
2529 Stack marker variable for the XSUB. See C<dMARK>.
2537 Push an integer onto the stack. The stack must have room for this element.
2538 Handles 'set' magic. Does not use C<TARG>. See also C<PUSHi>, C<mXPUSHi>
2549 Push a double onto the stack. The stack must have room for this element.
2550 Handles 'set' magic. Does not use C<TARG>. See also C<PUSHn>, C<mXPUSHn>
2561 Push a string onto the stack. The stack must have room for this element.
2562 The C<len> indicates the length of the string. Handles 'set' magic. Does
2563 not use C<TARG>. See also C<PUSHp>, C<mXPUSHp> and C<XPUSHp>.
2565 void mPUSHp(char* str, STRLEN len)
2573 Push an unsigned integer onto the stack. The stack must have room for this
2574 element. Handles 'set' magic. Does not use C<TARG>. See also C<PUSHu>,
2575 C<mXPUSHu> and C<XPUSHu>.
2585 Push an integer onto the stack, extending the stack if necessary. Handles
2586 'set' magic. Does not use C<TARG>. See also C<XPUSHi>, C<mPUSHi> and
2597 Push a double onto the stack, extending the stack if necessary. Handles
2598 'set' magic. Does not use C<TARG>. See also C<XPUSHn>, C<mPUSHn> and
2609 Push a string onto the stack, extending the stack if necessary. The C<len>
2610 indicates the length of the string. Handles 'set' magic. Does not use
2611 C<TARG>. See also C<XPUSHp>, C<mPUSHp> and C<PUSHp>.
2613 void mXPUSHp(char* str, STRLEN len)
2621 Push an unsigned integer onto the stack, extending the stack if necessary.
2622 Handles 'set' magic. Does not use C<TARG>. See also C<XPUSHu>, C<mPUSHu>
2633 The original stack mark for the XSUB. See C<dORIGMARK>.
2641 Pops an integer off the stack.
2651 Pops a long off the stack.
2661 Pops a double off the stack.
2671 Pops a string off the stack. Deprecated. New code should use POPpx.
2681 Pops a string off the stack which must consist of bytes i.e. characters < 256.
2691 Pops a string off the stack.
2701 Pops an SV off the stack.
2711 Push an integer onto the stack. The stack must have room for this element.
2712 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
2713 called to declare it. Do not call multiple C<TARG>-oriented macros to
2714 return lists from XSUB's - see C<mPUSHi> instead. See also C<XPUSHi> and
2725 Opening bracket for arguments on a callback. See C<PUTBACK> and
2736 Push a new mortal SV onto the stack. The stack must have room for this
2737 element. Does not handle 'set' magic. Does not use C<TARG>. See also
2738 C<PUSHs>, C<XPUSHmortal> and C<XPUSHs>.
2748 Push a double onto the stack. The stack must have room for this element.
2749 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
2750 called to declare it. Do not call multiple C<TARG>-oriented macros to
2751 return lists from XSUB's - see C<mPUSHn> instead. See also C<XPUSHn> and
2762 Push a string onto the stack. The stack must have room for this element.
2763 The C<len> indicates the length of the string. Handles 'set' magic. Uses
2764 C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to declare it. Do not
2765 call multiple C<TARG>-oriented macros to return lists from XSUB's - see
2766 C<mPUSHp> instead. See also C<XPUSHp> and C<mXPUSHp>.
2768 void PUSHp(char* str, STRLEN len)
2776 Push an SV onto the stack. The stack must have room for this element.
2777 Does not handle 'set' magic. Does not use C<TARG>. See also C<PUSHmortal>,
2778 C<XPUSHs> and C<XPUSHmortal>.
2788 Push an unsigned integer onto the stack. The stack must have room for this
2789 element. Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG>
2790 should be called to declare it. Do not call multiple C<TARG>-oriented
2791 macros to return lists from XSUB's - see C<mPUSHu> instead. See also
2792 C<XPUSHu> and C<mXPUSHu>.
2802 Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
2803 See C<PUSHMARK> and L<perlcall> for other uses.
2813 Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and
2822 Refetch the stack pointer. Used after a callback. See L<perlcall>.
2832 Push an integer onto the stack, extending the stack if necessary. Handles
2833 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
2834 declare it. Do not call multiple C<TARG>-oriented macros to return lists
2835 from XSUB's - see C<mXPUSHi> instead. See also C<PUSHi> and C<mPUSHi>.
2845 Push a new mortal SV onto the stack, extending the stack if necessary. Does
2846 not handle 'set' magic. Does not use C<TARG>. See also C<XPUSHs>,
2847 C<PUSHmortal> and C<PUSHs>.
2857 Push a double onto the stack, extending the stack if necessary. Handles
2858 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
2859 declare it. Do not call multiple C<TARG>-oriented macros to return lists
2860 from XSUB's - see C<mXPUSHn> instead. See also C<PUSHn> and C<mPUSHn>.
2870 Push a string onto the stack, extending the stack if necessary. The C<len>
2871 indicates the length of the string. Handles 'set' magic. Uses C<TARG>, so
2872 C<dTARGET> or C<dXSTARG> should be called to declare it. Do not call
2873 multiple C<TARG>-oriented macros to return lists from XSUB's - see
2874 C<mXPUSHp> instead. See also C<PUSHp> and C<mPUSHp>.
2876 void XPUSHp(char* str, STRLEN len)
2884 Push an SV onto the stack, extending the stack if necessary. Does not
2885 handle 'set' magic. Does not use C<TARG>. See also C<XPUSHmortal>,
2886 C<PUSHs> and C<PUSHmortal>.
2896 Push an unsigned integer onto the stack, extending the stack if necessary.
2897 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
2898 called to declare it. Do not call multiple C<TARG>-oriented macros to
2899 return lists from XSUB's - see C<mXPUSHu> instead. See also C<PUSHu> and
2910 Return from XSUB, indicating number of items on the stack. This is usually
2911 handled by C<xsubpp>.
2913 void XSRETURN(int nitems)
2916 Found in file XSUB.h
2918 =item XSRETURN_EMPTY
2921 Return an empty list from an XSUB immediately.
2926 Found in file XSUB.h
2931 Return an integer from an XSUB immediately. Uses C<XST_mIV>.
2933 void XSRETURN_IV(IV iv)
2936 Found in file XSUB.h
2941 Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
2946 Found in file XSUB.h
2951 Return a double from an XSUB immediately. Uses C<XST_mNV>.
2953 void XSRETURN_NV(NV nv)
2956 Found in file XSUB.h
2961 Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
2963 void XSRETURN_PV(char* str)
2966 Found in file XSUB.h
2968 =item XSRETURN_UNDEF
2971 Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
2976 Found in file XSUB.h
2981 Return an integer from an XSUB immediately. Uses C<XST_mUV>.
2983 void XSRETURN_UV(IV uv)
2986 Found in file XSUB.h
2991 Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
2996 Found in file XSUB.h
3001 Place an integer into the specified position C<pos> on the stack. The
3002 value is stored in a new mortal SV.
3004 void XST_mIV(int pos, IV iv)
3007 Found in file XSUB.h
3012 Place C<&PL_sv_no> into the specified position C<pos> on the
3015 void XST_mNO(int pos)
3018 Found in file XSUB.h
3023 Place a double into the specified position C<pos> on the stack. The value
3024 is stored in a new mortal SV.
3026 void XST_mNV(int pos, NV nv)
3029 Found in file XSUB.h
3034 Place a copy of a string into the specified position C<pos> on the stack.
3035 The value is stored in a new mortal SV.
3037 void XST_mPV(int pos, char* str)
3040 Found in file XSUB.h
3045 Place C<&PL_sv_undef> into the specified position C<pos> on the
3048 void XST_mUNDEF(int pos)
3051 Found in file XSUB.h
3056 Place C<&PL_sv_yes> into the specified position C<pos> on the
3059 void XST_mYES(int pos)
3062 Found in file XSUB.h
3074 An enum of flags for Perl types. These are found in the file B<sv.h>
3075 in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
3083 Integer type flag for scalars. See C<svtype>.
3091 Double type flag for scalars. See C<svtype>.
3099 Pointer type flag for scalars. See C<svtype>.
3107 Type flag for arrays. See C<svtype>.
3115 Type flag for code refs. See C<svtype>.
3123 Type flag for hashes. See C<svtype>.
3131 Type flag for blessed scalars. See C<svtype>.
3139 =head1 SV Manipulation Functions
3146 Returns the SV of the specified Perl scalar. If C<create> is set and the
3147 Perl variable does not exist then it will be created. If C<create> is not
3148 set and the variable does not exist then NULL is returned.
3150 NOTE: the perl_ form of this function is deprecated.
3152 SV* get_sv(const char* name, I32 create)
3155 Found in file perl.c
3157 =item looks_like_number
3158 X<looks_like_number>
3160 Test if the content of an SV looks like a number (or is a number).
3161 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
3162 non-numeric warning), even if your atof() doesn't grok them.
3164 I32 looks_like_number(SV* sv)
3172 Creates an RV wrapper for an SV. The reference count for the original SV is
3175 SV* newRV_inc(SV* sv)
3183 Creates an RV wrapper for an SV. The reference count for the original
3184 SV is B<not> incremented.
3186 SV* newRV_noinc(SV *sv)
3194 Creates a new SV. A non-zero C<len> parameter indicates the number of
3195 bytes of preallocated string space the SV should have. An extra byte for a
3196 tailing NUL is also reserved. (SvPOK is not set for the SV even if string
3197 space is allocated.) The reference count for the new SV is set to 1.
3198 C<id> is an integer id between 0 and 1299 (used to identify leaks).
3200 SV* NEWSV(int id, STRLEN len)
3203 Found in file handy.h
3208 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
3209 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
3212 SV* newSV(STRLEN len)
3220 Creates a new SV from the hash key structure. It will generate scalars that
3221 point to the shared string table where possible. Returns a new (undefined)
3222 SV if the hek is NULL.
3224 SV* newSVhek(const HEK *hek)
3232 Creates a new SV and copies an integer into it. The reference count for the
3243 Creates a new SV and copies a floating point value into it.
3244 The reference count for the SV is set to 1.
3254 Creates a new SV and copies a string into it. The reference count for the
3255 SV is set to 1. If C<len> is zero, Perl will compute the length using
3256 strlen(). For efficiency, consider using C<newSVpvn> instead.
3258 SV* newSVpv(const char* s, STRLEN len)
3266 Creates a new SV and initializes it with the string formatted like
3269 SV* newSVpvf(const char* pat, ...)
3277 Creates a new SV and copies a string into it. The reference count for the
3278 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
3279 string. You are responsible for ensuring that the source string is at least
3280 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
3282 SV* newSVpvn(const char* s, STRLEN len)
3287 =item newSVpvn_share
3290 Creates a new SV with its SvPVX_const pointing to a shared string in the string
3291 table. If the string does not already exist in the table, it is created
3292 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
3293 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
3294 otherwise the hash is computed. The idea here is that as the string table
3295 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
3296 hash lookup will avoid string compare.
3298 SV* newSVpvn_share(const char* s, I32 len, U32 hash)
3306 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
3307 it will be upgraded to one. If C<classname> is non-null then the new SV will
3308 be blessed in the specified package. The new SV is returned and its
3309 reference count is 1.
3311 SV* newSVrv(SV* rv, const char* classname)
3319 Creates a new SV which is an exact duplicate of the original SV.
3322 SV* newSVsv(SV* old)
3330 Creates a new SV and copies an unsigned integer into it.
3331 The reference count for the SV is set to 1.
3341 Returns the length of the string which is in the SV. See C<SvLEN>.
3343 STRLEN SvCUR(SV* sv)
3351 Set the current length of the string which is in the SV. See C<SvCUR>
3354 void SvCUR_set(SV* sv, STRLEN len)
3362 Returns a pointer to the last character in the string which is in the SV.
3363 See C<SvCUR>. Access the character as *(SvEND(sv)).
3373 Expands the character buffer in the SV so that it has room for the
3374 indicated number of bytes (remember to reserve space for an extra trailing
3375 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
3376 Returns a pointer to the character buffer.
3378 char * SvGROW(SV* sv, STRLEN len)
3386 Returns a boolean indicating whether the SV contains an integer.
3396 Returns a boolean indicating whether the SV contains an integer. Checks
3397 the B<private> setting. Use C<SvIOK>.
3407 Returns a boolean indicating whether the SV contains a signed integer.
3409 bool SvIOK_notUV(SV* sv)
3417 Unsets the IV status of an SV.
3419 void SvIOK_off(SV* sv)
3427 Tells an SV that it is an integer.
3429 void SvIOK_on(SV* sv)
3437 Tells an SV that it is an integer and disables all other OK bits.
3439 void SvIOK_only(SV* sv)
3447 Tells and SV that it is an unsigned integer and disables all other OK bits.
3449 void SvIOK_only_UV(SV* sv)
3457 Returns a boolean indicating whether the SV contains an unsigned integer.
3459 bool SvIOK_UV(SV* sv)
3467 Returns a boolean indicating whether the SV is Copy-On-Write. (either shared
3468 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
3471 bool SvIsCOW(SV* sv)
3476 =item SvIsCOW_shared_hash
3477 X<SvIsCOW_shared_hash>
3479 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
3482 bool SvIsCOW_shared_hash(SV* sv)
3490 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
3491 version which guarantees to evaluate sv only once.
3501 Returns the raw value in the SV's IV slot, without checks or conversions.
3502 Only use when you are sure SvIOK is true. See also C<SvIV()>.
3512 Coerces the given SV to an integer and returns it. Guarantees to evaluate
3513 sv only once. Use the more efficient C<SvIV> otherwise.
3523 Like C<SvIV> but doesn't process magic.
3525 IV SvIV_nomg(SV* sv)
3533 Set the value of the IV pointer in sv to val. It is possible to perform
3534 the same function of this macro with an lvalue assignment to C<SvIVX>.
3535 With future Perls, however, it will be more efficient to use
3536 C<SvIV_set> instead of the lvalue assignment to C<SvIVX>.
3538 void SvIV_set(SV* sv, IV val)
3546 Returns the size of the string buffer in the SV, not including any part
3547 attributable to C<SvOOK>. See C<SvCUR>.
3549 STRLEN SvLEN(SV* sv)
3557 Set the actual length of the string which is in the SV. See C<SvIV_set>.
3559 void SvLEN_set(SV* sv, STRLEN len)
3567 Set the value of the MAGIC pointer in sv to val. See C<SvIV_set>.
3569 void SvMAGIC_set(SV* sv, MAGIC* val)
3577 Returns a boolean indicating whether the SV contains a number, integer or
3588 Returns a boolean indicating whether the SV contains a number, integer or
3589 double. Checks the B<private> setting. Use C<SvNIOK>.
3591 bool SvNIOKp(SV* sv)
3599 Unsets the NV/IV status of an SV.
3601 void SvNIOK_off(SV* sv)
3609 Returns a boolean indicating whether the SV contains a double.
3619 Returns a boolean indicating whether the SV contains a double. Checks the
3620 B<private> setting. Use C<SvNOK>.
3630 Unsets the NV status of an SV.
3632 void SvNOK_off(SV* sv)
3640 Tells an SV that it is a double.
3642 void SvNOK_on(SV* sv)
3650 Tells an SV that it is a double and disables all other OK bits.
3652 void SvNOK_only(SV* sv)
3660 Coerce the given SV to a double and return it. See C<SvNVx> for a version
3661 which guarantees to evaluate sv only once.
3671 Returns the raw value in the SV's NV slot, without checks or conversions.
3672 Only use when you are sure SvNOK is true. See also C<SvNV()>.
3682 Coerces the given SV to a double and returns it. Guarantees to evaluate
3683 sv only once. Use the more efficient C<SvNV> otherwise.
3693 Set the value of the NV pointer in sv to val. See C<SvIV_set>.
3695 void SvNV_set(SV* sv, NV val)
3703 Returns a boolean indicating whether the value is an SV. It also tells
3704 whether the value is defined or not.
3714 Returns a boolean indicating whether the SvIVX is a valid offset value for
3715 the SvPVX. This hack is used internally to speed up removal of characters
3716 from the beginning of a SvPV. When SvOOK is true, then the start of the
3717 allocated string buffer is really (SvPVX - SvIVX).
3727 Returns a boolean indicating whether the SV contains a character
3738 Returns a boolean indicating whether the SV contains a character string.
3739 Checks the B<private> setting. Use C<SvPOK>.
3749 Unsets the PV status of an SV.
3751 void SvPOK_off(SV* sv)
3759 Tells an SV that it is a string.
3761 void SvPOK_on(SV* sv)
3769 Tells an SV that it is a string and disables all other OK bits.
3770 Will also turn off the UTF-8 status.
3772 void SvPOK_only(SV* sv)
3777 =item SvPOK_only_UTF8
3780 Tells an SV that it is a string and disables all other OK bits,
3781 and leaves the UTF-8 status as it was.
3783 void SvPOK_only_UTF8(SV* sv)
3791 Returns a pointer to the string in the SV, or a stringified form of
3792 the SV if the SV does not contain a string. The SV may cache the
3793 stringified version becoming C<SvPOK>. Handles 'get' magic. See also
3794 C<SvPVx> for a version which guarantees to evaluate sv only once.
3796 char* SvPV(SV* sv, STRLEN len)
3804 Like C<SvPV>, but converts sv to byte representation first if necessary.
3806 char* SvPVbyte(SV* sv, STRLEN len)
3814 Like C<SvPV>, but converts sv to byte representation first if necessary.
3815 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
3818 char* SvPVbytex(SV* sv, STRLEN len)
3823 =item SvPVbytex_force
3826 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
3827 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
3830 char* SvPVbytex_force(SV* sv, STRLEN len)
3835 =item SvPVbyte_force
3838 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
3840 char* SvPVbyte_force(SV* sv, STRLEN len)
3845 =item SvPVbyte_nolen
3848 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
3850 char* SvPVbyte_nolen(SV* sv)
3858 Like C<SvPV>, but converts sv to utf8 first if necessary.
3860 char* SvPVutf8(SV* sv, STRLEN len)
3868 Like C<SvPV>, but converts sv to utf8 first if necessary.
3869 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
3872 char* SvPVutf8x(SV* sv, STRLEN len)
3877 =item SvPVutf8x_force
3880 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
3881 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
3884 char* SvPVutf8x_force(SV* sv, STRLEN len)
3889 =item SvPVutf8_force
3892 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
3894 char* SvPVutf8_force(SV* sv, STRLEN len)
3899 =item SvPVutf8_nolen
3902 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
3904 char* SvPVutf8_nolen(SV* sv)
3912 Returns a pointer to the physical string in the SV. The SV must contain a
3923 A version of C<SvPV> which guarantees to evaluate sv only once.
3925 char* SvPVx(SV* sv, STRLEN len)
3933 Like C<SvPV> but will force the SV into containing just a string
3934 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
3937 char* SvPV_force(SV* sv, STRLEN len)
3942 =item SvPV_force_nomg
3945 Like C<SvPV> but will force the SV into containing just a string
3946 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
3947 directly. Doesn't process magic.
3949 char* SvPV_force_nomg(SV* sv, STRLEN len)
3957 Returns a pointer to the string in the SV, or a stringified form of
3958 the SV if the SV does not contain a string. The SV may cache the
3959 stringified form becoming C<SvPOK>. Handles 'get' magic.
3961 char* SvPV_nolen(SV* sv)
3969 Like C<SvPV> but doesn't process magic.
3971 char* SvPV_nomg(SV* sv, STRLEN len)
3979 Set the value of the PV pointer in sv to val. See C<SvIV_set>.
3981 void SvPV_set(SV* sv, char* val)
3989 Returns the value of the object's reference count.
3991 U32 SvREFCNT(SV* sv)
3999 Decrements the reference count of the given SV.
4001 void SvREFCNT_dec(SV* sv)
4009 Increments the reference count of the given SV.
4011 SV* SvREFCNT_inc(SV* sv)
4019 Tests if the SV is an RV.
4029 Unsets the RV status of an SV.
4031 void SvROK_off(SV* sv)
4039 Tells an SV that it is an RV.
4041 void SvROK_on(SV* sv)
4049 Dereferences an RV to return the SV.
4059 Set the value of the RV pointer in sv to val. See C<SvIV_set>.
4061 void SvRV_set(SV* sv, SV* val)
4069 Returns the stash of the SV.
4079 Set the value of the STASH pointer in sv to val. See C<SvIV_set>.
4081 void SvSTASH_set(SV* sv, STASH* val)
4089 Taints an SV if tainting is enabled.
4091 void SvTAINT(SV* sv)
4099 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
4102 bool SvTAINTED(SV* sv)
4110 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
4111 some of Perl's fundamental security features. XS module authors should not
4112 use this function unless they fully understand all the implications of
4113 unconditionally untainting the value. Untainting should be done in the
4114 standard perl fashion, via a carefully crafted regexp, rather than directly
4115 untainting variables.
4117 void SvTAINTED_off(SV* sv)
4125 Marks an SV as tainted if tainting is enabled.
4127 void SvTAINTED_on(SV* sv)
4135 Returns a boolean indicating whether Perl would evaluate the SV as true or
4136 false, defined or undefined. Does not handle 'get' magic.
4146 Returns the type of the SV. See C<svtype>.
4148 svtype SvTYPE(SV* sv)
4156 Returns a boolean indicating whether the SV contains an unsigned integer.
4166 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
4167 perform the upgrade if necessary. See C<svtype>.
4169 void SvUPGRADE(SV* sv, svtype type)
4177 Returns a boolean indicating whether the SV contains UTF-8 encoded data.
4187 Unsets the UTF-8 status of an SV.
4189 void SvUTF8_off(SV *sv)
4197 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
4198 Do not use frivolously.
4200 void SvUTF8_on(SV *sv)
4208 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
4209 for a version which guarantees to evaluate sv only once.
4219 Returns the raw value in the SV's UV slot, without checks or conversions.
4220 Only use when you are sure SvIOK is true. See also C<SvUV()>.
4230 Coerces the given SV to an unsigned integer and returns it. Guarantees to
4231 evaluate sv only once. Use the more efficient C<SvUV> otherwise.
4241 Like C<SvUV> but doesn't process magic.
4243 UV SvUV_nomg(SV* sv)
4251 Set the value of the UV pointer in sv to val. See C<SvIV_set>.
4253 void SvUV_set(SV* sv, UV val)
4261 Returns a boolean indicating whether the SV contains a v-string.
4271 This function is only called on magical items, and is only used by
4272 sv_true() or its macro equivalent.
4274 bool sv_2bool(SV* sv)
4282 Using various gambits, try to get a CV from an SV; in addition, try if
4283 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
4285 CV* sv_2cv(SV* sv, HV** st, GV** gvp, I32 lref)
4293 Using various gambits, try to get an IO from an SV: the IO slot if its a
4294 GV; or the recursive result if we're an RV; or the IO slot of the symbol
4295 named after the PV if we're a string.
4305 Return the integer value of an SV, doing any necessary string
4306 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
4307 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
4309 IV sv_2iv_flags(SV* sv, I32 flags)
4317 Marks an existing SV as mortal. The SV will be destroyed "soon", either
4318 by an explicit call to FREETMPS, or by an implicit call at places such as
4319 statement boundaries. SvTEMP() is turned on which means that the SV's
4320 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
4321 and C<sv_mortalcopy>.
4323 SV* sv_2mortal(SV* sv)
4331 Return the num value of an SV, doing any necessary string or integer
4332 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
4343 Return a pointer to the byte-encoded representation of the SV, and set *lp
4344 to its length. May cause the SV to be downgraded from UTF-8 as a
4347 Usually accessed via the C<SvPVbyte> macro.
4349 char* sv_2pvbyte(SV* sv, STRLEN* lp)
4354 =item sv_2pvbyte_nolen
4357 Return a pointer to the byte-encoded representation of the SV.
4358 May cause the SV to be downgraded from UTF-8 as a side-effect.
4360 Usually accessed via the C<SvPVbyte_nolen> macro.
4362 char* sv_2pvbyte_nolen(SV* sv)
4370 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
4371 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
4373 Usually accessed via the C<SvPVutf8> macro.
4375 char* sv_2pvutf8(SV* sv, STRLEN* lp)
4380 =item sv_2pvutf8_nolen
4383 Return a pointer to the UTF-8-encoded representation of the SV.
4384 May cause the SV to be upgraded to UTF-8 as a side-effect.
4386 Usually accessed via the C<SvPVutf8_nolen> macro.
4388 char* sv_2pvutf8_nolen(SV* sv)
4396 Returns a pointer to the string value of an SV, and sets *lp to its length.
4397 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
4399 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
4400 usually end up here too.
4402 char* sv_2pv_flags(SV* sv, STRLEN* lp, I32 flags)
4410 Like C<sv_2pv()>, but doesn't return the length too. You should usually
4411 use the macro wrapper C<SvPV_nolen(sv)> instead.
4412 char* sv_2pv_nolen(SV* sv)
4420 Return the unsigned integer value of an SV, doing any necessary string
4421 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
4422 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
4424 UV sv_2uv_flags(SV* sv, I32 flags)
4432 Remove any string offset. You should normally use the C<SvOOK_off> macro
4435 int sv_backoff(SV* sv)
4443 Blesses an SV into a specified package. The SV must be an RV. The package
4444 must be designated by its stash (see C<gv_stashpv()>). The reference count
4445 of the SV is unaffected.
4447 SV* sv_bless(SV* sv, HV* stash)
4455 Concatenates the string onto the end of the string which is in the SV.
4456 If the SV has the UTF-8 status set, then the bytes appended should be
4457 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4459 void sv_catpv(SV* sv, const char* ptr)
4467 Processes its arguments like C<sprintf> and appends the formatted
4468 output to an SV. If the appended data contains "wide" characters
4469 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
4470 and characters >255 formatted with %c), the original SV might get
4471 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
4472 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
4473 valid UTF-8; if the original SV was bytes, the pattern should be too.
4475 void sv_catpvf(SV* sv, const char* pat, ...)
4483 Like C<sv_catpvf>, but also handles 'set' magic.
4485 void sv_catpvf_mg(SV *sv, const char* pat, ...)
4493 Concatenates the string onto the end of the string which is in the SV. The
4494 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4495 status set, then the bytes appended should be valid UTF-8.
4496 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4498 void sv_catpvn(SV* sv, const char* ptr, STRLEN len)
4503 =item sv_catpvn_flags
4506 Concatenates the string onto the end of the string which is in the SV. The
4507 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4508 status set, then the bytes appended should be valid UTF-8.
4509 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4510 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4511 in terms of this function.
4513 void sv_catpvn_flags(SV* sv, const char* ptr, STRLEN len, I32 flags)
4521 Like C<sv_catpvn>, but also handles 'set' magic.
4523 void sv_catpvn_mg(SV *sv, const char *ptr, STRLEN len)
4528 =item sv_catpvn_nomg
4531 Like C<sv_catpvn> but doesn't process magic.
4533 void sv_catpvn_nomg(SV* sv, const char* ptr, STRLEN len)
4541 Like C<sv_catpv>, but also handles 'set' magic.
4543 void sv_catpv_mg(SV *sv, const char *ptr)
4551 Concatenates the string from SV C<ssv> onto the end of the string in
4552 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4553 not 'set' magic. See C<sv_catsv_mg>.
4555 void sv_catsv(SV* dsv, SV* ssv)
4560 =item sv_catsv_flags
4563 Concatenates the string from SV C<ssv> onto the end of the string in
4564 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4565 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4566 and C<sv_catsv_nomg> are implemented in terms of this function.
4568 void sv_catsv_flags(SV* dsv, SV* ssv, I32 flags)
4576 Like C<sv_catsv>, but also handles 'set' magic.
4578 void sv_catsv_mg(SV *dstr, SV *sstr)
4586 Like C<sv_catsv> but doesn't process magic.
4588 void sv_catsv_nomg(SV* dsv, SV* ssv)
4596 Efficient removal of characters from the beginning of the string buffer.
4597 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4598 the string buffer. The C<ptr> becomes the first character of the adjusted
4599 string. Uses the "OOK hack".
4600 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4601 refer to the same chunk of data.
4603 void sv_chop(SV* sv, const char* ptr)
4611 Clear an SV: call any destructors, free up any memory used by the body,
4612 and free the body itself. The SV's head is I<not> freed, although
4613 its type is set to all 1's so that it won't inadvertently be assumed
4614 to be live during global destruction etc.
4615 This function should only be called when REFCNT is zero. Most of the time
4616 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
4619 void sv_clear(SV* sv)
4627 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
4628 string in C<sv1> is less than, equal to, or greater than the string in
4629 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
4630 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
4632 I32 sv_cmp(SV* sv1, SV* sv2)
4640 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
4641 'use bytes' aware, handles get magic, and will coerce its args to strings
4642 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
4644 I32 sv_cmp_locale(SV* sv1, SV* sv2)
4652 Add Collate Transform magic to an SV if it doesn't already have it.
4654 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
4655 scalar data of the variable, but transformed to such a format that a normal
4656 memory comparison can be used to compare the data according to the locale
4659 char* sv_collxfrm(SV* sv, STRLEN* nxp)
4667 Copies a stringified representation of the source SV into the
4668 destination SV. Automatically performs any necessary mg_get and
4669 coercion of numeric values into strings. Guaranteed to preserve
4670 UTF-8 flag even from overloaded objects. Similar in nature to
4671 sv_2pv[_flags] but operates directly on an SV instead of just the
4672 string. Mostly uses sv_2pv_flags to do its work, except when that
4673 would lose the UTF-8'ness of the PV.
4675 void sv_copypv(SV* dsv, SV* ssv)
4683 Auto-decrement of the value in the SV, doing string to numeric conversion
4684 if necessary. Handles 'get' magic.
4691 =item sv_derived_from
4694 Returns a boolean indicating whether the SV is derived from the specified
4695 class. This is the function that implements C<UNIVERSAL::isa>. It works
4696 for class names as well as for objects.
4698 bool sv_derived_from(SV* sv, const char* name)
4701 Found in file universal.c
4706 Returns a boolean indicating whether the strings in the two SVs are
4707 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
4708 coerce its args to strings if necessary.
4710 I32 sv_eq(SV* sv1, SV* sv2)
4715 =item sv_force_normal
4718 Undo various types of fakery on an SV: if the PV is a shared string, make
4719 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4720 an xpvmg. See also C<sv_force_normal_flags>.
4722 void sv_force_normal(SV *sv)
4727 =item sv_force_normal_flags
4728 X<sv_force_normal_flags>
4730 Undo various types of fakery on an SV: if the PV is a shared string, make
4731 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4732 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4733 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4734 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4735 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4736 set to some other value.) In addition, the C<flags> parameter gets passed to
4737 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4738 with flags set to 0.
4740 void sv_force_normal_flags(SV *sv, U32 flags)
4748 Decrement an SV's reference count, and if it drops to zero, call
4749 C<sv_clear> to invoke destructors and free up any memory used by
4750 the body; finally, deallocate the SV's head itself.
4751 Normally called via a wrapper macro C<SvREFCNT_dec>.
4753 void sv_free(SV* sv)
4761 Get a line from the filehandle and store it into the SV, optionally
4762 appending to the currently-stored string.
4764 char* sv_gets(SV* sv, PerlIO* fp, I32 append)
4772 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
4773 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
4774 Use the C<SvGROW> wrapper instead.
4776 char* sv_grow(SV* sv, STRLEN newlen)
4784 Auto-increment of the value in the SV, doing string to numeric conversion
4785 if necessary. Handles 'get' magic.
4795 Inserts a string at the specified offset/length within the SV. Similar to
4796 the Perl substr() function.
4798 void sv_insert(SV* bigsv, STRLEN offset, STRLEN len, const char* little, STRLEN littlelen)
4806 Returns a boolean indicating whether the SV is blessed into the specified
4807 class. This does not check for subtypes; use C<sv_derived_from> to verify
4808 an inheritance relationship.
4810 int sv_isa(SV* sv, const char* name)
4818 Returns a boolean indicating whether the SV is an RV pointing to a blessed
4819 object. If the SV is not an RV, or if the object is not blessed, then this
4822 int sv_isobject(SV* sv)
4830 A private implementation of the C<SvIVx> macro for compilers which can't
4831 cope with complex macro expressions. Always use the macro instead.
4841 Returns the length of the string in the SV. Handles magic and type
4842 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
4844 STRLEN sv_len(SV* sv)
4852 Returns the number of characters in the string in an SV, counting wide
4853 UTF-8 bytes as a single character. Handles magic and type coercion.
4855 STRLEN sv_len_utf8(SV* sv)
4863 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4864 then adds a new magic item of type C<how> to the head of the magic list.
4866 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4867 handling of the C<name> and C<namlen> arguments.
4869 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4870 to add more than one instance of the same 'how'.
4872 void sv_magic(SV* sv, SV* obj, int how, const char* name, I32 namlen)
4880 Adds magic to an SV, upgrading it if necessary. Applies the
4881 supplied vtable and returns a pointer to the magic added.
4883 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4884 In particular, you can add magic to SvREADONLY SVs, and add more than
4885 one instance of the same 'how'.
4887 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4888 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4889 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4890 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4892 (This is now used as a subroutine by C<sv_magic>.)
4894 MAGIC * sv_magicext(SV* sv, SV* obj, int how, const MGVTBL *vtbl, const char* name, I32 namlen)
4902 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
4903 The new SV is marked as mortal. It will be destroyed "soon", either by an
4904 explicit call to FREETMPS, or by an implicit call at places such as
4905 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
4907 SV* sv_mortalcopy(SV* oldsv)
4915 Creates a new null SV which is mortal. The reference count of the SV is
4916 set to 1. It will be destroyed "soon", either by an explicit call to
4917 FREETMPS, or by an implicit call at places such as statement boundaries.
4918 See also C<sv_mortalcopy> and C<sv_2mortal>.
4928 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
4931 SV* sv_newref(SV* sv)
4939 A private implementation of the C<SvNVx> macro for compilers which can't
4940 cope with complex macro expressions. Always use the macro instead.
4950 Converts the value pointed to by offsetp from a count of bytes from the
4951 start of the string, to a count of the equivalent number of UTF-8 chars.
4952 Handles magic and type coercion.
4954 void sv_pos_b2u(SV* sv, I32* offsetp)
4962 Converts the value pointed to by offsetp from a count of UTF-8 chars from
4963 the start of the string, to a count of the equivalent number of bytes; if
4964 lenp is non-zero, it does the same to lenp, but this time starting from
4965 the offset, rather than from the start of the string. Handles magic and
4968 void sv_pos_u2b(SV* sv, I32* offsetp, I32* lenp)
4976 Use the C<SvPV_nolen> macro instead
4986 Use C<SvPVbyte_nolen> instead.
4988 char* sv_pvbyte(SV *sv)
4996 A private implementation of the C<SvPVbyte> macro for compilers
4997 which can't cope with complex macro expressions. Always use the macro
5000 char* sv_pvbyten(SV *sv, STRLEN *len)
5005 =item sv_pvbyten_force
5008 A private implementation of the C<SvPVbytex_force> macro for compilers
5009 which can't cope with complex macro expressions. Always use the macro
5012 char* sv_pvbyten_force(SV* sv, STRLEN* lp)
5020 A private implementation of the C<SvPV> macro for compilers which can't
5021 cope with complex macro expressions. Always use the macro instead.
5023 char* sv_pvn(SV *sv, STRLEN *len)
5031 Get a sensible string out of the SV somehow.
5032 A private implementation of the C<SvPV_force> macro for compilers which
5033 can't cope with complex macro expressions. Always use the macro instead.
5035 char* sv_pvn_force(SV* sv, STRLEN* lp)
5040 =item sv_pvn_force_flags
5041 X<sv_pvn_force_flags>
5043 Get a sensible string out of the SV somehow.
5044 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
5045 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
5046 implemented in terms of this function.
5047 You normally want to use the various wrapper macros instead: see
5048 C<SvPV_force> and C<SvPV_force_nomg>
5050 char* sv_pvn_force_flags(SV* sv, STRLEN* lp, I32 flags)
5058 Use the C<SvPVutf8_nolen> macro instead
5060 char* sv_pvutf8(SV *sv)
5068 A private implementation of the C<SvPVutf8> macro for compilers
5069 which can't cope with complex macro expressions. Always use the macro
5072 char* sv_pvutf8n(SV *sv, STRLEN *len)
5077 =item sv_pvutf8n_force
5080 A private implementation of the C<SvPVutf8_force> macro for compilers
5081 which can't cope with complex macro expressions. Always use the macro
5084 char* sv_pvutf8n_force(SV* sv, STRLEN* lp)
5092 Returns a string describing what the SV is a reference to.
5094 char* sv_reftype(const SV* sv, int ob)
5102 Make the first argument a copy of the second, then delete the original.
5103 The target SV physically takes over ownership of the body of the source SV
5104 and inherits its flags; however, the target keeps any magic it owns,
5105 and any magic in the source is discarded.
5106 Note that this is a rather specialist SV copying operation; most of the
5107 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5109 void sv_replace(SV* sv, SV* nsv)
5114 =item sv_report_used
5117 Dump the contents of all SVs not yet freed. (Debugging aid).
5119 void sv_report_used()
5127 Underlying implementation for the C<reset> Perl function.
5128 Note that the perl-level function is vaguely deprecated.
5130 void sv_reset(const char* s, HV* stash)
5138 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
5139 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
5140 push a back-reference to this RV onto the array of backreferences
5141 associated with that magic.
5143 SV* sv_rvweaken(SV *sv)
5151 Copies an integer into the given SV, upgrading first if necessary.
5152 Does not handle 'set' magic. See also C<sv_setiv_mg>.
5154 void sv_setiv(SV* sv, IV num)
5162 Like C<sv_setiv>, but also handles 'set' magic.
5164 void sv_setiv_mg(SV *sv, IV i)
5172 Copies a double into the given SV, upgrading first if necessary.
5173 Does not handle 'set' magic. See also C<sv_setnv_mg>.
5175 void sv_setnv(SV* sv, NV num)
5183 Like C<sv_setnv>, but also handles 'set' magic.
5185 void sv_setnv_mg(SV *sv, NV num)
5193 Copies a string into an SV. The string must be null-terminated. Does not
5194 handle 'set' magic. See C<sv_setpv_mg>.
5196 void sv_setpv(SV* sv, const char* ptr)
5204 Works like C<sv_catpvf> but copies the text into the SV instead of
5205 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
5207 void sv_setpvf(SV* sv, const char* pat, ...)
5215 Like C<sv_setpvf>, but also handles 'set' magic.
5217 void sv_setpvf_mg(SV *sv, const char* pat, ...)
5225 Copies an integer into the given SV, also updating its string value.
5226 Does not handle 'set' magic. See C<sv_setpviv_mg>.
5228 void sv_setpviv(SV* sv, IV num)
5236 Like C<sv_setpviv>, but also handles 'set' magic.
5238 void sv_setpviv_mg(SV *sv, IV iv)
5246 Copies a string into an SV. The C<len> parameter indicates the number of
5247 bytes to be copied. If the C<ptr> argument is NULL the SV will become
5248 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
5250 void sv_setpvn(SV* sv, const char* ptr, STRLEN len)
5258 Like C<sv_setpvn>, but also handles 'set' magic.
5260 void sv_setpvn_mg(SV *sv, const char *ptr, STRLEN len)
5268 Like C<sv_setpv>, but also handles 'set' magic.
5270 void sv_setpv_mg(SV *sv, const char *ptr)
5278 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
5279 argument will be upgraded to an RV. That RV will be modified to point to
5280 the new SV. The C<classname> argument indicates the package for the
5281 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
5282 will have a reference count of 1, and the RV will be returned.
5284 SV* sv_setref_iv(SV* rv, const char* classname, IV iv)
5292 Copies a double into a new SV, optionally blessing the SV. The C<rv>
5293 argument will be upgraded to an RV. That RV will be modified to point to
5294 the new SV. The C<classname> argument indicates the package for the
5295 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
5296 will have a reference count of 1, and the RV will be returned.
5298 SV* sv_setref_nv(SV* rv, const char* classname, NV nv)
5306 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
5307 argument will be upgraded to an RV. That RV will be modified to point to
5308 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
5309 into the SV. The C<classname> argument indicates the package for the
5310 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
5311 will have a reference count of 1, and the RV will be returned.
5313 Do not use with other Perl types such as HV, AV, SV, CV, because those
5314 objects will become corrupted by the pointer copy process.
5316 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
5318 SV* sv_setref_pv(SV* rv, const char* classname, void* pv)
5326 Copies a string into a new SV, optionally blessing the SV. The length of the
5327 string must be specified with C<n>. The C<rv> argument will be upgraded to
5328 an RV. That RV will be modified to point to the new SV. The C<classname>
5329 argument indicates the package for the blessing. Set C<classname> to
5330 C<Nullch> to avoid the blessing. The new SV will have a reference count
5331 of 1, and the RV will be returned.
5333 Note that C<sv_setref_pv> copies the pointer while this copies the string.
5335 SV* sv_setref_pvn(SV* rv, const char* classname, const char* pv, STRLEN n)
5343 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
5344 argument will be upgraded to an RV. That RV will be modified to point to
5345 the new SV. The C<classname> argument indicates the package for the
5346 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
5347 will have a reference count of 1, and the RV will be returned.
5349 SV* sv_setref_uv(SV* rv, const char* classname, UV uv)
5357 Copies the contents of the source SV C<ssv> into the destination SV
5358 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
5359 function if the source SV needs to be reused. Does not handle 'set' magic.
5360 Loosely speaking, it performs a copy-by-value, obliterating any previous
5361 content of the destination.
5363 You probably want to use one of the assortment of wrappers, such as
5364 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
5365 C<SvSetMagicSV_nosteal>.
5367 void sv_setsv(SV* dsv, SV* ssv)
5372 =item sv_setsv_flags
5375 Copies the contents of the source SV C<ssv> into the destination SV
5376 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
5377 function if the source SV needs to be reused. Does not handle 'set' magic.
5378 Loosely speaking, it performs a copy-by-value, obliterating any previous
5379 content of the destination.
5380 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
5381 C<ssv> if appropriate, else not. If the C<flags> parameter has the
5382 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
5383 and C<sv_setsv_nomg> are implemented in terms of this function.
5385 You probably want to use one of the assortment of wrappers, such as
5386 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
5387 C<SvSetMagicSV_nosteal>.
5389 This is the primary function for copying scalars, and most other
5390 copy-ish functions and macros use this underneath.
5392 void sv_setsv_flags(SV* dsv, SV* ssv, I32 flags)
5400 Like C<sv_setsv>, but also handles 'set' magic.
5402 void sv_setsv_mg(SV *dstr, SV *sstr)
5410 Like C<sv_setsv> but doesn't process magic.
5412 void sv_setsv_nomg(SV* dsv, SV* ssv)
5420 Copies an unsigned integer into the given SV, upgrading first if necessary.
5421 Does not handle 'set' magic. See also C<sv_setuv_mg>.
5423 void sv_setuv(SV* sv, UV num)
5431 Like C<sv_setuv>, but also handles 'set' magic.
5433 void sv_setuv_mg(SV *sv, UV u)
5441 Taint an SV. Use C<SvTAINTED_on> instead.
5442 void sv_taint(SV* sv)
5450 Test an SV for taintedness. Use C<SvTAINTED> instead.
5451 bool sv_tainted(SV* sv)
5459 Returns true if the SV has a true value by Perl's rules.
5460 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
5461 instead use an in-line version.
5471 Removes all magic of type C<type> from an SV.
5473 int sv_unmagic(SV* sv, int type)
5481 Unsets the RV status of the SV, and decrements the reference count of
5482 whatever was being referenced by the RV. This can almost be thought of
5483 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
5484 being zero. See C<SvROK_off>.
5486 void sv_unref(SV* sv)
5491 =item sv_unref_flags
5494 Unsets the RV status of the SV, and decrements the reference count of
5495 whatever was being referenced by the RV. This can almost be thought of
5496 as a reversal of C<newSVrv>. The C<cflags> argument can contain
5497 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
5498 (otherwise the decrementing is conditional on the reference count being
5499 different from one or the reference being a readonly SV).
5502 void sv_unref_flags(SV* sv, U32 flags)
5510 Untaint an SV. Use C<SvTAINTED_off> instead.
5511 void sv_untaint(SV* sv)
5519 Upgrade an SV to a more complex form. Generally adds a new body type to the
5520 SV, then copies across as much information as possible from the old body.
5521 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
5523 void sv_upgrade(SV* sv, U32 mt)
5531 Tells an SV to use C<ptr> to find its string value. Normally the string is
5532 stored inside the SV but sv_usepvn allows the SV to use an outside string.
5533 The C<ptr> should point to memory that was allocated by C<malloc>. The
5534 string length, C<len>, must be supplied. This function will realloc the
5535 memory pointed to by C<ptr>, so that pointer should not be freed or used by
5536 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
5537 See C<sv_usepvn_mg>.
5539 void sv_usepvn(SV* sv, char* ptr, STRLEN len)
5547 Like C<sv_usepvn>, but also handles 'set' magic.
5549 void sv_usepvn_mg(SV *sv, char *ptr, STRLEN len)
5554 =item sv_utf8_decode
5557 If the PV of the SV is an octet sequence in UTF-8
5558 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
5559 so that it looks like a character. If the PV contains only single-byte
5560 characters, the C<SvUTF8> flag stays being off.
5561 Scans PV for validity and returns false if the PV is invalid UTF-8.
5563 NOTE: this function is experimental and may change or be
5564 removed without notice.
5566 bool sv_utf8_decode(SV *sv)
5571 =item sv_utf8_downgrade
5572 X<sv_utf8_downgrade>
5574 Attempts to convert the PV of an SV from characters to bytes.
5575 If the PV contains a character beyond byte, this conversion will fail;
5576 in this case, either returns false or, if C<fail_ok> is not
5579 This is not as a general purpose Unicode to byte encoding interface:
5580 use the Encode extension for that.
5582 NOTE: this function is experimental and may change or be
5583 removed without notice.
5585 bool sv_utf8_downgrade(SV *sv, bool fail_ok)
5590 =item sv_utf8_encode
5593 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
5594 flag off so that it looks like octets again.
5596 void sv_utf8_encode(SV *sv)
5601 =item sv_utf8_upgrade
5604 Converts the PV of an SV to its UTF-8-encoded form.
5605 Forces the SV to string form if it is not already.
5606 Always sets the SvUTF8 flag to avoid future validity checks even
5607 if all the bytes have hibit clear.
5609 This is not as a general purpose byte encoding to Unicode interface:
5610 use the Encode extension for that.
5612 STRLEN sv_utf8_upgrade(SV *sv)
5617 =item sv_utf8_upgrade_flags
5618 X<sv_utf8_upgrade_flags>
5620 Converts the PV of an SV to its UTF-8-encoded form.
5621 Forces the SV to string form if it is not already.
5622 Always sets the SvUTF8 flag to avoid future validity checks even
5623 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
5624 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
5625 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
5627 This is not as a general purpose byte encoding to Unicode interface:
5628 use the Encode extension for that.
5630 STRLEN sv_utf8_upgrade_flags(SV *sv, I32 flags)
5638 A private implementation of the C<SvUVx> macro for compilers which can't
5639 cope with complex macro expressions. Always use the macro instead.
5649 Processes its arguments like C<vsprintf> and appends the formatted output
5650 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
5652 Usually used via its frontend C<sv_catpvf>.
5654 void sv_vcatpvf(SV* sv, const char* pat, va_list* args)
5662 Processes its arguments like C<vsprintf> and appends the formatted output
5663 to an SV. Uses an array of SVs if the C style variable argument list is
5664 missing (NULL). When running with taint checks enabled, indicates via
5665 C<maybe_tainted> if results are untrustworthy (often due to the use of
5668 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
5670 void sv_vcatpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
5678 Like C<sv_vcatpvf>, but also handles 'set' magic.
5680 Usually used via its frontend C<sv_catpvf_mg>.
5682 void sv_vcatpvf_mg(SV* sv, const char* pat, va_list* args)
5690 Works like C<sv_vcatpvf> but copies the text into the SV instead of
5691 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
5693 Usually used via its frontend C<sv_setpvf>.
5695 void sv_vsetpvf(SV* sv, const char* pat, va_list* args)
5703 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
5706 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
5708 void sv_vsetpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
5716 Like C<sv_vsetpvf>, but also handles 'set' magic.
5718 Usually used via its frontend C<sv_setpvf_mg>.
5720 void sv_vsetpvf_mg(SV* sv, const char* pat, va_list* args)
5728 =head1 Unicode Support
5732 =item bytes_from_utf8
5735 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
5736 Unlike C<utf8_to_bytes> but like C<bytes_to_utf8>, returns a pointer to
5737 the newly-created string, and updates C<len> to contain the new
5738 length. Returns the original string if no conversion occurs, C<len>
5739 is unchanged. Do nothing if C<is_utf8> points to 0. Sets C<is_utf8> to
5740 0 if C<s> is converted or contains all 7bit characters.
5742 NOTE: this function is experimental and may change or be
5743 removed without notice.
5745 U8* bytes_from_utf8(const U8 *s, STRLEN *len, bool *is_utf8)
5748 Found in file utf8.c
5753 Converts a string C<s> of length C<len> from ASCII into UTF-8 encoding.
5754 Returns a pointer to the newly-created string, and sets C<len> to
5755 reflect the new length.
5757 If you want to convert to UTF-8 from other encodings than ASCII,
5758 see sv_recode_to_utf8().
5760 NOTE: this function is experimental and may change or be
5761 removed without notice.
5763 U8* bytes_to_utf8(const U8 *s, STRLEN *len)
5766 Found in file utf8.c
5771 Return true if the strings s1 and s2 differ case-insensitively, false
5772 if not (if they are equal case-insensitively). If u1 is true, the
5773 string s1 is assumed to be in UTF-8-encoded Unicode. If u2 is true,
5774 the string s2 is assumed to be in UTF-8-encoded Unicode. If u1 or u2
5775 are false, the respective string is assumed to be in native 8-bit
5778 If the pe1 and pe2 are non-NULL, the scanning pointers will be copied
5779 in there (they will point at the beginning of the I<next> character).
5780 If the pointers behind pe1 or pe2 are non-NULL, they are the end
5781 pointers beyond which scanning will not continue under any
5782 circumstances. If the byte lengths l1 and l2 are non-zero, s1+l1 and
5783 s2+l2 will be used as goal end pointers that will also stop the scan,
5784 and which qualify towards defining a successful match: all the scans
5785 that define an explicit length must reach their goal pointers for
5786 a match to succeed).
5788 For case-insensitiveness, the "casefolding" of Unicode is used
5789 instead of upper/lowercasing both the characters, see
5790 http://www.unicode.org/unicode/reports/tr21/ (Case Mappings).
5792 I32 ibcmp_utf8(const char* a, char **pe1, UV l1, bool u1, const char* b, char **pe2, UV l2, bool u2)
5795 Found in file utf8.c
5800 Tests if some arbitrary number of bytes begins in a valid UTF-8
5801 character. Note that an INVARIANT (i.e. ASCII) character is a valid
5802 UTF-8 character. The actual number of bytes in the UTF-8 character
5803 will be returned if it is valid, otherwise 0.
5805 STRLEN is_utf8_char(const U8 *p)
5808 Found in file utf8.c
5810 =item is_utf8_string
5813 Returns true if first C<len> bytes of the given string form a valid
5814 UTF-8 string, false otherwise. Note that 'a valid UTF-8 string' does
5815 not mean 'a string that contains code points above 0x7F encoded in UTF-8'
5816 because a valid ASCII string is a valid UTF-8 string.
5818 See also is_utf8_string_loclen() and is_utf8_string_loc().
5820 bool is_utf8_string(const U8 *s, STRLEN len)
5823 Found in file utf8.c
5825 =item is_utf8_string_loc
5826 X<is_utf8_string_loc>
5828 Like is_ut8_string() but stores the location of the failure (in the
5829 case of "utf8ness failure") or the location s+len (in the case of
5830 "utf8ness success") in the C<ep>.
5832 See also is_utf8_string_loclen() and is_utf8_string().
5834 bool is_utf8_string_loc(const U8 *s, STRLEN len, const U8 **p)
5837 Found in file utf8.c
5839 =item is_utf8_string_loclen
5840 X<is_utf8_string_loclen>
5842 Like is_ut8_string() but stores the location of the failure (in the
5843 case of "utf8ness failure") or the location s+len (in the case of
5844 "utf8ness success") in the C<ep>, and the number of UTF-8
5845 encoded characters in the C<el>.
5847 See also is_utf8_string_loc() and is_utf8_string().
5849 bool is_utf8_string_loclen(const U8 *s, STRLEN len, const U8 **ep, STRLEN *el)
5852 Found in file utf8.c
5854 =item pv_uni_display
5857 Build to the scalar dsv a displayable version of the string spv,
5858 length len, the displayable version being at most pvlim bytes long
5859 (if longer, the rest is truncated and "..." will be appended).
5861 The flags argument can have UNI_DISPLAY_ISPRINT set to display
5862 isPRINT()able characters as themselves, UNI_DISPLAY_BACKSLASH
5863 to display the \\[nrfta\\] as the backslashed versions (like '\n')
5864 (UNI_DISPLAY_BACKSLASH is preferred over UNI_DISPLAY_ISPRINT for \\).
5865 UNI_DISPLAY_QQ (and its alias UNI_DISPLAY_REGEX) have both
5866 UNI_DISPLAY_BACKSLASH and UNI_DISPLAY_ISPRINT turned on.
5868 The pointer to the PV of the dsv is returned.
5870 char* pv_uni_display(SV *dsv, const U8 *spv, STRLEN len, STRLEN pvlim, UV flags)
5873 Found in file utf8.c
5878 The encoding is assumed to be an Encode object, the PV of the ssv is
5879 assumed to be octets in that encoding and decoding the input starts
5880 from the position which (PV + *offset) pointed to. The dsv will be
5881 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
5882 when the string tstr appears in decoding output or the input ends on
5883 the PV of the ssv. The value which the offset points will be modified
5884 to the last input position on the ssv.
5886 Returns TRUE if the terminator was found, else returns FALSE.
5888 bool sv_cat_decode(SV* dsv, SV *encoding, SV *ssv, int *offset, char* tstr, int tlen)
5893 =item sv_recode_to_utf8
5894 X<sv_recode_to_utf8>
5896 The encoding is assumed to be an Encode object, on entry the PV
5897 of the sv is assumed to be octets in that encoding, and the sv
5898 will be converted into Unicode (and UTF-8).
5900 If the sv already is UTF-8 (or if it is not POK), or if the encoding
5901 is not a reference, nothing is done to the sv. If the encoding is not
5902 an C<Encode::XS> Encoding object, bad things will happen.
5903 (See F<lib/encoding.pm> and L<Encode>).
5905 The PV of the sv is returned.
5907 char* sv_recode_to_utf8(SV* sv, SV *encoding)
5912 =item sv_uni_display
5915 Build to the scalar dsv a displayable version of the scalar sv,
5916 the displayable version being at most pvlim bytes long
5917 (if longer, the rest is truncated and "..." will be appended).
5919 The flags argument is as in pv_uni_display().
5921 The pointer to the PV of the dsv is returned.
5923 char* sv_uni_display(SV *dsv, SV *ssv, STRLEN pvlim, UV flags)
5926 Found in file utf8.c
5931 The "p" contains the pointer to the UTF-8 string encoding
5932 the character that is being converted.
5934 The "ustrp" is a pointer to the character buffer to put the
5935 conversion result to. The "lenp" is a pointer to the length
5938 The "swashp" is a pointer to the swash to use.
5940 Both the special and normal mappings are stored lib/unicore/To/Foo.pl,
5941 and loaded by SWASHGET, using lib/utf8_heavy.pl. The special (usually,
5942 but not always, a multicharacter mapping), is tried first.
5944 The "special" is a string like "utf8::ToSpecLower", which means the
5945 hash %utf8::ToSpecLower. The access to the hash is through
5946 Perl_to_utf8_case().
5948 The "normal" is a string like "ToLower" which means the swash
5951 UV to_utf8_case(const U8 *p, U8* ustrp, STRLEN *lenp, SV **swashp, const char *normal, const char *special)
5954 Found in file utf8.c
5959 Convert the UTF-8 encoded character at p to its foldcase version and
5960 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
5961 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
5962 foldcase version may be longer than the original character (up to
5965 The first character of the foldcased version is returned
5966 (but note, as explained above, that there may be more.)
5968 UV to_utf8_fold(const U8 *p, U8* ustrp, STRLEN *lenp)
5971 Found in file utf8.c
5976 Convert the UTF-8 encoded character at p to its lowercase version and
5977 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
5978 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
5979 lowercase version may be longer than the original character.
5981 The first character of the lowercased version is returned
5982 (but note, as explained above, that there may be more.)
5984 UV to_utf8_lower(const U8 *p, U8* ustrp, STRLEN *lenp)
5987 Found in file utf8.c
5992 Convert the UTF-8 encoded character at p to its titlecase version and
5993 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
5994 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
5995 titlecase version may be longer than the original character.
5997 The first character of the titlecased version is returned
5998 (but note, as explained above, that there may be more.)
6000 UV to_utf8_title(const U8 *p, U8* ustrp, STRLEN *lenp)
6003 Found in file utf8.c
6008 Convert the UTF-8 encoded character at p to its uppercase version and
6009 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
6010 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since
6011 the uppercase version may be longer than the original character.
6013 The first character of the uppercased version is returned
6014 (but note, as explained above, that there may be more.)
6016 UV to_utf8_upper(const U8 *p, U8* ustrp, STRLEN *lenp)
6019 Found in file utf8.c
6021 =item utf8n_to_uvchr
6024 Returns the native character value of the first character in the string C<s>
6025 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6026 length, in bytes, of that character.
6028 Allows length and flags to be passed to low level routine.
6030 UV utf8n_to_uvchr(const U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags)
6033 Found in file utf8.c
6035 =item utf8n_to_uvuni
6038 Bottom level UTF-8 decode routine.
6039 Returns the unicode code point value of the first character in the string C<s>
6040 which is assumed to be in UTF-8 encoding and no longer than C<curlen>;
6041 C<retlen> will be set to the length, in bytes, of that character.
6043 If C<s> does not point to a well-formed UTF-8 character, the behaviour
6044 is dependent on the value of C<flags>: if it contains UTF8_CHECK_ONLY,
6045 it is assumed that the caller will raise a warning, and this function
6046 will silently just set C<retlen> to C<-1> and return zero. If the
6047 C<flags> does not contain UTF8_CHECK_ONLY, warnings about
6048 malformations will be given, C<retlen> will be set to the expected
6049 length of the UTF-8 character in bytes, and zero will be returned.
6051 The C<flags> can also contain various flags to allow deviations from
6052 the strict UTF-8 encoding (see F<utf8.h>).
6054 Most code should use utf8_to_uvchr() rather than call this directly.
6056 UV utf8n_to_uvuni(const U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags)
6059 Found in file utf8.c
6064 Returns the number of UTF-8 characters between the UTF-8 pointers C<a>
6067 WARNING: use only if you *know* that the pointers point inside the
6070 IV utf8_distance(const U8 *a, const U8 *b)
6073 Found in file utf8.c
6078 Return the UTF-8 pointer C<s> displaced by C<off> characters, either
6079 forward or backward.
6081 WARNING: do not use the following unless you *know* C<off> is within
6082 the UTF-8 data pointed to by C<s> *and* that on entry C<s> is aligned
6083 on the first byte of character or just after the last byte of a character.
6085 U8* utf8_hop(const U8 *s, I32 off)
6088 Found in file utf8.c
6093 Return the length of the UTF-8 char encoded string C<s> in characters.
6094 Stops at C<e> (inclusive). If C<e E<lt> s> or if the scan would end
6095 up past C<e>, croaks.
6097 STRLEN utf8_length(const U8* s, const U8 *e)
6100 Found in file utf8.c
6105 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
6106 Unlike C<bytes_to_utf8>, this over-writes the original string, and
6107 updates len to contain the new length.
6108 Returns zero on failure, setting C<len> to -1.
6110 NOTE: this function is experimental and may change or be
6111 removed without notice.
6113 U8* utf8_to_bytes(U8 *s, STRLEN *len)
6116 Found in file utf8.c
6121 Returns the native character value of the first character in the string C<s>
6122 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6123 length, in bytes, of that character.
6125 If C<s> does not point to a well-formed UTF-8 character, zero is
6126 returned and retlen is set, if possible, to -1.
6128 UV utf8_to_uvchr(const U8 *s, STRLEN *retlen)
6131 Found in file utf8.c
6136 Returns the Unicode code point of the first character in the string C<s>
6137 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
6138 length, in bytes, of that character.
6140 This function should only be used when returned UV is considered
6141 an index into the Unicode semantic tables (e.g. swashes).
6143 If C<s> does not point to a well-formed UTF-8 character, zero is
6144 returned and retlen is set, if possible, to -1.
6146 UV utf8_to_uvuni(const U8 *s, STRLEN *retlen)
6149 Found in file utf8.c
6154 Adds the UTF-8 representation of the Native codepoint C<uv> to the end
6155 of the string C<d>; C<d> should be have at least C<UTF8_MAXBYTES+1> free
6156 bytes available. The return value is the pointer to the byte after the
6157 end of the new character. In other words,
6159 d = uvchr_to_utf8(d, uv);
6161 is the recommended wide native character-aware way of saying
6165 U8* uvchr_to_utf8(U8 *d, UV uv)
6168 Found in file utf8.c
6170 =item uvuni_to_utf8_flags
6171 X<uvuni_to_utf8_flags>
6173 Adds the UTF-8 representation of the Unicode codepoint C<uv> to the end
6174 of the string C<d>; C<d> should be have at least C<UTF8_MAXBYTES+1> free
6175 bytes available. The return value is the pointer to the byte after the
6176 end of the new character. In other words,
6178 d = uvuni_to_utf8_flags(d, uv, flags);
6182 d = uvuni_to_utf8(d, uv);
6184 (which is equivalent to)
6186 d = uvuni_to_utf8_flags(d, uv, 0);
6188 is the recommended Unicode-aware way of saying
6192 U8* uvuni_to_utf8_flags(U8 *d, UV uv, UV flags)
6195 Found in file utf8.c
6200 =head1 Variables created by C<xsubpp> and C<xsubpp> internal functions
6207 Variable which is setup by C<xsubpp> to indicate the stack base offset,
6208 used by the C<ST>, C<XSprePUSH> and C<XSRETURN> macros. The C<dMARK> macro
6209 must be called prior to setup the C<MARK> variable.
6214 Found in file XSUB.h
6219 Variable which is setup by C<xsubpp> to indicate the
6220 class name for a C++ XS constructor. This is always a C<char*>. See C<THIS>.
6225 Found in file XSUB.h
6230 Sets up the C<ax> variable.
6231 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
6236 Found in file XSUB.h
6241 Sets up the C<ax> variable and stack marker variable C<mark>.
6242 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
6247 Found in file XSUB.h
6252 Sets up the C<items> variable.
6253 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
6258 Found in file XSUB.h
6263 Sets up the C<padoff_du> variable for an XSUB that wishes to use
6269 Found in file XSUB.h
6274 Sets up stack and mark pointers for an XSUB, calling dSP and dMARK.
6275 Sets up the C<ax> and C<items> variables by calling C<dAX> and C<dITEMS>.
6276 This is usually handled automatically by C<xsubpp>.
6281 Found in file XSUB.h
6286 Sets up the C<ix> variable for an XSUB which has aliases. This is usually
6287 handled automatically by C<xsubpp>.
6292 Found in file XSUB.h
6297 Variable which is setup by C<xsubpp> to indicate the number of
6298 items on the stack. See L<perlxs/"Variable-length Parameter Lists">.
6303 Found in file XSUB.h
6308 Variable which is setup by C<xsubpp> to indicate which of an
6309 XSUB's aliases was used to invoke it. See L<perlxs/"The ALIAS: Keyword">.
6314 Found in file XSUB.h
6319 Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
6323 Found in file XSUB.h
6328 Variable which is setup by C<xsubpp> to hold the return value for an
6329 XSUB. This is always the proper type for the XSUB. See
6330 L<perlxs/"The RETVAL Variable">.
6335 Found in file XSUB.h
6340 Used to access elements on the XSUB's stack.
6345 Found in file XSUB.h
6350 Variable which is setup by C<xsubpp> to designate the object in a C++
6351 XSUB. This is always the proper type for the C++ object. See C<CLASS> and
6352 L<perlxs/"Using XS With C++">.
6357 Found in file XSUB.h
6362 The SV* corresponding to the $_ variable. Works even if there
6363 is a lexical $_ in scope.
6366 Found in file XSUB.h
6371 Macro to declare an XSUB and its C parameter list. This is handled by
6375 Found in file XSUB.h
6380 The version identifier for an XS module. This is usually
6381 handled automatically by C<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>.
6384 Found in file XSUB.h
6386 =item XS_VERSION_BOOTCHECK
6387 X<XS_VERSION_BOOTCHECK>
6389 Macro to verify that a PM module's $VERSION variable matches the XS
6390 module's C<XS_VERSION> variable. This is usually handled automatically by
6391 C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">.
6393 XS_VERSION_BOOTCHECK;
6396 Found in file XSUB.h
6401 =head1 Warning and Dieing
6408 This is the XSUB-writer's interface to Perl's C<die> function.
6409 Normally call this function the same way you call the C C<printf>
6410 function. Calling C<croak> returns control directly to Perl,
6411 sidestepping the normal C order of execution. See C<warn>.
6413 If you want to throw an exception object, assign the object to
6414 C<$@> and then pass C<Nullch> to croak():
6416 errsv = get_sv("@", TRUE);
6417 sv_setsv(errsv, exception_object);
6420 void croak(const char* pat, ...)
6423 Found in file util.c
6428 This is the XSUB-writer's interface to Perl's C<warn> function. Call this
6429 function the same way you call the C C<printf> function. See C<croak>.
6431 void warn(const char* pat, ...)
6434 Found in file util.c
6441 Until May 1997, this document was maintained by Jeff Okamoto
6442 <okamoto@corp.hp.com>. It is now maintained as part of Perl itself.
6444 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
6445 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
6446 Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
6447 Stephen McCamant, and Gurusamy Sarathy.
6449 API Listing originally by Dean Roehrich <roehrich@cray.com>.
6451 Updated to be autogenerated from comments in the source by Benjamin Stuhl.
6455 perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
https://perl5.git.perl.org / perl5.git / blob