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 Takes a sprintf-style format pattern and conventional
471 (non-SV) arguments and returns the formatted string.
473 (char *) Perl_form(pTHX_ const char* pat, ...)
475 can be used any place a string (char *) is required:
477 char * s = Perl_form("%d.%d",major,minor);
479 Uses a single private buffer so if you want to format several strings you
480 must explicitly copy the earlier strings away (and free the copies when you
483 char* form(const char* pat, ...)
490 Closing bracket for temporaries on a callback. See C<SAVETMPS> and
496 Found in file scope.h
500 Fill the sv with current working directory
502 int getcwd_sv(SV* sv)
509 Returns the AV of the specified Perl array. If C<create> is set and the
510 Perl variable does not exist then it will be created. If C<create> is not
511 set and the variable does not exist then NULL is returned.
513 NOTE: the perl_ form of this function is deprecated.
515 AV* get_av(const char* name, I32 create)
522 Returns the CV of the specified Perl subroutine. If C<create> is set and
523 the Perl subroutine does not exist then it will be declared (which has the
524 same effect as saying C<sub name;>). If C<create> is not set and the
525 subroutine does not exist then NULL is returned.
527 NOTE: the perl_ form of this function is deprecated.
529 CV* get_cv(const char* name, I32 create)
536 Returns the HV of the specified Perl hash. If C<create> is set and the
537 Perl variable does not exist then it will be created. If C<create> is not
538 set and the variable does not exist then NULL is returned.
540 NOTE: the perl_ form of this function is deprecated.
542 HV* get_hv(const char* name, I32 create)
549 Returns the SV of the specified Perl scalar. If C<create> is set and the
550 Perl variable does not exist then it will be created. If C<create> is not
551 set and the variable does not exist then NULL is returned.
553 NOTE: the perl_ form of this function is deprecated.
555 SV* get_sv(const char* name, I32 create)
562 A backward-compatible version of C<GIMME_V> which can only return
563 C<G_SCALAR> or C<G_ARRAY>; in a void context, it returns C<G_SCALAR>.
564 Deprecated. Use C<GIMME_V> instead.
573 The XSUB-writer's equivalent to Perl's C<wantarray>. Returns C<G_VOID>,
574 C<G_SCALAR> or C<G_ARRAY> for void, scalar or list context,
584 converts a string representing a binary number to numeric form.
586 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
587 conversion flags, and I<result> should be NULL or a pointer to an NV.
588 The scan stops at the end of the string, or the first invalid character.
589 On return I<*len> is set to the length scanned string, and I<*flags> gives
592 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
593 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_bin>
594 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
595 and writes the value to I<*result> (or the value is discarded if I<result>
598 The hex number may optionally be prefixed with "0b" or "b" unless
599 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
600 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the binary
601 number may use '_' characters to separate digits.
603 UV grok_bin(char* start, STRLEN* len, I32* flags, NV *result)
606 Found in file numeric.c
610 converts a string representing a hex number to numeric form.
612 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
613 conversion flags, and I<result> should be NULL or a pointer to an NV.
614 The scan stops at the end of the string, or the first non-hex-digit character.
615 On return I<*len> is set to the length scanned string, and I<*flags> gives
618 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
619 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_hex>
620 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
621 and writes the value to I<*result> (or the value is discarded if I<result>
624 The hex number may optionally be prefixed with "0x" or "x" unless
625 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
626 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the hex
627 number may use '_' characters to separate digits.
629 UV grok_hex(char* start, STRLEN* len, I32* flags, NV *result)
632 Found in file numeric.c
636 Recognise (or not) a number. The type of the number is returned
637 (0 if unrecognised), otherwise it is a bit-ORed combination of
638 IS_NUMBER_IN_UV, IS_NUMBER_GREATER_THAN_UV_MAX, IS_NUMBER_NOT_INT,
639 IS_NUMBER_NEG, IS_NUMBER_INFINITY, IS_NUMBER_NAN (defined in perl.h).
641 If the value of the number can fit an in UV, it is returned in the *valuep
642 IS_NUMBER_IN_UV will be set to indicate that *valuep is valid, IS_NUMBER_IN_UV
643 will never be set unless *valuep is valid, but *valuep may have been assigned
644 to during processing even though IS_NUMBER_IN_UV is not set on return.
645 If valuep is NULL, IS_NUMBER_IN_UV will be set for the same cases as when
646 valuep is non-NULL, but no actual assignment (or SEGV) will occur.
648 IS_NUMBER_NOT_INT will be set with IS_NUMBER_IN_UV if trailing decimals were
649 seen (in which case *valuep gives the true value truncated to an integer), and
650 IS_NUMBER_NEG if the number is negative (in which case *valuep holds the
651 absolute value). IS_NUMBER_IN_UV is not set if e notation was used or the
652 number is larger than a UV.
654 int grok_number(const char *pv, STRLEN len, UV *valuep)
657 Found in file numeric.c
659 =item grok_numeric_radix
661 Scan and skip for a numeric decimal separator (radix).
663 bool grok_numeric_radix(const char **sp, const char *send)
666 Found in file numeric.c
671 UV grok_oct(char* start, STRLEN* len, I32* flags, NV *result)
674 Found in file numeric.c
678 Return the SV from the GV.
687 Returns the glob with the given C<name> and a defined subroutine or
688 C<NULL>. The glob lives in the given C<stash>, or in the stashes
689 accessible via @ISA and UNIVERSAL::.
691 The argument C<level> should be either 0 or -1. If C<level==0>, as a
692 side-effect creates a glob with the given C<name> in the given C<stash>
693 which in the case of success contains an alias for the subroutine, and sets
694 up caching info for this glob. Similarly for all the searched stashes.
696 This function grants C<"SUPER"> token as a postfix of the stash name. The
697 GV returned from C<gv_fetchmeth> may be a method cache entry, which is not
698 visible to Perl code. So when calling C<call_sv>, you should not use
699 the GV directly; instead, you should use the method's CV, which can be
700 obtained from the GV with the C<GvCV> macro.
702 GV* gv_fetchmeth(HV* stash, const char* name, STRLEN len, I32 level)
709 See L<gv_fetchmethod_autoload>.
711 GV* gv_fetchmethod(HV* stash, const char* name)
716 =item gv_fetchmethod_autoload
718 Returns the glob which contains the subroutine to call to invoke the method
719 on the C<stash>. In fact in the presence of autoloading this may be the
720 glob for "AUTOLOAD". In this case the corresponding variable $AUTOLOAD is
723 The third parameter of C<gv_fetchmethod_autoload> determines whether
724 AUTOLOAD lookup is performed if the given method is not present: non-zero
725 means yes, look for AUTOLOAD; zero means no, don't look for AUTOLOAD.
726 Calling C<gv_fetchmethod> is equivalent to calling C<gv_fetchmethod_autoload>
727 with a non-zero C<autoload> parameter.
729 These functions grant C<"SUPER"> token as a prefix of the method name. Note
730 that if you want to keep the returned glob for a long time, you need to
731 check for it being "AUTOLOAD", since at the later time the call may load a
732 different subroutine due to $AUTOLOAD changing its value. Use the glob
733 created via a side effect to do this.
735 These functions have the same side-effects and as C<gv_fetchmeth> with
736 C<level==0>. C<name> should be writable if contains C<':'> or C<'
737 ''>. The warning against passing the GV returned by C<gv_fetchmeth> to
738 C<call_sv> apply equally to these functions.
740 GV* gv_fetchmethod_autoload(HV* stash, const char* name, I32 autoload)
747 Returns a pointer to the stash for a specified package. C<name> should
748 be a valid UTF-8 string. If C<create> is set then the package will be
749 created if it does not already exist. If C<create> is not set and the
750 package does not exist then NULL is returned.
752 HV* gv_stashpv(const char* name, I32 create)
759 Returns a pointer to the stash for a specified package, which must be a
760 valid UTF-8 string. See C<gv_stashpv>.
762 HV* gv_stashsv(SV* sv, I32 create)
769 Used to indicate list context. See C<GIMME_V>, C<GIMME> and
777 Indicates that arguments returned from a callback should be discarded. See
785 Used to force a Perl C<eval> wrapper around a callback. See
793 Indicates that no arguments are being sent to a callback. See
801 Used to indicate scalar context. See C<GIMME_V>, C<GIMME>, and
809 Used to indicate void context. See C<GIMME_V> and L<perlcall>.
816 This flag, used in the length slot of hash entries and magic structures,
817 specifies the structure contains an C<SV*> pointer where a C<char*> pointer
818 is to be expected. (For information only--not to be used).
825 Returns the computed hash stored in the hash entry.
834 Returns the actual pointer stored in the key slot of the hash entry. The
835 pointer may be either C<char*> or C<SV*>, depending on the value of
836 C<HeKLEN()>. Can be assigned to. The C<HePV()> or C<HeSVKEY()> macros are
837 usually preferable for finding the value of a key.
846 If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry
847 holds an C<SV*> key. Otherwise, holds the actual length of the key. Can
848 be assigned to. The C<HePV()> macro is usually preferable for finding key
851 STRLEN HeKLEN(HE* he)
858 Returns the key slot of the hash entry as a C<char*> value, doing any
859 necessary dereferencing of possibly C<SV*> keys. The length of the string
860 is placed in C<len> (this is a macro, so do I<not> use C<&len>). If you do
861 not care about what the length of the key is, you may use the global
862 variable C<PL_na>, though this is rather less efficient than using a local
863 variable. Remember though, that hash keys in perl are free to contain
864 embedded nulls, so using C<strlen()> or similar is not a good way to find
865 the length of hash keys. This is very similar to the C<SvPV()> macro
866 described elsewhere in this document.
868 char* HePV(HE* he, STRLEN len)
875 Returns the key as an C<SV*>, or C<Nullsv> if the hash entry does not
876 contain an C<SV*> key.
885 Returns the key as an C<SV*>. Will create and return a temporary mortal
886 C<SV*> if the hash entry contains only a C<char*> key.
888 SV* HeSVKEY_force(HE* he)
895 Sets the key to a given C<SV*>, taking care to set the appropriate flags to
896 indicate the presence of an C<SV*> key, and returns the same
899 SV* HeSVKEY_set(HE* he, SV* sv)
906 Returns the value slot (type C<SV*>) stored in the hash entry.
915 Returns the package name of a stash. See C<SvSTASH>, C<CvSTASH>.
917 char* HvNAME(HV* stash)
924 Clears a hash, making it empty.
926 void hv_clear(HV* tb)
933 Deletes a key/value pair in the hash. The value SV is removed from the
934 hash and returned to the caller. The C<klen> is the length of the key.
935 The C<flags> value will normally be zero; if set to G_DISCARD then NULL
938 SV* hv_delete(HV* tb, const char* key, I32 klen, I32 flags)
945 Deletes a key/value pair in the hash. The value SV is removed from the
946 hash and returned to the caller. The C<flags> value will normally be zero;
947 if set to G_DISCARD then NULL will be returned. C<hash> can be a valid
948 precomputed hash value, or 0 to ask for it to be computed.
950 SV* hv_delete_ent(HV* tb, SV* key, I32 flags, U32 hash)
957 Returns a boolean indicating whether the specified hash key exists. The
958 C<klen> is the length of the key.
960 bool hv_exists(HV* tb, const char* key, I32 klen)
967 Returns a boolean indicating whether the specified hash key exists. C<hash>
968 can be a valid precomputed hash value, or 0 to ask for it to be
971 bool hv_exists_ent(HV* tb, SV* key, U32 hash)
978 Returns the SV which corresponds to the specified key in the hash. The
979 C<klen> is the length of the key. If C<lval> is set then the fetch will be
980 part of a store. Check that the return value is non-null before
981 dereferencing it to an C<SV*>.
983 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
984 information on how to use this function on tied hashes.
986 SV** hv_fetch(HV* tb, const char* key, I32 klen, I32 lval)
993 Returns the hash entry which corresponds to the specified key in the hash.
994 C<hash> must be a valid precomputed hash number for the given C<key>, or 0
995 if you want the function to compute it. IF C<lval> is set then the fetch
996 will be part of a store. Make sure the return value is non-null before
997 accessing it. The return value when C<tb> is a tied hash is a pointer to a
998 static location, so be sure to make a copy of the structure if you need to
1001 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1002 information on how to use this function on tied hashes.
1004 HE* hv_fetch_ent(HV* tb, SV* key, I32 lval, U32 hash)
1011 Prepares a starting point to traverse a hash table. Returns the number of
1012 keys in the hash (i.e. the same as C<HvKEYS(tb)>). The return value is
1013 currently only meaningful for hashes without tie magic.
1015 NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
1016 hash buckets that happen to be in use. If you still need that esoteric
1017 value, you can get it through the macro C<HvFILL(tb)>.
1019 I32 hv_iterinit(HV* tb)
1026 Returns the key from the current position of the hash iterator. See
1029 char* hv_iterkey(HE* entry, I32* retlen)
1036 Returns the key as an C<SV*> from the current position of the hash
1037 iterator. The return value will always be a mortal copy of the key. Also
1040 SV* hv_iterkeysv(HE* entry)
1047 Returns entries from a hash iterator. See C<hv_iterinit>.
1049 HE* hv_iternext(HV* tb)
1056 Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
1059 SV* hv_iternextsv(HV* hv, char** key, I32* retlen)
1066 Returns the value from the current position of the hash iterator. See
1069 SV* hv_iterval(HV* tb, HE* entry)
1076 Adds magic to a hash. See C<sv_magic>.
1078 void hv_magic(HV* hv, GV* gv, int how)
1085 Stores an SV in a hash. The hash key is specified as C<key> and C<klen> is
1086 the length of the key. The C<hash> parameter is the precomputed hash
1087 value; if it is zero then Perl will compute it. The return value will be
1088 NULL if the operation failed or if the value did not need to be actually
1089 stored within the hash (as in the case of tied hashes). Otherwise it can
1090 be dereferenced to get the original C<SV*>. Note that the caller is
1091 responsible for suitably incrementing the reference count of C<val> before
1092 the call, and 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 SV** hv_store(HV* tb, const char* key, I32 klen, SV* val, U32 hash)
1104 Stores C<val> in a hash. The hash key is specified as C<key>. The C<hash>
1105 parameter is the precomputed hash value; if it is zero then Perl will
1106 compute it. The return value is the new hash entry so created. It will be
1107 NULL if the operation failed or if the value did not need to be actually
1108 stored within the hash (as in the case of tied hashes). Otherwise the
1109 contents of the return value can be accessed using the C<He?> macros
1110 described here. Note that the caller is responsible for suitably
1111 incrementing the reference count of C<val> before the call, and
1112 decrementing it if the function returned NULL.
1114 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1115 information on how to use this function on tied hashes.
1117 HE* hv_store_ent(HV* tb, SV* key, SV* val, U32 hash)
1126 void hv_undef(HV* tb)
1133 Return true if the strings s1 and s2 differ case-insensitively, false
1134 if not (if they are equal case-insensitively). If u1 is true, the
1135 string s1 is assumed to be in UTF-8-encoded Unicode. If u2 is true,
1136 the string s2 is assumed to be in UTF-8-encoded Unicode. If u1 or u2
1137 are false, the respective string is assumed to be in native 8-bit
1140 If the pe1 and pe2 are non-NULL, the scanning pointers will be copied
1141 in there (they will point at the beginning of the I<next> character).
1142 If the pointers behind pe1 or pe2 are non-NULL, they are the end
1143 pointers beyond which scanning will not continue under any
1144 circustances. If the byte lengths l1 and l2 are non-zero, s1+l1 and
1145 s2+l2 will be used as goal end pointers that will also stop the scan,
1146 and which qualify towards defining a successful match: all the scans
1147 that define an explicit length must reach their goal pointers for
1148 a match to succeed).
1150 For case-insensitiveness, the "casefolding" of Unicode is used
1151 instead of upper/lowercasing both the characters, see
1152 http://www.unicode.org/unicode/reports/tr21/ (Case Mappings).
1154 I32 ibcmp_utf8(const char* a, char **pe1, UV l1, bool u1, const char* b, char **pe2, UV l2, bool u2)
1157 Found in file utf8.c
1161 Returns a boolean indicating whether the C C<char> is an ASCII alphanumeric
1162 character (including underscore) or digit.
1164 bool isALNUM(char ch)
1167 Found in file handy.h
1171 Returns a boolean indicating whether the C C<char> is an ASCII alphabetic
1174 bool isALPHA(char ch)
1177 Found in file handy.h
1181 Returns a boolean indicating whether the C C<char> is an ASCII
1184 bool isDIGIT(char ch)
1187 Found in file handy.h
1191 Returns a boolean indicating whether the C C<char> is a lowercase
1194 bool isLOWER(char ch)
1197 Found in file handy.h
1201 Returns a boolean indicating whether the C C<char> is whitespace.
1203 bool isSPACE(char ch)
1206 Found in file handy.h
1210 Returns a boolean indicating whether the C C<char> is an uppercase
1213 bool isUPPER(char ch)
1216 Found in file handy.h
1220 Tests if some arbitrary number of bytes begins in a valid UTF-8
1221 character. Note that an INVARIANT (i.e. ASCII) character is a valid UTF-8 character.
1222 The actual number of bytes in the UTF-8 character will be returned if
1223 it is valid, otherwise 0.
1225 STRLEN is_utf8_char(U8 *p)
1228 Found in file utf8.c
1230 =item is_utf8_string
1232 Returns true if first C<len> bytes of the given string form a valid UTF8
1233 string, false otherwise. Note that 'a valid UTF8 string' does not mean
1234 'a string that contains UTF8' because a valid ASCII string is a valid
1237 bool is_utf8_string(U8 *s, STRLEN len)
1240 Found in file utf8.c
1244 Variable which is setup by C<xsubpp> to indicate the number of
1245 items on the stack. See L<perlxs/"Variable-length Parameter Lists">.
1250 Found in file XSUB.h
1254 Variable which is setup by C<xsubpp> to indicate which of an
1255 XSUB's aliases was used to invoke it. See L<perlxs/"The ALIAS: Keyword">.
1260 Found in file XSUB.h
1264 Closing bracket on a callback. See C<ENTER> and L<perlcall>.
1269 Found in file scope.h
1273 Loads the module whose name is pointed to by the string part of name.
1274 Note that the actual module name, not its filename, should be given.
1275 Eg, "Foo::Bar" instead of "Foo/Bar.pm". flags can be any of
1276 PERL_LOADMOD_DENY, PERL_LOADMOD_NOIMPORT, or PERL_LOADMOD_IMPORT_OPS
1277 (or 0 for no flags). ver, if specified, provides version semantics
1278 similar to C<use Foo::Bar VERSION>. The optional trailing SV*
1279 arguments can be used to specify arguments to the module's import()
1280 method, similar to C<use Foo::Bar VERSION LIST>.
1282 void load_module(U32 flags, SV* name, SV* ver, ...)
1287 =item looks_like_number
1289 Test if the content of an SV looks like a number (or is a number).
1290 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1291 non-numeric warning), even if your atof() doesn't grok them.
1293 I32 looks_like_number(SV* sv)
1300 Stack marker variable for the XSUB. See C<dMARK>.
1307 Clear something magical that the SV represents. See C<sv_magic>.
1309 int mg_clear(SV* sv)
1316 Copies the magic from one SV to another. See C<sv_magic>.
1318 int mg_copy(SV* sv, SV* nsv, const char* key, I32 klen)
1325 Finds the magic pointer for type matching the SV. See C<sv_magic>.
1327 MAGIC* mg_find(SV* sv, int type)
1334 Free any magic storage used by the SV. See C<sv_magic>.
1343 Do magic after a value is retrieved from the SV. See C<sv_magic>.
1352 Report on the SV's length. See C<sv_magic>.
1354 U32 mg_length(SV* sv)
1361 Turns on the magical status of an SV. See C<sv_magic>.
1363 void mg_magical(SV* sv)
1370 Do magic after a value is assigned to the SV. See C<sv_magic>.
1379 The XSUB-writer's interface to the C C<memmove> function. The C<src> is the
1380 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1381 the type. Can do overlapping moves. See also C<Copy>.
1383 void Move(void* src, void* dest, int nitems, type)
1386 Found in file handy.h
1390 The XSUB-writer's interface to the C C<malloc> function.
1392 void New(int id, void* ptr, int nitems, type)
1395 Found in file handy.h
1399 Creates a new AV. The reference count is set to 1.
1408 The XSUB-writer's interface to the C C<malloc> function, with
1411 void Newc(int id, void* ptr, int nitems, type, cast)
1414 Found in file handy.h
1418 Creates a constant sub equivalent to Perl C<sub FOO () { 123 }> which is
1419 eligible for inlining at compile-time.
1421 CV* newCONSTSUB(HV* stash, char* name, SV* sv)
1428 Creates a new HV. The reference count is set to 1.
1437 Creates an RV wrapper for an SV. The reference count for the original SV is
1440 SV* newRV_inc(SV* sv)
1447 Creates an RV wrapper for an SV. The reference count for the original
1448 SV is B<not> incremented.
1450 SV* newRV_noinc(SV *sv)
1457 Creates a new SV. A non-zero C<len> parameter indicates the number of
1458 bytes of preallocated string space the SV should have. An extra byte for a
1459 tailing NUL is also reserved. (SvPOK is not set for the SV even if string
1460 space is allocated.) The reference count for the new SV is set to 1.
1461 C<id> is an integer id between 0 and 1299 (used to identify leaks).
1463 SV* NEWSV(int id, STRLEN len)
1466 Found in file handy.h
1470 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
1471 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
1474 SV* newSV(STRLEN len)
1481 Creates a new SV and copies an integer into it. The reference count for the
1491 Creates a new SV and copies a floating point value into it.
1492 The reference count for the SV is set to 1.
1501 Creates a new SV and copies a string into it. The reference count for the
1502 SV is set to 1. If C<len> is zero, Perl will compute the length using
1503 strlen(). For efficiency, consider using C<newSVpvn> instead.
1505 SV* newSVpv(const char* s, STRLEN len)
1512 Creates a new SV and initializes it with the string formatted like
1515 SV* newSVpvf(const char* pat, ...)
1522 Creates a new SV and copies a string into it. The reference count for the
1523 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
1524 string. You are responsible for ensuring that the source string is at least
1527 SV* newSVpvn(const char* s, STRLEN len)
1532 =item newSVpvn_share
1534 Creates a new SV with its SvPVX pointing to a shared string in the string
1535 table. If the string does not already exist in the table, it is created
1536 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
1537 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
1538 otherwise the hash is computed. The idea here is that as the string table
1539 is used for shared hash keys these strings will have SvPVX == HeKEY and
1540 hash lookup will avoid string compare.
1542 SV* newSVpvn_share(const char* s, I32 len, U32 hash)
1549 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
1550 it will be upgraded to one. If C<classname> is non-null then the new SV will
1551 be blessed in the specified package. The new SV is returned and its
1552 reference count is 1.
1554 SV* newSVrv(SV* rv, const char* classname)
1561 Creates a new SV which is an exact duplicate of the original SV.
1564 SV* newSVsv(SV* old)
1571 Creates a new SV and copies an unsigned integer into it.
1572 The reference count for the SV is set to 1.
1581 Used by C<xsubpp> to hook up XSUBs as Perl subs.
1588 Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
1592 Found in file XSUB.h
1596 The XSUB-writer's interface to the C C<malloc> function. The allocated
1597 memory is zeroed with C<memzero>.
1599 void Newz(int id, void* ptr, int nitems, type)
1602 Found in file handy.h
1606 Returns a pointer to the next character after the parsed
1607 vstring, as well as updating the passed in sv.
1609 Function must be called like
1612 s = new_vstring(s,sv);
1614 The sv must already be large enough to store the vstring
1617 char* new_vstring(char *vstr, SV *sv)
1620 Found in file util.c
1631 Null character pointer.
1634 Found in file handy.h
1655 Found in file handy.h
1659 The original stack mark for the XSUB. See C<dORIGMARK>.
1666 Allocates a new Perl interpreter. See L<perlembed>.
1668 PerlInterpreter* perl_alloc()
1671 Found in file perl.c
1675 Create and return a new interpreter by cloning the current one.
1677 PerlInterpreter* perl_clone(PerlInterpreter* interp, UV flags)
1682 =item perl_construct
1684 Initializes a new Perl interpreter. See L<perlembed>.
1686 void perl_construct(PerlInterpreter* interp)
1689 Found in file perl.c
1693 Shuts down a Perl interpreter. See L<perlembed>.
1695 int perl_destruct(PerlInterpreter* interp)
1698 Found in file perl.c
1702 Releases a Perl interpreter. See L<perlembed>.
1704 void perl_free(PerlInterpreter* interp)
1707 Found in file perl.c
1711 Tells a Perl interpreter to parse a Perl script. See L<perlembed>.
1713 int perl_parse(PerlInterpreter* interp, XSINIT_t xsinit, int argc, char** argv, char** env)
1716 Found in file perl.c
1720 Tells a Perl interpreter to run. See L<perlembed>.
1722 int perl_run(PerlInterpreter* interp)
1725 Found in file perl.c
1729 C<PL_modglobal> is a general purpose, interpreter global HV for use by
1730 extensions that need to keep information on a per-interpreter basis.
1731 In a pinch, it can also be used as a symbol table for extensions
1732 to share data among each other. It is a good idea to use keys
1733 prefixed by the package name of the extension that owns the data.
1738 Found in file intrpvar.h
1742 A convenience variable which is typically used with C<SvPV> when one
1743 doesn't care about the length of the string. It is usually more efficient
1744 to either declare a local variable and use that instead or to use the
1745 C<SvPV_nolen> macro.
1750 Found in file thrdvar.h
1754 This is the C<false> SV. See C<PL_sv_yes>. Always refer to this as
1760 Found in file intrpvar.h
1764 This is the C<undef> SV. Always refer to this as C<&PL_sv_undef>.
1769 Found in file intrpvar.h
1773 This is the C<true> SV. See C<PL_sv_no>. Always refer to this as
1779 Found in file intrpvar.h
1783 Pops an integer off the stack.
1792 Pops a long off the stack.
1801 Pops a double off the stack.
1810 Pops a string off the stack. Deprecated. New code should provide
1811 a STRLEN n_a and use POPpx.
1820 Pops a string off the stack which must consist of bytes i.e. characters < 256.
1821 Requires a variable STRLEN n_a in scope.
1830 Pops a string off the stack.
1831 Requires a variable STRLEN n_a in scope.
1840 Pops an SV off the stack.
1849 Push an integer onto the stack. The stack must have room for this element.
1850 Handles 'set' magic. See C<XPUSHi>.
1859 Opening bracket for arguments on a callback. See C<PUTBACK> and
1869 Push a double onto the stack. The stack must have room for this element.
1870 Handles 'set' magic. See C<XPUSHn>.
1879 Push a string onto the stack. The stack must have room for this element.
1880 The C<len> indicates the length of the string. Handles 'set' magic. See
1883 void PUSHp(char* str, STRLEN len)
1890 Push an SV onto the stack. The stack must have room for this element.
1891 Does not handle 'set' magic. See C<XPUSHs>.
1900 Push an unsigned integer onto the stack. The stack must have room for this
1901 element. See C<XPUSHu>.
1910 Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
1911 See C<PUSHMARK> and L<perlcall> for other uses.
1918 =item pv_uni_display
1920 Build to the scalar dsv a displayable version of the string spv,
1921 length len, the displayable version being at most pvlim bytes long
1922 (if longer, the rest is truncated and "..." will be appended).
1923 The flags argument is currently unused but available for future extensions.
1924 The pointer to the PV of the dsv is returned.
1926 char* pv_uni_display(SV *dsv, U8 *spv, STRLEN len, STRLEN pvlim, UV flags)
1929 Found in file utf8.c
1933 The XSUB-writer's interface to the C C<realloc> function.
1935 void Renew(void* ptr, int nitems, type)
1938 Found in file handy.h
1942 The XSUB-writer's interface to the C C<realloc> function, with
1945 void Renewc(void* ptr, int nitems, type, cast)
1948 Found in file handy.h
1952 Tells Perl to C<require> the file named by the string argument. It is
1953 analogous to the Perl code C<eval "require '$file'">. It's even
1954 implemented that way; consider using Perl_load_module instead.
1956 NOTE: the perl_ form of this function is deprecated.
1958 void require_pv(const char* pv)
1961 Found in file perl.c
1965 Variable which is setup by C<xsubpp> to hold the return value for an
1966 XSUB. This is always the proper type for the XSUB. See
1967 L<perlxs/"The RETVAL Variable">.
1972 Found in file XSUB.h
1976 The XSUB-writer's interface to the C C<free> function.
1978 void Safefree(void* ptr)
1981 Found in file handy.h
1985 Copy a string to a safe spot. This does not use an SV.
1987 char* savepv(const char* sv)
1990 Found in file util.c
1994 Copy a string to a safe spot. The C<len> indicates number of bytes to
1995 copy. This does not use an SV.
1997 char* savepvn(const char* sv, I32 len)
2000 Found in file util.c
2004 Opening bracket for temporaries on a callback. See C<FREETMPS> and
2010 Found in file scope.h
2014 For backwards compatibility. Use C<grok_bin> instead.
2016 NV scan_bin(char* start, STRLEN len, STRLEN* retlen)
2019 Found in file numeric.c
2023 For backwards compatibility. Use C<grok_hex> instead.
2025 NV scan_hex(char* start, STRLEN len, STRLEN* retlen)
2028 Found in file numeric.c
2032 For backwards compatibility. Use C<grok_oct> instead.
2034 NV scan_oct(char* start, STRLEN len, STRLEN* retlen)
2037 Found in file numeric.c
2041 Tries to find if a given SV has a shared backend, either by
2042 looking at magic, or by checking if it is tied again threads::shared.
2044 shared_sv* sharedsv_find(SV* sv)
2047 Found in file sharedsv.c
2051 Saves a space for keeping SVs wider than an interpreter,
2052 currently only stores a pointer to the first interpreter.
2054 void sharedsv_init()
2057 Found in file sharedsv.c
2061 Recursive locks on a sharedsv.
2062 Locks are dynamically scoped at the level of the first lock.
2063 void sharedsv_lock(shared_sv* ssv)
2066 Found in file sharedsv.c
2070 Allocates a new shared sv struct, you must yourself create the SV/AV/HV.
2071 shared_sv* sharedsv_new()
2074 Found in file sharedsv.c
2076 =item sharedsv_thrcnt_dec
2078 Decrements the threadcount of a shared sv. When a threads frontend is freed
2079 this function should be called.
2081 void sharedsv_thrcnt_dec(shared_sv* ssv)
2084 Found in file sharedsv.c
2086 =item sharedsv_thrcnt_inc
2088 Increments the threadcount of a sharedsv.
2089 void sharedsv_thrcnt_inc(shared_sv* ssv)
2092 Found in file sharedsv.c
2094 =item sharedsv_unlock
2096 Recursively unlocks a shared sv.
2098 void sharedsv_unlock(shared_sv* ssv)
2101 Found in file sharedsv.c
2105 Sort an array. Here is an example:
2107 sortsv(AvARRAY(av), av_len(av)+1, Perl_sv_cmp_locale);
2109 void sortsv(SV ** array, size_t num_elts, SVCOMPARE_t cmp)
2112 Found in file pp_sort.c
2116 Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and
2124 Refetch the stack pointer. Used after a callback. See L<perlcall>.
2133 Used to access elements on the XSUB's stack.
2138 Found in file XSUB.h
2142 Test two strings to see if they are equal. Returns true or false.
2144 bool strEQ(char* s1, char* s2)
2147 Found in file handy.h
2151 Test two strings to see if the first, C<s1>, is greater than or equal to
2152 the second, C<s2>. Returns true or false.
2154 bool strGE(char* s1, char* s2)
2157 Found in file handy.h
2161 Test two strings to see if the first, C<s1>, is greater than the second,
2162 C<s2>. Returns true or false.
2164 bool strGT(char* s1, char* s2)
2167 Found in file handy.h
2171 Test two strings to see if the first, C<s1>, is less than or equal to the
2172 second, C<s2>. Returns true or false.
2174 bool strLE(char* s1, char* s2)
2177 Found in file handy.h
2181 Test two strings to see if the first, C<s1>, is less than the second,
2182 C<s2>. Returns true or false.
2184 bool strLT(char* s1, char* s2)
2187 Found in file handy.h
2191 Test two strings to see if they are different. Returns true or
2194 bool strNE(char* s1, char* s2)
2197 Found in file handy.h
2201 Test two strings to see if they are equal. The C<len> parameter indicates
2202 the number of bytes to compare. Returns true or false. (A wrapper for
2205 bool strnEQ(char* s1, char* s2, STRLEN len)
2208 Found in file handy.h
2212 Test two strings to see if they are different. The C<len> parameter
2213 indicates the number of bytes to compare. Returns true or false. (A
2214 wrapper for C<strncmp>).
2216 bool strnNE(char* s1, char* s2, STRLEN len)
2219 Found in file handy.h
2223 This is an architecture-independent macro to copy one structure to another.
2225 void StructCopy(type src, type dest, type)
2228 Found in file handy.h
2232 Returns the length of the string which is in the SV. See C<SvLEN>.
2234 STRLEN SvCUR(SV* sv)
2241 Set the length of the string which is in the SV. See C<SvCUR>.
2243 void SvCUR_set(SV* sv, STRLEN len)
2250 Returns a pointer to the last character in the string which is in the SV.
2251 See C<SvCUR>. Access the character as *(SvEND(sv)).
2260 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
2261 argument more than once.
2263 void SvGETMAGIC(SV* sv)
2270 Expands the character buffer in the SV so that it has room for the
2271 indicated number of bytes (remember to reserve space for an extra trailing
2272 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
2273 Returns a pointer to the character buffer.
2275 char * SvGROW(SV* sv, STRLEN len)
2282 Returns a boolean indicating whether the SV contains an integer.
2291 Returns a boolean indicating whether the SV contains an integer. Checks
2292 the B<private> setting. Use C<SvIOK>.
2301 Returns a boolean indicating whether the SV contains a signed integer.
2303 void SvIOK_notUV(SV* sv)
2310 Unsets the IV status of an SV.
2312 void SvIOK_off(SV* sv)
2319 Tells an SV that it is an integer.
2321 void SvIOK_on(SV* sv)
2328 Tells an SV that it is an integer and disables all other OK bits.
2330 void SvIOK_only(SV* sv)
2337 Tells and SV that it is an unsigned integer and disables all other OK bits.
2339 void SvIOK_only_UV(SV* sv)
2346 Returns a boolean indicating whether the SV contains an unsigned integer.
2348 void SvIOK_UV(SV* sv)
2355 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
2356 version which guarantees to evaluate sv only once.
2365 Returns the raw value in the SV's IV slot, without checks or conversions.
2366 Only use when you are sure SvIOK is true. See also C<SvIV()>.
2375 Coerces the given SV to an integer and returns it. Guarantees to evaluate
2376 sv only once. Use the more efficient C<SvIV> otherwise.
2385 Returns the size of the string buffer in the SV, not including any part
2386 attributable to C<SvOOK>. See C<SvCUR>.
2388 STRLEN SvLEN(SV* sv)
2395 Returns a boolean indicating whether the SV contains a number, integer or
2405 Returns a boolean indicating whether the SV contains a number, integer or
2406 double. Checks the B<private> setting. Use C<SvNIOK>.
2408 bool SvNIOKp(SV* sv)
2415 Unsets the NV/IV status of an SV.
2417 void SvNIOK_off(SV* sv)
2424 Returns a boolean indicating whether the SV contains a double.
2433 Returns a boolean indicating whether the SV contains a double. Checks the
2434 B<private> setting. Use C<SvNOK>.
2443 Unsets the NV status of an SV.
2445 void SvNOK_off(SV* sv)
2452 Tells an SV that it is a double.
2454 void SvNOK_on(SV* sv)
2461 Tells an SV that it is a double and disables all other OK bits.
2463 void SvNOK_only(SV* sv)
2470 Coerce the given SV to a double and return it. See C<SvNVx> for a version
2471 which guarantees to evaluate sv only once.
2480 Coerces the given SV to a double and returns it. Guarantees to evaluate
2481 sv only once. Use the more efficient C<SvNV> otherwise.
2490 Returns the raw value in the SV's NV slot, without checks or conversions.
2491 Only use when you are sure SvNOK is true. See also C<SvNV()>.
2500 Returns a boolean indicating whether the value is an SV.
2509 Returns a boolean indicating whether the SvIVX is a valid offset value for
2510 the SvPVX. This hack is used internally to speed up removal of characters
2511 from the beginning of a SvPV. When SvOOK is true, then the start of the
2512 allocated string buffer is really (SvPVX - SvIVX).
2521 Returns a boolean indicating whether the SV contains a character
2531 Returns a boolean indicating whether the SV contains a character string.
2532 Checks the B<private> setting. Use C<SvPOK>.
2541 Unsets the PV status of an SV.
2543 void SvPOK_off(SV* sv)
2550 Tells an SV that it is a string.
2552 void SvPOK_on(SV* sv)
2559 Tells an SV that it is a string and disables all other OK bits.
2560 Will also turn off the UTF8 status.
2562 void SvPOK_only(SV* sv)
2567 =item SvPOK_only_UTF8
2569 Tells an SV that it is a string and disables all other OK bits,
2570 and leaves the UTF8 status as it was.
2572 void SvPOK_only_UTF8(SV* sv)
2579 Returns a pointer to the string in the SV, or a stringified form of the SV
2580 if the SV does not contain a string. Handles 'get' magic. See also
2581 C<SvPVx> for a version which guarantees to evaluate sv only once.
2583 char* SvPV(SV* sv, STRLEN len)
2590 Like C<SvPV>, but converts sv to byte representation first if necessary.
2592 char* SvPVbyte(SV* sv, STRLEN len)
2599 Like C<SvPV>, but converts sv to byte representation first if necessary.
2600 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
2604 char* SvPVbytex(SV* sv, STRLEN len)
2609 =item SvPVbytex_force
2611 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
2612 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
2615 char* SvPVbytex_force(SV* sv, STRLEN len)
2620 =item SvPVbyte_force
2622 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
2624 char* SvPVbyte_force(SV* sv, STRLEN len)
2629 =item SvPVbyte_nolen
2631 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
2633 char* SvPVbyte_nolen(SV* sv)
2640 Like C<SvPV>, but converts sv to utf8 first if necessary.
2642 char* SvPVutf8(SV* sv, STRLEN len)
2649 Like C<SvPV>, but converts sv to utf8 first if necessary.
2650 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
2653 char* SvPVutf8x(SV* sv, STRLEN len)
2658 =item SvPVutf8x_force
2660 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
2661 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
2664 char* SvPVutf8x_force(SV* sv, STRLEN len)
2669 =item SvPVutf8_force
2671 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
2673 char* SvPVutf8_force(SV* sv, STRLEN len)
2678 =item SvPVutf8_nolen
2680 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
2682 char* SvPVutf8_nolen(SV* sv)
2689 Returns a pointer to the physical string in the SV. The SV must contain a
2699 A version of C<SvPV> which guarantees to evaluate sv only once.
2701 char* SvPVx(SV* sv, STRLEN len)
2708 Like <SvPV> but will force the SV into becoming a string (SvPOK). You want
2709 force if you are going to update the SvPVX directly.
2711 char* SvPV_force(SV* sv, STRLEN len)
2716 =item SvPV_force_nomg
2718 Like <SvPV> but will force the SV into becoming a string (SvPOK). You want
2719 force if you are going to update the SvPVX directly. Doesn't process magic.
2721 char* SvPV_force_nomg(SV* sv, STRLEN len)
2728 Returns a pointer to the string in the SV, or a stringified form of the SV
2729 if the SV does not contain a string. Handles 'get' magic.
2731 char* SvPV_nolen(SV* sv)
2738 Returns the value of the object's reference count.
2740 U32 SvREFCNT(SV* sv)
2747 Decrements the reference count of the given SV.
2749 void SvREFCNT_dec(SV* sv)
2756 Increments the reference count of the given SV.
2758 SV* SvREFCNT_inc(SV* sv)
2765 Tests if the SV is an RV.
2774 Unsets the RV status of an SV.
2776 void SvROK_off(SV* sv)
2783 Tells an SV that it is an RV.
2785 void SvROK_on(SV* sv)
2792 Dereferences an RV to return the SV.
2801 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
2802 argument more than once.
2804 void SvSETMAGIC(SV* sv)
2811 Like C<SvSetSV>, but does any set magic required afterwards.
2813 void SvSetMagicSV(SV* dsb, SV* ssv)
2818 =item SvSetMagicSV_nosteal
2820 Like C<SvSetMagicSV>, but does any set magic required afterwards.
2822 void SvSetMagicSV_nosteal(SV* dsv, SV* ssv)
2829 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
2832 void SvSetSV(SV* dsb, SV* ssv)
2837 =item SvSetSV_nosteal
2839 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
2840 ssv. May evaluate arguments more than once.
2842 void SvSetSV_nosteal(SV* dsv, SV* ssv)
2849 Returns the stash of the SV.
2858 Taints an SV if tainting is enabled
2860 void SvTAINT(SV* sv)
2867 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
2870 bool SvTAINTED(SV* sv)
2877 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
2878 some of Perl's fundamental security features. XS module authors should not
2879 use this function unless they fully understand all the implications of
2880 unconditionally untainting the value. Untainting should be done in the
2881 standard perl fashion, via a carefully crafted regexp, rather than directly
2882 untainting variables.
2884 void SvTAINTED_off(SV* sv)
2891 Marks an SV as tainted.
2893 void SvTAINTED_on(SV* sv)
2900 Returns a boolean indicating whether Perl would evaluate the SV as true or
2901 false, defined or undefined. Does not handle 'get' magic.
2910 An enum of flags for Perl types. These are found in the file B<sv.h>
2911 in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
2918 Returns the type of the SV. See C<svtype>.
2920 svtype SvTYPE(SV* sv)
2927 Integer type flag for scalars. See C<svtype>.
2934 Double type flag for scalars. See C<svtype>.
2941 Pointer type flag for scalars. See C<svtype>.
2948 Type flag for arrays. See C<svtype>.
2955 Type flag for code refs. See C<svtype>.
2962 Type flag for hashes. See C<svtype>.
2969 Type flag for blessed scalars. See C<svtype>.
2976 Returns a boolean indicating whether the SV contains an unsigned integer.
2985 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
2986 perform the upgrade if necessary. See C<svtype>.
2988 void SvUPGRADE(SV* sv, svtype type)
2995 Returns a boolean indicating whether the SV contains UTF-8 encoded data.
3004 Unsets the UTF8 status of an SV.
3006 void SvUTF8_off(SV *sv)
3013 Turn on the UTF8 status of an SV (the data is not changed, just the flag).
3014 Do not use frivolously.
3016 void SvUTF8_on(SV *sv)
3023 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
3024 for a version which guarantees to evaluate sv only once.
3033 Coerces the given SV to an unsigned integer and returns it. Guarantees to
3034 evaluate sv only once. Use the more efficient C<SvUV> otherwise.
3043 Returns the raw value in the SV's UV slot, without checks or conversions.
3044 Only use when you are sure SvIOK is true. See also C<SvUV()>.
3053 This function is only called on magical items, and is only used by
3054 sv_true() or its macro equivalent.
3056 bool sv_2bool(SV* sv)
3063 Using various gambits, try to get a CV from an SV; in addition, try if
3064 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
3066 CV* sv_2cv(SV* sv, HV** st, GV** gvp, I32 lref)
3073 Using various gambits, try to get an IO from an SV: the IO slot if its a
3074 GV; or the recursive result if we're an RV; or the IO slot of the symbol
3075 named after the PV if we're a string.
3084 Return the integer value of an SV, doing any necessary string conversion,
3085 magic etc. Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
3094 Marks an existing SV as mortal. The SV will be destroyed "soon", either
3095 by an explicit call to FREETMPS, or by an implicit call at places such as
3096 statement boundaries. See also C<sv_newmortal> and C<sv_mortalcopy>.
3098 SV* sv_2mortal(SV* sv)
3105 Return the num value of an SV, doing any necessary string or integer
3106 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
3116 Return a pointer to the byte-encoded representation of the SV, and set *lp
3117 to its length. May cause the SV to be downgraded from UTF8 as a
3120 Usually accessed via the C<SvPVbyte> macro.
3122 char* sv_2pvbyte(SV* sv, STRLEN* lp)
3127 =item sv_2pvbyte_nolen
3129 Return a pointer to the byte-encoded representation of the SV.
3130 May cause the SV to be downgraded from UTF8 as a side-effect.
3132 Usually accessed via the C<SvPVbyte_nolen> macro.
3134 char* sv_2pvbyte_nolen(SV* sv)
3141 Return a pointer to the UTF8-encoded representation of the SV, and set *lp
3142 to its length. May cause the SV to be upgraded to UTF8 as a side-effect.
3144 Usually accessed via the C<SvPVutf8> macro.
3146 char* sv_2pvutf8(SV* sv, STRLEN* lp)
3151 =item sv_2pvutf8_nolen
3153 Return a pointer to the UTF8-encoded representation of the SV.
3154 May cause the SV to be upgraded to UTF8 as a side-effect.
3156 Usually accessed via the C<SvPVutf8_nolen> macro.
3158 char* sv_2pvutf8_nolen(SV* sv)
3165 Returns a pointer to the string value of an SV, and sets *lp to its length.
3166 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
3168 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
3169 usually end up here too.
3171 char* sv_2pv_flags(SV* sv, STRLEN* lp, I32 flags)
3178 Like C<sv_2pv()>, but doesn't return the length too. You should usually
3179 use the macro wrapper C<SvPV_nolen(sv)> instead.
3180 char* sv_2pv_nolen(SV* sv)
3187 Return the unsigned integer value of an SV, doing any necessary string
3188 conversion, magic etc. Normally used via the C<SvUV(sv)> and C<SvUVx(sv)>
3198 Remove any string offset. You should normally use the C<SvOOK_off> macro
3201 int sv_backoff(SV* sv)
3208 Blesses an SV into a specified package. The SV must be an RV. The package
3209 must be designated by its stash (see C<gv_stashpv()>). The reference count
3210 of the SV is unaffected.
3212 SV* sv_bless(SV* sv, HV* stash)
3219 Concatenates the string onto the end of the string which is in the SV.
3220 If the SV has the UTF8 status set, then the bytes appended should be
3221 valid UTF8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
3223 void sv_catpv(SV* sv, const char* ptr)
3230 Processes its arguments like C<sprintf> and appends the formatted
3231 output to an SV. If the appended data contains "wide" characters
3232 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
3233 and characters >255 formatted with %c), the original SV might get
3234 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic.
3235 C<SvSETMAGIC()> must typically be called after calling this function
3236 to handle 'set' magic.
3238 void sv_catpvf(SV* sv, const char* pat, ...)
3245 Like C<sv_catpvf>, but also handles 'set' magic.
3247 void sv_catpvf_mg(SV *sv, const char* pat, ...)
3254 Concatenates the string onto the end of the string which is in the SV. The
3255 C<len> indicates number of bytes to copy. If the SV has the UTF8
3256 status set, then the bytes appended should be valid UTF8.
3257 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
3259 void sv_catpvn(SV* sv, const char* ptr, STRLEN len)
3264 =item sv_catpvn_flags
3266 Concatenates the string onto the end of the string which is in the SV. The
3267 C<len> indicates number of bytes to copy. If the SV has the UTF8
3268 status set, then the bytes appended should be valid UTF8.
3269 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
3270 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
3271 in terms of this function.
3273 void sv_catpvn_flags(SV* sv, const char* ptr, STRLEN len, I32 flags)
3280 Like C<sv_catpvn>, but also handles 'set' magic.
3282 void sv_catpvn_mg(SV *sv, const char *ptr, STRLEN len)
3289 Like C<sv_catpv>, but also handles 'set' magic.
3291 void sv_catpv_mg(SV *sv, const char *ptr)
3298 Concatenates the string from SV C<ssv> onto the end of the string in
3299 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
3300 not 'set' magic. See C<sv_catsv_mg>.
3302 void sv_catsv(SV* dsv, SV* ssv)
3307 =item sv_catsv_flags
3309 Concatenates the string from SV C<ssv> onto the end of the string in
3310 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
3311 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
3312 and C<sv_catsv_nomg> are implemented in terms of this function.
3314 void sv_catsv_flags(SV* dsv, SV* ssv, I32 flags)
3321 Like C<sv_catsv>, but also handles 'set' magic.
3323 void sv_catsv_mg(SV *dstr, SV *sstr)
3330 Efficient removal of characters from the beginning of the string buffer.
3331 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
3332 the string buffer. The C<ptr> becomes the first character of the adjusted
3333 string. Uses the "OOK hack".
3335 void sv_chop(SV* sv, char* ptr)
3342 Clear an SV: call any destructors, free up any memory used by the body,
3343 and free the body itself. The SV's head is I<not> freed, although
3344 its type is set to all 1's so that it won't inadvertently be assumed
3345 to be live during global destruction etc.
3346 This function should only be called when REFCNT is zero. Most of the time
3347 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
3350 void sv_clear(SV* sv)
3357 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
3358 string in C<sv1> is less than, equal to, or greater than the string in
3359 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
3360 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
3362 I32 sv_cmp(SV* sv1, SV* sv2)
3369 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
3370 'use bytes' aware, handles get magic, and will coerce its args to strings
3371 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
3373 I32 sv_cmp_locale(SV* sv1, SV* sv2)
3380 Add Collate Transform magic to an SV if it doesn't already have it.
3382 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
3383 scalar data of the variable, but transformed to such a format that a normal
3384 memory comparison can be used to compare the data according to the locale
3387 char* sv_collxfrm(SV* sv, STRLEN* nxp)
3394 Auto-decrement of the value in the SV, doing string to numeric conversion
3395 if necessary. Handles 'get' magic.
3402 =item sv_derived_from
3404 Returns a boolean indicating whether the SV is derived from the specified
3405 class. This is the function that implements C<UNIVERSAL::isa>. It works
3406 for class names as well as for objects.
3408 bool sv_derived_from(SV* sv, const char* name)
3411 Found in file universal.c
3415 Returns a boolean indicating whether the strings in the two SVs are
3416 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
3417 coerce its args to strings if necessary.
3419 I32 sv_eq(SV* sv1, SV* sv2)
3424 =item sv_force_normal
3426 Undo various types of fakery on an SV: if the PV is a shared string, make
3427 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3428 an xpvmg. See also C<sv_force_normal_flags>.
3430 void sv_force_normal(SV *sv)
3435 =item sv_force_normal_flags
3437 Undo various types of fakery on an SV: if the PV is a shared string, make
3438 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3439 an xpvmg. The C<flags> parameter gets passed to C<sv_unref_flags()>
3440 when unrefing. C<sv_force_normal> calls this function with flags set to 0.
3442 void sv_force_normal_flags(SV *sv, U32 flags)
3449 Decrement an SV's reference count, and if it drops to zero, call
3450 C<sv_clear> to invoke destructors and free up any memory used by
3451 the body; finally, deallocate the SV's head itself.
3452 Normally called via a wrapper macro C<SvREFCNT_dec>.
3454 void sv_free(SV* sv)
3461 Get a line from the filehandle and store it into the SV, optionally
3462 appending to the currently-stored string.
3464 char* sv_gets(SV* sv, PerlIO* fp, I32 append)
3471 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
3472 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
3473 Use the C<SvGROW> wrapper instead.
3475 char* sv_grow(SV* sv, STRLEN newlen)
3482 Auto-increment of the value in the SV, doing string to numeric conversion
3483 if necessary. Handles 'get' magic.
3492 Inserts a string at the specified offset/length within the SV. Similar to
3493 the Perl substr() function.
3495 void sv_insert(SV* bigsv, STRLEN offset, STRLEN len, char* little, STRLEN littlelen)
3502 Returns a boolean indicating whether the SV is blessed into the specified
3503 class. This does not check for subtypes; use C<sv_derived_from> to verify
3504 an inheritance relationship.
3506 int sv_isa(SV* sv, const char* name)
3513 Returns a boolean indicating whether the SV is an RV pointing to a blessed
3514 object. If the SV is not an RV, or if the object is not blessed, then this
3517 int sv_isobject(SV* sv)
3524 A private implementation of the C<SvIVx> macro for compilers which can't
3525 cope with complex macro expressions. Always use the macro instead.
3534 Returns the length of the string in the SV. Handles magic and type
3535 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
3537 STRLEN sv_len(SV* sv)
3544 Returns the number of characters in the string in an SV, counting wide
3545 UTF8 bytes as a single character. Handles magic and type coercion.
3547 STRLEN sv_len_utf8(SV* sv)
3554 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
3555 then adds a new magic item of type C<how> to the head of the magic list.
3557 C<name> is assumed to contain an C<SV*> if C<(name && namelen == HEf_SVKEY)>
3559 void sv_magic(SV* sv, SV* obj, int how, const char* name, I32 namlen)
3566 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
3567 The new SV is marked as mortal. It will be destroyed "soon", either by an
3568 explicit call to FREETMPS, or by an implicit call at places such as
3569 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
3571 SV* sv_mortalcopy(SV* oldsv)
3578 Creates a new null SV which is mortal. The reference count of the SV is
3579 set to 1. It will be destroyed "soon", either by an explicit call to
3580 FREETMPS, or by an implicit call at places such as statement boundaries.
3581 See also C<sv_mortalcopy> and C<sv_2mortal>.
3590 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
3593 SV* sv_newref(SV* sv)
3600 A private implementation of the C<SvNVx> macro for compilers which can't
3601 cope with complex macro expressions. Always use the macro instead.
3610 Converts the value pointed to by offsetp from a count of bytes from the
3611 start of the string, to a count of the equivalent number of UTF8 chars.
3612 Handles magic and type coercion.
3614 void sv_pos_b2u(SV* sv, I32* offsetp)
3621 Converts the value pointed to by offsetp from a count of UTF8 chars from
3622 the start of the string, to a count of the equivalent number of bytes; if
3623 lenp is non-zero, it does the same to lenp, but this time starting from
3624 the offset, rather than from the start of the string. Handles magic and
3627 void sv_pos_u2b(SV* sv, I32* offsetp, I32* lenp)
3634 A private implementation of the C<SvPV_nolen> macro for compilers which can't
3635 cope with complex macro expressions. Always use the macro instead.
3644 A private implementation of the C<SvPVbyte_nolen> macro for compilers
3645 which can't cope with complex macro expressions. Always use the macro
3648 char* sv_pvbyte(SV *sv)
3655 A private implementation of the C<SvPVbyte> macro for compilers
3656 which can't cope with complex macro expressions. Always use the macro
3659 char* sv_pvbyten(SV *sv, STRLEN *len)
3664 =item sv_pvbyten_force
3666 A private implementation of the C<SvPVbytex_force> macro for compilers
3667 which can't cope with complex macro expressions. Always use the macro
3670 char* sv_pvbyten_force(SV* sv, STRLEN* lp)
3677 A private implementation of the C<SvPV> macro for compilers which can't
3678 cope with complex macro expressions. Always use the macro instead.
3680 char* sv_pvn(SV *sv, STRLEN *len)
3687 Get a sensible string out of the SV somehow.
3688 A private implementation of the C<SvPV_force> macro for compilers which
3689 can't cope with complex macro expressions. Always use the macro instead.
3691 char* sv_pvn_force(SV* sv, STRLEN* lp)
3696 =item sv_pvn_force_flags
3698 Get a sensible string out of the SV somehow.
3699 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
3700 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
3701 implemented in terms of this function.
3702 You normally want to use the various wrapper macros instead: see
3703 C<SvPV_force> and C<SvPV_force_nomg>
3705 char* sv_pvn_force_flags(SV* sv, STRLEN* lp, I32 flags)
3712 A private implementation of the C<SvPVutf8_nolen> macro for compilers
3713 which can't cope with complex macro expressions. Always use the macro
3716 char* sv_pvutf8(SV *sv)
3723 A private implementation of the C<SvPVutf8> macro for compilers
3724 which can't cope with complex macro expressions. Always use the macro
3727 char* sv_pvutf8n(SV *sv, STRLEN *len)
3732 =item sv_pvutf8n_force
3734 A private implementation of the C<SvPVutf8_force> macro for compilers
3735 which can't cope with complex macro expressions. Always use the macro
3738 char* sv_pvutf8n_force(SV* sv, STRLEN* lp)
3743 =item sv_recode_to_utf8
3745 The encoding is assumed to be an Encode object, on entry the PV
3746 of the sv is assumed to be octets in that encoding, and the sv
3747 will be converted into Unicode (and UTF-8).
3749 If the sv already is UTF-8 (or if it is not POK), or if the encoding
3750 is not a reference, nothing is done to the sv. If the encoding is not
3751 an C<Encode::XS> Encoding object, bad things will happen.
3752 (See F<lib/encoding.pm> and L<Encode>).
3754 The PV of the sv is returned.
3756 char* sv_recode_to_utf8(SV* sv, SV *encoding)
3763 Returns a string describing what the SV is a reference to.
3765 char* sv_reftype(SV* sv, int ob)
3772 Make the first argument a copy of the second, then delete the original.
3773 The target SV physically takes over ownership of the body of the source SV
3774 and inherits its flags; however, the target keeps any magic it owns,
3775 and any magic in the source is discarded.
3776 Note that this is a rather specialist SV copying operation; most of the
3777 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
3779 void sv_replace(SV* sv, SV* nsv)
3784 =item sv_report_used
3786 Dump the contents of all SVs not yet freed. (Debugging aid).
3788 void sv_report_used()
3795 Underlying implementation for the C<reset> Perl function.
3796 Note that the perl-level function is vaguely deprecated.
3798 void sv_reset(char* s, HV* stash)
3805 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
3806 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
3807 push a back-reference to this RV onto the array of backreferences
3808 associated with that magic.
3810 SV* sv_rvweaken(SV *sv)
3817 Copies an integer into the given SV, upgrading first if necessary.
3818 Does not handle 'set' magic. See also C<sv_setiv_mg>.
3820 void sv_setiv(SV* sv, IV num)
3827 Like C<sv_setiv>, but also handles 'set' magic.
3829 void sv_setiv_mg(SV *sv, IV i)
3836 Copies a double into the given SV, upgrading first if necessary.
3837 Does not handle 'set' magic. See also C<sv_setnv_mg>.
3839 void sv_setnv(SV* sv, NV num)
3846 Like C<sv_setnv>, but also handles 'set' magic.
3848 void sv_setnv_mg(SV *sv, NV num)
3855 Copies a string into an SV. The string must be null-terminated. Does not
3856 handle 'set' magic. See C<sv_setpv_mg>.
3858 void sv_setpv(SV* sv, const char* ptr)
3865 Processes its arguments like C<sprintf> and sets an SV to the formatted
3866 output. Does not handle 'set' magic. See C<sv_setpvf_mg>.
3868 void sv_setpvf(SV* sv, const char* pat, ...)
3875 Like C<sv_setpvf>, but also handles 'set' magic.
3877 void sv_setpvf_mg(SV *sv, const char* pat, ...)
3884 Copies an integer into the given SV, also updating its string value.
3885 Does not handle 'set' magic. See C<sv_setpviv_mg>.
3887 void sv_setpviv(SV* sv, IV num)
3894 Like C<sv_setpviv>, but also handles 'set' magic.
3896 void sv_setpviv_mg(SV *sv, IV iv)
3903 Copies a string into an SV. The C<len> parameter indicates the number of
3904 bytes to be copied. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3906 void sv_setpvn(SV* sv, const char* ptr, STRLEN len)
3913 Like C<sv_setpvn>, but also handles 'set' magic.
3915 void sv_setpvn_mg(SV *sv, const char *ptr, STRLEN len)
3922 Like C<sv_setpv>, but also handles 'set' magic.
3924 void sv_setpv_mg(SV *sv, const char *ptr)
3931 Copies an 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_iv(SV* rv, const char* classname, IV iv)
3944 Copies a double into a new SV, optionally blessing the SV. The C<rv>
3945 argument will be upgraded to an RV. That RV will be modified to point to
3946 the new SV. The C<classname> argument indicates the package for the
3947 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
3948 will be returned and will have a reference count of 1.
3950 SV* sv_setref_nv(SV* rv, const char* classname, NV nv)
3957 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
3958 argument will be upgraded to an RV. That RV will be modified to point to
3959 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
3960 into the SV. The C<classname> argument indicates the package for the
3961 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
3962 will be returned and will have a reference count of 1.
3964 Do not use with other Perl types such as HV, AV, SV, CV, because those
3965 objects will become corrupted by the pointer copy process.
3967 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
3969 SV* sv_setref_pv(SV* rv, const char* classname, void* pv)
3976 Copies a string into a new SV, optionally blessing the SV. The length of the
3977 string must be specified with C<n>. The C<rv> argument will be upgraded to
3978 an RV. That RV will be modified to point to the new SV. The C<classname>
3979 argument indicates the package for the blessing. Set C<classname> to
3980 C<Nullch> to avoid the blessing. The new SV will be returned and will have
3981 a reference count of 1.
3983 Note that C<sv_setref_pv> copies the pointer while this copies the string.
3985 SV* sv_setref_pvn(SV* rv, const char* classname, char* pv, STRLEN n)
3992 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
3993 argument will be upgraded to an RV. That RV will be modified to point to
3994 the new SV. The C<classname> argument indicates the package for the
3995 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
3996 will be returned and will have a reference count of 1.
3998 SV* sv_setref_uv(SV* rv, const char* classname, UV uv)
4005 Copies the contents of the source SV C<ssv> into the destination SV
4006 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4007 function if the source SV needs to be reused. Does not handle 'set' magic.
4008 Loosely speaking, it performs a copy-by-value, obliterating any previous
4009 content of the destination.
4011 You probably want to use one of the assortment of wrappers, such as
4012 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4013 C<SvSetMagicSV_nosteal>.
4016 void sv_setsv(SV* dsv, SV* ssv)
4021 =item sv_setsv_flags
4023 Copies the contents of the source SV C<ssv> into the destination SV
4024 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4025 function if the source SV needs to be reused. Does not handle 'set' magic.
4026 Loosely speaking, it performs a copy-by-value, obliterating any previous
4027 content of the destination.
4028 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
4029 C<ssv> if appropriate, else not. C<sv_setsv> and C<sv_setsv_nomg> are
4030 implemented in terms of this function.
4032 You probably want to use one of the assortment of wrappers, such as
4033 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4034 C<SvSetMagicSV_nosteal>.
4036 This is the primary function for copying scalars, and most other
4037 copy-ish functions and macros use this underneath.
4039 void sv_setsv_flags(SV* dsv, SV* ssv, I32 flags)
4046 Like C<sv_setsv>, but also handles 'set' magic.
4048 void sv_setsv_mg(SV *dstr, SV *sstr)
4055 Copies an unsigned integer into the given SV, upgrading first if necessary.
4056 Does not handle 'set' magic. See also C<sv_setuv_mg>.
4058 void sv_setuv(SV* sv, UV num)
4065 Like C<sv_setuv>, but also handles 'set' magic.
4067 void sv_setuv_mg(SV *sv, UV u)
4074 Taint an SV. Use C<SvTAINTED_on> instead.
4075 void sv_taint(SV* sv)
4082 Test an SV for taintedness. Use C<SvTAINTED> instead.
4083 bool sv_tainted(SV* sv)
4090 Returns true if the SV has a true value by Perl's rules.
4091 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
4092 instead use an in-line version.
4099 =item sv_uni_display
4101 Build to the scalar dsv a displayable version of the scalar sv,
4102 he displayable version being at most pvlim bytes long
4103 (if longer, the rest is truncated and "..." will be appended).
4104 The flags argument is currently unused but available for future extensions.
4105 The pointer to the PV of the dsv is returned.
4107 char* sv_uni_display(SV *dsv, SV *ssv, STRLEN pvlim, UV flags)
4110 Found in file utf8.c
4114 Removes all magic of type C<type> from an SV.
4116 int sv_unmagic(SV* sv, int type)
4123 Unsets the RV status of the SV, and decrements the reference count of
4124 whatever was being referenced by the RV. This can almost be thought of
4125 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
4126 being zero. See C<SvROK_off>.
4128 void sv_unref(SV* sv)
4133 =item sv_unref_flags
4135 Unsets the RV status of the SV, and decrements the reference count of
4136 whatever was being referenced by the RV. This can almost be thought of
4137 as a reversal of C<newSVrv>. The C<cflags> argument can contain
4138 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
4139 (otherwise the decrementing is conditional on the reference count being
4140 different from one or the reference being a readonly SV).
4143 void sv_unref_flags(SV* sv, U32 flags)
4150 Untaint an SV. Use C<SvTAINTED_off> instead.
4151 void sv_untaint(SV* sv)
4158 Upgrade an SV to a more complex form. Generally adds a new body type to the
4159 SV, then copies across as much information as possible from the old body.
4160 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
4162 bool sv_upgrade(SV* sv, U32 mt)
4169 Tells an SV to use C<ptr> to find its string value. Normally the string is
4170 stored inside the SV but sv_usepvn allows the SV to use an outside string.
4171 The C<ptr> should point to memory that was allocated by C<malloc>. The
4172 string length, C<len>, must be supplied. This function will realloc the
4173 memory pointed to by C<ptr>, so that pointer should not be freed or used by
4174 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
4175 See C<sv_usepvn_mg>.
4177 void sv_usepvn(SV* sv, char* ptr, STRLEN len)
4184 Like C<sv_usepvn>, but also handles 'set' magic.
4186 void sv_usepvn_mg(SV *sv, char *ptr, STRLEN len)
4191 =item sv_utf8_decode
4193 Convert the octets in the PV from UTF-8 to chars. Scan for validity and then
4194 turn off SvUTF8 if needed so that we see characters. Used as a building block
4195 for decode_utf8 in Encode.xs
4197 NOTE: this function is experimental and may change or be
4198 removed without notice.
4200 bool sv_utf8_decode(SV *sv)
4205 =item sv_utf8_downgrade
4207 Attempt to convert the PV of an SV from UTF8-encoded to byte encoding.
4208 This may not be possible if the PV contains non-byte encoding characters;
4209 if this is the case, either returns false or, if C<fail_ok> is not
4212 NOTE: this function is experimental and may change or be
4213 removed without notice.
4215 bool sv_utf8_downgrade(SV *sv, bool fail_ok)
4220 =item sv_utf8_encode
4222 Convert the PV of an SV to UTF8-encoded, but then turn off the C<SvUTF8>
4223 flag so that it looks like octets again. Used as a building block
4224 for encode_utf8 in Encode.xs
4226 void sv_utf8_encode(SV *sv)
4231 =item sv_utf8_upgrade
4233 Convert the PV of an SV to its UTF8-encoded form.
4234 Forces the SV to string form if it is not already.
4235 Always sets the SvUTF8 flag to avoid future validity checks even
4236 if all the bytes have hibit clear.
4238 STRLEN sv_utf8_upgrade(SV *sv)
4243 =item sv_utf8_upgrade_flags
4245 Convert the PV of an SV to its UTF8-encoded form.
4246 Forces the SV to string form if it is not already.
4247 Always sets the SvUTF8 flag to avoid future validity checks even
4248 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
4249 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
4250 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
4252 STRLEN sv_utf8_upgrade_flags(SV *sv, I32 flags)
4259 A private implementation of the C<SvUVx> macro for compilers which can't
4260 cope with complex macro expressions. Always use the macro instead.
4269 Processes its arguments like C<vsprintf> and appends the formatted output
4270 to an SV. Uses an array of SVs if the C style variable argument list is
4271 missing (NULL). When running with taint checks enabled, indicates via
4272 C<maybe_tainted> if results are untrustworthy (often due to the use of
4275 Usually used via one of its frontends C<sv_catpvf> and C<sv_catpvf_mg>.
4277 void sv_vcatpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
4284 Works like C<vcatpvfn> but copies the text into the SV instead of
4287 Usually used via one of its frontends C<sv_setpvf> and C<sv_setpvf_mg>.
4289 void sv_vsetpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
4296 Variable which is setup by C<xsubpp> to designate the object in a C++
4297 XSUB. This is always the proper type for the C++ object. See C<CLASS> and
4298 L<perlxs/"Using XS With C++">.
4303 Found in file XSUB.h
4307 Converts the specified character to lowercase.
4309 char toLOWER(char ch)
4312 Found in file handy.h
4316 Converts the specified character to uppercase.
4318 char toUPPER(char ch)
4321 Found in file handy.h
4325 The "p" contains the pointer to the UTF-8 string encoding
4326 the character that is being converted.
4328 The "ustrp" is a pointer to the character buffer to put the
4329 conversion result to. The "lenp" is a pointer to the length
4332 The "swash" is a pointer to the swash to use.
4334 The "normal" is a string like "ToLower" which means the swash
4335 $utf8::ToLower, which is stored in lib/unicore/To/Lower.pl,
4336 and loaded by SWASHGET, using lib/utf8_heavy.pl.
4338 The "special" is a string like "utf8::ToSpecLower", which means
4339 the hash %utf8::ToSpecLower, which is stored in the same file,
4340 lib/unicore/To/Lower.pl, and also loaded by SWASHGET. The access
4341 to the hash is by Perl_to_utf8_case().
4343 UV to_utf8_case(U8 *p, U8* ustrp, STRLEN *lenp, SV **swash, char *normal, char *special)
4346 Found in file utf8.c
4350 Convert the UTF-8 encoded character at p to its foldcase version and
4351 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
4352 that the ustrp needs to be at least UTF8_MAXLEN_FOLD+1 bytes since the
4353 foldcase version may be longer than the original character (up to
4356 The first character of the foldcased version is returned
4357 (but note, as explained above, that there may be more.)
4359 UV to_utf8_fold(U8 *p, U8* ustrp, STRLEN *lenp)
4362 Found in file utf8.c
4366 Convert the UTF-8 encoded character at p to its lowercase version and
4367 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
4368 that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the
4369 lowercase version may be longer than the original character (up to two
4372 The first character of the lowercased version is returned
4373 (but note, as explained above, that there may be more.)
4375 UV to_utf8_lower(U8 *p, U8* ustrp, STRLEN *lenp)
4378 Found in file utf8.c
4382 Convert the UTF-8 encoded character at p to its titlecase version and
4383 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
4384 that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the
4385 titlecase version may be longer than the original character (up to two
4388 The first character of the titlecased version is returned
4389 (but note, as explained above, that there may be more.)
4391 UV to_utf8_title(U8 *p, U8* ustrp, STRLEN *lenp)
4394 Found in file utf8.c
4398 Convert the UTF-8 encoded character at p to its uppercase version and
4399 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
4400 that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the
4401 uppercase version may be longer than the original character (up to two
4404 The first character of the uppercased version is returned
4405 (but note, as explained above, that there may be more.)
4407 UV to_utf8_upper(U8 *p, U8* ustrp, STRLEN *lenp)
4410 Found in file utf8.c
4412 =item utf8n_to_uvchr
4414 Returns the native character value of the first character in the string C<s>
4415 which is assumed to be in UTF8 encoding; C<retlen> will be set to the
4416 length, in bytes, of that character.
4418 Allows length and flags to be passed to low level routine.
4420 UV utf8n_to_uvchr(U8 *s, STRLEN curlen, STRLEN* retlen, U32 flags)
4423 Found in file utf8.c
4425 =item utf8n_to_uvuni
4427 Bottom level UTF-8 decode routine.
4428 Returns the unicode code point value of the first character in the string C<s>
4429 which is assumed to be in UTF8 encoding and no longer than C<curlen>;
4430 C<retlen> will be set to the length, in bytes, of that character.
4432 If C<s> does not point to a well-formed UTF8 character, the behaviour
4433 is dependent on the value of C<flags>: if it contains UTF8_CHECK_ONLY,
4434 it is assumed that the caller will raise a warning, and this function
4435 will silently just set C<retlen> to C<-1> and return zero. If the
4436 C<flags> does not contain UTF8_CHECK_ONLY, warnings about
4437 malformations will be given, C<retlen> will be set to the expected
4438 length of the UTF-8 character in bytes, and zero will be returned.
4440 The C<flags> can also contain various flags to allow deviations from
4441 the strict UTF-8 encoding (see F<utf8.h>).
4443 Most code should use utf8_to_uvchr() rather than call this directly.
4445 UV utf8n_to_uvuni(U8 *s, STRLEN curlen, STRLEN* retlen, U32 flags)
4448 Found in file utf8.c
4452 Returns the number of UTF8 characters between the UTF-8 pointers C<a>
4455 WARNING: use only if you *know* that the pointers point inside the
4458 IV utf8_distance(U8 *a, U8 *b)
4461 Found in file utf8.c
4465 Return the UTF-8 pointer C<s> displaced by C<off> characters, either
4466 forward or backward.
4468 WARNING: do not use the following unless you *know* C<off> is within
4469 the UTF-8 data pointed to by C<s> *and* that on entry C<s> is aligned
4470 on the first byte of character or just after the last byte of a character.
4472 U8* utf8_hop(U8 *s, I32 off)
4475 Found in file utf8.c
4479 Return the length of the UTF-8 char encoded string C<s> in characters.
4480 Stops at C<e> (inclusive). If C<e E<lt> s> or if the scan would end
4481 up past C<e>, croaks.
4483 STRLEN utf8_length(U8* s, U8 *e)
4486 Found in file utf8.c
4490 Converts a string C<s> of length C<len> from UTF8 into byte encoding.
4491 Unlike C<bytes_to_utf8>, this over-writes the original string, and
4492 updates len to contain the new length.
4493 Returns zero on failure, setting C<len> to -1.
4495 NOTE: this function is experimental and may change or be
4496 removed without notice.
4498 U8* utf8_to_bytes(U8 *s, STRLEN *len)
4501 Found in file utf8.c
4505 Returns the native character value of the first character in the string C<s>
4506 which is assumed to be in UTF8 encoding; C<retlen> will be set to the
4507 length, in bytes, of that character.
4509 If C<s> does not point to a well-formed UTF8 character, zero is
4510 returned and retlen is set, if possible, to -1.
4512 UV utf8_to_uvchr(U8 *s, STRLEN* retlen)
4515 Found in file utf8.c
4519 Returns the Unicode code point of the first character in the string C<s>
4520 which is assumed to be in UTF8 encoding; C<retlen> will be set to the
4521 length, in bytes, of that character.
4523 This function should only be used when returned UV is considered
4524 an index into the Unicode semantic tables (e.g. swashes).
4526 If C<s> does not point to a well-formed UTF8 character, zero is
4527 returned and retlen is set, if possible, to -1.
4529 UV utf8_to_uvuni(U8 *s, STRLEN* retlen)
4532 Found in file utf8.c
4536 Adds the UTF8 representation of the Native codepoint C<uv> to the end
4537 of the string C<d>; C<d> should be have at least C<UTF8_MAXLEN+1> free
4538 bytes available. The return value is the pointer to the byte after the
4539 end of the new character. In other words,
4541 d = uvchr_to_utf8(d, uv);
4543 is the recommended wide native character-aware way of saying
4547 U8* uvchr_to_utf8(U8 *d, UV uv)
4550 Found in file utf8.c
4552 =item uvuni_to_utf8_flags
4554 Adds the UTF8 representation of the Unicode codepoint C<uv> to the end
4555 of the string C<d>; C<d> should be have at least C<UTF8_MAXLEN+1> free
4556 bytes available. The return value is the pointer to the byte after the
4557 end of the new character. In other words,
4559 d = uvuni_to_utf8_flags(d, uv, flags);
4563 d = uvuni_to_utf8(d, uv);
4565 (which is equivalent to)
4567 d = uvuni_to_utf8_flags(d, uv, 0);
4569 is the recommended Unicode-aware way of saying
4573 U8* uvuni_to_utf8_flags(U8 *d, UV uv, UV flags)
4576 Found in file utf8.c
4580 This is the XSUB-writer's interface to Perl's C<warn> function. Use this
4581 function the same way you use the C C<printf> function. See
4584 void warn(const char* pat, ...)
4587 Found in file util.c
4591 Push an integer onto the stack, extending the stack if necessary. Handles
4592 'set' magic. See C<PUSHi>.
4601 Push a double onto the stack, extending the stack if necessary. Handles
4602 'set' magic. See C<PUSHn>.
4611 Push a string onto the stack, extending the stack if necessary. The C<len>
4612 indicates the length of the string. Handles 'set' magic. See
4615 void XPUSHp(char* str, STRLEN len)
4622 Push an SV onto the stack, extending the stack if necessary. Does not
4623 handle 'set' magic. See C<PUSHs>.
4632 Push an unsigned integer onto the stack, extending the stack if necessary.
4642 Macro to declare an XSUB and its C parameter list. This is handled by
4646 Found in file XSUB.h
4650 Return from XSUB, indicating number of items on the stack. This is usually
4651 handled by C<xsubpp>.
4653 void XSRETURN(int nitems)
4656 Found in file XSUB.h
4658 =item XSRETURN_EMPTY
4660 Return an empty list from an XSUB immediately.
4665 Found in file XSUB.h
4669 Return an integer from an XSUB immediately. Uses C<XST_mIV>.
4671 void XSRETURN_IV(IV iv)
4674 Found in file XSUB.h
4678 Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
4683 Found in file XSUB.h
4687 Return a double from an XSUB immediately. Uses C<XST_mNV>.
4689 void XSRETURN_NV(NV nv)
4692 Found in file XSUB.h
4696 Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
4698 void XSRETURN_PV(char* str)
4701 Found in file XSUB.h
4703 =item XSRETURN_UNDEF
4705 Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
4710 Found in file XSUB.h
4714 Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
4719 Found in file XSUB.h
4723 Place an integer into the specified position C<pos> on the stack. The
4724 value is stored in a new mortal SV.
4726 void XST_mIV(int pos, IV iv)
4729 Found in file XSUB.h
4733 Place C<&PL_sv_no> into the specified position C<pos> on the
4736 void XST_mNO(int pos)
4739 Found in file XSUB.h
4743 Place a double into the specified position C<pos> on the stack. The value
4744 is stored in a new mortal SV.
4746 void XST_mNV(int pos, NV nv)
4749 Found in file XSUB.h
4753 Place a copy of a string into the specified position C<pos> on the stack.
4754 The value is stored in a new mortal SV.
4756 void XST_mPV(int pos, char* str)
4759 Found in file XSUB.h
4763 Place C<&PL_sv_undef> into the specified position C<pos> on the
4766 void XST_mUNDEF(int pos)
4769 Found in file XSUB.h
4773 Place C<&PL_sv_yes> into the specified position C<pos> on the
4776 void XST_mYES(int pos)
4779 Found in file XSUB.h
4783 The version identifier for an XS module. This is usually
4784 handled automatically by C<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>.
4787 Found in file XSUB.h
4789 =item XS_VERSION_BOOTCHECK
4791 Macro to verify that a PM module's $VERSION variable matches the XS
4792 module's C<XS_VERSION> variable. This is usually handled automatically by
4793 C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">.
4795 XS_VERSION_BOOTCHECK;
4798 Found in file XSUB.h
4802 The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the
4803 destination, C<nitems> is the number of items, and C<type> is the type.
4805 void Zero(void* dest, int nitems, type)
4808 Found in file handy.h
4814 Until May 1997, this document was maintained by Jeff Okamoto
4815 <okamoto@corp.hp.com>. It is now maintained as part of Perl itself.
4817 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
4818 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
4819 Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
4820 Stephen McCamant, and Gurusamy Sarathy.
4822 API Listing originally by Dean Roehrich <roehrich@cray.com>.
4824 Updated to be autogenerated from comments in the source by Benjamin Stuhl.
4828 perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
projects / p5sagit/p5-mst-13.2.git / blob