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. Effectively
1247 a successful hv_store takes ownership of one reference to C<val>. This is
1248 usually what you want; a newly created SV has a reference count of one, so
1249 if all your code does is create SVs then store them in a hash, hv_store
1250 will own the only reference to the new SV, and your code doesn't need to do
1251 anything further to tidy up. hv_store is not implemented as a call to
1252 hv_store_ent, and does not create a temporary SV for the key, so if your
1253 key data is not already in SV form then use hv_store in preference to
1256 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1257 information on how to use this function on tied hashes.
1259 SV** hv_store(HV* tb, const char* key, I32 klen, SV* val, U32 hash)
1266 Stores C<val> in a hash. The hash key is specified as C<key>. The C<hash>
1267 parameter is the precomputed hash value; if it is zero then Perl will
1268 compute it. The return value is the new hash entry so created. It will be
1269 NULL if the operation failed or if the value did not need to be actually
1270 stored within the hash (as in the case of tied hashes). Otherwise the
1271 contents of the return value can be accessed using the C<He?> macros
1272 described here. Note that the caller is responsible for suitably
1273 incrementing the reference count of C<val> before the call, and
1274 decrementing it if the function returned NULL. Effectively a successful
1275 hv_store_ent takes ownership of one reference to C<val>. This is
1276 usually what you want; a newly created SV has a reference count of one, so
1277 if all your code does is create SVs then store them in a hash, hv_store
1278 will own the only reference to the new SV, and your code doesn't need to do
1279 anything further to tidy up. Note that hv_store_ent only reads the C<key>;
1280 unlike C<val> it does not take ownership of it, so maintaining the correct
1281 reference count on C<key> is entirely the caller's responsibility. hv_store
1282 is not implemented as a call to hv_store_ent, and does not create a temporary
1283 SV for the key, so if your key data is not already in SV form then use
1284 hv_store in preference to hv_store_ent.
1286 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1287 information on how to use this function on tied hashes.
1289 HE* hv_store_ent(HV* tb, SV* key, SV* val, U32 hash)
1298 void hv_undef(HV* tb)
1305 Creates a new HV. The reference count is set to 1.
1323 =head1 Magical Functions
1329 Clear something magical that the SV represents. See C<sv_magic>.
1331 int mg_clear(SV* sv)
1338 Copies the magic from one SV to another. See C<sv_magic>.
1340 int mg_copy(SV* sv, SV* nsv, const char* key, I32 klen)
1347 Finds the magic pointer for type matching the SV. See C<sv_magic>.
1349 MAGIC* mg_find(SV* sv, int type)
1356 Free any magic storage used by the SV. See C<sv_magic>.
1365 Do magic after a value is retrieved from the SV. See C<sv_magic>.
1374 Report on the SV's length. See C<sv_magic>.
1376 U32 mg_length(SV* sv)
1383 Turns on the magical status of an SV. See C<sv_magic>.
1385 void mg_magical(SV* sv)
1392 Do magic after a value is assigned to the SV. See C<sv_magic>.
1401 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
1402 argument more than once.
1404 void SvGETMAGIC(SV* sv)
1411 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
1421 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
1422 argument more than once.
1424 void SvSETMAGIC(SV* sv)
1431 Like C<SvSetSV>, but does any set magic required afterwards.
1433 void SvSetMagicSV(SV* dsb, SV* ssv)
1438 =item SvSetMagicSV_nosteal
1440 Like C<SvSetMagicSV>, but does any set magic required afterwards.
1442 void SvSetMagicSV_nosteal(SV* dsv, SV* ssv)
1449 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
1452 void SvSetSV(SV* dsb, SV* ssv)
1457 =item SvSetSV_nosteal
1459 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
1460 ssv. May evaluate arguments more than once.
1462 void SvSetSV_nosteal(SV* dsv, SV* ssv)
1469 Arranges for sv to be shared between threads if a suitable module
1472 void SvSHARE(SV* sv)
1480 =head1 Memory Management
1486 The XSUB-writer's interface to the C C<memcpy> function. The C<src> is the
1487 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1488 the type. May fail on overlapping copies. See also C<Move>.
1490 void Copy(void* src, void* dest, int nitems, type)
1493 Found in file handy.h
1497 The XSUB-writer's interface to the C C<memmove> function. The C<src> is the
1498 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1499 the type. Can do overlapping moves. See also C<Copy>.
1501 void Move(void* src, void* dest, int nitems, type)
1504 Found in file handy.h
1508 The XSUB-writer's interface to the C C<malloc> function.
1510 void New(int id, void* ptr, int nitems, type)
1513 Found in file handy.h
1517 The XSUB-writer's interface to the C C<malloc> function, with
1520 void Newc(int id, void* ptr, int nitems, type, cast)
1523 Found in file handy.h
1527 Creates a new SV. A non-zero C<len> parameter indicates the number of
1528 bytes of preallocated string space the SV should have. An extra byte for a
1529 tailing NUL is also reserved. (SvPOK is not set for the SV even if string
1530 space is allocated.) The reference count for the new SV is set to 1.
1531 C<id> is an integer id between 0 and 1299 (used to identify leaks).
1534 SV* NEWSV(int id, STRLEN len)
1537 Found in file handy.h
1541 The XSUB-writer's interface to the C C<malloc> function. The allocated
1542 memory is zeroed with C<memzero>.
1544 void Newz(int id, void* ptr, int nitems, type)
1547 Found in file handy.h
1551 Fill up memory with a pattern (byte 0xAB over and over again) that
1552 hopefully catches attempts to access uninitialized memory.
1554 void Poison(void* dest, int nitems, type)
1557 Found in file handy.h
1561 The XSUB-writer's interface to the C C<realloc> function.
1563 void Renew(void* ptr, int nitems, type)
1566 Found in file handy.h
1570 The XSUB-writer's interface to the C C<realloc> function, with
1573 void Renewc(void* ptr, int nitems, type, cast)
1576 Found in file handy.h
1580 The XSUB-writer's interface to the C C<free> function.
1582 void Safefree(void* ptr)
1585 Found in file handy.h
1589 Perl's version of C<strdup()>. Returns a pointer to a newly allocated
1590 string which is a duplicate of C<pv>. The size of the string is
1591 determined by C<strlen()>. The memory allocated for the new string can
1592 be freed with the C<Safefree()> function.
1594 char* savepv(const char* pv)
1597 Found in file util.c
1601 Perl's version of what C<strndup()> would be if it existed. Returns a
1602 pointer to a newly allocated string which is a duplicate of the first
1603 C<len> bytes from C<pv>. The memory allocated for the new string can be
1604 freed with the C<Safefree()> function.
1606 char* savepvn(const char* pv, I32 len)
1609 Found in file util.c
1613 A version of C<savepv()> which allocates the duplicate string in memory
1614 which is shared between threads.
1616 char* savesharedpv(const char* pv)
1619 Found in file util.c
1623 This is an architecture-independent macro to copy one structure to another.
1625 void StructCopy(type src, type dest, type)
1628 Found in file handy.h
1632 The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the
1633 destination, C<nitems> is the number of items, and C<type> is the type.
1635 void Zero(void* dest, int nitems, type)
1638 Found in file handy.h
1643 =head1 Miscellaneous Functions
1649 Analyses the string in order to make fast searches on it using fbm_instr()
1650 -- the Boyer-Moore algorithm.
1652 void fbm_compile(SV* sv, U32 flags)
1655 Found in file util.c
1659 Returns the location of the SV in the string delimited by C<str> and
1660 C<strend>. It returns C<Nullch> if the string can't be found. The C<sv>
1661 does not have to be fbm_compiled, but the search will not be as fast
1664 char* fbm_instr(unsigned char* big, unsigned char* bigend, SV* littlesv, U32 flags)
1667 Found in file util.c
1671 Takes a sprintf-style format pattern and conventional
1672 (non-SV) arguments and returns the formatted string.
1674 (char *) Perl_form(pTHX_ const char* pat, ...)
1676 can be used any place a string (char *) is required:
1678 char * s = Perl_form("%d.%d",major,minor);
1680 Uses a single private buffer so if you want to format several strings you
1681 must explicitly copy the earlier strings away (and free the copies when you
1684 char* form(const char* pat, ...)
1687 Found in file util.c
1691 Fill the sv with current working directory
1693 int getcwd_sv(SV* sv)
1696 Found in file util.c
1700 Test two strings to see if they are equal. Returns true or false.
1702 bool strEQ(char* s1, char* s2)
1705 Found in file handy.h
1709 Test two strings to see if the first, C<s1>, is greater than or equal to
1710 the second, C<s2>. Returns true or false.
1712 bool strGE(char* s1, char* s2)
1715 Found in file handy.h
1719 Test two strings to see if the first, C<s1>, is greater than the second,
1720 C<s2>. Returns true or false.
1722 bool strGT(char* s1, char* s2)
1725 Found in file handy.h
1729 Test two strings to see if the first, C<s1>, is less than or equal to the
1730 second, C<s2>. Returns true or false.
1732 bool strLE(char* s1, char* s2)
1735 Found in file handy.h
1739 Test two strings to see if the first, C<s1>, is less than the second,
1740 C<s2>. Returns true or false.
1742 bool strLT(char* s1, char* s2)
1745 Found in file handy.h
1749 Test two strings to see if they are different. Returns true or
1752 bool strNE(char* s1, char* s2)
1755 Found in file handy.h
1759 Test two strings to see if they are equal. The C<len> parameter indicates
1760 the number of bytes to compare. Returns true or false. (A wrapper for
1763 bool strnEQ(char* s1, char* s2, STRLEN len)
1766 Found in file handy.h
1770 Test two strings to see if they are different. The C<len> parameter
1771 indicates the number of bytes to compare. Returns true or false. (A
1772 wrapper for C<strncmp>).
1774 bool strnNE(char* s1, char* s2, STRLEN len)
1777 Found in file handy.h
1782 =head1 Numeric functions
1788 converts a string representing a binary number to numeric form.
1790 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
1791 conversion flags, and I<result> should be NULL or a pointer to an NV.
1792 The scan stops at the end of the string, or the first invalid character.
1793 On return I<*len> is set to the length scanned string, and I<*flags> gives
1796 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
1797 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_bin>
1798 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
1799 and writes the value to I<*result> (or the value is discarded if I<result>
1802 The hex number may optionally be prefixed with "0b" or "b" unless
1803 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
1804 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the binary
1805 number may use '_' characters to separate digits.
1807 UV grok_bin(char* start, STRLEN* len, I32* flags, NV *result)
1810 Found in file numeric.c
1814 converts a string representing a hex number to numeric form.
1816 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
1817 conversion flags, and I<result> should be NULL or a pointer to an NV.
1818 The scan stops at the end of the string, or the first non-hex-digit character.
1819 On return I<*len> is set to the length scanned string, and I<*flags> gives
1822 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
1823 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_hex>
1824 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
1825 and writes the value to I<*result> (or the value is discarded if I<result>
1828 The hex number may optionally be prefixed with "0x" or "x" unless
1829 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
1830 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the hex
1831 number may use '_' characters to separate digits.
1833 UV grok_hex(char* start, STRLEN* len, I32* flags, NV *result)
1836 Found in file numeric.c
1840 Recognise (or not) a number. The type of the number is returned
1841 (0 if unrecognised), otherwise it is a bit-ORed combination of
1842 IS_NUMBER_IN_UV, IS_NUMBER_GREATER_THAN_UV_MAX, IS_NUMBER_NOT_INT,
1843 IS_NUMBER_NEG, IS_NUMBER_INFINITY, IS_NUMBER_NAN (defined in perl.h).
1845 If the value of the number can fit an in UV, it is returned in the *valuep
1846 IS_NUMBER_IN_UV will be set to indicate that *valuep is valid, IS_NUMBER_IN_UV
1847 will never be set unless *valuep is valid, but *valuep may have been assigned
1848 to during processing even though IS_NUMBER_IN_UV is not set on return.
1849 If valuep is NULL, IS_NUMBER_IN_UV will be set for the same cases as when
1850 valuep is non-NULL, but no actual assignment (or SEGV) will occur.
1852 IS_NUMBER_NOT_INT will be set with IS_NUMBER_IN_UV if trailing decimals were
1853 seen (in which case *valuep gives the true value truncated to an integer), and
1854 IS_NUMBER_NEG if the number is negative (in which case *valuep holds the
1855 absolute value). IS_NUMBER_IN_UV is not set if e notation was used or the
1856 number is larger than a UV.
1858 int grok_number(const char *pv, STRLEN len, UV *valuep)
1861 Found in file numeric.c
1863 =item grok_numeric_radix
1865 Scan and skip for a numeric decimal separator (radix).
1867 bool grok_numeric_radix(const char **sp, const char *send)
1870 Found in file numeric.c
1875 UV grok_oct(char* start, STRLEN* len, I32* flags, NV *result)
1878 Found in file numeric.c
1882 For backwards compatibility. Use C<grok_bin> instead.
1884 NV scan_bin(char* start, STRLEN len, STRLEN* retlen)
1887 Found in file numeric.c
1891 For backwards compatibility. Use C<grok_hex> instead.
1893 NV scan_hex(char* start, STRLEN len, STRLEN* retlen)
1896 Found in file numeric.c
1900 For backwards compatibility. Use C<grok_oct> instead.
1902 NV scan_oct(char* start, STRLEN len, STRLEN* retlen)
1905 Found in file numeric.c
1910 =head1 Optree Manipulation Functions
1916 If C<cv> is a constant sub eligible for inlining. returns the constant
1917 value returned by the sub. Otherwise, returns NULL.
1919 Constant subs can be created with C<newCONSTSUB> or as described in
1920 L<perlsub/"Constant Functions">.
1922 SV* cv_const_sv(CV* cv)
1929 Creates a constant sub equivalent to Perl C<sub FOO () { 123 }> which is
1930 eligible for inlining at compile-time.
1932 CV* newCONSTSUB(HV* stash, char* name, SV* sv)
1939 Used by C<xsubpp> to hook up XSUBs as Perl subs.
1947 =head1 Pad Data Structures
1953 Get the value at offset po in the current pad.
1954 Use macro PAD_SV instead of calling this function directly.
1956 SV* pad_sv(PADOFFSET po)
1964 =head1 Stack Manipulation Macros
1970 Declare a stack marker variable, C<mark>, for the XSUB. See C<MARK> and
1980 Saves the original stack mark for the XSUB. See C<ORIGMARK>.
1989 Declares a local copy of perl's stack pointer for the XSUB, available via
1990 the C<SP> macro. See C<SP>.
1999 Used to extend the argument stack for an XSUB's return values. Once
2000 used, guarantees that there is room for at least C<nitems> to be pushed
2003 void EXTEND(SP, int nitems)
2010 Stack marker variable for the XSUB. See C<dMARK>.
2017 The original stack mark for the XSUB. See C<dORIGMARK>.
2024 Pops an integer off the stack.
2033 Pops a long off the stack.
2042 Pops a double off the stack.
2051 Pops a string off the stack. Deprecated. New code should provide
2052 a STRLEN n_a and use POPpx.
2061 Pops a string off the stack which must consist of bytes i.e. characters < 256.
2062 Requires a variable STRLEN n_a in scope.
2071 Pops a string off the stack.
2072 Requires a variable STRLEN n_a in scope.
2081 Pops an SV off the stack.
2090 Push an integer onto the stack. The stack must have room for this element.
2091 Handles 'set' magic. See C<XPUSHi>.
2100 Opening bracket for arguments on a callback. See C<PUTBACK> and
2110 Push a double onto the stack. The stack must have room for this element.
2111 Handles 'set' magic. See C<XPUSHn>.
2120 Push a string onto the stack. The stack must have room for this element.
2121 The C<len> indicates the length of the string. Handles 'set' magic. See
2124 void PUSHp(char* str, STRLEN len)
2131 Push an SV onto the stack. The stack must have room for this element.
2132 Does not handle 'set' magic. See C<XPUSHs>.
2141 Push an unsigned integer onto the stack. The stack must have room for this
2142 element. See C<XPUSHu>.
2151 Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
2152 See C<PUSHMARK> and L<perlcall> for other uses.
2161 Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and
2169 Refetch the stack pointer. Used after a callback. See L<perlcall>.
2178 Push an integer onto the stack, extending the stack if necessary. Handles
2179 'set' magic. See C<PUSHi>.
2188 Push a double onto the stack, extending the stack if necessary. Handles
2189 'set' magic. See C<PUSHn>.
2198 Push a string onto the stack, extending the stack if necessary. The C<len>
2199 indicates the length of the string. Handles 'set' magic. See
2202 void XPUSHp(char* str, STRLEN len)
2209 Push an SV onto the stack, extending the stack if necessary. Does not
2210 handle 'set' magic. See C<PUSHs>.
2219 Push an unsigned integer onto the stack, extending the stack if necessary.
2229 Return from XSUB, indicating number of items on the stack. This is usually
2230 handled by C<xsubpp>.
2232 void XSRETURN(int nitems)
2235 Found in file XSUB.h
2239 Return an integer from an XSUB immediately. Uses C<XST_mIV>.
2241 void XSRETURN_IV(IV iv)
2244 Found in file XSUB.h
2248 Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
2253 Found in file XSUB.h
2257 Return a double from an XSUB immediately. Uses C<XST_mNV>.
2259 void XSRETURN_NV(NV nv)
2262 Found in file XSUB.h
2266 Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
2268 void XSRETURN_PV(char* str)
2271 Found in file XSUB.h
2273 =item XSRETURN_UNDEF
2275 Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
2280 Found in file XSUB.h
2284 Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
2289 Found in file XSUB.h
2293 Place an integer into the specified position C<pos> on the stack. The
2294 value is stored in a new mortal SV.
2296 void XST_mIV(int pos, IV iv)
2299 Found in file XSUB.h
2303 Place C<&PL_sv_no> into the specified position C<pos> on the
2306 void XST_mNO(int pos)
2309 Found in file XSUB.h
2313 Place a double into the specified position C<pos> on the stack. The value
2314 is stored in a new mortal SV.
2316 void XST_mNV(int pos, NV nv)
2319 Found in file XSUB.h
2323 Place a copy of a string into the specified position C<pos> on the stack.
2324 The value is stored in a new mortal SV.
2326 void XST_mPV(int pos, char* str)
2329 Found in file XSUB.h
2333 Place C<&PL_sv_undef> into the specified position C<pos> on the
2336 void XST_mUNDEF(int pos)
2339 Found in file XSUB.h
2343 Place C<&PL_sv_yes> into the specified position C<pos> on the
2346 void XST_mYES(int pos)
2349 Found in file XSUB.h
2360 An enum of flags for Perl types. These are found in the file B<sv.h>
2361 in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
2368 Integer type flag for scalars. See C<svtype>.
2375 Double type flag for scalars. See C<svtype>.
2382 Pointer type flag for scalars. See C<svtype>.
2389 Type flag for arrays. See C<svtype>.
2396 Type flag for code refs. See C<svtype>.
2403 Type flag for hashes. See C<svtype>.
2410 Type flag for blessed scalars. See C<svtype>.
2418 =head1 SV Manipulation Functions
2424 Returns the SV of the specified Perl scalar. If C<create> is set and the
2425 Perl variable does not exist then it will be created. If C<create> is not
2426 set and the variable does not exist then NULL is returned.
2428 NOTE: the perl_ form of this function is deprecated.
2430 SV* get_sv(const char* name, I32 create)
2433 Found in file perl.c
2435 =item looks_like_number
2437 Test if the content of an SV looks like a number (or is a number).
2438 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
2439 non-numeric warning), even if your atof() doesn't grok them.
2441 I32 looks_like_number(SV* sv)
2448 Creates an RV wrapper for an SV. The reference count for the original SV is
2451 SV* newRV_inc(SV* sv)
2458 Creates an RV wrapper for an SV. The reference count for the original
2459 SV is B<not> incremented.
2461 SV* newRV_noinc(SV *sv)
2468 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
2469 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
2472 SV* newSV(STRLEN len)
2479 Creates a new SV and copies an integer into it. The reference count for the
2489 Creates a new SV and copies a floating point value into it.
2490 The reference count for the SV is set to 1.
2499 Creates a new SV and copies a string into it. The reference count for the
2500 SV is set to 1. If C<len> is zero, Perl will compute the length using
2501 strlen(). For efficiency, consider using C<newSVpvn> instead.
2503 SV* newSVpv(const char* s, STRLEN len)
2510 Creates a new SV and initializes it with the string formatted like
2513 SV* newSVpvf(const char* pat, ...)
2520 Creates a new SV and copies a string into it. The reference count for the
2521 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
2522 string. You are responsible for ensuring that the source string is at least
2525 SV* newSVpvn(const char* s, STRLEN len)
2530 =item newSVpvn_share
2532 Creates a new SV with its SvPVX pointing to a shared string in the string
2533 table. If the string does not already exist in the table, it is created
2534 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
2535 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
2536 otherwise the hash is computed. The idea here is that as the string table
2537 is used for shared hash keys these strings will have SvPVX == HeKEY and
2538 hash lookup will avoid string compare.
2540 SV* newSVpvn_share(const char* s, I32 len, U32 hash)
2547 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
2548 it will be upgraded to one. If C<classname> is non-null then the new SV will
2549 be blessed in the specified package. The new SV is returned and its
2550 reference count is 1.
2552 SV* newSVrv(SV* rv, const char* classname)
2559 Creates a new SV which is an exact duplicate of the original SV.
2562 SV* newSVsv(SV* old)
2569 Creates a new SV and copies an unsigned integer into it.
2570 The reference count for the SV is set to 1.
2579 Returns a new version object based on the passed in SV:
2581 SV *sv = new_version(SV *ver);
2583 Does not alter the passed in ver SV. See "upg_version" if you
2584 want to upgrade the SV.
2586 SV* new_version(SV *ver)
2589 Found in file util.c
2593 Returns a pointer to the next character after the parsed
2594 version string, as well as upgrading the passed in SV to
2597 Function must be called with an already existing SV like
2600 s = scan_version(s,sv);
2602 Performs some preprocessing to the string to ensure that
2603 it has the correct characteristics of a version. Flags the
2604 object if it contains an underscore (which denotes this
2607 char* scan_version(char *vstr, SV *sv)
2610 Found in file util.c
2614 Returns a pointer to the next character after the parsed
2615 vstring, as well as updating the passed in sv.
2617 Function must be called like
2620 s = scan_vstring(s,sv);
2622 The sv should already be large enough to store the vstring
2623 passed in, for performance reasons.
2625 char* scan_vstring(char *vstr, SV *sv)
2628 Found in file util.c
2632 Returns the length of the string which is in the SV. See C<SvLEN>.
2634 STRLEN SvCUR(SV* sv)
2641 Set the length of the string which is in the SV. See C<SvCUR>.
2643 void SvCUR_set(SV* sv, STRLEN len)
2650 Returns a pointer to the last character in the string which is in the SV.
2651 See C<SvCUR>. Access the character as *(SvEND(sv)).
2660 Expands the character buffer in the SV so that it has room for the
2661 indicated number of bytes (remember to reserve space for an extra trailing
2662 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
2663 Returns a pointer to the character buffer.
2665 char * SvGROW(SV* sv, STRLEN len)
2672 Returns a boolean indicating whether the SV contains an integer.
2681 Returns a boolean indicating whether the SV contains an integer. Checks
2682 the B<private> setting. Use C<SvIOK>.
2691 Returns a boolean indicating whether the SV contains a signed integer.
2693 void SvIOK_notUV(SV* sv)
2700 Unsets the IV status of an SV.
2702 void SvIOK_off(SV* sv)
2709 Tells an SV that it is an integer.
2711 void SvIOK_on(SV* sv)
2718 Tells an SV that it is an integer and disables all other OK bits.
2720 void SvIOK_only(SV* sv)
2727 Tells and SV that it is an unsigned integer and disables all other OK bits.
2729 void SvIOK_only_UV(SV* sv)
2736 Returns a boolean indicating whether the SV contains an unsigned integer.
2738 void SvIOK_UV(SV* sv)
2745 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
2746 version which guarantees to evaluate sv only once.
2755 Coerces the given SV to an integer and returns it. Guarantees to evaluate
2756 sv only once. Use the more efficient C<SvIV> otherwise.
2765 Returns the raw value in the SV's IV slot, without checks or conversions.
2766 Only use when you are sure SvIOK is true. See also C<SvIV()>.
2775 Returns the size of the string buffer in the SV, not including any part
2776 attributable to C<SvOOK>. See C<SvCUR>.
2778 STRLEN SvLEN(SV* sv)
2785 Returns a boolean indicating whether the SV contains a number, integer or
2795 Returns a boolean indicating whether the SV contains a number, integer or
2796 double. Checks the B<private> setting. Use C<SvNIOK>.
2798 bool SvNIOKp(SV* sv)
2805 Unsets the NV/IV status of an SV.
2807 void SvNIOK_off(SV* sv)
2814 Returns a boolean indicating whether the SV contains a double.
2823 Returns a boolean indicating whether the SV contains a double. Checks the
2824 B<private> setting. Use C<SvNOK>.
2833 Unsets the NV status of an SV.
2835 void SvNOK_off(SV* sv)
2842 Tells an SV that it is a double.
2844 void SvNOK_on(SV* sv)
2851 Tells an SV that it is a double and disables all other OK bits.
2853 void SvNOK_only(SV* sv)
2860 Coerce the given SV to a double and return it. See C<SvNVx> for a version
2861 which guarantees to evaluate sv only once.
2870 Returns the raw value in the SV's NV slot, without checks or conversions.
2871 Only use when you are sure SvNOK is true. See also C<SvNV()>.
2880 Coerces the given SV to a double and returns it. Guarantees to evaluate
2881 sv only once. Use the more efficient C<SvNV> otherwise.
2890 Returns a boolean indicating whether the value is an SV.
2899 Returns a boolean indicating whether the SvIVX is a valid offset value for
2900 the SvPVX. This hack is used internally to speed up removal of characters
2901 from the beginning of a SvPV. When SvOOK is true, then the start of the
2902 allocated string buffer is really (SvPVX - SvIVX).
2911 Returns a boolean indicating whether the SV contains a character
2921 Returns a boolean indicating whether the SV contains a character string.
2922 Checks the B<private> setting. Use C<SvPOK>.
2931 Unsets the PV status of an SV.
2933 void SvPOK_off(SV* sv)
2940 Tells an SV that it is a string.
2942 void SvPOK_on(SV* sv)
2949 Tells an SV that it is a string and disables all other OK bits.
2950 Will also turn off the UTF8 status.
2952 void SvPOK_only(SV* sv)
2957 =item SvPOK_only_UTF8
2959 Tells an SV that it is a string and disables all other OK bits,
2960 and leaves the UTF8 status as it was.
2962 void SvPOK_only_UTF8(SV* sv)
2969 Returns a pointer to the string in the SV, or a stringified form of
2970 the SV if the SV does not contain a string. The SV may cache the
2971 stringified version becoming C<SvPOK>. Handles 'get' magic. See also
2972 C<SvPVx> for a version which guarantees to evaluate sv only once.
2974 char* SvPV(SV* sv, STRLEN len)
2981 Like C<SvPV>, but converts sv to byte representation first if necessary.
2983 char* SvPVbyte(SV* sv, STRLEN len)
2990 Like C<SvPV>, but converts sv to byte representation first if necessary.
2991 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
2995 char* SvPVbytex(SV* sv, STRLEN len)
3000 =item SvPVbytex_force
3002 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
3003 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
3006 char* SvPVbytex_force(SV* sv, STRLEN len)
3011 =item SvPVbyte_force
3013 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
3015 char* SvPVbyte_force(SV* sv, STRLEN len)
3020 =item SvPVbyte_nolen
3022 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
3024 char* SvPVbyte_nolen(SV* sv)
3031 Like C<SvPV>, but converts sv to utf8 first if necessary.
3033 char* SvPVutf8(SV* sv, STRLEN len)
3040 Like C<SvPV>, but converts sv to utf8 first if necessary.
3041 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
3044 char* SvPVutf8x(SV* sv, STRLEN len)
3049 =item SvPVutf8x_force
3051 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
3052 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
3055 char* SvPVutf8x_force(SV* sv, STRLEN len)
3060 =item SvPVutf8_force
3062 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
3064 char* SvPVutf8_force(SV* sv, STRLEN len)
3069 =item SvPVutf8_nolen
3071 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
3073 char* SvPVutf8_nolen(SV* sv)
3080 A version of C<SvPV> which guarantees to evaluate sv only once.
3082 char* SvPVx(SV* sv, STRLEN len)
3089 Returns a pointer to the physical string in the SV. The SV must contain a
3099 Like C<SvPV> but will force the SV into containing just a string
3100 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
3103 char* SvPV_force(SV* sv, STRLEN len)
3108 =item SvPV_force_nomg
3110 Like C<SvPV> but will force the SV into containing just a string
3111 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
3112 directly. Doesn't process magic.
3114 char* SvPV_force_nomg(SV* sv, STRLEN len)
3121 Returns a pointer to the string in the SV, or a stringified form of
3122 the SV if the SV does not contain a string. The SV may cache the
3123 stringified form becoming C<SvPOK>. Handles 'get' magic.
3125 char* SvPV_nolen(SV* sv)
3132 Returns the value of the object's reference count.
3134 U32 SvREFCNT(SV* sv)
3141 Decrements the reference count of the given SV.
3143 void SvREFCNT_dec(SV* sv)
3150 Increments the reference count of the given SV.
3152 SV* SvREFCNT_inc(SV* sv)
3159 Tests if the SV is an RV.
3168 Unsets the RV status of an SV.
3170 void SvROK_off(SV* sv)
3177 Tells an SV that it is an RV.
3179 void SvROK_on(SV* sv)
3186 Dereferences an RV to return the SV.
3195 Returns the stash of the SV.
3204 Taints an SV if tainting is enabled
3206 void SvTAINT(SV* sv)
3213 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
3216 bool SvTAINTED(SV* sv)
3223 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
3224 some of Perl's fundamental security features. XS module authors should not
3225 use this function unless they fully understand all the implications of
3226 unconditionally untainting the value. Untainting should be done in the
3227 standard perl fashion, via a carefully crafted regexp, rather than directly
3228 untainting variables.
3230 void SvTAINTED_off(SV* sv)
3237 Marks an SV as tainted.
3239 void SvTAINTED_on(SV* sv)
3246 Returns a boolean indicating whether Perl would evaluate the SV as true or
3247 false, defined or undefined. Does not handle 'get' magic.
3256 Returns the type of the SV. See C<svtype>.
3258 svtype SvTYPE(SV* sv)
3265 Releases a mutual exclusion lock on sv if a suitable module
3269 void SvUNLOCK(SV* sv)
3276 Returns a boolean indicating whether the SV contains an unsigned integer.
3285 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
3286 perform the upgrade if necessary. See C<svtype>.
3288 void SvUPGRADE(SV* sv, svtype type)
3295 Returns a boolean indicating whether the SV contains UTF-8 encoded data.
3304 Unsets the UTF8 status of an SV.
3306 void SvUTF8_off(SV *sv)
3313 Turn on the UTF8 status of an SV (the data is not changed, just the flag).
3314 Do not use frivolously.
3316 void SvUTF8_on(SV *sv)
3323 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
3324 for a version which guarantees to evaluate sv only once.
3333 Returns the raw value in the SV's UV slot, without checks or conversions.
3334 Only use when you are sure SvIOK is true. See also C<SvUV()>.
3343 Coerces the given SV to an unsigned integer and returns it. Guarantees to
3344 evaluate sv only once. Use the more efficient C<SvUV> otherwise.
3353 Returns a boolean indicating whether the SV contains a v-string.
3362 This function is only called on magical items, and is only used by
3363 sv_true() or its macro equivalent.
3365 bool sv_2bool(SV* sv)
3372 Using various gambits, try to get a CV from an SV; in addition, try if
3373 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
3375 CV* sv_2cv(SV* sv, HV** st, GV** gvp, I32 lref)
3382 Using various gambits, try to get an IO from an SV: the IO slot if its a
3383 GV; or the recursive result if we're an RV; or the IO slot of the symbol
3384 named after the PV if we're a string.
3393 Return the integer value of an SV, doing any necessary string conversion,
3394 magic etc. Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
3403 Marks an existing SV as mortal. The SV will be destroyed "soon", either
3404 by an explicit call to FREETMPS, or by an implicit call at places such as
3405 statement boundaries. See also C<sv_newmortal> and C<sv_mortalcopy>.
3407 SV* sv_2mortal(SV* sv)
3414 Return the num value of an SV, doing any necessary string or integer
3415 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
3425 Return a pointer to the byte-encoded representation of the SV, and set *lp
3426 to its length. May cause the SV to be downgraded from UTF8 as a
3429 Usually accessed via the C<SvPVbyte> macro.
3431 char* sv_2pvbyte(SV* sv, STRLEN* lp)
3436 =item sv_2pvbyte_nolen
3438 Return a pointer to the byte-encoded representation of the SV.
3439 May cause the SV to be downgraded from UTF8 as a side-effect.
3441 Usually accessed via the C<SvPVbyte_nolen> macro.
3443 char* sv_2pvbyte_nolen(SV* sv)
3450 Return a pointer to the UTF8-encoded representation of the SV, and set *lp
3451 to its length. May cause the SV to be upgraded to UTF8 as a side-effect.
3453 Usually accessed via the C<SvPVutf8> macro.
3455 char* sv_2pvutf8(SV* sv, STRLEN* lp)
3460 =item sv_2pvutf8_nolen
3462 Return a pointer to the UTF8-encoded representation of the SV.
3463 May cause the SV to be upgraded to UTF8 as a side-effect.
3465 Usually accessed via the C<SvPVutf8_nolen> macro.
3467 char* sv_2pvutf8_nolen(SV* sv)
3474 Returns a pointer to the string value of an SV, and sets *lp to its length.
3475 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
3477 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
3478 usually end up here too.
3480 char* sv_2pv_flags(SV* sv, STRLEN* lp, I32 flags)
3487 Like C<sv_2pv()>, but doesn't return the length too. You should usually
3488 use the macro wrapper C<SvPV_nolen(sv)> instead.
3489 char* sv_2pv_nolen(SV* sv)
3496 Return the unsigned integer value of an SV, doing any necessary string
3497 conversion, magic etc. Normally used via the C<SvUV(sv)> and C<SvUVx(sv)>
3507 Remove any string offset. You should normally use the C<SvOOK_off> macro
3510 int sv_backoff(SV* sv)
3517 Blesses an SV into a specified package. The SV must be an RV. The package
3518 must be designated by its stash (see C<gv_stashpv()>). The reference count
3519 of the SV is unaffected.
3521 SV* sv_bless(SV* sv, HV* stash)
3528 Concatenates the string onto the end of the string which is in the SV.
3529 If the SV has the UTF8 status set, then the bytes appended should be
3530 valid UTF8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
3532 void sv_catpv(SV* sv, const char* ptr)
3539 Processes its arguments like C<sprintf> and appends the formatted
3540 output to an SV. If the appended data contains "wide" characters
3541 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
3542 and characters >255 formatted with %c), the original SV might get
3543 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic.
3544 C<SvSETMAGIC()> must typically be called after calling this function
3545 to handle 'set' magic.
3547 void sv_catpvf(SV* sv, const char* pat, ...)
3554 Like C<sv_catpvf>, but also handles 'set' magic.
3556 void sv_catpvf_mg(SV *sv, const char* pat, ...)
3563 Concatenates the string onto the end of the string which is in the SV. The
3564 C<len> indicates number of bytes to copy. If the SV has the UTF8
3565 status set, then the bytes appended should be valid UTF8.
3566 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
3568 void sv_catpvn(SV* sv, const char* ptr, STRLEN len)
3573 =item sv_catpvn_flags
3575 Concatenates the string onto the end of the string which is in the SV. The
3576 C<len> indicates number of bytes to copy. If the SV has the UTF8
3577 status set, then the bytes appended should be valid UTF8.
3578 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
3579 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
3580 in terms of this function.
3582 void sv_catpvn_flags(SV* sv, const char* ptr, STRLEN len, I32 flags)
3589 Like C<sv_catpvn>, but also handles 'set' magic.
3591 void sv_catpvn_mg(SV *sv, const char *ptr, STRLEN len)
3598 Like C<sv_catpv>, but also handles 'set' magic.
3600 void sv_catpv_mg(SV *sv, const char *ptr)
3607 Concatenates the string from SV C<ssv> onto the end of the string in
3608 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
3609 not 'set' magic. See C<sv_catsv_mg>.
3611 void sv_catsv(SV* dsv, SV* ssv)
3616 =item sv_catsv_flags
3618 Concatenates the string from SV C<ssv> onto the end of the string in
3619 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
3620 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
3621 and C<sv_catsv_nomg> are implemented in terms of this function.
3623 void sv_catsv_flags(SV* dsv, SV* ssv, I32 flags)
3630 Like C<sv_catsv>, but also handles 'set' magic.
3632 void sv_catsv_mg(SV *dstr, SV *sstr)
3639 Efficient removal of characters from the beginning of the string buffer.
3640 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
3641 the string buffer. The C<ptr> becomes the first character of the adjusted
3642 string. Uses the "OOK hack".
3644 void sv_chop(SV* sv, char* ptr)
3651 Clear an SV: call any destructors, free up any memory used by the body,
3652 and free the body itself. The SV's head is I<not> freed, although
3653 its type is set to all 1's so that it won't inadvertently be assumed
3654 to be live during global destruction etc.
3655 This function should only be called when REFCNT is zero. Most of the time
3656 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
3659 void sv_clear(SV* sv)
3666 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
3667 string in C<sv1> is less than, equal to, or greater than the string in
3668 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
3669 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
3671 I32 sv_cmp(SV* sv1, SV* sv2)
3678 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
3679 'use bytes' aware, handles get magic, and will coerce its args to strings
3680 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
3682 I32 sv_cmp_locale(SV* sv1, SV* sv2)
3689 Add Collate Transform magic to an SV if it doesn't already have it.
3691 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
3692 scalar data of the variable, but transformed to such a format that a normal
3693 memory comparison can be used to compare the data according to the locale
3696 char* sv_collxfrm(SV* sv, STRLEN* nxp)
3703 Copies a stringified representation of the source SV into the
3704 destination SV. Automatically performs any necessary mg_get and
3705 coercion of numeric values into strings. Guaranteed to preserve
3706 UTF-8 flag even from overloaded objects. Similar in nature to
3707 sv_2pv[_flags] but operates directly on an SV instead of just the
3708 string. Mostly uses sv_2pv_flags to do its work, except when that
3709 would lose the UTF-8'ness of the PV.
3711 void sv_copypv(SV* dsv, SV* ssv)
3718 Auto-decrement of the value in the SV, doing string to numeric conversion
3719 if necessary. Handles 'get' magic.
3726 =item sv_derived_from
3728 Returns a boolean indicating whether the SV is derived from the specified
3729 class. This is the function that implements C<UNIVERSAL::isa>. It works
3730 for class names as well as for objects.
3732 bool sv_derived_from(SV* sv, const char* name)
3735 Found in file universal.c
3739 Returns a boolean indicating whether the strings in the two SVs are
3740 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
3741 coerce its args to strings if necessary.
3743 I32 sv_eq(SV* sv1, SV* sv2)
3748 =item sv_force_normal
3750 Undo various types of fakery on an SV: if the PV is a shared string, make
3751 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3752 an xpvmg. See also C<sv_force_normal_flags>.
3754 void sv_force_normal(SV *sv)
3759 =item sv_force_normal_flags
3761 Undo various types of fakery on an SV: if the PV is a shared string, make
3762 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3763 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
3764 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
3765 then a copy-on-write scalar drops its PV buffer (if any) and becomes
3766 SvPOK_off rather than making a copy. (Used where this scalar is about to be
3767 set to some other value.) In addtion, the C<flags> parameter gets passed to
3768 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
3769 with flags set to 0.
3771 void sv_force_normal_flags(SV *sv, U32 flags)
3778 Decrement an SV's reference count, and if it drops to zero, call
3779 C<sv_clear> to invoke destructors and free up any memory used by
3780 the body; finally, deallocate the SV's head itself.
3781 Normally called via a wrapper macro C<SvREFCNT_dec>.
3783 void sv_free(SV* sv)
3790 Get a line from the filehandle and store it into the SV, optionally
3791 appending to the currently-stored string.
3793 char* sv_gets(SV* sv, PerlIO* fp, I32 append)
3800 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
3801 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
3802 Use the C<SvGROW> wrapper instead.
3804 char* sv_grow(SV* sv, STRLEN newlen)
3811 Auto-increment of the value in the SV, doing string to numeric conversion
3812 if necessary. Handles 'get' magic.
3821 Inserts a string at the specified offset/length within the SV. Similar to
3822 the Perl substr() function.
3824 void sv_insert(SV* bigsv, STRLEN offset, STRLEN len, char* little, STRLEN littlelen)
3831 Returns a boolean indicating whether the SV is blessed into the specified
3832 class. This does not check for subtypes; use C<sv_derived_from> to verify
3833 an inheritance relationship.
3835 int sv_isa(SV* sv, const char* name)
3842 Returns a boolean indicating whether the SV is an RV pointing to a blessed
3843 object. If the SV is not an RV, or if the object is not blessed, then this
3846 int sv_isobject(SV* sv)
3853 A private implementation of the C<SvIVx> macro for compilers which can't
3854 cope with complex macro expressions. Always use the macro instead.
3863 Returns the length of the string in the SV. Handles magic and type
3864 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
3866 STRLEN sv_len(SV* sv)
3873 Returns the number of characters in the string in an SV, counting wide
3874 UTF8 bytes as a single character. Handles magic and type coercion.
3876 STRLEN sv_len_utf8(SV* sv)
3883 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
3884 then adds a new magic item of type C<how> to the head of the magic list.
3886 void sv_magic(SV* sv, SV* obj, int how, const char* name, I32 namlen)
3893 Adds magic to an SV, upgrading it if necessary. Applies the
3894 supplied vtable and returns pointer to the magic added.
3896 Note that sv_magicext will allow things that sv_magic will not.
3897 In particular you can add magic to SvREADONLY SVs and and more than
3898 one instance of the same 'how'
3900 I C<namelen> is greater then zero then a savepvn() I<copy> of C<name> is stored,
3901 if C<namelen> is zero then C<name> is stored as-is and - as another special
3902 case - if C<(name && namelen == HEf_SVKEY)> then C<name> is assumed to contain
3903 an C<SV*> and has its REFCNT incremented
3905 (This is now used as a subroutine by sv_magic.)
3907 MAGIC * sv_magicext(SV* sv, SV* obj, int how, MGVTBL *vtbl, const char* name, I32 namlen )
3914 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
3915 The new SV is marked as mortal. It will be destroyed "soon", either by an
3916 explicit call to FREETMPS, or by an implicit call at places such as
3917 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
3919 SV* sv_mortalcopy(SV* oldsv)
3926 Creates a new null SV which is mortal. The reference count of the SV is
3927 set to 1. It will be destroyed "soon", either by an explicit call to
3928 FREETMPS, or by an implicit call at places such as statement boundaries.
3929 See also C<sv_mortalcopy> and C<sv_2mortal>.
3938 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
3941 SV* sv_newref(SV* sv)
3948 Dummy routine which "locks" an SV when there is no locking module present.
3949 Exists to avoid test for a NULL function pointer and because it could potentially warn under
3950 some level of strict-ness.
3952 void sv_nolocking(SV *)
3955 Found in file util.c
3959 Dummy routine which "shares" an SV when there is no sharing module present.
3960 Exists to avoid test for a NULL function pointer and because it could potentially warn under
3961 some level of strict-ness.
3963 void sv_nosharing(SV *)
3966 Found in file util.c
3968 =item sv_nounlocking
3970 Dummy routine which "unlocks" an SV when there is no locking module present.
3971 Exists to avoid test for a NULL function pointer and because it could potentially warn under
3972 some level of strict-ness.
3974 void sv_nounlocking(SV *)
3977 Found in file util.c
3981 A private implementation of the C<SvNVx> macro for compilers which can't
3982 cope with complex macro expressions. Always use the macro instead.
3991 Converts the value pointed to by offsetp from a count of bytes from the
3992 start of the string, to a count of the equivalent number of UTF8 chars.
3993 Handles magic and type coercion.
3995 void sv_pos_b2u(SV* sv, I32* offsetp)
4002 Converts the value pointed to by offsetp from a count of UTF8 chars from
4003 the start of the string, to a count of the equivalent number of bytes; if
4004 lenp is non-zero, it does the same to lenp, but this time starting from
4005 the offset, rather than from the start of the string. Handles magic and
4008 void sv_pos_u2b(SV* sv, I32* offsetp, I32* lenp)
4015 Use the C<SvPV_nolen> macro instead
4024 Use C<SvPVbyte_nolen> instead.
4026 char* sv_pvbyte(SV *sv)
4033 A private implementation of the C<SvPVbyte> macro for compilers
4034 which can't cope with complex macro expressions. Always use the macro
4037 char* sv_pvbyten(SV *sv, STRLEN *len)
4042 =item sv_pvbyten_force
4044 A private implementation of the C<SvPVbytex_force> macro for compilers
4045 which can't cope with complex macro expressions. Always use the macro
4048 char* sv_pvbyten_force(SV* sv, STRLEN* lp)
4055 A private implementation of the C<SvPV> macro for compilers which can't
4056 cope with complex macro expressions. Always use the macro instead.
4058 char* sv_pvn(SV *sv, STRLEN *len)
4065 Get a sensible string out of the SV somehow.
4066 A private implementation of the C<SvPV_force> macro for compilers which
4067 can't cope with complex macro expressions. Always use the macro instead.
4069 char* sv_pvn_force(SV* sv, STRLEN* lp)
4074 =item sv_pvn_force_flags
4076 Get a sensible string out of the SV somehow.
4077 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
4078 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
4079 implemented in terms of this function.
4080 You normally want to use the various wrapper macros instead: see
4081 C<SvPV_force> and C<SvPV_force_nomg>
4083 char* sv_pvn_force_flags(SV* sv, STRLEN* lp, I32 flags)
4090 Use the C<SvPVutf8_nolen> macro instead
4092 char* sv_pvutf8(SV *sv)
4099 A private implementation of the C<SvPVutf8> macro for compilers
4100 which can't cope with complex macro expressions. Always use the macro
4103 char* sv_pvutf8n(SV *sv, STRLEN *len)
4108 =item sv_pvutf8n_force
4110 A private implementation of the C<SvPVutf8_force> macro for compilers
4111 which can't cope with complex macro expressions. Always use the macro
4114 char* sv_pvutf8n_force(SV* sv, STRLEN* lp)
4121 Returns a string describing what the SV is a reference to.
4123 char* sv_reftype(SV* sv, int ob)
4130 Make the first argument a copy of the second, then delete the original.
4131 The target SV physically takes over ownership of the body of the source SV
4132 and inherits its flags; however, the target keeps any magic it owns,
4133 and any magic in the source is discarded.
4134 Note that this is a rather specialist SV copying operation; most of the
4135 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4137 void sv_replace(SV* sv, SV* nsv)
4142 =item sv_report_used
4144 Dump the contents of all SVs not yet freed. (Debugging aid).
4146 void sv_report_used()
4153 Underlying implementation for the C<reset> Perl function.
4154 Note that the perl-level function is vaguely deprecated.
4156 void sv_reset(char* s, HV* stash)
4163 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4164 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4165 push a back-reference to this RV onto the array of backreferences
4166 associated with that magic.
4168 SV* sv_rvweaken(SV *sv)
4175 Copies an integer into the given SV, upgrading first if necessary.
4176 Does not handle 'set' magic. See also C<sv_setiv_mg>.
4178 void sv_setiv(SV* sv, IV num)
4185 Like C<sv_setiv>, but also handles 'set' magic.
4187 void sv_setiv_mg(SV *sv, IV i)
4194 Copies a double into the given SV, upgrading first if necessary.
4195 Does not handle 'set' magic. See also C<sv_setnv_mg>.
4197 void sv_setnv(SV* sv, NV num)
4204 Like C<sv_setnv>, but also handles 'set' magic.
4206 void sv_setnv_mg(SV *sv, NV num)
4213 Copies a string into an SV. The string must be null-terminated. Does not
4214 handle 'set' magic. See C<sv_setpv_mg>.
4216 void sv_setpv(SV* sv, const char* ptr)
4223 Processes its arguments like C<sprintf> and sets an SV to the formatted
4224 output. Does not handle 'set' magic. See C<sv_setpvf_mg>.
4226 void sv_setpvf(SV* sv, const char* pat, ...)
4233 Like C<sv_setpvf>, but also handles 'set' magic.
4235 void sv_setpvf_mg(SV *sv, const char* pat, ...)
4242 Copies a string into an SV. The C<len> parameter indicates the number of
4243 bytes to be copied. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4245 void sv_setpvn(SV* sv, const char* ptr, STRLEN len)
4252 Like C<sv_setpvn>, but also handles 'set' magic.
4254 void sv_setpvn_mg(SV *sv, const char *ptr, STRLEN len)
4261 Like C<sv_setpv>, but also handles 'set' magic.
4263 void sv_setpv_mg(SV *sv, const char *ptr)
4270 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
4271 argument will be upgraded to an RV. That RV will be modified to point to
4272 the new SV. The C<classname> argument indicates the package for the
4273 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4274 will be returned and will have a reference count of 1.
4276 SV* sv_setref_iv(SV* rv, const char* classname, IV iv)
4283 Copies a double into a new SV, optionally blessing the SV. The C<rv>
4284 argument will be upgraded to an RV. That RV will be modified to point to
4285 the new SV. The C<classname> argument indicates the package for the
4286 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4287 will be returned and will have a reference count of 1.
4289 SV* sv_setref_nv(SV* rv, const char* classname, NV nv)
4296 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
4297 argument will be upgraded to an RV. That RV will be modified to point to
4298 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
4299 into the SV. The C<classname> argument indicates the package for the
4300 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4301 will be returned and will have a reference count of 1.
4303 Do not use with other Perl types such as HV, AV, SV, CV, because those
4304 objects will become corrupted by the pointer copy process.
4306 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
4308 SV* sv_setref_pv(SV* rv, const char* classname, void* pv)
4315 Copies a string into a new SV, optionally blessing the SV. The length of the
4316 string must be specified with C<n>. The C<rv> argument will be upgraded to
4317 an RV. That RV will be modified to point to the new SV. The C<classname>
4318 argument indicates the package for the blessing. Set C<classname> to
4319 C<Nullch> to avoid the blessing. The new SV will be returned and will have
4320 a reference count of 1.
4322 Note that C<sv_setref_pv> copies the pointer while this copies the string.
4324 SV* sv_setref_pvn(SV* rv, const char* classname, char* pv, STRLEN n)
4331 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
4332 argument will be upgraded to an RV. That RV will be modified to point to
4333 the new SV. The C<classname> argument indicates the package for the
4334 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4335 will be returned and will have a reference count of 1.
4337 SV* sv_setref_uv(SV* rv, const char* classname, UV uv)
4344 Copies the contents of the source SV C<ssv> into the destination SV
4345 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4346 function if the source SV needs to be reused. Does not handle 'set' magic.
4347 Loosely speaking, it performs a copy-by-value, obliterating any previous
4348 content of the destination.
4350 You probably want to use one of the assortment of wrappers, such as
4351 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4352 C<SvSetMagicSV_nosteal>.
4354 void sv_setsv(SV* dsv, SV* ssv)
4359 =item sv_setsv_flags
4361 Copies the contents of the source SV C<ssv> into the destination SV
4362 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4363 function if the source SV needs to be reused. Does not handle 'set' magic.
4364 Loosely speaking, it performs a copy-by-value, obliterating any previous
4365 content of the destination.
4366 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
4367 C<ssv> if appropriate, else not. C<sv_setsv> and C<sv_setsv_nomg> are
4368 implemented in terms of this function.
4370 You probably want to use one of the assortment of wrappers, such as
4371 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4372 C<SvSetMagicSV_nosteal>.
4374 This is the primary function for copying scalars, and most other
4375 copy-ish functions and macros use this underneath.
4377 void sv_setsv_flags(SV* dsv, SV* ssv, I32 flags)
4384 Like C<sv_setsv>, but also handles 'set' magic.
4386 void sv_setsv_mg(SV *dstr, SV *sstr)
4393 Copies an unsigned integer into the given SV, upgrading first if necessary.
4394 Does not handle 'set' magic. See also C<sv_setuv_mg>.
4396 void sv_setuv(SV* sv, UV num)
4403 Like C<sv_setuv>, but also handles 'set' magic.
4405 void sv_setuv_mg(SV *sv, UV u)
4412 Taint an SV. Use C<SvTAINTED_on> instead.
4413 void sv_taint(SV* sv)
4420 Test an SV for taintedness. Use C<SvTAINTED> instead.
4421 bool sv_tainted(SV* sv)
4428 Returns true if the SV has a true value by Perl's rules.
4429 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
4430 instead use an in-line version.
4439 Removes all magic of type C<type> from an SV.
4441 int sv_unmagic(SV* sv, int type)
4448 Unsets the RV status of the SV, and decrements the reference count of
4449 whatever was being referenced by the RV. This can almost be thought of
4450 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
4451 being zero. See C<SvROK_off>.
4453 void sv_unref(SV* sv)
4458 =item sv_unref_flags
4460 Unsets the RV status of the SV, and decrements the reference count of
4461 whatever was being referenced by the RV. This can almost be thought of
4462 as a reversal of C<newSVrv>. The C<cflags> argument can contain
4463 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
4464 (otherwise the decrementing is conditional on the reference count being
4465 different from one or the reference being a readonly SV).
4468 void sv_unref_flags(SV* sv, U32 flags)
4475 Untaint an SV. Use C<SvTAINTED_off> instead.
4476 void sv_untaint(SV* sv)
4483 Upgrade an SV to a more complex form. Generally adds a new body type to the
4484 SV, then copies across as much information as possible from the old body.
4485 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
4487 bool sv_upgrade(SV* sv, U32 mt)
4494 Tells an SV to use C<ptr> to find its string value. Normally the string is
4495 stored inside the SV but sv_usepvn allows the SV to use an outside string.
4496 The C<ptr> should point to memory that was allocated by C<malloc>. The
4497 string length, C<len>, must be supplied. This function will realloc the
4498 memory pointed to by C<ptr>, so that pointer should not be freed or used by
4499 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
4500 See C<sv_usepvn_mg>.
4502 void sv_usepvn(SV* sv, char* ptr, STRLEN len)
4509 Like C<sv_usepvn>, but also handles 'set' magic.
4511 void sv_usepvn_mg(SV *sv, char *ptr, STRLEN len)
4516 =item sv_utf8_decode
4518 Convert the octets in the PV from UTF-8 to chars. Scan for validity and then
4519 turn off SvUTF8 if needed so that we see characters. Used as a building block
4520 for decode_utf8 in Encode.xs
4522 NOTE: this function is experimental and may change or be
4523 removed without notice.
4525 bool sv_utf8_decode(SV *sv)
4530 =item sv_utf8_downgrade
4532 Attempt to convert the PV of an SV from UTF8-encoded to byte encoding.
4533 This may not be possible if the PV contains non-byte encoding characters;
4534 if this is the case, either returns false or, if C<fail_ok> is not
4537 This is not as a general purpose Unicode to byte encoding interface:
4538 use the Encode extension for that.
4540 NOTE: this function is experimental and may change or be
4541 removed without notice.
4543 bool sv_utf8_downgrade(SV *sv, bool fail_ok)
4548 =item sv_utf8_encode
4550 Convert the PV of an SV to UTF8-encoded, but then turn off the C<SvUTF8>
4551 flag so that it looks like octets again. Used as a building block
4552 for encode_utf8 in Encode.xs
4554 void sv_utf8_encode(SV *sv)
4559 =item sv_utf8_upgrade
4561 Convert the PV of an SV to its UTF8-encoded form.
4562 Forces the SV to string form if it is not already.
4563 Always sets the SvUTF8 flag to avoid future validity checks even
4564 if all the bytes have hibit clear.
4566 This is not as a general purpose byte encoding to Unicode interface:
4567 use the Encode extension for that.
4569 STRLEN sv_utf8_upgrade(SV *sv)
4574 =item sv_utf8_upgrade_flags
4576 Convert the PV of an SV to its UTF8-encoded form.
4577 Forces the SV to string form if it is not already.
4578 Always sets the SvUTF8 flag to avoid future validity checks even
4579 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
4580 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
4581 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
4583 This is not as a general purpose byte encoding to Unicode interface:
4584 use the Encode extension for that.
4586 STRLEN sv_utf8_upgrade_flags(SV *sv, I32 flags)
4593 A private implementation of the C<SvUVx> macro for compilers which can't
4594 cope with complex macro expressions. Always use the macro instead.
4603 Processes its arguments like C<vsprintf> and appends the formatted output
4604 to an SV. Uses an array of SVs if the C style variable argument list is
4605 missing (NULL). When running with taint checks enabled, indicates via
4606 C<maybe_tainted> if results are untrustworthy (often due to the use of
4609 Usually used via one of its frontends C<sv_catpvf> and C<sv_catpvf_mg>.
4611 void sv_vcatpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
4618 Works like C<vcatpvfn> but copies the text into the SV instead of
4621 Usually used via one of its frontends C<sv_setpvf> and C<sv_setpvf_mg>.
4623 void sv_vsetpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
4630 In-place upgrade of the supplied SV to a version object.
4632 SV *sv = upg_version(SV *sv);
4634 Returns a pointer to the upgraded SV.
4636 SV* upg_version(SV *ver)
4639 Found in file util.c
4643 Version object aware cmp. Both operands must already have been
4644 converted into version objects.
4646 int vcmp(SV *lvs, SV *rvs)
4649 Found in file util.c
4653 Accepts a version object and returns the normalized floating
4654 point representation. Call like:
4658 NOTE: you can pass either the object directly or the SV
4659 contained within the RV.
4664 Found in file util.c
4668 Accepts a version object and returns the normalized string
4669 representation. Call like:
4671 sv = vstringify(rv);
4673 NOTE: you can pass either the object directly or the SV
4674 contained within the RV.
4676 SV* vstringify(SV *vs)
4679 Found in file util.c
4684 =head1 Unicode Support
4688 =item bytes_from_utf8
4690 Converts a string C<s> of length C<len> from UTF8 into byte encoding.
4691 Unlike <utf8_to_bytes> but like C<bytes_to_utf8>, returns a pointer to
4692 the newly-created string, and updates C<len> to contain the new
4693 length. Returns the original string if no conversion occurs, C<len>
4694 is unchanged. Do nothing if C<is_utf8> points to 0. Sets C<is_utf8> to
4695 0 if C<s> is converted or contains all 7bit characters.
4697 NOTE: this function is experimental and may change or be
4698 removed without notice.
4700 U8* bytes_from_utf8(U8 *s, STRLEN *len, bool *is_utf8)
4703 Found in file utf8.c
4707 Converts a string C<s> of length C<len> from ASCII into UTF8 encoding.
4708 Returns a pointer to the newly-created string, and sets C<len> to
4709 reflect the new length.
4711 NOTE: this function is experimental and may change or be
4712 removed without notice.
4714 U8* bytes_to_utf8(U8 *s, STRLEN *len)
4717 Found in file utf8.c
4721 Return true if the strings s1 and s2 differ case-insensitively, false
4722 if not (if they are equal case-insensitively). If u1 is true, the
4723 string s1 is assumed to be in UTF-8-encoded Unicode. If u2 is true,
4724 the string s2 is assumed to be in UTF-8-encoded Unicode. If u1 or u2
4725 are false, the respective string is assumed to be in native 8-bit
4728 If the pe1 and pe2 are non-NULL, the scanning pointers will be copied
4729 in there (they will point at the beginning of the I<next> character).
4730 If the pointers behind pe1 or pe2 are non-NULL, they are the end
4731 pointers beyond which scanning will not continue under any
4732 circustances. If the byte lengths l1 and l2 are non-zero, s1+l1 and
4733 s2+l2 will be used as goal end pointers that will also stop the scan,
4734 and which qualify towards defining a successful match: all the scans
4735 that define an explicit length must reach their goal pointers for
4736 a match to succeed).
4738 For case-insensitiveness, the "casefolding" of Unicode is used
4739 instead of upper/lowercasing both the characters, see
4740 http://www.unicode.org/unicode/reports/tr21/ (Case Mappings).
4742 I32 ibcmp_utf8(const char* a, char **pe1, UV l1, bool u1, const char* b, char **pe2, UV l2, bool u2)
4745 Found in file utf8.c
4749 Tests if some arbitrary number of bytes begins in a valid UTF-8
4750 character. Note that an INVARIANT (i.e. ASCII) character is a valid
4751 UTF-8 character. The actual number of bytes in the UTF-8 character
4752 will be returned if it is valid, otherwise 0.
4754 STRLEN is_utf8_char(U8 *p)
4757 Found in file utf8.c
4759 =item is_utf8_string
4761 Returns true if first C<len> bytes of the given string form a valid UTF8
4762 string, false otherwise. Note that 'a valid UTF8 string' does not mean
4763 'a string that contains UTF8' because a valid ASCII string is a valid
4766 bool is_utf8_string(U8 *s, STRLEN len)
4769 Found in file utf8.c
4771 =item pv_uni_display
4773 Build to the scalar dsv a displayable version of the string spv,
4774 length len, the displayable version being at most pvlim bytes long
4775 (if longer, the rest is truncated and "..." will be appended).
4777 The flags argument can have UNI_DISPLAY_ISPRINT set to display
4778 isPRINT()able characters as themselves, UNI_DISPLAY_BACKSLASH
4779 to display the \\[nrfta\\] as the backslashed versions (like '\n')
4780 (UNI_DISPLAY_BACKSLASH is preferred over UNI_DISPLAY_ISPRINT for \\).
4781 UNI_DISPLAY_QQ (and its alias UNI_DISPLAY_REGEX) have both
4782 UNI_DISPLAY_BACKSLASH and UNI_DISPLAY_ISPRINT turned on.
4784 The pointer to the PV of the dsv is returned.
4786 char* pv_uni_display(SV *dsv, U8 *spv, STRLEN len, STRLEN pvlim, UV flags)
4789 Found in file utf8.c
4793 The encoding is assumed to be an Encode object, the PV of the ssv is
4794 assumed to be octets in that encoding and decoding the input starts
4795 from the position which (PV + *offset) pointed to. The dsv will be
4796 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
4797 when the string tstr appears in decoding output or the input ends on
4798 the PV of the ssv. The value which the offset points will be modified
4799 to the last input position on the ssv.
4801 Returns TRUE if the terminator was found, else returns FALSE.
4803 bool sv_cat_decode(SV* dsv, SV *encoding, SV *ssv, int *offset, char* tstr, int tlen)
4808 =item sv_recode_to_utf8
4810 The encoding is assumed to be an Encode object, on entry the PV
4811 of the sv is assumed to be octets in that encoding, and the sv
4812 will be converted into Unicode (and UTF-8).
4814 If the sv already is UTF-8 (or if it is not POK), or if the encoding
4815 is not a reference, nothing is done to the sv. If the encoding is not
4816 an C<Encode::XS> Encoding object, bad things will happen.
4817 (See F<lib/encoding.pm> and L<Encode>).
4819 The PV of the sv is returned.
4821 char* sv_recode_to_utf8(SV* sv, SV *encoding)
4826 =item sv_uni_display
4828 Build to the scalar dsv a displayable version of the scalar sv,
4829 the displayable version being at most pvlim bytes long
4830 (if longer, the rest is truncated and "..." will be appended).
4832 The flags argument is as in pv_uni_display().
4834 The pointer to the PV of the dsv is returned.
4836 char* sv_uni_display(SV *dsv, SV *ssv, STRLEN pvlim, UV flags)
4839 Found in file utf8.c
4843 The "p" contains the pointer to the UTF-8 string encoding
4844 the character that is being converted.
4846 The "ustrp" is a pointer to the character buffer to put the
4847 conversion result to. The "lenp" is a pointer to the length
4850 The "swashp" is a pointer to the swash to use.
4852 Both the special and normal mappings are stored lib/unicore/To/Foo.pl,
4853 and loaded by SWASHGET, using lib/utf8_heavy.pl. The special (usually,
4854 but not always, a multicharacter mapping), is tried first.
4856 The "special" is a string like "utf8::ToSpecLower", which means the
4857 hash %utf8::ToSpecLower. The access to the hash is through
4858 Perl_to_utf8_case().
4860 The "normal" is a string like "ToLower" which means the swash
4863 UV to_utf8_case(U8 *p, U8* ustrp, STRLEN *lenp, SV **swash, char *normal, char *special)
4866 Found in file utf8.c
4870 Convert the UTF-8 encoded character at p to its foldcase version and
4871 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
4872 that the ustrp needs to be at least UTF8_MAXLEN_FOLD+1 bytes since the
4873 foldcase version may be longer than the original character (up to
4876 The first character of the foldcased version is returned
4877 (but note, as explained above, that there may be more.)
4879 UV to_utf8_fold(U8 *p, U8* ustrp, STRLEN *lenp)
4882 Found in file utf8.c
4886 Convert the UTF-8 encoded character at p to its lowercase version and
4887 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
4888 that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the
4889 lowercase version may be longer than the original character (up to two
4892 The first character of the lowercased version is returned
4893 (but note, as explained above, that there may be more.)
4895 UV to_utf8_lower(U8 *p, U8* ustrp, STRLEN *lenp)
4898 Found in file utf8.c
4902 Convert the UTF-8 encoded character at p to its titlecase version and
4903 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
4904 that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the
4905 titlecase version may be longer than the original character (up to two
4908 The first character of the titlecased version is returned
4909 (but note, as explained above, that there may be more.)
4911 UV to_utf8_title(U8 *p, U8* ustrp, STRLEN *lenp)
4914 Found in file utf8.c
4918 Convert the UTF-8 encoded character at p to its uppercase version and
4919 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
4920 that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the
4921 uppercase version may be longer than the original character (up to two
4924 The first character of the uppercased version is returned
4925 (but note, as explained above, that there may be more.)
4927 UV to_utf8_upper(U8 *p, U8* ustrp, STRLEN *lenp)
4930 Found in file utf8.c
4932 =item utf8n_to_uvchr
4934 Returns the native character value of the first character in the string C<s>
4935 which is assumed to be in UTF8 encoding; C<retlen> will be set to the
4936 length, in bytes, of that character.
4938 Allows length and flags to be passed to low level routine.
4940 UV utf8n_to_uvchr(U8 *s, STRLEN curlen, STRLEN* retlen, U32 flags)
4943 Found in file utf8.c
4945 =item utf8n_to_uvuni
4947 Bottom level UTF-8 decode routine.
4948 Returns the unicode code point value of the first character in the string C<s>
4949 which is assumed to be in UTF8 encoding and no longer than C<curlen>;
4950 C<retlen> will be set to the length, in bytes, of that character.
4952 If C<s> does not point to a well-formed UTF8 character, the behaviour
4953 is dependent on the value of C<flags>: if it contains UTF8_CHECK_ONLY,
4954 it is assumed that the caller will raise a warning, and this function
4955 will silently just set C<retlen> to C<-1> and return zero. If the
4956 C<flags> does not contain UTF8_CHECK_ONLY, warnings about
4957 malformations will be given, C<retlen> will be set to the expected
4958 length of the UTF-8 character in bytes, and zero will be returned.
4960 The C<flags> can also contain various flags to allow deviations from
4961 the strict UTF-8 encoding (see F<utf8.h>).
4963 Most code should use utf8_to_uvchr() rather than call this directly.
4965 UV utf8n_to_uvuni(U8 *s, STRLEN curlen, STRLEN* retlen, U32 flags)
4968 Found in file utf8.c
4972 Returns the number of UTF8 characters between the UTF-8 pointers C<a>
4975 WARNING: use only if you *know* that the pointers point inside the
4978 IV utf8_distance(U8 *a, U8 *b)
4981 Found in file utf8.c
4985 Return the UTF-8 pointer C<s> displaced by C<off> characters, either
4986 forward or backward.
4988 WARNING: do not use the following unless you *know* C<off> is within
4989 the UTF-8 data pointed to by C<s> *and* that on entry C<s> is aligned
4990 on the first byte of character or just after the last byte of a character.
4992 U8* utf8_hop(U8 *s, I32 off)
4995 Found in file utf8.c
4999 Return the length of the UTF-8 char encoded string C<s> in characters.
5000 Stops at C<e> (inclusive). If C<e E<lt> s> or if the scan would end
5001 up past C<e>, croaks.
5003 STRLEN utf8_length(U8* s, U8 *e)
5006 Found in file utf8.c
5010 Converts a string C<s> of length C<len> from UTF8 into byte encoding.
5011 Unlike C<bytes_to_utf8>, this over-writes the original string, and
5012 updates len to contain the new length.
5013 Returns zero on failure, setting C<len> to -1.
5015 NOTE: this function is experimental and may change or be
5016 removed without notice.
5018 U8* utf8_to_bytes(U8 *s, STRLEN *len)
5021 Found in file utf8.c
5025 Returns the native character value of the first character in the string C<s>
5026 which is assumed to be in UTF8 encoding; C<retlen> will be set to the
5027 length, in bytes, of that character.
5029 If C<s> does not point to a well-formed UTF8 character, zero is
5030 returned and retlen is set, if possible, to -1.
5032 UV utf8_to_uvchr(U8 *s, STRLEN* retlen)
5035 Found in file utf8.c
5039 Returns the Unicode code point of the first character in the string C<s>
5040 which is assumed to be in UTF8 encoding; C<retlen> will be set to the
5041 length, in bytes, of that character.
5043 This function should only be used when returned UV is considered
5044 an index into the Unicode semantic tables (e.g. swashes).
5046 If C<s> does not point to a well-formed UTF8 character, zero is
5047 returned and retlen is set, if possible, to -1.
5049 UV utf8_to_uvuni(U8 *s, STRLEN* retlen)
5052 Found in file utf8.c
5056 Adds the UTF8 representation of the Native codepoint C<uv> to the end
5057 of the string C<d>; C<d> should be have at least C<UTF8_MAXLEN+1> free
5058 bytes available. The return value is the pointer to the byte after the
5059 end of the new character. In other words,
5061 d = uvchr_to_utf8(d, uv);
5063 is the recommended wide native character-aware way of saying
5067 U8* uvchr_to_utf8(U8 *d, UV uv)
5070 Found in file utf8.c
5072 =item uvuni_to_utf8_flags
5074 Adds the UTF8 representation of the Unicode codepoint C<uv> to the end
5075 of the string C<d>; C<d> should be have at least C<UTF8_MAXLEN+1> free
5076 bytes available. The return value is the pointer to the byte after the
5077 end of the new character. In other words,
5079 d = uvuni_to_utf8_flags(d, uv, flags);
5083 d = uvuni_to_utf8(d, uv);
5085 (which is equivalent to)
5087 d = uvuni_to_utf8_flags(d, uv, 0);
5089 is the recommended Unicode-aware way of saying
5093 U8* uvuni_to_utf8_flags(U8 *d, UV uv, UV flags)
5096 Found in file utf8.c
5101 =head1 Variables created by C<xsubpp> and C<xsubpp> internal functions
5107 Variable which is setup by C<xsubpp> to indicate the stack base offset,
5108 used by the C<ST>, C<XSprePUSH> and C<XSRETURN> macros. The C<dMARK> macro
5109 must be called prior to setup the C<MARK> variable.
5114 Found in file XSUB.h
5118 Variable which is setup by C<xsubpp> to indicate the
5119 class name for a C++ XS constructor. This is always a C<char*>. See C<THIS>.
5124 Found in file XSUB.h
5128 Sets up the C<ax> variable.
5129 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
5134 Found in file XSUB.h
5138 Sets up the C<items> variable.
5139 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
5144 Found in file XSUB.h
5148 Sets up stack and mark pointers for an XSUB, calling dSP and dMARK.
5149 Sets up the C<ax> and C<items> variables by calling C<dAX> and C<dITEMS>.
5150 This is usually handled automatically by C<xsubpp>.
5155 Found in file XSUB.h
5159 Sets up the C<ix> variable for an XSUB which has aliases. This is usually
5160 handled automatically by C<xsubpp>.
5165 Found in file XSUB.h
5169 Variable which is setup by C<xsubpp> to indicate the number of
5170 items on the stack. See L<perlxs/"Variable-length Parameter Lists">.
5175 Found in file XSUB.h
5179 Variable which is setup by C<xsubpp> to indicate which of an
5180 XSUB's aliases was used to invoke it. See L<perlxs/"The ALIAS: Keyword">.
5185 Found in file XSUB.h
5189 Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
5193 Found in file XSUB.h
5197 Variable which is setup by C<xsubpp> to hold the return value for an
5198 XSUB. This is always the proper type for the XSUB. See
5199 L<perlxs/"The RETVAL Variable">.
5204 Found in file XSUB.h
5208 Used to access elements on the XSUB's stack.
5213 Found in file XSUB.h
5217 Variable which is setup by C<xsubpp> to designate the object in a C++
5218 XSUB. This is always the proper type for the C++ object. See C<CLASS> and
5219 L<perlxs/"Using XS With C++">.
5224 Found in file XSUB.h
5228 Macro to declare an XSUB and its C parameter list. This is handled by
5232 Found in file XSUB.h
5234 =item XSRETURN_EMPTY
5236 Return an empty list from an XSUB immediately.
5242 Found in file XSUB.h
5246 The version identifier for an XS module. This is usually
5247 handled automatically by C<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>.
5250 Found in file XSUB.h
5252 =item XS_VERSION_BOOTCHECK
5254 Macro to verify that a PM module's $VERSION variable matches the XS
5255 module's C<XS_VERSION> variable. This is usually handled automatically by
5256 C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">.
5258 XS_VERSION_BOOTCHECK;
5261 Found in file XSUB.h
5266 =head1 Warning and Dieing
5272 This is the XSUB-writer's interface to Perl's C<die> function.
5273 Normally use this function the same way you use the C C<printf>
5274 function. See C<warn>.
5276 If you want to throw an exception object, assign the object to
5277 C<$@> and then pass C<Nullch> to croak():
5279 errsv = get_sv("@", TRUE);
5280 sv_setsv(errsv, exception_object);
5283 void croak(const char* pat, ...)
5286 Found in file util.c
5290 This is the XSUB-writer's interface to Perl's C<warn> function. Use this
5291 function the same way you use the C C<printf> function. See
5294 void warn(const char* pat, ...)
5297 Found in file util.c
5304 Until May 1997, this document was maintained by Jeff Okamoto
5305 <okamoto@corp.hp.com>. It is now maintained as part of Perl itself.
5307 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
5308 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
5309 Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
5310 Stephen McCamant, and Gurusamy Sarathy.
5312 API Listing originally by Dean Roehrich <roehrich@cray.com>.
5314 Updated to be autogenerated from comments in the source by Benjamin Stuhl.
5318 perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
projects / p5sagit/p5-mst-13.2.git / blob