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)
811 Returns a pointer to the stash for a specified package. C<name> should
812 be a valid UTF-8 string. If C<create> is set then the package will be
813 created if it does not already exist. If C<create> is not set and the
814 package does not exist then NULL is returned.
816 HV* gv_stashpv(const char* name, I32 create)
823 Returns a pointer to the stash for a specified package, which must be a
824 valid UTF-8 string. See C<gv_stashpv>.
826 HV* gv_stashsv(SV* sv, I32 create)
840 This flag, used in the length slot of hash entries and magic structures,
841 specifies the structure contains an C<SV*> pointer where a C<char*> pointer
842 is to be expected. (For information only--not to be used).
850 Null character pointer.
852 Found in file handy.h
859 Found in file handy.h
864 =head1 Hash Manipulation Functions
870 Returns the HV of the specified Perl hash. If C<create> is set and the
871 Perl variable does not exist then it will be created. If C<create> is not
872 set and the variable does not exist then NULL is returned.
874 NOTE: the perl_ form of this function is deprecated.
876 HV* get_hv(const char* name, I32 create)
883 Returns the computed hash stored in the hash entry.
892 Returns the actual pointer stored in the key slot of the hash entry. The
893 pointer may be either C<char*> or C<SV*>, depending on the value of
894 C<HeKLEN()>. Can be assigned to. The C<HePV()> or C<HeSVKEY()> macros are
895 usually preferable for finding the value of a key.
904 If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry
905 holds an C<SV*> key. Otherwise, holds the actual length of the key. Can
906 be assigned to. The C<HePV()> macro is usually preferable for finding key
909 STRLEN HeKLEN(HE* he)
916 Returns the key slot of the hash entry as a C<char*> value, doing any
917 necessary dereferencing of possibly C<SV*> keys. The length of the string
918 is placed in C<len> (this is a macro, so do I<not> use C<&len>). If you do
919 not care about what the length of the key is, you may use the global
920 variable C<PL_na>, though this is rather less efficient than using a local
921 variable. Remember though, that hash keys in perl are free to contain
922 embedded nulls, so using C<strlen()> or similar is not a good way to find
923 the length of hash keys. This is very similar to the C<SvPV()> macro
924 described elsewhere in this document.
926 char* HePV(HE* he, STRLEN len)
933 Returns the key as an C<SV*>, or C<Nullsv> if the hash entry does not
934 contain an C<SV*> key.
943 Returns the key as an C<SV*>. Will create and return a temporary mortal
944 C<SV*> if the hash entry contains only a C<char*> key.
946 SV* HeSVKEY_force(HE* he)
953 Sets the key to a given C<SV*>, taking care to set the appropriate flags to
954 indicate the presence of an C<SV*> key, and returns the same
957 SV* HeSVKEY_set(HE* he, SV* sv)
964 Returns the value slot (type C<SV*>) stored in the hash entry.
973 Returns the package name of a stash. See C<SvSTASH>, C<CvSTASH>.
975 char* HvNAME(HV* stash)
982 Clears a hash, making it empty.
984 void hv_clear(HV* tb)
991 Deletes a key/value pair in the hash. The value SV is removed from the
992 hash and returned to the caller. The C<klen> is the length of the key.
993 The C<flags> value will normally be zero; if set to G_DISCARD then NULL
996 SV* hv_delete(HV* tb, const char* key, I32 klen, I32 flags)
1003 Deletes a key/value pair in the hash. The value SV is removed from the
1004 hash and returned to the caller. The C<flags> value will normally be zero;
1005 if set to G_DISCARD then NULL will be returned. C<hash> can be a valid
1006 precomputed hash value, or 0 to ask for it to be computed.
1008 SV* hv_delete_ent(HV* tb, SV* key, I32 flags, U32 hash)
1015 Returns a boolean indicating whether the specified hash key exists. The
1016 C<klen> is the length of the key.
1018 bool hv_exists(HV* tb, const char* key, I32 klen)
1025 Returns a boolean indicating whether the specified hash key exists. C<hash>
1026 can be a valid precomputed hash value, or 0 to ask for it to be
1029 bool hv_exists_ent(HV* tb, SV* key, U32 hash)
1036 Returns the SV which corresponds to the specified key in the hash. The
1037 C<klen> is the length of the key. If C<lval> is set then the fetch will be
1038 part of a store. Check that the return value is non-null before
1039 dereferencing it to an C<SV*>.
1041 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1042 information on how to use this function on tied hashes.
1044 SV** hv_fetch(HV* tb, const char* key, I32 klen, I32 lval)
1051 Returns the hash entry which corresponds to the specified key in the hash.
1052 C<hash> must be a valid precomputed hash number for the given C<key>, or 0
1053 if you want the function to compute it. IF C<lval> is set then the fetch
1054 will be part of a store. Make sure the return value is non-null before
1055 accessing it. The return value when C<tb> is a tied hash is a pointer to a
1056 static location, so be sure to make a copy of the structure if you need to
1059 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1060 information on how to use this function on tied hashes.
1062 HE* hv_fetch_ent(HV* tb, SV* key, I32 lval, U32 hash)
1069 Prepares a starting point to traverse a hash table. Returns the number of
1070 keys in the hash (i.e. the same as C<HvKEYS(tb)>). The return value is
1071 currently only meaningful for hashes without tie magic.
1073 NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
1074 hash buckets that happen to be in use. If you still need that esoteric
1075 value, you can get it through the macro C<HvFILL(tb)>.
1077 I32 hv_iterinit(HV* tb)
1084 Returns the key from the current position of the hash iterator. See
1087 char* hv_iterkey(HE* entry, I32* retlen)
1094 Returns the key as an C<SV*> from the current position of the hash
1095 iterator. The return value will always be a mortal copy of the key. Also
1098 SV* hv_iterkeysv(HE* entry)
1105 Returns entries from a hash iterator. See C<hv_iterinit>.
1107 HE* hv_iternext(HV* tb)
1114 Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
1117 SV* hv_iternextsv(HV* hv, char** key, I32* retlen)
1124 Returns the value from the current position of the hash iterator. See
1127 SV* hv_iterval(HV* tb, HE* entry)
1134 Adds magic to a hash. See C<sv_magic>.
1136 void hv_magic(HV* hv, GV* gv, int how)
1143 Stores an SV in a hash. The hash key is specified as C<key> and C<klen> is
1144 the length of the key. The C<hash> parameter is the precomputed hash
1145 value; if it is zero then Perl will compute it. The return value will be
1146 NULL if the operation failed or if the value did not need to be actually
1147 stored within the hash (as in the case of tied hashes). Otherwise it can
1148 be dereferenced to get the original C<SV*>. Note that the caller is
1149 responsible for suitably incrementing the reference count of C<val> before
1150 the call, and decrementing it if the function returned NULL.
1152 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1153 information on how to use this function on tied hashes.
1155 SV** hv_store(HV* tb, const char* key, I32 klen, SV* val, U32 hash)
1162 Stores C<val> in a hash. The hash key is specified as C<key>. The C<hash>
1163 parameter is the precomputed hash value; if it is zero then Perl will
1164 compute it. The return value is the new hash entry so created. It will be
1165 NULL if the operation failed or if the value did not need to be actually
1166 stored within the hash (as in the case of tied hashes). Otherwise the
1167 contents of the return value can be accessed using the C<He?> macros
1168 described here. Note that the caller is responsible for suitably
1169 incrementing the reference count of C<val> before the call, and
1170 decrementing it if the function returned NULL.
1172 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1173 information on how to use this function on tied hashes.
1175 HE* hv_store_ent(HV* tb, SV* key, SV* val, U32 hash)
1184 void hv_undef(HV* tb)
1191 Creates a new HV. The reference count is set to 1.
1209 =head1 Magical Functions
1215 Clear something magical that the SV represents. See C<sv_magic>.
1217 int mg_clear(SV* sv)
1224 Copies the magic from one SV to another. See C<sv_magic>.
1226 int mg_copy(SV* sv, SV* nsv, const char* key, I32 klen)
1233 Finds the magic pointer for type matching the SV. See C<sv_magic>.
1235 MAGIC* mg_find(SV* sv, int type)
1242 Free any magic storage used by the SV. See C<sv_magic>.
1251 Do magic after a value is retrieved from the SV. See C<sv_magic>.
1260 Report on the SV's length. See C<sv_magic>.
1262 U32 mg_length(SV* sv)
1269 Turns on the magical status of an SV. See C<sv_magic>.
1271 void mg_magical(SV* sv)
1278 Do magic after a value is assigned to the SV. See C<sv_magic>.
1287 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
1288 argument more than once.
1290 void SvGETMAGIC(SV* sv)
1297 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
1307 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
1308 argument more than once.
1310 void SvSETMAGIC(SV* sv)
1317 Like C<SvSetSV>, but does any set magic required afterwards.
1319 void SvSetMagicSV(SV* dsb, SV* ssv)
1324 =item SvSetMagicSV_nosteal
1326 Like C<SvSetMagicSV>, but does any set magic required afterwards.
1328 void SvSetMagicSV_nosteal(SV* dsv, SV* ssv)
1335 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
1338 void SvSetSV(SV* dsb, SV* ssv)
1343 =item SvSetSV_nosteal
1345 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
1346 ssv. May evaluate arguments more than once.
1348 void SvSetSV_nosteal(SV* dsv, SV* ssv)
1355 Arranges for sv to be shared between threads if a suitable module
1358 void SvSHARE(SV* sv)
1366 =head1 Memory Management
1372 The XSUB-writer's interface to the C C<memcpy> function. The C<src> is the
1373 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1374 the type. May fail on overlapping copies. See also C<Move>.
1376 void Copy(void* src, void* dest, int nitems, type)
1379 Found in file handy.h
1383 The XSUB-writer's interface to the C C<memmove> function. The C<src> is the
1384 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1385 the type. Can do overlapping moves. See also C<Copy>.
1387 void Move(void* src, void* dest, int nitems, type)
1390 Found in file handy.h
1394 The XSUB-writer's interface to the C C<malloc> function.
1396 void New(int id, void* ptr, int nitems, type)
1399 Found in file handy.h
1403 The XSUB-writer's interface to the C C<malloc> function, with
1406 void Newc(int id, void* ptr, int nitems, type, cast)
1409 Found in file handy.h
1413 Creates a new SV. A non-zero C<len> parameter indicates the number of
1414 bytes of preallocated string space the SV should have. An extra byte for a
1415 tailing NUL is also reserved. (SvPOK is not set for the SV even if string
1416 space is allocated.) The reference count for the new SV is set to 1.
1417 C<id> is an integer id between 0 and 1299 (used to identify leaks).
1420 SV* NEWSV(int id, STRLEN len)
1423 Found in file handy.h
1427 The XSUB-writer's interface to the C C<malloc> function. The allocated
1428 memory is zeroed with C<memzero>.
1430 void Newz(int id, void* ptr, int nitems, type)
1433 Found in file handy.h
1437 The XSUB-writer's interface to the C C<realloc> function.
1439 void Renew(void* ptr, int nitems, type)
1442 Found in file handy.h
1446 The XSUB-writer's interface to the C C<realloc> function, with
1449 void Renewc(void* ptr, int nitems, type, cast)
1452 Found in file handy.h
1456 The XSUB-writer's interface to the C C<free> function.
1458 void Safefree(void* ptr)
1461 Found in file handy.h
1465 Copy a string to a safe spot. This does not use an SV.
1467 char* savepv(const char* sv)
1470 Found in file util.c
1474 Copy a string to a safe spot. The C<len> indicates number of bytes to
1475 copy. If pointer is NULL allocate space for a string of size specified.
1476 This does not use an SV.
1478 char* savepvn(const char* sv, I32 len)
1481 Found in file util.c
1485 Copy a string to a safe spot in memory shared between threads.
1486 This does not use an SV.
1488 char* savesharedpv(const char* sv)
1491 Found in file util.c
1495 This is an architecture-independent macro to copy one structure to another.
1497 void StructCopy(type src, type dest, type)
1500 Found in file handy.h
1504 The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the
1505 destination, C<nitems> is the number of items, and C<type> is the type.
1507 void Zero(void* dest, int nitems, type)
1510 Found in file handy.h
1515 =head1 Miscellaneous Functions
1521 Analyses the string in order to make fast searches on it using fbm_instr()
1522 -- the Boyer-Moore algorithm.
1524 void fbm_compile(SV* sv, U32 flags)
1527 Found in file util.c
1531 Returns the location of the SV in the string delimited by C<str> and
1532 C<strend>. It returns C<Nullch> if the string can't be found. The C<sv>
1533 does not have to be fbm_compiled, but the search will not be as fast
1536 char* fbm_instr(unsigned char* big, unsigned char* bigend, SV* littlesv, U32 flags)
1539 Found in file util.c
1543 Takes a sprintf-style format pattern and conventional
1544 (non-SV) arguments and returns the formatted string.
1546 (char *) Perl_form(pTHX_ const char* pat, ...)
1548 can be used any place a string (char *) is required:
1550 char * s = Perl_form("%d.%d",major,minor);
1552 Uses a single private buffer so if you want to format several strings you
1553 must explicitly copy the earlier strings away (and free the copies when you
1556 char* form(const char* pat, ...)
1559 Found in file util.c
1563 Fill the sv with current working directory
1565 int getcwd_sv(SV* sv)
1568 Found in file util.c
1572 Test two strings to see if they are equal. Returns true or false.
1574 bool strEQ(char* s1, char* s2)
1577 Found in file handy.h
1581 Test two strings to see if the first, C<s1>, is greater than or equal to
1582 the second, C<s2>. Returns true or false.
1584 bool strGE(char* s1, char* s2)
1587 Found in file handy.h
1591 Test two strings to see if the first, C<s1>, is greater than the second,
1592 C<s2>. Returns true or false.
1594 bool strGT(char* s1, char* s2)
1597 Found in file handy.h
1601 Test two strings to see if the first, C<s1>, is less than or equal to the
1602 second, C<s2>. Returns true or false.
1604 bool strLE(char* s1, char* s2)
1607 Found in file handy.h
1611 Test two strings to see if the first, C<s1>, is less than the second,
1612 C<s2>. Returns true or false.
1614 bool strLT(char* s1, char* s2)
1617 Found in file handy.h
1621 Test two strings to see if they are different. Returns true or
1624 bool strNE(char* s1, char* s2)
1627 Found in file handy.h
1631 Test two strings to see if they are equal. The C<len> parameter indicates
1632 the number of bytes to compare. Returns true or false. (A wrapper for
1635 bool strnEQ(char* s1, char* s2, STRLEN len)
1638 Found in file handy.h
1642 Test two strings to see if they are different. The C<len> parameter
1643 indicates the number of bytes to compare. Returns true or false. (A
1644 wrapper for C<strncmp>).
1646 bool strnNE(char* s1, char* s2, STRLEN len)
1649 Found in file handy.h
1654 =head1 Numeric functions
1660 converts a string representing a binary number to numeric form.
1662 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
1663 conversion flags, and I<result> should be NULL or a pointer to an NV.
1664 The scan stops at the end of the string, or the first invalid character.
1665 On return I<*len> is set to the length scanned string, and I<*flags> gives
1668 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
1669 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_bin>
1670 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
1671 and writes the value to I<*result> (or the value is discarded if I<result>
1674 The hex number may optionally be prefixed with "0b" or "b" unless
1675 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
1676 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the binary
1677 number may use '_' characters to separate digits.
1679 UV grok_bin(char* start, STRLEN* len, I32* flags, NV *result)
1682 Found in file numeric.c
1686 converts a string representing a hex number to numeric form.
1688 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
1689 conversion flags, and I<result> should be NULL or a pointer to an NV.
1690 The scan stops at the end of the string, or the first non-hex-digit character.
1691 On return I<*len> is set to the length scanned string, and I<*flags> gives
1694 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
1695 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_hex>
1696 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
1697 and writes the value to I<*result> (or the value is discarded if I<result>
1700 The hex number may optionally be prefixed with "0x" or "x" unless
1701 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
1702 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the hex
1703 number may use '_' characters to separate digits.
1705 UV grok_hex(char* start, STRLEN* len, I32* flags, NV *result)
1708 Found in file numeric.c
1712 Recognise (or not) a number. The type of the number is returned
1713 (0 if unrecognised), otherwise it is a bit-ORed combination of
1714 IS_NUMBER_IN_UV, IS_NUMBER_GREATER_THAN_UV_MAX, IS_NUMBER_NOT_INT,
1715 IS_NUMBER_NEG, IS_NUMBER_INFINITY, IS_NUMBER_NAN (defined in perl.h).
1717 If the value of the number can fit an in UV, it is returned in the *valuep
1718 IS_NUMBER_IN_UV will be set to indicate that *valuep is valid, IS_NUMBER_IN_UV
1719 will never be set unless *valuep is valid, but *valuep may have been assigned
1720 to during processing even though IS_NUMBER_IN_UV is not set on return.
1721 If valuep is NULL, IS_NUMBER_IN_UV will be set for the same cases as when
1722 valuep is non-NULL, but no actual assignment (or SEGV) will occur.
1724 IS_NUMBER_NOT_INT will be set with IS_NUMBER_IN_UV if trailing decimals were
1725 seen (in which case *valuep gives the true value truncated to an integer), and
1726 IS_NUMBER_NEG if the number is negative (in which case *valuep holds the
1727 absolute value). IS_NUMBER_IN_UV is not set if e notation was used or the
1728 number is larger than a UV.
1730 int grok_number(const char *pv, STRLEN len, UV *valuep)
1733 Found in file numeric.c
1735 =item grok_numeric_radix
1737 Scan and skip for a numeric decimal separator (radix).
1739 bool grok_numeric_radix(const char **sp, const char *send)
1742 Found in file numeric.c
1747 UV grok_oct(char* start, STRLEN* len, I32* flags, NV *result)
1750 Found in file numeric.c
1754 For backwards compatibility. Use C<grok_bin> instead.
1756 NV scan_bin(char* start, STRLEN len, STRLEN* retlen)
1759 Found in file numeric.c
1763 For backwards compatibility. Use C<grok_hex> instead.
1765 NV scan_hex(char* start, STRLEN len, STRLEN* retlen)
1768 Found in file numeric.c
1772 For backwards compatibility. Use C<grok_oct> instead.
1774 NV scan_oct(char* start, STRLEN len, STRLEN* retlen)
1777 Found in file numeric.c
1782 =head1 Optree Manipulation Functions
1788 If C<cv> is a constant sub eligible for inlining. returns the constant
1789 value returned by the sub. Otherwise, returns NULL.
1791 Constant subs can be created with C<newCONSTSUB> or as described in
1792 L<perlsub/"Constant Functions">.
1794 SV* cv_const_sv(CV* cv)
1801 Creates a constant sub equivalent to Perl C<sub FOO () { 123 }> which is
1802 eligible for inlining at compile-time.
1804 CV* newCONSTSUB(HV* stash, char* name, SV* sv)
1811 Used by C<xsubpp> to hook up XSUBs as Perl subs.
1819 =head1 Stack Manipulation Macros
1825 Declare a stack marker variable, C<mark>, for the XSUB. See C<MARK> and
1835 Saves the original stack mark for the XSUB. See C<ORIGMARK>.
1844 Declares a local copy of perl's stack pointer for the XSUB, available via
1845 the C<SP> macro. See C<SP>.
1854 Used to extend the argument stack for an XSUB's return values. Once
1855 used, guarantees that there is room for at least C<nitems> to be pushed
1858 void EXTEND(SP, int nitems)
1865 Stack marker variable for the XSUB. See C<dMARK>.
1872 The original stack mark for the XSUB. See C<dORIGMARK>.
1879 Pops an integer off the stack.
1888 Pops a long off the stack.
1897 Pops a double off the stack.
1906 Pops a string off the stack. Deprecated. New code should provide
1907 a STRLEN n_a and use POPpx.
1916 Pops a string off the stack which must consist of bytes i.e. characters < 256.
1917 Requires a variable STRLEN n_a in scope.
1926 Pops a string off the stack.
1927 Requires a variable STRLEN n_a in scope.
1936 Pops an SV off the stack.
1945 Push an integer onto the stack. The stack must have room for this element.
1946 Handles 'set' magic. See C<XPUSHi>.
1955 Opening bracket for arguments on a callback. See C<PUTBACK> and
1965 Push a double onto the stack. The stack must have room for this element.
1966 Handles 'set' magic. See C<XPUSHn>.
1975 Push a string onto the stack. The stack must have room for this element.
1976 The C<len> indicates the length of the string. Handles 'set' magic. See
1979 void PUSHp(char* str, STRLEN len)
1986 Push an SV onto the stack. The stack must have room for this element.
1987 Does not handle 'set' magic. See C<XPUSHs>.
1996 Push an unsigned integer onto the stack. The stack must have room for this
1997 element. See C<XPUSHu>.
2006 Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
2007 See C<PUSHMARK> and L<perlcall> for other uses.
2016 Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and
2024 Refetch the stack pointer. Used after a callback. See L<perlcall>.
2033 Push an integer onto the stack, extending the stack if necessary. Handles
2034 'set' magic. See C<PUSHi>.
2043 Push a double onto the stack, extending the stack if necessary. Handles
2044 'set' magic. See C<PUSHn>.
2053 Push a string onto the stack, extending the stack if necessary. The C<len>
2054 indicates the length of the string. Handles 'set' magic. See
2057 void XPUSHp(char* str, STRLEN len)
2064 Push an SV onto the stack, extending the stack if necessary. Does not
2065 handle 'set' magic. See C<PUSHs>.
2074 Push an unsigned integer onto the stack, extending the stack if necessary.
2084 Return from XSUB, indicating number of items on the stack. This is usually
2085 handled by C<xsubpp>.
2087 void XSRETURN(int nitems)
2090 Found in file XSUB.h
2094 Return an integer from an XSUB immediately. Uses C<XST_mIV>.
2096 void XSRETURN_IV(IV iv)
2099 Found in file XSUB.h
2103 Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
2108 Found in file XSUB.h
2112 Return a double from an XSUB immediately. Uses C<XST_mNV>.
2114 void XSRETURN_NV(NV nv)
2117 Found in file XSUB.h
2121 Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
2123 void XSRETURN_PV(char* str)
2126 Found in file XSUB.h
2128 =item XSRETURN_UNDEF
2130 Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
2135 Found in file XSUB.h
2139 Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
2144 Found in file XSUB.h
2148 Place an integer into the specified position C<pos> on the stack. The
2149 value is stored in a new mortal SV.
2151 void XST_mIV(int pos, IV iv)
2154 Found in file XSUB.h
2158 Place C<&PL_sv_no> into the specified position C<pos> on the
2161 void XST_mNO(int pos)
2164 Found in file XSUB.h
2168 Place a double into the specified position C<pos> on the stack. The value
2169 is stored in a new mortal SV.
2171 void XST_mNV(int pos, NV nv)
2174 Found in file XSUB.h
2178 Place a copy of a string into the specified position C<pos> on the stack.
2179 The value is stored in a new mortal SV.
2181 void XST_mPV(int pos, char* str)
2184 Found in file XSUB.h
2188 Place C<&PL_sv_undef> into the specified position C<pos> on the
2191 void XST_mUNDEF(int pos)
2194 Found in file XSUB.h
2198 Place C<&PL_sv_yes> into the specified position C<pos> on the
2201 void XST_mYES(int pos)
2204 Found in file XSUB.h
2215 An enum of flags for Perl types. These are found in the file B<sv.h>
2216 in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
2223 Integer type flag for scalars. See C<svtype>.
2230 Double type flag for scalars. See C<svtype>.
2237 Pointer type flag for scalars. See C<svtype>.
2244 Type flag for arrays. See C<svtype>.
2251 Type flag for code refs. See C<svtype>.
2258 Type flag for hashes. See C<svtype>.
2265 Type flag for blessed scalars. See C<svtype>.
2273 =head1 SV Manipulation Functions
2279 Returns the SV of the specified Perl scalar. If C<create> is set and the
2280 Perl variable does not exist then it will be created. If C<create> is not
2281 set and the variable does not exist then NULL is returned.
2283 NOTE: the perl_ form of this function is deprecated.
2285 SV* get_sv(const char* name, I32 create)
2288 Found in file perl.c
2290 =item looks_like_number
2292 Test if the content of an SV looks like a number (or is a number).
2293 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
2294 non-numeric warning), even if your atof() doesn't grok them.
2296 I32 looks_like_number(SV* sv)
2303 Creates an RV wrapper for an SV. The reference count for the original SV is
2306 SV* newRV_inc(SV* sv)
2313 Creates an RV wrapper for an SV. The reference count for the original
2314 SV is B<not> incremented.
2316 SV* newRV_noinc(SV *sv)
2323 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
2324 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
2327 SV* newSV(STRLEN len)
2334 Creates a new SV and copies an integer into it. The reference count for the
2344 Creates a new SV and copies a floating point value into it.
2345 The reference count for the SV is set to 1.
2354 Creates a new SV and copies a string into it. The reference count for the
2355 SV is set to 1. If C<len> is zero, Perl will compute the length using
2356 strlen(). For efficiency, consider using C<newSVpvn> instead.
2358 SV* newSVpv(const char* s, STRLEN len)
2365 Creates a new SV and initializes it with the string formatted like
2368 SV* newSVpvf(const char* pat, ...)
2375 Creates a new SV and copies a string into it. The reference count for the
2376 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
2377 string. You are responsible for ensuring that the source string is at least
2380 SV* newSVpvn(const char* s, STRLEN len)
2385 =item newSVpvn_share
2387 Creates a new SV with its SvPVX pointing to a shared string in the string
2388 table. If the string does not already exist in the table, it is created
2389 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
2390 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
2391 otherwise the hash is computed. The idea here is that as the string table
2392 is used for shared hash keys these strings will have SvPVX == HeKEY and
2393 hash lookup will avoid string compare.
2395 SV* newSVpvn_share(const char* s, I32 len, U32 hash)
2402 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
2403 it will be upgraded to one. If C<classname> is non-null then the new SV will
2404 be blessed in the specified package. The new SV is returned and its
2405 reference count is 1.
2407 SV* newSVrv(SV* rv, const char* classname)
2414 Creates a new SV which is an exact duplicate of the original SV.
2417 SV* newSVsv(SV* old)
2424 Creates a new SV and copies an unsigned integer into it.
2425 The reference count for the SV is set to 1.
2434 Returns a pointer to the next character after the parsed
2435 vstring, as well as updating the passed in sv.
2437 Function must be called like
2440 s = new_vstring(s,sv);
2442 The sv must already be large enough to store the vstring
2445 char* new_vstring(char *vstr, SV *sv)
2448 Found in file util.c
2452 Returns the length of the string which is in the SV. See C<SvLEN>.
2454 STRLEN SvCUR(SV* sv)
2461 Set the length of the string which is in the SV. See C<SvCUR>.
2463 void SvCUR_set(SV* sv, STRLEN len)
2470 Returns a pointer to the last character in the string which is in the SV.
2471 See C<SvCUR>. Access the character as *(SvEND(sv)).
2480 Expands the character buffer in the SV so that it has room for the
2481 indicated number of bytes (remember to reserve space for an extra trailing
2482 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
2483 Returns a pointer to the character buffer.
2485 char * SvGROW(SV* sv, STRLEN len)
2492 Returns a boolean indicating whether the SV contains an integer.
2501 Returns a boolean indicating whether the SV contains an integer. Checks
2502 the B<private> setting. Use C<SvIOK>.
2511 Returns a boolean indicating whether the SV contains a signed integer.
2513 void SvIOK_notUV(SV* sv)
2520 Unsets the IV status of an SV.
2522 void SvIOK_off(SV* sv)
2529 Tells an SV that it is an integer.
2531 void SvIOK_on(SV* sv)
2538 Tells an SV that it is an integer and disables all other OK bits.
2540 void SvIOK_only(SV* sv)
2547 Tells and SV that it is an unsigned integer and disables all other OK bits.
2549 void SvIOK_only_UV(SV* sv)
2556 Returns a boolean indicating whether the SV contains an unsigned integer.
2558 void SvIOK_UV(SV* sv)
2565 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
2566 version which guarantees to evaluate sv only once.
2575 Returns the raw value in the SV's IV slot, without checks or conversions.
2576 Only use when you are sure SvIOK is true. See also C<SvIV()>.
2585 Coerces the given SV to an integer and returns it. Guarantees to evaluate
2586 sv only once. Use the more efficient C<SvIV> otherwise.
2595 Returns the size of the string buffer in the SV, not including any part
2596 attributable to C<SvOOK>. See C<SvCUR>.
2598 STRLEN SvLEN(SV* sv)
2605 Returns a boolean indicating whether the SV contains a number, integer or
2615 Returns a boolean indicating whether the SV contains a number, integer or
2616 double. Checks the B<private> setting. Use C<SvNIOK>.
2618 bool SvNIOKp(SV* sv)
2625 Unsets the NV/IV status of an SV.
2627 void SvNIOK_off(SV* sv)
2634 Returns a boolean indicating whether the SV contains a double.
2643 Returns a boolean indicating whether the SV contains a double. Checks the
2644 B<private> setting. Use C<SvNOK>.
2653 Unsets the NV status of an SV.
2655 void SvNOK_off(SV* sv)
2662 Tells an SV that it is a double.
2664 void SvNOK_on(SV* sv)
2671 Tells an SV that it is a double and disables all other OK bits.
2673 void SvNOK_only(SV* sv)
2680 Coerce the given SV to a double and return it. See C<SvNVx> for a version
2681 which guarantees to evaluate sv only once.
2690 Coerces the given SV to a double and returns it. Guarantees to evaluate
2691 sv only once. Use the more efficient C<SvNV> otherwise.
2700 Returns the raw value in the SV's NV slot, without checks or conversions.
2701 Only use when you are sure SvNOK is true. See also C<SvNV()>.
2710 Returns a boolean indicating whether the value is an SV.
2719 Returns a boolean indicating whether the SvIVX is a valid offset value for
2720 the SvPVX. This hack is used internally to speed up removal of characters
2721 from the beginning of a SvPV. When SvOOK is true, then the start of the
2722 allocated string buffer is really (SvPVX - SvIVX).
2731 Returns a boolean indicating whether the SV contains a character
2741 Returns a boolean indicating whether the SV contains a character string.
2742 Checks the B<private> setting. Use C<SvPOK>.
2751 Unsets the PV status of an SV.
2753 void SvPOK_off(SV* sv)
2760 Tells an SV that it is a string.
2762 void SvPOK_on(SV* sv)
2769 Tells an SV that it is a string and disables all other OK bits.
2770 Will also turn off the UTF8 status.
2772 void SvPOK_only(SV* sv)
2777 =item SvPOK_only_UTF8
2779 Tells an SV that it is a string and disables all other OK bits,
2780 and leaves the UTF8 status as it was.
2782 void SvPOK_only_UTF8(SV* sv)
2789 Returns a pointer to the string in the SV, or a stringified form of
2790 the SV if the SV does not contain a string. The SV may cache the
2791 stringified version becoming C<SvPOK>. Handles 'get' magic. See also
2792 C<SvPVx> for a version which guarantees to evaluate sv only once.
2794 char* SvPV(SV* sv, STRLEN len)
2801 Like C<SvPV>, but converts sv to byte representation first if necessary.
2803 char* SvPVbyte(SV* sv, STRLEN len)
2810 Like C<SvPV>, but converts sv to byte representation first if necessary.
2811 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
2815 char* SvPVbytex(SV* sv, STRLEN len)
2820 =item SvPVbytex_force
2822 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
2823 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
2826 char* SvPVbytex_force(SV* sv, STRLEN len)
2831 =item SvPVbyte_force
2833 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
2835 char* SvPVbyte_force(SV* sv, STRLEN len)
2840 =item SvPVbyte_nolen
2842 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
2844 char* SvPVbyte_nolen(SV* sv)
2851 Like C<SvPV>, but converts sv to utf8 first if necessary.
2853 char* SvPVutf8(SV* sv, STRLEN len)
2860 Like C<SvPV>, but converts sv to utf8 first if necessary.
2861 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
2864 char* SvPVutf8x(SV* sv, STRLEN len)
2869 =item SvPVutf8x_force
2871 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
2872 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
2875 char* SvPVutf8x_force(SV* sv, STRLEN len)
2880 =item SvPVutf8_force
2882 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
2884 char* SvPVutf8_force(SV* sv, STRLEN len)
2889 =item SvPVutf8_nolen
2891 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
2893 char* SvPVutf8_nolen(SV* sv)
2900 A version of C<SvPV> which guarantees to evaluate sv only once.
2902 char* SvPVx(SV* sv, STRLEN len)
2909 Returns a pointer to the physical string in the SV. The SV must contain a
2919 Like C<SvPV> but will force the SV into containing just a string
2920 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
2923 char* SvPV_force(SV* sv, STRLEN len)
2928 =item SvPV_force_nomg
2930 Like C<SvPV> but will force the SV into containing just a string
2931 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
2932 directly. Doesn't process magic.
2934 char* SvPV_force_nomg(SV* sv, STRLEN len)
2941 Returns a pointer to the string in the SV, or a stringified form of
2942 the SV if the SV does not contain a string. The SV may cache the
2943 stringified form becoming C<SvPOK>. Handles 'get' magic.
2945 char* SvPV_nolen(SV* sv)
2952 Returns the value of the object's reference count.
2954 U32 SvREFCNT(SV* sv)
2961 Decrements the reference count of the given SV.
2963 void SvREFCNT_dec(SV* sv)
2970 Increments the reference count of the given SV.
2972 SV* SvREFCNT_inc(SV* sv)
2979 Tests if the SV is an RV.
2988 Unsets the RV status of an SV.
2990 void SvROK_off(SV* sv)
2997 Tells an SV that it is an RV.
2999 void SvROK_on(SV* sv)
3006 Dereferences an RV to return the SV.
3015 Returns the stash of the SV.
3024 Taints an SV if tainting is enabled
3026 void SvTAINT(SV* sv)
3033 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
3036 bool SvTAINTED(SV* sv)
3043 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
3044 some of Perl's fundamental security features. XS module authors should not
3045 use this function unless they fully understand all the implications of
3046 unconditionally untainting the value. Untainting should be done in the
3047 standard perl fashion, via a carefully crafted regexp, rather than directly
3048 untainting variables.
3050 void SvTAINTED_off(SV* sv)
3057 Marks an SV as tainted.
3059 void SvTAINTED_on(SV* sv)
3066 Returns a boolean indicating whether Perl would evaluate the SV as true or
3067 false, defined or undefined. Does not handle 'get' magic.
3076 Returns the type of the SV. See C<svtype>.
3078 svtype SvTYPE(SV* sv)
3085 Releases a mutual exclusion lock on sv if a suitable module
3089 void SvUNLOCK(SV* sv)
3096 Returns a boolean indicating whether the SV contains an unsigned integer.
3105 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
3106 perform the upgrade if necessary. See C<svtype>.
3108 void SvUPGRADE(SV* sv, svtype type)
3115 Returns a boolean indicating whether the SV contains UTF-8 encoded data.
3124 Unsets the UTF8 status of an SV.
3126 void SvUTF8_off(SV *sv)
3133 Turn on the UTF8 status of an SV (the data is not changed, just the flag).
3134 Do not use frivolously.
3136 void SvUTF8_on(SV *sv)
3143 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
3144 for a version which guarantees to evaluate sv only once.
3153 Returns the raw value in the SV's UV slot, without checks or conversions.
3154 Only use when you are sure SvIOK is true. See also C<SvUV()>.
3163 Coerces the given SV to an unsigned integer and returns it. Guarantees to
3164 evaluate sv only once. Use the more efficient C<SvUV> otherwise.
3173 This function is only called on magical items, and is only used by
3174 sv_true() or its macro equivalent.
3176 bool sv_2bool(SV* sv)
3183 Using various gambits, try to get a CV from an SV; in addition, try if
3184 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
3186 CV* sv_2cv(SV* sv, HV** st, GV** gvp, I32 lref)
3193 Using various gambits, try to get an IO from an SV: the IO slot if its a
3194 GV; or the recursive result if we're an RV; or the IO slot of the symbol
3195 named after the PV if we're a string.
3204 Return the integer value of an SV, doing any necessary string conversion,
3205 magic etc. Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
3214 Marks an existing SV as mortal. The SV will be destroyed "soon", either
3215 by an explicit call to FREETMPS, or by an implicit call at places such as
3216 statement boundaries. See also C<sv_newmortal> and C<sv_mortalcopy>.
3218 SV* sv_2mortal(SV* sv)
3225 Return the num value of an SV, doing any necessary string or integer
3226 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
3236 Return a pointer to the byte-encoded representation of the SV, and set *lp
3237 to its length. May cause the SV to be downgraded from UTF8 as a
3240 Usually accessed via the C<SvPVbyte> macro.
3242 char* sv_2pvbyte(SV* sv, STRLEN* lp)
3247 =item sv_2pvbyte_nolen
3249 Return a pointer to the byte-encoded representation of the SV.
3250 May cause the SV to be downgraded from UTF8 as a side-effect.
3252 Usually accessed via the C<SvPVbyte_nolen> macro.
3254 char* sv_2pvbyte_nolen(SV* sv)
3261 Return a pointer to the UTF8-encoded representation of the SV, and set *lp
3262 to its length. May cause the SV to be upgraded to UTF8 as a side-effect.
3264 Usually accessed via the C<SvPVutf8> macro.
3266 char* sv_2pvutf8(SV* sv, STRLEN* lp)
3271 =item sv_2pvutf8_nolen
3273 Return a pointer to the UTF8-encoded representation of the SV.
3274 May cause the SV to be upgraded to UTF8 as a side-effect.
3276 Usually accessed via the C<SvPVutf8_nolen> macro.
3278 char* sv_2pvutf8_nolen(SV* sv)
3285 Returns a pointer to the string value of an SV, and sets *lp to its length.
3286 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
3288 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
3289 usually end up here too.
3291 char* sv_2pv_flags(SV* sv, STRLEN* lp, I32 flags)
3298 Like C<sv_2pv()>, but doesn't return the length too. You should usually
3299 use the macro wrapper C<SvPV_nolen(sv)> instead.
3300 char* sv_2pv_nolen(SV* sv)
3307 Return the unsigned integer value of an SV, doing any necessary string
3308 conversion, magic etc. Normally used via the C<SvUV(sv)> and C<SvUVx(sv)>
3318 Remove any string offset. You should normally use the C<SvOOK_off> macro
3321 int sv_backoff(SV* sv)
3328 Blesses an SV into a specified package. The SV must be an RV. The package
3329 must be designated by its stash (see C<gv_stashpv()>). The reference count
3330 of the SV is unaffected.
3332 SV* sv_bless(SV* sv, HV* stash)
3339 Concatenates the string onto the end of the string which is in the SV.
3340 If the SV has the UTF8 status set, then the bytes appended should be
3341 valid UTF8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
3343 void sv_catpv(SV* sv, const char* ptr)
3350 Processes its arguments like C<sprintf> and appends the formatted
3351 output to an SV. If the appended data contains "wide" characters
3352 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
3353 and characters >255 formatted with %c), the original SV might get
3354 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic.
3355 C<SvSETMAGIC()> must typically be called after calling this function
3356 to handle 'set' magic.
3358 void sv_catpvf(SV* sv, const char* pat, ...)
3365 Like C<sv_catpvf>, but also handles 'set' magic.
3367 void sv_catpvf_mg(SV *sv, const char* pat, ...)
3374 Concatenates the string onto the end of the string which is in the SV. The
3375 C<len> indicates number of bytes to copy. If the SV has the UTF8
3376 status set, then the bytes appended should be valid UTF8.
3377 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
3379 void sv_catpvn(SV* sv, const char* ptr, STRLEN len)
3384 =item sv_catpvn_flags
3386 Concatenates the string onto the end of the string which is in the SV. The
3387 C<len> indicates number of bytes to copy. If the SV has the UTF8
3388 status set, then the bytes appended should be valid UTF8.
3389 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
3390 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
3391 in terms of this function.
3393 void sv_catpvn_flags(SV* sv, const char* ptr, STRLEN len, I32 flags)
3400 Like C<sv_catpvn>, but also handles 'set' magic.
3402 void sv_catpvn_mg(SV *sv, const char *ptr, STRLEN len)
3409 Like C<sv_catpv>, but also handles 'set' magic.
3411 void sv_catpv_mg(SV *sv, const char *ptr)
3418 Concatenates the string from SV C<ssv> onto the end of the string in
3419 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
3420 not 'set' magic. See C<sv_catsv_mg>.
3422 void sv_catsv(SV* dsv, SV* ssv)
3427 =item sv_catsv_flags
3429 Concatenates the string from SV C<ssv> onto the end of the string in
3430 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
3431 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
3432 and C<sv_catsv_nomg> are implemented in terms of this function.
3434 void sv_catsv_flags(SV* dsv, SV* ssv, I32 flags)
3441 Like C<sv_catsv>, but also handles 'set' magic.
3443 void sv_catsv_mg(SV *dstr, SV *sstr)
3450 Efficient removal of characters from the beginning of the string buffer.
3451 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
3452 the string buffer. The C<ptr> becomes the first character of the adjusted
3453 string. Uses the "OOK hack".
3455 void sv_chop(SV* sv, char* ptr)
3462 Clear an SV: call any destructors, free up any memory used by the body,
3463 and free the body itself. The SV's head is I<not> freed, although
3464 its type is set to all 1's so that it won't inadvertently be assumed
3465 to be live during global destruction etc.
3466 This function should only be called when REFCNT is zero. Most of the time
3467 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
3470 void sv_clear(SV* sv)
3477 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
3478 string in C<sv1> is less than, equal to, or greater than the string in
3479 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
3480 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
3482 I32 sv_cmp(SV* sv1, SV* sv2)
3489 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
3490 'use bytes' aware, handles get magic, and will coerce its args to strings
3491 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
3493 I32 sv_cmp_locale(SV* sv1, SV* sv2)
3500 Add Collate Transform magic to an SV if it doesn't already have it.
3502 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
3503 scalar data of the variable, but transformed to such a format that a normal
3504 memory comparison can be used to compare the data according to the locale
3507 char* sv_collxfrm(SV* sv, STRLEN* nxp)
3514 Copies a stringified representation of the source SV into the
3515 destination SV. Automatically performs any necessary mg_get and
3516 coercion of numeric values into strings. Guaranteed to preserve
3517 UTF-8 flag even from overloaded objects. Similar in nature to
3518 sv_2pv[_flags] but operates directly on an SV instead of just the
3519 string. Mostly uses sv_2pv_flags to do its work, except when that
3520 would lose the UTF-8'ness of the PV.
3522 void sv_copypv(SV* dsv, SV* ssv)
3529 Auto-decrement of the value in the SV, doing string to numeric conversion
3530 if necessary. Handles 'get' magic.
3537 =item sv_derived_from
3539 Returns a boolean indicating whether the SV is derived from the specified
3540 class. This is the function that implements C<UNIVERSAL::isa>. It works
3541 for class names as well as for objects.
3543 bool sv_derived_from(SV* sv, const char* name)
3546 Found in file universal.c
3550 Returns a boolean indicating whether the strings in the two SVs are
3551 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
3552 coerce its args to strings if necessary.
3554 I32 sv_eq(SV* sv1, SV* sv2)
3559 =item sv_force_normal
3561 Undo various types of fakery on an SV: if the PV is a shared string, make
3562 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3563 an xpvmg. See also C<sv_force_normal_flags>.
3565 void sv_force_normal(SV *sv)
3570 =item sv_force_normal_flags
3572 Undo various types of fakery on an SV: if the PV is a shared string, make
3573 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3574 an xpvmg. The C<flags> parameter gets passed to C<sv_unref_flags()>
3575 when unrefing. C<sv_force_normal> calls this function with flags set to 0.
3577 void sv_force_normal_flags(SV *sv, U32 flags)
3584 Decrement an SV's reference count, and if it drops to zero, call
3585 C<sv_clear> to invoke destructors and free up any memory used by
3586 the body; finally, deallocate the SV's head itself.
3587 Normally called via a wrapper macro C<SvREFCNT_dec>.
3589 void sv_free(SV* sv)
3596 Get a line from the filehandle and store it into the SV, optionally
3597 appending to the currently-stored string.
3599 char* sv_gets(SV* sv, PerlIO* fp, I32 append)
3606 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
3607 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
3608 Use the C<SvGROW> wrapper instead.
3610 char* sv_grow(SV* sv, STRLEN newlen)
3617 Auto-increment of the value in the SV, doing string to numeric conversion
3618 if necessary. Handles 'get' magic.
3627 Inserts a string at the specified offset/length within the SV. Similar to
3628 the Perl substr() function.
3630 void sv_insert(SV* bigsv, STRLEN offset, STRLEN len, char* little, STRLEN littlelen)
3637 Returns a boolean indicating whether the SV is blessed into the specified
3638 class. This does not check for subtypes; use C<sv_derived_from> to verify
3639 an inheritance relationship.
3641 int sv_isa(SV* sv, const char* name)
3648 Returns a boolean indicating whether the SV is an RV pointing to a blessed
3649 object. If the SV is not an RV, or if the object is not blessed, then this
3652 int sv_isobject(SV* sv)
3659 A private implementation of the C<SvIVx> macro for compilers which can't
3660 cope with complex macro expressions. Always use the macro instead.
3669 Returns the length of the string in the SV. Handles magic and type
3670 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
3672 STRLEN sv_len(SV* sv)
3679 Returns the number of characters in the string in an SV, counting wide
3680 UTF8 bytes as a single character. Handles magic and type coercion.
3682 STRLEN sv_len_utf8(SV* sv)
3689 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
3690 then adds a new magic item of type C<how> to the head of the magic list.
3692 void sv_magic(SV* sv, SV* obj, int how, const char* name, I32 namlen)
3699 Adds magic to an SV, upgrading it if necessary. Applies the
3700 supplied vtable and returns pointer to the magic added.
3702 Note that sv_magicext will allow things that sv_magic will not.
3703 In particular you can add magic to SvREADONLY SVs and and more than
3704 one instance of the same 'how'
3706 I C<namelen> is greater then zero then a savepvn() I<copy> of C<name> is stored,
3707 if C<namelen> is zero then C<name> is stored as-is and - as another special
3708 case - if C<(name && namelen == HEf_SVKEY)> then C<name> is assumed to contain
3709 an C<SV*> and has its REFCNT incremented
3711 (This is now used as a subroutine by sv_magic.)
3713 MAGIC * sv_magicext(SV* sv, SV* obj, int how, MGVTBL *vtbl, const char* name, I32 namlen )
3720 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
3721 The new SV is marked as mortal. It will be destroyed "soon", either by an
3722 explicit call to FREETMPS, or by an implicit call at places such as
3723 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
3725 SV* sv_mortalcopy(SV* oldsv)
3732 Creates a new null SV which is mortal. The reference count of the SV is
3733 set to 1. It will be destroyed "soon", either by an explicit call to
3734 FREETMPS, or by an implicit call at places such as statement boundaries.
3735 See also C<sv_mortalcopy> and C<sv_2mortal>.
3744 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
3747 SV* sv_newref(SV* sv)
3754 Dummy routine which "locks" an SV when there is no locking module present.
3755 Exists to avoid test for a NULL function pointer and because it could potentially warn under
3756 some level of strict-ness.
3758 void sv_nolocking(SV *)
3761 Found in file util.c
3765 Dummy routine which "shares" an SV when there is no sharing module present.
3766 Exists to avoid test for a NULL function pointer and because it could potentially warn under
3767 some level of strict-ness.
3769 void sv_nosharing(SV *)
3772 Found in file util.c
3774 =item sv_nounlocking
3776 Dummy routine which "unlocks" an SV when there is no locking module present.
3777 Exists to avoid test for a NULL function pointer and because it could potentially warn under
3778 some level of strict-ness.
3780 void sv_nounlocking(SV *)
3783 Found in file util.c
3787 A private implementation of the C<SvNVx> macro for compilers which can't
3788 cope with complex macro expressions. Always use the macro instead.
3797 Converts the value pointed to by offsetp from a count of bytes from the
3798 start of the string, to a count of the equivalent number of UTF8 chars.
3799 Handles magic and type coercion.
3801 void sv_pos_b2u(SV* sv, I32* offsetp)
3808 Converts the value pointed to by offsetp from a count of UTF8 chars from
3809 the start of the string, to a count of the equivalent number of bytes; if
3810 lenp is non-zero, it does the same to lenp, but this time starting from
3811 the offset, rather than from the start of the string. Handles magic and
3814 void sv_pos_u2b(SV* sv, I32* offsetp, I32* lenp)
3821 A private implementation of the C<SvPV_nolen> macro for compilers which can't
3822 cope with complex macro expressions. Always use the macro instead.
3831 A private implementation of the C<SvPVbyte_nolen> macro for compilers
3832 which can't cope with complex macro expressions. Always use the macro
3835 char* sv_pvbyte(SV *sv)
3842 A private implementation of the C<SvPVbyte> macro for compilers
3843 which can't cope with complex macro expressions. Always use the macro
3846 char* sv_pvbyten(SV *sv, STRLEN *len)
3851 =item sv_pvbyten_force
3853 A private implementation of the C<SvPVbytex_force> macro for compilers
3854 which can't cope with complex macro expressions. Always use the macro
3857 char* sv_pvbyten_force(SV* sv, STRLEN* lp)
3864 A private implementation of the C<SvPV> macro for compilers which can't
3865 cope with complex macro expressions. Always use the macro instead.
3867 char* sv_pvn(SV *sv, STRLEN *len)
3874 Get a sensible string out of the SV somehow.
3875 A private implementation of the C<SvPV_force> macro for compilers which
3876 can't cope with complex macro expressions. Always use the macro instead.
3878 char* sv_pvn_force(SV* sv, STRLEN* lp)
3883 =item sv_pvn_force_flags
3885 Get a sensible string out of the SV somehow.
3886 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
3887 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
3888 implemented in terms of this function.
3889 You normally want to use the various wrapper macros instead: see
3890 C<SvPV_force> and C<SvPV_force_nomg>
3892 char* sv_pvn_force_flags(SV* sv, STRLEN* lp, I32 flags)
3899 A private implementation of the C<SvPVutf8_nolen> macro for compilers
3900 which can't cope with complex macro expressions. Always use the macro
3903 char* sv_pvutf8(SV *sv)
3910 A private implementation of the C<SvPVutf8> macro for compilers
3911 which can't cope with complex macro expressions. Always use the macro
3914 char* sv_pvutf8n(SV *sv, STRLEN *len)
3919 =item sv_pvutf8n_force
3921 A private implementation of the C<SvPVutf8_force> macro for compilers
3922 which can't cope with complex macro expressions. Always use the macro
3925 char* sv_pvutf8n_force(SV* sv, STRLEN* lp)
3932 Returns a string describing what the SV is a reference to.
3934 char* sv_reftype(SV* sv, int ob)
3941 Make the first argument a copy of the second, then delete the original.
3942 The target SV physically takes over ownership of the body of the source SV
3943 and inherits its flags; however, the target keeps any magic it owns,
3944 and any magic in the source is discarded.
3945 Note that this is a rather specialist SV copying operation; most of the
3946 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
3948 void sv_replace(SV* sv, SV* nsv)
3953 =item sv_report_used
3955 Dump the contents of all SVs not yet freed. (Debugging aid).
3957 void sv_report_used()
3964 Underlying implementation for the C<reset> Perl function.
3965 Note that the perl-level function is vaguely deprecated.
3967 void sv_reset(char* s, HV* stash)
3974 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
3975 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
3976 push a back-reference to this RV onto the array of backreferences
3977 associated with that magic.
3979 SV* sv_rvweaken(SV *sv)
3986 Copies an integer into the given SV, upgrading first if necessary.
3987 Does not handle 'set' magic. See also C<sv_setiv_mg>.
3989 void sv_setiv(SV* sv, IV num)
3996 Like C<sv_setiv>, but also handles 'set' magic.
3998 void sv_setiv_mg(SV *sv, IV i)
4005 Copies a double into the given SV, upgrading first if necessary.
4006 Does not handle 'set' magic. See also C<sv_setnv_mg>.
4008 void sv_setnv(SV* sv, NV num)
4015 Like C<sv_setnv>, but also handles 'set' magic.
4017 void sv_setnv_mg(SV *sv, NV num)
4024 Copies a string into an SV. The string must be null-terminated. Does not
4025 handle 'set' magic. See C<sv_setpv_mg>.
4027 void sv_setpv(SV* sv, const char* ptr)
4034 Processes its arguments like C<sprintf> and sets an SV to the formatted
4035 output. Does not handle 'set' magic. See C<sv_setpvf_mg>.
4037 void sv_setpvf(SV* sv, const char* pat, ...)
4044 Like C<sv_setpvf>, but also handles 'set' magic.
4046 void sv_setpvf_mg(SV *sv, const char* pat, ...)
4053 Copies an integer into the given SV, also updating its string value.
4054 Does not handle 'set' magic. See C<sv_setpviv_mg>.
4056 void sv_setpviv(SV* sv, IV num)
4063 Like C<sv_setpviv>, but also handles 'set' magic.
4065 void sv_setpviv_mg(SV *sv, IV iv)
4072 Copies a string into an SV. The C<len> parameter indicates the number of
4073 bytes to be copied. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4075 void sv_setpvn(SV* sv, const char* ptr, STRLEN len)
4082 Like C<sv_setpvn>, but also handles 'set' magic.
4084 void sv_setpvn_mg(SV *sv, const char *ptr, STRLEN len)
4091 Like C<sv_setpv>, but also handles 'set' magic.
4093 void sv_setpv_mg(SV *sv, const char *ptr)
4100 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
4101 argument will be upgraded to an RV. That RV will be modified to point to
4102 the new SV. The C<classname> argument indicates the package for the
4103 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4104 will be returned and will have a reference count of 1.
4106 SV* sv_setref_iv(SV* rv, const char* classname, IV iv)
4113 Copies a double into a new SV, optionally blessing the SV. The C<rv>
4114 argument will be upgraded to an RV. That RV will be modified to point to
4115 the new SV. The C<classname> argument indicates the package for the
4116 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4117 will be returned and will have a reference count of 1.
4119 SV* sv_setref_nv(SV* rv, const char* classname, NV nv)
4126 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
4127 argument will be upgraded to an RV. That RV will be modified to point to
4128 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
4129 into the 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 Do not use with other Perl types such as HV, AV, SV, CV, because those
4134 objects will become corrupted by the pointer copy process.
4136 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
4138 SV* sv_setref_pv(SV* rv, const char* classname, void* pv)
4145 Copies a string into a new SV, optionally blessing the SV. The length of the
4146 string must be specified with C<n>. The C<rv> argument will be upgraded to
4147 an RV. That RV will be modified to point to the new SV. The C<classname>
4148 argument indicates the package for the blessing. Set C<classname> to
4149 C<Nullch> to avoid the blessing. The new SV will be returned and will have
4150 a reference count of 1.
4152 Note that C<sv_setref_pv> copies the pointer while this copies the string.
4154 SV* sv_setref_pvn(SV* rv, const char* classname, char* pv, STRLEN n)
4161 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
4162 argument will be upgraded to an RV. That RV will be modified to point to
4163 the new SV. The C<classname> argument indicates the package for the
4164 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4165 will be returned and will have a reference count of 1.
4167 SV* sv_setref_uv(SV* rv, const char* classname, UV uv)
4174 Copies the contents of the source SV C<ssv> into the destination SV
4175 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4176 function if the source SV needs to be reused. Does not handle 'set' magic.
4177 Loosely speaking, it performs a copy-by-value, obliterating any previous
4178 content of the destination.
4180 You probably want to use one of the assortment of wrappers, such as
4181 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4182 C<SvSetMagicSV_nosteal>.
4185 void sv_setsv(SV* dsv, SV* ssv)
4190 =item sv_setsv_flags
4192 Copies the contents of the source SV C<ssv> into the destination SV
4193 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4194 function if the source SV needs to be reused. Does not handle 'set' magic.
4195 Loosely speaking, it performs a copy-by-value, obliterating any previous
4196 content of the destination.
4197 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
4198 C<ssv> if appropriate, else not. C<sv_setsv> and C<sv_setsv_nomg> are
4199 implemented in terms of this function.
4201 You probably want to use one of the assortment of wrappers, such as
4202 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4203 C<SvSetMagicSV_nosteal>.
4205 This is the primary function for copying scalars, and most other
4206 copy-ish functions and macros use this underneath.
4208 void sv_setsv_flags(SV* dsv, SV* ssv, I32 flags)
4215 Like C<sv_setsv>, but also handles 'set' magic.
4217 void sv_setsv_mg(SV *dstr, SV *sstr)
4224 Copies an unsigned integer into the given SV, upgrading first if necessary.
4225 Does not handle 'set' magic. See also C<sv_setuv_mg>.
4227 void sv_setuv(SV* sv, UV num)
4234 Like C<sv_setuv>, but also handles 'set' magic.
4236 void sv_setuv_mg(SV *sv, UV u)
4243 Taint an SV. Use C<SvTAINTED_on> instead.
4244 void sv_taint(SV* sv)
4251 Test an SV for taintedness. Use C<SvTAINTED> instead.
4252 bool sv_tainted(SV* sv)
4259 Returns true if the SV has a true value by Perl's rules.
4260 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
4261 instead use an in-line version.
4270 Removes all magic of type C<type> from an SV.
4272 int sv_unmagic(SV* sv, int type)
4279 Unsets the RV status of the SV, and decrements the reference count of
4280 whatever was being referenced by the RV. This can almost be thought of
4281 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
4282 being zero. See C<SvROK_off>.
4284 void sv_unref(SV* sv)
4289 =item sv_unref_flags
4291 Unsets the RV status of the SV, and decrements the reference count of
4292 whatever was being referenced by the RV. This can almost be thought of
4293 as a reversal of C<newSVrv>. The C<cflags> argument can contain
4294 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
4295 (otherwise the decrementing is conditional on the reference count being
4296 different from one or the reference being a readonly SV).
4299 void sv_unref_flags(SV* sv, U32 flags)
4306 Untaint an SV. Use C<SvTAINTED_off> instead.
4307 void sv_untaint(SV* sv)
4314 Upgrade an SV to a more complex form. Generally adds a new body type to the
4315 SV, then copies across as much information as possible from the old body.
4316 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
4318 bool sv_upgrade(SV* sv, U32 mt)
4325 Tells an SV to use C<ptr> to find its string value. Normally the string is
4326 stored inside the SV but sv_usepvn allows the SV to use an outside string.
4327 The C<ptr> should point to memory that was allocated by C<malloc>. The
4328 string length, C<len>, must be supplied. This function will realloc the
4329 memory pointed to by C<ptr>, so that pointer should not be freed or used by
4330 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
4331 See C<sv_usepvn_mg>.
4333 void sv_usepvn(SV* sv, char* ptr, STRLEN len)
4340 Like C<sv_usepvn>, but also handles 'set' magic.
4342 void sv_usepvn_mg(SV *sv, char *ptr, STRLEN len)
4347 =item sv_utf8_decode
4349 Convert the octets in the PV from UTF-8 to chars. Scan for validity and then
4350 turn off SvUTF8 if needed so that we see characters. Used as a building block
4351 for decode_utf8 in Encode.xs
4353 NOTE: this function is experimental and may change or be
4354 removed without notice.
4356 bool sv_utf8_decode(SV *sv)
4361 =item sv_utf8_downgrade
4363 Attempt to convert the PV of an SV from UTF8-encoded to byte encoding.
4364 This may not be possible if the PV contains non-byte encoding characters;
4365 if this is the case, either returns false or, if C<fail_ok> is not
4368 NOTE: this function is experimental and may change or be
4369 removed without notice.
4371 bool sv_utf8_downgrade(SV *sv, bool fail_ok)
4376 =item sv_utf8_encode
4378 Convert the PV of an SV to UTF8-encoded, but then turn off the C<SvUTF8>
4379 flag so that it looks like octets again. Used as a building block
4380 for encode_utf8 in Encode.xs
4382 void sv_utf8_encode(SV *sv)
4387 =item sv_utf8_upgrade
4389 Convert the PV of an SV to its UTF8-encoded form.
4390 Forces the SV to string form if it is not already.
4391 Always sets the SvUTF8 flag to avoid future validity checks even
4392 if all the bytes have hibit clear.
4394 STRLEN sv_utf8_upgrade(SV *sv)
4399 =item sv_utf8_upgrade_flags
4401 Convert the PV of an SV to its UTF8-encoded form.
4402 Forces the SV to string form if it is not already.
4403 Always sets the SvUTF8 flag to avoid future validity checks even
4404 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
4405 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
4406 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
4408 STRLEN sv_utf8_upgrade_flags(SV *sv, I32 flags)
4415 A private implementation of the C<SvUVx> macro for compilers which can't
4416 cope with complex macro expressions. Always use the macro instead.
4425 Processes its arguments like C<vsprintf> and appends the formatted output
4426 to an SV. Uses an array of SVs if the C style variable argument list is
4427 missing (NULL). When running with taint checks enabled, indicates via
4428 C<maybe_tainted> if results are untrustworthy (often due to the use of
4431 Usually used via one of its frontends C<sv_catpvf> and C<sv_catpvf_mg>.
4433 void sv_vcatpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
4440 Works like C<vcatpvfn> but copies the text into the SV instead of
4443 Usually used via one of its frontends C<sv_setpvf> and C<sv_setpvf_mg>.
4445 void sv_vsetpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
4453 =head1 Unicode Support
4457 =item bytes_from_utf8
4459 Converts a string C<s> of length C<len> from UTF8 into byte encoding.
4460 Unlike <utf8_to_bytes> but like C<bytes_to_utf8>, returns a pointer to
4461 the newly-created string, and updates C<len> to contain the new
4462 length. Returns the original string if no conversion occurs, C<len>
4463 is unchanged. Do nothing if C<is_utf8> points to 0. Sets C<is_utf8> to
4464 0 if C<s> is converted or contains all 7bit characters.
4466 NOTE: this function is experimental and may change or be
4467 removed without notice.
4469 U8* bytes_from_utf8(U8 *s, STRLEN *len, bool *is_utf8)
4472 Found in file utf8.c
4476 Converts a string C<s> of length C<len> from ASCII into UTF8 encoding.
4477 Returns a pointer to the newly-created string, and sets C<len> to
4478 reflect the new length.
4480 NOTE: this function is experimental and may change or be
4481 removed without notice.
4483 U8* bytes_to_utf8(U8 *s, STRLEN *len)
4486 Found in file utf8.c
4490 Return true if the strings s1 and s2 differ case-insensitively, false
4491 if not (if they are equal case-insensitively). If u1 is true, the
4492 string s1 is assumed to be in UTF-8-encoded Unicode. If u2 is true,
4493 the string s2 is assumed to be in UTF-8-encoded Unicode. If u1 or u2
4494 are false, the respective string is assumed to be in native 8-bit
4497 If the pe1 and pe2 are non-NULL, the scanning pointers will be copied
4498 in there (they will point at the beginning of the I<next> character).
4499 If the pointers behind pe1 or pe2 are non-NULL, they are the end
4500 pointers beyond which scanning will not continue under any
4501 circustances. If the byte lengths l1 and l2 are non-zero, s1+l1 and
4502 s2+l2 will be used as goal end pointers that will also stop the scan,
4503 and which qualify towards defining a successful match: all the scans
4504 that define an explicit length must reach their goal pointers for
4505 a match to succeed).
4507 For case-insensitiveness, the "casefolding" of Unicode is used
4508 instead of upper/lowercasing both the characters, see
4509 http://www.unicode.org/unicode/reports/tr21/ (Case Mappings).
4511 I32 ibcmp_utf8(const char* a, char **pe1, UV l1, bool u1, const char* b, char **pe2, UV l2, bool u2)
4514 Found in file utf8.c
4518 Tests if some arbitrary number of bytes begins in a valid UTF-8
4519 character. Note that an INVARIANT (i.e. ASCII) character is a valid UTF-8 character.
4520 The actual number of bytes in the UTF-8 character will be returned if
4521 it is valid, otherwise 0.
4523 STRLEN is_utf8_char(U8 *p)
4526 Found in file utf8.c
4528 =item is_utf8_string
4530 Returns true if first C<len> bytes of the given string form a valid UTF8
4531 string, false otherwise. Note that 'a valid UTF8 string' does not mean
4532 'a string that contains UTF8' because a valid ASCII string is a valid
4535 bool is_utf8_string(U8 *s, STRLEN len)
4538 Found in file utf8.c
4540 =item pv_uni_display
4542 Build to the scalar dsv a displayable version of the string spv,
4543 length len, the displayable version being at most pvlim bytes long
4544 (if longer, the rest is truncated and "..." will be appended).
4546 The flags argument can have UNI_DISPLAY_ISPRINT set to display
4547 isPRINT()able characters as themselves, UNI_DISPLAY_BACKSLASH
4548 to display the \\[nrfta\\] as the backslashed versions (like '\n')
4549 (UNI_DISPLAY_BACKSLASH is preferred over UNI_DISPLAY_ISPRINT for \\).
4550 UNI_DISPLAY_QQ (and its alias UNI_DISPLAY_REGEX) have both
4551 UNI_DISPLAY_BACKSLASH and UNI_DISPLAY_ISPRINT turned on.
4553 The pointer to the PV of the dsv is returned.
4555 char* pv_uni_display(SV *dsv, U8 *spv, STRLEN len, STRLEN pvlim, UV flags)
4558 Found in file utf8.c
4560 =item sv_recode_to_utf8
4562 The encoding is assumed to be an Encode object, on entry the PV
4563 of the sv is assumed to be octets in that encoding, and the sv
4564 will be converted into Unicode (and UTF-8).
4566 If the sv already is UTF-8 (or if it is not POK), or if the encoding
4567 is not a reference, nothing is done to the sv. If the encoding is not
4568 an C<Encode::XS> Encoding object, bad things will happen.
4569 (See F<lib/encoding.pm> and L<Encode>).
4571 The PV of the sv is returned.
4573 char* sv_recode_to_utf8(SV* sv, SV *encoding)
4578 =item sv_uni_display
4580 Build to the scalar dsv a displayable version of the scalar sv,
4581 the displayable version being at most pvlim bytes long
4582 (if longer, the rest is truncated and "..." will be appended).
4584 The flags argument is as in pv_uni_display().
4586 The pointer to the PV of the dsv is returned.
4588 char* sv_uni_display(SV *dsv, SV *ssv, STRLEN pvlim, UV flags)
4591 Found in file utf8.c
4595 The "p" contains the pointer to the UTF-8 string encoding
4596 the character that is being converted.
4598 The "ustrp" is a pointer to the character buffer to put the
4599 conversion result to. The "lenp" is a pointer to the length
4602 The "swashp" is a pointer to the swash to use.
4604 Both the special and normal mappings are stored lib/unicore/To/Foo.pl,
4605 and loaded by SWASHGET, using lib/utf8_heavy.pl. The special (usually,
4606 but not always, a multicharacter mapping), is tried first.
4608 The "special" is a string like "utf8::ToSpecLower", which means the
4609 hash %utf8::ToSpecLower. The access to the hash is through
4610 Perl_to_utf8_case().
4612 The "normal" is a string like "ToLower" which means the swash
4615 UV to_utf8_case(U8 *p, U8* ustrp, STRLEN *lenp, SV **swash, char *normal, char *special)
4618 Found in file utf8.c
4622 Convert the UTF-8 encoded character at p to its foldcase version and
4623 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
4624 that the ustrp needs to be at least UTF8_MAXLEN_FOLD+1 bytes since the
4625 foldcase version may be longer than the original character (up to
4628 The first character of the foldcased version is returned
4629 (but note, as explained above, that there may be more.)
4631 UV to_utf8_fold(U8 *p, U8* ustrp, STRLEN *lenp)
4634 Found in file utf8.c
4638 Convert the UTF-8 encoded character at p to its lowercase version and
4639 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
4640 that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the
4641 lowercase version may be longer than the original character (up to two
4644 The first character of the lowercased version is returned
4645 (but note, as explained above, that there may be more.)
4647 UV to_utf8_lower(U8 *p, U8* ustrp, STRLEN *lenp)
4650 Found in file utf8.c
4654 Convert the UTF-8 encoded character at p to its titlecase version and
4655 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
4656 that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the
4657 titlecase version may be longer than the original character (up to two
4660 The first character of the titlecased version is returned
4661 (but note, as explained above, that there may be more.)
4663 UV to_utf8_title(U8 *p, U8* ustrp, STRLEN *lenp)
4666 Found in file utf8.c
4670 Convert the UTF-8 encoded character at p to its uppercase version and
4671 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
4672 that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the
4673 uppercase version may be longer than the original character (up to two
4676 The first character of the uppercased version is returned
4677 (but note, as explained above, that there may be more.)
4679 UV to_utf8_upper(U8 *p, U8* ustrp, STRLEN *lenp)
4682 Found in file utf8.c
4684 =item utf8n_to_uvchr
4686 Returns the native character value of the first character in the string C<s>
4687 which is assumed to be in UTF8 encoding; C<retlen> will be set to the
4688 length, in bytes, of that character.
4690 Allows length and flags to be passed to low level routine.
4692 UV utf8n_to_uvchr(U8 *s, STRLEN curlen, STRLEN* retlen, U32 flags)
4695 Found in file utf8.c
4697 =item utf8n_to_uvuni
4699 Bottom level UTF-8 decode routine.
4700 Returns the unicode code point value of the first character in the string C<s>
4701 which is assumed to be in UTF8 encoding and no longer than C<curlen>;
4702 C<retlen> will be set to the length, in bytes, of that character.
4704 If C<s> does not point to a well-formed UTF8 character, the behaviour
4705 is dependent on the value of C<flags>: if it contains UTF8_CHECK_ONLY,
4706 it is assumed that the caller will raise a warning, and this function
4707 will silently just set C<retlen> to C<-1> and return zero. If the
4708 C<flags> does not contain UTF8_CHECK_ONLY, warnings about
4709 malformations will be given, C<retlen> will be set to the expected
4710 length of the UTF-8 character in bytes, and zero will be returned.
4712 The C<flags> can also contain various flags to allow deviations from
4713 the strict UTF-8 encoding (see F<utf8.h>).
4715 Most code should use utf8_to_uvchr() rather than call this directly.
4717 UV utf8n_to_uvuni(U8 *s, STRLEN curlen, STRLEN* retlen, U32 flags)
4720 Found in file utf8.c
4724 Returns the number of UTF8 characters between the UTF-8 pointers C<a>
4727 WARNING: use only if you *know* that the pointers point inside the
4730 IV utf8_distance(U8 *a, U8 *b)
4733 Found in file utf8.c
4737 Return the UTF-8 pointer C<s> displaced by C<off> characters, either
4738 forward or backward.
4740 WARNING: do not use the following unless you *know* C<off> is within
4741 the UTF-8 data pointed to by C<s> *and* that on entry C<s> is aligned
4742 on the first byte of character or just after the last byte of a character.
4744 U8* utf8_hop(U8 *s, I32 off)
4747 Found in file utf8.c
4751 Return the length of the UTF-8 char encoded string C<s> in characters.
4752 Stops at C<e> (inclusive). If C<e E<lt> s> or if the scan would end
4753 up past C<e>, croaks.
4755 STRLEN utf8_length(U8* s, U8 *e)
4758 Found in file utf8.c
4762 Converts a string C<s> of length C<len> from UTF8 into byte encoding.
4763 Unlike C<bytes_to_utf8>, this over-writes the original string, and
4764 updates len to contain the new length.
4765 Returns zero on failure, setting C<len> to -1.
4767 NOTE: this function is experimental and may change or be
4768 removed without notice.
4770 U8* utf8_to_bytes(U8 *s, STRLEN *len)
4773 Found in file utf8.c
4777 Returns the native character value of the first character in the string C<s>
4778 which is assumed to be in UTF8 encoding; C<retlen> will be set to the
4779 length, in bytes, of that character.
4781 If C<s> does not point to a well-formed UTF8 character, zero is
4782 returned and retlen is set, if possible, to -1.
4784 UV utf8_to_uvchr(U8 *s, STRLEN* retlen)
4787 Found in file utf8.c
4791 Returns the Unicode code point of the first character in the string C<s>
4792 which is assumed to be in UTF8 encoding; C<retlen> will be set to the
4793 length, in bytes, of that character.
4795 This function should only be used when returned UV is considered
4796 an index into the Unicode semantic tables (e.g. swashes).
4798 If C<s> does not point to a well-formed UTF8 character, zero is
4799 returned and retlen is set, if possible, to -1.
4801 UV utf8_to_uvuni(U8 *s, STRLEN* retlen)
4804 Found in file utf8.c
4808 Adds the UTF8 representation of the Native codepoint C<uv> to the end
4809 of the string C<d>; C<d> should be have at least C<UTF8_MAXLEN+1> free
4810 bytes available. The return value is the pointer to the byte after the
4811 end of the new character. In other words,
4813 d = uvchr_to_utf8(d, uv);
4815 is the recommended wide native character-aware way of saying
4819 U8* uvchr_to_utf8(U8 *d, UV uv)
4822 Found in file utf8.c
4824 =item uvuni_to_utf8_flags
4826 Adds the UTF8 representation of the Unicode codepoint C<uv> to the end
4827 of the string C<d>; C<d> should be have at least C<UTF8_MAXLEN+1> free
4828 bytes available. The return value is the pointer to the byte after the
4829 end of the new character. In other words,
4831 d = uvuni_to_utf8_flags(d, uv, flags);
4835 d = uvuni_to_utf8(d, uv);
4837 (which is equivalent to)
4839 d = uvuni_to_utf8_flags(d, uv, 0);
4841 is the recommended Unicode-aware way of saying
4845 U8* uvuni_to_utf8_flags(U8 *d, UV uv, UV flags)
4848 Found in file utf8.c
4853 =head1 Variables created by C<xsubpp> and C<xsubpp> internal functions
4859 Variable which is setup by C<xsubpp> to indicate the stack base offset,
4860 used by the C<ST>, C<XSprePUSH> and C<XSRETURN> macros. The C<dMARK> macro
4861 must be called prior to setup the C<MARK> variable.
4866 Found in file XSUB.h
4870 Variable which is setup by C<xsubpp> to indicate the
4871 class name for a C++ XS constructor. This is always a C<char*>. See C<THIS>.
4876 Found in file XSUB.h
4880 Sets up the C<ax> variable.
4881 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
4886 Found in file XSUB.h
4890 Sets up the C<items> variable.
4891 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
4896 Found in file XSUB.h
4900 Sets up stack and mark pointers for an XSUB, calling dSP and dMARK.
4901 Sets up the C<ax> and C<items> variables by calling C<dAX> and C<dITEMS>.
4902 This is usually handled automatically by C<xsubpp>.
4907 Found in file XSUB.h
4911 Sets up the C<ix> variable for an XSUB which has aliases. This is usually
4912 handled automatically by C<xsubpp>.
4917 Found in file XSUB.h
4921 Variable which is setup by C<xsubpp> to indicate the number of
4922 items on the stack. See L<perlxs/"Variable-length Parameter Lists">.
4927 Found in file XSUB.h
4931 Variable which is setup by C<xsubpp> to indicate which of an
4932 XSUB's aliases was used to invoke it. See L<perlxs/"The ALIAS: Keyword">.
4937 Found in file XSUB.h
4941 Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
4945 Found in file XSUB.h
4949 Variable which is setup by C<xsubpp> to hold the return value for an
4950 XSUB. This is always the proper type for the XSUB. See
4951 L<perlxs/"The RETVAL Variable">.
4956 Found in file XSUB.h
4960 Used to access elements on the XSUB's stack.
4965 Found in file XSUB.h
4969 Variable which is setup by C<xsubpp> to designate the object in a C++
4970 XSUB. This is always the proper type for the C++ object. See C<CLASS> and
4971 L<perlxs/"Using XS With C++">.
4976 Found in file XSUB.h
4980 Macro to declare an XSUB and its C parameter list. This is handled by
4984 Found in file XSUB.h
4986 =item XSRETURN_EMPTY
4988 Return an empty list from an XSUB immediately.
4994 Found in file XSUB.h
4998 The version identifier for an XS module. This is usually
4999 handled automatically by C<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>.
5002 Found in file XSUB.h
5004 =item XS_VERSION_BOOTCHECK
5006 Macro to verify that a PM module's $VERSION variable matches the XS
5007 module's C<XS_VERSION> variable. This is usually handled automatically by
5008 C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">.
5010 XS_VERSION_BOOTCHECK;
5013 Found in file XSUB.h
5018 =head1 Warning and Dieing
5024 This is the XSUB-writer's interface to Perl's C<die> function.
5025 Normally use this function the same way you use the C C<printf>
5026 function. See C<warn>.
5028 If you want to throw an exception object, assign the object to
5029 C<$@> and then pass C<Nullch> to croak():
5031 errsv = get_sv("@", TRUE);
5032 sv_setsv(errsv, exception_object);
5035 void croak(const char* pat, ...)
5038 Found in file util.c
5042 This is the XSUB-writer's interface to Perl's C<warn> function. Use this
5043 function the same way you use the C C<printf> function. See
5046 void warn(const char* pat, ...)
5049 Found in file util.c
5056 Until May 1997, this document was maintained by Jeff Okamoto
5057 <okamoto@corp.hp.com>. It is now maintained as part of Perl itself.
5059 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
5060 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
5061 Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
5062 Stephen McCamant, and Gurusamy Sarathy.
5064 API Listing originally by Dean Roehrich <roehrich@cray.com>.
5066 Updated to be autogenerated from comments in the source by Benjamin Stuhl.
5070 perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
https://perl5.git.perl.org / perl5.git / blob