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 If C<cv> is a constant sub eligible for inlining. returns the constant
293 value returned by the sub. Otherwise, returns NULL.
295 Constant subs can be created with C<newCONSTSUB> or as described in
296 L<perlsub/"Constant Functions">.
298 SV* cv_const_sv(CV* cv)
305 Declare a stack marker variable, C<mark>, for the XSUB. See C<MARK> and
315 Saves the original stack mark for the XSUB. See C<ORIGMARK>.
324 Declares a local copy of perl's stack pointer for the XSUB, available via
325 the C<SP> macro. See C<SP>.
334 Sets up stack and mark pointers for an XSUB, calling dSP and dMARK. This
335 is usually handled automatically by C<xsubpp>. Declares the C<items>
336 variable to indicate the number of items on the stack.
345 Sets up the C<ix> variable for an XSUB which has aliases. This is usually
346 handled automatically by C<xsubpp>.
355 Opening bracket on a callback. See C<LEAVE> and L<perlcall>.
360 Found in file scope.h
364 Tells Perl to C<eval> the given string and return an SV* result.
366 NOTE: the perl_ form of this function is deprecated.
368 SV* eval_pv(const char* p, I32 croak_on_error)
375 Tells Perl to C<eval> the string in the SV.
377 NOTE: the perl_ form of this function is deprecated.
379 I32 eval_sv(SV* sv, I32 flags)
386 Used to extend the argument stack for an XSUB's return values. Once
387 used, guarantees that there is room for at least C<nitems> to be pushed
390 void EXTEND(SP, int nitems)
397 Analyses the string in order to make fast searches on it using fbm_instr()
398 -- the Boyer-Moore algorithm.
400 void fbm_compile(SV* sv, U32 flags)
407 Returns the location of the SV in the string delimited by C<str> and
408 C<strend>. It returns C<Nullch> if the string can't be found. The C<sv>
409 does not have to be fbm_compiled, but the search will not be as fast
412 char* fbm_instr(unsigned char* big, unsigned char* bigend, SV* littlesv, U32 flags)
419 Closing bracket for temporaries on a callback. See C<SAVETMPS> and
425 Found in file scope.h
429 Returns the AV of the specified Perl array. If C<create> is set and the
430 Perl variable does not exist then it will be created. If C<create> is not
431 set and the variable does not exist then NULL is returned.
433 NOTE: the perl_ form of this function is deprecated.
435 AV* get_av(const char* name, I32 create)
442 Returns the CV of the specified Perl subroutine. If C<create> is set and
443 the Perl subroutine does not exist then it will be declared (which has the
444 same effect as saying C<sub name;>). If C<create> is not set and the
445 subroutine does not exist then NULL is returned.
447 NOTE: the perl_ form of this function is deprecated.
449 CV* get_cv(const char* name, I32 create)
456 Returns the HV of the specified Perl hash. 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 HV* get_hv(const char* name, I32 create)
469 Returns the SV of the specified Perl scalar. If C<create> is set and the
470 Perl variable does not exist then it will be created. If C<create> is not
471 set and the variable does not exist then NULL is returned.
473 NOTE: the perl_ form of this function is deprecated.
475 SV* get_sv(const char* name, I32 create)
482 A backward-compatible version of C<GIMME_V> which can only return
483 C<G_SCALAR> or C<G_ARRAY>; in a void context, it returns C<G_SCALAR>.
484 Deprecated. Use C<GIMME_V> instead.
493 The XSUB-writer's equivalent to Perl's C<wantarray>. Returns C<G_VOID>,
494 C<G_SCALAR> or C<G_ARRAY> for void, scalar or list context,
504 Return the SV from the GV.
513 Returns the glob with the given C<name> and a defined subroutine or
514 C<NULL>. The glob lives in the given C<stash>, or in the stashes
515 accessible via @ISA and @UNIVERSAL.
517 The argument C<level> should be either 0 or -1. If C<level==0>, as a
518 side-effect creates a glob with the given C<name> in the given C<stash>
519 which in the case of success contains an alias for the subroutine, and sets
520 up caching info for this glob. Similarly for all the searched stashes.
522 This function grants C<"SUPER"> token as a postfix of the stash name. The
523 GV returned from C<gv_fetchmeth> may be a method cache entry, which is not
524 visible to Perl code. So when calling C<call_sv>, you should not use
525 the GV directly; instead, you should use the method's CV, which can be
526 obtained from the GV with the C<GvCV> macro.
528 GV* gv_fetchmeth(HV* stash, const char* name, STRLEN len, I32 level)
535 See L<gv_fetchmethod_autoload>.
537 GV* gv_fetchmethod(HV* stash, const char* name)
542 =item gv_fetchmethod_autoload
544 Returns the glob which contains the subroutine to call to invoke the method
545 on the C<stash>. In fact in the presence of autoloading this may be the
546 glob for "AUTOLOAD". In this case the corresponding variable $AUTOLOAD is
549 The third parameter of C<gv_fetchmethod_autoload> determines whether
550 AUTOLOAD lookup is performed if the given method is not present: non-zero
551 means yes, look for AUTOLOAD; zero means no, don't look for AUTOLOAD.
552 Calling C<gv_fetchmethod> is equivalent to calling C<gv_fetchmethod_autoload>
553 with a non-zero C<autoload> parameter.
555 These functions grant C<"SUPER"> token as a prefix of the method name. Note
556 that if you want to keep the returned glob for a long time, you need to
557 check for it being "AUTOLOAD", since at the later time the call may load a
558 different subroutine due to $AUTOLOAD changing its value. Use the glob
559 created via a side effect to do this.
561 These functions have the same side-effects and as C<gv_fetchmeth> with
562 C<level==0>. C<name> should be writable if contains C<':'> or C<'
563 ''>. The warning against passing the GV returned by C<gv_fetchmeth> to
564 C<call_sv> apply equally to these functions.
566 GV* gv_fetchmethod_autoload(HV* stash, const char* name, I32 autoload)
573 Returns a pointer to the stash for a specified package. C<name> should
574 be a valid UTF-8 string. If C<create> is set then the package will be
575 created if it does not already exist. If C<create> is not set and the
576 package does not exist then NULL is returned.
578 HV* gv_stashpv(const char* name, I32 create)
585 Returns a pointer to the stash for a specified package, which must be a
586 valid UTF-8 string. See C<gv_stashpv>.
588 HV* gv_stashsv(SV* sv, I32 create)
595 Used to indicate list context. See C<GIMME_V>, C<GIMME> and
603 Indicates that arguments returned from a callback should be discarded. See
611 Used to force a Perl C<eval> wrapper around a callback. See
619 Indicates that no arguments are being sent to a callback. See
627 Used to indicate scalar context. See C<GIMME_V>, C<GIMME>, and
635 Used to indicate void context. See C<GIMME_V> and L<perlcall>.
642 This flag, used in the length slot of hash entries and magic structures,
643 specifies the structure contains a C<SV*> pointer where a C<char*> pointer
644 is to be expected. (For information only--not to be used).
651 Returns the computed hash stored in the hash entry.
660 Returns the actual pointer stored in the key slot of the hash entry. The
661 pointer may be either C<char*> or C<SV*>, depending on the value of
662 C<HeKLEN()>. Can be assigned to. The C<HePV()> or C<HeSVKEY()> macros are
663 usually preferable for finding the value of a key.
672 If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry
673 holds an C<SV*> key. Otherwise, holds the actual length of the key. Can
674 be assigned to. The C<HePV()> macro is usually preferable for finding key
677 STRLEN HeKLEN(HE* he)
684 Returns the key slot of the hash entry as a C<char*> value, doing any
685 necessary dereferencing of possibly C<SV*> keys. The length of the string
686 is placed in C<len> (this is a macro, so do I<not> use C<&len>). If you do
687 not care about what the length of the key is, you may use the global
688 variable C<PL_na>, though this is rather less efficient than using a local
689 variable. Remember though, that hash keys in perl are free to contain
690 embedded nulls, so using C<strlen()> or similar is not a good way to find
691 the length of hash keys. This is very similar to the C<SvPV()> macro
692 described elsewhere in this document.
694 char* HePV(HE* he, STRLEN len)
701 Returns the key as an C<SV*>, or C<Nullsv> if the hash entry does not
702 contain an C<SV*> key.
711 Returns the key as an C<SV*>. Will create and return a temporary mortal
712 C<SV*> if the hash entry contains only a C<char*> key.
714 SV* HeSVKEY_force(HE* he)
721 Sets the key to a given C<SV*>, taking care to set the appropriate flags to
722 indicate the presence of an C<SV*> key, and returns the same
725 SV* HeSVKEY_set(HE* he, SV* sv)
732 Returns the value slot (type C<SV*>) stored in the hash entry.
741 Returns the package name of a stash. See C<SvSTASH>, C<CvSTASH>.
743 char* HvNAME(HV* stash)
750 Clears a hash, making it empty.
752 void hv_clear(HV* tb)
759 Deletes a key/value pair in the hash. The value SV is removed from the
760 hash and returned to the caller. The C<klen> is the length of the key.
761 The C<flags> value will normally be zero; if set to G_DISCARD then NULL
764 SV* hv_delete(HV* tb, const char* key, I32 klen, I32 flags)
771 Deletes a key/value pair in the hash. The value SV is removed from the
772 hash and returned to the caller. The C<flags> value will normally be zero;
773 if set to G_DISCARD then NULL will be returned. C<hash> can be a valid
774 precomputed hash value, or 0 to ask for it to be computed.
776 SV* hv_delete_ent(HV* tb, SV* key, I32 flags, U32 hash)
783 Returns a boolean indicating whether the specified hash key exists. The
784 C<klen> is the length of the key.
786 bool hv_exists(HV* tb, const char* key, I32 klen)
793 Returns a boolean indicating whether the specified hash key exists. C<hash>
794 can be a valid precomputed hash value, or 0 to ask for it to be
797 bool hv_exists_ent(HV* tb, SV* key, U32 hash)
804 Returns the SV which corresponds to the specified key in the hash. The
805 C<klen> is the length of the key. If C<lval> is set then the fetch will be
806 part of a store. Check that the return value is non-null before
807 dereferencing it to a C<SV*>.
809 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
810 information on how to use this function on tied hashes.
812 SV** hv_fetch(HV* tb, const char* key, I32 klen, I32 lval)
819 Returns the hash entry which corresponds to the specified key in the hash.
820 C<hash> must be a valid precomputed hash number for the given C<key>, or 0
821 if you want the function to compute it. IF C<lval> is set then the fetch
822 will be part of a store. Make sure the return value is non-null before
823 accessing it. The return value when C<tb> is a tied hash is a pointer to a
824 static location, so be sure to make a copy of the structure if you need to
827 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
828 information on how to use this function on tied hashes.
830 HE* hv_fetch_ent(HV* tb, SV* key, I32 lval, U32 hash)
837 Prepares a starting point to traverse a hash table. Returns the number of
838 keys in the hash (i.e. the same as C<HvKEYS(tb)>). The return value is
839 currently only meaningful for hashes without tie magic.
841 NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
842 hash buckets that happen to be in use. If you still need that esoteric
843 value, you can get it through the macro C<HvFILL(tb)>.
845 I32 hv_iterinit(HV* tb)
852 Returns the key from the current position of the hash iterator. See
855 char* hv_iterkey(HE* entry, I32* retlen)
862 Returns the key as an C<SV*> from the current position of the hash
863 iterator. The return value will always be a mortal copy of the key. Also
866 SV* hv_iterkeysv(HE* entry)
873 Returns entries from a hash iterator. See C<hv_iterinit>.
875 HE* hv_iternext(HV* tb)
882 Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
885 SV* hv_iternextsv(HV* hv, char** key, I32* retlen)
892 Returns the value from the current position of the hash iterator. See
895 SV* hv_iterval(HV* tb, HE* entry)
902 Adds magic to a hash. See C<sv_magic>.
904 void hv_magic(HV* hv, GV* gv, int how)
911 Stores an SV in a hash. The hash key is specified as C<key> and C<klen> is
912 the length of the key. The C<hash> parameter is the precomputed hash
913 value; if it is zero then Perl will compute it. The return value will be
914 NULL if the operation failed or if the value did not need to be actually
915 stored within the hash (as in the case of tied hashes). Otherwise it can
916 be dereferenced to get the original C<SV*>. Note that the caller is
917 responsible for suitably incrementing the reference count of C<val> before
918 the call, and decrementing it if the function returned NULL.
920 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
921 information on how to use this function on tied hashes.
923 SV** hv_store(HV* tb, const char* key, I32 klen, SV* val, U32 hash)
930 Stores C<val> in a hash. The hash key is specified as C<key>. The C<hash>
931 parameter is the precomputed hash value; if it is zero then Perl will
932 compute it. The return value is the new hash entry so created. It will be
933 NULL if the operation failed or if the value did not need to be actually
934 stored within the hash (as in the case of tied hashes). Otherwise the
935 contents of the return value can be accessed using the C<He???> macros
936 described here. Note that the caller is responsible for suitably
937 incrementing the reference count of C<val> before the call, and
938 decrementing it if the function returned NULL.
940 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
941 information on how to use this function on tied hashes.
943 HE* hv_store_ent(HV* tb, SV* key, SV* val, U32 hash)
952 void hv_undef(HV* tb)
959 Returns a boolean indicating whether the C C<char> is an ASCII alphanumeric
960 character (including underscore) or digit.
962 bool isALNUM(char ch)
965 Found in file handy.h
969 Returns a boolean indicating whether the C C<char> is an ASCII alphabetic
972 bool isALPHA(char ch)
975 Found in file handy.h
979 Returns a boolean indicating whether the C C<char> is an ASCII
982 bool isDIGIT(char ch)
985 Found in file handy.h
989 Returns a boolean indicating whether the C C<char> is a lowercase
992 bool isLOWER(char ch)
995 Found in file handy.h
999 Returns a boolean indicating whether the C C<char> is whitespace.
1001 bool isSPACE(char ch)
1004 Found in file handy.h
1008 Returns a boolean indicating whether the C C<char> is an uppercase
1011 bool isUPPER(char ch)
1014 Found in file handy.h
1018 Variable which is setup by C<xsubpp> to indicate the number of
1019 items on the stack. See L<perlxs/"Variable-length Parameter Lists">.
1024 Found in file XSUB.h
1028 Variable which is setup by C<xsubpp> to indicate which of an
1029 XSUB's aliases was used to invoke it. See L<perlxs/"The ALIAS: Keyword">.
1034 Found in file XSUB.h
1038 Closing bracket on a callback. See C<ENTER> and L<perlcall>.
1043 Found in file scope.h
1045 =item looks_like_number
1047 Test if an the content of an SV looks like a number (or is a
1050 I32 looks_like_number(SV* sv)
1057 Stack marker variable for the XSUB. See C<dMARK>.
1064 Clear something magical that the SV represents. See C<sv_magic>.
1066 int mg_clear(SV* sv)
1073 Copies the magic from one SV to another. See C<sv_magic>.
1075 int mg_copy(SV* sv, SV* nsv, const char* key, I32 klen)
1082 Finds the magic pointer for type matching the SV. See C<sv_magic>.
1084 MAGIC* mg_find(SV* sv, int type)
1091 Free any magic storage used by the SV. See C<sv_magic>.
1100 Do magic after a value is retrieved from the SV. See C<sv_magic>.
1109 Report on the SV's length. See C<sv_magic>.
1111 U32 mg_length(SV* sv)
1118 Turns on the magical status of an SV. See C<sv_magic>.
1120 void mg_magical(SV* sv)
1127 Do magic after a value is assigned to the SV. See C<sv_magic>.
1136 The XSUB-writer's interface to the C C<memmove> function. The C<src> is the
1137 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1138 the type. Can do overlapping moves. See also C<Copy>.
1140 void Move(void* src, void* dest, int nitems, type)
1143 Found in file handy.h
1147 The XSUB-writer's interface to the C C<malloc> function.
1149 void New(int id, void* ptr, int nitems, type)
1152 Found in file handy.h
1156 Creates a new AV. The reference count is set to 1.
1165 The XSUB-writer's interface to the C C<malloc> function, with
1168 void Newc(int id, void* ptr, int nitems, type, cast)
1171 Found in file handy.h
1175 Creates a constant sub equivalent to Perl C<sub FOO () { 123 }> which is
1176 eligible for inlining at compile-time.
1178 CV* newCONSTSUB(HV* stash, char* name, SV* sv)
1185 Creates a new HV. The reference count is set to 1.
1194 Creates an RV wrapper for an SV. The reference count for the original SV is
1197 SV* newRV_inc(SV* sv)
1204 Creates an RV wrapper for an SV. The reference count for the original
1205 SV is B<not> incremented.
1207 SV* newRV_noinc(SV *sv)
1214 Creates a new SV. A non-zero C<len> parameter indicates the number of
1215 bytes of preallocated string space the SV should have. An extra byte for a
1216 tailing NUL is also reserved. (SvPOK is not set for the SV even if string
1217 space is allocated.) The reference count for the new SV is set to 1.
1218 C<id> is an integer id between 0 and 1299 (used to identify leaks).
1220 SV* NEWSV(int id, STRLEN len)
1223 Found in file handy.h
1227 Creates a new SV and copies an integer into it. The reference count for the
1237 Creates a new SV and copies a floating point value into it.
1238 The reference count for the SV is set to 1.
1247 Creates a new SV and copies a string into it. The reference count for the
1248 SV is set to 1. If C<len> is zero, Perl will compute the length using
1249 strlen(). For efficiency, consider using C<newSVpvn> instead.
1251 SV* newSVpv(const char* s, STRLEN len)
1258 Creates a new SV an initialize it with the string formatted like
1261 SV* newSVpvf(const char* pat, ...)
1268 Creates a new SV and copies a string into it. The reference count for the
1269 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
1270 string. You are responsible for ensuring that the source string is at least
1273 SV* newSVpvn(const char* s, STRLEN len)
1278 =item newSVpvn_share
1280 Creates a new SV and populates it with a string from
1281 the string table. Turns on READONLY and FAKE.
1282 The idea here is that as string table is used for shared hash
1283 keys these strings will have SvPVX == HeKEY and hash lookup
1284 will avoid string compare.
1286 SV* newSVpvn_share(const char* s, STRLEN len, U32 hash)
1293 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
1294 it will be upgraded to one. If C<classname> is non-null then the new SV will
1295 be blessed in the specified package. The new SV is returned and its
1296 reference count is 1.
1298 SV* newSVrv(SV* rv, const char* classname)
1305 Creates a new SV which is an exact duplicate of the original SV.
1307 SV* newSVsv(SV* old)
1314 Creates a new SV and copies an unsigned integer into it.
1315 The reference count for the SV is set to 1.
1324 Used by C<xsubpp> to hook up XSUBs as Perl subs.
1331 Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
1335 Found in file XSUB.h
1339 The XSUB-writer's interface to the C C<malloc> function. The allocated
1340 memory is zeroed with C<memzero>.
1342 void Newz(int id, void* ptr, int nitems, type)
1345 Found in file handy.h
1356 Null character pointer.
1359 Found in file handy.h
1380 Found in file handy.h
1384 The original stack mark for the XSUB. See C<dORIGMARK>.
1391 Allocates a new Perl interpreter. See L<perlembed>.
1393 PerlInterpreter* perl_alloc()
1396 Found in file perl.c
1398 =item perl_construct
1400 Initializes a new Perl interpreter. See L<perlembed>.
1402 void perl_construct(PerlInterpreter* interp)
1405 Found in file perl.c
1409 Shuts down a Perl interpreter. See L<perlembed>.
1411 void perl_destruct(PerlInterpreter* interp)
1414 Found in file perl.c
1418 Releases a Perl interpreter. See L<perlembed>.
1420 void perl_free(PerlInterpreter* interp)
1423 Found in file perl.c
1427 Tells a Perl interpreter to parse a Perl script. See L<perlembed>.
1429 int perl_parse(PerlInterpreter* interp, XSINIT_t xsinit, int argc, char** argv, char** env)
1432 Found in file perl.c
1436 Tells a Perl interpreter to run. See L<perlembed>.
1438 int perl_run(PerlInterpreter* interp)
1441 Found in file perl.c
1445 When Perl is run in debugging mode, with the B<-d> switch, this SV is a
1446 boolean which indicates whether subs are being single-stepped.
1447 Single-stepping is automatically turned on after every step. This is the C
1448 variable which corresponds to Perl's $DB::single variable. See
1454 Found in file intrpvar.h
1458 When Perl is run in debugging mode, with the B<-d> switch, this GV contains
1459 the SV which holds the name of the sub being debugged. This is the C
1460 variable which corresponds to Perl's $DB::sub variable. See
1466 Found in file intrpvar.h
1470 Trace variable used when Perl is run in debugging mode, with the B<-d>
1471 switch. This is the C variable which corresponds to Perl's $DB::trace
1472 variable. See C<PL_DBsingle>.
1477 Found in file intrpvar.h
1481 The C variable which corresponds to Perl's $^W warning variable.
1486 Found in file intrpvar.h
1490 C<PL_modglobal> is a general purpose, interpreter global HV for use by
1491 extensions that need to keep information on a per-interpreter basis.
1492 In a pinch, it can also be used as a symbol table for extensions
1493 to share data among each other. It is a good idea to use keys
1494 prefixed by the package name of the extension that owns the data.
1499 Found in file intrpvar.h
1503 A convenience variable which is typically used with C<SvPV> when one
1504 doesn't care about the length of the string. It is usually more efficient
1505 to either declare a local variable and use that instead or to use the
1506 C<SvPV_nolen> macro.
1511 Found in file thrdvar.h
1515 This is the C<false> SV. See C<PL_sv_yes>. Always refer to this as
1521 Found in file intrpvar.h
1525 This is the C<undef> SV. Always refer to this as C<&PL_sv_undef>.
1530 Found in file intrpvar.h
1534 This is the C<true> SV. See C<PL_sv_no>. Always refer to this as
1540 Found in file intrpvar.h
1544 Pops an integer off the stack.
1553 Pops a long off the stack.
1562 Pops a double off the stack.
1571 Pops a string off the stack.
1580 Pops an SV off the stack.
1589 Push an integer onto the stack. The stack must have room for this element.
1590 Handles 'set' magic. See C<XPUSHi>.
1599 Opening bracket for arguments on a callback. See C<PUTBACK> and
1609 Push a double onto the stack. The stack must have room for this element.
1610 Handles 'set' magic. See C<XPUSHn>.
1619 Push a string onto the stack. The stack must have room for this element.
1620 The C<len> indicates the length of the string. Handles 'set' magic. See
1623 void PUSHp(char* str, STRLEN len)
1630 Push an SV onto the stack. The stack must have room for this element.
1631 Does not handle 'set' magic. See C<XPUSHs>.
1640 Push an unsigned integer onto the stack. The stack must have room for this
1641 element. See C<XPUSHu>.
1650 Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
1651 See C<PUSHMARK> and L<perlcall> for other uses.
1660 The XSUB-writer's interface to the C C<realloc> function.
1662 void Renew(void* ptr, int nitems, type)
1665 Found in file handy.h
1669 The XSUB-writer's interface to the C C<realloc> function, with
1672 void Renewc(void* ptr, int nitems, type, cast)
1675 Found in file handy.h
1679 Tells Perl to C<require> a module.
1681 NOTE: the perl_ form of this function is deprecated.
1683 void require_pv(const char* pv)
1686 Found in file perl.c
1690 Variable which is setup by C<xsubpp> to hold the return value for an
1691 XSUB. This is always the proper type for the XSUB. See
1692 L<perlxs/"The RETVAL Variable">.
1697 Found in file XSUB.h
1701 The XSUB-writer's interface to the C C<free> function.
1703 void Safefree(void* ptr)
1706 Found in file handy.h
1710 Copy a string to a safe spot. This does not use an SV.
1712 char* savepv(const char* sv)
1715 Found in file util.c
1719 Copy a string to a safe spot. The C<len> indicates number of bytes to
1720 copy. This does not use an SV.
1722 char* savepvn(const char* sv, I32 len)
1725 Found in file util.c
1729 Opening bracket for temporaries on a callback. See C<FREETMPS> and
1735 Found in file scope.h
1739 Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and
1747 Refetch the stack pointer. Used after a callback. See L<perlcall>.
1756 Used to access elements on the XSUB's stack.
1761 Found in file XSUB.h
1765 Test two strings to see if they are equal. Returns true or false.
1767 bool strEQ(char* s1, char* s2)
1770 Found in file handy.h
1774 Test two strings to see if the first, C<s1>, is greater than or equal to
1775 the second, C<s2>. Returns true or false.
1777 bool strGE(char* s1, char* s2)
1780 Found in file handy.h
1784 Test two strings to see if the first, C<s1>, is greater than the second,
1785 C<s2>. Returns true or false.
1787 bool strGT(char* s1, char* s2)
1790 Found in file handy.h
1794 Test two strings to see if the first, C<s1>, is less than or equal to the
1795 second, C<s2>. Returns true or false.
1797 bool strLE(char* s1, char* s2)
1800 Found in file handy.h
1804 Test two strings to see if the first, C<s1>, is less than the second,
1805 C<s2>. Returns true or false.
1807 bool strLT(char* s1, char* s2)
1810 Found in file handy.h
1814 Test two strings to see if they are different. Returns true or
1817 bool strNE(char* s1, char* s2)
1820 Found in file handy.h
1824 Test two strings to see if they are equal. The C<len> parameter indicates
1825 the number of bytes to compare. Returns true or false. (A wrapper for
1828 bool strnEQ(char* s1, char* s2, STRLEN len)
1831 Found in file handy.h
1835 Test two strings to see if they are different. The C<len> parameter
1836 indicates the number of bytes to compare. Returns true or false. (A
1837 wrapper for C<strncmp>).
1839 bool strnNE(char* s1, char* s2, STRLEN len)
1842 Found in file handy.h
1846 This is an architecture-independent macro to copy one structure to another.
1848 void StructCopy(type src, type dest, type)
1851 Found in file handy.h
1855 Returns the length of the string which is in the SV. See C<SvLEN>.
1857 STRLEN SvCUR(SV* sv)
1864 Set the length of the string which is in the SV. See C<SvCUR>.
1866 void SvCUR_set(SV* sv, STRLEN len)
1873 Returns a pointer to the last character in the string which is in the SV.
1874 See C<SvCUR>. Access the character as *(SvEND(sv)).
1883 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
1884 argument more than once.
1886 void SvGETMAGIC(SV* sv)
1893 Expands the character buffer in the SV so that it has room for the
1894 indicated number of bytes (remember to reserve space for an extra trailing
1895 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
1896 Returns a pointer to the character buffer.
1898 void SvGROW(SV* sv, STRLEN len)
1905 Returns a boolean indicating whether the SV contains an integer.
1914 Returns a boolean indicating whether the SV contains an integer. Checks
1915 the B<private> setting. Use C<SvIOK>.
1924 Returns a boolean indicating whether the SV contains an signed integer.
1926 void SvIOK_notUV(SV* sv)
1933 Unsets the IV status of an SV.
1935 void SvIOK_off(SV* sv)
1942 Tells an SV that it is an integer.
1944 void SvIOK_on(SV* sv)
1951 Tells an SV that it is an integer and disables all other OK bits.
1953 void SvIOK_only(SV* sv)
1960 Tells and SV that it is an unsigned integer and disables all other OK bits.
1962 void SvIOK_only_UV(SV* sv)
1969 Returns a boolean indicating whether the SV contains an unsigned integer.
1971 void SvIOK_UV(SV* sv)
1978 Coerces the given SV to an integer and returns it.
1987 Returns the integer which is stored in the SV, assuming SvIOK is
1997 Returns the size of the string buffer in the SV, not including any part
1998 attributable to C<SvOOK>. See C<SvCUR>.
2000 STRLEN SvLEN(SV* sv)
2007 Returns a boolean indicating whether the SV contains a number, integer or
2017 Returns a boolean indicating whether the SV contains a number, integer or
2018 double. Checks the B<private> setting. Use C<SvNIOK>.
2020 bool SvNIOKp(SV* sv)
2027 Unsets the NV/IV status of an SV.
2029 void SvNIOK_off(SV* sv)
2036 Returns a boolean indicating whether the SV contains a double.
2045 Returns a boolean indicating whether the SV contains a double. Checks the
2046 B<private> setting. Use C<SvNOK>.
2055 Unsets the NV status of an SV.
2057 void SvNOK_off(SV* sv)
2064 Tells an SV that it is a double.
2066 void SvNOK_on(SV* sv)
2073 Tells an SV that it is a double and disables all other OK bits.
2075 void SvNOK_only(SV* sv)
2082 Coerce the given SV to a double and return it.
2091 Returns the double which is stored in the SV, assuming SvNOK is
2101 Returns a boolean indicating whether the value is an SV.
2110 Returns a boolean indicating whether the SvIVX is a valid offset value for
2111 the SvPVX. This hack is used internally to speed up removal of characters
2112 from the beginning of a SvPV. When SvOOK is true, then the start of the
2113 allocated string buffer is really (SvPVX - SvIVX).
2122 Returns a boolean indicating whether the SV contains a character
2132 Returns a boolean indicating whether the SV contains a character string.
2133 Checks the B<private> setting. Use C<SvPOK>.
2142 Unsets the PV status of an SV.
2144 void SvPOK_off(SV* sv)
2151 Tells an SV that it is a string.
2153 void SvPOK_on(SV* sv)
2160 Tells an SV that it is a string and disables all other OK bits.
2162 void SvPOK_only(SV* sv)
2167 =item SvPOK_only_UTF8
2169 Tells an SV that it is a UTF8 string (do not use frivolously)
2170 and disables all other OK bits.
2172 void SvPOK_only_UTF8(SV* sv)
2179 Returns a pointer to the string in the SV, or a stringified form of the SV
2180 if the SV does not contain a string. Handles 'get' magic.
2182 char* SvPV(SV* sv, STRLEN len)
2189 Returns a pointer to the string in the SV. The SV must contain a
2199 Like <SvPV> but will force the SV into becoming a string (SvPOK). You want
2200 force if you are going to update the SvPVX directly.
2202 char* SvPV_force(SV* sv, STRLEN len)
2209 Returns a pointer to the string in the SV, or a stringified form of the SV
2210 if the SV does not contain a string. Handles 'get' magic.
2212 char* SvPV_nolen(SV* sv)
2219 Returns the value of the object's reference count.
2221 U32 SvREFCNT(SV* sv)
2228 Decrements the reference count of the given SV.
2230 void SvREFCNT_dec(SV* sv)
2237 Increments the reference count of the given SV.
2239 SV* SvREFCNT_inc(SV* sv)
2246 Tests if the SV is an RV.
2255 Unsets the RV status of an SV.
2257 void SvROK_off(SV* sv)
2264 Tells an SV that it is an RV.
2266 void SvROK_on(SV* sv)
2273 Dereferences an RV to return the SV.
2282 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
2283 argument more than once.
2285 void SvSETMAGIC(SV* sv)
2292 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
2295 void SvSetSV(SV* dsb, SV* ssv)
2300 =item SvSetSV_nosteal
2302 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
2303 ssv. May evaluate arguments more than once.
2305 void SvSetSV_nosteal(SV* dsv, SV* ssv)
2312 Returns the stash of the SV.
2321 Taints an SV if tainting is enabled
2323 void SvTAINT(SV* sv)
2330 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
2333 bool SvTAINTED(SV* sv)
2340 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
2341 some of Perl's fundamental security features. XS module authors should not
2342 use this function unless they fully understand all the implications of
2343 unconditionally untainting the value. Untainting should be done in the
2344 standard perl fashion, via a carefully crafted regexp, rather than directly
2345 untainting variables.
2347 void SvTAINTED_off(SV* sv)
2354 Marks an SV as tainted.
2356 void SvTAINTED_on(SV* sv)
2363 Returns a boolean indicating whether Perl would evaluate the SV as true or
2364 false, defined or undefined. Does not handle 'get' magic.
2373 An enum of flags for Perl types. These are found in the file B<sv.h>
2374 in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
2381 Returns the type of the SV. See C<svtype>.
2383 svtype SvTYPE(SV* sv)
2390 Integer type flag for scalars. See C<svtype>.
2397 Double type flag for scalars. See C<svtype>.
2404 Pointer type flag for scalars. See C<svtype>.
2411 Type flag for arrays. See C<svtype>.
2418 Type flag for code refs. See C<svtype>.
2425 Type flag for hashes. See C<svtype>.
2432 Type flag for blessed scalars. See C<svtype>.
2439 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
2440 perform the upgrade if necessary. See C<svtype>.
2442 void SvUPGRADE(SV* sv, svtype type)
2449 Returns a boolean indicating whether the SV contains UTF-8 encoded data.
2458 Unsets the UTF8 status of an SV.
2460 void SvUTF8_off(SV *sv)
2467 Tells an SV that it is a string and encoded in UTF8. Do not use frivolously.
2469 void SvUTF8_on(SV *sv)
2476 Coerces the given SV to an unsigned integer and returns it.
2485 Returns the unsigned integer which is stored in the SV, assuming SvIOK is
2495 Marks an SV as mortal. The SV will be destroyed when the current context
2498 SV* sv_2mortal(SV* sv)
2505 Blesses an SV into a specified package. The SV must be an RV. The package
2506 must be designated by its stash (see C<gv_stashpv()>). The reference count
2507 of the SV is unaffected.
2509 SV* sv_bless(SV* sv, HV* stash)
2516 Concatenates the string onto the end of the string which is in the SV.
2517 Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
2519 void sv_catpv(SV* sv, const char* ptr)
2526 Processes its arguments like C<sprintf> and appends the formatted output
2527 to an SV. Handles 'get' magic, but not 'set' magic. C<SvSETMAGIC()> must
2528 typically be called after calling this function to handle 'set' magic.
2530 void sv_catpvf(SV* sv, const char* pat, ...)
2537 Like C<sv_catpvf>, but also handles 'set' magic.
2539 void sv_catpvf_mg(SV *sv, const char* pat, ...)
2546 Concatenates the string onto the end of the string which is in the SV. The
2547 C<len> indicates number of bytes to copy. Handles 'get' magic, but not
2548 'set' magic. See C<sv_catpvn_mg>.
2550 void sv_catpvn(SV* sv, const char* ptr, STRLEN len)
2557 Like C<sv_catpvn>, but also handles 'set' magic.
2559 void sv_catpvn_mg(SV *sv, const char *ptr, STRLEN len)
2566 Like C<sv_catpv>, but also handles 'set' magic.
2568 void sv_catpv_mg(SV *sv, const char *ptr)
2575 Concatenates the string from SV C<ssv> onto the end of the string in SV
2576 C<dsv>. Handles 'get' magic, but not 'set' magic. See C<sv_catsv_mg>.
2578 void sv_catsv(SV* dsv, SV* ssv)
2585 Like C<sv_catsv>, but also handles 'set' magic.
2587 void sv_catsv_mg(SV *dstr, SV *sstr)
2594 Efficient removal of characters from the beginning of the string buffer.
2595 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
2596 the string buffer. The C<ptr> becomes the first character of the adjusted
2599 void sv_chop(SV* sv, char* ptr)
2606 Clear an SV, making it empty. Does not free the memory used by the SV
2609 void sv_clear(SV* sv)
2616 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
2617 string in C<sv1> is less than, equal to, or greater than the string in
2620 I32 sv_cmp(SV* sv1, SV* sv2)
2627 Compares the strings in two SVs in a locale-aware manner. See
2630 I32 sv_cmp_locale(SV* sv1, SV* sv2)
2637 Auto-decrement of the value in the SV.
2644 =item sv_derived_from
2646 Returns a boolean indicating whether the SV is derived from the specified
2647 class. This is the function that implements C<UNIVERSAL::isa>. It works
2648 for class names as well as for objects.
2650 bool sv_derived_from(SV* sv, const char* name)
2653 Found in file universal.c
2657 Returns a boolean indicating whether the strings in the two SVs are
2660 I32 sv_eq(SV* sv1, SV* sv2)
2667 Free the memory used by an SV.
2669 void sv_free(SV* sv)
2676 Get a line from the filehandle and store it into the SV, optionally
2677 appending to the currently-stored string.
2679 char* sv_gets(SV* sv, PerlIO* fp, I32 append)
2686 Expands the character buffer in the SV. This will use C<sv_unref> and will
2687 upgrade the SV to C<SVt_PV>. Returns a pointer to the character buffer.
2690 char* sv_grow(SV* sv, STRLEN newlen)
2697 Auto-increment of the value in the SV.
2706 Inserts a string at the specified offset/length within the SV. Similar to
2707 the Perl substr() function.
2709 void sv_insert(SV* bigsv, STRLEN offset, STRLEN len, char* little, STRLEN littlelen)
2716 Returns a boolean indicating whether the SV is blessed into the specified
2717 class. This does not check for subtypes; use C<sv_derived_from> to verify
2718 an inheritance relationship.
2720 int sv_isa(SV* sv, const char* name)
2727 Returns a boolean indicating whether the SV is an RV pointing to a blessed
2728 object. If the SV is not an RV, or if the object is not blessed, then this
2731 int sv_isobject(SV* sv)
2738 Returns the length of the string in the SV. See also C<SvCUR>.
2740 STRLEN sv_len(SV* sv)
2747 Returns the number of characters in the string in an SV, counting wide
2748 UTF8 bytes as a single character.
2750 STRLEN sv_len_utf8(SV* sv)
2757 Adds magic to an SV.
2759 void sv_magic(SV* sv, SV* obj, int how, const char* name, I32 namlen)
2766 Creates a new SV which is a copy of the original SV. The new SV is marked
2769 SV* sv_mortalcopy(SV* oldsv)
2776 Creates a new SV which is mortal. The reference count of the SV is set to 1.
2785 Get a sensible string out of the SV somehow.
2787 char* sv_pvn_force(SV* sv, STRLEN* lp)
2792 =item sv_pvutf8n_force
2794 Get a sensible UTF8-encoded string out of the SV somehow. See
2797 char* sv_pvutf8n_force(SV* sv, STRLEN* lp)
2804 Returns a string describing what the SV is a reference to.
2806 char* sv_reftype(SV* sv, int ob)
2813 Make the first argument a copy of the second, then delete the original.
2815 void sv_replace(SV* sv, SV* nsv)
2824 SV* sv_rvweaken(SV *sv)
2831 Copies an integer into the given SV. Does not handle 'set' magic. See
2834 void sv_setiv(SV* sv, IV num)
2841 Like C<sv_setiv>, but also handles 'set' magic.
2843 void sv_setiv_mg(SV *sv, IV i)
2850 Copies a double into the given SV. Does not handle 'set' magic. See
2853 void sv_setnv(SV* sv, NV num)
2860 Like C<sv_setnv>, but also handles 'set' magic.
2862 void sv_setnv_mg(SV *sv, NV num)
2869 Copies a string into an SV. The string must be null-terminated. Does not
2870 handle 'set' magic. See C<sv_setpv_mg>.
2872 void sv_setpv(SV* sv, const char* ptr)
2879 Processes its arguments like C<sprintf> and sets an SV to the formatted
2880 output. Does not handle 'set' magic. See C<sv_setpvf_mg>.
2882 void sv_setpvf(SV* sv, const char* pat, ...)
2889 Like C<sv_setpvf>, but also handles 'set' magic.
2891 void sv_setpvf_mg(SV *sv, const char* pat, ...)
2898 Copies an integer into the given SV, also updating its string value.
2899 Does not handle 'set' magic. See C<sv_setpviv_mg>.
2901 void sv_setpviv(SV* sv, IV num)
2908 Like C<sv_setpviv>, but also handles 'set' magic.
2910 void sv_setpviv_mg(SV *sv, IV iv)
2917 Copies a string into an SV. The C<len> parameter indicates the number of
2918 bytes to be copied. Does not handle 'set' magic. See C<sv_setpvn_mg>.
2920 void sv_setpvn(SV* sv, const char* ptr, STRLEN len)
2927 Like C<sv_setpvn>, but also handles 'set' magic.
2929 void sv_setpvn_mg(SV *sv, const char *ptr, STRLEN len)
2936 Like C<sv_setpv>, but also handles 'set' magic.
2938 void sv_setpv_mg(SV *sv, const char *ptr)
2945 Copies an integer 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_iv(SV* rv, const char* classname, IV iv)
2958 Copies a double 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. The C<classname> argument indicates the package for the
2961 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
2962 will be returned and will have a reference count of 1.
2964 SV* sv_setref_nv(SV* rv, const char* classname, NV nv)
2971 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
2972 argument will be upgraded to an RV. That RV will be modified to point to
2973 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
2974 into the SV. The C<classname> argument indicates the package for the
2975 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
2976 will be returned and will have a reference count of 1.
2978 Do not use with other Perl types such as HV, AV, SV, CV, because those
2979 objects will become corrupted by the pointer copy process.
2981 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
2983 SV* sv_setref_pv(SV* rv, const char* classname, void* pv)
2990 Copies a string into a new SV, optionally blessing the SV. The length of the
2991 string must be specified with C<n>. The C<rv> argument will be upgraded to
2992 an RV. That RV will be modified to point to the new SV. The C<classname>
2993 argument indicates the package for the blessing. Set C<classname> to
2994 C<Nullch> to avoid the blessing. The new SV will be returned and will have
2995 a reference count of 1.
2997 Note that C<sv_setref_pv> copies the pointer while this copies the string.
2999 SV* sv_setref_pvn(SV* rv, const char* classname, char* pv, STRLEN n)
3006 Copies the contents of the source SV C<ssv> into the destination SV C<dsv>.
3007 The source SV may be destroyed if it is mortal. Does not handle 'set'
3008 magic. See the macro forms C<SvSetSV>, C<SvSetSV_nosteal> and
3011 void sv_setsv(SV* dsv, SV* ssv)
3018 Like C<sv_setsv>, but also handles 'set' magic.
3020 void sv_setsv_mg(SV *dstr, SV *sstr)
3027 Copies an unsigned integer into the given SV. Does not handle 'set' magic.
3030 void sv_setuv(SV* sv, UV num)
3037 Like C<sv_setuv>, but also handles 'set' magic.
3039 void sv_setuv_mg(SV *sv, UV u)
3046 Returns true if the SV has a true value by Perl's rules.
3055 Removes magic from an SV.
3057 int sv_unmagic(SV* sv, int type)
3064 Unsets the RV status of the SV, and decrements the reference count of
3065 whatever was being referenced by the RV. This can almost be thought of
3066 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
3067 being zero. See C<SvROK_off>.
3069 void sv_unref(SV* sv)
3074 =item sv_unref_flags
3076 Unsets the RV status of the SV, and decrements the reference count of
3077 whatever was being referenced by the RV. This can almost be thought of
3078 as a reversal of C<newSVrv>. The C<cflags> argument can contain
3079 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
3080 (otherwise the decrementing is conditional on the reference count being
3081 different from one or the reference being a readonly SV).
3084 void sv_unref_flags(SV* sv, U32 flags)
3091 Upgrade an SV to a more complex form. Use C<SvUPGRADE>. See
3094 bool sv_upgrade(SV* sv, U32 mt)
3101 Tells an SV to use C<ptr> to find its string value. Normally the string is
3102 stored inside the SV but sv_usepvn allows the SV to use an outside string.
3103 The C<ptr> should point to memory that was allocated by C<malloc>. The
3104 string length, C<len>, must be supplied. This function will realloc the
3105 memory pointed to by C<ptr>, so that pointer should not be freed or used by
3106 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
3107 See C<sv_usepvn_mg>.
3109 void sv_usepvn(SV* sv, char* ptr, STRLEN len)
3116 Like C<sv_usepvn>, but also handles 'set' magic.
3118 void sv_usepvn_mg(SV *sv, char *ptr, STRLEN len)
3123 =item sv_utf8_downgrade
3125 Attempt to convert the PV of an SV from UTF8-encoded to byte encoding.
3126 This may not be possible if the PV contains non-byte encoding characters;
3127 if this is the case, either returns false or, if C<fail_ok> is not
3130 NOTE: this function is experimental and may change or be
3131 removed without notice.
3133 bool sv_utf8_downgrade(SV *sv, bool fail_ok)
3138 =item sv_utf8_encode
3140 Convert the PV of an SV to UTF8-encoded, but then turn off the C<SvUTF8>
3141 flag so that it looks like bytes again. Nothing calls this.
3143 NOTE: this function is experimental and may change or be
3144 removed without notice.
3146 void sv_utf8_encode(SV *sv)
3151 =item sv_utf8_upgrade
3153 Convert the PV of an SV to its UTF8-encoded form.
3155 void sv_utf8_upgrade(SV *sv)
3162 Processes its arguments like C<vsprintf> and appends the formatted output
3163 to an SV. Uses an array of SVs if the C style variable argument list is
3164 missing (NULL). When running with taint checks enabled, indicates via
3165 C<maybe_tainted> if results are untrustworthy (often due to the use of
3168 void sv_vcatpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
3175 Works like C<vcatpvfn> but copies the text into the SV instead of
3178 void sv_vsetpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
3185 Variable which is setup by C<xsubpp> to designate the object in a C++
3186 XSUB. This is always the proper type for the C++ object. See C<CLASS> and
3187 L<perlxs/"Using XS With C++">.
3192 Found in file XSUB.h
3196 Converts the specified character to lowercase.
3198 char toLOWER(char ch)
3201 Found in file handy.h
3205 Converts the specified character to uppercase.
3207 char toUPPER(char ch)
3210 Found in file handy.h
3214 Returns true if first C<len> bytes of the given string form valid a UTF8
3215 string, false otherwise.
3217 is_utf8_string U8 *s(STRLEN len)
3220 Found in file utf8.c
3224 Returns the number of UTF8 characters between the UTF-8 pointers C<a>
3227 WARNING: use only if you *know* that the pointers point inside the
3230 IV utf8_distance(U8 *a, U8 *b)
3233 Found in file utf8.c
3237 Return the UTF-8 pointer C<s> displaced by C<off> characters, either
3238 forward or backward.
3240 WARNING: do not use the following unless you *know* C<off> is within
3241 the UTF-8 data pointed to by C<s> *and* that on entry C<s> is aligned
3242 on the first byte of character or just after the last byte of a character.
3244 U8* utf8_hop(U8 *s, I32 off)
3247 Found in file utf8.c
3251 Return the length of the UTF-8 char encoded string C<s> in characters.
3252 Stops at C<e> (inclusive). If C<e E<lt> s> or if the scan would end
3253 up past C<e>, croaks.
3255 STRLEN utf8_length(U8* s, U8 *e)
3258 Found in file utf8.c
3262 Converts a string C<s> of length C<len> from UTF8 into byte encoding.
3263 Unlike C<bytes_to_utf8>, this over-writes the original string, and
3264 updates len to contain the new length.
3265 Returns zero on failure, setting C<len> to -1.
3267 U8 * utf8_to_bytes(U8 *s, STRLEN *len)
3270 Found in file utf8.c
3274 Returns the character value of the first character in the string C<s>
3275 which is assumed to be in UTF8 encoding and no longer than C<curlen>;
3276 C<retlen> will be set to the length, in bytes, of that character,
3277 and the pointer C<s> will be advanced to the end of the character.
3279 If C<s> does not point to a well-formed UTF8 character, the behaviour
3280 is dependent on the value of C<flags>: if it contains UTF8_CHECK_ONLY,
3281 it is assumed that the caller will raise a warning, and this function
3282 will set C<retlen> to C<-1> and return zero. If the C<flags> does not
3283 contain UTF8_CHECK_ONLY, the UNICODE_REPLACEMENT (0xFFFD) will be
3284 returned, and C<retlen> will be set to the expected length of the
3285 UTF-8 character in bytes. The C<flags> can also contain various flags
3286 to allow deviations from the strict UTF-8 encoding (see F<utf8.h>).
3288 U8* s utf8_to_uv(STRLEN curlen, STRLEN *retlen, U32 flags)
3291 Found in file utf8.c
3293 =item utf8_to_uv_simple
3295 Returns the character value of the first character in the string C<s>
3296 which is assumed to be in UTF8 encoding; C<retlen> will be set to the
3297 length, in bytes, of that character, and the pointer C<s> will be
3298 advanced to the end of the character.
3300 If C<s> does not point to a well-formed UTF8 character, zero is
3301 returned and retlen is set, if possible, to -1.
3303 U8* s utf8_to_uv_simple(STRLEN *retlen)
3306 Found in file utf8.c
3310 This is the XSUB-writer's interface to Perl's C<warn> function. Use this
3311 function the same way you use the C C<printf> function. See
3314 void warn(const char* pat, ...)
3317 Found in file util.c
3321 Push an integer onto the stack, extending the stack if necessary. Handles
3322 'set' magic. See C<PUSHi>.
3331 Push a double onto the stack, extending the stack if necessary. Handles
3332 'set' magic. See C<PUSHn>.
3341 Push a string onto the stack, extending the stack if necessary. The C<len>
3342 indicates the length of the string. Handles 'set' magic. See
3345 void XPUSHp(char* str, STRLEN len)
3352 Push an SV onto the stack, extending the stack if necessary. Does not
3353 handle 'set' magic. See C<PUSHs>.
3362 Push an unsigned integer onto the stack, extending the stack if necessary.
3372 Macro to declare an XSUB and its C parameter list. This is handled by
3376 Found in file XSUB.h
3380 Return from XSUB, indicating number of items on the stack. This is usually
3381 handled by C<xsubpp>.
3383 void XSRETURN(int nitems)
3386 Found in file XSUB.h
3388 =item XSRETURN_EMPTY
3390 Return an empty list from an XSUB immediately.
3395 Found in file XSUB.h
3399 Return an integer from an XSUB immediately. Uses C<XST_mIV>.
3401 void XSRETURN_IV(IV iv)
3404 Found in file XSUB.h
3408 Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
3413 Found in file XSUB.h
3417 Return an double from an XSUB immediately. Uses C<XST_mNV>.
3419 void XSRETURN_NV(NV nv)
3422 Found in file XSUB.h
3426 Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
3428 void XSRETURN_PV(char* str)
3431 Found in file XSUB.h
3433 =item XSRETURN_UNDEF
3435 Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
3440 Found in file XSUB.h
3444 Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
3449 Found in file XSUB.h
3453 Place an integer into the specified position C<pos> on the stack. The
3454 value is stored in a new mortal SV.
3456 void XST_mIV(int pos, IV iv)
3459 Found in file XSUB.h
3463 Place C<&PL_sv_no> into the specified position C<pos> on the
3466 void XST_mNO(int pos)
3469 Found in file XSUB.h
3473 Place a double into the specified position C<pos> on the stack. The value
3474 is stored in a new mortal SV.
3476 void XST_mNV(int pos, NV nv)
3479 Found in file XSUB.h
3483 Place a copy of a string into the specified position C<pos> on the stack.
3484 The value is stored in a new mortal SV.
3486 void XST_mPV(int pos, char* str)
3489 Found in file XSUB.h
3493 Place C<&PL_sv_undef> into the specified position C<pos> on the
3496 void XST_mUNDEF(int pos)
3499 Found in file XSUB.h
3503 Place C<&PL_sv_yes> into the specified position C<pos> on the
3506 void XST_mYES(int pos)
3509 Found in file XSUB.h
3513 The version identifier for an XS module. This is usually
3514 handled automatically by C<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>.
3517 Found in file XSUB.h
3519 =item XS_VERSION_BOOTCHECK
3521 Macro to verify that a PM module's $VERSION variable matches the XS
3522 module's C<XS_VERSION> variable. This is usually handled automatically by
3523 C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">.
3525 XS_VERSION_BOOTCHECK;
3528 Found in file XSUB.h
3532 The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the
3533 destination, C<nitems> is the number of items, and C<type> is the type.
3535 void Zero(void* dest, int nitems, type)
3538 Found in file handy.h
3544 Until May 1997, this document was maintained by Jeff Okamoto
3545 <okamoto@corp.hp.com>. It is now maintained as part of Perl itself.
3547 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
3548 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
3549 Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
3550 Stephen McCamant, and Gurusamy Sarathy.
3552 API Listing originally by Dean Roehrich <roehrich@cray.com>.
3554 Updated to be autogenerated from comments in the source by Benjamin Stuhl.
3558 perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
projects / p5sagit/p5-mst-13.2.git / blob