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 Variable which is setup by C<xsubpp> to indicate the stack base offset,
188 used by the C<ST>, C<XSprePUSH> and C<XSRETURN> macros. The C<dMARK> macro
189 must be called prior to setup the C<MARK> variable.
196 =item bytes_from_utf8
198 Converts a string C<s> of length C<len> from UTF8 into byte encoding.
199 Unlike <utf8_to_bytes> but like C<bytes_to_utf8>, returns a pointer to
200 the newly-created string, and updates C<len> to contain the new
201 length. Returns the original string if no conversion occurs, C<len>
202 is unchanged. Do nothing if C<is_utf8> points to 0. Sets C<is_utf8> to
203 0 if C<s> is converted or contains all 7bit characters.
205 NOTE: this function is experimental and may change or be
206 removed without notice.
208 U8* bytes_from_utf8(U8 *s, STRLEN *len, bool *is_utf8)
215 Converts a string C<s> of length C<len> from ASCII into UTF8 encoding.
216 Returns a pointer to the newly-created string, and sets C<len> to
217 reflect the new length.
219 NOTE: this function is experimental and may change or be
220 removed without notice.
222 U8* bytes_to_utf8(U8 *s, STRLEN *len)
229 Performs a callback to the specified Perl sub. See L<perlcall>.
231 NOTE: the perl_ form of this function is deprecated.
233 I32 call_argv(const char* sub_name, I32 flags, char** argv)
240 Performs a callback to the specified Perl method. The blessed object must
241 be on the stack. See L<perlcall>.
243 NOTE: the perl_ form of this function is deprecated.
245 I32 call_method(const char* methname, I32 flags)
252 Performs a callback to the specified Perl sub. See L<perlcall>.
254 NOTE: the perl_ form of this function is deprecated.
256 I32 call_pv(const char* sub_name, I32 flags)
263 Performs a callback to the Perl sub whose name is in the SV. See
266 NOTE: the perl_ form of this function is deprecated.
268 I32 call_sv(SV* sv, I32 flags)
275 Variable which is setup by C<xsubpp> to indicate the
276 class name for a C++ XS constructor. This is always a C<char*>. See C<THIS>.
285 The XSUB-writer's interface to the C C<memcpy> function. The C<src> is the
286 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
287 the type. May fail on overlapping copies. See also C<Move>.
289 void Copy(void* src, void* dest, int nitems, type)
292 Found in file handy.h
296 This is the XSUB-writer's interface to Perl's C<die> function.
297 Normally use this function the same way you use the C C<printf>
298 function. See C<warn>.
300 If you want to throw an exception object, assign the object to
301 C<$@> and then pass C<Nullch> to croak():
303 errsv = get_sv("@", TRUE);
304 sv_setsv(errsv, exception_object);
307 void croak(const char* pat, ...)
314 Returns the stash of the CV.
323 If C<cv> is a constant sub eligible for inlining. returns the constant
324 value returned by the sub. Otherwise, returns NULL.
326 Constant subs can be created with C<newCONSTSUB> or as described in
327 L<perlsub/"Constant Functions">.
329 SV* cv_const_sv(CV* cv)
332 Found in file opmini.c
336 Sets up the C<ax> variable.
337 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
346 Sets up the C<items> variable.
347 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
356 Declare a stack marker variable, C<mark>, for the XSUB. See C<MARK> and
366 Saves the original stack mark for the XSUB. See C<ORIGMARK>.
375 Declares a local copy of perl's stack pointer for the XSUB, available via
376 the C<SP> macro. See C<SP>.
385 Sets up stack and mark pointers for an XSUB, calling dSP and dMARK.
386 Sets up the C<ax> and C<items> variables by calling C<dAX> and C<dITEMS>.
387 This is usually handled automatically by C<xsubpp>.
396 Sets up the C<ix> variable for an XSUB which has aliases. This is usually
397 handled automatically by C<xsubpp>.
406 Opening bracket on a callback. See C<LEAVE> and L<perlcall>.
411 Found in file scope.h
415 Tells Perl to C<eval> the given string and return an SV* result.
417 NOTE: the perl_ form of this function is deprecated.
419 SV* eval_pv(const char* p, I32 croak_on_error)
426 Tells Perl to C<eval> the string in the SV.
428 NOTE: the perl_ form of this function is deprecated.
430 I32 eval_sv(SV* sv, I32 flags)
437 Used to extend the argument stack for an XSUB's return values. Once
438 used, guarantees that there is room for at least C<nitems> to be pushed
441 void EXTEND(SP, int nitems)
448 Analyses the string in order to make fast searches on it using fbm_instr()
449 -- the Boyer-Moore algorithm.
451 void fbm_compile(SV* sv, U32 flags)
458 Returns the location of the SV in the string delimited by C<str> and
459 C<strend>. It returns C<Nullch> if the string can't be found. The C<sv>
460 does not have to be fbm_compiled, but the search will not be as fast
463 char* fbm_instr(unsigned char* big, unsigned char* bigend, SV* littlesv, U32 flags)
470 Closing bracket for temporaries on a callback. See C<SAVETMPS> and
476 Found in file scope.h
480 Returns the AV of the specified Perl array. If C<create> is set and the
481 Perl variable does not exist then it will be created. If C<create> is not
482 set and the variable does not exist then NULL is returned.
484 NOTE: the perl_ form of this function is deprecated.
486 AV* get_av(const char* name, I32 create)
493 Returns the CV of the specified Perl subroutine. If C<create> is set and
494 the Perl subroutine does not exist then it will be declared (which has the
495 same effect as saying C<sub name;>). If C<create> is not set and the
496 subroutine does not exist then NULL is returned.
498 NOTE: the perl_ form of this function is deprecated.
500 CV* get_cv(const char* name, I32 create)
507 Returns the HV of the specified Perl hash. If C<create> is set and the
508 Perl variable does not exist then it will be created. If C<create> is not
509 set and the variable does not exist then NULL is returned.
511 NOTE: the perl_ form of this function is deprecated.
513 HV* get_hv(const char* name, I32 create)
520 Returns the SV of the specified Perl scalar. If C<create> is set and the
521 Perl variable does not exist then it will be created. If C<create> is not
522 set and the variable does not exist then NULL is returned.
524 NOTE: the perl_ form of this function is deprecated.
526 SV* get_sv(const char* name, I32 create)
533 A backward-compatible version of C<GIMME_V> which can only return
534 C<G_SCALAR> or C<G_ARRAY>; in a void context, it returns C<G_SCALAR>.
535 Deprecated. Use C<GIMME_V> instead.
544 The XSUB-writer's equivalent to Perl's C<wantarray>. Returns C<G_VOID>,
545 C<G_SCALAR> or C<G_ARRAY> for void, scalar or list context,
555 Recognise (or not) a number. The type of the number is returned
556 (0 if unrecognised), otherwise it is a bit-ORed combination of
557 IS_NUMBER_IN_UV, IS_NUMBER_GREATER_THAN_UV_MAX, IS_NUMBER_NOT_INT,
558 IS_NUMBER_NEG, IS_NUMBER_INFINITY (defined in perl.h). If the value
559 of the number can fit an in UV, it is returned in the *valuep.
561 int grok_number(const char *pv, STRLEN len, UV *valuep)
564 Found in file numeric.c
566 =item grok_numeric_radix
568 Scan and skip for a numeric decimal separator (radix).
570 bool grok_numeric_radix(const char **sp, const char *send)
573 Found in file numeric.c
577 Return the SV from the GV.
586 Returns the glob with the given C<name> and a defined subroutine or
587 C<NULL>. The glob lives in the given C<stash>, or in the stashes
588 accessible via @ISA and UNIVERSAL::.
590 The argument C<level> should be either 0 or -1. If C<level==0>, as a
591 side-effect creates a glob with the given C<name> in the given C<stash>
592 which in the case of success contains an alias for the subroutine, and sets
593 up caching info for this glob. Similarly for all the searched stashes.
595 This function grants C<"SUPER"> token as a postfix of the stash name. The
596 GV returned from C<gv_fetchmeth> may be a method cache entry, which is not
597 visible to Perl code. So when calling C<call_sv>, you should not use
598 the GV directly; instead, you should use the method's CV, which can be
599 obtained from the GV with the C<GvCV> macro.
601 GV* gv_fetchmeth(HV* stash, const char* name, STRLEN len, I32 level)
608 See L<gv_fetchmethod_autoload>.
610 GV* gv_fetchmethod(HV* stash, const char* name)
615 =item gv_fetchmethod_autoload
617 Returns the glob which contains the subroutine to call to invoke the method
618 on the C<stash>. In fact in the presence of autoloading this may be the
619 glob for "AUTOLOAD". In this case the corresponding variable $AUTOLOAD is
622 The third parameter of C<gv_fetchmethod_autoload> determines whether
623 AUTOLOAD lookup is performed if the given method is not present: non-zero
624 means yes, look for AUTOLOAD; zero means no, don't look for AUTOLOAD.
625 Calling C<gv_fetchmethod> is equivalent to calling C<gv_fetchmethod_autoload>
626 with a non-zero C<autoload> parameter.
628 These functions grant C<"SUPER"> token as a prefix of the method name. Note
629 that if you want to keep the returned glob for a long time, you need to
630 check for it being "AUTOLOAD", since at the later time the call may load a
631 different subroutine due to $AUTOLOAD changing its value. Use the glob
632 created via a side effect to do this.
634 These functions have the same side-effects and as C<gv_fetchmeth> with
635 C<level==0>. C<name> should be writable if contains C<':'> or C<'
636 ''>. The warning against passing the GV returned by C<gv_fetchmeth> to
637 C<call_sv> apply equally to these functions.
639 GV* gv_fetchmethod_autoload(HV* stash, const char* name, I32 autoload)
646 Returns a pointer to the stash for a specified package. C<name> should
647 be a valid UTF-8 string. If C<create> is set then the package will be
648 created if it does not already exist. If C<create> is not set and the
649 package does not exist then NULL is returned.
651 HV* gv_stashpv(const char* name, I32 create)
658 Returns a pointer to the stash for a specified package, which must be a
659 valid UTF-8 string. See C<gv_stashpv>.
661 HV* gv_stashsv(SV* sv, I32 create)
668 Used to indicate list context. See C<GIMME_V>, C<GIMME> and
676 Indicates that arguments returned from a callback should be discarded. See
684 Used to force a Perl C<eval> wrapper around a callback. See
692 Indicates that no arguments are being sent to a callback. See
700 Used to indicate scalar context. See C<GIMME_V>, C<GIMME>, and
708 Used to indicate void context. See C<GIMME_V> and L<perlcall>.
715 This flag, used in the length slot of hash entries and magic structures,
716 specifies the structure contains a C<SV*> pointer where a C<char*> pointer
717 is to be expected. (For information only--not to be used).
724 Returns the computed hash stored in the hash entry.
733 Returns the actual pointer stored in the key slot of the hash entry. The
734 pointer may be either C<char*> or C<SV*>, depending on the value of
735 C<HeKLEN()>. Can be assigned to. The C<HePV()> or C<HeSVKEY()> macros are
736 usually preferable for finding the value of a key.
745 If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry
746 holds an C<SV*> key. Otherwise, holds the actual length of the key. Can
747 be assigned to. The C<HePV()> macro is usually preferable for finding key
750 STRLEN HeKLEN(HE* he)
757 Returns the key slot of the hash entry as a C<char*> value, doing any
758 necessary dereferencing of possibly C<SV*> keys. The length of the string
759 is placed in C<len> (this is a macro, so do I<not> use C<&len>). If you do
760 not care about what the length of the key is, you may use the global
761 variable C<PL_na>, though this is rather less efficient than using a local
762 variable. Remember though, that hash keys in perl are free to contain
763 embedded nulls, so using C<strlen()> or similar is not a good way to find
764 the length of hash keys. This is very similar to the C<SvPV()> macro
765 described elsewhere in this document.
767 char* HePV(HE* he, STRLEN len)
774 Returns the key as an C<SV*>, or C<Nullsv> if the hash entry does not
775 contain an C<SV*> key.
784 Returns the key as an C<SV*>. Will create and return a temporary mortal
785 C<SV*> if the hash entry contains only a C<char*> key.
787 SV* HeSVKEY_force(HE* he)
794 Sets the key to a given C<SV*>, taking care to set the appropriate flags to
795 indicate the presence of an C<SV*> key, and returns the same
798 SV* HeSVKEY_set(HE* he, SV* sv)
805 Returns the value slot (type C<SV*>) stored in the hash entry.
814 Returns the package name of a stash. See C<SvSTASH>, C<CvSTASH>.
816 char* HvNAME(HV* stash)
823 Clears a hash, making it empty.
825 void hv_clear(HV* tb)
832 Deletes a key/value pair in the hash. The value SV is removed from the
833 hash and returned to the caller. The C<klen> is the length of the key.
834 The C<flags> value will normally be zero; if set to G_DISCARD then NULL
837 SV* hv_delete(HV* tb, const char* key, I32 klen, I32 flags)
844 Deletes a key/value pair in the hash. The value SV is removed from the
845 hash and returned to the caller. The C<flags> value will normally be zero;
846 if set to G_DISCARD then NULL will be returned. C<hash> can be a valid
847 precomputed hash value, or 0 to ask for it to be computed.
849 SV* hv_delete_ent(HV* tb, SV* key, I32 flags, U32 hash)
856 Returns a boolean indicating whether the specified hash key exists. The
857 C<klen> is the length of the key.
859 bool hv_exists(HV* tb, const char* key, I32 klen)
866 Returns a boolean indicating whether the specified hash key exists. C<hash>
867 can be a valid precomputed hash value, or 0 to ask for it to be
870 bool hv_exists_ent(HV* tb, SV* key, U32 hash)
877 Returns the SV which corresponds to the specified key in the hash. The
878 C<klen> is the length of the key. If C<lval> is set then the fetch will be
879 part of a store. Check that the return value is non-null before
880 dereferencing it to a C<SV*>.
882 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
883 information on how to use this function on tied hashes.
885 SV** hv_fetch(HV* tb, const char* key, I32 klen, I32 lval)
892 Returns the hash entry which corresponds to the specified key in the hash.
893 C<hash> must be a valid precomputed hash number for the given C<key>, or 0
894 if you want the function to compute it. IF C<lval> is set then the fetch
895 will be part of a store. Make sure the return value is non-null before
896 accessing it. The return value when C<tb> is a tied hash is a pointer to a
897 static location, so be sure to make a copy of the structure if you need to
900 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
901 information on how to use this function on tied hashes.
903 HE* hv_fetch_ent(HV* tb, SV* key, I32 lval, U32 hash)
910 Prepares a starting point to traverse a hash table. Returns the number of
911 keys in the hash (i.e. the same as C<HvKEYS(tb)>). The return value is
912 currently only meaningful for hashes without tie magic.
914 NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
915 hash buckets that happen to be in use. If you still need that esoteric
916 value, you can get it through the macro C<HvFILL(tb)>.
918 I32 hv_iterinit(HV* tb)
925 Returns the key from the current position of the hash iterator. See
928 char* hv_iterkey(HE* entry, I32* retlen)
935 Returns the key as an C<SV*> from the current position of the hash
936 iterator. The return value will always be a mortal copy of the key. Also
939 SV* hv_iterkeysv(HE* entry)
946 Returns entries from a hash iterator. See C<hv_iterinit>.
948 HE* hv_iternext(HV* tb)
955 Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
958 SV* hv_iternextsv(HV* hv, char** key, I32* retlen)
965 Returns the value from the current position of the hash iterator. See
968 SV* hv_iterval(HV* tb, HE* entry)
975 Adds magic to a hash. See C<sv_magic>.
977 void hv_magic(HV* hv, GV* gv, int how)
984 Stores an SV in a hash. The hash key is specified as C<key> and C<klen> is
985 the length of the key. The C<hash> parameter is the precomputed hash
986 value; if it is zero then Perl will compute it. The return value will be
987 NULL if the operation failed or if the value did not need to be actually
988 stored within the hash (as in the case of tied hashes). Otherwise it can
989 be dereferenced to get the original C<SV*>. Note that the caller is
990 responsible for suitably incrementing the reference count of C<val> before
991 the call, and decrementing it if the function returned NULL.
993 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
994 information on how to use this function on tied hashes.
996 SV** hv_store(HV* tb, const char* key, I32 klen, SV* val, U32 hash)
1003 Stores C<val> in a hash. The hash key is specified as C<key>. The C<hash>
1004 parameter is the precomputed hash value; if it is zero then Perl will
1005 compute it. The return value is the new hash entry so created. It will be
1006 NULL if the operation failed or if the value did not need to be actually
1007 stored within the hash (as in the case of tied hashes). Otherwise the
1008 contents of the return value can be accessed using the C<He?> macros
1009 described here. Note that the caller is responsible for suitably
1010 incrementing the reference count of C<val> before the call, and
1011 decrementing it if the function returned NULL.
1013 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1014 information on how to use this function on tied hashes.
1016 HE* hv_store_ent(HV* tb, SV* key, SV* val, U32 hash)
1025 void hv_undef(HV* tb)
1032 Returns a boolean indicating whether the C C<char> is an ASCII alphanumeric
1033 character (including underscore) or digit.
1035 bool isALNUM(char ch)
1038 Found in file handy.h
1042 Returns a boolean indicating whether the C C<char> is an ASCII alphabetic
1045 bool isALPHA(char ch)
1048 Found in file handy.h
1052 Returns a boolean indicating whether the C C<char> is an ASCII
1055 bool isDIGIT(char ch)
1058 Found in file handy.h
1062 Returns a boolean indicating whether the C C<char> is a lowercase
1065 bool isLOWER(char ch)
1068 Found in file handy.h
1072 Returns a boolean indicating whether the C C<char> is whitespace.
1074 bool isSPACE(char ch)
1077 Found in file handy.h
1081 Returns a boolean indicating whether the C C<char> is an uppercase
1084 bool isUPPER(char ch)
1087 Found in file handy.h
1091 Tests if some arbitrary number of bytes begins in a valid UTF-8
1092 character. Note that an INVARIANT (i.e. ASCII) character is a valid UTF-8 character.
1093 The actual number of bytes in the UTF-8 character will be returned if
1094 it is valid, otherwise 0.
1096 STRLEN is_utf8_char(U8 *p)
1099 Found in file utf8.c
1101 =item is_utf8_string
1103 Returns true if first C<len> bytes of the given string form a valid UTF8
1104 string, false otherwise. Note that 'a valid UTF8 string' does not mean
1105 'a string that contains UTF8' because a valid ASCII string is a valid
1108 bool is_utf8_string(U8 *s, STRLEN len)
1111 Found in file utf8.c
1115 Variable which is setup by C<xsubpp> to indicate the number of
1116 items on the stack. See L<perlxs/"Variable-length Parameter Lists">.
1121 Found in file XSUB.h
1125 Variable which is setup by C<xsubpp> to indicate which of an
1126 XSUB's aliases was used to invoke it. See L<perlxs/"The ALIAS: Keyword">.
1131 Found in file XSUB.h
1135 Closing bracket on a callback. See C<ENTER> and L<perlcall>.
1140 Found in file scope.h
1144 Loads the module whose name is pointed to by the string part of name.
1145 Note that the actual module name, not its filename, should be given.
1146 Eg, "Foo::Bar" instead of "Foo/Bar.pm". flags can be any of
1147 PERL_LOADMOD_DENY, PERL_LOADMOD_NOIMPORT, or PERL_LOADMOD_IMPORT_OPS
1148 (or 0 for no flags). ver, if specified, provides version semantics
1149 similar to C<use Foo::Bar VERSION>. The optional trailing SV*
1150 arguments can be used to specify arguments to the module's import()
1151 method, similar to C<use Foo::Bar VERSION LIST>.
1153 void load_module(U32 flags, SV* name, SV* ver, ...)
1156 Found in file opmini.c
1158 =item looks_like_number
1160 Test if an the content of an SV looks like a number (or is a
1161 number). C<Inf> and C<Infinity> are treated as numbers (so will not
1162 issue a non-numeric warning), even if your atof() doesn't grok them.
1164 I32 looks_like_number(SV* sv)
1171 Stack marker variable for the XSUB. See C<dMARK>.
1178 Clear something magical that the SV represents. See C<sv_magic>.
1180 int mg_clear(SV* sv)
1187 Copies the magic from one SV to another. See C<sv_magic>.
1189 int mg_copy(SV* sv, SV* nsv, const char* key, I32 klen)
1196 Finds the magic pointer for type matching the SV. See C<sv_magic>.
1198 MAGIC* mg_find(SV* sv, int type)
1205 Free any magic storage used by the SV. See C<sv_magic>.
1214 Do magic after a value is retrieved from the SV. See C<sv_magic>.
1223 Report on the SV's length. See C<sv_magic>.
1225 U32 mg_length(SV* sv)
1232 Turns on the magical status of an SV. See C<sv_magic>.
1234 void mg_magical(SV* sv)
1241 Do magic after a value is assigned to the SV. See C<sv_magic>.
1250 The XSUB-writer's interface to the C C<memmove> function. The C<src> is the
1251 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1252 the type. Can do overlapping moves. See also C<Copy>.
1254 void Move(void* src, void* dest, int nitems, type)
1257 Found in file handy.h
1261 The XSUB-writer's interface to the C C<malloc> function.
1263 void New(int id, void* ptr, int nitems, type)
1266 Found in file handy.h
1270 Creates a new AV. The reference count is set to 1.
1279 The XSUB-writer's interface to the C C<malloc> function, with
1282 void Newc(int id, void* ptr, int nitems, type, cast)
1285 Found in file handy.h
1289 Creates a constant sub equivalent to Perl C<sub FOO () { 123 }> which is
1290 eligible for inlining at compile-time.
1292 CV* newCONSTSUB(HV* stash, char* name, SV* sv)
1295 Found in file opmini.c
1299 Creates a new HV. The reference count is set to 1.
1308 Creates an RV wrapper for an SV. The reference count for the original SV is
1311 SV* newRV_inc(SV* sv)
1318 Creates an RV wrapper for an SV. The reference count for the original
1319 SV is B<not> incremented.
1321 SV* newRV_noinc(SV *sv)
1328 Creates a new SV. A non-zero C<len> parameter indicates the number of
1329 bytes of preallocated string space the SV should have. An extra byte for a
1330 tailing NUL is also reserved. (SvPOK is not set for the SV even if string
1331 space is allocated.) The reference count for the new SV is set to 1.
1332 C<id> is an integer id between 0 and 1299 (used to identify leaks).
1334 SV* NEWSV(int id, STRLEN len)
1337 Found in file handy.h
1341 Creates a new SV and copies an integer into it. The reference count for the
1351 Creates a new SV and copies a floating point value into it.
1352 The reference count for the SV is set to 1.
1361 Creates a new SV and copies a string into it. The reference count for the
1362 SV is set to 1. If C<len> is zero, Perl will compute the length using
1363 strlen(). For efficiency, consider using C<newSVpvn> instead.
1365 SV* newSVpv(const char* s, STRLEN len)
1372 Creates a new SV an initialize it with the string formatted like
1375 SV* newSVpvf(const char* pat, ...)
1382 Creates a new SV and copies a string into it. The reference count for the
1383 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
1384 string. You are responsible for ensuring that the source string is at least
1387 SV* newSVpvn(const char* s, STRLEN len)
1392 =item newSVpvn_share
1394 Creates a new SV and populates it with a string from
1395 the string table. Turns on READONLY and FAKE.
1396 The idea here is that as string table is used for shared hash
1397 keys these strings will have SvPVX == HeKEY and hash lookup
1398 will avoid string compare.
1400 SV* newSVpvn_share(const char* s, I32 len, U32 hash)
1407 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
1408 it will be upgraded to one. If C<classname> is non-null then the new SV will
1409 be blessed in the specified package. The new SV is returned and its
1410 reference count is 1.
1412 SV* newSVrv(SV* rv, const char* classname)
1419 Creates a new SV which is an exact duplicate of the original SV.
1421 SV* newSVsv(SV* old)
1428 Creates a new SV and copies an unsigned integer into it.
1429 The reference count for the SV is set to 1.
1438 Used by C<xsubpp> to hook up XSUBs as Perl subs.
1441 Found in file opmini.c
1445 Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
1449 Found in file XSUB.h
1453 The XSUB-writer's interface to the C C<malloc> function. The allocated
1454 memory is zeroed with C<memzero>.
1456 void Newz(int id, void* ptr, int nitems, type)
1459 Found in file handy.h
1470 Null character pointer.
1473 Found in file handy.h
1494 Found in file handy.h
1498 The original stack mark for the XSUB. See C<dORIGMARK>.
1505 Allocates a new Perl interpreter. See L<perlembed>.
1507 PerlInterpreter* perl_alloc()
1510 Found in file perl.c
1512 =item perl_construct
1514 Initializes a new Perl interpreter. See L<perlembed>.
1516 void perl_construct(PerlInterpreter* interp)
1519 Found in file perl.c
1523 Shuts down a Perl interpreter. See L<perlembed>.
1525 void perl_destruct(PerlInterpreter* interp)
1528 Found in file perl.c
1532 Releases a Perl interpreter. See L<perlembed>.
1534 void perl_free(PerlInterpreter* interp)
1537 Found in file perl.c
1541 Tells a Perl interpreter to parse a Perl script. See L<perlembed>.
1543 int perl_parse(PerlInterpreter* interp, XSINIT_t xsinit, int argc, char** argv, char** env)
1546 Found in file perl.c
1550 Tells a Perl interpreter to run. See L<perlembed>.
1552 int perl_run(PerlInterpreter* interp)
1555 Found in file perl.c
1559 C<PL_modglobal> is a general purpose, interpreter global HV for use by
1560 extensions that need to keep information on a per-interpreter basis.
1561 In a pinch, it can also be used as a symbol table for extensions
1562 to share data among each other. It is a good idea to use keys
1563 prefixed by the package name of the extension that owns the data.
1568 Found in file intrpvar.h
1572 A convenience variable which is typically used with C<SvPV> when one
1573 doesn't care about the length of the string. It is usually more efficient
1574 to either declare a local variable and use that instead or to use the
1575 C<SvPV_nolen> macro.
1580 Found in file thrdvar.h
1584 This is the C<false> SV. See C<PL_sv_yes>. Always refer to this as
1590 Found in file intrpvar.h
1594 This is the C<undef> SV. Always refer to this as C<&PL_sv_undef>.
1599 Found in file intrpvar.h
1603 This is the C<true> SV. See C<PL_sv_no>. Always refer to this as
1609 Found in file intrpvar.h
1613 Pops an integer off the stack.
1622 Pops a long off the stack.
1631 Pops a double off the stack.
1640 Pops a string off the stack. Deprecated. New code should provide
1641 a STRLEN n_a and use POPpx.
1650 Pops a string off the stack which must consist of bytes i.e. characters < 256.
1651 Requires a variable STRLEN n_a in scope.
1660 Pops a string off the stack.
1661 Requires a variable STRLEN n_a in scope.
1670 Pops an SV off the stack.
1679 Push an integer onto the stack. The stack must have room for this element.
1680 Handles 'set' magic. See C<XPUSHi>.
1689 Opening bracket for arguments on a callback. See C<PUTBACK> and
1699 Push a double onto the stack. The stack must have room for this element.
1700 Handles 'set' magic. See C<XPUSHn>.
1709 Push a string onto the stack. The stack must have room for this element.
1710 The C<len> indicates the length of the string. Handles 'set' magic. See
1713 void PUSHp(char* str, STRLEN len)
1720 Push an SV onto the stack. The stack must have room for this element.
1721 Does not handle 'set' magic. See C<XPUSHs>.
1730 Push an unsigned integer onto the stack. The stack must have room for this
1731 element. See C<XPUSHu>.
1740 Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
1741 See C<PUSHMARK> and L<perlcall> for other uses.
1750 The XSUB-writer's interface to the C C<realloc> function.
1752 void Renew(void* ptr, int nitems, type)
1755 Found in file handy.h
1759 The XSUB-writer's interface to the C C<realloc> function, with
1762 void Renewc(void* ptr, int nitems, type, cast)
1765 Found in file handy.h
1769 Tells Perl to C<require> the file named by the string argument. It is
1770 analogous to the Perl code C<eval "require '$file'">. It's even
1771 implemented that way; consider using Perl_load_module instead.
1773 NOTE: the perl_ form of this function is deprecated.
1775 void require_pv(const char* pv)
1778 Found in file perl.c
1782 Variable which is setup by C<xsubpp> to hold the return value for an
1783 XSUB. This is always the proper type for the XSUB. See
1784 L<perlxs/"The RETVAL Variable">.
1789 Found in file XSUB.h
1793 The XSUB-writer's interface to the C C<free> function.
1795 void Safefree(void* ptr)
1798 Found in file handy.h
1802 Copy a string to a safe spot. This does not use an SV.
1804 char* savepv(const char* sv)
1807 Found in file util.c
1811 Copy a string to a safe spot. The C<len> indicates number of bytes to
1812 copy. This does not use an SV.
1814 char* savepvn(const char* sv, I32 len)
1817 Found in file util.c
1821 Opening bracket for temporaries on a callback. See C<FREETMPS> and
1827 Found in file scope.h
1831 Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and
1839 Refetch the stack pointer. Used after a callback. See L<perlcall>.
1848 Used to access elements on the XSUB's stack.
1853 Found in file XSUB.h
1857 Test two strings to see if they are equal. Returns true or false.
1859 bool strEQ(char* s1, char* s2)
1862 Found in file handy.h
1866 Test two strings to see if the first, C<s1>, is greater than or equal to
1867 the second, C<s2>. Returns true or false.
1869 bool strGE(char* s1, char* s2)
1872 Found in file handy.h
1876 Test two strings to see if the first, C<s1>, is greater than the second,
1877 C<s2>. Returns true or false.
1879 bool strGT(char* s1, char* s2)
1882 Found in file handy.h
1886 Test two strings to see if the first, C<s1>, is less than or equal to the
1887 second, C<s2>. Returns true or false.
1889 bool strLE(char* s1, char* s2)
1892 Found in file handy.h
1896 Test two strings to see if the first, C<s1>, is less than the second,
1897 C<s2>. Returns true or false.
1899 bool strLT(char* s1, char* s2)
1902 Found in file handy.h
1906 Test two strings to see if they are different. Returns true or
1909 bool strNE(char* s1, char* s2)
1912 Found in file handy.h
1916 Test two strings to see if they are equal. The C<len> parameter indicates
1917 the number of bytes to compare. Returns true or false. (A wrapper for
1920 bool strnEQ(char* s1, char* s2, STRLEN len)
1923 Found in file handy.h
1927 Test two strings to see if they are different. The C<len> parameter
1928 indicates the number of bytes to compare. Returns true or false. (A
1929 wrapper for C<strncmp>).
1931 bool strnNE(char* s1, char* s2, STRLEN len)
1934 Found in file handy.h
1938 This is an architecture-independent macro to copy one structure to another.
1940 void StructCopy(type src, type dest, type)
1943 Found in file handy.h
1947 Returns the length of the string which is in the SV. See C<SvLEN>.
1949 STRLEN SvCUR(SV* sv)
1956 Set the length of the string which is in the SV. See C<SvCUR>.
1958 void SvCUR_set(SV* sv, STRLEN len)
1965 Returns a pointer to the last character in the string which is in the SV.
1966 See C<SvCUR>. Access the character as *(SvEND(sv)).
1975 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
1976 argument more than once.
1978 void SvGETMAGIC(SV* sv)
1985 Expands the character buffer in the SV so that it has room for the
1986 indicated number of bytes (remember to reserve space for an extra trailing
1987 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
1988 Returns a pointer to the character buffer.
1990 char * SvGROW(SV* sv, STRLEN len)
1997 Returns a boolean indicating whether the SV contains an integer.
2006 Returns a boolean indicating whether the SV contains an integer. Checks
2007 the B<private> setting. Use C<SvIOK>.
2016 Returns a boolean indicating whether the SV contains an signed integer.
2018 void SvIOK_notUV(SV* sv)
2025 Unsets the IV status of an SV.
2027 void SvIOK_off(SV* sv)
2034 Tells an SV that it is an integer.
2036 void SvIOK_on(SV* sv)
2043 Tells an SV that it is an integer and disables all other OK bits.
2045 void SvIOK_only(SV* sv)
2052 Tells and SV that it is an unsigned integer and disables all other OK bits.
2054 void SvIOK_only_UV(SV* sv)
2061 Returns a boolean indicating whether the SV contains an unsigned integer.
2063 void SvIOK_UV(SV* sv)
2070 Coerces the given SV to an integer and returns it.
2079 Returns the integer which is stored in the SV, assuming SvIOK is
2089 Returns the size of the string buffer in the SV, not including any part
2090 attributable to C<SvOOK>. See C<SvCUR>.
2092 STRLEN SvLEN(SV* sv)
2099 Returns a boolean indicating whether the SV contains a number, integer or
2109 Returns a boolean indicating whether the SV contains a number, integer or
2110 double. Checks the B<private> setting. Use C<SvNIOK>.
2112 bool SvNIOKp(SV* sv)
2119 Unsets the NV/IV status of an SV.
2121 void SvNIOK_off(SV* sv)
2128 Returns a boolean indicating whether the SV contains a double.
2137 Returns a boolean indicating whether the SV contains a double. Checks the
2138 B<private> setting. Use C<SvNOK>.
2147 Unsets the NV status of an SV.
2149 void SvNOK_off(SV* sv)
2156 Tells an SV that it is a double.
2158 void SvNOK_on(SV* sv)
2165 Tells an SV that it is a double and disables all other OK bits.
2167 void SvNOK_only(SV* sv)
2174 Coerce the given SV to a double and return it.
2183 Returns the double which is stored in the SV, assuming SvNOK is
2193 Returns a boolean indicating whether the value is an SV.
2202 Returns a boolean indicating whether the SvIVX is a valid offset value for
2203 the SvPVX. This hack is used internally to speed up removal of characters
2204 from the beginning of a SvPV. When SvOOK is true, then the start of the
2205 allocated string buffer is really (SvPVX - SvIVX).
2214 Returns a boolean indicating whether the SV contains a character
2224 Returns a boolean indicating whether the SV contains a character string.
2225 Checks the B<private> setting. Use C<SvPOK>.
2234 Unsets the PV status of an SV.
2236 void SvPOK_off(SV* sv)
2243 Tells an SV that it is a string.
2245 void SvPOK_on(SV* sv)
2252 Tells an SV that it is a string and disables all other OK bits.
2253 Will also turn off the UTF8 status.
2255 void SvPOK_only(SV* sv)
2260 =item SvPOK_only_UTF8
2262 Tells an SV that it is a string and disables all other OK bits,
2263 and leaves the UTF8 status as it was.
2265 void SvPOK_only_UTF8(SV* sv)
2272 Returns a pointer to the string in the SV, or a stringified form of the SV
2273 if the SV does not contain a string. Handles 'get' magic.
2275 char* SvPV(SV* sv, STRLEN len)
2282 Returns a pointer to the string in the SV. The SV must contain a
2292 Like <SvPV> but will force the SV into becoming a string (SvPOK). You want
2293 force if you are going to update the SvPVX directly.
2295 char* SvPV_force(SV* sv, STRLEN len)
2302 Returns a pointer to the string in the SV, or a stringified form of the SV
2303 if the SV does not contain a string. Handles 'get' magic.
2305 char* SvPV_nolen(SV* sv)
2312 Returns the value of the object's reference count.
2314 U32 SvREFCNT(SV* sv)
2321 Decrements the reference count of the given SV.
2323 void SvREFCNT_dec(SV* sv)
2330 Increments the reference count of the given SV.
2332 SV* SvREFCNT_inc(SV* sv)
2339 Tests if the SV is an RV.
2348 Unsets the RV status of an SV.
2350 void SvROK_off(SV* sv)
2357 Tells an SV that it is an RV.
2359 void SvROK_on(SV* sv)
2366 Dereferences an RV to return the SV.
2375 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
2376 argument more than once.
2378 void SvSETMAGIC(SV* sv)
2385 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
2388 void SvSetSV(SV* dsb, SV* ssv)
2393 =item SvSetSV_nosteal
2395 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
2396 ssv. May evaluate arguments more than once.
2398 void SvSetSV_nosteal(SV* dsv, SV* ssv)
2405 Returns the stash of the SV.
2414 Taints an SV if tainting is enabled
2416 void SvTAINT(SV* sv)
2423 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
2426 bool SvTAINTED(SV* sv)
2433 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
2434 some of Perl's fundamental security features. XS module authors should not
2435 use this function unless they fully understand all the implications of
2436 unconditionally untainting the value. Untainting should be done in the
2437 standard perl fashion, via a carefully crafted regexp, rather than directly
2438 untainting variables.
2440 void SvTAINTED_off(SV* sv)
2447 Marks an SV as tainted.
2449 void SvTAINTED_on(SV* sv)
2456 Returns a boolean indicating whether Perl would evaluate the SV as true or
2457 false, defined or undefined. Does not handle 'get' magic.
2466 An enum of flags for Perl types. These are found in the file B<sv.h>
2467 in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
2474 Returns the type of the SV. See C<svtype>.
2476 svtype SvTYPE(SV* sv)
2483 Integer type flag for scalars. See C<svtype>.
2490 Double type flag for scalars. See C<svtype>.
2497 Pointer type flag for scalars. See C<svtype>.
2504 Type flag for arrays. See C<svtype>.
2511 Type flag for code refs. See C<svtype>.
2518 Type flag for hashes. See C<svtype>.
2525 Type flag for blessed scalars. See C<svtype>.
2532 Returns a boolean indicating whether the SV contains an unsigned integer.
2541 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
2542 perform the upgrade if necessary. See C<svtype>.
2544 void SvUPGRADE(SV* sv, svtype type)
2551 Returns a boolean indicating whether the SV contains UTF-8 encoded data.
2560 Unsets the UTF8 status of an SV.
2562 void SvUTF8_off(SV *sv)
2569 Turn on the UTF8 status of an SV (the data is not changed, just the flag).
2570 Do not use frivolously.
2572 void SvUTF8_on(SV *sv)
2579 Coerces the given SV to an unsigned integer and returns it.
2588 Returns the unsigned integer which is stored in the SV, assuming SvIOK is
2598 Marks an SV as mortal. The SV will be destroyed when the current context
2601 SV* sv_2mortal(SV* sv)
2608 Blesses an SV into a specified package. The SV must be an RV. The package
2609 must be designated by its stash (see C<gv_stashpv()>). The reference count
2610 of the SV is unaffected.
2612 SV* sv_bless(SV* sv, HV* stash)
2619 Concatenates the string onto the end of the string which is in the SV.
2620 If the SV has the UTF8 status set, then the bytes appended should be
2621 valid UTF8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
2623 void sv_catpv(SV* sv, const char* ptr)
2630 Processes its arguments like C<sprintf> and appends the formatted
2631 output to an SV. If the appended data contains "wide" characters
2632 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
2633 and characters >255 formatted with %c), the original SV might get
2634 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic.
2635 C<SvSETMAGIC()> must typically be called after calling this function
2636 to handle 'set' magic.
2638 void sv_catpvf(SV* sv, const char* pat, ...)
2645 Like C<sv_catpvf>, but also handles 'set' magic.
2647 void sv_catpvf_mg(SV *sv, const char* pat, ...)
2654 Concatenates the string onto the end of the string which is in the SV. The
2655 C<len> indicates number of bytes to copy. If the SV has the UTF8
2656 status set, then the bytes appended should be valid UTF8.
2657 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
2659 void sv_catpvn(SV* sv, const char* ptr, STRLEN len)
2664 =item sv_catpvn_flags
2666 Concatenates the string onto the end of the string which is in the SV. The
2667 C<len> indicates number of bytes to copy. If the SV has the UTF8
2668 status set, then the bytes appended should be valid UTF8.
2669 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
2670 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
2671 in terms of this function.
2673 void sv_catpvn_flags(SV* sv, const char* ptr, STRLEN len, I32 flags)
2680 Like C<sv_catpvn>, but also handles 'set' magic.
2682 void sv_catpvn_mg(SV *sv, const char *ptr, STRLEN len)
2689 Like C<sv_catpv>, but also handles 'set' magic.
2691 void sv_catpv_mg(SV *sv, const char *ptr)
2698 Concatenates the string from SV C<ssv> onto the end of the string in
2699 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
2700 not 'set' magic. See C<sv_catsv_mg>.
2702 void sv_catsv(SV* dsv, SV* ssv)
2707 =item sv_catsv_flags
2709 Concatenates the string from SV C<ssv> onto the end of the string in
2710 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
2711 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
2712 and C<sv_catsv_nomg> are implemented in terms of this function.
2714 void sv_catsv_flags(SV* dsv, SV* ssv, I32 flags)
2721 Like C<sv_catsv>, but also handles 'set' magic.
2723 void sv_catsv_mg(SV *dstr, SV *sstr)
2730 Efficient removal of characters from the beginning of the string buffer.
2731 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
2732 the string buffer. The C<ptr> becomes the first character of the adjusted
2735 void sv_chop(SV* sv, char* ptr)
2742 Clear an SV, making it empty. Does not free the memory used by the SV
2745 void sv_clear(SV* sv)
2752 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
2753 string in C<sv1> is less than, equal to, or greater than the string in
2756 I32 sv_cmp(SV* sv1, SV* sv2)
2763 Compares the strings in two SVs in a locale-aware manner. See
2766 I32 sv_cmp_locale(SV* sv1, SV* sv2)
2773 Auto-decrement of the value in the SV.
2780 =item sv_derived_from
2782 Returns a boolean indicating whether the SV is derived from the specified
2783 class. This is the function that implements C<UNIVERSAL::isa>. It works
2784 for class names as well as for objects.
2786 bool sv_derived_from(SV* sv, const char* name)
2789 Found in file universal.c
2793 Returns a boolean indicating whether the strings in the two SVs are
2796 I32 sv_eq(SV* sv1, SV* sv2)
2803 Free the memory used by an SV.
2805 void sv_free(SV* sv)
2812 Fill the sv with current working directory
2814 int sv_getcwd(SV* sv)
2817 Found in file util.c
2821 Get a line from the filehandle and store it into the SV, optionally
2822 appending to the currently-stored string.
2824 char* sv_gets(SV* sv, PerlIO* fp, I32 append)
2831 Expands the character buffer in the SV. This will use C<sv_unref> and will
2832 upgrade the SV to C<SVt_PV>. Returns a pointer to the character buffer.
2835 char* sv_grow(SV* sv, STRLEN newlen)
2842 Auto-increment of the value in the SV.
2851 Inserts a string at the specified offset/length within the SV. Similar to
2852 the Perl substr() function.
2854 void sv_insert(SV* bigsv, STRLEN offset, STRLEN len, char* little, STRLEN littlelen)
2861 Returns a boolean indicating whether the SV is blessed into the specified
2862 class. This does not check for subtypes; use C<sv_derived_from> to verify
2863 an inheritance relationship.
2865 int sv_isa(SV* sv, const char* name)
2872 Returns a boolean indicating whether the SV is an RV pointing to a blessed
2873 object. If the SV is not an RV, or if the object is not blessed, then this
2876 int sv_isobject(SV* sv)
2883 Returns the length of the string in the SV. See also C<SvCUR>.
2885 STRLEN sv_len(SV* sv)
2892 Returns the number of characters in the string in an SV, counting wide
2893 UTF8 bytes as a single character.
2895 STRLEN sv_len_utf8(SV* sv)
2902 Adds magic to an SV.
2904 void sv_magic(SV* sv, SV* obj, int how, const char* name, I32 namlen)
2911 Creates a new SV which is a copy of the original SV. The new SV is marked
2914 SV* sv_mortalcopy(SV* oldsv)
2921 Creates a new SV which is mortal. The reference count of the SV is set to 1.
2930 Get a sensible string out of the SV somehow.
2932 char* sv_pvn_force(SV* sv, STRLEN* lp)
2937 =item sv_pvn_force_flags
2939 Get a sensible string out of the SV somehow.
2940 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
2941 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
2942 implemented in terms of this function.
2944 char* sv_pvn_force_flags(SV* sv, STRLEN* lp, I32 flags)
2949 =item sv_pvutf8n_force
2951 Get a sensible UTF8-encoded string out of the SV somehow. See
2954 char* sv_pvutf8n_force(SV* sv, STRLEN* lp)
2961 Wrap or emulate realpath(3).
2963 int sv_realpath(SV* sv, char *path, STRLEN len)
2966 Found in file util.c
2970 Returns a string describing what the SV is a reference to.
2972 char* sv_reftype(SV* sv, int ob)
2979 Make the first argument a copy of the second, then delete the original.
2981 void sv_replace(SV* sv, SV* nsv)
2990 SV* sv_rvweaken(SV *sv)
2997 Copies an integer into the given SV. Does not handle 'set' magic. See
3000 void sv_setiv(SV* sv, IV num)
3007 Like C<sv_setiv>, but also handles 'set' magic.
3009 void sv_setiv_mg(SV *sv, IV i)
3016 Copies a double into the given SV. Does not handle 'set' magic. See
3019 void sv_setnv(SV* sv, NV num)
3026 Like C<sv_setnv>, but also handles 'set' magic.
3028 void sv_setnv_mg(SV *sv, NV num)
3035 Copies a string into an SV. The string must be null-terminated. Does not
3036 handle 'set' magic. See C<sv_setpv_mg>.
3038 void sv_setpv(SV* sv, const char* ptr)
3045 Processes its arguments like C<sprintf> and sets an SV to the formatted
3046 output. Does not handle 'set' magic. See C<sv_setpvf_mg>.
3048 void sv_setpvf(SV* sv, const char* pat, ...)
3055 Like C<sv_setpvf>, but also handles 'set' magic.
3057 void sv_setpvf_mg(SV *sv, const char* pat, ...)
3064 Copies an integer into the given SV, also updating its string value.
3065 Does not handle 'set' magic. See C<sv_setpviv_mg>.
3067 void sv_setpviv(SV* sv, IV num)
3074 Like C<sv_setpviv>, but also handles 'set' magic.
3076 void sv_setpviv_mg(SV *sv, IV iv)
3083 Copies a string into an SV. The C<len> parameter indicates the number of
3084 bytes to be copied. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3086 void sv_setpvn(SV* sv, const char* ptr, STRLEN len)
3093 Like C<sv_setpvn>, but also handles 'set' magic.
3095 void sv_setpvn_mg(SV *sv, const char *ptr, STRLEN len)
3102 Like C<sv_setpv>, but also handles 'set' magic.
3104 void sv_setpv_mg(SV *sv, const char *ptr)
3111 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
3112 argument will be upgraded to an RV. That RV will be modified to point to
3113 the new SV. The C<classname> argument indicates the package for the
3114 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
3115 will be returned and will have a reference count of 1.
3117 SV* sv_setref_iv(SV* rv, const char* classname, IV iv)
3124 Copies a double into a new SV, optionally blessing the SV. The C<rv>
3125 argument will be upgraded to an RV. That RV will be modified to point to
3126 the new SV. The C<classname> argument indicates the package for the
3127 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
3128 will be returned and will have a reference count of 1.
3130 SV* sv_setref_nv(SV* rv, const char* classname, NV nv)
3137 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
3138 argument will be upgraded to an RV. That RV will be modified to point to
3139 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
3140 into the SV. The C<classname> argument indicates the package for the
3141 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
3142 will be returned and will have a reference count of 1.
3144 Do not use with other Perl types such as HV, AV, SV, CV, because those
3145 objects will become corrupted by the pointer copy process.
3147 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
3149 SV* sv_setref_pv(SV* rv, const char* classname, void* pv)
3156 Copies a string into a new SV, optionally blessing the SV. The length of the
3157 string must be specified with C<n>. The C<rv> argument will be upgraded to
3158 an RV. That RV will be modified to point to the new SV. The C<classname>
3159 argument indicates the package for the blessing. Set C<classname> to
3160 C<Nullch> to avoid the blessing. The new SV will be returned and will have
3161 a reference count of 1.
3163 Note that C<sv_setref_pv> copies the pointer while this copies the string.
3165 SV* sv_setref_pvn(SV* rv, const char* classname, char* pv, STRLEN n)
3172 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
3173 argument will be upgraded to an RV. That RV will be modified to point to
3174 the new SV. The C<classname> argument indicates the package for the
3175 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
3176 will be returned and will have a reference count of 1.
3178 SV* sv_setref_uv(SV* rv, const char* classname, UV uv)
3185 Copies the contents of the source SV C<ssv> into the destination SV C<dsv>.
3186 The source SV may be destroyed if it is mortal. Does not handle 'set'
3187 magic. See the macro forms C<SvSetSV>, C<SvSetSV_nosteal> and
3190 void sv_setsv(SV* dsv, SV* ssv)
3195 =item sv_setsv_flags
3197 Copies the contents of the source SV C<ssv> into the destination SV C<dsv>.
3198 The source SV may be destroyed if it is mortal. Does not handle 'set'
3199 magic. If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<ssv> if
3200 appropriate, else not. C<sv_setsv> and C<sv_setsv_nomg> are implemented
3201 in terms of this function.
3203 void sv_setsv_flags(SV* dsv, SV* ssv, I32 flags)
3210 Like C<sv_setsv>, but also handles 'set' magic.
3212 void sv_setsv_mg(SV *dstr, SV *sstr)
3219 Copies an unsigned integer into the given SV. Does not handle 'set' magic.
3222 void sv_setuv(SV* sv, UV num)
3229 Like C<sv_setuv>, but also handles 'set' magic.
3231 void sv_setuv_mg(SV *sv, UV u)
3238 Returns true if the SV has a true value by Perl's rules.
3247 Removes magic from an SV.
3249 int sv_unmagic(SV* sv, int type)
3256 Unsets the RV status of the SV, and decrements the reference count of
3257 whatever was being referenced by the RV. This can almost be thought of
3258 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
3259 being zero. See C<SvROK_off>.
3261 void sv_unref(SV* sv)
3266 =item sv_unref_flags
3268 Unsets the RV status of the SV, and decrements the reference count of
3269 whatever was being referenced by the RV. This can almost be thought of
3270 as a reversal of C<newSVrv>. The C<cflags> argument can contain
3271 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
3272 (otherwise the decrementing is conditional on the reference count being
3273 different from one or the reference being a readonly SV).
3276 void sv_unref_flags(SV* sv, U32 flags)
3283 Upgrade an SV to a more complex form. Use C<SvUPGRADE>. See
3286 bool sv_upgrade(SV* sv, U32 mt)
3293 Tells an SV to use C<ptr> to find its string value. Normally the string is
3294 stored inside the SV but sv_usepvn allows the SV to use an outside string.
3295 The C<ptr> should point to memory that was allocated by C<malloc>. The
3296 string length, C<len>, must be supplied. This function will realloc the
3297 memory pointed to by C<ptr>, so that pointer should not be freed or used by
3298 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
3299 See C<sv_usepvn_mg>.
3301 void sv_usepvn(SV* sv, char* ptr, STRLEN len)
3308 Like C<sv_usepvn>, but also handles 'set' magic.
3310 void sv_usepvn_mg(SV *sv, char *ptr, STRLEN len)
3315 =item sv_utf8_decode
3317 Convert the octets in the PV from UTF-8 to chars. Scan for validity and then
3318 turn of SvUTF8 if needed so that we see characters. Used as a building block
3319 for decode_utf8 in Encode.xs
3321 NOTE: this function is experimental and may change or be
3322 removed without notice.
3324 bool sv_utf8_decode(SV *sv)
3329 =item sv_utf8_downgrade
3331 Attempt to convert the PV of an SV from UTF8-encoded to byte encoding.
3332 This may not be possible if the PV contains non-byte encoding characters;
3333 if this is the case, either returns false or, if C<fail_ok> is not
3336 NOTE: this function is experimental and may change or be
3337 removed without notice.
3339 bool sv_utf8_downgrade(SV *sv, bool fail_ok)
3344 =item sv_utf8_encode
3346 Convert the PV of an SV to UTF8-encoded, but then turn off the C<SvUTF8>
3347 flag so that it looks like octets again. Used as a building block
3348 for encode_utf8 in Encode.xs
3350 void sv_utf8_encode(SV *sv)
3355 =item sv_utf8_upgrade
3357 Convert the PV of an SV to its UTF8-encoded form.
3358 Forces the SV to string form it it is not already.
3359 Always sets the SvUTF8 flag to avoid future validity checks even
3360 if all the bytes have hibit clear.
3362 STRLEN sv_utf8_upgrade(SV *sv)
3367 =item sv_utf8_upgrade_flags
3369 Convert the PV of an SV to its UTF8-encoded form.
3370 Forces the SV to string form it it is not already.
3371 Always sets the SvUTF8 flag to avoid future validity checks even
3372 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
3373 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
3374 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3376 STRLEN sv_utf8_upgrade_flags(SV *sv, I32 flags)
3383 Processes its arguments like C<vsprintf> and appends the formatted output
3384 to an SV. Uses an array of SVs if the C style variable argument list is
3385 missing (NULL). When running with taint checks enabled, indicates via
3386 C<maybe_tainted> if results are untrustworthy (often due to the use of
3389 void sv_vcatpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
3396 Works like C<vcatpvfn> but copies the text into the SV instead of
3399 void sv_vsetpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
3406 Variable which is setup by C<xsubpp> to designate the object in a C++
3407 XSUB. This is always the proper type for the C++ object. See C<CLASS> and
3408 L<perlxs/"Using XS With C++">.
3413 Found in file XSUB.h
3417 Converts the specified character to lowercase.
3419 char toLOWER(char ch)
3422 Found in file handy.h
3426 Converts the specified character to uppercase.
3428 char toUPPER(char ch)
3431 Found in file handy.h
3433 =item utf8n_to_uvchr
3435 Returns the native character value of the first character in the string C<s>
3436 which is assumed to be in UTF8 encoding; C<retlen> will be set to the
3437 length, in bytes, of that character.
3439 Allows length and flags to be passed to low level routine.
3441 UV utf8n_to_uvchr(U8 *s, STRLEN curlen, STRLEN* retlen, U32 flags)
3444 Found in file utf8.c
3446 =item utf8n_to_uvuni
3448 Bottom level UTF-8 decode routine.
3449 Returns the unicode code point value of the first character in the string C<s>
3450 which is assumed to be in UTF8 encoding and no longer than C<curlen>;
3451 C<retlen> will be set to the length, in bytes, of that character.
3453 If C<s> does not point to a well-formed UTF8 character, the behaviour
3454 is dependent on the value of C<flags>: if it contains UTF8_CHECK_ONLY,
3455 it is assumed that the caller will raise a warning, and this function
3456 will silently just set C<retlen> to C<-1> and return zero. If the
3457 C<flags> does not contain UTF8_CHECK_ONLY, warnings about
3458 malformations will be given, C<retlen> will be set to the expected
3459 length of the UTF-8 character in bytes, and zero will be returned.
3461 The C<flags> can also contain various flags to allow deviations from
3462 the strict UTF-8 encoding (see F<utf8.h>).
3464 Most code should use utf8_to_uvchr() rather than call this directly.
3466 UV utf8n_to_uvuni(U8 *s, STRLEN curlen, STRLEN* retlen, U32 flags)
3469 Found in file utf8.c
3473 Returns the number of UTF8 characters between the UTF-8 pointers C<a>
3476 WARNING: use only if you *know* that the pointers point inside the
3479 IV utf8_distance(U8 *a, U8 *b)
3482 Found in file utf8.c
3486 Return the UTF-8 pointer C<s> displaced by C<off> characters, either
3487 forward or backward.
3489 WARNING: do not use the following unless you *know* C<off> is within
3490 the UTF-8 data pointed to by C<s> *and* that on entry C<s> is aligned
3491 on the first byte of character or just after the last byte of a character.
3493 U8* utf8_hop(U8 *s, I32 off)
3496 Found in file utf8.c
3500 Return the length of the UTF-8 char encoded string C<s> in characters.
3501 Stops at C<e> (inclusive). If C<e E<lt> s> or if the scan would end
3502 up past C<e>, croaks.
3504 STRLEN utf8_length(U8* s, U8 *e)
3507 Found in file utf8.c
3511 Converts a string C<s> of length C<len> from UTF8 into byte encoding.
3512 Unlike C<bytes_to_utf8>, this over-writes the original string, and
3513 updates len to contain the new length.
3514 Returns zero on failure, setting C<len> to -1.
3516 NOTE: this function is experimental and may change or be
3517 removed without notice.
3519 U8* utf8_to_bytes(U8 *s, STRLEN *len)
3522 Found in file utf8.c
3526 Returns the native character value of the first character in the string C<s>
3527 which is assumed to be in UTF8 encoding; C<retlen> will be set to the
3528 length, in bytes, of that character.
3530 If C<s> does not point to a well-formed UTF8 character, zero is
3531 returned and retlen is set, if possible, to -1.
3533 UV utf8_to_uvchr(U8 *s, STRLEN* retlen)
3536 Found in file utf8.c
3540 Returns the Unicode code point of the first character in the string C<s>
3541 which is assumed to be in UTF8 encoding; C<retlen> will be set to the
3542 length, in bytes, of that character.
3544 This function should only be used when returned UV is considered
3545 an index into the Unicode semantic tables (e.g. swashes).
3547 If C<s> does not point to a well-formed UTF8 character, zero is
3548 returned and retlen is set, if possible, to -1.
3550 UV utf8_to_uvuni(U8 *s, STRLEN* retlen)
3553 Found in file utf8.c
3557 Adds the UTF8 representation of the Native codepoint C<uv> to the end
3558 of the string C<d>; C<d> should be have at least C<UTF8_MAXLEN+1> free
3559 bytes available. The return value is the pointer to the byte after the
3560 end of the new character. In other words,
3562 d = uvchr_to_utf8(d, uv);
3564 is the recommended wide native character-aware way of saying
3568 U8* uvchr_to_utf8(U8 *d, UV uv)
3571 Found in file utf8.c
3575 Adds the UTF8 representation of the Unicode codepoint C<uv> to the end
3576 of the string C<d>; C<d> should be have at least C<UTF8_MAXLEN+1> free
3577 bytes available. The return value is the pointer to the byte after the
3578 end of the new character. In other words,
3580 d = uvuni_to_utf8(d, uv);
3582 is the recommended Unicode-aware way of saying
3586 U8* uvuni_to_utf8(U8 *d, UV uv)
3589 Found in file utf8.c
3593 This is the XSUB-writer's interface to Perl's C<warn> function. Use this
3594 function the same way you use the C C<printf> function. See
3597 void warn(const char* pat, ...)
3600 Found in file util.c
3604 Push an integer onto the stack, extending the stack if necessary. Handles
3605 'set' magic. See C<PUSHi>.
3614 Push a double onto the stack, extending the stack if necessary. Handles
3615 'set' magic. See C<PUSHn>.
3624 Push a string onto the stack, extending the stack if necessary. The C<len>
3625 indicates the length of the string. Handles 'set' magic. See
3628 void XPUSHp(char* str, STRLEN len)
3635 Push an SV onto the stack, extending the stack if necessary. Does not
3636 handle 'set' magic. See C<PUSHs>.
3645 Push an unsigned integer onto the stack, extending the stack if necessary.
3655 Macro to declare an XSUB and its C parameter list. This is handled by
3659 Found in file XSUB.h
3663 Return from XSUB, indicating number of items on the stack. This is usually
3664 handled by C<xsubpp>.
3666 void XSRETURN(int nitems)
3669 Found in file XSUB.h
3671 =item XSRETURN_EMPTY
3673 Return an empty list from an XSUB immediately.
3678 Found in file XSUB.h
3682 Return an integer from an XSUB immediately. Uses C<XST_mIV>.
3684 void XSRETURN_IV(IV iv)
3687 Found in file XSUB.h
3691 Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
3696 Found in file XSUB.h
3700 Return an double from an XSUB immediately. Uses C<XST_mNV>.
3702 void XSRETURN_NV(NV nv)
3705 Found in file XSUB.h
3709 Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
3711 void XSRETURN_PV(char* str)
3714 Found in file XSUB.h
3716 =item XSRETURN_UNDEF
3718 Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
3723 Found in file XSUB.h
3727 Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
3732 Found in file XSUB.h
3736 Place an integer into the specified position C<pos> on the stack. The
3737 value is stored in a new mortal SV.
3739 void XST_mIV(int pos, IV iv)
3742 Found in file XSUB.h
3746 Place C<&PL_sv_no> into the specified position C<pos> on the
3749 void XST_mNO(int pos)
3752 Found in file XSUB.h
3756 Place a double into the specified position C<pos> on the stack. The value
3757 is stored in a new mortal SV.
3759 void XST_mNV(int pos, NV nv)
3762 Found in file XSUB.h
3766 Place a copy of a string into the specified position C<pos> on the stack.
3767 The value is stored in a new mortal SV.
3769 void XST_mPV(int pos, char* str)
3772 Found in file XSUB.h
3776 Place C<&PL_sv_undef> into the specified position C<pos> on the
3779 void XST_mUNDEF(int pos)
3782 Found in file XSUB.h
3786 Place C<&PL_sv_yes> into the specified position C<pos> on the
3789 void XST_mYES(int pos)
3792 Found in file XSUB.h
3796 The version identifier for an XS module. This is usually
3797 handled automatically by C<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>.
3800 Found in file XSUB.h
3802 =item XS_VERSION_BOOTCHECK
3804 Macro to verify that a PM module's $VERSION variable matches the XS
3805 module's C<XS_VERSION> variable. This is usually handled automatically by
3806 C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">.
3808 XS_VERSION_BOOTCHECK;
3811 Found in file XSUB.h
3815 The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the
3816 destination, C<nitems> is the number of items, and C<type> is the type.
3818 void Zero(void* dest, int nitems, type)
3821 Found in file handy.h
3827 Until May 1997, this document was maintained by Jeff Okamoto
3828 <okamoto@corp.hp.com>. It is now maintained as part of Perl itself.
3830 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
3831 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
3832 Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
3833 Stephen McCamant, and Gurusamy Sarathy.
3835 API Listing originally by Dean Roehrich <roehrich@cray.com>.
3837 Updated to be autogenerated from comments in the source by Benjamin Stuhl.
3841 perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
projects / p5sagit/p5-mst-13.2.git / blob