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 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
1329 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
1332 SV* newSV(STRLEN len)
1339 Creates a new SV. A non-zero C<len> parameter indicates the number of
1340 bytes of preallocated string space the SV should have. An extra byte for a
1341 tailing NUL is also reserved. (SvPOK is not set for the SV even if string
1342 space is allocated.) The reference count for the new SV is set to 1.
1343 C<id> is an integer id between 0 and 1299 (used to identify leaks).
1345 SV* NEWSV(int id, STRLEN len)
1348 Found in file handy.h
1352 Creates a new SV and copies an integer into it. The reference count for the
1362 Creates a new SV and copies a floating point value into it.
1363 The reference count for the SV is set to 1.
1372 Creates a new SV and copies a string into it. The reference count for the
1373 SV is set to 1. If C<len> is zero, Perl will compute the length using
1374 strlen(). For efficiency, consider using C<newSVpvn> instead.
1376 SV* newSVpv(const char* s, STRLEN len)
1383 Creates a new SV and initializes it with the string formatted like
1386 SV* newSVpvf(const char* pat, ...)
1393 Creates a new SV and copies a string into it. The reference count for the
1394 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
1395 string. You are responsible for ensuring that the source string is at least
1398 SV* newSVpvn(const char* s, STRLEN len)
1403 =item newSVpvn_share
1405 Creates a new SV with its SvPVX pointing to a shared string in the string
1406 table. If the string does not already exist in the table, it is created
1407 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
1408 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
1409 otherwise the hash is computed. The idea here is that as the string table
1410 is used for shared hash keys these strings will have SvPVX == HeKEY and
1411 hash lookup will avoid string compare.
1413 SV* newSVpvn_share(const char* s, I32 len, U32 hash)
1420 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
1421 it will be upgraded to one. If C<classname> is non-null then the new SV will
1422 be blessed in the specified package. The new SV is returned and its
1423 reference count is 1.
1425 SV* newSVrv(SV* rv, const char* classname)
1432 Creates a new SV which is an exact duplicate of the original SV.
1435 SV* newSVsv(SV* old)
1442 Creates a new SV and copies an unsigned integer into it.
1443 The reference count for the SV is set to 1.
1452 Used by C<xsubpp> to hook up XSUBs as Perl subs.
1459 Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
1463 Found in file XSUB.h
1467 The XSUB-writer's interface to the C C<malloc> function. The allocated
1468 memory is zeroed with C<memzero>.
1470 void Newz(int id, void* ptr, int nitems, type)
1473 Found in file handy.h
1484 Null character pointer.
1487 Found in file handy.h
1508 Found in file handy.h
1512 The original stack mark for the XSUB. See C<dORIGMARK>.
1519 Allocates a new Perl interpreter. See L<perlembed>.
1521 PerlInterpreter* perl_alloc()
1524 Found in file perl.c
1528 Create and return a new interpreter by cloning the current one.
1530 PerlInterpreter* perl_clone(PerlInterpreter* interp, UV flags)
1535 =item perl_construct
1537 Initializes a new Perl interpreter. See L<perlembed>.
1539 void perl_construct(PerlInterpreter* interp)
1542 Found in file perl.c
1546 Shuts down a Perl interpreter. See L<perlembed>.
1548 void perl_destruct(PerlInterpreter* interp)
1551 Found in file perl.c
1555 Releases a Perl interpreter. See L<perlembed>.
1557 void perl_free(PerlInterpreter* interp)
1560 Found in file perl.c
1564 Tells a Perl interpreter to parse a Perl script. See L<perlembed>.
1566 int perl_parse(PerlInterpreter* interp, XSINIT_t xsinit, int argc, char** argv, char** env)
1569 Found in file perl.c
1573 Tells a Perl interpreter to run. See L<perlembed>.
1575 int perl_run(PerlInterpreter* interp)
1578 Found in file perl.c
1582 C<PL_modglobal> is a general purpose, interpreter global HV for use by
1583 extensions that need to keep information on a per-interpreter basis.
1584 In a pinch, it can also be used as a symbol table for extensions
1585 to share data among each other. It is a good idea to use keys
1586 prefixed by the package name of the extension that owns the data.
1591 Found in file intrpvar.h
1595 A convenience variable which is typically used with C<SvPV> when one
1596 doesn't care about the length of the string. It is usually more efficient
1597 to either declare a local variable and use that instead or to use the
1598 C<SvPV_nolen> macro.
1603 Found in file thrdvar.h
1607 This is the C<false> SV. See C<PL_sv_yes>. Always refer to this as
1613 Found in file intrpvar.h
1617 This is the C<undef> SV. Always refer to this as C<&PL_sv_undef>.
1622 Found in file intrpvar.h
1626 This is the C<true> SV. See C<PL_sv_no>. Always refer to this as
1632 Found in file intrpvar.h
1636 Pops an integer off the stack.
1645 Pops a long off the stack.
1654 Pops a double off the stack.
1663 Pops a string off the stack. Deprecated. New code should provide
1664 a STRLEN n_a and use POPpx.
1673 Pops a string off the stack which must consist of bytes i.e. characters < 256.
1674 Requires a variable STRLEN n_a in scope.
1683 Pops a string off the stack.
1684 Requires a variable STRLEN n_a in scope.
1693 Pops an SV off the stack.
1702 Push an integer onto the stack. The stack must have room for this element.
1703 Handles 'set' magic. See C<XPUSHi>.
1712 Opening bracket for arguments on a callback. See C<PUTBACK> and
1722 Push a double onto the stack. The stack must have room for this element.
1723 Handles 'set' magic. See C<XPUSHn>.
1732 Push a string onto the stack. The stack must have room for this element.
1733 The C<len> indicates the length of the string. Handles 'set' magic. See
1736 void PUSHp(char* str, STRLEN len)
1743 Push an SV onto the stack. The stack must have room for this element.
1744 Does not handle 'set' magic. See C<XPUSHs>.
1753 Push an unsigned integer onto the stack. The stack must have room for this
1754 element. See C<XPUSHu>.
1763 Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
1764 See C<PUSHMARK> and L<perlcall> for other uses.
1773 The XSUB-writer's interface to the C C<realloc> function.
1775 void Renew(void* ptr, int nitems, type)
1778 Found in file handy.h
1782 The XSUB-writer's interface to the C C<realloc> function, with
1785 void Renewc(void* ptr, int nitems, type, cast)
1788 Found in file handy.h
1792 Tells Perl to C<require> the file named by the string argument. It is
1793 analogous to the Perl code C<eval "require '$file'">. It's even
1794 implemented that way; consider using Perl_load_module instead.
1796 NOTE: the perl_ form of this function is deprecated.
1798 void require_pv(const char* pv)
1801 Found in file perl.c
1805 Variable which is setup by C<xsubpp> to hold the return value for an
1806 XSUB. This is always the proper type for the XSUB. See
1807 L<perlxs/"The RETVAL Variable">.
1812 Found in file XSUB.h
1816 The XSUB-writer's interface to the C C<free> function.
1818 void Safefree(void* ptr)
1821 Found in file handy.h
1825 Copy a string to a safe spot. This does not use an SV.
1827 char* savepv(const char* sv)
1830 Found in file util.c
1834 Copy a string to a safe spot. The C<len> indicates number of bytes to
1835 copy. This does not use an SV.
1837 char* savepvn(const char* sv, I32 len)
1840 Found in file util.c
1844 Opening bracket for temporaries on a callback. See C<FREETMPS> and
1850 Found in file scope.h
1854 Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and
1862 Refetch the stack pointer. Used after a callback. See L<perlcall>.
1871 Used to access elements on the XSUB's stack.
1876 Found in file XSUB.h
1880 Test two strings to see if they are equal. Returns true or false.
1882 bool strEQ(char* s1, char* s2)
1885 Found in file handy.h
1889 Test two strings to see if the first, C<s1>, is greater than or equal to
1890 the second, C<s2>. Returns true or false.
1892 bool strGE(char* s1, char* s2)
1895 Found in file handy.h
1899 Test two strings to see if the first, C<s1>, is greater than the second,
1900 C<s2>. Returns true or false.
1902 bool strGT(char* s1, char* s2)
1905 Found in file handy.h
1909 Test two strings to see if the first, C<s1>, is less than or equal to the
1910 second, C<s2>. Returns true or false.
1912 bool strLE(char* s1, char* s2)
1915 Found in file handy.h
1919 Test two strings to see if the first, C<s1>, is less than the second,
1920 C<s2>. Returns true or false.
1922 bool strLT(char* s1, char* s2)
1925 Found in file handy.h
1929 Test two strings to see if they are different. Returns true or
1932 bool strNE(char* s1, char* s2)
1935 Found in file handy.h
1939 Test two strings to see if they are equal. The C<len> parameter indicates
1940 the number of bytes to compare. Returns true or false. (A wrapper for
1943 bool strnEQ(char* s1, char* s2, STRLEN len)
1946 Found in file handy.h
1950 Test two strings to see if they are different. The C<len> parameter
1951 indicates the number of bytes to compare. Returns true or false. (A
1952 wrapper for C<strncmp>).
1954 bool strnNE(char* s1, char* s2, STRLEN len)
1957 Found in file handy.h
1961 This is an architecture-independent macro to copy one structure to another.
1963 void StructCopy(type src, type dest, type)
1966 Found in file handy.h
1970 Returns the length of the string which is in the SV. See C<SvLEN>.
1972 STRLEN SvCUR(SV* sv)
1979 Set the length of the string which is in the SV. See C<SvCUR>.
1981 void SvCUR_set(SV* sv, STRLEN len)
1988 Returns a pointer to the last character in the string which is in the SV.
1989 See C<SvCUR>. Access the character as *(SvEND(sv)).
1998 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
1999 argument more than once.
2001 void SvGETMAGIC(SV* sv)
2008 Expands the character buffer in the SV so that it has room for the
2009 indicated number of bytes (remember to reserve space for an extra trailing
2010 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
2011 Returns a pointer to the character buffer.
2013 char * SvGROW(SV* sv, STRLEN len)
2020 Returns a boolean indicating whether the SV contains an integer.
2029 Returns a boolean indicating whether the SV contains an integer. Checks
2030 the B<private> setting. Use C<SvIOK>.
2039 Returns a boolean indicating whether the SV contains an signed integer.
2041 void SvIOK_notUV(SV* sv)
2048 Unsets the IV status of an SV.
2050 void SvIOK_off(SV* sv)
2057 Tells an SV that it is an integer.
2059 void SvIOK_on(SV* sv)
2066 Tells an SV that it is an integer and disables all other OK bits.
2068 void SvIOK_only(SV* sv)
2075 Tells and SV that it is an unsigned integer and disables all other OK bits.
2077 void SvIOK_only_UV(SV* sv)
2084 Returns a boolean indicating whether the SV contains an unsigned integer.
2086 void SvIOK_UV(SV* sv)
2093 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
2094 version which guarantees to evaluate sv only once.
2103 Returns the raw value in the SV's IV slot, without checks or conversions.
2104 Only use when you are sure SvIOK is true. See also C<SvIV()>.
2113 Coerces the given SV to an integer and returns it. Guarantees to evaluate
2114 sv only once. Use the more efficent C<SvIV> otherwise.
2123 Returns the size of the string buffer in the SV, not including any part
2124 attributable to C<SvOOK>. See C<SvCUR>.
2126 STRLEN SvLEN(SV* sv)
2133 Returns a boolean indicating whether the SV contains a number, integer or
2143 Returns a boolean indicating whether the SV contains a number, integer or
2144 double. Checks the B<private> setting. Use C<SvNIOK>.
2146 bool SvNIOKp(SV* sv)
2153 Unsets the NV/IV status of an SV.
2155 void SvNIOK_off(SV* sv)
2162 Returns a boolean indicating whether the SV contains a double.
2171 Returns a boolean indicating whether the SV contains a double. Checks the
2172 B<private> setting. Use C<SvNOK>.
2181 Unsets the NV status of an SV.
2183 void SvNOK_off(SV* sv)
2190 Tells an SV that it is a double.
2192 void SvNOK_on(SV* sv)
2199 Tells an SV that it is a double and disables all other OK bits.
2201 void SvNOK_only(SV* sv)
2208 Coerce the given SV to a double and return it. See C<SvNVx> for a version
2209 which guarantees to evaluate sv only once.
2218 Returns the raw value in the SV's NV slot, without checks or conversions.
2219 Only use when you are sure SvNOK is true. See also C<SvNV()>.
2228 Coerces the given SV to a double and returns it. Guarantees to evaluate
2229 sv only once. Use the more efficent C<SvNV> otherwise.
2238 Returns a boolean indicating whether the value is an SV.
2247 Returns a boolean indicating whether the SvIVX is a valid offset value for
2248 the SvPVX. This hack is used internally to speed up removal of characters
2249 from the beginning of a SvPV. When SvOOK is true, then the start of the
2250 allocated string buffer is really (SvPVX - SvIVX).
2259 Returns a boolean indicating whether the SV contains a character
2269 Returns a boolean indicating whether the SV contains a character string.
2270 Checks the B<private> setting. Use C<SvPOK>.
2279 Unsets the PV status of an SV.
2281 void SvPOK_off(SV* sv)
2288 Tells an SV that it is a string.
2290 void SvPOK_on(SV* sv)
2297 Tells an SV that it is a string and disables all other OK bits.
2298 Will also turn off the UTF8 status.
2300 void SvPOK_only(SV* sv)
2305 =item SvPOK_only_UTF8
2307 Tells an SV that it is a string and disables all other OK bits,
2308 and leaves the UTF8 status as it was.
2310 void SvPOK_only_UTF8(SV* sv)
2317 Returns a pointer to the string in the SV, or a stringified form of the SV
2318 if the SV does not contain a string. Handles 'get' magic. See also
2319 C<SvPVx> for a version which guarantees to evaluate sv only once.
2321 char* SvPV(SV* sv, STRLEN len)
2328 Like C<SvPV>, but converts sv to byte representation first if necessary.
2330 char* SvPVbyte(SV* sv, STRLEN len)
2337 Like C<SvPV>, but converts sv to byte representation first if necessary.
2338 Guarantees to evalute sv only once; use the more efficient C<SvPVbyte>
2342 char* SvPVbytex(SV* sv, STRLEN len)
2347 =item SvPVbytex_force
2349 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
2350 Guarantees to evalute sv only once; use the more efficient C<SvPVbyte_force>
2353 char* SvPVbytex_force(SV* sv, STRLEN len)
2358 =item SvPVbyte_force
2360 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
2362 char* SvPVbyte_force(SV* sv, STRLEN len)
2367 =item SvPVbyte_nolen
2369 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
2371 char* SvPVbyte_nolen(SV* sv, STRLEN len)
2378 Like C<SvPV>, but converts sv to uft8 first if necessary.
2380 char* SvPVutf8(SV* sv, STRLEN len)
2387 Like C<SvPV>, but converts sv to uft8 first if necessary.
2388 Guarantees to evalute sv only once; use the more efficient C<SvPVutf8>
2391 char* SvPVutf8x(SV* sv, STRLEN len)
2396 =item SvPVutf8x_force
2398 Like C<SvPV_force>, but converts sv to uft8 first if necessary.
2399 Guarantees to evalute sv only once; use the more efficient C<SvPVutf8_force>
2402 char* SvPVutf8x_force(SV* sv, STRLEN len)
2407 =item SvPVutf8_force
2409 Like C<SvPV_force>, but converts sv to uft8 first if necessary.
2411 char* SvPVutf8_force(SV* sv, STRLEN len)
2416 =item SvPVutf8_nolen
2418 Like C<SvPV_nolen>, but converts sv to uft8 first if necessary.
2420 char* SvPVutf8_nolen(SV* sv, STRLEN len)
2427 A version of C<SvPV> which guarantees to evaluate sv only once.
2429 char* SvPVx(SV* sv, STRLEN len)
2436 Returns a pointer to the physical string in the SV. The SV must contain a
2446 Like <SvPV> but will force the SV into becoming a string (SvPOK). You want
2447 force if you are going to update the SvPVX directly.
2449 char* SvPV_force(SV* sv, STRLEN len)
2454 =item SvPV_force_nomg
2456 Like <SvPV> but will force the SV into becoming a string (SvPOK). You want
2457 force if you are going to update the SvPVX directly. Doesn't process magic.
2459 char* SvPV_force_nomg(SV* sv, STRLEN len)
2466 Returns a pointer to the string in the SV, or a stringified form of the SV
2467 if the SV does not contain a string. Handles 'get' magic.
2469 char* SvPV_nolen(SV* sv)
2476 Returns the value of the object's reference count.
2478 U32 SvREFCNT(SV* sv)
2485 Decrements the reference count of the given SV.
2487 void SvREFCNT_dec(SV* sv)
2494 Increments the reference count of the given SV.
2496 SV* SvREFCNT_inc(SV* sv)
2503 Tests if the SV is an RV.
2512 Unsets the RV status of an SV.
2514 void SvROK_off(SV* sv)
2521 Tells an SV that it is an RV.
2523 void SvROK_on(SV* sv)
2530 Dereferences an RV to return the SV.
2539 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
2540 argument more than once.
2542 void SvSETMAGIC(SV* sv)
2549 Like C<SvSetSV>, but does any set magic required afterwards.
2551 void SvSetMagicSV(SV* dsb, SV* ssv)
2556 =item SvSetMagicSV_nosteal
2558 Like C<SvSetMagicSV>, but does any set magic required afterwards.
2560 void SvSetMagicSV_nosteal(SV* dsv, SV* ssv)
2567 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
2570 void SvSetSV(SV* dsb, SV* ssv)
2575 =item SvSetSV_nosteal
2577 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
2578 ssv. May evaluate arguments more than once.
2580 void SvSetSV_nosteal(SV* dsv, SV* ssv)
2587 Returns the stash of the SV.
2596 Taints an SV if tainting is enabled
2598 void SvTAINT(SV* sv)
2605 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
2608 bool SvTAINTED(SV* sv)
2615 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
2616 some of Perl's fundamental security features. XS module authors should not
2617 use this function unless they fully understand all the implications of
2618 unconditionally untainting the value. Untainting should be done in the
2619 standard perl fashion, via a carefully crafted regexp, rather than directly
2620 untainting variables.
2622 void SvTAINTED_off(SV* sv)
2629 Marks an SV as tainted.
2631 void SvTAINTED_on(SV* sv)
2638 Returns a boolean indicating whether Perl would evaluate the SV as true or
2639 false, defined or undefined. Does not handle 'get' magic.
2648 Returns the type of the SV. See C<svtype>.
2650 svtype SvTYPE(SV* sv)
2657 An enum of flags for Perl types. These are found in the file B<sv.h>
2658 in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
2665 Integer type flag for scalars. See C<svtype>.
2672 Double type flag for scalars. See C<svtype>.
2679 Pointer type flag for scalars. See C<svtype>.
2686 Type flag for arrays. See C<svtype>.
2693 Type flag for code refs. See C<svtype>.
2700 Type flag for hashes. See C<svtype>.
2707 Type flag for blessed scalars. See C<svtype>.
2714 Returns a boolean indicating whether the SV contains an unsigned integer.
2723 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
2724 perform the upgrade if necessary. See C<svtype>.
2726 void SvUPGRADE(SV* sv, svtype type)
2733 Returns a boolean indicating whether the SV contains UTF-8 encoded data.
2742 Unsets the UTF8 status of an SV.
2744 void SvUTF8_off(SV *sv)
2751 Turn on the UTF8 status of an SV (the data is not changed, just the flag).
2752 Do not use frivolously.
2754 void SvUTF8_on(SV *sv)
2761 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
2762 for a version which guarantees to evaluate sv only once.
2771 Coerces the given SV to an unsigned integer and returns it. Guarantees to
2772 evaluate sv only once. Use the more efficent C<SvUV> otherwise.
2781 Returns the raw value in the SV's UV slot, without checks or conversions.
2782 Only use when you are sure SvIOK is true. See also C<SvUV()>.
2791 This function is only called on magical items, and is only used by
2792 sv_true() or its macro equivalent.
2794 bool sv_2bool(SV* sv)
2801 Using various gambits, try to get a CV from an SV; in addition, try if
2802 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
2804 CV* sv_2cv(SV* sv, HV** st, GV** gvp, I32 lref)
2811 Using various gambits, try to get an IO from an SV: the IO slot if its a
2812 GV; or the recursive result if we're an RV; or the IO slot of the symbol
2813 named after the PV if we're a string.
2822 Return the integer value of an SV, doing any necessary string conversion,
2823 magic etc. Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2832 Marks an existing SV as mortal. The SV will be destroyed when the current
2833 context ends. See also C<sv_newmortal> and C<sv_mortalcopy>.
2835 SV* sv_2mortal(SV* sv)
2842 Return the num value of an SV, doing any necessary string or integer
2843 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2853 Return a pointer to the byte-encoded representation of the SV, and set *lp
2854 to its length. May cause the SV to be downgraded from UTF8 as a
2857 Usually accessed via the C<SvPVbyte> macro.
2859 char* sv_2pvbyte(SV* sv, STRLEN* lp)
2864 =item sv_2pvbyte_nolen
2866 Return a pointer to the byte-encoded representation of the SV.
2867 May cause the SV to be downgraded from UTF8 as a side-effect.
2869 Usually accessed via the C<SvPVbyte_nolen> macro.
2871 char* sv_2pvbyte_nolen(SV* sv)
2878 Return a pointer to the UTF8-encoded representation of the SV, and set *lp
2879 to its length. May cause the SV to be upgraded to UTF8 as a side-effect.
2881 Usually accessed via the C<SvPVutf8> macro.
2883 char* sv_2pvutf8(SV* sv, STRLEN* lp)
2888 =item sv_2pvutf8_nolen
2890 Return a pointer to the UTF8-encoded representation of the SV.
2891 May cause the SV to be upgraded to UTF8 as a side-effect.
2893 Usually accessed via the C<SvPVutf8_nolen> macro.
2895 char* sv_2pvutf8_nolen(SV* sv)
2902 Returns a pointer to the string value of an SV, and sets *lp to its length.
2903 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2905 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2906 usually end up here too.
2908 char* sv_2pv_flags(SV* sv, STRLEN* lp, I32 flags)
2915 Like C<sv_2pv()>, but doesn't return the length too. You should usually
2916 use the macro wrapper C<SvPV_nolen(sv)> instead.
2917 char* sv_2pv_nolen(SV* sv)
2924 Return the unsigned integer value of an SV, doing any necessary string
2925 conversion, magic etc. Normally used via the C<SvUV(sv)> and C<SvUVx(sv)>
2935 Remove any string offset. You should normally use the C<SvOOK_off> macro
2938 int sv_backoff(SV* sv)
2945 Blesses an SV into a specified package. The SV must be an RV. The package
2946 must be designated by its stash (see C<gv_stashpv()>). The reference count
2947 of the SV is unaffected.
2949 SV* sv_bless(SV* sv, HV* stash)
2956 Concatenates the string onto the end of the string which is in the SV.
2957 If the SV has the UTF8 status set, then the bytes appended should be
2958 valid UTF8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
2960 void sv_catpv(SV* sv, const char* ptr)
2967 Processes its arguments like C<sprintf> and appends the formatted
2968 output to an SV. If the appended data contains "wide" characters
2969 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
2970 and characters >255 formatted with %c), the original SV might get
2971 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic.
2972 C<SvSETMAGIC()> must typically be called after calling this function
2973 to handle 'set' magic.
2975 void sv_catpvf(SV* sv, const char* pat, ...)
2982 Like C<sv_catpvf>, but also handles 'set' magic.
2984 void sv_catpvf_mg(SV *sv, const char* pat, ...)
2991 Concatenates the string onto the end of the string which is in the SV. The
2992 C<len> indicates number of bytes to copy. If the SV has the UTF8
2993 status set, then the bytes appended should be valid UTF8.
2994 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
2996 void sv_catpvn(SV* sv, const char* ptr, STRLEN len)
3001 =item sv_catpvn_flags
3003 Concatenates the string onto the end of the string which is in the SV. The
3004 C<len> indicates number of bytes to copy. If the SV has the UTF8
3005 status set, then the bytes appended should be valid UTF8.
3006 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
3007 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
3008 in terms of this function.
3010 void sv_catpvn_flags(SV* sv, const char* ptr, STRLEN len, I32 flags)
3017 Like C<sv_catpvn>, but also handles 'set' magic.
3019 void sv_catpvn_mg(SV *sv, const char *ptr, STRLEN len)
3026 Like C<sv_catpv>, but also handles 'set' magic.
3028 void sv_catpv_mg(SV *sv, const char *ptr)
3035 Concatenates the string from SV C<ssv> onto the end of the string in
3036 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
3037 not 'set' magic. See C<sv_catsv_mg>.
3039 void sv_catsv(SV* dsv, SV* ssv)
3044 =item sv_catsv_flags
3046 Concatenates the string from SV C<ssv> onto the end of the string in
3047 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
3048 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
3049 and C<sv_catsv_nomg> are implemented in terms of this function.
3051 void sv_catsv_flags(SV* dsv, SV* ssv, I32 flags)
3058 Like C<sv_catsv>, but also handles 'set' magic.
3060 void sv_catsv_mg(SV *dstr, SV *sstr)
3067 Efficient removal of characters from the beginning of the string buffer.
3068 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
3069 the string buffer. The C<ptr> becomes the first character of the adjusted
3070 string. Uses the "OOK hack".
3072 void sv_chop(SV* sv, char* ptr)
3079 Clear an SV: call any destructors, free up any memory used by the body,
3080 and free the body itself. The SV's head is I<not> freed, although
3081 its type is set to all 1's so that it won't inadvertently be assumed
3082 to be live during global destruction etc.
3083 This function should only be called when REFCNT is zero. Most of the time
3084 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
3087 void sv_clear(SV* sv)
3094 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
3095 string in C<sv1> is less than, equal to, or greater than the string in
3096 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
3097 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
3099 I32 sv_cmp(SV* sv1, SV* sv2)
3106 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
3107 'use bytes' aware, handles get magic, and will coerce its args to strings
3108 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
3110 I32 sv_cmp_locale(SV* sv1, SV* sv2)
3117 Add Collate Transform magic to an SV if it doesn't already have it.
3119 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
3120 scalar data of the variable, but transformed to such a format that a normal
3121 memory comparison can be used to compare the data according to the locale
3124 char* sv_collxfrm(SV* sv, STRLEN* nxp)
3131 Auto-decrement of the value in the SV, doing string to numeric conversion
3132 if necessary. Handles 'get' magic.
3139 =item sv_derived_from
3141 Returns a boolean indicating whether the SV is derived from the specified
3142 class. This is the function that implements C<UNIVERSAL::isa>. It works
3143 for class names as well as for objects.
3145 bool sv_derived_from(SV* sv, const char* name)
3148 Found in file universal.c
3152 Returns a boolean indicating whether the strings in the two SVs are
3153 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
3154 coerce its args to strings if necessary.
3156 I32 sv_eq(SV* sv1, SV* sv2)
3161 =item sv_force_normal
3163 Undo various types of fakery on an SV: if the PV is a shared string, make
3164 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3165 an xpvmg. See also C<sv_force_normal_flags>.
3167 void sv_force_normal(SV *sv)
3172 =item sv_force_normal_flags
3174 Undo various types of fakery on an SV: if the PV is a shared string, make
3175 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3176 an xpvmg. The C<flags> parameter gets passed to C<sv_unref_flags()>
3177 when unrefing. C<sv_force_normal> calls this function with flags set to 0.
3179 void sv_force_normal_flags(SV *sv, U32 flags)
3186 Decrement an SV's reference count, and if it drops to zero, call
3187 C<sv_clear> to invoke destructors and free up any memory used by
3188 the body; finally, deallocate the SV's head itself.
3189 Normally called via a wrapper macro C<SvREFCNT_dec>.
3191 void sv_free(SV* sv)
3198 Fill the sv with current working directory
3200 int sv_getcwd(SV* sv)
3203 Found in file util.c
3207 Get a line from the filehandle and store it into the SV, optionally
3208 appending to the currently-stored string.
3210 char* sv_gets(SV* sv, PerlIO* fp, I32 append)
3217 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
3218 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
3219 Use the C<SvGROW> wrapper instead.
3221 char* sv_grow(SV* sv, STRLEN newlen)
3228 Auto-increment of the value in the SV, doing string to numeric conversion
3229 if necessary. Handles 'get' magic.
3238 Inserts a string at the specified offset/length within the SV. Similar to
3239 the Perl substr() function.
3241 void sv_insert(SV* bigsv, STRLEN offset, STRLEN len, char* little, STRLEN littlelen)
3248 Returns a boolean indicating whether the SV is blessed into the specified
3249 class. This does not check for subtypes; use C<sv_derived_from> to verify
3250 an inheritance relationship.
3252 int sv_isa(SV* sv, const char* name)
3259 Returns a boolean indicating whether the SV is an RV pointing to a blessed
3260 object. If the SV is not an RV, or if the object is not blessed, then this
3263 int sv_isobject(SV* sv)
3270 A private implementation of the C<SvIVx> macro for compilers which can't
3271 cope with complex macro expressions. Always use the macro instead.
3280 Returns the length of the string in the SV. Handles magic and type
3281 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
3283 STRLEN sv_len(SV* sv)
3290 Returns the number of characters in the string in an SV, counting wide
3291 UTF8 bytes as a single character. Handles magic and type coercion.
3293 STRLEN sv_len_utf8(SV* sv)
3300 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
3301 then adds a new magic item of type C<how> to the head of the magic list.
3303 C<name> is assumed to contain an C<SV*> if C<(name && namelen == HEf_SVKEY)>
3305 void sv_magic(SV* sv, SV* obj, int how, const char* name, I32 namlen)
3312 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
3313 The new SV is marked as mortal. It will be destroyed when the current
3314 context ends. See also C<sv_newmortal> and C<sv_2mortal>.
3316 SV* sv_mortalcopy(SV* oldsv)
3323 Creates a new null SV which is mortal. The reference count of the SV is
3324 set to 1. It will be destroyed when the current context ends. See
3325 also C<sv_mortalcopy> and C<sv_2mortal>.
3334 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
3337 SV* sv_newref(SV* sv)
3344 A private implementation of the C<SvNVx> macro for compilers which can't
3345 cope with complex macro expressions. Always use the macro instead.
3354 Converts the value pointed to by offsetp from a count of bytes from the
3355 start of the string, to a count of the equivalent number of UTF8 chars.
3356 Handles magic and type coercion.
3358 void sv_pos_b2u(SV* sv, I32* offsetp)
3365 Converts the value pointed to by offsetp from a count of UTF8 chars from
3366 the start of the string, to a count of the equivalent number of bytes; if
3367 lenp is non-zero, it does the same to lenp, but this time starting from
3368 the offset, rather than from the start of the string. Handles magic and
3371 void sv_pos_u2b(SV* sv, I32* offsetp, I32* lenp)
3378 A private implementation of the C<SvPV_nolen> macro for compilers which can't
3379 cope with complex macro expressions. Always use the macro instead.
3388 A private implementation of the C<SvPVbyte_nolen> macro for compilers
3389 which can't cope with complex macro expressions. Always use the macro
3392 char* sv_pvbyte(SV *sv)
3399 A private implementation of the C<SvPVbyte> macro for compilers
3400 which can't cope with complex macro expressions. Always use the macro
3403 char* sv_pvbyten(SV *sv, STRLEN *len)
3408 =item sv_pvbyten_force
3410 A private implementation of the C<SvPVbytex_force> macro for compilers
3411 which can't cope with complex macro expressions. Always use the macro
3414 char* sv_pvbyten_force(SV* sv, STRLEN* lp)
3421 A private implementation of the C<SvPV> macro for compilers which can't
3422 cope with complex macro expressions. Always use the macro instead.
3424 char* sv_pvn(SV *sv, STRLEN *len)
3431 Get a sensible string out of the SV somehow.
3432 A private implementation of the C<SvPV_force> macro for compilers which
3433 can't cope with complex macro expressions. Always use the macro instead.
3435 char* sv_pvn_force(SV* sv, STRLEN* lp)
3440 =item sv_pvn_force_flags
3442 Get a sensible string out of the SV somehow.
3443 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
3444 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
3445 implemented in terms of this function.
3446 You normally want to use the various wrapper macros instead: see
3447 C<SvPV_force> and C<SvPV_force_nomg>
3449 char* sv_pvn_force_flags(SV* sv, STRLEN* lp, I32 flags)
3456 A private implementation of the C<SvPVutf8_nolen> macro for compilers
3457 which can't cope with complex macro expressions. Always use the macro
3460 char* sv_pvutf8(SV *sv)
3467 A private implementation of the C<SvPVutf8> macro for compilers
3468 which can't cope with complex macro expressions. Always use the macro
3471 char* sv_pvutf8n(SV *sv, STRLEN *len)
3476 =item sv_pvutf8n_force
3478 A private implementation of the C<SvPVutf8_force> macro for compilers
3479 which can't cope with complex macro expressions. Always use the macro
3482 char* sv_pvutf8n_force(SV* sv, STRLEN* lp)
3489 Returns a string describing what the SV is a reference to.
3491 char* sv_reftype(SV* sv, int ob)
3498 Make the first argument a copy of the second, then delete the original.
3499 The target SV physically takes over ownership of the body of the source SV
3500 and inherits its flags; however, the target keeps any magic it owns,
3501 and any magic in the source is discarded.
3502 Note that this is a rather specialist SV copying operation; most of the
3503 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
3505 void sv_replace(SV* sv, SV* nsv)
3510 =item sv_report_used
3512 Dump the contents of all SVs not yet freed. (Debugging aid).
3514 void sv_report_used()
3521 Underlying implementation for the C<reset> Perl function.
3522 Note that the perl-level function is vaguely deprecated.
3524 void sv_reset(char* s, HV* stash)
3531 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
3532 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
3533 push a back-reference to this RV onto the array of backreferences
3534 associated with that magic.
3536 SV* sv_rvweaken(SV *sv)
3543 Copies an integer into the given SV, upgrading first if necessary.
3544 Does not handle 'set' magic. See also C<sv_setiv_mg>.
3546 void sv_setiv(SV* sv, IV num)
3553 Like C<sv_setiv>, but also handles 'set' magic.
3555 void sv_setiv_mg(SV *sv, IV i)
3562 Copies a double into the given SV, upgrading first if necessary.
3563 Does not handle 'set' magic. See also C<sv_setnv_mg>.
3565 void sv_setnv(SV* sv, NV num)
3572 Like C<sv_setnv>, but also handles 'set' magic.
3574 void sv_setnv_mg(SV *sv, NV num)
3581 Copies a string into an SV. The string must be null-terminated. Does not
3582 handle 'set' magic. See C<sv_setpv_mg>.
3584 void sv_setpv(SV* sv, const char* ptr)
3591 Processes its arguments like C<sprintf> and sets an SV to the formatted
3592 output. Does not handle 'set' magic. See C<sv_setpvf_mg>.
3594 void sv_setpvf(SV* sv, const char* pat, ...)
3601 Like C<sv_setpvf>, but also handles 'set' magic.
3603 void sv_setpvf_mg(SV *sv, const char* pat, ...)
3610 Copies an integer into the given SV, also updating its string value.
3611 Does not handle 'set' magic. See C<sv_setpviv_mg>.
3613 void sv_setpviv(SV* sv, IV num)
3620 Like C<sv_setpviv>, but also handles 'set' magic.
3622 void sv_setpviv_mg(SV *sv, IV iv)
3629 Copies a string into an SV. The C<len> parameter indicates the number of
3630 bytes to be copied. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3632 void sv_setpvn(SV* sv, const char* ptr, STRLEN len)
3639 Like C<sv_setpvn>, but also handles 'set' magic.
3641 void sv_setpvn_mg(SV *sv, const char *ptr, STRLEN len)
3648 Like C<sv_setpv>, but also handles 'set' magic.
3650 void sv_setpv_mg(SV *sv, const char *ptr)
3657 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
3658 argument will be upgraded to an RV. That RV will be modified to point to
3659 the new SV. The C<classname> argument indicates the package for the
3660 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
3661 will be returned and will have a reference count of 1.
3663 SV* sv_setref_iv(SV* rv, const char* classname, IV iv)
3670 Copies a double into a new SV, optionally blessing the SV. The C<rv>
3671 argument will be upgraded to an RV. That RV will be modified to point to
3672 the new SV. The C<classname> argument indicates the package for the
3673 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
3674 will be returned and will have a reference count of 1.
3676 SV* sv_setref_nv(SV* rv, const char* classname, NV nv)
3683 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
3684 argument will be upgraded to an RV. That RV will be modified to point to
3685 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
3686 into the SV. The C<classname> argument indicates the package for the
3687 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
3688 will be returned and will have a reference count of 1.
3690 Do not use with other Perl types such as HV, AV, SV, CV, because those
3691 objects will become corrupted by the pointer copy process.
3693 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
3695 SV* sv_setref_pv(SV* rv, const char* classname, void* pv)
3702 Copies a string into a new SV, optionally blessing the SV. The length of the
3703 string must be specified with C<n>. The C<rv> argument will be upgraded to
3704 an RV. That RV will be modified to point to the new SV. The C<classname>
3705 argument indicates the package for the blessing. Set C<classname> to
3706 C<Nullch> to avoid the blessing. The new SV will be returned and will have
3707 a reference count of 1.
3709 Note that C<sv_setref_pv> copies the pointer while this copies the string.
3711 SV* sv_setref_pvn(SV* rv, const char* classname, char* pv, STRLEN n)
3718 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
3719 argument will be upgraded to an RV. That RV will be modified to point to
3720 the new SV. The C<classname> argument indicates the package for the
3721 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
3722 will be returned and will have a reference count of 1.
3724 SV* sv_setref_uv(SV* rv, const char* classname, UV uv)
3731 Copies the contents of the source SV C<ssv> into the destination SV
3732 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3733 function if the source SV needs to be reused. Does not handle 'set' magic.
3734 Loosely speaking, it performs a copy-by-value, obliterating any previous
3735 content of the destination.
3737 You probably want to use one of the assortment of wrappers, such as
3738 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3739 C<SvSetMagicSV_nosteal>.
3742 void sv_setsv(SV* dsv, SV* ssv)
3747 =item sv_setsv_flags
3749 Copies the contents of the source SV C<ssv> into the destination SV
3750 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3751 function if the source SV needs to be reused. Does not handle 'set' magic.
3752 Loosely speaking, it performs a copy-by-value, obliterating any previous
3753 content of the destination.
3754 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3755 C<ssv> if appropriate, else not. C<sv_setsv> and C<sv_setsv_nomg> are
3756 implemented in terms of this function.
3758 You probably want to use one of the assortment of wrappers, such as
3759 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3760 C<SvSetMagicSV_nosteal>.
3762 This is the primary function for copying scalars, and most other
3763 copy-ish functions and macros use this underneath.
3765 void sv_setsv_flags(SV* dsv, SV* ssv, I32 flags)
3772 Like C<sv_setsv>, but also handles 'set' magic.
3774 void sv_setsv_mg(SV *dstr, SV *sstr)
3781 Copies an unsigned integer into the given SV, upgrading first if necessary.
3782 Does not handle 'set' magic. See also C<sv_setuv_mg>.
3784 void sv_setuv(SV* sv, UV num)
3791 Like C<sv_setuv>, but also handles 'set' magic.
3793 void sv_setuv_mg(SV *sv, UV u)
3800 Taint an SV. Use C<SvTAINTED_on> instead.
3801 void sv_taint(SV* sv)
3808 Test an SV for taintedness. Use C<SvTAINTED> instead.
3809 bool sv_tainted(SV* sv)
3816 Returns true if the SV has a true value by Perl's rules.
3817 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
3818 instead use an in-line version.
3827 Removes all magic of type C<type> from an SV.
3829 int sv_unmagic(SV* sv, int type)
3836 Unsets the RV status of the SV, and decrements the reference count of
3837 whatever was being referenced by the RV. This can almost be thought of
3838 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
3839 being zero. See C<SvROK_off>.
3841 void sv_unref(SV* sv)
3846 =item sv_unref_flags
3848 Unsets the RV status of the SV, and decrements the reference count of
3849 whatever was being referenced by the RV. This can almost be thought of
3850 as a reversal of C<newSVrv>. The C<cflags> argument can contain
3851 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
3852 (otherwise the decrementing is conditional on the reference count being
3853 different from one or the reference being a readonly SV).
3856 void sv_unref_flags(SV* sv, U32 flags)
3863 Untaint an SV. Use C<SvTAINTED_off> instead.
3864 void sv_untaint(SV* sv)
3871 Upgrade an SV to a more complex form. Generally adds a new body type to the
3872 SV, then copies across as much information as possible from the old body.
3873 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
3875 bool sv_upgrade(SV* sv, U32 mt)
3882 Tells an SV to use C<ptr> to find its string value. Normally the string is
3883 stored inside the SV but sv_usepvn allows the SV to use an outside string.
3884 The C<ptr> should point to memory that was allocated by C<malloc>. The
3885 string length, C<len>, must be supplied. This function will realloc the
3886 memory pointed to by C<ptr>, so that pointer should not be freed or used by
3887 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
3888 See C<sv_usepvn_mg>.
3890 void sv_usepvn(SV* sv, char* ptr, STRLEN len)
3897 Like C<sv_usepvn>, but also handles 'set' magic.
3899 void sv_usepvn_mg(SV *sv, char *ptr, STRLEN len)
3904 =item sv_utf8_decode
3906 Convert the octets in the PV from UTF-8 to chars. Scan for validity and then
3907 turn off SvUTF8 if needed so that we see characters. Used as a building block
3908 for decode_utf8 in Encode.xs
3910 NOTE: this function is experimental and may change or be
3911 removed without notice.
3913 bool sv_utf8_decode(SV *sv)
3918 =item sv_utf8_downgrade
3920 Attempt to convert the PV of an SV from UTF8-encoded to byte encoding.
3921 This may not be possible if the PV contains non-byte encoding characters;
3922 if this is the case, either returns false or, if C<fail_ok> is not
3925 NOTE: this function is experimental and may change or be
3926 removed without notice.
3928 bool sv_utf8_downgrade(SV *sv, bool fail_ok)
3933 =item sv_utf8_encode
3935 Convert the PV of an SV to UTF8-encoded, but then turn off the C<SvUTF8>
3936 flag so that it looks like octets again. Used as a building block
3937 for encode_utf8 in Encode.xs
3939 void sv_utf8_encode(SV *sv)
3944 =item sv_utf8_upgrade
3946 Convert the PV of an SV to its UTF8-encoded form.
3947 Forces the SV to string form if it is not already.
3948 Always sets the SvUTF8 flag to avoid future validity checks even
3949 if all the bytes have hibit clear.
3951 STRLEN sv_utf8_upgrade(SV *sv)
3956 =item sv_utf8_upgrade_flags
3958 Convert the PV of an SV to its UTF8-encoded form.
3959 Forces the SV to string form if it is not already.
3960 Always sets the SvUTF8 flag to avoid future validity checks even
3961 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
3962 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
3963 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3965 STRLEN sv_utf8_upgrade_flags(SV *sv, I32 flags)
3972 A private implementation of the C<SvUVx> macro for compilers which can't
3973 cope with complex macro expressions. Always use the macro instead.
3982 Processes its arguments like C<vsprintf> and appends the formatted output
3983 to an SV. Uses an array of SVs if the C style variable argument list is
3984 missing (NULL). When running with taint checks enabled, indicates via
3985 C<maybe_tainted> if results are untrustworthy (often due to the use of
3988 Usually used via one of its frontends C<sv_catpvf> and C<sv_catpvf_mg>.
3990 void sv_vcatpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
3997 Works like C<vcatpvfn> but copies the text into the SV instead of
4000 Usually used via one of its frontends C<sv_setpvf> and C<sv_setpvf_mg>.
4002 void sv_vsetpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
4009 Variable which is setup by C<xsubpp> to designate the object in a C++
4010 XSUB. This is always the proper type for the C++ object. See C<CLASS> and
4011 L<perlxs/"Using XS With C++">.
4016 Found in file XSUB.h
4020 Converts the specified character to lowercase.
4022 char toLOWER(char ch)
4025 Found in file handy.h
4029 Converts the specified character to uppercase.
4031 char toUPPER(char ch)
4034 Found in file handy.h
4036 =item utf8n_to_uvchr
4038 Returns the native character value of the first character in the string C<s>
4039 which is assumed to be in UTF8 encoding; C<retlen> will be set to the
4040 length, in bytes, of that character.
4042 Allows length and flags to be passed to low level routine.
4044 UV utf8n_to_uvchr(U8 *s, STRLEN curlen, STRLEN* retlen, U32 flags)
4047 Found in file utf8.c
4049 =item utf8n_to_uvuni
4051 Bottom level UTF-8 decode routine.
4052 Returns the unicode code point value of the first character in the string C<s>
4053 which is assumed to be in UTF8 encoding and no longer than C<curlen>;
4054 C<retlen> will be set to the length, in bytes, of that character.
4056 If C<s> does not point to a well-formed UTF8 character, the behaviour
4057 is dependent on the value of C<flags>: if it contains UTF8_CHECK_ONLY,
4058 it is assumed that the caller will raise a warning, and this function
4059 will silently just set C<retlen> to C<-1> and return zero. If the
4060 C<flags> does not contain UTF8_CHECK_ONLY, warnings about
4061 malformations will be given, C<retlen> will be set to the expected
4062 length of the UTF-8 character in bytes, and zero will be returned.
4064 The C<flags> can also contain various flags to allow deviations from
4065 the strict UTF-8 encoding (see F<utf8.h>).
4067 Most code should use utf8_to_uvchr() rather than call this directly.
4069 UV utf8n_to_uvuni(U8 *s, STRLEN curlen, STRLEN* retlen, U32 flags)
4072 Found in file utf8.c
4076 Returns the number of UTF8 characters between the UTF-8 pointers C<a>
4079 WARNING: use only if you *know* that the pointers point inside the
4082 IV utf8_distance(U8 *a, U8 *b)
4085 Found in file utf8.c
4089 Return the UTF-8 pointer C<s> displaced by C<off> characters, either
4090 forward or backward.
4092 WARNING: do not use the following unless you *know* C<off> is within
4093 the UTF-8 data pointed to by C<s> *and* that on entry C<s> is aligned
4094 on the first byte of character or just after the last byte of a character.
4096 U8* utf8_hop(U8 *s, I32 off)
4099 Found in file utf8.c
4103 Return the length of the UTF-8 char encoded string C<s> in characters.
4104 Stops at C<e> (inclusive). If C<e E<lt> s> or if the scan would end
4105 up past C<e>, croaks.
4107 STRLEN utf8_length(U8* s, U8 *e)
4110 Found in file utf8.c
4114 Converts a string C<s> of length C<len> from UTF8 into byte encoding.
4115 Unlike C<bytes_to_utf8>, this over-writes the original string, and
4116 updates len to contain the new length.
4117 Returns zero on failure, setting C<len> to -1.
4119 NOTE: this function is experimental and may change or be
4120 removed without notice.
4122 U8* utf8_to_bytes(U8 *s, STRLEN *len)
4125 Found in file utf8.c
4129 Returns the native character value of the first character in the string C<s>
4130 which is assumed to be in UTF8 encoding; C<retlen> will be set to the
4131 length, in bytes, of that character.
4133 If C<s> does not point to a well-formed UTF8 character, zero is
4134 returned and retlen is set, if possible, to -1.
4136 UV utf8_to_uvchr(U8 *s, STRLEN* retlen)
4139 Found in file utf8.c
4143 Returns the Unicode code point of the first character in the string C<s>
4144 which is assumed to be in UTF8 encoding; C<retlen> will be set to the
4145 length, in bytes, of that character.
4147 This function should only be used when returned UV is considered
4148 an index into the Unicode semantic tables (e.g. swashes).
4150 If C<s> does not point to a well-formed UTF8 character, zero is
4151 returned and retlen is set, if possible, to -1.
4153 UV utf8_to_uvuni(U8 *s, STRLEN* retlen)
4156 Found in file utf8.c
4160 Adds the UTF8 representation of the Native codepoint C<uv> to the end
4161 of the string C<d>; C<d> should be have at least C<UTF8_MAXLEN+1> free
4162 bytes available. The return value is the pointer to the byte after the
4163 end of the new character. In other words,
4165 d = uvchr_to_utf8(d, uv);
4167 is the recommended wide native character-aware way of saying
4171 U8* uvchr_to_utf8(U8 *d, UV uv)
4174 Found in file utf8.c
4178 Adds the UTF8 representation of the Unicode codepoint C<uv> to the end
4179 of the string C<d>; C<d> should be have at least C<UTF8_MAXLEN+1> free
4180 bytes available. The return value is the pointer to the byte after the
4181 end of the new character. In other words,
4183 d = uvuni_to_utf8(d, uv);
4185 is the recommended Unicode-aware way of saying
4189 U8* uvuni_to_utf8(U8 *d, UV uv)
4192 Found in file utf8.c
4196 This is the XSUB-writer's interface to Perl's C<warn> function. Use this
4197 function the same way you use the C C<printf> function. See
4200 void warn(const char* pat, ...)
4203 Found in file util.c
4207 Push an integer onto the stack, extending the stack if necessary. Handles
4208 'set' magic. See C<PUSHi>.
4217 Push a double onto the stack, extending the stack if necessary. Handles
4218 'set' magic. See C<PUSHn>.
4227 Push a string onto the stack, extending the stack if necessary. The C<len>
4228 indicates the length of the string. Handles 'set' magic. See
4231 void XPUSHp(char* str, STRLEN len)
4238 Push an SV onto the stack, extending the stack if necessary. Does not
4239 handle 'set' magic. See C<PUSHs>.
4248 Push an unsigned integer onto the stack, extending the stack if necessary.
4258 Macro to declare an XSUB and its C parameter list. This is handled by
4262 Found in file XSUB.h
4266 Return from XSUB, indicating number of items on the stack. This is usually
4267 handled by C<xsubpp>.
4269 void XSRETURN(int nitems)
4272 Found in file XSUB.h
4274 =item XSRETURN_EMPTY
4276 Return an empty list from an XSUB immediately.
4281 Found in file XSUB.h
4285 Return an integer from an XSUB immediately. Uses C<XST_mIV>.
4287 void XSRETURN_IV(IV iv)
4290 Found in file XSUB.h
4294 Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
4299 Found in file XSUB.h
4303 Return an double from an XSUB immediately. Uses C<XST_mNV>.
4305 void XSRETURN_NV(NV nv)
4308 Found in file XSUB.h
4312 Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
4314 void XSRETURN_PV(char* str)
4317 Found in file XSUB.h
4319 =item XSRETURN_UNDEF
4321 Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
4326 Found in file XSUB.h
4330 Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
4335 Found in file XSUB.h
4339 Place an integer into the specified position C<pos> on the stack. The
4340 value is stored in a new mortal SV.
4342 void XST_mIV(int pos, IV iv)
4345 Found in file XSUB.h
4349 Place C<&PL_sv_no> into the specified position C<pos> on the
4352 void XST_mNO(int pos)
4355 Found in file XSUB.h
4359 Place a double into the specified position C<pos> on the stack. The value
4360 is stored in a new mortal SV.
4362 void XST_mNV(int pos, NV nv)
4365 Found in file XSUB.h
4369 Place a copy of a string into the specified position C<pos> on the stack.
4370 The value is stored in a new mortal SV.
4372 void XST_mPV(int pos, char* str)
4375 Found in file XSUB.h
4379 Place C<&PL_sv_undef> into the specified position C<pos> on the
4382 void XST_mUNDEF(int pos)
4385 Found in file XSUB.h
4389 Place C<&PL_sv_yes> into the specified position C<pos> on the
4392 void XST_mYES(int pos)
4395 Found in file XSUB.h
4399 The version identifier for an XS module. This is usually
4400 handled automatically by C<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>.
4403 Found in file XSUB.h
4405 =item XS_VERSION_BOOTCHECK
4407 Macro to verify that a PM module's $VERSION variable matches the XS
4408 module's C<XS_VERSION> variable. This is usually handled automatically by
4409 C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">.
4411 XS_VERSION_BOOTCHECK;
4414 Found in file XSUB.h
4418 The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the
4419 destination, C<nitems> is the number of items, and C<type> is the type.
4421 void Zero(void* dest, int nitems, type)
4424 Found in file handy.h
4430 Until May 1997, this document was maintained by Jeff Okamoto
4431 <okamoto@corp.hp.com>. It is now maintained as part of Perl itself.
4433 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
4434 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
4435 Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
4436 Stephen McCamant, and Gurusamy Sarathy.
4438 API Listing originally by Dean Roehrich <roehrich@cray.com>.
4440 Updated to be autogenerated from comments in the source by Benjamin Stuhl.
4444 perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
projects / p5sagit/p5-mst-13.2.git / blob