3 perlapi - autogenerated documentation for the perl public API
7 This file contains the documentation of the perl public API generated by
8 embed.pl, specifically a listing of functions, macros, flags, and variables
9 that may be used by extension writers. The interfaces of any functions that
10 are not listed here are subject to change without notice. For this reason,
11 blindly using functions listed in proto.h is to be avoided when writing
14 Note that all Perl API global variables must be referenced with the C<PL_>
15 prefix. Some macros are provided for compatibility with the older,
16 unadorned names, but this support may be disabled in a future release.
18 The listing is alphabetical, case insensitive.
27 A backward-compatible version of C<GIMME_V> which can only return
28 C<G_SCALAR> or C<G_ARRAY>; in a void context, it returns C<G_SCALAR>.
29 Deprecated. Use C<GIMME_V> instead.
38 The XSUB-writer's equivalent to Perl's C<wantarray>. Returns C<G_VOID>,
39 C<G_SCALAR> or C<G_ARRAY> for void, scalar or list context,
49 Used to indicate list context. See C<GIMME_V>, C<GIMME> and
57 Indicates that arguments returned from a callback should be discarded. See
65 Used to force a Perl C<eval> wrapper around a callback. See
73 Indicates that no arguments are being sent to a callback. See
81 Used to indicate scalar context. See C<GIMME_V>, C<GIMME>, and
89 Used to indicate void context. See C<GIMME_V> and L<perlcall>.
97 =head1 Array Manipulation Functions
103 Same as C<av_len()>. Deprecated, use C<av_len()> instead.
112 Clears an array, making it empty. Does not free the memory used by the
115 void av_clear(AV* ar)
122 Deletes the element indexed by C<key> from the array. Returns the
123 deleted element. C<flags> is currently ignored.
125 SV* av_delete(AV* ar, I32 key, I32 flags)
132 Returns true if the element indexed by C<key> has been initialized.
134 This relies on the fact that uninitialized array elements are set to
137 bool av_exists(AV* ar, I32 key)
144 Pre-extend an array. The C<key> is the index to which the array should be
147 void av_extend(AV* ar, I32 key)
154 Returns the SV at the specified index in the array. The C<key> is the
155 index. If C<lval> is set then the fetch will be part of a store. Check
156 that the return value is non-null before dereferencing it to a C<SV*>.
158 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for
159 more information on how to use this function on tied arrays.
161 SV** av_fetch(AV* ar, I32 key, I32 lval)
168 Ensure than an array has a given number of elements, equivalent to
169 Perl's C<$#array = $fill;>.
171 void av_fill(AV* ar, I32 fill)
178 Returns the highest index in the array. Returns -1 if the array is
188 Creates a new AV and populates it with a list of SVs. The SVs are copied
189 into the array, so they may be freed after the call to av_make. The new AV
190 will have a reference count of 1.
192 AV* av_make(I32 size, SV** svp)
199 Pops an SV off the end of the array. Returns C<&PL_sv_undef> if the array
209 Pushes an SV onto the end of the array. The array will grow automatically
210 to accommodate the addition.
212 void av_push(AV* ar, SV* val)
219 Shifts an SV off the beginning of the array.
228 Stores an SV in an array. The array index is specified as C<key>. The
229 return value will be NULL if the operation failed or if the value did not
230 need to be actually stored within the array (as in the case of tied
231 arrays). Otherwise it can be dereferenced to get the original C<SV*>. Note
232 that the caller is responsible for suitably incrementing the reference
233 count of C<val> before the call, and decrementing it if the function
236 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for
237 more information on how to use this function on tied arrays.
239 SV** av_store(AV* ar, I32 key, SV* val)
246 Undefines the array. Frees the memory used by the array itself.
248 void av_undef(AV* ar)
255 Unshift the given number of C<undef> values onto the beginning of the
256 array. The array will grow automatically to accommodate the addition. You
257 must then use C<av_store> to assign values to these new elements.
259 void av_unshift(AV* ar, I32 num)
266 Returns the AV of the specified Perl array. If C<create> is set and the
267 Perl variable does not exist then it will be created. If C<create> is not
268 set and the variable does not exist then NULL is returned.
270 NOTE: the perl_ form of this function is deprecated.
272 AV* get_av(const char* name, I32 create)
279 Creates a new AV. The reference count is set to 1.
296 Sort an array. Here is an example:
298 sortsv(AvARRAY(av), av_len(av)+1, Perl_sv_cmp_locale);
300 void sortsv(SV ** array, size_t num_elts, SVCOMPARE_t cmp)
303 Found in file pp_sort.c
308 =head1 Callback Functions
314 Performs a callback to the specified Perl sub. See L<perlcall>.
316 NOTE: the perl_ form of this function is deprecated.
318 I32 call_argv(const char* sub_name, I32 flags, char** argv)
325 Performs a callback to the specified Perl method. The blessed object must
326 be on the stack. See L<perlcall>.
328 NOTE: the perl_ form of this function is deprecated.
330 I32 call_method(const char* methname, I32 flags)
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_pv(const char* sub_name, I32 flags)
348 Performs a callback to the Perl sub whose name is in the SV. See
351 NOTE: the perl_ form of this function is deprecated.
353 I32 call_sv(SV* sv, I32 flags)
360 Opening bracket on a callback. See C<LEAVE> and L<perlcall>.
365 Found in file scope.h
369 Tells Perl to C<eval> the given string and return an SV* result.
371 NOTE: the perl_ form of this function is deprecated.
373 SV* eval_pv(const char* p, I32 croak_on_error)
380 Tells Perl to C<eval> the string in the SV.
382 NOTE: the perl_ form of this function is deprecated.
384 I32 eval_sv(SV* sv, I32 flags)
391 Closing bracket for temporaries on a callback. See C<SAVETMPS> and
397 Found in file scope.h
401 Closing bracket on a callback. See C<ENTER> and L<perlcall>.
406 Found in file scope.h
410 Opening bracket for temporaries on a callback. See C<FREETMPS> and
416 Found in file scope.h
421 =head1 Character classes
427 Returns a boolean indicating whether the C C<char> is an ASCII alphanumeric
428 character (including underscore) or digit.
430 bool isALNUM(char ch)
433 Found in file handy.h
437 Returns a boolean indicating whether the C C<char> is an ASCII alphabetic
440 bool isALPHA(char ch)
443 Found in file handy.h
447 Returns a boolean indicating whether the C C<char> is an ASCII
450 bool isDIGIT(char ch)
453 Found in file handy.h
457 Returns a boolean indicating whether the C C<char> is a lowercase
460 bool isLOWER(char ch)
463 Found in file handy.h
467 Returns a boolean indicating whether the C C<char> is whitespace.
469 bool isSPACE(char ch)
472 Found in file handy.h
476 Returns a boolean indicating whether the C C<char> is an uppercase
479 bool isUPPER(char ch)
482 Found in file handy.h
486 Converts the specified character to lowercase.
488 char toLOWER(char ch)
491 Found in file handy.h
495 Converts the specified character to uppercase.
497 char toUPPER(char ch)
500 Found in file handy.h
505 =head1 Cloning an interpreter
511 Create and return a new interpreter by cloning the current one.
513 PerlInterpreter* perl_clone(PerlInterpreter* interp, UV flags)
521 =head1 CV Manipulation Functions
527 Returns the stash of the CV.
536 Returns the CV of the specified Perl subroutine. If C<create> is set and
537 the Perl subroutine does not exist then it will be declared (which has the
538 same effect as saying C<sub name;>). If C<create> is not set and the
539 subroutine does not exist then NULL is returned.
541 NOTE: the perl_ form of this function is deprecated.
543 CV* get_cv(const char* name, I32 create)
559 =head1 Embedding Functions
565 Loads the module whose name is pointed to by the string part of name.
566 Note that the actual module name, not its filename, should be given.
567 Eg, "Foo::Bar" instead of "Foo/Bar.pm". flags can be any of
568 PERL_LOADMOD_DENY, PERL_LOADMOD_NOIMPORT, or PERL_LOADMOD_IMPORT_OPS
569 (or 0 for no flags). ver, if specified, provides version semantics
570 similar to C<use Foo::Bar VERSION>. The optional trailing SV*
571 arguments can be used to specify arguments to the module's import()
572 method, similar to C<use Foo::Bar VERSION LIST>.
574 void load_module(U32 flags, SV* name, SV* ver, ...)
581 Stub that provides thread hook for perl_destruct when there are
591 Allocates a new Perl interpreter. See L<perlembed>.
593 PerlInterpreter* perl_alloc()
600 Initializes a new Perl interpreter. See L<perlembed>.
602 void perl_construct(PerlInterpreter* interp)
609 Shuts down a Perl interpreter. See L<perlembed>.
611 int perl_destruct(PerlInterpreter* interp)
618 Releases a Perl interpreter. See L<perlembed>.
620 void perl_free(PerlInterpreter* interp)
627 Tells a Perl interpreter to parse a Perl script. See L<perlembed>.
629 int perl_parse(PerlInterpreter* interp, XSINIT_t xsinit, int argc, char** argv, char** env)
636 Tells a Perl interpreter to run. See L<perlembed>.
638 int perl_run(PerlInterpreter* interp)
645 Tells Perl to C<require> the file named by the string argument. It is
646 analogous to the Perl code C<eval "require '$file'">. It's even
647 implemented that way; consider using Perl_load_module instead.
649 NOTE: the perl_ form of this function is deprecated.
651 void require_pv(const char* pv)
659 =head1 Functions in file pp_pack.c
666 The engine implementing pack() Perl function.
668 void pack_cat(SV *cat, char *pat, char *patend, SV **beglist, SV **endlist, SV ***next_in_list, U32 flags)
671 Found in file pp_pack.c
675 The engine implementing unpack() Perl function.
677 I32 unpack_str(char *pat, char *patend, char *s, char *strbeg, char *strend, char **new_s, I32 ocnt, U32 flags)
680 Found in file pp_pack.c
685 =head1 Global Variables
691 C<PL_modglobal> is a general purpose, interpreter global HV for use by
692 extensions that need to keep information on a per-interpreter basis.
693 In a pinch, it can also be used as a symbol table for extensions
694 to share data among each other. It is a good idea to use keys
695 prefixed by the package name of the extension that owns the data.
700 Found in file intrpvar.h
704 A convenience variable which is typically used with C<SvPV> when one
705 doesn't care about the length of the string. It is usually more efficient
706 to either declare a local variable and use that instead or to use the
712 Found in file thrdvar.h
716 This is the C<false> SV. See C<PL_sv_yes>. Always refer to this as
722 Found in file intrpvar.h
726 This is the C<undef> SV. Always refer to this as C<&PL_sv_undef>.
731 Found in file intrpvar.h
735 This is the C<true> SV. See C<PL_sv_no>. Always refer to this as
741 Found in file intrpvar.h
752 Return the SV from the GV.
761 Returns the glob with the given C<name> and a defined subroutine or
762 C<NULL>. The glob lives in the given C<stash>, or in the stashes
763 accessible via @ISA and UNIVERSAL::.
765 The argument C<level> should be either 0 or -1. If C<level==0>, as a
766 side-effect creates a glob with the given C<name> in the given C<stash>
767 which in the case of success contains an alias for the subroutine, and sets
768 up caching info for this glob. Similarly for all the searched stashes.
770 This function grants C<"SUPER"> token as a postfix of the stash name. The
771 GV returned from C<gv_fetchmeth> may be a method cache entry, which is not
772 visible to Perl code. So when calling C<call_sv>, you should not use
773 the GV directly; instead, you should use the method's CV, which can be
774 obtained from the GV with the C<GvCV> macro.
776 GV* gv_fetchmeth(HV* stash, const char* name, STRLEN len, I32 level)
783 See L<gv_fetchmethod_autoload>.
785 GV* gv_fetchmethod(HV* stash, const char* name)
790 =item gv_fetchmethod_autoload
792 Returns the glob which contains the subroutine to call to invoke the method
793 on the C<stash>. In fact in the presence of autoloading this may be the
794 glob for "AUTOLOAD". In this case the corresponding variable $AUTOLOAD is
797 The third parameter of C<gv_fetchmethod_autoload> determines whether
798 AUTOLOAD lookup is performed if the given method is not present: non-zero
799 means yes, look for AUTOLOAD; zero means no, don't look for AUTOLOAD.
800 Calling C<gv_fetchmethod> is equivalent to calling C<gv_fetchmethod_autoload>
801 with a non-zero C<autoload> parameter.
803 These functions grant C<"SUPER"> token as a prefix of the method name. Note
804 that if you want to keep the returned glob for a long time, you need to
805 check for it being "AUTOLOAD", since at the later time the call may load a
806 different subroutine due to $AUTOLOAD changing its value. Use the glob
807 created via a side effect to do this.
809 These functions have the same side-effects and as C<gv_fetchmeth> with
810 C<level==0>. C<name> should be writable if contains C<':'> or C<'
811 ''>. The warning against passing the GV returned by C<gv_fetchmeth> to
812 C<call_sv> apply equally to these functions.
814 GV* gv_fetchmethod_autoload(HV* stash, const char* name, I32 autoload)
819 =item gv_fetchmeth_autoload
821 Same as gv_fetchmeth(), but looks for autoloaded subroutines too.
822 Returns a glob for the subroutine.
824 For an autoloaded subroutine without a GV, will create a GV even
825 if C<level < 0>. For an autoloaded subroutine without a stub, GvCV()
826 of the result may be zero.
828 GV* gv_fetchmeth_autoload(HV* stash, const char* name, STRLEN len, I32 level)
835 Returns a pointer to the stash for a specified package. C<name> should
836 be a valid UTF-8 string. If C<create> is set then the package will be
837 created if it does not already exist. If C<create> is not set and the
838 package does not exist then NULL is returned.
840 HV* gv_stashpv(const char* name, I32 create)
847 Returns a pointer to the stash for a specified package, which must be a
848 valid UTF-8 string. See C<gv_stashpv>.
850 HV* gv_stashsv(SV* sv, I32 create)
864 This flag, used in the length slot of hash entries and magic structures,
865 specifies the structure contains an C<SV*> pointer where a C<char*> pointer
866 is to be expected. (For information only--not to be used).
874 Null character pointer.
876 Found in file handy.h
883 Found in file handy.h
888 =head1 Hash Manipulation Functions
894 Returns the HV of the specified Perl hash. If C<create> is set and the
895 Perl variable does not exist then it will be created. If C<create> is not
896 set and the variable does not exist then NULL is returned.
898 NOTE: the perl_ form of this function is deprecated.
900 HV* get_hv(const char* name, I32 create)
907 Returns the computed hash stored in the hash entry.
916 Returns the actual pointer stored in the key slot of the hash entry. The
917 pointer may be either C<char*> or C<SV*>, depending on the value of
918 C<HeKLEN()>. Can be assigned to. The C<HePV()> or C<HeSVKEY()> macros are
919 usually preferable for finding the value of a key.
928 If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry
929 holds an C<SV*> key. Otherwise, holds the actual length of the key. Can
930 be assigned to. The C<HePV()> macro is usually preferable for finding key
933 STRLEN HeKLEN(HE* he)
940 Returns the key slot of the hash entry as a C<char*> value, doing any
941 necessary dereferencing of possibly C<SV*> keys. The length of the string
942 is placed in C<len> (this is a macro, so do I<not> use C<&len>). If you do
943 not care about what the length of the key is, you may use the global
944 variable C<PL_na>, though this is rather less efficient than using a local
945 variable. Remember though, that hash keys in perl are free to contain
946 embedded nulls, so using C<strlen()> or similar is not a good way to find
947 the length of hash keys. This is very similar to the C<SvPV()> macro
948 described elsewhere in this document.
950 char* HePV(HE* he, STRLEN len)
957 Returns the key as an C<SV*>, or C<Nullsv> if the hash entry does not
958 contain an C<SV*> key.
967 Returns the key as an C<SV*>. Will create and return a temporary mortal
968 C<SV*> if the hash entry contains only a C<char*> key.
970 SV* HeSVKEY_force(HE* he)
977 Sets the key to a given C<SV*>, taking care to set the appropriate flags to
978 indicate the presence of an C<SV*> key, and returns the same
981 SV* HeSVKEY_set(HE* he, SV* sv)
988 Returns the value slot (type C<SV*>) stored in the hash entry.
997 Returns the package name of a stash. See C<SvSTASH>, C<CvSTASH>.
999 char* HvNAME(HV* stash)
1006 Clears a hash, making it empty.
1008 void hv_clear(HV* tb)
1015 Deletes a key/value pair in the hash. The value SV is removed from the
1016 hash and returned to the caller. The C<klen> is the length of the key.
1017 The C<flags> value will normally be zero; if set to G_DISCARD then NULL
1020 SV* hv_delete(HV* tb, const char* key, I32 klen, I32 flags)
1027 Deletes a key/value pair in the hash. The value SV is removed from the
1028 hash and returned to the caller. The C<flags> value will normally be zero;
1029 if set to G_DISCARD then NULL will be returned. C<hash> can be a valid
1030 precomputed hash value, or 0 to ask for it to be computed.
1032 SV* hv_delete_ent(HV* tb, SV* key, I32 flags, U32 hash)
1039 Returns a boolean indicating whether the specified hash key exists. The
1040 C<klen> is the length of the key.
1042 bool hv_exists(HV* tb, const char* key, I32 klen)
1049 Returns a boolean indicating whether the specified hash key exists. C<hash>
1050 can be a valid precomputed hash value, or 0 to ask for it to be
1053 bool hv_exists_ent(HV* tb, SV* key, U32 hash)
1060 Returns the SV which corresponds to the specified key in the hash. The
1061 C<klen> is the length of the key. If C<lval> is set then the fetch will be
1062 part of a store. Check that the return value is non-null before
1063 dereferencing it to an C<SV*>.
1065 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1066 information on how to use this function on tied hashes.
1068 SV** hv_fetch(HV* tb, const char* key, I32 klen, I32 lval)
1075 Returns the hash entry which corresponds to the specified key in the hash.
1076 C<hash> must be a valid precomputed hash number for the given C<key>, or 0
1077 if you want the function to compute it. IF C<lval> is set then the fetch
1078 will be part of a store. Make sure the return value is non-null before
1079 accessing it. The return value when C<tb> is a tied hash is a pointer to a
1080 static location, so be sure to make a copy of the structure if you need to
1083 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1084 information on how to use this function on tied hashes.
1086 HE* hv_fetch_ent(HV* tb, SV* key, I32 lval, U32 hash)
1093 Prepares a starting point to traverse a hash table. Returns the number of
1094 keys in the hash (i.e. the same as C<HvKEYS(tb)>). The return value is
1095 currently only meaningful for hashes without tie magic.
1097 NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
1098 hash buckets that happen to be in use. If you still need that esoteric
1099 value, you can get it through the macro C<HvFILL(tb)>.
1101 I32 hv_iterinit(HV* tb)
1108 Returns the key from the current position of the hash iterator. See
1111 char* hv_iterkey(HE* entry, I32* retlen)
1118 Returns the key as an C<SV*> from the current position of the hash
1119 iterator. The return value will always be a mortal copy of the key. Also
1122 SV* hv_iterkeysv(HE* entry)
1129 Returns entries from a hash iterator. See C<hv_iterinit>.
1131 HE* hv_iternext(HV* tb)
1138 Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
1141 SV* hv_iternextsv(HV* hv, char** key, I32* retlen)
1148 Returns the value from the current position of the hash iterator. See
1151 SV* hv_iterval(HV* tb, HE* entry)
1158 Adds magic to a hash. See C<sv_magic>.
1160 void hv_magic(HV* hv, GV* gv, int how)
1167 Stores an SV in a hash. The hash key is specified as C<key> and C<klen> is
1168 the length of the key. The C<hash> parameter is the precomputed hash
1169 value; if it is zero then Perl will compute it. The return value will be
1170 NULL if the operation failed or if the value did not need to be actually
1171 stored within the hash (as in the case of tied hashes). Otherwise it can
1172 be dereferenced to get the original C<SV*>. Note that the caller is
1173 responsible for suitably incrementing the reference count of C<val> before
1174 the call, and decrementing it if the function returned NULL.
1176 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1177 information on how to use this function on tied hashes.
1179 SV** hv_store(HV* tb, const char* key, I32 klen, SV* val, U32 hash)
1186 Stores C<val> in a hash. The hash key is specified as C<key>. The C<hash>
1187 parameter is the precomputed hash value; if it is zero then Perl will
1188 compute it. The return value is the new hash entry so created. It will be
1189 NULL if the operation failed or if the value did not need to be actually
1190 stored within the hash (as in the case of tied hashes). Otherwise the
1191 contents of the return value can be accessed using the C<He?> macros
1192 described here. Note that the caller is responsible for suitably
1193 incrementing the reference count of C<val> before the call, and
1194 decrementing it if the function returned NULL.
1196 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1197 information on how to use this function on tied hashes.
1199 HE* hv_store_ent(HV* tb, SV* key, SV* val, U32 hash)
1208 void hv_undef(HV* tb)
1215 Creates a new HV. The reference count is set to 1.
1233 =head1 Magical Functions
1239 Clear something magical that the SV represents. See C<sv_magic>.
1241 int mg_clear(SV* sv)
1248 Copies the magic from one SV to another. See C<sv_magic>.
1250 int mg_copy(SV* sv, SV* nsv, const char* key, I32 klen)
1257 Finds the magic pointer for type matching the SV. See C<sv_magic>.
1259 MAGIC* mg_find(SV* sv, int type)
1266 Free any magic storage used by the SV. See C<sv_magic>.
1275 Do magic after a value is retrieved from the SV. See C<sv_magic>.
1284 Report on the SV's length. See C<sv_magic>.
1286 U32 mg_length(SV* sv)
1293 Turns on the magical status of an SV. See C<sv_magic>.
1295 void mg_magical(SV* sv)
1302 Do magic after a value is assigned to the SV. See C<sv_magic>.
1311 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
1312 argument more than once.
1314 void SvGETMAGIC(SV* sv)
1321 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
1331 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
1332 argument more than once.
1334 void SvSETMAGIC(SV* sv)
1341 Like C<SvSetSV>, but does any set magic required afterwards.
1343 void SvSetMagicSV(SV* dsb, SV* ssv)
1348 =item SvSetMagicSV_nosteal
1350 Like C<SvSetMagicSV>, but does any set magic required afterwards.
1352 void SvSetMagicSV_nosteal(SV* dsv, SV* ssv)
1359 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
1362 void SvSetSV(SV* dsb, SV* ssv)
1367 =item SvSetSV_nosteal
1369 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
1370 ssv. May evaluate arguments more than once.
1372 void SvSetSV_nosteal(SV* dsv, SV* ssv)
1379 Arranges for sv to be shared between threads if a suitable module
1382 void SvSHARE(SV* sv)
1390 =head1 Memory Management
1396 The XSUB-writer's interface to the C C<memcpy> function. The C<src> is the
1397 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1398 the type. May fail on overlapping copies. See also C<Move>.
1400 void Copy(void* src, void* dest, int nitems, type)
1403 Found in file handy.h
1407 The XSUB-writer's interface to the C C<memmove> function. The C<src> is the
1408 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1409 the type. Can do overlapping moves. See also C<Copy>.
1411 void Move(void* src, void* dest, int nitems, type)
1414 Found in file handy.h
1418 The XSUB-writer's interface to the C C<malloc> function.
1420 void New(int id, void* ptr, int nitems, type)
1423 Found in file handy.h
1427 The XSUB-writer's interface to the C C<malloc> function, with
1430 void Newc(int id, void* ptr, int nitems, type, cast)
1433 Found in file handy.h
1437 Creates a new SV. A non-zero C<len> parameter indicates the number of
1438 bytes of preallocated string space the SV should have. An extra byte for a
1439 tailing NUL is also reserved. (SvPOK is not set for the SV even if string
1440 space is allocated.) The reference count for the new SV is set to 1.
1441 C<id> is an integer id between 0 and 1299 (used to identify leaks).
1444 SV* NEWSV(int id, STRLEN len)
1447 Found in file handy.h
1451 The XSUB-writer's interface to the C C<malloc> function. The allocated
1452 memory is zeroed with C<memzero>.
1454 void Newz(int id, void* ptr, int nitems, type)
1457 Found in file handy.h
1461 The XSUB-writer's interface to the C C<realloc> function.
1463 void Renew(void* ptr, int nitems, type)
1466 Found in file handy.h
1470 The XSUB-writer's interface to the C C<realloc> function, with
1473 void Renewc(void* ptr, int nitems, type, cast)
1476 Found in file handy.h
1480 The XSUB-writer's interface to the C C<free> function.
1482 void Safefree(void* ptr)
1485 Found in file handy.h
1489 Copy a string to a safe spot. This does not use an SV.
1491 char* savepv(const char* sv)
1494 Found in file util.c
1498 Copy a string to a safe spot. The C<len> indicates number of bytes to
1499 copy. If pointer is NULL allocate space for a string of size specified.
1500 This does not use an SV.
1502 char* savepvn(const char* sv, I32 len)
1505 Found in file util.c
1509 Copy a string to a safe spot in memory shared between threads.
1510 This does not use an SV.
1512 char* savesharedpv(const char* sv)
1515 Found in file util.c
1519 This is an architecture-independent macro to copy one structure to another.
1521 void StructCopy(type src, type dest, type)
1524 Found in file handy.h
1528 The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the
1529 destination, C<nitems> is the number of items, and C<type> is the type.
1531 void Zero(void* dest, int nitems, type)
1534 Found in file handy.h
1539 =head1 Miscellaneous Functions
1545 Analyses the string in order to make fast searches on it using fbm_instr()
1546 -- the Boyer-Moore algorithm.
1548 void fbm_compile(SV* sv, U32 flags)
1551 Found in file util.c
1555 Returns the location of the SV in the string delimited by C<str> and
1556 C<strend>. It returns C<Nullch> if the string can't be found. The C<sv>
1557 does not have to be fbm_compiled, but the search will not be as fast
1560 char* fbm_instr(unsigned char* big, unsigned char* bigend, SV* littlesv, U32 flags)
1563 Found in file util.c
1567 Takes a sprintf-style format pattern and conventional
1568 (non-SV) arguments and returns the formatted string.
1570 (char *) Perl_form(pTHX_ const char* pat, ...)
1572 can be used any place a string (char *) is required:
1574 char * s = Perl_form("%d.%d",major,minor);
1576 Uses a single private buffer so if you want to format several strings you
1577 must explicitly copy the earlier strings away (and free the copies when you
1580 char* form(const char* pat, ...)
1583 Found in file util.c
1587 Fill the sv with current working directory
1589 int getcwd_sv(SV* sv)
1592 Found in file util.c
1596 Test two strings to see if they are equal. Returns true or false.
1598 bool strEQ(char* s1, char* s2)
1601 Found in file handy.h
1605 Test two strings to see if the first, C<s1>, is greater than or equal to
1606 the second, C<s2>. Returns true or false.
1608 bool strGE(char* s1, char* s2)
1611 Found in file handy.h
1615 Test two strings to see if the first, C<s1>, is greater than the second,
1616 C<s2>. Returns true or false.
1618 bool strGT(char* s1, char* s2)
1621 Found in file handy.h
1625 Test two strings to see if the first, C<s1>, is less than or equal to the
1626 second, C<s2>. Returns true or false.
1628 bool strLE(char* s1, char* s2)
1631 Found in file handy.h
1635 Test two strings to see if the first, C<s1>, is less than the second,
1636 C<s2>. Returns true or false.
1638 bool strLT(char* s1, char* s2)
1641 Found in file handy.h
1645 Test two strings to see if they are different. Returns true or
1648 bool strNE(char* s1, char* s2)
1651 Found in file handy.h
1655 Test two strings to see if they are equal. The C<len> parameter indicates
1656 the number of bytes to compare. Returns true or false. (A wrapper for
1659 bool strnEQ(char* s1, char* s2, STRLEN len)
1662 Found in file handy.h
1666 Test two strings to see if they are different. The C<len> parameter
1667 indicates the number of bytes to compare. Returns true or false. (A
1668 wrapper for C<strncmp>).
1670 bool strnNE(char* s1, char* s2, STRLEN len)
1673 Found in file handy.h
1678 =head1 Numeric functions
1684 converts a string representing a binary number to numeric form.
1686 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
1687 conversion flags, and I<result> should be NULL or a pointer to an NV.
1688 The scan stops at the end of the string, or the first invalid character.
1689 On return I<*len> is set to the length scanned string, and I<*flags> gives
1692 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
1693 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_bin>
1694 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
1695 and writes the value to I<*result> (or the value is discarded if I<result>
1698 The hex number may optionally be prefixed with "0b" or "b" unless
1699 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
1700 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the binary
1701 number may use '_' characters to separate digits.
1703 UV grok_bin(char* start, STRLEN* len, I32* flags, NV *result)
1706 Found in file numeric.c
1710 converts a string representing a hex number to numeric form.
1712 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
1713 conversion flags, and I<result> should be NULL or a pointer to an NV.
1714 The scan stops at the end of the string, or the first non-hex-digit character.
1715 On return I<*len> is set to the length scanned string, and I<*flags> gives
1718 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
1719 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_hex>
1720 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
1721 and writes the value to I<*result> (or the value is discarded if I<result>
1724 The hex number may optionally be prefixed with "0x" or "x" unless
1725 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
1726 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the hex
1727 number may use '_' characters to separate digits.
1729 UV grok_hex(char* start, STRLEN* len, I32* flags, NV *result)
1732 Found in file numeric.c
1736 Recognise (or not) a number. The type of the number is returned
1737 (0 if unrecognised), otherwise it is a bit-ORed combination of
1738 IS_NUMBER_IN_UV, IS_NUMBER_GREATER_THAN_UV_MAX, IS_NUMBER_NOT_INT,
1739 IS_NUMBER_NEG, IS_NUMBER_INFINITY, IS_NUMBER_NAN (defined in perl.h).
1741 If the value of the number can fit an in UV, it is returned in the *valuep
1742 IS_NUMBER_IN_UV will be set to indicate that *valuep is valid, IS_NUMBER_IN_UV
1743 will never be set unless *valuep is valid, but *valuep may have been assigned
1744 to during processing even though IS_NUMBER_IN_UV is not set on return.
1745 If valuep is NULL, IS_NUMBER_IN_UV will be set for the same cases as when
1746 valuep is non-NULL, but no actual assignment (or SEGV) will occur.
1748 IS_NUMBER_NOT_INT will be set with IS_NUMBER_IN_UV if trailing decimals were
1749 seen (in which case *valuep gives the true value truncated to an integer), and
1750 IS_NUMBER_NEG if the number is negative (in which case *valuep holds the
1751 absolute value). IS_NUMBER_IN_UV is not set if e notation was used or the
1752 number is larger than a UV.
1754 int grok_number(const char *pv, STRLEN len, UV *valuep)
1757 Found in file numeric.c
1759 =item grok_numeric_radix
1761 Scan and skip for a numeric decimal separator (radix).
1763 bool grok_numeric_radix(const char **sp, const char *send)
1766 Found in file numeric.c
1771 UV grok_oct(char* start, STRLEN* len, I32* flags, NV *result)
1774 Found in file numeric.c
1778 For backwards compatibility. Use C<grok_bin> instead.
1780 NV scan_bin(char* start, STRLEN len, STRLEN* retlen)
1783 Found in file numeric.c
1787 For backwards compatibility. Use C<grok_hex> instead.
1789 NV scan_hex(char* start, STRLEN len, STRLEN* retlen)
1792 Found in file numeric.c
1796 For backwards compatibility. Use C<grok_oct> instead.
1798 NV scan_oct(char* start, STRLEN len, STRLEN* retlen)
1801 Found in file numeric.c
1806 =head1 Optree Manipulation Functions
1812 If C<cv> is a constant sub eligible for inlining. returns the constant
1813 value returned by the sub. Otherwise, returns NULL.
1815 Constant subs can be created with C<newCONSTSUB> or as described in
1816 L<perlsub/"Constant Functions">.
1818 SV* cv_const_sv(CV* cv)
1825 Creates a constant sub equivalent to Perl C<sub FOO () { 123 }> which is
1826 eligible for inlining at compile-time.
1828 CV* newCONSTSUB(HV* stash, char* name, SV* sv)
1835 Used by C<xsubpp> to hook up XSUBs as Perl subs.
1843 =head1 Stack Manipulation Macros
1849 Declare a stack marker variable, C<mark>, for the XSUB. See C<MARK> and
1859 Saves the original stack mark for the XSUB. See C<ORIGMARK>.
1868 Declares a local copy of perl's stack pointer for the XSUB, available via
1869 the C<SP> macro. See C<SP>.
1878 Used to extend the argument stack for an XSUB's return values. Once
1879 used, guarantees that there is room for at least C<nitems> to be pushed
1882 void EXTEND(SP, int nitems)
1889 Stack marker variable for the XSUB. See C<dMARK>.
1896 The original stack mark for the XSUB. See C<dORIGMARK>.
1903 Pops an integer off the stack.
1912 Pops a long off the stack.
1921 Pops a double off the stack.
1930 Pops a string off the stack. Deprecated. New code should provide
1931 a STRLEN n_a and use POPpx.
1940 Pops a string off the stack which must consist of bytes i.e. characters < 256.
1941 Requires a variable STRLEN n_a in scope.
1950 Pops a string off the stack.
1951 Requires a variable STRLEN n_a in scope.
1960 Pops an SV off the stack.
1969 Push an integer onto the stack. The stack must have room for this element.
1970 Handles 'set' magic. See C<XPUSHi>.
1979 Opening bracket for arguments on a callback. See C<PUTBACK> and
1989 Push a double onto the stack. The stack must have room for this element.
1990 Handles 'set' magic. See C<XPUSHn>.
1999 Push a string onto the stack. The stack must have room for this element.
2000 The C<len> indicates the length of the string. Handles 'set' magic. See
2003 void PUSHp(char* str, STRLEN len)
2010 Push an SV onto the stack. The stack must have room for this element.
2011 Does not handle 'set' magic. See C<XPUSHs>.
2020 Push an unsigned integer onto the stack. The stack must have room for this
2021 element. See C<XPUSHu>.
2030 Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
2031 See C<PUSHMARK> and L<perlcall> for other uses.
2040 Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and
2048 Refetch the stack pointer. Used after a callback. See L<perlcall>.
2057 Push an integer onto the stack, extending the stack if necessary. Handles
2058 'set' magic. See C<PUSHi>.
2067 Push a double onto the stack, extending the stack if necessary. Handles
2068 'set' magic. See C<PUSHn>.
2077 Push a string onto the stack, extending the stack if necessary. The C<len>
2078 indicates the length of the string. Handles 'set' magic. See
2081 void XPUSHp(char* str, STRLEN len)
2088 Push an SV onto the stack, extending the stack if necessary. Does not
2089 handle 'set' magic. See C<PUSHs>.
2098 Push an unsigned integer onto the stack, extending the stack if necessary.
2108 Return from XSUB, indicating number of items on the stack. This is usually
2109 handled by C<xsubpp>.
2111 void XSRETURN(int nitems)
2114 Found in file XSUB.h
2118 Return an integer from an XSUB immediately. Uses C<XST_mIV>.
2120 void XSRETURN_IV(IV iv)
2123 Found in file XSUB.h
2127 Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
2132 Found in file XSUB.h
2136 Return a double from an XSUB immediately. Uses C<XST_mNV>.
2138 void XSRETURN_NV(NV nv)
2141 Found in file XSUB.h
2145 Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
2147 void XSRETURN_PV(char* str)
2150 Found in file XSUB.h
2152 =item XSRETURN_UNDEF
2154 Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
2159 Found in file XSUB.h
2163 Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
2168 Found in file XSUB.h
2172 Place an integer into the specified position C<pos> on the stack. The
2173 value is stored in a new mortal SV.
2175 void XST_mIV(int pos, IV iv)
2178 Found in file XSUB.h
2182 Place C<&PL_sv_no> into the specified position C<pos> on the
2185 void XST_mNO(int pos)
2188 Found in file XSUB.h
2192 Place a double into the specified position C<pos> on the stack. The value
2193 is stored in a new mortal SV.
2195 void XST_mNV(int pos, NV nv)
2198 Found in file XSUB.h
2202 Place a copy of a string into the specified position C<pos> on the stack.
2203 The value is stored in a new mortal SV.
2205 void XST_mPV(int pos, char* str)
2208 Found in file XSUB.h
2212 Place C<&PL_sv_undef> into the specified position C<pos> on the
2215 void XST_mUNDEF(int pos)
2218 Found in file XSUB.h
2222 Place C<&PL_sv_yes> into the specified position C<pos> on the
2225 void XST_mYES(int pos)
2228 Found in file XSUB.h
2239 An enum of flags for Perl types. These are found in the file B<sv.h>
2240 in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
2247 Integer type flag for scalars. See C<svtype>.
2254 Double type flag for scalars. See C<svtype>.
2261 Pointer type flag for scalars. See C<svtype>.
2268 Type flag for arrays. See C<svtype>.
2275 Type flag for code refs. See C<svtype>.
2282 Type flag for hashes. See C<svtype>.
2289 Type flag for blessed scalars. See C<svtype>.
2297 =head1 SV Manipulation Functions
2303 Returns the SV of the specified Perl scalar. If C<create> is set and the
2304 Perl variable does not exist then it will be created. If C<create> is not
2305 set and the variable does not exist then NULL is returned.
2307 NOTE: the perl_ form of this function is deprecated.
2309 SV* get_sv(const char* name, I32 create)
2312 Found in file perl.c
2314 =item looks_like_number
2316 Test if the content of an SV looks like a number (or is a number).
2317 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
2318 non-numeric warning), even if your atof() doesn't grok them.
2320 I32 looks_like_number(SV* sv)
2327 Creates an RV wrapper for an SV. The reference count for the original SV is
2330 SV* newRV_inc(SV* sv)
2337 Creates an RV wrapper for an SV. The reference count for the original
2338 SV is B<not> incremented.
2340 SV* newRV_noinc(SV *sv)
2347 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
2348 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
2351 SV* newSV(STRLEN len)
2358 Creates a new SV and copies an integer into it. The reference count for the
2368 Creates a new SV and copies a floating point value into it.
2369 The reference count for the SV is set to 1.
2378 Creates a new SV and copies a string into it. The reference count for the
2379 SV is set to 1. If C<len> is zero, Perl will compute the length using
2380 strlen(). For efficiency, consider using C<newSVpvn> instead.
2382 SV* newSVpv(const char* s, STRLEN len)
2389 Creates a new SV and initializes it with the string formatted like
2392 SV* newSVpvf(const char* pat, ...)
2399 Creates a new SV and copies a string into it. The reference count for the
2400 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
2401 string. You are responsible for ensuring that the source string is at least
2404 SV* newSVpvn(const char* s, STRLEN len)
2409 =item newSVpvn_share
2411 Creates a new SV with its SvPVX pointing to a shared string in the string
2412 table. If the string does not already exist in the table, it is created
2413 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
2414 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
2415 otherwise the hash is computed. The idea here is that as the string table
2416 is used for shared hash keys these strings will have SvPVX == HeKEY and
2417 hash lookup will avoid string compare.
2419 SV* newSVpvn_share(const char* s, I32 len, U32 hash)
2426 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
2427 it will be upgraded to one. If C<classname> is non-null then the new SV will
2428 be blessed in the specified package. The new SV is returned and its
2429 reference count is 1.
2431 SV* newSVrv(SV* rv, const char* classname)
2438 Creates a new SV which is an exact duplicate of the original SV.
2441 SV* newSVsv(SV* old)
2448 Creates a new SV and copies an unsigned integer into it.
2449 The reference count for the SV is set to 1.
2458 Returns a pointer to the next character after the parsed
2459 vstring, as well as updating the passed in sv.
2461 Function must be called like
2464 s = new_vstring(s,sv);
2466 The sv must already be large enough to store the vstring
2469 char* new_vstring(char *vstr, SV *sv)
2472 Found in file util.c
2476 Returns the length of the string which is in the SV. See C<SvLEN>.
2478 STRLEN SvCUR(SV* sv)
2485 Set the length of the string which is in the SV. See C<SvCUR>.
2487 void SvCUR_set(SV* sv, STRLEN len)
2494 Returns a pointer to the last character in the string which is in the SV.
2495 See C<SvCUR>. Access the character as *(SvEND(sv)).
2504 Expands the character buffer in the SV so that it has room for the
2505 indicated number of bytes (remember to reserve space for an extra trailing
2506 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
2507 Returns a pointer to the character buffer.
2509 char * SvGROW(SV* sv, STRLEN len)
2516 Returns a boolean indicating whether the SV contains an integer.
2525 Returns a boolean indicating whether the SV contains an integer. Checks
2526 the B<private> setting. Use C<SvIOK>.
2535 Returns a boolean indicating whether the SV contains a signed integer.
2537 void SvIOK_notUV(SV* sv)
2544 Unsets the IV status of an SV.
2546 void SvIOK_off(SV* sv)
2553 Tells an SV that it is an integer.
2555 void SvIOK_on(SV* sv)
2562 Tells an SV that it is an integer and disables all other OK bits.
2564 void SvIOK_only(SV* sv)
2571 Tells and SV that it is an unsigned integer and disables all other OK bits.
2573 void SvIOK_only_UV(SV* sv)
2580 Returns a boolean indicating whether the SV contains an unsigned integer.
2582 void SvIOK_UV(SV* sv)
2589 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
2590 version which guarantees to evaluate sv only once.
2599 Coerces the given SV to an integer and returns it. Guarantees to evaluate
2600 sv only once. Use the more efficient C<SvIV> otherwise.
2609 Returns the raw value in the SV's IV slot, without checks or conversions.
2610 Only use when you are sure SvIOK is true. See also C<SvIV()>.
2619 Returns the size of the string buffer in the SV, not including any part
2620 attributable to C<SvOOK>. See C<SvCUR>.
2622 STRLEN SvLEN(SV* sv)
2629 Returns a boolean indicating whether the SV contains a number, integer or
2639 Returns a boolean indicating whether the SV contains a number, integer or
2640 double. Checks the B<private> setting. Use C<SvNIOK>.
2642 bool SvNIOKp(SV* sv)
2649 Unsets the NV/IV status of an SV.
2651 void SvNIOK_off(SV* sv)
2658 Returns a boolean indicating whether the SV contains a double.
2667 Returns a boolean indicating whether the SV contains a double. Checks the
2668 B<private> setting. Use C<SvNOK>.
2677 Unsets the NV status of an SV.
2679 void SvNOK_off(SV* sv)
2686 Tells an SV that it is a double.
2688 void SvNOK_on(SV* sv)
2695 Tells an SV that it is a double and disables all other OK bits.
2697 void SvNOK_only(SV* sv)
2704 Coerce the given SV to a double and return it. See C<SvNVx> for a version
2705 which guarantees to evaluate sv only once.
2714 Returns the raw value in the SV's NV slot, without checks or conversions.
2715 Only use when you are sure SvNOK is true. See also C<SvNV()>.
2724 Coerces the given SV to a double and returns it. Guarantees to evaluate
2725 sv only once. Use the more efficient C<SvNV> otherwise.
2734 Returns a boolean indicating whether the value is an SV.
2743 Returns a boolean indicating whether the SvIVX is a valid offset value for
2744 the SvPVX. This hack is used internally to speed up removal of characters
2745 from the beginning of a SvPV. When SvOOK is true, then the start of the
2746 allocated string buffer is really (SvPVX - SvIVX).
2755 Returns a boolean indicating whether the SV contains a character
2765 Returns a boolean indicating whether the SV contains a character string.
2766 Checks the B<private> setting. Use C<SvPOK>.
2775 Unsets the PV status of an SV.
2777 void SvPOK_off(SV* sv)
2784 Tells an SV that it is a string.
2786 void SvPOK_on(SV* sv)
2793 Tells an SV that it is a string and disables all other OK bits.
2794 Will also turn off the UTF8 status.
2796 void SvPOK_only(SV* sv)
2801 =item SvPOK_only_UTF8
2803 Tells an SV that it is a string and disables all other OK bits,
2804 and leaves the UTF8 status as it was.
2806 void SvPOK_only_UTF8(SV* sv)
2813 Returns a pointer to the string in the SV, or a stringified form of
2814 the SV if the SV does not contain a string. The SV may cache the
2815 stringified version becoming C<SvPOK>. Handles 'get' magic. See also
2816 C<SvPVx> for a version which guarantees to evaluate sv only once.
2818 char* SvPV(SV* sv, STRLEN len)
2825 Like C<SvPV>, but converts sv to byte representation first if necessary.
2827 char* SvPVbyte(SV* sv, STRLEN len)
2834 Like C<SvPV>, but converts sv to byte representation first if necessary.
2835 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
2839 char* SvPVbytex(SV* sv, STRLEN len)
2844 =item SvPVbytex_force
2846 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
2847 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
2850 char* SvPVbytex_force(SV* sv, STRLEN len)
2855 =item SvPVbyte_force
2857 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
2859 char* SvPVbyte_force(SV* sv, STRLEN len)
2864 =item SvPVbyte_nolen
2866 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
2868 char* SvPVbyte_nolen(SV* sv)
2875 Like C<SvPV>, but converts sv to utf8 first if necessary.
2877 char* SvPVutf8(SV* sv, STRLEN len)
2884 Like C<SvPV>, but converts sv to utf8 first if necessary.
2885 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
2888 char* SvPVutf8x(SV* sv, STRLEN len)
2893 =item SvPVutf8x_force
2895 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
2896 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
2899 char* SvPVutf8x_force(SV* sv, STRLEN len)
2904 =item SvPVutf8_force
2906 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
2908 char* SvPVutf8_force(SV* sv, STRLEN len)
2913 =item SvPVutf8_nolen
2915 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
2917 char* SvPVutf8_nolen(SV* sv)
2924 A version of C<SvPV> which guarantees to evaluate sv only once.
2926 char* SvPVx(SV* sv, STRLEN len)
2933 Returns a pointer to the physical string in the SV. The SV must contain a
2943 Like C<SvPV> but will force the SV into containing just a string
2944 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
2947 char* SvPV_force(SV* sv, STRLEN len)
2952 =item SvPV_force_nomg
2954 Like C<SvPV> but will force the SV into containing just a string
2955 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
2956 directly. Doesn't process magic.
2958 char* SvPV_force_nomg(SV* sv, STRLEN len)
2965 Returns a pointer to the string in the SV, or a stringified form of
2966 the SV if the SV does not contain a string. The SV may cache the
2967 stringified form becoming C<SvPOK>. Handles 'get' magic.
2969 char* SvPV_nolen(SV* sv)
2976 Returns the value of the object's reference count.
2978 U32 SvREFCNT(SV* sv)
2985 Decrements the reference count of the given SV.
2987 void SvREFCNT_dec(SV* sv)
2994 Increments the reference count of the given SV.
2996 SV* SvREFCNT_inc(SV* sv)
3003 Tests if the SV is an RV.
3012 Unsets the RV status of an SV.
3014 void SvROK_off(SV* sv)
3021 Tells an SV that it is an RV.
3023 void SvROK_on(SV* sv)
3030 Dereferences an RV to return the SV.
3039 Returns the stash of the SV.
3048 Taints an SV if tainting is enabled
3050 void SvTAINT(SV* sv)
3057 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
3060 bool SvTAINTED(SV* sv)
3067 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
3068 some of Perl's fundamental security features. XS module authors should not
3069 use this function unless they fully understand all the implications of
3070 unconditionally untainting the value. Untainting should be done in the
3071 standard perl fashion, via a carefully crafted regexp, rather than directly
3072 untainting variables.
3074 void SvTAINTED_off(SV* sv)
3081 Marks an SV as tainted.
3083 void SvTAINTED_on(SV* sv)
3090 Returns a boolean indicating whether Perl would evaluate the SV as true or
3091 false, defined or undefined. Does not handle 'get' magic.
3100 Returns the type of the SV. See C<svtype>.
3102 svtype SvTYPE(SV* sv)
3109 Releases a mutual exclusion lock on sv if a suitable module
3113 void SvUNLOCK(SV* sv)
3120 Returns a boolean indicating whether the SV contains an unsigned integer.
3129 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
3130 perform the upgrade if necessary. See C<svtype>.
3132 void SvUPGRADE(SV* sv, svtype type)
3139 Returns a boolean indicating whether the SV contains UTF-8 encoded data.
3148 Unsets the UTF8 status of an SV.
3150 void SvUTF8_off(SV *sv)
3157 Turn on the UTF8 status of an SV (the data is not changed, just the flag).
3158 Do not use frivolously.
3160 void SvUTF8_on(SV *sv)
3167 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
3168 for a version which guarantees to evaluate sv only once.
3177 Returns the raw value in the SV's UV slot, without checks or conversions.
3178 Only use when you are sure SvIOK is true. See also C<SvUV()>.
3187 Coerces the given SV to an unsigned integer and returns it. Guarantees to
3188 evaluate sv only once. Use the more efficient C<SvUV> otherwise.
3197 This function is only called on magical items, and is only used by
3198 sv_true() or its macro equivalent.
3200 bool sv_2bool(SV* sv)
3207 Using various gambits, try to get a CV from an SV; in addition, try if
3208 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
3210 CV* sv_2cv(SV* sv, HV** st, GV** gvp, I32 lref)
3217 Using various gambits, try to get an IO from an SV: the IO slot if its a
3218 GV; or the recursive result if we're an RV; or the IO slot of the symbol
3219 named after the PV if we're a string.
3228 Return the integer value of an SV, doing any necessary string conversion,
3229 magic etc. Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
3238 Marks an existing SV as mortal. The SV will be destroyed "soon", either
3239 by an explicit call to FREETMPS, or by an implicit call at places such as
3240 statement boundaries. See also C<sv_newmortal> and C<sv_mortalcopy>.
3242 SV* sv_2mortal(SV* sv)
3249 Return the num value of an SV, doing any necessary string or integer
3250 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
3260 Return a pointer to the byte-encoded representation of the SV, and set *lp
3261 to its length. May cause the SV to be downgraded from UTF8 as a
3264 Usually accessed via the C<SvPVbyte> macro.
3266 char* sv_2pvbyte(SV* sv, STRLEN* lp)
3271 =item sv_2pvbyte_nolen
3273 Return a pointer to the byte-encoded representation of the SV.
3274 May cause the SV to be downgraded from UTF8 as a side-effect.
3276 Usually accessed via the C<SvPVbyte_nolen> macro.
3278 char* sv_2pvbyte_nolen(SV* sv)
3285 Return a pointer to the UTF8-encoded representation of the SV, and set *lp
3286 to its length. May cause the SV to be upgraded to UTF8 as a side-effect.
3288 Usually accessed via the C<SvPVutf8> macro.
3290 char* sv_2pvutf8(SV* sv, STRLEN* lp)
3295 =item sv_2pvutf8_nolen
3297 Return a pointer to the UTF8-encoded representation of the SV.
3298 May cause the SV to be upgraded to UTF8 as a side-effect.
3300 Usually accessed via the C<SvPVutf8_nolen> macro.
3302 char* sv_2pvutf8_nolen(SV* sv)
3309 Returns a pointer to the string value of an SV, and sets *lp to its length.
3310 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
3312 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
3313 usually end up here too.
3315 char* sv_2pv_flags(SV* sv, STRLEN* lp, I32 flags)
3322 Like C<sv_2pv()>, but doesn't return the length too. You should usually
3323 use the macro wrapper C<SvPV_nolen(sv)> instead.
3324 char* sv_2pv_nolen(SV* sv)
3331 Return the unsigned integer value of an SV, doing any necessary string
3332 conversion, magic etc. Normally used via the C<SvUV(sv)> and C<SvUVx(sv)>
3342 Remove any string offset. You should normally use the C<SvOOK_off> macro
3345 int sv_backoff(SV* sv)
3352 Blesses an SV into a specified package. The SV must be an RV. The package
3353 must be designated by its stash (see C<gv_stashpv()>). The reference count
3354 of the SV is unaffected.
3356 SV* sv_bless(SV* sv, HV* stash)
3363 Concatenates the string onto the end of the string which is in the SV.
3364 If the SV has the UTF8 status set, then the bytes appended should be
3365 valid UTF8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
3367 void sv_catpv(SV* sv, const char* ptr)
3374 Processes its arguments like C<sprintf> and appends the formatted
3375 output to an SV. If the appended data contains "wide" characters
3376 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
3377 and characters >255 formatted with %c), the original SV might get
3378 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic.
3379 C<SvSETMAGIC()> must typically be called after calling this function
3380 to handle 'set' magic.
3382 void sv_catpvf(SV* sv, const char* pat, ...)
3389 Like C<sv_catpvf>, but also handles 'set' magic.
3391 void sv_catpvf_mg(SV *sv, const char* pat, ...)
3398 Concatenates the string onto the end of the string which is in the SV. The
3399 C<len> indicates number of bytes to copy. If the SV has the UTF8
3400 status set, then the bytes appended should be valid UTF8.
3401 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
3403 void sv_catpvn(SV* sv, const char* ptr, STRLEN len)
3408 =item sv_catpvn_flags
3410 Concatenates the string onto the end of the string which is in the SV. The
3411 C<len> indicates number of bytes to copy. If the SV has the UTF8
3412 status set, then the bytes appended should be valid UTF8.
3413 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
3414 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
3415 in terms of this function.
3417 void sv_catpvn_flags(SV* sv, const char* ptr, STRLEN len, I32 flags)
3424 Like C<sv_catpvn>, but also handles 'set' magic.
3426 void sv_catpvn_mg(SV *sv, const char *ptr, STRLEN len)
3433 Like C<sv_catpv>, but also handles 'set' magic.
3435 void sv_catpv_mg(SV *sv, const char *ptr)
3442 Concatenates the string from SV C<ssv> onto the end of the string in
3443 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
3444 not 'set' magic. See C<sv_catsv_mg>.
3446 void sv_catsv(SV* dsv, SV* ssv)
3451 =item sv_catsv_flags
3453 Concatenates the string from SV C<ssv> onto the end of the string in
3454 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
3455 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
3456 and C<sv_catsv_nomg> are implemented in terms of this function.
3458 void sv_catsv_flags(SV* dsv, SV* ssv, I32 flags)
3465 Like C<sv_catsv>, but also handles 'set' magic.
3467 void sv_catsv_mg(SV *dstr, SV *sstr)
3474 Efficient removal of characters from the beginning of the string buffer.
3475 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
3476 the string buffer. The C<ptr> becomes the first character of the adjusted
3477 string. Uses the "OOK hack".
3479 void sv_chop(SV* sv, char* ptr)
3486 Clear an SV: call any destructors, free up any memory used by the body,
3487 and free the body itself. The SV's head is I<not> freed, although
3488 its type is set to all 1's so that it won't inadvertently be assumed
3489 to be live during global destruction etc.
3490 This function should only be called when REFCNT is zero. Most of the time
3491 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
3494 void sv_clear(SV* sv)
3501 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
3502 string in C<sv1> is less than, equal to, or greater than the string in
3503 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
3504 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
3506 I32 sv_cmp(SV* sv1, SV* sv2)
3513 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
3514 'use bytes' aware, handles get magic, and will coerce its args to strings
3515 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
3517 I32 sv_cmp_locale(SV* sv1, SV* sv2)
3524 Add Collate Transform magic to an SV if it doesn't already have it.
3526 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
3527 scalar data of the variable, but transformed to such a format that a normal
3528 memory comparison can be used to compare the data according to the locale
3531 char* sv_collxfrm(SV* sv, STRLEN* nxp)
3538 Copies a stringified representation of the source SV into the
3539 destination SV. Automatically performs any necessary mg_get and
3540 coercion of numeric values into strings. Guaranteed to preserve
3541 UTF-8 flag even from overloaded objects. Similar in nature to
3542 sv_2pv[_flags] but operates directly on an SV instead of just the
3543 string. Mostly uses sv_2pv_flags to do its work, except when that
3544 would lose the UTF-8'ness of the PV.
3546 void sv_copypv(SV* dsv, SV* ssv)
3553 Auto-decrement of the value in the SV, doing string to numeric conversion
3554 if necessary. Handles 'get' magic.
3561 =item sv_derived_from
3563 Returns a boolean indicating whether the SV is derived from the specified
3564 class. This is the function that implements C<UNIVERSAL::isa>. It works
3565 for class names as well as for objects.
3567 bool sv_derived_from(SV* sv, const char* name)
3570 Found in file universal.c
3574 Returns a boolean indicating whether the strings in the two SVs are
3575 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
3576 coerce its args to strings if necessary.
3578 I32 sv_eq(SV* sv1, SV* sv2)
3583 =item sv_force_normal
3585 Undo various types of fakery on an SV: if the PV is a shared string, make
3586 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3587 an xpvmg. See also C<sv_force_normal_flags>.
3589 void sv_force_normal(SV *sv)
3594 =item sv_force_normal_flags
3596 Undo various types of fakery on an SV: if the PV is a shared string, make
3597 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3598 an xpvmg. The C<flags> parameter gets passed to C<sv_unref_flags()>
3599 when unrefing. C<sv_force_normal> calls this function with flags set to 0.
3601 void sv_force_normal_flags(SV *sv, U32 flags)
3608 Decrement an SV's reference count, and if it drops to zero, call
3609 C<sv_clear> to invoke destructors and free up any memory used by
3610 the body; finally, deallocate the SV's head itself.
3611 Normally called via a wrapper macro C<SvREFCNT_dec>.
3613 void sv_free(SV* sv)
3620 Get a line from the filehandle and store it into the SV, optionally
3621 appending to the currently-stored string.
3623 char* sv_gets(SV* sv, PerlIO* fp, I32 append)
3630 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
3631 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
3632 Use the C<SvGROW> wrapper instead.
3634 char* sv_grow(SV* sv, STRLEN newlen)
3641 Auto-increment of the value in the SV, doing string to numeric conversion
3642 if necessary. Handles 'get' magic.
3651 Inserts a string at the specified offset/length within the SV. Similar to
3652 the Perl substr() function.
3654 void sv_insert(SV* bigsv, STRLEN offset, STRLEN len, char* little, STRLEN littlelen)
3661 Returns a boolean indicating whether the SV is blessed into the specified
3662 class. This does not check for subtypes; use C<sv_derived_from> to verify
3663 an inheritance relationship.
3665 int sv_isa(SV* sv, const char* name)
3672 Returns a boolean indicating whether the SV is an RV pointing to a blessed
3673 object. If the SV is not an RV, or if the object is not blessed, then this
3676 int sv_isobject(SV* sv)
3683 A private implementation of the C<SvIVx> macro for compilers which can't
3684 cope with complex macro expressions. Always use the macro instead.
3693 Returns the length of the string in the SV. Handles magic and type
3694 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
3696 STRLEN sv_len(SV* sv)
3703 Returns the number of characters in the string in an SV, counting wide
3704 UTF8 bytes as a single character. Handles magic and type coercion.
3706 STRLEN sv_len_utf8(SV* sv)
3713 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
3714 then adds a new magic item of type C<how> to the head of the magic list.
3716 void sv_magic(SV* sv, SV* obj, int how, const char* name, I32 namlen)
3723 Adds magic to an SV, upgrading it if necessary. Applies the
3724 supplied vtable and returns pointer to the magic added.
3726 Note that sv_magicext will allow things that sv_magic will not.
3727 In particular you can add magic to SvREADONLY SVs and and more than
3728 one instance of the same 'how'
3730 I C<namelen> is greater then zero then a savepvn() I<copy> of C<name> is stored,
3731 if C<namelen> is zero then C<name> is stored as-is and - as another special
3732 case - if C<(name && namelen == HEf_SVKEY)> then C<name> is assumed to contain
3733 an C<SV*> and has its REFCNT incremented
3735 (This is now used as a subroutine by sv_magic.)
3737 MAGIC * sv_magicext(SV* sv, SV* obj, int how, MGVTBL *vtbl, const char* name, I32 namlen )
3744 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
3745 The new SV is marked as mortal. It will be destroyed "soon", either by an
3746 explicit call to FREETMPS, or by an implicit call at places such as
3747 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
3749 SV* sv_mortalcopy(SV* oldsv)
3756 Creates a new null SV which is mortal. The reference count of the SV is
3757 set to 1. It will be destroyed "soon", either by an explicit call to
3758 FREETMPS, or by an implicit call at places such as statement boundaries.
3759 See also C<sv_mortalcopy> and C<sv_2mortal>.
3768 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
3771 SV* sv_newref(SV* sv)
3778 Dummy routine which "locks" an SV when there is no locking module present.
3779 Exists to avoid test for a NULL function pointer and because it could potentially warn under
3780 some level of strict-ness.
3782 void sv_nolocking(SV *)
3785 Found in file util.c
3789 Dummy routine which "shares" an SV when there is no sharing module present.
3790 Exists to avoid test for a NULL function pointer and because it could potentially warn under
3791 some level of strict-ness.
3793 void sv_nosharing(SV *)
3796 Found in file util.c
3798 =item sv_nounlocking
3800 Dummy routine which "unlocks" an SV when there is no locking module present.
3801 Exists to avoid test for a NULL function pointer and because it could potentially warn under
3802 some level of strict-ness.
3804 void sv_nounlocking(SV *)
3807 Found in file util.c
3811 A private implementation of the C<SvNVx> macro for compilers which can't
3812 cope with complex macro expressions. Always use the macro instead.
3821 Converts the value pointed to by offsetp from a count of bytes from the
3822 start of the string, to a count of the equivalent number of UTF8 chars.
3823 Handles magic and type coercion.
3825 void sv_pos_b2u(SV* sv, I32* offsetp)
3832 Converts the value pointed to by offsetp from a count of UTF8 chars from
3833 the start of the string, to a count of the equivalent number of bytes; if
3834 lenp is non-zero, it does the same to lenp, but this time starting from
3835 the offset, rather than from the start of the string. Handles magic and
3838 void sv_pos_u2b(SV* sv, I32* offsetp, I32* lenp)
3845 Use the C<SvPV_nolen> macro instead
3854 Use C<SvPVbyte_nolen> instead.
3856 char* sv_pvbyte(SV *sv)
3863 A private implementation of the C<SvPVbyte> macro for compilers
3864 which can't cope with complex macro expressions. Always use the macro
3867 char* sv_pvbyten(SV *sv, STRLEN *len)
3872 =item sv_pvbyten_force
3874 A private implementation of the C<SvPVbytex_force> macro for compilers
3875 which can't cope with complex macro expressions. Always use the macro
3878 char* sv_pvbyten_force(SV* sv, STRLEN* lp)
3885 A private implementation of the C<SvPV> macro for compilers which can't
3886 cope with complex macro expressions. Always use the macro instead.
3888 char* sv_pvn(SV *sv, STRLEN *len)
3895 Get a sensible string out of the SV somehow.
3896 A private implementation of the C<SvPV_force> macro for compilers which
3897 can't cope with complex macro expressions. Always use the macro instead.
3899 char* sv_pvn_force(SV* sv, STRLEN* lp)
3904 =item sv_pvn_force_flags
3906 Get a sensible string out of the SV somehow.
3907 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
3908 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
3909 implemented in terms of this function.
3910 You normally want to use the various wrapper macros instead: see
3911 C<SvPV_force> and C<SvPV_force_nomg>
3913 char* sv_pvn_force_flags(SV* sv, STRLEN* lp, I32 flags)
3920 Use the C<SvPVutf8_nolen> macro instead
3922 char* sv_pvutf8(SV *sv)
3929 A private implementation of the C<SvPVutf8> macro for compilers
3930 which can't cope with complex macro expressions. Always use the macro
3933 char* sv_pvutf8n(SV *sv, STRLEN *len)
3938 =item sv_pvutf8n_force
3940 A private implementation of the C<SvPVutf8_force> macro for compilers
3941 which can't cope with complex macro expressions. Always use the macro
3944 char* sv_pvutf8n_force(SV* sv, STRLEN* lp)
3951 Returns a string describing what the SV is a reference to.
3953 char* sv_reftype(SV* sv, int ob)
3960 Make the first argument a copy of the second, then delete the original.
3961 The target SV physically takes over ownership of the body of the source SV
3962 and inherits its flags; however, the target keeps any magic it owns,
3963 and any magic in the source is discarded.
3964 Note that this is a rather specialist SV copying operation; most of the
3965 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
3967 void sv_replace(SV* sv, SV* nsv)
3972 =item sv_report_used
3974 Dump the contents of all SVs not yet freed. (Debugging aid).
3976 void sv_report_used()
3983 Underlying implementation for the C<reset> Perl function.
3984 Note that the perl-level function is vaguely deprecated.
3986 void sv_reset(char* s, HV* stash)
3993 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
3994 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
3995 push a back-reference to this RV onto the array of backreferences
3996 associated with that magic.
3998 SV* sv_rvweaken(SV *sv)
4005 Copies an integer into the given SV, upgrading first if necessary.
4006 Does not handle 'set' magic. See also C<sv_setiv_mg>.
4008 void sv_setiv(SV* sv, IV num)
4015 Like C<sv_setiv>, but also handles 'set' magic.
4017 void sv_setiv_mg(SV *sv, IV i)
4024 Copies a double into the given SV, upgrading first if necessary.
4025 Does not handle 'set' magic. See also C<sv_setnv_mg>.
4027 void sv_setnv(SV* sv, NV num)
4034 Like C<sv_setnv>, but also handles 'set' magic.
4036 void sv_setnv_mg(SV *sv, NV num)
4043 Copies a string into an SV. The string must be null-terminated. Does not
4044 handle 'set' magic. See C<sv_setpv_mg>.
4046 void sv_setpv(SV* sv, const char* ptr)
4053 Processes its arguments like C<sprintf> and sets an SV to the formatted
4054 output. Does not handle 'set' magic. See C<sv_setpvf_mg>.
4056 void sv_setpvf(SV* sv, const char* pat, ...)
4063 Like C<sv_setpvf>, but also handles 'set' magic.
4065 void sv_setpvf_mg(SV *sv, const char* pat, ...)
4072 Copies an integer into the given SV, also updating its string value.
4073 Does not handle 'set' magic. See C<sv_setpviv_mg>.
4075 void sv_setpviv(SV* sv, IV num)
4082 Like C<sv_setpviv>, but also handles 'set' magic.
4084 void sv_setpviv_mg(SV *sv, IV iv)
4091 Copies a string into an SV. The C<len> parameter indicates the number of
4092 bytes to be copied. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4094 void sv_setpvn(SV* sv, const char* ptr, STRLEN len)
4101 Like C<sv_setpvn>, but also handles 'set' magic.
4103 void sv_setpvn_mg(SV *sv, const char *ptr, STRLEN len)
4110 Like C<sv_setpv>, but also handles 'set' magic.
4112 void sv_setpv_mg(SV *sv, const char *ptr)
4119 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
4120 argument will be upgraded to an RV. That RV will be modified to point to
4121 the new SV. The C<classname> argument indicates the package for the
4122 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4123 will be returned and will have a reference count of 1.
4125 SV* sv_setref_iv(SV* rv, const char* classname, IV iv)
4132 Copies a double into a new SV, optionally blessing the SV. The C<rv>
4133 argument will be upgraded to an RV. That RV will be modified to point to
4134 the new SV. The C<classname> argument indicates the package for the
4135 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4136 will be returned and will have a reference count of 1.
4138 SV* sv_setref_nv(SV* rv, const char* classname, NV nv)
4145 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
4146 argument will be upgraded to an RV. That RV will be modified to point to
4147 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
4148 into the SV. The C<classname> argument indicates the package for the
4149 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4150 will be returned and will have a reference count of 1.
4152 Do not use with other Perl types such as HV, AV, SV, CV, because those
4153 objects will become corrupted by the pointer copy process.
4155 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
4157 SV* sv_setref_pv(SV* rv, const char* classname, void* pv)
4164 Copies a string into a new SV, optionally blessing the SV. The length of the
4165 string must be specified with C<n>. The C<rv> argument will be upgraded to
4166 an RV. That RV will be modified to point to the new SV. The C<classname>
4167 argument indicates the package for the blessing. Set C<classname> to
4168 C<Nullch> to avoid the blessing. The new SV will be returned and will have
4169 a reference count of 1.
4171 Note that C<sv_setref_pv> copies the pointer while this copies the string.
4173 SV* sv_setref_pvn(SV* rv, const char* classname, char* pv, STRLEN n)
4180 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
4181 argument will be upgraded to an RV. That RV will be modified to point to
4182 the new SV. The C<classname> argument indicates the package for the
4183 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4184 will be returned and will have a reference count of 1.
4186 SV* sv_setref_uv(SV* rv, const char* classname, UV uv)
4193 Copies the contents of the source SV C<ssv> into the destination SV
4194 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4195 function if the source SV needs to be reused. Does not handle 'set' magic.
4196 Loosely speaking, it performs a copy-by-value, obliterating any previous
4197 content of the destination.
4199 You probably want to use one of the assortment of wrappers, such as
4200 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4201 C<SvSetMagicSV_nosteal>.
4204 void sv_setsv(SV* dsv, SV* ssv)
4209 =item sv_setsv_flags
4211 Copies the contents of the source SV C<ssv> into the destination SV
4212 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4213 function if the source SV needs to be reused. Does not handle 'set' magic.
4214 Loosely speaking, it performs a copy-by-value, obliterating any previous
4215 content of the destination.
4216 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
4217 C<ssv> if appropriate, else not. C<sv_setsv> and C<sv_setsv_nomg> are
4218 implemented in terms of this function.
4220 You probably want to use one of the assortment of wrappers, such as
4221 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4222 C<SvSetMagicSV_nosteal>.
4224 This is the primary function for copying scalars, and most other
4225 copy-ish functions and macros use this underneath.
4227 void sv_setsv_flags(SV* dsv, SV* ssv, I32 flags)
4234 Like C<sv_setsv>, but also handles 'set' magic.
4236 void sv_setsv_mg(SV *dstr, SV *sstr)
4243 Copies an unsigned integer into the given SV, upgrading first if necessary.
4244 Does not handle 'set' magic. See also C<sv_setuv_mg>.
4246 void sv_setuv(SV* sv, UV num)
4253 Like C<sv_setuv>, but also handles 'set' magic.
4255 void sv_setuv_mg(SV *sv, UV u)
4262 Taint an SV. Use C<SvTAINTED_on> instead.
4263 void sv_taint(SV* sv)
4270 Test an SV for taintedness. Use C<SvTAINTED> instead.
4271 bool sv_tainted(SV* sv)
4278 Returns true if the SV has a true value by Perl's rules.
4279 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
4280 instead use an in-line version.
4289 Removes all magic of type C<type> from an SV.
4291 int sv_unmagic(SV* sv, int type)
4298 Unsets the RV status of the SV, and decrements the reference count of
4299 whatever was being referenced by the RV. This can almost be thought of
4300 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
4301 being zero. See C<SvROK_off>.
4303 void sv_unref(SV* sv)
4308 =item sv_unref_flags
4310 Unsets the RV status of the SV, and decrements the reference count of
4311 whatever was being referenced by the RV. This can almost be thought of
4312 as a reversal of C<newSVrv>. The C<cflags> argument can contain
4313 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
4314 (otherwise the decrementing is conditional on the reference count being
4315 different from one or the reference being a readonly SV).
4318 void sv_unref_flags(SV* sv, U32 flags)
4325 Untaint an SV. Use C<SvTAINTED_off> instead.
4326 void sv_untaint(SV* sv)
4333 Upgrade an SV to a more complex form. Generally adds a new body type to the
4334 SV, then copies across as much information as possible from the old body.
4335 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
4337 bool sv_upgrade(SV* sv, U32 mt)
4344 Tells an SV to use C<ptr> to find its string value. Normally the string is
4345 stored inside the SV but sv_usepvn allows the SV to use an outside string.
4346 The C<ptr> should point to memory that was allocated by C<malloc>. The
4347 string length, C<len>, must be supplied. This function will realloc the
4348 memory pointed to by C<ptr>, so that pointer should not be freed or used by
4349 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
4350 See C<sv_usepvn_mg>.
4352 void sv_usepvn(SV* sv, char* ptr, STRLEN len)
4359 Like C<sv_usepvn>, but also handles 'set' magic.
4361 void sv_usepvn_mg(SV *sv, char *ptr, STRLEN len)
4366 =item sv_utf8_decode
4368 Convert the octets in the PV from UTF-8 to chars. Scan for validity and then
4369 turn off SvUTF8 if needed so that we see characters. Used as a building block
4370 for decode_utf8 in Encode.xs
4372 NOTE: this function is experimental and may change or be
4373 removed without notice.
4375 bool sv_utf8_decode(SV *sv)
4380 =item sv_utf8_downgrade
4382 Attempt to convert the PV of an SV from UTF8-encoded to byte encoding.
4383 This may not be possible if the PV contains non-byte encoding characters;
4384 if this is the case, either returns false or, if C<fail_ok> is not
4387 This is not as a general purpose Unicode to byte encoding interface:
4388 use the Encode extension for that.
4390 NOTE: this function is experimental and may change or be
4391 removed without notice.
4393 bool sv_utf8_downgrade(SV *sv, bool fail_ok)
4398 =item sv_utf8_encode
4400 Convert the PV of an SV to UTF8-encoded, but then turn off the C<SvUTF8>
4401 flag so that it looks like octets again. Used as a building block
4402 for encode_utf8 in Encode.xs
4404 void sv_utf8_encode(SV *sv)
4409 =item sv_utf8_upgrade
4411 Convert the PV of an SV to its UTF8-encoded form.
4412 Forces the SV to string form if it is not already.
4413 Always sets the SvUTF8 flag to avoid future validity checks even
4414 if all the bytes have hibit clear.
4416 This is not as a general purpose byte encoding to Unicode interface:
4417 use the Encode extension for that.
4419 STRLEN sv_utf8_upgrade(SV *sv)
4424 =item sv_utf8_upgrade_flags
4426 Convert the PV of an SV to its UTF8-encoded form.
4427 Forces the SV to string form if it is not already.
4428 Always sets the SvUTF8 flag to avoid future validity checks even
4429 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
4430 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
4431 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
4433 This is not as a general purpose byte encoding to Unicode interface:
4434 use the Encode extension for that.
4436 STRLEN sv_utf8_upgrade_flags(SV *sv, I32 flags)
4443 A private implementation of the C<SvUVx> macro for compilers which can't
4444 cope with complex macro expressions. Always use the macro instead.
4453 Processes its arguments like C<vsprintf> and appends the formatted output
4454 to an SV. Uses an array of SVs if the C style variable argument list is
4455 missing (NULL). When running with taint checks enabled, indicates via
4456 C<maybe_tainted> if results are untrustworthy (often due to the use of
4459 Usually used via one of its frontends C<sv_catpvf> and C<sv_catpvf_mg>.
4461 void sv_vcatpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
4468 Works like C<vcatpvfn> but copies the text into the SV instead of
4471 Usually used via one of its frontends C<sv_setpvf> and C<sv_setpvf_mg>.
4473 void sv_vsetpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
4481 =head1 Unicode Support
4485 =item bytes_from_utf8
4487 Converts a string C<s> of length C<len> from UTF8 into byte encoding.
4488 Unlike <utf8_to_bytes> but like C<bytes_to_utf8>, returns a pointer to
4489 the newly-created string, and updates C<len> to contain the new
4490 length. Returns the original string if no conversion occurs, C<len>
4491 is unchanged. Do nothing if C<is_utf8> points to 0. Sets C<is_utf8> to
4492 0 if C<s> is converted or contains all 7bit characters.
4494 NOTE: this function is experimental and may change or be
4495 removed without notice.
4497 U8* bytes_from_utf8(U8 *s, STRLEN *len, bool *is_utf8)
4500 Found in file utf8.c
4504 Converts a string C<s> of length C<len> from ASCII into UTF8 encoding.
4505 Returns a pointer to the newly-created string, and sets C<len> to
4506 reflect the new length.
4508 NOTE: this function is experimental and may change or be
4509 removed without notice.
4511 U8* bytes_to_utf8(U8 *s, STRLEN *len)
4514 Found in file utf8.c
4518 Return true if the strings s1 and s2 differ case-insensitively, false
4519 if not (if they are equal case-insensitively). If u1 is true, the
4520 string s1 is assumed to be in UTF-8-encoded Unicode. If u2 is true,
4521 the string s2 is assumed to be in UTF-8-encoded Unicode. If u1 or u2
4522 are false, the respective string is assumed to be in native 8-bit
4525 If the pe1 and pe2 are non-NULL, the scanning pointers will be copied
4526 in there (they will point at the beginning of the I<next> character).
4527 If the pointers behind pe1 or pe2 are non-NULL, they are the end
4528 pointers beyond which scanning will not continue under any
4529 circustances. If the byte lengths l1 and l2 are non-zero, s1+l1 and
4530 s2+l2 will be used as goal end pointers that will also stop the scan,
4531 and which qualify towards defining a successful match: all the scans
4532 that define an explicit length must reach their goal pointers for
4533 a match to succeed).
4535 For case-insensitiveness, the "casefolding" of Unicode is used
4536 instead of upper/lowercasing both the characters, see
4537 http://www.unicode.org/unicode/reports/tr21/ (Case Mappings).
4539 I32 ibcmp_utf8(const char* a, char **pe1, UV l1, bool u1, const char* b, char **pe2, UV l2, bool u2)
4542 Found in file utf8.c
4546 Tests if some arbitrary number of bytes begins in a valid UTF-8
4547 character. Note that an INVARIANT (i.e. ASCII) character is a valid UTF-8 character.
4548 The actual number of bytes in the UTF-8 character will be returned if
4549 it is valid, otherwise 0.
4551 STRLEN is_utf8_char(U8 *p)
4554 Found in file utf8.c
4556 =item is_utf8_string
4558 Returns true if first C<len> bytes of the given string form a valid UTF8
4559 string, false otherwise. Note that 'a valid UTF8 string' does not mean
4560 'a string that contains UTF8' because a valid ASCII string is a valid
4563 bool is_utf8_string(U8 *s, STRLEN len)
4566 Found in file utf8.c
4568 =item pv_uni_display
4570 Build to the scalar dsv a displayable version of the string spv,
4571 length len, the displayable version being at most pvlim bytes long
4572 (if longer, the rest is truncated and "..." will be appended).
4574 The flags argument can have UNI_DISPLAY_ISPRINT set to display
4575 isPRINT()able characters as themselves, UNI_DISPLAY_BACKSLASH
4576 to display the \\[nrfta\\] as the backslashed versions (like '\n')
4577 (UNI_DISPLAY_BACKSLASH is preferred over UNI_DISPLAY_ISPRINT for \\).
4578 UNI_DISPLAY_QQ (and its alias UNI_DISPLAY_REGEX) have both
4579 UNI_DISPLAY_BACKSLASH and UNI_DISPLAY_ISPRINT turned on.
4581 The pointer to the PV of the dsv is returned.
4583 char* pv_uni_display(SV *dsv, U8 *spv, STRLEN len, STRLEN pvlim, UV flags)
4586 Found in file utf8.c
4588 =item sv_recode_to_utf8
4590 The encoding is assumed to be an Encode object, on entry the PV
4591 of the sv is assumed to be octets in that encoding, and the sv
4592 will be converted into Unicode (and UTF-8).
4594 If the sv already is UTF-8 (or if it is not POK), or if the encoding
4595 is not a reference, nothing is done to the sv. If the encoding is not
4596 an C<Encode::XS> Encoding object, bad things will happen.
4597 (See F<lib/encoding.pm> and L<Encode>).
4599 The PV of the sv is returned.
4601 char* sv_recode_to_utf8(SV* sv, SV *encoding)
4606 =item sv_uni_display
4608 Build to the scalar dsv a displayable version of the scalar sv,
4609 the displayable version being at most pvlim bytes long
4610 (if longer, the rest is truncated and "..." will be appended).
4612 The flags argument is as in pv_uni_display().
4614 The pointer to the PV of the dsv is returned.
4616 char* sv_uni_display(SV *dsv, SV *ssv, STRLEN pvlim, UV flags)
4619 Found in file utf8.c
4623 The "p" contains the pointer to the UTF-8 string encoding
4624 the character that is being converted.
4626 The "ustrp" is a pointer to the character buffer to put the
4627 conversion result to. The "lenp" is a pointer to the length
4630 The "swashp" is a pointer to the swash to use.
4632 Both the special and normal mappings are stored lib/unicore/To/Foo.pl,
4633 and loaded by SWASHGET, using lib/utf8_heavy.pl. The special (usually,
4634 but not always, a multicharacter mapping), is tried first.
4636 The "special" is a string like "utf8::ToSpecLower", which means the
4637 hash %utf8::ToSpecLower. The access to the hash is through
4638 Perl_to_utf8_case().
4640 The "normal" is a string like "ToLower" which means the swash
4643 UV to_utf8_case(U8 *p, U8* ustrp, STRLEN *lenp, SV **swash, char *normal, char *special)
4646 Found in file utf8.c
4650 Convert the UTF-8 encoded character at p to its foldcase version and
4651 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
4652 that the ustrp needs to be at least UTF8_MAXLEN_FOLD+1 bytes since the
4653 foldcase version may be longer than the original character (up to
4656 The first character of the foldcased version is returned
4657 (but note, as explained above, that there may be more.)
4659 UV to_utf8_fold(U8 *p, U8* ustrp, STRLEN *lenp)
4662 Found in file utf8.c
4666 Convert the UTF-8 encoded character at p to its lowercase version and
4667 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
4668 that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the
4669 lowercase version may be longer than the original character (up to two
4672 The first character of the lowercased version is returned
4673 (but note, as explained above, that there may be more.)
4675 UV to_utf8_lower(U8 *p, U8* ustrp, STRLEN *lenp)
4678 Found in file utf8.c
4682 Convert the UTF-8 encoded character at p to its titlecase version and
4683 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
4684 that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the
4685 titlecase version may be longer than the original character (up to two
4688 The first character of the titlecased version is returned
4689 (but note, as explained above, that there may be more.)
4691 UV to_utf8_title(U8 *p, U8* ustrp, STRLEN *lenp)
4694 Found in file utf8.c
4698 Convert the UTF-8 encoded character at p to its uppercase version and
4699 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
4700 that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the
4701 uppercase version may be longer than the original character (up to two
4704 The first character of the uppercased version is returned
4705 (but note, as explained above, that there may be more.)
4707 UV to_utf8_upper(U8 *p, U8* ustrp, STRLEN *lenp)
4710 Found in file utf8.c
4712 =item utf8n_to_uvchr
4714 Returns the native character value of the first character in the string C<s>
4715 which is assumed to be in UTF8 encoding; C<retlen> will be set to the
4716 length, in bytes, of that character.
4718 Allows length and flags to be passed to low level routine.
4720 UV utf8n_to_uvchr(U8 *s, STRLEN curlen, STRLEN* retlen, U32 flags)
4723 Found in file utf8.c
4725 =item utf8n_to_uvuni
4727 Bottom level UTF-8 decode routine.
4728 Returns the unicode code point value of the first character in the string C<s>
4729 which is assumed to be in UTF8 encoding and no longer than C<curlen>;
4730 C<retlen> will be set to the length, in bytes, of that character.
4732 If C<s> does not point to a well-formed UTF8 character, the behaviour
4733 is dependent on the value of C<flags>: if it contains UTF8_CHECK_ONLY,
4734 it is assumed that the caller will raise a warning, and this function
4735 will silently just set C<retlen> to C<-1> and return zero. If the
4736 C<flags> does not contain UTF8_CHECK_ONLY, warnings about
4737 malformations will be given, C<retlen> will be set to the expected
4738 length of the UTF-8 character in bytes, and zero will be returned.
4740 The C<flags> can also contain various flags to allow deviations from
4741 the strict UTF-8 encoding (see F<utf8.h>).
4743 Most code should use utf8_to_uvchr() rather than call this directly.
4745 UV utf8n_to_uvuni(U8 *s, STRLEN curlen, STRLEN* retlen, U32 flags)
4748 Found in file utf8.c
4752 Returns the number of UTF8 characters between the UTF-8 pointers C<a>
4755 WARNING: use only if you *know* that the pointers point inside the
4758 IV utf8_distance(U8 *a, U8 *b)
4761 Found in file utf8.c
4765 Return the UTF-8 pointer C<s> displaced by C<off> characters, either
4766 forward or backward.
4768 WARNING: do not use the following unless you *know* C<off> is within
4769 the UTF-8 data pointed to by C<s> *and* that on entry C<s> is aligned
4770 on the first byte of character or just after the last byte of a character.
4772 U8* utf8_hop(U8 *s, I32 off)
4775 Found in file utf8.c
4779 Return the length of the UTF-8 char encoded string C<s> in characters.
4780 Stops at C<e> (inclusive). If C<e E<lt> s> or if the scan would end
4781 up past C<e>, croaks.
4783 STRLEN utf8_length(U8* s, U8 *e)
4786 Found in file utf8.c
4790 Converts a string C<s> of length C<len> from UTF8 into byte encoding.
4791 Unlike C<bytes_to_utf8>, this over-writes the original string, and
4792 updates len to contain the new length.
4793 Returns zero on failure, setting C<len> to -1.
4795 NOTE: this function is experimental and may change or be
4796 removed without notice.
4798 U8* utf8_to_bytes(U8 *s, STRLEN *len)
4801 Found in file utf8.c
4805 Returns the native character value of the first character in the string C<s>
4806 which is assumed to be in UTF8 encoding; C<retlen> will be set to the
4807 length, in bytes, of that character.
4809 If C<s> does not point to a well-formed UTF8 character, zero is
4810 returned and retlen is set, if possible, to -1.
4812 UV utf8_to_uvchr(U8 *s, STRLEN* retlen)
4815 Found in file utf8.c
4819 Returns the Unicode code point of the first character in the string C<s>
4820 which is assumed to be in UTF8 encoding; C<retlen> will be set to the
4821 length, in bytes, of that character.
4823 This function should only be used when returned UV is considered
4824 an index into the Unicode semantic tables (e.g. swashes).
4826 If C<s> does not point to a well-formed UTF8 character, zero is
4827 returned and retlen is set, if possible, to -1.
4829 UV utf8_to_uvuni(U8 *s, STRLEN* retlen)
4832 Found in file utf8.c
4836 Adds the UTF8 representation of the Native codepoint C<uv> to the end
4837 of the string C<d>; C<d> should be have at least C<UTF8_MAXLEN+1> free
4838 bytes available. The return value is the pointer to the byte after the
4839 end of the new character. In other words,
4841 d = uvchr_to_utf8(d, uv);
4843 is the recommended wide native character-aware way of saying
4847 U8* uvchr_to_utf8(U8 *d, UV uv)
4850 Found in file utf8.c
4852 =item uvuni_to_utf8_flags
4854 Adds the UTF8 representation of the Unicode codepoint C<uv> to the end
4855 of the string C<d>; C<d> should be have at least C<UTF8_MAXLEN+1> free
4856 bytes available. The return value is the pointer to the byte after the
4857 end of the new character. In other words,
4859 d = uvuni_to_utf8_flags(d, uv, flags);
4863 d = uvuni_to_utf8(d, uv);
4865 (which is equivalent to)
4867 d = uvuni_to_utf8_flags(d, uv, 0);
4869 is the recommended Unicode-aware way of saying
4873 U8* uvuni_to_utf8_flags(U8 *d, UV uv, UV flags)
4876 Found in file utf8.c
4881 =head1 Variables created by C<xsubpp> and C<xsubpp> internal functions
4887 Variable which is setup by C<xsubpp> to indicate the stack base offset,
4888 used by the C<ST>, C<XSprePUSH> and C<XSRETURN> macros. The C<dMARK> macro
4889 must be called prior to setup the C<MARK> variable.
4894 Found in file XSUB.h
4898 Variable which is setup by C<xsubpp> to indicate the
4899 class name for a C++ XS constructor. This is always a C<char*>. See C<THIS>.
4904 Found in file XSUB.h
4908 Sets up the C<ax> variable.
4909 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
4914 Found in file XSUB.h
4918 Sets up the C<items> variable.
4919 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
4924 Found in file XSUB.h
4928 Sets up stack and mark pointers for an XSUB, calling dSP and dMARK.
4929 Sets up the C<ax> and C<items> variables by calling C<dAX> and C<dITEMS>.
4930 This is usually handled automatically by C<xsubpp>.
4935 Found in file XSUB.h
4939 Sets up the C<ix> variable for an XSUB which has aliases. This is usually
4940 handled automatically by C<xsubpp>.
4945 Found in file XSUB.h
4949 Variable which is setup by C<xsubpp> to indicate the number of
4950 items on the stack. See L<perlxs/"Variable-length Parameter Lists">.
4955 Found in file XSUB.h
4959 Variable which is setup by C<xsubpp> to indicate which of an
4960 XSUB's aliases was used to invoke it. See L<perlxs/"The ALIAS: Keyword">.
4965 Found in file XSUB.h
4969 Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
4973 Found in file XSUB.h
4977 Variable which is setup by C<xsubpp> to hold the return value for an
4978 XSUB. This is always the proper type for the XSUB. See
4979 L<perlxs/"The RETVAL Variable">.
4984 Found in file XSUB.h
4988 Used to access elements on the XSUB's stack.
4993 Found in file XSUB.h
4997 Variable which is setup by C<xsubpp> to designate the object in a C++
4998 XSUB. This is always the proper type for the C++ object. See C<CLASS> and
4999 L<perlxs/"Using XS With C++">.
5004 Found in file XSUB.h
5008 Macro to declare an XSUB and its C parameter list. This is handled by
5012 Found in file XSUB.h
5014 =item XSRETURN_EMPTY
5016 Return an empty list from an XSUB immediately.
5022 Found in file XSUB.h
5026 The version identifier for an XS module. This is usually
5027 handled automatically by C<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>.
5030 Found in file XSUB.h
5032 =item XS_VERSION_BOOTCHECK
5034 Macro to verify that a PM module's $VERSION variable matches the XS
5035 module's C<XS_VERSION> variable. This is usually handled automatically by
5036 C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">.
5038 XS_VERSION_BOOTCHECK;
5041 Found in file XSUB.h
5046 =head1 Warning and Dieing
5052 This is the XSUB-writer's interface to Perl's C<die> function.
5053 Normally use this function the same way you use the C C<printf>
5054 function. See C<warn>.
5056 If you want to throw an exception object, assign the object to
5057 C<$@> and then pass C<Nullch> to croak():
5059 errsv = get_sv("@", TRUE);
5060 sv_setsv(errsv, exception_object);
5063 void croak(const char* pat, ...)
5066 Found in file util.c
5070 This is the XSUB-writer's interface to Perl's C<warn> function. Use this
5071 function the same way you use the C C<printf> function. See
5074 void warn(const char* pat, ...)
5077 Found in file util.c
5084 Until May 1997, this document was maintained by Jeff Okamoto
5085 <okamoto@corp.hp.com>. It is now maintained as part of Perl itself.
5087 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
5088 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
5089 Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
5090 Stephen McCamant, and Gurusamy Sarathy.
5092 API Listing originally by Dean Roehrich <roehrich@cray.com>.
5094 Updated to be autogenerated from comments in the source by Benjamin Stuhl.
5098 perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
projects / p5sagit/p5-mst-13.2.git / blob