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 Recognise (or not) a number. The type of the number is returned
565 (0 if unrecognised), otherwise it is a bit-ORed combination of
566 IS_NUMBER_IN_UV, IS_NUMBER_GREATER_THAN_UV_MAX, IS_NUMBER_NOT_INT,
567 IS_NUMBER_NEG, IS_NUMBER_INFINITY, IS_NUMBER_NAN (defined in perl.h).
569 If the value of the number can fit an in UV, it is returned in the *valuep
570 IS_NUMBER_IN_UV will be set to indicate that *valuep is valid, IS_NUMBER_IN_UV
571 will never be set unless *valuep is valid, but *valuep may have been assigned
572 to during processing even though IS_NUMBER_IN_UV is not set on return.
573 If valuep is NULL, IS_NUMBER_IN_UV will be set for the same cases as when
574 valuep is non-NULL, but no actual assignment (or SEGV) will occur.
576 IS_NUMBER_NOT_INT will be set with IS_NUMBER_IN_UV if trailing decimals were
577 seen (in which case *valuep gives the true value truncated to an integer), and
578 IS_NUMBER_NEG if the number is negative (in which case *valuep holds the
579 absolute value). IS_NUMBER_IN_UV is not set if e notation was used or the
580 number is larger than a UV.
582 int grok_number(const char *pv, STRLEN len, UV *valuep)
585 Found in file numeric.c
587 =item grok_numeric_radix
589 Scan and skip for a numeric decimal separator (radix).
591 bool grok_numeric_radix(const char **sp, const char *send)
594 Found in file numeric.c
598 Return the SV from the GV.
607 Returns the glob with the given C<name> and a defined subroutine or
608 C<NULL>. The glob lives in the given C<stash>, or in the stashes
609 accessible via @ISA and UNIVERSAL::.
611 The argument C<level> should be either 0 or -1. If C<level==0>, as a
612 side-effect creates a glob with the given C<name> in the given C<stash>
613 which in the case of success contains an alias for the subroutine, and sets
614 up caching info for this glob. Similarly for all the searched stashes.
616 This function grants C<"SUPER"> token as a postfix of the stash name. The
617 GV returned from C<gv_fetchmeth> may be a method cache entry, which is not
618 visible to Perl code. So when calling C<call_sv>, you should not use
619 the GV directly; instead, you should use the method's CV, which can be
620 obtained from the GV with the C<GvCV> macro.
622 GV* gv_fetchmeth(HV* stash, const char* name, STRLEN len, I32 level)
629 See L<gv_fetchmethod_autoload>.
631 GV* gv_fetchmethod(HV* stash, const char* name)
636 =item gv_fetchmethod_autoload
638 Returns the glob which contains the subroutine to call to invoke the method
639 on the C<stash>. In fact in the presence of autoloading this may be the
640 glob for "AUTOLOAD". In this case the corresponding variable $AUTOLOAD is
643 The third parameter of C<gv_fetchmethod_autoload> determines whether
644 AUTOLOAD lookup is performed if the given method is not present: non-zero
645 means yes, look for AUTOLOAD; zero means no, don't look for AUTOLOAD.
646 Calling C<gv_fetchmethod> is equivalent to calling C<gv_fetchmethod_autoload>
647 with a non-zero C<autoload> parameter.
649 These functions grant C<"SUPER"> token as a prefix of the method name. Note
650 that if you want to keep the returned glob for a long time, you need to
651 check for it being "AUTOLOAD", since at the later time the call may load a
652 different subroutine due to $AUTOLOAD changing its value. Use the glob
653 created via a side effect to do this.
655 These functions have the same side-effects and as C<gv_fetchmeth> with
656 C<level==0>. C<name> should be writable if contains C<':'> or C<'
657 ''>. The warning against passing the GV returned by C<gv_fetchmeth> to
658 C<call_sv> apply equally to these functions.
660 GV* gv_fetchmethod_autoload(HV* stash, const char* name, I32 autoload)
667 Returns a pointer to the stash for a specified package. C<name> should
668 be a valid UTF-8 string. If C<create> is set then the package will be
669 created if it does not already exist. If C<create> is not set and the
670 package does not exist then NULL is returned.
672 HV* gv_stashpv(const char* name, I32 create)
679 Returns a pointer to the stash for a specified package, which must be a
680 valid UTF-8 string. See C<gv_stashpv>.
682 HV* gv_stashsv(SV* sv, I32 create)
689 Used to indicate list context. See C<GIMME_V>, C<GIMME> and
697 Indicates that arguments returned from a callback should be discarded. See
705 Used to force a Perl C<eval> wrapper around a callback. See
713 Indicates that no arguments are being sent to a callback. See
721 Used to indicate scalar context. See C<GIMME_V>, C<GIMME>, and
729 Used to indicate void context. See C<GIMME_V> and L<perlcall>.
736 This flag, used in the length slot of hash entries and magic structures,
737 specifies the structure contains a C<SV*> pointer where a C<char*> pointer
738 is to be expected. (For information only--not to be used).
745 Returns the computed hash stored in the hash entry.
754 Returns the actual pointer stored in the key slot of the hash entry. The
755 pointer may be either C<char*> or C<SV*>, depending on the value of
756 C<HeKLEN()>. Can be assigned to. The C<HePV()> or C<HeSVKEY()> macros are
757 usually preferable for finding the value of a key.
766 If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry
767 holds an C<SV*> key. Otherwise, holds the actual length of the key. Can
768 be assigned to. The C<HePV()> macro is usually preferable for finding key
771 STRLEN HeKLEN(HE* he)
778 Returns the key slot of the hash entry as a C<char*> value, doing any
779 necessary dereferencing of possibly C<SV*> keys. The length of the string
780 is placed in C<len> (this is a macro, so do I<not> use C<&len>). If you do
781 not care about what the length of the key is, you may use the global
782 variable C<PL_na>, though this is rather less efficient than using a local
783 variable. Remember though, that hash keys in perl are free to contain
784 embedded nulls, so using C<strlen()> or similar is not a good way to find
785 the length of hash keys. This is very similar to the C<SvPV()> macro
786 described elsewhere in this document.
788 char* HePV(HE* he, STRLEN len)
795 Returns the key as an C<SV*>, or C<Nullsv> if the hash entry does not
796 contain an C<SV*> key.
805 Returns the key as an C<SV*>. Will create and return a temporary mortal
806 C<SV*> if the hash entry contains only a C<char*> key.
808 SV* HeSVKEY_force(HE* he)
815 Sets the key to a given C<SV*>, taking care to set the appropriate flags to
816 indicate the presence of an C<SV*> key, and returns the same
819 SV* HeSVKEY_set(HE* he, SV* sv)
826 Returns the value slot (type C<SV*>) stored in the hash entry.
835 Returns the package name of a stash. See C<SvSTASH>, C<CvSTASH>.
837 char* HvNAME(HV* stash)
844 Clears a hash, making it empty.
846 void hv_clear(HV* tb)
853 Deletes a key/value pair in the hash. The value SV is removed from the
854 hash and returned to the caller. The C<klen> is the length of the key.
855 The C<flags> value will normally be zero; if set to G_DISCARD then NULL
858 SV* hv_delete(HV* tb, const char* key, I32 klen, I32 flags)
865 Deletes a key/value pair in the hash. The value SV is removed from the
866 hash and returned to the caller. The C<flags> value will normally be zero;
867 if set to G_DISCARD then NULL will be returned. C<hash> can be a valid
868 precomputed hash value, or 0 to ask for it to be computed.
870 SV* hv_delete_ent(HV* tb, SV* key, I32 flags, U32 hash)
877 Returns a boolean indicating whether the specified hash key exists. The
878 C<klen> is the length of the key.
880 bool hv_exists(HV* tb, const char* key, I32 klen)
887 Returns a boolean indicating whether the specified hash key exists. C<hash>
888 can be a valid precomputed hash value, or 0 to ask for it to be
891 bool hv_exists_ent(HV* tb, SV* key, U32 hash)
898 Returns the SV which corresponds to the specified key in the hash. The
899 C<klen> is the length of the key. If C<lval> is set then the fetch will be
900 part of a store. Check that the return value is non-null before
901 dereferencing it to a C<SV*>.
903 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
904 information on how to use this function on tied hashes.
906 SV** hv_fetch(HV* tb, const char* key, I32 klen, I32 lval)
913 Returns the hash entry which corresponds to the specified key in the hash.
914 C<hash> must be a valid precomputed hash number for the given C<key>, or 0
915 if you want the function to compute it. IF C<lval> is set then the fetch
916 will be part of a store. Make sure the return value is non-null before
917 accessing it. The return value when C<tb> is a tied hash is a pointer to a
918 static location, so be sure to make a copy of the structure if you need to
921 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
922 information on how to use this function on tied hashes.
924 HE* hv_fetch_ent(HV* tb, SV* key, I32 lval, U32 hash)
931 Prepares a starting point to traverse a hash table. Returns the number of
932 keys in the hash (i.e. the same as C<HvKEYS(tb)>). The return value is
933 currently only meaningful for hashes without tie magic.
935 NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
936 hash buckets that happen to be in use. If you still need that esoteric
937 value, you can get it through the macro C<HvFILL(tb)>.
939 I32 hv_iterinit(HV* tb)
946 Returns the key from the current position of the hash iterator. See
949 char* hv_iterkey(HE* entry, I32* retlen)
956 Returns the key as an C<SV*> from the current position of the hash
957 iterator. The return value will always be a mortal copy of the key. Also
960 SV* hv_iterkeysv(HE* entry)
967 Returns entries from a hash iterator. See C<hv_iterinit>.
969 HE* hv_iternext(HV* tb)
976 Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
979 SV* hv_iternextsv(HV* hv, char** key, I32* retlen)
986 Returns the value from the current position of the hash iterator. See
989 SV* hv_iterval(HV* tb, HE* entry)
996 Adds magic to a hash. See C<sv_magic>.
998 void hv_magic(HV* hv, GV* gv, int how)
1005 Stores an SV in a hash. The hash key is specified as C<key> and C<klen> is
1006 the length of the key. The C<hash> parameter is the precomputed hash
1007 value; if it is zero then Perl will compute it. The return value will be
1008 NULL if the operation failed or if the value did not need to be actually
1009 stored within the hash (as in the case of tied hashes). Otherwise it can
1010 be dereferenced to get the original C<SV*>. Note that the caller is
1011 responsible for suitably incrementing the reference count of C<val> before
1012 the call, and decrementing it if the function returned NULL.
1014 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1015 information on how to use this function on tied hashes.
1017 SV** hv_store(HV* tb, const char* key, I32 klen, SV* val, U32 hash)
1024 Stores C<val> in a hash. The hash key is specified as C<key>. The C<hash>
1025 parameter is the precomputed hash value; if it is zero then Perl will
1026 compute it. The return value is the new hash entry so created. It will be
1027 NULL if the operation failed or if the value did not need to be actually
1028 stored within the hash (as in the case of tied hashes). Otherwise the
1029 contents of the return value can be accessed using the C<He?> macros
1030 described here. Note that the caller is responsible for suitably
1031 incrementing the reference count of C<val> before the call, and
1032 decrementing it if the function returned NULL.
1034 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1035 information on how to use this function on tied hashes.
1037 HE* hv_store_ent(HV* tb, SV* key, SV* val, U32 hash)
1046 void hv_undef(HV* tb)
1053 Returns a boolean indicating whether the C C<char> is an ASCII alphanumeric
1054 character (including underscore) or digit.
1056 bool isALNUM(char ch)
1059 Found in file handy.h
1063 Returns a boolean indicating whether the C C<char> is an ASCII alphabetic
1066 bool isALPHA(char ch)
1069 Found in file handy.h
1073 Returns a boolean indicating whether the C C<char> is an ASCII
1076 bool isDIGIT(char ch)
1079 Found in file handy.h
1083 Returns a boolean indicating whether the C C<char> is a lowercase
1086 bool isLOWER(char ch)
1089 Found in file handy.h
1093 Returns a boolean indicating whether the C C<char> is whitespace.
1095 bool isSPACE(char ch)
1098 Found in file handy.h
1102 Returns a boolean indicating whether the C C<char> is an uppercase
1105 bool isUPPER(char ch)
1108 Found in file handy.h
1112 Tests if some arbitrary number of bytes begins in a valid UTF-8
1113 character. Note that an INVARIANT (i.e. ASCII) character is a valid UTF-8 character.
1114 The actual number of bytes in the UTF-8 character will be returned if
1115 it is valid, otherwise 0.
1117 STRLEN is_utf8_char(U8 *p)
1120 Found in file utf8.c
1122 =item is_utf8_string
1124 Returns true if first C<len> bytes of the given string form a valid UTF8
1125 string, false otherwise. Note that 'a valid UTF8 string' does not mean
1126 'a string that contains UTF8' because a valid ASCII string is a valid
1129 bool is_utf8_string(U8 *s, STRLEN len)
1132 Found in file utf8.c
1136 Variable which is setup by C<xsubpp> to indicate the number of
1137 items on the stack. See L<perlxs/"Variable-length Parameter Lists">.
1142 Found in file XSUB.h
1146 Variable which is setup by C<xsubpp> to indicate which of an
1147 XSUB's aliases was used to invoke it. See L<perlxs/"The ALIAS: Keyword">.
1152 Found in file XSUB.h
1156 Closing bracket on a callback. See C<ENTER> and L<perlcall>.
1161 Found in file scope.h
1165 Loads the module whose name is pointed to by the string part of name.
1166 Note that the actual module name, not its filename, should be given.
1167 Eg, "Foo::Bar" instead of "Foo/Bar.pm". flags can be any of
1168 PERL_LOADMOD_DENY, PERL_LOADMOD_NOIMPORT, or PERL_LOADMOD_IMPORT_OPS
1169 (or 0 for no flags). ver, if specified, provides version semantics
1170 similar to C<use Foo::Bar VERSION>. The optional trailing SV*
1171 arguments can be used to specify arguments to the module's import()
1172 method, similar to C<use Foo::Bar VERSION LIST>.
1174 void load_module(U32 flags, SV* name, SV* ver, ...)
1179 =item looks_like_number
1181 Test if the content of an SV looks like a number (or is a number).
1182 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1183 non-numeric warning), even if your atof() doesn't grok them.
1185 I32 looks_like_number(SV* sv)
1192 Stack marker variable for the XSUB. See C<dMARK>.
1199 Clear something magical that the SV represents. See C<sv_magic>.
1201 int mg_clear(SV* sv)
1208 Copies the magic from one SV to another. See C<sv_magic>.
1210 int mg_copy(SV* sv, SV* nsv, const char* key, I32 klen)
1217 Finds the magic pointer for type matching the SV. See C<sv_magic>.
1219 MAGIC* mg_find(SV* sv, int type)
1226 Free any magic storage used by the SV. See C<sv_magic>.
1235 Do magic after a value is retrieved from the SV. See C<sv_magic>.
1244 Report on the SV's length. See C<sv_magic>.
1246 U32 mg_length(SV* sv)
1253 Turns on the magical status of an SV. See C<sv_magic>.
1255 void mg_magical(SV* sv)
1262 Do magic after a value is assigned to the SV. See C<sv_magic>.
1271 The XSUB-writer's interface to the C C<memmove> function. The C<src> is the
1272 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1273 the type. Can do overlapping moves. See also C<Copy>.
1275 void Move(void* src, void* dest, int nitems, type)
1278 Found in file handy.h
1282 The XSUB-writer's interface to the C C<malloc> function.
1284 void New(int id, void* ptr, int nitems, type)
1287 Found in file handy.h
1291 Creates a new AV. The reference count is set to 1.
1300 The XSUB-writer's interface to the C C<malloc> function, with
1303 void Newc(int id, void* ptr, int nitems, type, cast)
1306 Found in file handy.h
1310 Creates a constant sub equivalent to Perl C<sub FOO () { 123 }> which is
1311 eligible for inlining at compile-time.
1313 CV* newCONSTSUB(HV* stash, char* name, SV* sv)
1320 Creates a new HV. The reference count is set to 1.
1329 Creates an RV wrapper for an SV. The reference count for the original SV is
1332 SV* newRV_inc(SV* sv)
1339 Creates an RV wrapper for an SV. The reference count for the original
1340 SV is B<not> incremented.
1342 SV* newRV_noinc(SV *sv)
1349 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
1350 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
1353 SV* newSV(STRLEN len)
1360 Creates a new SV. A non-zero C<len> parameter indicates the number of
1361 bytes of preallocated string space the SV should have. An extra byte for a
1362 tailing NUL is also reserved. (SvPOK is not set for the SV even if string
1363 space is allocated.) The reference count for the new SV is set to 1.
1364 C<id> is an integer id between 0 and 1299 (used to identify leaks).
1366 SV* NEWSV(int id, STRLEN len)
1369 Found in file handy.h
1373 Creates a new SV and copies an integer into it. The reference count for the
1383 Creates a new SV and copies a floating point value into it.
1384 The reference count for the SV is set to 1.
1393 Creates a new SV and copies a string into it. The reference count for the
1394 SV is set to 1. If C<len> is zero, Perl will compute the length using
1395 strlen(). For efficiency, consider using C<newSVpvn> instead.
1397 SV* newSVpv(const char* s, STRLEN len)
1404 Creates a new SV and initializes it with the string formatted like
1407 SV* newSVpvf(const char* pat, ...)
1414 Creates a new SV and copies a string into it. The reference count for the
1415 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
1416 string. You are responsible for ensuring that the source string is at least
1419 SV* newSVpvn(const char* s, STRLEN len)
1424 =item newSVpvn_share
1426 Creates a new SV with its SvPVX pointing to a shared string in the string
1427 table. If the string does not already exist in the table, it is created
1428 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
1429 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
1430 otherwise the hash is computed. The idea here is that as the string table
1431 is used for shared hash keys these strings will have SvPVX == HeKEY and
1432 hash lookup will avoid string compare.
1434 SV* newSVpvn_share(const char* s, I32 len, U32 hash)
1441 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
1442 it will be upgraded to one. If C<classname> is non-null then the new SV will
1443 be blessed in the specified package. The new SV is returned and its
1444 reference count is 1.
1446 SV* newSVrv(SV* rv, const char* classname)
1453 Creates a new SV which is an exact duplicate of the original SV.
1456 SV* newSVsv(SV* old)
1463 Creates a new SV and copies an unsigned integer into it.
1464 The reference count for the SV is set to 1.
1473 Used by C<xsubpp> to hook up XSUBs as Perl subs.
1480 Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
1484 Found in file XSUB.h
1488 The XSUB-writer's interface to the C C<malloc> function. The allocated
1489 memory is zeroed with C<memzero>.
1491 void Newz(int id, void* ptr, int nitems, type)
1494 Found in file handy.h
1505 Null character pointer.
1508 Found in file handy.h
1529 Found in file handy.h
1533 The original stack mark for the XSUB. See C<dORIGMARK>.
1540 Allocates a new Perl interpreter. See L<perlembed>.
1542 PerlInterpreter* perl_alloc()
1545 Found in file perl.c
1549 Create and return a new interpreter by cloning the current one.
1551 PerlInterpreter* perl_clone(PerlInterpreter* interp, UV flags)
1556 =item perl_construct
1558 Initializes a new Perl interpreter. See L<perlembed>.
1560 void perl_construct(PerlInterpreter* interp)
1563 Found in file perl.c
1567 Shuts down a Perl interpreter. See L<perlembed>.
1569 int perl_destruct(PerlInterpreter* interp)
1572 Found in file perl.c
1576 Releases a Perl interpreter. See L<perlembed>.
1578 void perl_free(PerlInterpreter* interp)
1581 Found in file perl.c
1585 Tells a Perl interpreter to parse a Perl script. See L<perlembed>.
1587 int perl_parse(PerlInterpreter* interp, XSINIT_t xsinit, int argc, char** argv, char** env)
1590 Found in file perl.c
1594 Tells a Perl interpreter to run. See L<perlembed>.
1596 int perl_run(PerlInterpreter* interp)
1599 Found in file perl.c
1603 C<PL_modglobal> is a general purpose, interpreter global HV for use by
1604 extensions that need to keep information on a per-interpreter basis.
1605 In a pinch, it can also be used as a symbol table for extensions
1606 to share data among each other. It is a good idea to use keys
1607 prefixed by the package name of the extension that owns the data.
1612 Found in file intrpvar.h
1616 A convenience variable which is typically used with C<SvPV> when one
1617 doesn't care about the length of the string. It is usually more efficient
1618 to either declare a local variable and use that instead or to use the
1619 C<SvPV_nolen> macro.
1624 Found in file thrdvar.h
1628 This is the C<false> SV. See C<PL_sv_yes>. Always refer to this as
1634 Found in file intrpvar.h
1638 This is the C<undef> SV. Always refer to this as C<&PL_sv_undef>.
1643 Found in file intrpvar.h
1647 This is the C<true> SV. See C<PL_sv_no>. Always refer to this as
1653 Found in file intrpvar.h
1657 Pops an integer off the stack.
1666 Pops a long off the stack.
1675 Pops a double off the stack.
1684 Pops a string off the stack. Deprecated. New code should provide
1685 a STRLEN n_a and use POPpx.
1694 Pops a string off the stack which must consist of bytes i.e. characters < 256.
1695 Requires a variable STRLEN n_a in scope.
1704 Pops a string off the stack.
1705 Requires a variable STRLEN n_a in scope.
1714 Pops an SV off the stack.
1723 Push an integer onto the stack. The stack must have room for this element.
1724 Handles 'set' magic. See C<XPUSHi>.
1733 Opening bracket for arguments on a callback. See C<PUTBACK> and
1743 Push a double onto the stack. The stack must have room for this element.
1744 Handles 'set' magic. See C<XPUSHn>.
1753 Push a string onto the stack. The stack must have room for this element.
1754 The C<len> indicates the length of the string. Handles 'set' magic. See
1757 void PUSHp(char* str, STRLEN len)
1764 Push an SV onto the stack. The stack must have room for this element.
1765 Does not handle 'set' magic. See C<XPUSHs>.
1774 Push an unsigned integer onto the stack. The stack must have room for this
1775 element. See C<XPUSHu>.
1784 Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
1785 See C<PUSHMARK> and L<perlcall> for other uses.
1794 The XSUB-writer's interface to the C C<realloc> function.
1796 void Renew(void* ptr, int nitems, type)
1799 Found in file handy.h
1803 The XSUB-writer's interface to the C C<realloc> function, with
1806 void Renewc(void* ptr, int nitems, type, cast)
1809 Found in file handy.h
1813 Tells Perl to C<require> the file named by the string argument. It is
1814 analogous to the Perl code C<eval "require '$file'">. It's even
1815 implemented that way; consider using Perl_load_module instead.
1817 NOTE: the perl_ form of this function is deprecated.
1819 void require_pv(const char* pv)
1822 Found in file perl.c
1826 Variable which is setup by C<xsubpp> to hold the return value for an
1827 XSUB. This is always the proper type for the XSUB. See
1828 L<perlxs/"The RETVAL Variable">.
1833 Found in file XSUB.h
1837 The XSUB-writer's interface to the C C<free> function.
1839 void Safefree(void* ptr)
1842 Found in file handy.h
1846 Copy a string to a safe spot. This does not use an SV.
1848 char* savepv(const char* sv)
1851 Found in file util.c
1855 Copy a string to a safe spot. The C<len> indicates number of bytes to
1856 copy. This does not use an SV.
1858 char* savepvn(const char* sv, I32 len)
1861 Found in file util.c
1865 Opening bracket for temporaries on a callback. See C<FREETMPS> and
1871 Found in file scope.h
1875 Tries to find if a given SV has a shared backend, either by
1876 looking at magic, or by checking if it is tied again threads::shared.
1878 shared_sv* sharedsv_find(SV* sv)
1881 Found in file sharedsv.c
1885 Saves a space for keeping SVs wider than an interpreter,
1886 currently only stores a pointer to the first interpreter.
1888 void sharedsv_init()
1891 Found in file sharedsv.c
1895 Recursive locks on a sharedsv.
1896 Locks are dynamicly scoped at the level of the first lock.
1897 void sharedsv_lock(shared_sv* ssv)
1900 Found in file sharedsv.c
1904 Allocates a new shared sv struct, you must yourself create the SV/AV/HV.
1905 shared_sv* sharedsv_new()
1908 Found in file sharedsv.c
1910 =item sharedsv_thrcnt_dec
1912 Decrements the threadcount of a shared sv. When a threads frontend is freed
1913 this function should be called.
1915 void sharedsv_thrcnt_dec(shared_sv* ssv)
1918 Found in file sharedsv.c
1920 =item sharedsv_thrcnt_inc
1922 Increments the threadcount of a sharedsv.
1923 void sharedsv_thrcnt_inc(shared_sv* ssv)
1926 Found in file sharedsv.c
1928 =item sharedsv_unlock
1930 Recursively unlocks a shared sv.
1932 void sharedsv_unlock(shared_sv* ssv)
1935 Found in file sharedsv.c
1939 Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and
1947 Refetch the stack pointer. Used after a callback. See L<perlcall>.
1956 Used to access elements on the XSUB's stack.
1961 Found in file XSUB.h
1965 Test two strings to see if they are equal. Returns true or false.
1967 bool strEQ(char* s1, char* s2)
1970 Found in file handy.h
1974 Test two strings to see if the first, C<s1>, is greater than or equal to
1975 the second, C<s2>. Returns true or false.
1977 bool strGE(char* s1, char* s2)
1980 Found in file handy.h
1984 Test two strings to see if the first, C<s1>, is greater than the second,
1985 C<s2>. Returns true or false.
1987 bool strGT(char* s1, char* s2)
1990 Found in file handy.h
1994 Test two strings to see if the first, C<s1>, is less than or equal to the
1995 second, C<s2>. Returns true or false.
1997 bool strLE(char* s1, char* s2)
2000 Found in file handy.h
2004 Test two strings to see if the first, C<s1>, is less than the second,
2005 C<s2>. Returns true or false.
2007 bool strLT(char* s1, char* s2)
2010 Found in file handy.h
2014 Test two strings to see if they are different. Returns true or
2017 bool strNE(char* s1, char* s2)
2020 Found in file handy.h
2024 Test two strings to see if they are equal. The C<len> parameter indicates
2025 the number of bytes to compare. Returns true or false. (A wrapper for
2028 bool strnEQ(char* s1, char* s2, STRLEN len)
2031 Found in file handy.h
2035 Test two strings to see if they are different. The C<len> parameter
2036 indicates the number of bytes to compare. Returns true or false. (A
2037 wrapper for C<strncmp>).
2039 bool strnNE(char* s1, char* s2, STRLEN len)
2042 Found in file handy.h
2046 This is an architecture-independent macro to copy one structure to another.
2048 void StructCopy(type src, type dest, type)
2051 Found in file handy.h
2055 Returns the length of the string which is in the SV. See C<SvLEN>.
2057 STRLEN SvCUR(SV* sv)
2064 Set the length of the string which is in the SV. See C<SvCUR>.
2066 void SvCUR_set(SV* sv, STRLEN len)
2073 Returns a pointer to the last character in the string which is in the SV.
2074 See C<SvCUR>. Access the character as *(SvEND(sv)).
2083 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
2084 argument more than once.
2086 void SvGETMAGIC(SV* sv)
2093 Expands the character buffer in the SV so that it has room for the
2094 indicated number of bytes (remember to reserve space for an extra trailing
2095 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
2096 Returns a pointer to the character buffer.
2098 char * SvGROW(SV* sv, STRLEN len)
2105 Returns a boolean indicating whether the SV contains an integer.
2114 Returns a boolean indicating whether the SV contains an integer. Checks
2115 the B<private> setting. Use C<SvIOK>.
2124 Returns a boolean indicating whether the SV contains an signed integer.
2126 void SvIOK_notUV(SV* sv)
2133 Unsets the IV status of an SV.
2135 void SvIOK_off(SV* sv)
2142 Tells an SV that it is an integer.
2144 void SvIOK_on(SV* sv)
2151 Tells an SV that it is an integer and disables all other OK bits.
2153 void SvIOK_only(SV* sv)
2160 Tells and SV that it is an unsigned integer and disables all other OK bits.
2162 void SvIOK_only_UV(SV* sv)
2169 Returns a boolean indicating whether the SV contains an unsigned integer.
2171 void SvIOK_UV(SV* sv)
2178 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
2179 version which guarantees to evaluate sv only once.
2188 Coerces the given SV to an integer and returns it. Guarantees to evaluate
2189 sv only once. Use the more efficent C<SvIV> otherwise.
2198 Returns the raw value in the SV's IV slot, without checks or conversions.
2199 Only use when you are sure SvIOK is true. See also C<SvIV()>.
2208 Returns the size of the string buffer in the SV, not including any part
2209 attributable to C<SvOOK>. See C<SvCUR>.
2211 STRLEN SvLEN(SV* sv)
2218 Returns a boolean indicating whether the SV contains a number, integer or
2228 Returns a boolean indicating whether the SV contains a number, integer or
2229 double. Checks the B<private> setting. Use C<SvNIOK>.
2231 bool SvNIOKp(SV* sv)
2238 Unsets the NV/IV status of an SV.
2240 void SvNIOK_off(SV* sv)
2247 Returns a boolean indicating whether the SV contains a double.
2256 Returns a boolean indicating whether the SV contains a double. Checks the
2257 B<private> setting. Use C<SvNOK>.
2266 Unsets the NV status of an SV.
2268 void SvNOK_off(SV* sv)
2275 Tells an SV that it is a double.
2277 void SvNOK_on(SV* sv)
2284 Tells an SV that it is a double and disables all other OK bits.
2286 void SvNOK_only(SV* sv)
2293 Coerce the given SV to a double and return it. See C<SvNVx> for a version
2294 which guarantees to evaluate sv only once.
2303 Coerces the given SV to a double and returns it. Guarantees to evaluate
2304 sv only once. Use the more efficent C<SvNV> otherwise.
2313 Returns the raw value in the SV's NV slot, without checks or conversions.
2314 Only use when you are sure SvNOK is true. See also C<SvNV()>.
2323 Returns a boolean indicating whether the value is an SV.
2332 Returns a boolean indicating whether the SvIVX is a valid offset value for
2333 the SvPVX. This hack is used internally to speed up removal of characters
2334 from the beginning of a SvPV. When SvOOK is true, then the start of the
2335 allocated string buffer is really (SvPVX - SvIVX).
2344 Returns a boolean indicating whether the SV contains a character
2354 Returns a boolean indicating whether the SV contains a character string.
2355 Checks the B<private> setting. Use C<SvPOK>.
2364 Unsets the PV status of an SV.
2366 void SvPOK_off(SV* sv)
2373 Tells an SV that it is a string.
2375 void SvPOK_on(SV* sv)
2382 Tells an SV that it is a string and disables all other OK bits.
2383 Will also turn off the UTF8 status.
2385 void SvPOK_only(SV* sv)
2390 =item SvPOK_only_UTF8
2392 Tells an SV that it is a string and disables all other OK bits,
2393 and leaves the UTF8 status as it was.
2395 void SvPOK_only_UTF8(SV* sv)
2402 Returns a pointer to the string in the SV, or a stringified form of the SV
2403 if the SV does not contain a string. Handles 'get' magic. See also
2404 C<SvPVx> for a version which guarantees to evaluate sv only once.
2406 char* SvPV(SV* sv, STRLEN len)
2413 Like C<SvPV>, but converts sv to byte representation first if necessary.
2415 char* SvPVbyte(SV* sv, STRLEN len)
2422 Like C<SvPV>, but converts sv to byte representation first if necessary.
2423 Guarantees to evalute sv only once; use the more efficient C<SvPVbyte>
2427 char* SvPVbytex(SV* sv, STRLEN len)
2432 =item SvPVbytex_force
2434 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
2435 Guarantees to evalute sv only once; use the more efficient C<SvPVbyte_force>
2438 char* SvPVbytex_force(SV* sv, STRLEN len)
2443 =item SvPVbyte_force
2445 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
2447 char* SvPVbyte_force(SV* sv, STRLEN len)
2452 =item SvPVbyte_nolen
2454 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
2456 char* SvPVbyte_nolen(SV* sv, STRLEN len)
2463 Like C<SvPV>, but converts sv to uft8 first if necessary.
2465 char* SvPVutf8(SV* sv, STRLEN len)
2472 Like C<SvPV>, but converts sv to uft8 first if necessary.
2473 Guarantees to evalute sv only once; use the more efficient C<SvPVutf8>
2476 char* SvPVutf8x(SV* sv, STRLEN len)
2481 =item SvPVutf8x_force
2483 Like C<SvPV_force>, but converts sv to uft8 first if necessary.
2484 Guarantees to evalute sv only once; use the more efficient C<SvPVutf8_force>
2487 char* SvPVutf8x_force(SV* sv, STRLEN len)
2492 =item SvPVutf8_force
2494 Like C<SvPV_force>, but converts sv to uft8 first if necessary.
2496 char* SvPVutf8_force(SV* sv, STRLEN len)
2501 =item SvPVutf8_nolen
2503 Like C<SvPV_nolen>, but converts sv to uft8 first if necessary.
2505 char* SvPVutf8_nolen(SV* sv, STRLEN len)
2512 A version of C<SvPV> which guarantees to evaluate sv only once.
2514 char* SvPVx(SV* sv, STRLEN len)
2521 Returns a pointer to the physical string in the SV. The SV must contain a
2531 Like <SvPV> but will force the SV into becoming a string (SvPOK). You want
2532 force if you are going to update the SvPVX directly.
2534 char* SvPV_force(SV* sv, STRLEN len)
2539 =item SvPV_force_nomg
2541 Like <SvPV> but will force the SV into becoming a string (SvPOK). You want
2542 force if you are going to update the SvPVX directly. Doesn't process magic.
2544 char* SvPV_force_nomg(SV* sv, STRLEN len)
2551 Returns a pointer to the string in the SV, or a stringified form of the SV
2552 if the SV does not contain a string. Handles 'get' magic.
2554 char* SvPV_nolen(SV* sv)
2561 Returns the value of the object's reference count.
2563 U32 SvREFCNT(SV* sv)
2570 Decrements the reference count of the given SV.
2572 void SvREFCNT_dec(SV* sv)
2579 Increments the reference count of the given SV.
2581 SV* SvREFCNT_inc(SV* sv)
2588 Tests if the SV is an RV.
2597 Unsets the RV status of an SV.
2599 void SvROK_off(SV* sv)
2606 Tells an SV that it is an RV.
2608 void SvROK_on(SV* sv)
2615 Dereferences an RV to return the SV.
2624 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
2625 argument more than once.
2627 void SvSETMAGIC(SV* sv)
2634 Like C<SvSetSV>, but does any set magic required afterwards.
2636 void SvSetMagicSV(SV* dsb, SV* ssv)
2641 =item SvSetMagicSV_nosteal
2643 Like C<SvSetMagicSV>, but does any set magic required afterwards.
2645 void SvSetMagicSV_nosteal(SV* dsv, SV* ssv)
2652 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
2655 void SvSetSV(SV* dsb, SV* ssv)
2660 =item SvSetSV_nosteal
2662 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
2663 ssv. May evaluate arguments more than once.
2665 void SvSetSV_nosteal(SV* dsv, SV* ssv)
2672 Returns the stash of the SV.
2681 Taints an SV if tainting is enabled
2683 void SvTAINT(SV* sv)
2690 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
2693 bool SvTAINTED(SV* sv)
2700 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
2701 some of Perl's fundamental security features. XS module authors should not
2702 use this function unless they fully understand all the implications of
2703 unconditionally untainting the value. Untainting should be done in the
2704 standard perl fashion, via a carefully crafted regexp, rather than directly
2705 untainting variables.
2707 void SvTAINTED_off(SV* sv)
2714 Marks an SV as tainted.
2716 void SvTAINTED_on(SV* sv)
2723 Returns a boolean indicating whether Perl would evaluate the SV as true or
2724 false, defined or undefined. Does not handle 'get' magic.
2733 An enum of flags for Perl types. These are found in the file B<sv.h>
2734 in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
2741 Returns the type of the SV. See C<svtype>.
2743 svtype SvTYPE(SV* sv)
2750 Integer type flag for scalars. See C<svtype>.
2757 Double type flag for scalars. See C<svtype>.
2764 Pointer type flag for scalars. See C<svtype>.
2771 Type flag for arrays. See C<svtype>.
2778 Type flag for code refs. See C<svtype>.
2785 Type flag for hashes. See C<svtype>.
2792 Type flag for blessed scalars. See C<svtype>.
2799 Returns a boolean indicating whether the SV contains an unsigned integer.
2808 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
2809 perform the upgrade if necessary. See C<svtype>.
2811 void SvUPGRADE(SV* sv, svtype type)
2818 Returns a boolean indicating whether the SV contains UTF-8 encoded data.
2827 Unsets the UTF8 status of an SV.
2829 void SvUTF8_off(SV *sv)
2836 Turn on the UTF8 status of an SV (the data is not changed, just the flag).
2837 Do not use frivolously.
2839 void SvUTF8_on(SV *sv)
2846 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
2847 for a version which guarantees to evaluate sv only once.
2856 Returns the raw value in the SV's UV slot, without checks or conversions.
2857 Only use when you are sure SvIOK is true. See also C<SvUV()>.
2866 Coerces the given SV to an unsigned integer and returns it. Guarantees to
2867 evaluate sv only once. Use the more efficent C<SvUV> otherwise.
2876 This function is only called on magical items, and is only used by
2877 sv_true() or its macro equivalent.
2879 bool sv_2bool(SV* sv)
2886 Using various gambits, try to get a CV from an SV; in addition, try if
2887 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
2889 CV* sv_2cv(SV* sv, HV** st, GV** gvp, I32 lref)
2896 Using various gambits, try to get an IO from an SV: the IO slot if its a
2897 GV; or the recursive result if we're an RV; or the IO slot of the symbol
2898 named after the PV if we're a string.
2907 Return the integer value of an SV, doing any necessary string conversion,
2908 magic etc. Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2917 Marks an existing SV as mortal. The SV will be destroyed "soon", either
2918 by an explicit call to FREETMPS, or by an implicit call at places such as
2919 statement boundaries. See also C<sv_newmortal> and C<sv_mortalcopy>.
2921 SV* sv_2mortal(SV* sv)
2928 Return the num value of an SV, doing any necessary string or integer
2929 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2939 Return a pointer to the byte-encoded representation of the SV, and set *lp
2940 to its length. May cause the SV to be downgraded from UTF8 as a
2943 Usually accessed via the C<SvPVbyte> macro.
2945 char* sv_2pvbyte(SV* sv, STRLEN* lp)
2950 =item sv_2pvbyte_nolen
2952 Return a pointer to the byte-encoded representation of the SV.
2953 May cause the SV to be downgraded from UTF8 as a side-effect.
2955 Usually accessed via the C<SvPVbyte_nolen> macro.
2957 char* sv_2pvbyte_nolen(SV* sv)
2964 Return a pointer to the UTF8-encoded representation of the SV, and set *lp
2965 to its length. May cause the SV to be upgraded to UTF8 as a side-effect.
2967 Usually accessed via the C<SvPVutf8> macro.
2969 char* sv_2pvutf8(SV* sv, STRLEN* lp)
2974 =item sv_2pvutf8_nolen
2976 Return a pointer to the UTF8-encoded representation of the SV.
2977 May cause the SV to be upgraded to UTF8 as a side-effect.
2979 Usually accessed via the C<SvPVutf8_nolen> macro.
2981 char* sv_2pvutf8_nolen(SV* sv)
2988 Returns a pointer to the string value of an SV, and sets *lp to its length.
2989 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2991 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2992 usually end up here too.
2994 char* sv_2pv_flags(SV* sv, STRLEN* lp, I32 flags)
3001 Like C<sv_2pv()>, but doesn't return the length too. You should usually
3002 use the macro wrapper C<SvPV_nolen(sv)> instead.
3003 char* sv_2pv_nolen(SV* sv)
3010 Return the unsigned integer value of an SV, doing any necessary string
3011 conversion, magic etc. Normally used via the C<SvUV(sv)> and C<SvUVx(sv)>
3021 Remove any string offset. You should normally use the C<SvOOK_off> macro
3024 int sv_backoff(SV* sv)
3031 Blesses an SV into a specified package. The SV must be an RV. The package
3032 must be designated by its stash (see C<gv_stashpv()>). The reference count
3033 of the SV is unaffected.
3035 SV* sv_bless(SV* sv, HV* stash)
3042 Concatenates the string onto the end of the string which is in the SV.
3043 If the SV has the UTF8 status set, then the bytes appended should be
3044 valid UTF8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
3046 void sv_catpv(SV* sv, const char* ptr)
3053 Processes its arguments like C<sprintf> and appends the formatted
3054 output to an SV. If the appended data contains "wide" characters
3055 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
3056 and characters >255 formatted with %c), the original SV might get
3057 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic.
3058 C<SvSETMAGIC()> must typically be called after calling this function
3059 to handle 'set' magic.
3061 void sv_catpvf(SV* sv, const char* pat, ...)
3068 Like C<sv_catpvf>, but also handles 'set' magic.
3070 void sv_catpvf_mg(SV *sv, const char* pat, ...)
3077 Concatenates the string onto the end of the string which is in the SV. The
3078 C<len> indicates number of bytes to copy. If the SV has the UTF8
3079 status set, then the bytes appended should be valid UTF8.
3080 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
3082 void sv_catpvn(SV* sv, const char* ptr, STRLEN len)
3087 =item sv_catpvn_flags
3089 Concatenates the string onto the end of the string which is in the SV. The
3090 C<len> indicates number of bytes to copy. If the SV has the UTF8
3091 status set, then the bytes appended should be valid UTF8.
3092 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
3093 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
3094 in terms of this function.
3096 void sv_catpvn_flags(SV* sv, const char* ptr, STRLEN len, I32 flags)
3103 Like C<sv_catpvn>, but also handles 'set' magic.
3105 void sv_catpvn_mg(SV *sv, const char *ptr, STRLEN len)
3112 Like C<sv_catpv>, but also handles 'set' magic.
3114 void sv_catpv_mg(SV *sv, const char *ptr)
3121 Concatenates the string from SV C<ssv> onto the end of the string in
3122 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
3123 not 'set' magic. See C<sv_catsv_mg>.
3125 void sv_catsv(SV* dsv, SV* ssv)
3130 =item sv_catsv_flags
3132 Concatenates the string from SV C<ssv> onto the end of the string in
3133 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
3134 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
3135 and C<sv_catsv_nomg> are implemented in terms of this function.
3137 void sv_catsv_flags(SV* dsv, SV* ssv, I32 flags)
3144 Like C<sv_catsv>, but also handles 'set' magic.
3146 void sv_catsv_mg(SV *dstr, SV *sstr)
3153 Efficient removal of characters from the beginning of the string buffer.
3154 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
3155 the string buffer. The C<ptr> becomes the first character of the adjusted
3156 string. Uses the "OOK hack".
3158 void sv_chop(SV* sv, char* ptr)
3165 Clear an SV: call any destructors, free up any memory used by the body,
3166 and free the body itself. The SV's head is I<not> freed, although
3167 its type is set to all 1's so that it won't inadvertently be assumed
3168 to be live during global destruction etc.
3169 This function should only be called when REFCNT is zero. Most of the time
3170 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
3173 void sv_clear(SV* sv)
3180 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
3181 string in C<sv1> is less than, equal to, or greater than the string in
3182 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
3183 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
3185 I32 sv_cmp(SV* sv1, SV* sv2)
3192 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
3193 'use bytes' aware, handles get magic, and will coerce its args to strings
3194 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
3196 I32 sv_cmp_locale(SV* sv1, SV* sv2)
3203 Add Collate Transform magic to an SV if it doesn't already have it.
3205 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
3206 scalar data of the variable, but transformed to such a format that a normal
3207 memory comparison can be used to compare the data according to the locale
3210 char* sv_collxfrm(SV* sv, STRLEN* nxp)
3217 Auto-decrement of the value in the SV, doing string to numeric conversion
3218 if necessary. Handles 'get' magic.
3225 =item sv_derived_from
3227 Returns a boolean indicating whether the SV is derived from the specified
3228 class. This is the function that implements C<UNIVERSAL::isa>. It works
3229 for class names as well as for objects.
3231 bool sv_derived_from(SV* sv, const char* name)
3234 Found in file universal.c
3238 Returns a boolean indicating whether the strings in the two SVs are
3239 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
3240 coerce its args to strings if necessary.
3242 I32 sv_eq(SV* sv1, SV* sv2)
3247 =item sv_force_normal
3249 Undo various types of fakery on an SV: if the PV is a shared string, make
3250 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3251 an xpvmg. See also C<sv_force_normal_flags>.
3253 void sv_force_normal(SV *sv)
3258 =item sv_force_normal_flags
3260 Undo various types of fakery on an SV: if the PV is a shared string, make
3261 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3262 an xpvmg. The C<flags> parameter gets passed to C<sv_unref_flags()>
3263 when unrefing. C<sv_force_normal> calls this function with flags set to 0.
3265 void sv_force_normal_flags(SV *sv, U32 flags)
3272 Decrement an SV's reference count, and if it drops to zero, call
3273 C<sv_clear> to invoke destructors and free up any memory used by
3274 the body; finally, deallocate the SV's head itself.
3275 Normally called via a wrapper macro C<SvREFCNT_dec>.
3277 void sv_free(SV* sv)
3284 Get a line from the filehandle and store it into the SV, optionally
3285 appending to the currently-stored string.
3287 char* sv_gets(SV* sv, PerlIO* fp, I32 append)
3294 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
3295 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
3296 Use the C<SvGROW> wrapper instead.
3298 char* sv_grow(SV* sv, STRLEN newlen)
3305 Auto-increment of the value in the SV, doing string to numeric conversion
3306 if necessary. Handles 'get' magic.
3315 Inserts a string at the specified offset/length within the SV. Similar to
3316 the Perl substr() function.
3318 void sv_insert(SV* bigsv, STRLEN offset, STRLEN len, char* little, STRLEN littlelen)
3325 Returns a boolean indicating whether the SV is blessed into the specified
3326 class. This does not check for subtypes; use C<sv_derived_from> to verify
3327 an inheritance relationship.
3329 int sv_isa(SV* sv, const char* name)
3336 Returns a boolean indicating whether the SV is an RV pointing to a blessed
3337 object. If the SV is not an RV, or if the object is not blessed, then this
3340 int sv_isobject(SV* sv)
3347 A private implementation of the C<SvIVx> macro for compilers which can't
3348 cope with complex macro expressions. Always use the macro instead.
3357 Returns the length of the string in the SV. Handles magic and type
3358 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
3360 STRLEN sv_len(SV* sv)
3367 Returns the number of characters in the string in an SV, counting wide
3368 UTF8 bytes as a single character. Handles magic and type coercion.
3370 STRLEN sv_len_utf8(SV* sv)
3377 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
3378 then adds a new magic item of type C<how> to the head of the magic list.
3380 C<name> is assumed to contain an C<SV*> if C<(name && namelen == HEf_SVKEY)>
3382 void sv_magic(SV* sv, SV* obj, int how, const char* name, I32 namlen)
3389 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
3390 The new SV is marked as mortal. It will be destroyed "soon", either by an
3391 explicit call to FREETMPS, or by an implicit call at places such as
3392 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
3394 SV* sv_mortalcopy(SV* oldsv)
3401 Creates a new null SV which is mortal. The reference count of the SV is
3402 set to 1. It will be destroyed "soon", either by an explicit call to
3403 FREETMPS, or by an implicit call at places such as statement boundaries.
3404 See also C<sv_mortalcopy> and C<sv_2mortal>.
3413 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
3416 SV* sv_newref(SV* sv)
3423 A private implementation of the C<SvNVx> macro for compilers which can't
3424 cope with complex macro expressions. Always use the macro instead.
3433 Converts the value pointed to by offsetp from a count of bytes from the
3434 start of the string, to a count of the equivalent number of UTF8 chars.
3435 Handles magic and type coercion.
3437 void sv_pos_b2u(SV* sv, I32* offsetp)
3444 Converts the value pointed to by offsetp from a count of UTF8 chars from
3445 the start of the string, to a count of the equivalent number of bytes; if
3446 lenp is non-zero, it does the same to lenp, but this time starting from
3447 the offset, rather than from the start of the string. Handles magic and
3450 void sv_pos_u2b(SV* sv, I32* offsetp, I32* lenp)
3457 A private implementation of the C<SvPV_nolen> macro for compilers which can't
3458 cope with complex macro expressions. Always use the macro instead.
3467 A private implementation of the C<SvPVbyte_nolen> macro for compilers
3468 which can't cope with complex macro expressions. Always use the macro
3471 char* sv_pvbyte(SV *sv)
3478 A private implementation of the C<SvPVbyte> macro for compilers
3479 which can't cope with complex macro expressions. Always use the macro
3482 char* sv_pvbyten(SV *sv, STRLEN *len)
3487 =item sv_pvbyten_force
3489 A private implementation of the C<SvPVbytex_force> macro for compilers
3490 which can't cope with complex macro expressions. Always use the macro
3493 char* sv_pvbyten_force(SV* sv, STRLEN* lp)
3500 A private implementation of the C<SvPV> macro for compilers which can't
3501 cope with complex macro expressions. Always use the macro instead.
3503 char* sv_pvn(SV *sv, STRLEN *len)
3510 Get a sensible string out of the SV somehow.
3511 A private implementation of the C<SvPV_force> macro for compilers which
3512 can't cope with complex macro expressions. Always use the macro instead.
3514 char* sv_pvn_force(SV* sv, STRLEN* lp)
3519 =item sv_pvn_force_flags
3521 Get a sensible string out of the SV somehow.
3522 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
3523 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
3524 implemented in terms of this function.
3525 You normally want to use the various wrapper macros instead: see
3526 C<SvPV_force> and C<SvPV_force_nomg>
3528 char* sv_pvn_force_flags(SV* sv, STRLEN* lp, I32 flags)
3535 A private implementation of the C<SvPVutf8_nolen> macro for compilers
3536 which can't cope with complex macro expressions. Always use the macro
3539 char* sv_pvutf8(SV *sv)
3546 A private implementation of the C<SvPVutf8> macro for compilers
3547 which can't cope with complex macro expressions. Always use the macro
3550 char* sv_pvutf8n(SV *sv, STRLEN *len)
3555 =item sv_pvutf8n_force
3557 A private implementation of the C<SvPVutf8_force> macro for compilers
3558 which can't cope with complex macro expressions. Always use the macro
3561 char* sv_pvutf8n_force(SV* sv, STRLEN* lp)
3568 Returns a string describing what the SV is a reference to.
3570 char* sv_reftype(SV* sv, int ob)
3577 Make the first argument a copy of the second, then delete the original.
3578 The target SV physically takes over ownership of the body of the source SV
3579 and inherits its flags; however, the target keeps any magic it owns,
3580 and any magic in the source is discarded.
3581 Note that this is a rather specialist SV copying operation; most of the
3582 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
3584 void sv_replace(SV* sv, SV* nsv)
3589 =item sv_report_used
3591 Dump the contents of all SVs not yet freed. (Debugging aid).
3593 void sv_report_used()
3600 Underlying implementation for the C<reset> Perl function.
3601 Note that the perl-level function is vaguely deprecated.
3603 void sv_reset(char* s, HV* stash)
3610 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
3611 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
3612 push a back-reference to this RV onto the array of backreferences
3613 associated with that magic.
3615 SV* sv_rvweaken(SV *sv)
3622 Copies an integer into the given SV, upgrading first if necessary.
3623 Does not handle 'set' magic. See also C<sv_setiv_mg>.
3625 void sv_setiv(SV* sv, IV num)
3632 Like C<sv_setiv>, but also handles 'set' magic.
3634 void sv_setiv_mg(SV *sv, IV i)
3641 Copies a double into the given SV, upgrading first if necessary.
3642 Does not handle 'set' magic. See also C<sv_setnv_mg>.
3644 void sv_setnv(SV* sv, NV num)
3651 Like C<sv_setnv>, but also handles 'set' magic.
3653 void sv_setnv_mg(SV *sv, NV num)
3660 Copies a string into an SV. The string must be null-terminated. Does not
3661 handle 'set' magic. See C<sv_setpv_mg>.
3663 void sv_setpv(SV* sv, const char* ptr)
3670 Processes its arguments like C<sprintf> and sets an SV to the formatted
3671 output. Does not handle 'set' magic. See C<sv_setpvf_mg>.
3673 void sv_setpvf(SV* sv, const char* pat, ...)
3680 Like C<sv_setpvf>, but also handles 'set' magic.
3682 void sv_setpvf_mg(SV *sv, const char* pat, ...)
3689 Copies an integer into the given SV, also updating its string value.
3690 Does not handle 'set' magic. See C<sv_setpviv_mg>.
3692 void sv_setpviv(SV* sv, IV num)
3699 Like C<sv_setpviv>, but also handles 'set' magic.
3701 void sv_setpviv_mg(SV *sv, IV iv)
3708 Copies a string into an SV. The C<len> parameter indicates the number of
3709 bytes to be copied. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3711 void sv_setpvn(SV* sv, const char* ptr, STRLEN len)
3718 Like C<sv_setpvn>, but also handles 'set' magic.
3720 void sv_setpvn_mg(SV *sv, const char *ptr, STRLEN len)
3727 Like C<sv_setpv>, but also handles 'set' magic.
3729 void sv_setpv_mg(SV *sv, const char *ptr)
3736 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
3737 argument will be upgraded to an RV. That RV will be modified to point to
3738 the new SV. The C<classname> argument indicates the package for the
3739 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
3740 will be returned and will have a reference count of 1.
3742 SV* sv_setref_iv(SV* rv, const char* classname, IV iv)
3749 Copies a double into a new SV, optionally blessing the SV. The C<rv>
3750 argument will be upgraded to an RV. That RV will be modified to point to
3751 the new SV. The C<classname> argument indicates the package for the
3752 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
3753 will be returned and will have a reference count of 1.
3755 SV* sv_setref_nv(SV* rv, const char* classname, NV nv)
3762 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
3763 argument will be upgraded to an RV. That RV will be modified to point to
3764 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
3765 into the SV. The C<classname> argument indicates the package for the
3766 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
3767 will be returned and will have a reference count of 1.
3769 Do not use with other Perl types such as HV, AV, SV, CV, because those
3770 objects will become corrupted by the pointer copy process.
3772 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
3774 SV* sv_setref_pv(SV* rv, const char* classname, void* pv)
3781 Copies a string into a new SV, optionally blessing the SV. The length of the
3782 string must be specified with C<n>. The C<rv> argument will be upgraded to
3783 an RV. That RV will be modified to point to the new SV. The C<classname>
3784 argument indicates the package for the blessing. Set C<classname> to
3785 C<Nullch> to avoid the blessing. The new SV will be returned and will have
3786 a reference count of 1.
3788 Note that C<sv_setref_pv> copies the pointer while this copies the string.
3790 SV* sv_setref_pvn(SV* rv, const char* classname, char* pv, STRLEN n)
3797 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
3798 argument will be upgraded to an RV. That RV will be modified to point to
3799 the new SV. The C<classname> argument indicates the package for the
3800 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
3801 will be returned and will have a reference count of 1.
3803 SV* sv_setref_uv(SV* rv, const char* classname, UV uv)
3810 Copies the contents of the source SV C<ssv> into the destination SV
3811 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3812 function if the source SV needs to be reused. Does not handle 'set' magic.
3813 Loosely speaking, it performs a copy-by-value, obliterating any previous
3814 content of the destination.
3816 You probably want to use one of the assortment of wrappers, such as
3817 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3818 C<SvSetMagicSV_nosteal>.
3821 void sv_setsv(SV* dsv, SV* ssv)
3826 =item sv_setsv_flags
3828 Copies the contents of the source SV C<ssv> into the destination SV
3829 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3830 function if the source SV needs to be reused. Does not handle 'set' magic.
3831 Loosely speaking, it performs a copy-by-value, obliterating any previous
3832 content of the destination.
3833 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3834 C<ssv> if appropriate, else not. C<sv_setsv> and C<sv_setsv_nomg> are
3835 implemented in terms of this function.
3837 You probably want to use one of the assortment of wrappers, such as
3838 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3839 C<SvSetMagicSV_nosteal>.
3841 This is the primary function for copying scalars, and most other
3842 copy-ish functions and macros use this underneath.
3844 void sv_setsv_flags(SV* dsv, SV* ssv, I32 flags)
3851 Like C<sv_setsv>, but also handles 'set' magic.
3853 void sv_setsv_mg(SV *dstr, SV *sstr)
3860 Copies an unsigned integer into the given SV, upgrading first if necessary.
3861 Does not handle 'set' magic. See also C<sv_setuv_mg>.
3863 void sv_setuv(SV* sv, UV num)
3870 Like C<sv_setuv>, but also handles 'set' magic.
3872 void sv_setuv_mg(SV *sv, UV u)
3879 Taint an SV. Use C<SvTAINTED_on> instead.
3880 void sv_taint(SV* sv)
3887 Test an SV for taintedness. Use C<SvTAINTED> instead.
3888 bool sv_tainted(SV* sv)
3895 Returns true if the SV has a true value by Perl's rules.
3896 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
3897 instead use an in-line version.
3906 Removes all magic of type C<type> from an SV.
3908 int sv_unmagic(SV* sv, int type)
3915 Unsets the RV status of the SV, and decrements the reference count of
3916 whatever was being referenced by the RV. This can almost be thought of
3917 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
3918 being zero. See C<SvROK_off>.
3920 void sv_unref(SV* sv)
3925 =item sv_unref_flags
3927 Unsets the RV status of the SV, and decrements the reference count of
3928 whatever was being referenced by the RV. This can almost be thought of
3929 as a reversal of C<newSVrv>. The C<cflags> argument can contain
3930 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
3931 (otherwise the decrementing is conditional on the reference count being
3932 different from one or the reference being a readonly SV).
3935 void sv_unref_flags(SV* sv, U32 flags)
3942 Untaint an SV. Use C<SvTAINTED_off> instead.
3943 void sv_untaint(SV* sv)
3950 Upgrade an SV to a more complex form. Generally adds a new body type to the
3951 SV, then copies across as much information as possible from the old body.
3952 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
3954 bool sv_upgrade(SV* sv, U32 mt)
3961 Tells an SV to use C<ptr> to find its string value. Normally the string is
3962 stored inside the SV but sv_usepvn allows the SV to use an outside string.
3963 The C<ptr> should point to memory that was allocated by C<malloc>. The
3964 string length, C<len>, must be supplied. This function will realloc the
3965 memory pointed to by C<ptr>, so that pointer should not be freed or used by
3966 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
3967 See C<sv_usepvn_mg>.
3969 void sv_usepvn(SV* sv, char* ptr, STRLEN len)
3976 Like C<sv_usepvn>, but also handles 'set' magic.
3978 void sv_usepvn_mg(SV *sv, char *ptr, STRLEN len)
3983 =item sv_utf8_decode
3985 Convert the octets in the PV from UTF-8 to chars. Scan for validity and then
3986 turn off SvUTF8 if needed so that we see characters. Used as a building block
3987 for decode_utf8 in Encode.xs
3989 NOTE: this function is experimental and may change or be
3990 removed without notice.
3992 bool sv_utf8_decode(SV *sv)
3997 =item sv_utf8_downgrade
3999 Attempt to convert the PV of an SV from UTF8-encoded to byte encoding.
4000 This may not be possible if the PV contains non-byte encoding characters;
4001 if this is the case, either returns false or, if C<fail_ok> is not
4004 NOTE: this function is experimental and may change or be
4005 removed without notice.
4007 bool sv_utf8_downgrade(SV *sv, bool fail_ok)
4012 =item sv_utf8_encode
4014 Convert the PV of an SV to UTF8-encoded, but then turn off the C<SvUTF8>
4015 flag so that it looks like octets again. Used as a building block
4016 for encode_utf8 in Encode.xs
4018 void sv_utf8_encode(SV *sv)
4023 =item sv_utf8_upgrade
4025 Convert the PV of an SV to its UTF8-encoded form.
4026 Forces the SV to string form if it is not already.
4027 Always sets the SvUTF8 flag to avoid future validity checks even
4028 if all the bytes have hibit clear.
4030 STRLEN sv_utf8_upgrade(SV *sv)
4035 =item sv_utf8_upgrade_flags
4037 Convert the PV of an SV to its UTF8-encoded form.
4038 Forces the SV to string form if it is not already.
4039 Always sets the SvUTF8 flag to avoid future validity checks even
4040 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
4041 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
4042 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
4044 STRLEN sv_utf8_upgrade_flags(SV *sv, I32 flags)
4051 A private implementation of the C<SvUVx> macro for compilers which can't
4052 cope with complex macro expressions. Always use the macro instead.
4061 Processes its arguments like C<vsprintf> and appends the formatted output
4062 to an SV. Uses an array of SVs if the C style variable argument list is
4063 missing (NULL). When running with taint checks enabled, indicates via
4064 C<maybe_tainted> if results are untrustworthy (often due to the use of
4067 Usually used via one of its frontends C<sv_catpvf> and C<sv_catpvf_mg>.
4069 void sv_vcatpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
4076 Works like C<vcatpvfn> but copies the text into the SV instead of
4079 Usually used via one of its frontends C<sv_setpvf> and C<sv_setpvf_mg>.
4081 void sv_vsetpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
4088 Variable which is setup by C<xsubpp> to designate the object in a C++
4089 XSUB. This is always the proper type for the C++ object. See C<CLASS> and
4090 L<perlxs/"Using XS With C++">.
4095 Found in file XSUB.h
4099 Converts the specified character to lowercase.
4101 char toLOWER(char ch)
4104 Found in file handy.h
4108 Converts the specified character to uppercase.
4110 char toUPPER(char ch)
4113 Found in file handy.h
4115 =item utf8n_to_uvchr
4117 Returns the native character value of the first character in the string C<s>
4118 which is assumed to be in UTF8 encoding; C<retlen> will be set to the
4119 length, in bytes, of that character.
4121 Allows length and flags to be passed to low level routine.
4123 UV utf8n_to_uvchr(U8 *s, STRLEN curlen, STRLEN* retlen, U32 flags)
4126 Found in file utf8.c
4128 =item utf8n_to_uvuni
4130 Bottom level UTF-8 decode routine.
4131 Returns the unicode code point value of the first character in the string C<s>
4132 which is assumed to be in UTF8 encoding and no longer than C<curlen>;
4133 C<retlen> will be set to the length, in bytes, of that character.
4135 If C<s> does not point to a well-formed UTF8 character, the behaviour
4136 is dependent on the value of C<flags>: if it contains UTF8_CHECK_ONLY,
4137 it is assumed that the caller will raise a warning, and this function
4138 will silently just set C<retlen> to C<-1> and return zero. If the
4139 C<flags> does not contain UTF8_CHECK_ONLY, warnings about
4140 malformations will be given, C<retlen> will be set to the expected
4141 length of the UTF-8 character in bytes, and zero will be returned.
4143 The C<flags> can also contain various flags to allow deviations from
4144 the strict UTF-8 encoding (see F<utf8.h>).
4146 Most code should use utf8_to_uvchr() rather than call this directly.
4148 UV utf8n_to_uvuni(U8 *s, STRLEN curlen, STRLEN* retlen, U32 flags)
4151 Found in file utf8.c
4155 Returns the number of UTF8 characters between the UTF-8 pointers C<a>
4158 WARNING: use only if you *know* that the pointers point inside the
4161 IV utf8_distance(U8 *a, U8 *b)
4164 Found in file utf8.c
4168 Return the UTF-8 pointer C<s> displaced by C<off> characters, either
4169 forward or backward.
4171 WARNING: do not use the following unless you *know* C<off> is within
4172 the UTF-8 data pointed to by C<s> *and* that on entry C<s> is aligned
4173 on the first byte of character or just after the last byte of a character.
4175 U8* utf8_hop(U8 *s, I32 off)
4178 Found in file utf8.c
4182 Return the length of the UTF-8 char encoded string C<s> in characters.
4183 Stops at C<e> (inclusive). If C<e E<lt> s> or if the scan would end
4184 up past C<e>, croaks.
4186 STRLEN utf8_length(U8* s, U8 *e)
4189 Found in file utf8.c
4193 Converts a string C<s> of length C<len> from UTF8 into byte encoding.
4194 Unlike C<bytes_to_utf8>, this over-writes the original string, and
4195 updates len to contain the new length.
4196 Returns zero on failure, setting C<len> to -1.
4198 NOTE: this function is experimental and may change or be
4199 removed without notice.
4201 U8* utf8_to_bytes(U8 *s, STRLEN *len)
4204 Found in file utf8.c
4208 Returns the native character value of the first character in the string C<s>
4209 which is assumed to be in UTF8 encoding; C<retlen> will be set to the
4210 length, in bytes, of that character.
4212 If C<s> does not point to a well-formed UTF8 character, zero is
4213 returned and retlen is set, if possible, to -1.
4215 UV utf8_to_uvchr(U8 *s, STRLEN* retlen)
4218 Found in file utf8.c
4222 Returns the Unicode code point of the first character in the string C<s>
4223 which is assumed to be in UTF8 encoding; C<retlen> will be set to the
4224 length, in bytes, of that character.
4226 This function should only be used when returned UV is considered
4227 an index into the Unicode semantic tables (e.g. swashes).
4229 If C<s> does not point to a well-formed UTF8 character, zero is
4230 returned and retlen is set, if possible, to -1.
4232 UV utf8_to_uvuni(U8 *s, STRLEN* retlen)
4235 Found in file utf8.c
4239 Adds the UTF8 representation of the Native codepoint C<uv> to the end
4240 of the string C<d>; C<d> should be have at least C<UTF8_MAXLEN+1> free
4241 bytes available. The return value is the pointer to the byte after the
4242 end of the new character. In other words,
4244 d = uvchr_to_utf8(d, uv);
4246 is the recommended wide native character-aware way of saying
4250 U8* uvchr_to_utf8(U8 *d, UV uv)
4253 Found in file utf8.c
4257 Adds the UTF8 representation of the Unicode codepoint C<uv> to the end
4258 of the string C<d>; C<d> should be have at least C<UTF8_MAXLEN+1> free
4259 bytes available. The return value is the pointer to the byte after the
4260 end of the new character. In other words,
4262 d = uvuni_to_utf8(d, uv);
4264 is the recommended Unicode-aware way of saying
4268 U8* uvuni_to_utf8(U8 *d, UV uv)
4271 Found in file utf8.c
4275 This is the XSUB-writer's interface to Perl's C<warn> function. Use this
4276 function the same way you use the C C<printf> function. See
4279 void warn(const char* pat, ...)
4282 Found in file util.c
4286 Push an integer onto the stack, extending the stack if necessary. Handles
4287 'set' magic. See C<PUSHi>.
4296 Push a double onto the stack, extending the stack if necessary. Handles
4297 'set' magic. See C<PUSHn>.
4306 Push a string onto the stack, extending the stack if necessary. The C<len>
4307 indicates the length of the string. Handles 'set' magic. See
4310 void XPUSHp(char* str, STRLEN len)
4317 Push an SV onto the stack, extending the stack if necessary. Does not
4318 handle 'set' magic. See C<PUSHs>.
4327 Push an unsigned integer onto the stack, extending the stack if necessary.
4337 Macro to declare an XSUB and its C parameter list. This is handled by
4341 Found in file XSUB.h
4345 Return from XSUB, indicating number of items on the stack. This is usually
4346 handled by C<xsubpp>.
4348 void XSRETURN(int nitems)
4351 Found in file XSUB.h
4353 =item XSRETURN_EMPTY
4355 Return an empty list from an XSUB immediately.
4360 Found in file XSUB.h
4364 Return an integer from an XSUB immediately. Uses C<XST_mIV>.
4366 void XSRETURN_IV(IV iv)
4369 Found in file XSUB.h
4373 Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
4378 Found in file XSUB.h
4382 Return an double from an XSUB immediately. Uses C<XST_mNV>.
4384 void XSRETURN_NV(NV nv)
4387 Found in file XSUB.h
4391 Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
4393 void XSRETURN_PV(char* str)
4396 Found in file XSUB.h
4398 =item XSRETURN_UNDEF
4400 Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
4405 Found in file XSUB.h
4409 Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
4414 Found in file XSUB.h
4418 Place an integer into the specified position C<pos> on the stack. The
4419 value is stored in a new mortal SV.
4421 void XST_mIV(int pos, IV iv)
4424 Found in file XSUB.h
4428 Place C<&PL_sv_no> into the specified position C<pos> on the
4431 void XST_mNO(int pos)
4434 Found in file XSUB.h
4438 Place a double into the specified position C<pos> on the stack. The value
4439 is stored in a new mortal SV.
4441 void XST_mNV(int pos, NV nv)
4444 Found in file XSUB.h
4448 Place a copy of a string into the specified position C<pos> on the stack.
4449 The value is stored in a new mortal SV.
4451 void XST_mPV(int pos, char* str)
4454 Found in file XSUB.h
4458 Place C<&PL_sv_undef> into the specified position C<pos> on the
4461 void XST_mUNDEF(int pos)
4464 Found in file XSUB.h
4468 Place C<&PL_sv_yes> into the specified position C<pos> on the
4471 void XST_mYES(int pos)
4474 Found in file XSUB.h
4478 The version identifier for an XS module. This is usually
4479 handled automatically by C<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>.
4482 Found in file XSUB.h
4484 =item XS_VERSION_BOOTCHECK
4486 Macro to verify that a PM module's $VERSION variable matches the XS
4487 module's C<XS_VERSION> variable. This is usually handled automatically by
4488 C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">.
4490 XS_VERSION_BOOTCHECK;
4493 Found in file XSUB.h
4497 The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the
4498 destination, C<nitems> is the number of items, and C<type> is the type.
4500 void Zero(void* dest, int nitems, type)
4503 Found in file handy.h
4509 Until May 1997, this document was maintained by Jeff Okamoto
4510 <okamoto@corp.hp.com>. It is now maintained as part of Perl itself.
4512 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
4513 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
4514 Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
4515 Stephen McCamant, and Gurusamy Sarathy.
4517 API Listing originally by Dean Roehrich <roehrich@cray.com>.
4519 Updated to be autogenerated from comments in the source by Benjamin Stuhl.
4523 perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
https://perl5.git.perl.org / perl5.git / blob