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 perl_clone takes these flags as paramters:
517 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
518 without it we only clone the data and zero the stacks,
519 with it we copy the stacks and the new perl interpreter is
520 ready to run at the exact same point as the previous one.
521 The pseudo-fork code uses COPY_STACKS while the
522 threads->new doesn't.
524 CLONEf_KEEP_PTR_TABLE
525 perl_clone keeps a ptr_table with the pointer of the old
526 variable as a key and the new variable as a value,
527 this allows it to check if something has been cloned and not
528 clone it again but rather just use the value and increase the
529 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
530 the ptr_table using the function
531 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
532 reason to keep it around is if you want to dup some of your own
533 variable who are outside the graph perl scans, example of this
534 code is in threads.xs create
537 This is a win32 thing, it is ignored on unix, it tells perls
538 win32host code (which is c++) to clone itself, this is needed on
539 win32 if you want to run two threads at the same time,
540 if you just want to do some stuff in a separate perl interpreter
541 and then throw it away and return to the original one,
542 you don't need to do anything.
544 PerlInterpreter* perl_clone(PerlInterpreter* interp, UV flags)
552 =head1 CV Manipulation Functions
558 Returns the stash of the CV.
567 Returns the CV of the specified Perl subroutine. If C<create> is set and
568 the Perl subroutine does not exist then it will be declared (which has the
569 same effect as saying C<sub name;>). If C<create> is not set and the
570 subroutine does not exist then NULL is returned.
572 NOTE: the perl_ form of this function is deprecated.
574 CV* get_cv(const char* name, I32 create)
590 =head1 Embedding Functions
596 Clear out all the active components of a CV. This can happen either
597 by an explicit C<undef &foo>, or by the reference count going to zero.
598 In the former case, we keep the CvOUTSIDE pointer, so that any anonymous
599 children can still follow the full lexical scope chain.
601 void cv_undef(CV* cv)
608 Loads the module whose name is pointed to by the string part of name.
609 Note that the actual module name, not its filename, should be given.
610 Eg, "Foo::Bar" instead of "Foo/Bar.pm". flags can be any of
611 PERL_LOADMOD_DENY, PERL_LOADMOD_NOIMPORT, or PERL_LOADMOD_IMPORT_OPS
612 (or 0 for no flags). ver, if specified, provides version semantics
613 similar to C<use Foo::Bar VERSION>. The optional trailing SV*
614 arguments can be used to specify arguments to the module's import()
615 method, similar to C<use Foo::Bar VERSION LIST>.
617 void load_module(U32 flags, SV* name, SV* ver, ...)
624 Stub that provides thread hook for perl_destruct when there are
634 Allocates a new Perl interpreter. See L<perlembed>.
636 PerlInterpreter* perl_alloc()
643 Initializes a new Perl interpreter. See L<perlembed>.
645 void perl_construct(PerlInterpreter* interp)
652 Shuts down a Perl interpreter. See L<perlembed>.
654 int perl_destruct(PerlInterpreter* interp)
661 Releases a Perl interpreter. See L<perlembed>.
663 void perl_free(PerlInterpreter* interp)
670 Tells a Perl interpreter to parse a Perl script. See L<perlembed>.
672 int perl_parse(PerlInterpreter* interp, XSINIT_t xsinit, int argc, char** argv, char** env)
679 Tells a Perl interpreter to run. See L<perlembed>.
681 int perl_run(PerlInterpreter* interp)
688 Tells Perl to C<require> the file named by the string argument. It is
689 analogous to the Perl code C<eval "require '$file'">. It's even
690 implemented that way; consider using Perl_load_module instead.
692 NOTE: the perl_ form of this function is deprecated.
694 void require_pv(const char* pv)
702 =head1 Functions in file pp_pack.c
709 The engine implementing pack() Perl function.
711 void pack_cat(SV *cat, char *pat, char *patend, SV **beglist, SV **endlist, SV ***next_in_list, U32 flags)
714 Found in file pp_pack.c
718 The engine implementing unpack() Perl function.
720 I32 unpack_str(char *pat, char *patend, char *s, char *strbeg, char *strend, char **new_s, I32 ocnt, U32 flags)
723 Found in file pp_pack.c
728 =head1 Global Variables
734 C<PL_modglobal> is a general purpose, interpreter global HV for use by
735 extensions that need to keep information on a per-interpreter basis.
736 In a pinch, it can also be used as a symbol table for extensions
737 to share data among each other. It is a good idea to use keys
738 prefixed by the package name of the extension that owns the data.
743 Found in file intrpvar.h
747 A convenience variable which is typically used with C<SvPV> when one
748 doesn't care about the length of the string. It is usually more efficient
749 to either declare a local variable and use that instead or to use the
755 Found in file thrdvar.h
759 This is the C<false> SV. See C<PL_sv_yes>. Always refer to this as
765 Found in file intrpvar.h
769 This is the C<undef> SV. Always refer to this as C<&PL_sv_undef>.
774 Found in file intrpvar.h
778 This is the C<true> SV. See C<PL_sv_no>. Always refer to this as
784 Found in file intrpvar.h
795 Return the SV from the GV.
804 Returns the glob with the given C<name> and a defined subroutine or
805 C<NULL>. The glob lives in the given C<stash>, or in the stashes
806 accessible via @ISA and UNIVERSAL::.
808 The argument C<level> should be either 0 or -1. If C<level==0>, as a
809 side-effect creates a glob with the given C<name> in the given C<stash>
810 which in the case of success contains an alias for the subroutine, and sets
811 up caching info for this glob. Similarly for all the searched stashes.
813 This function grants C<"SUPER"> token as a postfix of the stash name. The
814 GV returned from C<gv_fetchmeth> may be a method cache entry, which is not
815 visible to Perl code. So when calling C<call_sv>, you should not use
816 the GV directly; instead, you should use the method's CV, which can be
817 obtained from the GV with the C<GvCV> macro.
819 GV* gv_fetchmeth(HV* stash, const char* name, STRLEN len, I32 level)
826 See L<gv_fetchmethod_autoload>.
828 GV* gv_fetchmethod(HV* stash, const char* name)
833 =item gv_fetchmethod_autoload
835 Returns the glob which contains the subroutine to call to invoke the method
836 on the C<stash>. In fact in the presence of autoloading this may be the
837 glob for "AUTOLOAD". In this case the corresponding variable $AUTOLOAD is
840 The third parameter of C<gv_fetchmethod_autoload> determines whether
841 AUTOLOAD lookup is performed if the given method is not present: non-zero
842 means yes, look for AUTOLOAD; zero means no, don't look for AUTOLOAD.
843 Calling C<gv_fetchmethod> is equivalent to calling C<gv_fetchmethod_autoload>
844 with a non-zero C<autoload> parameter.
846 These functions grant C<"SUPER"> token as a prefix of the method name. Note
847 that if you want to keep the returned glob for a long time, you need to
848 check for it being "AUTOLOAD", since at the later time the call may load a
849 different subroutine due to $AUTOLOAD changing its value. Use the glob
850 created via a side effect to do this.
852 These functions have the same side-effects and as C<gv_fetchmeth> with
853 C<level==0>. C<name> should be writable if contains C<':'> or C<'
854 ''>. The warning against passing the GV returned by C<gv_fetchmeth> to
855 C<call_sv> apply equally to these functions.
857 GV* gv_fetchmethod_autoload(HV* stash, const char* name, I32 autoload)
862 =item gv_fetchmeth_autoload
864 Same as gv_fetchmeth(), but looks for autoloaded subroutines too.
865 Returns a glob for the subroutine.
867 For an autoloaded subroutine without a GV, will create a GV even
868 if C<level < 0>. For an autoloaded subroutine without a stub, GvCV()
869 of the result may be zero.
871 GV* gv_fetchmeth_autoload(HV* stash, const char* name, STRLEN len, I32 level)
878 Returns a pointer to the stash for a specified package. C<name> should
879 be a valid UTF-8 string. If C<create> is set then the package will be
880 created if it does not already exist. If C<create> is not set and the
881 package does not exist then NULL is returned.
883 HV* gv_stashpv(const char* name, I32 create)
890 Returns a pointer to the stash for a specified package, which must be a
891 valid UTF-8 string. See C<gv_stashpv>.
893 HV* gv_stashsv(SV* sv, I32 create)
907 This flag, used in the length slot of hash entries and magic structures,
908 specifies the structure contains an C<SV*> pointer where a C<char*> pointer
909 is to be expected. (For information only--not to be used).
917 Null character pointer.
919 Found in file handy.h
926 Found in file handy.h
931 =head1 Hash Manipulation Functions
937 Returns the HV of the specified Perl hash. If C<create> is set and the
938 Perl variable does not exist then it will be created. If C<create> is not
939 set and the variable does not exist then NULL is returned.
941 NOTE: the perl_ form of this function is deprecated.
943 HV* get_hv(const char* name, I32 create)
950 Returns the computed hash stored in the hash entry.
959 Returns the actual pointer stored in the key slot of the hash entry. The
960 pointer may be either C<char*> or C<SV*>, depending on the value of
961 C<HeKLEN()>. Can be assigned to. The C<HePV()> or C<HeSVKEY()> macros are
962 usually preferable for finding the value of a key.
971 If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry
972 holds an C<SV*> key. Otherwise, holds the actual length of the key. Can
973 be assigned to. The C<HePV()> macro is usually preferable for finding key
976 STRLEN HeKLEN(HE* he)
983 Returns the key slot of the hash entry as a C<char*> value, doing any
984 necessary dereferencing of possibly C<SV*> keys. The length of the string
985 is placed in C<len> (this is a macro, so do I<not> use C<&len>). If you do
986 not care about what the length of the key is, you may use the global
987 variable C<PL_na>, though this is rather less efficient than using a local
988 variable. Remember though, that hash keys in perl are free to contain
989 embedded nulls, so using C<strlen()> or similar is not a good way to find
990 the length of hash keys. This is very similar to the C<SvPV()> macro
991 described elsewhere in this document.
993 char* HePV(HE* he, STRLEN len)
1000 Returns the key as an C<SV*>, or C<Nullsv> if the hash entry does not
1001 contain an C<SV*> key.
1010 Returns the key as an C<SV*>. Will create and return a temporary mortal
1011 C<SV*> if the hash entry contains only a C<char*> key.
1013 SV* HeSVKEY_force(HE* he)
1020 Sets the key to a given C<SV*>, taking care to set the appropriate flags to
1021 indicate the presence of an C<SV*> key, and returns the same
1024 SV* HeSVKEY_set(HE* he, SV* sv)
1031 Returns the value slot (type C<SV*>) stored in the hash entry.
1040 Returns the package name of a stash. See C<SvSTASH>, C<CvSTASH>.
1042 char* HvNAME(HV* stash)
1049 Clears a hash, making it empty.
1051 void hv_clear(HV* tb)
1058 Deletes a key/value pair in the hash. The value SV is removed from the
1059 hash and returned to the caller. The C<klen> is the length of the key.
1060 The C<flags> value will normally be zero; if set to G_DISCARD then NULL
1063 SV* hv_delete(HV* tb, const char* key, I32 klen, I32 flags)
1070 Deletes a key/value pair in the hash. The value SV is removed from the
1071 hash and returned to the caller. The C<flags> value will normally be zero;
1072 if set to G_DISCARD then NULL will be returned. C<hash> can be a valid
1073 precomputed hash value, or 0 to ask for it to be computed.
1075 SV* hv_delete_ent(HV* tb, SV* key, I32 flags, U32 hash)
1082 Returns a boolean indicating whether the specified hash key exists. The
1083 C<klen> is the length of the key.
1085 bool hv_exists(HV* tb, const char* key, I32 klen)
1092 Returns a boolean indicating whether the specified hash key exists. C<hash>
1093 can be a valid precomputed hash value, or 0 to ask for it to be
1096 bool hv_exists_ent(HV* tb, SV* key, U32 hash)
1103 Returns the SV which corresponds to the specified key in the hash. The
1104 C<klen> is the length of the key. If C<lval> is set then the fetch will be
1105 part of a store. Check that the return value is non-null before
1106 dereferencing it to an C<SV*>.
1108 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1109 information on how to use this function on tied hashes.
1111 SV** hv_fetch(HV* tb, const char* key, I32 klen, I32 lval)
1118 Returns the hash entry which corresponds to the specified key in the hash.
1119 C<hash> must be a valid precomputed hash number for the given C<key>, or 0
1120 if you want the function to compute it. IF C<lval> is set then the fetch
1121 will be part of a store. Make sure the return value is non-null before
1122 accessing it. The return value when C<tb> is a tied hash is a pointer to a
1123 static location, so be sure to make a copy of the structure if you need to
1126 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1127 information on how to use this function on tied hashes.
1129 HE* hv_fetch_ent(HV* tb, SV* key, I32 lval, U32 hash)
1136 Prepares a starting point to traverse a hash table. Returns the number of
1137 keys in the hash (i.e. the same as C<HvKEYS(tb)>). The return value is
1138 currently only meaningful for hashes without tie magic.
1140 NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
1141 hash buckets that happen to be in use. If you still need that esoteric
1142 value, you can get it through the macro C<HvFILL(tb)>.
1145 I32 hv_iterinit(HV* tb)
1152 Returns the key from the current position of the hash iterator. See
1155 char* hv_iterkey(HE* entry, I32* retlen)
1162 Returns the key as an C<SV*> from the current position of the hash
1163 iterator. The return value will always be a mortal copy of the key. Also
1166 SV* hv_iterkeysv(HE* entry)
1173 Returns entries from a hash iterator. See C<hv_iterinit>.
1175 You may call C<hv_delete> or C<hv_delete_ent> on the hash entry that the
1176 iterator currently points to, without losing your place or invalidating your
1177 iterator. Note that in this case the current entry is deleted from the hash
1178 with your iterator holding the last reference to it. Your iterator is flagged
1179 to free the entry on the next call to C<hv_iternext>, so you must not discard
1180 your iterator immediately else the entry will leak - call C<hv_iternext> to
1181 trigger the resource deallocation.
1183 HE* hv_iternext(HV* tb)
1190 Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
1193 SV* hv_iternextsv(HV* hv, char** key, I32* retlen)
1198 =item hv_iternext_flags
1200 Returns entries from a hash iterator. See C<hv_iterinit> and C<hv_iternext>.
1201 The C<flags> value will normally be zero; if HV_ITERNEXT_WANTPLACEHOLDERS is
1202 set the placeholders keys (for restricted hashes) will be returned in addition
1203 to normal keys. By default placeholders are automatically skipped over.
1204 Currently a placeholder is implemented with a value that is literally
1205 <&Perl_sv_undef> (a regular C<undef> value is a normal read-write SV for which
1206 C<!SvOK> is false). Note that the implementation of placeholders and
1207 restricted hashes may change, and the implementation currently is
1208 insufficiently abstracted for any change to be tidy.
1210 NOTE: this function is experimental and may change or be
1211 removed without notice.
1213 HE* hv_iternext_flags(HV* tb, I32 flags)
1220 Returns the value from the current position of the hash iterator. See
1223 SV* hv_iterval(HV* tb, HE* entry)
1230 Adds magic to a hash. See C<sv_magic>.
1232 void hv_magic(HV* hv, GV* gv, int how)
1239 Stores an SV in a hash. The hash key is specified as C<key> and C<klen> is
1240 the length of the key. The C<hash> parameter is the precomputed hash
1241 value; if it is zero then Perl will compute it. The return value will be
1242 NULL if the operation failed or if the value did not need to be actually
1243 stored within the hash (as in the case of tied hashes). Otherwise it can
1244 be dereferenced to get the original C<SV*>. Note that the caller is
1245 responsible for suitably incrementing the reference count of C<val> before
1246 the call, and decrementing it if the function returned NULL.
1248 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1249 information on how to use this function on tied hashes.
1251 SV** hv_store(HV* tb, const char* key, I32 klen, SV* val, U32 hash)
1258 Stores C<val> in a hash. The hash key is specified as C<key>. The C<hash>
1259 parameter is the precomputed hash value; if it is zero then Perl will
1260 compute it. The return value is the new hash entry so created. It will be
1261 NULL if the operation failed or if the value did not need to be actually
1262 stored within the hash (as in the case of tied hashes). Otherwise the
1263 contents of the return value can be accessed using the C<He?> macros
1264 described here. Note that the caller is responsible for suitably
1265 incrementing the reference count of C<val> before the call, and
1266 decrementing it if the function returned NULL.
1268 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1269 information on how to use this function on tied hashes.
1271 HE* hv_store_ent(HV* tb, SV* key, SV* val, U32 hash)
1280 void hv_undef(HV* tb)
1287 Creates a new HV. The reference count is set to 1.
1305 =head1 Magical Functions
1311 Clear something magical that the SV represents. See C<sv_magic>.
1313 int mg_clear(SV* sv)
1320 Copies the magic from one SV to another. See C<sv_magic>.
1322 int mg_copy(SV* sv, SV* nsv, const char* key, I32 klen)
1329 Finds the magic pointer for type matching the SV. See C<sv_magic>.
1331 MAGIC* mg_find(SV* sv, int type)
1338 Free any magic storage used by the SV. See C<sv_magic>.
1347 Do magic after a value is retrieved from the SV. See C<sv_magic>.
1356 Report on the SV's length. See C<sv_magic>.
1358 U32 mg_length(SV* sv)
1365 Turns on the magical status of an SV. See C<sv_magic>.
1367 void mg_magical(SV* sv)
1374 Do magic after a value is assigned to the SV. See C<sv_magic>.
1383 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
1384 argument more than once.
1386 void SvGETMAGIC(SV* sv)
1393 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
1403 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
1404 argument more than once.
1406 void SvSETMAGIC(SV* sv)
1413 Like C<SvSetSV>, but does any set magic required afterwards.
1415 void SvSetMagicSV(SV* dsb, SV* ssv)
1420 =item SvSetMagicSV_nosteal
1422 Like C<SvSetMagicSV>, but does any set magic required afterwards.
1424 void SvSetMagicSV_nosteal(SV* dsv, SV* ssv)
1431 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
1434 void SvSetSV(SV* dsb, SV* ssv)
1439 =item SvSetSV_nosteal
1441 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
1442 ssv. May evaluate arguments more than once.
1444 void SvSetSV_nosteal(SV* dsv, SV* ssv)
1451 Arranges for sv to be shared between threads if a suitable module
1454 void SvSHARE(SV* sv)
1462 =head1 Memory Management
1468 The XSUB-writer's interface to the C C<memcpy> function. The C<src> is the
1469 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1470 the type. May fail on overlapping copies. See also C<Move>.
1472 void Copy(void* src, void* dest, int nitems, type)
1475 Found in file handy.h
1479 The XSUB-writer's interface to the C C<memmove> function. The C<src> is the
1480 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1481 the type. Can do overlapping moves. See also C<Copy>.
1483 void Move(void* src, void* dest, int nitems, type)
1486 Found in file handy.h
1490 The XSUB-writer's interface to the C C<malloc> function.
1492 void New(int id, void* ptr, int nitems, type)
1495 Found in file handy.h
1499 The XSUB-writer's interface to the C C<malloc> function, with
1502 void Newc(int id, void* ptr, int nitems, type, cast)
1505 Found in file handy.h
1509 Creates a new SV. A non-zero C<len> parameter indicates the number of
1510 bytes of preallocated string space the SV should have. An extra byte for a
1511 tailing NUL is also reserved. (SvPOK is not set for the SV even if string
1512 space is allocated.) The reference count for the new SV is set to 1.
1513 C<id> is an integer id between 0 and 1299 (used to identify leaks).
1516 SV* NEWSV(int id, STRLEN len)
1519 Found in file handy.h
1523 The XSUB-writer's interface to the C C<malloc> function. The allocated
1524 memory is zeroed with C<memzero>.
1526 void Newz(int id, void* ptr, int nitems, type)
1529 Found in file handy.h
1533 Fill up memory with a pattern (byte 0xAB over and over again) that
1534 hopefully catches attempts to access uninitialized memory.
1536 void Poison(void* dest, int nitems, type)
1539 Found in file handy.h
1543 The XSUB-writer's interface to the C C<realloc> function.
1545 void Renew(void* ptr, int nitems, type)
1548 Found in file handy.h
1552 The XSUB-writer's interface to the C C<realloc> function, with
1555 void Renewc(void* ptr, int nitems, type, cast)
1558 Found in file handy.h
1562 The XSUB-writer's interface to the C C<free> function.
1564 void Safefree(void* ptr)
1567 Found in file handy.h
1571 Perl's version of C<strdup()>. Returns a pointer to a newly allocated
1572 string which is a duplicate of C<pv>. The size of the string is
1573 determined by C<strlen()>. The memory allocated for the new string can
1574 be freed with the C<Safefree()> function.
1576 char* savepv(const char* pv)
1579 Found in file util.c
1583 Perl's version of what C<strndup()> would be if it existed. Returns a
1584 pointer to a newly allocated string which is a duplicate of the first
1585 C<len> bytes from C<pv>. The memory allocated for the new string can be
1586 freed with the C<Safefree()> function.
1588 char* savepvn(const char* pv, I32 len)
1591 Found in file util.c
1595 A version of C<savepv()> which allocates the duplicate string in memory
1596 which is shared between threads.
1598 char* savesharedpv(const char* pv)
1601 Found in file util.c
1605 This is an architecture-independent macro to copy one structure to another.
1607 void StructCopy(type src, type dest, type)
1610 Found in file handy.h
1614 The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the
1615 destination, C<nitems> is the number of items, and C<type> is the type.
1617 void Zero(void* dest, int nitems, type)
1620 Found in file handy.h
1625 =head1 Miscellaneous Functions
1631 Analyses the string in order to make fast searches on it using fbm_instr()
1632 -- the Boyer-Moore algorithm.
1634 void fbm_compile(SV* sv, U32 flags)
1637 Found in file util.c
1641 Returns the location of the SV in the string delimited by C<str> and
1642 C<strend>. It returns C<Nullch> if the string can't be found. The C<sv>
1643 does not have to be fbm_compiled, but the search will not be as fast
1646 char* fbm_instr(unsigned char* big, unsigned char* bigend, SV* littlesv, U32 flags)
1649 Found in file util.c
1653 Takes a sprintf-style format pattern and conventional
1654 (non-SV) arguments and returns the formatted string.
1656 (char *) Perl_form(pTHX_ const char* pat, ...)
1658 can be used any place a string (char *) is required:
1660 char * s = Perl_form("%d.%d",major,minor);
1662 Uses a single private buffer so if you want to format several strings you
1663 must explicitly copy the earlier strings away (and free the copies when you
1666 char* form(const char* pat, ...)
1669 Found in file util.c
1673 Fill the sv with current working directory
1675 int getcwd_sv(SV* sv)
1678 Found in file util.c
1682 Test two strings to see if they are equal. Returns true or false.
1684 bool strEQ(char* s1, char* s2)
1687 Found in file handy.h
1691 Test two strings to see if the first, C<s1>, is greater than or equal to
1692 the second, C<s2>. Returns true or false.
1694 bool strGE(char* s1, char* s2)
1697 Found in file handy.h
1701 Test two strings to see if the first, C<s1>, is greater than the second,
1702 C<s2>. Returns true or false.
1704 bool strGT(char* s1, char* s2)
1707 Found in file handy.h
1711 Test two strings to see if the first, C<s1>, is less than or equal to the
1712 second, C<s2>. Returns true or false.
1714 bool strLE(char* s1, char* s2)
1717 Found in file handy.h
1721 Test two strings to see if the first, C<s1>, is less than the second,
1722 C<s2>. Returns true or false.
1724 bool strLT(char* s1, char* s2)
1727 Found in file handy.h
1731 Test two strings to see if they are different. Returns true or
1734 bool strNE(char* s1, char* s2)
1737 Found in file handy.h
1741 Test two strings to see if they are equal. The C<len> parameter indicates
1742 the number of bytes to compare. Returns true or false. (A wrapper for
1745 bool strnEQ(char* s1, char* s2, STRLEN len)
1748 Found in file handy.h
1752 Test two strings to see if they are different. The C<len> parameter
1753 indicates the number of bytes to compare. Returns true or false. (A
1754 wrapper for C<strncmp>).
1756 bool strnNE(char* s1, char* s2, STRLEN len)
1759 Found in file handy.h
1764 =head1 Numeric functions
1770 converts a string representing a binary number to numeric form.
1772 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
1773 conversion flags, and I<result> should be NULL or a pointer to an NV.
1774 The scan stops at the end of the string, or the first invalid character.
1775 On return I<*len> is set to the length scanned string, and I<*flags> gives
1778 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
1779 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_bin>
1780 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
1781 and writes the value to I<*result> (or the value is discarded if I<result>
1784 The hex number may optionally be prefixed with "0b" or "b" unless
1785 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
1786 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the binary
1787 number may use '_' characters to separate digits.
1789 UV grok_bin(char* start, STRLEN* len, I32* flags, NV *result)
1792 Found in file numeric.c
1796 converts a string representing a hex number to numeric form.
1798 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
1799 conversion flags, and I<result> should be NULL or a pointer to an NV.
1800 The scan stops at the end of the string, or the first non-hex-digit character.
1801 On return I<*len> is set to the length scanned string, and I<*flags> gives
1804 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
1805 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_hex>
1806 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
1807 and writes the value to I<*result> (or the value is discarded if I<result>
1810 The hex number may optionally be prefixed with "0x" or "x" unless
1811 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
1812 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the hex
1813 number may use '_' characters to separate digits.
1815 UV grok_hex(char* start, STRLEN* len, I32* flags, NV *result)
1818 Found in file numeric.c
1822 Recognise (or not) a number. The type of the number is returned
1823 (0 if unrecognised), otherwise it is a bit-ORed combination of
1824 IS_NUMBER_IN_UV, IS_NUMBER_GREATER_THAN_UV_MAX, IS_NUMBER_NOT_INT,
1825 IS_NUMBER_NEG, IS_NUMBER_INFINITY, IS_NUMBER_NAN (defined in perl.h).
1827 If the value of the number can fit an in UV, it is returned in the *valuep
1828 IS_NUMBER_IN_UV will be set to indicate that *valuep is valid, IS_NUMBER_IN_UV
1829 will never be set unless *valuep is valid, but *valuep may have been assigned
1830 to during processing even though IS_NUMBER_IN_UV is not set on return.
1831 If valuep is NULL, IS_NUMBER_IN_UV will be set for the same cases as when
1832 valuep is non-NULL, but no actual assignment (or SEGV) will occur.
1834 IS_NUMBER_NOT_INT will be set with IS_NUMBER_IN_UV if trailing decimals were
1835 seen (in which case *valuep gives the true value truncated to an integer), and
1836 IS_NUMBER_NEG if the number is negative (in which case *valuep holds the
1837 absolute value). IS_NUMBER_IN_UV is not set if e notation was used or the
1838 number is larger than a UV.
1840 int grok_number(const char *pv, STRLEN len, UV *valuep)
1843 Found in file numeric.c
1845 =item grok_numeric_radix
1847 Scan and skip for a numeric decimal separator (radix).
1849 bool grok_numeric_radix(const char **sp, const char *send)
1852 Found in file numeric.c
1857 UV grok_oct(char* start, STRLEN* len, I32* flags, NV *result)
1860 Found in file numeric.c
1864 For backwards compatibility. Use C<grok_bin> instead.
1866 NV scan_bin(char* start, STRLEN len, STRLEN* retlen)
1869 Found in file numeric.c
1873 For backwards compatibility. Use C<grok_hex> instead.
1875 NV scan_hex(char* start, STRLEN len, STRLEN* retlen)
1878 Found in file numeric.c
1882 For backwards compatibility. Use C<grok_oct> instead.
1884 NV scan_oct(char* start, STRLEN len, STRLEN* retlen)
1887 Found in file numeric.c
1892 =head1 Optree Manipulation Functions
1898 If C<cv> is a constant sub eligible for inlining. returns the constant
1899 value returned by the sub. Otherwise, returns NULL.
1901 Constant subs can be created with C<newCONSTSUB> or as described in
1902 L<perlsub/"Constant Functions">.
1904 SV* cv_const_sv(CV* cv)
1911 Creates a constant sub equivalent to Perl C<sub FOO () { 123 }> which is
1912 eligible for inlining at compile-time.
1914 CV* newCONSTSUB(HV* stash, char* name, SV* sv)
1921 Used by C<xsubpp> to hook up XSUBs as Perl subs.
1929 =head1 Pad Data Structures
1935 Get the value at offset po in the current pad.
1936 Use macro PAD_SV instead of calling this function directly.
1938 SV* pad_sv(PADOFFSET po)
1946 =head1 Stack Manipulation Macros
1952 Declare a stack marker variable, C<mark>, for the XSUB. See C<MARK> and
1962 Saves the original stack mark for the XSUB. See C<ORIGMARK>.
1971 Declares a local copy of perl's stack pointer for the XSUB, available via
1972 the C<SP> macro. See C<SP>.
1981 Used to extend the argument stack for an XSUB's return values. Once
1982 used, guarantees that there is room for at least C<nitems> to be pushed
1985 void EXTEND(SP, int nitems)
1992 Stack marker variable for the XSUB. See C<dMARK>.
1999 The original stack mark for the XSUB. See C<dORIGMARK>.
2006 Pops an integer off the stack.
2015 Pops a long off the stack.
2024 Pops a double off the stack.
2033 Pops a string off the stack. Deprecated. New code should provide
2034 a STRLEN n_a and use POPpx.
2043 Pops a string off the stack which must consist of bytes i.e. characters < 256.
2044 Requires a variable STRLEN n_a in scope.
2053 Pops a string off the stack.
2054 Requires a variable STRLEN n_a in scope.
2063 Pops an SV off the stack.
2072 Push an integer onto the stack. The stack must have room for this element.
2073 Handles 'set' magic. See C<XPUSHi>.
2082 Opening bracket for arguments on a callback. See C<PUTBACK> and
2092 Push a double onto the stack. The stack must have room for this element.
2093 Handles 'set' magic. See C<XPUSHn>.
2102 Push a string onto the stack. The stack must have room for this element.
2103 The C<len> indicates the length of the string. Handles 'set' magic. See
2106 void PUSHp(char* str, STRLEN len)
2113 Push an SV onto the stack. The stack must have room for this element.
2114 Does not handle 'set' magic. See C<XPUSHs>.
2123 Push an unsigned integer onto the stack. The stack must have room for this
2124 element. See C<XPUSHu>.
2133 Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
2134 See C<PUSHMARK> and L<perlcall> for other uses.
2143 Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and
2151 Refetch the stack pointer. Used after a callback. See L<perlcall>.
2160 Push an integer onto the stack, extending the stack if necessary. Handles
2161 'set' magic. See C<PUSHi>.
2170 Push a double onto the stack, extending the stack if necessary. Handles
2171 'set' magic. See C<PUSHn>.
2180 Push a string onto the stack, extending the stack if necessary. The C<len>
2181 indicates the length of the string. Handles 'set' magic. See
2184 void XPUSHp(char* str, STRLEN len)
2191 Push an SV onto the stack, extending the stack if necessary. Does not
2192 handle 'set' magic. See C<PUSHs>.
2201 Push an unsigned integer onto the stack, extending the stack if necessary.
2211 Return from XSUB, indicating number of items on the stack. This is usually
2212 handled by C<xsubpp>.
2214 void XSRETURN(int nitems)
2217 Found in file XSUB.h
2221 Return an integer from an XSUB immediately. Uses C<XST_mIV>.
2223 void XSRETURN_IV(IV iv)
2226 Found in file XSUB.h
2230 Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
2235 Found in file XSUB.h
2239 Return a double from an XSUB immediately. Uses C<XST_mNV>.
2241 void XSRETURN_NV(NV nv)
2244 Found in file XSUB.h
2248 Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
2250 void XSRETURN_PV(char* str)
2253 Found in file XSUB.h
2255 =item XSRETURN_UNDEF
2257 Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
2262 Found in file XSUB.h
2266 Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
2271 Found in file XSUB.h
2275 Place an integer into the specified position C<pos> on the stack. The
2276 value is stored in a new mortal SV.
2278 void XST_mIV(int pos, IV iv)
2281 Found in file XSUB.h
2285 Place C<&PL_sv_no> into the specified position C<pos> on the
2288 void XST_mNO(int pos)
2291 Found in file XSUB.h
2295 Place a double into the specified position C<pos> on the stack. The value
2296 is stored in a new mortal SV.
2298 void XST_mNV(int pos, NV nv)
2301 Found in file XSUB.h
2305 Place a copy of a string into the specified position C<pos> on the stack.
2306 The value is stored in a new mortal SV.
2308 void XST_mPV(int pos, char* str)
2311 Found in file XSUB.h
2315 Place C<&PL_sv_undef> into the specified position C<pos> on the
2318 void XST_mUNDEF(int pos)
2321 Found in file XSUB.h
2325 Place C<&PL_sv_yes> into the specified position C<pos> on the
2328 void XST_mYES(int pos)
2331 Found in file XSUB.h
2342 An enum of flags for Perl types. These are found in the file B<sv.h>
2343 in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
2350 Integer type flag for scalars. See C<svtype>.
2357 Double type flag for scalars. See C<svtype>.
2364 Pointer type flag for scalars. See C<svtype>.
2371 Type flag for arrays. See C<svtype>.
2378 Type flag for code refs. See C<svtype>.
2385 Type flag for hashes. See C<svtype>.
2392 Type flag for blessed scalars. See C<svtype>.
2400 =head1 SV Manipulation Functions
2406 Returns the SV of the specified Perl scalar. If C<create> is set and the
2407 Perl variable does not exist then it will be created. If C<create> is not
2408 set and the variable does not exist then NULL is returned.
2410 NOTE: the perl_ form of this function is deprecated.
2412 SV* get_sv(const char* name, I32 create)
2415 Found in file perl.c
2417 =item looks_like_number
2419 Test if the content of an SV looks like a number (or is a number).
2420 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
2421 non-numeric warning), even if your atof() doesn't grok them.
2423 I32 looks_like_number(SV* sv)
2430 Creates an RV wrapper for an SV. The reference count for the original SV is
2433 SV* newRV_inc(SV* sv)
2440 Creates an RV wrapper for an SV. The reference count for the original
2441 SV is B<not> incremented.
2443 SV* newRV_noinc(SV *sv)
2450 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
2451 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
2454 SV* newSV(STRLEN len)
2461 Creates a new SV and copies an integer into it. The reference count for the
2471 Creates a new SV and copies a floating point value into it.
2472 The reference count for the SV is set to 1.
2481 Creates a new SV and copies a string into it. The reference count for the
2482 SV is set to 1. If C<len> is zero, Perl will compute the length using
2483 strlen(). For efficiency, consider using C<newSVpvn> instead.
2485 SV* newSVpv(const char* s, STRLEN len)
2492 Creates a new SV and initializes it with the string formatted like
2495 SV* newSVpvf(const char* pat, ...)
2502 Creates a new SV and copies a string into it. The reference count for the
2503 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
2504 string. You are responsible for ensuring that the source string is at least
2507 SV* newSVpvn(const char* s, STRLEN len)
2512 =item newSVpvn_share
2514 Creates a new SV with its SvPVX pointing to a shared string in the string
2515 table. If the string does not already exist in the table, it is created
2516 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
2517 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
2518 otherwise the hash is computed. The idea here is that as the string table
2519 is used for shared hash keys these strings will have SvPVX == HeKEY and
2520 hash lookup will avoid string compare.
2522 SV* newSVpvn_share(const char* s, I32 len, U32 hash)
2529 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
2530 it will be upgraded to one. If C<classname> is non-null then the new SV will
2531 be blessed in the specified package. The new SV is returned and its
2532 reference count is 1.
2534 SV* newSVrv(SV* rv, const char* classname)
2541 Creates a new SV which is an exact duplicate of the original SV.
2544 SV* newSVsv(SV* old)
2551 Creates a new SV and copies an unsigned integer into it.
2552 The reference count for the SV is set to 1.
2561 Returns a new version object based on the passed in SV:
2563 SV *sv = new_version(SV *ver);
2565 Does not alter the passed in ver SV. See "upg_version" if you
2566 want to upgrade the SV.
2568 SV* new_version(SV *ver)
2571 Found in file util.c
2575 Returns a pointer to the next character after the parsed
2576 version string, as well as upgrading the passed in SV to
2579 Function must be called with an already existing SV like
2582 s = scan_version(s,sv);
2584 Performs some preprocessing to the string to ensure that
2585 it has the correct characteristics of a version. Flags the
2586 object if it contains an underscore (which denotes this
2589 char* scan_version(char *vstr, SV *sv)
2592 Found in file util.c
2596 Returns a pointer to the next character after the parsed
2597 vstring, as well as updating the passed in sv.
2599 Function must be called like
2602 s = scan_vstring(s,sv);
2604 The sv should already be large enough to store the vstring
2605 passed in, for performance reasons.
2607 char* scan_vstring(char *vstr, SV *sv)
2610 Found in file util.c
2614 Returns the length of the string which is in the SV. See C<SvLEN>.
2616 STRLEN SvCUR(SV* sv)
2623 Set the length of the string which is in the SV. See C<SvCUR>.
2625 void SvCUR_set(SV* sv, STRLEN len)
2632 Returns a pointer to the last character in the string which is in the SV.
2633 See C<SvCUR>. Access the character as *(SvEND(sv)).
2642 Expands the character buffer in the SV so that it has room for the
2643 indicated number of bytes (remember to reserve space for an extra trailing
2644 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
2645 Returns a pointer to the character buffer.
2647 char * SvGROW(SV* sv, STRLEN len)
2654 Returns a boolean indicating whether the SV contains an integer.
2663 Returns a boolean indicating whether the SV contains an integer. Checks
2664 the B<private> setting. Use C<SvIOK>.
2673 Returns a boolean indicating whether the SV contains a signed integer.
2675 void SvIOK_notUV(SV* sv)
2682 Unsets the IV status of an SV.
2684 void SvIOK_off(SV* sv)
2691 Tells an SV that it is an integer.
2693 void SvIOK_on(SV* sv)
2700 Tells an SV that it is an integer and disables all other OK bits.
2702 void SvIOK_only(SV* sv)
2709 Tells and SV that it is an unsigned integer and disables all other OK bits.
2711 void SvIOK_only_UV(SV* sv)
2718 Returns a boolean indicating whether the SV contains an unsigned integer.
2720 void SvIOK_UV(SV* sv)
2727 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
2728 version which guarantees to evaluate sv only once.
2737 Coerces the given SV to an integer and returns it. Guarantees to evaluate
2738 sv only once. Use the more efficient C<SvIV> otherwise.
2747 Returns the raw value in the SV's IV slot, without checks or conversions.
2748 Only use when you are sure SvIOK is true. See also C<SvIV()>.
2757 Returns the size of the string buffer in the SV, not including any part
2758 attributable to C<SvOOK>. See C<SvCUR>.
2760 STRLEN SvLEN(SV* sv)
2767 Returns a boolean indicating whether the SV contains a number, integer or
2777 Returns a boolean indicating whether the SV contains a number, integer or
2778 double. Checks the B<private> setting. Use C<SvNIOK>.
2780 bool SvNIOKp(SV* sv)
2787 Unsets the NV/IV status of an SV.
2789 void SvNIOK_off(SV* sv)
2796 Returns a boolean indicating whether the SV contains a double.
2805 Returns a boolean indicating whether the SV contains a double. Checks the
2806 B<private> setting. Use C<SvNOK>.
2815 Unsets the NV status of an SV.
2817 void SvNOK_off(SV* sv)
2824 Tells an SV that it is a double.
2826 void SvNOK_on(SV* sv)
2833 Tells an SV that it is a double and disables all other OK bits.
2835 void SvNOK_only(SV* sv)
2842 Coerce the given SV to a double and return it. See C<SvNVx> for a version
2843 which guarantees to evaluate sv only once.
2852 Returns the raw value in the SV's NV slot, without checks or conversions.
2853 Only use when you are sure SvNOK is true. See also C<SvNV()>.
2862 Coerces the given SV to a double and returns it. Guarantees to evaluate
2863 sv only once. Use the more efficient C<SvNV> otherwise.
2872 Returns a boolean indicating whether the value is an SV.
2881 Returns a boolean indicating whether the SvIVX is a valid offset value for
2882 the SvPVX. This hack is used internally to speed up removal of characters
2883 from the beginning of a SvPV. When SvOOK is true, then the start of the
2884 allocated string buffer is really (SvPVX - SvIVX).
2893 Returns a boolean indicating whether the SV contains a character
2903 Returns a boolean indicating whether the SV contains a character string.
2904 Checks the B<private> setting. Use C<SvPOK>.
2913 Unsets the PV status of an SV.
2915 void SvPOK_off(SV* sv)
2922 Tells an SV that it is a string.
2924 void SvPOK_on(SV* sv)
2931 Tells an SV that it is a string and disables all other OK bits.
2932 Will also turn off the UTF8 status.
2934 void SvPOK_only(SV* sv)
2939 =item SvPOK_only_UTF8
2941 Tells an SV that it is a string and disables all other OK bits,
2942 and leaves the UTF8 status as it was.
2944 void SvPOK_only_UTF8(SV* sv)
2951 Returns a pointer to the string in the SV, or a stringified form of
2952 the SV if the SV does not contain a string. The SV may cache the
2953 stringified version becoming C<SvPOK>. Handles 'get' magic. See also
2954 C<SvPVx> for a version which guarantees to evaluate sv only once.
2956 char* SvPV(SV* sv, STRLEN len)
2963 Like C<SvPV>, but converts sv to byte representation first if necessary.
2965 char* SvPVbyte(SV* sv, STRLEN len)
2972 Like C<SvPV>, but converts sv to byte representation first if necessary.
2973 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
2977 char* SvPVbytex(SV* sv, STRLEN len)
2982 =item SvPVbytex_force
2984 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
2985 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
2988 char* SvPVbytex_force(SV* sv, STRLEN len)
2993 =item SvPVbyte_force
2995 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
2997 char* SvPVbyte_force(SV* sv, STRLEN len)
3002 =item SvPVbyte_nolen
3004 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
3006 char* SvPVbyte_nolen(SV* sv)
3013 Like C<SvPV>, but converts sv to utf8 first if necessary.
3015 char* SvPVutf8(SV* sv, STRLEN len)
3022 Like C<SvPV>, but converts sv to utf8 first if necessary.
3023 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
3026 char* SvPVutf8x(SV* sv, STRLEN len)
3031 =item SvPVutf8x_force
3033 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
3034 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
3037 char* SvPVutf8x_force(SV* sv, STRLEN len)
3042 =item SvPVutf8_force
3044 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
3046 char* SvPVutf8_force(SV* sv, STRLEN len)
3051 =item SvPVutf8_nolen
3053 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
3055 char* SvPVutf8_nolen(SV* sv)
3062 A version of C<SvPV> which guarantees to evaluate sv only once.
3064 char* SvPVx(SV* sv, STRLEN len)
3071 Returns a pointer to the physical string in the SV. The SV must contain a
3081 Like C<SvPV> but will force the SV into containing just a string
3082 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
3085 char* SvPV_force(SV* sv, STRLEN len)
3090 =item SvPV_force_nomg
3092 Like C<SvPV> but will force the SV into containing just a string
3093 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
3094 directly. Doesn't process magic.
3096 char* SvPV_force_nomg(SV* sv, STRLEN len)
3103 Returns a pointer to the string in the SV, or a stringified form of
3104 the SV if the SV does not contain a string. The SV may cache the
3105 stringified form becoming C<SvPOK>. Handles 'get' magic.
3107 char* SvPV_nolen(SV* sv)
3114 Returns the value of the object's reference count.
3116 U32 SvREFCNT(SV* sv)
3123 Decrements the reference count of the given SV.
3125 void SvREFCNT_dec(SV* sv)
3132 Increments the reference count of the given SV.
3134 SV* SvREFCNT_inc(SV* sv)
3141 Tests if the SV is an RV.
3150 Unsets the RV status of an SV.
3152 void SvROK_off(SV* sv)
3159 Tells an SV that it is an RV.
3161 void SvROK_on(SV* sv)
3168 Dereferences an RV to return the SV.
3177 Returns the stash of the SV.
3186 Taints an SV if tainting is enabled
3188 void SvTAINT(SV* sv)
3195 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
3198 bool SvTAINTED(SV* sv)
3205 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
3206 some of Perl's fundamental security features. XS module authors should not
3207 use this function unless they fully understand all the implications of
3208 unconditionally untainting the value. Untainting should be done in the
3209 standard perl fashion, via a carefully crafted regexp, rather than directly
3210 untainting variables.
3212 void SvTAINTED_off(SV* sv)
3219 Marks an SV as tainted.
3221 void SvTAINTED_on(SV* sv)
3228 Returns a boolean indicating whether Perl would evaluate the SV as true or
3229 false, defined or undefined. Does not handle 'get' magic.
3238 Returns the type of the SV. See C<svtype>.
3240 svtype SvTYPE(SV* sv)
3247 Releases a mutual exclusion lock on sv if a suitable module
3251 void SvUNLOCK(SV* sv)
3258 Returns a boolean indicating whether the SV contains an unsigned integer.
3267 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
3268 perform the upgrade if necessary. See C<svtype>.
3270 void SvUPGRADE(SV* sv, svtype type)
3277 Returns a boolean indicating whether the SV contains UTF-8 encoded data.
3286 Unsets the UTF8 status of an SV.
3288 void SvUTF8_off(SV *sv)
3295 Turn on the UTF8 status of an SV (the data is not changed, just the flag).
3296 Do not use frivolously.
3298 void SvUTF8_on(SV *sv)
3305 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
3306 for a version which guarantees to evaluate sv only once.
3315 Returns the raw value in the SV's UV slot, without checks or conversions.
3316 Only use when you are sure SvIOK is true. See also C<SvUV()>.
3325 Coerces the given SV to an unsigned integer and returns it. Guarantees to
3326 evaluate sv only once. Use the more efficient C<SvUV> otherwise.
3335 Returns a boolean indicating whether the SV contains a v-string.
3344 This function is only called on magical items, and is only used by
3345 sv_true() or its macro equivalent.
3347 bool sv_2bool(SV* sv)
3354 Using various gambits, try to get a CV from an SV; in addition, try if
3355 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
3357 CV* sv_2cv(SV* sv, HV** st, GV** gvp, I32 lref)
3364 Using various gambits, try to get an IO from an SV: the IO slot if its a
3365 GV; or the recursive result if we're an RV; or the IO slot of the symbol
3366 named after the PV if we're a string.
3375 Return the integer value of an SV, doing any necessary string conversion,
3376 magic etc. Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
3385 Marks an existing SV as mortal. The SV will be destroyed "soon", either
3386 by an explicit call to FREETMPS, or by an implicit call at places such as
3387 statement boundaries. See also C<sv_newmortal> and C<sv_mortalcopy>.
3389 SV* sv_2mortal(SV* sv)
3396 Return the num value of an SV, doing any necessary string or integer
3397 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
3407 Return a pointer to the byte-encoded representation of the SV, and set *lp
3408 to its length. May cause the SV to be downgraded from UTF8 as a
3411 Usually accessed via the C<SvPVbyte> macro.
3413 char* sv_2pvbyte(SV* sv, STRLEN* lp)
3418 =item sv_2pvbyte_nolen
3420 Return a pointer to the byte-encoded representation of the SV.
3421 May cause the SV to be downgraded from UTF8 as a side-effect.
3423 Usually accessed via the C<SvPVbyte_nolen> macro.
3425 char* sv_2pvbyte_nolen(SV* sv)
3432 Return a pointer to the UTF8-encoded representation of the SV, and set *lp
3433 to its length. May cause the SV to be upgraded to UTF8 as a side-effect.
3435 Usually accessed via the C<SvPVutf8> macro.
3437 char* sv_2pvutf8(SV* sv, STRLEN* lp)
3442 =item sv_2pvutf8_nolen
3444 Return a pointer to the UTF8-encoded representation of the SV.
3445 May cause the SV to be upgraded to UTF8 as a side-effect.
3447 Usually accessed via the C<SvPVutf8_nolen> macro.
3449 char* sv_2pvutf8_nolen(SV* sv)
3456 Returns a pointer to the string value of an SV, and sets *lp to its length.
3457 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
3459 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
3460 usually end up here too.
3462 char* sv_2pv_flags(SV* sv, STRLEN* lp, I32 flags)
3469 Like C<sv_2pv()>, but doesn't return the length too. You should usually
3470 use the macro wrapper C<SvPV_nolen(sv)> instead.
3471 char* sv_2pv_nolen(SV* sv)
3478 Return the unsigned integer value of an SV, doing any necessary string
3479 conversion, magic etc. Normally used via the C<SvUV(sv)> and C<SvUVx(sv)>
3489 Remove any string offset. You should normally use the C<SvOOK_off> macro
3492 int sv_backoff(SV* sv)
3499 Blesses an SV into a specified package. The SV must be an RV. The package
3500 must be designated by its stash (see C<gv_stashpv()>). The reference count
3501 of the SV is unaffected.
3503 SV* sv_bless(SV* sv, HV* stash)
3510 Concatenates the string onto the end of the string which is in the SV.
3511 If the SV has the UTF8 status set, then the bytes appended should be
3512 valid UTF8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
3514 void sv_catpv(SV* sv, const char* ptr)
3521 Processes its arguments like C<sprintf> and appends the formatted
3522 output to an SV. If the appended data contains "wide" characters
3523 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
3524 and characters >255 formatted with %c), the original SV might get
3525 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic.
3526 C<SvSETMAGIC()> must typically be called after calling this function
3527 to handle 'set' magic.
3529 void sv_catpvf(SV* sv, const char* pat, ...)
3536 Like C<sv_catpvf>, but also handles 'set' magic.
3538 void sv_catpvf_mg(SV *sv, const char* pat, ...)
3545 Concatenates the string onto the end of the string which is in the SV. The
3546 C<len> indicates number of bytes to copy. If the SV has the UTF8
3547 status set, then the bytes appended should be valid UTF8.
3548 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
3550 void sv_catpvn(SV* sv, const char* ptr, STRLEN len)
3555 =item sv_catpvn_flags
3557 Concatenates the string onto the end of the string which is in the SV. The
3558 C<len> indicates number of bytes to copy. If the SV has the UTF8
3559 status set, then the bytes appended should be valid UTF8.
3560 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
3561 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
3562 in terms of this function.
3564 void sv_catpvn_flags(SV* sv, const char* ptr, STRLEN len, I32 flags)
3571 Like C<sv_catpvn>, but also handles 'set' magic.
3573 void sv_catpvn_mg(SV *sv, const char *ptr, STRLEN len)
3580 Like C<sv_catpv>, but also handles 'set' magic.
3582 void sv_catpv_mg(SV *sv, const char *ptr)
3589 Concatenates the string from SV C<ssv> onto the end of the string in
3590 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
3591 not 'set' magic. See C<sv_catsv_mg>.
3593 void sv_catsv(SV* dsv, SV* ssv)
3598 =item sv_catsv_flags
3600 Concatenates the string from SV C<ssv> onto the end of the string in
3601 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
3602 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
3603 and C<sv_catsv_nomg> are implemented in terms of this function.
3605 void sv_catsv_flags(SV* dsv, SV* ssv, I32 flags)
3612 Like C<sv_catsv>, but also handles 'set' magic.
3614 void sv_catsv_mg(SV *dstr, SV *sstr)
3621 Efficient removal of characters from the beginning of the string buffer.
3622 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
3623 the string buffer. The C<ptr> becomes the first character of the adjusted
3624 string. Uses the "OOK hack".
3626 void sv_chop(SV* sv, char* ptr)
3633 Clear an SV: call any destructors, free up any memory used by the body,
3634 and free the body itself. The SV's head is I<not> freed, although
3635 its type is set to all 1's so that it won't inadvertently be assumed
3636 to be live during global destruction etc.
3637 This function should only be called when REFCNT is zero. Most of the time
3638 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
3641 void sv_clear(SV* sv)
3648 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
3649 string in C<sv1> is less than, equal to, or greater than the string in
3650 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
3651 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
3653 I32 sv_cmp(SV* sv1, SV* sv2)
3660 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
3661 'use bytes' aware, handles get magic, and will coerce its args to strings
3662 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
3664 I32 sv_cmp_locale(SV* sv1, SV* sv2)
3671 Add Collate Transform magic to an SV if it doesn't already have it.
3673 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
3674 scalar data of the variable, but transformed to such a format that a normal
3675 memory comparison can be used to compare the data according to the locale
3678 char* sv_collxfrm(SV* sv, STRLEN* nxp)
3685 Copies a stringified representation of the source SV into the
3686 destination SV. Automatically performs any necessary mg_get and
3687 coercion of numeric values into strings. Guaranteed to preserve
3688 UTF-8 flag even from overloaded objects. Similar in nature to
3689 sv_2pv[_flags] but operates directly on an SV instead of just the
3690 string. Mostly uses sv_2pv_flags to do its work, except when that
3691 would lose the UTF-8'ness of the PV.
3693 void sv_copypv(SV* dsv, SV* ssv)
3700 Auto-decrement of the value in the SV, doing string to numeric conversion
3701 if necessary. Handles 'get' magic.
3708 =item sv_derived_from
3710 Returns a boolean indicating whether the SV is derived from the specified
3711 class. This is the function that implements C<UNIVERSAL::isa>. It works
3712 for class names as well as for objects.
3714 bool sv_derived_from(SV* sv, const char* name)
3717 Found in file universal.c
3721 Returns a boolean indicating whether the strings in the two SVs are
3722 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
3723 coerce its args to strings if necessary.
3725 I32 sv_eq(SV* sv1, SV* sv2)
3730 =item sv_force_normal
3732 Undo various types of fakery on an SV: if the PV is a shared string, make
3733 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3734 an xpvmg. See also C<sv_force_normal_flags>.
3736 void sv_force_normal(SV *sv)
3741 =item sv_force_normal_flags
3743 Undo various types of fakery on an SV: if the PV is a shared string, make
3744 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3745 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
3746 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
3747 then a copy-on-write scalar drops its PV buffer (if any) and becomes
3748 SvPOK_off rather than making a copy. (Used where this scalar is about to be
3749 set to some other value. In addtion, the C<flags> parameter gets passed to
3750 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
3751 with flags set to 0.
3753 void sv_force_normal_flags(SV *sv, U32 flags)
3760 Decrement an SV's reference count, and if it drops to zero, call
3761 C<sv_clear> to invoke destructors and free up any memory used by
3762 the body; finally, deallocate the SV's head itself.
3763 Normally called via a wrapper macro C<SvREFCNT_dec>.
3765 void sv_free(SV* sv)
3772 Get a line from the filehandle and store it into the SV, optionally
3773 appending to the currently-stored string.
3775 char* sv_gets(SV* sv, PerlIO* fp, I32 append)
3782 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
3783 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
3784 Use the C<SvGROW> wrapper instead.
3786 char* sv_grow(SV* sv, STRLEN newlen)
3793 Auto-increment of the value in the SV, doing string to numeric conversion
3794 if necessary. Handles 'get' magic.
3803 Inserts a string at the specified offset/length within the SV. Similar to
3804 the Perl substr() function.
3806 void sv_insert(SV* bigsv, STRLEN offset, STRLEN len, char* little, STRLEN littlelen)
3813 Returns a boolean indicating whether the SV is blessed into the specified
3814 class. This does not check for subtypes; use C<sv_derived_from> to verify
3815 an inheritance relationship.
3817 int sv_isa(SV* sv, const char* name)
3824 Returns a boolean indicating whether the SV is an RV pointing to a blessed
3825 object. If the SV is not an RV, or if the object is not blessed, then this
3828 int sv_isobject(SV* sv)
3835 A private implementation of the C<SvIVx> macro for compilers which can't
3836 cope with complex macro expressions. Always use the macro instead.
3845 Returns the length of the string in the SV. Handles magic and type
3846 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
3848 STRLEN sv_len(SV* sv)
3855 Returns the number of characters in the string in an SV, counting wide
3856 UTF8 bytes as a single character. Handles magic and type coercion.
3858 STRLEN sv_len_utf8(SV* sv)
3865 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
3866 then adds a new magic item of type C<how> to the head of the magic list.
3868 void sv_magic(SV* sv, SV* obj, int how, const char* name, I32 namlen)
3875 Adds magic to an SV, upgrading it if necessary. Applies the
3876 supplied vtable and returns pointer to the magic added.
3878 Note that sv_magicext will allow things that sv_magic will not.
3879 In particular you can add magic to SvREADONLY SVs and and more than
3880 one instance of the same 'how'
3882 I C<namelen> is greater then zero then a savepvn() I<copy> of C<name> is stored,
3883 if C<namelen> is zero then C<name> is stored as-is and - as another special
3884 case - if C<(name && namelen == HEf_SVKEY)> then C<name> is assumed to contain
3885 an C<SV*> and has its REFCNT incremented
3887 (This is now used as a subroutine by sv_magic.)
3889 MAGIC * sv_magicext(SV* sv, SV* obj, int how, MGVTBL *vtbl, const char* name, I32 namlen )
3896 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
3897 The new SV is marked as mortal. It will be destroyed "soon", either by an
3898 explicit call to FREETMPS, or by an implicit call at places such as
3899 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
3901 SV* sv_mortalcopy(SV* oldsv)
3908 Creates a new null SV which is mortal. The reference count of the SV is
3909 set to 1. It will be destroyed "soon", either by an explicit call to
3910 FREETMPS, or by an implicit call at places such as statement boundaries.
3911 See also C<sv_mortalcopy> and C<sv_2mortal>.
3920 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
3923 SV* sv_newref(SV* sv)
3930 Dummy routine which "locks" an SV when there is no locking module present.
3931 Exists to avoid test for a NULL function pointer and because it could potentially warn under
3932 some level of strict-ness.
3934 void sv_nolocking(SV *)
3937 Found in file util.c
3941 Dummy routine which "shares" an SV when there is no sharing module present.
3942 Exists to avoid test for a NULL function pointer and because it could potentially warn under
3943 some level of strict-ness.
3945 void sv_nosharing(SV *)
3948 Found in file util.c
3950 =item sv_nounlocking
3952 Dummy routine which "unlocks" an SV when there is no locking module present.
3953 Exists to avoid test for a NULL function pointer and because it could potentially warn under
3954 some level of strict-ness.
3956 void sv_nounlocking(SV *)
3959 Found in file util.c
3963 A private implementation of the C<SvNVx> macro for compilers which can't
3964 cope with complex macro expressions. Always use the macro instead.
3973 Converts the value pointed to by offsetp from a count of bytes from the
3974 start of the string, to a count of the equivalent number of UTF8 chars.
3975 Handles magic and type coercion.
3977 void sv_pos_b2u(SV* sv, I32* offsetp)
3984 Converts the value pointed to by offsetp from a count of UTF8 chars from
3985 the start of the string, to a count of the equivalent number of bytes; if
3986 lenp is non-zero, it does the same to lenp, but this time starting from
3987 the offset, rather than from the start of the string. Handles magic and
3990 void sv_pos_u2b(SV* sv, I32* offsetp, I32* lenp)
3997 Use the C<SvPV_nolen> macro instead
4006 Use C<SvPVbyte_nolen> instead.
4008 char* sv_pvbyte(SV *sv)
4015 A private implementation of the C<SvPVbyte> macro for compilers
4016 which can't cope with complex macro expressions. Always use the macro
4019 char* sv_pvbyten(SV *sv, STRLEN *len)
4024 =item sv_pvbyten_force
4026 A private implementation of the C<SvPVbytex_force> macro for compilers
4027 which can't cope with complex macro expressions. Always use the macro
4030 char* sv_pvbyten_force(SV* sv, STRLEN* lp)
4037 A private implementation of the C<SvPV> macro for compilers which can't
4038 cope with complex macro expressions. Always use the macro instead.
4040 char* sv_pvn(SV *sv, STRLEN *len)
4047 Get a sensible string out of the SV somehow.
4048 A private implementation of the C<SvPV_force> macro for compilers which
4049 can't cope with complex macro expressions. Always use the macro instead.
4051 char* sv_pvn_force(SV* sv, STRLEN* lp)
4056 =item sv_pvn_force_flags
4058 Get a sensible string out of the SV somehow.
4059 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
4060 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
4061 implemented in terms of this function.
4062 You normally want to use the various wrapper macros instead: see
4063 C<SvPV_force> and C<SvPV_force_nomg>
4065 char* sv_pvn_force_flags(SV* sv, STRLEN* lp, I32 flags)
4072 Use the C<SvPVutf8_nolen> macro instead
4074 char* sv_pvutf8(SV *sv)
4081 A private implementation of the C<SvPVutf8> macro for compilers
4082 which can't cope with complex macro expressions. Always use the macro
4085 char* sv_pvutf8n(SV *sv, STRLEN *len)
4090 =item sv_pvutf8n_force
4092 A private implementation of the C<SvPVutf8_force> macro for compilers
4093 which can't cope with complex macro expressions. Always use the macro
4096 char* sv_pvutf8n_force(SV* sv, STRLEN* lp)
4103 Returns a string describing what the SV is a reference to.
4105 char* sv_reftype(SV* sv, int ob)
4112 Make the first argument a copy of the second, then delete the original.
4113 The target SV physically takes over ownership of the body of the source SV
4114 and inherits its flags; however, the target keeps any magic it owns,
4115 and any magic in the source is discarded.
4116 Note that this is a rather specialist SV copying operation; most of the
4117 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4119 void sv_replace(SV* sv, SV* nsv)
4124 =item sv_report_used
4126 Dump the contents of all SVs not yet freed. (Debugging aid).
4128 void sv_report_used()
4135 Underlying implementation for the C<reset> Perl function.
4136 Note that the perl-level function is vaguely deprecated.
4138 void sv_reset(char* s, HV* stash)
4145 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4146 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4147 push a back-reference to this RV onto the array of backreferences
4148 associated with that magic.
4150 SV* sv_rvweaken(SV *sv)
4157 Copies an integer into the given SV, upgrading first if necessary.
4158 Does not handle 'set' magic. See also C<sv_setiv_mg>.
4160 void sv_setiv(SV* sv, IV num)
4167 Like C<sv_setiv>, but also handles 'set' magic.
4169 void sv_setiv_mg(SV *sv, IV i)
4176 Copies a double into the given SV, upgrading first if necessary.
4177 Does not handle 'set' magic. See also C<sv_setnv_mg>.
4179 void sv_setnv(SV* sv, NV num)
4186 Like C<sv_setnv>, but also handles 'set' magic.
4188 void sv_setnv_mg(SV *sv, NV num)
4195 Copies a string into an SV. The string must be null-terminated. Does not
4196 handle 'set' magic. See C<sv_setpv_mg>.
4198 void sv_setpv(SV* sv, const char* ptr)
4205 Processes its arguments like C<sprintf> and sets an SV to the formatted
4206 output. Does not handle 'set' magic. See C<sv_setpvf_mg>.
4208 void sv_setpvf(SV* sv, const char* pat, ...)
4215 Like C<sv_setpvf>, but also handles 'set' magic.
4217 void sv_setpvf_mg(SV *sv, const char* pat, ...)
4224 Copies a string into an SV. The C<len> parameter indicates the number of
4225 bytes to be copied. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4227 void sv_setpvn(SV* sv, const char* ptr, STRLEN len)
4234 Like C<sv_setpvn>, but also handles 'set' magic.
4236 void sv_setpvn_mg(SV *sv, const char *ptr, STRLEN len)
4243 Like C<sv_setpv>, but also handles 'set' magic.
4245 void sv_setpv_mg(SV *sv, const char *ptr)
4252 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
4253 argument will be upgraded to an RV. That RV will be modified to point to
4254 the new SV. The C<classname> argument indicates the package for the
4255 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4256 will be returned and will have a reference count of 1.
4258 SV* sv_setref_iv(SV* rv, const char* classname, IV iv)
4265 Copies a double into a new SV, optionally blessing the SV. The C<rv>
4266 argument will be upgraded to an RV. That RV will be modified to point to
4267 the new SV. The C<classname> argument indicates the package for the
4268 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4269 will be returned and will have a reference count of 1.
4271 SV* sv_setref_nv(SV* rv, const char* classname, NV nv)
4278 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
4279 argument will be upgraded to an RV. That RV will be modified to point to
4280 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
4281 into the SV. The C<classname> argument indicates the package for the
4282 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4283 will be returned and will have a reference count of 1.
4285 Do not use with other Perl types such as HV, AV, SV, CV, because those
4286 objects will become corrupted by the pointer copy process.
4288 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
4290 SV* sv_setref_pv(SV* rv, const char* classname, void* pv)
4297 Copies a string into a new SV, optionally blessing the SV. The length of the
4298 string must be specified with C<n>. The C<rv> argument will be upgraded to
4299 an RV. That RV will be modified to point to the new SV. The C<classname>
4300 argument indicates the package for the blessing. Set C<classname> to
4301 C<Nullch> to avoid the blessing. The new SV will be returned and will have
4302 a reference count of 1.
4304 Note that C<sv_setref_pv> copies the pointer while this copies the string.
4306 SV* sv_setref_pvn(SV* rv, const char* classname, char* pv, STRLEN n)
4313 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
4314 argument will be upgraded to an RV. That RV will be modified to point to
4315 the new SV. The C<classname> argument indicates the package for the
4316 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4317 will be returned and will have a reference count of 1.
4319 SV* sv_setref_uv(SV* rv, const char* classname, UV uv)
4326 Copies the contents of the source SV C<ssv> into the destination SV
4327 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4328 function if the source SV needs to be reused. Does not handle 'set' magic.
4329 Loosely speaking, it performs a copy-by-value, obliterating any previous
4330 content of the destination.
4332 You probably want to use one of the assortment of wrappers, such as
4333 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4334 C<SvSetMagicSV_nosteal>.
4336 void sv_setsv(SV* dsv, SV* ssv)
4341 =item sv_setsv_flags
4343 Copies the contents of the source SV C<ssv> into the destination SV
4344 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4345 function if the source SV needs to be reused. Does not handle 'set' magic.
4346 Loosely speaking, it performs a copy-by-value, obliterating any previous
4347 content of the destination.
4348 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
4349 C<ssv> if appropriate, else not. C<sv_setsv> and C<sv_setsv_nomg> are
4350 implemented in terms of this function.
4352 You probably want to use one of the assortment of wrappers, such as
4353 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4354 C<SvSetMagicSV_nosteal>.
4356 This is the primary function for copying scalars, and most other
4357 copy-ish functions and macros use this underneath.
4359 void sv_setsv_flags(SV* dsv, SV* ssv, I32 flags)
4366 Like C<sv_setsv>, but also handles 'set' magic.
4368 void sv_setsv_mg(SV *dstr, SV *sstr)
4375 Copies an unsigned integer into the given SV, upgrading first if necessary.
4376 Does not handle 'set' magic. See also C<sv_setuv_mg>.
4378 void sv_setuv(SV* sv, UV num)
4385 Like C<sv_setuv>, but also handles 'set' magic.
4387 void sv_setuv_mg(SV *sv, UV u)
4394 Taint an SV. Use C<SvTAINTED_on> instead.
4395 void sv_taint(SV* sv)
4402 Test an SV for taintedness. Use C<SvTAINTED> instead.
4403 bool sv_tainted(SV* sv)
4410 Returns true if the SV has a true value by Perl's rules.
4411 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
4412 instead use an in-line version.
4421 Removes all magic of type C<type> from an SV.
4423 int sv_unmagic(SV* sv, int type)
4430 Unsets the RV status of the SV, and decrements the reference count of
4431 whatever was being referenced by the RV. This can almost be thought of
4432 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
4433 being zero. See C<SvROK_off>.
4435 void sv_unref(SV* sv)
4440 =item sv_unref_flags
4442 Unsets the RV status of the SV, and decrements the reference count of
4443 whatever was being referenced by the RV. This can almost be thought of
4444 as a reversal of C<newSVrv>. The C<cflags> argument can contain
4445 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
4446 (otherwise the decrementing is conditional on the reference count being
4447 different from one or the reference being a readonly SV).
4450 void sv_unref_flags(SV* sv, U32 flags)
4457 Untaint an SV. Use C<SvTAINTED_off> instead.
4458 void sv_untaint(SV* sv)
4465 Upgrade an SV to a more complex form. Generally adds a new body type to the
4466 SV, then copies across as much information as possible from the old body.
4467 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
4469 bool sv_upgrade(SV* sv, U32 mt)
4476 Tells an SV to use C<ptr> to find its string value. Normally the string is
4477 stored inside the SV but sv_usepvn allows the SV to use an outside string.
4478 The C<ptr> should point to memory that was allocated by C<malloc>. The
4479 string length, C<len>, must be supplied. This function will realloc the
4480 memory pointed to by C<ptr>, so that pointer should not be freed or used by
4481 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
4482 See C<sv_usepvn_mg>.
4484 void sv_usepvn(SV* sv, char* ptr, STRLEN len)
4491 Like C<sv_usepvn>, but also handles 'set' magic.
4493 void sv_usepvn_mg(SV *sv, char *ptr, STRLEN len)
4498 =item sv_utf8_decode
4500 Convert the octets in the PV from UTF-8 to chars. Scan for validity and then
4501 turn off SvUTF8 if needed so that we see characters. Used as a building block
4502 for decode_utf8 in Encode.xs
4504 NOTE: this function is experimental and may change or be
4505 removed without notice.
4507 bool sv_utf8_decode(SV *sv)
4512 =item sv_utf8_downgrade
4514 Attempt to convert the PV of an SV from UTF8-encoded to byte encoding.
4515 This may not be possible if the PV contains non-byte encoding characters;
4516 if this is the case, either returns false or, if C<fail_ok> is not
4519 This is not as a general purpose Unicode to byte encoding interface:
4520 use the Encode extension for that.
4522 NOTE: this function is experimental and may change or be
4523 removed without notice.
4525 bool sv_utf8_downgrade(SV *sv, bool fail_ok)
4530 =item sv_utf8_encode
4532 Convert the PV of an SV to UTF8-encoded, but then turn off the C<SvUTF8>
4533 flag so that it looks like octets again. Used as a building block
4534 for encode_utf8 in Encode.xs
4536 void sv_utf8_encode(SV *sv)
4541 =item sv_utf8_upgrade
4543 Convert the PV of an SV to its UTF8-encoded form.
4544 Forces the SV to string form if it is not already.
4545 Always sets the SvUTF8 flag to avoid future validity checks even
4546 if all the bytes have hibit clear.
4548 This is not as a general purpose byte encoding to Unicode interface:
4549 use the Encode extension for that.
4551 STRLEN sv_utf8_upgrade(SV *sv)
4556 =item sv_utf8_upgrade_flags
4558 Convert the PV of an SV to its UTF8-encoded form.
4559 Forces the SV to string form if it is not already.
4560 Always sets the SvUTF8 flag to avoid future validity checks even
4561 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
4562 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
4563 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
4565 This is not as a general purpose byte encoding to Unicode interface:
4566 use the Encode extension for that.
4568 STRLEN sv_utf8_upgrade_flags(SV *sv, I32 flags)
4575 A private implementation of the C<SvUVx> macro for compilers which can't
4576 cope with complex macro expressions. Always use the macro instead.
4585 Processes its arguments like C<vsprintf> and appends the formatted output
4586 to an SV. Uses an array of SVs if the C style variable argument list is
4587 missing (NULL). When running with taint checks enabled, indicates via
4588 C<maybe_tainted> if results are untrustworthy (often due to the use of
4591 Usually used via one of its frontends C<sv_catpvf> and C<sv_catpvf_mg>.
4593 void sv_vcatpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
4600 Works like C<vcatpvfn> but copies the text into the SV instead of
4603 Usually used via one of its frontends C<sv_setpvf> and C<sv_setpvf_mg>.
4605 void sv_vsetpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
4612 In-place upgrade of the supplied SV to a version object.
4614 SV *sv = upg_version(SV *sv);
4616 Returns a pointer to the upgraded SV.
4618 SV* upg_version(SV *ver)
4621 Found in file util.c
4625 Version object aware cmp. Both operands must already have been
4626 converted into version objects.
4628 int vcmp(SV *lvs, SV *rvs)
4631 Found in file util.c
4635 Accepts a version object and returns the normalized floating
4636 point representation. Call like:
4640 NOTE: you can pass either the object directly or the SV
4641 contained within the RV.
4646 Found in file util.c
4650 Accepts a version object and returns the normalized string
4651 representation. Call like:
4653 sv = vstringify(rv);
4655 NOTE: you can pass either the object directly or the SV
4656 contained within the RV.
4658 SV* vstringify(SV *vs)
4661 Found in file util.c
4666 =head1 Unicode Support
4670 =item bytes_from_utf8
4672 Converts a string C<s> of length C<len> from UTF8 into byte encoding.
4673 Unlike <utf8_to_bytes> but like C<bytes_to_utf8>, returns a pointer to
4674 the newly-created string, and updates C<len> to contain the new
4675 length. Returns the original string if no conversion occurs, C<len>
4676 is unchanged. Do nothing if C<is_utf8> points to 0. Sets C<is_utf8> to
4677 0 if C<s> is converted or contains all 7bit characters.
4679 NOTE: this function is experimental and may change or be
4680 removed without notice.
4682 U8* bytes_from_utf8(U8 *s, STRLEN *len, bool *is_utf8)
4685 Found in file utf8.c
4689 Converts a string C<s> of length C<len> from ASCII into UTF8 encoding.
4690 Returns a pointer to the newly-created string, and sets C<len> to
4691 reflect the new length.
4693 NOTE: this function is experimental and may change or be
4694 removed without notice.
4696 U8* bytes_to_utf8(U8 *s, STRLEN *len)
4699 Found in file utf8.c
4703 Return true if the strings s1 and s2 differ case-insensitively, false
4704 if not (if they are equal case-insensitively). If u1 is true, the
4705 string s1 is assumed to be in UTF-8-encoded Unicode. If u2 is true,
4706 the string s2 is assumed to be in UTF-8-encoded Unicode. If u1 or u2
4707 are false, the respective string is assumed to be in native 8-bit
4710 If the pe1 and pe2 are non-NULL, the scanning pointers will be copied
4711 in there (they will point at the beginning of the I<next> character).
4712 If the pointers behind pe1 or pe2 are non-NULL, they are the end
4713 pointers beyond which scanning will not continue under any
4714 circustances. If the byte lengths l1 and l2 are non-zero, s1+l1 and
4715 s2+l2 will be used as goal end pointers that will also stop the scan,
4716 and which qualify towards defining a successful match: all the scans
4717 that define an explicit length must reach their goal pointers for
4718 a match to succeed).
4720 For case-insensitiveness, the "casefolding" of Unicode is used
4721 instead of upper/lowercasing both the characters, see
4722 http://www.unicode.org/unicode/reports/tr21/ (Case Mappings).
4724 I32 ibcmp_utf8(const char* a, char **pe1, UV l1, bool u1, const char* b, char **pe2, UV l2, bool u2)
4727 Found in file utf8.c
4731 Tests if some arbitrary number of bytes begins in a valid UTF-8
4732 character. Note that an INVARIANT (i.e. ASCII) character is a valid
4733 UTF-8 character. The actual number of bytes in the UTF-8 character
4734 will be returned if it is valid, otherwise 0.
4736 STRLEN is_utf8_char(U8 *p)
4739 Found in file utf8.c
4741 =item is_utf8_string
4743 Returns true if first C<len> bytes of the given string form a valid UTF8
4744 string, false otherwise. Note that 'a valid UTF8 string' does not mean
4745 'a string that contains UTF8' because a valid ASCII string is a valid
4748 bool is_utf8_string(U8 *s, STRLEN len)
4751 Found in file utf8.c
4753 =item pv_uni_display
4755 Build to the scalar dsv a displayable version of the string spv,
4756 length len, the displayable version being at most pvlim bytes long
4757 (if longer, the rest is truncated and "..." will be appended).
4759 The flags argument can have UNI_DISPLAY_ISPRINT set to display
4760 isPRINT()able characters as themselves, UNI_DISPLAY_BACKSLASH
4761 to display the \\[nrfta\\] as the backslashed versions (like '\n')
4762 (UNI_DISPLAY_BACKSLASH is preferred over UNI_DISPLAY_ISPRINT for \\).
4763 UNI_DISPLAY_QQ (and its alias UNI_DISPLAY_REGEX) have both
4764 UNI_DISPLAY_BACKSLASH and UNI_DISPLAY_ISPRINT turned on.
4766 The pointer to the PV of the dsv is returned.
4768 char* pv_uni_display(SV *dsv, U8 *spv, STRLEN len, STRLEN pvlim, UV flags)
4771 Found in file utf8.c
4773 =item sv_recode_to_utf8
4775 The encoding is assumed to be an Encode object, on entry the PV
4776 of the sv is assumed to be octets in that encoding, and the sv
4777 will be converted into Unicode (and UTF-8).
4779 If the sv already is UTF-8 (or if it is not POK), or if the encoding
4780 is not a reference, nothing is done to the sv. If the encoding is not
4781 an C<Encode::XS> Encoding object, bad things will happen.
4782 (See F<lib/encoding.pm> and L<Encode>).
4784 The PV of the sv is returned.
4786 char* sv_recode_to_utf8(SV* sv, SV *encoding)
4791 =item sv_uni_display
4793 Build to the scalar dsv a displayable version of the scalar sv,
4794 the displayable version being at most pvlim bytes long
4795 (if longer, the rest is truncated and "..." will be appended).
4797 The flags argument is as in pv_uni_display().
4799 The pointer to the PV of the dsv is returned.
4801 char* sv_uni_display(SV *dsv, SV *ssv, STRLEN pvlim, UV flags)
4804 Found in file utf8.c
4808 The "p" contains the pointer to the UTF-8 string encoding
4809 the character that is being converted.
4811 The "ustrp" is a pointer to the character buffer to put the
4812 conversion result to. The "lenp" is a pointer to the length
4815 The "swashp" is a pointer to the swash to use.
4817 Both the special and normal mappings are stored lib/unicore/To/Foo.pl,
4818 and loaded by SWASHGET, using lib/utf8_heavy.pl. The special (usually,
4819 but not always, a multicharacter mapping), is tried first.
4821 The "special" is a string like "utf8::ToSpecLower", which means the
4822 hash %utf8::ToSpecLower. The access to the hash is through
4823 Perl_to_utf8_case().
4825 The "normal" is a string like "ToLower" which means the swash
4828 UV to_utf8_case(U8 *p, U8* ustrp, STRLEN *lenp, SV **swash, char *normal, char *special)
4831 Found in file utf8.c
4835 Convert the UTF-8 encoded character at p to its foldcase version and
4836 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
4837 that the ustrp needs to be at least UTF8_MAXLEN_FOLD+1 bytes since the
4838 foldcase version may be longer than the original character (up to
4841 The first character of the foldcased version is returned
4842 (but note, as explained above, that there may be more.)
4844 UV to_utf8_fold(U8 *p, U8* ustrp, STRLEN *lenp)
4847 Found in file utf8.c
4851 Convert the UTF-8 encoded character at p to its lowercase version and
4852 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
4853 that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the
4854 lowercase version may be longer than the original character (up to two
4857 The first character of the lowercased version is returned
4858 (but note, as explained above, that there may be more.)
4860 UV to_utf8_lower(U8 *p, U8* ustrp, STRLEN *lenp)
4863 Found in file utf8.c
4867 Convert the UTF-8 encoded character at p to its titlecase version and
4868 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
4869 that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the
4870 titlecase version may be longer than the original character (up to two
4873 The first character of the titlecased version is returned
4874 (but note, as explained above, that there may be more.)
4876 UV to_utf8_title(U8 *p, U8* ustrp, STRLEN *lenp)
4879 Found in file utf8.c
4883 Convert the UTF-8 encoded character at p to its uppercase version and
4884 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
4885 that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the
4886 uppercase version may be longer than the original character (up to two
4889 The first character of the uppercased version is returned
4890 (but note, as explained above, that there may be more.)
4892 UV to_utf8_upper(U8 *p, U8* ustrp, STRLEN *lenp)
4895 Found in file utf8.c
4897 =item utf8n_to_uvchr
4899 Returns the native character value of the first character in the string C<s>
4900 which is assumed to be in UTF8 encoding; C<retlen> will be set to the
4901 length, in bytes, of that character.
4903 Allows length and flags to be passed to low level routine.
4905 UV utf8n_to_uvchr(U8 *s, STRLEN curlen, STRLEN* retlen, U32 flags)
4908 Found in file utf8.c
4910 =item utf8n_to_uvuni
4912 Bottom level UTF-8 decode routine.
4913 Returns the unicode code point value of the first character in the string C<s>
4914 which is assumed to be in UTF8 encoding and no longer than C<curlen>;
4915 C<retlen> will be set to the length, in bytes, of that character.
4917 If C<s> does not point to a well-formed UTF8 character, the behaviour
4918 is dependent on the value of C<flags>: if it contains UTF8_CHECK_ONLY,
4919 it is assumed that the caller will raise a warning, and this function
4920 will silently just set C<retlen> to C<-1> and return zero. If the
4921 C<flags> does not contain UTF8_CHECK_ONLY, warnings about
4922 malformations will be given, C<retlen> will be set to the expected
4923 length of the UTF-8 character in bytes, and zero will be returned.
4925 The C<flags> can also contain various flags to allow deviations from
4926 the strict UTF-8 encoding (see F<utf8.h>).
4928 Most code should use utf8_to_uvchr() rather than call this directly.
4930 UV utf8n_to_uvuni(U8 *s, STRLEN curlen, STRLEN* retlen, U32 flags)
4933 Found in file utf8.c
4937 Returns the number of UTF8 characters between the UTF-8 pointers C<a>
4940 WARNING: use only if you *know* that the pointers point inside the
4943 IV utf8_distance(U8 *a, U8 *b)
4946 Found in file utf8.c
4950 Return the UTF-8 pointer C<s> displaced by C<off> characters, either
4951 forward or backward.
4953 WARNING: do not use the following unless you *know* C<off> is within
4954 the UTF-8 data pointed to by C<s> *and* that on entry C<s> is aligned
4955 on the first byte of character or just after the last byte of a character.
4957 U8* utf8_hop(U8 *s, I32 off)
4960 Found in file utf8.c
4964 Return the length of the UTF-8 char encoded string C<s> in characters.
4965 Stops at C<e> (inclusive). If C<e E<lt> s> or if the scan would end
4966 up past C<e>, croaks.
4968 STRLEN utf8_length(U8* s, U8 *e)
4971 Found in file utf8.c
4975 Converts a string C<s> of length C<len> from UTF8 into byte encoding.
4976 Unlike C<bytes_to_utf8>, this over-writes the original string, and
4977 updates len to contain the new length.
4978 Returns zero on failure, setting C<len> to -1.
4980 NOTE: this function is experimental and may change or be
4981 removed without notice.
4983 U8* utf8_to_bytes(U8 *s, STRLEN *len)
4986 Found in file utf8.c
4990 Returns the native character value of the first character in the string C<s>
4991 which is assumed to be in UTF8 encoding; C<retlen> will be set to the
4992 length, in bytes, of that character.
4994 If C<s> does not point to a well-formed UTF8 character, zero is
4995 returned and retlen is set, if possible, to -1.
4997 UV utf8_to_uvchr(U8 *s, STRLEN* retlen)
5000 Found in file utf8.c
5004 Returns the Unicode code point of the first character in the string C<s>
5005 which is assumed to be in UTF8 encoding; C<retlen> will be set to the
5006 length, in bytes, of that character.
5008 This function should only be used when returned UV is considered
5009 an index into the Unicode semantic tables (e.g. swashes).
5011 If C<s> does not point to a well-formed UTF8 character, zero is
5012 returned and retlen is set, if possible, to -1.
5014 UV utf8_to_uvuni(U8 *s, STRLEN* retlen)
5017 Found in file utf8.c
5021 Adds the UTF8 representation of the Native codepoint C<uv> to the end
5022 of the string C<d>; C<d> should be have at least C<UTF8_MAXLEN+1> free
5023 bytes available. The return value is the pointer to the byte after the
5024 end of the new character. In other words,
5026 d = uvchr_to_utf8(d, uv);
5028 is the recommended wide native character-aware way of saying
5032 U8* uvchr_to_utf8(U8 *d, UV uv)
5035 Found in file utf8.c
5037 =item uvuni_to_utf8_flags
5039 Adds the UTF8 representation of the Unicode codepoint C<uv> to the end
5040 of the string C<d>; C<d> should be have at least C<UTF8_MAXLEN+1> free
5041 bytes available. The return value is the pointer to the byte after the
5042 end of the new character. In other words,
5044 d = uvuni_to_utf8_flags(d, uv, flags);
5048 d = uvuni_to_utf8(d, uv);
5050 (which is equivalent to)
5052 d = uvuni_to_utf8_flags(d, uv, 0);
5054 is the recommended Unicode-aware way of saying
5058 U8* uvuni_to_utf8_flags(U8 *d, UV uv, UV flags)
5061 Found in file utf8.c
5066 =head1 Variables created by C<xsubpp> and C<xsubpp> internal functions
5072 Variable which is setup by C<xsubpp> to indicate the stack base offset,
5073 used by the C<ST>, C<XSprePUSH> and C<XSRETURN> macros. The C<dMARK> macro
5074 must be called prior to setup the C<MARK> variable.
5079 Found in file XSUB.h
5083 Variable which is setup by C<xsubpp> to indicate the
5084 class name for a C++ XS constructor. This is always a C<char*>. See C<THIS>.
5089 Found in file XSUB.h
5093 Sets up the C<ax> variable.
5094 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
5099 Found in file XSUB.h
5103 Sets up the C<items> variable.
5104 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
5109 Found in file XSUB.h
5113 Sets up stack and mark pointers for an XSUB, calling dSP and dMARK.
5114 Sets up the C<ax> and C<items> variables by calling C<dAX> and C<dITEMS>.
5115 This is usually handled automatically by C<xsubpp>.
5120 Found in file XSUB.h
5124 Sets up the C<ix> variable for an XSUB which has aliases. This is usually
5125 handled automatically by C<xsubpp>.
5130 Found in file XSUB.h
5134 Variable which is setup by C<xsubpp> to indicate the number of
5135 items on the stack. See L<perlxs/"Variable-length Parameter Lists">.
5140 Found in file XSUB.h
5144 Variable which is setup by C<xsubpp> to indicate which of an
5145 XSUB's aliases was used to invoke it. See L<perlxs/"The ALIAS: Keyword">.
5150 Found in file XSUB.h
5154 Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
5158 Found in file XSUB.h
5162 Variable which is setup by C<xsubpp> to hold the return value for an
5163 XSUB. This is always the proper type for the XSUB. See
5164 L<perlxs/"The RETVAL Variable">.
5169 Found in file XSUB.h
5173 Used to access elements on the XSUB's stack.
5178 Found in file XSUB.h
5182 Variable which is setup by C<xsubpp> to designate the object in a C++
5183 XSUB. This is always the proper type for the C++ object. See C<CLASS> and
5184 L<perlxs/"Using XS With C++">.
5189 Found in file XSUB.h
5193 Macro to declare an XSUB and its C parameter list. This is handled by
5197 Found in file XSUB.h
5199 =item XSRETURN_EMPTY
5201 Return an empty list from an XSUB immediately.
5207 Found in file XSUB.h
5211 The version identifier for an XS module. This is usually
5212 handled automatically by C<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>.
5215 Found in file XSUB.h
5217 =item XS_VERSION_BOOTCHECK
5219 Macro to verify that a PM module's $VERSION variable matches the XS
5220 module's C<XS_VERSION> variable. This is usually handled automatically by
5221 C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">.
5223 XS_VERSION_BOOTCHECK;
5226 Found in file XSUB.h
5231 =head1 Warning and Dieing
5237 This is the XSUB-writer's interface to Perl's C<die> function.
5238 Normally use this function the same way you use the C C<printf>
5239 function. See C<warn>.
5241 If you want to throw an exception object, assign the object to
5242 C<$@> and then pass C<Nullch> to croak():
5244 errsv = get_sv("@", TRUE);
5245 sv_setsv(errsv, exception_object);
5248 void croak(const char* pat, ...)
5251 Found in file util.c
5255 This is the XSUB-writer's interface to Perl's C<warn> function. Use this
5256 function the same way you use the C C<printf> function. See
5259 void warn(const char* pat, ...)
5262 Found in file util.c
5269 Until May 1997, this document was maintained by Jeff Okamoto
5270 <okamoto@corp.hp.com>. It is now maintained as part of Perl itself.
5272 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
5273 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
5274 Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
5275 Stephen McCamant, and Gurusamy Sarathy.
5277 API Listing originally by Dean Roehrich <roehrich@cray.com>.
5279 Updated to be autogenerated from comments in the source by Benjamin Stuhl.
5283 perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
projects / p5sagit/p5-mst-13.2.git / blob