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.
27 A backward-compatible version of C<GIMME_V> which can only return
28 C<G_SCALAR> or C<G_ARRAY>; in a void context, it returns C<G_SCALAR>.
29 Deprecated. Use C<GIMME_V> instead.
38 The XSUB-writer's equivalent to Perl's C<wantarray>. Returns C<G_VOID>,
39 C<G_SCALAR> or C<G_ARRAY> for void, scalar or list context,
49 Used to indicate list context. See C<GIMME_V>, C<GIMME> and
57 Indicates that arguments returned from a callback should be discarded. See
65 Used to force a Perl C<eval> wrapper around a callback. See
73 Indicates that no arguments are being sent to a callback. See
81 Used to indicate scalar context. See C<GIMME_V>, C<GIMME>, and
89 Used to indicate void context. See C<GIMME_V> and L<perlcall>.
97 =head1 Array Manipulation Functions
103 Same as C<av_len()>. Deprecated, use C<av_len()> instead.
112 Clears an array, making it empty. Does not free the memory used by the
115 void av_clear(AV* ar)
122 Deletes the element indexed by C<key> from the array. Returns the
123 deleted element. If C<flags> equals C<G_DISCARD>, the element is freed
124 and null is returned.
126 SV* av_delete(AV* ar, I32 key, I32 flags)
133 Returns true if the element indexed by C<key> has been initialized.
135 This relies on the fact that uninitialized array elements are set to
138 bool av_exists(AV* ar, I32 key)
145 Pre-extend an array. The C<key> is the index to which the array should be
148 void av_extend(AV* ar, I32 key)
155 Returns the SV at the specified index in the array. The C<key> is the
156 index. If C<lval> is set then the fetch will be part of a store. Check
157 that the return value is non-null before dereferencing it to a C<SV*>.
159 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for
160 more information on how to use this function on tied arrays.
162 SV** av_fetch(AV* ar, I32 key, I32 lval)
169 Ensure than an array has a given number of elements, equivalent to
170 Perl's C<$#array = $fill;>.
172 void av_fill(AV* ar, I32 fill)
179 Returns the highest index in the array. Returns -1 if the array is
189 Creates a new AV and populates it with a list of SVs. The SVs are copied
190 into the array, so they may be freed after the call to av_make. The new AV
191 will have a reference count of 1.
193 AV* av_make(I32 size, SV** svp)
200 Pops an SV off the end of the array. Returns C<&PL_sv_undef> if the array
210 Pushes an SV onto the end of the array. The array will grow automatically
211 to accommodate the addition.
213 void av_push(AV* ar, SV* val)
220 Shifts an SV off the beginning of the array.
229 Stores an SV in an array. The array index is specified as C<key>. The
230 return value will be NULL if the operation failed or if the value did not
231 need to be actually stored within the array (as in the case of tied
232 arrays). Otherwise it can be dereferenced to get the original C<SV*>. Note
233 that the caller is responsible for suitably incrementing the reference
234 count of C<val> before the call, and decrementing it if the function
237 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for
238 more information on how to use this function on tied arrays.
240 SV** av_store(AV* ar, I32 key, SV* val)
247 Undefines the array. Frees the memory used by the array itself.
249 void av_undef(AV* ar)
256 Unshift the given number of C<undef> values onto the beginning of the
257 array. The array will grow automatically to accommodate the addition. You
258 must then use C<av_store> to assign values to these new elements.
260 void av_unshift(AV* ar, I32 num)
267 Returns the AV of the specified Perl array. If C<create> is set and the
268 Perl variable does not exist then it will be created. If C<create> is not
269 set and the variable does not exist then NULL is returned.
271 NOTE: the perl_ form of this function is deprecated.
273 AV* get_av(const char* name, I32 create)
280 Creates a new AV. The reference count is set to 1.
297 Sort an array. Here is an example:
299 sortsv(AvARRAY(av), av_len(av)+1, Perl_sv_cmp_locale);
301 See lib/sort.pm for details about controlling the sorting algorithm.
303 void sortsv(SV ** array, size_t num_elts, SVCOMPARE_t cmp)
306 Found in file pp_sort.c
311 =head1 Callback Functions
317 Performs a callback to the specified Perl sub. See L<perlcall>.
319 NOTE: the perl_ form of this function is deprecated.
321 I32 call_argv(const char* sub_name, I32 flags, char** argv)
328 Performs a callback to the specified Perl method. The blessed object must
329 be on the stack. See L<perlcall>.
331 NOTE: the perl_ form of this function is deprecated.
333 I32 call_method(const char* methname, I32 flags)
340 Performs a callback to the specified Perl sub. See L<perlcall>.
342 NOTE: the perl_ form of this function is deprecated.
344 I32 call_pv(const char* sub_name, I32 flags)
351 Performs a callback to the Perl sub whose name is in the SV. See
354 NOTE: the perl_ form of this function is deprecated.
356 I32 call_sv(SV* sv, I32 flags)
363 Opening bracket on a callback. See C<LEAVE> and L<perlcall>.
368 Found in file scope.h
372 Tells Perl to C<eval> the given string and return an SV* result.
374 NOTE: the perl_ form of this function is deprecated.
376 SV* eval_pv(const char* p, I32 croak_on_error)
383 Tells Perl to C<eval> the string in the SV.
385 NOTE: the perl_ form of this function is deprecated.
387 I32 eval_sv(SV* sv, I32 flags)
394 Closing bracket for temporaries on a callback. See C<SAVETMPS> and
400 Found in file scope.h
404 Closing bracket on a callback. See C<ENTER> and L<perlcall>.
409 Found in file scope.h
413 Opening bracket for temporaries on a callback. See C<FREETMPS> and
419 Found in file scope.h
424 =head1 Character classes
430 Returns a boolean indicating whether the C C<char> is an ASCII alphanumeric
431 character (including underscore) or digit.
433 bool isALNUM(char ch)
436 Found in file handy.h
440 Returns a boolean indicating whether the C C<char> is an ASCII alphabetic
443 bool isALPHA(char ch)
446 Found in file handy.h
450 Returns a boolean indicating whether the C C<char> is an ASCII
453 bool isDIGIT(char ch)
456 Found in file handy.h
460 Returns a boolean indicating whether the C C<char> is a lowercase
463 bool isLOWER(char ch)
466 Found in file handy.h
470 Returns a boolean indicating whether the C C<char> is whitespace.
472 bool isSPACE(char ch)
475 Found in file handy.h
479 Returns a boolean indicating whether the C C<char> is an uppercase
482 bool isUPPER(char ch)
485 Found in file handy.h
489 Converts the specified character to lowercase.
491 char toLOWER(char ch)
494 Found in file handy.h
498 Converts the specified character to uppercase.
500 char toUPPER(char ch)
503 Found in file handy.h
508 =head1 Cloning an interpreter
514 Create and return a new interpreter by cloning the current one.
516 perl_clone takes these flags as parameters:
518 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
519 without it we only clone the data and zero the stacks,
520 with it we copy the stacks and the new perl interpreter is
521 ready to run at the exact same point as the previous one.
522 The pseudo-fork code uses COPY_STACKS while the
523 threads->new doesn't.
525 CLONEf_KEEP_PTR_TABLE
526 perl_clone keeps a ptr_table with the pointer of the old
527 variable as a key and the new variable as a value,
528 this allows it to check if something has been cloned and not
529 clone it again but rather just use the value and increase the
530 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
531 the ptr_table using the function
532 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
533 reason to keep it around is if you want to dup some of your own
534 variable who are outside the graph perl scans, example of this
535 code is in threads.xs create
538 This is a win32 thing, it is ignored on unix, it tells perls
539 win32host code (which is c++) to clone itself, this is needed on
540 win32 if you want to run two threads at the same time,
541 if you just want to do some stuff in a separate perl interpreter
542 and then throw it away and return to the original one,
543 you don't need to do anything.
545 PerlInterpreter* perl_clone(PerlInterpreter* interp, UV flags)
553 =head1 CV Manipulation Functions
559 Returns the stash of the CV.
568 Returns the CV of the specified Perl subroutine. If C<create> is set and
569 the Perl subroutine does not exist then it will be declared (which has the
570 same effect as saying C<sub name;>). If C<create> is not set and the
571 subroutine does not exist then NULL is returned.
573 NOTE: the perl_ form of this function is deprecated.
575 CV* get_cv(const char* name, I32 create)
591 =head1 Embedding Functions
597 Clear out all the active components of a CV. This can happen either
598 by an explicit C<undef &foo>, or by the reference count going to zero.
599 In the former case, we keep the CvOUTSIDE pointer, so that any anonymous
600 children can still follow the full lexical scope chain.
602 void cv_undef(CV* cv)
609 Loads the module whose name is pointed to by the string part of name.
610 Note that the actual module name, not its filename, should be given.
611 Eg, "Foo::Bar" instead of "Foo/Bar.pm". flags can be any of
612 PERL_LOADMOD_DENY, PERL_LOADMOD_NOIMPORT, or PERL_LOADMOD_IMPORT_OPS
613 (or 0 for no flags). ver, if specified, provides version semantics
614 similar to C<use Foo::Bar VERSION>. The optional trailing SV*
615 arguments can be used to specify arguments to the module's import()
616 method, similar to C<use Foo::Bar VERSION LIST>.
618 void load_module(U32 flags, SV* name, SV* ver, ...)
625 Stub that provides thread hook for perl_destruct when there are
635 Allocates a new Perl interpreter. See L<perlembed>.
637 PerlInterpreter* perl_alloc()
644 Initializes a new Perl interpreter. See L<perlembed>.
646 void perl_construct(PerlInterpreter* interp)
653 Shuts down a Perl interpreter. See L<perlembed>.
655 int perl_destruct(PerlInterpreter* interp)
662 Releases a Perl interpreter. See L<perlembed>.
664 void perl_free(PerlInterpreter* interp)
671 Tells a Perl interpreter to parse a Perl script. See L<perlembed>.
673 int perl_parse(PerlInterpreter* interp, XSINIT_t xsinit, int argc, char** argv, char** env)
680 Tells a Perl interpreter to run. See L<perlembed>.
682 int perl_run(PerlInterpreter* interp)
689 Tells Perl to C<require> the file named by the string argument. It is
690 analogous to the Perl code C<eval "require '$file'">. It's even
691 implemented that way; consider using load_module instead.
693 NOTE: the perl_ form of this function is deprecated.
695 void require_pv(const char* pv)
703 =head1 Functions in file pp_pack.c
710 The engine implementing pack() Perl function.
712 void packlist(SV *cat, char *pat, char *patend, SV **beglist, SV **endlist)
715 Found in file pp_pack.c
719 The engine implementing pack() Perl function. Note: parameters next_in_list and
720 flags are not used. This call should not be used; use packlist instead.
722 void pack_cat(SV *cat, char *pat, char *patend, SV **beglist, SV **endlist, SV ***next_in_list, U32 flags)
725 Found in file pp_pack.c
729 The engine implementing unpack() Perl function. C<unpackstring> puts the
730 extracted list items on the stack and returns the number of elements.
731 Issue C<PUTBACK> before and C<SPAGAIN> after the call to this function.
733 I32 unpackstring(char *pat, char *patend, char *s, char *strend, U32 flags)
736 Found in file pp_pack.c
740 The engine implementing unpack() Perl function. Note: parameters strbeg, new_s
741 and ocnt are not used. This call should not be used, use unpackstring instead.
743 I32 unpack_str(char *pat, char *patend, char *s, char *strbeg, char *strend, char **new_s, I32 ocnt, U32 flags)
746 Found in file pp_pack.c
751 =head1 Global Variables
757 C<PL_modglobal> is a general purpose, interpreter global HV for use by
758 extensions that need to keep information on a per-interpreter basis.
759 In a pinch, it can also be used as a symbol table for extensions
760 to share data among each other. It is a good idea to use keys
761 prefixed by the package name of the extension that owns the data.
766 Found in file intrpvar.h
770 A convenience variable which is typically used with C<SvPV> when one
771 doesn't care about the length of the string. It is usually more efficient
772 to either declare a local variable and use that instead or to use the
778 Found in file thrdvar.h
782 This is the C<false> SV. See C<PL_sv_yes>. Always refer to this as
788 Found in file intrpvar.h
792 This is the C<undef> SV. Always refer to this as C<&PL_sv_undef>.
797 Found in file intrpvar.h
801 This is the C<true> SV. See C<PL_sv_no>. Always refer to this as
807 Found in file intrpvar.h
818 Return the SV from the GV.
827 Returns the glob with the given C<name> and a defined subroutine or
828 C<NULL>. The glob lives in the given C<stash>, or in the stashes
829 accessible via @ISA and UNIVERSAL::.
831 The argument C<level> should be either 0 or -1. If C<level==0>, as a
832 side-effect creates a glob with the given C<name> in the given C<stash>
833 which in the case of success contains an alias for the subroutine, and sets
834 up caching info for this glob. Similarly for all the searched stashes.
836 This function grants C<"SUPER"> token as a postfix of the stash name. The
837 GV returned from C<gv_fetchmeth> may be a method cache entry, which is not
838 visible to Perl code. So when calling C<call_sv>, you should not use
839 the GV directly; instead, you should use the method's CV, which can be
840 obtained from the GV with the C<GvCV> macro.
842 GV* gv_fetchmeth(HV* stash, const char* name, STRLEN len, I32 level)
849 See L<gv_fetchmethod_autoload>.
851 GV* gv_fetchmethod(HV* stash, const char* name)
856 =item gv_fetchmethod_autoload
858 Returns the glob which contains the subroutine to call to invoke the method
859 on the C<stash>. In fact in the presence of autoloading this may be the
860 glob for "AUTOLOAD". In this case the corresponding variable $AUTOLOAD is
863 The third parameter of C<gv_fetchmethod_autoload> determines whether
864 AUTOLOAD lookup is performed if the given method is not present: non-zero
865 means yes, look for AUTOLOAD; zero means no, don't look for AUTOLOAD.
866 Calling C<gv_fetchmethod> is equivalent to calling C<gv_fetchmethod_autoload>
867 with a non-zero C<autoload> parameter.
869 These functions grant C<"SUPER"> token as a prefix of the method name. Note
870 that if you want to keep the returned glob for a long time, you need to
871 check for it being "AUTOLOAD", since at the later time the call may load a
872 different subroutine due to $AUTOLOAD changing its value. Use the glob
873 created via a side effect to do this.
875 These functions have the same side-effects and as C<gv_fetchmeth> with
876 C<level==0>. C<name> should be writable if contains C<':'> or C<'
877 ''>. The warning against passing the GV returned by C<gv_fetchmeth> to
878 C<call_sv> apply equally to these functions.
880 GV* gv_fetchmethod_autoload(HV* stash, const char* name, I32 autoload)
885 =item gv_fetchmeth_autoload
887 Same as gv_fetchmeth(), but looks for autoloaded subroutines too.
888 Returns a glob for the subroutine.
890 For an autoloaded subroutine without a GV, will create a GV even
891 if C<level < 0>. For an autoloaded subroutine without a stub, GvCV()
892 of the result may be zero.
894 GV* gv_fetchmeth_autoload(HV* stash, const char* name, STRLEN len, I32 level)
901 Returns a pointer to the stash for a specified package. C<name> should
902 be a valid UTF-8 string. If C<create> is set then the package will be
903 created if it does not already exist. If C<create> is not set and the
904 package does not exist then NULL is returned.
906 HV* gv_stashpv(const char* name, I32 create)
913 Returns a pointer to the stash for a specified package, which must be a
914 valid UTF-8 string. See C<gv_stashpv>.
916 HV* gv_stashsv(SV* sv, I32 create)
930 This flag, used in the length slot of hash entries and magic structures,
931 specifies the structure contains an C<SV*> pointer where a C<char*> pointer
932 is to be expected. (For information only--not to be used).
940 Null character pointer.
943 Found in file handy.h
950 Found in file handy.h
955 =head1 Hash Manipulation Functions
961 Returns the HV of the specified Perl hash. If C<create> is set and the
962 Perl variable does not exist then it will be created. If C<create> is not
963 set and the variable does not exist then NULL is returned.
965 NOTE: the perl_ form of this function is deprecated.
967 HV* get_hv(const char* name, I32 create)
974 Returns the computed hash stored in the hash entry.
983 Returns the actual pointer stored in the key slot of the hash entry. The
984 pointer may be either C<char*> or C<SV*>, depending on the value of
985 C<HeKLEN()>. Can be assigned to. The C<HePV()> or C<HeSVKEY()> macros are
986 usually preferable for finding the value of a key.
995 If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry
996 holds an C<SV*> key. Otherwise, holds the actual length of the key. Can
997 be assigned to. The C<HePV()> macro is usually preferable for finding key
1000 STRLEN HeKLEN(HE* he)
1007 Returns the key slot of the hash entry as a C<char*> value, doing any
1008 necessary dereferencing of possibly C<SV*> keys. The length of the string
1009 is placed in C<len> (this is a macro, so do I<not> use C<&len>). If you do
1010 not care about what the length of the key is, you may use the global
1011 variable C<PL_na>, though this is rather less efficient than using a local
1012 variable. Remember though, that hash keys in perl are free to contain
1013 embedded nulls, so using C<strlen()> or similar is not a good way to find
1014 the length of hash keys. This is very similar to the C<SvPV()> macro
1015 described elsewhere in this document.
1017 char* HePV(HE* he, STRLEN len)
1024 Returns the key as an C<SV*>, or C<Nullsv> if the hash entry does not
1025 contain an C<SV*> key.
1034 Returns the key as an C<SV*>. Will create and return a temporary mortal
1035 C<SV*> if the hash entry contains only a C<char*> key.
1037 SV* HeSVKEY_force(HE* he)
1044 Sets the key to a given C<SV*>, taking care to set the appropriate flags to
1045 indicate the presence of an C<SV*> key, and returns the same
1048 SV* HeSVKEY_set(HE* he, SV* sv)
1055 Returns the value slot (type C<SV*>) stored in the hash entry.
1064 Returns the package name of a stash. See C<SvSTASH>, C<CvSTASH>.
1066 char* HvNAME(HV* stash)
1073 Check that a hash is in an internally consistent state.
1075 void hv_assert(HV* tb)
1082 Clears a hash, making it empty.
1084 void hv_clear(HV* tb)
1089 =item hv_clear_placeholders
1091 Clears any placeholders from a hash. If a restricted hash has any of its keys
1092 marked as readonly and the key is subsequently deleted, the key is not actually
1093 deleted but is marked by assigning it a value of &PL_sv_placeholder. This tags
1094 it so it will be ignored by future operations such as iterating over the hash,
1095 but will still allow the hash to have a value reaasigned to the key at some
1096 future point. This function clears any such placeholder keys from the hash.
1097 See Hash::Util::lock_keys() for an example of its use.
1099 void hv_clear_placeholders(HV* hb)
1106 Deletes a key/value pair in the hash. The value SV is removed from the
1107 hash and returned to the caller. The C<klen> is the length of the key.
1108 The C<flags> value will normally be zero; if set to G_DISCARD then NULL
1111 SV* hv_delete(HV* tb, const char* key, I32 klen, I32 flags)
1118 Deletes a key/value pair in the hash. The value SV is removed from the
1119 hash and returned to the caller. The C<flags> value will normally be zero;
1120 if set to G_DISCARD then NULL will be returned. C<hash> can be a valid
1121 precomputed hash value, or 0 to ask for it to be computed.
1123 SV* hv_delete_ent(HV* tb, SV* key, I32 flags, U32 hash)
1130 Returns a boolean indicating whether the specified hash key exists. The
1131 C<klen> is the length of the key.
1133 bool hv_exists(HV* tb, const char* key, I32 klen)
1140 Returns a boolean indicating whether the specified hash key exists. C<hash>
1141 can be a valid precomputed hash value, or 0 to ask for it to be
1144 bool hv_exists_ent(HV* tb, SV* key, U32 hash)
1151 Returns the SV which corresponds to the specified key in the hash. The
1152 C<klen> is the length of the key. If C<lval> is set then the fetch will be
1153 part of a store. Check that the return value is non-null before
1154 dereferencing it to an C<SV*>.
1156 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1157 information on how to use this function on tied hashes.
1159 SV** hv_fetch(HV* tb, const char* key, I32 klen, I32 lval)
1166 Returns the hash entry which corresponds to the specified key in the hash.
1167 C<hash> must be a valid precomputed hash number for the given C<key>, or 0
1168 if you want the function to compute it. IF C<lval> is set then the fetch
1169 will be part of a store. Make sure the return value is non-null before
1170 accessing it. The return value when C<tb> is a tied hash is a pointer to a
1171 static location, so be sure to make a copy of the structure if you need to
1174 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1175 information on how to use this function on tied hashes.
1177 HE* hv_fetch_ent(HV* tb, SV* key, I32 lval, U32 hash)
1184 Prepares a starting point to traverse a hash table. Returns the number of
1185 keys in the hash (i.e. the same as C<HvKEYS(tb)>). The return value is
1186 currently only meaningful for hashes without tie magic.
1188 NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
1189 hash buckets that happen to be in use. If you still need that esoteric
1190 value, you can get it through the macro C<HvFILL(tb)>.
1193 I32 hv_iterinit(HV* tb)
1200 Returns the key from the current position of the hash iterator. See
1203 char* hv_iterkey(HE* entry, I32* retlen)
1210 Returns the key as an C<SV*> from the current position of the hash
1211 iterator. The return value will always be a mortal copy of the key. Also
1214 SV* hv_iterkeysv(HE* entry)
1221 Returns entries from a hash iterator. See C<hv_iterinit>.
1223 You may call C<hv_delete> or C<hv_delete_ent> on the hash entry that the
1224 iterator currently points to, without losing your place or invalidating your
1225 iterator. Note that in this case the current entry is deleted from the hash
1226 with your iterator holding the last reference to it. Your iterator is flagged
1227 to free the entry on the next call to C<hv_iternext>, so you must not discard
1228 your iterator immediately else the entry will leak - call C<hv_iternext> to
1229 trigger the resource deallocation.
1231 HE* hv_iternext(HV* tb)
1238 Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
1241 SV* hv_iternextsv(HV* hv, char** key, I32* retlen)
1246 =item hv_iternext_flags
1248 Returns entries from a hash iterator. See C<hv_iterinit> and C<hv_iternext>.
1249 The C<flags> value will normally be zero; if HV_ITERNEXT_WANTPLACEHOLDERS is
1250 set the placeholders keys (for restricted hashes) will be returned in addition
1251 to normal keys. By default placeholders are automatically skipped over.
1252 Currently a placeholder is implemented with a value that is
1253 C<&Perl_sv_placeholder>. Note that the implementation of placeholders and
1254 restricted hashes may change, and the implementation currently is
1255 insufficiently abstracted for any change to be tidy.
1257 NOTE: this function is experimental and may change or be
1258 removed without notice.
1260 HE* hv_iternext_flags(HV* tb, I32 flags)
1267 Returns the value from the current position of the hash iterator. See
1270 SV* hv_iterval(HV* tb, HE* entry)
1277 Adds magic to a hash. See C<sv_magic>.
1279 void hv_magic(HV* hv, GV* gv, int how)
1286 Evaluates the hash in scalar context and returns the result. Handles magic when the hash is tied.
1288 SV* hv_scalar(HV* hv)
1295 Stores an SV in a hash. The hash key is specified as C<key> and C<klen> is
1296 the length of the key. The C<hash> parameter is the precomputed hash
1297 value; if it is zero then Perl will compute it. The return value will be
1298 NULL if the operation failed or if the value did not need to be actually
1299 stored within the hash (as in the case of tied hashes). Otherwise it can
1300 be dereferenced to get the original C<SV*>. Note that the caller is
1301 responsible for suitably incrementing the reference count of C<val> before
1302 the call, and decrementing it if the function returned NULL. Effectively
1303 a successful hv_store takes ownership of one reference to C<val>. This is
1304 usually what you want; a newly created SV has a reference count of one, so
1305 if all your code does is create SVs then store them in a hash, hv_store
1306 will own the only reference to the new SV, and your code doesn't need to do
1307 anything further to tidy up. hv_store is not implemented as a call to
1308 hv_store_ent, and does not create a temporary SV for the key, so if your
1309 key data is not already in SV form then use hv_store in preference to
1312 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1313 information on how to use this function on tied hashes.
1315 SV** hv_store(HV* tb, const char* key, I32 klen, SV* val, U32 hash)
1322 Stores C<val> in a hash. The hash key is specified as C<key>. The C<hash>
1323 parameter is the precomputed hash value; if it is zero then Perl will
1324 compute it. The return value is the new hash entry so created. It will be
1325 NULL if the operation failed or if the value did not need to be actually
1326 stored within the hash (as in the case of tied hashes). Otherwise the
1327 contents of the return value can be accessed using the C<He?> macros
1328 described here. Note that the caller is responsible for suitably
1329 incrementing the reference count of C<val> before the call, and
1330 decrementing it if the function returned NULL. Effectively a successful
1331 hv_store_ent takes ownership of one reference to C<val>. This is
1332 usually what you want; a newly created SV has a reference count of one, so
1333 if all your code does is create SVs then store them in a hash, hv_store
1334 will own the only reference to the new SV, and your code doesn't need to do
1335 anything further to tidy up. Note that hv_store_ent only reads the C<key>;
1336 unlike C<val> it does not take ownership of it, so maintaining the correct
1337 reference count on C<key> is entirely the caller's responsibility. hv_store
1338 is not implemented as a call to hv_store_ent, and does not create a temporary
1339 SV for the key, so if your key data is not already in SV form then use
1340 hv_store in preference to hv_store_ent.
1342 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1343 information on how to use this function on tied hashes.
1345 HE* hv_store_ent(HV* tb, SV* key, SV* val, U32 hash)
1354 void hv_undef(HV* tb)
1361 Creates a new HV. The reference count is set to 1.
1379 =head1 Magical Functions
1385 Clear something magical that the SV represents. See C<sv_magic>.
1387 int mg_clear(SV* sv)
1394 Copies the magic from one SV to another. See C<sv_magic>.
1396 int mg_copy(SV* sv, SV* nsv, const char* key, I32 klen)
1403 Finds the magic pointer for type matching the SV. See C<sv_magic>.
1405 MAGIC* mg_find(SV* sv, int type)
1412 Free any magic storage used by the SV. See C<sv_magic>.
1421 Do magic after a value is retrieved from the SV. See C<sv_magic>.
1430 Report on the SV's length. See C<sv_magic>.
1432 U32 mg_length(SV* sv)
1439 Turns on the magical status of an SV. See C<sv_magic>.
1441 void mg_magical(SV* sv)
1448 Do magic after a value is assigned to the SV. See C<sv_magic>.
1457 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
1458 argument more than once.
1460 void SvGETMAGIC(SV* sv)
1467 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
1477 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
1478 argument more than once.
1480 void SvSETMAGIC(SV* sv)
1487 Like C<SvSetSV>, but does any set magic required afterwards.
1489 void SvSetMagicSV(SV* dsb, SV* ssv)
1494 =item SvSetMagicSV_nosteal
1496 Like C<SvSetMagicSV>, but does any set magic required afterwards.
1498 void SvSetMagicSV_nosteal(SV* dsv, SV* ssv)
1505 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
1508 void SvSetSV(SV* dsb, SV* ssv)
1513 =item SvSetSV_nosteal
1515 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
1516 ssv. May evaluate arguments more than once.
1518 void SvSetSV_nosteal(SV* dsv, SV* ssv)
1525 Arranges for sv to be shared between threads if a suitable module
1528 void SvSHARE(SV* sv)
1536 =head1 Memory Management
1542 The XSUB-writer's interface to the C C<memcpy> function. The C<src> is the
1543 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1544 the type. May fail on overlapping copies. See also C<Move>.
1546 void Copy(void* src, void* dest, int nitems, type)
1549 Found in file handy.h
1553 The XSUB-writer's interface to the C C<memmove> function. The C<src> is the
1554 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1555 the type. Can do overlapping moves. See also C<Copy>.
1557 void Move(void* src, void* dest, int nitems, type)
1560 Found in file handy.h
1564 The XSUB-writer's interface to the C C<malloc> function.
1566 void New(int id, void* ptr, int nitems, type)
1569 Found in file handy.h
1573 The XSUB-writer's interface to the C C<malloc> function, with
1576 void Newc(int id, void* ptr, int nitems, type, cast)
1579 Found in file handy.h
1583 Creates a new SV. A non-zero C<len> parameter indicates the number of
1584 bytes of preallocated string space the SV should have. An extra byte for a
1585 tailing NUL is also reserved. (SvPOK is not set for the SV even if string
1586 space is allocated.) The reference count for the new SV is set to 1.
1587 C<id> is an integer id between 0 and 1299 (used to identify leaks).
1590 SV* NEWSV(int id, STRLEN len)
1593 Found in file handy.h
1597 The XSUB-writer's interface to the C C<malloc> function. The allocated
1598 memory is zeroed with C<memzero>.
1600 void Newz(int id, void* ptr, int nitems, type)
1603 Found in file handy.h
1607 Fill up memory with a pattern (byte 0xAB over and over again) that
1608 hopefully catches attempts to access uninitialized memory.
1610 void Poison(void* dest, int nitems, type)
1613 Found in file handy.h
1617 The XSUB-writer's interface to the C C<realloc> function.
1619 void Renew(void* ptr, int nitems, type)
1622 Found in file handy.h
1626 The XSUB-writer's interface to the C C<realloc> function, with
1629 void Renewc(void* ptr, int nitems, type, cast)
1632 Found in file handy.h
1636 The XSUB-writer's interface to the C C<free> function.
1638 void Safefree(void* ptr)
1641 Found in file handy.h
1645 Perl's version of C<strdup()>. Returns a pointer to a newly allocated
1646 string which is a duplicate of C<pv>. The size of the string is
1647 determined by C<strlen()>. The memory allocated for the new string can
1648 be freed with the C<Safefree()> function.
1650 char* savepv(const char* pv)
1653 Found in file util.c
1657 Perl's version of what C<strndup()> would be if it existed. Returns a
1658 pointer to a newly allocated string which is a duplicate of the first
1659 C<len> bytes from C<pv>. The memory allocated for the new string can be
1660 freed with the C<Safefree()> function.
1662 char* savepvn(const char* pv, I32 len)
1665 Found in file util.c
1669 A version of C<savepv()> which allocates the duplicate string in memory
1670 which is shared between threads.
1672 char* savesharedpv(const char* pv)
1675 Found in file util.c
1679 This is an architecture-independent macro to copy one structure to another.
1681 void StructCopy(type src, type dest, type)
1684 Found in file handy.h
1688 The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the
1689 destination, C<nitems> is the number of items, and C<type> is the type.
1691 void Zero(void* dest, int nitems, type)
1694 Found in file handy.h
1699 =head1 Miscellaneous Functions
1705 Analyses the string in order to make fast searches on it using fbm_instr()
1706 -- the Boyer-Moore algorithm.
1708 void fbm_compile(SV* sv, U32 flags)
1711 Found in file util.c
1715 Returns the location of the SV in the string delimited by C<str> and
1716 C<strend>. It returns C<Nullch> if the string can't be found. The C<sv>
1717 does not have to be fbm_compiled, but the search will not be as fast
1720 char* fbm_instr(unsigned char* big, unsigned char* bigend, SV* littlesv, U32 flags)
1723 Found in file util.c
1727 Takes a sprintf-style format pattern and conventional
1728 (non-SV) arguments and returns the formatted string.
1730 (char *) Perl_form(pTHX_ const char* pat, ...)
1732 can be used any place a string (char *) is required:
1734 char * s = Perl_form("%d.%d",major,minor);
1736 Uses a single private buffer so if you want to format several strings you
1737 must explicitly copy the earlier strings away (and free the copies when you
1740 char* form(const char* pat, ...)
1743 Found in file util.c
1747 Fill the sv with current working directory
1749 int getcwd_sv(SV* sv)
1752 Found in file util.c
1756 Returns a new version object based on the passed in SV:
1758 SV *sv = new_version(SV *ver);
1760 Does not alter the passed in ver SV. See "upg_version" if you
1761 want to upgrade the SV.
1763 SV* new_version(SV *ver)
1766 Found in file util.c
1770 Returns a pointer to the next character after the parsed
1771 version string, as well as upgrading the passed in SV to
1774 Function must be called with an already existing SV like
1777 s = scan_version(s,SV *sv, bool qv);
1779 Performs some preprocessing to the string to ensure that
1780 it has the correct characteristics of a version. Flags the
1781 object if it contains an underscore (which denotes this
1782 is a alpha version). The boolean qv denotes that the version
1783 should be interpreted as if it had multiple decimals, even if
1786 char* scan_version(char *vstr, SV *sv, bool qv)
1789 Found in file util.c
1793 Test two strings to see if they are equal. Returns true or false.
1795 bool strEQ(char* s1, char* s2)
1798 Found in file handy.h
1802 Test two strings to see if the first, C<s1>, is greater than or equal to
1803 the second, C<s2>. Returns true or false.
1805 bool strGE(char* s1, char* s2)
1808 Found in file handy.h
1812 Test two strings to see if the first, C<s1>, is greater than the second,
1813 C<s2>. Returns true or false.
1815 bool strGT(char* s1, char* s2)
1818 Found in file handy.h
1822 Test two strings to see if the first, C<s1>, is less than or equal to the
1823 second, C<s2>. Returns true or false.
1825 bool strLE(char* s1, char* s2)
1828 Found in file handy.h
1832 Test two strings to see if the first, C<s1>, is less than the second,
1833 C<s2>. Returns true or false.
1835 bool strLT(char* s1, char* s2)
1838 Found in file handy.h
1842 Test two strings to see if they are different. Returns true or
1845 bool strNE(char* s1, char* s2)
1848 Found in file handy.h
1852 Test two strings to see if they are equal. The C<len> parameter indicates
1853 the number of bytes to compare. Returns true or false. (A wrapper for
1856 bool strnEQ(char* s1, char* s2, STRLEN len)
1859 Found in file handy.h
1863 Test two strings to see if they are different. The C<len> parameter
1864 indicates the number of bytes to compare. Returns true or false. (A
1865 wrapper for C<strncmp>).
1867 bool strnNE(char* s1, char* s2, STRLEN len)
1870 Found in file handy.h
1874 Dummy routine which "locks" an SV when there is no locking module present.
1875 Exists to avoid test for a NULL function pointer and because it could potentially warn under
1876 some level of strict-ness.
1878 void sv_nolocking(SV *)
1881 Found in file util.c
1885 Dummy routine which "shares" an SV when there is no sharing module present.
1886 Exists to avoid test for a NULL function pointer and because it could potentially warn under
1887 some level of strict-ness.
1889 void sv_nosharing(SV *)
1892 Found in file util.c
1894 =item sv_nounlocking
1896 Dummy routine which "unlocks" an SV when there is no locking module present.
1897 Exists to avoid test for a NULL function pointer and because it could potentially warn under
1898 some level of strict-ness.
1900 void sv_nounlocking(SV *)
1903 Found in file util.c
1907 In-place upgrade of the supplied SV to a version object.
1909 SV *sv = upg_version(SV *sv);
1911 Returns a pointer to the upgraded SV.
1913 SV* upg_version(SV *ver)
1916 Found in file util.c
1920 Version object aware cmp. Both operands must already have been
1921 converted into version objects.
1923 int vcmp(SV *lvs, SV *rvs)
1926 Found in file util.c
1930 Accepts a version object and returns the normalized string
1931 representation. Call like:
1935 NOTE: you can pass either the object directly or the SV
1936 contained within the RV.
1941 Found in file util.c
1945 Accepts a version object and returns the normalized floating
1946 point representation. Call like:
1950 NOTE: you can pass either the object directly or the SV
1951 contained within the RV.
1956 Found in file util.c
1960 In order to maintain maximum compatibility with earlier versions
1961 of Perl, this function will return either the floating point
1962 notation or the multiple dotted notation, depending on whether
1963 the original version contained 1 or more dots, respectively
1965 SV* vstringify(SV *vs)
1968 Found in file util.c
1973 =head1 Numeric functions
1979 converts a string representing a binary number to numeric form.
1981 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
1982 conversion flags, and I<result> should be NULL or a pointer to an NV.
1983 The scan stops at the end of the string, or the first invalid character.
1984 On return I<*len> is set to the length scanned string, and I<*flags> gives
1987 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
1988 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_bin>
1989 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
1990 and writes the value to I<*result> (or the value is discarded if I<result>
1993 The hex number may optionally be prefixed with "0b" or "b" unless
1994 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
1995 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the binary
1996 number may use '_' characters to separate digits.
1998 UV grok_bin(char* start, STRLEN* len, I32* flags, NV *result)
2001 Found in file numeric.c
2005 converts a string representing a hex number to numeric form.
2007 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2008 conversion flags, and I<result> should be NULL or a pointer to an NV.
2009 The scan stops at the end of the string, or the first non-hex-digit character.
2010 On return I<*len> is set to the length scanned string, and I<*flags> gives
2013 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2014 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_hex>
2015 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2016 and writes the value to I<*result> (or the value is discarded if I<result>
2019 The hex number may optionally be prefixed with "0x" or "x" unless
2020 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
2021 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the hex
2022 number may use '_' characters to separate digits.
2024 UV grok_hex(char* start, STRLEN* len, I32* flags, NV *result)
2027 Found in file numeric.c
2031 Recognise (or not) a number. The type of the number is returned
2032 (0 if unrecognised), otherwise it is a bit-ORed combination of
2033 IS_NUMBER_IN_UV, IS_NUMBER_GREATER_THAN_UV_MAX, IS_NUMBER_NOT_INT,
2034 IS_NUMBER_NEG, IS_NUMBER_INFINITY, IS_NUMBER_NAN (defined in perl.h).
2036 If the value of the number can fit an in UV, it is returned in the *valuep
2037 IS_NUMBER_IN_UV will be set to indicate that *valuep is valid, IS_NUMBER_IN_UV
2038 will never be set unless *valuep is valid, but *valuep may have been assigned
2039 to during processing even though IS_NUMBER_IN_UV is not set on return.
2040 If valuep is NULL, IS_NUMBER_IN_UV will be set for the same cases as when
2041 valuep is non-NULL, but no actual assignment (or SEGV) will occur.
2043 IS_NUMBER_NOT_INT will be set with IS_NUMBER_IN_UV if trailing decimals were
2044 seen (in which case *valuep gives the true value truncated to an integer), and
2045 IS_NUMBER_NEG if the number is negative (in which case *valuep holds the
2046 absolute value). IS_NUMBER_IN_UV is not set if e notation was used or the
2047 number is larger than a UV.
2049 int grok_number(const char *pv, STRLEN len, UV *valuep)
2052 Found in file numeric.c
2054 =item grok_numeric_radix
2056 Scan and skip for a numeric decimal separator (radix).
2058 bool grok_numeric_radix(const char **sp, const char *send)
2061 Found in file numeric.c
2066 UV grok_oct(char* start, STRLEN* len, I32* flags, NV *result)
2069 Found in file numeric.c
2073 For backwards compatibility. Use C<grok_bin> instead.
2075 NV scan_bin(char* start, STRLEN len, STRLEN* retlen)
2078 Found in file numeric.c
2082 For backwards compatibility. Use C<grok_hex> instead.
2084 NV scan_hex(char* start, STRLEN len, STRLEN* retlen)
2087 Found in file numeric.c
2091 For backwards compatibility. Use C<grok_oct> instead.
2093 NV scan_oct(char* start, STRLEN len, STRLEN* retlen)
2096 Found in file numeric.c
2101 =head1 Optree Manipulation Functions
2107 If C<cv> is a constant sub eligible for inlining. returns the constant
2108 value returned by the sub. Otherwise, returns NULL.
2110 Constant subs can be created with C<newCONSTSUB> or as described in
2111 L<perlsub/"Constant Functions">.
2113 SV* cv_const_sv(CV* cv)
2120 Creates a constant sub equivalent to Perl C<sub FOO () { 123 }> which is
2121 eligible for inlining at compile-time.
2123 CV* newCONSTSUB(HV* stash, char* name, SV* sv)
2130 Used by C<xsubpp> to hook up XSUBs as Perl subs.
2138 =head1 Pad Data Structures
2144 Get the value at offset po in the current pad.
2145 Use macro PAD_SV instead of calling this function directly.
2147 SV* pad_sv(PADOFFSET po)
2155 =head1 Stack Manipulation Macros
2161 Declare a stack marker variable, C<mark>, for the XSUB. See C<MARK> and
2171 Saves the original stack mark for the XSUB. See C<ORIGMARK>.
2180 Declares a local copy of perl's stack pointer for the XSUB, available via
2181 the C<SP> macro. See C<SP>.
2190 Used to extend the argument stack for an XSUB's return values. Once
2191 used, guarantees that there is room for at least C<nitems> to be pushed
2194 void EXTEND(SP, int nitems)
2201 Stack marker variable for the XSUB. See C<dMARK>.
2208 Push an integer onto the stack. The stack must have room for this element.
2209 Does not handle 'set' magic. Does not use C<TARG>. See also C<PUSHi>,
2210 C<mXPUSHi> and C<XPUSHi>.
2219 Push a double onto the stack. The stack must have room for this element.
2220 Does not handle 'set' magic. Does not use C<TARG>. See also C<PUSHn>,
2221 C<mXPUSHn> and C<XPUSHn>.
2230 Push a string onto the stack. The stack must have room for this element.
2231 The C<len> indicates the length of the string. Does not handle 'set' magic.
2232 Does not use C<TARG>. See also C<PUSHp>, C<mXPUSHp> and C<XPUSHp>.
2234 void mPUSHp(char* str, STRLEN len)
2241 Push an unsigned integer onto the stack. The stack must have room for this
2242 element. Does not handle 'set' magic. Does not use C<TARG>. See also
2243 C<PUSHu>, C<mXPUSHu> and C<XPUSHu>.
2252 Push an integer onto the stack, extending the stack if necessary. Does not
2253 handle 'set' magic. Does not use C<TARG>. See also C<XPUSHi>, C<mPUSHi>
2263 Push a double onto the stack, extending the stack if necessary. Does not
2264 handle 'set' magic. Does not use C<TARG>. See also C<XPUSHn>, C<mPUSHn>
2274 Push a string onto the stack, extending the stack if necessary. The C<len>
2275 indicates the length of the string. Does not handle 'set' magic. Does not
2276 use C<TARG>. See also C<XPUSHp>, C<mPUSHp> and C<PUSHp>.
2278 void mXPUSHp(char* str, STRLEN len)
2285 Push an unsigned integer onto the stack, extending the stack if necessary.
2286 Does not handle 'set' magic. Does not use C<TARG>. See also C<XPUSHu>,
2287 C<mPUSHu> and C<PUSHu>.
2296 The original stack mark for the XSUB. See C<dORIGMARK>.
2303 Pops an integer off the stack.
2312 Pops a long off the stack.
2321 Pops a double off the stack.
2330 Pops a string off the stack. Deprecated. New code should provide
2331 a STRLEN n_a and use POPpx.
2340 Pops a string off the stack which must consist of bytes i.e. characters < 256.
2341 Requires a variable STRLEN n_a in scope.
2350 Pops a string off the stack.
2351 Requires a variable STRLEN n_a in scope.
2360 Pops an SV off the stack.
2369 Push an integer onto the stack. The stack must have room for this element.
2370 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
2371 called to declare it. Do not call multiple C<TARG>-oriented macros to
2372 return lists from XSUB's - see C<mPUSHi> instead. See also C<XPUSHi> and
2382 Opening bracket for arguments on a callback. See C<PUTBACK> and
2392 Push a new mortal SV onto the stack. The stack must have room for this
2393 element. Does not handle 'set' magic. Does not use C<TARG>. See also
2394 C<PUSHs>, C<XPUSHmortal> and C<XPUSHs>.
2403 Push a double onto the stack. The stack must have room for this element.
2404 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
2405 called to declare it. Do not call multiple C<TARG>-oriented macros to
2406 return lists from XSUB's - see C<mPUSHn> instead. See also C<XPUSHn> and
2416 Push a string onto the stack. The stack must have room for this element.
2417 The C<len> indicates the length of the string. Handles 'set' magic. Uses
2418 C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to declare it. Do not
2419 call multiple C<TARG>-oriented macros to return lists from XSUB's - see
2420 C<mPUSHp> instead. See also C<XPUSHp> and C<mXPUSHp>.
2422 void PUSHp(char* str, STRLEN len)
2429 Push an SV onto the stack. The stack must have room for this element.
2430 Does not handle 'set' magic. Does not use C<TARG>. See also C<PUSHmortal>,
2431 C<XPUSHs> and C<XPUSHmortal>.
2440 Push an unsigned integer onto the stack. The stack must have room for this
2441 element. Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG>
2442 should be called to declare it. Do not call multiple C<TARG>-oriented
2443 macros to return lists from XSUB's - see C<mPUSHu> instead. See also
2444 C<XPUSHu> and C<mXPUSHu>.
2453 Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
2454 See C<PUSHMARK> and L<perlcall> for other uses.
2463 Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and
2471 Refetch the stack pointer. Used after a callback. See L<perlcall>.
2480 Push an integer onto the stack, extending the stack if necessary. Handles
2481 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
2482 declare it. Do not call multiple C<TARG>-oriented macros to return lists
2483 from XSUB's - see C<mXPUSHi> instead. See also C<PUSHi> and C<mPUSHi>.
2492 Push a new mortal SV onto the stack, extending the stack if necessary. Does
2493 not handle 'set' magic. Does not use C<TARG>. See also C<XPUSHs>,
2494 C<PUSHmortal> and C<PUSHs>.
2503 Push a double onto the stack, extending the stack if necessary. Handles
2504 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
2505 declare it. Do not call multiple C<TARG>-oriented macros to return lists
2506 from XSUB's - see C<mXPUSHn> instead. See also C<PUSHn> and C<mPUSHn>.
2515 Push a string onto the stack, extending the stack if necessary. The C<len>
2516 indicates the length of the string. Handles 'set' magic. Uses C<TARG>, so
2517 C<dTARGET> or C<dXSTARG> should be called to declare it. Do not call
2518 multiple C<TARG>-oriented macros to return lists from XSUB's - see
2519 C<mXPUSHp> instead. See also C<PUSHp> and C<mPUSHp>.
2521 void XPUSHp(char* str, STRLEN len)
2528 Push an SV onto the stack, extending the stack if necessary. Does not
2529 handle 'set' magic. Does not use C<TARG>. See also C<XPUSHmortal>,
2530 C<PUSHs> and C<PUSHmortal>.
2539 Push an unsigned integer onto the stack, extending the stack if necessary.
2540 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
2541 called to declare it. Do not call multiple C<TARG>-oriented macros to
2542 return lists from XSUB's - see C<mXPUSHu> instead. See also C<PUSHu> and
2552 Return from XSUB, indicating number of items on the stack. This is usually
2553 handled by C<xsubpp>.
2555 void XSRETURN(int nitems)
2558 Found in file XSUB.h
2562 Return an integer from an XSUB immediately. Uses C<XST_mIV>.
2564 void XSRETURN_IV(IV iv)
2567 Found in file XSUB.h
2571 Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
2576 Found in file XSUB.h
2580 Return a double from an XSUB immediately. Uses C<XST_mNV>.
2582 void XSRETURN_NV(NV nv)
2585 Found in file XSUB.h
2589 Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
2591 void XSRETURN_PV(char* str)
2594 Found in file XSUB.h
2596 =item XSRETURN_UNDEF
2598 Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
2603 Found in file XSUB.h
2607 Return an integer from an XSUB immediately. Uses C<XST_mUV>.
2609 void XSRETURN_UV(IV uv)
2612 Found in file XSUB.h
2616 Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
2621 Found in file XSUB.h
2625 Place an integer into the specified position C<pos> on the stack. The
2626 value is stored in a new mortal SV.
2628 void XST_mIV(int pos, IV iv)
2631 Found in file XSUB.h
2635 Place C<&PL_sv_no> into the specified position C<pos> on the
2638 void XST_mNO(int pos)
2641 Found in file XSUB.h
2645 Place a double into the specified position C<pos> on the stack. The value
2646 is stored in a new mortal SV.
2648 void XST_mNV(int pos, NV nv)
2651 Found in file XSUB.h
2655 Place a copy of a string into the specified position C<pos> on the stack.
2656 The value is stored in a new mortal SV.
2658 void XST_mPV(int pos, char* str)
2661 Found in file XSUB.h
2665 Place C<&PL_sv_undef> into the specified position C<pos> on the
2668 void XST_mUNDEF(int pos)
2671 Found in file XSUB.h
2675 Place C<&PL_sv_yes> into the specified position C<pos> on the
2678 void XST_mYES(int pos)
2681 Found in file XSUB.h
2692 An enum of flags for Perl types. These are found in the file B<sv.h>
2693 in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
2700 Integer type flag for scalars. See C<svtype>.
2707 Double type flag for scalars. See C<svtype>.
2714 Pointer type flag for scalars. See C<svtype>.
2721 Type flag for arrays. See C<svtype>.
2728 Type flag for code refs. See C<svtype>.
2735 Type flag for hashes. See C<svtype>.
2742 Type flag for blessed scalars. See C<svtype>.
2750 =head1 SV Manipulation Functions
2756 Returns the SV of the specified Perl scalar. If C<create> is set and the
2757 Perl variable does not exist then it will be created. If C<create> is not
2758 set and the variable does not exist then NULL is returned.
2760 NOTE: the perl_ form of this function is deprecated.
2762 SV* get_sv(const char* name, I32 create)
2765 Found in file perl.c
2767 =item looks_like_number
2769 Test if the content of an SV looks like a number (or is a number).
2770 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
2771 non-numeric warning), even if your atof() doesn't grok them.
2773 I32 looks_like_number(SV* sv)
2780 Creates an RV wrapper for an SV. The reference count for the original SV is
2783 SV* newRV_inc(SV* sv)
2790 Creates an RV wrapper for an SV. The reference count for the original
2791 SV is B<not> incremented.
2793 SV* newRV_noinc(SV *sv)
2800 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
2801 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
2804 SV* newSV(STRLEN len)
2811 Creates a new SV and copies an integer into it. The reference count for the
2821 Creates a new SV and copies a floating point value into it.
2822 The reference count for the SV is set to 1.
2831 Creates a new SV and copies a string into it. The reference count for the
2832 SV is set to 1. If C<len> is zero, Perl will compute the length using
2833 strlen(). For efficiency, consider using C<newSVpvn> instead.
2835 SV* newSVpv(const char* s, STRLEN len)
2842 Creates a new SV and initializes it with the string formatted like
2845 SV* newSVpvf(const char* pat, ...)
2852 Creates a new SV and copies a string into it. The reference count for the
2853 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
2854 string. You are responsible for ensuring that the source string is at least
2857 SV* newSVpvn(const char* s, STRLEN len)
2862 =item newSVpvn_share
2864 Creates a new SV with its SvPVX pointing to a shared string in the string
2865 table. If the string does not already exist in the table, it is created
2866 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
2867 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
2868 otherwise the hash is computed. The idea here is that as the string table
2869 is used for shared hash keys these strings will have SvPVX == HeKEY and
2870 hash lookup will avoid string compare.
2872 SV* newSVpvn_share(const char* s, I32 len, U32 hash)
2879 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
2880 it will be upgraded to one. If C<classname> is non-null then the new SV will
2881 be blessed in the specified package. The new SV is returned and its
2882 reference count is 1.
2884 SV* newSVrv(SV* rv, const char* classname)
2891 Creates a new SV which is an exact duplicate of the original SV.
2894 SV* newSVsv(SV* old)
2901 Creates a new SV and copies an unsigned integer into it.
2902 The reference count for the SV is set to 1.
2911 Returns the length of the string which is in the SV. See C<SvLEN>.
2913 STRLEN SvCUR(SV* sv)
2920 Set the length of the string which is in the SV. See C<SvCUR>.
2922 void SvCUR_set(SV* sv, STRLEN len)
2929 Returns a pointer to the last character in the string which is in the SV.
2930 See C<SvCUR>. Access the character as *(SvEND(sv)).
2939 Expands the character buffer in the SV so that it has room for the
2940 indicated number of bytes (remember to reserve space for an extra trailing
2941 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
2942 Returns a pointer to the character buffer.
2944 char * SvGROW(SV* sv, STRLEN len)
2951 Returns a boolean indicating whether the SV contains an integer.
2960 Returns a boolean indicating whether the SV contains an integer. Checks
2961 the B<private> setting. Use C<SvIOK>.
2970 Returns a boolean indicating whether the SV contains a signed integer.
2972 bool SvIOK_notUV(SV* sv)
2979 Unsets the IV status of an SV.
2981 void SvIOK_off(SV* sv)
2988 Tells an SV that it is an integer.
2990 void SvIOK_on(SV* sv)
2997 Tells an SV that it is an integer and disables all other OK bits.
2999 void SvIOK_only(SV* sv)
3006 Tells and SV that it is an unsigned integer and disables all other OK bits.
3008 void SvIOK_only_UV(SV* sv)
3015 Returns a boolean indicating whether the SV contains an unsigned integer.
3017 bool SvIOK_UV(SV* sv)
3024 Returns a boolean indicating whether the SV is Copy-On-Write. (either shared
3025 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
3028 bool SvIsCOW(SV* sv)
3033 =item SvIsCOW_shared_hash
3035 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
3038 bool SvIsCOW_shared_hash(SV* sv)
3045 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
3046 version which guarantees to evaluate sv only once.
3055 Coerces the given SV to an integer and returns it. Guarantees to evaluate
3056 sv only once. Use the more efficient C<SvIV> otherwise.
3065 Returns the raw value in the SV's IV slot, without checks or conversions.
3066 Only use when you are sure SvIOK is true. See also C<SvIV()>.
3075 Like C<SvIV> but doesn't process magic.
3077 IV SvIV_nomg(SV* sv)
3084 Returns the size of the string buffer in the SV, not including any part
3085 attributable to C<SvOOK>. See C<SvCUR>.
3087 STRLEN SvLEN(SV* sv)
3094 Returns a boolean indicating whether the SV contains a number, integer or
3104 Returns a boolean indicating whether the SV contains a number, integer or
3105 double. Checks the B<private> setting. Use C<SvNIOK>.
3107 bool SvNIOKp(SV* sv)
3114 Unsets the NV/IV status of an SV.
3116 void SvNIOK_off(SV* sv)
3123 Returns a boolean indicating whether the SV contains a double.
3132 Returns a boolean indicating whether the SV contains a double. Checks the
3133 B<private> setting. Use C<SvNOK>.
3142 Unsets the NV status of an SV.
3144 void SvNOK_off(SV* sv)
3151 Tells an SV that it is a double.
3153 void SvNOK_on(SV* sv)
3160 Tells an SV that it is a double and disables all other OK bits.
3162 void SvNOK_only(SV* sv)
3169 Coerce the given SV to a double and return it. See C<SvNVx> for a version
3170 which guarantees to evaluate sv only once.
3179 Returns the raw value in the SV's NV slot, without checks or conversions.
3180 Only use when you are sure SvNOK is true. See also C<SvNV()>.
3189 Coerces the given SV to a double and returns it. Guarantees to evaluate
3190 sv only once. Use the more efficient C<SvNV> otherwise.
3199 Returns a boolean indicating whether the value is an SV.
3208 Returns a boolean indicating whether the SvIVX is a valid offset value for
3209 the SvPVX. This hack is used internally to speed up removal of characters
3210 from the beginning of a SvPV. When SvOOK is true, then the start of the
3211 allocated string buffer is really (SvPVX - SvIVX).
3220 Returns a boolean indicating whether the SV contains a character
3230 Returns a boolean indicating whether the SV contains a character string.
3231 Checks the B<private> setting. Use C<SvPOK>.
3240 Unsets the PV status of an SV.
3242 void SvPOK_off(SV* sv)
3249 Tells an SV that it is a string.
3251 void SvPOK_on(SV* sv)
3258 Tells an SV that it is a string and disables all other OK bits.
3259 Will also turn off the UTF-8 status.
3261 void SvPOK_only(SV* sv)
3266 =item SvPOK_only_UTF8
3268 Tells an SV that it is a string and disables all other OK bits,
3269 and leaves the UTF-8 status as it was.
3271 void SvPOK_only_UTF8(SV* sv)
3278 Returns a pointer to the string in the SV, or a stringified form of
3279 the SV if the SV does not contain a string. The SV may cache the
3280 stringified version becoming C<SvPOK>. Handles 'get' magic. See also
3281 C<SvPVx> for a version which guarantees to evaluate sv only once.
3283 char* SvPV(SV* sv, STRLEN len)
3290 Like C<SvPV>, but converts sv to byte representation first if necessary.
3292 char* SvPVbyte(SV* sv, STRLEN len)
3299 Like C<SvPV>, but converts sv to byte representation first if necessary.
3300 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
3303 char* SvPVbytex(SV* sv, STRLEN len)
3308 =item SvPVbytex_force
3310 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
3311 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
3314 char* SvPVbytex_force(SV* sv, STRLEN len)
3319 =item SvPVbyte_force
3321 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
3323 char* SvPVbyte_force(SV* sv, STRLEN len)
3328 =item SvPVbyte_nolen
3330 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
3332 char* SvPVbyte_nolen(SV* sv)
3339 Like C<SvPV>, but converts sv to utf8 first if necessary.
3341 char* SvPVutf8(SV* sv, STRLEN len)
3348 Like C<SvPV>, but converts sv to utf8 first if necessary.
3349 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
3352 char* SvPVutf8x(SV* sv, STRLEN len)
3357 =item SvPVutf8x_force
3359 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
3360 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
3363 char* SvPVutf8x_force(SV* sv, STRLEN len)
3368 =item SvPVutf8_force
3370 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
3372 char* SvPVutf8_force(SV* sv, STRLEN len)
3377 =item SvPVutf8_nolen
3379 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
3381 char* SvPVutf8_nolen(SV* sv)
3388 A version of C<SvPV> which guarantees to evaluate sv only once.
3390 char* SvPVx(SV* sv, STRLEN len)
3397 Returns a pointer to the physical string in the SV. The SV must contain a
3407 Like C<SvPV> but will force the SV into containing just a string
3408 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
3411 char* SvPV_force(SV* sv, STRLEN len)
3416 =item SvPV_force_nomg
3418 Like C<SvPV> but will force the SV into containing just a string
3419 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
3420 directly. Doesn't process magic.
3422 char* SvPV_force_nomg(SV* sv, STRLEN len)
3429 Returns a pointer to the string in the SV, or a stringified form of
3430 the SV if the SV does not contain a string. The SV may cache the
3431 stringified form becoming C<SvPOK>. Handles 'get' magic.
3433 char* SvPV_nolen(SV* sv)
3440 Like C<SvPV> but doesn't process magic.
3442 char* SvPV_nomg(SV* sv, STRLEN len)
3449 Returns the value of the object's reference count.
3451 U32 SvREFCNT(SV* sv)
3458 Decrements the reference count of the given SV.
3460 void SvREFCNT_dec(SV* sv)
3467 Increments the reference count of the given SV.
3469 SV* SvREFCNT_inc(SV* sv)
3476 Tests if the SV is an RV.
3485 Unsets the RV status of an SV.
3487 void SvROK_off(SV* sv)
3494 Tells an SV that it is an RV.
3496 void SvROK_on(SV* sv)
3503 Dereferences an RV to return the SV.
3512 Returns the stash of the SV.
3521 Taints an SV if tainting is enabled.
3523 void SvTAINT(SV* sv)
3530 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
3533 bool SvTAINTED(SV* sv)
3540 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
3541 some of Perl's fundamental security features. XS module authors should not
3542 use this function unless they fully understand all the implications of
3543 unconditionally untainting the value. Untainting should be done in the
3544 standard perl fashion, via a carefully crafted regexp, rather than directly
3545 untainting variables.
3547 void SvTAINTED_off(SV* sv)
3554 Marks an SV as tainted if tainting is enabled.
3556 void SvTAINTED_on(SV* sv)
3563 Returns a boolean indicating whether Perl would evaluate the SV as true or
3564 false, defined or undefined. Does not handle 'get' magic.
3573 Returns the type of the SV. See C<svtype>.
3575 svtype SvTYPE(SV* sv)
3582 Releases a mutual exclusion lock on sv if a suitable module
3586 void SvUNLOCK(SV* sv)
3593 Returns a boolean indicating whether the SV contains an unsigned integer.
3602 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
3603 perform the upgrade if necessary. See C<svtype>.
3605 void SvUPGRADE(SV* sv, svtype type)
3612 Returns a boolean indicating whether the SV contains UTF-8 encoded data.
3621 Unsets the UTF-8 status of an SV.
3623 void SvUTF8_off(SV *sv)
3630 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
3631 Do not use frivolously.
3633 void SvUTF8_on(SV *sv)
3640 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
3641 for a version which guarantees to evaluate sv only once.
3650 Returns the raw value in the SV's UV slot, without checks or conversions.
3651 Only use when you are sure SvIOK is true. See also C<SvUV()>.
3660 Coerces the given SV to an unsigned integer and returns it. Guarantees to
3661 evaluate sv only once. Use the more efficient C<SvUV> otherwise.
3670 Like C<SvUV> but doesn't process magic.
3672 UV SvUV_nomg(SV* sv)
3679 Returns a boolean indicating whether the SV contains a v-string.
3688 This function is only called on magical items, and is only used by
3689 sv_true() or its macro equivalent.
3691 bool sv_2bool(SV* sv)
3698 Using various gambits, try to get a CV from an SV; in addition, try if
3699 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
3701 CV* sv_2cv(SV* sv, HV** st, GV** gvp, I32 lref)
3708 Using various gambits, try to get an IO from an SV: the IO slot if its a
3709 GV; or the recursive result if we're an RV; or the IO slot of the symbol
3710 named after the PV if we're a string.
3719 Return the integer value of an SV, doing any necessary string
3720 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
3721 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
3723 IV sv_2iv_flags(SV* sv, I32 flags)
3730 Marks an existing SV as mortal. The SV will be destroyed "soon", either
3731 by an explicit call to FREETMPS, or by an implicit call at places such as
3732 statement boundaries. See also C<sv_newmortal> and C<sv_mortalcopy>.
3734 SV* sv_2mortal(SV* sv)
3741 Return the num value of an SV, doing any necessary string or integer
3742 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
3752 Return a pointer to the byte-encoded representation of the SV, and set *lp
3753 to its length. May cause the SV to be downgraded from UTF-8 as a
3756 Usually accessed via the C<SvPVbyte> macro.
3758 char* sv_2pvbyte(SV* sv, STRLEN* lp)
3763 =item sv_2pvbyte_nolen
3765 Return a pointer to the byte-encoded representation of the SV.
3766 May cause the SV to be downgraded from UTF-8 as a side-effect.
3768 Usually accessed via the C<SvPVbyte_nolen> macro.
3770 char* sv_2pvbyte_nolen(SV* sv)
3777 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3778 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
3780 Usually accessed via the C<SvPVutf8> macro.
3782 char* sv_2pvutf8(SV* sv, STRLEN* lp)
3787 =item sv_2pvutf8_nolen
3789 Return a pointer to the UTF-8-encoded representation of the SV.
3790 May cause the SV to be upgraded to UTF-8 as a side-effect.
3792 Usually accessed via the C<SvPVutf8_nolen> macro.
3794 char* sv_2pvutf8_nolen(SV* sv)
3801 Returns a pointer to the string value of an SV, and sets *lp to its length.
3802 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
3804 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
3805 usually end up here too.
3807 char* sv_2pv_flags(SV* sv, STRLEN* lp, I32 flags)
3814 Like C<sv_2pv()>, but doesn't return the length too. You should usually
3815 use the macro wrapper C<SvPV_nolen(sv)> instead.
3816 char* sv_2pv_nolen(SV* sv)
3823 Return the unsigned integer value of an SV, doing any necessary string
3824 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
3825 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
3827 UV sv_2uv_flags(SV* sv, I32 flags)
3834 Remove any string offset. You should normally use the C<SvOOK_off> macro
3837 int sv_backoff(SV* sv)
3844 Blesses an SV into a specified package. The SV must be an RV. The package
3845 must be designated by its stash (see C<gv_stashpv()>). The reference count
3846 of the SV is unaffected.
3848 SV* sv_bless(SV* sv, HV* stash)
3855 Concatenates the string onto the end of the string which is in the SV.
3856 If the SV has the UTF-8 status set, then the bytes appended should be
3857 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
3859 void sv_catpv(SV* sv, const char* ptr)
3866 Processes its arguments like C<sprintf> and appends the formatted
3867 output to an SV. If the appended data contains "wide" characters
3868 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
3869 and characters >255 formatted with %c), the original SV might get
3870 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic.
3871 C<SvSETMAGIC()> must typically be called after calling this function
3872 to handle 'set' magic.
3874 void sv_catpvf(SV* sv, const char* pat, ...)
3881 Like C<sv_catpvf>, but also handles 'set' magic.
3883 void sv_catpvf_mg(SV *sv, const char* pat, ...)
3890 Concatenates the string onto the end of the string which is in the SV. The
3891 C<len> indicates number of bytes to copy. If the SV has the UTF-8
3892 status set, then the bytes appended should be valid UTF-8.
3893 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
3895 void sv_catpvn(SV* sv, const char* ptr, STRLEN len)
3900 =item sv_catpvn_flags
3902 Concatenates the string onto the end of the string which is in the SV. The
3903 C<len> indicates number of bytes to copy. If the SV has the UTF-8
3904 status set, then the bytes appended should be valid UTF-8.
3905 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
3906 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
3907 in terms of this function.
3909 void sv_catpvn_flags(SV* sv, const char* ptr, STRLEN len, I32 flags)
3916 Like C<sv_catpvn>, but also handles 'set' magic.
3918 void sv_catpvn_mg(SV *sv, const char *ptr, STRLEN len)
3925 Like C<sv_catpv>, but also handles 'set' magic.
3927 void sv_catpv_mg(SV *sv, const char *ptr)
3934 Concatenates the string from SV C<ssv> onto the end of the string in
3935 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
3936 not 'set' magic. See C<sv_catsv_mg>.
3938 void sv_catsv(SV* dsv, SV* ssv)
3943 =item sv_catsv_flags
3945 Concatenates the string from SV C<ssv> onto the end of the string in
3946 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
3947 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
3948 and C<sv_catsv_nomg> are implemented in terms of this function.
3950 void sv_catsv_flags(SV* dsv, SV* ssv, I32 flags)
3957 Like C<sv_catsv>, but also handles 'set' magic.
3959 void sv_catsv_mg(SV *dstr, SV *sstr)
3966 Efficient removal of characters from the beginning of the string buffer.
3967 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
3968 the string buffer. The C<ptr> becomes the first character of the adjusted
3969 string. Uses the "OOK hack".
3970 Beware: after this function returns, C<ptr> and SvPVX(sv) may no longer
3971 refer to the same chunk of data.
3973 void sv_chop(SV* sv, char* ptr)
3980 Clear an SV: call any destructors, free up any memory used by the body,
3981 and free the body itself. The SV's head is I<not> freed, although
3982 its type is set to all 1's so that it won't inadvertently be assumed
3983 to be live during global destruction etc.
3984 This function should only be called when REFCNT is zero. Most of the time
3985 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
3988 void sv_clear(SV* sv)
3995 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
3996 string in C<sv1> is less than, equal to, or greater than the string in
3997 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
3998 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
4000 I32 sv_cmp(SV* sv1, SV* sv2)
4007 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
4008 'use bytes' aware, handles get magic, and will coerce its args to strings
4009 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
4011 I32 sv_cmp_locale(SV* sv1, SV* sv2)
4018 Add Collate Transform magic to an SV if it doesn't already have it.
4020 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
4021 scalar data of the variable, but transformed to such a format that a normal
4022 memory comparison can be used to compare the data according to the locale
4025 char* sv_collxfrm(SV* sv, STRLEN* nxp)
4032 Copies a stringified representation of the source SV into the
4033 destination SV. Automatically performs any necessary mg_get and
4034 coercion of numeric values into strings. Guaranteed to preserve
4035 UTF-8 flag even from overloaded objects. Similar in nature to
4036 sv_2pv[_flags] but operates directly on an SV instead of just the
4037 string. Mostly uses sv_2pv_flags to do its work, except when that
4038 would lose the UTF-8'ness of the PV.
4040 void sv_copypv(SV* dsv, SV* ssv)
4047 Auto-decrement of the value in the SV, doing string to numeric conversion
4048 if necessary. Handles 'get' magic.
4055 =item sv_derived_from
4057 Returns a boolean indicating whether the SV is derived from the specified
4058 class. This is the function that implements C<UNIVERSAL::isa>. It works
4059 for class names as well as for objects.
4061 bool sv_derived_from(SV* sv, const char* name)
4064 Found in file universal.c
4068 Returns a boolean indicating whether the strings in the two SVs are
4069 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
4070 coerce its args to strings if necessary.
4072 I32 sv_eq(SV* sv1, SV* sv2)
4077 =item sv_force_normal
4079 Undo various types of fakery on an SV: if the PV is a shared string, make
4080 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4081 an xpvmg. See also C<sv_force_normal_flags>.
4083 void sv_force_normal(SV *sv)
4088 =item sv_force_normal_flags
4090 Undo various types of fakery on an SV: if the PV is a shared string, make
4091 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4092 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4093 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4094 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4095 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4096 set to some other value.) In addition, the C<flags> parameter gets passed to
4097 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4098 with flags set to 0.
4100 void sv_force_normal_flags(SV *sv, U32 flags)
4107 Decrement an SV's reference count, and if it drops to zero, call
4108 C<sv_clear> to invoke destructors and free up any memory used by
4109 the body; finally, deallocate the SV's head itself.
4110 Normally called via a wrapper macro C<SvREFCNT_dec>.
4112 void sv_free(SV* sv)
4119 Get a line from the filehandle and store it into the SV, optionally
4120 appending to the currently-stored string.
4122 char* sv_gets(SV* sv, PerlIO* fp, I32 append)
4129 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
4130 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
4131 Use the C<SvGROW> wrapper instead.
4133 char* sv_grow(SV* sv, STRLEN newlen)
4140 Auto-increment of the value in the SV, doing string to numeric conversion
4141 if necessary. Handles 'get' magic.
4150 Inserts a string at the specified offset/length within the SV. Similar to
4151 the Perl substr() function.
4153 void sv_insert(SV* bigsv, STRLEN offset, STRLEN len, char* little, STRLEN littlelen)
4160 Returns a boolean indicating whether the SV is blessed into the specified
4161 class. This does not check for subtypes; use C<sv_derived_from> to verify
4162 an inheritance relationship.
4164 int sv_isa(SV* sv, const char* name)
4171 Returns a boolean indicating whether the SV is an RV pointing to a blessed
4172 object. If the SV is not an RV, or if the object is not blessed, then this
4175 int sv_isobject(SV* sv)
4182 A private implementation of the C<SvIVx> macro for compilers which can't
4183 cope with complex macro expressions. Always use the macro instead.
4192 Returns the length of the string in the SV. Handles magic and type
4193 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
4195 STRLEN sv_len(SV* sv)
4202 Returns the number of characters in the string in an SV, counting wide
4203 UTF-8 bytes as a single character. Handles magic and type coercion.
4205 STRLEN sv_len_utf8(SV* sv)
4212 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4213 then adds a new magic item of type C<how> to the head of the magic list.
4215 void sv_magic(SV* sv, SV* obj, int how, const char* name, I32 namlen)
4222 Adds magic to an SV, upgrading it if necessary. Applies the
4223 supplied vtable and returns pointer to the magic added.
4225 Note that sv_magicext will allow things that sv_magic will not.
4226 In particular you can add magic to SvREADONLY SVs and and more than
4227 one instance of the same 'how'
4229 I C<namelen> is greater then zero then a savepvn() I<copy> of C<name> is stored,
4230 if C<namelen> is zero then C<name> is stored as-is and - as another special
4231 case - if C<(name && namelen == HEf_SVKEY)> then C<name> is assumed to contain
4232 an C<SV*> and has its REFCNT incremented
4234 (This is now used as a subroutine by sv_magic.)
4236 MAGIC * sv_magicext(SV* sv, SV* obj, int how, MGVTBL *vtbl, const char* name, I32 namlen )
4243 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
4244 The new SV is marked as mortal. It will be destroyed "soon", either by an
4245 explicit call to FREETMPS, or by an implicit call at places such as
4246 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
4248 SV* sv_mortalcopy(SV* oldsv)
4255 Creates a new null SV which is mortal. The reference count of the SV is
4256 set to 1. It will be destroyed "soon", either by an explicit call to
4257 FREETMPS, or by an implicit call at places such as statement boundaries.
4258 See also C<sv_mortalcopy> and C<sv_2mortal>.
4267 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
4270 SV* sv_newref(SV* sv)
4277 A private implementation of the C<SvNVx> macro for compilers which can't
4278 cope with complex macro expressions. Always use the macro instead.
4287 Converts the value pointed to by offsetp from a count of bytes from the
4288 start of the string, to a count of the equivalent number of UTF-8 chars.
4289 Handles magic and type coercion.
4291 void sv_pos_b2u(SV* sv, I32* offsetp)
4298 Converts the value pointed to by offsetp from a count of UTF-8 chars from
4299 the start of the string, to a count of the equivalent number of bytes; if
4300 lenp is non-zero, it does the same to lenp, but this time starting from
4301 the offset, rather than from the start of the string. Handles magic and
4304 void sv_pos_u2b(SV* sv, I32* offsetp, I32* lenp)
4311 Use the C<SvPV_nolen> macro instead
4320 Use C<SvPVbyte_nolen> instead.
4322 char* sv_pvbyte(SV *sv)
4329 A private implementation of the C<SvPVbyte> macro for compilers
4330 which can't cope with complex macro expressions. Always use the macro
4333 char* sv_pvbyten(SV *sv, STRLEN *len)
4338 =item sv_pvbyten_force
4340 A private implementation of the C<SvPVbytex_force> macro for compilers
4341 which can't cope with complex macro expressions. Always use the macro
4344 char* sv_pvbyten_force(SV* sv, STRLEN* lp)
4351 A private implementation of the C<SvPV> macro for compilers which can't
4352 cope with complex macro expressions. Always use the macro instead.
4354 char* sv_pvn(SV *sv, STRLEN *len)
4361 Get a sensible string out of the SV somehow.
4362 A private implementation of the C<SvPV_force> macro for compilers which
4363 can't cope with complex macro expressions. Always use the macro instead.
4365 char* sv_pvn_force(SV* sv, STRLEN* lp)
4370 =item sv_pvn_force_flags
4372 Get a sensible string out of the SV somehow.
4373 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
4374 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
4375 implemented in terms of this function.
4376 You normally want to use the various wrapper macros instead: see
4377 C<SvPV_force> and C<SvPV_force_nomg>
4379 char* sv_pvn_force_flags(SV* sv, STRLEN* lp, I32 flags)
4386 Use the C<SvPVutf8_nolen> macro instead
4388 char* sv_pvutf8(SV *sv)
4395 A private implementation of the C<SvPVutf8> macro for compilers
4396 which can't cope with complex macro expressions. Always use the macro
4399 char* sv_pvutf8n(SV *sv, STRLEN *len)
4404 =item sv_pvutf8n_force
4406 A private implementation of the C<SvPVutf8_force> macro for compilers
4407 which can't cope with complex macro expressions. Always use the macro
4410 char* sv_pvutf8n_force(SV* sv, STRLEN* lp)
4417 Returns a string describing what the SV is a reference to.
4419 char* sv_reftype(SV* sv, int ob)
4426 Make the first argument a copy of the second, then delete the original.
4427 The target SV physically takes over ownership of the body of the source SV
4428 and inherits its flags; however, the target keeps any magic it owns,
4429 and any magic in the source is discarded.
4430 Note that this is a rather specialist SV copying operation; most of the
4431 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4433 void sv_replace(SV* sv, SV* nsv)
4438 =item sv_report_used
4440 Dump the contents of all SVs not yet freed. (Debugging aid).
4442 void sv_report_used()
4449 Underlying implementation for the C<reset> Perl function.
4450 Note that the perl-level function is vaguely deprecated.
4452 void sv_reset(char* s, HV* stash)
4459 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4460 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4461 push a back-reference to this RV onto the array of backreferences
4462 associated with that magic.
4464 SV* sv_rvweaken(SV *sv)
4471 Copies an integer into the given SV, upgrading first if necessary.
4472 Does not handle 'set' magic. See also C<sv_setiv_mg>.
4474 void sv_setiv(SV* sv, IV num)
4481 Like C<sv_setiv>, but also handles 'set' magic.
4483 void sv_setiv_mg(SV *sv, IV i)
4490 Copies a double into the given SV, upgrading first if necessary.
4491 Does not handle 'set' magic. See also C<sv_setnv_mg>.
4493 void sv_setnv(SV* sv, NV num)
4500 Like C<sv_setnv>, but also handles 'set' magic.
4502 void sv_setnv_mg(SV *sv, NV num)
4509 Copies a string into an SV. The string must be null-terminated. Does not
4510 handle 'set' magic. See C<sv_setpv_mg>.
4512 void sv_setpv(SV* sv, const char* ptr)
4519 Processes its arguments like C<sprintf> and sets an SV to the formatted
4520 output. Does not handle 'set' magic. See C<sv_setpvf_mg>.
4522 void sv_setpvf(SV* sv, const char* pat, ...)
4529 Like C<sv_setpvf>, but also handles 'set' magic.
4531 void sv_setpvf_mg(SV *sv, const char* pat, ...)
4538 Copies an integer into the given SV, also updating its string value.
4539 Does not handle 'set' magic. See C<sv_setpviv_mg>.
4541 void sv_setpviv(SV* sv, IV num)
4548 Like C<sv_setpviv>, but also handles 'set' magic.
4550 void sv_setpviv_mg(SV *sv, IV iv)
4557 Copies a string into an SV. The C<len> parameter indicates the number of
4558 bytes to be copied. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4560 void sv_setpvn(SV* sv, const char* ptr, STRLEN len)
4567 Like C<sv_setpvn>, but also handles 'set' magic.
4569 void sv_setpvn_mg(SV *sv, const char *ptr, STRLEN len)
4576 Like C<sv_setpv>, but also handles 'set' magic.
4578 void sv_setpv_mg(SV *sv, const char *ptr)
4585 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
4586 argument will be upgraded to an RV. That RV will be modified to point to
4587 the new SV. The C<classname> argument indicates the package for the
4588 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4589 will have a reference count of 1, and the RV will be returned.
4591 SV* sv_setref_iv(SV* rv, const char* classname, IV iv)
4598 Copies a double into a new SV, optionally blessing the SV. The C<rv>
4599 argument will be upgraded to an RV. That RV will be modified to point to
4600 the new SV. The C<classname> argument indicates the package for the
4601 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4602 will have a reference count of 1, and the RV will be returned.
4604 SV* sv_setref_nv(SV* rv, const char* classname, NV nv)
4611 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
4612 argument will be upgraded to an RV. That RV will be modified to point to
4613 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
4614 into the SV. The C<classname> argument indicates the package for the
4615 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4616 will have a reference count of 1, and the RV will be returned.
4618 Do not use with other Perl types such as HV, AV, SV, CV, because those
4619 objects will become corrupted by the pointer copy process.
4621 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
4623 SV* sv_setref_pv(SV* rv, const char* classname, void* pv)
4630 Copies a string into a new SV, optionally blessing the SV. The length of the
4631 string must be specified with C<n>. The C<rv> argument will be upgraded to
4632 an RV. That RV will be modified to point to the new SV. The C<classname>
4633 argument indicates the package for the blessing. Set C<classname> to
4634 C<Nullch> to avoid the blessing. The new SV will have a reference count
4635 of 1, and the RV will be returned.
4637 Note that C<sv_setref_pv> copies the pointer while this copies the string.
4639 SV* sv_setref_pvn(SV* rv, const char* classname, char* pv, STRLEN n)
4646 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
4647 argument will be upgraded to an RV. That RV will be modified to point to
4648 the new SV. The C<classname> argument indicates the package for the
4649 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4650 will have a reference count of 1, and the RV will be returned.
4652 SV* sv_setref_uv(SV* rv, const char* classname, UV uv)
4659 Copies the contents of the source SV C<ssv> into the destination SV
4660 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4661 function if the source SV needs to be reused. Does not handle 'set' magic.
4662 Loosely speaking, it performs a copy-by-value, obliterating any previous
4663 content of the destination.
4665 You probably want to use one of the assortment of wrappers, such as
4666 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4667 C<SvSetMagicSV_nosteal>.
4669 void sv_setsv(SV* dsv, SV* ssv)
4674 =item sv_setsv_flags
4676 Copies the contents of the source SV C<ssv> into the destination SV
4677 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4678 function if the source SV needs to be reused. Does not handle 'set' magic.
4679 Loosely speaking, it performs a copy-by-value, obliterating any previous
4680 content of the destination.
4681 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
4682 C<ssv> if appropriate, else not. C<sv_setsv> and C<sv_setsv_nomg> are
4683 implemented in terms of this function.
4685 You probably want to use one of the assortment of wrappers, such as
4686 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4687 C<SvSetMagicSV_nosteal>.
4689 This is the primary function for copying scalars, and most other
4690 copy-ish functions and macros use this underneath.
4692 void sv_setsv_flags(SV* dsv, SV* ssv, I32 flags)
4699 Like C<sv_setsv>, but also handles 'set' magic.
4701 void sv_setsv_mg(SV *dstr, SV *sstr)
4708 Copies an unsigned integer into the given SV, upgrading first if necessary.
4709 Does not handle 'set' magic. See also C<sv_setuv_mg>.
4711 void sv_setuv(SV* sv, UV num)
4718 Like C<sv_setuv>, but also handles 'set' magic.
4720 void sv_setuv_mg(SV *sv, UV u)
4727 Taint an SV. Use C<SvTAINTED_on> instead.
4728 void sv_taint(SV* sv)
4735 Test an SV for taintedness. Use C<SvTAINTED> instead.
4736 bool sv_tainted(SV* sv)
4743 Returns true if the SV has a true value by Perl's rules.
4744 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
4745 instead use an in-line version.
4754 Removes all magic of type C<type> from an SV.
4756 int sv_unmagic(SV* sv, int type)
4763 Unsets the RV status of the SV, and decrements the reference count of
4764 whatever was being referenced by the RV. This can almost be thought of
4765 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
4766 being zero. See C<SvROK_off>.
4768 void sv_unref(SV* sv)
4773 =item sv_unref_flags
4775 Unsets the RV status of the SV, and decrements the reference count of
4776 whatever was being referenced by the RV. This can almost be thought of
4777 as a reversal of C<newSVrv>. The C<cflags> argument can contain
4778 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
4779 (otherwise the decrementing is conditional on the reference count being
4780 different from one or the reference being a readonly SV).
4783 void sv_unref_flags(SV* sv, U32 flags)
4790 Untaint an SV. Use C<SvTAINTED_off> instead.
4791 void sv_untaint(SV* sv)
4798 Upgrade an SV to a more complex form. Generally adds a new body type to the
4799 SV, then copies across as much information as possible from the old body.
4800 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
4802 bool sv_upgrade(SV* sv, U32 mt)
4809 Tells an SV to use C<ptr> to find its string value. Normally the string is
4810 stored inside the SV but sv_usepvn allows the SV to use an outside string.
4811 The C<ptr> should point to memory that was allocated by C<malloc>. The
4812 string length, C<len>, must be supplied. This function will realloc the
4813 memory pointed to by C<ptr>, so that pointer should not be freed or used by
4814 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
4815 See C<sv_usepvn_mg>.
4817 void sv_usepvn(SV* sv, char* ptr, STRLEN len)
4824 Like C<sv_usepvn>, but also handles 'set' magic.
4826 void sv_usepvn_mg(SV *sv, char *ptr, STRLEN len)
4831 =item sv_utf8_decode
4833 Convert the octets in the PV from UTF-8 to chars. Scan for validity and then
4834 turn off SvUTF8 if needed so that we see characters. Used as a building block
4835 for decode_utf8 in Encode.xs
4837 NOTE: this function is experimental and may change or be
4838 removed without notice.
4840 bool sv_utf8_decode(SV *sv)
4845 =item sv_utf8_downgrade
4847 Attempt to convert the PV of an SV from UTF-8-encoded to byte encoding.
4848 This may not be possible if the PV contains non-byte encoding characters;
4849 if this is the case, either returns false or, if C<fail_ok> is not
4852 This is not as a general purpose Unicode to byte encoding interface:
4853 use the Encode extension for that.
4855 NOTE: this function is experimental and may change or be
4856 removed without notice.
4858 bool sv_utf8_downgrade(SV *sv, bool fail_ok)
4863 =item sv_utf8_encode
4865 Convert the PV of an SV to UTF-8-encoded, but then turn off the C<SvUTF8>
4866 flag so that it looks like octets again. Used as a building block
4867 for encode_utf8 in Encode.xs
4869 void sv_utf8_encode(SV *sv)
4874 =item sv_utf8_upgrade
4876 Convert the PV of an SV to its UTF-8-encoded form.
4877 Forces the SV to string form if it is not already.
4878 Always sets the SvUTF8 flag to avoid future validity checks even
4879 if all the bytes have hibit clear.
4881 This is not as a general purpose byte encoding to Unicode interface:
4882 use the Encode extension for that.
4884 STRLEN sv_utf8_upgrade(SV *sv)
4889 =item sv_utf8_upgrade_flags
4891 Convert the PV of an SV to its UTF-8-encoded form.
4892 Forces the SV to string form if it is not already.
4893 Always sets the SvUTF8 flag to avoid future validity checks even
4894 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
4895 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
4896 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
4898 This is not as a general purpose byte encoding to Unicode interface:
4899 use the Encode extension for that.
4901 STRLEN sv_utf8_upgrade_flags(SV *sv, I32 flags)
4908 A private implementation of the C<SvUVx> macro for compilers which can't
4909 cope with complex macro expressions. Always use the macro instead.
4918 Processes its arguments like C<vsprintf> and appends the formatted output
4919 to an SV. Uses an array of SVs if the C style variable argument list is
4920 missing (NULL). When running with taint checks enabled, indicates via
4921 C<maybe_tainted> if results are untrustworthy (often due to the use of
4924 Usually used via one of its frontends C<sv_catpvf> and C<sv_catpvf_mg>.
4926 void sv_vcatpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
4933 Works like C<vcatpvfn> but copies the text into the SV instead of
4936 Usually used via one of its frontends C<sv_setpvf> and C<sv_setpvf_mg>.
4938 void sv_vsetpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
4946 =head1 Unicode Support
4950 =item bytes_from_utf8
4952 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
4953 Unlike <utf8_to_bytes> but like C<bytes_to_utf8>, returns a pointer to
4954 the newly-created string, and updates C<len> to contain the new
4955 length. Returns the original string if no conversion occurs, C<len>
4956 is unchanged. Do nothing if C<is_utf8> points to 0. Sets C<is_utf8> to
4957 0 if C<s> is converted or contains all 7bit characters.
4959 NOTE: this function is experimental and may change or be
4960 removed without notice.
4962 U8* bytes_from_utf8(U8 *s, STRLEN *len, bool *is_utf8)
4965 Found in file utf8.c
4969 Converts a string C<s> of length C<len> from ASCII into UTF-8 encoding.
4970 Returns a pointer to the newly-created string, and sets C<len> to
4971 reflect the new length.
4973 If you want to convert to UTF-8 from other encodings than ASCII,
4974 see sv_recode_to_utf8().
4976 NOTE: this function is experimental and may change or be
4977 removed without notice.
4979 U8* bytes_to_utf8(U8 *s, STRLEN *len)
4982 Found in file utf8.c
4986 Return true if the strings s1 and s2 differ case-insensitively, false
4987 if not (if they are equal case-insensitively). If u1 is true, the
4988 string s1 is assumed to be in UTF-8-encoded Unicode. If u2 is true,
4989 the string s2 is assumed to be in UTF-8-encoded Unicode. If u1 or u2
4990 are false, the respective string is assumed to be in native 8-bit
4993 If the pe1 and pe2 are non-NULL, the scanning pointers will be copied
4994 in there (they will point at the beginning of the I<next> character).
4995 If the pointers behind pe1 or pe2 are non-NULL, they are the end
4996 pointers beyond which scanning will not continue under any
4997 circustances. If the byte lengths l1 and l2 are non-zero, s1+l1 and
4998 s2+l2 will be used as goal end pointers that will also stop the scan,
4999 and which qualify towards defining a successful match: all the scans
5000 that define an explicit length must reach their goal pointers for
5001 a match to succeed).
5003 For case-insensitiveness, the "casefolding" of Unicode is used
5004 instead of upper/lowercasing both the characters, see
5005 http://www.unicode.org/unicode/reports/tr21/ (Case Mappings).
5007 I32 ibcmp_utf8(const char* a, char **pe1, UV l1, bool u1, const char* b, char **pe2, UV l2, bool u2)
5010 Found in file utf8.c
5014 Tests if some arbitrary number of bytes begins in a valid UTF-8
5015 character. Note that an INVARIANT (i.e. ASCII) character is a valid
5016 UTF-8 character. The actual number of bytes in the UTF-8 character
5017 will be returned if it is valid, otherwise 0.
5019 STRLEN is_utf8_char(U8 *p)
5022 Found in file utf8.c
5024 =item is_utf8_string
5026 Returns true if first C<len> bytes of the given string form a valid
5027 UTF-8 string, false otherwise. Note that 'a valid UTF-8 string' does
5028 not mean 'a string that contains code points above 0x7F encoded in UTF-8'
5029 because a valid ASCII string is a valid UTF-8 string.
5031 bool is_utf8_string(U8 *s, STRLEN len)
5034 Found in file utf8.c
5036 =item is_utf8_string_loc
5038 Like is_ut8_string but store the location of the failure in
5041 bool is_utf8_string_loc(U8 *s, STRLEN len, U8 **p)
5044 Found in file utf8.c
5046 =item pv_uni_display
5048 Build to the scalar dsv a displayable version of the string spv,
5049 length len, the displayable version being at most pvlim bytes long
5050 (if longer, the rest is truncated and "..." will be appended).
5052 The flags argument can have UNI_DISPLAY_ISPRINT set to display
5053 isPRINT()able characters as themselves, UNI_DISPLAY_BACKSLASH
5054 to display the \\[nrfta\\] as the backslashed versions (like '\n')
5055 (UNI_DISPLAY_BACKSLASH is preferred over UNI_DISPLAY_ISPRINT for \\).
5056 UNI_DISPLAY_QQ (and its alias UNI_DISPLAY_REGEX) have both
5057 UNI_DISPLAY_BACKSLASH and UNI_DISPLAY_ISPRINT turned on.
5059 The pointer to the PV of the dsv is returned.
5061 char* pv_uni_display(SV *dsv, U8 *spv, STRLEN len, STRLEN pvlim, UV flags)
5064 Found in file utf8.c
5068 The encoding is assumed to be an Encode object, the PV of the ssv is
5069 assumed to be octets in that encoding and decoding the input starts
5070 from the position which (PV + *offset) pointed to. The dsv will be
5071 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
5072 when the string tstr appears in decoding output or the input ends on
5073 the PV of the ssv. The value which the offset points will be modified
5074 to the last input position on the ssv.
5076 Returns TRUE if the terminator was found, else returns FALSE.
5078 bool sv_cat_decode(SV* dsv, SV *encoding, SV *ssv, int *offset, char* tstr, int tlen)
5083 =item sv_recode_to_utf8
5085 The encoding is assumed to be an Encode object, on entry the PV
5086 of the sv is assumed to be octets in that encoding, and the sv
5087 will be converted into Unicode (and UTF-8).
5089 If the sv already is UTF-8 (or if it is not POK), or if the encoding
5090 is not a reference, nothing is done to the sv. If the encoding is not
5091 an C<Encode::XS> Encoding object, bad things will happen.
5092 (See F<lib/encoding.pm> and L<Encode>).
5094 The PV of the sv is returned.
5096 char* sv_recode_to_utf8(SV* sv, SV *encoding)
5101 =item sv_uni_display
5103 Build to the scalar dsv a displayable version of the scalar sv,
5104 the displayable version being at most pvlim bytes long
5105 (if longer, the rest is truncated and "..." will be appended).
5107 The flags argument is as in pv_uni_display().
5109 The pointer to the PV of the dsv is returned.
5111 char* sv_uni_display(SV *dsv, SV *ssv, STRLEN pvlim, UV flags)
5114 Found in file utf8.c
5118 The "p" contains the pointer to the UTF-8 string encoding
5119 the character that is being converted.
5121 The "ustrp" is a pointer to the character buffer to put the
5122 conversion result to. The "lenp" is a pointer to the length
5125 The "swashp" is a pointer to the swash to use.
5127 Both the special and normal mappings are stored lib/unicore/To/Foo.pl,
5128 and loaded by SWASHGET, using lib/utf8_heavy.pl. The special (usually,
5129 but not always, a multicharacter mapping), is tried first.
5131 The "special" is a string like "utf8::ToSpecLower", which means the
5132 hash %utf8::ToSpecLower. The access to the hash is through
5133 Perl_to_utf8_case().
5135 The "normal" is a string like "ToLower" which means the swash
5138 UV to_utf8_case(U8 *p, U8* ustrp, STRLEN *lenp, SV **swash, char *normal, char *special)
5141 Found in file utf8.c
5145 Convert the UTF-8 encoded character at p to its foldcase version and
5146 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
5147 that the ustrp needs to be at least UTF8_MAXLEN_FOLD+1 bytes since the
5148 foldcase version may be longer than the original character (up to
5151 The first character of the foldcased version is returned
5152 (but note, as explained above, that there may be more.)
5154 UV to_utf8_fold(U8 *p, U8* ustrp, STRLEN *lenp)
5157 Found in file utf8.c
5161 Convert the UTF-8 encoded character at p to its lowercase version and
5162 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
5163 that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the
5164 lowercase version may be longer than the original character (up to two
5167 The first character of the lowercased version is returned
5168 (but note, as explained above, that there may be more.)
5170 UV to_utf8_lower(U8 *p, U8* ustrp, STRLEN *lenp)
5173 Found in file utf8.c
5177 Convert the UTF-8 encoded character at p to its titlecase version and
5178 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
5179 that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the
5180 titlecase version may be longer than the original character (up to two
5183 The first character of the titlecased version is returned
5184 (but note, as explained above, that there may be more.)
5186 UV to_utf8_title(U8 *p, U8* ustrp, STRLEN *lenp)
5189 Found in file utf8.c
5193 Convert the UTF-8 encoded character at p to its uppercase version and
5194 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
5195 that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the
5196 uppercase version may be longer than the original character (up to two
5199 The first character of the uppercased version is returned
5200 (but note, as explained above, that there may be more.)
5202 UV to_utf8_upper(U8 *p, U8* ustrp, STRLEN *lenp)
5205 Found in file utf8.c
5207 =item utf8n_to_uvchr
5209 Returns the native character value of the first character in the string C<s>
5210 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
5211 length, in bytes, of that character.
5213 Allows length and flags to be passed to low level routine.
5215 UV utf8n_to_uvchr(U8 *s, STRLEN curlen, STRLEN* retlen, U32 flags)
5218 Found in file utf8.c
5220 =item utf8n_to_uvuni
5222 Bottom level UTF-8 decode routine.
5223 Returns the unicode code point value of the first character in the string C<s>
5224 which is assumed to be in UTF-8 encoding and no longer than C<curlen>;
5225 C<retlen> will be set to the length, in bytes, of that character.
5227 If C<s> does not point to a well-formed UTF-8 character, the behaviour
5228 is dependent on the value of C<flags>: if it contains UTF8_CHECK_ONLY,
5229 it is assumed that the caller will raise a warning, and this function
5230 will silently just set C<retlen> to C<-1> and return zero. If the
5231 C<flags> does not contain UTF8_CHECK_ONLY, warnings about
5232 malformations will be given, C<retlen> will be set to the expected
5233 length of the UTF-8 character in bytes, and zero will be returned.
5235 The C<flags> can also contain various flags to allow deviations from
5236 the strict UTF-8 encoding (see F<utf8.h>).
5238 Most code should use utf8_to_uvchr() rather than call this directly.
5240 UV utf8n_to_uvuni(U8 *s, STRLEN curlen, STRLEN* retlen, U32 flags)
5243 Found in file utf8.c
5247 Returns the number of UTF-8 characters between the UTF-8 pointers C<a>
5250 WARNING: use only if you *know* that the pointers point inside the
5253 IV utf8_distance(U8 *a, U8 *b)
5256 Found in file utf8.c
5260 Return the UTF-8 pointer C<s> displaced by C<off> characters, either
5261 forward or backward.
5263 WARNING: do not use the following unless you *know* C<off> is within
5264 the UTF-8 data pointed to by C<s> *and* that on entry C<s> is aligned
5265 on the first byte of character or just after the last byte of a character.
5267 U8* utf8_hop(U8 *s, I32 off)
5270 Found in file utf8.c
5274 Return the length of the UTF-8 char encoded string C<s> in characters.
5275 Stops at C<e> (inclusive). If C<e E<lt> s> or if the scan would end
5276 up past C<e>, croaks.
5278 STRLEN utf8_length(U8* s, U8 *e)
5281 Found in file utf8.c
5285 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
5286 Unlike C<bytes_to_utf8>, this over-writes the original string, and
5287 updates len to contain the new length.
5288 Returns zero on failure, setting C<len> to -1.
5290 NOTE: this function is experimental and may change or be
5291 removed without notice.
5293 U8* utf8_to_bytes(U8 *s, STRLEN *len)
5296 Found in file utf8.c
5300 Returns the native character value of the first character in the string C<s>
5301 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
5302 length, in bytes, of that character.
5304 If C<s> does not point to a well-formed UTF-8 character, zero is
5305 returned and retlen is set, if possible, to -1.
5307 UV utf8_to_uvchr(U8 *s, STRLEN* retlen)
5310 Found in file utf8.c
5314 Returns the Unicode code point of the first character in the string C<s>
5315 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
5316 length, in bytes, of that character.
5318 This function should only be used when returned UV is considered
5319 an index into the Unicode semantic tables (e.g. swashes).
5321 If C<s> does not point to a well-formed UTF-8 character, zero is
5322 returned and retlen is set, if possible, to -1.
5324 UV utf8_to_uvuni(U8 *s, STRLEN* retlen)
5327 Found in file utf8.c
5331 Adds the UTF-8 representation of the Native codepoint C<uv> to the end
5332 of the string C<d>; C<d> should be have at least C<UTF8_MAXLEN+1> free
5333 bytes available. The return value is the pointer to the byte after the
5334 end of the new character. In other words,
5336 d = uvchr_to_utf8(d, uv);
5338 is the recommended wide native character-aware way of saying
5342 U8* uvchr_to_utf8(U8 *d, UV uv)
5345 Found in file utf8.c
5347 =item uvuni_to_utf8_flags
5349 Adds the UTF-8 representation of the Unicode codepoint C<uv> to the end
5350 of the string C<d>; C<d> should be have at least C<UTF8_MAXLEN+1> free
5351 bytes available. The return value is the pointer to the byte after the
5352 end of the new character. In other words,
5354 d = uvuni_to_utf8_flags(d, uv, flags);
5358 d = uvuni_to_utf8(d, uv);
5360 (which is equivalent to)
5362 d = uvuni_to_utf8_flags(d, uv, 0);
5364 is the recommended Unicode-aware way of saying
5368 U8* uvuni_to_utf8_flags(U8 *d, UV uv, UV flags)
5371 Found in file utf8.c
5376 =head1 Variables created by C<xsubpp> and C<xsubpp> internal functions
5382 Variable which is setup by C<xsubpp> to indicate the stack base offset,
5383 used by the C<ST>, C<XSprePUSH> and C<XSRETURN> macros. The C<dMARK> macro
5384 must be called prior to setup the C<MARK> variable.
5389 Found in file XSUB.h
5393 Variable which is setup by C<xsubpp> to indicate the
5394 class name for a C++ XS constructor. This is always a C<char*>. See C<THIS>.
5399 Found in file XSUB.h
5403 Sets up the C<ax> variable.
5404 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
5409 Found in file XSUB.h
5413 Sets up the C<items> variable.
5414 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
5419 Found in file XSUB.h
5423 Sets up stack and mark pointers for an XSUB, calling dSP and dMARK.
5424 Sets up the C<ax> and C<items> variables by calling C<dAX> and C<dITEMS>.
5425 This is usually handled automatically by C<xsubpp>.
5430 Found in file XSUB.h
5434 Sets up the C<ix> variable for an XSUB which has aliases. This is usually
5435 handled automatically by C<xsubpp>.
5440 Found in file XSUB.h
5444 Variable which is setup by C<xsubpp> to indicate the number of
5445 items on the stack. See L<perlxs/"Variable-length Parameter Lists">.
5450 Found in file XSUB.h
5454 Variable which is setup by C<xsubpp> to indicate which of an
5455 XSUB's aliases was used to invoke it. See L<perlxs/"The ALIAS: Keyword">.
5460 Found in file XSUB.h
5464 Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
5468 Found in file XSUB.h
5472 Variable which is setup by C<xsubpp> to hold the return value for an
5473 XSUB. This is always the proper type for the XSUB. See
5474 L<perlxs/"The RETVAL Variable">.
5479 Found in file XSUB.h
5483 Used to access elements on the XSUB's stack.
5488 Found in file XSUB.h
5492 Variable which is setup by C<xsubpp> to designate the object in a C++
5493 XSUB. This is always the proper type for the C++ object. See C<CLASS> and
5494 L<perlxs/"Using XS With C++">.
5499 Found in file XSUB.h
5503 Macro to declare an XSUB and its C parameter list. This is handled by
5507 Found in file XSUB.h
5509 =item XSRETURN_EMPTY
5511 Return an empty list from an XSUB immediately.
5517 Found in file XSUB.h
5521 The version identifier for an XS module. This is usually
5522 handled automatically by C<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>.
5525 Found in file XSUB.h
5527 =item XS_VERSION_BOOTCHECK
5529 Macro to verify that a PM module's $VERSION variable matches the XS
5530 module's C<XS_VERSION> variable. This is usually handled automatically by
5531 C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">.
5533 XS_VERSION_BOOTCHECK;
5536 Found in file XSUB.h
5541 =head1 Warning and Dieing
5547 This is the XSUB-writer's interface to Perl's C<die> function.
5548 Normally call this function the same way you call the C C<printf>
5549 function. Calling C<croak> returns control directly to Perl,
5550 sidestepping the normal C order of execution. See C<warn>.
5552 If you want to throw an exception object, assign the object to
5553 C<$@> and then pass C<Nullch> to croak():
5555 errsv = get_sv("@", TRUE);
5556 sv_setsv(errsv, exception_object);
5559 void croak(const char* pat, ...)
5562 Found in file util.c
5566 This is the XSUB-writer's interface to Perl's C<warn> function. Call this
5567 function the same way you call the C C<printf> function. See C<croak>.
5569 void warn(const char* pat, ...)
5572 Found in file util.c
5579 Until May 1997, this document was maintained by Jeff Okamoto
5580 <okamoto@corp.hp.com>. It is now maintained as part of Perl itself.
5582 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
5583 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
5584 Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
5585 Stephen McCamant, and Gurusamy Sarathy.
5587 API Listing originally by Dean Roehrich <roehrich@cray.com>.
5589 Updated to be autogenerated from comments in the source by Benjamin Stuhl.
5593 perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
projects / p5sagit/p5-mst-13.2.git / blob