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)
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, ...)
1158 =item looks_like_number
1160 Test if the content of an SV looks like a number (or is a number).
1161 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1162 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)
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 and initializes 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 with its SvPVX pointing to a shared string in the string
1395 table. If the string does not already exist in the table, it is created
1396 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
1397 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
1398 otherwise the hash is computed. The idea here is that as the string table
1399 is used for shared hash keys these strings will have SvPVX == HeKEY and
1400 hash lookup will avoid string compare.
1402 SV* newSVpvn_share(const char* s, I32 len, U32 hash)
1409 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
1410 it will be upgraded to one. If C<classname> is non-null then the new SV will
1411 be blessed in the specified package. The new SV is returned and its
1412 reference count is 1.
1414 SV* newSVrv(SV* rv, const char* classname)
1421 Creates a new SV which is an exact duplicate of the original SV.
1424 SV* newSVsv(SV* old)
1431 Creates a new SV and copies an unsigned integer into it.
1432 The reference count for the SV is set to 1.
1441 Used by C<xsubpp> to hook up XSUBs as Perl subs.
1448 Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
1452 Found in file XSUB.h
1456 The XSUB-writer's interface to the C C<malloc> function. The allocated
1457 memory is zeroed with C<memzero>.
1459 void Newz(int id, void* ptr, int nitems, type)
1462 Found in file handy.h
1473 Null character pointer.
1476 Found in file handy.h
1497 Found in file handy.h
1501 The original stack mark for the XSUB. See C<dORIGMARK>.
1508 Allocates a new Perl interpreter. See L<perlembed>.
1510 PerlInterpreter* perl_alloc()
1513 Found in file perl.c
1517 Create and return a new interpreter by cloning the current one.
1519 PerlInterpreter* perl_clone(PerlInterpreter* interp, UV flags)
1524 =item perl_construct
1526 Initializes a new Perl interpreter. See L<perlembed>.
1528 void perl_construct(PerlInterpreter* interp)
1531 Found in file perl.c
1535 Shuts down a Perl interpreter. See L<perlembed>.
1537 void perl_destruct(PerlInterpreter* interp)
1540 Found in file perl.c
1544 Releases a Perl interpreter. See L<perlembed>.
1546 void perl_free(PerlInterpreter* interp)
1549 Found in file perl.c
1553 Tells a Perl interpreter to parse a Perl script. See L<perlembed>.
1555 int perl_parse(PerlInterpreter* interp, XSINIT_t xsinit, int argc, char** argv, char** env)
1558 Found in file perl.c
1562 Tells a Perl interpreter to run. See L<perlembed>.
1564 int perl_run(PerlInterpreter* interp)
1567 Found in file perl.c
1571 C<PL_modglobal> is a general purpose, interpreter global HV for use by
1572 extensions that need to keep information on a per-interpreter basis.
1573 In a pinch, it can also be used as a symbol table for extensions
1574 to share data among each other. It is a good idea to use keys
1575 prefixed by the package name of the extension that owns the data.
1580 Found in file intrpvar.h
1584 A convenience variable which is typically used with C<SvPV> when one
1585 doesn't care about the length of the string. It is usually more efficient
1586 to either declare a local variable and use that instead or to use the
1587 C<SvPV_nolen> macro.
1592 Found in file thrdvar.h
1596 This is the C<false> SV. See C<PL_sv_yes>. Always refer to this as
1602 Found in file intrpvar.h
1606 This is the C<undef> SV. Always refer to this as C<&PL_sv_undef>.
1611 Found in file intrpvar.h
1615 This is the C<true> SV. See C<PL_sv_no>. Always refer to this as
1621 Found in file intrpvar.h
1625 Pops an integer off the stack.
1634 Pops a long off the stack.
1643 Pops a double off the stack.
1652 Pops a string off the stack. Deprecated. New code should provide
1653 a STRLEN n_a and use POPpx.
1662 Pops a string off the stack which must consist of bytes i.e. characters < 256.
1663 Requires a variable STRLEN n_a in scope.
1672 Pops a string off the stack.
1673 Requires a variable STRLEN n_a in scope.
1682 Pops an SV off the stack.
1691 Push an integer onto the stack. The stack must have room for this element.
1692 Handles 'set' magic. See C<XPUSHi>.
1701 Opening bracket for arguments on a callback. See C<PUTBACK> and
1711 Push a double onto the stack. The stack must have room for this element.
1712 Handles 'set' magic. See C<XPUSHn>.
1721 Push a string onto the stack. The stack must have room for this element.
1722 The C<len> indicates the length of the string. Handles 'set' magic. See
1725 void PUSHp(char* str, STRLEN len)
1732 Push an SV onto the stack. The stack must have room for this element.
1733 Does not handle 'set' magic. See C<XPUSHs>.
1742 Push an unsigned integer onto the stack. The stack must have room for this
1743 element. See C<XPUSHu>.
1752 Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
1753 See C<PUSHMARK> and L<perlcall> for other uses.
1762 The XSUB-writer's interface to the C C<realloc> function.
1764 void Renew(void* ptr, int nitems, type)
1767 Found in file handy.h
1771 The XSUB-writer's interface to the C C<realloc> function, with
1774 void Renewc(void* ptr, int nitems, type, cast)
1777 Found in file handy.h
1781 Tells Perl to C<require> the file named by the string argument. It is
1782 analogous to the Perl code C<eval "require '$file'">. It's even
1783 implemented that way; consider using Perl_load_module instead.
1785 NOTE: the perl_ form of this function is deprecated.
1787 void require_pv(const char* pv)
1790 Found in file perl.c
1794 Variable which is setup by C<xsubpp> to hold the return value for an
1795 XSUB. This is always the proper type for the XSUB. See
1796 L<perlxs/"The RETVAL Variable">.
1801 Found in file XSUB.h
1805 The XSUB-writer's interface to the C C<free> function.
1807 void Safefree(void* ptr)
1810 Found in file handy.h
1814 Copy a string to a safe spot. This does not use an SV.
1816 char* savepv(const char* sv)
1819 Found in file util.c
1823 Copy a string to a safe spot. The C<len> indicates number of bytes to
1824 copy. This does not use an SV.
1826 char* savepvn(const char* sv, I32 len)
1829 Found in file util.c
1833 Opening bracket for temporaries on a callback. See C<FREETMPS> and
1839 Found in file scope.h
1843 Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and
1851 Refetch the stack pointer. Used after a callback. See L<perlcall>.
1860 Used to access elements on the XSUB's stack.
1865 Found in file XSUB.h
1869 Test two strings to see if they are equal. Returns true or false.
1871 bool strEQ(char* s1, char* s2)
1874 Found in file handy.h
1878 Test two strings to see if the first, C<s1>, is greater than or equal to
1879 the second, C<s2>. Returns true or false.
1881 bool strGE(char* s1, char* s2)
1884 Found in file handy.h
1888 Test two strings to see if the first, C<s1>, is greater than the second,
1889 C<s2>. Returns true or false.
1891 bool strGT(char* s1, char* s2)
1894 Found in file handy.h
1898 Test two strings to see if the first, C<s1>, is less than or equal to the
1899 second, C<s2>. Returns true or false.
1901 bool strLE(char* s1, char* s2)
1904 Found in file handy.h
1908 Test two strings to see if the first, C<s1>, is less than the second,
1909 C<s2>. Returns true or false.
1911 bool strLT(char* s1, char* s2)
1914 Found in file handy.h
1918 Test two strings to see if they are different. Returns true or
1921 bool strNE(char* s1, char* s2)
1924 Found in file handy.h
1928 Test two strings to see if they are equal. The C<len> parameter indicates
1929 the number of bytes to compare. Returns true or false. (A wrapper for
1932 bool strnEQ(char* s1, char* s2, STRLEN len)
1935 Found in file handy.h
1939 Test two strings to see if they are different. The C<len> parameter
1940 indicates the number of bytes to compare. Returns true or false. (A
1941 wrapper for C<strncmp>).
1943 bool strnNE(char* s1, char* s2, STRLEN len)
1946 Found in file handy.h
1950 This is an architecture-independent macro to copy one structure to another.
1952 void StructCopy(type src, type dest, type)
1955 Found in file handy.h
1959 Returns the length of the string which is in the SV. See C<SvLEN>.
1961 STRLEN SvCUR(SV* sv)
1968 Set the length of the string which is in the SV. See C<SvCUR>.
1970 void SvCUR_set(SV* sv, STRLEN len)
1977 Returns a pointer to the last character in the string which is in the SV.
1978 See C<SvCUR>. Access the character as *(SvEND(sv)).
1987 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
1988 argument more than once.
1990 void SvGETMAGIC(SV* sv)
1997 Expands the character buffer in the SV so that it has room for the
1998 indicated number of bytes (remember to reserve space for an extra trailing
1999 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
2000 Returns a pointer to the character buffer.
2002 char * SvGROW(SV* sv, STRLEN len)
2009 Returns a boolean indicating whether the SV contains an integer.
2018 Returns a boolean indicating whether the SV contains an integer. Checks
2019 the B<private> setting. Use C<SvIOK>.
2028 Returns a boolean indicating whether the SV contains an signed integer.
2030 void SvIOK_notUV(SV* sv)
2037 Unsets the IV status of an SV.
2039 void SvIOK_off(SV* sv)
2046 Tells an SV that it is an integer.
2048 void SvIOK_on(SV* sv)
2055 Tells an SV that it is an integer and disables all other OK bits.
2057 void SvIOK_only(SV* sv)
2064 Tells and SV that it is an unsigned integer and disables all other OK bits.
2066 void SvIOK_only_UV(SV* sv)
2073 Returns a boolean indicating whether the SV contains an unsigned integer.
2075 void SvIOK_UV(SV* sv)
2082 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
2083 version which guarantees to evaluate sv only once.
2092 Returns the raw value in the SV's IV slot, without checks or conversions.
2093 Only use when you are sure SvIOK is true. See also C<SvIV()>.
2102 Coerces the given SV to an integer and returns it. Guarantees to evaluate
2103 sv only once. Use the more efficent C<SvIV> otherwise.
2112 Returns the size of the string buffer in the SV, not including any part
2113 attributable to C<SvOOK>. See C<SvCUR>.
2115 STRLEN SvLEN(SV* sv)
2122 Returns a boolean indicating whether the SV contains a number, integer or
2132 Returns a boolean indicating whether the SV contains a number, integer or
2133 double. Checks the B<private> setting. Use C<SvNIOK>.
2135 bool SvNIOKp(SV* sv)
2142 Unsets the NV/IV status of an SV.
2144 void SvNIOK_off(SV* sv)
2151 Returns a boolean indicating whether the SV contains a double.
2160 Returns a boolean indicating whether the SV contains a double. Checks the
2161 B<private> setting. Use C<SvNOK>.
2170 Unsets the NV status of an SV.
2172 void SvNOK_off(SV* sv)
2179 Tells an SV that it is a double.
2181 void SvNOK_on(SV* sv)
2188 Tells an SV that it is a double and disables all other OK bits.
2190 void SvNOK_only(SV* sv)
2197 Coerce the given SV to a double and return it. See C<SvNVx> for a version
2198 which guarantees to evaluate sv only once.
2207 Coerces the given SV to a double and returns it. Guarantees to evaluate
2208 sv only once. Use the more efficent C<SvNV> otherwise.
2217 Returns the raw value in the SV's NV slot, without checks or conversions.
2218 Only use when you are sure SvNOK is true. See also C<SvNV()>.
2227 Returns a boolean indicating whether the value is an SV.
2236 Returns a boolean indicating whether the SvIVX is a valid offset value for
2237 the SvPVX. This hack is used internally to speed up removal of characters
2238 from the beginning of a SvPV. When SvOOK is true, then the start of the
2239 allocated string buffer is really (SvPVX - SvIVX).
2248 Returns a boolean indicating whether the SV contains a character
2258 Returns a boolean indicating whether the SV contains a character string.
2259 Checks the B<private> setting. Use C<SvPOK>.
2268 Unsets the PV status of an SV.
2270 void SvPOK_off(SV* sv)
2277 Tells an SV that it is a string.
2279 void SvPOK_on(SV* sv)
2286 Tells an SV that it is a string and disables all other OK bits.
2287 Will also turn off the UTF8 status.
2289 void SvPOK_only(SV* sv)
2294 =item SvPOK_only_UTF8
2296 Tells an SV that it is a string and disables all other OK bits,
2297 and leaves the UTF8 status as it was.
2299 void SvPOK_only_UTF8(SV* sv)
2306 Returns a pointer to the string in the SV, or a stringified form of the SV
2307 if the SV does not contain a string. Handles 'get' magic. See also
2308 C<SvPVx> for a version which guarantees to evaluate sv only once.
2310 char* SvPV(SV* sv, STRLEN len)
2317 Like C<SvPV>, but converts sv to byte representation first if necessary.
2319 char* SvPVbyte(SV* sv, STRLEN len)
2326 Like C<SvPV>, but converts sv to byte representation first if necessary.
2327 Guarantees to evalute sv only once; use the more efficient C<SvPVbyte>
2331 char* SvPVbytex(SV* sv, STRLEN len)
2336 =item SvPVbytex_force
2338 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
2339 Guarantees to evalute sv only once; use the more efficient C<SvPVbyte_force>
2342 char* SvPVbytex_force(SV* sv, STRLEN len)
2347 =item SvPVbyte_force
2349 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
2351 char* SvPVbyte_force(SV* sv, STRLEN len)
2356 =item SvPVbyte_nolen
2358 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
2360 char* SvPVbyte_nolen(SV* sv, STRLEN len)
2367 Like C<SvPV>, but converts sv to uft8 first if necessary.
2369 char* SvPVutf8(SV* sv, STRLEN len)
2376 Like C<SvPV>, but converts sv to uft8 first if necessary.
2377 Guarantees to evalute sv only once; use the more efficient C<SvPVutf8>
2380 char* SvPVutf8x(SV* sv, STRLEN len)
2385 =item SvPVutf8x_force
2387 Like C<SvPV_force>, but converts sv to uft8 first if necessary.
2388 Guarantees to evalute sv only once; use the more efficient C<SvPVutf8_force>
2391 char* SvPVutf8x_force(SV* sv, STRLEN len)
2396 =item SvPVutf8_force
2398 Like C<SvPV_force>, but converts sv to uft8 first if necessary.
2400 char* SvPVutf8_force(SV* sv, STRLEN len)
2405 =item SvPVutf8_nolen
2407 Like C<SvPV_nolen>, but converts sv to uft8 first if necessary.
2409 char* SvPVutf8_nolen(SV* sv, STRLEN len)
2416 A version of C<SvPV> which guarantees to evaluate sv only once.
2418 char* SvPVx(SV* sv, STRLEN len)
2425 Returns a pointer to the physical string in the SV. The SV must contain a
2435 Like <SvPV> but will force the SV into becoming a string (SvPOK). You want
2436 force if you are going to update the SvPVX directly.
2438 char* SvPV_force(SV* sv, STRLEN len)
2443 =item SvPV_force_nomg
2445 Like <SvPV> but will force the SV into becoming a string (SvPOK). You want
2446 force if you are going to update the SvPVX directly. Doesn't process magic.
2448 char* SvPV_force_nomg(SV* sv, STRLEN len)
2455 Returns a pointer to the string in the SV, or a stringified form of the SV
2456 if the SV does not contain a string. Handles 'get' magic.
2458 char* SvPV_nolen(SV* sv)
2465 Returns the value of the object's reference count.
2467 U32 SvREFCNT(SV* sv)
2474 Decrements the reference count of the given SV.
2476 void SvREFCNT_dec(SV* sv)
2483 Increments the reference count of the given SV.
2485 SV* SvREFCNT_inc(SV* sv)
2492 Tests if the SV is an RV.
2501 Unsets the RV status of an SV.
2503 void SvROK_off(SV* sv)
2510 Tells an SV that it is an RV.
2512 void SvROK_on(SV* sv)
2519 Dereferences an RV to return the SV.
2528 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
2529 argument more than once.
2531 void SvSETMAGIC(SV* sv)
2538 Like C<SvSetSV>, but does any set magic required afterwards.
2540 void SvSetMagicSV(SV* dsb, SV* ssv)
2545 =item SvSetMagicSV_nosteal
2547 Like C<SvSetMagicSV>, but does any set magic required afterwards.
2549 void SvSetMagicSV_nosteal(SV* dsv, SV* ssv)
2556 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
2559 void SvSetSV(SV* dsb, SV* ssv)
2564 =item SvSetSV_nosteal
2566 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
2567 ssv. May evaluate arguments more than once.
2569 void SvSetSV_nosteal(SV* dsv, SV* ssv)
2576 Returns the stash of the SV.
2585 Taints an SV if tainting is enabled
2587 void SvTAINT(SV* sv)
2594 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
2597 bool SvTAINTED(SV* sv)
2604 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
2605 some of Perl's fundamental security features. XS module authors should not
2606 use this function unless they fully understand all the implications of
2607 unconditionally untainting the value. Untainting should be done in the
2608 standard perl fashion, via a carefully crafted regexp, rather than directly
2609 untainting variables.
2611 void SvTAINTED_off(SV* sv)
2618 Marks an SV as tainted.
2620 void SvTAINTED_on(SV* sv)
2627 Returns a boolean indicating whether Perl would evaluate the SV as true or
2628 false, defined or undefined. Does not handle 'get' magic.
2637 Returns the type of the SV. See C<svtype>.
2639 svtype SvTYPE(SV* sv)
2646 An enum of flags for Perl types. These are found in the file B<sv.h>
2647 in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
2654 Integer type flag for scalars. See C<svtype>.
2661 Double type flag for scalars. See C<svtype>.
2668 Pointer type flag for scalars. See C<svtype>.
2675 Type flag for arrays. See C<svtype>.
2682 Type flag for code refs. See C<svtype>.
2689 Type flag for hashes. See C<svtype>.
2696 Type flag for blessed scalars. See C<svtype>.
2703 Returns a boolean indicating whether the SV contains an unsigned integer.
2712 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
2713 perform the upgrade if necessary. See C<svtype>.
2715 void SvUPGRADE(SV* sv, svtype type)
2722 Returns a boolean indicating whether the SV contains UTF-8 encoded data.
2731 Unsets the UTF8 status of an SV.
2733 void SvUTF8_off(SV *sv)
2740 Turn on the UTF8 status of an SV (the data is not changed, just the flag).
2741 Do not use frivolously.
2743 void SvUTF8_on(SV *sv)
2750 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
2751 for a version which guarantees to evaluate sv only once.
2760 Returns the raw value in the SV's UV slot, without checks or conversions.
2761 Only use when you are sure SvIOK is true. See also C<SvUV()>.
2770 Coerces the given SV to an unsigned integer and returns it. Guarantees to
2771 evaluate sv only once. Use the more efficent C<SvUV> otherwise.
2780 This function is only called on magical items, and is only used by
2781 sv_true() or its macro equivalent.
2783 bool sv_2bool(SV* sv)
2790 Using various gambits, try to get a CV from an SV; in addition, try if
2791 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
2793 CV* sv_2cv(SV* sv, HV** st, GV** gvp, I32 lref)
2800 Using various gambits, try to get an IO from an SV: the IO slot if its a
2801 GV; or the recursive result if we're an RV; or the IO slot of the symbol
2802 named after the PV if we're a string.
2811 Return the integer value of an SV, doing any necessary string conversion,
2812 magic etc. Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2821 Marks an existing SV as mortal. The SV will be destroyed when the current
2822 context ends. See also C<sv_newmortal> and C<sv_mortalcopy>.
2824 SV* sv_2mortal(SV* sv)
2831 Return the num value of an SV, doing any necessary string or integer
2832 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2840 =item sv_2pvbyte_nolen
2842 Return a pointer to the byte-encoded representation of the SV.
2843 May cause the SV to be downgraded from UTF8 as a side-effect.
2845 Usually accessed via the C<SvPVbyte_nolen> macro.
2847 char* sv_2pvbyte_nolen(SV* sv)
2852 =item sv_2pvutf8_nolen
2854 Return a pointer to the UTF8-encoded representation of the SV.
2855 May cause the SV to be upgraded to UTF8 as a side-effect.
2857 Usually accessed via the C<SvPVutf8_nolen> macro.
2859 char* sv_2pvutf8_nolen(SV* sv)
2866 Returns pointer to the string value of an SV, and sets *lp to its length.
2867 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2869 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2870 usually end up here too.
2872 char* sv_2pv_flags(SV* sv, STRLEN* lp, I32 flags)
2879 Like C<sv_2pv()>, but doesn't return the length too. You should usually
2880 use the macro wrapper C<SvPV_nolen(sv)> instead.
2881 char* sv_2pv_nolen(SV* sv)
2888 Return the unsigned integer value of an SV, doing any necessary string
2889 conversion, magic etc. Normally used via the C<SvUV(sv)> and C<SvUVx(sv)>
2899 Remove any string offset. You should normally use the C<SvOOK_off> macro
2902 int sv_backoff(SV* sv)
2909 Blesses an SV into a specified package. The SV must be an RV. The package
2910 must be designated by its stash (see C<gv_stashpv()>). The reference count
2911 of the SV is unaffected.
2913 SV* sv_bless(SV* sv, HV* stash)
2920 Concatenates the string onto the end of the string which is in the SV.
2921 If the SV has the UTF8 status set, then the bytes appended should be
2922 valid UTF8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
2924 void sv_catpv(SV* sv, const char* ptr)
2931 Processes its arguments like C<sprintf> and appends the formatted
2932 output to an SV. If the appended data contains "wide" characters
2933 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
2934 and characters >255 formatted with %c), the original SV might get
2935 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic.
2936 C<SvSETMAGIC()> must typically be called after calling this function
2937 to handle 'set' magic.
2939 void sv_catpvf(SV* sv, const char* pat, ...)
2946 Like C<sv_catpvf>, but also handles 'set' magic.
2948 void sv_catpvf_mg(SV *sv, const char* pat, ...)
2955 Concatenates the string onto the end of the string which is in the SV. The
2956 C<len> indicates number of bytes to copy. If the SV has the UTF8
2957 status set, then the bytes appended should be valid UTF8.
2958 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
2960 void sv_catpvn(SV* sv, const char* ptr, STRLEN len)
2965 =item sv_catpvn_flags
2967 Concatenates the string onto the end of the string which is in the SV. The
2968 C<len> indicates number of bytes to copy. If the SV has the UTF8
2969 status set, then the bytes appended should be valid UTF8.
2970 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
2971 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
2972 in terms of this function.
2974 void sv_catpvn_flags(SV* sv, const char* ptr, STRLEN len, I32 flags)
2981 Like C<sv_catpvn>, but also handles 'set' magic.
2983 void sv_catpvn_mg(SV *sv, const char *ptr, STRLEN len)
2990 Like C<sv_catpv>, but also handles 'set' magic.
2992 void sv_catpv_mg(SV *sv, const char *ptr)
2999 Concatenates the string from SV C<ssv> onto the end of the string in
3000 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
3001 not 'set' magic. See C<sv_catsv_mg>.
3003 void sv_catsv(SV* dsv, SV* ssv)
3008 =item sv_catsv_flags
3010 Concatenates the string from SV C<ssv> onto the end of the string in
3011 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
3012 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
3013 and C<sv_catsv_nomg> are implemented in terms of this function.
3015 void sv_catsv_flags(SV* dsv, SV* ssv, I32 flags)
3022 Like C<sv_catsv>, but also handles 'set' magic.
3024 void sv_catsv_mg(SV *dstr, SV *sstr)
3031 Efficient removal of characters from the beginning of the string buffer.
3032 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
3033 the string buffer. The C<ptr> becomes the first character of the adjusted
3034 string. Uses the "OOK hack".
3036 void sv_chop(SV* sv, char* ptr)
3043 Clear an SV: call any destructors, free up any memory used by the body,
3044 and free the body itself. The SV's head is I<not> freed, although
3045 its type is set to all 1's so that it won't inadvertently be assumed
3046 to be live during global destruction etc.
3047 This function should only be called when REFCNT is zero. Most of the time
3048 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
3051 void sv_clear(SV* sv)
3058 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
3059 string in C<sv1> is less than, equal to, or greater than the string in
3060 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
3061 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
3063 I32 sv_cmp(SV* sv1, SV* sv2)
3070 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
3071 'use bytes' aware, handles get magic, and will coerce its args to strings
3072 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
3074 I32 sv_cmp_locale(SV* sv1, SV* sv2)
3081 Add Collate Transform magic to an SV if it doesn't already have it.
3083 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
3084 scalar data of the variable, but transformed to such a format that a normal
3085 memory comparison can be used to compare the data according to the locale
3088 char* sv_collxfrm(SV* sv, STRLEN* nxp)
3095 Auto-decrement of the value in the SV, doing string to numeric conversion
3096 if necessary. Handles 'get' magic.
3103 =item sv_derived_from
3105 Returns a boolean indicating whether the SV is derived from the specified
3106 class. This is the function that implements C<UNIVERSAL::isa>. It works
3107 for class names as well as for objects.
3109 bool sv_derived_from(SV* sv, const char* name)
3112 Found in file universal.c
3116 Returns a boolean indicating whether the strings in the two SVs are
3117 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
3118 coerce its args to strings if necessary.
3120 I32 sv_eq(SV* sv1, SV* sv2)
3125 =item sv_force_normal
3127 Undo various types of fakery on an SV: if the PV is a shared string, make
3128 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3129 an xpvmg. See also C<sv_force_normal_flags>.
3131 void sv_force_normal(SV *sv)
3136 =item sv_force_normal_flags
3138 Undo various types of fakery on an SV: if the PV is a shared string, make
3139 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3140 an xpvmg. The C<flags> parameter gets passed to C<sv_unref_flags()>
3141 when unrefing. C<sv_force_normal> calls this function with flags set to 0.
3143 void sv_force_normal_flags(SV *sv, U32 flags)
3150 Decrement an SV's reference count, and if it drops to zero, call
3151 C<sv_clear> to invoke destructors and free up any memory used by
3152 the body; finally, deallocate the SV's head itself.
3153 Normally called via a wrapper macro C<SvREFCNT_dec>.
3155 void sv_free(SV* sv)
3162 Fill the sv with current working directory
3164 int sv_getcwd(SV* sv)
3167 Found in file util.c
3171 Get a line from the filehandle and store it into the SV, optionally
3172 appending to the currently-stored string.
3174 char* sv_gets(SV* sv, PerlIO* fp, I32 append)
3181 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
3182 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
3183 Use the C<SvGROW> wrapper instead.
3185 char* sv_grow(SV* sv, STRLEN newlen)
3192 Auto-increment of the value in the SV, doing string to numeric conversion
3193 if necessary. Handles 'get' magic.
3202 Inserts a string at the specified offset/length within the SV. Similar to
3203 the Perl substr() function.
3205 void sv_insert(SV* bigsv, STRLEN offset, STRLEN len, char* little, STRLEN littlelen)
3212 Returns a boolean indicating whether the SV is blessed into the specified
3213 class. This does not check for subtypes; use C<sv_derived_from> to verify
3214 an inheritance relationship.
3216 int sv_isa(SV* sv, const char* name)
3223 Returns a boolean indicating whether the SV is an RV pointing to a blessed
3224 object. If the SV is not an RV, or if the object is not blessed, then this
3227 int sv_isobject(SV* sv)
3234 A private implementation of the C<SvIVx> macro for compilers which can't
3235 cope with complex macro expressions. Always use the macro instead.
3244 Returns the length of the string in the SV. Handles magic and type
3245 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
3247 STRLEN sv_len(SV* sv)
3254 Returns the number of characters in the string in an SV, counting wide
3255 UTF8 bytes as a single character. Handles magic and type coercion.
3257 STRLEN sv_len_utf8(SV* sv)
3264 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
3265 then adds a new magic item of type C<how> to the head of the magic list.
3267 C<name> is assumed to contain an C<SV*> if C<(name && namelen == HEf_SVKEY)>
3269 void sv_magic(SV* sv, SV* obj, int how, const char* name, I32 namlen)
3276 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
3277 The new SV is marked as mortal. It will be destroyed when the current
3278 context ends. See also C<sv_newmortal> and C<sv_2mortal>.
3280 SV* sv_mortalcopy(SV* oldsv)
3287 Creates a new null SV which is mortal. The reference count of the SV is
3288 set to 1. It will be destroyed when the current context ends. See
3289 also C<sv_mortalcopy> and C<sv_2mortal>.
3298 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
3301 SV* sv_newref(SV* sv)
3308 A private implementation of the C<SvNVx> macro for compilers which can't
3309 cope with complex macro expressions. Always use the macro instead.
3318 Converts the value pointed to by offsetp from a count of bytes from the
3319 start of the string, to a count of the equivalent number of UTF8 chars.
3320 Handles magic and type coercion.
3322 void sv_pos_b2u(SV* sv, I32* offsetp)
3329 Converts the value pointed to by offsetp from a count of UTF8 chars from
3330 the start of the string, to a count of the equivalent number of bytes; if
3331 lenp is non-zero, it does the same to lenp, but this time starting from
3332 the offset, rather than from the start of the string. Handles magic and
3335 void sv_pos_u2b(SV* sv, I32* offsetp, I32* lenp)
3342 A private implementation of the C<SvPVbyte_nolen> macro for compilers
3343 which can't cope with complex macro expressions. Always use the macro
3346 char* sv_pvbyte(SV *sv)
3353 A private implementation of the C<SvPVbyte> macro for compilers
3354 which can't cope with complex macro expressions. Always use the macro
3357 char* sv_pvbyten(SV *sv, STRLEN *len)
3362 =item sv_pvbyten_force
3364 A private implementation of the C<SvPVbytex_force> macro for compilers
3365 which can't cope with complex macro expressions. Always use the macro
3368 char* sv_pvbyten_force(SV* sv, STRLEN* lp)
3375 Get a sensible string out of the SV somehow.
3376 A private implementation of the C<SvPV_force> macro for compilers which
3377 can't cope with complex macro expressions. Always use the macro instead.
3379 char* sv_pvn_force(SV* sv, STRLEN* lp)
3384 =item sv_pvn_force_flags
3386 Get a sensible string out of the SV somehow.
3387 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
3388 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
3389 implemented in terms of this function.
3390 You normally want to use the various wrapper macros instead: see
3391 C<SvPV_force> and C<SvPV_force_nomg>
3393 char* sv_pvn_force_flags(SV* sv, STRLEN* lp, I32 flags)
3400 A private implementation of the C<SvPVutf8_nolen> macro for compilers
3401 which can't cope with complex macro expressions. Always use the macro
3404 char* sv_pvutf8(SV *sv)
3411 A private implementation of the C<SvPVutf8> macro for compilers
3412 which can't cope with complex macro expressions. Always use the macro
3415 char* sv_pvutf8n(SV *sv, STRLEN *len)
3420 =item sv_pvutf8n_force
3422 A private implementation of the C<SvPVutf8_force> macro for compilers
3423 which can't cope with complex macro expressions. Always use the macro
3426 char* sv_pvutf8n_force(SV* sv, STRLEN* lp)
3433 Wrap or emulate realpath(3).
3435 int sv_realpath(SV* sv, char *path, STRLEN len)
3438 Found in file util.c
3442 Returns a string describing what the SV is a reference to.
3444 char* sv_reftype(SV* sv, int ob)
3451 Make the first argument a copy of the second, then delete the original.
3452 The target SV physically takes over ownership of the body of the source SV
3453 and inherits its flags; however, the target keeps any magic it owns,
3454 and any magic in the source is discarded.
3455 Note that this a rather specialist SV copying operation; most of the
3456 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
3458 void sv_replace(SV* sv, SV* nsv)
3463 =item sv_report_used
3465 Dump the contents of all SVs not yet freed. (Debugging aid).
3467 void sv_report_used()
3474 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
3475 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
3476 push a back-reference to this RV onto the array of backreferences
3477 associated with that magic.
3479 SV* sv_rvweaken(SV *sv)
3486 Copies an integer into the given SV, upgrading first if necessary.
3487 Does not handle 'set' magic. See also C<sv_setiv_mg>.
3489 void sv_setiv(SV* sv, IV num)
3496 Like C<sv_setiv>, but also handles 'set' magic.
3498 void sv_setiv_mg(SV *sv, IV i)
3505 Copies a double into the given SV, upgrading first if necessary.
3506 Does not handle 'set' magic. See also C<sv_setnv_mg>.
3508 void sv_setnv(SV* sv, NV num)
3515 Like C<sv_setnv>, but also handles 'set' magic.
3517 void sv_setnv_mg(SV *sv, NV num)
3524 Copies a string into an SV. The string must be null-terminated. Does not
3525 handle 'set' magic. See C<sv_setpv_mg>.
3527 void sv_setpv(SV* sv, const char* ptr)
3534 Processes its arguments like C<sprintf> and sets an SV to the formatted
3535 output. Does not handle 'set' magic. See C<sv_setpvf_mg>.
3537 void sv_setpvf(SV* sv, const char* pat, ...)
3544 Like C<sv_setpvf>, but also handles 'set' magic.
3546 void sv_setpvf_mg(SV *sv, const char* pat, ...)
3553 Copies an integer into the given SV, also updating its string value.
3554 Does not handle 'set' magic. See C<sv_setpviv_mg>.
3556 void sv_setpviv(SV* sv, IV num)
3563 Like C<sv_setpviv>, but also handles 'set' magic.
3565 void sv_setpviv_mg(SV *sv, IV iv)
3572 Copies a string into an SV. The C<len> parameter indicates the number of
3573 bytes to be copied. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3575 void sv_setpvn(SV* sv, const char* ptr, STRLEN len)
3582 Like C<sv_setpvn>, but also handles 'set' magic.
3584 void sv_setpvn_mg(SV *sv, const char *ptr, STRLEN len)
3591 Like C<sv_setpv>, but also handles 'set' magic.
3593 void sv_setpv_mg(SV *sv, const char *ptr)
3600 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
3601 argument will be upgraded to an RV. That RV will be modified to point to
3602 the new SV. The C<classname> argument indicates the package for the
3603 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
3604 will be returned and will have a reference count of 1.
3606 SV* sv_setref_iv(SV* rv, const char* classname, IV iv)
3613 Copies a double into a new SV, optionally blessing the SV. The C<rv>
3614 argument will be upgraded to an RV. That RV will be modified to point to
3615 the new SV. The C<classname> argument indicates the package for the
3616 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
3617 will be returned and will have a reference count of 1.
3619 SV* sv_setref_nv(SV* rv, const char* classname, NV nv)
3626 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
3627 argument will be upgraded to an RV. That RV will be modified to point to
3628 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
3629 into the SV. The C<classname> argument indicates the package for the
3630 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
3631 will be returned and will have a reference count of 1.
3633 Do not use with other Perl types such as HV, AV, SV, CV, because those
3634 objects will become corrupted by the pointer copy process.
3636 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
3638 SV* sv_setref_pv(SV* rv, const char* classname, void* pv)
3645 Copies a string into a new SV, optionally blessing the SV. The length of the
3646 string must be specified with C<n>. The C<rv> argument will be upgraded to
3647 an RV. That RV will be modified to point to the new SV. The C<classname>
3648 argument indicates the package for the blessing. Set C<classname> to
3649 C<Nullch> to avoid the blessing. The new SV will be returned and will have
3650 a reference count of 1.
3652 Note that C<sv_setref_pv> copies the pointer while this copies the string.
3654 SV* sv_setref_pvn(SV* rv, const char* classname, char* pv, STRLEN n)
3661 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
3662 argument will be upgraded to an RV. That RV will be modified to point to
3663 the new SV. The C<classname> argument indicates the package for the
3664 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
3665 will be returned and will have a reference count of 1.
3667 SV* sv_setref_uv(SV* rv, const char* classname, UV uv)
3674 Copies the contents of the source SV C<ssv> into the destination SV
3675 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3676 function if the source SV needs to be reused. Does not handle 'set' magic.
3677 Loosely speaking, it performs a copy-by-value, obliterating any previous
3678 content of the destination.
3680 You probably want to use one of the assortment of wrappers, such as
3681 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3682 C<SvSetMagicSV_nosteal>.
3685 void sv_setsv(SV* dsv, SV* ssv)
3690 =item sv_setsv_flags
3692 Copies the contents of the source SV C<ssv> into the destination SV
3693 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3694 function if the source SV needs to be reused. Does not handle 'set' magic.
3695 Loosely speaking, it performs a copy-by-value, obliterating any previous
3696 content of the destination.
3697 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3698 C<ssv> if appropriate, else not. C<sv_setsv> and C<sv_setsv_nomg> are
3699 implemented in terms of this function.
3701 You probably want to use one of the assortment of wrappers, such as
3702 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3703 C<SvSetMagicSV_nosteal>.
3705 This is the primary function for copying scalars, and most other
3706 copy-ish functions and macros use this underneath.
3708 void sv_setsv_flags(SV* dsv, SV* ssv, I32 flags)
3715 Like C<sv_setsv>, but also handles 'set' magic.
3717 void sv_setsv_mg(SV *dstr, SV *sstr)
3724 Copies an unsigned integer into the given SV, upgrading first if necessary.
3725 Does not handle 'set' magic. See also C<sv_setuv_mg>.
3727 void sv_setuv(SV* sv, UV num)
3734 Like C<sv_setuv>, but also handles 'set' magic.
3736 void sv_setuv_mg(SV *sv, UV u)
3743 Taint an SV. Use C<SvTAINTED_on> instead.
3744 void sv_taint(SV* sv)
3751 Returns true if the SV has a true value by Perl's rules.
3752 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
3753 instead use an in-line version.
3762 Removes all magic of type C<type> from an SV.
3764 int sv_unmagic(SV* sv, int type)
3771 Unsets the RV status of the SV, and decrements the reference count of
3772 whatever was being referenced by the RV. This can almost be thought of
3773 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
3774 being zero. See C<SvROK_off>.
3776 void sv_unref(SV* sv)
3781 =item sv_unref_flags
3783 Unsets the RV status of the SV, and decrements the reference count of
3784 whatever was being referenced by the RV. This can almost be thought of
3785 as a reversal of C<newSVrv>. The C<cflags> argument can contain
3786 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
3787 (otherwise the decrementing is conditional on the reference count being
3788 different from one or the reference being a readonly SV).
3791 void sv_unref_flags(SV* sv, U32 flags)
3798 Upgrade an SV to a more complex form. Gnenerally adds a new body type to the
3799 SV, then copies across as much information as possible from the old body.
3800 You genrally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
3802 bool sv_upgrade(SV* sv, U32 mt)
3809 Tells an SV to use C<ptr> to find its string value. Normally the string is
3810 stored inside the SV but sv_usepvn allows the SV to use an outside string.
3811 The C<ptr> should point to memory that was allocated by C<malloc>. The
3812 string length, C<len>, must be supplied. This function will realloc the
3813 memory pointed to by C<ptr>, so that pointer should not be freed or used by
3814 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
3815 See C<sv_usepvn_mg>.
3817 void sv_usepvn(SV* sv, char* ptr, STRLEN len)
3824 Like C<sv_usepvn>, but also handles 'set' magic.
3826 void sv_usepvn_mg(SV *sv, char *ptr, STRLEN len)
3831 =item sv_utf8_decode
3833 Convert the octets in the PV from UTF-8 to chars. Scan for validity and then
3834 turn off SvUTF8 if needed so that we see characters. Used as a building block
3835 for decode_utf8 in Encode.xs
3837 NOTE: this function is experimental and may change or be
3838 removed without notice.
3840 bool sv_utf8_decode(SV *sv)
3845 =item sv_utf8_downgrade
3847 Attempt to convert the PV of an SV from UTF8-encoded to byte encoding.
3848 This may not be possible if the PV contains non-byte encoding characters;
3849 if this is the case, either returns false or, if C<fail_ok> is not
3852 NOTE: this function is experimental and may change or be
3853 removed without notice.
3855 bool sv_utf8_downgrade(SV *sv, bool fail_ok)
3860 =item sv_utf8_encode
3862 Convert the PV of an SV to UTF8-encoded, but then turn off the C<SvUTF8>
3863 flag so that it looks like octets again. Used as a building block
3864 for encode_utf8 in Encode.xs
3866 void sv_utf8_encode(SV *sv)
3871 =item sv_utf8_upgrade
3873 Convert the PV of an SV to its UTF8-encoded form.
3874 Forces the SV to string form if it is not already.
3875 Always sets the SvUTF8 flag to avoid future validity checks even
3876 if all the bytes have hibit clear.
3878 STRLEN sv_utf8_upgrade(SV *sv)
3883 =item sv_utf8_upgrade_flags
3885 Convert the PV of an SV to its UTF8-encoded form.
3886 Forces the SV to string form if it is not already.
3887 Always sets the SvUTF8 flag to avoid future validity checks even
3888 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
3889 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
3890 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3892 STRLEN sv_utf8_upgrade_flags(SV *sv, I32 flags)
3899 A private implementation of the C<SvUVx> macro for compilers which can't
3900 cope with complex macro expressions. Always use the macro instead.
3909 Processes its arguments like C<vsprintf> and appends the formatted output
3910 to an SV. Uses an array of SVs if the C style variable argument list is
3911 missing (NULL). When running with taint checks enabled, indicates via
3912 C<maybe_tainted> if results are untrustworthy (often due to the use of
3915 Usually used via one of its frontends C<sv_catpvf> and C<sv_catpvf_mg>.
3917 void sv_vcatpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
3924 Works like C<vcatpvfn> but copies the text into the SV instead of
3927 Usually used via one of its frontends C<sv_setpvf> and C<sv_setpvf_mg>.
3929 void sv_vsetpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
3936 Variable which is setup by C<xsubpp> to designate the object in a C++
3937 XSUB. This is always the proper type for the C++ object. See C<CLASS> and
3938 L<perlxs/"Using XS With C++">.
3943 Found in file XSUB.h
3947 Converts the specified character to lowercase.
3949 char toLOWER(char ch)
3952 Found in file handy.h
3956 Converts the specified character to uppercase.
3958 char toUPPER(char ch)
3961 Found in file handy.h
3963 =item utf8n_to_uvchr
3965 Returns the native character value of the first character in the string C<s>
3966 which is assumed to be in UTF8 encoding; C<retlen> will be set to the
3967 length, in bytes, of that character.
3969 Allows length and flags to be passed to low level routine.
3971 UV utf8n_to_uvchr(U8 *s, STRLEN curlen, STRLEN* retlen, U32 flags)
3974 Found in file utf8.c
3976 =item utf8n_to_uvuni
3978 Bottom level UTF-8 decode routine.
3979 Returns the unicode code point value of the first character in the string C<s>
3980 which is assumed to be in UTF8 encoding and no longer than C<curlen>;
3981 C<retlen> will be set to the length, in bytes, of that character.
3983 If C<s> does not point to a well-formed UTF8 character, the behaviour
3984 is dependent on the value of C<flags>: if it contains UTF8_CHECK_ONLY,
3985 it is assumed that the caller will raise a warning, and this function
3986 will silently just set C<retlen> to C<-1> and return zero. If the
3987 C<flags> does not contain UTF8_CHECK_ONLY, warnings about
3988 malformations will be given, C<retlen> will be set to the expected
3989 length of the UTF-8 character in bytes, and zero will be returned.
3991 The C<flags> can also contain various flags to allow deviations from
3992 the strict UTF-8 encoding (see F<utf8.h>).
3994 Most code should use utf8_to_uvchr() rather than call this directly.
3996 UV utf8n_to_uvuni(U8 *s, STRLEN curlen, STRLEN* retlen, U32 flags)
3999 Found in file utf8.c
4003 Returns the number of UTF8 characters between the UTF-8 pointers C<a>
4006 WARNING: use only if you *know* that the pointers point inside the
4009 IV utf8_distance(U8 *a, U8 *b)
4012 Found in file utf8.c
4016 Return the UTF-8 pointer C<s> displaced by C<off> characters, either
4017 forward or backward.
4019 WARNING: do not use the following unless you *know* C<off> is within
4020 the UTF-8 data pointed to by C<s> *and* that on entry C<s> is aligned
4021 on the first byte of character or just after the last byte of a character.
4023 U8* utf8_hop(U8 *s, I32 off)
4026 Found in file utf8.c
4030 Return the length of the UTF-8 char encoded string C<s> in characters.
4031 Stops at C<e> (inclusive). If C<e E<lt> s> or if the scan would end
4032 up past C<e>, croaks.
4034 STRLEN utf8_length(U8* s, U8 *e)
4037 Found in file utf8.c
4041 Converts a string C<s> of length C<len> from UTF8 into byte encoding.
4042 Unlike C<bytes_to_utf8>, this over-writes the original string, and
4043 updates len to contain the new length.
4044 Returns zero on failure, setting C<len> to -1.
4046 NOTE: this function is experimental and may change or be
4047 removed without notice.
4049 U8* utf8_to_bytes(U8 *s, STRLEN *len)
4052 Found in file utf8.c
4056 Returns the native character value of the first character in the string C<s>
4057 which is assumed to be in UTF8 encoding; C<retlen> will be set to the
4058 length, in bytes, of that character.
4060 If C<s> does not point to a well-formed UTF8 character, zero is
4061 returned and retlen is set, if possible, to -1.
4063 UV utf8_to_uvchr(U8 *s, STRLEN* retlen)
4066 Found in file utf8.c
4070 Returns the Unicode code point of the first character in the string C<s>
4071 which is assumed to be in UTF8 encoding; C<retlen> will be set to the
4072 length, in bytes, of that character.
4074 This function should only be used when returned UV is considered
4075 an index into the Unicode semantic tables (e.g. swashes).
4077 If C<s> does not point to a well-formed UTF8 character, zero is
4078 returned and retlen is set, if possible, to -1.
4080 UV utf8_to_uvuni(U8 *s, STRLEN* retlen)
4083 Found in file utf8.c
4087 Adds the UTF8 representation of the Native codepoint C<uv> to the end
4088 of the string C<d>; C<d> should be have at least C<UTF8_MAXLEN+1> free
4089 bytes available. The return value is the pointer to the byte after the
4090 end of the new character. In other words,
4092 d = uvchr_to_utf8(d, uv);
4094 is the recommended wide native character-aware way of saying
4098 U8* uvchr_to_utf8(U8 *d, UV uv)
4101 Found in file utf8.c
4105 Adds the UTF8 representation of the Unicode codepoint C<uv> to the end
4106 of the string C<d>; C<d> should be have at least C<UTF8_MAXLEN+1> free
4107 bytes available. The return value is the pointer to the byte after the
4108 end of the new character. In other words,
4110 d = uvuni_to_utf8(d, uv);
4112 is the recommended Unicode-aware way of saying
4116 U8* uvuni_to_utf8(U8 *d, UV uv)
4119 Found in file utf8.c
4123 This is the XSUB-writer's interface to Perl's C<warn> function. Use this
4124 function the same way you use the C C<printf> function. See
4127 void warn(const char* pat, ...)
4130 Found in file util.c
4134 Push an integer onto the stack, extending the stack if necessary. Handles
4135 'set' magic. See C<PUSHi>.
4144 Push a double onto the stack, extending the stack if necessary. Handles
4145 'set' magic. See C<PUSHn>.
4154 Push a string onto the stack, extending the stack if necessary. The C<len>
4155 indicates the length of the string. Handles 'set' magic. See
4158 void XPUSHp(char* str, STRLEN len)
4165 Push an SV onto the stack, extending the stack if necessary. Does not
4166 handle 'set' magic. See C<PUSHs>.
4175 Push an unsigned integer onto the stack, extending the stack if necessary.
4185 Macro to declare an XSUB and its C parameter list. This is handled by
4189 Found in file XSUB.h
4193 Return from XSUB, indicating number of items on the stack. This is usually
4194 handled by C<xsubpp>.
4196 void XSRETURN(int nitems)
4199 Found in file XSUB.h
4201 =item XSRETURN_EMPTY
4203 Return an empty list from an XSUB immediately.
4208 Found in file XSUB.h
4212 Return an integer from an XSUB immediately. Uses C<XST_mIV>.
4214 void XSRETURN_IV(IV iv)
4217 Found in file XSUB.h
4221 Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
4226 Found in file XSUB.h
4230 Return an double from an XSUB immediately. Uses C<XST_mNV>.
4232 void XSRETURN_NV(NV nv)
4235 Found in file XSUB.h
4239 Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
4241 void XSRETURN_PV(char* str)
4244 Found in file XSUB.h
4246 =item XSRETURN_UNDEF
4248 Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
4253 Found in file XSUB.h
4257 Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
4262 Found in file XSUB.h
4266 Place an integer into the specified position C<pos> on the stack. The
4267 value is stored in a new mortal SV.
4269 void XST_mIV(int pos, IV iv)
4272 Found in file XSUB.h
4276 Place C<&PL_sv_no> into the specified position C<pos> on the
4279 void XST_mNO(int pos)
4282 Found in file XSUB.h
4286 Place a double into the specified position C<pos> on the stack. The value
4287 is stored in a new mortal SV.
4289 void XST_mNV(int pos, NV nv)
4292 Found in file XSUB.h
4296 Place a copy of a string into the specified position C<pos> on the stack.
4297 The value is stored in a new mortal SV.
4299 void XST_mPV(int pos, char* str)
4302 Found in file XSUB.h
4306 Place C<&PL_sv_undef> into the specified position C<pos> on the
4309 void XST_mUNDEF(int pos)
4312 Found in file XSUB.h
4316 Place C<&PL_sv_yes> into the specified position C<pos> on the
4319 void XST_mYES(int pos)
4322 Found in file XSUB.h
4326 The version identifier for an XS module. This is usually
4327 handled automatically by C<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>.
4330 Found in file XSUB.h
4332 =item XS_VERSION_BOOTCHECK
4334 Macro to verify that a PM module's $VERSION variable matches the XS
4335 module's C<XS_VERSION> variable. This is usually handled automatically by
4336 C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">.
4338 XS_VERSION_BOOTCHECK;
4341 Found in file XSUB.h
4345 The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the
4346 destination, C<nitems> is the number of items, and C<type> is the type.
4348 void Zero(void* dest, int nitems, type)
4351 Found in file handy.h
4357 Until May 1997, this document was maintained by Jeff Okamoto
4358 <okamoto@corp.hp.com>. It is now maintained as part of Perl itself.
4360 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
4361 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
4362 Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
4363 Stephen McCamant, and Gurusamy Sarathy.
4365 API Listing originally by Dean Roehrich <roehrich@cray.com>.
4367 Updated to be autogenerated from comments in the source by Benjamin Stuhl.
4371 perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
projects / p5sagit/p5-mst-13.2.git / blob