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.
158 U8 * bytes_to_utf8(U8 *s, STRLEN len)
165 Performs a callback to the specified Perl sub. See L<perlcall>.
167 NOTE: the perl_ form of this function is deprecated.
169 I32 call_argv(const char* sub_name, I32 flags, char** argv)
176 Performs a callback to the specified Perl method. The blessed object must
177 be on the stack. See L<perlcall>.
179 NOTE: the perl_ form of this function is deprecated.
181 I32 call_method(const char* methname, I32 flags)
188 Performs a callback to the specified Perl sub. See L<perlcall>.
190 NOTE: the perl_ form of this function is deprecated.
192 I32 call_pv(const char* sub_name, I32 flags)
199 Performs a callback to the Perl sub whose name is in the SV. See
202 NOTE: the perl_ form of this function is deprecated.
204 I32 call_sv(SV* sv, I32 flags)
211 Variable which is setup by C<xsubpp> to indicate the
212 class name for a C++ XS constructor. This is always a C<char*>. See C<THIS>.
221 The XSUB-writer's interface to the C C<memcpy> function. The C<src> is the
222 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
223 the type. May fail on overlapping copies. See also C<Move>.
225 void Copy(void* src, void* dest, int nitems, type)
228 Found in file handy.h
232 This is the XSUB-writer's interface to Perl's C<die> function.
233 Normally use this function the same way you use the C C<printf>
234 function. See C<warn>.
236 If you want to throw an exception object, assign the object to
237 C<$@> and then pass C<Nullch> to croak():
239 errsv = get_sv("@", TRUE);
240 sv_setsv(errsv, exception_object);
243 void croak(const char* pat, ...)
250 Returns the stash of the CV.
259 Declare a stack marker variable, C<mark>, for the XSUB. See C<MARK> and
269 Saves the original stack mark for the XSUB. See C<ORIGMARK>.
278 Declares a local copy of perl's stack pointer for the XSUB, available via
279 the C<SP> macro. See C<SP>.
288 Sets up stack and mark pointers for an XSUB, calling dSP and dMARK. This
289 is usually handled automatically by C<xsubpp>. Declares the C<items>
290 variable to indicate the number of items on the stack.
299 Sets up the C<ix> variable for an XSUB which has aliases. This is usually
300 handled automatically by C<xsubpp>.
309 Opening bracket on a callback. See C<LEAVE> and L<perlcall>.
314 Found in file scope.h
318 Tells Perl to C<eval> the given string and return an SV* result.
320 NOTE: the perl_ form of this function is deprecated.
322 SV* eval_pv(const char* p, I32 croak_on_error)
329 Tells Perl to C<eval> the string in the SV.
331 NOTE: the perl_ form of this function is deprecated.
333 I32 eval_sv(SV* sv, I32 flags)
340 Used to extend the argument stack for an XSUB's return values. Once
341 used, guarantees that there is room for at least C<nitems> to be pushed
344 void EXTEND(SP, int nitems)
351 Analyses the string in order to make fast searches on it using fbm_instr()
352 -- the Boyer-Moore algorithm.
354 void fbm_compile(SV* sv, U32 flags)
361 Returns the location of the SV in the string delimited by C<str> and
362 C<strend>. It returns C<Nullch> if the string can't be found. The C<sv>
363 does not have to be fbm_compiled, but the search will not be as fast
366 char* fbm_instr(unsigned char* big, unsigned char* bigend, SV* littlesv, U32 flags)
373 Closing bracket for temporaries on a callback. See C<SAVETMPS> and
379 Found in file scope.h
383 Returns the AV of the specified Perl array. If C<create> is set and the
384 Perl variable does not exist then it will be created. If C<create> is not
385 set and the variable does not exist then NULL is returned.
387 NOTE: the perl_ form of this function is deprecated.
389 AV* get_av(const char* name, I32 create)
396 Returns the CV of the specified Perl subroutine. If C<create> is set and
397 the Perl subroutine does not exist then it will be declared (which has the
398 same effect as saying C<sub name;>). If C<create> is not set and the
399 subroutine does not exist then NULL is returned.
401 NOTE: the perl_ form of this function is deprecated.
403 CV* get_cv(const char* name, I32 create)
410 Returns the HV of the specified Perl hash. If C<create> is set and the
411 Perl variable does not exist then it will be created. If C<create> is not
412 set and the variable does not exist then NULL is returned.
414 NOTE: the perl_ form of this function is deprecated.
416 HV* get_hv(const char* name, I32 create)
423 Returns the SV of the specified Perl scalar. If C<create> is set and the
424 Perl variable does not exist then it will be created. If C<create> is not
425 set and the variable does not exist then NULL is returned.
427 NOTE: the perl_ form of this function is deprecated.
429 SV* get_sv(const char* name, I32 create)
436 A backward-compatible version of C<GIMME_V> which can only return
437 C<G_SCALAR> or C<G_ARRAY>; in a void context, it returns C<G_SCALAR>.
438 Deprecated. Use C<GIMME_V> instead.
447 The XSUB-writer's equivalent to Perl's C<wantarray>. Returns C<G_VOID>,
448 C<G_SCALAR> or C<G_ARRAY> for void, scalar or array context,
458 Return the SV from the GV.
467 Returns the glob with the given C<name> and a defined subroutine or
468 C<NULL>. The glob lives in the given C<stash>, or in the stashes
469 accessible via @ISA and @UNIVERSAL.
471 The argument C<level> should be either 0 or -1. If C<level==0>, as a
472 side-effect creates a glob with the given C<name> in the given C<stash>
473 which in the case of success contains an alias for the subroutine, and sets
474 up caching info for this glob. Similarly for all the searched stashes.
476 This function grants C<"SUPER"> token as a postfix of the stash name. The
477 GV returned from C<gv_fetchmeth> may be a method cache entry, which is not
478 visible to Perl code. So when calling C<call_sv>, you should not use
479 the GV directly; instead, you should use the method's CV, which can be
480 obtained from the GV with the C<GvCV> macro.
482 GV* gv_fetchmeth(HV* stash, const char* name, STRLEN len, I32 level)
489 See L<gv_fetchmethod_autoload>.
491 GV* gv_fetchmethod(HV* stash, const char* name)
496 =item gv_fetchmethod_autoload
498 Returns the glob which contains the subroutine to call to invoke the method
499 on the C<stash>. In fact in the presence of autoloading this may be the
500 glob for "AUTOLOAD". In this case the corresponding variable $AUTOLOAD is
503 The third parameter of C<gv_fetchmethod_autoload> determines whether
504 AUTOLOAD lookup is performed if the given method is not present: non-zero
505 means yes, look for AUTOLOAD; zero means no, don't look for AUTOLOAD.
506 Calling C<gv_fetchmethod> is equivalent to calling C<gv_fetchmethod_autoload>
507 with a non-zero C<autoload> parameter.
509 These functions grant C<"SUPER"> token as a prefix of the method name. Note
510 that if you want to keep the returned glob for a long time, you need to
511 check for it being "AUTOLOAD", since at the later time the call may load a
512 different subroutine due to $AUTOLOAD changing its value. Use the glob
513 created via a side effect to do this.
515 These functions have the same side-effects and as C<gv_fetchmeth> with
516 C<level==0>. C<name> should be writable if contains C<':'> or C<'
517 ''>. The warning against passing the GV returned by C<gv_fetchmeth> to
518 C<call_sv> apply equally to these functions.
520 GV* gv_fetchmethod_autoload(HV* stash, const char* name, I32 autoload)
527 Returns a pointer to the stash for a specified package. C<name> should
528 be a valid UTF-8 string. If C<create> is set then the package will be
529 created if it does not already exist. If C<create> is not set and the
530 package does not exist then NULL is returned.
532 HV* gv_stashpv(const char* name, I32 create)
539 Returns a pointer to the stash for a specified package, which must be a
540 valid UTF-8 string. See C<gv_stashpv>.
542 HV* gv_stashsv(SV* sv, I32 create)
549 Used to indicate array context. See C<GIMME_V>, C<GIMME> and
557 Indicates that arguments returned from a callback should be discarded. See
565 Used to force a Perl C<eval> wrapper around a callback. See
573 Indicates that no arguments are being sent to a callback. See
581 Used to indicate scalar context. See C<GIMME_V>, C<GIMME>, and
589 Used to indicate void context. See C<GIMME_V> and L<perlcall>.
596 This flag, used in the length slot of hash entries and magic structures,
597 specifies the structure contains a C<SV*> pointer where a C<char*> pointer
598 is to be expected. (For information only--not to be used).
605 Returns the computed hash stored in the hash entry.
614 Returns the actual pointer stored in the key slot of the hash entry. The
615 pointer may be either C<char*> or C<SV*>, depending on the value of
616 C<HeKLEN()>. Can be assigned to. The C<HePV()> or C<HeSVKEY()> macros are
617 usually preferable for finding the value of a key.
626 If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry
627 holds an C<SV*> key. Otherwise, holds the actual length of the key. Can
628 be assigned to. The C<HePV()> macro is usually preferable for finding key
631 STRLEN HeKLEN(HE* he)
638 Returns the key slot of the hash entry as a C<char*> value, doing any
639 necessary dereferencing of possibly C<SV*> keys. The length of the string
640 is placed in C<len> (this is a macro, so do I<not> use C<&len>). If you do
641 not care about what the length of the key is, you may use the global
642 variable C<PL_na>, though this is rather less efficient than using a local
643 variable. Remember though, that hash keys in perl are free to contain
644 embedded nulls, so using C<strlen()> or similar is not a good way to find
645 the length of hash keys. This is very similar to the C<SvPV()> macro
646 described elsewhere in this document.
648 char* HePV(HE* he, STRLEN len)
655 Returns the key as an C<SV*>, or C<Nullsv> if the hash entry does not
656 contain an C<SV*> key.
665 Returns the key as an C<SV*>. Will create and return a temporary mortal
666 C<SV*> if the hash entry contains only a C<char*> key.
668 SV* HeSVKEY_force(HE* he)
675 Sets the key to a given C<SV*>, taking care to set the appropriate flags to
676 indicate the presence of an C<SV*> key, and returns the same
679 SV* HeSVKEY_set(HE* he, SV* sv)
686 Returns the value slot (type C<SV*>) stored in the hash entry.
695 Returns the package name of a stash. See C<SvSTASH>, C<CvSTASH>.
697 char* HvNAME(HV* stash)
704 Clears a hash, making it empty.
706 void hv_clear(HV* tb)
713 Deletes a key/value pair in the hash. The value SV is removed from the
714 hash and returned to the caller. The C<klen> is the length of the key.
715 The C<flags> value will normally be zero; if set to G_DISCARD then NULL
718 SV* hv_delete(HV* tb, const char* key, U32 klen, I32 flags)
725 Deletes a key/value pair in the hash. The value SV is removed from the
726 hash and returned to the caller. The C<flags> value will normally be zero;
727 if set to G_DISCARD then NULL will be returned. C<hash> can be a valid
728 precomputed hash value, or 0 to ask for it to be computed.
730 SV* hv_delete_ent(HV* tb, SV* key, I32 flags, U32 hash)
737 Returns a boolean indicating whether the specified hash key exists. The
738 C<klen> is the length of the key.
740 bool hv_exists(HV* tb, const char* key, U32 klen)
747 Returns a boolean indicating whether the specified hash key exists. C<hash>
748 can be a valid precomputed hash value, or 0 to ask for it to be
751 bool hv_exists_ent(HV* tb, SV* key, U32 hash)
758 Returns the SV which corresponds to the specified key in the hash. The
759 C<klen> is the length of the key. If C<lval> is set then the fetch will be
760 part of a store. Check that the return value is non-null before
761 dereferencing it to a C<SV*>.
763 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
764 information on how to use this function on tied hashes.
766 SV** hv_fetch(HV* tb, const char* key, U32 klen, I32 lval)
773 Returns the hash entry which corresponds to the specified key in the hash.
774 C<hash> must be a valid precomputed hash number for the given C<key>, or 0
775 if you want the function to compute it. IF C<lval> is set then the fetch
776 will be part of a store. Make sure the return value is non-null before
777 accessing it. The return value when C<tb> is a tied hash is a pointer to a
778 static location, so be sure to make a copy of the structure if you need to
781 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
782 information on how to use this function on tied hashes.
784 HE* hv_fetch_ent(HV* tb, SV* key, I32 lval, U32 hash)
791 Prepares a starting point to traverse a hash table. Returns the number of
792 keys in the hash (i.e. the same as C<HvKEYS(tb)>). The return value is
793 currently only meaningful for hashes without tie magic.
795 NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
796 hash buckets that happen to be in use. If you still need that esoteric
797 value, you can get it through the macro C<HvFILL(tb)>.
799 I32 hv_iterinit(HV* tb)
806 Returns the key from the current position of the hash iterator. See
809 char* hv_iterkey(HE* entry, I32* retlen)
816 Returns the key as an C<SV*> from the current position of the hash
817 iterator. The return value will always be a mortal copy of the key. Also
820 SV* hv_iterkeysv(HE* entry)
827 Returns entries from a hash iterator. See C<hv_iterinit>.
829 HE* hv_iternext(HV* tb)
836 Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
839 SV* hv_iternextsv(HV* hv, char** key, I32* retlen)
846 Returns the value from the current position of the hash iterator. See
849 SV* hv_iterval(HV* tb, HE* entry)
856 Adds magic to a hash. See C<sv_magic>.
858 void hv_magic(HV* hv, GV* gv, int how)
865 Stores an SV in a hash. The hash key is specified as C<key> and C<klen> is
866 the length of the key. The C<hash> parameter is the precomputed hash
867 value; if it is zero then Perl will compute it. The return value will be
868 NULL if the operation failed or if the value did not need to be actually
869 stored within the hash (as in the case of tied hashes). Otherwise it can
870 be dereferenced to get the original C<SV*>. Note that the caller is
871 responsible for suitably incrementing the reference count of C<val> before
872 the call, and decrementing it if the function returned NULL.
874 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
875 information on how to use this function on tied hashes.
877 SV** hv_store(HV* tb, const char* key, U32 klen, SV* val, U32 hash)
884 Stores C<val> in a hash. The hash key is specified as C<key>. The C<hash>
885 parameter is the precomputed hash value; if it is zero then Perl will
886 compute it. The return value is the new hash entry so created. It will be
887 NULL if the operation failed or if the value did not need to be actually
888 stored within the hash (as in the case of tied hashes). Otherwise the
889 contents of the return value can be accessed using the C<He???> macros
890 described here. Note that the caller is responsible for suitably
891 incrementing the reference count of C<val> before the call, and
892 decrementing it if the function returned NULL.
894 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
895 information on how to use this function on tied hashes.
897 HE* hv_store_ent(HV* tb, SV* key, SV* val, U32 hash)
906 void hv_undef(HV* tb)
913 Returns a boolean indicating whether the C C<char> is an ASCII alphanumeric
914 character (including underscore) or digit.
916 bool isALNUM(char ch)
919 Found in file handy.h
923 Returns a boolean indicating whether the C C<char> is an ASCII alphabetic
926 bool isALPHA(char ch)
929 Found in file handy.h
933 Returns a boolean indicating whether the C C<char> is an ASCII
936 bool isDIGIT(char ch)
939 Found in file handy.h
943 Returns a boolean indicating whether the C C<char> is a lowercase
946 bool isLOWER(char ch)
949 Found in file handy.h
953 Returns a boolean indicating whether the C C<char> is whitespace.
955 bool isSPACE(char ch)
958 Found in file handy.h
962 Returns a boolean indicating whether the C C<char> is an uppercase
965 bool isUPPER(char ch)
968 Found in file handy.h
972 Variable which is setup by C<xsubpp> to indicate the number of
973 items on the stack. See L<perlxs/"Variable-length Parameter Lists">.
982 Variable which is setup by C<xsubpp> to indicate which of an
983 XSUB's aliases was used to invoke it. See L<perlxs/"The ALIAS: Keyword">.
992 Closing bracket on a callback. See C<ENTER> and L<perlcall>.
997 Found in file scope.h
999 =item looks_like_number
1001 Test if an the content of an SV looks like a number (or is a
1004 I32 looks_like_number(SV* sv)
1011 Stack marker variable for the XSUB. See C<dMARK>.
1018 Clear something magical that the SV represents. See C<sv_magic>.
1020 int mg_clear(SV* sv)
1027 Copies the magic from one SV to another. See C<sv_magic>.
1029 int mg_copy(SV* sv, SV* nsv, const char* key, I32 klen)
1036 Finds the magic pointer for type matching the SV. See C<sv_magic>.
1038 MAGIC* mg_find(SV* sv, int type)
1045 Free any magic storage used by the SV. See C<sv_magic>.
1054 Do magic after a value is retrieved from the SV. See C<sv_magic>.
1063 Report on the SV's length. See C<sv_magic>.
1065 U32 mg_length(SV* sv)
1072 Turns on the magical status of an SV. See C<sv_magic>.
1074 void mg_magical(SV* sv)
1081 Do magic after a value is assigned to the SV. See C<sv_magic>.
1090 The XSUB-writer's interface to the C C<memmove> function. The C<src> is the
1091 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1092 the type. Can do overlapping moves. See also C<Copy>.
1094 void Move(void* src, void* dest, int nitems, type)
1097 Found in file handy.h
1101 The XSUB-writer's interface to the C C<malloc> function.
1103 void New(int id, void* ptr, int nitems, type)
1106 Found in file handy.h
1110 Creates a new AV. The reference count is set to 1.
1119 The XSUB-writer's interface to the C C<malloc> function, with
1122 void Newc(int id, void* ptr, int nitems, type, cast)
1125 Found in file handy.h
1129 Creates a constant sub equivalent to Perl C<sub FOO () { 123 }> which is
1130 eligible for inlining at compile-time.
1132 void newCONSTSUB(HV* stash, char* name, SV* sv)
1139 Creates a new HV. The reference count is set to 1.
1148 Creates an RV wrapper for an SV. The reference count for the original SV is
1151 SV* newRV_inc(SV* sv)
1158 Creates an RV wrapper for an SV. The reference count for the original
1159 SV is B<not> incremented.
1161 SV* newRV_noinc(SV *sv)
1168 Creates a new SV. A non-zero C<len> parameter indicates the number of
1169 bytes of preallocated string space the SV should have. An extra byte for a
1170 tailing NUL is also reserved. (SvPOK is not set for the SV even if string
1171 space is allocated.) The reference count for the new SV is set to 1.
1172 C<id> is an integer id between 0 and 1299 (used to identify leaks).
1174 SV* NEWSV(int id, STRLEN len)
1177 Found in file handy.h
1181 Creates a new SV and copies an integer into it. The reference count for the
1191 Creates a new SV and copies a floating point value into it.
1192 The reference count for the SV is set to 1.
1201 Creates a new SV and copies a string into it. The reference count for the
1202 SV is set to 1. If C<len> is zero, Perl will compute the length using
1203 strlen(). For efficiency, consider using C<newSVpvn> instead.
1205 SV* newSVpv(const char* s, STRLEN len)
1212 Creates a new SV an initialize it with the string formatted like
1215 SV* newSVpvf(const char* pat, ...)
1222 Creates a new SV and copies a string into it. The reference count for the
1223 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
1224 string. You are responsible for ensuring that the source string is at least
1227 SV* newSVpvn(const char* s, STRLEN len)
1234 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
1235 it will be upgraded to one. If C<classname> is non-null then the new SV will
1236 be blessed in the specified package. The new SV is returned and its
1237 reference count is 1.
1239 SV* newSVrv(SV* rv, const char* classname)
1246 Creates a new SV which is an exact duplicate of the original SV.
1248 SV* newSVsv(SV* old)
1255 Creates a new SV and copies an unsigned integer into it.
1256 The reference count for the SV is set to 1.
1265 Used by C<xsubpp> to hook up XSUBs as Perl subs.
1272 Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
1276 Found in file XSUB.h
1280 The XSUB-writer's interface to the C C<malloc> function. The allocated
1281 memory is zeroed with C<memzero>.
1283 void Newz(int id, void* ptr, int nitems, type)
1286 Found in file handy.h
1297 Null character pointer.
1300 Found in file handy.h
1321 Found in file handy.h
1325 The original stack mark for the XSUB. See C<dORIGMARK>.
1332 Allocates a new Perl interpreter. See L<perlembed>.
1334 PerlInterpreter* perl_alloc()
1337 Found in file perl.c
1339 =item perl_construct
1341 Initializes a new Perl interpreter. See L<perlembed>.
1343 void perl_construct(PerlInterpreter* interp)
1346 Found in file perl.c
1350 Shuts down a Perl interpreter. See L<perlembed>.
1352 void perl_destruct(PerlInterpreter* interp)
1355 Found in file perl.c
1359 Releases a Perl interpreter. See L<perlembed>.
1361 void perl_free(PerlInterpreter* interp)
1364 Found in file perl.c
1368 Tells a Perl interpreter to parse a Perl script. See L<perlembed>.
1370 int perl_parse(PerlInterpreter* interp, XSINIT_t xsinit, int argc, char** argv, char** env)
1373 Found in file perl.c
1377 Tells a Perl interpreter to run. See L<perlembed>.
1379 int perl_run(PerlInterpreter* interp)
1382 Found in file perl.c
1386 When Perl is run in debugging mode, with the B<-d> switch, this SV is a
1387 boolean which indicates whether subs are being single-stepped.
1388 Single-stepping is automatically turned on after every step. This is the C
1389 variable which corresponds to Perl's $DB::single variable. See
1395 Found in file intrpvar.h
1399 When Perl is run in debugging mode, with the B<-d> switch, this GV contains
1400 the SV which holds the name of the sub being debugged. This is the C
1401 variable which corresponds to Perl's $DB::sub variable. See
1407 Found in file intrpvar.h
1411 Trace variable used when Perl is run in debugging mode, with the B<-d>
1412 switch. This is the C variable which corresponds to Perl's $DB::trace
1413 variable. See C<PL_DBsingle>.
1418 Found in file intrpvar.h
1422 The C variable which corresponds to Perl's $^W warning variable.
1427 Found in file intrpvar.h
1431 C<PL_modglobal> is a general purpose, interpreter global HV for use by
1432 extensions that need to keep information on a per-interpreter basis.
1433 In a pinch, it can also be used as a symbol table for extensions
1434 to share data among each other. It is a good idea to use keys
1435 prefixed by the package name of the extension that owns the data.
1440 Found in file intrpvar.h
1444 A convenience variable which is typically used with C<SvPV> when one
1445 doesn't care about the length of the string. It is usually more efficient
1446 to either declare a local variable and use that instead or to use the
1447 C<SvPV_nolen> macro.
1452 Found in file thrdvar.h
1456 This is the C<false> SV. See C<PL_sv_yes>. Always refer to this as
1462 Found in file intrpvar.h
1466 This is the C<undef> SV. Always refer to this as C<&PL_sv_undef>.
1471 Found in file intrpvar.h
1475 This is the C<true> SV. See C<PL_sv_no>. Always refer to this as
1481 Found in file intrpvar.h
1485 Pops an integer off the stack.
1494 Pops a long off the stack.
1503 Pops a double off the stack.
1512 Pops a string off the stack.
1521 Pops an SV off the stack.
1530 Push an integer onto the stack. The stack must have room for this element.
1531 Handles 'set' magic. See C<XPUSHi>.
1540 Opening bracket for arguments on a callback. See C<PUTBACK> and
1550 Push a double onto the stack. The stack must have room for this element.
1551 Handles 'set' magic. See C<XPUSHn>.
1560 Push a string onto the stack. The stack must have room for this element.
1561 The C<len> indicates the length of the string. Handles 'set' magic. See
1564 void PUSHp(char* str, STRLEN len)
1571 Push an SV onto the stack. The stack must have room for this element.
1572 Does not handle 'set' magic. See C<XPUSHs>.
1581 Push an unsigned integer onto the stack. The stack must have room for this
1582 element. See C<XPUSHu>.
1591 Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
1592 See C<PUSHMARK> and L<perlcall> for other uses.
1601 The XSUB-writer's interface to the C C<realloc> function.
1603 void Renew(void* ptr, int nitems, type)
1606 Found in file handy.h
1610 The XSUB-writer's interface to the C C<realloc> function, with
1613 void Renewc(void* ptr, int nitems, type, cast)
1616 Found in file handy.h
1620 Tells Perl to C<require> a module.
1622 NOTE: the perl_ form of this function is deprecated.
1624 void require_pv(const char* pv)
1627 Found in file perl.c
1631 Variable which is setup by C<xsubpp> to hold the return value for an
1632 XSUB. This is always the proper type for the XSUB. See
1633 L<perlxs/"The RETVAL Variable">.
1638 Found in file XSUB.h
1642 The XSUB-writer's interface to the C C<free> function.
1644 void Safefree(void* src, void* dest, int nitems, type)
1647 Found in file handy.h
1651 Copy a string to a safe spot. This does not use an SV.
1653 char* savepv(const char* sv)
1656 Found in file util.c
1660 Copy a string to a safe spot. The C<len> indicates number of bytes to
1661 copy. This does not use an SV.
1663 char* savepvn(const char* sv, I32 len)
1666 Found in file util.c
1670 Opening bracket for temporaries on a callback. See C<FREETMPS> and
1676 Found in file scope.h
1680 Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and
1688 Refetch the stack pointer. Used after a callback. See L<perlcall>.
1697 Used to access elements on the XSUB's stack.
1702 Found in file XSUB.h
1706 Test two strings to see if they are equal. Returns true or false.
1708 bool strEQ(char* s1, char* s2)
1711 Found in file handy.h
1715 Test two strings to see if the first, C<s1>, is greater than or equal to
1716 the second, C<s2>. Returns true or false.
1718 bool strGE(char* s1, char* s2)
1721 Found in file handy.h
1725 Test two strings to see if the first, C<s1>, is greater than the second,
1726 C<s2>. Returns true or false.
1728 bool strGT(char* s1, char* s2)
1731 Found in file handy.h
1735 Test two strings to see if the first, C<s1>, is less than or equal to the
1736 second, C<s2>. Returns true or false.
1738 bool strLE(char* s1, char* s2)
1741 Found in file handy.h
1745 Test two strings to see if the first, C<s1>, is less than the second,
1746 C<s2>. Returns true or false.
1748 bool strLT(char* s1, char* s2)
1751 Found in file handy.h
1755 Test two strings to see if they are different. Returns true or
1758 bool strNE(char* s1, char* s2)
1761 Found in file handy.h
1765 Test two strings to see if they are equal. The C<len> parameter indicates
1766 the number of bytes to compare. Returns true or false. (A wrapper for
1769 bool strnEQ(char* s1, char* s2, STRLEN len)
1772 Found in file handy.h
1776 Test two strings to see if they are different. The C<len> parameter
1777 indicates the number of bytes to compare. Returns true or false. (A
1778 wrapper for C<strncmp>).
1780 bool strnNE(char* s1, char* s2, STRLEN len)
1783 Found in file handy.h
1787 This is an architecture-independent macro to copy one structure to another.
1789 void StructCopy(type src, type dest, type)
1792 Found in file handy.h
1796 Returns the length of the string which is in the SV. See C<SvLEN>.
1798 STRLEN SvCUR(SV* sv)
1805 Set the length of the string which is in the SV. See C<SvCUR>.
1807 void SvCUR_set(SV* sv, STRLEN len)
1814 Returns a pointer to the last character in the string which is in the SV.
1815 See C<SvCUR>. Access the character as *(SvEND(sv)).
1824 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
1825 argument more than once.
1827 void SvGETMAGIC(SV* sv)
1834 Expands the character buffer in the SV so that it has room for the
1835 indicated number of bytes (remember to reserve space for an extra trailing
1836 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
1837 Returns a pointer to the character buffer.
1839 void SvGROW(SV* sv, STRLEN len)
1846 Returns a boolean indicating whether the SV contains an integer.
1855 Returns a boolean indicating whether the SV contains an integer. Checks
1856 the B<private> setting. Use C<SvIOK>.
1865 Unsets the IV status of an SV.
1867 void SvIOK_off(SV* sv)
1874 Tells an SV that it is an integer.
1876 void SvIOK_on(SV* sv)
1883 Tells an SV that it is an integer and disables all other OK bits.
1885 void SvIOK_only(SV* sv)
1892 Coerces the given SV to an integer and returns it.
1901 Returns the integer which is stored in the SV, assuming SvIOK is
1911 Returns the size of the string buffer in the SV. See C<SvCUR>.
1913 STRLEN SvLEN(SV* sv)
1920 Aquires an internal mutex for a SV. Used to make sure multiple threads
1921 don't stomp on the guts of an SV at the same time
1930 Returns a boolean indicating whether the SV contains a number, integer or
1940 Returns a boolean indicating whether the SV contains a number, integer or
1941 double. Checks the B<private> setting. Use C<SvNIOK>.
1943 bool SvNIOKp(SV* sv)
1950 Unsets the NV/IV status of an SV.
1952 void SvNIOK_off(SV* sv)
1959 Returns a boolean indicating whether the SV contains a double.
1968 Returns a boolean indicating whether the SV contains a double. Checks the
1969 B<private> setting. Use C<SvNOK>.
1978 Unsets the NV status of an SV.
1980 void SvNOK_off(SV* sv)
1987 Tells an SV that it is a double.
1989 void SvNOK_on(SV* sv)
1996 Tells an SV that it is a double and disables all other OK bits.
1998 void SvNOK_only(SV* sv)
2005 Coerce the given SV to a double and return it.
2014 Returns the double which is stored in the SV, assuming SvNOK is
2024 Returns a boolean indicating whether the value is an SV.
2033 Returns a boolean indicating whether the SvIVX is a valid offset value for
2034 the SvPVX. This hack is used internally to speed up removal of characters
2035 from the beginning of a SvPV. When SvOOK is true, then the start of the
2036 allocated string buffer is really (SvPVX - SvIVX).
2045 Returns a boolean indicating whether the SV contains a character
2055 Returns a boolean indicating whether the SV contains a character string.
2056 Checks the B<private> setting. Use C<SvPOK>.
2065 Unsets the PV status of an SV.
2067 void SvPOK_off(SV* sv)
2074 Tells an SV that it is a string.
2076 void SvPOK_on(SV* sv)
2083 Tells an SV that it is a string and disables all other OK bits.
2085 void SvPOK_only(SV* sv)
2092 Returns a pointer to the string in the SV, or a stringified form of the SV
2093 if the SV does not contain a string. Handles 'get' magic.
2095 char* SvPV(SV* sv, STRLEN len)
2102 Returns a pointer to the string in the SV. The SV must contain a
2112 Like <SvPV> but will force the SV into becoming a string (SvPOK). You want
2113 force if you are going to update the SvPVX directly.
2115 char* SvPV_force(SV* sv, STRLEN len)
2122 Returns a pointer to the string in the SV, or a stringified form of the SV
2123 if the SV does not contain a string. Handles 'get' magic.
2125 char* SvPV_nolen(SV* sv)
2132 Returns the value of the object's reference count.
2134 U32 SvREFCNT(SV* sv)
2141 Decrements the reference count of the given SV.
2143 void SvREFCNT_dec(SV* sv)
2150 Increments the reference count of the given SV.
2152 SV* SvREFCNT_inc(SV* sv)
2159 Tests if the SV is an RV.
2168 Unsets the RV status of an SV.
2170 void SvROK_off(SV* sv)
2177 Tells an SV that it is an RV.
2179 void SvROK_on(SV* sv)
2186 Dereferences an RV to return the SV.
2195 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
2196 argument more than once.
2198 void SvSETMAGIC(SV* sv)
2205 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
2208 void SvSetSV(SV* dsb, SV* ssv)
2213 =item SvSetSV_nosteal
2215 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
2216 ssv. May evaluate arguments more than once.
2218 void SvSetSV_nosteal(SV* dsv, SV* ssv)
2225 Returns the stash of the SV.
2234 Taints an SV if tainting is enabled
2236 void SvTAINT(SV* sv)
2243 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
2246 bool SvTAINTED(SV* sv)
2253 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
2254 some of Perl's fundamental security features. XS module authors should not
2255 use this function unless they fully understand all the implications of
2256 unconditionally untainting the value. Untainting should be done in the
2257 standard perl fashion, via a carefully crafted regexp, rather than directly
2258 untainting variables.
2260 void SvTAINTED_off(SV* sv)
2267 Marks an SV as tainted.
2269 void SvTAINTED_on(SV* sv)
2276 Returns a boolean indicating whether Perl would evaluate the SV as true or
2277 false, defined or undefined. Does not handle 'get' magic.
2286 An enum of flags for Perl types. These are found in the file B<sv.h>
2287 in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
2294 Returns the type of the SV. See C<svtype>.
2296 svtype SvTYPE(SV* sv)
2303 Integer type flag for scalars. See C<svtype>.
2310 Double type flag for scalars. See C<svtype>.
2317 Pointer type flag for scalars. See C<svtype>.
2324 Type flag for arrays. See C<svtype>.
2331 Type flag for code refs. See C<svtype>.
2338 Type flag for hashes. See C<svtype>.
2345 Type flag for blessed scalars. See C<svtype>.
2352 Release the internal mutex for an SV.
2354 void SvUNLOCK(SV* sv)
2361 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
2362 perform the upgrade if necessary. See C<svtype>.
2364 void SvUPGRADE(SV* sv, svtype type)
2371 Coerces the given SV to an unsigned integer and returns it.
2380 Returns the unsigned integer which is stored in the SV, assuming SvIOK is
2390 Marks an SV as mortal. The SV will be destroyed when the current context
2393 SV* sv_2mortal(SV* sv)
2400 Blesses an SV into a specified package. The SV must be an RV. The package
2401 must be designated by its stash (see C<gv_stashpv()>). The reference count
2402 of the SV is unaffected.
2404 SV* sv_bless(SV* sv, HV* stash)
2411 Concatenates the string onto the end of the string which is in the SV.
2412 Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
2414 void sv_catpv(SV* sv, const char* ptr)
2421 Processes its arguments like C<sprintf> and appends the formatted output
2422 to an SV. Handles 'get' magic, but not 'set' magic. C<SvSETMAGIC()> must
2423 typically be called after calling this function to handle 'set' magic.
2425 void sv_catpvf(SV* sv, const char* pat, ...)
2432 Like C<sv_catpvf>, but also handles 'set' magic.
2434 void sv_catpvf_mg(SV *sv, const char* pat, ...)
2441 Concatenates the string onto the end of the string which is in the SV. The
2442 C<len> indicates number of bytes to copy. Handles 'get' magic, but not
2443 'set' magic. See C<sv_catpvn_mg>.
2445 void sv_catpvn(SV* sv, const char* ptr, STRLEN len)
2452 Like C<sv_catpvn>, but also handles 'set' magic.
2454 void sv_catpvn_mg(SV *sv, const char *ptr, STRLEN len)
2461 Like C<sv_catpv>, but also handles 'set' magic.
2463 void sv_catpv_mg(SV *sv, const char *ptr)
2470 Concatenates the string from SV C<ssv> onto the end of the string in SV
2471 C<dsv>. Handles 'get' magic, but not 'set' magic. See C<sv_catsv_mg>.
2473 void sv_catsv(SV* dsv, SV* ssv)
2480 Like C<sv_catsv>, but also handles 'set' magic.
2482 void sv_catsv_mg(SV *dstr, SV *sstr)
2489 Efficient removal of characters from the beginning of the string buffer.
2490 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
2491 the string buffer. The C<ptr> becomes the first character of the adjusted
2494 void sv_chop(SV* sv, char* ptr)
2501 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
2502 string in C<sv1> is less than, equal to, or greater than the string in
2505 I32 sv_cmp(SV* sv1, SV* sv2)
2512 Auto-decrement of the value in the SV.
2519 =item sv_derived_from
2521 Returns a boolean indicating whether the SV is derived from the specified
2522 class. This is the function that implements C<UNIVERSAL::isa>. It works
2523 for class names as well as for objects.
2525 bool sv_derived_from(SV* sv, const char* name)
2528 Found in file universal.c
2532 Returns a boolean indicating whether the strings in the two SVs are
2535 I32 sv_eq(SV* sv1, SV* sv2)
2542 Expands the character buffer in the SV. This will use C<sv_unref> and will
2543 upgrade the SV to C<SVt_PV>. Returns a pointer to the character buffer.
2546 char* sv_grow(SV* sv, STRLEN newlen)
2553 Auto-increment of the value in the SV.
2562 Inserts a string at the specified offset/length within the SV. Similar to
2563 the Perl substr() function.
2565 void sv_insert(SV* bigsv, STRLEN offset, STRLEN len, char* little, STRLEN littlelen)
2572 Returns a boolean indicating whether the SV is blessed into the specified
2573 class. This does not check for subtypes; use C<sv_derived_from> to verify
2574 an inheritance relationship.
2576 int sv_isa(SV* sv, const char* name)
2583 Returns a boolean indicating whether the SV is an RV pointing to a blessed
2584 object. If the SV is not an RV, or if the object is not blessed, then this
2587 int sv_isobject(SV* sv)
2594 Returns the length of the string in the SV. See also C<SvCUR>.
2596 STRLEN sv_len(SV* sv)
2603 Adds magic to an SV.
2605 void sv_magic(SV* sv, SV* obj, int how, const char* name, I32 namlen)
2612 Creates a new SV which is a copy of the original SV. The new SV is marked
2615 SV* sv_mortalcopy(SV* oldsv)
2622 Creates a new SV which is mortal. The reference count of the SV is set to 1.
2631 Copies an integer into the given SV. Does not handle 'set' magic. See
2634 void sv_setiv(SV* sv, IV num)
2641 Like C<sv_setiv>, but also handles 'set' magic.
2643 void sv_setiv_mg(SV *sv, IV i)
2650 Copies a double into the given SV. Does not handle 'set' magic. See
2653 void sv_setnv(SV* sv, NV num)
2660 Like C<sv_setnv>, but also handles 'set' magic.
2662 void sv_setnv_mg(SV *sv, NV num)
2669 Copies a string into an SV. The string must be null-terminated. Does not
2670 handle 'set' magic. See C<sv_setpv_mg>.
2672 void sv_setpv(SV* sv, const char* ptr)
2679 Processes its arguments like C<sprintf> and sets an SV to the formatted
2680 output. Does not handle 'set' magic. See C<sv_setpvf_mg>.
2682 void sv_setpvf(SV* sv, const char* pat, ...)
2689 Like C<sv_setpvf>, but also handles 'set' magic.
2691 void sv_setpvf_mg(SV *sv, const char* pat, ...)
2698 Copies an integer into the given SV, also updating its string value.
2699 Does not handle 'set' magic. See C<sv_setpviv_mg>.
2701 void sv_setpviv(SV* sv, IV num)
2708 Like C<sv_setpviv>, but also handles 'set' magic.
2710 void sv_setpviv_mg(SV *sv, IV iv)
2717 Copies a string into an SV. The C<len> parameter indicates the number of
2718 bytes to be copied. Does not handle 'set' magic. See C<sv_setpvn_mg>.
2720 void sv_setpvn(SV* sv, const char* ptr, STRLEN len)
2727 Like C<sv_setpvn>, but also handles 'set' magic.
2729 void sv_setpvn_mg(SV *sv, const char *ptr, STRLEN len)
2736 Like C<sv_setpv>, but also handles 'set' magic.
2738 void sv_setpv_mg(SV *sv, const char *ptr)
2745 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
2746 argument will be upgraded to an RV. That RV will be modified to point to
2747 the new SV. The C<classname> argument indicates the package for the
2748 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
2749 will be returned and will have a reference count of 1.
2751 SV* sv_setref_iv(SV* rv, const char* classname, IV iv)
2758 Copies a double into a new SV, optionally blessing the SV. The C<rv>
2759 argument will be upgraded to an RV. That RV will be modified to point to
2760 the new SV. The C<classname> argument indicates the package for the
2761 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
2762 will be returned and will have a reference count of 1.
2764 SV* sv_setref_nv(SV* rv, const char* classname, NV nv)
2771 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
2772 argument will be upgraded to an RV. That RV will be modified to point to
2773 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
2774 into the SV. The C<classname> argument indicates the package for the
2775 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
2776 will be returned and will have a reference count of 1.
2778 Do not use with other Perl types such as HV, AV, SV, CV, because those
2779 objects will become corrupted by the pointer copy process.
2781 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
2783 SV* sv_setref_pv(SV* rv, const char* classname, void* pv)
2790 Copies a string into a new SV, optionally blessing the SV. The length of the
2791 string must be specified with C<n>. The C<rv> argument will be upgraded to
2792 an RV. That RV will be modified to point to the new SV. The C<classname>
2793 argument indicates the package for the blessing. Set C<classname> to
2794 C<Nullch> to avoid the blessing. The new SV will be returned and will have
2795 a reference count of 1.
2797 Note that C<sv_setref_pv> copies the pointer while this copies the string.
2799 SV* sv_setref_pvn(SV* rv, const char* classname, char* pv, STRLEN n)
2806 Copies the contents of the source SV C<ssv> into the destination SV C<dsv>.
2807 The source SV may be destroyed if it is mortal. Does not handle 'set'
2808 magic. See the macro forms C<SvSetSV>, C<SvSetSV_nosteal> and
2811 void sv_setsv(SV* dsv, SV* ssv)
2818 Like C<sv_setsv>, but also handles 'set' magic.
2820 void sv_setsv_mg(SV *dstr, SV *sstr)
2827 Copies an unsigned integer into the given SV. Does not handle 'set' magic.
2830 void sv_setuv(SV* sv, UV num)
2837 Like C<sv_setuv>, but also handles 'set' magic.
2839 void sv_setuv_mg(SV *sv, UV u)
2846 Unsets the RV status of the SV, and decrements the reference count of
2847 whatever was being referenced by the RV. This can almost be thought of
2848 as a reversal of C<newSVrv>. See C<SvROK_off>.
2850 void sv_unref(SV* sv)
2857 Upgrade an SV to a more complex form. Use C<SvUPGRADE>. See
2860 bool sv_upgrade(SV* sv, U32 mt)
2867 Tells an SV to use C<ptr> to find its string value. Normally the string is
2868 stored inside the SV but sv_usepvn allows the SV to use an outside string.
2869 The C<ptr> should point to memory that was allocated by C<malloc>. The
2870 string length, C<len>, must be supplied. This function will realloc the
2871 memory pointed to by C<ptr>, so that pointer should not be freed or used by
2872 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
2873 See C<sv_usepvn_mg>.
2875 void sv_usepvn(SV* sv, char* ptr, STRLEN len)
2882 Like C<sv_usepvn>, but also handles 'set' magic.
2884 void sv_usepvn_mg(SV *sv, char *ptr, STRLEN len)
2891 Processes its arguments like C<vsprintf> and appends the formatted output
2892 to an SV. Uses an array of SVs if the C style variable argument list is
2893 missing (NULL). When running with taint checks enabled, indicates via
2894 C<maybe_tainted> if results are untrustworthy (often due to the use of
2897 void sv_vcatpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
2904 Works like C<vcatpvfn> but copies the text into the SV instead of
2907 void sv_vsetpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
2914 Variable which is setup by C<xsubpp> to designate the object in a C++
2915 XSUB. This is always the proper type for the C++ object. See C<CLASS> and
2916 L<perlxs/"Using XS With C++">.
2921 Found in file XSUB.h
2925 Converts the specified character to lowercase.
2927 char toLOWER(char ch)
2930 Found in file handy.h
2934 Converts the specified character to uppercase.
2936 char toUPPER(char ch)
2939 Found in file handy.h
2943 Converts a string C<s> of length C<len> from UTF8 into ASCII encoding.
2944 Unlike C<bytes_to_utf8>, this over-writes the original string.
2946 U8 * utf8_to_bytes(U8 *s, STRLEN len)
2949 Found in file utf8.c
2953 This is the XSUB-writer's interface to Perl's C<warn> function. Use this
2954 function the same way you use the C C<printf> function. See
2957 void warn(const char* pat, ...)
2960 Found in file util.c
2964 Push an integer onto the stack, extending the stack if necessary. Handles
2965 'set' magic. See C<PUSHi>.
2974 Push a double onto the stack, extending the stack if necessary. Handles
2975 'set' magic. See C<PUSHn>.
2984 Push a string onto the stack, extending the stack if necessary. The C<len>
2985 indicates the length of the string. Handles 'set' magic. See
2988 void XPUSHp(char* str, STRLEN len)
2995 Push an SV onto the stack, extending the stack if necessary. Does not
2996 handle 'set' magic. See C<PUSHs>.
3005 Push an unsigned integer onto the stack, extending the stack if necessary.
3015 Macro to declare an XSUB and its C parameter list. This is handled by
3019 Found in file XSUB.h
3023 Return from XSUB, indicating number of items on the stack. This is usually
3024 handled by C<xsubpp>.
3026 void XSRETURN(int nitems)
3029 Found in file XSUB.h
3031 =item XSRETURN_EMPTY
3033 Return an empty list from an XSUB immediately.
3038 Found in file XSUB.h
3042 Return an integer from an XSUB immediately. Uses C<XST_mIV>.
3044 void XSRETURN_IV(IV iv)
3047 Found in file XSUB.h
3051 Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
3056 Found in file XSUB.h
3060 Return an double from an XSUB immediately. Uses C<XST_mNV>.
3062 void XSRETURN_NV(NV nv)
3065 Found in file XSUB.h
3069 Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
3071 void XSRETURN_PV(char* str)
3074 Found in file XSUB.h
3076 =item XSRETURN_UNDEF
3078 Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
3083 Found in file XSUB.h
3087 Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
3092 Found in file XSUB.h
3096 Place an integer into the specified position C<pos> on the stack. The
3097 value is stored in a new mortal SV.
3099 void XST_mIV(int pos, IV iv)
3102 Found in file XSUB.h
3106 Place C<&PL_sv_no> into the specified position C<pos> on the
3109 void XST_mNO(int pos)
3112 Found in file XSUB.h
3116 Place a double into the specified position C<pos> on the stack. The value
3117 is stored in a new mortal SV.
3119 void XST_mNV(int pos, NV nv)
3122 Found in file XSUB.h
3126 Place a copy of a string into the specified position C<pos> on the stack.
3127 The value is stored in a new mortal SV.
3129 void XST_mPV(int pos, char* str)
3132 Found in file XSUB.h
3136 Place C<&PL_sv_undef> into the specified position C<pos> on the
3139 void XST_mUNDEF(int pos)
3142 Found in file XSUB.h
3146 Place C<&PL_sv_yes> into the specified position C<pos> on the
3149 void XST_mYES(int pos)
3152 Found in file XSUB.h
3156 The version identifier for an XS module. This is usually
3157 handled automatically by C<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>.
3160 Found in file XSUB.h
3162 =item XS_VERSION_BOOTCHECK
3164 Macro to verify that a PM module's $VERSION variable matches the XS
3165 module's C<XS_VERSION> variable. This is usually handled automatically by
3166 C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">.
3168 XS_VERSION_BOOTCHECK;
3171 Found in file XSUB.h
3175 The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the
3176 destination, C<nitems> is the number of items, and C<type> is the type.
3178 void Zero(void* dest, int nitems, type)
3181 Found in file handy.h
3187 Until May 1997, this document was maintained by Jeff Okamoto
3188 <okamoto@corp.hp.com>. It is now maintained as part of Perl itself.
3190 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
3191 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
3192 Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
3193 Stephen McCamant, and Gurusamy Sarathy.
3195 API Listing originally by Dean Roehrich <roehrich@cray.com>.
3197 Updated to be autogenerated from comments in the source by Benjamin Stuhl.
3201 perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
projects / p5sagit/p5-mst-13.2.git / blob