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 Fill the sv with current working directory
482 int getcwd_sv(SV* sv)
489 Returns the AV of the specified Perl array. If C<create> is set and the
490 Perl variable does not exist then it will be created. If C<create> is not
491 set and the variable does not exist then NULL is returned.
493 NOTE: the perl_ form of this function is deprecated.
495 AV* get_av(const char* name, I32 create)
502 Returns the CV of the specified Perl subroutine. If C<create> is set and
503 the Perl subroutine does not exist then it will be declared (which has the
504 same effect as saying C<sub name;>). If C<create> is not set and the
505 subroutine does not exist then NULL is returned.
507 NOTE: the perl_ form of this function is deprecated.
509 CV* get_cv(const char* name, I32 create)
516 Returns the HV of the specified Perl hash. If C<create> is set and the
517 Perl variable does not exist then it will be created. If C<create> is not
518 set and the variable does not exist then NULL is returned.
520 NOTE: the perl_ form of this function is deprecated.
522 HV* get_hv(const char* name, I32 create)
529 Returns the SV of the specified Perl scalar. If C<create> is set and the
530 Perl variable does not exist then it will be created. If C<create> is not
531 set and the variable does not exist then NULL is returned.
533 NOTE: the perl_ form of this function is deprecated.
535 SV* get_sv(const char* name, I32 create)
542 A backward-compatible version of C<GIMME_V> which can only return
543 C<G_SCALAR> or C<G_ARRAY>; in a void context, it returns C<G_SCALAR>.
544 Deprecated. Use C<GIMME_V> instead.
553 The XSUB-writer's equivalent to Perl's C<wantarray>. Returns C<G_VOID>,
554 C<G_SCALAR> or C<G_ARRAY> for void, scalar or list context,
564 converts a string representing a binary number to numeric form.
566 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
567 conversion flags, and I<result> should be NULL or a pointer to an NV.
568 The scan stops at the end of the string, or the first invalid character.
569 On return I<*len> is set to the length scanned string, and I<*flags> gives
572 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
573 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_bin>
574 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
575 and writes the value to I<*result> (or the value is discarded if I<result>
578 The hex number may optinally be prefixed with "0b" or "b". If
579 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> on entry then the binary
580 number may use '_' characters to separate digits.
582 UV grok_bin(char* start, STRLEN* len, I32* flags, NV *result)
585 Found in file numeric.c
589 converts a string representing a hex number to numeric form.
591 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
592 conversion flags, and I<result> should be NULL or a pointer to an NV.
593 The scan stops at the end of the string, or the first non-hex-digit character.
594 On return I<*len> is set to the length scanned string, and I<*flags> gives
597 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
598 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_hex>
599 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
600 and writes the value to I<*result> (or the value is discarded if I<result>
603 The hex number may optinally be prefixed with "0x" or "x". If
604 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> on entry then the hex
605 number may use '_' characters to separate digits.
607 UV grok_hex(char* start, STRLEN* len, I32* flags, NV *result)
610 Found in file numeric.c
614 Recognise (or not) a number. The type of the number is returned
615 (0 if unrecognised), otherwise it is a bit-ORed combination of
616 IS_NUMBER_IN_UV, IS_NUMBER_GREATER_THAN_UV_MAX, IS_NUMBER_NOT_INT,
617 IS_NUMBER_NEG, IS_NUMBER_INFINITY, IS_NUMBER_NAN (defined in perl.h).
619 If the value of the number can fit an in UV, it is returned in the *valuep
620 IS_NUMBER_IN_UV will be set to indicate that *valuep is valid, IS_NUMBER_IN_UV
621 will never be set unless *valuep is valid, but *valuep may have been assigned
622 to during processing even though IS_NUMBER_IN_UV is not set on return.
623 If valuep is NULL, IS_NUMBER_IN_UV will be set for the same cases as when
624 valuep is non-NULL, but no actual assignment (or SEGV) will occur.
626 IS_NUMBER_NOT_INT will be set with IS_NUMBER_IN_UV if trailing decimals were
627 seen (in which case *valuep gives the true value truncated to an integer), and
628 IS_NUMBER_NEG if the number is negative (in which case *valuep holds the
629 absolute value). IS_NUMBER_IN_UV is not set if e notation was used or the
630 number is larger than a UV.
632 int grok_number(const char *pv, STRLEN len, UV *valuep)
635 Found in file numeric.c
637 =item grok_numeric_radix
639 Scan and skip for a numeric decimal separator (radix).
641 bool grok_numeric_radix(const char **sp, const char *send)
644 Found in file numeric.c
649 UV grok_oct(char* start, STRLEN* len, I32* flags, NV *result)
652 Found in file numeric.c
656 Return the SV from the GV.
665 Returns the glob with the given C<name> and a defined subroutine or
666 C<NULL>. The glob lives in the given C<stash>, or in the stashes
667 accessible via @ISA and UNIVERSAL::.
669 The argument C<level> should be either 0 or -1. If C<level==0>, as a
670 side-effect creates a glob with the given C<name> in the given C<stash>
671 which in the case of success contains an alias for the subroutine, and sets
672 up caching info for this glob. Similarly for all the searched stashes.
674 This function grants C<"SUPER"> token as a postfix of the stash name. The
675 GV returned from C<gv_fetchmeth> may be a method cache entry, which is not
676 visible to Perl code. So when calling C<call_sv>, you should not use
677 the GV directly; instead, you should use the method's CV, which can be
678 obtained from the GV with the C<GvCV> macro.
680 GV* gv_fetchmeth(HV* stash, const char* name, STRLEN len, I32 level)
687 See L<gv_fetchmethod_autoload>.
689 GV* gv_fetchmethod(HV* stash, const char* name)
694 =item gv_fetchmethod_autoload
696 Returns the glob which contains the subroutine to call to invoke the method
697 on the C<stash>. In fact in the presence of autoloading this may be the
698 glob for "AUTOLOAD". In this case the corresponding variable $AUTOLOAD is
701 The third parameter of C<gv_fetchmethod_autoload> determines whether
702 AUTOLOAD lookup is performed if the given method is not present: non-zero
703 means yes, look for AUTOLOAD; zero means no, don't look for AUTOLOAD.
704 Calling C<gv_fetchmethod> is equivalent to calling C<gv_fetchmethod_autoload>
705 with a non-zero C<autoload> parameter.
707 These functions grant C<"SUPER"> token as a prefix of the method name. Note
708 that if you want to keep the returned glob for a long time, you need to
709 check for it being "AUTOLOAD", since at the later time the call may load a
710 different subroutine due to $AUTOLOAD changing its value. Use the glob
711 created via a side effect to do this.
713 These functions have the same side-effects and as C<gv_fetchmeth> with
714 C<level==0>. C<name> should be writable if contains C<':'> or C<'
715 ''>. The warning against passing the GV returned by C<gv_fetchmeth> to
716 C<call_sv> apply equally to these functions.
718 GV* gv_fetchmethod_autoload(HV* stash, const char* name, I32 autoload)
725 Returns a pointer to the stash for a specified package. C<name> should
726 be a valid UTF-8 string. If C<create> is set then the package will be
727 created if it does not already exist. If C<create> is not set and the
728 package does not exist then NULL is returned.
730 HV* gv_stashpv(const char* name, I32 create)
737 Returns a pointer to the stash for a specified package, which must be a
738 valid UTF-8 string. See C<gv_stashpv>.
740 HV* gv_stashsv(SV* sv, I32 create)
747 Used to indicate list context. See C<GIMME_V>, C<GIMME> and
755 Indicates that arguments returned from a callback should be discarded. See
763 Used to force a Perl C<eval> wrapper around a callback. See
771 Indicates that no arguments are being sent to a callback. See
779 Used to indicate scalar context. See C<GIMME_V>, C<GIMME>, and
787 Used to indicate void context. See C<GIMME_V> and L<perlcall>.
794 This flag, used in the length slot of hash entries and magic structures,
795 specifies the structure contains a C<SV*> pointer where a C<char*> pointer
796 is to be expected. (For information only--not to be used).
803 Returns the computed hash stored in the hash entry.
812 Returns the actual pointer stored in the key slot of the hash entry. The
813 pointer may be either C<char*> or C<SV*>, depending on the value of
814 C<HeKLEN()>. Can be assigned to. The C<HePV()> or C<HeSVKEY()> macros are
815 usually preferable for finding the value of a key.
824 If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry
825 holds an C<SV*> key. Otherwise, holds the actual length of the key. Can
826 be assigned to. The C<HePV()> macro is usually preferable for finding key
829 STRLEN HeKLEN(HE* he)
836 Returns the key slot of the hash entry as a C<char*> value, doing any
837 necessary dereferencing of possibly C<SV*> keys. The length of the string
838 is placed in C<len> (this is a macro, so do I<not> use C<&len>). If you do
839 not care about what the length of the key is, you may use the global
840 variable C<PL_na>, though this is rather less efficient than using a local
841 variable. Remember though, that hash keys in perl are free to contain
842 embedded nulls, so using C<strlen()> or similar is not a good way to find
843 the length of hash keys. This is very similar to the C<SvPV()> macro
844 described elsewhere in this document.
846 char* HePV(HE* he, STRLEN len)
853 Returns the key as an C<SV*>, or C<Nullsv> if the hash entry does not
854 contain an C<SV*> key.
863 Returns the key as an C<SV*>. Will create and return a temporary mortal
864 C<SV*> if the hash entry contains only a C<char*> key.
866 SV* HeSVKEY_force(HE* he)
873 Sets the key to a given C<SV*>, taking care to set the appropriate flags to
874 indicate the presence of an C<SV*> key, and returns the same
877 SV* HeSVKEY_set(HE* he, SV* sv)
884 Returns the value slot (type C<SV*>) stored in the hash entry.
893 Returns the package name of a stash. See C<SvSTASH>, C<CvSTASH>.
895 char* HvNAME(HV* stash)
902 Clears a hash, making it empty.
904 void hv_clear(HV* tb)
911 Deletes a key/value pair in the hash. The value SV is removed from the
912 hash and returned to the caller. The C<klen> is the length of the key.
913 The C<flags> value will normally be zero; if set to G_DISCARD then NULL
916 SV* hv_delete(HV* tb, const char* key, I32 klen, I32 flags)
923 Deletes a key/value pair in the hash. The value SV is removed from the
924 hash and returned to the caller. The C<flags> value will normally be zero;
925 if set to G_DISCARD then NULL will be returned. C<hash> can be a valid
926 precomputed hash value, or 0 to ask for it to be computed.
928 SV* hv_delete_ent(HV* tb, SV* key, I32 flags, U32 hash)
935 Returns a boolean indicating whether the specified hash key exists. The
936 C<klen> is the length of the key.
938 bool hv_exists(HV* tb, const char* key, I32 klen)
945 Returns a boolean indicating whether the specified hash key exists. C<hash>
946 can be a valid precomputed hash value, or 0 to ask for it to be
949 bool hv_exists_ent(HV* tb, SV* key, U32 hash)
956 Returns the SV which corresponds to the specified key in the hash. The
957 C<klen> is the length of the key. If C<lval> is set then the fetch will be
958 part of a store. Check that the return value is non-null before
959 dereferencing it to a C<SV*>.
961 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
962 information on how to use this function on tied hashes.
964 SV** hv_fetch(HV* tb, const char* key, I32 klen, I32 lval)
971 Returns the hash entry which corresponds to the specified key in the hash.
972 C<hash> must be a valid precomputed hash number for the given C<key>, or 0
973 if you want the function to compute it. IF C<lval> is set then the fetch
974 will be part of a store. Make sure the return value is non-null before
975 accessing it. The return value when C<tb> is a tied hash is a pointer to a
976 static location, so be sure to make a copy of the structure if you need to
979 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
980 information on how to use this function on tied hashes.
982 HE* hv_fetch_ent(HV* tb, SV* key, I32 lval, U32 hash)
989 Prepares a starting point to traverse a hash table. Returns the number of
990 keys in the hash (i.e. the same as C<HvKEYS(tb)>). The return value is
991 currently only meaningful for hashes without tie magic.
993 NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
994 hash buckets that happen to be in use. If you still need that esoteric
995 value, you can get it through the macro C<HvFILL(tb)>.
997 I32 hv_iterinit(HV* tb)
1004 Returns the key from the current position of the hash iterator. See
1007 char* hv_iterkey(HE* entry, I32* retlen)
1014 Returns the key as an C<SV*> from the current position of the hash
1015 iterator. The return value will always be a mortal copy of the key. Also
1018 SV* hv_iterkeysv(HE* entry)
1025 Returns entries from a hash iterator. See C<hv_iterinit>.
1027 HE* hv_iternext(HV* tb)
1034 Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
1037 SV* hv_iternextsv(HV* hv, char** key, I32* retlen)
1044 Returns the value from the current position of the hash iterator. See
1047 SV* hv_iterval(HV* tb, HE* entry)
1054 Adds magic to a hash. See C<sv_magic>.
1056 void hv_magic(HV* hv, GV* gv, int how)
1063 Stores an SV in a hash. The hash key is specified as C<key> and C<klen> is
1064 the length of the key. The C<hash> parameter is the precomputed hash
1065 value; if it is zero then Perl will compute it. The return value will be
1066 NULL if the operation failed or if the value did not need to be actually
1067 stored within the hash (as in the case of tied hashes). Otherwise it can
1068 be dereferenced to get the original C<SV*>. Note that the caller is
1069 responsible for suitably incrementing the reference count of C<val> before
1070 the call, and decrementing it if the function returned NULL.
1072 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1073 information on how to use this function on tied hashes.
1075 SV** hv_store(HV* tb, const char* key, I32 klen, SV* val, U32 hash)
1082 Stores C<val> in a hash. The hash key is specified as C<key>. The C<hash>
1083 parameter is the precomputed hash value; if it is zero then Perl will
1084 compute it. The return value is the new hash entry so created. It will be
1085 NULL if the operation failed or if the value did not need to be actually
1086 stored within the hash (as in the case of tied hashes). Otherwise the
1087 contents of the return value can be accessed using the C<He?> macros
1088 described here. Note that the caller is responsible for suitably
1089 incrementing the reference count of C<val> before the call, and
1090 decrementing it if the function returned NULL.
1092 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1093 information on how to use this function on tied hashes.
1095 HE* hv_store_ent(HV* tb, SV* key, SV* val, U32 hash)
1104 void hv_undef(HV* tb)
1111 Returns a boolean indicating whether the C C<char> is an ASCII alphanumeric
1112 character (including underscore) or digit.
1114 bool isALNUM(char ch)
1117 Found in file handy.h
1121 Returns a boolean indicating whether the C C<char> is an ASCII alphabetic
1124 bool isALPHA(char ch)
1127 Found in file handy.h
1131 Returns a boolean indicating whether the C C<char> is an ASCII
1134 bool isDIGIT(char ch)
1137 Found in file handy.h
1141 Returns a boolean indicating whether the C C<char> is a lowercase
1144 bool isLOWER(char ch)
1147 Found in file handy.h
1151 Returns a boolean indicating whether the C C<char> is whitespace.
1153 bool isSPACE(char ch)
1156 Found in file handy.h
1160 Returns a boolean indicating whether the C C<char> is an uppercase
1163 bool isUPPER(char ch)
1166 Found in file handy.h
1170 Tests if some arbitrary number of bytes begins in a valid UTF-8
1171 character. Note that an INVARIANT (i.e. ASCII) character is a valid UTF-8 character.
1172 The actual number of bytes in the UTF-8 character will be returned if
1173 it is valid, otherwise 0.
1175 STRLEN is_utf8_char(U8 *p)
1178 Found in file utf8.c
1180 =item is_utf8_string
1182 Returns true if first C<len> bytes of the given string form a valid UTF8
1183 string, false otherwise. Note that 'a valid UTF8 string' does not mean
1184 'a string that contains UTF8' because a valid ASCII string is a valid
1187 bool is_utf8_string(U8 *s, STRLEN len)
1190 Found in file utf8.c
1194 Variable which is setup by C<xsubpp> to indicate the number of
1195 items on the stack. See L<perlxs/"Variable-length Parameter Lists">.
1200 Found in file XSUB.h
1204 Variable which is setup by C<xsubpp> to indicate which of an
1205 XSUB's aliases was used to invoke it. See L<perlxs/"The ALIAS: Keyword">.
1210 Found in file XSUB.h
1214 Closing bracket on a callback. See C<ENTER> and L<perlcall>.
1219 Found in file scope.h
1223 Loads the module whose name is pointed to by the string part of name.
1224 Note that the actual module name, not its filename, should be given.
1225 Eg, "Foo::Bar" instead of "Foo/Bar.pm". flags can be any of
1226 PERL_LOADMOD_DENY, PERL_LOADMOD_NOIMPORT, or PERL_LOADMOD_IMPORT_OPS
1227 (or 0 for no flags). ver, if specified, provides version semantics
1228 similar to C<use Foo::Bar VERSION>. The optional trailing SV*
1229 arguments can be used to specify arguments to the module's import()
1230 method, similar to C<use Foo::Bar VERSION LIST>.
1232 void load_module(U32 flags, SV* name, SV* ver, ...)
1237 =item looks_like_number
1239 Test if the content of an SV looks like a number (or is a number).
1240 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1241 non-numeric warning), even if your atof() doesn't grok them.
1243 I32 looks_like_number(SV* sv)
1250 Stack marker variable for the XSUB. See C<dMARK>.
1257 Clear something magical that the SV represents. See C<sv_magic>.
1259 int mg_clear(SV* sv)
1266 Copies the magic from one SV to another. See C<sv_magic>.
1268 int mg_copy(SV* sv, SV* nsv, const char* key, I32 klen)
1275 Finds the magic pointer for type matching the SV. See C<sv_magic>.
1277 MAGIC* mg_find(SV* sv, int type)
1284 Free any magic storage used by the SV. See C<sv_magic>.
1293 Do magic after a value is retrieved from the SV. See C<sv_magic>.
1302 Report on the SV's length. See C<sv_magic>.
1304 U32 mg_length(SV* sv)
1311 Turns on the magical status of an SV. See C<sv_magic>.
1313 void mg_magical(SV* sv)
1320 Do magic after a value is assigned to the SV. See C<sv_magic>.
1329 The XSUB-writer's interface to the C C<memmove> function. The C<src> is the
1330 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1331 the type. Can do overlapping moves. See also C<Copy>.
1333 void Move(void* src, void* dest, int nitems, type)
1336 Found in file handy.h
1340 The XSUB-writer's interface to the C C<malloc> function.
1342 void New(int id, void* ptr, int nitems, type)
1345 Found in file handy.h
1349 Creates a new AV. The reference count is set to 1.
1358 The XSUB-writer's interface to the C C<malloc> function, with
1361 void Newc(int id, void* ptr, int nitems, type, cast)
1364 Found in file handy.h
1368 Creates a constant sub equivalent to Perl C<sub FOO () { 123 }> which is
1369 eligible for inlining at compile-time.
1371 CV* newCONSTSUB(HV* stash, char* name, SV* sv)
1378 Creates a new HV. The reference count is set to 1.
1387 Creates an RV wrapper for an SV. The reference count for the original SV is
1390 SV* newRV_inc(SV* sv)
1397 Creates an RV wrapper for an SV. The reference count for the original
1398 SV is B<not> incremented.
1400 SV* newRV_noinc(SV *sv)
1407 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
1408 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
1411 SV* newSV(STRLEN len)
1418 Creates a new SV. A non-zero C<len> parameter indicates the number of
1419 bytes of preallocated string space the SV should have. An extra byte for a
1420 tailing NUL is also reserved. (SvPOK is not set for the SV even if string
1421 space is allocated.) The reference count for the new SV is set to 1.
1422 C<id> is an integer id between 0 and 1299 (used to identify leaks).
1424 SV* NEWSV(int id, STRLEN len)
1427 Found in file handy.h
1431 Creates a new SV and copies an integer into it. The reference count for the
1441 Creates a new SV and copies a floating point value into it.
1442 The reference count for the SV is set to 1.
1451 Creates a new SV and copies a string into it. The reference count for the
1452 SV is set to 1. If C<len> is zero, Perl will compute the length using
1453 strlen(). For efficiency, consider using C<newSVpvn> instead.
1455 SV* newSVpv(const char* s, STRLEN len)
1462 Creates a new SV and initializes it with the string formatted like
1465 SV* newSVpvf(const char* pat, ...)
1472 Creates a new SV and copies a string into it. The reference count for the
1473 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
1474 string. You are responsible for ensuring that the source string is at least
1477 SV* newSVpvn(const char* s, STRLEN len)
1482 =item newSVpvn_share
1484 Creates a new SV with its SvPVX pointing to a shared string in the string
1485 table. If the string does not already exist in the table, it is created
1486 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
1487 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
1488 otherwise the hash is computed. The idea here is that as the string table
1489 is used for shared hash keys these strings will have SvPVX == HeKEY and
1490 hash lookup will avoid string compare.
1492 SV* newSVpvn_share(const char* s, I32 len, U32 hash)
1499 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
1500 it will be upgraded to one. If C<classname> is non-null then the new SV will
1501 be blessed in the specified package. The new SV is returned and its
1502 reference count is 1.
1504 SV* newSVrv(SV* rv, const char* classname)
1511 Creates a new SV which is an exact duplicate of the original SV.
1514 SV* newSVsv(SV* old)
1521 Creates a new SV and copies an unsigned integer into it.
1522 The reference count for the SV is set to 1.
1531 Used by C<xsubpp> to hook up XSUBs as Perl subs.
1538 Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
1542 Found in file XSUB.h
1546 The XSUB-writer's interface to the C C<malloc> function. The allocated
1547 memory is zeroed with C<memzero>.
1549 void Newz(int id, void* ptr, int nitems, type)
1552 Found in file handy.h
1563 Null character pointer.
1566 Found in file handy.h
1587 Found in file handy.h
1591 The original stack mark for the XSUB. See C<dORIGMARK>.
1598 Allocates a new Perl interpreter. See L<perlembed>.
1600 PerlInterpreter* perl_alloc()
1603 Found in file perl.c
1607 Create and return a new interpreter by cloning the current one.
1609 PerlInterpreter* perl_clone(PerlInterpreter* interp, UV flags)
1614 =item perl_construct
1616 Initializes a new Perl interpreter. See L<perlembed>.
1618 void perl_construct(PerlInterpreter* interp)
1621 Found in file perl.c
1625 Shuts down a Perl interpreter. See L<perlembed>.
1627 int perl_destruct(PerlInterpreter* interp)
1630 Found in file perl.c
1634 Releases a Perl interpreter. See L<perlembed>.
1636 void perl_free(PerlInterpreter* interp)
1639 Found in file perl.c
1643 Tells a Perl interpreter to parse a Perl script. See L<perlembed>.
1645 int perl_parse(PerlInterpreter* interp, XSINIT_t xsinit, int argc, char** argv, char** env)
1648 Found in file perl.c
1652 Tells a Perl interpreter to run. See L<perlembed>.
1654 int perl_run(PerlInterpreter* interp)
1657 Found in file perl.c
1661 C<PL_modglobal> is a general purpose, interpreter global HV for use by
1662 extensions that need to keep information on a per-interpreter basis.
1663 In a pinch, it can also be used as a symbol table for extensions
1664 to share data among each other. It is a good idea to use keys
1665 prefixed by the package name of the extension that owns the data.
1670 Found in file intrpvar.h
1674 A convenience variable which is typically used with C<SvPV> when one
1675 doesn't care about the length of the string. It is usually more efficient
1676 to either declare a local variable and use that instead or to use the
1677 C<SvPV_nolen> macro.
1682 Found in file thrdvar.h
1686 This is the C<false> SV. See C<PL_sv_yes>. Always refer to this as
1692 Found in file intrpvar.h
1696 This is the C<undef> SV. Always refer to this as C<&PL_sv_undef>.
1701 Found in file intrpvar.h
1705 This is the C<true> SV. See C<PL_sv_no>. Always refer to this as
1711 Found in file intrpvar.h
1715 Pops an integer off the stack.
1724 Pops a long off the stack.
1733 Pops a double off the stack.
1742 Pops a string off the stack. Deprecated. New code should provide
1743 a STRLEN n_a and use POPpx.
1752 Pops a string off the stack which must consist of bytes i.e. characters < 256.
1753 Requires a variable STRLEN n_a in scope.
1762 Pops a string off the stack.
1763 Requires a variable STRLEN n_a in scope.
1772 Pops an SV off the stack.
1781 Push an integer onto the stack. The stack must have room for this element.
1782 Handles 'set' magic. See C<XPUSHi>.
1791 Opening bracket for arguments on a callback. See C<PUTBACK> and
1801 Push a double onto the stack. The stack must have room for this element.
1802 Handles 'set' magic. See C<XPUSHn>.
1811 Push a string onto the stack. The stack must have room for this element.
1812 The C<len> indicates the length of the string. Handles 'set' magic. See
1815 void PUSHp(char* str, STRLEN len)
1822 Push an SV onto the stack. The stack must have room for this element.
1823 Does not handle 'set' magic. See C<XPUSHs>.
1832 Push an unsigned integer onto the stack. The stack must have room for this
1833 element. See C<XPUSHu>.
1842 Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
1843 See C<PUSHMARK> and L<perlcall> for other uses.
1852 The XSUB-writer's interface to the C C<realloc> function.
1854 void Renew(void* ptr, int nitems, type)
1857 Found in file handy.h
1861 The XSUB-writer's interface to the C C<realloc> function, with
1864 void Renewc(void* ptr, int nitems, type, cast)
1867 Found in file handy.h
1871 Tells Perl to C<require> the file named by the string argument. It is
1872 analogous to the Perl code C<eval "require '$file'">. It's even
1873 implemented that way; consider using Perl_load_module instead.
1875 NOTE: the perl_ form of this function is deprecated.
1877 void require_pv(const char* pv)
1880 Found in file perl.c
1884 Variable which is setup by C<xsubpp> to hold the return value for an
1885 XSUB. This is always the proper type for the XSUB. See
1886 L<perlxs/"The RETVAL Variable">.
1891 Found in file XSUB.h
1895 The XSUB-writer's interface to the C C<free> function.
1897 void Safefree(void* ptr)
1900 Found in file handy.h
1904 Copy a string to a safe spot. This does not use an SV.
1906 char* savepv(const char* sv)
1909 Found in file util.c
1913 Copy a string to a safe spot. The C<len> indicates number of bytes to
1914 copy. This does not use an SV.
1916 char* savepvn(const char* sv, I32 len)
1919 Found in file util.c
1923 Opening bracket for temporaries on a callback. See C<FREETMPS> and
1929 Found in file scope.h
1933 For backwards compatibility. Use C<grok_bin> instead.
1935 NV scan_bin(char* start, STRLEN len, STRLEN* retlen)
1938 Found in file numeric.c
1942 For backwards compatibility. Use C<grok_hex> instead.
1944 NV scan_hex(char* start, STRLEN len, STRLEN* retlen)
1947 Found in file numeric.c
1951 For backwards compatibility. Use C<grok_oct> instead.
1953 NV scan_oct(char* start, STRLEN len, STRLEN* retlen)
1956 Found in file numeric.c
1960 Tries to find if a given SV has a shared backend, either by
1961 looking at magic, or by checking if it is tied again threads::shared.
1963 shared_sv* sharedsv_find(SV* sv)
1966 Found in file sharedsv.c
1970 Saves a space for keeping SVs wider than an interpreter,
1971 currently only stores a pointer to the first interpreter.
1973 void sharedsv_init()
1976 Found in file sharedsv.c
1980 Recursive locks on a sharedsv.
1981 Locks are dynamicly scoped at the level of the first lock.
1982 void sharedsv_lock(shared_sv* ssv)
1985 Found in file sharedsv.c
1989 Allocates a new shared sv struct, you must yourself create the SV/AV/HV.
1990 shared_sv* sharedsv_new()
1993 Found in file sharedsv.c
1995 =item sharedsv_thrcnt_dec
1997 Decrements the threadcount of a shared sv. When a threads frontend is freed
1998 this function should be called.
2000 void sharedsv_thrcnt_dec(shared_sv* ssv)
2003 Found in file sharedsv.c
2005 =item sharedsv_thrcnt_inc
2007 Increments the threadcount of a sharedsv.
2008 void sharedsv_thrcnt_inc(shared_sv* ssv)
2011 Found in file sharedsv.c
2013 =item sharedsv_unlock
2015 Recursively unlocks a shared sv.
2017 void sharedsv_unlock(shared_sv* ssv)
2020 Found in file sharedsv.c
2024 Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and
2032 Refetch the stack pointer. Used after a callback. See L<perlcall>.
2041 Used to access elements on the XSUB's stack.
2046 Found in file XSUB.h
2050 Test two strings to see if they are equal. Returns true or false.
2052 bool strEQ(char* s1, char* s2)
2055 Found in file handy.h
2059 Test two strings to see if the first, C<s1>, is greater than or equal to
2060 the second, C<s2>. Returns true or false.
2062 bool strGE(char* s1, char* s2)
2065 Found in file handy.h
2069 Test two strings to see if the first, C<s1>, is greater than the second,
2070 C<s2>. Returns true or false.
2072 bool strGT(char* s1, char* s2)
2075 Found in file handy.h
2079 Test two strings to see if the first, C<s1>, is less than or equal to the
2080 second, C<s2>. Returns true or false.
2082 bool strLE(char* s1, char* s2)
2085 Found in file handy.h
2089 Test two strings to see if the first, C<s1>, is less than the second,
2090 C<s2>. Returns true or false.
2092 bool strLT(char* s1, char* s2)
2095 Found in file handy.h
2099 Test two strings to see if they are different. Returns true or
2102 bool strNE(char* s1, char* s2)
2105 Found in file handy.h
2109 Test two strings to see if they are equal. The C<len> parameter indicates
2110 the number of bytes to compare. Returns true or false. (A wrapper for
2113 bool strnEQ(char* s1, char* s2, STRLEN len)
2116 Found in file handy.h
2120 Test two strings to see if they are different. The C<len> parameter
2121 indicates the number of bytes to compare. Returns true or false. (A
2122 wrapper for C<strncmp>).
2124 bool strnNE(char* s1, char* s2, STRLEN len)
2127 Found in file handy.h
2131 This is an architecture-independent macro to copy one structure to another.
2133 void StructCopy(type src, type dest, type)
2136 Found in file handy.h
2140 Returns the length of the string which is in the SV. See C<SvLEN>.
2142 STRLEN SvCUR(SV* sv)
2149 Set the length of the string which is in the SV. See C<SvCUR>.
2151 void SvCUR_set(SV* sv, STRLEN len)
2158 Returns a pointer to the last character in the string which is in the SV.
2159 See C<SvCUR>. Access the character as *(SvEND(sv)).
2168 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
2169 argument more than once.
2171 void SvGETMAGIC(SV* sv)
2178 Expands the character buffer in the SV so that it has room for the
2179 indicated number of bytes (remember to reserve space for an extra trailing
2180 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
2181 Returns a pointer to the character buffer.
2183 char * SvGROW(SV* sv, STRLEN len)
2190 Returns a boolean indicating whether the SV contains an integer.
2199 Returns a boolean indicating whether the SV contains an integer. Checks
2200 the B<private> setting. Use C<SvIOK>.
2209 Returns a boolean indicating whether the SV contains an signed integer.
2211 void SvIOK_notUV(SV* sv)
2218 Unsets the IV status of an SV.
2220 void SvIOK_off(SV* sv)
2227 Tells an SV that it is an integer.
2229 void SvIOK_on(SV* sv)
2236 Tells an SV that it is an integer and disables all other OK bits.
2238 void SvIOK_only(SV* sv)
2245 Tells and SV that it is an unsigned integer and disables all other OK bits.
2247 void SvIOK_only_UV(SV* sv)
2254 Returns a boolean indicating whether the SV contains an unsigned integer.
2256 void SvIOK_UV(SV* sv)
2263 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
2264 version which guarantees to evaluate sv only once.
2273 Returns the raw value in the SV's IV slot, without checks or conversions.
2274 Only use when you are sure SvIOK is true. See also C<SvIV()>.
2283 Coerces the given SV to an integer and returns it. Guarantees to evaluate
2284 sv only once. Use the more efficent C<SvIV> otherwise.
2293 Returns the size of the string buffer in the SV, not including any part
2294 attributable to C<SvOOK>. See C<SvCUR>.
2296 STRLEN SvLEN(SV* sv)
2303 Returns a boolean indicating whether the SV contains a number, integer or
2313 Returns a boolean indicating whether the SV contains a number, integer or
2314 double. Checks the B<private> setting. Use C<SvNIOK>.
2316 bool SvNIOKp(SV* sv)
2323 Unsets the NV/IV status of an SV.
2325 void SvNIOK_off(SV* sv)
2332 Returns a boolean indicating whether the SV contains a double.
2341 Returns a boolean indicating whether the SV contains a double. Checks the
2342 B<private> setting. Use C<SvNOK>.
2351 Unsets the NV status of an SV.
2353 void SvNOK_off(SV* sv)
2360 Tells an SV that it is a double.
2362 void SvNOK_on(SV* sv)
2369 Tells an SV that it is a double and disables all other OK bits.
2371 void SvNOK_only(SV* sv)
2378 Coerce the given SV to a double and return it. See C<SvNVx> for a version
2379 which guarantees to evaluate sv only once.
2388 Coerces the given SV to a double and returns it. Guarantees to evaluate
2389 sv only once. Use the more efficent C<SvNV> otherwise.
2398 Returns the raw value in the SV's NV slot, without checks or conversions.
2399 Only use when you are sure SvNOK is true. See also C<SvNV()>.
2408 Returns a boolean indicating whether the value is an SV.
2417 Returns a boolean indicating whether the SvIVX is a valid offset value for
2418 the SvPVX. This hack is used internally to speed up removal of characters
2419 from the beginning of a SvPV. When SvOOK is true, then the start of the
2420 allocated string buffer is really (SvPVX - SvIVX).
2429 Returns a boolean indicating whether the SV contains a character
2439 Returns a boolean indicating whether the SV contains a character string.
2440 Checks the B<private> setting. Use C<SvPOK>.
2449 Unsets the PV status of an SV.
2451 void SvPOK_off(SV* sv)
2458 Tells an SV that it is a string.
2460 void SvPOK_on(SV* sv)
2467 Tells an SV that it is a string and disables all other OK bits.
2468 Will also turn off the UTF8 status.
2470 void SvPOK_only(SV* sv)
2475 =item SvPOK_only_UTF8
2477 Tells an SV that it is a string and disables all other OK bits,
2478 and leaves the UTF8 status as it was.
2480 void SvPOK_only_UTF8(SV* sv)
2487 Returns a pointer to the string in the SV, or a stringified form of the SV
2488 if the SV does not contain a string. Handles 'get' magic. See also
2489 C<SvPVx> for a version which guarantees to evaluate sv only once.
2491 char* SvPV(SV* sv, STRLEN len)
2498 Like C<SvPV>, but converts sv to byte representation first if necessary.
2500 char* SvPVbyte(SV* sv, STRLEN len)
2507 Like C<SvPV>, but converts sv to byte representation first if necessary.
2508 Guarantees to evalute sv only once; use the more efficient C<SvPVbyte>
2512 char* SvPVbytex(SV* sv, STRLEN len)
2517 =item SvPVbytex_force
2519 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
2520 Guarantees to evalute sv only once; use the more efficient C<SvPVbyte_force>
2523 char* SvPVbytex_force(SV* sv, STRLEN len)
2528 =item SvPVbyte_force
2530 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
2532 char* SvPVbyte_force(SV* sv, STRLEN len)
2537 =item SvPVbyte_nolen
2539 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
2541 char* SvPVbyte_nolen(SV* sv, STRLEN len)
2548 Like C<SvPV>, but converts sv to uft8 first if necessary.
2550 char* SvPVutf8(SV* sv, STRLEN len)
2557 Like C<SvPV>, but converts sv to uft8 first if necessary.
2558 Guarantees to evalute sv only once; use the more efficient C<SvPVutf8>
2561 char* SvPVutf8x(SV* sv, STRLEN len)
2566 =item SvPVutf8x_force
2568 Like C<SvPV_force>, but converts sv to uft8 first if necessary.
2569 Guarantees to evalute sv only once; use the more efficient C<SvPVutf8_force>
2572 char* SvPVutf8x_force(SV* sv, STRLEN len)
2577 =item SvPVutf8_force
2579 Like C<SvPV_force>, but converts sv to uft8 first if necessary.
2581 char* SvPVutf8_force(SV* sv, STRLEN len)
2586 =item SvPVutf8_nolen
2588 Like C<SvPV_nolen>, but converts sv to uft8 first if necessary.
2590 char* SvPVutf8_nolen(SV* sv, STRLEN len)
2597 Returns a pointer to the physical string in the SV. The SV must contain a
2607 A version of C<SvPV> which guarantees to evaluate sv only once.
2609 char* SvPVx(SV* sv, STRLEN len)
2616 Like <SvPV> but will force the SV into becoming a string (SvPOK). You want
2617 force if you are going to update the SvPVX directly.
2619 char* SvPV_force(SV* sv, STRLEN len)
2624 =item SvPV_force_nomg
2626 Like <SvPV> but will force the SV into becoming a string (SvPOK). You want
2627 force if you are going to update the SvPVX directly. Doesn't process magic.
2629 char* SvPV_force_nomg(SV* sv, STRLEN len)
2636 Returns a pointer to the string in the SV, or a stringified form of the SV
2637 if the SV does not contain a string. Handles 'get' magic.
2639 char* SvPV_nolen(SV* sv)
2646 Returns the value of the object's reference count.
2648 U32 SvREFCNT(SV* sv)
2655 Decrements the reference count of the given SV.
2657 void SvREFCNT_dec(SV* sv)
2664 Increments the reference count of the given SV.
2666 SV* SvREFCNT_inc(SV* sv)
2673 Tests if the SV is an RV.
2682 Unsets the RV status of an SV.
2684 void SvROK_off(SV* sv)
2691 Tells an SV that it is an RV.
2693 void SvROK_on(SV* sv)
2700 Dereferences an RV to return the SV.
2709 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
2710 argument more than once.
2712 void SvSETMAGIC(SV* sv)
2719 Like C<SvSetSV>, but does any set magic required afterwards.
2721 void SvSetMagicSV(SV* dsb, SV* ssv)
2726 =item SvSetMagicSV_nosteal
2728 Like C<SvSetMagicSV>, but does any set magic required afterwards.
2730 void SvSetMagicSV_nosteal(SV* dsv, SV* ssv)
2737 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
2740 void SvSetSV(SV* dsb, SV* ssv)
2745 =item SvSetSV_nosteal
2747 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
2748 ssv. May evaluate arguments more than once.
2750 void SvSetSV_nosteal(SV* dsv, SV* ssv)
2757 Returns the stash of the SV.
2766 Taints an SV if tainting is enabled
2768 void SvTAINT(SV* sv)
2775 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
2778 bool SvTAINTED(SV* sv)
2785 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
2786 some of Perl's fundamental security features. XS module authors should not
2787 use this function unless they fully understand all the implications of
2788 unconditionally untainting the value. Untainting should be done in the
2789 standard perl fashion, via a carefully crafted regexp, rather than directly
2790 untainting variables.
2792 void SvTAINTED_off(SV* sv)
2799 Marks an SV as tainted.
2801 void SvTAINTED_on(SV* sv)
2808 Returns a boolean indicating whether Perl would evaluate the SV as true or
2809 false, defined or undefined. Does not handle 'get' magic.
2818 An enum of flags for Perl types. These are found in the file B<sv.h>
2819 in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
2826 Returns the type of the SV. See C<svtype>.
2828 svtype SvTYPE(SV* sv)
2835 Integer type flag for scalars. See C<svtype>.
2842 Double type flag for scalars. See C<svtype>.
2849 Pointer type flag for scalars. See C<svtype>.
2856 Type flag for arrays. See C<svtype>.
2863 Type flag for code refs. See C<svtype>.
2870 Type flag for hashes. See C<svtype>.
2877 Type flag for blessed scalars. See C<svtype>.
2884 Returns a boolean indicating whether the SV contains an unsigned integer.
2893 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
2894 perform the upgrade if necessary. See C<svtype>.
2896 void SvUPGRADE(SV* sv, svtype type)
2903 Returns a boolean indicating whether the SV contains UTF-8 encoded data.
2912 Unsets the UTF8 status of an SV.
2914 void SvUTF8_off(SV *sv)
2921 Turn on the UTF8 status of an SV (the data is not changed, just the flag).
2922 Do not use frivolously.
2924 void SvUTF8_on(SV *sv)
2931 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
2932 for a version which guarantees to evaluate sv only once.
2941 Returns the raw value in the SV's UV slot, without checks or conversions.
2942 Only use when you are sure SvIOK is true. See also C<SvUV()>.
2951 Coerces the given SV to an unsigned integer and returns it. Guarantees to
2952 evaluate sv only once. Use the more efficent C<SvUV> otherwise.
2961 This function is only called on magical items, and is only used by
2962 sv_true() or its macro equivalent.
2964 bool sv_2bool(SV* sv)
2971 Using various gambits, try to get a CV from an SV; in addition, try if
2972 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
2974 CV* sv_2cv(SV* sv, HV** st, GV** gvp, I32 lref)
2981 Using various gambits, try to get an IO from an SV: the IO slot if its a
2982 GV; or the recursive result if we're an RV; or the IO slot of the symbol
2983 named after the PV if we're a string.
2992 Return the integer value of an SV, doing any necessary string conversion,
2993 magic etc. Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
3002 Marks an existing SV as mortal. The SV will be destroyed "soon", either
3003 by an explicit call to FREETMPS, or by an implicit call at places such as
3004 statement boundaries. See also C<sv_newmortal> and C<sv_mortalcopy>.
3006 SV* sv_2mortal(SV* sv)
3013 Return the num value of an SV, doing any necessary string or integer
3014 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
3024 Return a pointer to the byte-encoded representation of the SV, and set *lp
3025 to its length. May cause the SV to be downgraded from UTF8 as a
3028 Usually accessed via the C<SvPVbyte> macro.
3030 char* sv_2pvbyte(SV* sv, STRLEN* lp)
3035 =item sv_2pvbyte_nolen
3037 Return a pointer to the byte-encoded representation of the SV.
3038 May cause the SV to be downgraded from UTF8 as a side-effect.
3040 Usually accessed via the C<SvPVbyte_nolen> macro.
3042 char* sv_2pvbyte_nolen(SV* sv)
3049 Return a pointer to the UTF8-encoded representation of the SV, and set *lp
3050 to its length. May cause the SV to be upgraded to UTF8 as a side-effect.
3052 Usually accessed via the C<SvPVutf8> macro.
3054 char* sv_2pvutf8(SV* sv, STRLEN* lp)
3059 =item sv_2pvutf8_nolen
3061 Return a pointer to the UTF8-encoded representation of the SV.
3062 May cause the SV to be upgraded to UTF8 as a side-effect.
3064 Usually accessed via the C<SvPVutf8_nolen> macro.
3066 char* sv_2pvutf8_nolen(SV* sv)
3073 Returns a pointer to the string value of an SV, and sets *lp to its length.
3074 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
3076 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
3077 usually end up here too.
3079 char* sv_2pv_flags(SV* sv, STRLEN* lp, I32 flags)
3086 Like C<sv_2pv()>, but doesn't return the length too. You should usually
3087 use the macro wrapper C<SvPV_nolen(sv)> instead.
3088 char* sv_2pv_nolen(SV* sv)
3095 Return the unsigned integer value of an SV, doing any necessary string
3096 conversion, magic etc. Normally used via the C<SvUV(sv)> and C<SvUVx(sv)>
3106 Remove any string offset. You should normally use the C<SvOOK_off> macro
3109 int sv_backoff(SV* sv)
3116 Blesses an SV into a specified package. The SV must be an RV. The package
3117 must be designated by its stash (see C<gv_stashpv()>). The reference count
3118 of the SV is unaffected.
3120 SV* sv_bless(SV* sv, HV* stash)
3127 Concatenates the string onto the end of the string which is in the SV.
3128 If the SV has the UTF8 status set, then the bytes appended should be
3129 valid UTF8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
3131 void sv_catpv(SV* sv, const char* ptr)
3138 Processes its arguments like C<sprintf> and appends the formatted
3139 output to an SV. If the appended data contains "wide" characters
3140 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
3141 and characters >255 formatted with %c), the original SV might get
3142 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic.
3143 C<SvSETMAGIC()> must typically be called after calling this function
3144 to handle 'set' magic.
3146 void sv_catpvf(SV* sv, const char* pat, ...)
3153 Like C<sv_catpvf>, but also handles 'set' magic.
3155 void sv_catpvf_mg(SV *sv, const char* pat, ...)
3162 Concatenates the string onto the end of the string which is in the SV. The
3163 C<len> indicates number of bytes to copy. If the SV has the UTF8
3164 status set, then the bytes appended should be valid UTF8.
3165 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
3167 void sv_catpvn(SV* sv, const char* ptr, STRLEN len)
3172 =item sv_catpvn_flags
3174 Concatenates the string onto the end of the string which is in the SV. The
3175 C<len> indicates number of bytes to copy. If the SV has the UTF8
3176 status set, then the bytes appended should be valid UTF8.
3177 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
3178 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
3179 in terms of this function.
3181 void sv_catpvn_flags(SV* sv, const char* ptr, STRLEN len, I32 flags)
3188 Like C<sv_catpvn>, but also handles 'set' magic.
3190 void sv_catpvn_mg(SV *sv, const char *ptr, STRLEN len)
3197 Like C<sv_catpv>, but also handles 'set' magic.
3199 void sv_catpv_mg(SV *sv, const char *ptr)
3206 Concatenates the string from SV C<ssv> onto the end of the string in
3207 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
3208 not 'set' magic. See C<sv_catsv_mg>.
3210 void sv_catsv(SV* dsv, SV* ssv)
3215 =item sv_catsv_flags
3217 Concatenates the string from SV C<ssv> onto the end of the string in
3218 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
3219 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
3220 and C<sv_catsv_nomg> are implemented in terms of this function.
3222 void sv_catsv_flags(SV* dsv, SV* ssv, I32 flags)
3229 Like C<sv_catsv>, but also handles 'set' magic.
3231 void sv_catsv_mg(SV *dstr, SV *sstr)
3238 Efficient removal of characters from the beginning of the string buffer.
3239 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
3240 the string buffer. The C<ptr> becomes the first character of the adjusted
3241 string. Uses the "OOK hack".
3243 void sv_chop(SV* sv, char* ptr)
3250 Clear an SV: call any destructors, free up any memory used by the body,
3251 and free the body itself. The SV's head is I<not> freed, although
3252 its type is set to all 1's so that it won't inadvertently be assumed
3253 to be live during global destruction etc.
3254 This function should only be called when REFCNT is zero. Most of the time
3255 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
3258 void sv_clear(SV* sv)
3265 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
3266 string in C<sv1> is less than, equal to, or greater than the string in
3267 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
3268 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
3270 I32 sv_cmp(SV* sv1, SV* sv2)
3277 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
3278 'use bytes' aware, handles get magic, and will coerce its args to strings
3279 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
3281 I32 sv_cmp_locale(SV* sv1, SV* sv2)
3288 Add Collate Transform magic to an SV if it doesn't already have it.
3290 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
3291 scalar data of the variable, but transformed to such a format that a normal
3292 memory comparison can be used to compare the data according to the locale
3295 char* sv_collxfrm(SV* sv, STRLEN* nxp)
3302 Auto-decrement of the value in the SV, doing string to numeric conversion
3303 if necessary. Handles 'get' magic.
3310 =item sv_derived_from
3312 Returns a boolean indicating whether the SV is derived from the specified
3313 class. This is the function that implements C<UNIVERSAL::isa>. It works
3314 for class names as well as for objects.
3316 bool sv_derived_from(SV* sv, const char* name)
3319 Found in file universal.c
3323 Returns a boolean indicating whether the strings in the two SVs are
3324 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
3325 coerce its args to strings if necessary.
3327 I32 sv_eq(SV* sv1, SV* sv2)
3332 =item sv_force_normal
3334 Undo various types of fakery on an SV: if the PV is a shared string, make
3335 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3336 an xpvmg. See also C<sv_force_normal_flags>.
3338 void sv_force_normal(SV *sv)
3343 =item sv_force_normal_flags
3345 Undo various types of fakery on an SV: if the PV is a shared string, make
3346 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3347 an xpvmg. The C<flags> parameter gets passed to C<sv_unref_flags()>
3348 when unrefing. C<sv_force_normal> calls this function with flags set to 0.
3350 void sv_force_normal_flags(SV *sv, U32 flags)
3357 Decrement an SV's reference count, and if it drops to zero, call
3358 C<sv_clear> to invoke destructors and free up any memory used by
3359 the body; finally, deallocate the SV's head itself.
3360 Normally called via a wrapper macro C<SvREFCNT_dec>.
3362 void sv_free(SV* sv)
3369 Get a line from the filehandle and store it into the SV, optionally
3370 appending to the currently-stored string.
3372 char* sv_gets(SV* sv, PerlIO* fp, I32 append)
3379 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
3380 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
3381 Use the C<SvGROW> wrapper instead.
3383 char* sv_grow(SV* sv, STRLEN newlen)
3390 Auto-increment of the value in the SV, doing string to numeric conversion
3391 if necessary. Handles 'get' magic.
3400 Inserts a string at the specified offset/length within the SV. Similar to
3401 the Perl substr() function.
3403 void sv_insert(SV* bigsv, STRLEN offset, STRLEN len, char* little, STRLEN littlelen)
3410 Returns a boolean indicating whether the SV is blessed into the specified
3411 class. This does not check for subtypes; use C<sv_derived_from> to verify
3412 an inheritance relationship.
3414 int sv_isa(SV* sv, const char* name)
3421 Returns a boolean indicating whether the SV is an RV pointing to a blessed
3422 object. If the SV is not an RV, or if the object is not blessed, then this
3425 int sv_isobject(SV* sv)
3432 A private implementation of the C<SvIVx> macro for compilers which can't
3433 cope with complex macro expressions. Always use the macro instead.
3442 Returns the length of the string in the SV. Handles magic and type
3443 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
3445 STRLEN sv_len(SV* sv)
3452 Returns the number of characters in the string in an SV, counting wide
3453 UTF8 bytes as a single character. Handles magic and type coercion.
3455 STRLEN sv_len_utf8(SV* sv)
3462 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
3463 then adds a new magic item of type C<how> to the head of the magic list.
3465 C<name> is assumed to contain an C<SV*> if C<(name && namelen == HEf_SVKEY)>
3467 void sv_magic(SV* sv, SV* obj, int how, const char* name, I32 namlen)
3474 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
3475 The new SV is marked as mortal. It will be destroyed "soon", either by an
3476 explicit call to FREETMPS, or by an implicit call at places such as
3477 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
3479 SV* sv_mortalcopy(SV* oldsv)
3486 Creates a new null SV which is mortal. The reference count of the SV is
3487 set to 1. It will be destroyed "soon", either by an explicit call to
3488 FREETMPS, or by an implicit call at places such as statement boundaries.
3489 See also C<sv_mortalcopy> and C<sv_2mortal>.
3498 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
3501 SV* sv_newref(SV* sv)
3508 A private implementation of the C<SvNVx> macro for compilers which can't
3509 cope with complex macro expressions. Always use the macro instead.
3518 Converts the value pointed to by offsetp from a count of bytes from the
3519 start of the string, to a count of the equivalent number of UTF8 chars.
3520 Handles magic and type coercion.
3522 void sv_pos_b2u(SV* sv, I32* offsetp)
3529 Converts the value pointed to by offsetp from a count of UTF8 chars from
3530 the start of the string, to a count of the equivalent number of bytes; if
3531 lenp is non-zero, it does the same to lenp, but this time starting from
3532 the offset, rather than from the start of the string. Handles magic and
3535 void sv_pos_u2b(SV* sv, I32* offsetp, I32* lenp)
3542 A private implementation of the C<SvPV_nolen> macro for compilers which can't
3543 cope with complex macro expressions. Always use the macro instead.
3552 A private implementation of the C<SvPVbyte_nolen> macro for compilers
3553 which can't cope with complex macro expressions. Always use the macro
3556 char* sv_pvbyte(SV *sv)
3563 A private implementation of the C<SvPVbyte> macro for compilers
3564 which can't cope with complex macro expressions. Always use the macro
3567 char* sv_pvbyten(SV *sv, STRLEN *len)
3572 =item sv_pvbyten_force
3574 A private implementation of the C<SvPVbytex_force> macro for compilers
3575 which can't cope with complex macro expressions. Always use the macro
3578 char* sv_pvbyten_force(SV* sv, STRLEN* lp)
3585 A private implementation of the C<SvPV> macro for compilers which can't
3586 cope with complex macro expressions. Always use the macro instead.
3588 char* sv_pvn(SV *sv, STRLEN *len)
3595 Get a sensible string out of the SV somehow.
3596 A private implementation of the C<SvPV_force> macro for compilers which
3597 can't cope with complex macro expressions. Always use the macro instead.
3599 char* sv_pvn_force(SV* sv, STRLEN* lp)
3604 =item sv_pvn_force_flags
3606 Get a sensible string out of the SV somehow.
3607 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
3608 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
3609 implemented in terms of this function.
3610 You normally want to use the various wrapper macros instead: see
3611 C<SvPV_force> and C<SvPV_force_nomg>
3613 char* sv_pvn_force_flags(SV* sv, STRLEN* lp, I32 flags)
3620 A private implementation of the C<SvPVutf8_nolen> macro for compilers
3621 which can't cope with complex macro expressions. Always use the macro
3624 char* sv_pvutf8(SV *sv)
3631 A private implementation of the C<SvPVutf8> macro for compilers
3632 which can't cope with complex macro expressions. Always use the macro
3635 char* sv_pvutf8n(SV *sv, STRLEN *len)
3640 =item sv_pvutf8n_force
3642 A private implementation of the C<SvPVutf8_force> macro for compilers
3643 which can't cope with complex macro expressions. Always use the macro
3646 char* sv_pvutf8n_force(SV* sv, STRLEN* lp)
3653 Returns a string describing what the SV is a reference to.
3655 char* sv_reftype(SV* sv, int ob)
3662 Make the first argument a copy of the second, then delete the original.
3663 The target SV physically takes over ownership of the body of the source SV
3664 and inherits its flags; however, the target keeps any magic it owns,
3665 and any magic in the source is discarded.
3666 Note that this is a rather specialist SV copying operation; most of the
3667 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
3669 void sv_replace(SV* sv, SV* nsv)
3674 =item sv_report_used
3676 Dump the contents of all SVs not yet freed. (Debugging aid).
3678 void sv_report_used()
3685 Underlying implementation for the C<reset> Perl function.
3686 Note that the perl-level function is vaguely deprecated.
3688 void sv_reset(char* s, HV* stash)
3695 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
3696 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
3697 push a back-reference to this RV onto the array of backreferences
3698 associated with that magic.
3700 SV* sv_rvweaken(SV *sv)
3707 Copies an integer into the given SV, upgrading first if necessary.
3708 Does not handle 'set' magic. See also C<sv_setiv_mg>.
3710 void sv_setiv(SV* sv, IV num)
3717 Like C<sv_setiv>, but also handles 'set' magic.
3719 void sv_setiv_mg(SV *sv, IV i)
3726 Copies a double into the given SV, upgrading first if necessary.
3727 Does not handle 'set' magic. See also C<sv_setnv_mg>.
3729 void sv_setnv(SV* sv, NV num)
3736 Like C<sv_setnv>, but also handles 'set' magic.
3738 void sv_setnv_mg(SV *sv, NV num)
3745 Copies a string into an SV. The string must be null-terminated. Does not
3746 handle 'set' magic. See C<sv_setpv_mg>.
3748 void sv_setpv(SV* sv, const char* ptr)
3755 Processes its arguments like C<sprintf> and sets an SV to the formatted
3756 output. Does not handle 'set' magic. See C<sv_setpvf_mg>.
3758 void sv_setpvf(SV* sv, const char* pat, ...)
3765 Like C<sv_setpvf>, but also handles 'set' magic.
3767 void sv_setpvf_mg(SV *sv, const char* pat, ...)
3774 Copies an integer into the given SV, also updating its string value.
3775 Does not handle 'set' magic. See C<sv_setpviv_mg>.
3777 void sv_setpviv(SV* sv, IV num)
3784 Like C<sv_setpviv>, but also handles 'set' magic.
3786 void sv_setpviv_mg(SV *sv, IV iv)
3793 Copies a string into an SV. The C<len> parameter indicates the number of
3794 bytes to be copied. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3796 void sv_setpvn(SV* sv, const char* ptr, STRLEN len)
3803 Like C<sv_setpvn>, but also handles 'set' magic.
3805 void sv_setpvn_mg(SV *sv, const char *ptr, STRLEN len)
3812 Like C<sv_setpv>, but also handles 'set' magic.
3814 void sv_setpv_mg(SV *sv, const char *ptr)
3821 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
3822 argument will be upgraded to an RV. That RV will be modified to point to
3823 the new SV. The C<classname> argument indicates the package for the
3824 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
3825 will be returned and will have a reference count of 1.
3827 SV* sv_setref_iv(SV* rv, const char* classname, IV iv)
3834 Copies a double into a new SV, optionally blessing the SV. The C<rv>
3835 argument will be upgraded to an RV. That RV will be modified to point to
3836 the new SV. The C<classname> argument indicates the package for the
3837 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
3838 will be returned and will have a reference count of 1.
3840 SV* sv_setref_nv(SV* rv, const char* classname, NV nv)
3847 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
3848 argument will be upgraded to an RV. That RV will be modified to point to
3849 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
3850 into the SV. The C<classname> argument indicates the package for the
3851 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
3852 will be returned and will have a reference count of 1.
3854 Do not use with other Perl types such as HV, AV, SV, CV, because those
3855 objects will become corrupted by the pointer copy process.
3857 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
3859 SV* sv_setref_pv(SV* rv, const char* classname, void* pv)
3866 Copies a string into a new SV, optionally blessing the SV. The length of the
3867 string must be specified with C<n>. The C<rv> argument will be upgraded to
3868 an RV. That RV will be modified to point to the new SV. The C<classname>
3869 argument indicates the package for the blessing. Set C<classname> to
3870 C<Nullch> to avoid the blessing. The new SV will be returned and will have
3871 a reference count of 1.
3873 Note that C<sv_setref_pv> copies the pointer while this copies the string.
3875 SV* sv_setref_pvn(SV* rv, const char* classname, char* pv, STRLEN n)
3882 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
3883 argument will be upgraded to an RV. That RV will be modified to point to
3884 the new SV. The C<classname> argument indicates the package for the
3885 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
3886 will be returned and will have a reference count of 1.
3888 SV* sv_setref_uv(SV* rv, const char* classname, UV uv)
3895 Copies the contents of the source SV C<ssv> into the destination SV
3896 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3897 function if the source SV needs to be reused. Does not handle 'set' magic.
3898 Loosely speaking, it performs a copy-by-value, obliterating any previous
3899 content of the destination.
3901 You probably want to use one of the assortment of wrappers, such as
3902 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3903 C<SvSetMagicSV_nosteal>.
3906 void sv_setsv(SV* dsv, SV* ssv)
3911 =item sv_setsv_flags
3913 Copies the contents of the source SV C<ssv> into the destination SV
3914 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3915 function if the source SV needs to be reused. Does not handle 'set' magic.
3916 Loosely speaking, it performs a copy-by-value, obliterating any previous
3917 content of the destination.
3918 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3919 C<ssv> if appropriate, else not. C<sv_setsv> and C<sv_setsv_nomg> are
3920 implemented in terms of this function.
3922 You probably want to use one of the assortment of wrappers, such as
3923 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3924 C<SvSetMagicSV_nosteal>.
3926 This is the primary function for copying scalars, and most other
3927 copy-ish functions and macros use this underneath.
3929 void sv_setsv_flags(SV* dsv, SV* ssv, I32 flags)
3936 Like C<sv_setsv>, but also handles 'set' magic.
3938 void sv_setsv_mg(SV *dstr, SV *sstr)
3945 Copies an unsigned integer into the given SV, upgrading first if necessary.
3946 Does not handle 'set' magic. See also C<sv_setuv_mg>.
3948 void sv_setuv(SV* sv, UV num)
3955 Like C<sv_setuv>, but also handles 'set' magic.
3957 void sv_setuv_mg(SV *sv, UV u)
3964 Taint an SV. Use C<SvTAINTED_on> instead.
3965 void sv_taint(SV* sv)
3972 Test an SV for taintedness. Use C<SvTAINTED> instead.
3973 bool sv_tainted(SV* sv)
3980 Returns true if the SV has a true value by Perl's rules.
3981 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
3982 instead use an in-line version.
3991 Removes all magic of type C<type> from an SV.
3993 int sv_unmagic(SV* sv, int type)
4000 Unsets the RV status of the SV, and decrements the reference count of
4001 whatever was being referenced by the RV. This can almost be thought of
4002 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
4003 being zero. See C<SvROK_off>.
4005 void sv_unref(SV* sv)
4010 =item sv_unref_flags
4012 Unsets the RV status of the SV, and decrements the reference count of
4013 whatever was being referenced by the RV. This can almost be thought of
4014 as a reversal of C<newSVrv>. The C<cflags> argument can contain
4015 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
4016 (otherwise the decrementing is conditional on the reference count being
4017 different from one or the reference being a readonly SV).
4020 void sv_unref_flags(SV* sv, U32 flags)
4027 Untaint an SV. Use C<SvTAINTED_off> instead.
4028 void sv_untaint(SV* sv)
4035 Upgrade an SV to a more complex form. Generally adds a new body type to the
4036 SV, then copies across as much information as possible from the old body.
4037 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
4039 bool sv_upgrade(SV* sv, U32 mt)
4046 Tells an SV to use C<ptr> to find its string value. Normally the string is
4047 stored inside the SV but sv_usepvn allows the SV to use an outside string.
4048 The C<ptr> should point to memory that was allocated by C<malloc>. The
4049 string length, C<len>, must be supplied. This function will realloc the
4050 memory pointed to by C<ptr>, so that pointer should not be freed or used by
4051 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
4052 See C<sv_usepvn_mg>.
4054 void sv_usepvn(SV* sv, char* ptr, STRLEN len)
4061 Like C<sv_usepvn>, but also handles 'set' magic.
4063 void sv_usepvn_mg(SV *sv, char *ptr, STRLEN len)
4068 =item sv_utf8_decode
4070 Convert the octets in the PV from UTF-8 to chars. Scan for validity and then
4071 turn off SvUTF8 if needed so that we see characters. Used as a building block
4072 for decode_utf8 in Encode.xs
4074 NOTE: this function is experimental and may change or be
4075 removed without notice.
4077 bool sv_utf8_decode(SV *sv)
4082 =item sv_utf8_downgrade
4084 Attempt to convert the PV of an SV from UTF8-encoded to byte encoding.
4085 This may not be possible if the PV contains non-byte encoding characters;
4086 if this is the case, either returns false or, if C<fail_ok> is not
4089 NOTE: this function is experimental and may change or be
4090 removed without notice.
4092 bool sv_utf8_downgrade(SV *sv, bool fail_ok)
4097 =item sv_utf8_encode
4099 Convert the PV of an SV to UTF8-encoded, but then turn off the C<SvUTF8>
4100 flag so that it looks like octets again. Used as a building block
4101 for encode_utf8 in Encode.xs
4103 void sv_utf8_encode(SV *sv)
4108 =item sv_utf8_upgrade
4110 Convert the PV of an SV to its UTF8-encoded form.
4111 Forces the SV to string form if it is not already.
4112 Always sets the SvUTF8 flag to avoid future validity checks even
4113 if all the bytes have hibit clear.
4115 STRLEN sv_utf8_upgrade(SV *sv)
4120 =item sv_utf8_upgrade_flags
4122 Convert the PV of an SV to its UTF8-encoded form.
4123 Forces the SV to string form if it is not already.
4124 Always sets the SvUTF8 flag to avoid future validity checks even
4125 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
4126 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
4127 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
4129 STRLEN sv_utf8_upgrade_flags(SV *sv, I32 flags)
4136 A private implementation of the C<SvUVx> macro for compilers which can't
4137 cope with complex macro expressions. Always use the macro instead.
4146 Processes its arguments like C<vsprintf> and appends the formatted output
4147 to an SV. Uses an array of SVs if the C style variable argument list is
4148 missing (NULL). When running with taint checks enabled, indicates via
4149 C<maybe_tainted> if results are untrustworthy (often due to the use of
4152 Usually used via one of its frontends C<sv_catpvf> and C<sv_catpvf_mg>.
4154 void sv_vcatpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
4161 Works like C<vcatpvfn> but copies the text into the SV instead of
4164 Usually used via one of its frontends C<sv_setpvf> and C<sv_setpvf_mg>.
4166 void sv_vsetpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
4173 Variable which is setup by C<xsubpp> to designate the object in a C++
4174 XSUB. This is always the proper type for the C++ object. See C<CLASS> and
4175 L<perlxs/"Using XS With C++">.
4180 Found in file XSUB.h
4184 Converts the specified character to lowercase.
4186 char toLOWER(char ch)
4189 Found in file handy.h
4193 Converts the specified character to uppercase.
4195 char toUPPER(char ch)
4198 Found in file handy.h
4200 =item utf8n_to_uvchr
4202 Returns the native character value of the first character in the string C<s>
4203 which is assumed to be in UTF8 encoding; C<retlen> will be set to the
4204 length, in bytes, of that character.
4206 Allows length and flags to be passed to low level routine.
4208 UV utf8n_to_uvchr(U8 *s, STRLEN curlen, STRLEN* retlen, U32 flags)
4211 Found in file utf8.c
4213 =item utf8n_to_uvuni
4215 Bottom level UTF-8 decode routine.
4216 Returns the unicode code point value of the first character in the string C<s>
4217 which is assumed to be in UTF8 encoding and no longer than C<curlen>;
4218 C<retlen> will be set to the length, in bytes, of that character.
4220 If C<s> does not point to a well-formed UTF8 character, the behaviour
4221 is dependent on the value of C<flags>: if it contains UTF8_CHECK_ONLY,
4222 it is assumed that the caller will raise a warning, and this function
4223 will silently just set C<retlen> to C<-1> and return zero. If the
4224 C<flags> does not contain UTF8_CHECK_ONLY, warnings about
4225 malformations will be given, C<retlen> will be set to the expected
4226 length of the UTF-8 character in bytes, and zero will be returned.
4228 The C<flags> can also contain various flags to allow deviations from
4229 the strict UTF-8 encoding (see F<utf8.h>).
4231 Most code should use utf8_to_uvchr() rather than call this directly.
4233 UV utf8n_to_uvuni(U8 *s, STRLEN curlen, STRLEN* retlen, U32 flags)
4236 Found in file utf8.c
4240 Returns the number of UTF8 characters between the UTF-8 pointers C<a>
4243 WARNING: use only if you *know* that the pointers point inside the
4246 IV utf8_distance(U8 *a, U8 *b)
4249 Found in file utf8.c
4253 Return the UTF-8 pointer C<s> displaced by C<off> characters, either
4254 forward or backward.
4256 WARNING: do not use the following unless you *know* C<off> is within
4257 the UTF-8 data pointed to by C<s> *and* that on entry C<s> is aligned
4258 on the first byte of character or just after the last byte of a character.
4260 U8* utf8_hop(U8 *s, I32 off)
4263 Found in file utf8.c
4267 Return the length of the UTF-8 char encoded string C<s> in characters.
4268 Stops at C<e> (inclusive). If C<e E<lt> s> or if the scan would end
4269 up past C<e>, croaks.
4271 STRLEN utf8_length(U8* s, U8 *e)
4274 Found in file utf8.c
4278 Converts a string C<s> of length C<len> from UTF8 into byte encoding.
4279 Unlike C<bytes_to_utf8>, this over-writes the original string, and
4280 updates len to contain the new length.
4281 Returns zero on failure, setting C<len> to -1.
4283 NOTE: this function is experimental and may change or be
4284 removed without notice.
4286 U8* utf8_to_bytes(U8 *s, STRLEN *len)
4289 Found in file utf8.c
4293 Returns the native character value of the first character in the string C<s>
4294 which is assumed to be in UTF8 encoding; C<retlen> will be set to the
4295 length, in bytes, of that character.
4297 If C<s> does not point to a well-formed UTF8 character, zero is
4298 returned and retlen is set, if possible, to -1.
4300 UV utf8_to_uvchr(U8 *s, STRLEN* retlen)
4303 Found in file utf8.c
4307 Returns the Unicode code point of the first character in the string C<s>
4308 which is assumed to be in UTF8 encoding; C<retlen> will be set to the
4309 length, in bytes, of that character.
4311 This function should only be used when returned UV is considered
4312 an index into the Unicode semantic tables (e.g. swashes).
4314 If C<s> does not point to a well-formed UTF8 character, zero is
4315 returned and retlen is set, if possible, to -1.
4317 UV utf8_to_uvuni(U8 *s, STRLEN* retlen)
4320 Found in file utf8.c
4324 Adds the UTF8 representation of the Native codepoint C<uv> to the end
4325 of the string C<d>; C<d> should be have at least C<UTF8_MAXLEN+1> free
4326 bytes available. The return value is the pointer to the byte after the
4327 end of the new character. In other words,
4329 d = uvchr_to_utf8(d, uv);
4331 is the recommended wide native character-aware way of saying
4335 U8* uvchr_to_utf8(U8 *d, UV uv)
4338 Found in file utf8.c
4342 Adds the UTF8 representation of the Unicode codepoint C<uv> to the end
4343 of the string C<d>; C<d> should be have at least C<UTF8_MAXLEN+1> free
4344 bytes available. The return value is the pointer to the byte after the
4345 end of the new character. In other words,
4347 d = uvuni_to_utf8(d, uv);
4349 is the recommended Unicode-aware way of saying
4353 U8* uvuni_to_utf8(U8 *d, UV uv)
4356 Found in file utf8.c
4360 This is the XSUB-writer's interface to Perl's C<warn> function. Use this
4361 function the same way you use the C C<printf> function. See
4364 void warn(const char* pat, ...)
4367 Found in file util.c
4371 Push an integer onto the stack, extending the stack if necessary. Handles
4372 'set' magic. See C<PUSHi>.
4381 Push a double onto the stack, extending the stack if necessary. Handles
4382 'set' magic. See C<PUSHn>.
4391 Push a string onto the stack, extending the stack if necessary. The C<len>
4392 indicates the length of the string. Handles 'set' magic. See
4395 void XPUSHp(char* str, STRLEN len)
4402 Push an SV onto the stack, extending the stack if necessary. Does not
4403 handle 'set' magic. See C<PUSHs>.
4412 Push an unsigned integer onto the stack, extending the stack if necessary.
4422 Macro to declare an XSUB and its C parameter list. This is handled by
4426 Found in file XSUB.h
4430 Return from XSUB, indicating number of items on the stack. This is usually
4431 handled by C<xsubpp>.
4433 void XSRETURN(int nitems)
4436 Found in file XSUB.h
4438 =item XSRETURN_EMPTY
4440 Return an empty list from an XSUB immediately.
4445 Found in file XSUB.h
4449 Return an integer from an XSUB immediately. Uses C<XST_mIV>.
4451 void XSRETURN_IV(IV iv)
4454 Found in file XSUB.h
4458 Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
4463 Found in file XSUB.h
4467 Return an double from an XSUB immediately. Uses C<XST_mNV>.
4469 void XSRETURN_NV(NV nv)
4472 Found in file XSUB.h
4476 Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
4478 void XSRETURN_PV(char* str)
4481 Found in file XSUB.h
4483 =item XSRETURN_UNDEF
4485 Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
4490 Found in file XSUB.h
4494 Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
4499 Found in file XSUB.h
4503 Place an integer into the specified position C<pos> on the stack. The
4504 value is stored in a new mortal SV.
4506 void XST_mIV(int pos, IV iv)
4509 Found in file XSUB.h
4513 Place C<&PL_sv_no> into the specified position C<pos> on the
4516 void XST_mNO(int pos)
4519 Found in file XSUB.h
4523 Place a double into the specified position C<pos> on the stack. The value
4524 is stored in a new mortal SV.
4526 void XST_mNV(int pos, NV nv)
4529 Found in file XSUB.h
4533 Place a copy of a string into the specified position C<pos> on the stack.
4534 The value is stored in a new mortal SV.
4536 void XST_mPV(int pos, char* str)
4539 Found in file XSUB.h
4543 Place C<&PL_sv_undef> into the specified position C<pos> on the
4546 void XST_mUNDEF(int pos)
4549 Found in file XSUB.h
4553 Place C<&PL_sv_yes> into the specified position C<pos> on the
4556 void XST_mYES(int pos)
4559 Found in file XSUB.h
4563 The version identifier for an XS module. This is usually
4564 handled automatically by C<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>.
4567 Found in file XSUB.h
4569 =item XS_VERSION_BOOTCHECK
4571 Macro to verify that a PM module's $VERSION variable matches the XS
4572 module's C<XS_VERSION> variable. This is usually handled automatically by
4573 C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">.
4575 XS_VERSION_BOOTCHECK;
4578 Found in file XSUB.h
4582 The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the
4583 destination, C<nitems> is the number of items, and C<type> is the type.
4585 void Zero(void* dest, int nitems, type)
4588 Found in file handy.h
4594 Until May 1997, this document was maintained by Jeff Okamoto
4595 <okamoto@corp.hp.com>. It is now maintained as part of Perl itself.
4597 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
4598 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
4599 Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
4600 Stephen McCamant, and Gurusamy Sarathy.
4602 API Listing originally by Dean Roehrich <roehrich@cray.com>.
4604 Updated to be autogenerated from comments in the source by Benjamin Stuhl.
4608 perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
projects / p5sagit/p5-mst-13.2.git / blob