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.
24 Same as C<av_len()>. Deprecated, use C<av_len()> instead.
33 Clears an array, making it empty. Does not free the memory used by the
43 Pre-extend an array. The C<key> is the index to which the array should be
46 void av_extend(AV* ar, I32 key)
53 Returns the SV at the specified index in the array. The C<key> is the
54 index. If C<lval> is set then the fetch will be part of a store. Check
55 that the return value is non-null before dereferencing it to a C<SV*>.
57 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for
58 more information on how to use this function on tied arrays.
60 SV** av_fetch(AV* ar, I32 key, I32 lval)
67 Returns the highest index in the array. Returns -1 if the array is
77 Creates a new AV and populates it with a list of SVs. The SVs are copied
78 into the array, so they may be freed after the call to av_make. The new AV
79 will have a reference count of 1.
81 AV* av_make(I32 size, SV** svp)
88 Pops an SV off the end of the array. Returns C<&PL_sv_undef> if the array
98 Pushes an SV onto the end of the array. The array will grow automatically
99 to accommodate the addition.
101 void av_push(AV* ar, SV* val)
108 Shifts an SV off the beginning of the array.
117 Stores an SV in an array. The array index is specified as C<key>. The
118 return value will be NULL if the operation failed or if the value did not
119 need to be actually stored within the array (as in the case of tied
120 arrays). Otherwise it can be dereferenced to get the original C<SV*>. Note
121 that the caller is responsible for suitably incrementing the reference
122 count of C<val> before the call, and decrementing it if the function
125 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for
126 more information on how to use this function on tied arrays.
128 SV** av_store(AV* ar, I32 key, SV* val)
135 Undefines the array. Frees the memory used by the array itself.
137 void av_undef(AV* ar)
144 Unshift the given number of C<undef> values onto the beginning of the
145 array. The array will grow automatically to accommodate the addition. You
146 must then use C<av_store> to assign values to these new elements.
148 void av_unshift(AV* ar, I32 num)
155 Converts a string C<s> of length C<len> from ASCII into UTF8 encoding.
156 Returns a pointer to the newly-created string, and sets C<len> to
157 reflect the new length.
159 U8 * bytes_to_utf8(U8 *s, STRLEN *len)
166 Performs a callback to the specified Perl sub. See L<perlcall>.
168 NOTE: the perl_ form of this function is deprecated.
170 I32 call_argv(const char* sub_name, I32 flags, char** argv)
177 Performs a callback to the specified Perl method. The blessed object must
178 be on the stack. See L<perlcall>.
180 NOTE: the perl_ form of this function is deprecated.
182 I32 call_method(const char* methname, I32 flags)
189 Performs a callback to the specified Perl sub. See L<perlcall>.
191 NOTE: the perl_ form of this function is deprecated.
193 I32 call_pv(const char* sub_name, I32 flags)
200 Performs a callback to the Perl sub whose name is in the SV. See
203 NOTE: the perl_ form of this function is deprecated.
205 I32 call_sv(SV* sv, I32 flags)
212 Variable which is setup by C<xsubpp> to indicate the
213 class name for a C++ XS constructor. This is always a C<char*>. See C<THIS>.
222 The XSUB-writer's interface to the C C<memcpy> function. The C<src> is the
223 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
224 the type. May fail on overlapping copies. See also C<Move>.
226 void Copy(void* src, void* dest, int nitems, type)
229 Found in file handy.h
233 This is the XSUB-writer's interface to Perl's C<die> function.
234 Normally use this function the same way you use the C C<printf>
235 function. See C<warn>.
237 If you want to throw an exception object, assign the object to
238 C<$@> and then pass C<Nullch> to croak():
240 errsv = get_sv("@", TRUE);
241 sv_setsv(errsv, exception_object);
244 void croak(const char* pat, ...)
251 Returns the stash of the CV.
260 Declare a stack marker variable, C<mark>, for the XSUB. See C<MARK> and
270 Saves the original stack mark for the XSUB. See C<ORIGMARK>.
279 Declares a local copy of perl's stack pointer for the XSUB, available via
280 the C<SP> macro. See C<SP>.
289 Sets up stack and mark pointers for an XSUB, calling dSP and dMARK. This
290 is usually handled automatically by C<xsubpp>. Declares the C<items>
291 variable to indicate the number of items on the stack.
300 Sets up the C<ix> variable for an XSUB which has aliases. This is usually
301 handled automatically by C<xsubpp>.
310 Opening bracket on a callback. See C<LEAVE> and L<perlcall>.
315 Found in file scope.h
319 Tells Perl to C<eval> the given string and return an SV* result.
321 NOTE: the perl_ form of this function is deprecated.
323 SV* eval_pv(const char* p, I32 croak_on_error)
330 Tells Perl to C<eval> the string in the SV.
332 NOTE: the perl_ form of this function is deprecated.
334 I32 eval_sv(SV* sv, I32 flags)
341 Used to extend the argument stack for an XSUB's return values. Once
342 used, guarantees that there is room for at least C<nitems> to be pushed
345 void EXTEND(SP, int nitems)
352 Analyses the string in order to make fast searches on it using fbm_instr()
353 -- the Boyer-Moore algorithm.
355 void fbm_compile(SV* sv, U32 flags)
362 Returns the location of the SV in the string delimited by C<str> and
363 C<strend>. It returns C<Nullch> if the string can't be found. The C<sv>
364 does not have to be fbm_compiled, but the search will not be as fast
367 char* fbm_instr(unsigned char* big, unsigned char* bigend, SV* littlesv, U32 flags)
374 Closing bracket for temporaries on a callback. See C<SAVETMPS> and
380 Found in file scope.h
384 Returns the AV of the specified Perl array. If C<create> is set and the
385 Perl variable does not exist then it will be created. If C<create> is not
386 set and the variable does not exist then NULL is returned.
388 NOTE: the perl_ form of this function is deprecated.
390 AV* get_av(const char* name, I32 create)
397 Returns the CV of the specified Perl subroutine. If C<create> is set and
398 the Perl subroutine does not exist then it will be declared (which has the
399 same effect as saying C<sub name;>). If C<create> is not set and the
400 subroutine does not exist then NULL is returned.
402 NOTE: the perl_ form of this function is deprecated.
404 CV* get_cv(const char* name, I32 create)
411 Returns the HV of the specified Perl hash. If C<create> is set and the
412 Perl variable does not exist then it will be created. If C<create> is not
413 set and the variable does not exist then NULL is returned.
415 NOTE: the perl_ form of this function is deprecated.
417 HV* get_hv(const char* name, I32 create)
424 Returns the SV of the specified Perl scalar. If C<create> is set and the
425 Perl variable does not exist then it will be created. If C<create> is not
426 set and the variable does not exist then NULL is returned.
428 NOTE: the perl_ form of this function is deprecated.
430 SV* get_sv(const char* name, I32 create)
437 A backward-compatible version of C<GIMME_V> which can only return
438 C<G_SCALAR> or C<G_ARRAY>; in a void context, it returns C<G_SCALAR>.
439 Deprecated. Use C<GIMME_V> instead.
448 The XSUB-writer's equivalent to Perl's C<wantarray>. Returns C<G_VOID>,
449 C<G_SCALAR> or C<G_ARRAY> for void, scalar or array context,
459 Return the SV from the GV.
468 Returns the glob with the given C<name> and a defined subroutine or
469 C<NULL>. The glob lives in the given C<stash>, or in the stashes
470 accessible via @ISA and @UNIVERSAL.
472 The argument C<level> should be either 0 or -1. If C<level==0>, as a
473 side-effect creates a glob with the given C<name> in the given C<stash>
474 which in the case of success contains an alias for the subroutine, and sets
475 up caching info for this glob. Similarly for all the searched stashes.
477 This function grants C<"SUPER"> token as a postfix of the stash name. The
478 GV returned from C<gv_fetchmeth> may be a method cache entry, which is not
479 visible to Perl code. So when calling C<call_sv>, you should not use
480 the GV directly; instead, you should use the method's CV, which can be
481 obtained from the GV with the C<GvCV> macro.
483 GV* gv_fetchmeth(HV* stash, const char* name, STRLEN len, I32 level)
490 See L<gv_fetchmethod_autoload>.
492 GV* gv_fetchmethod(HV* stash, const char* name)
497 =item gv_fetchmethod_autoload
499 Returns the glob which contains the subroutine to call to invoke the method
500 on the C<stash>. In fact in the presence of autoloading this may be the
501 glob for "AUTOLOAD". In this case the corresponding variable $AUTOLOAD is
504 The third parameter of C<gv_fetchmethod_autoload> determines whether
505 AUTOLOAD lookup is performed if the given method is not present: non-zero
506 means yes, look for AUTOLOAD; zero means no, don't look for AUTOLOAD.
507 Calling C<gv_fetchmethod> is equivalent to calling C<gv_fetchmethod_autoload>
508 with a non-zero C<autoload> parameter.
510 These functions grant C<"SUPER"> token as a prefix of the method name. Note
511 that if you want to keep the returned glob for a long time, you need to
512 check for it being "AUTOLOAD", since at the later time the call may load a
513 different subroutine due to $AUTOLOAD changing its value. Use the glob
514 created via a side effect to do this.
516 These functions have the same side-effects and as C<gv_fetchmeth> with
517 C<level==0>. C<name> should be writable if contains C<':'> or C<'
518 ''>. The warning against passing the GV returned by C<gv_fetchmeth> to
519 C<call_sv> apply equally to these functions.
521 GV* gv_fetchmethod_autoload(HV* stash, const char* name, I32 autoload)
528 Returns a pointer to the stash for a specified package. C<name> should
529 be a valid UTF-8 string. If C<create> is set then the package will be
530 created if it does not already exist. If C<create> is not set and the
531 package does not exist then NULL is returned.
533 HV* gv_stashpv(const char* name, I32 create)
540 Returns a pointer to the stash for a specified package, which must be a
541 valid UTF-8 string. See C<gv_stashpv>.
543 HV* gv_stashsv(SV* sv, I32 create)
550 Used to indicate array context. See C<GIMME_V>, C<GIMME> and
558 Indicates that arguments returned from a callback should be discarded. See
566 Used to force a Perl C<eval> wrapper around a callback. See
574 Indicates that no arguments are being sent to a callback. See
582 Used to indicate scalar context. See C<GIMME_V>, C<GIMME>, and
590 Used to indicate void context. See C<GIMME_V> and L<perlcall>.
597 This flag, used in the length slot of hash entries and magic structures,
598 specifies the structure contains a C<SV*> pointer where a C<char*> pointer
599 is to be expected. (For information only--not to be used).
606 Returns the computed hash stored in the hash entry.
615 Returns the actual pointer stored in the key slot of the hash entry. The
616 pointer may be either C<char*> or C<SV*>, depending on the value of
617 C<HeKLEN()>. Can be assigned to. The C<HePV()> or C<HeSVKEY()> macros are
618 usually preferable for finding the value of a key.
627 If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry
628 holds an C<SV*> key. Otherwise, holds the actual length of the key. Can
629 be assigned to. The C<HePV()> macro is usually preferable for finding key
632 STRLEN HeKLEN(HE* he)
639 Returns the key slot of the hash entry as a C<char*> value, doing any
640 necessary dereferencing of possibly C<SV*> keys. The length of the string
641 is placed in C<len> (this is a macro, so do I<not> use C<&len>). If you do
642 not care about what the length of the key is, you may use the global
643 variable C<PL_na>, though this is rather less efficient than using a local
644 variable. Remember though, that hash keys in perl are free to contain
645 embedded nulls, so using C<strlen()> or similar is not a good way to find
646 the length of hash keys. This is very similar to the C<SvPV()> macro
647 described elsewhere in this document.
649 char* HePV(HE* he, STRLEN len)
656 Returns the key as an C<SV*>, or C<Nullsv> if the hash entry does not
657 contain an C<SV*> key.
666 Returns the key as an C<SV*>. Will create and return a temporary mortal
667 C<SV*> if the hash entry contains only a C<char*> key.
669 SV* HeSVKEY_force(HE* he)
676 Sets the key to a given C<SV*>, taking care to set the appropriate flags to
677 indicate the presence of an C<SV*> key, and returns the same
680 SV* HeSVKEY_set(HE* he, SV* sv)
687 Returns the value slot (type C<SV*>) stored in the hash entry.
696 Returns the package name of a stash. See C<SvSTASH>, C<CvSTASH>.
698 char* HvNAME(HV* stash)
705 Clears a hash, making it empty.
707 void hv_clear(HV* tb)
714 Deletes a key/value pair in the hash. The value SV is removed from the
715 hash and returned to the caller. The C<klen> is the length of the key.
716 The C<flags> value will normally be zero; if set to G_DISCARD then NULL
719 SV* hv_delete(HV* tb, const char* key, U32 klen, I32 flags)
726 Deletes a key/value pair in the hash. The value SV is removed from the
727 hash and returned to the caller. The C<flags> value will normally be zero;
728 if set to G_DISCARD then NULL will be returned. C<hash> can be a valid
729 precomputed hash value, or 0 to ask for it to be computed.
731 SV* hv_delete_ent(HV* tb, SV* key, I32 flags, U32 hash)
738 Returns a boolean indicating whether the specified hash key exists. The
739 C<klen> is the length of the key.
741 bool hv_exists(HV* tb, const char* key, U32 klen)
748 Returns a boolean indicating whether the specified hash key exists. C<hash>
749 can be a valid precomputed hash value, or 0 to ask for it to be
752 bool hv_exists_ent(HV* tb, SV* key, U32 hash)
759 Returns the SV which corresponds to the specified key in the hash. The
760 C<klen> is the length of the key. If C<lval> is set then the fetch will be
761 part of a store. Check that the return value is non-null before
762 dereferencing it to a C<SV*>.
764 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
765 information on how to use this function on tied hashes.
767 SV** hv_fetch(HV* tb, const char* key, U32 klen, I32 lval)
774 Returns the hash entry which corresponds to the specified key in the hash.
775 C<hash> must be a valid precomputed hash number for the given C<key>, or 0
776 if you want the function to compute it. IF C<lval> is set then the fetch
777 will be part of a store. Make sure the return value is non-null before
778 accessing it. The return value when C<tb> is a tied hash is a pointer to a
779 static location, so be sure to make a copy of the structure if you need to
782 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
783 information on how to use this function on tied hashes.
785 HE* hv_fetch_ent(HV* tb, SV* key, I32 lval, U32 hash)
792 Prepares a starting point to traverse a hash table. Returns the number of
793 keys in the hash (i.e. the same as C<HvKEYS(tb)>). The return value is
794 currently only meaningful for hashes without tie magic.
796 NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
797 hash buckets that happen to be in use. If you still need that esoteric
798 value, you can get it through the macro C<HvFILL(tb)>.
800 I32 hv_iterinit(HV* tb)
807 Returns the key from the current position of the hash iterator. See
810 char* hv_iterkey(HE* entry, I32* retlen)
817 Returns the key as an C<SV*> from the current position of the hash
818 iterator. The return value will always be a mortal copy of the key. Also
821 SV* hv_iterkeysv(HE* entry)
828 Returns entries from a hash iterator. See C<hv_iterinit>.
830 HE* hv_iternext(HV* tb)
837 Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
840 SV* hv_iternextsv(HV* hv, char** key, I32* retlen)
847 Returns the value from the current position of the hash iterator. See
850 SV* hv_iterval(HV* tb, HE* entry)
857 Adds magic to a hash. See C<sv_magic>.
859 void hv_magic(HV* hv, GV* gv, int how)
866 Stores an SV in a hash. The hash key is specified as C<key> and C<klen> is
867 the length of the key. The C<hash> parameter is the precomputed hash
868 value; if it is zero then Perl will compute it. The return value will be
869 NULL if the operation failed or if the value did not need to be actually
870 stored within the hash (as in the case of tied hashes). Otherwise it can
871 be dereferenced to get the original C<SV*>. Note that the caller is
872 responsible for suitably incrementing the reference count of C<val> before
873 the call, and decrementing it if the function returned NULL.
875 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
876 information on how to use this function on tied hashes.
878 SV** hv_store(HV* tb, const char* key, U32 klen, SV* val, U32 hash)
885 Stores C<val> in a hash. The hash key is specified as C<key>. The C<hash>
886 parameter is the precomputed hash value; if it is zero then Perl will
887 compute it. The return value is the new hash entry so created. It will be
888 NULL if the operation failed or if the value did not need to be actually
889 stored within the hash (as in the case of tied hashes). Otherwise the
890 contents of the return value can be accessed using the C<He???> macros
891 described here. Note that the caller is responsible for suitably
892 incrementing the reference count of C<val> before the call, and
893 decrementing it if the function returned NULL.
895 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
896 information on how to use this function on tied hashes.
898 HE* hv_store_ent(HV* tb, SV* key, SV* val, U32 hash)
907 void hv_undef(HV* tb)
914 Returns a boolean indicating whether the C C<char> is an ASCII alphanumeric
915 character (including underscore) or digit.
917 bool isALNUM(char ch)
920 Found in file handy.h
924 Returns a boolean indicating whether the C C<char> is an ASCII alphabetic
927 bool isALPHA(char ch)
930 Found in file handy.h
934 Returns a boolean indicating whether the C C<char> is an ASCII
937 bool isDIGIT(char ch)
940 Found in file handy.h
944 Returns a boolean indicating whether the C C<char> is a lowercase
947 bool isLOWER(char ch)
950 Found in file handy.h
954 Returns a boolean indicating whether the C C<char> is whitespace.
956 bool isSPACE(char ch)
959 Found in file handy.h
963 Returns a boolean indicating whether the C C<char> is an uppercase
966 bool isUPPER(char ch)
969 Found in file handy.h
973 Variable which is setup by C<xsubpp> to indicate the number of
974 items on the stack. See L<perlxs/"Variable-length Parameter Lists">.
983 Variable which is setup by C<xsubpp> to indicate which of an
984 XSUB's aliases was used to invoke it. See L<perlxs/"The ALIAS: Keyword">.
993 Closing bracket on a callback. See C<ENTER> and L<perlcall>.
998 Found in file scope.h
1000 =item looks_like_number
1002 Test if an the content of an SV looks like a number (or is a
1005 I32 looks_like_number(SV* sv)
1012 Stack marker variable for the XSUB. See C<dMARK>.
1019 Clear something magical that the SV represents. See C<sv_magic>.
1021 int mg_clear(SV* sv)
1028 Copies the magic from one SV to another. See C<sv_magic>.
1030 int mg_copy(SV* sv, SV* nsv, const char* key, I32 klen)
1037 Finds the magic pointer for type matching the SV. See C<sv_magic>.
1039 MAGIC* mg_find(SV* sv, int type)
1046 Free any magic storage used by the SV. See C<sv_magic>.
1055 Do magic after a value is retrieved from the SV. See C<sv_magic>.
1064 Report on the SV's length. See C<sv_magic>.
1066 U32 mg_length(SV* sv)
1073 Turns on the magical status of an SV. See C<sv_magic>.
1075 void mg_magical(SV* sv)
1082 Do magic after a value is assigned to the SV. See C<sv_magic>.
1091 The XSUB-writer's interface to the C C<memmove> function. The C<src> is the
1092 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1093 the type. Can do overlapping moves. See also C<Copy>.
1095 void Move(void* src, void* dest, int nitems, type)
1098 Found in file handy.h
1102 The XSUB-writer's interface to the C C<malloc> function.
1104 void New(int id, void* ptr, int nitems, type)
1107 Found in file handy.h
1111 Creates a new AV. The reference count is set to 1.
1120 The XSUB-writer's interface to the C C<malloc> function, with
1123 void Newc(int id, void* ptr, int nitems, type, cast)
1126 Found in file handy.h
1130 Creates a constant sub equivalent to Perl C<sub FOO () { 123 }> which is
1131 eligible for inlining at compile-time.
1133 void newCONSTSUB(HV* stash, char* name, SV* sv)
1140 Creates a new HV. The reference count is set to 1.
1149 Creates an RV wrapper for an SV. The reference count for the original SV is
1152 SV* newRV_inc(SV* sv)
1159 Creates an RV wrapper for an SV. The reference count for the original
1160 SV is B<not> incremented.
1162 SV* newRV_noinc(SV *sv)
1169 Creates a new SV. A non-zero C<len> parameter indicates the number of
1170 bytes of preallocated string space the SV should have. An extra byte for a
1171 tailing NUL is also reserved. (SvPOK is not set for the SV even if string
1172 space is allocated.) The reference count for the new SV is set to 1.
1173 C<id> is an integer id between 0 and 1299 (used to identify leaks).
1175 SV* NEWSV(int id, STRLEN len)
1178 Found in file handy.h
1182 Creates a new SV and copies an integer into it. The reference count for the
1192 Creates a new SV and copies a floating point value into it.
1193 The reference count for the SV is set to 1.
1202 Creates a new SV and copies a string into it. The reference count for the
1203 SV is set to 1. If C<len> is zero, Perl will compute the length using
1204 strlen(). For efficiency, consider using C<newSVpvn> instead.
1206 SV* newSVpv(const char* s, STRLEN len)
1213 Creates a new SV an initialize it with the string formatted like
1216 SV* newSVpvf(const char* pat, ...)
1223 Creates a new SV and copies a string into it. The reference count for the
1224 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
1225 string. You are responsible for ensuring that the source string is at least
1228 SV* newSVpvn(const char* s, STRLEN len)
1235 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
1236 it will be upgraded to one. If C<classname> is non-null then the new SV will
1237 be blessed in the specified package. The new SV is returned and its
1238 reference count is 1.
1240 SV* newSVrv(SV* rv, const char* classname)
1247 Creates a new SV which is an exact duplicate of the original SV.
1249 SV* newSVsv(SV* old)
1256 Creates a new SV and copies an unsigned integer into it.
1257 The reference count for the SV is set to 1.
1266 Used by C<xsubpp> to hook up XSUBs as Perl subs.
1273 Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
1277 Found in file XSUB.h
1281 The XSUB-writer's interface to the C C<malloc> function. The allocated
1282 memory is zeroed with C<memzero>.
1284 void Newz(int id, void* ptr, int nitems, type)
1287 Found in file handy.h
1298 Null character pointer.
1301 Found in file handy.h
1322 Found in file handy.h
1326 The original stack mark for the XSUB. See C<dORIGMARK>.
1333 Allocates a new Perl interpreter. See L<perlembed>.
1335 PerlInterpreter* perl_alloc()
1338 Found in file perl.c
1340 =item perl_construct
1342 Initializes a new Perl interpreter. See L<perlembed>.
1344 void perl_construct(PerlInterpreter* interp)
1347 Found in file perl.c
1351 Shuts down a Perl interpreter. See L<perlembed>.
1353 void perl_destruct(PerlInterpreter* interp)
1356 Found in file perl.c
1360 Releases a Perl interpreter. See L<perlembed>.
1362 void perl_free(PerlInterpreter* interp)
1365 Found in file perl.c
1369 Tells a Perl interpreter to parse a Perl script. See L<perlembed>.
1371 int perl_parse(PerlInterpreter* interp, XSINIT_t xsinit, int argc, char** argv, char** env)
1374 Found in file perl.c
1378 Tells a Perl interpreter to run. See L<perlembed>.
1380 int perl_run(PerlInterpreter* interp)
1383 Found in file perl.c
1387 When Perl is run in debugging mode, with the B<-d> switch, this SV is a
1388 boolean which indicates whether subs are being single-stepped.
1389 Single-stepping is automatically turned on after every step. This is the C
1390 variable which corresponds to Perl's $DB::single variable. See
1396 Found in file intrpvar.h
1400 When Perl is run in debugging mode, with the B<-d> switch, this GV contains
1401 the SV which holds the name of the sub being debugged. This is the C
1402 variable which corresponds to Perl's $DB::sub variable. See
1408 Found in file intrpvar.h
1412 Trace variable used when Perl is run in debugging mode, with the B<-d>
1413 switch. This is the C variable which corresponds to Perl's $DB::trace
1414 variable. See C<PL_DBsingle>.
1419 Found in file intrpvar.h
1423 The C variable which corresponds to Perl's $^W warning variable.
1428 Found in file intrpvar.h
1432 C<PL_modglobal> is a general purpose, interpreter global HV for use by
1433 extensions that need to keep information on a per-interpreter basis.
1434 In a pinch, it can also be used as a symbol table for extensions
1435 to share data among each other. It is a good idea to use keys
1436 prefixed by the package name of the extension that owns the data.
1441 Found in file intrpvar.h
1445 A convenience variable which is typically used with C<SvPV> when one
1446 doesn't care about the length of the string. It is usually more efficient
1447 to either declare a local variable and use that instead or to use the
1448 C<SvPV_nolen> macro.
1453 Found in file thrdvar.h
1457 This is the C<false> SV. See C<PL_sv_yes>. Always refer to this as
1463 Found in file intrpvar.h
1467 This is the C<undef> SV. Always refer to this as C<&PL_sv_undef>.
1472 Found in file intrpvar.h
1476 This is the C<true> SV. See C<PL_sv_no>. Always refer to this as
1482 Found in file intrpvar.h
1486 Pops an integer off the stack.
1495 Pops a long off the stack.
1504 Pops a double off the stack.
1513 Pops a string off the stack.
1522 Pops an SV off the stack.
1531 Push an integer onto the stack. The stack must have room for this element.
1532 Handles 'set' magic. See C<XPUSHi>.
1541 Opening bracket for arguments on a callback. See C<PUTBACK> and
1551 Push a double onto the stack. The stack must have room for this element.
1552 Handles 'set' magic. See C<XPUSHn>.
1561 Push a string onto the stack. The stack must have room for this element.
1562 The C<len> indicates the length of the string. Handles 'set' magic. See
1565 void PUSHp(char* str, STRLEN len)
1572 Push an SV onto the stack. The stack must have room for this element.
1573 Does not handle 'set' magic. See C<XPUSHs>.
1582 Push an unsigned integer onto the stack. The stack must have room for this
1583 element. See C<XPUSHu>.
1592 Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
1593 See C<PUSHMARK> and L<perlcall> for other uses.
1602 The XSUB-writer's interface to the C C<realloc> function.
1604 void Renew(void* ptr, int nitems, type)
1607 Found in file handy.h
1611 The XSUB-writer's interface to the C C<realloc> function, with
1614 void Renewc(void* ptr, int nitems, type, cast)
1617 Found in file handy.h
1621 Tells Perl to C<require> a module.
1623 NOTE: the perl_ form of this function is deprecated.
1625 void require_pv(const char* pv)
1628 Found in file perl.c
1632 Variable which is setup by C<xsubpp> to hold the return value for an
1633 XSUB. This is always the proper type for the XSUB. See
1634 L<perlxs/"The RETVAL Variable">.
1639 Found in file XSUB.h
1643 The XSUB-writer's interface to the C C<free> function.
1645 void Safefree(void* src, void* dest, int nitems, type)
1648 Found in file handy.h
1652 Copy a string to a safe spot. This does not use an SV.
1654 char* savepv(const char* sv)
1657 Found in file util.c
1661 Copy a string to a safe spot. The C<len> indicates number of bytes to
1662 copy. This does not use an SV.
1664 char* savepvn(const char* sv, I32 len)
1667 Found in file util.c
1671 Opening bracket for temporaries on a callback. See C<FREETMPS> and
1677 Found in file scope.h
1681 Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and
1689 Refetch the stack pointer. Used after a callback. See L<perlcall>.
1698 Used to access elements on the XSUB's stack.
1703 Found in file XSUB.h
1707 Test two strings to see if they are equal. Returns true or false.
1709 bool strEQ(char* s1, char* s2)
1712 Found in file handy.h
1716 Test two strings to see if the first, C<s1>, is greater than or equal to
1717 the second, C<s2>. Returns true or false.
1719 bool strGE(char* s1, char* s2)
1722 Found in file handy.h
1726 Test two strings to see if the first, C<s1>, is greater than the second,
1727 C<s2>. Returns true or false.
1729 bool strGT(char* s1, char* s2)
1732 Found in file handy.h
1736 Test two strings to see if the first, C<s1>, is less than or equal to the
1737 second, C<s2>. Returns true or false.
1739 bool strLE(char* s1, char* s2)
1742 Found in file handy.h
1746 Test two strings to see if the first, C<s1>, is less than the second,
1747 C<s2>. Returns true or false.
1749 bool strLT(char* s1, char* s2)
1752 Found in file handy.h
1756 Test two strings to see if they are different. Returns true or
1759 bool strNE(char* s1, char* s2)
1762 Found in file handy.h
1766 Test two strings to see if they are equal. The C<len> parameter indicates
1767 the number of bytes to compare. Returns true or false. (A wrapper for
1770 bool strnEQ(char* s1, char* s2, STRLEN len)
1773 Found in file handy.h
1777 Test two strings to see if they are different. The C<len> parameter
1778 indicates the number of bytes to compare. Returns true or false. (A
1779 wrapper for C<strncmp>).
1781 bool strnNE(char* s1, char* s2, STRLEN len)
1784 Found in file handy.h
1788 This is an architecture-independent macro to copy one structure to another.
1790 void StructCopy(type src, type dest, type)
1793 Found in file handy.h
1797 Returns the length of the string which is in the SV. See C<SvLEN>.
1799 STRLEN SvCUR(SV* sv)
1806 Set the length of the string which is in the SV. See C<SvCUR>.
1808 void SvCUR_set(SV* sv, STRLEN len)
1815 Returns a pointer to the last character in the string which is in the SV.
1816 See C<SvCUR>. Access the character as *(SvEND(sv)).
1825 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
1826 argument more than once.
1828 void SvGETMAGIC(SV* sv)
1835 Expands the character buffer in the SV so that it has room for the
1836 indicated number of bytes (remember to reserve space for an extra trailing
1837 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
1838 Returns a pointer to the character buffer.
1840 void SvGROW(SV* sv, STRLEN len)
1847 Returns a boolean indicating whether the SV contains an integer.
1856 Returns a boolean indicating whether the SV contains an integer. Checks
1857 the B<private> setting. Use C<SvIOK>.
1866 Unsets the IV status of an SV.
1868 void SvIOK_off(SV* sv)
1875 Tells an SV that it is an integer.
1877 void SvIOK_on(SV* sv)
1884 Tells an SV that it is an integer and disables all other OK bits.
1886 void SvIOK_only(SV* sv)
1893 Coerces the given SV to an integer and returns it.
1902 Returns the integer which is stored in the SV, assuming SvIOK is
1912 Returns the size of the string buffer in the SV. See C<SvCUR>.
1914 STRLEN SvLEN(SV* sv)
1921 Returns a boolean indicating whether the SV contains a number, integer or
1931 Returns a boolean indicating whether the SV contains a number, integer or
1932 double. Checks the B<private> setting. Use C<SvNIOK>.
1934 bool SvNIOKp(SV* sv)
1941 Unsets the NV/IV status of an SV.
1943 void SvNIOK_off(SV* sv)
1950 Returns a boolean indicating whether the SV contains a double.
1959 Returns a boolean indicating whether the SV contains a double. Checks the
1960 B<private> setting. Use C<SvNOK>.
1969 Unsets the NV status of an SV.
1971 void SvNOK_off(SV* sv)
1978 Tells an SV that it is a double.
1980 void SvNOK_on(SV* sv)
1987 Tells an SV that it is a double and disables all other OK bits.
1989 void SvNOK_only(SV* sv)
1996 Coerce the given SV to a double and return it.
2005 Returns the double which is stored in the SV, assuming SvNOK is
2015 Returns a boolean indicating whether the value is an SV.
2024 Returns a boolean indicating whether the SvIVX is a valid offset value for
2025 the SvPVX. This hack is used internally to speed up removal of characters
2026 from the beginning of a SvPV. When SvOOK is true, then the start of the
2027 allocated string buffer is really (SvPVX - SvIVX).
2036 Returns a boolean indicating whether the SV contains a character
2046 Returns a boolean indicating whether the SV contains a character string.
2047 Checks the B<private> setting. Use C<SvPOK>.
2056 Unsets the PV status of an SV.
2058 void SvPOK_off(SV* sv)
2065 Tells an SV that it is a string.
2067 void SvPOK_on(SV* sv)
2074 Tells an SV that it is a string and disables all other OK bits.
2076 void SvPOK_only(SV* sv)
2083 Returns a pointer to the string in the SV, or a stringified form of the SV
2084 if the SV does not contain a string. Handles 'get' magic.
2086 char* SvPV(SV* sv, STRLEN len)
2093 Returns a pointer to the string in the SV. The SV must contain a
2103 Like <SvPV> but will force the SV into becoming a string (SvPOK). You want
2104 force if you are going to update the SvPVX directly.
2106 char* SvPV_force(SV* sv, STRLEN len)
2113 Returns a pointer to the string in the SV, or a stringified form of the SV
2114 if the SV does not contain a string. Handles 'get' magic.
2116 char* SvPV_nolen(SV* sv)
2123 Returns the value of the object's reference count.
2125 U32 SvREFCNT(SV* sv)
2132 Decrements the reference count of the given SV.
2134 void SvREFCNT_dec(SV* sv)
2141 Increments the reference count of the given SV.
2143 SV* SvREFCNT_inc(SV* sv)
2150 Tests if the SV is an RV.
2159 Unsets the RV status of an SV.
2161 void SvROK_off(SV* sv)
2168 Tells an SV that it is an RV.
2170 void SvROK_on(SV* sv)
2177 Dereferences an RV to return the SV.
2186 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
2187 argument more than once.
2189 void SvSETMAGIC(SV* sv)
2196 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
2199 void SvSetSV(SV* dsb, SV* ssv)
2204 =item SvSetSV_nosteal
2206 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
2207 ssv. May evaluate arguments more than once.
2209 void SvSetSV_nosteal(SV* dsv, SV* ssv)
2216 Returns the stash of the SV.
2225 Taints an SV if tainting is enabled
2227 void SvTAINT(SV* sv)
2234 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
2237 bool SvTAINTED(SV* sv)
2244 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
2245 some of Perl's fundamental security features. XS module authors should not
2246 use this function unless they fully understand all the implications of
2247 unconditionally untainting the value. Untainting should be done in the
2248 standard perl fashion, via a carefully crafted regexp, rather than directly
2249 untainting variables.
2251 void SvTAINTED_off(SV* sv)
2258 Marks an SV as tainted.
2260 void SvTAINTED_on(SV* sv)
2267 Returns a boolean indicating whether Perl would evaluate the SV as true or
2268 false, defined or undefined. Does not handle 'get' magic.
2277 An enum of flags for Perl types. These are found in the file B<sv.h>
2278 in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
2285 Returns the type of the SV. See C<svtype>.
2287 svtype SvTYPE(SV* sv)
2294 Integer type flag for scalars. See C<svtype>.
2301 Double type flag for scalars. See C<svtype>.
2308 Pointer type flag for scalars. See C<svtype>.
2315 Type flag for arrays. See C<svtype>.
2322 Type flag for code refs. See C<svtype>.
2329 Type flag for hashes. See C<svtype>.
2336 Type flag for blessed scalars. See C<svtype>.
2343 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
2344 perform the upgrade if necessary. See C<svtype>.
2346 void SvUPGRADE(SV* sv, svtype type)
2353 Coerces the given SV to an unsigned integer and returns it.
2362 Returns the unsigned integer which is stored in the SV, assuming SvIOK is
2372 Marks an SV as mortal. The SV will be destroyed when the current context
2375 SV* sv_2mortal(SV* sv)
2382 Blesses an SV into a specified package. The SV must be an RV. The package
2383 must be designated by its stash (see C<gv_stashpv()>). The reference count
2384 of the SV is unaffected.
2386 SV* sv_bless(SV* sv, HV* stash)
2393 Concatenates the string onto the end of the string which is in the SV.
2394 Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
2396 void sv_catpv(SV* sv, const char* ptr)
2403 Processes its arguments like C<sprintf> and appends the formatted output
2404 to an SV. Handles 'get' magic, but not 'set' magic. C<SvSETMAGIC()> must
2405 typically be called after calling this function to handle 'set' magic.
2407 void sv_catpvf(SV* sv, const char* pat, ...)
2414 Like C<sv_catpvf>, but also handles 'set' magic.
2416 void sv_catpvf_mg(SV *sv, const char* pat, ...)
2423 Concatenates the string onto the end of the string which is in the SV. The
2424 C<len> indicates number of bytes to copy. Handles 'get' magic, but not
2425 'set' magic. See C<sv_catpvn_mg>.
2427 void sv_catpvn(SV* sv, const char* ptr, STRLEN len)
2434 Like C<sv_catpvn>, but also handles 'set' magic.
2436 void sv_catpvn_mg(SV *sv, const char *ptr, STRLEN len)
2443 Like C<sv_catpv>, but also handles 'set' magic.
2445 void sv_catpv_mg(SV *sv, const char *ptr)
2452 Concatenates the string from SV C<ssv> onto the end of the string in SV
2453 C<dsv>. Handles 'get' magic, but not 'set' magic. See C<sv_catsv_mg>.
2455 void sv_catsv(SV* dsv, SV* ssv)
2462 Like C<sv_catsv>, but also handles 'set' magic.
2464 void sv_catsv_mg(SV *dstr, SV *sstr)
2471 Efficient removal of characters from the beginning of the string buffer.
2472 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
2473 the string buffer. The C<ptr> becomes the first character of the adjusted
2476 void sv_chop(SV* sv, char* ptr)
2483 Clear an SV, making it empty. Does not free the memory used by the SV
2486 void sv_clear(SV* sv)
2493 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
2494 string in C<sv1> is less than, equal to, or greater than the string in
2497 I32 sv_cmp(SV* sv1, SV* sv2)
2504 Compares the strings in two SVs in a locale-aware manner. See
2507 I32 sv_cmp_locale(SV* sv1, SV* sv2)
2514 Auto-decrement of the value in the SV.
2521 =item sv_derived_from
2523 Returns a boolean indicating whether the SV is derived from the specified
2524 class. This is the function that implements C<UNIVERSAL::isa>. It works
2525 for class names as well as for objects.
2527 bool sv_derived_from(SV* sv, const char* name)
2530 Found in file universal.c
2534 Returns a boolean indicating whether the strings in the two SVs are
2537 I32 sv_eq(SV* sv1, SV* sv2)
2544 Free the memory used by an SV.
2546 void sv_free(SV* sv)
2553 Get a line from the filehandle and store it into the SV, optionally
2554 appending to the currently-stored string.
2556 char* sv_gets(SV* sv, PerlIO* fp, I32 append)
2563 Expands the character buffer in the SV. This will use C<sv_unref> and will
2564 upgrade the SV to C<SVt_PV>. Returns a pointer to the character buffer.
2567 char* sv_grow(SV* sv, STRLEN newlen)
2574 Auto-increment of the value in the SV.
2583 Inserts a string at the specified offset/length within the SV. Similar to
2584 the Perl substr() function.
2586 void sv_insert(SV* bigsv, STRLEN offset, STRLEN len, char* little, STRLEN littlelen)
2593 Returns a boolean indicating whether the SV is blessed into the specified
2594 class. This does not check for subtypes; use C<sv_derived_from> to verify
2595 an inheritance relationship.
2597 int sv_isa(SV* sv, const char* name)
2604 Returns a boolean indicating whether the SV is an RV pointing to a blessed
2605 object. If the SV is not an RV, or if the object is not blessed, then this
2608 int sv_isobject(SV* sv)
2615 Returns the length of the string in the SV. See also C<SvCUR>.
2617 STRLEN sv_len(SV* sv)
2624 Returns the number of characters in the string in an SV, counting wide
2625 UTF8 bytes as a single character.
2627 STRLEN sv_len_utf8(SV* sv)
2634 Adds magic to an SV.
2636 void sv_magic(SV* sv, SV* obj, int how, const char* name, I32 namlen)
2643 Creates a new SV which is a copy of the original SV. The new SV is marked
2646 SV* sv_mortalcopy(SV* oldsv)
2653 Creates a new SV which is mortal. The reference count of the SV is set to 1.
2662 Get a sensible string out of the SV somehow.
2664 char* sv_pvn_force(SV* sv, STRLEN* lp)
2669 =item sv_pvutf8n_force
2671 Get a sensible UTF8-encoded string out of the SV somehow. See
2674 char* sv_pvutf8n_force(SV* sv, STRLEN* lp)
2681 Returns a string describing what the SV is a reference to.
2683 char* sv_reftype(SV* sv, int ob)
2690 Make the first argument a copy of the second, then delete the original.
2692 void sv_replace(SV* sv, SV* nsv)
2701 SV* sv_rvweaken(SV *sv)
2708 Copies an integer into the given SV. Does not handle 'set' magic. See
2711 void sv_setiv(SV* sv, IV num)
2718 Like C<sv_setiv>, but also handles 'set' magic.
2720 void sv_setiv_mg(SV *sv, IV i)
2727 Copies a double into the given SV. Does not handle 'set' magic. See
2730 void sv_setnv(SV* sv, NV num)
2737 Like C<sv_setnv>, but also handles 'set' magic.
2739 void sv_setnv_mg(SV *sv, NV num)
2746 Copies a string into an SV. The string must be null-terminated. Does not
2747 handle 'set' magic. See C<sv_setpv_mg>.
2749 void sv_setpv(SV* sv, const char* ptr)
2756 Processes its arguments like C<sprintf> and sets an SV to the formatted
2757 output. Does not handle 'set' magic. See C<sv_setpvf_mg>.
2759 void sv_setpvf(SV* sv, const char* pat, ...)
2766 Like C<sv_setpvf>, but also handles 'set' magic.
2768 void sv_setpvf_mg(SV *sv, const char* pat, ...)
2775 Copies an integer into the given SV, also updating its string value.
2776 Does not handle 'set' magic. See C<sv_setpviv_mg>.
2778 void sv_setpviv(SV* sv, IV num)
2785 Like C<sv_setpviv>, but also handles 'set' magic.
2787 void sv_setpviv_mg(SV *sv, IV iv)
2794 Copies a string into an SV. The C<len> parameter indicates the number of
2795 bytes to be copied. Does not handle 'set' magic. See C<sv_setpvn_mg>.
2797 void sv_setpvn(SV* sv, const char* ptr, STRLEN len)
2804 Like C<sv_setpvn>, but also handles 'set' magic.
2806 void sv_setpvn_mg(SV *sv, const char *ptr, STRLEN len)
2813 Like C<sv_setpv>, but also handles 'set' magic.
2815 void sv_setpv_mg(SV *sv, const char *ptr)
2822 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
2823 argument will be upgraded to an RV. That RV will be modified to point to
2824 the new SV. The C<classname> argument indicates the package for the
2825 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
2826 will be returned and will have a reference count of 1.
2828 SV* sv_setref_iv(SV* rv, const char* classname, IV iv)
2835 Copies a double into a new SV, optionally blessing the SV. The C<rv>
2836 argument will be upgraded to an RV. That RV will be modified to point to
2837 the new SV. The C<classname> argument indicates the package for the
2838 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
2839 will be returned and will have a reference count of 1.
2841 SV* sv_setref_nv(SV* rv, const char* classname, NV nv)
2848 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
2849 argument will be upgraded to an RV. That RV will be modified to point to
2850 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
2851 into the SV. The C<classname> argument indicates the package for the
2852 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
2853 will be returned and will have a reference count of 1.
2855 Do not use with other Perl types such as HV, AV, SV, CV, because those
2856 objects will become corrupted by the pointer copy process.
2858 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
2860 SV* sv_setref_pv(SV* rv, const char* classname, void* pv)
2867 Copies a string into a new SV, optionally blessing the SV. The length of the
2868 string must be specified with C<n>. The C<rv> argument will be upgraded to
2869 an RV. That RV will be modified to point to the new SV. The C<classname>
2870 argument indicates the package for the blessing. Set C<classname> to
2871 C<Nullch> to avoid the blessing. The new SV will be returned and will have
2872 a reference count of 1.
2874 Note that C<sv_setref_pv> copies the pointer while this copies the string.
2876 SV* sv_setref_pvn(SV* rv, const char* classname, char* pv, STRLEN n)
2883 Copies the contents of the source SV C<ssv> into the destination SV C<dsv>.
2884 The source SV may be destroyed if it is mortal. Does not handle 'set'
2885 magic. See the macro forms C<SvSetSV>, C<SvSetSV_nosteal> and
2888 void sv_setsv(SV* dsv, SV* ssv)
2895 Like C<sv_setsv>, but also handles 'set' magic.
2897 void sv_setsv_mg(SV *dstr, SV *sstr)
2904 Copies an unsigned integer into the given SV. Does not handle 'set' magic.
2907 void sv_setuv(SV* sv, UV num)
2914 Like C<sv_setuv>, but also handles 'set' magic.
2916 void sv_setuv_mg(SV *sv, UV u)
2923 Returns true if the SV has a true value by Perl's rules.
2932 Removes magic from an SV.
2934 int sv_unmagic(SV* sv, int type)
2941 Unsets the RV status of the SV, and decrements the reference count of
2942 whatever was being referenced by the RV. This can almost be thought of
2943 as a reversal of C<newSVrv>. See C<SvROK_off>.
2945 void sv_unref(SV* sv)
2952 Upgrade an SV to a more complex form. Use C<SvUPGRADE>. See
2955 bool sv_upgrade(SV* sv, U32 mt)
2962 Tells an SV to use C<ptr> to find its string value. Normally the string is
2963 stored inside the SV but sv_usepvn allows the SV to use an outside string.
2964 The C<ptr> should point to memory that was allocated by C<malloc>. The
2965 string length, C<len>, must be supplied. This function will realloc the
2966 memory pointed to by C<ptr>, so that pointer should not be freed or used by
2967 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
2968 See C<sv_usepvn_mg>.
2970 void sv_usepvn(SV* sv, char* ptr, STRLEN len)
2977 Like C<sv_usepvn>, but also handles 'set' magic.
2979 void sv_usepvn_mg(SV *sv, char *ptr, STRLEN len)
2984 =item sv_utf8_downgrade
2986 Attempt to convert the PV of an SV from UTF8-encoded to byte encoding.
2987 This may not be possible if the PV contains non-byte encoding characters;
2988 if this is the case, either returns false or, if C<fail_ok> is not
2991 NOTE: this function is experimental and may change or be
2992 removed without notice.
2994 bool sv_utf8_downgrade(SV *sv, bool fail_ok)
2999 =item sv_utf8_encode
3001 Convert the PV of an SV to UTF8-encoded, but then turn off the C<SvUTF8>
3002 flag so that it looks like bytes again. Nothing calls this.
3004 NOTE: this function is experimental and may change or be
3005 removed without notice.
3007 void sv_utf8_encode(SV *sv)
3012 =item sv_utf8_upgrade
3014 Convert the PV of an SV to its UTF8-encoded form.
3016 void sv_utf8_upgrade(SV *sv)
3023 Processes its arguments like C<vsprintf> and appends the formatted output
3024 to an SV. Uses an array of SVs if the C style variable argument list is
3025 missing (NULL). When running with taint checks enabled, indicates via
3026 C<maybe_tainted> if results are untrustworthy (often due to the use of
3029 void sv_vcatpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
3036 Works like C<vcatpvfn> but copies the text into the SV instead of
3039 void sv_vsetpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
3046 Variable which is setup by C<xsubpp> to designate the object in a C++
3047 XSUB. This is always the proper type for the C++ object. See C<CLASS> and
3048 L<perlxs/"Using XS With C++">.
3053 Found in file XSUB.h
3057 Converts the specified character to lowercase.
3059 char toLOWER(char ch)
3062 Found in file handy.h
3066 Converts the specified character to uppercase.
3068 char toUPPER(char ch)
3071 Found in file handy.h
3075 Returns true if first C<len> bytes of the given string form valid a UTF8
3076 string, false otherwise.
3078 bool_utf8_string U8 *s(STRLEN len)
3081 Found in file utf8.c
3085 Converts a string C<s> of length C<len> from UTF8 into ASCII encoding.
3086 Unlike C<bytes_to_utf8>, this over-writes the original string.
3087 Returns zero on failure after converting as much as possible.
3089 U8 * utf8_to_bytes(U8 *s, STRLEN len)
3092 Found in file utf8.c
3096 This is the XSUB-writer's interface to Perl's C<warn> function. Use this
3097 function the same way you use the C C<printf> function. See
3100 void warn(const char* pat, ...)
3103 Found in file util.c
3107 Push an integer onto the stack, extending the stack if necessary. Handles
3108 'set' magic. See C<PUSHi>.
3117 Push a double onto the stack, extending the stack if necessary. Handles
3118 'set' magic. See C<PUSHn>.
3127 Push a string onto the stack, extending the stack if necessary. The C<len>
3128 indicates the length of the string. Handles 'set' magic. See
3131 void XPUSHp(char* str, STRLEN len)
3138 Push an SV onto the stack, extending the stack if necessary. Does not
3139 handle 'set' magic. See C<PUSHs>.
3148 Push an unsigned integer onto the stack, extending the stack if necessary.
3158 Macro to declare an XSUB and its C parameter list. This is handled by
3162 Found in file XSUB.h
3166 Return from XSUB, indicating number of items on the stack. This is usually
3167 handled by C<xsubpp>.
3169 void XSRETURN(int nitems)
3172 Found in file XSUB.h
3174 =item XSRETURN_EMPTY
3176 Return an empty list from an XSUB immediately.
3181 Found in file XSUB.h
3185 Return an integer from an XSUB immediately. Uses C<XST_mIV>.
3187 void XSRETURN_IV(IV iv)
3190 Found in file XSUB.h
3194 Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
3199 Found in file XSUB.h
3203 Return an double from an XSUB immediately. Uses C<XST_mNV>.
3205 void XSRETURN_NV(NV nv)
3208 Found in file XSUB.h
3212 Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
3214 void XSRETURN_PV(char* str)
3217 Found in file XSUB.h
3219 =item XSRETURN_UNDEF
3221 Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
3226 Found in file XSUB.h
3230 Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
3235 Found in file XSUB.h
3239 Place an integer into the specified position C<pos> on the stack. The
3240 value is stored in a new mortal SV.
3242 void XST_mIV(int pos, IV iv)
3245 Found in file XSUB.h
3249 Place C<&PL_sv_no> into the specified position C<pos> on the
3252 void XST_mNO(int pos)
3255 Found in file XSUB.h
3259 Place a double into the specified position C<pos> on the stack. The value
3260 is stored in a new mortal SV.
3262 void XST_mNV(int pos, NV nv)
3265 Found in file XSUB.h
3269 Place a copy of a string into the specified position C<pos> on the stack.
3270 The value is stored in a new mortal SV.
3272 void XST_mPV(int pos, char* str)
3275 Found in file XSUB.h
3279 Place C<&PL_sv_undef> into the specified position C<pos> on the
3282 void XST_mUNDEF(int pos)
3285 Found in file XSUB.h
3289 Place C<&PL_sv_yes> into the specified position C<pos> on the
3292 void XST_mYES(int pos)
3295 Found in file XSUB.h
3299 The version identifier for an XS module. This is usually
3300 handled automatically by C<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>.
3303 Found in file XSUB.h
3305 =item XS_VERSION_BOOTCHECK
3307 Macro to verify that a PM module's $VERSION variable matches the XS
3308 module's C<XS_VERSION> variable. This is usually handled automatically by
3309 C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">.
3311 XS_VERSION_BOOTCHECK;
3314 Found in file XSUB.h
3318 The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the
3319 destination, C<nitems> is the number of items, and C<type> is the type.
3321 void Zero(void* dest, int nitems, type)
3324 Found in file handy.h
3330 Until May 1997, this document was maintained by Jeff Okamoto
3331 <okamoto@corp.hp.com>. It is now maintained as part of Perl itself.
3333 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
3334 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
3335 Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
3336 Stephen McCamant, and Gurusamy Sarathy.
3338 API Listing originally by Dean Roehrich <roehrich@cray.com>.
3340 Updated to be autogenerated from comments in the source by Benjamin Stuhl.
3344 perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
projects / p5sagit/p5-mst-13.2.git / blob