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)
301 Found in file opmini.c
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
1048 number). C<Inf> and C<Infinity> are treated as numbers (so will not
1049 issue a non-numeric warning), even if your atof() doesn't grok them.
1051 I32 looks_like_number(SV* sv)
1058 Stack marker variable for the XSUB. See C<dMARK>.
1065 Clear something magical that the SV represents. See C<sv_magic>.
1067 int mg_clear(SV* sv)
1074 Copies the magic from one SV to another. See C<sv_magic>.
1076 int mg_copy(SV* sv, SV* nsv, const char* key, I32 klen)
1083 Finds the magic pointer for type matching the SV. See C<sv_magic>.
1085 MAGIC* mg_find(SV* sv, int type)
1092 Free any magic storage used by the SV. See C<sv_magic>.
1101 Do magic after a value is retrieved from the SV. See C<sv_magic>.
1110 Report on the SV's length. See C<sv_magic>.
1112 U32 mg_length(SV* sv)
1119 Turns on the magical status of an SV. See C<sv_magic>.
1121 void mg_magical(SV* sv)
1128 Do magic after a value is assigned to the SV. See C<sv_magic>.
1137 The XSUB-writer's interface to the C C<memmove> function. The C<src> is the
1138 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1139 the type. Can do overlapping moves. See also C<Copy>.
1141 void Move(void* src, void* dest, int nitems, type)
1144 Found in file handy.h
1148 The XSUB-writer's interface to the C C<malloc> function.
1150 void New(int id, void* ptr, int nitems, type)
1153 Found in file handy.h
1157 Creates a new AV. The reference count is set to 1.
1166 The XSUB-writer's interface to the C C<malloc> function, with
1169 void Newc(int id, void* ptr, int nitems, type, cast)
1172 Found in file handy.h
1176 Creates a constant sub equivalent to Perl C<sub FOO () { 123 }> which is
1177 eligible for inlining at compile-time.
1179 CV* newCONSTSUB(HV* stash, char* name, SV* sv)
1182 Found in file opmini.c
1186 Creates a new HV. The reference count is set to 1.
1195 Creates an RV wrapper for an SV. The reference count for the original SV is
1198 SV* newRV_inc(SV* sv)
1205 Creates an RV wrapper for an SV. The reference count for the original
1206 SV is B<not> incremented.
1208 SV* newRV_noinc(SV *sv)
1215 Creates a new SV. A non-zero C<len> parameter indicates the number of
1216 bytes of preallocated string space the SV should have. An extra byte for a
1217 tailing NUL is also reserved. (SvPOK is not set for the SV even if string
1218 space is allocated.) The reference count for the new SV is set to 1.
1219 C<id> is an integer id between 0 and 1299 (used to identify leaks).
1221 SV* NEWSV(int id, STRLEN len)
1224 Found in file handy.h
1228 Creates a new SV and copies an integer into it. The reference count for the
1238 Creates a new SV and copies a floating point value into it.
1239 The reference count for the SV is set to 1.
1248 Creates a new SV and copies a string into it. The reference count for the
1249 SV is set to 1. If C<len> is zero, Perl will compute the length using
1250 strlen(). For efficiency, consider using C<newSVpvn> instead.
1252 SV* newSVpv(const char* s, STRLEN len)
1259 Creates a new SV an initialize it with the string formatted like
1262 SV* newSVpvf(const char* pat, ...)
1269 Creates a new SV and copies a string into it. The reference count for the
1270 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
1271 string. You are responsible for ensuring that the source string is at least
1274 SV* newSVpvn(const char* s, STRLEN len)
1279 =item newSVpvn_share
1281 Creates a new SV and populates it with a string from
1282 the string table. Turns on READONLY and FAKE.
1283 The idea here is that as string table is used for shared hash
1284 keys these strings will have SvPVX == HeKEY and hash lookup
1285 will avoid string compare.
1287 SV* newSVpvn_share(const char* s, I32 len, U32 hash)
1294 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
1295 it will be upgraded to one. If C<classname> is non-null then the new SV will
1296 be blessed in the specified package. The new SV is returned and its
1297 reference count is 1.
1299 SV* newSVrv(SV* rv, const char* classname)
1306 Creates a new SV which is an exact duplicate of the original SV.
1308 SV* newSVsv(SV* old)
1315 Creates a new SV and copies an unsigned integer into it.
1316 The reference count for the SV is set to 1.
1325 Used by C<xsubpp> to hook up XSUBs as Perl subs.
1328 Found in file opmini.c
1332 Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
1336 Found in file XSUB.h
1340 The XSUB-writer's interface to the C C<malloc> function. The allocated
1341 memory is zeroed with C<memzero>.
1343 void Newz(int id, void* ptr, int nitems, type)
1346 Found in file handy.h
1357 Null character pointer.
1360 Found in file handy.h
1381 Found in file handy.h
1385 The original stack mark for the XSUB. See C<dORIGMARK>.
1392 Allocates a new Perl interpreter. See L<perlembed>.
1394 PerlInterpreter* perl_alloc()
1397 Found in file perl.c
1399 =item perl_construct
1401 Initializes a new Perl interpreter. See L<perlembed>.
1403 void perl_construct(PerlInterpreter* interp)
1406 Found in file perl.c
1410 Shuts down a Perl interpreter. See L<perlembed>.
1412 void perl_destruct(PerlInterpreter* interp)
1415 Found in file perl.c
1419 Releases a Perl interpreter. See L<perlembed>.
1421 void perl_free(PerlInterpreter* interp)
1424 Found in file perl.c
1428 Tells a Perl interpreter to parse a Perl script. See L<perlembed>.
1430 int perl_parse(PerlInterpreter* interp, XSINIT_t xsinit, int argc, char** argv, char** env)
1433 Found in file perl.c
1437 Tells a Perl interpreter to run. See L<perlembed>.
1439 int perl_run(PerlInterpreter* interp)
1442 Found in file perl.c
1446 When Perl is run in debugging mode, with the B<-d> switch, this SV is a
1447 boolean which indicates whether subs are being single-stepped.
1448 Single-stepping is automatically turned on after every step. This is the C
1449 variable which corresponds to Perl's $DB::single variable. See
1455 Found in file intrpvar.h
1459 When Perl is run in debugging mode, with the B<-d> switch, this GV contains
1460 the SV which holds the name of the sub being debugged. This is the C
1461 variable which corresponds to Perl's $DB::sub variable. See
1467 Found in file intrpvar.h
1471 Trace variable used when Perl is run in debugging mode, with the B<-d>
1472 switch. This is the C variable which corresponds to Perl's $DB::trace
1473 variable. See C<PL_DBsingle>.
1478 Found in file intrpvar.h
1482 The C variable which corresponds to Perl's $^W warning variable.
1487 Found in file intrpvar.h
1491 C<PL_modglobal> is a general purpose, interpreter global HV for use by
1492 extensions that need to keep information on a per-interpreter basis.
1493 In a pinch, it can also be used as a symbol table for extensions
1494 to share data among each other. It is a good idea to use keys
1495 prefixed by the package name of the extension that owns the data.
1500 Found in file intrpvar.h
1504 A convenience variable which is typically used with C<SvPV> when one
1505 doesn't care about the length of the string. It is usually more efficient
1506 to either declare a local variable and use that instead or to use the
1507 C<SvPV_nolen> macro.
1512 Found in file thrdvar.h
1516 This is the C<false> SV. See C<PL_sv_yes>. Always refer to this as
1522 Found in file intrpvar.h
1526 This is the C<undef> SV. Always refer to this as C<&PL_sv_undef>.
1531 Found in file intrpvar.h
1535 This is the C<true> SV. See C<PL_sv_no>. Always refer to this as
1541 Found in file intrpvar.h
1545 Pops an integer off the stack.
1554 Pops a long off the stack.
1563 Pops a double off the stack.
1572 Pops a string off the stack.
1581 Pops an SV off the stack.
1590 Push an integer onto the stack. The stack must have room for this element.
1591 Handles 'set' magic. See C<XPUSHi>.
1600 Opening bracket for arguments on a callback. See C<PUTBACK> and
1610 Push a double onto the stack. The stack must have room for this element.
1611 Handles 'set' magic. See C<XPUSHn>.
1620 Push a string onto the stack. The stack must have room for this element.
1621 The C<len> indicates the length of the string. Handles 'set' magic. See
1624 void PUSHp(char* str, STRLEN len)
1631 Push an SV onto the stack. The stack must have room for this element.
1632 Does not handle 'set' magic. See C<XPUSHs>.
1641 Push an unsigned integer onto the stack. The stack must have room for this
1642 element. See C<XPUSHu>.
1651 Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
1652 See C<PUSHMARK> and L<perlcall> for other uses.
1661 The XSUB-writer's interface to the C C<realloc> function.
1663 void Renew(void* ptr, int nitems, type)
1666 Found in file handy.h
1670 The XSUB-writer's interface to the C C<realloc> function, with
1673 void Renewc(void* ptr, int nitems, type, cast)
1676 Found in file handy.h
1680 Tells Perl to C<require> a module.
1682 NOTE: the perl_ form of this function is deprecated.
1684 void require_pv(const char* pv)
1687 Found in file perl.c
1691 Variable which is setup by C<xsubpp> to hold the return value for an
1692 XSUB. This is always the proper type for the XSUB. See
1693 L<perlxs/"The RETVAL Variable">.
1698 Found in file XSUB.h
1702 The XSUB-writer's interface to the C C<free> function.
1704 void Safefree(void* ptr)
1707 Found in file handy.h
1711 Copy a string to a safe spot. This does not use an SV.
1713 char* savepv(const char* sv)
1716 Found in file util.c
1720 Copy a string to a safe spot. The C<len> indicates number of bytes to
1721 copy. This does not use an SV.
1723 char* savepvn(const char* sv, I32 len)
1726 Found in file util.c
1730 Opening bracket for temporaries on a callback. See C<FREETMPS> and
1736 Found in file scope.h
1740 Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and
1748 Refetch the stack pointer. Used after a callback. See L<perlcall>.
1757 Used to access elements on the XSUB's stack.
1762 Found in file XSUB.h
1766 Test two strings to see if they are equal. Returns true or false.
1768 bool strEQ(char* s1, char* s2)
1771 Found in file handy.h
1775 Test two strings to see if the first, C<s1>, is greater than or equal to
1776 the second, C<s2>. Returns true or false.
1778 bool strGE(char* s1, char* s2)
1781 Found in file handy.h
1785 Test two strings to see if the first, C<s1>, is greater than the second,
1786 C<s2>. Returns true or false.
1788 bool strGT(char* s1, char* s2)
1791 Found in file handy.h
1795 Test two strings to see if the first, C<s1>, is less than or equal to the
1796 second, C<s2>. Returns true or false.
1798 bool strLE(char* s1, char* s2)
1801 Found in file handy.h
1805 Test two strings to see if the first, C<s1>, is less than the second,
1806 C<s2>. Returns true or false.
1808 bool strLT(char* s1, char* s2)
1811 Found in file handy.h
1815 Test two strings to see if they are different. Returns true or
1818 bool strNE(char* s1, char* s2)
1821 Found in file handy.h
1825 Test two strings to see if they are equal. The C<len> parameter indicates
1826 the number of bytes to compare. Returns true or false. (A wrapper for
1829 bool strnEQ(char* s1, char* s2, STRLEN len)
1832 Found in file handy.h
1836 Test two strings to see if they are different. The C<len> parameter
1837 indicates the number of bytes to compare. Returns true or false. (A
1838 wrapper for C<strncmp>).
1840 bool strnNE(char* s1, char* s2, STRLEN len)
1843 Found in file handy.h
1847 This is an architecture-independent macro to copy one structure to another.
1849 void StructCopy(type src, type dest, type)
1852 Found in file handy.h
1856 Returns the length of the string which is in the SV. See C<SvLEN>.
1858 STRLEN SvCUR(SV* sv)
1865 Set the length of the string which is in the SV. See C<SvCUR>.
1867 void SvCUR_set(SV* sv, STRLEN len)
1874 Returns a pointer to the last character in the string which is in the SV.
1875 See C<SvCUR>. Access the character as *(SvEND(sv)).
1884 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
1885 argument more than once.
1887 void SvGETMAGIC(SV* sv)
1894 Expands the character buffer in the SV so that it has room for the
1895 indicated number of bytes (remember to reserve space for an extra trailing
1896 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
1897 Returns a pointer to the character buffer.
1899 void SvGROW(SV* sv, STRLEN len)
1906 Returns a boolean indicating whether the SV contains an integer.
1915 Returns a boolean indicating whether the SV contains an integer. Checks
1916 the B<private> setting. Use C<SvIOK>.
1925 Returns a boolean indicating whether the SV contains an signed integer.
1927 void SvIOK_notUV(SV* sv)
1934 Unsets the IV status of an SV.
1936 void SvIOK_off(SV* sv)
1943 Tells an SV that it is an integer.
1945 void SvIOK_on(SV* sv)
1952 Tells an SV that it is an integer and disables all other OK bits.
1954 void SvIOK_only(SV* sv)
1961 Tells and SV that it is an unsigned integer and disables all other OK bits.
1963 void SvIOK_only_UV(SV* sv)
1970 Returns a boolean indicating whether the SV contains an unsigned integer.
1972 void SvIOK_UV(SV* sv)
1979 Coerces the given SV to an integer and returns it.
1988 Returns the integer which is stored in the SV, assuming SvIOK is
1998 Returns the size of the string buffer in the SV, not including any part
1999 attributable to C<SvOOK>. See C<SvCUR>.
2001 STRLEN SvLEN(SV* sv)
2008 Returns a boolean indicating whether the SV contains a number, integer or
2018 Returns a boolean indicating whether the SV contains a number, integer or
2019 double. Checks the B<private> setting. Use C<SvNIOK>.
2021 bool SvNIOKp(SV* sv)
2028 Unsets the NV/IV status of an SV.
2030 void SvNIOK_off(SV* sv)
2037 Returns a boolean indicating whether the SV contains a double.
2046 Returns a boolean indicating whether the SV contains a double. Checks the
2047 B<private> setting. Use C<SvNOK>.
2056 Unsets the NV status of an SV.
2058 void SvNOK_off(SV* sv)
2065 Tells an SV that it is a double.
2067 void SvNOK_on(SV* sv)
2074 Tells an SV that it is a double and disables all other OK bits.
2076 void SvNOK_only(SV* sv)
2083 Coerce the given SV to a double and return it.
2092 Returns the double which is stored in the SV, assuming SvNOK is
2102 Returns a boolean indicating whether the value is an SV.
2111 Returns a boolean indicating whether the SvIVX is a valid offset value for
2112 the SvPVX. This hack is used internally to speed up removal of characters
2113 from the beginning of a SvPV. When SvOOK is true, then the start of the
2114 allocated string buffer is really (SvPVX - SvIVX).
2123 Returns a boolean indicating whether the SV contains a character
2133 Returns a boolean indicating whether the SV contains a character string.
2134 Checks the B<private> setting. Use C<SvPOK>.
2143 Unsets the PV status of an SV.
2145 void SvPOK_off(SV* sv)
2152 Tells an SV that it is a string.
2154 void SvPOK_on(SV* sv)
2161 Tells an SV that it is a string and disables all other OK bits.
2163 void SvPOK_only(SV* sv)
2168 =item SvPOK_only_UTF8
2170 Tells an SV that it is a UTF8 string (do not use frivolously)
2171 and disables all other OK bits.
2173 void SvPOK_only_UTF8(SV* sv)
2180 Returns a pointer to the string in the SV, or a stringified form of the SV
2181 if the SV does not contain a string. Handles 'get' magic.
2183 char* SvPV(SV* sv, STRLEN len)
2190 Returns a pointer to the string in the SV. The SV must contain a
2200 Like <SvPV> but will force the SV into becoming a string (SvPOK). You want
2201 force if you are going to update the SvPVX directly.
2203 char* SvPV_force(SV* sv, STRLEN len)
2210 Returns a pointer to the string in the SV, or a stringified form of the SV
2211 if the SV does not contain a string. Handles 'get' magic.
2213 char* SvPV_nolen(SV* sv)
2220 Returns the value of the object's reference count.
2222 U32 SvREFCNT(SV* sv)
2229 Decrements the reference count of the given SV.
2231 void SvREFCNT_dec(SV* sv)
2238 Increments the reference count of the given SV.
2240 SV* SvREFCNT_inc(SV* sv)
2247 Tests if the SV is an RV.
2256 Unsets the RV status of an SV.
2258 void SvROK_off(SV* sv)
2265 Tells an SV that it is an RV.
2267 void SvROK_on(SV* sv)
2274 Dereferences an RV to return the SV.
2283 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
2284 argument more than once.
2286 void SvSETMAGIC(SV* sv)
2293 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
2296 void SvSetSV(SV* dsb, SV* ssv)
2301 =item SvSetSV_nosteal
2303 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
2304 ssv. May evaluate arguments more than once.
2306 void SvSetSV_nosteal(SV* dsv, SV* ssv)
2313 Returns the stash of the SV.
2322 Taints an SV if tainting is enabled
2324 void SvTAINT(SV* sv)
2331 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
2334 bool SvTAINTED(SV* sv)
2341 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
2342 some of Perl's fundamental security features. XS module authors should not
2343 use this function unless they fully understand all the implications of
2344 unconditionally untainting the value. Untainting should be done in the
2345 standard perl fashion, via a carefully crafted regexp, rather than directly
2346 untainting variables.
2348 void SvTAINTED_off(SV* sv)
2355 Marks an SV as tainted.
2357 void SvTAINTED_on(SV* sv)
2364 Returns a boolean indicating whether Perl would evaluate the SV as true or
2365 false, defined or undefined. Does not handle 'get' magic.
2374 An enum of flags for Perl types. These are found in the file B<sv.h>
2375 in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
2382 Returns the type of the SV. See C<svtype>.
2384 svtype SvTYPE(SV* sv)
2391 Integer type flag for scalars. See C<svtype>.
2398 Double type flag for scalars. See C<svtype>.
2405 Pointer type flag for scalars. See C<svtype>.
2412 Type flag for arrays. See C<svtype>.
2419 Type flag for code refs. See C<svtype>.
2426 Type flag for hashes. See C<svtype>.
2433 Type flag for blessed scalars. See C<svtype>.
2440 Returns a boolean indicating whether the SV contains an unsigned integer.
2449 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
2450 perform the upgrade if necessary. See C<svtype>.
2452 void SvUPGRADE(SV* sv, svtype type)
2459 Returns a boolean indicating whether the SV contains UTF-8 encoded data.
2468 Unsets the UTF8 status of an SV.
2470 void SvUTF8_off(SV *sv)
2477 Tells an SV that it is a string and encoded in UTF8. Do not use frivolously.
2479 void SvUTF8_on(SV *sv)
2486 Coerces the given SV to an unsigned integer and returns it.
2495 Returns the unsigned integer which is stored in the SV, assuming SvIOK is
2505 Marks an SV as mortal. The SV will be destroyed when the current context
2508 SV* sv_2mortal(SV* sv)
2515 Blesses an SV into a specified package. The SV must be an RV. The package
2516 must be designated by its stash (see C<gv_stashpv()>). The reference count
2517 of the SV is unaffected.
2519 SV* sv_bless(SV* sv, HV* stash)
2526 Concatenates the string onto the end of the string which is in the SV.
2527 Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
2529 void sv_catpv(SV* sv, const char* ptr)
2536 Processes its arguments like C<sprintf> and appends the formatted output
2537 to an SV. Handles 'get' magic, but not 'set' magic. C<SvSETMAGIC()> must
2538 typically be called after calling this function to handle 'set' magic.
2540 void sv_catpvf(SV* sv, const char* pat, ...)
2547 Like C<sv_catpvf>, but also handles 'set' magic.
2549 void sv_catpvf_mg(SV *sv, const char* pat, ...)
2556 Concatenates the string onto the end of the string which is in the SV. The
2557 C<len> indicates number of bytes to copy. Handles 'get' magic, but not
2558 'set' magic. See C<sv_catpvn_mg>.
2560 void sv_catpvn(SV* sv, const char* ptr, STRLEN len)
2567 Like C<sv_catpvn>, but also handles 'set' magic.
2569 void sv_catpvn_mg(SV *sv, const char *ptr, STRLEN len)
2576 Like C<sv_catpv>, but also handles 'set' magic.
2578 void sv_catpv_mg(SV *sv, const char *ptr)
2585 Concatenates the string from SV C<ssv> onto the end of the string in SV
2586 C<dsv>. Handles 'get' magic, but not 'set' magic. See C<sv_catsv_mg>.
2588 void sv_catsv(SV* dsv, SV* ssv)
2595 Like C<sv_catsv>, but also handles 'set' magic.
2597 void sv_catsv_mg(SV *dstr, SV *sstr)
2604 Efficient removal of characters from the beginning of the string buffer.
2605 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
2606 the string buffer. The C<ptr> becomes the first character of the adjusted
2609 void sv_chop(SV* sv, char* ptr)
2616 Clear an SV, making it empty. Does not free the memory used by the SV
2619 void sv_clear(SV* sv)
2626 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
2627 string in C<sv1> is less than, equal to, or greater than the string in
2630 I32 sv_cmp(SV* sv1, SV* sv2)
2637 Compares the strings in two SVs in a locale-aware manner. See
2640 I32 sv_cmp_locale(SV* sv1, SV* sv2)
2647 Auto-decrement of the value in the SV.
2654 =item sv_derived_from
2656 Returns a boolean indicating whether the SV is derived from the specified
2657 class. This is the function that implements C<UNIVERSAL::isa>. It works
2658 for class names as well as for objects.
2660 bool sv_derived_from(SV* sv, const char* name)
2663 Found in file universal.c
2667 Returns a boolean indicating whether the strings in the two SVs are
2670 I32 sv_eq(SV* sv1, SV* sv2)
2677 Free the memory used by an SV.
2679 void sv_free(SV* sv)
2686 Get a line from the filehandle and store it into the SV, optionally
2687 appending to the currently-stored string.
2689 char* sv_gets(SV* sv, PerlIO* fp, I32 append)
2696 Expands the character buffer in the SV. This will use C<sv_unref> and will
2697 upgrade the SV to C<SVt_PV>. Returns a pointer to the character buffer.
2700 char* sv_grow(SV* sv, STRLEN newlen)
2707 Auto-increment of the value in the SV.
2716 Inserts a string at the specified offset/length within the SV. Similar to
2717 the Perl substr() function.
2719 void sv_insert(SV* bigsv, STRLEN offset, STRLEN len, char* little, STRLEN littlelen)
2726 Returns a boolean indicating whether the SV is blessed into the specified
2727 class. This does not check for subtypes; use C<sv_derived_from> to verify
2728 an inheritance relationship.
2730 int sv_isa(SV* sv, const char* name)
2737 Returns a boolean indicating whether the SV is an RV pointing to a blessed
2738 object. If the SV is not an RV, or if the object is not blessed, then this
2741 int sv_isobject(SV* sv)
2748 Returns the length of the string in the SV. See also C<SvCUR>.
2750 STRLEN sv_len(SV* sv)
2757 Returns the number of characters in the string in an SV, counting wide
2758 UTF8 bytes as a single character.
2760 STRLEN sv_len_utf8(SV* sv)
2767 Adds magic to an SV.
2769 void sv_magic(SV* sv, SV* obj, int how, const char* name, I32 namlen)
2776 Creates a new SV which is a copy of the original SV. The new SV is marked
2779 SV* sv_mortalcopy(SV* oldsv)
2786 Creates a new SV which is mortal. The reference count of the SV is set to 1.
2795 Get a sensible string out of the SV somehow.
2797 char* sv_pvn_force(SV* sv, STRLEN* lp)
2802 =item sv_pvutf8n_force
2804 Get a sensible UTF8-encoded string out of the SV somehow. See
2807 char* sv_pvutf8n_force(SV* sv, STRLEN* lp)
2814 Returns a string describing what the SV is a reference to.
2816 char* sv_reftype(SV* sv, int ob)
2823 Make the first argument a copy of the second, then delete the original.
2825 void sv_replace(SV* sv, SV* nsv)
2834 SV* sv_rvweaken(SV *sv)
2841 Copies an integer into the given SV. Does not handle 'set' magic. See
2844 void sv_setiv(SV* sv, IV num)
2851 Like C<sv_setiv>, but also handles 'set' magic.
2853 void sv_setiv_mg(SV *sv, IV i)
2860 Copies a double into the given SV. Does not handle 'set' magic. See
2863 void sv_setnv(SV* sv, NV num)
2870 Like C<sv_setnv>, but also handles 'set' magic.
2872 void sv_setnv_mg(SV *sv, NV num)
2879 Copies a string into an SV. The string must be null-terminated. Does not
2880 handle 'set' magic. See C<sv_setpv_mg>.
2882 void sv_setpv(SV* sv, const char* ptr)
2889 Processes its arguments like C<sprintf> and sets an SV to the formatted
2890 output. Does not handle 'set' magic. See C<sv_setpvf_mg>.
2892 void sv_setpvf(SV* sv, const char* pat, ...)
2899 Like C<sv_setpvf>, but also handles 'set' magic.
2901 void sv_setpvf_mg(SV *sv, const char* pat, ...)
2908 Copies an integer into the given SV, also updating its string value.
2909 Does not handle 'set' magic. See C<sv_setpviv_mg>.
2911 void sv_setpviv(SV* sv, IV num)
2918 Like C<sv_setpviv>, but also handles 'set' magic.
2920 void sv_setpviv_mg(SV *sv, IV iv)
2927 Copies a string into an SV. The C<len> parameter indicates the number of
2928 bytes to be copied. Does not handle 'set' magic. See C<sv_setpvn_mg>.
2930 void sv_setpvn(SV* sv, const char* ptr, STRLEN len)
2937 Like C<sv_setpvn>, but also handles 'set' magic.
2939 void sv_setpvn_mg(SV *sv, const char *ptr, STRLEN len)
2946 Like C<sv_setpv>, but also handles 'set' magic.
2948 void sv_setpv_mg(SV *sv, const char *ptr)
2955 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
2956 argument will be upgraded to an RV. That RV will be modified to point to
2957 the new SV. The C<classname> argument indicates the package for the
2958 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
2959 will be returned and will have a reference count of 1.
2961 SV* sv_setref_iv(SV* rv, const char* classname, IV iv)
2968 Copies a double into a new SV, optionally blessing the SV. The C<rv>
2969 argument will be upgraded to an RV. That RV will be modified to point to
2970 the new SV. The C<classname> argument indicates the package for the
2971 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
2972 will be returned and will have a reference count of 1.
2974 SV* sv_setref_nv(SV* rv, const char* classname, NV nv)
2981 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
2982 argument will be upgraded to an RV. That RV will be modified to point to
2983 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
2984 into the SV. The C<classname> argument indicates the package for the
2985 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
2986 will be returned and will have a reference count of 1.
2988 Do not use with other Perl types such as HV, AV, SV, CV, because those
2989 objects will become corrupted by the pointer copy process.
2991 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
2993 SV* sv_setref_pv(SV* rv, const char* classname, void* pv)
3000 Copies a string into a new SV, optionally blessing the SV. The length of the
3001 string must be specified with C<n>. The C<rv> argument will be upgraded to
3002 an RV. That RV will be modified to point to the new SV. The C<classname>
3003 argument indicates the package for the blessing. Set C<classname> to
3004 C<Nullch> to avoid the blessing. The new SV will be returned and will have
3005 a reference count of 1.
3007 Note that C<sv_setref_pv> copies the pointer while this copies the string.
3009 SV* sv_setref_pvn(SV* rv, const char* classname, char* pv, STRLEN n)
3016 Copies the contents of the source SV C<ssv> into the destination SV C<dsv>.
3017 The source SV may be destroyed if it is mortal. Does not handle 'set'
3018 magic. See the macro forms C<SvSetSV>, C<SvSetSV_nosteal> and
3021 void sv_setsv(SV* dsv, SV* ssv)
3028 Like C<sv_setsv>, but also handles 'set' magic.
3030 void sv_setsv_mg(SV *dstr, SV *sstr)
3037 Copies an unsigned integer into the given SV. Does not handle 'set' magic.
3040 void sv_setuv(SV* sv, UV num)
3047 Like C<sv_setuv>, but also handles 'set' magic.
3049 void sv_setuv_mg(SV *sv, UV u)
3056 Returns true if the SV has a true value by Perl's rules.
3065 Removes magic from an SV.
3067 int sv_unmagic(SV* sv, int type)
3074 Unsets the RV status of the SV, and decrements the reference count of
3075 whatever was being referenced by the RV. This can almost be thought of
3076 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
3077 being zero. See C<SvROK_off>.
3079 void sv_unref(SV* sv)
3084 =item sv_unref_flags
3086 Unsets the RV status of the SV, and decrements the reference count of
3087 whatever was being referenced by the RV. This can almost be thought of
3088 as a reversal of C<newSVrv>. The C<cflags> argument can contain
3089 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
3090 (otherwise the decrementing is conditional on the reference count being
3091 different from one or the reference being a readonly SV).
3094 void sv_unref_flags(SV* sv, U32 flags)
3101 Upgrade an SV to a more complex form. Use C<SvUPGRADE>. See
3104 bool sv_upgrade(SV* sv, U32 mt)
3111 Tells an SV to use C<ptr> to find its string value. Normally the string is
3112 stored inside the SV but sv_usepvn allows the SV to use an outside string.
3113 The C<ptr> should point to memory that was allocated by C<malloc>. The
3114 string length, C<len>, must be supplied. This function will realloc the
3115 memory pointed to by C<ptr>, so that pointer should not be freed or used by
3116 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
3117 See C<sv_usepvn_mg>.
3119 void sv_usepvn(SV* sv, char* ptr, STRLEN len)
3126 Like C<sv_usepvn>, but also handles 'set' magic.
3128 void sv_usepvn_mg(SV *sv, char *ptr, STRLEN len)
3133 =item sv_utf8_downgrade
3135 Attempt to convert the PV of an SV from UTF8-encoded to byte encoding.
3136 This may not be possible if the PV contains non-byte encoding characters;
3137 if this is the case, either returns false or, if C<fail_ok> is not
3140 NOTE: this function is experimental and may change or be
3141 removed without notice.
3143 bool sv_utf8_downgrade(SV *sv, bool fail_ok)
3148 =item sv_utf8_encode
3150 Convert the PV of an SV to UTF8-encoded, but then turn off the C<SvUTF8>
3151 flag so that it looks like bytes again. Nothing calls this.
3153 NOTE: this function is experimental and may change or be
3154 removed without notice.
3156 void sv_utf8_encode(SV *sv)
3161 =item sv_utf8_upgrade
3163 Convert the PV of an SV to its UTF8-encoded form.
3165 void sv_utf8_upgrade(SV *sv)
3172 Processes its arguments like C<vsprintf> and appends the formatted output
3173 to an SV. Uses an array of SVs if the C style variable argument list is
3174 missing (NULL). When running with taint checks enabled, indicates via
3175 C<maybe_tainted> if results are untrustworthy (often due to the use of
3178 void sv_vcatpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
3185 Works like C<vcatpvfn> but copies the text into the SV instead of
3188 void sv_vsetpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
3195 Variable which is setup by C<xsubpp> to designate the object in a C++
3196 XSUB. This is always the proper type for the C++ object. See C<CLASS> and
3197 L<perlxs/"Using XS With C++">.
3202 Found in file XSUB.h
3206 Converts the specified character to lowercase.
3208 char toLOWER(char ch)
3211 Found in file handy.h
3215 Converts the specified character to uppercase.
3217 char toUPPER(char ch)
3220 Found in file handy.h
3224 Returns true if first C<len> bytes of the given string form valid a UTF8
3225 string, false otherwise.
3227 is_utf8_string U8 *s(STRLEN len)
3230 Found in file utf8.c
3234 Returns the number of UTF8 characters between the UTF-8 pointers C<a>
3237 WARNING: use only if you *know* that the pointers point inside the
3240 IV utf8_distance(U8 *a, U8 *b)
3243 Found in file utf8.c
3247 Return the UTF-8 pointer C<s> displaced by C<off> characters, either
3248 forward or backward.
3250 WARNING: do not use the following unless you *know* C<off> is within
3251 the UTF-8 data pointed to by C<s> *and* that on entry C<s> is aligned
3252 on the first byte of character or just after the last byte of a character.
3254 U8* utf8_hop(U8 *s, I32 off)
3257 Found in file utf8.c
3261 Return the length of the UTF-8 char encoded string C<s> in characters.
3262 Stops at C<e> (inclusive). If C<e E<lt> s> or if the scan would end
3263 up past C<e>, croaks.
3265 STRLEN utf8_length(U8* s, U8 *e)
3268 Found in file utf8.c
3272 Converts a string C<s> of length C<len> from UTF8 into byte encoding.
3273 Unlike C<bytes_to_utf8>, this over-writes the original string, and
3274 updates len to contain the new length.
3275 Returns zero on failure, setting C<len> to -1.
3277 U8 * utf8_to_bytes(U8 *s, STRLEN *len)
3280 Found in file utf8.c
3284 Returns the character value of the first character in the string C<s>
3285 which is assumed to be in UTF8 encoding and no longer than C<curlen>;
3286 C<retlen> will be set to the length, in bytes, of that character,
3287 and the pointer C<s> will be advanced to the end of the character.
3289 If C<s> does not point to a well-formed UTF8 character, the behaviour
3290 is dependent on the value of C<flags>: if it contains UTF8_CHECK_ONLY,
3291 it is assumed that the caller will raise a warning, and this function
3292 will silently just set C<retlen> to C<-1> and return zero. If the
3293 C<flags> does not contain UTF8_CHECK_ONLY, warnings about
3294 malformations will be given, C<retlen> will be set to the expected
3295 length of the UTF-8 character in bytes, and zero will be returned.
3297 The C<flags> can also contain various flags to allow deviations from
3298 the strict UTF-8 encoding (see F<utf8.h>).
3300 U8* s utf8_to_uv(STRLEN curlen, STRLEN *retlen, U32 flags)
3303 Found in file utf8.c
3305 =item utf8_to_uv_simple
3307 Returns the character value of the first character in the string C<s>
3308 which is assumed to be in UTF8 encoding; C<retlen> will be set to the
3309 length, in bytes, of that character, and the pointer C<s> will be
3310 advanced to the end of the character.
3312 If C<s> does not point to a well-formed UTF8 character, zero is
3313 returned and retlen is set, if possible, to -1.
3315 U8* s utf8_to_uv_simple(STRLEN *retlen)
3318 Found in file utf8.c
3322 This is the XSUB-writer's interface to Perl's C<warn> function. Use this
3323 function the same way you use the C C<printf> function. See
3326 void warn(const char* pat, ...)
3329 Found in file util.c
3333 Push an integer onto the stack, extending the stack if necessary. Handles
3334 'set' magic. See C<PUSHi>.
3343 Push a double onto the stack, extending the stack if necessary. Handles
3344 'set' magic. See C<PUSHn>.
3353 Push a string onto the stack, extending the stack if necessary. The C<len>
3354 indicates the length of the string. Handles 'set' magic. See
3357 void XPUSHp(char* str, STRLEN len)
3364 Push an SV onto the stack, extending the stack if necessary. Does not
3365 handle 'set' magic. See C<PUSHs>.
3374 Push an unsigned integer onto the stack, extending the stack if necessary.
3384 Macro to declare an XSUB and its C parameter list. This is handled by
3388 Found in file XSUB.h
3392 Return from XSUB, indicating number of items on the stack. This is usually
3393 handled by C<xsubpp>.
3395 void XSRETURN(int nitems)
3398 Found in file XSUB.h
3400 =item XSRETURN_EMPTY
3402 Return an empty list from an XSUB immediately.
3407 Found in file XSUB.h
3411 Return an integer from an XSUB immediately. Uses C<XST_mIV>.
3413 void XSRETURN_IV(IV iv)
3416 Found in file XSUB.h
3420 Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
3425 Found in file XSUB.h
3429 Return an double from an XSUB immediately. Uses C<XST_mNV>.
3431 void XSRETURN_NV(NV nv)
3434 Found in file XSUB.h
3438 Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
3440 void XSRETURN_PV(char* str)
3443 Found in file XSUB.h
3445 =item XSRETURN_UNDEF
3447 Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
3452 Found in file XSUB.h
3456 Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
3461 Found in file XSUB.h
3465 Place an integer into the specified position C<pos> on the stack. The
3466 value is stored in a new mortal SV.
3468 void XST_mIV(int pos, IV iv)
3471 Found in file XSUB.h
3475 Place C<&PL_sv_no> into the specified position C<pos> on the
3478 void XST_mNO(int pos)
3481 Found in file XSUB.h
3485 Place a double into the specified position C<pos> on the stack. The value
3486 is stored in a new mortal SV.
3488 void XST_mNV(int pos, NV nv)
3491 Found in file XSUB.h
3495 Place a copy of a string into the specified position C<pos> on the stack.
3496 The value is stored in a new mortal SV.
3498 void XST_mPV(int pos, char* str)
3501 Found in file XSUB.h
3505 Place C<&PL_sv_undef> into the specified position C<pos> on the
3508 void XST_mUNDEF(int pos)
3511 Found in file XSUB.h
3515 Place C<&PL_sv_yes> into the specified position C<pos> on the
3518 void XST_mYES(int pos)
3521 Found in file XSUB.h
3525 The version identifier for an XS module. This is usually
3526 handled automatically by C<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>.
3529 Found in file XSUB.h
3531 =item XS_VERSION_BOOTCHECK
3533 Macro to verify that a PM module's $VERSION variable matches the XS
3534 module's C<XS_VERSION> variable. This is usually handled automatically by
3535 C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">.
3537 XS_VERSION_BOOTCHECK;
3540 Found in file XSUB.h
3544 The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the
3545 destination, C<nitems> is the number of items, and C<type> is the type.
3547 void Zero(void* dest, int nitems, type)
3550 Found in file handy.h
3556 Until May 1997, this document was maintained by Jeff Okamoto
3557 <okamoto@corp.hp.com>. It is now maintained as part of Perl itself.
3559 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
3560 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
3561 Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
3562 Stephen McCamant, and Gurusamy Sarathy.
3564 API Listing originally by Dean Roehrich <roehrich@cray.com>.
3566 Updated to be autogenerated from comments in the source by Benjamin Stuhl.
3570 perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
projects / p5sagit/p5-mst-13.2.git / blob