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 optionally be prefixed with "0b" or "b" unless
579 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
580 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the binary
581 number may use '_' characters to separate digits.
583 UV grok_bin(char* start, STRLEN* len, I32* flags, NV *result)
586 Found in file numeric.c
590 converts a string representing a hex number to numeric form.
592 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
593 conversion flags, and I<result> should be NULL or a pointer to an NV.
594 The scan stops at the end of the string, or the first non-hex-digit character.
595 On return I<*len> is set to the length scanned string, and I<*flags> gives
598 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
599 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_hex>
600 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
601 and writes the value to I<*result> (or the value is discarded if I<result>
604 The hex number may optionally be prefixed with "0x" or "x" unless
605 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
606 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the hex
607 number may use '_' characters to separate digits.
609 UV grok_hex(char* start, STRLEN* len, I32* flags, NV *result)
612 Found in file numeric.c
616 Recognise (or not) a number. The type of the number is returned
617 (0 if unrecognised), otherwise it is a bit-ORed combination of
618 IS_NUMBER_IN_UV, IS_NUMBER_GREATER_THAN_UV_MAX, IS_NUMBER_NOT_INT,
619 IS_NUMBER_NEG, IS_NUMBER_INFINITY, IS_NUMBER_NAN (defined in perl.h).
621 If the value of the number can fit an in UV, it is returned in the *valuep
622 IS_NUMBER_IN_UV will be set to indicate that *valuep is valid, IS_NUMBER_IN_UV
623 will never be set unless *valuep is valid, but *valuep may have been assigned
624 to during processing even though IS_NUMBER_IN_UV is not set on return.
625 If valuep is NULL, IS_NUMBER_IN_UV will be set for the same cases as when
626 valuep is non-NULL, but no actual assignment (or SEGV) will occur.
628 IS_NUMBER_NOT_INT will be set with IS_NUMBER_IN_UV if trailing decimals were
629 seen (in which case *valuep gives the true value truncated to an integer), and
630 IS_NUMBER_NEG if the number is negative (in which case *valuep holds the
631 absolute value). IS_NUMBER_IN_UV is not set if e notation was used or the
632 number is larger than a UV.
634 int grok_number(const char *pv, STRLEN len, UV *valuep)
637 Found in file numeric.c
639 =item grok_numeric_radix
641 Scan and skip for a numeric decimal separator (radix).
643 bool grok_numeric_radix(const char **sp, const char *send)
646 Found in file numeric.c
651 UV grok_oct(char* start, STRLEN* len, I32* flags, NV *result)
654 Found in file numeric.c
658 Return the SV from the GV.
667 Returns the glob with the given C<name> and a defined subroutine or
668 C<NULL>. The glob lives in the given C<stash>, or in the stashes
669 accessible via @ISA and UNIVERSAL::.
671 The argument C<level> should be either 0 or -1. If C<level==0>, as a
672 side-effect creates a glob with the given C<name> in the given C<stash>
673 which in the case of success contains an alias for the subroutine, and sets
674 up caching info for this glob. Similarly for all the searched stashes.
676 This function grants C<"SUPER"> token as a postfix of the stash name. The
677 GV returned from C<gv_fetchmeth> may be a method cache entry, which is not
678 visible to Perl code. So when calling C<call_sv>, you should not use
679 the GV directly; instead, you should use the method's CV, which can be
680 obtained from the GV with the C<GvCV> macro.
682 GV* gv_fetchmeth(HV* stash, const char* name, STRLEN len, I32 level)
689 See L<gv_fetchmethod_autoload>.
691 GV* gv_fetchmethod(HV* stash, const char* name)
696 =item gv_fetchmethod_autoload
698 Returns the glob which contains the subroutine to call to invoke the method
699 on the C<stash>. In fact in the presence of autoloading this may be the
700 glob for "AUTOLOAD". In this case the corresponding variable $AUTOLOAD is
703 The third parameter of C<gv_fetchmethod_autoload> determines whether
704 AUTOLOAD lookup is performed if the given method is not present: non-zero
705 means yes, look for AUTOLOAD; zero means no, don't look for AUTOLOAD.
706 Calling C<gv_fetchmethod> is equivalent to calling C<gv_fetchmethod_autoload>
707 with a non-zero C<autoload> parameter.
709 These functions grant C<"SUPER"> token as a prefix of the method name. Note
710 that if you want to keep the returned glob for a long time, you need to
711 check for it being "AUTOLOAD", since at the later time the call may load a
712 different subroutine due to $AUTOLOAD changing its value. Use the glob
713 created via a side effect to do this.
715 These functions have the same side-effects and as C<gv_fetchmeth> with
716 C<level==0>. C<name> should be writable if contains C<':'> or C<'
717 ''>. The warning against passing the GV returned by C<gv_fetchmeth> to
718 C<call_sv> apply equally to these functions.
720 GV* gv_fetchmethod_autoload(HV* stash, const char* name, I32 autoload)
727 Returns a pointer to the stash for a specified package. C<name> should
728 be a valid UTF-8 string. If C<create> is set then the package will be
729 created if it does not already exist. If C<create> is not set and the
730 package does not exist then NULL is returned.
732 HV* gv_stashpv(const char* name, I32 create)
739 Returns a pointer to the stash for a specified package, which must be a
740 valid UTF-8 string. See C<gv_stashpv>.
742 HV* gv_stashsv(SV* sv, I32 create)
749 Used to indicate list context. See C<GIMME_V>, C<GIMME> and
757 Indicates that arguments returned from a callback should be discarded. See
765 Used to force a Perl C<eval> wrapper around a callback. See
773 Indicates that no arguments are being sent to a callback. See
781 Used to indicate scalar context. See C<GIMME_V>, C<GIMME>, and
789 Used to indicate void context. See C<GIMME_V> and L<perlcall>.
796 This flag, used in the length slot of hash entries and magic structures,
797 specifies the structure contains an C<SV*> pointer where a C<char*> pointer
798 is to be expected. (For information only--not to be used).
805 Returns the computed hash stored in the hash entry.
814 Returns the actual pointer stored in the key slot of the hash entry. The
815 pointer may be either C<char*> or C<SV*>, depending on the value of
816 C<HeKLEN()>. Can be assigned to. The C<HePV()> or C<HeSVKEY()> macros are
817 usually preferable for finding the value of a key.
826 If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry
827 holds an C<SV*> key. Otherwise, holds the actual length of the key. Can
828 be assigned to. The C<HePV()> macro is usually preferable for finding key
831 STRLEN HeKLEN(HE* he)
838 Returns the key slot of the hash entry as a C<char*> value, doing any
839 necessary dereferencing of possibly C<SV*> keys. The length of the string
840 is placed in C<len> (this is a macro, so do I<not> use C<&len>). If you do
841 not care about what the length of the key is, you may use the global
842 variable C<PL_na>, though this is rather less efficient than using a local
843 variable. Remember though, that hash keys in perl are free to contain
844 embedded nulls, so using C<strlen()> or similar is not a good way to find
845 the length of hash keys. This is very similar to the C<SvPV()> macro
846 described elsewhere in this document.
848 char* HePV(HE* he, STRLEN len)
855 Returns the key as an C<SV*>, or C<Nullsv> if the hash entry does not
856 contain an C<SV*> key.
865 Returns the key as an C<SV*>. Will create and return a temporary mortal
866 C<SV*> if the hash entry contains only a C<char*> key.
868 SV* HeSVKEY_force(HE* he)
875 Sets the key to a given C<SV*>, taking care to set the appropriate flags to
876 indicate the presence of an C<SV*> key, and returns the same
879 SV* HeSVKEY_set(HE* he, SV* sv)
886 Returns the value slot (type C<SV*>) stored in the hash entry.
895 Returns the package name of a stash. See C<SvSTASH>, C<CvSTASH>.
897 char* HvNAME(HV* stash)
904 Clears a hash, making it empty.
906 void hv_clear(HV* tb)
913 Deletes a key/value pair in the hash. The value SV is removed from the
914 hash and returned to the caller. The C<klen> is the length of the key.
915 The C<flags> value will normally be zero; if set to G_DISCARD then NULL
918 SV* hv_delete(HV* tb, const char* key, I32 klen, I32 flags)
925 Deletes a key/value pair in the hash. The value SV is removed from the
926 hash and returned to the caller. The C<flags> value will normally be zero;
927 if set to G_DISCARD then NULL will be returned. C<hash> can be a valid
928 precomputed hash value, or 0 to ask for it to be computed.
930 SV* hv_delete_ent(HV* tb, SV* key, I32 flags, U32 hash)
937 Returns a boolean indicating whether the specified hash key exists. The
938 C<klen> is the length of the key.
940 bool hv_exists(HV* tb, const char* key, I32 klen)
947 Returns a boolean indicating whether the specified hash key exists. C<hash>
948 can be a valid precomputed hash value, or 0 to ask for it to be
951 bool hv_exists_ent(HV* tb, SV* key, U32 hash)
958 Returns the SV which corresponds to the specified key in the hash. The
959 C<klen> is the length of the key. If C<lval> is set then the fetch will be
960 part of a store. Check that the return value is non-null before
961 dereferencing it to an C<SV*>.
963 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
964 information on how to use this function on tied hashes.
966 SV** hv_fetch(HV* tb, const char* key, I32 klen, I32 lval)
973 Returns the hash entry which corresponds to the specified key in the hash.
974 C<hash> must be a valid precomputed hash number for the given C<key>, or 0
975 if you want the function to compute it. IF C<lval> is set then the fetch
976 will be part of a store. Make sure the return value is non-null before
977 accessing it. The return value when C<tb> is a tied hash is a pointer to a
978 static location, so be sure to make a copy of the structure if you need to
981 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
982 information on how to use this function on tied hashes.
984 HE* hv_fetch_ent(HV* tb, SV* key, I32 lval, U32 hash)
991 Prepares a starting point to traverse a hash table. Returns the number of
992 keys in the hash (i.e. the same as C<HvKEYS(tb)>). The return value is
993 currently only meaningful for hashes without tie magic.
995 NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
996 hash buckets that happen to be in use. If you still need that esoteric
997 value, you can get it through the macro C<HvFILL(tb)>.
999 I32 hv_iterinit(HV* tb)
1006 Returns the key from the current position of the hash iterator. See
1009 char* hv_iterkey(HE* entry, I32* retlen)
1016 Returns the key as an C<SV*> from the current position of the hash
1017 iterator. The return value will always be a mortal copy of the key. Also
1020 SV* hv_iterkeysv(HE* entry)
1027 Returns entries from a hash iterator. See C<hv_iterinit>.
1029 HE* hv_iternext(HV* tb)
1036 Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
1039 SV* hv_iternextsv(HV* hv, char** key, I32* retlen)
1046 Returns the value from the current position of the hash iterator. See
1049 SV* hv_iterval(HV* tb, HE* entry)
1056 Adds magic to a hash. See C<sv_magic>.
1058 void hv_magic(HV* hv, GV* gv, int how)
1065 Stores an SV in a hash. The hash key is specified as C<key> and C<klen> is
1066 the length of the key. The C<hash> parameter is the precomputed hash
1067 value; if it is zero then Perl will compute it. The return value will be
1068 NULL if the operation failed or if the value did not need to be actually
1069 stored within the hash (as in the case of tied hashes). Otherwise it can
1070 be dereferenced to get the original C<SV*>. Note that the caller is
1071 responsible for suitably incrementing the reference count of C<val> before
1072 the call, and decrementing it if the function returned NULL.
1074 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1075 information on how to use this function on tied hashes.
1077 SV** hv_store(HV* tb, const char* key, I32 klen, SV* val, U32 hash)
1084 Stores C<val> in a hash. The hash key is specified as C<key>. The C<hash>
1085 parameter is the precomputed hash value; if it is zero then Perl will
1086 compute it. The return value is the new hash entry so created. It will be
1087 NULL if the operation failed or if the value did not need to be actually
1088 stored within the hash (as in the case of tied hashes). Otherwise the
1089 contents of the return value can be accessed using the C<He?> macros
1090 described here. Note that the caller is responsible for suitably
1091 incrementing the reference count of C<val> before the call, and
1092 decrementing it if the function returned NULL.
1094 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1095 information on how to use this function on tied hashes.
1097 HE* hv_store_ent(HV* tb, SV* key, SV* val, U32 hash)
1106 void hv_undef(HV* tb)
1113 Returns a boolean indicating whether the C C<char> is an ASCII alphanumeric
1114 character (including underscore) or digit.
1116 bool isALNUM(char ch)
1119 Found in file handy.h
1123 Returns a boolean indicating whether the C C<char> is an ASCII alphabetic
1126 bool isALPHA(char ch)
1129 Found in file handy.h
1133 Returns a boolean indicating whether the C C<char> is an ASCII
1136 bool isDIGIT(char ch)
1139 Found in file handy.h
1143 Returns a boolean indicating whether the C C<char> is a lowercase
1146 bool isLOWER(char ch)
1149 Found in file handy.h
1153 Returns a boolean indicating whether the C C<char> is whitespace.
1155 bool isSPACE(char ch)
1158 Found in file handy.h
1162 Returns a boolean indicating whether the C C<char> is an uppercase
1165 bool isUPPER(char ch)
1168 Found in file handy.h
1172 Tests if some arbitrary number of bytes begins in a valid UTF-8
1173 character. Note that an INVARIANT (i.e. ASCII) character is a valid UTF-8 character.
1174 The actual number of bytes in the UTF-8 character will be returned if
1175 it is valid, otherwise 0.
1177 STRLEN is_utf8_char(U8 *p)
1180 Found in file utf8.c
1182 =item is_utf8_string
1184 Returns true if first C<len> bytes of the given string form a valid UTF8
1185 string, false otherwise. Note that 'a valid UTF8 string' does not mean
1186 'a string that contains UTF8' because a valid ASCII string is a valid
1189 bool is_utf8_string(U8 *s, STRLEN len)
1192 Found in file utf8.c
1196 Variable which is setup by C<xsubpp> to indicate the number of
1197 items on the stack. See L<perlxs/"Variable-length Parameter Lists">.
1202 Found in file XSUB.h
1206 Variable which is setup by C<xsubpp> to indicate which of an
1207 XSUB's aliases was used to invoke it. See L<perlxs/"The ALIAS: Keyword">.
1212 Found in file XSUB.h
1216 Closing bracket on a callback. See C<ENTER> and L<perlcall>.
1221 Found in file scope.h
1225 Loads the module whose name is pointed to by the string part of name.
1226 Note that the actual module name, not its filename, should be given.
1227 Eg, "Foo::Bar" instead of "Foo/Bar.pm". flags can be any of
1228 PERL_LOADMOD_DENY, PERL_LOADMOD_NOIMPORT, or PERL_LOADMOD_IMPORT_OPS
1229 (or 0 for no flags). ver, if specified, provides version semantics
1230 similar to C<use Foo::Bar VERSION>. The optional trailing SV*
1231 arguments can be used to specify arguments to the module's import()
1232 method, similar to C<use Foo::Bar VERSION LIST>.
1234 void load_module(U32 flags, SV* name, SV* ver, ...)
1239 =item looks_like_number
1241 Test if the content of an SV looks like a number (or is a number).
1242 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1243 non-numeric warning), even if your atof() doesn't grok them.
1245 I32 looks_like_number(SV* sv)
1252 Stack marker variable for the XSUB. See C<dMARK>.
1259 Clear something magical that the SV represents. See C<sv_magic>.
1261 int mg_clear(SV* sv)
1268 Copies the magic from one SV to another. See C<sv_magic>.
1270 int mg_copy(SV* sv, SV* nsv, const char* key, I32 klen)
1277 Finds the magic pointer for type matching the SV. See C<sv_magic>.
1279 MAGIC* mg_find(SV* sv, int type)
1286 Free any magic storage used by the SV. See C<sv_magic>.
1295 Do magic after a value is retrieved from the SV. See C<sv_magic>.
1304 Report on the SV's length. See C<sv_magic>.
1306 U32 mg_length(SV* sv)
1313 Turns on the magical status of an SV. See C<sv_magic>.
1315 void mg_magical(SV* sv)
1322 Do magic after a value is assigned to the SV. See C<sv_magic>.
1331 The XSUB-writer's interface to the C C<memmove> function. The C<src> is the
1332 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1333 the type. Can do overlapping moves. See also C<Copy>.
1335 void Move(void* src, void* dest, int nitems, type)
1338 Found in file handy.h
1342 The XSUB-writer's interface to the C C<malloc> function.
1344 void New(int id, void* ptr, int nitems, type)
1347 Found in file handy.h
1351 Creates a new AV. The reference count is set to 1.
1360 The XSUB-writer's interface to the C C<malloc> function, with
1363 void Newc(int id, void* ptr, int nitems, type, cast)
1366 Found in file handy.h
1370 Creates a constant sub equivalent to Perl C<sub FOO () { 123 }> which is
1371 eligible for inlining at compile-time.
1373 CV* newCONSTSUB(HV* stash, char* name, SV* sv)
1380 Creates a new HV. The reference count is set to 1.
1389 Creates an RV wrapper for an SV. The reference count for the original SV is
1392 SV* newRV_inc(SV* sv)
1399 Creates an RV wrapper for an SV. The reference count for the original
1400 SV is B<not> incremented.
1402 SV* newRV_noinc(SV *sv)
1409 Creates a new SV. A non-zero C<len> parameter indicates the number of
1410 bytes of preallocated string space the SV should have. An extra byte for a
1411 tailing NUL is also reserved. (SvPOK is not set for the SV even if string
1412 space is allocated.) The reference count for the new SV is set to 1.
1413 C<id> is an integer id between 0 and 1299 (used to identify leaks).
1415 SV* NEWSV(int id, STRLEN len)
1418 Found in file handy.h
1422 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
1423 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
1426 SV* newSV(STRLEN len)
1433 Creates a new SV and copies an integer into it. The reference count for the
1443 Creates a new SV and copies a floating point value into it.
1444 The reference count for the SV is set to 1.
1453 Creates a new SV and copies a string into it. The reference count for the
1454 SV is set to 1. If C<len> is zero, Perl will compute the length using
1455 strlen(). For efficiency, consider using C<newSVpvn> instead.
1457 SV* newSVpv(const char* s, STRLEN len)
1464 Creates a new SV and initializes it with the string formatted like
1467 SV* newSVpvf(const char* pat, ...)
1474 Creates a new SV and copies a string into it. The reference count for the
1475 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
1476 string. You are responsible for ensuring that the source string is at least
1479 SV* newSVpvn(const char* s, STRLEN len)
1484 =item newSVpvn_share
1486 Creates a new SV with its SvPVX pointing to a shared string in the string
1487 table. If the string does not already exist in the table, it is created
1488 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
1489 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
1490 otherwise the hash is computed. The idea here is that as the string table
1491 is used for shared hash keys these strings will have SvPVX == HeKEY and
1492 hash lookup will avoid string compare.
1494 SV* newSVpvn_share(const char* s, I32 len, U32 hash)
1501 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
1502 it will be upgraded to one. If C<classname> is non-null then the new SV will
1503 be blessed in the specified package. The new SV is returned and its
1504 reference count is 1.
1506 SV* newSVrv(SV* rv, const char* classname)
1513 Creates a new SV which is an exact duplicate of the original SV.
1516 SV* newSVsv(SV* old)
1523 Creates a new SV and copies an unsigned integer into it.
1524 The reference count for the SV is set to 1.
1533 Used by C<xsubpp> to hook up XSUBs as Perl subs.
1540 Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
1544 Found in file XSUB.h
1548 The XSUB-writer's interface to the C C<malloc> function. The allocated
1549 memory is zeroed with C<memzero>.
1551 void Newz(int id, void* ptr, int nitems, type)
1554 Found in file handy.h
1558 Returns a pointer to the next character after the parsed
1559 vstring, as well as updating the passed in sv.
1561 Function must be called like
1564 s = new_vstring(s,sv);
1566 The sv must already be large enough to store the vstring
1569 char* new_vstring(char *vstr, SV *sv)
1572 Found in file util.c
1583 Null character pointer.
1586 Found in file handy.h
1607 Found in file handy.h
1611 The original stack mark for the XSUB. See C<dORIGMARK>.
1618 Allocates a new Perl interpreter. See L<perlembed>.
1620 PerlInterpreter* perl_alloc()
1623 Found in file perl.c
1627 Create and return a new interpreter by cloning the current one.
1629 PerlInterpreter* perl_clone(PerlInterpreter* interp, UV flags)
1634 =item perl_construct
1636 Initializes a new Perl interpreter. See L<perlembed>.
1638 void perl_construct(PerlInterpreter* interp)
1641 Found in file perl.c
1645 Shuts down a Perl interpreter. See L<perlembed>.
1647 int perl_destruct(PerlInterpreter* interp)
1650 Found in file perl.c
1654 Releases a Perl interpreter. See L<perlembed>.
1656 void perl_free(PerlInterpreter* interp)
1659 Found in file perl.c
1663 Tells a Perl interpreter to parse a Perl script. See L<perlembed>.
1665 int perl_parse(PerlInterpreter* interp, XSINIT_t xsinit, int argc, char** argv, char** env)
1668 Found in file perl.c
1672 Tells a Perl interpreter to run. See L<perlembed>.
1674 int perl_run(PerlInterpreter* interp)
1677 Found in file perl.c
1681 C<PL_modglobal> is a general purpose, interpreter global HV for use by
1682 extensions that need to keep information on a per-interpreter basis.
1683 In a pinch, it can also be used as a symbol table for extensions
1684 to share data among each other. It is a good idea to use keys
1685 prefixed by the package name of the extension that owns the data.
1690 Found in file intrpvar.h
1694 A convenience variable which is typically used with C<SvPV> when one
1695 doesn't care about the length of the string. It is usually more efficient
1696 to either declare a local variable and use that instead or to use the
1697 C<SvPV_nolen> macro.
1702 Found in file thrdvar.h
1706 This is the C<false> SV. See C<PL_sv_yes>. Always refer to this as
1712 Found in file intrpvar.h
1716 This is the C<undef> SV. Always refer to this as C<&PL_sv_undef>.
1721 Found in file intrpvar.h
1725 This is the C<true> SV. See C<PL_sv_no>. Always refer to this as
1731 Found in file intrpvar.h
1735 Pops an integer off the stack.
1744 Pops a long off the stack.
1753 Pops a double off the stack.
1762 Pops a string off the stack. Deprecated. New code should provide
1763 a STRLEN n_a and use POPpx.
1772 Pops a string off the stack which must consist of bytes i.e. characters < 256.
1773 Requires a variable STRLEN n_a in scope.
1782 Pops a string off the stack.
1783 Requires a variable STRLEN n_a in scope.
1792 Pops an SV off the stack.
1801 Push an integer onto the stack. The stack must have room for this element.
1802 Handles 'set' magic. See C<XPUSHi>.
1811 Opening bracket for arguments on a callback. See C<PUTBACK> and
1821 Push a double onto the stack. The stack must have room for this element.
1822 Handles 'set' magic. See C<XPUSHn>.
1831 Push a string onto the stack. The stack must have room for this element.
1832 The C<len> indicates the length of the string. Handles 'set' magic. See
1835 void PUSHp(char* str, STRLEN len)
1842 Push an SV onto the stack. The stack must have room for this element.
1843 Does not handle 'set' magic. See C<XPUSHs>.
1852 Push an unsigned integer onto the stack. The stack must have room for this
1853 element. See C<XPUSHu>.
1862 Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
1863 See C<PUSHMARK> and L<perlcall> for other uses.
1872 The XSUB-writer's interface to the C C<realloc> function.
1874 void Renew(void* ptr, int nitems, type)
1877 Found in file handy.h
1881 The XSUB-writer's interface to the C C<realloc> function, with
1884 void Renewc(void* ptr, int nitems, type, cast)
1887 Found in file handy.h
1891 Tells Perl to C<require> the file named by the string argument. It is
1892 analogous to the Perl code C<eval "require '$file'">. It's even
1893 implemented that way; consider using Perl_load_module instead.
1895 NOTE: the perl_ form of this function is deprecated.
1897 void require_pv(const char* pv)
1900 Found in file perl.c
1904 Variable which is setup by C<xsubpp> to hold the return value for an
1905 XSUB. This is always the proper type for the XSUB. See
1906 L<perlxs/"The RETVAL Variable">.
1911 Found in file XSUB.h
1915 The XSUB-writer's interface to the C C<free> function.
1917 void Safefree(void* ptr)
1920 Found in file handy.h
1924 Copy a string to a safe spot. This does not use an SV.
1926 char* savepv(const char* sv)
1929 Found in file util.c
1933 Copy a string to a safe spot. The C<len> indicates number of bytes to
1934 copy. This does not use an SV.
1936 char* savepvn(const char* sv, I32 len)
1939 Found in file util.c
1943 Opening bracket for temporaries on a callback. See C<FREETMPS> and
1949 Found in file scope.h
1953 For backwards compatibility. Use C<grok_bin> instead.
1955 NV scan_bin(char* start, STRLEN len, STRLEN* retlen)
1958 Found in file numeric.c
1962 For backwards compatibility. Use C<grok_hex> instead.
1964 NV scan_hex(char* start, STRLEN len, STRLEN* retlen)
1967 Found in file numeric.c
1971 For backwards compatibility. Use C<grok_oct> instead.
1973 NV scan_oct(char* start, STRLEN len, STRLEN* retlen)
1976 Found in file numeric.c
1980 Tries to find if a given SV has a shared backend, either by
1981 looking at magic, or by checking if it is tied again threads::shared.
1983 shared_sv* sharedsv_find(SV* sv)
1986 Found in file sharedsv.c
1990 Saves a space for keeping SVs wider than an interpreter,
1991 currently only stores a pointer to the first interpreter.
1993 void sharedsv_init()
1996 Found in file sharedsv.c
2000 Recursive locks on a sharedsv.
2001 Locks are dynamically scoped at the level of the first lock.
2002 void sharedsv_lock(shared_sv* ssv)
2005 Found in file sharedsv.c
2009 Allocates a new shared sv struct, you must yourself create the SV/AV/HV.
2010 shared_sv* sharedsv_new()
2013 Found in file sharedsv.c
2015 =item sharedsv_thrcnt_dec
2017 Decrements the threadcount of a shared sv. When a threads frontend is freed
2018 this function should be called.
2020 void sharedsv_thrcnt_dec(shared_sv* ssv)
2023 Found in file sharedsv.c
2025 =item sharedsv_thrcnt_inc
2027 Increments the threadcount of a sharedsv.
2028 void sharedsv_thrcnt_inc(shared_sv* ssv)
2031 Found in file sharedsv.c
2033 =item sharedsv_unlock
2035 Recursively unlocks a shared sv.
2037 void sharedsv_unlock(shared_sv* ssv)
2040 Found in file sharedsv.c
2044 Sort an array. Here is an example:
2046 sortsv(AvARRAY(av), av_len(av)+1, Perl_sv_cmp_locale);
2048 void sortsv(SV ** array, size_t num_elts, SVCOMPARE_t cmp)
2051 Found in file pp_sort.c
2055 Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and
2063 Refetch the stack pointer. Used after a callback. See L<perlcall>.
2072 Used to access elements on the XSUB's stack.
2077 Found in file XSUB.h
2081 Test two strings to see if they are equal. Returns true or false.
2083 bool strEQ(char* s1, char* s2)
2086 Found in file handy.h
2090 Test two strings to see if the first, C<s1>, is greater than or equal to
2091 the second, C<s2>. Returns true or false.
2093 bool strGE(char* s1, char* s2)
2096 Found in file handy.h
2100 Test two strings to see if the first, C<s1>, is greater than the second,
2101 C<s2>. Returns true or false.
2103 bool strGT(char* s1, char* s2)
2106 Found in file handy.h
2110 Test two strings to see if the first, C<s1>, is less than or equal to the
2111 second, C<s2>. Returns true or false.
2113 bool strLE(char* s1, char* s2)
2116 Found in file handy.h
2120 Test two strings to see if the first, C<s1>, is less than the second,
2121 C<s2>. Returns true or false.
2123 bool strLT(char* s1, char* s2)
2126 Found in file handy.h
2130 Test two strings to see if they are different. Returns true or
2133 bool strNE(char* s1, char* s2)
2136 Found in file handy.h
2140 Test two strings to see if they are equal. The C<len> parameter indicates
2141 the number of bytes to compare. Returns true or false. (A wrapper for
2144 bool strnEQ(char* s1, char* s2, STRLEN len)
2147 Found in file handy.h
2151 Test two strings to see if they are different. The C<len> parameter
2152 indicates the number of bytes to compare. Returns true or false. (A
2153 wrapper for C<strncmp>).
2155 bool strnNE(char* s1, char* s2, STRLEN len)
2158 Found in file handy.h
2162 This is an architecture-independent macro to copy one structure to another.
2164 void StructCopy(type src, type dest, type)
2167 Found in file handy.h
2171 Returns the length of the string which is in the SV. See C<SvLEN>.
2173 STRLEN SvCUR(SV* sv)
2180 Set the length of the string which is in the SV. See C<SvCUR>.
2182 void SvCUR_set(SV* sv, STRLEN len)
2189 Returns a pointer to the last character in the string which is in the SV.
2190 See C<SvCUR>. Access the character as *(SvEND(sv)).
2199 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
2200 argument more than once.
2202 void SvGETMAGIC(SV* sv)
2209 Expands the character buffer in the SV so that it has room for the
2210 indicated number of bytes (remember to reserve space for an extra trailing
2211 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
2212 Returns a pointer to the character buffer.
2214 char * SvGROW(SV* sv, STRLEN len)
2221 Returns a boolean indicating whether the SV contains an integer.
2230 Returns a boolean indicating whether the SV contains an integer. Checks
2231 the B<private> setting. Use C<SvIOK>.
2240 Returns a boolean indicating whether the SV contains a signed integer.
2242 void SvIOK_notUV(SV* sv)
2249 Unsets the IV status of an SV.
2251 void SvIOK_off(SV* sv)
2258 Tells an SV that it is an integer.
2260 void SvIOK_on(SV* sv)
2267 Tells an SV that it is an integer and disables all other OK bits.
2269 void SvIOK_only(SV* sv)
2276 Tells and SV that it is an unsigned integer and disables all other OK bits.
2278 void SvIOK_only_UV(SV* sv)
2285 Returns a boolean indicating whether the SV contains an unsigned integer.
2287 void SvIOK_UV(SV* sv)
2294 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
2295 version which guarantees to evaluate sv only once.
2304 Returns the raw value in the SV's IV slot, without checks or conversions.
2305 Only use when you are sure SvIOK is true. See also C<SvIV()>.
2314 Coerces the given SV to an integer and returns it. Guarantees to evaluate
2315 sv only once. Use the more efficient C<SvIV> otherwise.
2324 Returns the size of the string buffer in the SV, not including any part
2325 attributable to C<SvOOK>. See C<SvCUR>.
2327 STRLEN SvLEN(SV* sv)
2334 Returns a boolean indicating whether the SV contains a number, integer or
2344 Returns a boolean indicating whether the SV contains a number, integer or
2345 double. Checks the B<private> setting. Use C<SvNIOK>.
2347 bool SvNIOKp(SV* sv)
2354 Unsets the NV/IV status of an SV.
2356 void SvNIOK_off(SV* sv)
2363 Returns a boolean indicating whether the SV contains a double.
2372 Returns a boolean indicating whether the SV contains a double. Checks the
2373 B<private> setting. Use C<SvNOK>.
2382 Unsets the NV status of an SV.
2384 void SvNOK_off(SV* sv)
2391 Tells an SV that it is a double.
2393 void SvNOK_on(SV* sv)
2400 Tells an SV that it is a double and disables all other OK bits.
2402 void SvNOK_only(SV* sv)
2409 Coerce the given SV to a double and return it. See C<SvNVx> for a version
2410 which guarantees to evaluate sv only once.
2419 Coerces the given SV to a double and returns it. Guarantees to evaluate
2420 sv only once. Use the more efficient C<SvNV> otherwise.
2429 Returns the raw value in the SV's NV slot, without checks or conversions.
2430 Only use when you are sure SvNOK is true. See also C<SvNV()>.
2439 Returns a boolean indicating whether the value is an SV.
2448 Returns a boolean indicating whether the SvIVX is a valid offset value for
2449 the SvPVX. This hack is used internally to speed up removal of characters
2450 from the beginning of a SvPV. When SvOOK is true, then the start of the
2451 allocated string buffer is really (SvPVX - SvIVX).
2460 Returns a boolean indicating whether the SV contains a character
2470 Returns a boolean indicating whether the SV contains a character string.
2471 Checks the B<private> setting. Use C<SvPOK>.
2480 Unsets the PV status of an SV.
2482 void SvPOK_off(SV* sv)
2489 Tells an SV that it is a string.
2491 void SvPOK_on(SV* sv)
2498 Tells an SV that it is a string and disables all other OK bits.
2499 Will also turn off the UTF8 status.
2501 void SvPOK_only(SV* sv)
2506 =item SvPOK_only_UTF8
2508 Tells an SV that it is a string and disables all other OK bits,
2509 and leaves the UTF8 status as it was.
2511 void SvPOK_only_UTF8(SV* sv)
2518 Returns a pointer to the string in the SV, or a stringified form of the SV
2519 if the SV does not contain a string. Handles 'get' magic. See also
2520 C<SvPVx> for a version which guarantees to evaluate sv only once.
2522 char* SvPV(SV* sv, STRLEN len)
2529 Like C<SvPV>, but converts sv to byte representation first if necessary.
2531 char* SvPVbyte(SV* sv, STRLEN len)
2538 Like C<SvPV>, but converts sv to byte representation first if necessary.
2539 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
2543 char* SvPVbytex(SV* sv, STRLEN len)
2548 =item SvPVbytex_force
2550 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
2551 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
2554 char* SvPVbytex_force(SV* sv, STRLEN len)
2559 =item SvPVbyte_force
2561 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
2563 char* SvPVbyte_force(SV* sv, STRLEN len)
2568 =item SvPVbyte_nolen
2570 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
2572 char* SvPVbyte_nolen(SV* sv)
2579 Like C<SvPV>, but converts sv to utf8 first if necessary.
2581 char* SvPVutf8(SV* sv, STRLEN len)
2588 Like C<SvPV>, but converts sv to utf8 first if necessary.
2589 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
2592 char* SvPVutf8x(SV* sv, STRLEN len)
2597 =item SvPVutf8x_force
2599 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
2600 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
2603 char* SvPVutf8x_force(SV* sv, STRLEN len)
2608 =item SvPVutf8_force
2610 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
2612 char* SvPVutf8_force(SV* sv, STRLEN len)
2617 =item SvPVutf8_nolen
2619 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
2621 char* SvPVutf8_nolen(SV* sv)
2628 Returns a pointer to the physical string in the SV. The SV must contain a
2638 A version of C<SvPV> which guarantees to evaluate sv only once.
2640 char* SvPVx(SV* sv, STRLEN len)
2647 Like <SvPV> but will force the SV into becoming a string (SvPOK). You want
2648 force if you are going to update the SvPVX directly.
2650 char* SvPV_force(SV* sv, STRLEN len)
2655 =item SvPV_force_nomg
2657 Like <SvPV> but will force the SV into becoming a string (SvPOK). You want
2658 force if you are going to update the SvPVX directly. Doesn't process magic.
2660 char* SvPV_force_nomg(SV* sv, STRLEN len)
2667 Returns a pointer to the string in the SV, or a stringified form of the SV
2668 if the SV does not contain a string. Handles 'get' magic.
2670 char* SvPV_nolen(SV* sv)
2677 Returns the value of the object's reference count.
2679 U32 SvREFCNT(SV* sv)
2686 Decrements the reference count of the given SV.
2688 void SvREFCNT_dec(SV* sv)
2695 Increments the reference count of the given SV.
2697 SV* SvREFCNT_inc(SV* sv)
2704 Tests if the SV is an RV.
2713 Unsets the RV status of an SV.
2715 void SvROK_off(SV* sv)
2722 Tells an SV that it is an RV.
2724 void SvROK_on(SV* sv)
2731 Dereferences an RV to return the SV.
2740 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
2741 argument more than once.
2743 void SvSETMAGIC(SV* sv)
2750 Like C<SvSetSV>, but does any set magic required afterwards.
2752 void SvSetMagicSV(SV* dsb, SV* ssv)
2757 =item SvSetMagicSV_nosteal
2759 Like C<SvSetMagicSV>, but does any set magic required afterwards.
2761 void SvSetMagicSV_nosteal(SV* dsv, SV* ssv)
2768 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
2771 void SvSetSV(SV* dsb, SV* ssv)
2776 =item SvSetSV_nosteal
2778 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
2779 ssv. May evaluate arguments more than once.
2781 void SvSetSV_nosteal(SV* dsv, SV* ssv)
2788 Returns the stash of the SV.
2797 Taints an SV if tainting is enabled
2799 void SvTAINT(SV* sv)
2806 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
2809 bool SvTAINTED(SV* sv)
2816 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
2817 some of Perl's fundamental security features. XS module authors should not
2818 use this function unless they fully understand all the implications of
2819 unconditionally untainting the value. Untainting should be done in the
2820 standard perl fashion, via a carefully crafted regexp, rather than directly
2821 untainting variables.
2823 void SvTAINTED_off(SV* sv)
2830 Marks an SV as tainted.
2832 void SvTAINTED_on(SV* sv)
2839 Returns a boolean indicating whether Perl would evaluate the SV as true or
2840 false, defined or undefined. Does not handle 'get' magic.
2849 An enum of flags for Perl types. These are found in the file B<sv.h>
2850 in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
2857 Returns the type of the SV. See C<svtype>.
2859 svtype SvTYPE(SV* sv)
2866 Integer type flag for scalars. See C<svtype>.
2873 Double type flag for scalars. See C<svtype>.
2880 Pointer type flag for scalars. See C<svtype>.
2887 Type flag for arrays. See C<svtype>.
2894 Type flag for code refs. See C<svtype>.
2901 Type flag for hashes. See C<svtype>.
2908 Type flag for blessed scalars. See C<svtype>.
2915 Returns a boolean indicating whether the SV contains an unsigned integer.
2924 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
2925 perform the upgrade if necessary. See C<svtype>.
2927 void SvUPGRADE(SV* sv, svtype type)
2934 Returns a boolean indicating whether the SV contains UTF-8 encoded data.
2943 Unsets the UTF8 status of an SV.
2945 void SvUTF8_off(SV *sv)
2952 Turn on the UTF8 status of an SV (the data is not changed, just the flag).
2953 Do not use frivolously.
2955 void SvUTF8_on(SV *sv)
2962 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
2963 for a version which guarantees to evaluate sv only once.
2972 Coerces the given SV to an unsigned integer and returns it. Guarantees to
2973 evaluate sv only once. Use the more efficient C<SvUV> otherwise.
2982 Returns the raw value in the SV's UV slot, without checks or conversions.
2983 Only use when you are sure SvIOK is true. See also C<SvUV()>.
2992 This function is only called on magical items, and is only used by
2993 sv_true() or its macro equivalent.
2995 bool sv_2bool(SV* sv)
3002 Using various gambits, try to get a CV from an SV; in addition, try if
3003 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
3005 CV* sv_2cv(SV* sv, HV** st, GV** gvp, I32 lref)
3012 Using various gambits, try to get an IO from an SV: the IO slot if its a
3013 GV; or the recursive result if we're an RV; or the IO slot of the symbol
3014 named after the PV if we're a string.
3023 Return the integer value of an SV, doing any necessary string conversion,
3024 magic etc. Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
3033 Marks an existing SV as mortal. The SV will be destroyed "soon", either
3034 by an explicit call to FREETMPS, or by an implicit call at places such as
3035 statement boundaries. See also C<sv_newmortal> and C<sv_mortalcopy>.
3037 SV* sv_2mortal(SV* sv)
3044 Return the num value of an SV, doing any necessary string or integer
3045 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
3055 Return a pointer to the byte-encoded representation of the SV, and set *lp
3056 to its length. May cause the SV to be downgraded from UTF8 as a
3059 Usually accessed via the C<SvPVbyte> macro.
3061 char* sv_2pvbyte(SV* sv, STRLEN* lp)
3066 =item sv_2pvbyte_nolen
3068 Return a pointer to the byte-encoded representation of the SV.
3069 May cause the SV to be downgraded from UTF8 as a side-effect.
3071 Usually accessed via the C<SvPVbyte_nolen> macro.
3073 char* sv_2pvbyte_nolen(SV* sv)
3080 Return a pointer to the UTF8-encoded representation of the SV, and set *lp
3081 to its length. May cause the SV to be upgraded to UTF8 as a side-effect.
3083 Usually accessed via the C<SvPVutf8> macro.
3085 char* sv_2pvutf8(SV* sv, STRLEN* lp)
3090 =item sv_2pvutf8_nolen
3092 Return a pointer to the UTF8-encoded representation of the SV.
3093 May cause the SV to be upgraded to UTF8 as a side-effect.
3095 Usually accessed via the C<SvPVutf8_nolen> macro.
3097 char* sv_2pvutf8_nolen(SV* sv)
3104 Returns a pointer to the string value of an SV, and sets *lp to its length.
3105 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
3107 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
3108 usually end up here too.
3110 char* sv_2pv_flags(SV* sv, STRLEN* lp, I32 flags)
3117 Like C<sv_2pv()>, but doesn't return the length too. You should usually
3118 use the macro wrapper C<SvPV_nolen(sv)> instead.
3119 char* sv_2pv_nolen(SV* sv)
3126 Return the unsigned integer value of an SV, doing any necessary string
3127 conversion, magic etc. Normally used via the C<SvUV(sv)> and C<SvUVx(sv)>
3137 Remove any string offset. You should normally use the C<SvOOK_off> macro
3140 int sv_backoff(SV* sv)
3147 Blesses an SV into a specified package. The SV must be an RV. The package
3148 must be designated by its stash (see C<gv_stashpv()>). The reference count
3149 of the SV is unaffected.
3151 SV* sv_bless(SV* sv, HV* stash)
3158 Concatenates the string onto the end of the string which is in the SV.
3159 If the SV has the UTF8 status set, then the bytes appended should be
3160 valid UTF8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
3162 void sv_catpv(SV* sv, const char* ptr)
3169 Processes its arguments like C<sprintf> and appends the formatted
3170 output to an SV. If the appended data contains "wide" characters
3171 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
3172 and characters >255 formatted with %c), the original SV might get
3173 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic.
3174 C<SvSETMAGIC()> must typically be called after calling this function
3175 to handle 'set' magic.
3177 void sv_catpvf(SV* sv, const char* pat, ...)
3184 Like C<sv_catpvf>, but also handles 'set' magic.
3186 void sv_catpvf_mg(SV *sv, const char* pat, ...)
3193 Concatenates the string onto the end of the string which is in the SV. The
3194 C<len> indicates number of bytes to copy. If the SV has the UTF8
3195 status set, then the bytes appended should be valid UTF8.
3196 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
3198 void sv_catpvn(SV* sv, const char* ptr, STRLEN len)
3203 =item sv_catpvn_flags
3205 Concatenates the string onto the end of the string which is in the SV. The
3206 C<len> indicates number of bytes to copy. If the SV has the UTF8
3207 status set, then the bytes appended should be valid UTF8.
3208 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
3209 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
3210 in terms of this function.
3212 void sv_catpvn_flags(SV* sv, const char* ptr, STRLEN len, I32 flags)
3219 Like C<sv_catpvn>, but also handles 'set' magic.
3221 void sv_catpvn_mg(SV *sv, const char *ptr, STRLEN len)
3228 Like C<sv_catpv>, but also handles 'set' magic.
3230 void sv_catpv_mg(SV *sv, const char *ptr)
3237 Concatenates the string from SV C<ssv> onto the end of the string in
3238 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
3239 not 'set' magic. See C<sv_catsv_mg>.
3241 void sv_catsv(SV* dsv, SV* ssv)
3246 =item sv_catsv_flags
3248 Concatenates the string from SV C<ssv> onto the end of the string in
3249 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
3250 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
3251 and C<sv_catsv_nomg> are implemented in terms of this function.
3253 void sv_catsv_flags(SV* dsv, SV* ssv, I32 flags)
3260 Like C<sv_catsv>, but also handles 'set' magic.
3262 void sv_catsv_mg(SV *dstr, SV *sstr)
3269 Efficient removal of characters from the beginning of the string buffer.
3270 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
3271 the string buffer. The C<ptr> becomes the first character of the adjusted
3272 string. Uses the "OOK hack".
3274 void sv_chop(SV* sv, char* ptr)
3281 Clear an SV: call any destructors, free up any memory used by the body,
3282 and free the body itself. The SV's head is I<not> freed, although
3283 its type is set to all 1's so that it won't inadvertently be assumed
3284 to be live during global destruction etc.
3285 This function should only be called when REFCNT is zero. Most of the time
3286 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
3289 void sv_clear(SV* sv)
3296 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
3297 string in C<sv1> is less than, equal to, or greater than the string in
3298 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
3299 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
3301 I32 sv_cmp(SV* sv1, SV* sv2)
3308 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
3309 'use bytes' aware, handles get magic, and will coerce its args to strings
3310 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
3312 I32 sv_cmp_locale(SV* sv1, SV* sv2)
3319 Add Collate Transform magic to an SV if it doesn't already have it.
3321 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
3322 scalar data of the variable, but transformed to such a format that a normal
3323 memory comparison can be used to compare the data according to the locale
3326 char* sv_collxfrm(SV* sv, STRLEN* nxp)
3333 Auto-decrement of the value in the SV, doing string to numeric conversion
3334 if necessary. Handles 'get' magic.
3341 =item sv_derived_from
3343 Returns a boolean indicating whether the SV is derived from the specified
3344 class. This is the function that implements C<UNIVERSAL::isa>. It works
3345 for class names as well as for objects.
3347 bool sv_derived_from(SV* sv, const char* name)
3350 Found in file universal.c
3354 Returns a boolean indicating whether the strings in the two SVs are
3355 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
3356 coerce its args to strings if necessary.
3358 I32 sv_eq(SV* sv1, SV* sv2)
3363 =item sv_force_normal
3365 Undo various types of fakery on an SV: if the PV is a shared string, make
3366 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3367 an xpvmg. See also C<sv_force_normal_flags>.
3369 void sv_force_normal(SV *sv)
3374 =item sv_force_normal_flags
3376 Undo various types of fakery on an SV: if the PV is a shared string, make
3377 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3378 an xpvmg. The C<flags> parameter gets passed to C<sv_unref_flags()>
3379 when unrefing. C<sv_force_normal> calls this function with flags set to 0.
3381 void sv_force_normal_flags(SV *sv, U32 flags)
3388 Decrement an SV's reference count, and if it drops to zero, call
3389 C<sv_clear> to invoke destructors and free up any memory used by
3390 the body; finally, deallocate the SV's head itself.
3391 Normally called via a wrapper macro C<SvREFCNT_dec>.
3393 void sv_free(SV* sv)
3400 Get a line from the filehandle and store it into the SV, optionally
3401 appending to the currently-stored string.
3403 char* sv_gets(SV* sv, PerlIO* fp, I32 append)
3410 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
3411 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
3412 Use the C<SvGROW> wrapper instead.
3414 char* sv_grow(SV* sv, STRLEN newlen)
3421 Auto-increment of the value in the SV, doing string to numeric conversion
3422 if necessary. Handles 'get' magic.
3431 Inserts a string at the specified offset/length within the SV. Similar to
3432 the Perl substr() function.
3434 void sv_insert(SV* bigsv, STRLEN offset, STRLEN len, char* little, STRLEN littlelen)
3441 Returns a boolean indicating whether the SV is blessed into the specified
3442 class. This does not check for subtypes; use C<sv_derived_from> to verify
3443 an inheritance relationship.
3445 int sv_isa(SV* sv, const char* name)
3452 Returns a boolean indicating whether the SV is an RV pointing to a blessed
3453 object. If the SV is not an RV, or if the object is not blessed, then this
3456 int sv_isobject(SV* sv)
3463 A private implementation of the C<SvIVx> macro for compilers which can't
3464 cope with complex macro expressions. Always use the macro instead.
3473 Returns the length of the string in the SV. Handles magic and type
3474 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
3476 STRLEN sv_len(SV* sv)
3483 Returns the number of characters in the string in an SV, counting wide
3484 UTF8 bytes as a single character. Handles magic and type coercion.
3486 STRLEN sv_len_utf8(SV* sv)
3493 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
3494 then adds a new magic item of type C<how> to the head of the magic list.
3496 C<name> is assumed to contain an C<SV*> if C<(name && namelen == HEf_SVKEY)>
3498 void sv_magic(SV* sv, SV* obj, int how, const char* name, I32 namlen)
3505 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
3506 The new SV is marked as mortal. It will be destroyed "soon", either by an
3507 explicit call to FREETMPS, or by an implicit call at places such as
3508 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
3510 SV* sv_mortalcopy(SV* oldsv)
3517 Creates a new null SV which is mortal. The reference count of the SV is
3518 set to 1. It will be destroyed "soon", either by an explicit call to
3519 FREETMPS, or by an implicit call at places such as statement boundaries.
3520 See also C<sv_mortalcopy> and C<sv_2mortal>.
3529 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
3532 SV* sv_newref(SV* sv)
3539 A private implementation of the C<SvNVx> macro for compilers which can't
3540 cope with complex macro expressions. Always use the macro instead.
3549 Converts the value pointed to by offsetp from a count of bytes from the
3550 start of the string, to a count of the equivalent number of UTF8 chars.
3551 Handles magic and type coercion.
3553 void sv_pos_b2u(SV* sv, I32* offsetp)
3560 Converts the value pointed to by offsetp from a count of UTF8 chars from
3561 the start of the string, to a count of the equivalent number of bytes; if
3562 lenp is non-zero, it does the same to lenp, but this time starting from
3563 the offset, rather than from the start of the string. Handles magic and
3566 void sv_pos_u2b(SV* sv, I32* offsetp, I32* lenp)
3573 A private implementation of the C<SvPV_nolen> macro for compilers which can't
3574 cope with complex macro expressions. Always use the macro instead.
3583 A private implementation of the C<SvPVbyte_nolen> macro for compilers
3584 which can't cope with complex macro expressions. Always use the macro
3587 char* sv_pvbyte(SV *sv)
3594 A private implementation of the C<SvPVbyte> macro for compilers
3595 which can't cope with complex macro expressions. Always use the macro
3598 char* sv_pvbyten(SV *sv, STRLEN *len)
3603 =item sv_pvbyten_force
3605 A private implementation of the C<SvPVbytex_force> macro for compilers
3606 which can't cope with complex macro expressions. Always use the macro
3609 char* sv_pvbyten_force(SV* sv, STRLEN* lp)
3616 A private implementation of the C<SvPV> macro for compilers which can't
3617 cope with complex macro expressions. Always use the macro instead.
3619 char* sv_pvn(SV *sv, STRLEN *len)
3626 Get a sensible string out of the SV somehow.
3627 A private implementation of the C<SvPV_force> macro for compilers which
3628 can't cope with complex macro expressions. Always use the macro instead.
3630 char* sv_pvn_force(SV* sv, STRLEN* lp)
3635 =item sv_pvn_force_flags
3637 Get a sensible string out of the SV somehow.
3638 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
3639 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
3640 implemented in terms of this function.
3641 You normally want to use the various wrapper macros instead: see
3642 C<SvPV_force> and C<SvPV_force_nomg>
3644 char* sv_pvn_force_flags(SV* sv, STRLEN* lp, I32 flags)
3651 A private implementation of the C<SvPVutf8_nolen> macro for compilers
3652 which can't cope with complex macro expressions. Always use the macro
3655 char* sv_pvutf8(SV *sv)
3662 A private implementation of the C<SvPVutf8> macro for compilers
3663 which can't cope with complex macro expressions. Always use the macro
3666 char* sv_pvutf8n(SV *sv, STRLEN *len)
3671 =item sv_pvutf8n_force
3673 A private implementation of the C<SvPVutf8_force> macro for compilers
3674 which can't cope with complex macro expressions. Always use the macro
3677 char* sv_pvutf8n_force(SV* sv, STRLEN* lp)
3682 =item sv_recode_to_utf8
3684 The encoding is assumed to be an Encode object, on entry the PV
3685 of the sv is assumed to be octets in that encoding, and the sv
3686 will be converted into Unicode (and UTF-8).
3688 If the sv already is UTF-8 (or if it is not POK), or if the encoding
3689 is not a reference, nothing is done to the sv. If the encoding is not
3690 an C<Encode::XS> Encoding object, bad things will happen.
3691 (See F<lib/encoding.pm> and L<Encode>).
3693 The PV of the sv is returned.
3695 char* sv_recode_to_utf8(SV* sv, SV *encoding)
3702 Returns a string describing what the SV is a reference to.
3704 char* sv_reftype(SV* sv, int ob)
3711 Make the first argument a copy of the second, then delete the original.
3712 The target SV physically takes over ownership of the body of the source SV
3713 and inherits its flags; however, the target keeps any magic it owns,
3714 and any magic in the source is discarded.
3715 Note that this is a rather specialist SV copying operation; most of the
3716 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
3718 void sv_replace(SV* sv, SV* nsv)
3723 =item sv_report_used
3725 Dump the contents of all SVs not yet freed. (Debugging aid).
3727 void sv_report_used()
3734 Underlying implementation for the C<reset> Perl function.
3735 Note that the perl-level function is vaguely deprecated.
3737 void sv_reset(char* s, HV* stash)
3744 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
3745 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
3746 push a back-reference to this RV onto the array of backreferences
3747 associated with that magic.
3749 SV* sv_rvweaken(SV *sv)
3756 Copies an integer into the given SV, upgrading first if necessary.
3757 Does not handle 'set' magic. See also C<sv_setiv_mg>.
3759 void sv_setiv(SV* sv, IV num)
3766 Like C<sv_setiv>, but also handles 'set' magic.
3768 void sv_setiv_mg(SV *sv, IV i)
3775 Copies a double into the given SV, upgrading first if necessary.
3776 Does not handle 'set' magic. See also C<sv_setnv_mg>.
3778 void sv_setnv(SV* sv, NV num)
3785 Like C<sv_setnv>, but also handles 'set' magic.
3787 void sv_setnv_mg(SV *sv, NV num)
3794 Copies a string into an SV. The string must be null-terminated. Does not
3795 handle 'set' magic. See C<sv_setpv_mg>.
3797 void sv_setpv(SV* sv, const char* ptr)
3804 Processes its arguments like C<sprintf> and sets an SV to the formatted
3805 output. Does not handle 'set' magic. See C<sv_setpvf_mg>.
3807 void sv_setpvf(SV* sv, const char* pat, ...)
3814 Like C<sv_setpvf>, but also handles 'set' magic.
3816 void sv_setpvf_mg(SV *sv, const char* pat, ...)
3823 Copies an integer into the given SV, also updating its string value.
3824 Does not handle 'set' magic. See C<sv_setpviv_mg>.
3826 void sv_setpviv(SV* sv, IV num)
3833 Like C<sv_setpviv>, but also handles 'set' magic.
3835 void sv_setpviv_mg(SV *sv, IV iv)
3842 Copies a string into an SV. The C<len> parameter indicates the number of
3843 bytes to be copied. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3845 void sv_setpvn(SV* sv, const char* ptr, STRLEN len)
3852 Like C<sv_setpvn>, but also handles 'set' magic.
3854 void sv_setpvn_mg(SV *sv, const char *ptr, STRLEN len)
3861 Like C<sv_setpv>, but also handles 'set' magic.
3863 void sv_setpv_mg(SV *sv, const char *ptr)
3870 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
3871 argument will be upgraded to an RV. That RV will be modified to point to
3872 the new SV. The C<classname> argument indicates the package for the
3873 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
3874 will be returned and will have a reference count of 1.
3876 SV* sv_setref_iv(SV* rv, const char* classname, IV iv)
3883 Copies a double into a new SV, optionally blessing the SV. The C<rv>
3884 argument will be upgraded to an RV. That RV will be modified to point to
3885 the new SV. The C<classname> argument indicates the package for the
3886 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
3887 will be returned and will have a reference count of 1.
3889 SV* sv_setref_nv(SV* rv, const char* classname, NV nv)
3896 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
3897 argument will be upgraded to an RV. That RV will be modified to point to
3898 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
3899 into the SV. The C<classname> argument indicates the package for the
3900 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
3901 will be returned and will have a reference count of 1.
3903 Do not use with other Perl types such as HV, AV, SV, CV, because those
3904 objects will become corrupted by the pointer copy process.
3906 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
3908 SV* sv_setref_pv(SV* rv, const char* classname, void* pv)
3915 Copies a string into a new SV, optionally blessing the SV. The length of the
3916 string must be specified with C<n>. The C<rv> argument will be upgraded to
3917 an RV. That RV will be modified to point to the new SV. The C<classname>
3918 argument indicates the package for the blessing. Set C<classname> to
3919 C<Nullch> to avoid the blessing. The new SV will be returned and will have
3920 a reference count of 1.
3922 Note that C<sv_setref_pv> copies the pointer while this copies the string.
3924 SV* sv_setref_pvn(SV* rv, const char* classname, char* pv, STRLEN n)
3931 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
3932 argument will be upgraded to an RV. That RV will be modified to point to
3933 the new SV. The C<classname> argument indicates the package for the
3934 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
3935 will be returned and will have a reference count of 1.
3937 SV* sv_setref_uv(SV* rv, const char* classname, UV uv)
3944 Copies the contents of the source SV C<ssv> into the destination SV
3945 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3946 function if the source SV needs to be reused. Does not handle 'set' magic.
3947 Loosely speaking, it performs a copy-by-value, obliterating any previous
3948 content of the destination.
3950 You probably want to use one of the assortment of wrappers, such as
3951 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3952 C<SvSetMagicSV_nosteal>.
3955 void sv_setsv(SV* dsv, SV* ssv)
3960 =item sv_setsv_flags
3962 Copies the contents of the source SV C<ssv> into the destination SV
3963 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3964 function if the source SV needs to be reused. Does not handle 'set' magic.
3965 Loosely speaking, it performs a copy-by-value, obliterating any previous
3966 content of the destination.
3967 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3968 C<ssv> if appropriate, else not. C<sv_setsv> and C<sv_setsv_nomg> are
3969 implemented in terms of this function.
3971 You probably want to use one of the assortment of wrappers, such as
3972 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3973 C<SvSetMagicSV_nosteal>.
3975 This is the primary function for copying scalars, and most other
3976 copy-ish functions and macros use this underneath.
3978 void sv_setsv_flags(SV* dsv, SV* ssv, I32 flags)
3985 Like C<sv_setsv>, but also handles 'set' magic.
3987 void sv_setsv_mg(SV *dstr, SV *sstr)
3994 Copies an unsigned integer into the given SV, upgrading first if necessary.
3995 Does not handle 'set' magic. See also C<sv_setuv_mg>.
3997 void sv_setuv(SV* sv, UV num)
4004 Like C<sv_setuv>, but also handles 'set' magic.
4006 void sv_setuv_mg(SV *sv, UV u)
4013 Taint an SV. Use C<SvTAINTED_on> instead.
4014 void sv_taint(SV* sv)
4021 Test an SV for taintedness. Use C<SvTAINTED> instead.
4022 bool sv_tainted(SV* sv)
4029 Returns true if the SV has a true value by Perl's rules.
4030 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
4031 instead use an in-line version.
4040 Removes all magic of type C<type> from an SV.
4042 int sv_unmagic(SV* sv, int type)
4049 Unsets the RV status of the SV, and decrements the reference count of
4050 whatever was being referenced by the RV. This can almost be thought of
4051 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
4052 being zero. See C<SvROK_off>.
4054 void sv_unref(SV* sv)
4059 =item sv_unref_flags
4061 Unsets the RV status of the SV, and decrements the reference count of
4062 whatever was being referenced by the RV. This can almost be thought of
4063 as a reversal of C<newSVrv>. The C<cflags> argument can contain
4064 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
4065 (otherwise the decrementing is conditional on the reference count being
4066 different from one or the reference being a readonly SV).
4069 void sv_unref_flags(SV* sv, U32 flags)
4076 Untaint an SV. Use C<SvTAINTED_off> instead.
4077 void sv_untaint(SV* sv)
4084 Upgrade an SV to a more complex form. Generally adds a new body type to the
4085 SV, then copies across as much information as possible from the old body.
4086 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
4088 bool sv_upgrade(SV* sv, U32 mt)
4095 Tells an SV to use C<ptr> to find its string value. Normally the string is
4096 stored inside the SV but sv_usepvn allows the SV to use an outside string.
4097 The C<ptr> should point to memory that was allocated by C<malloc>. The
4098 string length, C<len>, must be supplied. This function will realloc the
4099 memory pointed to by C<ptr>, so that pointer should not be freed or used by
4100 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
4101 See C<sv_usepvn_mg>.
4103 void sv_usepvn(SV* sv, char* ptr, STRLEN len)
4110 Like C<sv_usepvn>, but also handles 'set' magic.
4112 void sv_usepvn_mg(SV *sv, char *ptr, STRLEN len)
4117 =item sv_utf8_decode
4119 Convert the octets in the PV from UTF-8 to chars. Scan for validity and then
4120 turn off SvUTF8 if needed so that we see characters. Used as a building block
4121 for decode_utf8 in Encode.xs
4123 NOTE: this function is experimental and may change or be
4124 removed without notice.
4126 bool sv_utf8_decode(SV *sv)
4131 =item sv_utf8_downgrade
4133 Attempt to convert the PV of an SV from UTF8-encoded to byte encoding.
4134 This may not be possible if the PV contains non-byte encoding characters;
4135 if this is the case, either returns false or, if C<fail_ok> is not
4138 NOTE: this function is experimental and may change or be
4139 removed without notice.
4141 bool sv_utf8_downgrade(SV *sv, bool fail_ok)
4146 =item sv_utf8_encode
4148 Convert the PV of an SV to UTF8-encoded, but then turn off the C<SvUTF8>
4149 flag so that it looks like octets again. Used as a building block
4150 for encode_utf8 in Encode.xs
4152 void sv_utf8_encode(SV *sv)
4157 =item sv_utf8_upgrade
4159 Convert the PV of an SV to its UTF8-encoded form.
4160 Forces the SV to string form if it is not already.
4161 Always sets the SvUTF8 flag to avoid future validity checks even
4162 if all the bytes have hibit clear.
4164 STRLEN sv_utf8_upgrade(SV *sv)
4169 =item sv_utf8_upgrade_flags
4171 Convert the PV of an SV to its UTF8-encoded form.
4172 Forces the SV to string form if it is not already.
4173 Always sets the SvUTF8 flag to avoid future validity checks even
4174 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
4175 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
4176 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
4178 STRLEN sv_utf8_upgrade_flags(SV *sv, I32 flags)
4185 A private implementation of the C<SvUVx> macro for compilers which can't
4186 cope with complex macro expressions. Always use the macro instead.
4195 Processes its arguments like C<vsprintf> and appends the formatted output
4196 to an SV. Uses an array of SVs if the C style variable argument list is
4197 missing (NULL). When running with taint checks enabled, indicates via
4198 C<maybe_tainted> if results are untrustworthy (often due to the use of
4201 Usually used via one of its frontends C<sv_catpvf> and C<sv_catpvf_mg>.
4203 void sv_vcatpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
4210 Works like C<vcatpvfn> but copies the text into the SV instead of
4213 Usually used via one of its frontends C<sv_setpvf> and C<sv_setpvf_mg>.
4215 void sv_vsetpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
4222 Variable which is setup by C<xsubpp> to designate the object in a C++
4223 XSUB. This is always the proper type for the C++ object. See C<CLASS> and
4224 L<perlxs/"Using XS With C++">.
4229 Found in file XSUB.h
4233 Converts the specified character to lowercase.
4235 char toLOWER(char ch)
4238 Found in file handy.h
4242 Converts the specified character to uppercase.
4244 char toUPPER(char ch)
4247 Found in file handy.h
4251 The "p" contains the pointer to the UTF-8 string encoding
4252 the character that is being converted.
4254 The "ustrp" is a pointer to the character buffer to put the
4255 conversion result to. The "lenp" is a pointer to the length
4258 The "swash" is a pointer to the swash to use.
4260 The "normal" is a string like "ToLower" which means the swash
4261 $utf8::ToLower, which is stored in lib/unicore/To/Lower.pl,
4262 and loaded by SWASHGET, using lib/utf8_heavy.pl.
4264 The "special" is a string like "utf8::ToSpecLower", which means
4265 the hash %utf8::ToSpecLower, which is stored in the same file,
4266 lib/unicore/To/Lower.pl, and also loaded by SWASHGET. The access
4267 to the hash is by Perl_to_utf8_case().
4269 UV to_utf8_case(U8 *p, U8* ustrp, STRLEN *lenp, SV **swash, char *normal, char *special)
4272 Found in file utf8.c
4274 =item utf8n_to_uvchr
4276 Returns the native character value of the first character in the string C<s>
4277 which is assumed to be in UTF8 encoding; C<retlen> will be set to the
4278 length, in bytes, of that character.
4280 Allows length and flags to be passed to low level routine.
4282 UV utf8n_to_uvchr(U8 *s, STRLEN curlen, STRLEN* retlen, U32 flags)
4285 Found in file utf8.c
4287 =item utf8n_to_uvuni
4289 Bottom level UTF-8 decode routine.
4290 Returns the unicode code point value of the first character in the string C<s>
4291 which is assumed to be in UTF8 encoding and no longer than C<curlen>;
4292 C<retlen> will be set to the length, in bytes, of that character.
4294 If C<s> does not point to a well-formed UTF8 character, the behaviour
4295 is dependent on the value of C<flags>: if it contains UTF8_CHECK_ONLY,
4296 it is assumed that the caller will raise a warning, and this function
4297 will silently just set C<retlen> to C<-1> and return zero. If the
4298 C<flags> does not contain UTF8_CHECK_ONLY, warnings about
4299 malformations will be given, C<retlen> will be set to the expected
4300 length of the UTF-8 character in bytes, and zero will be returned.
4302 The C<flags> can also contain various flags to allow deviations from
4303 the strict UTF-8 encoding (see F<utf8.h>).
4305 Most code should use utf8_to_uvchr() rather than call this directly.
4307 UV utf8n_to_uvuni(U8 *s, STRLEN curlen, STRLEN* retlen, U32 flags)
4310 Found in file utf8.c
4314 Returns the number of UTF8 characters between the UTF-8 pointers C<a>
4317 WARNING: use only if you *know* that the pointers point inside the
4320 IV utf8_distance(U8 *a, U8 *b)
4323 Found in file utf8.c
4327 Return the UTF-8 pointer C<s> displaced by C<off> characters, either
4328 forward or backward.
4330 WARNING: do not use the following unless you *know* C<off> is within
4331 the UTF-8 data pointed to by C<s> *and* that on entry C<s> is aligned
4332 on the first byte of character or just after the last byte of a character.
4334 U8* utf8_hop(U8 *s, I32 off)
4337 Found in file utf8.c
4341 Return the length of the UTF-8 char encoded string C<s> in characters.
4342 Stops at C<e> (inclusive). If C<e E<lt> s> or if the scan would end
4343 up past C<e>, croaks.
4345 STRLEN utf8_length(U8* s, U8 *e)
4348 Found in file utf8.c
4352 Converts a string C<s> of length C<len> from UTF8 into byte encoding.
4353 Unlike C<bytes_to_utf8>, this over-writes the original string, and
4354 updates len to contain the new length.
4355 Returns zero on failure, setting C<len> to -1.
4357 NOTE: this function is experimental and may change or be
4358 removed without notice.
4360 U8* utf8_to_bytes(U8 *s, STRLEN *len)
4363 Found in file utf8.c
4367 Returns the native character value of the first character in the string C<s>
4368 which is assumed to be in UTF8 encoding; C<retlen> will be set to the
4369 length, in bytes, of that character.
4371 If C<s> does not point to a well-formed UTF8 character, zero is
4372 returned and retlen is set, if possible, to -1.
4374 UV utf8_to_uvchr(U8 *s, STRLEN* retlen)
4377 Found in file utf8.c
4381 Returns the Unicode code point of the first character in the string C<s>
4382 which is assumed to be in UTF8 encoding; C<retlen> will be set to the
4383 length, in bytes, of that character.
4385 This function should only be used when returned UV is considered
4386 an index into the Unicode semantic tables (e.g. swashes).
4388 If C<s> does not point to a well-formed UTF8 character, zero is
4389 returned and retlen is set, if possible, to -1.
4391 UV utf8_to_uvuni(U8 *s, STRLEN* retlen)
4394 Found in file utf8.c
4398 Adds the UTF8 representation of the Native codepoint C<uv> to the end
4399 of the string C<d>; C<d> should be have at least C<UTF8_MAXLEN+1> free
4400 bytes available. The return value is the pointer to the byte after the
4401 end of the new character. In other words,
4403 d = uvchr_to_utf8(d, uv);
4405 is the recommended wide native character-aware way of saying
4409 U8* uvchr_to_utf8(U8 *d, UV uv)
4412 Found in file utf8.c
4416 Adds the UTF8 representation of the Unicode codepoint C<uv> to the end
4417 of the string C<d>; C<d> should be have at least C<UTF8_MAXLEN+1> free
4418 bytes available. The return value is the pointer to the byte after the
4419 end of the new character. In other words,
4421 d = uvuni_to_utf8(d, uv);
4423 is the recommended Unicode-aware way of saying
4427 U8* uvuni_to_utf8(U8 *d, UV uv)
4430 Found in file utf8.c
4434 This is the XSUB-writer's interface to Perl's C<warn> function. Use this
4435 function the same way you use the C C<printf> function. See
4438 void warn(const char* pat, ...)
4441 Found in file util.c
4445 Push an integer onto the stack, extending the stack if necessary. Handles
4446 'set' magic. See C<PUSHi>.
4455 Push a double onto the stack, extending the stack if necessary. Handles
4456 'set' magic. See C<PUSHn>.
4465 Push a string onto the stack, extending the stack if necessary. The C<len>
4466 indicates the length of the string. Handles 'set' magic. See
4469 void XPUSHp(char* str, STRLEN len)
4476 Push an SV onto the stack, extending the stack if necessary. Does not
4477 handle 'set' magic. See C<PUSHs>.
4486 Push an unsigned integer onto the stack, extending the stack if necessary.
4496 Macro to declare an XSUB and its C parameter list. This is handled by
4500 Found in file XSUB.h
4504 Return from XSUB, indicating number of items on the stack. This is usually
4505 handled by C<xsubpp>.
4507 void XSRETURN(int nitems)
4510 Found in file XSUB.h
4512 =item XSRETURN_EMPTY
4514 Return an empty list from an XSUB immediately.
4519 Found in file XSUB.h
4523 Return an integer from an XSUB immediately. Uses C<XST_mIV>.
4525 void XSRETURN_IV(IV iv)
4528 Found in file XSUB.h
4532 Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
4537 Found in file XSUB.h
4541 Return a double from an XSUB immediately. Uses C<XST_mNV>.
4543 void XSRETURN_NV(NV nv)
4546 Found in file XSUB.h
4550 Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
4552 void XSRETURN_PV(char* str)
4555 Found in file XSUB.h
4557 =item XSRETURN_UNDEF
4559 Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
4564 Found in file XSUB.h
4568 Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
4573 Found in file XSUB.h
4577 Place an integer into the specified position C<pos> on the stack. The
4578 value is stored in a new mortal SV.
4580 void XST_mIV(int pos, IV iv)
4583 Found in file XSUB.h
4587 Place C<&PL_sv_no> into the specified position C<pos> on the
4590 void XST_mNO(int pos)
4593 Found in file XSUB.h
4597 Place a double into the specified position C<pos> on the stack. The value
4598 is stored in a new mortal SV.
4600 void XST_mNV(int pos, NV nv)
4603 Found in file XSUB.h
4607 Place a copy of a string into the specified position C<pos> on the stack.
4608 The value is stored in a new mortal SV.
4610 void XST_mPV(int pos, char* str)
4613 Found in file XSUB.h
4617 Place C<&PL_sv_undef> into the specified position C<pos> on the
4620 void XST_mUNDEF(int pos)
4623 Found in file XSUB.h
4627 Place C<&PL_sv_yes> into the specified position C<pos> on the
4630 void XST_mYES(int pos)
4633 Found in file XSUB.h
4637 The version identifier for an XS module. This is usually
4638 handled automatically by C<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>.
4641 Found in file XSUB.h
4643 =item XS_VERSION_BOOTCHECK
4645 Macro to verify that a PM module's $VERSION variable matches the XS
4646 module's C<XS_VERSION> variable. This is usually handled automatically by
4647 C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">.
4649 XS_VERSION_BOOTCHECK;
4652 Found in file XSUB.h
4656 The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the
4657 destination, C<nitems> is the number of items, and C<type> is the type.
4659 void Zero(void* dest, int nitems, type)
4662 Found in file handy.h
4668 Until May 1997, this document was maintained by Jeff Okamoto
4669 <okamoto@corp.hp.com>. It is now maintained as part of Perl itself.
4671 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
4672 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
4673 Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
4674 Stephen McCamant, and Gurusamy Sarathy.
4676 API Listing originally by Dean Roehrich <roehrich@cray.com>.
4678 Updated to be autogenerated from comments in the source by Benjamin Stuhl.
4682 perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
https://perl5.git.perl.org / perl5.git / blob