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 Allocates a new Perl interpreter. See L<perlembed>.
583 PerlInterpreter* perl_alloc()
590 Initializes a new Perl interpreter. See L<perlembed>.
592 void perl_construct(PerlInterpreter* interp)
599 Shuts down a Perl interpreter. See L<perlembed>.
601 int perl_destruct(PerlInterpreter* interp)
608 Releases a Perl interpreter. See L<perlembed>.
610 void perl_free(PerlInterpreter* interp)
617 Tells a Perl interpreter to parse a Perl script. See L<perlembed>.
619 int perl_parse(PerlInterpreter* interp, XSINIT_t xsinit, int argc, char** argv, char** env)
626 Tells a Perl interpreter to run. See L<perlembed>.
628 int perl_run(PerlInterpreter* interp)
635 Tells Perl to C<require> the file named by the string argument. It is
636 analogous to the Perl code C<eval "require '$file'">. It's even
637 implemented that way; consider using Perl_load_module instead.
639 NOTE: the perl_ form of this function is deprecated.
641 void require_pv(const char* pv)
649 =head1 Functions in file pp_pack.c
656 The engine implementing pack() Perl function.
658 void pack_cat(SV *cat, char *pat, char *patend, SV **beglist, SV **endlist, SV ***next_in_list, U32 flags)
661 Found in file pp_pack.c
665 The engine implementing unpack() Perl function.
667 I32 unpack_str(char *pat, char *patend, char *s, char *strbeg, char *strend, char **new_s, I32 ocnt, U32 flags)
670 Found in file pp_pack.c
675 =head1 Global Variables
681 C<PL_modglobal> is a general purpose, interpreter global HV for use by
682 extensions that need to keep information on a per-interpreter basis.
683 In a pinch, it can also be used as a symbol table for extensions
684 to share data among each other. It is a good idea to use keys
685 prefixed by the package name of the extension that owns the data.
690 Found in file intrpvar.h
694 A convenience variable which is typically used with C<SvPV> when one
695 doesn't care about the length of the string. It is usually more efficient
696 to either declare a local variable and use that instead or to use the
702 Found in file thrdvar.h
706 This is the C<false> SV. See C<PL_sv_yes>. Always refer to this as
712 Found in file intrpvar.h
716 This is the C<undef> SV. Always refer to this as C<&PL_sv_undef>.
721 Found in file intrpvar.h
725 This is the C<true> SV. See C<PL_sv_no>. Always refer to this as
731 Found in file intrpvar.h
742 Return the SV from the GV.
751 Returns the glob with the given C<name> and a defined subroutine or
752 C<NULL>. The glob lives in the given C<stash>, or in the stashes
753 accessible via @ISA and UNIVERSAL::.
755 The argument C<level> should be either 0 or -1. If C<level==0>, as a
756 side-effect creates a glob with the given C<name> in the given C<stash>
757 which in the case of success contains an alias for the subroutine, and sets
758 up caching info for this glob. Similarly for all the searched stashes.
760 This function grants C<"SUPER"> token as a postfix of the stash name. The
761 GV returned from C<gv_fetchmeth> may be a method cache entry, which is not
762 visible to Perl code. So when calling C<call_sv>, you should not use
763 the GV directly; instead, you should use the method's CV, which can be
764 obtained from the GV with the C<GvCV> macro.
766 GV* gv_fetchmeth(HV* stash, const char* name, STRLEN len, I32 level)
773 See L<gv_fetchmethod_autoload>.
775 GV* gv_fetchmethod(HV* stash, const char* name)
780 =item gv_fetchmethod_autoload
782 Returns the glob which contains the subroutine to call to invoke the method
783 on the C<stash>. In fact in the presence of autoloading this may be the
784 glob for "AUTOLOAD". In this case the corresponding variable $AUTOLOAD is
787 The third parameter of C<gv_fetchmethod_autoload> determines whether
788 AUTOLOAD lookup is performed if the given method is not present: non-zero
789 means yes, look for AUTOLOAD; zero means no, don't look for AUTOLOAD.
790 Calling C<gv_fetchmethod> is equivalent to calling C<gv_fetchmethod_autoload>
791 with a non-zero C<autoload> parameter.
793 These functions grant C<"SUPER"> token as a prefix of the method name. Note
794 that if you want to keep the returned glob for a long time, you need to
795 check for it being "AUTOLOAD", since at the later time the call may load a
796 different subroutine due to $AUTOLOAD changing its value. Use the glob
797 created via a side effect to do this.
799 These functions have the same side-effects and as C<gv_fetchmeth> with
800 C<level==0>. C<name> should be writable if contains C<':'> or C<'
801 ''>. The warning against passing the GV returned by C<gv_fetchmeth> to
802 C<call_sv> apply equally to these functions.
804 GV* gv_fetchmethod_autoload(HV* stash, const char* name, I32 autoload)
809 =item gv_fetchmeth_autoload
811 Same as gv_fetchmeth(), but looks for autoloaded subroutines too.
812 Returns a glob for the subroutine.
814 For an autoloaded subroutine without a GV, will create a GV even
815 if C<level < 0>. For an autoloaded subroutine without a stub, GvCV()
816 of the result may be zero.
818 GV* gv_fetchmeth_autoload(HV* stash, const char* name, STRLEN len, I32 level)
825 Returns a pointer to the stash for a specified package. C<name> should
826 be a valid UTF-8 string. If C<create> is set then the package will be
827 created if it does not already exist. If C<create> is not set and the
828 package does not exist then NULL is returned.
830 HV* gv_stashpv(const char* name, I32 create)
837 Returns a pointer to the stash for a specified package, which must be a
838 valid UTF-8 string. See C<gv_stashpv>.
840 HV* gv_stashsv(SV* sv, I32 create)
854 This flag, used in the length slot of hash entries and magic structures,
855 specifies the structure contains an C<SV*> pointer where a C<char*> pointer
856 is to be expected. (For information only--not to be used).
864 Null character pointer.
866 Found in file handy.h
873 Found in file handy.h
878 =head1 Hash Manipulation Functions
884 Returns the HV of the specified Perl hash. If C<create> is set and the
885 Perl variable does not exist then it will be created. If C<create> is not
886 set and the variable does not exist then NULL is returned.
888 NOTE: the perl_ form of this function is deprecated.
890 HV* get_hv(const char* name, I32 create)
897 Returns the computed hash stored in the hash entry.
906 Returns the actual pointer stored in the key slot of the hash entry. The
907 pointer may be either C<char*> or C<SV*>, depending on the value of
908 C<HeKLEN()>. Can be assigned to. The C<HePV()> or C<HeSVKEY()> macros are
909 usually preferable for finding the value of a key.
918 If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry
919 holds an C<SV*> key. Otherwise, holds the actual length of the key. Can
920 be assigned to. The C<HePV()> macro is usually preferable for finding key
923 STRLEN HeKLEN(HE* he)
930 Returns the key slot of the hash entry as a C<char*> value, doing any
931 necessary dereferencing of possibly C<SV*> keys. The length of the string
932 is placed in C<len> (this is a macro, so do I<not> use C<&len>). If you do
933 not care about what the length of the key is, you may use the global
934 variable C<PL_na>, though this is rather less efficient than using a local
935 variable. Remember though, that hash keys in perl are free to contain
936 embedded nulls, so using C<strlen()> or similar is not a good way to find
937 the length of hash keys. This is very similar to the C<SvPV()> macro
938 described elsewhere in this document.
940 char* HePV(HE* he, STRLEN len)
947 Returns the key as an C<SV*>, or C<Nullsv> if the hash entry does not
948 contain an C<SV*> key.
957 Returns the key as an C<SV*>. Will create and return a temporary mortal
958 C<SV*> if the hash entry contains only a C<char*> key.
960 SV* HeSVKEY_force(HE* he)
967 Sets the key to a given C<SV*>, taking care to set the appropriate flags to
968 indicate the presence of an C<SV*> key, and returns the same
971 SV* HeSVKEY_set(HE* he, SV* sv)
978 Returns the value slot (type C<SV*>) stored in the hash entry.
987 Returns the package name of a stash. See C<SvSTASH>, C<CvSTASH>.
989 char* HvNAME(HV* stash)
996 Clears a hash, making it empty.
998 void hv_clear(HV* tb)
1005 Deletes a key/value pair in the hash. The value SV is removed from the
1006 hash and returned to the caller. The C<klen> is the length of the key.
1007 The C<flags> value will normally be zero; if set to G_DISCARD then NULL
1010 SV* hv_delete(HV* tb, const char* key, I32 klen, I32 flags)
1017 Deletes a key/value pair in the hash. The value SV is removed from the
1018 hash and returned to the caller. The C<flags> value will normally be zero;
1019 if set to G_DISCARD then NULL will be returned. C<hash> can be a valid
1020 precomputed hash value, or 0 to ask for it to be computed.
1022 SV* hv_delete_ent(HV* tb, SV* key, I32 flags, U32 hash)
1029 Returns a boolean indicating whether the specified hash key exists. The
1030 C<klen> is the length of the key.
1032 bool hv_exists(HV* tb, const char* key, I32 klen)
1039 Returns a boolean indicating whether the specified hash key exists. C<hash>
1040 can be a valid precomputed hash value, or 0 to ask for it to be
1043 bool hv_exists_ent(HV* tb, SV* key, U32 hash)
1050 Returns the SV which corresponds to the specified key in the hash. The
1051 C<klen> is the length of the key. If C<lval> is set then the fetch will be
1052 part of a store. Check that the return value is non-null before
1053 dereferencing it to an C<SV*>.
1055 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1056 information on how to use this function on tied hashes.
1058 SV** hv_fetch(HV* tb, const char* key, I32 klen, I32 lval)
1065 Returns the hash entry which corresponds to the specified key in the hash.
1066 C<hash> must be a valid precomputed hash number for the given C<key>, or 0
1067 if you want the function to compute it. IF C<lval> is set then the fetch
1068 will be part of a store. Make sure the return value is non-null before
1069 accessing it. The return value when C<tb> is a tied hash is a pointer to a
1070 static location, so be sure to make a copy of the structure if you need to
1073 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1074 information on how to use this function on tied hashes.
1076 HE* hv_fetch_ent(HV* tb, SV* key, I32 lval, U32 hash)
1083 Prepares a starting point to traverse a hash table. Returns the number of
1084 keys in the hash (i.e. the same as C<HvKEYS(tb)>). The return value is
1085 currently only meaningful for hashes without tie magic.
1087 NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
1088 hash buckets that happen to be in use. If you still need that esoteric
1089 value, you can get it through the macro C<HvFILL(tb)>.
1091 I32 hv_iterinit(HV* tb)
1098 Returns the key from the current position of the hash iterator. See
1101 char* hv_iterkey(HE* entry, I32* retlen)
1108 Returns the key as an C<SV*> from the current position of the hash
1109 iterator. The return value will always be a mortal copy of the key. Also
1112 SV* hv_iterkeysv(HE* entry)
1119 Returns entries from a hash iterator. See C<hv_iterinit>.
1121 HE* hv_iternext(HV* tb)
1128 Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
1131 SV* hv_iternextsv(HV* hv, char** key, I32* retlen)
1138 Returns the value from the current position of the hash iterator. See
1141 SV* hv_iterval(HV* tb, HE* entry)
1148 Adds magic to a hash. See C<sv_magic>.
1150 void hv_magic(HV* hv, GV* gv, int how)
1157 Stores an SV in a hash. The hash key is specified as C<key> and C<klen> is
1158 the length of the key. The C<hash> parameter is the precomputed hash
1159 value; if it is zero then Perl will compute it. The return value will be
1160 NULL if the operation failed or if the value did not need to be actually
1161 stored within the hash (as in the case of tied hashes). Otherwise it can
1162 be dereferenced to get the original C<SV*>. Note that the caller is
1163 responsible for suitably incrementing the reference count of C<val> before
1164 the call, and decrementing it if the function returned NULL.
1166 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1167 information on how to use this function on tied hashes.
1169 SV** hv_store(HV* tb, const char* key, I32 klen, SV* val, U32 hash)
1176 Stores C<val> in a hash. The hash key is specified as C<key>. The C<hash>
1177 parameter is the precomputed hash value; if it is zero then Perl will
1178 compute it. The return value is the new hash entry so created. It will be
1179 NULL if the operation failed or if the value did not need to be actually
1180 stored within the hash (as in the case of tied hashes). Otherwise the
1181 contents of the return value can be accessed using the C<He?> macros
1182 described here. Note that the caller is responsible for suitably
1183 incrementing the reference count of C<val> before the call, and
1184 decrementing it if the function returned NULL.
1186 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1187 information on how to use this function on tied hashes.
1189 HE* hv_store_ent(HV* tb, SV* key, SV* val, U32 hash)
1198 void hv_undef(HV* tb)
1205 Creates a new HV. The reference count is set to 1.
1223 =head1 Magical Functions
1229 Clear something magical that the SV represents. See C<sv_magic>.
1231 int mg_clear(SV* sv)
1238 Copies the magic from one SV to another. See C<sv_magic>.
1240 int mg_copy(SV* sv, SV* nsv, const char* key, I32 klen)
1247 Finds the magic pointer for type matching the SV. See C<sv_magic>.
1249 MAGIC* mg_find(SV* sv, int type)
1256 Free any magic storage used by the SV. See C<sv_magic>.
1265 Do magic after a value is retrieved from the SV. See C<sv_magic>.
1274 Report on the SV's length. See C<sv_magic>.
1276 U32 mg_length(SV* sv)
1283 Turns on the magical status of an SV. See C<sv_magic>.
1285 void mg_magical(SV* sv)
1292 Do magic after a value is assigned to the SV. See C<sv_magic>.
1301 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
1302 argument more than once.
1304 void SvGETMAGIC(SV* sv)
1311 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
1321 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
1322 argument more than once.
1324 void SvSETMAGIC(SV* sv)
1331 Like C<SvSetSV>, but does any set magic required afterwards.
1333 void SvSetMagicSV(SV* dsb, SV* ssv)
1338 =item SvSetMagicSV_nosteal
1340 Like C<SvSetMagicSV>, but does any set magic required afterwards.
1342 void SvSetMagicSV_nosteal(SV* dsv, SV* ssv)
1349 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
1352 void SvSetSV(SV* dsb, SV* ssv)
1357 =item SvSetSV_nosteal
1359 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
1360 ssv. May evaluate arguments more than once.
1362 void SvSetSV_nosteal(SV* dsv, SV* ssv)
1369 Arranges for sv to be shared between threads if a suitable module
1372 void SvSHARE(SV* sv)
1380 =head1 Memory Management
1386 The XSUB-writer's interface to the C C<memcpy> function. The C<src> is the
1387 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1388 the type. May fail on overlapping copies. See also C<Move>.
1390 void Copy(void* src, void* dest, int nitems, type)
1393 Found in file handy.h
1397 The XSUB-writer's interface to the C C<memmove> function. The C<src> is the
1398 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1399 the type. Can do overlapping moves. See also C<Copy>.
1401 void Move(void* src, void* dest, int nitems, type)
1404 Found in file handy.h
1408 The XSUB-writer's interface to the C C<malloc> function.
1410 void New(int id, void* ptr, int nitems, type)
1413 Found in file handy.h
1417 The XSUB-writer's interface to the C C<malloc> function, with
1420 void Newc(int id, void* ptr, int nitems, type, cast)
1423 Found in file handy.h
1427 Creates a new SV. A non-zero C<len> parameter indicates the number of
1428 bytes of preallocated string space the SV should have. An extra byte for a
1429 tailing NUL is also reserved. (SvPOK is not set for the SV even if string
1430 space is allocated.) The reference count for the new SV is set to 1.
1431 C<id> is an integer id between 0 and 1299 (used to identify leaks).
1434 SV* NEWSV(int id, STRLEN len)
1437 Found in file handy.h
1441 The XSUB-writer's interface to the C C<malloc> function. The allocated
1442 memory is zeroed with C<memzero>.
1444 void Newz(int id, void* ptr, int nitems, type)
1447 Found in file handy.h
1451 The XSUB-writer's interface to the C C<realloc> function.
1453 void Renew(void* ptr, int nitems, type)
1456 Found in file handy.h
1460 The XSUB-writer's interface to the C C<realloc> function, with
1463 void Renewc(void* ptr, int nitems, type, cast)
1466 Found in file handy.h
1470 The XSUB-writer's interface to the C C<free> function.
1472 void Safefree(void* ptr)
1475 Found in file handy.h
1479 Copy a string to a safe spot. This does not use an SV.
1481 char* savepv(const char* sv)
1484 Found in file util.c
1488 Copy a string to a safe spot. The C<len> indicates number of bytes to
1489 copy. If pointer is NULL allocate space for a string of size specified.
1490 This does not use an SV.
1492 char* savepvn(const char* sv, I32 len)
1495 Found in file util.c
1499 Copy a string to a safe spot in memory shared between threads.
1500 This does not use an SV.
1502 char* savesharedpv(const char* sv)
1505 Found in file util.c
1509 This is an architecture-independent macro to copy one structure to another.
1511 void StructCopy(type src, type dest, type)
1514 Found in file handy.h
1518 The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the
1519 destination, C<nitems> is the number of items, and C<type> is the type.
1521 void Zero(void* dest, int nitems, type)
1524 Found in file handy.h
1529 =head1 Miscellaneous Functions
1535 Analyses the string in order to make fast searches on it using fbm_instr()
1536 -- the Boyer-Moore algorithm.
1538 void fbm_compile(SV* sv, U32 flags)
1541 Found in file util.c
1545 Returns the location of the SV in the string delimited by C<str> and
1546 C<strend>. It returns C<Nullch> if the string can't be found. The C<sv>
1547 does not have to be fbm_compiled, but the search will not be as fast
1550 char* fbm_instr(unsigned char* big, unsigned char* bigend, SV* littlesv, U32 flags)
1553 Found in file util.c
1557 Takes a sprintf-style format pattern and conventional
1558 (non-SV) arguments and returns the formatted string.
1560 (char *) Perl_form(pTHX_ const char* pat, ...)
1562 can be used any place a string (char *) is required:
1564 char * s = Perl_form("%d.%d",major,minor);
1566 Uses a single private buffer so if you want to format several strings you
1567 must explicitly copy the earlier strings away (and free the copies when you
1570 char* form(const char* pat, ...)
1573 Found in file util.c
1577 Fill the sv with current working directory
1579 int getcwd_sv(SV* sv)
1582 Found in file util.c
1586 Test two strings to see if they are equal. Returns true or false.
1588 bool strEQ(char* s1, char* s2)
1591 Found in file handy.h
1595 Test two strings to see if the first, C<s1>, is greater than or equal to
1596 the second, C<s2>. Returns true or false.
1598 bool strGE(char* s1, char* s2)
1601 Found in file handy.h
1605 Test two strings to see if the first, C<s1>, is greater than the second,
1606 C<s2>. Returns true or false.
1608 bool strGT(char* s1, char* s2)
1611 Found in file handy.h
1615 Test two strings to see if the first, C<s1>, is less than or equal to the
1616 second, C<s2>. Returns true or false.
1618 bool strLE(char* s1, char* s2)
1621 Found in file handy.h
1625 Test two strings to see if the first, C<s1>, is less than the second,
1626 C<s2>. Returns true or false.
1628 bool strLT(char* s1, char* s2)
1631 Found in file handy.h
1635 Test two strings to see if they are different. Returns true or
1638 bool strNE(char* s1, char* s2)
1641 Found in file handy.h
1645 Test two strings to see if they are equal. The C<len> parameter indicates
1646 the number of bytes to compare. Returns true or false. (A wrapper for
1649 bool strnEQ(char* s1, char* s2, STRLEN len)
1652 Found in file handy.h
1656 Test two strings to see if they are different. The C<len> parameter
1657 indicates the number of bytes to compare. Returns true or false. (A
1658 wrapper for C<strncmp>).
1660 bool strnNE(char* s1, char* s2, STRLEN len)
1663 Found in file handy.h
1668 =head1 Numeric functions
1674 converts a string representing a binary number to numeric form.
1676 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
1677 conversion flags, and I<result> should be NULL or a pointer to an NV.
1678 The scan stops at the end of the string, or the first invalid character.
1679 On return I<*len> is set to the length scanned string, and I<*flags> gives
1682 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
1683 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_bin>
1684 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
1685 and writes the value to I<*result> (or the value is discarded if I<result>
1688 The hex number may optionally be prefixed with "0b" or "b" unless
1689 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
1690 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the binary
1691 number may use '_' characters to separate digits.
1693 UV grok_bin(char* start, STRLEN* len, I32* flags, NV *result)
1696 Found in file numeric.c
1700 converts a string representing a hex number to numeric form.
1702 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
1703 conversion flags, and I<result> should be NULL or a pointer to an NV.
1704 The scan stops at the end of the string, or the first non-hex-digit character.
1705 On return I<*len> is set to the length scanned string, and I<*flags> gives
1708 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
1709 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_hex>
1710 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
1711 and writes the value to I<*result> (or the value is discarded if I<result>
1714 The hex number may optionally be prefixed with "0x" or "x" unless
1715 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
1716 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the hex
1717 number may use '_' characters to separate digits.
1719 UV grok_hex(char* start, STRLEN* len, I32* flags, NV *result)
1722 Found in file numeric.c
1726 Recognise (or not) a number. The type of the number is returned
1727 (0 if unrecognised), otherwise it is a bit-ORed combination of
1728 IS_NUMBER_IN_UV, IS_NUMBER_GREATER_THAN_UV_MAX, IS_NUMBER_NOT_INT,
1729 IS_NUMBER_NEG, IS_NUMBER_INFINITY, IS_NUMBER_NAN (defined in perl.h).
1731 If the value of the number can fit an in UV, it is returned in the *valuep
1732 IS_NUMBER_IN_UV will be set to indicate that *valuep is valid, IS_NUMBER_IN_UV
1733 will never be set unless *valuep is valid, but *valuep may have been assigned
1734 to during processing even though IS_NUMBER_IN_UV is not set on return.
1735 If valuep is NULL, IS_NUMBER_IN_UV will be set for the same cases as when
1736 valuep is non-NULL, but no actual assignment (or SEGV) will occur.
1738 IS_NUMBER_NOT_INT will be set with IS_NUMBER_IN_UV if trailing decimals were
1739 seen (in which case *valuep gives the true value truncated to an integer), and
1740 IS_NUMBER_NEG if the number is negative (in which case *valuep holds the
1741 absolute value). IS_NUMBER_IN_UV is not set if e notation was used or the
1742 number is larger than a UV.
1744 int grok_number(const char *pv, STRLEN len, UV *valuep)
1747 Found in file numeric.c
1749 =item grok_numeric_radix
1751 Scan and skip for a numeric decimal separator (radix).
1753 bool grok_numeric_radix(const char **sp, const char *send)
1756 Found in file numeric.c
1761 UV grok_oct(char* start, STRLEN* len, I32* flags, NV *result)
1764 Found in file numeric.c
1768 For backwards compatibility. Use C<grok_bin> instead.
1770 NV scan_bin(char* start, STRLEN len, STRLEN* retlen)
1773 Found in file numeric.c
1777 For backwards compatibility. Use C<grok_hex> instead.
1779 NV scan_hex(char* start, STRLEN len, STRLEN* retlen)
1782 Found in file numeric.c
1786 For backwards compatibility. Use C<grok_oct> instead.
1788 NV scan_oct(char* start, STRLEN len, STRLEN* retlen)
1791 Found in file numeric.c
1796 =head1 Optree Manipulation Functions
1802 If C<cv> is a constant sub eligible for inlining. returns the constant
1803 value returned by the sub. Otherwise, returns NULL.
1805 Constant subs can be created with C<newCONSTSUB> or as described in
1806 L<perlsub/"Constant Functions">.
1808 SV* cv_const_sv(CV* cv)
1815 Creates a constant sub equivalent to Perl C<sub FOO () { 123 }> which is
1816 eligible for inlining at compile-time.
1818 CV* newCONSTSUB(HV* stash, char* name, SV* sv)
1825 Used by C<xsubpp> to hook up XSUBs as Perl subs.
1833 =head1 Stack Manipulation Macros
1839 Declare a stack marker variable, C<mark>, for the XSUB. See C<MARK> and
1849 Saves the original stack mark for the XSUB. See C<ORIGMARK>.
1858 Declares a local copy of perl's stack pointer for the XSUB, available via
1859 the C<SP> macro. See C<SP>.
1868 Used to extend the argument stack for an XSUB's return values. Once
1869 used, guarantees that there is room for at least C<nitems> to be pushed
1872 void EXTEND(SP, int nitems)
1879 Stack marker variable for the XSUB. See C<dMARK>.
1886 The original stack mark for the XSUB. See C<dORIGMARK>.
1893 Pops an integer off the stack.
1902 Pops a long off the stack.
1911 Pops a double off the stack.
1920 Pops a string off the stack. Deprecated. New code should provide
1921 a STRLEN n_a and use POPpx.
1930 Pops a string off the stack which must consist of bytes i.e. characters < 256.
1931 Requires a variable STRLEN n_a in scope.
1940 Pops a string off the stack.
1941 Requires a variable STRLEN n_a in scope.
1950 Pops an SV off the stack.
1959 Push an integer onto the stack. The stack must have room for this element.
1960 Handles 'set' magic. See C<XPUSHi>.
1969 Opening bracket for arguments on a callback. See C<PUTBACK> and
1979 Push a double onto the stack. The stack must have room for this element.
1980 Handles 'set' magic. See C<XPUSHn>.
1989 Push a string onto the stack. The stack must have room for this element.
1990 The C<len> indicates the length of the string. Handles 'set' magic. See
1993 void PUSHp(char* str, STRLEN len)
2000 Push an SV onto the stack. The stack must have room for this element.
2001 Does not handle 'set' magic. See C<XPUSHs>.
2010 Push an unsigned integer onto the stack. The stack must have room for this
2011 element. See C<XPUSHu>.
2020 Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
2021 See C<PUSHMARK> and L<perlcall> for other uses.
2030 Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and
2038 Refetch the stack pointer. Used after a callback. See L<perlcall>.
2047 Push an integer onto the stack, extending the stack if necessary. Handles
2048 'set' magic. See C<PUSHi>.
2057 Push a double onto the stack, extending the stack if necessary. Handles
2058 'set' magic. See C<PUSHn>.
2067 Push a string onto the stack, extending the stack if necessary. The C<len>
2068 indicates the length of the string. Handles 'set' magic. See
2071 void XPUSHp(char* str, STRLEN len)
2078 Push an SV onto the stack, extending the stack if necessary. Does not
2079 handle 'set' magic. See C<PUSHs>.
2088 Push an unsigned integer onto the stack, extending the stack if necessary.
2098 Return from XSUB, indicating number of items on the stack. This is usually
2099 handled by C<xsubpp>.
2101 void XSRETURN(int nitems)
2104 Found in file XSUB.h
2108 Return an integer from an XSUB immediately. Uses C<XST_mIV>.
2110 void XSRETURN_IV(IV iv)
2113 Found in file XSUB.h
2117 Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
2122 Found in file XSUB.h
2126 Return a double from an XSUB immediately. Uses C<XST_mNV>.
2128 void XSRETURN_NV(NV nv)
2131 Found in file XSUB.h
2135 Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
2137 void XSRETURN_PV(char* str)
2140 Found in file XSUB.h
2142 =item XSRETURN_UNDEF
2144 Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
2149 Found in file XSUB.h
2153 Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
2158 Found in file XSUB.h
2162 Place an integer into the specified position C<pos> on the stack. The
2163 value is stored in a new mortal SV.
2165 void XST_mIV(int pos, IV iv)
2168 Found in file XSUB.h
2172 Place C<&PL_sv_no> into the specified position C<pos> on the
2175 void XST_mNO(int pos)
2178 Found in file XSUB.h
2182 Place a double into the specified position C<pos> on the stack. The value
2183 is stored in a new mortal SV.
2185 void XST_mNV(int pos, NV nv)
2188 Found in file XSUB.h
2192 Place a copy of a string into the specified position C<pos> on the stack.
2193 The value is stored in a new mortal SV.
2195 void XST_mPV(int pos, char* str)
2198 Found in file XSUB.h
2202 Place C<&PL_sv_undef> into the specified position C<pos> on the
2205 void XST_mUNDEF(int pos)
2208 Found in file XSUB.h
2212 Place C<&PL_sv_yes> into the specified position C<pos> on the
2215 void XST_mYES(int pos)
2218 Found in file XSUB.h
2229 An enum of flags for Perl types. These are found in the file B<sv.h>
2230 in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
2237 Integer type flag for scalars. See C<svtype>.
2244 Double type flag for scalars. See C<svtype>.
2251 Pointer type flag for scalars. See C<svtype>.
2258 Type flag for arrays. See C<svtype>.
2265 Type flag for code refs. See C<svtype>.
2272 Type flag for hashes. See C<svtype>.
2279 Type flag for blessed scalars. See C<svtype>.
2287 =head1 SV Manipulation Functions
2293 Returns the SV of the specified Perl scalar. If C<create> is set and the
2294 Perl variable does not exist then it will be created. If C<create> is not
2295 set and the variable does not exist then NULL is returned.
2297 NOTE: the perl_ form of this function is deprecated.
2299 SV* get_sv(const char* name, I32 create)
2302 Found in file perl.c
2304 =item looks_like_number
2306 Test if the content of an SV looks like a number (or is a number).
2307 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
2308 non-numeric warning), even if your atof() doesn't grok them.
2310 I32 looks_like_number(SV* sv)
2317 Creates an RV wrapper for an SV. The reference count for the original SV is
2320 SV* newRV_inc(SV* sv)
2327 Creates an RV wrapper for an SV. The reference count for the original
2328 SV is B<not> incremented.
2330 SV* newRV_noinc(SV *sv)
2337 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
2338 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
2341 SV* newSV(STRLEN len)
2348 Creates a new SV and copies an integer into it. The reference count for the
2358 Creates a new SV and copies a floating point value into it.
2359 The reference count for the SV is set to 1.
2368 Creates a new SV and copies a string into it. The reference count for the
2369 SV is set to 1. If C<len> is zero, Perl will compute the length using
2370 strlen(). For efficiency, consider using C<newSVpvn> instead.
2372 SV* newSVpv(const char* s, STRLEN len)
2379 Creates a new SV and initializes it with the string formatted like
2382 SV* newSVpvf(const char* pat, ...)
2389 Creates a new SV and copies a string into it. The reference count for the
2390 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
2391 string. You are responsible for ensuring that the source string is at least
2394 SV* newSVpvn(const char* s, STRLEN len)
2399 =item newSVpvn_share
2401 Creates a new SV with its SvPVX pointing to a shared string in the string
2402 table. If the string does not already exist in the table, it is created
2403 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
2404 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
2405 otherwise the hash is computed. The idea here is that as the string table
2406 is used for shared hash keys these strings will have SvPVX == HeKEY and
2407 hash lookup will avoid string compare.
2409 SV* newSVpvn_share(const char* s, I32 len, U32 hash)
2416 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
2417 it will be upgraded to one. If C<classname> is non-null then the new SV will
2418 be blessed in the specified package. The new SV is returned and its
2419 reference count is 1.
2421 SV* newSVrv(SV* rv, const char* classname)
2428 Creates a new SV which is an exact duplicate of the original SV.
2431 SV* newSVsv(SV* old)
2438 Creates a new SV and copies an unsigned integer into it.
2439 The reference count for the SV is set to 1.
2448 Returns a pointer to the next character after the parsed
2449 vstring, as well as updating the passed in sv.
2451 Function must be called like
2454 s = new_vstring(s,sv);
2456 The sv must already be large enough to store the vstring
2459 char* new_vstring(char *vstr, SV *sv)
2462 Found in file util.c
2466 Returns the length of the string which is in the SV. See C<SvLEN>.
2468 STRLEN SvCUR(SV* sv)
2475 Set the length of the string which is in the SV. See C<SvCUR>.
2477 void SvCUR_set(SV* sv, STRLEN len)
2484 Returns a pointer to the last character in the string which is in the SV.
2485 See C<SvCUR>. Access the character as *(SvEND(sv)).
2494 Expands the character buffer in the SV so that it has room for the
2495 indicated number of bytes (remember to reserve space for an extra trailing
2496 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
2497 Returns a pointer to the character buffer.
2499 char * SvGROW(SV* sv, STRLEN len)
2506 Returns a boolean indicating whether the SV contains an integer.
2515 Returns a boolean indicating whether the SV contains an integer. Checks
2516 the B<private> setting. Use C<SvIOK>.
2525 Returns a boolean indicating whether the SV contains a signed integer.
2527 void SvIOK_notUV(SV* sv)
2534 Unsets the IV status of an SV.
2536 void SvIOK_off(SV* sv)
2543 Tells an SV that it is an integer.
2545 void SvIOK_on(SV* sv)
2552 Tells an SV that it is an integer and disables all other OK bits.
2554 void SvIOK_only(SV* sv)
2561 Tells and SV that it is an unsigned integer and disables all other OK bits.
2563 void SvIOK_only_UV(SV* sv)
2570 Returns a boolean indicating whether the SV contains an unsigned integer.
2572 void SvIOK_UV(SV* sv)
2579 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
2580 version which guarantees to evaluate sv only once.
2589 Returns the raw value in the SV's IV slot, without checks or conversions.
2590 Only use when you are sure SvIOK is true. See also C<SvIV()>.
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 size of the string buffer in the SV, not including any part
2610 attributable to C<SvOOK>. See C<SvCUR>.
2612 STRLEN SvLEN(SV* sv)
2619 Returns a boolean indicating whether the SV contains a number, integer or
2629 Returns a boolean indicating whether the SV contains a number, integer or
2630 double. Checks the B<private> setting. Use C<SvNIOK>.
2632 bool SvNIOKp(SV* sv)
2639 Unsets the NV/IV status of an SV.
2641 void SvNIOK_off(SV* sv)
2648 Returns a boolean indicating whether the SV contains a double.
2657 Returns a boolean indicating whether the SV contains a double. Checks the
2658 B<private> setting. Use C<SvNOK>.
2667 Unsets the NV status of an SV.
2669 void SvNOK_off(SV* sv)
2676 Tells an SV that it is a double.
2678 void SvNOK_on(SV* sv)
2685 Tells an SV that it is a double and disables all other OK bits.
2687 void SvNOK_only(SV* sv)
2694 Coerce the given SV to a double and return it. See C<SvNVx> for a version
2695 which guarantees to evaluate sv only once.
2704 Coerces the given SV to a double and returns it. Guarantees to evaluate
2705 sv only once. Use the more efficient C<SvNV> otherwise.
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 Returns a boolean indicating whether the value is an SV.
2733 Returns a boolean indicating whether the SvIVX is a valid offset value for
2734 the SvPVX. This hack is used internally to speed up removal of characters
2735 from the beginning of a SvPV. When SvOOK is true, then the start of the
2736 allocated string buffer is really (SvPVX - SvIVX).
2745 Returns a boolean indicating whether the SV contains a character
2755 Returns a boolean indicating whether the SV contains a character string.
2756 Checks the B<private> setting. Use C<SvPOK>.
2765 Unsets the PV status of an SV.
2767 void SvPOK_off(SV* sv)
2774 Tells an SV that it is a string.
2776 void SvPOK_on(SV* sv)
2783 Tells an SV that it is a string and disables all other OK bits.
2784 Will also turn off the UTF8 status.
2786 void SvPOK_only(SV* sv)
2791 =item SvPOK_only_UTF8
2793 Tells an SV that it is a string and disables all other OK bits,
2794 and leaves the UTF8 status as it was.
2796 void SvPOK_only_UTF8(SV* sv)
2803 Returns a pointer to the string in the SV, or a stringified form of
2804 the SV if the SV does not contain a string. The SV may cache the
2805 stringified version becoming C<SvPOK>. Handles 'get' magic. See also
2806 C<SvPVx> for a version which guarantees to evaluate sv only once.
2808 char* SvPV(SV* sv, STRLEN len)
2815 Like C<SvPV>, but converts sv to byte representation first if necessary.
2817 char* SvPVbyte(SV* sv, STRLEN len)
2824 Like C<SvPV>, but converts sv to byte representation first if necessary.
2825 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
2829 char* SvPVbytex(SV* sv, STRLEN len)
2834 =item SvPVbytex_force
2836 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
2837 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
2840 char* SvPVbytex_force(SV* sv, STRLEN len)
2845 =item SvPVbyte_force
2847 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
2849 char* SvPVbyte_force(SV* sv, STRLEN len)
2854 =item SvPVbyte_nolen
2856 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
2858 char* SvPVbyte_nolen(SV* sv)
2865 Like C<SvPV>, but converts sv to utf8 first if necessary.
2867 char* SvPVutf8(SV* sv, STRLEN len)
2874 Like C<SvPV>, but converts sv to utf8 first if necessary.
2875 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
2878 char* SvPVutf8x(SV* sv, STRLEN len)
2883 =item SvPVutf8x_force
2885 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
2886 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
2889 char* SvPVutf8x_force(SV* sv, STRLEN len)
2894 =item SvPVutf8_force
2896 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
2898 char* SvPVutf8_force(SV* sv, STRLEN len)
2903 =item SvPVutf8_nolen
2905 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
2907 char* SvPVutf8_nolen(SV* sv)
2914 A version of C<SvPV> which guarantees to evaluate sv only once.
2916 char* SvPVx(SV* sv, STRLEN len)
2923 Returns a pointer to the physical string in the SV. The SV must contain a
2933 Like C<SvPV> but will force the SV into containing just a string
2934 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
2937 char* SvPV_force(SV* sv, STRLEN len)
2942 =item SvPV_force_nomg
2944 Like C<SvPV> but will force the SV into containing just a string
2945 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
2946 directly. Doesn't process magic.
2948 char* SvPV_force_nomg(SV* sv, STRLEN len)
2955 Returns a pointer to the string in the SV, or a stringified form of
2956 the SV if the SV does not contain a string. The SV may cache the
2957 stringified form becoming C<SvPOK>. Handles 'get' magic.
2959 char* SvPV_nolen(SV* sv)
2966 Returns the value of the object's reference count.
2968 U32 SvREFCNT(SV* sv)
2975 Decrements the reference count of the given SV.
2977 void SvREFCNT_dec(SV* sv)
2984 Increments the reference count of the given SV.
2986 SV* SvREFCNT_inc(SV* sv)
2993 Tests if the SV is an RV.
3002 Unsets the RV status of an SV.
3004 void SvROK_off(SV* sv)
3011 Tells an SV that it is an RV.
3013 void SvROK_on(SV* sv)
3020 Dereferences an RV to return the SV.
3029 Returns the stash of the SV.
3038 Taints an SV if tainting is enabled
3040 void SvTAINT(SV* sv)
3047 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
3050 bool SvTAINTED(SV* sv)
3057 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
3058 some of Perl's fundamental security features. XS module authors should not
3059 use this function unless they fully understand all the implications of
3060 unconditionally untainting the value. Untainting should be done in the
3061 standard perl fashion, via a carefully crafted regexp, rather than directly
3062 untainting variables.
3064 void SvTAINTED_off(SV* sv)
3071 Marks an SV as tainted.
3073 void SvTAINTED_on(SV* sv)
3080 Returns a boolean indicating whether Perl would evaluate the SV as true or
3081 false, defined or undefined. Does not handle 'get' magic.
3090 Returns the type of the SV. See C<svtype>.
3092 svtype SvTYPE(SV* sv)
3099 Releases a mutual exclusion lock on sv if a suitable module
3103 void SvUNLOCK(SV* sv)
3110 Returns a boolean indicating whether the SV contains an unsigned integer.
3119 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
3120 perform the upgrade if necessary. See C<svtype>.
3122 void SvUPGRADE(SV* sv, svtype type)
3129 Returns a boolean indicating whether the SV contains UTF-8 encoded data.
3138 Unsets the UTF8 status of an SV.
3140 void SvUTF8_off(SV *sv)
3147 Turn on the UTF8 status of an SV (the data is not changed, just the flag).
3148 Do not use frivolously.
3150 void SvUTF8_on(SV *sv)
3157 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
3158 for a version which guarantees to evaluate sv only once.
3167 Returns the raw value in the SV's UV slot, without checks or conversions.
3168 Only use when you are sure SvIOK is true. See also C<SvUV()>.
3177 Coerces the given SV to an unsigned integer and returns it. Guarantees to
3178 evaluate sv only once. Use the more efficient C<SvUV> otherwise.
3187 This function is only called on magical items, and is only used by
3188 sv_true() or its macro equivalent.
3190 bool sv_2bool(SV* sv)
3197 Using various gambits, try to get a CV from an SV; in addition, try if
3198 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
3200 CV* sv_2cv(SV* sv, HV** st, GV** gvp, I32 lref)
3207 Using various gambits, try to get an IO from an SV: the IO slot if its a
3208 GV; or the recursive result if we're an RV; or the IO slot of the symbol
3209 named after the PV if we're a string.
3218 Return the integer value of an SV, doing any necessary string conversion,
3219 magic etc. Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
3228 Marks an existing SV as mortal. The SV will be destroyed "soon", either
3229 by an explicit call to FREETMPS, or by an implicit call at places such as
3230 statement boundaries. See also C<sv_newmortal> and C<sv_mortalcopy>.
3232 SV* sv_2mortal(SV* sv)
3239 Return the num value of an SV, doing any necessary string or integer
3240 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
3250 Return a pointer to the byte-encoded representation of the SV, and set *lp
3251 to its length. May cause the SV to be downgraded from UTF8 as a
3254 Usually accessed via the C<SvPVbyte> macro.
3256 char* sv_2pvbyte(SV* sv, STRLEN* lp)
3261 =item sv_2pvbyte_nolen
3263 Return a pointer to the byte-encoded representation of the SV.
3264 May cause the SV to be downgraded from UTF8 as a side-effect.
3266 Usually accessed via the C<SvPVbyte_nolen> macro.
3268 char* sv_2pvbyte_nolen(SV* sv)
3275 Return a pointer to the UTF8-encoded representation of the SV, and set *lp
3276 to its length. May cause the SV to be upgraded to UTF8 as a side-effect.
3278 Usually accessed via the C<SvPVutf8> macro.
3280 char* sv_2pvutf8(SV* sv, STRLEN* lp)
3285 =item sv_2pvutf8_nolen
3287 Return a pointer to the UTF8-encoded representation of the SV.
3288 May cause the SV to be upgraded to UTF8 as a side-effect.
3290 Usually accessed via the C<SvPVutf8_nolen> macro.
3292 char* sv_2pvutf8_nolen(SV* sv)
3299 Returns a pointer to the string value of an SV, and sets *lp to its length.
3300 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
3302 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
3303 usually end up here too.
3305 char* sv_2pv_flags(SV* sv, STRLEN* lp, I32 flags)
3312 Like C<sv_2pv()>, but doesn't return the length too. You should usually
3313 use the macro wrapper C<SvPV_nolen(sv)> instead.
3314 char* sv_2pv_nolen(SV* sv)
3321 Return the unsigned integer value of an SV, doing any necessary string
3322 conversion, magic etc. Normally used via the C<SvUV(sv)> and C<SvUVx(sv)>
3332 Remove any string offset. You should normally use the C<SvOOK_off> macro
3335 int sv_backoff(SV* sv)
3342 Blesses an SV into a specified package. The SV must be an RV. The package
3343 must be designated by its stash (see C<gv_stashpv()>). The reference count
3344 of the SV is unaffected.
3346 SV* sv_bless(SV* sv, HV* stash)
3353 Concatenates the string onto the end of the string which is in the SV.
3354 If the SV has the UTF8 status set, then the bytes appended should be
3355 valid UTF8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
3357 void sv_catpv(SV* sv, const char* ptr)
3364 Processes its arguments like C<sprintf> and appends the formatted
3365 output to an SV. If the appended data contains "wide" characters
3366 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
3367 and characters >255 formatted with %c), the original SV might get
3368 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic.
3369 C<SvSETMAGIC()> must typically be called after calling this function
3370 to handle 'set' magic.
3372 void sv_catpvf(SV* sv, const char* pat, ...)
3379 Like C<sv_catpvf>, but also handles 'set' magic.
3381 void sv_catpvf_mg(SV *sv, const char* pat, ...)
3388 Concatenates the string onto the end of the string which is in the SV. The
3389 C<len> indicates number of bytes to copy. If the SV has the UTF8
3390 status set, then the bytes appended should be valid UTF8.
3391 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
3393 void sv_catpvn(SV* sv, const char* ptr, STRLEN len)
3398 =item sv_catpvn_flags
3400 Concatenates the string onto the end of the string which is in the SV. The
3401 C<len> indicates number of bytes to copy. If the SV has the UTF8
3402 status set, then the bytes appended should be valid UTF8.
3403 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
3404 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
3405 in terms of this function.
3407 void sv_catpvn_flags(SV* sv, const char* ptr, STRLEN len, I32 flags)
3414 Like C<sv_catpvn>, but also handles 'set' magic.
3416 void sv_catpvn_mg(SV *sv, const char *ptr, STRLEN len)
3423 Like C<sv_catpv>, but also handles 'set' magic.
3425 void sv_catpv_mg(SV *sv, const char *ptr)
3432 Concatenates the string from SV C<ssv> onto the end of the string in
3433 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
3434 not 'set' magic. See C<sv_catsv_mg>.
3436 void sv_catsv(SV* dsv, SV* ssv)
3441 =item sv_catsv_flags
3443 Concatenates the string from SV C<ssv> onto the end of the string in
3444 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
3445 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
3446 and C<sv_catsv_nomg> are implemented in terms of this function.
3448 void sv_catsv_flags(SV* dsv, SV* ssv, I32 flags)
3455 Like C<sv_catsv>, but also handles 'set' magic.
3457 void sv_catsv_mg(SV *dstr, SV *sstr)
3464 Efficient removal of characters from the beginning of the string buffer.
3465 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
3466 the string buffer. The C<ptr> becomes the first character of the adjusted
3467 string. Uses the "OOK hack".
3469 void sv_chop(SV* sv, char* ptr)
3476 Clear an SV: call any destructors, free up any memory used by the body,
3477 and free the body itself. The SV's head is I<not> freed, although
3478 its type is set to all 1's so that it won't inadvertently be assumed
3479 to be live during global destruction etc.
3480 This function should only be called when REFCNT is zero. Most of the time
3481 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
3484 void sv_clear(SV* sv)
3491 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
3492 string in C<sv1> is less than, equal to, or greater than the string in
3493 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
3494 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
3496 I32 sv_cmp(SV* sv1, SV* sv2)
3503 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
3504 'use bytes' aware, handles get magic, and will coerce its args to strings
3505 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
3507 I32 sv_cmp_locale(SV* sv1, SV* sv2)
3514 Add Collate Transform magic to an SV if it doesn't already have it.
3516 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
3517 scalar data of the variable, but transformed to such a format that a normal
3518 memory comparison can be used to compare the data according to the locale
3521 char* sv_collxfrm(SV* sv, STRLEN* nxp)
3528 Copies a stringified representation of the source SV into the
3529 destination SV. Automatically performs any necessary mg_get and
3530 coercion of numeric values into strings. Guaranteed to preserve
3531 UTF-8 flag even from overloaded objects. Similar in nature to
3532 sv_2pv[_flags] but operates directly on an SV instead of just the
3533 string. Mostly uses sv_2pv_flags to do its work, except when that
3534 would lose the UTF-8'ness of the PV.
3536 void sv_copypv(SV* dsv, SV* ssv)
3543 Auto-decrement of the value in the SV, doing string to numeric conversion
3544 if necessary. Handles 'get' magic.
3551 =item sv_derived_from
3553 Returns a boolean indicating whether the SV is derived from the specified
3554 class. This is the function that implements C<UNIVERSAL::isa>. It works
3555 for class names as well as for objects.
3557 bool sv_derived_from(SV* sv, const char* name)
3560 Found in file universal.c
3564 Returns a boolean indicating whether the strings in the two SVs are
3565 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
3566 coerce its args to strings if necessary.
3568 I32 sv_eq(SV* sv1, SV* sv2)
3573 =item sv_force_normal
3575 Undo various types of fakery on an SV: if the PV is a shared string, make
3576 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3577 an xpvmg. See also C<sv_force_normal_flags>.
3579 void sv_force_normal(SV *sv)
3584 =item sv_force_normal_flags
3586 Undo various types of fakery on an SV: if the PV is a shared string, make
3587 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3588 an xpvmg. The C<flags> parameter gets passed to C<sv_unref_flags()>
3589 when unrefing. C<sv_force_normal> calls this function with flags set to 0.
3591 void sv_force_normal_flags(SV *sv, U32 flags)
3598 Decrement an SV's reference count, and if it drops to zero, call
3599 C<sv_clear> to invoke destructors and free up any memory used by
3600 the body; finally, deallocate the SV's head itself.
3601 Normally called via a wrapper macro C<SvREFCNT_dec>.
3603 void sv_free(SV* sv)
3610 Get a line from the filehandle and store it into the SV, optionally
3611 appending to the currently-stored string.
3613 char* sv_gets(SV* sv, PerlIO* fp, I32 append)
3620 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
3621 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
3622 Use the C<SvGROW> wrapper instead.
3624 char* sv_grow(SV* sv, STRLEN newlen)
3631 Auto-increment of the value in the SV, doing string to numeric conversion
3632 if necessary. Handles 'get' magic.
3641 Inserts a string at the specified offset/length within the SV. Similar to
3642 the Perl substr() function.
3644 void sv_insert(SV* bigsv, STRLEN offset, STRLEN len, char* little, STRLEN littlelen)
3651 Returns a boolean indicating whether the SV is blessed into the specified
3652 class. This does not check for subtypes; use C<sv_derived_from> to verify
3653 an inheritance relationship.
3655 int sv_isa(SV* sv, const char* name)
3662 Returns a boolean indicating whether the SV is an RV pointing to a blessed
3663 object. If the SV is not an RV, or if the object is not blessed, then this
3666 int sv_isobject(SV* sv)
3673 A private implementation of the C<SvIVx> macro for compilers which can't
3674 cope with complex macro expressions. Always use the macro instead.
3683 Returns the length of the string in the SV. Handles magic and type
3684 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
3686 STRLEN sv_len(SV* sv)
3693 Returns the number of characters in the string in an SV, counting wide
3694 UTF8 bytes as a single character. Handles magic and type coercion.
3696 STRLEN sv_len_utf8(SV* sv)
3703 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
3704 then adds a new magic item of type C<how> to the head of the magic list.
3706 void sv_magic(SV* sv, SV* obj, int how, const char* name, I32 namlen)
3713 Adds magic to an SV, upgrading it if necessary. Applies the
3714 supplied vtable and returns pointer to the magic added.
3716 Note that sv_magicext will allow things that sv_magic will not.
3717 In particular you can add magic to SvREADONLY SVs and and more than
3718 one instance of the same 'how'
3720 I C<namelen> is greater then zero then a savepvn() I<copy> of C<name> is stored,
3721 if C<namelen> is zero then C<name> is stored as-is and - as another special
3722 case - if C<(name && namelen == HEf_SVKEY)> then C<name> is assumed to contain
3723 an C<SV*> and has its REFCNT incremented
3725 (This is now used as a subroutine by sv_magic.)
3727 MAGIC * sv_magicext(SV* sv, SV* obj, int how, MGVTBL *vtbl, const char* name, I32 namlen )
3734 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
3735 The new SV is marked as mortal. It will be destroyed "soon", either by an
3736 explicit call to FREETMPS, or by an implicit call at places such as
3737 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
3739 SV* sv_mortalcopy(SV* oldsv)
3746 Creates a new null SV which is mortal. The reference count of the SV is
3747 set to 1. It will be destroyed "soon", either by an explicit call to
3748 FREETMPS, or by an implicit call at places such as statement boundaries.
3749 See also C<sv_mortalcopy> and C<sv_2mortal>.
3758 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
3761 SV* sv_newref(SV* sv)
3768 Dummy routine which "locks" an SV when there is no locking module present.
3769 Exists to avoid test for a NULL function pointer and because it could potentially warn under
3770 some level of strict-ness.
3772 void sv_nolocking(SV *)
3775 Found in file util.c
3779 Dummy routine which "shares" an SV when there is no sharing module present.
3780 Exists to avoid test for a NULL function pointer and because it could potentially warn under
3781 some level of strict-ness.
3783 void sv_nosharing(SV *)
3786 Found in file util.c
3788 =item sv_nounlocking
3790 Dummy routine which "unlocks" an SV when there is no locking module present.
3791 Exists to avoid test for a NULL function pointer and because it could potentially warn under
3792 some level of strict-ness.
3794 void sv_nounlocking(SV *)
3797 Found in file util.c
3801 A private implementation of the C<SvNVx> macro for compilers which can't
3802 cope with complex macro expressions. Always use the macro instead.
3811 Converts the value pointed to by offsetp from a count of bytes from the
3812 start of the string, to a count of the equivalent number of UTF8 chars.
3813 Handles magic and type coercion.
3815 void sv_pos_b2u(SV* sv, I32* offsetp)
3822 Converts the value pointed to by offsetp from a count of UTF8 chars from
3823 the start of the string, to a count of the equivalent number of bytes; if
3824 lenp is non-zero, it does the same to lenp, but this time starting from
3825 the offset, rather than from the start of the string. Handles magic and
3828 void sv_pos_u2b(SV* sv, I32* offsetp, I32* lenp)
3835 A private implementation of the C<SvPV_nolen> macro for compilers which can't
3836 cope with complex macro expressions. Always use the macro instead.
3845 A private implementation of the C<SvPVbyte_nolen> macro for compilers
3846 which can't cope with complex macro expressions. Always use the macro
3849 char* sv_pvbyte(SV *sv)
3856 A private implementation of the C<SvPVbyte> macro for compilers
3857 which can't cope with complex macro expressions. Always use the macro
3860 char* sv_pvbyten(SV *sv, STRLEN *len)
3865 =item sv_pvbyten_force
3867 A private implementation of the C<SvPVbytex_force> macro for compilers
3868 which can't cope with complex macro expressions. Always use the macro
3871 char* sv_pvbyten_force(SV* sv, STRLEN* lp)
3878 A private implementation of the C<SvPV> macro for compilers which can't
3879 cope with complex macro expressions. Always use the macro instead.
3881 char* sv_pvn(SV *sv, STRLEN *len)
3888 Get a sensible string out of the SV somehow.
3889 A private implementation of the C<SvPV_force> macro for compilers which
3890 can't cope with complex macro expressions. Always use the macro instead.
3892 char* sv_pvn_force(SV* sv, STRLEN* lp)
3897 =item sv_pvn_force_flags
3899 Get a sensible string out of the SV somehow.
3900 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
3901 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
3902 implemented in terms of this function.
3903 You normally want to use the various wrapper macros instead: see
3904 C<SvPV_force> and C<SvPV_force_nomg>
3906 char* sv_pvn_force_flags(SV* sv, STRLEN* lp, I32 flags)
3913 A private implementation of the C<SvPVutf8_nolen> macro for compilers
3914 which can't cope with complex macro expressions. Always use the macro
3917 char* sv_pvutf8(SV *sv)
3924 A private implementation of the C<SvPVutf8> macro for compilers
3925 which can't cope with complex macro expressions. Always use the macro
3928 char* sv_pvutf8n(SV *sv, STRLEN *len)
3933 =item sv_pvutf8n_force
3935 A private implementation of the C<SvPVutf8_force> macro for compilers
3936 which can't cope with complex macro expressions. Always use the macro
3939 char* sv_pvutf8n_force(SV* sv, STRLEN* lp)
3946 Returns a string describing what the SV is a reference to.
3948 char* sv_reftype(SV* sv, int ob)
3955 Make the first argument a copy of the second, then delete the original.
3956 The target SV physically takes over ownership of the body of the source SV
3957 and inherits its flags; however, the target keeps any magic it owns,
3958 and any magic in the source is discarded.
3959 Note that this is a rather specialist SV copying operation; most of the
3960 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
3962 void sv_replace(SV* sv, SV* nsv)
3967 =item sv_report_used
3969 Dump the contents of all SVs not yet freed. (Debugging aid).
3971 void sv_report_used()
3978 Underlying implementation for the C<reset> Perl function.
3979 Note that the perl-level function is vaguely deprecated.
3981 void sv_reset(char* s, HV* stash)
3988 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
3989 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
3990 push a back-reference to this RV onto the array of backreferences
3991 associated with that magic.
3993 SV* sv_rvweaken(SV *sv)
4000 Copies an integer into the given SV, upgrading first if necessary.
4001 Does not handle 'set' magic. See also C<sv_setiv_mg>.
4003 void sv_setiv(SV* sv, IV num)
4010 Like C<sv_setiv>, but also handles 'set' magic.
4012 void sv_setiv_mg(SV *sv, IV i)
4019 Copies a double into the given SV, upgrading first if necessary.
4020 Does not handle 'set' magic. See also C<sv_setnv_mg>.
4022 void sv_setnv(SV* sv, NV num)
4029 Like C<sv_setnv>, but also handles 'set' magic.
4031 void sv_setnv_mg(SV *sv, NV num)
4038 Copies a string into an SV. The string must be null-terminated. Does not
4039 handle 'set' magic. See C<sv_setpv_mg>.
4041 void sv_setpv(SV* sv, const char* ptr)
4048 Processes its arguments like C<sprintf> and sets an SV to the formatted
4049 output. Does not handle 'set' magic. See C<sv_setpvf_mg>.
4051 void sv_setpvf(SV* sv, const char* pat, ...)
4058 Like C<sv_setpvf>, but also handles 'set' magic.
4060 void sv_setpvf_mg(SV *sv, const char* pat, ...)
4067 Copies an integer into the given SV, also updating its string value.
4068 Does not handle 'set' magic. See C<sv_setpviv_mg>.
4070 void sv_setpviv(SV* sv, IV num)
4077 Like C<sv_setpviv>, but also handles 'set' magic.
4079 void sv_setpviv_mg(SV *sv, IV iv)
4086 Copies a string into an SV. The C<len> parameter indicates the number of
4087 bytes to be copied. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4089 void sv_setpvn(SV* sv, const char* ptr, STRLEN len)
4096 Like C<sv_setpvn>, but also handles 'set' magic.
4098 void sv_setpvn_mg(SV *sv, const char *ptr, STRLEN len)
4105 Like C<sv_setpv>, but also handles 'set' magic.
4107 void sv_setpv_mg(SV *sv, const char *ptr)
4114 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
4115 argument will be upgraded to an RV. That RV will be modified to point to
4116 the new SV. The C<classname> argument indicates the package for the
4117 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4118 will be returned and will have a reference count of 1.
4120 SV* sv_setref_iv(SV* rv, const char* classname, IV iv)
4127 Copies a double into a new SV, optionally blessing the SV. The C<rv>
4128 argument will be upgraded to an RV. That RV will be modified to point to
4129 the new SV. The C<classname> argument indicates the package for the
4130 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4131 will be returned and will have a reference count of 1.
4133 SV* sv_setref_nv(SV* rv, const char* classname, NV nv)
4140 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
4141 argument will be upgraded to an RV. That RV will be modified to point to
4142 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
4143 into the SV. The C<classname> argument indicates the package for the
4144 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4145 will be returned and will have a reference count of 1.
4147 Do not use with other Perl types such as HV, AV, SV, CV, because those
4148 objects will become corrupted by the pointer copy process.
4150 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
4152 SV* sv_setref_pv(SV* rv, const char* classname, void* pv)
4159 Copies a string into a new SV, optionally blessing the SV. The length of the
4160 string must be specified with C<n>. The C<rv> argument will be upgraded to
4161 an RV. That RV will be modified to point to the new SV. The C<classname>
4162 argument indicates the package for the blessing. Set C<classname> to
4163 C<Nullch> to avoid the blessing. The new SV will be returned and will have
4164 a reference count of 1.
4166 Note that C<sv_setref_pv> copies the pointer while this copies the string.
4168 SV* sv_setref_pvn(SV* rv, const char* classname, char* pv, STRLEN n)
4175 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
4176 argument will be upgraded to an RV. That RV will be modified to point to
4177 the new SV. The C<classname> argument indicates the package for the
4178 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4179 will be returned and will have a reference count of 1.
4181 SV* sv_setref_uv(SV* rv, const char* classname, UV uv)
4188 Copies the contents of the source SV C<ssv> into the destination SV
4189 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4190 function if the source SV needs to be reused. Does not handle 'set' magic.
4191 Loosely speaking, it performs a copy-by-value, obliterating any previous
4192 content of the destination.
4194 You probably want to use one of the assortment of wrappers, such as
4195 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4196 C<SvSetMagicSV_nosteal>.
4199 void sv_setsv(SV* dsv, SV* ssv)
4204 =item sv_setsv_flags
4206 Copies the contents of the source SV C<ssv> into the destination SV
4207 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4208 function if the source SV needs to be reused. Does not handle 'set' magic.
4209 Loosely speaking, it performs a copy-by-value, obliterating any previous
4210 content of the destination.
4211 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
4212 C<ssv> if appropriate, else not. C<sv_setsv> and C<sv_setsv_nomg> are
4213 implemented in terms of this function.
4215 You probably want to use one of the assortment of wrappers, such as
4216 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4217 C<SvSetMagicSV_nosteal>.
4219 This is the primary function for copying scalars, and most other
4220 copy-ish functions and macros use this underneath.
4222 void sv_setsv_flags(SV* dsv, SV* ssv, I32 flags)
4229 Like C<sv_setsv>, but also handles 'set' magic.
4231 void sv_setsv_mg(SV *dstr, SV *sstr)
4238 Copies an unsigned integer into the given SV, upgrading first if necessary.
4239 Does not handle 'set' magic. See also C<sv_setuv_mg>.
4241 void sv_setuv(SV* sv, UV num)
4248 Like C<sv_setuv>, but also handles 'set' magic.
4250 void sv_setuv_mg(SV *sv, UV u)
4257 Taint an SV. Use C<SvTAINTED_on> instead.
4258 void sv_taint(SV* sv)
4265 Test an SV for taintedness. Use C<SvTAINTED> instead.
4266 bool sv_tainted(SV* sv)
4273 Returns true if the SV has a true value by Perl's rules.
4274 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
4275 instead use an in-line version.
4284 Removes all magic of type C<type> from an SV.
4286 int sv_unmagic(SV* sv, int type)
4293 Unsets the RV status of the SV, and decrements the reference count of
4294 whatever was being referenced by the RV. This can almost be thought of
4295 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
4296 being zero. See C<SvROK_off>.
4298 void sv_unref(SV* sv)
4303 =item sv_unref_flags
4305 Unsets the RV status of the SV, and decrements the reference count of
4306 whatever was being referenced by the RV. This can almost be thought of
4307 as a reversal of C<newSVrv>. The C<cflags> argument can contain
4308 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
4309 (otherwise the decrementing is conditional on the reference count being
4310 different from one or the reference being a readonly SV).
4313 void sv_unref_flags(SV* sv, U32 flags)
4320 Untaint an SV. Use C<SvTAINTED_off> instead.
4321 void sv_untaint(SV* sv)
4328 Upgrade an SV to a more complex form. Generally adds a new body type to the
4329 SV, then copies across as much information as possible from the old body.
4330 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
4332 bool sv_upgrade(SV* sv, U32 mt)
4339 Tells an SV to use C<ptr> to find its string value. Normally the string is
4340 stored inside the SV but sv_usepvn allows the SV to use an outside string.
4341 The C<ptr> should point to memory that was allocated by C<malloc>. The
4342 string length, C<len>, must be supplied. This function will realloc the
4343 memory pointed to by C<ptr>, so that pointer should not be freed or used by
4344 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
4345 See C<sv_usepvn_mg>.
4347 void sv_usepvn(SV* sv, char* ptr, STRLEN len)
4354 Like C<sv_usepvn>, but also handles 'set' magic.
4356 void sv_usepvn_mg(SV *sv, char *ptr, STRLEN len)
4361 =item sv_utf8_decode
4363 Convert the octets in the PV from UTF-8 to chars. Scan for validity and then
4364 turn off SvUTF8 if needed so that we see characters. Used as a building block
4365 for decode_utf8 in Encode.xs
4367 NOTE: this function is experimental and may change or be
4368 removed without notice.
4370 bool sv_utf8_decode(SV *sv)
4375 =item sv_utf8_downgrade
4377 Attempt to convert the PV of an SV from UTF8-encoded to byte encoding.
4378 This may not be possible if the PV contains non-byte encoding characters;
4379 if this is the case, either returns false or, if C<fail_ok> is not
4382 This is not as a general purpose Unicode to byte encoding interface:
4383 use the Encode extension for that.
4385 NOTE: this function is experimental and may change or be
4386 removed without notice.
4388 bool sv_utf8_downgrade(SV *sv, bool fail_ok)
4393 =item sv_utf8_encode
4395 Convert the PV of an SV to UTF8-encoded, but then turn off the C<SvUTF8>
4396 flag so that it looks like octets again. Used as a building block
4397 for encode_utf8 in Encode.xs
4399 void sv_utf8_encode(SV *sv)
4404 =item sv_utf8_upgrade
4406 Convert the PV of an SV to its UTF8-encoded form.
4407 Forces the SV to string form if it is not already.
4408 Always sets the SvUTF8 flag to avoid future validity checks even
4409 if all the bytes have hibit clear.
4411 This is not as a general purpose byte encoding to Unicode interface:
4412 use the Encode extension for that.
4414 STRLEN sv_utf8_upgrade(SV *sv)
4419 =item sv_utf8_upgrade_flags
4421 Convert the PV of an SV to its UTF8-encoded form.
4422 Forces the SV to string form if it is not already.
4423 Always sets the SvUTF8 flag to avoid future validity checks even
4424 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
4425 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
4426 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
4428 This is not as a general purpose byte encoding to Unicode interface:
4429 use the Encode extension for that.
4431 STRLEN sv_utf8_upgrade_flags(SV *sv, I32 flags)
4438 A private implementation of the C<SvUVx> macro for compilers which can't
4439 cope with complex macro expressions. Always use the macro instead.
4448 Processes its arguments like C<vsprintf> and appends the formatted output
4449 to an SV. Uses an array of SVs if the C style variable argument list is
4450 missing (NULL). When running with taint checks enabled, indicates via
4451 C<maybe_tainted> if results are untrustworthy (often due to the use of
4454 Usually used via one of its frontends C<sv_catpvf> and C<sv_catpvf_mg>.
4456 void sv_vcatpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
4463 Works like C<vcatpvfn> but copies the text into the SV instead of
4466 Usually used via one of its frontends C<sv_setpvf> and C<sv_setpvf_mg>.
4468 void sv_vsetpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
4476 =head1 Unicode Support
4480 =item bytes_from_utf8
4482 Converts a string C<s> of length C<len> from UTF8 into byte encoding.
4483 Unlike <utf8_to_bytes> but like C<bytes_to_utf8>, returns a pointer to
4484 the newly-created string, and updates C<len> to contain the new
4485 length. Returns the original string if no conversion occurs, C<len>
4486 is unchanged. Do nothing if C<is_utf8> points to 0. Sets C<is_utf8> to
4487 0 if C<s> is converted or contains all 7bit characters.
4489 NOTE: this function is experimental and may change or be
4490 removed without notice.
4492 U8* bytes_from_utf8(U8 *s, STRLEN *len, bool *is_utf8)
4495 Found in file utf8.c
4499 Converts a string C<s> of length C<len> from ASCII into UTF8 encoding.
4500 Returns a pointer to the newly-created string, and sets C<len> to
4501 reflect the new length.
4503 NOTE: this function is experimental and may change or be
4504 removed without notice.
4506 U8* bytes_to_utf8(U8 *s, STRLEN *len)
4509 Found in file utf8.c
4513 Return true if the strings s1 and s2 differ case-insensitively, false
4514 if not (if they are equal case-insensitively). If u1 is true, the
4515 string s1 is assumed to be in UTF-8-encoded Unicode. If u2 is true,
4516 the string s2 is assumed to be in UTF-8-encoded Unicode. If u1 or u2
4517 are false, the respective string is assumed to be in native 8-bit
4520 If the pe1 and pe2 are non-NULL, the scanning pointers will be copied
4521 in there (they will point at the beginning of the I<next> character).
4522 If the pointers behind pe1 or pe2 are non-NULL, they are the end
4523 pointers beyond which scanning will not continue under any
4524 circustances. If the byte lengths l1 and l2 are non-zero, s1+l1 and
4525 s2+l2 will be used as goal end pointers that will also stop the scan,
4526 and which qualify towards defining a successful match: all the scans
4527 that define an explicit length must reach their goal pointers for
4528 a match to succeed).
4530 For case-insensitiveness, the "casefolding" of Unicode is used
4531 instead of upper/lowercasing both the characters, see
4532 http://www.unicode.org/unicode/reports/tr21/ (Case Mappings).
4534 I32 ibcmp_utf8(const char* a, char **pe1, UV l1, bool u1, const char* b, char **pe2, UV l2, bool u2)
4537 Found in file utf8.c
4541 Tests if some arbitrary number of bytes begins in a valid UTF-8
4542 character. Note that an INVARIANT (i.e. ASCII) character is a valid UTF-8 character.
4543 The actual number of bytes in the UTF-8 character will be returned if
4544 it is valid, otherwise 0.
4546 STRLEN is_utf8_char(U8 *p)
4549 Found in file utf8.c
4551 =item is_utf8_string
4553 Returns true if first C<len> bytes of the given string form a valid UTF8
4554 string, false otherwise. Note that 'a valid UTF8 string' does not mean
4555 'a string that contains UTF8' because a valid ASCII string is a valid
4558 bool is_utf8_string(U8 *s, STRLEN len)
4561 Found in file utf8.c
4563 =item pv_uni_display
4565 Build to the scalar dsv a displayable version of the string spv,
4566 length len, the displayable version being at most pvlim bytes long
4567 (if longer, the rest is truncated and "..." will be appended).
4569 The flags argument can have UNI_DISPLAY_ISPRINT set to display
4570 isPRINT()able characters as themselves, UNI_DISPLAY_BACKSLASH
4571 to display the \\[nrfta\\] as the backslashed versions (like '\n')
4572 (UNI_DISPLAY_BACKSLASH is preferred over UNI_DISPLAY_ISPRINT for \\).
4573 UNI_DISPLAY_QQ (and its alias UNI_DISPLAY_REGEX) have both
4574 UNI_DISPLAY_BACKSLASH and UNI_DISPLAY_ISPRINT turned on.
4576 The pointer to the PV of the dsv is returned.
4578 char* pv_uni_display(SV *dsv, U8 *spv, STRLEN len, STRLEN pvlim, UV flags)
4581 Found in file utf8.c
4583 =item sv_recode_to_utf8
4585 The encoding is assumed to be an Encode object, on entry the PV
4586 of the sv is assumed to be octets in that encoding, and the sv
4587 will be converted into Unicode (and UTF-8).
4589 If the sv already is UTF-8 (or if it is not POK), or if the encoding
4590 is not a reference, nothing is done to the sv. If the encoding is not
4591 an C<Encode::XS> Encoding object, bad things will happen.
4592 (See F<lib/encoding.pm> and L<Encode>).
4594 The PV of the sv is returned.
4596 char* sv_recode_to_utf8(SV* sv, SV *encoding)
4601 =item sv_uni_display
4603 Build to the scalar dsv a displayable version of the scalar sv,
4604 the displayable version being at most pvlim bytes long
4605 (if longer, the rest is truncated and "..." will be appended).
4607 The flags argument is as in pv_uni_display().
4609 The pointer to the PV of the dsv is returned.
4611 char* sv_uni_display(SV *dsv, SV *ssv, STRLEN pvlim, UV flags)
4614 Found in file utf8.c
4618 The "p" contains the pointer to the UTF-8 string encoding
4619 the character that is being converted.
4621 The "ustrp" is a pointer to the character buffer to put the
4622 conversion result to. The "lenp" is a pointer to the length
4625 The "swashp" is a pointer to the swash to use.
4627 Both the special and normal mappings are stored lib/unicore/To/Foo.pl,
4628 and loaded by SWASHGET, using lib/utf8_heavy.pl. The special (usually,
4629 but not always, a multicharacter mapping), is tried first.
4631 The "special" is a string like "utf8::ToSpecLower", which means the
4632 hash %utf8::ToSpecLower. The access to the hash is through
4633 Perl_to_utf8_case().
4635 The "normal" is a string like "ToLower" which means the swash
4638 UV to_utf8_case(U8 *p, U8* ustrp, STRLEN *lenp, SV **swash, char *normal, char *special)
4641 Found in file utf8.c
4645 Convert the UTF-8 encoded character at p to its foldcase version and
4646 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
4647 that the ustrp needs to be at least UTF8_MAXLEN_FOLD+1 bytes since the
4648 foldcase version may be longer than the original character (up to
4651 The first character of the foldcased version is returned
4652 (but note, as explained above, that there may be more.)
4654 UV to_utf8_fold(U8 *p, U8* ustrp, STRLEN *lenp)
4657 Found in file utf8.c
4661 Convert the UTF-8 encoded character at p to its lowercase version and
4662 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
4663 that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the
4664 lowercase version may be longer than the original character (up to two
4667 The first character of the lowercased version is returned
4668 (but note, as explained above, that there may be more.)
4670 UV to_utf8_lower(U8 *p, U8* ustrp, STRLEN *lenp)
4673 Found in file utf8.c
4677 Convert the UTF-8 encoded character at p to its titlecase version and
4678 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
4679 that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the
4680 titlecase version may be longer than the original character (up to two
4683 The first character of the titlecased version is returned
4684 (but note, as explained above, that there may be more.)
4686 UV to_utf8_title(U8 *p, U8* ustrp, STRLEN *lenp)
4689 Found in file utf8.c
4693 Convert the UTF-8 encoded character at p to its uppercase version and
4694 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
4695 that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the
4696 uppercase version may be longer than the original character (up to two
4699 The first character of the uppercased version is returned
4700 (but note, as explained above, that there may be more.)
4702 UV to_utf8_upper(U8 *p, U8* ustrp, STRLEN *lenp)
4705 Found in file utf8.c
4707 =item utf8n_to_uvchr
4709 Returns the native character value of the first character in the string C<s>
4710 which is assumed to be in UTF8 encoding; C<retlen> will be set to the
4711 length, in bytes, of that character.
4713 Allows length and flags to be passed to low level routine.
4715 UV utf8n_to_uvchr(U8 *s, STRLEN curlen, STRLEN* retlen, U32 flags)
4718 Found in file utf8.c
4720 =item utf8n_to_uvuni
4722 Bottom level UTF-8 decode routine.
4723 Returns the unicode code point value of the first character in the string C<s>
4724 which is assumed to be in UTF8 encoding and no longer than C<curlen>;
4725 C<retlen> will be set to the length, in bytes, of that character.
4727 If C<s> does not point to a well-formed UTF8 character, the behaviour
4728 is dependent on the value of C<flags>: if it contains UTF8_CHECK_ONLY,
4729 it is assumed that the caller will raise a warning, and this function
4730 will silently just set C<retlen> to C<-1> and return zero. If the
4731 C<flags> does not contain UTF8_CHECK_ONLY, warnings about
4732 malformations will be given, C<retlen> will be set to the expected
4733 length of the UTF-8 character in bytes, and zero will be returned.
4735 The C<flags> can also contain various flags to allow deviations from
4736 the strict UTF-8 encoding (see F<utf8.h>).
4738 Most code should use utf8_to_uvchr() rather than call this directly.
4740 UV utf8n_to_uvuni(U8 *s, STRLEN curlen, STRLEN* retlen, U32 flags)
4743 Found in file utf8.c
4747 Returns the number of UTF8 characters between the UTF-8 pointers C<a>
4750 WARNING: use only if you *know* that the pointers point inside the
4753 IV utf8_distance(U8 *a, U8 *b)
4756 Found in file utf8.c
4760 Return the UTF-8 pointer C<s> displaced by C<off> characters, either
4761 forward or backward.
4763 WARNING: do not use the following unless you *know* C<off> is within
4764 the UTF-8 data pointed to by C<s> *and* that on entry C<s> is aligned
4765 on the first byte of character or just after the last byte of a character.
4767 U8* utf8_hop(U8 *s, I32 off)
4770 Found in file utf8.c
4774 Return the length of the UTF-8 char encoded string C<s> in characters.
4775 Stops at C<e> (inclusive). If C<e E<lt> s> or if the scan would end
4776 up past C<e>, croaks.
4778 STRLEN utf8_length(U8* s, U8 *e)
4781 Found in file utf8.c
4785 Converts a string C<s> of length C<len> from UTF8 into byte encoding.
4786 Unlike C<bytes_to_utf8>, this over-writes the original string, and
4787 updates len to contain the new length.
4788 Returns zero on failure, setting C<len> to -1.
4790 NOTE: this function is experimental and may change or be
4791 removed without notice.
4793 U8* utf8_to_bytes(U8 *s, STRLEN *len)
4796 Found in file utf8.c
4800 Returns the native character value of the first character in the string C<s>
4801 which is assumed to be in UTF8 encoding; C<retlen> will be set to the
4802 length, in bytes, of that character.
4804 If C<s> does not point to a well-formed UTF8 character, zero is
4805 returned and retlen is set, if possible, to -1.
4807 UV utf8_to_uvchr(U8 *s, STRLEN* retlen)
4810 Found in file utf8.c
4814 Returns the Unicode code point of the first character in the string C<s>
4815 which is assumed to be in UTF8 encoding; C<retlen> will be set to the
4816 length, in bytes, of that character.
4818 This function should only be used when returned UV is considered
4819 an index into the Unicode semantic tables (e.g. swashes).
4821 If C<s> does not point to a well-formed UTF8 character, zero is
4822 returned and retlen is set, if possible, to -1.
4824 UV utf8_to_uvuni(U8 *s, STRLEN* retlen)
4827 Found in file utf8.c
4831 Adds the UTF8 representation of the Native codepoint C<uv> to the end
4832 of the string C<d>; C<d> should be have at least C<UTF8_MAXLEN+1> free
4833 bytes available. The return value is the pointer to the byte after the
4834 end of the new character. In other words,
4836 d = uvchr_to_utf8(d, uv);
4838 is the recommended wide native character-aware way of saying
4842 U8* uvchr_to_utf8(U8 *d, UV uv)
4845 Found in file utf8.c
4847 =item uvuni_to_utf8_flags
4849 Adds the UTF8 representation of the Unicode codepoint C<uv> to the end
4850 of the string C<d>; C<d> should be have at least C<UTF8_MAXLEN+1> free
4851 bytes available. The return value is the pointer to the byte after the
4852 end of the new character. In other words,
4854 d = uvuni_to_utf8_flags(d, uv, flags);
4858 d = uvuni_to_utf8(d, uv);
4860 (which is equivalent to)
4862 d = uvuni_to_utf8_flags(d, uv, 0);
4864 is the recommended Unicode-aware way of saying
4868 U8* uvuni_to_utf8_flags(U8 *d, UV uv, UV flags)
4871 Found in file utf8.c
4876 =head1 Variables created by C<xsubpp> and C<xsubpp> internal functions
4882 Variable which is setup by C<xsubpp> to indicate the stack base offset,
4883 used by the C<ST>, C<XSprePUSH> and C<XSRETURN> macros. The C<dMARK> macro
4884 must be called prior to setup the C<MARK> variable.
4889 Found in file XSUB.h
4893 Variable which is setup by C<xsubpp> to indicate the
4894 class name for a C++ XS constructor. This is always a C<char*>. See C<THIS>.
4899 Found in file XSUB.h
4903 Sets up the C<ax> variable.
4904 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
4909 Found in file XSUB.h
4913 Sets up the C<items> variable.
4914 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
4919 Found in file XSUB.h
4923 Sets up stack and mark pointers for an XSUB, calling dSP and dMARK.
4924 Sets up the C<ax> and C<items> variables by calling C<dAX> and C<dITEMS>.
4925 This is usually handled automatically by C<xsubpp>.
4930 Found in file XSUB.h
4934 Sets up the C<ix> variable for an XSUB which has aliases. This is usually
4935 handled automatically by C<xsubpp>.
4940 Found in file XSUB.h
4944 Variable which is setup by C<xsubpp> to indicate the number of
4945 items on the stack. See L<perlxs/"Variable-length Parameter Lists">.
4950 Found in file XSUB.h
4954 Variable which is setup by C<xsubpp> to indicate which of an
4955 XSUB's aliases was used to invoke it. See L<perlxs/"The ALIAS: Keyword">.
4960 Found in file XSUB.h
4964 Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
4968 Found in file XSUB.h
4972 Variable which is setup by C<xsubpp> to hold the return value for an
4973 XSUB. This is always the proper type for the XSUB. See
4974 L<perlxs/"The RETVAL Variable">.
4979 Found in file XSUB.h
4983 Used to access elements on the XSUB's stack.
4988 Found in file XSUB.h
4992 Variable which is setup by C<xsubpp> to designate the object in a C++
4993 XSUB. This is always the proper type for the C++ object. See C<CLASS> and
4994 L<perlxs/"Using XS With C++">.
4999 Found in file XSUB.h
5003 Macro to declare an XSUB and its C parameter list. This is handled by
5007 Found in file XSUB.h
5009 =item XSRETURN_EMPTY
5011 Return an empty list from an XSUB immediately.
5017 Found in file XSUB.h
5021 The version identifier for an XS module. This is usually
5022 handled automatically by C<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>.
5025 Found in file XSUB.h
5027 =item XS_VERSION_BOOTCHECK
5029 Macro to verify that a PM module's $VERSION variable matches the XS
5030 module's C<XS_VERSION> variable. This is usually handled automatically by
5031 C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">.
5033 XS_VERSION_BOOTCHECK;
5036 Found in file XSUB.h
5041 =head1 Warning and Dieing
5047 This is the XSUB-writer's interface to Perl's C<die> function.
5048 Normally use this function the same way you use the C C<printf>
5049 function. See C<warn>.
5051 If you want to throw an exception object, assign the object to
5052 C<$@> and then pass C<Nullch> to croak():
5054 errsv = get_sv("@", TRUE);
5055 sv_setsv(errsv, exception_object);
5058 void croak(const char* pat, ...)
5061 Found in file util.c
5065 This is the XSUB-writer's interface to Perl's C<warn> function. Use this
5066 function the same way you use the C C<printf> function. See
5069 void warn(const char* pat, ...)
5072 Found in file util.c
5079 Until May 1997, this document was maintained by Jeff Okamoto
5080 <okamoto@corp.hp.com>. It is now maintained as part of Perl itself.
5082 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
5083 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
5084 Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
5085 Stephen McCamant, and Gurusamy Sarathy.
5087 API Listing originally by Dean Roehrich <roehrich@cray.com>.
5089 Updated to be autogenerated from comments in the source by Benjamin Stuhl.
5093 perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
projects / p5sagit/p5-mst-13.2.git / blob