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. C<flags> is currently ignored.
125 SV* av_delete(AV* ar, I32 key, I32 flags)
132 Returns true if the element indexed by C<key> has been initialized.
134 This relies on the fact that uninitialized array elements are set to
137 bool av_exists(AV* ar, I32 key)
144 Pre-extend an array. The C<key> is the index to which the array should be
147 void av_extend(AV* ar, I32 key)
154 Returns the SV at the specified index in the array. The C<key> is the
155 index. If C<lval> is set then the fetch will be part of a store. Check
156 that the return value is non-null before dereferencing it to a C<SV*>.
158 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for
159 more information on how to use this function on tied arrays.
161 SV** av_fetch(AV* ar, I32 key, I32 lval)
168 Ensure than an array has a given number of elements, equivalent to
169 Perl's C<$#array = $fill;>.
171 void av_fill(AV* ar, I32 fill)
178 Returns the highest index in the array. Returns -1 if the array is
188 Creates a new AV and populates it with a list of SVs. The SVs are copied
189 into the array, so they may be freed after the call to av_make. The new AV
190 will have a reference count of 1.
192 AV* av_make(I32 size, SV** svp)
199 Pops an SV off the end of the array. Returns C<&PL_sv_undef> if the array
209 Pushes an SV onto the end of the array. The array will grow automatically
210 to accommodate the addition.
212 void av_push(AV* ar, SV* val)
219 Shifts an SV off the beginning of the array.
228 Stores an SV in an array. The array index is specified as C<key>. The
229 return value will be NULL if the operation failed or if the value did not
230 need to be actually stored within the array (as in the case of tied
231 arrays). Otherwise it can be dereferenced to get the original C<SV*>. Note
232 that the caller is responsible for suitably incrementing the reference
233 count of C<val> before the call, and decrementing it if the function
236 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for
237 more information on how to use this function on tied arrays.
239 SV** av_store(AV* ar, I32 key, SV* val)
246 Undefines the array. Frees the memory used by the array itself.
248 void av_undef(AV* ar)
255 Unshift the given number of C<undef> values onto the beginning of the
256 array. The array will grow automatically to accommodate the addition. You
257 must then use C<av_store> to assign values to these new elements.
259 void av_unshift(AV* ar, I32 num)
266 Returns the AV of the specified Perl array. If C<create> is set and the
267 Perl variable does not exist then it will be created. If C<create> is not
268 set and the variable does not exist then NULL is returned.
270 NOTE: the perl_ form of this function is deprecated.
272 AV* get_av(const char* name, I32 create)
279 Creates a new AV. The reference count is set to 1.
296 Sort an array. Here is an example:
298 sortsv(AvARRAY(av), av_len(av)+1, Perl_sv_cmp_locale);
300 See lib/sort.pm for details about controlling the sorting algorithm.
302 void sortsv(SV ** array, size_t num_elts, SVCOMPARE_t cmp)
305 Found in file pp_sort.c
310 =head1 Callback Functions
316 Performs a callback to the specified Perl sub. See L<perlcall>.
318 NOTE: the perl_ form of this function is deprecated.
320 I32 call_argv(const char* sub_name, I32 flags, char** argv)
327 Performs a callback to the specified Perl method. The blessed object must
328 be on the stack. See L<perlcall>.
330 NOTE: the perl_ form of this function is deprecated.
332 I32 call_method(const char* methname, I32 flags)
339 Performs a callback to the specified Perl sub. See L<perlcall>.
341 NOTE: the perl_ form of this function is deprecated.
343 I32 call_pv(const char* sub_name, I32 flags)
350 Performs a callback to the Perl sub whose name is in the SV. See
353 NOTE: the perl_ form of this function is deprecated.
355 I32 call_sv(SV* sv, I32 flags)
362 Opening bracket on a callback. See C<LEAVE> and L<perlcall>.
367 Found in file scope.h
371 Tells Perl to C<eval> the given string and return an SV* result.
373 NOTE: the perl_ form of this function is deprecated.
375 SV* eval_pv(const char* p, I32 croak_on_error)
382 Tells Perl to C<eval> the string in the SV.
384 NOTE: the perl_ form of this function is deprecated.
386 I32 eval_sv(SV* sv, I32 flags)
393 Closing bracket for temporaries on a callback. See C<SAVETMPS> and
399 Found in file scope.h
403 Closing bracket on a callback. See C<ENTER> and L<perlcall>.
408 Found in file scope.h
412 Opening bracket for temporaries on a callback. See C<FREETMPS> and
418 Found in file scope.h
423 =head1 Character classes
429 Returns a boolean indicating whether the C C<char> is an ASCII alphanumeric
430 character (including underscore) or digit.
432 bool isALNUM(char ch)
435 Found in file handy.h
439 Returns a boolean indicating whether the C C<char> is an ASCII alphabetic
442 bool isALPHA(char ch)
445 Found in file handy.h
449 Returns a boolean indicating whether the C C<char> is an ASCII
452 bool isDIGIT(char ch)
455 Found in file handy.h
459 Returns a boolean indicating whether the C C<char> is a lowercase
462 bool isLOWER(char ch)
465 Found in file handy.h
469 Returns a boolean indicating whether the C C<char> is whitespace.
471 bool isSPACE(char ch)
474 Found in file handy.h
478 Returns a boolean indicating whether the C C<char> is an uppercase
481 bool isUPPER(char ch)
484 Found in file handy.h
488 Converts the specified character to lowercase.
490 char toLOWER(char ch)
493 Found in file handy.h
497 Converts the specified character to uppercase.
499 char toUPPER(char ch)
502 Found in file handy.h
507 =head1 Cloning an interpreter
513 Create and return a new interpreter by cloning the current one.
515 PerlInterpreter* perl_clone(PerlInterpreter* interp, UV flags)
523 =head1 CV Manipulation Functions
529 Returns the stash of the CV.
538 Returns the CV of the specified Perl subroutine. If C<create> is set and
539 the Perl subroutine does not exist then it will be declared (which has the
540 same effect as saying C<sub name;>). If C<create> is not set and the
541 subroutine does not exist then NULL is returned.
543 NOTE: the perl_ form of this function is deprecated.
545 CV* get_cv(const char* name, I32 create)
561 =head1 Embedding Functions
567 Clear out all the active components of a CV. This can happen either
568 by an explicit C<undef &foo>, or by the reference count going to zero.
569 In the former case, we keep the CvOUTSIDE pointer, so that any anonymous
570 children can still follow the full lexical scope chain.
572 void cv_undef(CV* cv)
579 Loads the module whose name is pointed to by the string part of name.
580 Note that the actual module name, not its filename, should be given.
581 Eg, "Foo::Bar" instead of "Foo/Bar.pm". flags can be any of
582 PERL_LOADMOD_DENY, PERL_LOADMOD_NOIMPORT, or PERL_LOADMOD_IMPORT_OPS
583 (or 0 for no flags). ver, if specified, provides version semantics
584 similar to C<use Foo::Bar VERSION>. The optional trailing SV*
585 arguments can be used to specify arguments to the module's import()
586 method, similar to C<use Foo::Bar VERSION LIST>.
588 void load_module(U32 flags, SV* name, SV* ver, ...)
595 Stub that provides thread hook for perl_destruct when there are
605 Allocates a new Perl interpreter. See L<perlembed>.
607 PerlInterpreter* perl_alloc()
614 Initializes a new Perl interpreter. See L<perlembed>.
616 void perl_construct(PerlInterpreter* interp)
623 Shuts down a Perl interpreter. See L<perlembed>.
625 int perl_destruct(PerlInterpreter* interp)
632 Releases a Perl interpreter. See L<perlembed>.
634 void perl_free(PerlInterpreter* interp)
641 Tells a Perl interpreter to parse a Perl script. See L<perlembed>.
643 int perl_parse(PerlInterpreter* interp, XSINIT_t xsinit, int argc, char** argv, char** env)
650 Tells a Perl interpreter to run. See L<perlembed>.
652 int perl_run(PerlInterpreter* interp)
659 Tells Perl to C<require> the file named by the string argument. It is
660 analogous to the Perl code C<eval "require '$file'">. It's even
661 implemented that way; consider using Perl_load_module instead.
663 NOTE: the perl_ form of this function is deprecated.
665 void require_pv(const char* pv)
673 =head1 Functions in file pp_pack.c
680 The engine implementing pack() Perl function.
682 void pack_cat(SV *cat, char *pat, char *patend, SV **beglist, SV **endlist, SV ***next_in_list, U32 flags)
685 Found in file pp_pack.c
689 The engine implementing unpack() Perl function.
691 I32 unpack_str(char *pat, char *patend, char *s, char *strbeg, char *strend, char **new_s, I32 ocnt, U32 flags)
694 Found in file pp_pack.c
699 =head1 Global Variables
705 C<PL_modglobal> is a general purpose, interpreter global HV for use by
706 extensions that need to keep information on a per-interpreter basis.
707 In a pinch, it can also be used as a symbol table for extensions
708 to share data among each other. It is a good idea to use keys
709 prefixed by the package name of the extension that owns the data.
714 Found in file intrpvar.h
718 A convenience variable which is typically used with C<SvPV> when one
719 doesn't care about the length of the string. It is usually more efficient
720 to either declare a local variable and use that instead or to use the
726 Found in file thrdvar.h
730 This is the C<false> SV. See C<PL_sv_yes>. Always refer to this as
736 Found in file intrpvar.h
740 This is the C<undef> SV. Always refer to this as C<&PL_sv_undef>.
745 Found in file intrpvar.h
749 This is the C<true> SV. See C<PL_sv_no>. Always refer to this as
755 Found in file intrpvar.h
766 Return the SV from the GV.
775 Returns the glob with the given C<name> and a defined subroutine or
776 C<NULL>. The glob lives in the given C<stash>, or in the stashes
777 accessible via @ISA and UNIVERSAL::.
779 The argument C<level> should be either 0 or -1. If C<level==0>, as a
780 side-effect creates a glob with the given C<name> in the given C<stash>
781 which in the case of success contains an alias for the subroutine, and sets
782 up caching info for this glob. Similarly for all the searched stashes.
784 This function grants C<"SUPER"> token as a postfix of the stash name. The
785 GV returned from C<gv_fetchmeth> may be a method cache entry, which is not
786 visible to Perl code. So when calling C<call_sv>, you should not use
787 the GV directly; instead, you should use the method's CV, which can be
788 obtained from the GV with the C<GvCV> macro.
790 GV* gv_fetchmeth(HV* stash, const char* name, STRLEN len, I32 level)
797 See L<gv_fetchmethod_autoload>.
799 GV* gv_fetchmethod(HV* stash, const char* name)
804 =item gv_fetchmethod_autoload
806 Returns the glob which contains the subroutine to call to invoke the method
807 on the C<stash>. In fact in the presence of autoloading this may be the
808 glob for "AUTOLOAD". In this case the corresponding variable $AUTOLOAD is
811 The third parameter of C<gv_fetchmethod_autoload> determines whether
812 AUTOLOAD lookup is performed if the given method is not present: non-zero
813 means yes, look for AUTOLOAD; zero means no, don't look for AUTOLOAD.
814 Calling C<gv_fetchmethod> is equivalent to calling C<gv_fetchmethod_autoload>
815 with a non-zero C<autoload> parameter.
817 These functions grant C<"SUPER"> token as a prefix of the method name. Note
818 that if you want to keep the returned glob for a long time, you need to
819 check for it being "AUTOLOAD", since at the later time the call may load a
820 different subroutine due to $AUTOLOAD changing its value. Use the glob
821 created via a side effect to do this.
823 These functions have the same side-effects and as C<gv_fetchmeth> with
824 C<level==0>. C<name> should be writable if contains C<':'> or C<'
825 ''>. The warning against passing the GV returned by C<gv_fetchmeth> to
826 C<call_sv> apply equally to these functions.
828 GV* gv_fetchmethod_autoload(HV* stash, const char* name, I32 autoload)
833 =item gv_fetchmeth_autoload
835 Same as gv_fetchmeth(), but looks for autoloaded subroutines too.
836 Returns a glob for the subroutine.
838 For an autoloaded subroutine without a GV, will create a GV even
839 if C<level < 0>. For an autoloaded subroutine without a stub, GvCV()
840 of the result may be zero.
842 GV* gv_fetchmeth_autoload(HV* stash, const char* name, STRLEN len, I32 level)
849 Returns a pointer to the stash for a specified package. C<name> should
850 be a valid UTF-8 string. If C<create> is set then the package will be
851 created if it does not already exist. If C<create> is not set and the
852 package does not exist then NULL is returned.
854 HV* gv_stashpv(const char* name, I32 create)
861 Returns a pointer to the stash for a specified package, which must be a
862 valid UTF-8 string. See C<gv_stashpv>.
864 HV* gv_stashsv(SV* sv, I32 create)
878 This flag, used in the length slot of hash entries and magic structures,
879 specifies the structure contains an C<SV*> pointer where a C<char*> pointer
880 is to be expected. (For information only--not to be used).
888 Null character pointer.
890 Found in file handy.h
897 Found in file handy.h
902 =head1 Hash Manipulation Functions
908 Returns the HV of the specified Perl hash. If C<create> is set and the
909 Perl variable does not exist then it will be created. If C<create> is not
910 set and the variable does not exist then NULL is returned.
912 NOTE: the perl_ form of this function is deprecated.
914 HV* get_hv(const char* name, I32 create)
921 Returns the computed hash stored in the hash entry.
930 Returns the actual pointer stored in the key slot of the hash entry. The
931 pointer may be either C<char*> or C<SV*>, depending on the value of
932 C<HeKLEN()>. Can be assigned to. The C<HePV()> or C<HeSVKEY()> macros are
933 usually preferable for finding the value of a key.
942 If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry
943 holds an C<SV*> key. Otherwise, holds the actual length of the key. Can
944 be assigned to. The C<HePV()> macro is usually preferable for finding key
947 STRLEN HeKLEN(HE* he)
954 Returns the key slot of the hash entry as a C<char*> value, doing any
955 necessary dereferencing of possibly C<SV*> keys. The length of the string
956 is placed in C<len> (this is a macro, so do I<not> use C<&len>). If you do
957 not care about what the length of the key is, you may use the global
958 variable C<PL_na>, though this is rather less efficient than using a local
959 variable. Remember though, that hash keys in perl are free to contain
960 embedded nulls, so using C<strlen()> or similar is not a good way to find
961 the length of hash keys. This is very similar to the C<SvPV()> macro
962 described elsewhere in this document.
964 char* HePV(HE* he, STRLEN len)
971 Returns the key as an C<SV*>, or C<Nullsv> if the hash entry does not
972 contain an C<SV*> key.
981 Returns the key as an C<SV*>. Will create and return a temporary mortal
982 C<SV*> if the hash entry contains only a C<char*> key.
984 SV* HeSVKEY_force(HE* he)
991 Sets the key to a given C<SV*>, taking care to set the appropriate flags to
992 indicate the presence of an C<SV*> key, and returns the same
995 SV* HeSVKEY_set(HE* he, SV* sv)
1002 Returns the value slot (type C<SV*>) stored in the hash entry.
1011 Returns the package name of a stash. See C<SvSTASH>, C<CvSTASH>.
1013 char* HvNAME(HV* stash)
1020 Clears a hash, making it empty.
1022 void hv_clear(HV* tb)
1029 Deletes a key/value pair in the hash. The value SV is removed from the
1030 hash and returned to the caller. The C<klen> is the length of the key.
1031 The C<flags> value will normally be zero; if set to G_DISCARD then NULL
1034 SV* hv_delete(HV* tb, const char* key, I32 klen, I32 flags)
1041 Deletes a key/value pair in the hash. The value SV is removed from the
1042 hash and returned to the caller. The C<flags> value will normally be zero;
1043 if set to G_DISCARD then NULL will be returned. C<hash> can be a valid
1044 precomputed hash value, or 0 to ask for it to be computed.
1046 SV* hv_delete_ent(HV* tb, SV* key, I32 flags, U32 hash)
1053 Returns a boolean indicating whether the specified hash key exists. The
1054 C<klen> is the length of the key.
1056 bool hv_exists(HV* tb, const char* key, I32 klen)
1063 Returns a boolean indicating whether the specified hash key exists. C<hash>
1064 can be a valid precomputed hash value, or 0 to ask for it to be
1067 bool hv_exists_ent(HV* tb, SV* key, U32 hash)
1074 Returns the SV which corresponds to the specified key in the hash. The
1075 C<klen> is the length of the key. If C<lval> is set then the fetch will be
1076 part of a store. Check that the return value is non-null before
1077 dereferencing it to an C<SV*>.
1079 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1080 information on how to use this function on tied hashes.
1082 SV** hv_fetch(HV* tb, const char* key, I32 klen, I32 lval)
1089 Returns the hash entry which corresponds to the specified key in the hash.
1090 C<hash> must be a valid precomputed hash number for the given C<key>, or 0
1091 if you want the function to compute it. IF C<lval> is set then the fetch
1092 will be part of a store. Make sure the return value is non-null before
1093 accessing it. The return value when C<tb> is a tied hash is a pointer to a
1094 static location, so be sure to make a copy of the structure if you need to
1097 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1098 information on how to use this function on tied hashes.
1100 HE* hv_fetch_ent(HV* tb, SV* key, I32 lval, U32 hash)
1107 Prepares a starting point to traverse a hash table. Returns the number of
1108 keys in the hash (i.e. the same as C<HvKEYS(tb)>). The return value is
1109 currently only meaningful for hashes without tie magic.
1111 NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
1112 hash buckets that happen to be in use. If you still need that esoteric
1113 value, you can get it through the macro C<HvFILL(tb)>.
1116 I32 hv_iterinit(HV* tb)
1123 Returns the key from the current position of the hash iterator. See
1126 char* hv_iterkey(HE* entry, I32* retlen)
1133 Returns the key as an C<SV*> from the current position of the hash
1134 iterator. The return value will always be a mortal copy of the key. Also
1137 SV* hv_iterkeysv(HE* entry)
1144 Returns entries from a hash iterator. See C<hv_iterinit>.
1146 You may call C<hv_delete> or C<hv_delete_ent> on the hash entry that the
1147 iterator currently points to, without losing your place or invalidating your
1148 iterator. Note that in this case the current entry is deleted from the hash
1149 with your iterator holding the last reference to it. Your iterator is flagged
1150 to free the entry on the next call to C<hv_iternext>, so you must not discard
1151 your iterator immediately else the entry will leak - call C<hv_iternext> to
1152 trigger the resource deallocation.
1154 HE* hv_iternext(HV* tb)
1161 Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
1164 SV* hv_iternextsv(HV* hv, char** key, I32* retlen)
1169 =item hv_iternext_flags
1171 Returns entries from a hash iterator. See C<hv_iterinit> and C<hv_iternext>.
1172 The C<flags> value will normally be zero; if HV_ITERNEXT_WANTPLACEHOLDERS is
1173 set the placeholders keys (for restricted hashes) will be returned in addition
1174 to normal keys. By default placeholders are automatically skipped over.
1175 Currently a placeholder is implemented with a value that is literally
1176 <&Perl_sv_undef> (a regular C<undef> value is a normal read-write SV for which
1177 C<!SvOK> is false). Note that the implementation of placeholders and
1178 restricted hashes may change, and the implementation currently is
1179 insufficiently abstracted for any change to be tidy.
1181 NOTE: this function is experimental and may change or be
1182 removed without notice.
1184 HE* hv_iternext_flags(HV* tb, I32 flags)
1191 Returns the value from the current position of the hash iterator. See
1194 SV* hv_iterval(HV* tb, HE* entry)
1201 Adds magic to a hash. See C<sv_magic>.
1203 void hv_magic(HV* hv, GV* gv, int how)
1210 Stores an SV in a hash. The hash key is specified as C<key> and C<klen> is
1211 the length of the key. The C<hash> parameter is the precomputed hash
1212 value; if it is zero then Perl will compute it. The return value will be
1213 NULL if the operation failed or if the value did not need to be actually
1214 stored within the hash (as in the case of tied hashes). Otherwise it can
1215 be dereferenced to get the original C<SV*>. Note that the caller is
1216 responsible for suitably incrementing the reference count of C<val> before
1217 the call, and decrementing it if the function returned NULL.
1219 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1220 information on how to use this function on tied hashes.
1222 SV** hv_store(HV* tb, const char* key, I32 klen, SV* val, U32 hash)
1229 Stores C<val> in a hash. The hash key is specified as C<key>. The C<hash>
1230 parameter is the precomputed hash value; if it is zero then Perl will
1231 compute it. The return value is the new hash entry so created. It will be
1232 NULL if the operation failed or if the value did not need to be actually
1233 stored within the hash (as in the case of tied hashes). Otherwise the
1234 contents of the return value can be accessed using the C<He?> macros
1235 described here. Note that the caller is responsible for suitably
1236 incrementing the reference count of C<val> before the call, and
1237 decrementing it if the function returned NULL.
1239 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1240 information on how to use this function on tied hashes.
1242 HE* hv_store_ent(HV* tb, SV* key, SV* val, U32 hash)
1251 void hv_undef(HV* tb)
1258 Creates a new HV. The reference count is set to 1.
1276 =head1 Magical Functions
1282 Clear something magical that the SV represents. See C<sv_magic>.
1284 int mg_clear(SV* sv)
1291 Copies the magic from one SV to another. See C<sv_magic>.
1293 int mg_copy(SV* sv, SV* nsv, const char* key, I32 klen)
1300 Finds the magic pointer for type matching the SV. See C<sv_magic>.
1302 MAGIC* mg_find(SV* sv, int type)
1309 Free any magic storage used by the SV. See C<sv_magic>.
1318 Do magic after a value is retrieved from the SV. See C<sv_magic>.
1327 Report on the SV's length. See C<sv_magic>.
1329 U32 mg_length(SV* sv)
1336 Turns on the magical status of an SV. See C<sv_magic>.
1338 void mg_magical(SV* sv)
1345 Do magic after a value is assigned to the SV. See C<sv_magic>.
1354 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
1355 argument more than once.
1357 void SvGETMAGIC(SV* sv)
1364 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
1374 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
1375 argument more than once.
1377 void SvSETMAGIC(SV* sv)
1384 Like C<SvSetSV>, but does any set magic required afterwards.
1386 void SvSetMagicSV(SV* dsb, SV* ssv)
1391 =item SvSetMagicSV_nosteal
1393 Like C<SvSetMagicSV>, but does any set magic required afterwards.
1395 void SvSetMagicSV_nosteal(SV* dsv, SV* ssv)
1402 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
1405 void SvSetSV(SV* dsb, SV* ssv)
1410 =item SvSetSV_nosteal
1412 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
1413 ssv. May evaluate arguments more than once.
1415 void SvSetSV_nosteal(SV* dsv, SV* ssv)
1422 Arranges for sv to be shared between threads if a suitable module
1425 void SvSHARE(SV* sv)
1433 =head1 Memory Management
1439 The XSUB-writer's interface to the C C<memcpy> function. The C<src> is the
1440 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1441 the type. May fail on overlapping copies. See also C<Move>.
1443 void Copy(void* src, void* dest, int nitems, type)
1446 Found in file handy.h
1450 The XSUB-writer's interface to the C C<memmove> function. The C<src> is the
1451 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1452 the type. Can do overlapping moves. See also C<Copy>.
1454 void Move(void* src, void* dest, int nitems, type)
1457 Found in file handy.h
1461 The XSUB-writer's interface to the C C<malloc> function.
1463 void New(int id, void* ptr, int nitems, type)
1466 Found in file handy.h
1470 The XSUB-writer's interface to the C C<malloc> function, with
1473 void Newc(int id, void* ptr, int nitems, type, cast)
1476 Found in file handy.h
1480 Creates a new SV. A non-zero C<len> parameter indicates the number of
1481 bytes of preallocated string space the SV should have. An extra byte for a
1482 tailing NUL is also reserved. (SvPOK is not set for the SV even if string
1483 space is allocated.) The reference count for the new SV is set to 1.
1484 C<id> is an integer id between 0 and 1299 (used to identify leaks).
1487 SV* NEWSV(int id, STRLEN len)
1490 Found in file handy.h
1494 The XSUB-writer's interface to the C C<malloc> function. The allocated
1495 memory is zeroed with C<memzero>.
1497 void Newz(int id, void* ptr, int nitems, type)
1500 Found in file handy.h
1504 Fill up memory with a pattern (byte 0xAB over and over again) that
1505 hopefully catches attempts to access uninitialized memory.
1507 void Poison(void* dest, int nitems, type)
1510 Found in file handy.h
1514 The XSUB-writer's interface to the C C<realloc> function.
1516 void Renew(void* ptr, int nitems, type)
1519 Found in file handy.h
1523 The XSUB-writer's interface to the C C<realloc> function, with
1526 void Renewc(void* ptr, int nitems, type, cast)
1529 Found in file handy.h
1533 The XSUB-writer's interface to the C C<free> function.
1535 void Safefree(void* ptr)
1538 Found in file handy.h
1542 Perl's version of C<strdup()>. Returns a pointer to a newly allocated
1543 string which is a duplicate of C<pv>. The size of the string is
1544 determined by C<strlen()>. The memory allocated for the new string can
1545 be freed with the C<Safefree()> function.
1547 char* savepv(const char* pv)
1550 Found in file util.c
1554 Perl's version of what C<strndup()> would be if it existed. Returns a
1555 pointer to a newly allocated string which is a duplicate of the first
1556 C<len> bytes from C<pv>. The memory allocated for the new string can be
1557 freed with the C<Safefree()> function.
1559 char* savepvn(const char* pv, I32 len)
1562 Found in file util.c
1566 A version of C<savepv()> which allocates the duplicate string in memory
1567 which is shared between threads.
1569 char* savesharedpv(const char* pv)
1572 Found in file util.c
1576 This is an architecture-independent macro to copy one structure to another.
1578 void StructCopy(type src, type dest, type)
1581 Found in file handy.h
1585 The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the
1586 destination, C<nitems> is the number of items, and C<type> is the type.
1588 void Zero(void* dest, int nitems, type)
1591 Found in file handy.h
1596 =head1 Miscellaneous Functions
1602 Analyses the string in order to make fast searches on it using fbm_instr()
1603 -- the Boyer-Moore algorithm.
1605 void fbm_compile(SV* sv, U32 flags)
1608 Found in file util.c
1612 Returns the location of the SV in the string delimited by C<str> and
1613 C<strend>. It returns C<Nullch> if the string can't be found. The C<sv>
1614 does not have to be fbm_compiled, but the search will not be as fast
1617 char* fbm_instr(unsigned char* big, unsigned char* bigend, SV* littlesv, U32 flags)
1620 Found in file util.c
1624 Takes a sprintf-style format pattern and conventional
1625 (non-SV) arguments and returns the formatted string.
1627 (char *) Perl_form(pTHX_ const char* pat, ...)
1629 can be used any place a string (char *) is required:
1631 char * s = Perl_form("%d.%d",major,minor);
1633 Uses a single private buffer so if you want to format several strings you
1634 must explicitly copy the earlier strings away (and free the copies when you
1637 char* form(const char* pat, ...)
1640 Found in file util.c
1644 Fill the sv with current working directory
1646 int getcwd_sv(SV* sv)
1649 Found in file util.c
1653 Test two strings to see if they are equal. Returns true or false.
1655 bool strEQ(char* s1, char* s2)
1658 Found in file handy.h
1662 Test two strings to see if the first, C<s1>, is greater than or equal to
1663 the second, C<s2>. Returns true or false.
1665 bool strGE(char* s1, char* s2)
1668 Found in file handy.h
1672 Test two strings to see if the first, C<s1>, is greater than the second,
1673 C<s2>. Returns true or false.
1675 bool strGT(char* s1, char* s2)
1678 Found in file handy.h
1682 Test two strings to see if the first, C<s1>, is less than or equal to the
1683 second, C<s2>. Returns true or false.
1685 bool strLE(char* s1, char* s2)
1688 Found in file handy.h
1692 Test two strings to see if the first, C<s1>, is less than the second,
1693 C<s2>. Returns true or false.
1695 bool strLT(char* s1, char* s2)
1698 Found in file handy.h
1702 Test two strings to see if they are different. Returns true or
1705 bool strNE(char* s1, char* s2)
1708 Found in file handy.h
1712 Test two strings to see if they are equal. The C<len> parameter indicates
1713 the number of bytes to compare. Returns true or false. (A wrapper for
1716 bool strnEQ(char* s1, char* s2, STRLEN len)
1719 Found in file handy.h
1723 Test two strings to see if they are different. The C<len> parameter
1724 indicates the number of bytes to compare. Returns true or false. (A
1725 wrapper for C<strncmp>).
1727 bool strnNE(char* s1, char* s2, STRLEN len)
1730 Found in file handy.h
1735 =head1 Numeric functions
1741 converts a string representing a binary number to numeric form.
1743 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
1744 conversion flags, and I<result> should be NULL or a pointer to an NV.
1745 The scan stops at the end of the string, or the first invalid character.
1746 On return I<*len> is set to the length scanned string, and I<*flags> gives
1749 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
1750 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_bin>
1751 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
1752 and writes the value to I<*result> (or the value is discarded if I<result>
1755 The hex number may optionally be prefixed with "0b" or "b" unless
1756 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
1757 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the binary
1758 number may use '_' characters to separate digits.
1760 UV grok_bin(char* start, STRLEN* len, I32* flags, NV *result)
1763 Found in file numeric.c
1767 converts a string representing a hex number to numeric form.
1769 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
1770 conversion flags, and I<result> should be NULL or a pointer to an NV.
1771 The scan stops at the end of the string, or the first non-hex-digit character.
1772 On return I<*len> is set to the length scanned string, and I<*flags> gives
1775 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
1776 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_hex>
1777 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
1778 and writes the value to I<*result> (or the value is discarded if I<result>
1781 The hex number may optionally be prefixed with "0x" or "x" unless
1782 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
1783 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the hex
1784 number may use '_' characters to separate digits.
1786 UV grok_hex(char* start, STRLEN* len, I32* flags, NV *result)
1789 Found in file numeric.c
1793 Recognise (or not) a number. The type of the number is returned
1794 (0 if unrecognised), otherwise it is a bit-ORed combination of
1795 IS_NUMBER_IN_UV, IS_NUMBER_GREATER_THAN_UV_MAX, IS_NUMBER_NOT_INT,
1796 IS_NUMBER_NEG, IS_NUMBER_INFINITY, IS_NUMBER_NAN (defined in perl.h).
1798 If the value of the number can fit an in UV, it is returned in the *valuep
1799 IS_NUMBER_IN_UV will be set to indicate that *valuep is valid, IS_NUMBER_IN_UV
1800 will never be set unless *valuep is valid, but *valuep may have been assigned
1801 to during processing even though IS_NUMBER_IN_UV is not set on return.
1802 If valuep is NULL, IS_NUMBER_IN_UV will be set for the same cases as when
1803 valuep is non-NULL, but no actual assignment (or SEGV) will occur.
1805 IS_NUMBER_NOT_INT will be set with IS_NUMBER_IN_UV if trailing decimals were
1806 seen (in which case *valuep gives the true value truncated to an integer), and
1807 IS_NUMBER_NEG if the number is negative (in which case *valuep holds the
1808 absolute value). IS_NUMBER_IN_UV is not set if e notation was used or the
1809 number is larger than a UV.
1811 int grok_number(const char *pv, STRLEN len, UV *valuep)
1814 Found in file numeric.c
1816 =item grok_numeric_radix
1818 Scan and skip for a numeric decimal separator (radix).
1820 bool grok_numeric_radix(const char **sp, const char *send)
1823 Found in file numeric.c
1828 UV grok_oct(char* start, STRLEN* len, I32* flags, NV *result)
1831 Found in file numeric.c
1835 For backwards compatibility. Use C<grok_bin> instead.
1837 NV scan_bin(char* start, STRLEN len, STRLEN* retlen)
1840 Found in file numeric.c
1844 For backwards compatibility. Use C<grok_hex> instead.
1846 NV scan_hex(char* start, STRLEN len, STRLEN* retlen)
1849 Found in file numeric.c
1853 For backwards compatibility. Use C<grok_oct> instead.
1855 NV scan_oct(char* start, STRLEN len, STRLEN* retlen)
1858 Found in file numeric.c
1863 =head1 Optree Manipulation Functions
1869 If C<cv> is a constant sub eligible for inlining. returns the constant
1870 value returned by the sub. Otherwise, returns NULL.
1872 Constant subs can be created with C<newCONSTSUB> or as described in
1873 L<perlsub/"Constant Functions">.
1875 SV* cv_const_sv(CV* cv)
1882 Creates a constant sub equivalent to Perl C<sub FOO () { 123 }> which is
1883 eligible for inlining at compile-time.
1885 CV* newCONSTSUB(HV* stash, char* name, SV* sv)
1892 Used by C<xsubpp> to hook up XSUBs as Perl subs.
1900 =head1 Pad Data Structures
1906 Get the value at offset po in the current pad.
1907 Use macro PAD_SV instead of calling this function directly.
1909 SV* pad_sv(PADOFFSET po)
1917 =head1 Stack Manipulation Macros
1923 Declare a stack marker variable, C<mark>, for the XSUB. See C<MARK> and
1933 Saves the original stack mark for the XSUB. See C<ORIGMARK>.
1942 Declares a local copy of perl's stack pointer for the XSUB, available via
1943 the C<SP> macro. See C<SP>.
1952 Used to extend the argument stack for an XSUB's return values. Once
1953 used, guarantees that there is room for at least C<nitems> to be pushed
1956 void EXTEND(SP, int nitems)
1963 Stack marker variable for the XSUB. See C<dMARK>.
1970 The original stack mark for the XSUB. See C<dORIGMARK>.
1977 Pops an integer off the stack.
1986 Pops a long off the stack.
1995 Pops a double off the stack.
2004 Pops a string off the stack. Deprecated. New code should provide
2005 a STRLEN n_a and use POPpx.
2014 Pops a string off the stack which must consist of bytes i.e. characters < 256.
2015 Requires a variable STRLEN n_a in scope.
2024 Pops a string off the stack.
2025 Requires a variable STRLEN n_a in scope.
2034 Pops an SV off the stack.
2043 Push an integer onto the stack. The stack must have room for this element.
2044 Handles 'set' magic. See C<XPUSHi>.
2053 Opening bracket for arguments on a callback. See C<PUTBACK> and
2063 Push a double onto the stack. The stack must have room for this element.
2064 Handles 'set' magic. See C<XPUSHn>.
2073 Push a string onto the stack. The stack must have room for this element.
2074 The C<len> indicates the length of the string. Handles 'set' magic. See
2077 void PUSHp(char* str, STRLEN len)
2084 Push an SV onto the stack. The stack must have room for this element.
2085 Does not handle 'set' magic. See C<XPUSHs>.
2094 Push an unsigned integer onto the stack. The stack must have room for this
2095 element. See C<XPUSHu>.
2104 Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
2105 See C<PUSHMARK> and L<perlcall> for other uses.
2114 Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and
2122 Refetch the stack pointer. Used after a callback. See L<perlcall>.
2131 Push an integer onto the stack, extending the stack if necessary. Handles
2132 'set' magic. See C<PUSHi>.
2141 Push a double onto the stack, extending the stack if necessary. Handles
2142 'set' magic. See C<PUSHn>.
2151 Push a string onto the stack, extending the stack if necessary. The C<len>
2152 indicates the length of the string. Handles 'set' magic. See
2155 void XPUSHp(char* str, STRLEN len)
2162 Push an SV onto the stack, extending the stack if necessary. Does not
2163 handle 'set' magic. See C<PUSHs>.
2172 Push an unsigned integer onto the stack, extending the stack if necessary.
2182 Return from XSUB, indicating number of items on the stack. This is usually
2183 handled by C<xsubpp>.
2185 void XSRETURN(int nitems)
2188 Found in file XSUB.h
2192 Return an integer from an XSUB immediately. Uses C<XST_mIV>.
2194 void XSRETURN_IV(IV iv)
2197 Found in file XSUB.h
2201 Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
2206 Found in file XSUB.h
2210 Return a double from an XSUB immediately. Uses C<XST_mNV>.
2212 void XSRETURN_NV(NV nv)
2215 Found in file XSUB.h
2219 Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
2221 void XSRETURN_PV(char* str)
2224 Found in file XSUB.h
2226 =item XSRETURN_UNDEF
2228 Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
2233 Found in file XSUB.h
2237 Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
2242 Found in file XSUB.h
2246 Place an integer into the specified position C<pos> on the stack. The
2247 value is stored in a new mortal SV.
2249 void XST_mIV(int pos, IV iv)
2252 Found in file XSUB.h
2256 Place C<&PL_sv_no> into the specified position C<pos> on the
2259 void XST_mNO(int pos)
2262 Found in file XSUB.h
2266 Place a double into the specified position C<pos> on the stack. The value
2267 is stored in a new mortal SV.
2269 void XST_mNV(int pos, NV nv)
2272 Found in file XSUB.h
2276 Place a copy of a string into the specified position C<pos> on the stack.
2277 The value is stored in a new mortal SV.
2279 void XST_mPV(int pos, char* str)
2282 Found in file XSUB.h
2286 Place C<&PL_sv_undef> into the specified position C<pos> on the
2289 void XST_mUNDEF(int pos)
2292 Found in file XSUB.h
2296 Place C<&PL_sv_yes> into the specified position C<pos> on the
2299 void XST_mYES(int pos)
2302 Found in file XSUB.h
2313 An enum of flags for Perl types. These are found in the file B<sv.h>
2314 in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
2321 Integer type flag for scalars. See C<svtype>.
2328 Double type flag for scalars. See C<svtype>.
2335 Pointer type flag for scalars. See C<svtype>.
2342 Type flag for arrays. See C<svtype>.
2349 Type flag for code refs. See C<svtype>.
2356 Type flag for hashes. See C<svtype>.
2363 Type flag for blessed scalars. See C<svtype>.
2371 =head1 SV Manipulation Functions
2377 Returns the SV of the specified Perl scalar. If C<create> is set and the
2378 Perl variable does not exist then it will be created. If C<create> is not
2379 set and the variable does not exist then NULL is returned.
2381 NOTE: the perl_ form of this function is deprecated.
2383 SV* get_sv(const char* name, I32 create)
2386 Found in file perl.c
2388 =item looks_like_number
2390 Test if the content of an SV looks like a number (or is a number).
2391 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
2392 non-numeric warning), even if your atof() doesn't grok them.
2394 I32 looks_like_number(SV* sv)
2401 Creates an RV wrapper for an SV. The reference count for the original SV is
2404 SV* newRV_inc(SV* sv)
2411 Creates an RV wrapper for an SV. The reference count for the original
2412 SV is B<not> incremented.
2414 SV* newRV_noinc(SV *sv)
2421 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
2422 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
2425 SV* newSV(STRLEN len)
2432 Creates a new SV and copies an integer into it. The reference count for the
2442 Creates a new SV and copies a floating point value into it.
2443 The reference count for the SV is set to 1.
2452 Creates a new SV and copies a string into it. The reference count for the
2453 SV is set to 1. If C<len> is zero, Perl will compute the length using
2454 strlen(). For efficiency, consider using C<newSVpvn> instead.
2456 SV* newSVpv(const char* s, STRLEN len)
2463 Creates a new SV and initializes it with the string formatted like
2466 SV* newSVpvf(const char* pat, ...)
2473 Creates a new SV and copies a string into it. The reference count for the
2474 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
2475 string. You are responsible for ensuring that the source string is at least
2478 SV* newSVpvn(const char* s, STRLEN len)
2483 =item newSVpvn_share
2485 Creates a new SV with its SvPVX pointing to a shared string in the string
2486 table. If the string does not already exist in the table, it is created
2487 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
2488 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
2489 otherwise the hash is computed. The idea here is that as the string table
2490 is used for shared hash keys these strings will have SvPVX == HeKEY and
2491 hash lookup will avoid string compare.
2493 SV* newSVpvn_share(const char* s, I32 len, U32 hash)
2500 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
2501 it will be upgraded to one. If C<classname> is non-null then the new SV will
2502 be blessed in the specified package. The new SV is returned and its
2503 reference count is 1.
2505 SV* newSVrv(SV* rv, const char* classname)
2512 Creates a new SV which is an exact duplicate of the original SV.
2515 SV* newSVsv(SV* old)
2522 Creates a new SV and copies an unsigned integer into it.
2523 The reference count for the SV is set to 1.
2532 Returns a new version object based on the passed in SV:
2534 SV *sv = new_version(SV *ver);
2536 Does not alter the passed in ver SV. See "upg_version" if you
2537 want to upgrade the SV.
2539 SV* new_version(SV *ver)
2542 Found in file util.c
2546 Returns a pointer to the next character after the parsed
2547 version string, as well as upgrading the passed in SV to
2550 Function must be called with an already existing SV like
2553 s = scan_version(s,sv);
2555 Performs some preprocessing to the string to ensure that
2556 it has the correct characteristics of a version. Flags the
2557 object if it contains an underscore (which denotes this
2560 char* scan_version(char *vstr, SV *sv)
2563 Found in file util.c
2567 Returns a pointer to the next character after the parsed
2568 vstring, as well as updating the passed in sv.
2570 Function must be called like
2573 s = scan_vstring(s,sv);
2575 The sv should already be large enough to store the vstring
2576 passed in, for performance reasons.
2578 char* scan_vstring(char *vstr, SV *sv)
2581 Found in file util.c
2585 Returns the length of the string which is in the SV. See C<SvLEN>.
2587 STRLEN SvCUR(SV* sv)
2594 Set the length of the string which is in the SV. See C<SvCUR>.
2596 void SvCUR_set(SV* sv, STRLEN len)
2603 Returns a pointer to the last character in the string which is in the SV.
2604 See C<SvCUR>. Access the character as *(SvEND(sv)).
2613 Expands the character buffer in the SV so that it has room for the
2614 indicated number of bytes (remember to reserve space for an extra trailing
2615 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
2616 Returns a pointer to the character buffer.
2618 char * SvGROW(SV* sv, STRLEN len)
2625 Returns a boolean indicating whether the SV contains an integer.
2634 Returns a boolean indicating whether the SV contains an integer. Checks
2635 the B<private> setting. Use C<SvIOK>.
2644 Returns a boolean indicating whether the SV contains a signed integer.
2646 void SvIOK_notUV(SV* sv)
2653 Unsets the IV status of an SV.
2655 void SvIOK_off(SV* sv)
2662 Tells an SV that it is an integer.
2664 void SvIOK_on(SV* sv)
2671 Tells an SV that it is an integer and disables all other OK bits.
2673 void SvIOK_only(SV* sv)
2680 Tells and SV that it is an unsigned integer and disables all other OK bits.
2682 void SvIOK_only_UV(SV* sv)
2689 Returns a boolean indicating whether the SV contains an unsigned integer.
2691 void SvIOK_UV(SV* sv)
2698 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
2699 version which guarantees to evaluate sv only once.
2708 Coerces the given SV to an integer and returns it. Guarantees to evaluate
2709 sv only once. Use the more efficient C<SvIV> otherwise.
2718 Returns the raw value in the SV's IV slot, without checks or conversions.
2719 Only use when you are sure SvIOK is true. See also C<SvIV()>.
2728 Returns the size of the string buffer in the SV, not including any part
2729 attributable to C<SvOOK>. See C<SvCUR>.
2731 STRLEN SvLEN(SV* sv)
2738 Returns a boolean indicating whether the SV contains a number, integer or
2748 Returns a boolean indicating whether the SV contains a number, integer or
2749 double. Checks the B<private> setting. Use C<SvNIOK>.
2751 bool SvNIOKp(SV* sv)
2758 Unsets the NV/IV status of an SV.
2760 void SvNIOK_off(SV* sv)
2767 Returns a boolean indicating whether the SV contains a double.
2776 Returns a boolean indicating whether the SV contains a double. Checks the
2777 B<private> setting. Use C<SvNOK>.
2786 Unsets the NV status of an SV.
2788 void SvNOK_off(SV* sv)
2795 Tells an SV that it is a double.
2797 void SvNOK_on(SV* sv)
2804 Tells an SV that it is a double and disables all other OK bits.
2806 void SvNOK_only(SV* sv)
2813 Coerce the given SV to a double and return it. See C<SvNVx> for a version
2814 which guarantees to evaluate sv only once.
2823 Returns the raw value in the SV's NV slot, without checks or conversions.
2824 Only use when you are sure SvNOK is true. See also C<SvNV()>.
2833 Coerces the given SV to a double and returns it. Guarantees to evaluate
2834 sv only once. Use the more efficient C<SvNV> otherwise.
2843 Returns a boolean indicating whether the value is an SV.
2852 Returns a boolean indicating whether the SvIVX is a valid offset value for
2853 the SvPVX. This hack is used internally to speed up removal of characters
2854 from the beginning of a SvPV. When SvOOK is true, then the start of the
2855 allocated string buffer is really (SvPVX - SvIVX).
2864 Returns a boolean indicating whether the SV contains a character
2874 Returns a boolean indicating whether the SV contains a character string.
2875 Checks the B<private> setting. Use C<SvPOK>.
2884 Unsets the PV status of an SV.
2886 void SvPOK_off(SV* sv)
2893 Tells an SV that it is a string.
2895 void SvPOK_on(SV* sv)
2902 Tells an SV that it is a string and disables all other OK bits.
2903 Will also turn off the UTF8 status.
2905 void SvPOK_only(SV* sv)
2910 =item SvPOK_only_UTF8
2912 Tells an SV that it is a string and disables all other OK bits,
2913 and leaves the UTF8 status as it was.
2915 void SvPOK_only_UTF8(SV* sv)
2922 Returns a pointer to the string in the SV, or a stringified form of
2923 the SV if the SV does not contain a string. The SV may cache the
2924 stringified version becoming C<SvPOK>. Handles 'get' magic. See also
2925 C<SvPVx> for a version which guarantees to evaluate sv only once.
2927 char* SvPV(SV* sv, STRLEN len)
2934 Like C<SvPV>, but converts sv to byte representation first if necessary.
2936 char* SvPVbyte(SV* sv, STRLEN len)
2943 Like C<SvPV>, but converts sv to byte representation first if necessary.
2944 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
2948 char* SvPVbytex(SV* sv, STRLEN len)
2953 =item SvPVbytex_force
2955 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
2956 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
2959 char* SvPVbytex_force(SV* sv, STRLEN len)
2964 =item SvPVbyte_force
2966 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
2968 char* SvPVbyte_force(SV* sv, STRLEN len)
2973 =item SvPVbyte_nolen
2975 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
2977 char* SvPVbyte_nolen(SV* sv)
2984 Like C<SvPV>, but converts sv to utf8 first if necessary.
2986 char* SvPVutf8(SV* sv, STRLEN len)
2993 Like C<SvPV>, but converts sv to utf8 first if necessary.
2994 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
2997 char* SvPVutf8x(SV* sv, STRLEN len)
3002 =item SvPVutf8x_force
3004 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
3005 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
3008 char* SvPVutf8x_force(SV* sv, STRLEN len)
3013 =item SvPVutf8_force
3015 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
3017 char* SvPVutf8_force(SV* sv, STRLEN len)
3022 =item SvPVutf8_nolen
3024 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
3026 char* SvPVutf8_nolen(SV* sv)
3033 A version of C<SvPV> which guarantees to evaluate sv only once.
3035 char* SvPVx(SV* sv, STRLEN len)
3042 Returns a pointer to the physical string in the SV. The SV must contain a
3052 Like C<SvPV> but will force the SV into containing just a string
3053 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
3056 char* SvPV_force(SV* sv, STRLEN len)
3061 =item SvPV_force_nomg
3063 Like C<SvPV> but will force the SV into containing just a string
3064 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
3065 directly. Doesn't process magic.
3067 char* SvPV_force_nomg(SV* sv, STRLEN len)
3074 Returns a pointer to the string in the SV, or a stringified form of
3075 the SV if the SV does not contain a string. The SV may cache the
3076 stringified form becoming C<SvPOK>. Handles 'get' magic.
3078 char* SvPV_nolen(SV* sv)
3085 Returns the value of the object's reference count.
3087 U32 SvREFCNT(SV* sv)
3094 Decrements the reference count of the given SV.
3096 void SvREFCNT_dec(SV* sv)
3103 Increments the reference count of the given SV.
3105 SV* SvREFCNT_inc(SV* sv)
3112 Tests if the SV is an RV.
3121 Unsets the RV status of an SV.
3123 void SvROK_off(SV* sv)
3130 Tells an SV that it is an RV.
3132 void SvROK_on(SV* sv)
3139 Dereferences an RV to return the SV.
3148 Returns the stash of the SV.
3157 Taints an SV if tainting is enabled
3159 void SvTAINT(SV* sv)
3166 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
3169 bool SvTAINTED(SV* sv)
3176 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
3177 some of Perl's fundamental security features. XS module authors should not
3178 use this function unless they fully understand all the implications of
3179 unconditionally untainting the value. Untainting should be done in the
3180 standard perl fashion, via a carefully crafted regexp, rather than directly
3181 untainting variables.
3183 void SvTAINTED_off(SV* sv)
3190 Marks an SV as tainted.
3192 void SvTAINTED_on(SV* sv)
3199 Returns a boolean indicating whether Perl would evaluate the SV as true or
3200 false, defined or undefined. Does not handle 'get' magic.
3209 Returns the type of the SV. See C<svtype>.
3211 svtype SvTYPE(SV* sv)
3218 Releases a mutual exclusion lock on sv if a suitable module
3222 void SvUNLOCK(SV* sv)
3229 Returns a boolean indicating whether the SV contains an unsigned integer.
3238 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
3239 perform the upgrade if necessary. See C<svtype>.
3241 void SvUPGRADE(SV* sv, svtype type)
3248 Returns a boolean indicating whether the SV contains UTF-8 encoded data.
3257 Unsets the UTF8 status of an SV.
3259 void SvUTF8_off(SV *sv)
3266 Turn on the UTF8 status of an SV (the data is not changed, just the flag).
3267 Do not use frivolously.
3269 void SvUTF8_on(SV *sv)
3276 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
3277 for a version which guarantees to evaluate sv only once.
3286 Returns the raw value in the SV's UV slot, without checks or conversions.
3287 Only use when you are sure SvIOK is true. See also C<SvUV()>.
3296 Coerces the given SV to an unsigned integer and returns it. Guarantees to
3297 evaluate sv only once. Use the more efficient C<SvUV> otherwise.
3306 Returns a boolean indicating whether the SV contains a v-string.
3315 This function is only called on magical items, and is only used by
3316 sv_true() or its macro equivalent.
3318 bool sv_2bool(SV* sv)
3325 Using various gambits, try to get a CV from an SV; in addition, try if
3326 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
3328 CV* sv_2cv(SV* sv, HV** st, GV** gvp, I32 lref)
3335 Using various gambits, try to get an IO from an SV: the IO slot if its a
3336 GV; or the recursive result if we're an RV; or the IO slot of the symbol
3337 named after the PV if we're a string.
3346 Return the integer value of an SV, doing any necessary string conversion,
3347 magic etc. Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
3356 Marks an existing SV as mortal. The SV will be destroyed "soon", either
3357 by an explicit call to FREETMPS, or by an implicit call at places such as
3358 statement boundaries. See also C<sv_newmortal> and C<sv_mortalcopy>.
3360 SV* sv_2mortal(SV* sv)
3367 Return the num value of an SV, doing any necessary string or integer
3368 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
3378 Return a pointer to the byte-encoded representation of the SV, and set *lp
3379 to its length. May cause the SV to be downgraded from UTF8 as a
3382 Usually accessed via the C<SvPVbyte> macro.
3384 char* sv_2pvbyte(SV* sv, STRLEN* lp)
3389 =item sv_2pvbyte_nolen
3391 Return a pointer to the byte-encoded representation of the SV.
3392 May cause the SV to be downgraded from UTF8 as a side-effect.
3394 Usually accessed via the C<SvPVbyte_nolen> macro.
3396 char* sv_2pvbyte_nolen(SV* sv)
3403 Return a pointer to the UTF8-encoded representation of the SV, and set *lp
3404 to its length. May cause the SV to be upgraded to UTF8 as a side-effect.
3406 Usually accessed via the C<SvPVutf8> macro.
3408 char* sv_2pvutf8(SV* sv, STRLEN* lp)
3413 =item sv_2pvutf8_nolen
3415 Return a pointer to the UTF8-encoded representation of the SV.
3416 May cause the SV to be upgraded to UTF8 as a side-effect.
3418 Usually accessed via the C<SvPVutf8_nolen> macro.
3420 char* sv_2pvutf8_nolen(SV* sv)
3427 Returns a pointer to the string value of an SV, and sets *lp to its length.
3428 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
3430 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
3431 usually end up here too.
3433 char* sv_2pv_flags(SV* sv, STRLEN* lp, I32 flags)
3440 Like C<sv_2pv()>, but doesn't return the length too. You should usually
3441 use the macro wrapper C<SvPV_nolen(sv)> instead.
3442 char* sv_2pv_nolen(SV* sv)
3449 Return the unsigned integer value of an SV, doing any necessary string
3450 conversion, magic etc. Normally used via the C<SvUV(sv)> and C<SvUVx(sv)>
3460 Remove any string offset. You should normally use the C<SvOOK_off> macro
3463 int sv_backoff(SV* sv)
3470 Blesses an SV into a specified package. The SV must be an RV. The package
3471 must be designated by its stash (see C<gv_stashpv()>). The reference count
3472 of the SV is unaffected.
3474 SV* sv_bless(SV* sv, HV* stash)
3481 Concatenates the string onto the end of the string which is in the SV.
3482 If the SV has the UTF8 status set, then the bytes appended should be
3483 valid UTF8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
3485 void sv_catpv(SV* sv, const char* ptr)
3492 Processes its arguments like C<sprintf> and appends the formatted
3493 output to an SV. If the appended data contains "wide" characters
3494 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
3495 and characters >255 formatted with %c), the original SV might get
3496 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic.
3497 C<SvSETMAGIC()> must typically be called after calling this function
3498 to handle 'set' magic.
3500 void sv_catpvf(SV* sv, const char* pat, ...)
3507 Like C<sv_catpvf>, but also handles 'set' magic.
3509 void sv_catpvf_mg(SV *sv, const char* pat, ...)
3516 Concatenates the string onto the end of the string which is in the SV. The
3517 C<len> indicates number of bytes to copy. If the SV has the UTF8
3518 status set, then the bytes appended should be valid UTF8.
3519 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
3521 void sv_catpvn(SV* sv, const char* ptr, STRLEN len)
3526 =item sv_catpvn_flags
3528 Concatenates the string onto the end of the string which is in the SV. The
3529 C<len> indicates number of bytes to copy. If the SV has the UTF8
3530 status set, then the bytes appended should be valid UTF8.
3531 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
3532 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
3533 in terms of this function.
3535 void sv_catpvn_flags(SV* sv, const char* ptr, STRLEN len, I32 flags)
3542 Like C<sv_catpvn>, but also handles 'set' magic.
3544 void sv_catpvn_mg(SV *sv, const char *ptr, STRLEN len)
3551 Like C<sv_catpv>, but also handles 'set' magic.
3553 void sv_catpv_mg(SV *sv, const char *ptr)
3560 Concatenates the string from SV C<ssv> onto the end of the string in
3561 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
3562 not 'set' magic. See C<sv_catsv_mg>.
3564 void sv_catsv(SV* dsv, SV* ssv)
3569 =item sv_catsv_flags
3571 Concatenates the string from SV C<ssv> onto the end of the string in
3572 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
3573 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
3574 and C<sv_catsv_nomg> are implemented in terms of this function.
3576 void sv_catsv_flags(SV* dsv, SV* ssv, I32 flags)
3583 Like C<sv_catsv>, but also handles 'set' magic.
3585 void sv_catsv_mg(SV *dstr, SV *sstr)
3592 Efficient removal of characters from the beginning of the string buffer.
3593 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
3594 the string buffer. The C<ptr> becomes the first character of the adjusted
3595 string. Uses the "OOK hack".
3597 void sv_chop(SV* sv, char* ptr)
3604 Clear an SV: call any destructors, free up any memory used by the body,
3605 and free the body itself. The SV's head is I<not> freed, although
3606 its type is set to all 1's so that it won't inadvertently be assumed
3607 to be live during global destruction etc.
3608 This function should only be called when REFCNT is zero. Most of the time
3609 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
3612 void sv_clear(SV* sv)
3619 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
3620 string in C<sv1> is less than, equal to, or greater than the string in
3621 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
3622 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
3624 I32 sv_cmp(SV* sv1, SV* sv2)
3631 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
3632 'use bytes' aware, handles get magic, and will coerce its args to strings
3633 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
3635 I32 sv_cmp_locale(SV* sv1, SV* sv2)
3642 Add Collate Transform magic to an SV if it doesn't already have it.
3644 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
3645 scalar data of the variable, but transformed to such a format that a normal
3646 memory comparison can be used to compare the data according to the locale
3649 char* sv_collxfrm(SV* sv, STRLEN* nxp)
3656 Copies a stringified representation of the source SV into the
3657 destination SV. Automatically performs any necessary mg_get and
3658 coercion of numeric values into strings. Guaranteed to preserve
3659 UTF-8 flag even from overloaded objects. Similar in nature to
3660 sv_2pv[_flags] but operates directly on an SV instead of just the
3661 string. Mostly uses sv_2pv_flags to do its work, except when that
3662 would lose the UTF-8'ness of the PV.
3664 void sv_copypv(SV* dsv, SV* ssv)
3671 Auto-decrement of the value in the SV, doing string to numeric conversion
3672 if necessary. Handles 'get' magic.
3679 =item sv_derived_from
3681 Returns a boolean indicating whether the SV is derived from the specified
3682 class. This is the function that implements C<UNIVERSAL::isa>. It works
3683 for class names as well as for objects.
3685 bool sv_derived_from(SV* sv, const char* name)
3688 Found in file universal.c
3692 Returns a boolean indicating whether the strings in the two SVs are
3693 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
3694 coerce its args to strings if necessary.
3696 I32 sv_eq(SV* sv1, SV* sv2)
3701 =item sv_force_normal
3703 Undo various types of fakery on an SV: if the PV is a shared string, make
3704 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3705 an xpvmg. See also C<sv_force_normal_flags>.
3707 void sv_force_normal(SV *sv)
3712 =item sv_force_normal_flags
3714 Undo various types of fakery on an SV: if the PV is a shared string, make
3715 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3716 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
3717 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
3718 then a copy-on-write scalar drops its PV buffer (if any) and becomes
3719 SvPOK_off rather than making a copy. (Used where this scalar is about to be
3720 set to some other value. In addtion, the C<flags> parameter gets passed to
3721 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
3722 with flags set to 0.
3724 void sv_force_normal_flags(SV *sv, U32 flags)
3731 Decrement an SV's reference count, and if it drops to zero, call
3732 C<sv_clear> to invoke destructors and free up any memory used by
3733 the body; finally, deallocate the SV's head itself.
3734 Normally called via a wrapper macro C<SvREFCNT_dec>.
3736 void sv_free(SV* sv)
3743 Get a line from the filehandle and store it into the SV, optionally
3744 appending to the currently-stored string.
3746 char* sv_gets(SV* sv, PerlIO* fp, I32 append)
3753 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
3754 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
3755 Use the C<SvGROW> wrapper instead.
3757 char* sv_grow(SV* sv, STRLEN newlen)
3764 Auto-increment of the value in the SV, doing string to numeric conversion
3765 if necessary. Handles 'get' magic.
3774 Inserts a string at the specified offset/length within the SV. Similar to
3775 the Perl substr() function.
3777 void sv_insert(SV* bigsv, STRLEN offset, STRLEN len, char* little, STRLEN littlelen)
3784 Returns a boolean indicating whether the SV is blessed into the specified
3785 class. This does not check for subtypes; use C<sv_derived_from> to verify
3786 an inheritance relationship.
3788 int sv_isa(SV* sv, const char* name)
3795 Returns a boolean indicating whether the SV is an RV pointing to a blessed
3796 object. If the SV is not an RV, or if the object is not blessed, then this
3799 int sv_isobject(SV* sv)
3806 A private implementation of the C<SvIVx> macro for compilers which can't
3807 cope with complex macro expressions. Always use the macro instead.
3816 Returns the length of the string in the SV. Handles magic and type
3817 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
3819 STRLEN sv_len(SV* sv)
3826 Returns the number of characters in the string in an SV, counting wide
3827 UTF8 bytes as a single character. Handles magic and type coercion.
3829 STRLEN sv_len_utf8(SV* sv)
3836 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
3837 then adds a new magic item of type C<how> to the head of the magic list.
3839 void sv_magic(SV* sv, SV* obj, int how, const char* name, I32 namlen)
3846 Adds magic to an SV, upgrading it if necessary. Applies the
3847 supplied vtable and returns pointer to the magic added.
3849 Note that sv_magicext will allow things that sv_magic will not.
3850 In particular you can add magic to SvREADONLY SVs and and more than
3851 one instance of the same 'how'
3853 I C<namelen> is greater then zero then a savepvn() I<copy> of C<name> is stored,
3854 if C<namelen> is zero then C<name> is stored as-is and - as another special
3855 case - if C<(name && namelen == HEf_SVKEY)> then C<name> is assumed to contain
3856 an C<SV*> and has its REFCNT incremented
3858 (This is now used as a subroutine by sv_magic.)
3860 MAGIC * sv_magicext(SV* sv, SV* obj, int how, MGVTBL *vtbl, const char* name, I32 namlen )
3867 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
3868 The new SV is marked as mortal. It will be destroyed "soon", either by an
3869 explicit call to FREETMPS, or by an implicit call at places such as
3870 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
3872 SV* sv_mortalcopy(SV* oldsv)
3879 Creates a new null SV which is mortal. The reference count of the SV is
3880 set to 1. It will be destroyed "soon", either by an explicit call to
3881 FREETMPS, or by an implicit call at places such as statement boundaries.
3882 See also C<sv_mortalcopy> and C<sv_2mortal>.
3891 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
3894 SV* sv_newref(SV* sv)
3901 Dummy routine which "locks" an SV when there is no locking module present.
3902 Exists to avoid test for a NULL function pointer and because it could potentially warn under
3903 some level of strict-ness.
3905 void sv_nolocking(SV *)
3908 Found in file util.c
3912 Dummy routine which "shares" an SV when there is no sharing module present.
3913 Exists to avoid test for a NULL function pointer and because it could potentially warn under
3914 some level of strict-ness.
3916 void sv_nosharing(SV *)
3919 Found in file util.c
3921 =item sv_nounlocking
3923 Dummy routine which "unlocks" an SV when there is no locking module present.
3924 Exists to avoid test for a NULL function pointer and because it could potentially warn under
3925 some level of strict-ness.
3927 void sv_nounlocking(SV *)
3930 Found in file util.c
3934 A private implementation of the C<SvNVx> macro for compilers which can't
3935 cope with complex macro expressions. Always use the macro instead.
3944 Converts the value pointed to by offsetp from a count of bytes from the
3945 start of the string, to a count of the equivalent number of UTF8 chars.
3946 Handles magic and type coercion.
3948 void sv_pos_b2u(SV* sv, I32* offsetp)
3955 Converts the value pointed to by offsetp from a count of UTF8 chars from
3956 the start of the string, to a count of the equivalent number of bytes; if
3957 lenp is non-zero, it does the same to lenp, but this time starting from
3958 the offset, rather than from the start of the string. Handles magic and
3961 void sv_pos_u2b(SV* sv, I32* offsetp, I32* lenp)
3968 Use the C<SvPV_nolen> macro instead
3977 Use C<SvPVbyte_nolen> instead.
3979 char* sv_pvbyte(SV *sv)
3986 A private implementation of the C<SvPVbyte> macro for compilers
3987 which can't cope with complex macro expressions. Always use the macro
3990 char* sv_pvbyten(SV *sv, STRLEN *len)
3995 =item sv_pvbyten_force
3997 A private implementation of the C<SvPVbytex_force> macro for compilers
3998 which can't cope with complex macro expressions. Always use the macro
4001 char* sv_pvbyten_force(SV* sv, STRLEN* lp)
4008 A private implementation of the C<SvPV> macro for compilers which can't
4009 cope with complex macro expressions. Always use the macro instead.
4011 char* sv_pvn(SV *sv, STRLEN *len)
4018 Get a sensible string out of the SV somehow.
4019 A private implementation of the C<SvPV_force> macro for compilers which
4020 can't cope with complex macro expressions. Always use the macro instead.
4022 char* sv_pvn_force(SV* sv, STRLEN* lp)
4027 =item sv_pvn_force_flags
4029 Get a sensible string out of the SV somehow.
4030 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
4031 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
4032 implemented in terms of this function.
4033 You normally want to use the various wrapper macros instead: see
4034 C<SvPV_force> and C<SvPV_force_nomg>
4036 char* sv_pvn_force_flags(SV* sv, STRLEN* lp, I32 flags)
4043 Use the C<SvPVutf8_nolen> macro instead
4045 char* sv_pvutf8(SV *sv)
4052 A private implementation of the C<SvPVutf8> macro for compilers
4053 which can't cope with complex macro expressions. Always use the macro
4056 char* sv_pvutf8n(SV *sv, STRLEN *len)
4061 =item sv_pvutf8n_force
4063 A private implementation of the C<SvPVutf8_force> macro for compilers
4064 which can't cope with complex macro expressions. Always use the macro
4067 char* sv_pvutf8n_force(SV* sv, STRLEN* lp)
4074 Returns a string describing what the SV is a reference to.
4076 char* sv_reftype(SV* sv, int ob)
4083 Make the first argument a copy of the second, then delete the original.
4084 The target SV physically takes over ownership of the body of the source SV
4085 and inherits its flags; however, the target keeps any magic it owns,
4086 and any magic in the source is discarded.
4087 Note that this is a rather specialist SV copying operation; most of the
4088 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4090 void sv_replace(SV* sv, SV* nsv)
4095 =item sv_report_used
4097 Dump the contents of all SVs not yet freed. (Debugging aid).
4099 void sv_report_used()
4106 Underlying implementation for the C<reset> Perl function.
4107 Note that the perl-level function is vaguely deprecated.
4109 void sv_reset(char* s, HV* stash)
4116 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4117 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4118 push a back-reference to this RV onto the array of backreferences
4119 associated with that magic.
4121 SV* sv_rvweaken(SV *sv)
4128 Copies an integer into the given SV, upgrading first if necessary.
4129 Does not handle 'set' magic. See also C<sv_setiv_mg>.
4131 void sv_setiv(SV* sv, IV num)
4138 Like C<sv_setiv>, but also handles 'set' magic.
4140 void sv_setiv_mg(SV *sv, IV i)
4147 Copies a double into the given SV, upgrading first if necessary.
4148 Does not handle 'set' magic. See also C<sv_setnv_mg>.
4150 void sv_setnv(SV* sv, NV num)
4157 Like C<sv_setnv>, but also handles 'set' magic.
4159 void sv_setnv_mg(SV *sv, NV num)
4166 Copies a string into an SV. The string must be null-terminated. Does not
4167 handle 'set' magic. See C<sv_setpv_mg>.
4169 void sv_setpv(SV* sv, const char* ptr)
4176 Processes its arguments like C<sprintf> and sets an SV to the formatted
4177 output. Does not handle 'set' magic. See C<sv_setpvf_mg>.
4179 void sv_setpvf(SV* sv, const char* pat, ...)
4186 Like C<sv_setpvf>, but also handles 'set' magic.
4188 void sv_setpvf_mg(SV *sv, const char* pat, ...)
4195 Copies a string into an SV. The C<len> parameter indicates the number of
4196 bytes to be copied. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4198 void sv_setpvn(SV* sv, const char* ptr, STRLEN len)
4205 Like C<sv_setpvn>, but also handles 'set' magic.
4207 void sv_setpvn_mg(SV *sv, const char *ptr, STRLEN len)
4214 Like C<sv_setpv>, but also handles 'set' magic.
4216 void sv_setpv_mg(SV *sv, const char *ptr)
4223 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
4224 argument will be upgraded to an RV. That RV will be modified to point to
4225 the new SV. The C<classname> argument indicates the package for the
4226 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4227 will be returned and will have a reference count of 1.
4229 SV* sv_setref_iv(SV* rv, const char* classname, IV iv)
4236 Copies a double into a new SV, optionally blessing the SV. The C<rv>
4237 argument will be upgraded to an RV. That RV will be modified to point to
4238 the new SV. The C<classname> argument indicates the package for the
4239 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4240 will be returned and will have a reference count of 1.
4242 SV* sv_setref_nv(SV* rv, const char* classname, NV nv)
4249 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
4250 argument will be upgraded to an RV. That RV will be modified to point to
4251 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
4252 into the SV. The C<classname> argument indicates the package for the
4253 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4254 will be returned and will have a reference count of 1.
4256 Do not use with other Perl types such as HV, AV, SV, CV, because those
4257 objects will become corrupted by the pointer copy process.
4259 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
4261 SV* sv_setref_pv(SV* rv, const char* classname, void* pv)
4268 Copies a string into a new SV, optionally blessing the SV. The length of the
4269 string must be specified with C<n>. The C<rv> argument will be upgraded to
4270 an RV. That RV will be modified to point to the new SV. The C<classname>
4271 argument indicates the package for the blessing. Set C<classname> to
4272 C<Nullch> to avoid the blessing. The new SV will be returned and will have
4273 a reference count of 1.
4275 Note that C<sv_setref_pv> copies the pointer while this copies the string.
4277 SV* sv_setref_pvn(SV* rv, const char* classname, char* pv, STRLEN n)
4284 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
4285 argument will be upgraded to an RV. That RV will be modified to point to
4286 the new SV. The C<classname> argument indicates the package for the
4287 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4288 will be returned and will have a reference count of 1.
4290 SV* sv_setref_uv(SV* rv, const char* classname, UV uv)
4297 Copies the contents of the source SV C<ssv> into the destination SV
4298 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4299 function if the source SV needs to be reused. Does not handle 'set' magic.
4300 Loosely speaking, it performs a copy-by-value, obliterating any previous
4301 content of the destination.
4303 You probably want to use one of the assortment of wrappers, such as
4304 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4305 C<SvSetMagicSV_nosteal>.
4307 void sv_setsv(SV* dsv, SV* ssv)
4312 =item sv_setsv_flags
4314 Copies the contents of the source SV C<ssv> into the destination SV
4315 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4316 function if the source SV needs to be reused. Does not handle 'set' magic.
4317 Loosely speaking, it performs a copy-by-value, obliterating any previous
4318 content of the destination.
4319 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
4320 C<ssv> if appropriate, else not. C<sv_setsv> and C<sv_setsv_nomg> are
4321 implemented in terms of this function.
4323 You probably want to use one of the assortment of wrappers, such as
4324 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4325 C<SvSetMagicSV_nosteal>.
4327 This is the primary function for copying scalars, and most other
4328 copy-ish functions and macros use this underneath.
4330 void sv_setsv_flags(SV* dsv, SV* ssv, I32 flags)
4337 Like C<sv_setsv>, but also handles 'set' magic.
4339 void sv_setsv_mg(SV *dstr, SV *sstr)
4346 Copies an unsigned integer into the given SV, upgrading first if necessary.
4347 Does not handle 'set' magic. See also C<sv_setuv_mg>.
4349 void sv_setuv(SV* sv, UV num)
4356 Like C<sv_setuv>, but also handles 'set' magic.
4358 void sv_setuv_mg(SV *sv, UV u)
4365 Taint an SV. Use C<SvTAINTED_on> instead.
4366 void sv_taint(SV* sv)
4373 Test an SV for taintedness. Use C<SvTAINTED> instead.
4374 bool sv_tainted(SV* sv)
4381 Returns true if the SV has a true value by Perl's rules.
4382 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
4383 instead use an in-line version.
4392 Removes all magic of type C<type> from an SV.
4394 int sv_unmagic(SV* sv, int type)
4401 Unsets the RV status of the SV, and decrements the reference count of
4402 whatever was being referenced by the RV. This can almost be thought of
4403 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
4404 being zero. See C<SvROK_off>.
4406 void sv_unref(SV* sv)
4411 =item sv_unref_flags
4413 Unsets the RV status of the SV, and decrements the reference count of
4414 whatever was being referenced by the RV. This can almost be thought of
4415 as a reversal of C<newSVrv>. The C<cflags> argument can contain
4416 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
4417 (otherwise the decrementing is conditional on the reference count being
4418 different from one or the reference being a readonly SV).
4421 void sv_unref_flags(SV* sv, U32 flags)
4428 Untaint an SV. Use C<SvTAINTED_off> instead.
4429 void sv_untaint(SV* sv)
4436 Upgrade an SV to a more complex form. Generally adds a new body type to the
4437 SV, then copies across as much information as possible from the old body.
4438 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
4440 bool sv_upgrade(SV* sv, U32 mt)
4447 Tells an SV to use C<ptr> to find its string value. Normally the string is
4448 stored inside the SV but sv_usepvn allows the SV to use an outside string.
4449 The C<ptr> should point to memory that was allocated by C<malloc>. The
4450 string length, C<len>, must be supplied. This function will realloc the
4451 memory pointed to by C<ptr>, so that pointer should not be freed or used by
4452 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
4453 See C<sv_usepvn_mg>.
4455 void sv_usepvn(SV* sv, char* ptr, STRLEN len)
4462 Like C<sv_usepvn>, but also handles 'set' magic.
4464 void sv_usepvn_mg(SV *sv, char *ptr, STRLEN len)
4469 =item sv_utf8_decode
4471 Convert the octets in the PV from UTF-8 to chars. Scan for validity and then
4472 turn off SvUTF8 if needed so that we see characters. Used as a building block
4473 for decode_utf8 in Encode.xs
4475 NOTE: this function is experimental and may change or be
4476 removed without notice.
4478 bool sv_utf8_decode(SV *sv)
4483 =item sv_utf8_downgrade
4485 Attempt to convert the PV of an SV from UTF8-encoded to byte encoding.
4486 This may not be possible if the PV contains non-byte encoding characters;
4487 if this is the case, either returns false or, if C<fail_ok> is not
4490 This is not as a general purpose Unicode to byte encoding interface:
4491 use the Encode extension for that.
4493 NOTE: this function is experimental and may change or be
4494 removed without notice.
4496 bool sv_utf8_downgrade(SV *sv, bool fail_ok)
4501 =item sv_utf8_encode
4503 Convert the PV of an SV to UTF8-encoded, but then turn off the C<SvUTF8>
4504 flag so that it looks like octets again. Used as a building block
4505 for encode_utf8 in Encode.xs
4507 void sv_utf8_encode(SV *sv)
4512 =item sv_utf8_upgrade
4514 Convert the PV of an SV to its UTF8-encoded form.
4515 Forces the SV to string form if it is not already.
4516 Always sets the SvUTF8 flag to avoid future validity checks even
4517 if all the bytes have hibit clear.
4519 This is not as a general purpose byte encoding to Unicode interface:
4520 use the Encode extension for that.
4522 STRLEN sv_utf8_upgrade(SV *sv)
4527 =item sv_utf8_upgrade_flags
4529 Convert the PV of an SV to its UTF8-encoded form.
4530 Forces the SV to string form if it is not already.
4531 Always sets the SvUTF8 flag to avoid future validity checks even
4532 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
4533 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
4534 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
4536 This is not as a general purpose byte encoding to Unicode interface:
4537 use the Encode extension for that.
4539 STRLEN sv_utf8_upgrade_flags(SV *sv, I32 flags)
4546 A private implementation of the C<SvUVx> macro for compilers which can't
4547 cope with complex macro expressions. Always use the macro instead.
4556 Processes its arguments like C<vsprintf> and appends the formatted output
4557 to an SV. Uses an array of SVs if the C style variable argument list is
4558 missing (NULL). When running with taint checks enabled, indicates via
4559 C<maybe_tainted> if results are untrustworthy (often due to the use of
4562 Usually used via one of its frontends C<sv_catpvf> and C<sv_catpvf_mg>.
4564 void sv_vcatpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
4571 Works like C<vcatpvfn> but copies the text into the SV instead of
4574 Usually used via one of its frontends C<sv_setpvf> and C<sv_setpvf_mg>.
4576 void sv_vsetpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
4583 In-place upgrade of the supplied SV to a version object.
4585 SV *sv = upg_version(SV *sv);
4587 Returns a pointer to the upgraded SV.
4589 SV* upg_version(SV *ver)
4592 Found in file util.c
4596 Version object aware cmp. Both operands must already have been
4597 converted into version objects.
4599 int vcmp(SV *lvs, SV *rvs)
4602 Found in file util.c
4606 Accepts a version object and returns the normalized floating
4607 point representation. Call like:
4611 NOTE: you can pass either the object directly or the SV
4612 contained within the RV.
4617 Found in file util.c
4621 Accepts a version object and returns the normalized string
4622 representation. Call like:
4624 sv = vstringify(rv);
4626 NOTE: you can pass either the object directly or the SV
4627 contained within the RV.
4629 SV* vstringify(SV *vs)
4632 Found in file util.c
4637 =head1 Unicode Support
4641 =item bytes_from_utf8
4643 Converts a string C<s> of length C<len> from UTF8 into byte encoding.
4644 Unlike <utf8_to_bytes> but like C<bytes_to_utf8>, returns a pointer to
4645 the newly-created string, and updates C<len> to contain the new
4646 length. Returns the original string if no conversion occurs, C<len>
4647 is unchanged. Do nothing if C<is_utf8> points to 0. Sets C<is_utf8> to
4648 0 if C<s> is converted or contains all 7bit characters.
4650 NOTE: this function is experimental and may change or be
4651 removed without notice.
4653 U8* bytes_from_utf8(U8 *s, STRLEN *len, bool *is_utf8)
4656 Found in file utf8.c
4660 Converts a string C<s> of length C<len> from ASCII into UTF8 encoding.
4661 Returns a pointer to the newly-created string, and sets C<len> to
4662 reflect the new length.
4664 NOTE: this function is experimental and may change or be
4665 removed without notice.
4667 U8* bytes_to_utf8(U8 *s, STRLEN *len)
4670 Found in file utf8.c
4674 Return true if the strings s1 and s2 differ case-insensitively, false
4675 if not (if they are equal case-insensitively). If u1 is true, the
4676 string s1 is assumed to be in UTF-8-encoded Unicode. If u2 is true,
4677 the string s2 is assumed to be in UTF-8-encoded Unicode. If u1 or u2
4678 are false, the respective string is assumed to be in native 8-bit
4681 If the pe1 and pe2 are non-NULL, the scanning pointers will be copied
4682 in there (they will point at the beginning of the I<next> character).
4683 If the pointers behind pe1 or pe2 are non-NULL, they are the end
4684 pointers beyond which scanning will not continue under any
4685 circustances. If the byte lengths l1 and l2 are non-zero, s1+l1 and
4686 s2+l2 will be used as goal end pointers that will also stop the scan,
4687 and which qualify towards defining a successful match: all the scans
4688 that define an explicit length must reach their goal pointers for
4689 a match to succeed).
4691 For case-insensitiveness, the "casefolding" of Unicode is used
4692 instead of upper/lowercasing both the characters, see
4693 http://www.unicode.org/unicode/reports/tr21/ (Case Mappings).
4695 I32 ibcmp_utf8(const char* a, char **pe1, UV l1, bool u1, const char* b, char **pe2, UV l2, bool u2)
4698 Found in file utf8.c
4702 Tests if some arbitrary number of bytes begins in a valid UTF-8
4703 character. Note that an INVARIANT (i.e. ASCII) character is a valid
4704 UTF-8 character. The actual number of bytes in the UTF-8 character
4705 will be returned if it is valid, otherwise 0.
4707 STRLEN is_utf8_char(U8 *p)
4710 Found in file utf8.c
4712 =item is_utf8_string
4714 Returns true if first C<len> bytes of the given string form a valid UTF8
4715 string, false otherwise. Note that 'a valid UTF8 string' does not mean
4716 'a string that contains UTF8' because a valid ASCII string is a valid
4719 bool is_utf8_string(U8 *s, STRLEN len)
4722 Found in file utf8.c
4724 =item pv_uni_display
4726 Build to the scalar dsv a displayable version of the string spv,
4727 length len, the displayable version being at most pvlim bytes long
4728 (if longer, the rest is truncated and "..." will be appended).
4730 The flags argument can have UNI_DISPLAY_ISPRINT set to display
4731 isPRINT()able characters as themselves, UNI_DISPLAY_BACKSLASH
4732 to display the \\[nrfta\\] as the backslashed versions (like '\n')
4733 (UNI_DISPLAY_BACKSLASH is preferred over UNI_DISPLAY_ISPRINT for \\).
4734 UNI_DISPLAY_QQ (and its alias UNI_DISPLAY_REGEX) have both
4735 UNI_DISPLAY_BACKSLASH and UNI_DISPLAY_ISPRINT turned on.
4737 The pointer to the PV of the dsv is returned.
4739 char* pv_uni_display(SV *dsv, U8 *spv, STRLEN len, STRLEN pvlim, UV flags)
4742 Found in file utf8.c
4744 =item sv_recode_to_utf8
4746 The encoding is assumed to be an Encode object, on entry the PV
4747 of the sv is assumed to be octets in that encoding, and the sv
4748 will be converted into Unicode (and UTF-8).
4750 If the sv already is UTF-8 (or if it is not POK), or if the encoding
4751 is not a reference, nothing is done to the sv. If the encoding is not
4752 an C<Encode::XS> Encoding object, bad things will happen.
4753 (See F<lib/encoding.pm> and L<Encode>).
4755 The PV of the sv is returned.
4757 char* sv_recode_to_utf8(SV* sv, SV *encoding)
4762 =item sv_uni_display
4764 Build to the scalar dsv a displayable version of the scalar sv,
4765 the displayable version being at most pvlim bytes long
4766 (if longer, the rest is truncated and "..." will be appended).
4768 The flags argument is as in pv_uni_display().
4770 The pointer to the PV of the dsv is returned.
4772 char* sv_uni_display(SV *dsv, SV *ssv, STRLEN pvlim, UV flags)
4775 Found in file utf8.c
4779 The "p" contains the pointer to the UTF-8 string encoding
4780 the character that is being converted.
4782 The "ustrp" is a pointer to the character buffer to put the
4783 conversion result to. The "lenp" is a pointer to the length
4786 The "swashp" is a pointer to the swash to use.
4788 Both the special and normal mappings are stored lib/unicore/To/Foo.pl,
4789 and loaded by SWASHGET, using lib/utf8_heavy.pl. The special (usually,
4790 but not always, a multicharacter mapping), is tried first.
4792 The "special" is a string like "utf8::ToSpecLower", which means the
4793 hash %utf8::ToSpecLower. The access to the hash is through
4794 Perl_to_utf8_case().
4796 The "normal" is a string like "ToLower" which means the swash
4799 UV to_utf8_case(U8 *p, U8* ustrp, STRLEN *lenp, SV **swash, char *normal, char *special)
4802 Found in file utf8.c
4806 Convert the UTF-8 encoded character at p to its foldcase version and
4807 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
4808 that the ustrp needs to be at least UTF8_MAXLEN_FOLD+1 bytes since the
4809 foldcase version may be longer than the original character (up to
4812 The first character of the foldcased version is returned
4813 (but note, as explained above, that there may be more.)
4815 UV to_utf8_fold(U8 *p, U8* ustrp, STRLEN *lenp)
4818 Found in file utf8.c
4822 Convert the UTF-8 encoded character at p to its lowercase version and
4823 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
4824 that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the
4825 lowercase version may be longer than the original character (up to two
4828 The first character of the lowercased version is returned
4829 (but note, as explained above, that there may be more.)
4831 UV to_utf8_lower(U8 *p, U8* ustrp, STRLEN *lenp)
4834 Found in file utf8.c
4838 Convert the UTF-8 encoded character at p to its titlecase version and
4839 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
4840 that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the
4841 titlecase version may be longer than the original character (up to two
4844 The first character of the titlecased version is returned
4845 (but note, as explained above, that there may be more.)
4847 UV to_utf8_title(U8 *p, U8* ustrp, STRLEN *lenp)
4850 Found in file utf8.c
4854 Convert the UTF-8 encoded character at p to its uppercase version and
4855 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
4856 that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the
4857 uppercase version may be longer than the original character (up to two
4860 The first character of the uppercased version is returned
4861 (but note, as explained above, that there may be more.)
4863 UV to_utf8_upper(U8 *p, U8* ustrp, STRLEN *lenp)
4866 Found in file utf8.c
4868 =item utf8n_to_uvchr
4870 Returns the native character value of the first character in the string C<s>
4871 which is assumed to be in UTF8 encoding; C<retlen> will be set to the
4872 length, in bytes, of that character.
4874 Allows length and flags to be passed to low level routine.
4876 UV utf8n_to_uvchr(U8 *s, STRLEN curlen, STRLEN* retlen, U32 flags)
4879 Found in file utf8.c
4881 =item utf8n_to_uvuni
4883 Bottom level UTF-8 decode routine.
4884 Returns the unicode code point value of the first character in the string C<s>
4885 which is assumed to be in UTF8 encoding and no longer than C<curlen>;
4886 C<retlen> will be set to the length, in bytes, of that character.
4888 If C<s> does not point to a well-formed UTF8 character, the behaviour
4889 is dependent on the value of C<flags>: if it contains UTF8_CHECK_ONLY,
4890 it is assumed that the caller will raise a warning, and this function
4891 will silently just set C<retlen> to C<-1> and return zero. If the
4892 C<flags> does not contain UTF8_CHECK_ONLY, warnings about
4893 malformations will be given, C<retlen> will be set to the expected
4894 length of the UTF-8 character in bytes, and zero will be returned.
4896 The C<flags> can also contain various flags to allow deviations from
4897 the strict UTF-8 encoding (see F<utf8.h>).
4899 Most code should use utf8_to_uvchr() rather than call this directly.
4901 UV utf8n_to_uvuni(U8 *s, STRLEN curlen, STRLEN* retlen, U32 flags)
4904 Found in file utf8.c
4908 Returns the number of UTF8 characters between the UTF-8 pointers C<a>
4911 WARNING: use only if you *know* that the pointers point inside the
4914 IV utf8_distance(U8 *a, U8 *b)
4917 Found in file utf8.c
4921 Return the UTF-8 pointer C<s> displaced by C<off> characters, either
4922 forward or backward.
4924 WARNING: do not use the following unless you *know* C<off> is within
4925 the UTF-8 data pointed to by C<s> *and* that on entry C<s> is aligned
4926 on the first byte of character or just after the last byte of a character.
4928 U8* utf8_hop(U8 *s, I32 off)
4931 Found in file utf8.c
4935 Return the length of the UTF-8 char encoded string C<s> in characters.
4936 Stops at C<e> (inclusive). If C<e E<lt> s> or if the scan would end
4937 up past C<e>, croaks.
4939 STRLEN utf8_length(U8* s, U8 *e)
4942 Found in file utf8.c
4946 Converts a string C<s> of length C<len> from UTF8 into byte encoding.
4947 Unlike C<bytes_to_utf8>, this over-writes the original string, and
4948 updates len to contain the new length.
4949 Returns zero on failure, setting C<len> to -1.
4951 NOTE: this function is experimental and may change or be
4952 removed without notice.
4954 U8* utf8_to_bytes(U8 *s, STRLEN *len)
4957 Found in file utf8.c
4961 Returns the native character value of the first character in the string C<s>
4962 which is assumed to be in UTF8 encoding; C<retlen> will be set to the
4963 length, in bytes, of that character.
4965 If C<s> does not point to a well-formed UTF8 character, zero is
4966 returned and retlen is set, if possible, to -1.
4968 UV utf8_to_uvchr(U8 *s, STRLEN* retlen)
4971 Found in file utf8.c
4975 Returns the Unicode code point of the first character in the string C<s>
4976 which is assumed to be in UTF8 encoding; C<retlen> will be set to the
4977 length, in bytes, of that character.
4979 This function should only be used when returned UV is considered
4980 an index into the Unicode semantic tables (e.g. swashes).
4982 If C<s> does not point to a well-formed UTF8 character, zero is
4983 returned and retlen is set, if possible, to -1.
4985 UV utf8_to_uvuni(U8 *s, STRLEN* retlen)
4988 Found in file utf8.c
4992 Adds the UTF8 representation of the Native codepoint C<uv> to the end
4993 of the string C<d>; C<d> should be have at least C<UTF8_MAXLEN+1> free
4994 bytes available. The return value is the pointer to the byte after the
4995 end of the new character. In other words,
4997 d = uvchr_to_utf8(d, uv);
4999 is the recommended wide native character-aware way of saying
5003 U8* uvchr_to_utf8(U8 *d, UV uv)
5006 Found in file utf8.c
5008 =item uvuni_to_utf8_flags
5010 Adds the UTF8 representation of the Unicode codepoint C<uv> to the end
5011 of the string C<d>; C<d> should be have at least C<UTF8_MAXLEN+1> free
5012 bytes available. The return value is the pointer to the byte after the
5013 end of the new character. In other words,
5015 d = uvuni_to_utf8_flags(d, uv, flags);
5019 d = uvuni_to_utf8(d, uv);
5021 (which is equivalent to)
5023 d = uvuni_to_utf8_flags(d, uv, 0);
5025 is the recommended Unicode-aware way of saying
5029 U8* uvuni_to_utf8_flags(U8 *d, UV uv, UV flags)
5032 Found in file utf8.c
5037 =head1 Variables created by C<xsubpp> and C<xsubpp> internal functions
5043 Variable which is setup by C<xsubpp> to indicate the stack base offset,
5044 used by the C<ST>, C<XSprePUSH> and C<XSRETURN> macros. The C<dMARK> macro
5045 must be called prior to setup the C<MARK> variable.
5050 Found in file XSUB.h
5054 Variable which is setup by C<xsubpp> to indicate the
5055 class name for a C++ XS constructor. This is always a C<char*>. See C<THIS>.
5060 Found in file XSUB.h
5064 Sets up the C<ax> variable.
5065 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
5070 Found in file XSUB.h
5074 Sets up the C<items> variable.
5075 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
5080 Found in file XSUB.h
5084 Sets up stack and mark pointers for an XSUB, calling dSP and dMARK.
5085 Sets up the C<ax> and C<items> variables by calling C<dAX> and C<dITEMS>.
5086 This is usually handled automatically by C<xsubpp>.
5091 Found in file XSUB.h
5095 Sets up the C<ix> variable for an XSUB which has aliases. This is usually
5096 handled automatically by C<xsubpp>.
5101 Found in file XSUB.h
5105 Variable which is setup by C<xsubpp> to indicate the number of
5106 items on the stack. See L<perlxs/"Variable-length Parameter Lists">.
5111 Found in file XSUB.h
5115 Variable which is setup by C<xsubpp> to indicate which of an
5116 XSUB's aliases was used to invoke it. See L<perlxs/"The ALIAS: Keyword">.
5121 Found in file XSUB.h
5125 Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
5129 Found in file XSUB.h
5133 Variable which is setup by C<xsubpp> to hold the return value for an
5134 XSUB. This is always the proper type for the XSUB. See
5135 L<perlxs/"The RETVAL Variable">.
5140 Found in file XSUB.h
5144 Used to access elements on the XSUB's stack.
5149 Found in file XSUB.h
5153 Variable which is setup by C<xsubpp> to designate the object in a C++
5154 XSUB. This is always the proper type for the C++ object. See C<CLASS> and
5155 L<perlxs/"Using XS With C++">.
5160 Found in file XSUB.h
5164 Macro to declare an XSUB and its C parameter list. This is handled by
5168 Found in file XSUB.h
5170 =item XSRETURN_EMPTY
5172 Return an empty list from an XSUB immediately.
5178 Found in file XSUB.h
5182 The version identifier for an XS module. This is usually
5183 handled automatically by C<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>.
5186 Found in file XSUB.h
5188 =item XS_VERSION_BOOTCHECK
5190 Macro to verify that a PM module's $VERSION variable matches the XS
5191 module's C<XS_VERSION> variable. This is usually handled automatically by
5192 C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">.
5194 XS_VERSION_BOOTCHECK;
5197 Found in file XSUB.h
5202 =head1 Warning and Dieing
5208 This is the XSUB-writer's interface to Perl's C<die> function.
5209 Normally use this function the same way you use the C C<printf>
5210 function. See C<warn>.
5212 If you want to throw an exception object, assign the object to
5213 C<$@> and then pass C<Nullch> to croak():
5215 errsv = get_sv("@", TRUE);
5216 sv_setsv(errsv, exception_object);
5219 void croak(const char* pat, ...)
5222 Found in file util.c
5226 This is the XSUB-writer's interface to Perl's C<warn> function. Use this
5227 function the same way you use the C C<printf> function. See
5230 void warn(const char* pat, ...)
5233 Found in file util.c
5240 Until May 1997, this document was maintained by Jeff Okamoto
5241 <okamoto@corp.hp.com>. It is now maintained as part of Perl itself.
5243 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
5244 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
5245 Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
5246 Stephen McCamant, and Gurusamy Sarathy.
5248 API Listing originally by Dean Roehrich <roehrich@cray.com>.
5250 Updated to be autogenerated from comments in the source by Benjamin Stuhl.
5254 perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
projects / p5sagit/p5-mst-13.2.git / blob