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 Deletes the element indexed by C<key> from the array. Returns the
44 deleted element. C<flags> is currently ignored.
46 SV* av_delete(AV* ar, I32 key, I32 flags)
53 Returns true if the element indexed by C<key> has been initialized.
55 This relies on the fact that uninitialized array elements are set to
58 bool av_exists(AV* ar, I32 key)
65 Pre-extend an array. The C<key> is the index to which the array should be
68 void av_extend(AV* ar, I32 key)
75 Returns the SV at the specified index in the array. The C<key> is the
76 index. If C<lval> is set then the fetch will be part of a store. Check
77 that the return value is non-null before dereferencing it to a C<SV*>.
79 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for
80 more information on how to use this function on tied arrays.
82 SV** av_fetch(AV* ar, I32 key, I32 lval)
89 Ensure than an array has a given number of elements, equivalent to
90 Perl's C<$#array = $fill;>.
92 void av_fill(AV* ar, I32 fill)
99 Returns the highest index in the array. Returns -1 if the array is
109 Creates a new AV and populates it with a list of SVs. The SVs are copied
110 into the array, so they may be freed after the call to av_make. The new AV
111 will have a reference count of 1.
113 AV* av_make(I32 size, SV** svp)
120 Pops an SV off the end of the array. Returns C<&PL_sv_undef> if the array
130 Pushes an SV onto the end of the array. The array will grow automatically
131 to accommodate the addition.
133 void av_push(AV* ar, SV* val)
140 Shifts an SV off the beginning of the array.
149 Stores an SV in an array. The array index is specified as C<key>. The
150 return value will be NULL if the operation failed or if the value did not
151 need to be actually stored within the array (as in the case of tied
152 arrays). Otherwise it can be dereferenced to get the original C<SV*>. Note
153 that the caller is responsible for suitably incrementing the reference
154 count of C<val> before the call, and decrementing it if the function
157 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for
158 more information on how to use this function on tied arrays.
160 SV** av_store(AV* ar, I32 key, SV* val)
167 Undefines the array. Frees the memory used by the array itself.
169 void av_undef(AV* ar)
176 Unshift the given number of C<undef> values onto the beginning of the
177 array. The array will grow automatically to accommodate the addition. You
178 must then use C<av_store> to assign values to these new elements.
180 void av_unshift(AV* ar, I32 num)
187 Converts a string C<s> of length C<len> from ASCII into UTF8 encoding.
188 Returns a pointer to the newly-created string, and sets C<len> to
189 reflect the new length.
191 U8 * bytes_to_utf8(U8 *s, STRLEN *len)
198 Performs a callback to the specified Perl sub. See L<perlcall>.
200 NOTE: the perl_ form of this function is deprecated.
202 I32 call_argv(const char* sub_name, I32 flags, char** argv)
209 Performs a callback to the specified Perl method. The blessed object must
210 be on the stack. See L<perlcall>.
212 NOTE: the perl_ form of this function is deprecated.
214 I32 call_method(const char* methname, I32 flags)
221 Performs a callback to the specified Perl sub. See L<perlcall>.
223 NOTE: the perl_ form of this function is deprecated.
225 I32 call_pv(const char* sub_name, I32 flags)
232 Performs a callback to the Perl sub whose name is in the SV. See
235 NOTE: the perl_ form of this function is deprecated.
237 I32 call_sv(SV* sv, I32 flags)
244 Variable which is setup by C<xsubpp> to indicate the
245 class name for a C++ XS constructor. This is always a C<char*>. See C<THIS>.
254 The XSUB-writer's interface to the C C<memcpy> function. The C<src> is the
255 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
256 the type. May fail on overlapping copies. See also C<Move>.
258 void Copy(void* src, void* dest, int nitems, type)
261 Found in file handy.h
265 This is the XSUB-writer's interface to Perl's C<die> function.
266 Normally use this function the same way you use the C C<printf>
267 function. See C<warn>.
269 If you want to throw an exception object, assign the object to
270 C<$@> and then pass C<Nullch> to croak():
272 errsv = get_sv("@", TRUE);
273 sv_setsv(errsv, exception_object);
276 void croak(const char* pat, ...)
283 Returns the stash of the CV.
292 Declare a stack marker variable, C<mark>, for the XSUB. See C<MARK> and
302 Saves the original stack mark for the XSUB. See C<ORIGMARK>.
311 Declares a local copy of perl's stack pointer for the XSUB, available via
312 the C<SP> macro. See C<SP>.
321 Sets up stack and mark pointers for an XSUB, calling dSP and dMARK. This
322 is usually handled automatically by C<xsubpp>. Declares the C<items>
323 variable to indicate the number of items on the stack.
332 Sets up the C<ix> variable for an XSUB which has aliases. This is usually
333 handled automatically by C<xsubpp>.
342 Opening bracket on a callback. See C<LEAVE> and L<perlcall>.
347 Found in file scope.h
351 Tells Perl to C<eval> the given string and return an SV* result.
353 NOTE: the perl_ form of this function is deprecated.
355 SV* eval_pv(const char* p, I32 croak_on_error)
362 Tells Perl to C<eval> the string in the SV.
364 NOTE: the perl_ form of this function is deprecated.
366 I32 eval_sv(SV* sv, I32 flags)
373 Used to extend the argument stack for an XSUB's return values. Once
374 used, guarantees that there is room for at least C<nitems> to be pushed
377 void EXTEND(SP, int nitems)
384 Analyses the string in order to make fast searches on it using fbm_instr()
385 -- the Boyer-Moore algorithm.
387 void fbm_compile(SV* sv, U32 flags)
394 Returns the location of the SV in the string delimited by C<str> and
395 C<strend>. It returns C<Nullch> if the string can't be found. The C<sv>
396 does not have to be fbm_compiled, but the search will not be as fast
399 char* fbm_instr(unsigned char* big, unsigned char* bigend, SV* littlesv, U32 flags)
406 Closing bracket for temporaries on a callback. See C<SAVETMPS> and
412 Found in file scope.h
416 Returns the AV of the specified Perl array. If C<create> is set and the
417 Perl variable does not exist then it will be created. If C<create> is not
418 set and the variable does not exist then NULL is returned.
420 NOTE: the perl_ form of this function is deprecated.
422 AV* get_av(const char* name, I32 create)
429 Returns the CV of the specified Perl subroutine. If C<create> is set and
430 the Perl subroutine does not exist then it will be declared (which has the
431 same effect as saying C<sub name;>). If C<create> is not set and the
432 subroutine does not exist then NULL is returned.
434 NOTE: the perl_ form of this function is deprecated.
436 CV* get_cv(const char* name, I32 create)
443 Returns the HV of the specified Perl hash. If C<create> is set and the
444 Perl variable does not exist then it will be created. If C<create> is not
445 set and the variable does not exist then NULL is returned.
447 NOTE: the perl_ form of this function is deprecated.
449 HV* get_hv(const char* name, I32 create)
456 Returns the SV of the specified Perl scalar. If C<create> is set and the
457 Perl variable does not exist then it will be created. If C<create> is not
458 set and the variable does not exist then NULL is returned.
460 NOTE: the perl_ form of this function is deprecated.
462 SV* get_sv(const char* name, I32 create)
469 A backward-compatible version of C<GIMME_V> which can only return
470 C<G_SCALAR> or C<G_ARRAY>; in a void context, it returns C<G_SCALAR>.
471 Deprecated. Use C<GIMME_V> instead.
480 The XSUB-writer's equivalent to Perl's C<wantarray>. Returns C<G_VOID>,
481 C<G_SCALAR> or C<G_ARRAY> for void, scalar or list context,
491 Return the SV from the GV.
500 Returns the glob with the given C<name> and a defined subroutine or
501 C<NULL>. The glob lives in the given C<stash>, or in the stashes
502 accessible via @ISA and @UNIVERSAL.
504 The argument C<level> should be either 0 or -1. If C<level==0>, as a
505 side-effect creates a glob with the given C<name> in the given C<stash>
506 which in the case of success contains an alias for the subroutine, and sets
507 up caching info for this glob. Similarly for all the searched stashes.
509 This function grants C<"SUPER"> token as a postfix of the stash name. The
510 GV returned from C<gv_fetchmeth> may be a method cache entry, which is not
511 visible to Perl code. So when calling C<call_sv>, you should not use
512 the GV directly; instead, you should use the method's CV, which can be
513 obtained from the GV with the C<GvCV> macro.
515 GV* gv_fetchmeth(HV* stash, const char* name, STRLEN len, I32 level)
522 See L<gv_fetchmethod_autoload>.
524 GV* gv_fetchmethod(HV* stash, const char* name)
529 =item gv_fetchmethod_autoload
531 Returns the glob which contains the subroutine to call to invoke the method
532 on the C<stash>. In fact in the presence of autoloading this may be the
533 glob for "AUTOLOAD". In this case the corresponding variable $AUTOLOAD is
536 The third parameter of C<gv_fetchmethod_autoload> determines whether
537 AUTOLOAD lookup is performed if the given method is not present: non-zero
538 means yes, look for AUTOLOAD; zero means no, don't look for AUTOLOAD.
539 Calling C<gv_fetchmethod> is equivalent to calling C<gv_fetchmethod_autoload>
540 with a non-zero C<autoload> parameter.
542 These functions grant C<"SUPER"> token as a prefix of the method name. Note
543 that if you want to keep the returned glob for a long time, you need to
544 check for it being "AUTOLOAD", since at the later time the call may load a
545 different subroutine due to $AUTOLOAD changing its value. Use the glob
546 created via a side effect to do this.
548 These functions have the same side-effects and as C<gv_fetchmeth> with
549 C<level==0>. C<name> should be writable if contains C<':'> or C<'
550 ''>. The warning against passing the GV returned by C<gv_fetchmeth> to
551 C<call_sv> apply equally to these functions.
553 GV* gv_fetchmethod_autoload(HV* stash, const char* name, I32 autoload)
560 Returns a pointer to the stash for a specified package. C<name> should
561 be a valid UTF-8 string. If C<create> is set then the package will be
562 created if it does not already exist. If C<create> is not set and the
563 package does not exist then NULL is returned.
565 HV* gv_stashpv(const char* name, I32 create)
572 Returns a pointer to the stash for a specified package, which must be a
573 valid UTF-8 string. See C<gv_stashpv>.
575 HV* gv_stashsv(SV* sv, I32 create)
582 Used to indicate list context. See C<GIMME_V>, C<GIMME> and
590 Indicates that arguments returned from a callback should be discarded. See
598 Used to force a Perl C<eval> wrapper around a callback. See
606 Indicates that no arguments are being sent to a callback. See
614 Used to indicate scalar context. See C<GIMME_V>, C<GIMME>, and
622 Used to indicate void context. See C<GIMME_V> and L<perlcall>.
629 This flag, used in the length slot of hash entries and magic structures,
630 specifies the structure contains a C<SV*> pointer where a C<char*> pointer
631 is to be expected. (For information only--not to be used).
638 Returns the computed hash stored in the hash entry.
647 Returns the actual pointer stored in the key slot of the hash entry. The
648 pointer may be either C<char*> or C<SV*>, depending on the value of
649 C<HeKLEN()>. Can be assigned to. The C<HePV()> or C<HeSVKEY()> macros are
650 usually preferable for finding the value of a key.
659 If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry
660 holds an C<SV*> key. Otherwise, holds the actual length of the key. Can
661 be assigned to. The C<HePV()> macro is usually preferable for finding key
664 STRLEN HeKLEN(HE* he)
671 Returns the key slot of the hash entry as a C<char*> value, doing any
672 necessary dereferencing of possibly C<SV*> keys. The length of the string
673 is placed in C<len> (this is a macro, so do I<not> use C<&len>). If you do
674 not care about what the length of the key is, you may use the global
675 variable C<PL_na>, though this is rather less efficient than using a local
676 variable. Remember though, that hash keys in perl are free to contain
677 embedded nulls, so using C<strlen()> or similar is not a good way to find
678 the length of hash keys. This is very similar to the C<SvPV()> macro
679 described elsewhere in this document.
681 char* HePV(HE* he, STRLEN len)
688 Returns the key as an C<SV*>, or C<Nullsv> if the hash entry does not
689 contain an C<SV*> key.
698 Returns the key as an C<SV*>. Will create and return a temporary mortal
699 C<SV*> if the hash entry contains only a C<char*> key.
701 SV* HeSVKEY_force(HE* he)
708 Sets the key to a given C<SV*>, taking care to set the appropriate flags to
709 indicate the presence of an C<SV*> key, and returns the same
712 SV* HeSVKEY_set(HE* he, SV* sv)
719 Returns the value slot (type C<SV*>) stored in the hash entry.
728 Returns the package name of a stash. See C<SvSTASH>, C<CvSTASH>.
730 char* HvNAME(HV* stash)
737 Clears a hash, making it empty.
739 void hv_clear(HV* tb)
746 Deletes a key/value pair in the hash. The value SV is removed from the
747 hash and returned to the caller. The C<klen> is the length of the key.
748 The C<flags> value will normally be zero; if set to G_DISCARD then NULL
751 SV* hv_delete(HV* tb, const char* key, U32 klen, I32 flags)
758 Deletes a key/value pair in the hash. The value SV is removed from the
759 hash and returned to the caller. The C<flags> value will normally be zero;
760 if set to G_DISCARD then NULL will be returned. C<hash> can be a valid
761 precomputed hash value, or 0 to ask for it to be computed.
763 SV* hv_delete_ent(HV* tb, SV* key, I32 flags, U32 hash)
770 Returns a boolean indicating whether the specified hash key exists. The
771 C<klen> is the length of the key.
773 bool hv_exists(HV* tb, const char* key, U32 klen)
780 Returns a boolean indicating whether the specified hash key exists. C<hash>
781 can be a valid precomputed hash value, or 0 to ask for it to be
784 bool hv_exists_ent(HV* tb, SV* key, U32 hash)
791 Returns the SV which corresponds to the specified key in the hash. The
792 C<klen> is the length of the key. If C<lval> is set then the fetch will be
793 part of a store. Check that the return value is non-null before
794 dereferencing it to a C<SV*>.
796 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
797 information on how to use this function on tied hashes.
799 SV** hv_fetch(HV* tb, const char* key, U32 klen, I32 lval)
806 Returns the hash entry which corresponds to the specified key in the hash.
807 C<hash> must be a valid precomputed hash number for the given C<key>, or 0
808 if you want the function to compute it. IF C<lval> is set then the fetch
809 will be part of a store. Make sure the return value is non-null before
810 accessing it. The return value when C<tb> is a tied hash is a pointer to a
811 static location, so be sure to make a copy of the structure if you need to
814 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
815 information on how to use this function on tied hashes.
817 HE* hv_fetch_ent(HV* tb, SV* key, I32 lval, U32 hash)
824 Prepares a starting point to traverse a hash table. Returns the number of
825 keys in the hash (i.e. the same as C<HvKEYS(tb)>). The return value is
826 currently only meaningful for hashes without tie magic.
828 NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
829 hash buckets that happen to be in use. If you still need that esoteric
830 value, you can get it through the macro C<HvFILL(tb)>.
832 I32 hv_iterinit(HV* tb)
839 Returns the key from the current position of the hash iterator. See
842 char* hv_iterkey(HE* entry, I32* retlen)
849 Returns the key as an C<SV*> from the current position of the hash
850 iterator. The return value will always be a mortal copy of the key. Also
853 SV* hv_iterkeysv(HE* entry)
860 Returns entries from a hash iterator. See C<hv_iterinit>.
862 HE* hv_iternext(HV* tb)
869 Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
872 SV* hv_iternextsv(HV* hv, char** key, I32* retlen)
879 Returns the value from the current position of the hash iterator. See
882 SV* hv_iterval(HV* tb, HE* entry)
889 Adds magic to a hash. See C<sv_magic>.
891 void hv_magic(HV* hv, GV* gv, int how)
898 Stores an SV in a hash. The hash key is specified as C<key> and C<klen> is
899 the length of the key. The C<hash> parameter is the precomputed hash
900 value; if it is zero then Perl will compute it. The return value will be
901 NULL if the operation failed or if the value did not need to be actually
902 stored within the hash (as in the case of tied hashes). Otherwise it can
903 be dereferenced to get the original C<SV*>. Note that the caller is
904 responsible for suitably incrementing the reference count of C<val> before
905 the call, and decrementing it if the function returned NULL.
907 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
908 information on how to use this function on tied hashes.
910 SV** hv_store(HV* tb, const char* key, U32 klen, SV* val, U32 hash)
917 Stores C<val> in a hash. The hash key is specified as C<key>. The C<hash>
918 parameter is the precomputed hash value; if it is zero then Perl will
919 compute it. The return value is the new hash entry so created. It will be
920 NULL if the operation failed or if the value did not need to be actually
921 stored within the hash (as in the case of tied hashes). Otherwise the
922 contents of the return value can be accessed using the C<He???> macros
923 described here. Note that the caller is responsible for suitably
924 incrementing the reference count of C<val> before the call, and
925 decrementing it if the function returned NULL.
927 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
928 information on how to use this function on tied hashes.
930 HE* hv_store_ent(HV* tb, SV* key, SV* val, U32 hash)
939 void hv_undef(HV* tb)
946 Returns a boolean indicating whether the C C<char> is an ASCII alphanumeric
947 character (including underscore) or digit.
949 bool isALNUM(char ch)
952 Found in file handy.h
956 Returns a boolean indicating whether the C C<char> is an ASCII alphabetic
959 bool isALPHA(char ch)
962 Found in file handy.h
966 Returns a boolean indicating whether the C C<char> is an ASCII
969 bool isDIGIT(char ch)
972 Found in file handy.h
976 Returns a boolean indicating whether the C C<char> is a lowercase
979 bool isLOWER(char ch)
982 Found in file handy.h
986 Returns a boolean indicating whether the C C<char> is whitespace.
988 bool isSPACE(char ch)
991 Found in file handy.h
995 Returns a boolean indicating whether the C C<char> is an uppercase
998 bool isUPPER(char ch)
1001 Found in file handy.h
1005 Variable which is setup by C<xsubpp> to indicate the number of
1006 items on the stack. See L<perlxs/"Variable-length Parameter Lists">.
1011 Found in file XSUB.h
1015 Variable which is setup by C<xsubpp> to indicate which of an
1016 XSUB's aliases was used to invoke it. See L<perlxs/"The ALIAS: Keyword">.
1021 Found in file XSUB.h
1025 Closing bracket on a callback. See C<ENTER> and L<perlcall>.
1030 Found in file scope.h
1032 =item looks_like_number
1034 Test if an the content of an SV looks like a number (or is a
1037 I32 looks_like_number(SV* sv)
1044 Stack marker variable for the XSUB. See C<dMARK>.
1051 Clear something magical that the SV represents. See C<sv_magic>.
1053 int mg_clear(SV* sv)
1060 Copies the magic from one SV to another. See C<sv_magic>.
1062 int mg_copy(SV* sv, SV* nsv, const char* key, I32 klen)
1069 Finds the magic pointer for type matching the SV. See C<sv_magic>.
1071 MAGIC* mg_find(SV* sv, int type)
1078 Free any magic storage used by the SV. See C<sv_magic>.
1087 Do magic after a value is retrieved from the SV. See C<sv_magic>.
1096 Report on the SV's length. See C<sv_magic>.
1098 U32 mg_length(SV* sv)
1105 Turns on the magical status of an SV. See C<sv_magic>.
1107 void mg_magical(SV* sv)
1114 Do magic after a value is assigned to the SV. See C<sv_magic>.
1123 The XSUB-writer's interface to the C C<memmove> function. The C<src> is the
1124 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1125 the type. Can do overlapping moves. See also C<Copy>.
1127 void Move(void* src, void* dest, int nitems, type)
1130 Found in file handy.h
1134 The XSUB-writer's interface to the C C<malloc> function.
1136 void New(int id, void* ptr, int nitems, type)
1139 Found in file handy.h
1143 Creates a new AV. The reference count is set to 1.
1152 The XSUB-writer's interface to the C C<malloc> function, with
1155 void Newc(int id, void* ptr, int nitems, type, cast)
1158 Found in file handy.h
1162 Creates a constant sub equivalent to Perl C<sub FOO () { 123 }> which is
1163 eligible for inlining at compile-time.
1165 void newCONSTSUB(HV* stash, char* name, SV* sv)
1172 Creates a new HV. The reference count is set to 1.
1181 Creates an RV wrapper for an SV. The reference count for the original SV is
1184 SV* newRV_inc(SV* sv)
1191 Creates an RV wrapper for an SV. The reference count for the original
1192 SV is B<not> incremented.
1194 SV* newRV_noinc(SV *sv)
1201 Creates a new SV. A non-zero C<len> parameter indicates the number of
1202 bytes of preallocated string space the SV should have. An extra byte for a
1203 tailing NUL is also reserved. (SvPOK is not set for the SV even if string
1204 space is allocated.) The reference count for the new SV is set to 1.
1205 C<id> is an integer id between 0 and 1299 (used to identify leaks).
1207 SV* NEWSV(int id, STRLEN len)
1210 Found in file handy.h
1214 Creates a new SV and copies an integer into it. The reference count for the
1224 Creates a new SV and copies a floating point value into it.
1225 The reference count for the SV is set to 1.
1234 Creates a new SV and copies a string into it. The reference count for the
1235 SV is set to 1. If C<len> is zero, Perl will compute the length using
1236 strlen(). For efficiency, consider using C<newSVpvn> instead.
1238 SV* newSVpv(const char* s, STRLEN len)
1245 Creates a new SV an initialize it with the string formatted like
1248 SV* newSVpvf(const char* pat, ...)
1255 Creates a new SV and copies a string into it. The reference count for the
1256 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
1257 string. You are responsible for ensuring that the source string is at least
1260 SV* newSVpvn(const char* s, STRLEN len)
1265 =item newSVpvn_share
1267 Creates a new SV and populates it with a string from
1268 the string table. Turns on READONLY and FAKE.
1269 The idea here is that as string table is used for shared hash
1270 keys these strings will have SvPVX == HeKEY and hash lookup
1271 will avoid string compare.
1273 SV* newSVpvn_share(const char* s, STRLEN len, U32 hash)
1280 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
1281 it will be upgraded to one. If C<classname> is non-null then the new SV will
1282 be blessed in the specified package. The new SV is returned and its
1283 reference count is 1.
1285 SV* newSVrv(SV* rv, const char* classname)
1292 Creates a new SV which is an exact duplicate of the original SV.
1294 SV* newSVsv(SV* old)
1301 Creates a new SV and copies an unsigned integer into it.
1302 The reference count for the SV is set to 1.
1311 Used by C<xsubpp> to hook up XSUBs as Perl subs.
1318 Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
1322 Found in file XSUB.h
1326 The XSUB-writer's interface to the C C<malloc> function. The allocated
1327 memory is zeroed with C<memzero>.
1329 void Newz(int id, void* ptr, int nitems, type)
1332 Found in file handy.h
1343 Null character pointer.
1346 Found in file handy.h
1367 Found in file handy.h
1371 The original stack mark for the XSUB. See C<dORIGMARK>.
1378 Allocates a new Perl interpreter. See L<perlembed>.
1380 PerlInterpreter* perl_alloc()
1383 Found in file perl.c
1385 =item perl_construct
1387 Initializes a new Perl interpreter. See L<perlembed>.
1389 void perl_construct(PerlInterpreter* interp)
1392 Found in file perl.c
1396 Shuts down a Perl interpreter. See L<perlembed>.
1398 void perl_destruct(PerlInterpreter* interp)
1401 Found in file perl.c
1405 Releases a Perl interpreter. See L<perlembed>.
1407 void perl_free(PerlInterpreter* interp)
1410 Found in file perl.c
1414 Tells a Perl interpreter to parse a Perl script. See L<perlembed>.
1416 int perl_parse(PerlInterpreter* interp, XSINIT_t xsinit, int argc, char** argv, char** env)
1419 Found in file perl.c
1423 Tells a Perl interpreter to run. See L<perlembed>.
1425 int perl_run(PerlInterpreter* interp)
1428 Found in file perl.c
1432 When Perl is run in debugging mode, with the B<-d> switch, this SV is a
1433 boolean which indicates whether subs are being single-stepped.
1434 Single-stepping is automatically turned on after every step. This is the C
1435 variable which corresponds to Perl's $DB::single variable. See
1441 Found in file intrpvar.h
1445 When Perl is run in debugging mode, with the B<-d> switch, this GV contains
1446 the SV which holds the name of the sub being debugged. This is the C
1447 variable which corresponds to Perl's $DB::sub variable. See
1453 Found in file intrpvar.h
1457 Trace variable used when Perl is run in debugging mode, with the B<-d>
1458 switch. This is the C variable which corresponds to Perl's $DB::trace
1459 variable. See C<PL_DBsingle>.
1464 Found in file intrpvar.h
1468 The C variable which corresponds to Perl's $^W warning variable.
1473 Found in file intrpvar.h
1477 C<PL_modglobal> is a general purpose, interpreter global HV for use by
1478 extensions that need to keep information on a per-interpreter basis.
1479 In a pinch, it can also be used as a symbol table for extensions
1480 to share data among each other. It is a good idea to use keys
1481 prefixed by the package name of the extension that owns the data.
1486 Found in file intrpvar.h
1490 A convenience variable which is typically used with C<SvPV> when one
1491 doesn't care about the length of the string. It is usually more efficient
1492 to either declare a local variable and use that instead or to use the
1493 C<SvPV_nolen> macro.
1498 Found in file thrdvar.h
1502 This is the C<false> SV. See C<PL_sv_yes>. Always refer to this as
1508 Found in file intrpvar.h
1512 This is the C<undef> SV. Always refer to this as C<&PL_sv_undef>.
1517 Found in file intrpvar.h
1521 This is the C<true> SV. See C<PL_sv_no>. Always refer to this as
1527 Found in file intrpvar.h
1531 Pops an integer off the stack.
1540 Pops a long off the stack.
1549 Pops a double off the stack.
1558 Pops a string off the stack.
1567 Pops an SV off the stack.
1576 Push an integer onto the stack. The stack must have room for this element.
1577 Handles 'set' magic. See C<XPUSHi>.
1586 Opening bracket for arguments on a callback. See C<PUTBACK> and
1596 Push a double onto the stack. The stack must have room for this element.
1597 Handles 'set' magic. See C<XPUSHn>.
1606 Push a string onto the stack. The stack must have room for this element.
1607 The C<len> indicates the length of the string. Handles 'set' magic. See
1610 void PUSHp(char* str, STRLEN len)
1617 Push an SV onto the stack. The stack must have room for this element.
1618 Does not handle 'set' magic. See C<XPUSHs>.
1627 Push an unsigned integer onto the stack. The stack must have room for this
1628 element. See C<XPUSHu>.
1637 Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
1638 See C<PUSHMARK> and L<perlcall> for other uses.
1647 The XSUB-writer's interface to the C C<realloc> function.
1649 void Renew(void* ptr, int nitems, type)
1652 Found in file handy.h
1656 The XSUB-writer's interface to the C C<realloc> function, with
1659 void Renewc(void* ptr, int nitems, type, cast)
1662 Found in file handy.h
1666 Tells Perl to C<require> a module.
1668 NOTE: the perl_ form of this function is deprecated.
1670 void require_pv(const char* pv)
1673 Found in file perl.c
1677 Variable which is setup by C<xsubpp> to hold the return value for an
1678 XSUB. This is always the proper type for the XSUB. See
1679 L<perlxs/"The RETVAL Variable">.
1684 Found in file XSUB.h
1688 The XSUB-writer's interface to the C C<free> function.
1690 void Safefree(void* ptr)
1693 Found in file handy.h
1697 Copy a string to a safe spot. This does not use an SV.
1699 char* savepv(const char* sv)
1702 Found in file util.c
1706 Copy a string to a safe spot. The C<len> indicates number of bytes to
1707 copy. This does not use an SV.
1709 char* savepvn(const char* sv, I32 len)
1712 Found in file util.c
1716 Opening bracket for temporaries on a callback. See C<FREETMPS> and
1722 Found in file scope.h
1726 Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and
1734 Refetch the stack pointer. Used after a callback. See L<perlcall>.
1743 Used to access elements on the XSUB's stack.
1748 Found in file XSUB.h
1752 Test two strings to see if they are equal. Returns true or false.
1754 bool strEQ(char* s1, char* s2)
1757 Found in file handy.h
1761 Test two strings to see if the first, C<s1>, is greater than or equal to
1762 the second, C<s2>. Returns true or false.
1764 bool strGE(char* s1, char* s2)
1767 Found in file handy.h
1771 Test two strings to see if the first, C<s1>, is greater than the second,
1772 C<s2>. Returns true or false.
1774 bool strGT(char* s1, char* s2)
1777 Found in file handy.h
1781 Test two strings to see if the first, C<s1>, is less than or equal to the
1782 second, C<s2>. Returns true or false.
1784 bool strLE(char* s1, char* s2)
1787 Found in file handy.h
1791 Test two strings to see if the first, C<s1>, is less than the second,
1792 C<s2>. Returns true or false.
1794 bool strLT(char* s1, char* s2)
1797 Found in file handy.h
1801 Test two strings to see if they are different. Returns true or
1804 bool strNE(char* s1, char* s2)
1807 Found in file handy.h
1811 Test two strings to see if they are equal. The C<len> parameter indicates
1812 the number of bytes to compare. Returns true or false. (A wrapper for
1815 bool strnEQ(char* s1, char* s2, STRLEN len)
1818 Found in file handy.h
1822 Test two strings to see if they are different. The C<len> parameter
1823 indicates the number of bytes to compare. Returns true or false. (A
1824 wrapper for C<strncmp>).
1826 bool strnNE(char* s1, char* s2, STRLEN len)
1829 Found in file handy.h
1833 This is an architecture-independent macro to copy one structure to another.
1835 void StructCopy(type src, type dest, type)
1838 Found in file handy.h
1842 Returns the length of the string which is in the SV. See C<SvLEN>.
1844 STRLEN SvCUR(SV* sv)
1851 Set the length of the string which is in the SV. See C<SvCUR>.
1853 void SvCUR_set(SV* sv, STRLEN len)
1860 Returns a pointer to the last character in the string which is in the SV.
1861 See C<SvCUR>. Access the character as *(SvEND(sv)).
1870 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
1871 argument more than once.
1873 void SvGETMAGIC(SV* sv)
1880 Expands the character buffer in the SV so that it has room for the
1881 indicated number of bytes (remember to reserve space for an extra trailing
1882 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
1883 Returns a pointer to the character buffer.
1885 void SvGROW(SV* sv, STRLEN len)
1892 Returns a boolean indicating whether the SV contains an integer.
1901 Returns a boolean indicating whether the SV contains an integer. Checks
1902 the B<private> setting. Use C<SvIOK>.
1911 Returns a boolean indicating whether the SV contains an signed integer.
1913 void SvIOK_notUV(SV* sv)
1920 Unsets the IV status of an SV.
1922 void SvIOK_off(SV* sv)
1929 Tells an SV that it is an integer.
1931 void SvIOK_on(SV* sv)
1938 Tells an SV that it is an integer and disables all other OK bits.
1940 void SvIOK_only(SV* sv)
1947 Tells and SV that it is an unsigned integer and disables all other OK bits.
1949 void SvIOK_only_UV(SV* sv)
1956 Returns a boolean indicating whether the SV contains an unsigned integer.
1958 void SvIOK_UV(SV* sv)
1965 Coerces the given SV to an integer and returns it.
1974 Returns the integer which is stored in the SV, assuming SvIOK is
1984 Returns the size of the string buffer in the SV, not including any part
1985 attributable to C<SvOOK>. See C<SvCUR>.
1987 STRLEN SvLEN(SV* sv)
1994 Returns a boolean indicating whether the SV contains a number, integer or
2004 Returns a boolean indicating whether the SV contains a number, integer or
2005 double. Checks the B<private> setting. Use C<SvNIOK>.
2007 bool SvNIOKp(SV* sv)
2014 Unsets the NV/IV status of an SV.
2016 void SvNIOK_off(SV* sv)
2023 Returns a boolean indicating whether the SV contains a double.
2032 Returns a boolean indicating whether the SV contains a double. Checks the
2033 B<private> setting. Use C<SvNOK>.
2042 Unsets the NV status of an SV.
2044 void SvNOK_off(SV* sv)
2051 Tells an SV that it is a double.
2053 void SvNOK_on(SV* sv)
2060 Tells an SV that it is a double and disables all other OK bits.
2062 void SvNOK_only(SV* sv)
2069 Coerce the given SV to a double and return it.
2078 Returns the double which is stored in the SV, assuming SvNOK is
2088 Returns a boolean indicating whether the value is an SV.
2097 Returns a boolean indicating whether the SvIVX is a valid offset value for
2098 the SvPVX. This hack is used internally to speed up removal of characters
2099 from the beginning of a SvPV. When SvOOK is true, then the start of the
2100 allocated string buffer is really (SvPVX - SvIVX).
2109 Returns a boolean indicating whether the SV contains a character
2119 Returns a boolean indicating whether the SV contains a character string.
2120 Checks the B<private> setting. Use C<SvPOK>.
2129 Unsets the PV status of an SV.
2131 void SvPOK_off(SV* sv)
2138 Tells an SV that it is a string.
2140 void SvPOK_on(SV* sv)
2147 Tells an SV that it is a string and disables all other OK bits.
2149 void SvPOK_only(SV* sv)
2154 =item SvPOK_only_UTF8
2156 Tells an SV that it is a UTF8 string (do not use frivolously)
2157 and disables all other OK bits.
2159 void SvPOK_only_UTF8(SV* sv)
2166 Returns a pointer to the string in the SV, or a stringified form of the SV
2167 if the SV does not contain a string. Handles 'get' magic.
2169 char* SvPV(SV* sv, STRLEN len)
2176 Returns a pointer to the string in the SV. The SV must contain a
2186 Like <SvPV> but will force the SV into becoming a string (SvPOK). You want
2187 force if you are going to update the SvPVX directly.
2189 char* SvPV_force(SV* sv, STRLEN len)
2196 Returns a pointer to the string in the SV, or a stringified form of the SV
2197 if the SV does not contain a string. Handles 'get' magic.
2199 char* SvPV_nolen(SV* sv)
2206 Returns the value of the object's reference count.
2208 U32 SvREFCNT(SV* sv)
2215 Decrements the reference count of the given SV.
2217 void SvREFCNT_dec(SV* sv)
2224 Increments the reference count of the given SV.
2226 SV* SvREFCNT_inc(SV* sv)
2233 Tests if the SV is an RV.
2242 Unsets the RV status of an SV.
2244 void SvROK_off(SV* sv)
2251 Tells an SV that it is an RV.
2253 void SvROK_on(SV* sv)
2260 Dereferences an RV to return the SV.
2269 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
2270 argument more than once.
2272 void SvSETMAGIC(SV* sv)
2279 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
2282 void SvSetSV(SV* dsb, SV* ssv)
2287 =item SvSetSV_nosteal
2289 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
2290 ssv. May evaluate arguments more than once.
2292 void SvSetSV_nosteal(SV* dsv, SV* ssv)
2299 Returns the stash of the SV.
2308 Taints an SV if tainting is enabled
2310 void SvTAINT(SV* sv)
2317 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
2320 bool SvTAINTED(SV* sv)
2327 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
2328 some of Perl's fundamental security features. XS module authors should not
2329 use this function unless they fully understand all the implications of
2330 unconditionally untainting the value. Untainting should be done in the
2331 standard perl fashion, via a carefully crafted regexp, rather than directly
2332 untainting variables.
2334 void SvTAINTED_off(SV* sv)
2341 Marks an SV as tainted.
2343 void SvTAINTED_on(SV* sv)
2350 Returns a boolean indicating whether Perl would evaluate the SV as true or
2351 false, defined or undefined. Does not handle 'get' magic.
2360 Returns the type of the SV. See C<svtype>.
2362 svtype SvTYPE(SV* sv)
2369 An enum of flags for Perl types. These are found in the file B<sv.h>
2370 in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
2377 Integer type flag for scalars. See C<svtype>.
2384 Double type flag for scalars. See C<svtype>.
2391 Pointer type flag for scalars. See C<svtype>.
2398 Type flag for arrays. See C<svtype>.
2405 Type flag for code refs. See C<svtype>.
2412 Type flag for hashes. See C<svtype>.
2419 Type flag for blessed scalars. See C<svtype>.
2426 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
2427 perform the upgrade if necessary. See C<svtype>.
2429 void SvUPGRADE(SV* sv, svtype type)
2436 Returns a boolean indicating whether the SV contains UTF-8 encoded data.
2445 Unsets the UTF8 status of an SV.
2447 void SvUTF8_off(SV *sv)
2454 Tells an SV that it is a string and encoded in UTF8. Do not use frivolously.
2456 void SvUTF8_on(SV *sv)
2463 Coerces the given SV to an unsigned integer and returns it.
2472 Returns the unsigned integer which is stored in the SV, assuming SvIOK is
2482 Marks an SV as mortal. The SV will be destroyed when the current context
2485 SV* sv_2mortal(SV* sv)
2492 Blesses an SV into a specified package. The SV must be an RV. The package
2493 must be designated by its stash (see C<gv_stashpv()>). The reference count
2494 of the SV is unaffected.
2496 SV* sv_bless(SV* sv, HV* stash)
2503 Concatenates the string onto the end of the string which is in the SV.
2504 Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
2506 void sv_catpv(SV* sv, const char* ptr)
2513 Processes its arguments like C<sprintf> and appends the formatted output
2514 to an SV. Handles 'get' magic, but not 'set' magic. C<SvSETMAGIC()> must
2515 typically be called after calling this function to handle 'set' magic.
2517 void sv_catpvf(SV* sv, const char* pat, ...)
2524 Like C<sv_catpvf>, but also handles 'set' magic.
2526 void sv_catpvf_mg(SV *sv, const char* pat, ...)
2533 Concatenates the string onto the end of the string which is in the SV. The
2534 C<len> indicates number of bytes to copy. Handles 'get' magic, but not
2535 'set' magic. See C<sv_catpvn_mg>.
2537 void sv_catpvn(SV* sv, const char* ptr, STRLEN len)
2544 Like C<sv_catpvn>, but also handles 'set' magic.
2546 void sv_catpvn_mg(SV *sv, const char *ptr, STRLEN len)
2553 Like C<sv_catpv>, but also handles 'set' magic.
2555 void sv_catpv_mg(SV *sv, const char *ptr)
2562 Concatenates the string from SV C<ssv> onto the end of the string in SV
2563 C<dsv>. Handles 'get' magic, but not 'set' magic. See C<sv_catsv_mg>.
2565 void sv_catsv(SV* dsv, SV* ssv)
2572 Like C<sv_catsv>, but also handles 'set' magic.
2574 void sv_catsv_mg(SV *dstr, SV *sstr)
2581 Efficient removal of characters from the beginning of the string buffer.
2582 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
2583 the string buffer. The C<ptr> becomes the first character of the adjusted
2586 void sv_chop(SV* sv, char* ptr)
2593 Clear an SV, making it empty. Does not free the memory used by the SV
2596 void sv_clear(SV* sv)
2603 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
2604 string in C<sv1> is less than, equal to, or greater than the string in
2607 I32 sv_cmp(SV* sv1, SV* sv2)
2614 Compares the strings in two SVs in a locale-aware manner. See
2617 I32 sv_cmp_locale(SV* sv1, SV* sv2)
2624 Auto-decrement of the value in the SV.
2631 =item sv_derived_from
2633 Returns a boolean indicating whether the SV is derived from the specified
2634 class. This is the function that implements C<UNIVERSAL::isa>. It works
2635 for class names as well as for objects.
2637 bool sv_derived_from(SV* sv, const char* name)
2640 Found in file universal.c
2644 Returns a boolean indicating whether the strings in the two SVs are
2647 I32 sv_eq(SV* sv1, SV* sv2)
2654 Free the memory used by an SV.
2656 void sv_free(SV* sv)
2663 Get a line from the filehandle and store it into the SV, optionally
2664 appending to the currently-stored string.
2666 char* sv_gets(SV* sv, PerlIO* fp, I32 append)
2673 Expands the character buffer in the SV. This will use C<sv_unref> and will
2674 upgrade the SV to C<SVt_PV>. Returns a pointer to the character buffer.
2677 char* sv_grow(SV* sv, STRLEN newlen)
2684 Auto-increment of the value in the SV.
2693 Inserts a string at the specified offset/length within the SV. Similar to
2694 the Perl substr() function.
2696 void sv_insert(SV* bigsv, STRLEN offset, STRLEN len, char* little, STRLEN littlelen)
2703 Returns a boolean indicating whether the SV is blessed into the specified
2704 class. This does not check for subtypes; use C<sv_derived_from> to verify
2705 an inheritance relationship.
2707 int sv_isa(SV* sv, const char* name)
2714 Returns a boolean indicating whether the SV is an RV pointing to a blessed
2715 object. If the SV is not an RV, or if the object is not blessed, then this
2718 int sv_isobject(SV* sv)
2725 Returns the length of the string in the SV. See also C<SvCUR>.
2727 STRLEN sv_len(SV* sv)
2734 Returns the number of characters in the string in an SV, counting wide
2735 UTF8 bytes as a single character.
2737 STRLEN sv_len_utf8(SV* sv)
2744 Adds magic to an SV.
2746 void sv_magic(SV* sv, SV* obj, int how, const char* name, I32 namlen)
2753 Creates a new SV which is a copy of the original SV. The new SV is marked
2756 SV* sv_mortalcopy(SV* oldsv)
2763 Creates a new SV which is mortal. The reference count of the SV is set to 1.
2772 Get a sensible string out of the SV somehow.
2774 char* sv_pvn_force(SV* sv, STRLEN* lp)
2779 =item sv_pvutf8n_force
2781 Get a sensible UTF8-encoded string out of the SV somehow. See
2784 char* sv_pvutf8n_force(SV* sv, STRLEN* lp)
2791 Returns a string describing what the SV is a reference to.
2793 char* sv_reftype(SV* sv, int ob)
2800 Make the first argument a copy of the second, then delete the original.
2802 void sv_replace(SV* sv, SV* nsv)
2811 SV* sv_rvweaken(SV *sv)
2818 Copies an integer into the given SV. Does not handle 'set' magic. See
2821 void sv_setiv(SV* sv, IV num)
2828 Like C<sv_setiv>, but also handles 'set' magic.
2830 void sv_setiv_mg(SV *sv, IV i)
2837 Copies a double into the given SV. Does not handle 'set' magic. See
2840 void sv_setnv(SV* sv, NV num)
2847 Like C<sv_setnv>, but also handles 'set' magic.
2849 void sv_setnv_mg(SV *sv, NV num)
2856 Copies a string into an SV. The string must be null-terminated. Does not
2857 handle 'set' magic. See C<sv_setpv_mg>.
2859 void sv_setpv(SV* sv, const char* ptr)
2866 Processes its arguments like C<sprintf> and sets an SV to the formatted
2867 output. Does not handle 'set' magic. See C<sv_setpvf_mg>.
2869 void sv_setpvf(SV* sv, const char* pat, ...)
2876 Like C<sv_setpvf>, but also handles 'set' magic.
2878 void sv_setpvf_mg(SV *sv, const char* pat, ...)
2885 Copies an integer into the given SV, also updating its string value.
2886 Does not handle 'set' magic. See C<sv_setpviv_mg>.
2888 void sv_setpviv(SV* sv, IV num)
2895 Like C<sv_setpviv>, but also handles 'set' magic.
2897 void sv_setpviv_mg(SV *sv, IV iv)
2904 Copies a string into an SV. The C<len> parameter indicates the number of
2905 bytes to be copied. Does not handle 'set' magic. See C<sv_setpvn_mg>.
2907 void sv_setpvn(SV* sv, const char* ptr, STRLEN len)
2914 Like C<sv_setpvn>, but also handles 'set' magic.
2916 void sv_setpvn_mg(SV *sv, const char *ptr, STRLEN len)
2923 Like C<sv_setpv>, but also handles 'set' magic.
2925 void sv_setpv_mg(SV *sv, const char *ptr)
2932 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
2933 argument will be upgraded to an RV. That RV will be modified to point to
2934 the new SV. The C<classname> argument indicates the package for the
2935 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
2936 will be returned and will have a reference count of 1.
2938 SV* sv_setref_iv(SV* rv, const char* classname, IV iv)
2945 Copies a double into a new SV, optionally blessing the SV. The C<rv>
2946 argument will be upgraded to an RV. That RV will be modified to point to
2947 the new SV. The C<classname> argument indicates the package for the
2948 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
2949 will be returned and will have a reference count of 1.
2951 SV* sv_setref_nv(SV* rv, const char* classname, NV nv)
2958 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
2959 argument will be upgraded to an RV. That RV will be modified to point to
2960 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
2961 into the SV. The C<classname> argument indicates the package for the
2962 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
2963 will be returned and will have a reference count of 1.
2965 Do not use with other Perl types such as HV, AV, SV, CV, because those
2966 objects will become corrupted by the pointer copy process.
2968 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
2970 SV* sv_setref_pv(SV* rv, const char* classname, void* pv)
2977 Copies a string into a new SV, optionally blessing the SV. The length of the
2978 string must be specified with C<n>. The C<rv> argument will be upgraded to
2979 an RV. That RV will be modified to point to the new SV. The C<classname>
2980 argument indicates the package for the blessing. Set C<classname> to
2981 C<Nullch> to avoid the blessing. The new SV will be returned and will have
2982 a reference count of 1.
2984 Note that C<sv_setref_pv> copies the pointer while this copies the string.
2986 SV* sv_setref_pvn(SV* rv, const char* classname, char* pv, STRLEN n)
2993 Copies the contents of the source SV C<ssv> into the destination SV C<dsv>.
2994 The source SV may be destroyed if it is mortal. Does not handle 'set'
2995 magic. See the macro forms C<SvSetSV>, C<SvSetSV_nosteal> and
2998 void sv_setsv(SV* dsv, SV* ssv)
3005 Like C<sv_setsv>, but also handles 'set' magic.
3007 void sv_setsv_mg(SV *dstr, SV *sstr)
3014 Copies an unsigned integer into the given SV. Does not handle 'set' magic.
3017 void sv_setuv(SV* sv, UV num)
3024 Like C<sv_setuv>, but also handles 'set' magic.
3026 void sv_setuv_mg(SV *sv, UV u)
3033 Returns true if the SV has a true value by Perl's rules.
3042 Removes magic from an SV.
3044 int sv_unmagic(SV* sv, int type)
3051 Unsets the RV status of the SV, and decrements the reference count of
3052 whatever was being referenced by the RV. This can almost be thought of
3053 as a reversal of C<newSVrv>. See C<SvROK_off>.
3055 void sv_unref(SV* sv)
3062 Upgrade an SV to a more complex form. Use C<SvUPGRADE>. See
3065 bool sv_upgrade(SV* sv, U32 mt)
3072 Tells an SV to use C<ptr> to find its string value. Normally the string is
3073 stored inside the SV but sv_usepvn allows the SV to use an outside string.
3074 The C<ptr> should point to memory that was allocated by C<malloc>. The
3075 string length, C<len>, must be supplied. This function will realloc the
3076 memory pointed to by C<ptr>, so that pointer should not be freed or used by
3077 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
3078 See C<sv_usepvn_mg>.
3080 void sv_usepvn(SV* sv, char* ptr, STRLEN len)
3087 Like C<sv_usepvn>, but also handles 'set' magic.
3089 void sv_usepvn_mg(SV *sv, char *ptr, STRLEN len)
3094 =item sv_utf8_downgrade
3096 Attempt to convert the PV of an SV from UTF8-encoded to byte encoding.
3097 This may not be possible if the PV contains non-byte encoding characters;
3098 if this is the case, either returns false or, if C<fail_ok> is not
3101 NOTE: this function is experimental and may change or be
3102 removed without notice.
3104 bool sv_utf8_downgrade(SV *sv, bool fail_ok)
3109 =item sv_utf8_encode
3111 Convert the PV of an SV to UTF8-encoded, but then turn off the C<SvUTF8>
3112 flag so that it looks like bytes again. Nothing calls this.
3114 NOTE: this function is experimental and may change or be
3115 removed without notice.
3117 void sv_utf8_encode(SV *sv)
3122 =item sv_utf8_upgrade
3124 Convert the PV of an SV to its UTF8-encoded form.
3126 void sv_utf8_upgrade(SV *sv)
3133 Processes its arguments like C<vsprintf> and appends the formatted output
3134 to an SV. Uses an array of SVs if the C style variable argument list is
3135 missing (NULL). When running with taint checks enabled, indicates via
3136 C<maybe_tainted> if results are untrustworthy (often due to the use of
3139 void sv_vcatpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
3146 Works like C<vcatpvfn> but copies the text into the SV instead of
3149 void sv_vsetpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
3156 Variable which is setup by C<xsubpp> to designate the object in a C++
3157 XSUB. This is always the proper type for the C++ object. See C<CLASS> and
3158 L<perlxs/"Using XS With C++">.
3163 Found in file XSUB.h
3167 Converts the specified character to lowercase.
3169 char toLOWER(char ch)
3172 Found in file handy.h
3176 Converts the specified character to uppercase.
3178 char toUPPER(char ch)
3181 Found in file handy.h
3185 Returns the character value of the first character in the string C<s>
3186 which is assumed to be in UTF8 encoding; C<retlen> will be set to the
3187 length, in bytes, of that character, and the pointer C<s> will be
3188 advanced to the end of the character.
3190 If C<s> does not point to a well-formed UTF8 character, the behaviour
3191 is dependent on the value of C<checking>: if this is true, it is
3192 assumed that the caller will raise a warning, and this function will
3193 set C<retlen> to C<-1> and return. If C<checking> is not true, an optional UTF8
3194 warning is produced.
3196 utf8_to_uv U8 *s(I32 *retlen, I32 checking)
3199 Found in file utf8.c
3203 Converts a string C<s> of length C<len> from UTF8 into byte encoding.
3204 Unlike C<bytes_to_utf8>, this over-writes the original string, and
3205 updates len to contain the new length.
3206 Returns zero on failure, setting C<len> to -1.
3208 U8 * utf8_to_bytes(U8 *s, STRLEN *len)
3211 Found in file utf8.c
3215 This is the XSUB-writer's interface to Perl's C<warn> function. Use this
3216 function the same way you use the C C<printf> function. See
3219 void warn(const char* pat, ...)
3222 Found in file util.c
3226 Push an integer onto the stack, extending the stack if necessary. Handles
3227 'set' magic. See C<PUSHi>.
3236 Push a double onto the stack, extending the stack if necessary. Handles
3237 'set' magic. See C<PUSHn>.
3246 Push a string onto the stack, extending the stack if necessary. The C<len>
3247 indicates the length of the string. Handles 'set' magic. See
3250 void XPUSHp(char* str, STRLEN len)
3257 Push an SV onto the stack, extending the stack if necessary. Does not
3258 handle 'set' magic. See C<PUSHs>.
3267 Push an unsigned integer onto the stack, extending the stack if necessary.
3277 Macro to declare an XSUB and its C parameter list. This is handled by
3281 Found in file XSUB.h
3285 Return from XSUB, indicating number of items on the stack. This is usually
3286 handled by C<xsubpp>.
3288 void XSRETURN(int nitems)
3291 Found in file XSUB.h
3293 =item XSRETURN_EMPTY
3295 Return an empty list from an XSUB immediately.
3300 Found in file XSUB.h
3304 Return an integer from an XSUB immediately. Uses C<XST_mIV>.
3306 void XSRETURN_IV(IV iv)
3309 Found in file XSUB.h
3313 Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
3318 Found in file XSUB.h
3322 Return an double from an XSUB immediately. Uses C<XST_mNV>.
3324 void XSRETURN_NV(NV nv)
3327 Found in file XSUB.h
3331 Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
3333 void XSRETURN_PV(char* str)
3336 Found in file XSUB.h
3338 =item XSRETURN_UNDEF
3340 Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
3345 Found in file XSUB.h
3349 Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
3354 Found in file XSUB.h
3358 Place an integer into the specified position C<pos> on the stack. The
3359 value is stored in a new mortal SV.
3361 void XST_mIV(int pos, IV iv)
3364 Found in file XSUB.h
3368 Place C<&PL_sv_no> into the specified position C<pos> on the
3371 void XST_mNO(int pos)
3374 Found in file XSUB.h
3378 Place a double into the specified position C<pos> on the stack. The value
3379 is stored in a new mortal SV.
3381 void XST_mNV(int pos, NV nv)
3384 Found in file XSUB.h
3388 Place a copy of a string into the specified position C<pos> on the stack.
3389 The value is stored in a new mortal SV.
3391 void XST_mPV(int pos, char* str)
3394 Found in file XSUB.h
3398 Place C<&PL_sv_undef> into the specified position C<pos> on the
3401 void XST_mUNDEF(int pos)
3404 Found in file XSUB.h
3408 Place C<&PL_sv_yes> into the specified position C<pos> on the
3411 void XST_mYES(int pos)
3414 Found in file XSUB.h
3418 The version identifier for an XS module. This is usually
3419 handled automatically by C<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>.
3422 Found in file XSUB.h
3424 =item XS_VERSION_BOOTCHECK
3426 Macro to verify that a PM module's $VERSION variable matches the XS
3427 module's C<XS_VERSION> variable. This is usually handled automatically by
3428 C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">.
3430 XS_VERSION_BOOTCHECK;
3433 Found in file XSUB.h
3437 The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the
3438 destination, C<nitems> is the number of items, and C<type> is the type.
3440 void Zero(void* dest, int nitems, type)
3443 Found in file handy.h
3449 Until May 1997, this document was maintained by Jeff Okamoto
3450 <okamoto@corp.hp.com>. It is now maintained as part of Perl itself.
3452 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
3453 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
3454 Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
3455 Stephen McCamant, and Gurusamy Sarathy.
3457 API Listing originally by Dean Roehrich <roehrich@cray.com>.
3459 Updated to be autogenerated from comments in the source by Benjamin Stuhl.
3463 perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
projects / p5sagit/p5-mst-13.2.git / blob