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 parameters:
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 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 packlist(SV *cat, char *pat, char *patend, SV **beglist, SV **endlist)
714 Found in file pp_pack.c
718 The engine implementing pack() Perl function. Note: parameters next_in_list and
719 flags are not used. This call should not be used; use packlist instead.
721 void pack_cat(SV *cat, char *pat, char *patend, SV **beglist, SV **endlist, SV ***next_in_list, U32 flags)
724 Found in file pp_pack.c
728 The engine implementing unpack() Perl function.
730 I32 unpackstring(char *pat, char *patend, char *s, char *strend, U32 flags)
733 Found in file pp_pack.c
737 The engine implementing unpack() Perl function. Note: parameters strbeg, new_s
738 and ocnt are not used. This call should not be used, use unpackstring instead.
740 I32 unpack_str(char *pat, char *patend, char *s, char *strbeg, char *strend, char **new_s, I32 ocnt, U32 flags)
743 Found in file pp_pack.c
748 =head1 Global Variables
754 C<PL_modglobal> is a general purpose, interpreter global HV for use by
755 extensions that need to keep information on a per-interpreter basis.
756 In a pinch, it can also be used as a symbol table for extensions
757 to share data among each other. It is a good idea to use keys
758 prefixed by the package name of the extension that owns the data.
763 Found in file intrpvar.h
767 A convenience variable which is typically used with C<SvPV> when one
768 doesn't care about the length of the string. It is usually more efficient
769 to either declare a local variable and use that instead or to use the
775 Found in file thrdvar.h
779 This is the C<false> SV. See C<PL_sv_yes>. Always refer to this as
785 Found in file intrpvar.h
789 This is the C<undef> SV. Always refer to this as C<&PL_sv_undef>.
794 Found in file intrpvar.h
798 This is the C<true> SV. See C<PL_sv_no>. Always refer to this as
804 Found in file intrpvar.h
815 Return the SV from the GV.
824 Returns the glob with the given C<name> and a defined subroutine or
825 C<NULL>. The glob lives in the given C<stash>, or in the stashes
826 accessible via @ISA and UNIVERSAL::.
828 The argument C<level> should be either 0 or -1. If C<level==0>, as a
829 side-effect creates a glob with the given C<name> in the given C<stash>
830 which in the case of success contains an alias for the subroutine, and sets
831 up caching info for this glob. Similarly for all the searched stashes.
833 This function grants C<"SUPER"> token as a postfix of the stash name. The
834 GV returned from C<gv_fetchmeth> may be a method cache entry, which is not
835 visible to Perl code. So when calling C<call_sv>, you should not use
836 the GV directly; instead, you should use the method's CV, which can be
837 obtained from the GV with the C<GvCV> macro.
839 GV* gv_fetchmeth(HV* stash, const char* name, STRLEN len, I32 level)
846 See L<gv_fetchmethod_autoload>.
848 GV* gv_fetchmethod(HV* stash, const char* name)
853 =item gv_fetchmethod_autoload
855 Returns the glob which contains the subroutine to call to invoke the method
856 on the C<stash>. In fact in the presence of autoloading this may be the
857 glob for "AUTOLOAD". In this case the corresponding variable $AUTOLOAD is
860 The third parameter of C<gv_fetchmethod_autoload> determines whether
861 AUTOLOAD lookup is performed if the given method is not present: non-zero
862 means yes, look for AUTOLOAD; zero means no, don't look for AUTOLOAD.
863 Calling C<gv_fetchmethod> is equivalent to calling C<gv_fetchmethod_autoload>
864 with a non-zero C<autoload> parameter.
866 These functions grant C<"SUPER"> token as a prefix of the method name. Note
867 that if you want to keep the returned glob for a long time, you need to
868 check for it being "AUTOLOAD", since at the later time the call may load a
869 different subroutine due to $AUTOLOAD changing its value. Use the glob
870 created via a side effect to do this.
872 These functions have the same side-effects and as C<gv_fetchmeth> with
873 C<level==0>. C<name> should be writable if contains C<':'> or C<'
874 ''>. The warning against passing the GV returned by C<gv_fetchmeth> to
875 C<call_sv> apply equally to these functions.
877 GV* gv_fetchmethod_autoload(HV* stash, const char* name, I32 autoload)
882 =item gv_fetchmeth_autoload
884 Same as gv_fetchmeth(), but looks for autoloaded subroutines too.
885 Returns a glob for the subroutine.
887 For an autoloaded subroutine without a GV, will create a GV even
888 if C<level < 0>. For an autoloaded subroutine without a stub, GvCV()
889 of the result may be zero.
891 GV* gv_fetchmeth_autoload(HV* stash, const char* name, STRLEN len, I32 level)
898 Returns a pointer to the stash for a specified package. C<name> should
899 be a valid UTF-8 string. If C<create> is set then the package will be
900 created if it does not already exist. If C<create> is not set and the
901 package does not exist then NULL is returned.
903 HV* gv_stashpv(const char* name, I32 create)
910 Returns a pointer to the stash for a specified package, which must be a
911 valid UTF-8 string. See C<gv_stashpv>.
913 HV* gv_stashsv(SV* sv, I32 create)
927 This flag, used in the length slot of hash entries and magic structures,
928 specifies the structure contains an C<SV*> pointer where a C<char*> pointer
929 is to be expected. (For information only--not to be used).
937 Null character pointer.
940 Found in file handy.h
947 Found in file handy.h
952 =head1 Hash Manipulation Functions
958 Returns the HV of the specified Perl hash. If C<create> is set and the
959 Perl variable does not exist then it will be created. If C<create> is not
960 set and the variable does not exist then NULL is returned.
962 NOTE: the perl_ form of this function is deprecated.
964 HV* get_hv(const char* name, I32 create)
971 Returns the computed hash stored in the hash entry.
980 Returns the actual pointer stored in the key slot of the hash entry. The
981 pointer may be either C<char*> or C<SV*>, depending on the value of
982 C<HeKLEN()>. Can be assigned to. The C<HePV()> or C<HeSVKEY()> macros are
983 usually preferable for finding the value of a key.
992 If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry
993 holds an C<SV*> key. Otherwise, holds the actual length of the key. Can
994 be assigned to. The C<HePV()> macro is usually preferable for finding key
997 STRLEN HeKLEN(HE* he)
1004 Returns the key slot of the hash entry as a C<char*> value, doing any
1005 necessary dereferencing of possibly C<SV*> keys. The length of the string
1006 is placed in C<len> (this is a macro, so do I<not> use C<&len>). If you do
1007 not care about what the length of the key is, you may use the global
1008 variable C<PL_na>, though this is rather less efficient than using a local
1009 variable. Remember though, that hash keys in perl are free to contain
1010 embedded nulls, so using C<strlen()> or similar is not a good way to find
1011 the length of hash keys. This is very similar to the C<SvPV()> macro
1012 described elsewhere in this document.
1014 char* HePV(HE* he, STRLEN len)
1021 Returns the key as an C<SV*>, or C<Nullsv> if the hash entry does not
1022 contain an C<SV*> key.
1031 Returns the key as an C<SV*>. Will create and return a temporary mortal
1032 C<SV*> if the hash entry contains only a C<char*> key.
1034 SV* HeSVKEY_force(HE* he)
1041 Sets the key to a given C<SV*>, taking care to set the appropriate flags to
1042 indicate the presence of an C<SV*> key, and returns the same
1045 SV* HeSVKEY_set(HE* he, SV* sv)
1052 Returns the value slot (type C<SV*>) stored in the hash entry.
1061 Returns the package name of a stash. See C<SvSTASH>, C<CvSTASH>.
1063 char* HvNAME(HV* stash)
1070 Clears a hash, making it empty.
1072 void hv_clear(HV* tb)
1079 Deletes a key/value pair in the hash. The value SV is removed from the
1080 hash and returned to the caller. The C<klen> is the length of the key.
1081 The C<flags> value will normally be zero; if set to G_DISCARD then NULL
1084 SV* hv_delete(HV* tb, const char* key, I32 klen, I32 flags)
1091 Deletes a key/value pair in the hash. The value SV is removed from the
1092 hash and returned to the caller. The C<flags> value will normally be zero;
1093 if set to G_DISCARD then NULL will be returned. C<hash> can be a valid
1094 precomputed hash value, or 0 to ask for it to be computed.
1096 SV* hv_delete_ent(HV* tb, SV* key, I32 flags, U32 hash)
1103 Returns a boolean indicating whether the specified hash key exists. The
1104 C<klen> is the length of the key.
1106 bool hv_exists(HV* tb, const char* key, I32 klen)
1113 Returns a boolean indicating whether the specified hash key exists. C<hash>
1114 can be a valid precomputed hash value, or 0 to ask for it to be
1117 bool hv_exists_ent(HV* tb, SV* key, U32 hash)
1124 Returns the SV which corresponds to the specified key in the hash. The
1125 C<klen> is the length of the key. If C<lval> is set then the fetch will be
1126 part of a store. Check that the return value is non-null before
1127 dereferencing it to an C<SV*>.
1129 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1130 information on how to use this function on tied hashes.
1132 SV** hv_fetch(HV* tb, const char* key, I32 klen, I32 lval)
1139 Returns the hash entry which corresponds to the specified key in the hash.
1140 C<hash> must be a valid precomputed hash number for the given C<key>, or 0
1141 if you want the function to compute it. IF C<lval> is set then the fetch
1142 will be part of a store. Make sure the return value is non-null before
1143 accessing it. The return value when C<tb> is a tied hash is a pointer to a
1144 static location, so be sure to make a copy of the structure if you need to
1147 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1148 information on how to use this function on tied hashes.
1150 HE* hv_fetch_ent(HV* tb, SV* key, I32 lval, U32 hash)
1157 Prepares a starting point to traverse a hash table. Returns the number of
1158 keys in the hash (i.e. the same as C<HvKEYS(tb)>). The return value is
1159 currently only meaningful for hashes without tie magic.
1161 NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
1162 hash buckets that happen to be in use. If you still need that esoteric
1163 value, you can get it through the macro C<HvFILL(tb)>.
1166 I32 hv_iterinit(HV* tb)
1173 Returns the key from the current position of the hash iterator. See
1176 char* hv_iterkey(HE* entry, I32* retlen)
1183 Returns the key as an C<SV*> from the current position of the hash
1184 iterator. The return value will always be a mortal copy of the key. Also
1187 SV* hv_iterkeysv(HE* entry)
1194 Returns entries from a hash iterator. See C<hv_iterinit>.
1196 You may call C<hv_delete> or C<hv_delete_ent> on the hash entry that the
1197 iterator currently points to, without losing your place or invalidating your
1198 iterator. Note that in this case the current entry is deleted from the hash
1199 with your iterator holding the last reference to it. Your iterator is flagged
1200 to free the entry on the next call to C<hv_iternext>, so you must not discard
1201 your iterator immediately else the entry will leak - call C<hv_iternext> to
1202 trigger the resource deallocation.
1204 HE* hv_iternext(HV* tb)
1211 Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
1214 SV* hv_iternextsv(HV* hv, char** key, I32* retlen)
1219 =item hv_iternext_flags
1221 Returns entries from a hash iterator. See C<hv_iterinit> and C<hv_iternext>.
1222 The C<flags> value will normally be zero; if HV_ITERNEXT_WANTPLACEHOLDERS is
1223 set the placeholders keys (for restricted hashes) will be returned in addition
1224 to normal keys. By default placeholders are automatically skipped over.
1225 Currently a placeholder is implemented with a value that is literally
1226 <&Perl_sv_undef> (a regular C<undef> value is a normal read-write SV for which
1227 C<!SvOK> is false). Note that the implementation of placeholders and
1228 restricted hashes may change, and the implementation currently is
1229 insufficiently abstracted for any change to be tidy.
1231 NOTE: this function is experimental and may change or be
1232 removed without notice.
1234 HE* hv_iternext_flags(HV* tb, I32 flags)
1241 Returns the value from the current position of the hash iterator. See
1244 SV* hv_iterval(HV* tb, HE* entry)
1251 Adds magic to a hash. See C<sv_magic>.
1253 void hv_magic(HV* hv, GV* gv, int how)
1260 Stores an SV in a hash. The hash key is specified as C<key> and C<klen> is
1261 the length of the key. The C<hash> parameter is the precomputed hash
1262 value; if it is zero then Perl will compute it. The return value will be
1263 NULL if the operation failed or if the value did not need to be actually
1264 stored within the hash (as in the case of tied hashes). Otherwise it can
1265 be dereferenced to get the original C<SV*>. Note that the caller is
1266 responsible for suitably incrementing the reference count of C<val> before
1267 the call, and decrementing it if the function returned NULL. Effectively
1268 a successful hv_store takes ownership of one reference to C<val>. This is
1269 usually what you want; a newly created SV has a reference count of one, so
1270 if all your code does is create SVs then store them in a hash, hv_store
1271 will own the only reference to the new SV, and your code doesn't need to do
1272 anything further to tidy up. hv_store is not implemented as a call to
1273 hv_store_ent, and does not create a temporary SV for the key, so if your
1274 key data is not already in SV form then use hv_store in preference to
1277 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1278 information on how to use this function on tied hashes.
1280 SV** hv_store(HV* tb, const char* key, I32 klen, SV* val, U32 hash)
1287 Stores C<val> in a hash. The hash key is specified as C<key>. The C<hash>
1288 parameter is the precomputed hash value; if it is zero then Perl will
1289 compute it. The return value is the new hash entry so created. It will be
1290 NULL if the operation failed or if the value did not need to be actually
1291 stored within the hash (as in the case of tied hashes). Otherwise the
1292 contents of the return value can be accessed using the C<He?> macros
1293 described here. Note that the caller is responsible for suitably
1294 incrementing the reference count of C<val> before the call, and
1295 decrementing it if the function returned NULL. Effectively a successful
1296 hv_store_ent takes ownership of one reference to C<val>. This is
1297 usually what you want; a newly created SV has a reference count of one, so
1298 if all your code does is create SVs then store them in a hash, hv_store
1299 will own the only reference to the new SV, and your code doesn't need to do
1300 anything further to tidy up. Note that hv_store_ent only reads the C<key>;
1301 unlike C<val> it does not take ownership of it, so maintaining the correct
1302 reference count on C<key> is entirely the caller's responsibility. hv_store
1303 is not implemented as a call to hv_store_ent, and does not create a temporary
1304 SV for the key, so if your key data is not already in SV form then use
1305 hv_store in preference to hv_store_ent.
1307 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1308 information on how to use this function on tied hashes.
1310 HE* hv_store_ent(HV* tb, SV* key, SV* val, U32 hash)
1319 void hv_undef(HV* tb)
1326 Creates a new HV. The reference count is set to 1.
1344 =head1 Magical Functions
1350 Clear something magical that the SV represents. See C<sv_magic>.
1352 int mg_clear(SV* sv)
1359 Copies the magic from one SV to another. See C<sv_magic>.
1361 int mg_copy(SV* sv, SV* nsv, const char* key, I32 klen)
1368 Finds the magic pointer for type matching the SV. See C<sv_magic>.
1370 MAGIC* mg_find(SV* sv, int type)
1377 Free any magic storage used by the SV. See C<sv_magic>.
1386 Do magic after a value is retrieved from the SV. See C<sv_magic>.
1395 Report on the SV's length. See C<sv_magic>.
1397 U32 mg_length(SV* sv)
1404 Turns on the magical status of an SV. See C<sv_magic>.
1406 void mg_magical(SV* sv)
1413 Do magic after a value is assigned to the SV. See C<sv_magic>.
1422 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
1423 argument more than once.
1425 void SvGETMAGIC(SV* sv)
1432 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
1442 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
1443 argument more than once.
1445 void SvSETMAGIC(SV* sv)
1452 Like C<SvSetSV>, but does any set magic required afterwards.
1454 void SvSetMagicSV(SV* dsb, SV* ssv)
1459 =item SvSetMagicSV_nosteal
1461 Like C<SvSetMagicSV>, but does any set magic required afterwards.
1463 void SvSetMagicSV_nosteal(SV* dsv, SV* ssv)
1470 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
1473 void SvSetSV(SV* dsb, SV* ssv)
1478 =item SvSetSV_nosteal
1480 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
1481 ssv. May evaluate arguments more than once.
1483 void SvSetSV_nosteal(SV* dsv, SV* ssv)
1490 Arranges for sv to be shared between threads if a suitable module
1493 void SvSHARE(SV* sv)
1501 =head1 Memory Management
1507 The XSUB-writer's interface to the C C<memcpy> function. The C<src> is the
1508 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1509 the type. May fail on overlapping copies. See also C<Move>.
1511 void Copy(void* src, void* dest, int nitems, type)
1514 Found in file handy.h
1518 The XSUB-writer's interface to the C C<memmove> function. The C<src> is the
1519 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1520 the type. Can do overlapping moves. See also C<Copy>.
1522 void Move(void* src, void* dest, int nitems, type)
1525 Found in file handy.h
1529 The XSUB-writer's interface to the C C<malloc> function.
1531 void New(int id, void* ptr, int nitems, type)
1534 Found in file handy.h
1538 The XSUB-writer's interface to the C C<malloc> function, with
1541 void Newc(int id, void* ptr, int nitems, type, cast)
1544 Found in file handy.h
1548 Creates a new SV. A non-zero C<len> parameter indicates the number of
1549 bytes of preallocated string space the SV should have. An extra byte for a
1550 tailing NUL is also reserved. (SvPOK is not set for the SV even if string
1551 space is allocated.) The reference count for the new SV is set to 1.
1552 C<id> is an integer id between 0 and 1299 (used to identify leaks).
1555 SV* NEWSV(int id, STRLEN len)
1558 Found in file handy.h
1562 The XSUB-writer's interface to the C C<malloc> function. The allocated
1563 memory is zeroed with C<memzero>.
1565 void Newz(int id, void* ptr, int nitems, type)
1568 Found in file handy.h
1572 Fill up memory with a pattern (byte 0xAB over and over again) that
1573 hopefully catches attempts to access uninitialized memory.
1575 void Poison(void* dest, int nitems, type)
1578 Found in file handy.h
1582 The XSUB-writer's interface to the C C<realloc> function.
1584 void Renew(void* ptr, int nitems, type)
1587 Found in file handy.h
1591 The XSUB-writer's interface to the C C<realloc> function, with
1594 void Renewc(void* ptr, int nitems, type, cast)
1597 Found in file handy.h
1601 The XSUB-writer's interface to the C C<free> function.
1603 void Safefree(void* ptr)
1606 Found in file handy.h
1610 Perl's version of C<strdup()>. Returns a pointer to a newly allocated
1611 string which is a duplicate of C<pv>. The size of the string is
1612 determined by C<strlen()>. The memory allocated for the new string can
1613 be freed with the C<Safefree()> function.
1615 char* savepv(const char* pv)
1618 Found in file util.c
1622 Perl's version of what C<strndup()> would be if it existed. Returns a
1623 pointer to a newly allocated string which is a duplicate of the first
1624 C<len> bytes from C<pv>. The memory allocated for the new string can be
1625 freed with the C<Safefree()> function.
1627 char* savepvn(const char* pv, I32 len)
1630 Found in file util.c
1634 A version of C<savepv()> which allocates the duplicate string in memory
1635 which is shared between threads.
1637 char* savesharedpv(const char* pv)
1640 Found in file util.c
1644 This is an architecture-independent macro to copy one structure to another.
1646 void StructCopy(type src, type dest, type)
1649 Found in file handy.h
1653 The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the
1654 destination, C<nitems> is the number of items, and C<type> is the type.
1656 void Zero(void* dest, int nitems, type)
1659 Found in file handy.h
1664 =head1 Miscellaneous Functions
1670 Analyses the string in order to make fast searches on it using fbm_instr()
1671 -- the Boyer-Moore algorithm.
1673 void fbm_compile(SV* sv, U32 flags)
1676 Found in file util.c
1680 Returns the location of the SV in the string delimited by C<str> and
1681 C<strend>. It returns C<Nullch> if the string can't be found. The C<sv>
1682 does not have to be fbm_compiled, but the search will not be as fast
1685 char* fbm_instr(unsigned char* big, unsigned char* bigend, SV* littlesv, U32 flags)
1688 Found in file util.c
1692 Takes a sprintf-style format pattern and conventional
1693 (non-SV) arguments and returns the formatted string.
1695 (char *) Perl_form(pTHX_ const char* pat, ...)
1697 can be used any place a string (char *) is required:
1699 char * s = Perl_form("%d.%d",major,minor);
1701 Uses a single private buffer so if you want to format several strings you
1702 must explicitly copy the earlier strings away (and free the copies when you
1705 char* form(const char* pat, ...)
1708 Found in file util.c
1712 Fill the sv with current working directory
1714 int getcwd_sv(SV* sv)
1717 Found in file util.c
1721 Returns a new version object based on the passed in SV:
1723 SV *sv = new_version(SV *ver);
1725 Does not alter the passed in ver SV. See "upg_version" if you
1726 want to upgrade the SV.
1728 SV* new_version(SV *ver)
1731 Found in file util.c
1735 Returns a pointer to the next character after the parsed
1736 version string, as well as upgrading the passed in SV to
1739 Function must be called with an already existing SV like
1742 s = scan_version(s,sv);
1744 Performs some preprocessing to the string to ensure that
1745 it has the correct characteristics of a version. Flags the
1746 object if it contains an underscore (which denotes this
1749 char* scan_version(char *vstr, SV *sv)
1752 Found in file util.c
1756 Test two strings to see if they are equal. Returns true or false.
1758 bool strEQ(char* s1, char* s2)
1761 Found in file handy.h
1765 Test two strings to see if the first, C<s1>, is greater than or equal to
1766 the second, C<s2>. Returns true or false.
1768 bool strGE(char* s1, char* s2)
1771 Found in file handy.h
1775 Test two strings to see if the first, C<s1>, is greater than the second,
1776 C<s2>. Returns true or false.
1778 bool strGT(char* s1, char* s2)
1781 Found in file handy.h
1785 Test two strings to see if the first, C<s1>, is less than or equal to the
1786 second, C<s2>. Returns true or false.
1788 bool strLE(char* s1, char* s2)
1791 Found in file handy.h
1795 Test two strings to see if the first, C<s1>, is less than the second,
1796 C<s2>. Returns true or false.
1798 bool strLT(char* s1, char* s2)
1801 Found in file handy.h
1805 Test two strings to see if they are different. Returns true or
1808 bool strNE(char* s1, char* s2)
1811 Found in file handy.h
1815 Test two strings to see if they are equal. The C<len> parameter indicates
1816 the number of bytes to compare. Returns true or false. (A wrapper for
1819 bool strnEQ(char* s1, char* s2, STRLEN len)
1822 Found in file handy.h
1826 Test two strings to see if they are different. The C<len> parameter
1827 indicates the number of bytes to compare. Returns true or false. (A
1828 wrapper for C<strncmp>).
1830 bool strnNE(char* s1, char* s2, STRLEN len)
1833 Found in file handy.h
1837 Dummy routine which "locks" an SV when there is no locking module present.
1838 Exists to avoid test for a NULL function pointer and because it could potentially warn under
1839 some level of strict-ness.
1841 void sv_nolocking(SV *)
1844 Found in file util.c
1848 Dummy routine which "shares" an SV when there is no sharing module present.
1849 Exists to avoid test for a NULL function pointer and because it could potentially warn under
1850 some level of strict-ness.
1852 void sv_nosharing(SV *)
1855 Found in file util.c
1857 =item sv_nounlocking
1859 Dummy routine which "unlocks" an SV when there is no locking module present.
1860 Exists to avoid test for a NULL function pointer and because it could potentially warn under
1861 some level of strict-ness.
1863 void sv_nounlocking(SV *)
1866 Found in file util.c
1870 In-place upgrade of the supplied SV to a version object.
1872 SV *sv = upg_version(SV *sv);
1874 Returns a pointer to the upgraded SV.
1876 SV* upg_version(SV *ver)
1879 Found in file util.c
1883 Version object aware cmp. Both operands must already have been
1884 converted into version objects.
1886 int vcmp(SV *lvs, SV *rvs)
1889 Found in file util.c
1893 Accepts a version object and returns the normalized floating
1894 point representation. Call like:
1898 NOTE: you can pass either the object directly or the SV
1899 contained within the RV.
1904 Found in file util.c
1908 Accepts a version object and returns the normalized string
1909 representation. Call like:
1911 sv = vstringify(rv);
1913 NOTE: you can pass either the object directly or the SV
1914 contained within the RV.
1916 SV* vstringify(SV *vs)
1919 Found in file util.c
1924 =head1 Numeric functions
1930 converts a string representing a binary number to numeric form.
1932 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
1933 conversion flags, and I<result> should be NULL or a pointer to an NV.
1934 The scan stops at the end of the string, or the first invalid character.
1935 On return I<*len> is set to the length scanned string, and I<*flags> gives
1938 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
1939 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_bin>
1940 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
1941 and writes the value to I<*result> (or the value is discarded if I<result>
1944 The hex number may optionally be prefixed with "0b" or "b" unless
1945 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
1946 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the binary
1947 number may use '_' characters to separate digits.
1949 UV grok_bin(char* start, STRLEN* len, I32* flags, NV *result)
1952 Found in file numeric.c
1956 converts a string representing a hex number to numeric form.
1958 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
1959 conversion flags, and I<result> should be NULL or a pointer to an NV.
1960 The scan stops at the end of the string, or the first non-hex-digit character.
1961 On return I<*len> is set to the length scanned string, and I<*flags> gives
1964 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
1965 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_hex>
1966 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
1967 and writes the value to I<*result> (or the value is discarded if I<result>
1970 The hex number may optionally be prefixed with "0x" or "x" unless
1971 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
1972 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the hex
1973 number may use '_' characters to separate digits.
1975 UV grok_hex(char* start, STRLEN* len, I32* flags, NV *result)
1978 Found in file numeric.c
1982 Recognise (or not) a number. The type of the number is returned
1983 (0 if unrecognised), otherwise it is a bit-ORed combination of
1984 IS_NUMBER_IN_UV, IS_NUMBER_GREATER_THAN_UV_MAX, IS_NUMBER_NOT_INT,
1985 IS_NUMBER_NEG, IS_NUMBER_INFINITY, IS_NUMBER_NAN (defined in perl.h).
1987 If the value of the number can fit an in UV, it is returned in the *valuep
1988 IS_NUMBER_IN_UV will be set to indicate that *valuep is valid, IS_NUMBER_IN_UV
1989 will never be set unless *valuep is valid, but *valuep may have been assigned
1990 to during processing even though IS_NUMBER_IN_UV is not set on return.
1991 If valuep is NULL, IS_NUMBER_IN_UV will be set for the same cases as when
1992 valuep is non-NULL, but no actual assignment (or SEGV) will occur.
1994 IS_NUMBER_NOT_INT will be set with IS_NUMBER_IN_UV if trailing decimals were
1995 seen (in which case *valuep gives the true value truncated to an integer), and
1996 IS_NUMBER_NEG if the number is negative (in which case *valuep holds the
1997 absolute value). IS_NUMBER_IN_UV is not set if e notation was used or the
1998 number is larger than a UV.
2000 int grok_number(const char *pv, STRLEN len, UV *valuep)
2003 Found in file numeric.c
2005 =item grok_numeric_radix
2007 Scan and skip for a numeric decimal separator (radix).
2009 bool grok_numeric_radix(const char **sp, const char *send)
2012 Found in file numeric.c
2017 UV grok_oct(char* start, STRLEN* len, I32* flags, NV *result)
2020 Found in file numeric.c
2024 For backwards compatibility. Use C<grok_bin> instead.
2026 NV scan_bin(char* start, STRLEN len, STRLEN* retlen)
2029 Found in file numeric.c
2033 For backwards compatibility. Use C<grok_hex> instead.
2035 NV scan_hex(char* start, STRLEN len, STRLEN* retlen)
2038 Found in file numeric.c
2042 For backwards compatibility. Use C<grok_oct> instead.
2044 NV scan_oct(char* start, STRLEN len, STRLEN* retlen)
2047 Found in file numeric.c
2052 =head1 Optree Manipulation Functions
2058 If C<cv> is a constant sub eligible for inlining. returns the constant
2059 value returned by the sub. Otherwise, returns NULL.
2061 Constant subs can be created with C<newCONSTSUB> or as described in
2062 L<perlsub/"Constant Functions">.
2064 SV* cv_const_sv(CV* cv)
2071 Creates a constant sub equivalent to Perl C<sub FOO () { 123 }> which is
2072 eligible for inlining at compile-time.
2074 CV* newCONSTSUB(HV* stash, char* name, SV* sv)
2081 Used by C<xsubpp> to hook up XSUBs as Perl subs.
2089 =head1 Pad Data Structures
2095 Get the value at offset po in the current pad.
2096 Use macro PAD_SV instead of calling this function directly.
2098 SV* pad_sv(PADOFFSET po)
2106 =head1 Stack Manipulation Macros
2112 Declare a stack marker variable, C<mark>, for the XSUB. See C<MARK> and
2122 Saves the original stack mark for the XSUB. See C<ORIGMARK>.
2131 Declares a local copy of perl's stack pointer for the XSUB, available via
2132 the C<SP> macro. See C<SP>.
2141 Used to extend the argument stack for an XSUB's return values. Once
2142 used, guarantees that there is room for at least C<nitems> to be pushed
2145 void EXTEND(SP, int nitems)
2152 Stack marker variable for the XSUB. See C<dMARK>.
2159 The original stack mark for the XSUB. See C<dORIGMARK>.
2166 Pops an integer off the stack.
2175 Pops a long off the stack.
2184 Pops a double off the stack.
2193 Pops a string off the stack. Deprecated. New code should provide
2194 a STRLEN n_a and use POPpx.
2203 Pops a string off the stack which must consist of bytes i.e. characters < 256.
2204 Requires a variable STRLEN n_a in scope.
2213 Pops a string off the stack.
2214 Requires a variable STRLEN n_a in scope.
2223 Pops an SV off the stack.
2232 Push an integer onto the stack. The stack must have room for this element.
2233 Handles 'set' magic. See C<XPUSHi>.
2242 Opening bracket for arguments on a callback. See C<PUTBACK> and
2252 Push a double onto the stack. The stack must have room for this element.
2253 Handles 'set' magic. See C<XPUSHn>.
2262 Push a string onto the stack. The stack must have room for this element.
2263 The C<len> indicates the length of the string. Handles 'set' magic. See
2266 void PUSHp(char* str, STRLEN len)
2273 Push an SV onto the stack. The stack must have room for this element.
2274 Does not handle 'set' magic. See C<XPUSHs>.
2283 Push an unsigned integer onto the stack. The stack must have room for this
2284 element. See C<XPUSHu>.
2293 Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
2294 See C<PUSHMARK> and L<perlcall> for other uses.
2303 Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and
2311 Refetch the stack pointer. Used after a callback. See L<perlcall>.
2320 Push an integer onto the stack, extending the stack if necessary. Handles
2321 'set' magic. See C<PUSHi>.
2330 Push a double onto the stack, extending the stack if necessary. Handles
2331 'set' magic. See C<PUSHn>.
2340 Push a string onto the stack, extending the stack if necessary. The C<len>
2341 indicates the length of the string. Handles 'set' magic. See
2344 void XPUSHp(char* str, STRLEN len)
2351 Push an SV onto the stack, extending the stack if necessary. Does not
2352 handle 'set' magic. See C<PUSHs>.
2361 Push an unsigned integer onto the stack, extending the stack if necessary.
2371 Return from XSUB, indicating number of items on the stack. This is usually
2372 handled by C<xsubpp>.
2374 void XSRETURN(int nitems)
2377 Found in file XSUB.h
2381 Return an integer from an XSUB immediately. Uses C<XST_mIV>.
2383 void XSRETURN_IV(IV iv)
2386 Found in file XSUB.h
2390 Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
2395 Found in file XSUB.h
2399 Return a double from an XSUB immediately. Uses C<XST_mNV>.
2401 void XSRETURN_NV(NV nv)
2404 Found in file XSUB.h
2408 Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
2410 void XSRETURN_PV(char* str)
2413 Found in file XSUB.h
2415 =item XSRETURN_UNDEF
2417 Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
2422 Found in file XSUB.h
2426 Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
2431 Found in file XSUB.h
2435 Place an integer into the specified position C<pos> on the stack. The
2436 value is stored in a new mortal SV.
2438 void XST_mIV(int pos, IV iv)
2441 Found in file XSUB.h
2445 Place C<&PL_sv_no> into the specified position C<pos> on the
2448 void XST_mNO(int pos)
2451 Found in file XSUB.h
2455 Place a double into the specified position C<pos> on the stack. The value
2456 is stored in a new mortal SV.
2458 void XST_mNV(int pos, NV nv)
2461 Found in file XSUB.h
2465 Place a copy of a string into the specified position C<pos> on the stack.
2466 The value is stored in a new mortal SV.
2468 void XST_mPV(int pos, char* str)
2471 Found in file XSUB.h
2475 Place C<&PL_sv_undef> into the specified position C<pos> on the
2478 void XST_mUNDEF(int pos)
2481 Found in file XSUB.h
2485 Place C<&PL_sv_yes> into the specified position C<pos> on the
2488 void XST_mYES(int pos)
2491 Found in file XSUB.h
2502 An enum of flags for Perl types. These are found in the file B<sv.h>
2503 in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
2510 Integer type flag for scalars. See C<svtype>.
2517 Double type flag for scalars. See C<svtype>.
2524 Pointer type flag for scalars. See C<svtype>.
2531 Type flag for arrays. See C<svtype>.
2538 Type flag for code refs. See C<svtype>.
2545 Type flag for hashes. See C<svtype>.
2552 Type flag for blessed scalars. See C<svtype>.
2560 =head1 SV Manipulation Functions
2566 Returns the SV of the specified Perl scalar. If C<create> is set and the
2567 Perl variable does not exist then it will be created. If C<create> is not
2568 set and the variable does not exist then NULL is returned.
2570 NOTE: the perl_ form of this function is deprecated.
2572 SV* get_sv(const char* name, I32 create)
2575 Found in file perl.c
2577 =item looks_like_number
2579 Test if the content of an SV looks like a number (or is a number).
2580 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
2581 non-numeric warning), even if your atof() doesn't grok them.
2583 I32 looks_like_number(SV* sv)
2590 Creates an RV wrapper for an SV. The reference count for the original SV is
2593 SV* newRV_inc(SV* sv)
2600 Creates an RV wrapper for an SV. The reference count for the original
2601 SV is B<not> incremented.
2603 SV* newRV_noinc(SV *sv)
2610 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
2611 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
2614 SV* newSV(STRLEN len)
2621 Creates a new SV and copies an integer into it. The reference count for the
2631 Creates a new SV and copies a floating point value into it.
2632 The reference count for the SV is set to 1.
2641 Creates a new SV and copies a string into it. The reference count for the
2642 SV is set to 1. If C<len> is zero, Perl will compute the length using
2643 strlen(). For efficiency, consider using C<newSVpvn> instead.
2645 SV* newSVpv(const char* s, STRLEN len)
2652 Creates a new SV and initializes it with the string formatted like
2655 SV* newSVpvf(const char* pat, ...)
2662 Creates a new SV and copies a string into it. The reference count for the
2663 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
2664 string. You are responsible for ensuring that the source string is at least
2667 SV* newSVpvn(const char* s, STRLEN len)
2672 =item newSVpvn_share
2674 Creates a new SV with its SvPVX pointing to a shared string in the string
2675 table. If the string does not already exist in the table, it is created
2676 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
2677 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
2678 otherwise the hash is computed. The idea here is that as the string table
2679 is used for shared hash keys these strings will have SvPVX == HeKEY and
2680 hash lookup will avoid string compare.
2682 SV* newSVpvn_share(const char* s, I32 len, U32 hash)
2689 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
2690 it will be upgraded to one. If C<classname> is non-null then the new SV will
2691 be blessed in the specified package. The new SV is returned and its
2692 reference count is 1.
2694 SV* newSVrv(SV* rv, const char* classname)
2701 Creates a new SV which is an exact duplicate of the original SV.
2704 SV* newSVsv(SV* old)
2711 Creates a new SV and copies an unsigned integer into it.
2712 The reference count for the SV is set to 1.
2721 Returns the length of the string which is in the SV. See C<SvLEN>.
2723 STRLEN SvCUR(SV* sv)
2730 Set the length of the string which is in the SV. See C<SvCUR>.
2732 void SvCUR_set(SV* sv, STRLEN len)
2739 Returns a pointer to the last character in the string which is in the SV.
2740 See C<SvCUR>. Access the character as *(SvEND(sv)).
2749 Expands the character buffer in the SV so that it has room for the
2750 indicated number of bytes (remember to reserve space for an extra trailing
2751 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
2752 Returns a pointer to the character buffer.
2754 char * SvGROW(SV* sv, STRLEN len)
2761 Returns a boolean indicating whether the SV contains an integer.
2770 Returns a boolean indicating whether the SV contains an integer. Checks
2771 the B<private> setting. Use C<SvIOK>.
2780 Returns a boolean indicating whether the SV contains a signed integer.
2782 void SvIOK_notUV(SV* sv)
2789 Unsets the IV status of an SV.
2791 void SvIOK_off(SV* sv)
2798 Tells an SV that it is an integer.
2800 void SvIOK_on(SV* sv)
2807 Tells an SV that it is an integer and disables all other OK bits.
2809 void SvIOK_only(SV* sv)
2816 Tells and SV that it is an unsigned integer and disables all other OK bits.
2818 void SvIOK_only_UV(SV* sv)
2825 Returns a boolean indicating whether the SV contains an unsigned integer.
2827 void SvIOK_UV(SV* sv)
2834 Returns a boolean indicating whether the SV is Copy-On-Write. (either shared
2835 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
2838 bool SvIsCOW(SV* sv)
2843 =item SvIsCOW_shared_hash
2845 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
2848 bool SvIsCOW_shared_hash(SV* sv)
2855 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
2856 version which guarantees to evaluate sv only once.
2865 Coerces the given SV to an integer and returns it. Guarantees to evaluate
2866 sv only once. Use the more efficient C<SvIV> otherwise.
2875 Returns the raw value in the SV's IV slot, without checks or conversions.
2876 Only use when you are sure SvIOK is true. See also C<SvIV()>.
2885 Returns the size of the string buffer in the SV, not including any part
2886 attributable to C<SvOOK>. See C<SvCUR>.
2888 STRLEN SvLEN(SV* sv)
2895 Returns a boolean indicating whether the SV contains a number, integer or
2905 Returns a boolean indicating whether the SV contains a number, integer or
2906 double. Checks the B<private> setting. Use C<SvNIOK>.
2908 bool SvNIOKp(SV* sv)
2915 Unsets the NV/IV status of an SV.
2917 void SvNIOK_off(SV* sv)
2924 Returns a boolean indicating whether the SV contains a double.
2933 Returns a boolean indicating whether the SV contains a double. Checks the
2934 B<private> setting. Use C<SvNOK>.
2943 Unsets the NV status of an SV.
2945 void SvNOK_off(SV* sv)
2952 Tells an SV that it is a double.
2954 void SvNOK_on(SV* sv)
2961 Tells an SV that it is a double and disables all other OK bits.
2963 void SvNOK_only(SV* sv)
2970 Coerce the given SV to a double and return it. See C<SvNVx> for a version
2971 which guarantees to evaluate sv only once.
2980 Returns the raw value in the SV's NV slot, without checks or conversions.
2981 Only use when you are sure SvNOK is true. See also C<SvNV()>.
2990 Coerces the given SV to a double and returns it. Guarantees to evaluate
2991 sv only once. Use the more efficient C<SvNV> otherwise.
3000 Returns a boolean indicating whether the value is an SV.
3009 Returns a boolean indicating whether the SvIVX is a valid offset value for
3010 the SvPVX. This hack is used internally to speed up removal of characters
3011 from the beginning of a SvPV. When SvOOK is true, then the start of the
3012 allocated string buffer is really (SvPVX - SvIVX).
3021 Returns a boolean indicating whether the SV contains a character
3031 Returns a boolean indicating whether the SV contains a character string.
3032 Checks the B<private> setting. Use C<SvPOK>.
3041 Unsets the PV status of an SV.
3043 void SvPOK_off(SV* sv)
3050 Tells an SV that it is a string.
3052 void SvPOK_on(SV* sv)
3059 Tells an SV that it is a string and disables all other OK bits.
3060 Will also turn off the UTF8 status.
3062 void SvPOK_only(SV* sv)
3067 =item SvPOK_only_UTF8
3069 Tells an SV that it is a string and disables all other OK bits,
3070 and leaves the UTF8 status as it was.
3072 void SvPOK_only_UTF8(SV* sv)
3079 Returns a pointer to the string in the SV, or a stringified form of
3080 the SV if the SV does not contain a string. The SV may cache the
3081 stringified version becoming C<SvPOK>. Handles 'get' magic. See also
3082 C<SvPVx> for a version which guarantees to evaluate sv only once.
3084 char* SvPV(SV* sv, STRLEN len)
3091 Like C<SvPV>, but converts sv to byte representation first if necessary.
3093 char* SvPVbyte(SV* sv, STRLEN len)
3100 Like C<SvPV>, but converts sv to byte representation first if necessary.
3101 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
3104 char* SvPVbytex(SV* sv, STRLEN len)
3109 =item SvPVbytex_force
3111 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
3112 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
3115 char* SvPVbytex_force(SV* sv, STRLEN len)
3120 =item SvPVbyte_force
3122 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
3124 char* SvPVbyte_force(SV* sv, STRLEN len)
3129 =item SvPVbyte_nolen
3131 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
3133 char* SvPVbyte_nolen(SV* sv)
3140 Like C<SvPV>, but converts sv to utf8 first if necessary.
3142 char* SvPVutf8(SV* sv, STRLEN len)
3149 Like C<SvPV>, but converts sv to utf8 first if necessary.
3150 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
3153 char* SvPVutf8x(SV* sv, STRLEN len)
3158 =item SvPVutf8x_force
3160 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
3161 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
3164 char* SvPVutf8x_force(SV* sv, STRLEN len)
3169 =item SvPVutf8_force
3171 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
3173 char* SvPVutf8_force(SV* sv, STRLEN len)
3178 =item SvPVutf8_nolen
3180 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
3182 char* SvPVutf8_nolen(SV* sv)
3189 A version of C<SvPV> which guarantees to evaluate sv only once.
3191 char* SvPVx(SV* sv, STRLEN len)
3198 Returns a pointer to the physical string in the SV. The SV must contain a
3208 Like C<SvPV> but will force the SV into containing just a string
3209 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
3212 char* SvPV_force(SV* sv, STRLEN len)
3217 =item SvPV_force_nomg
3219 Like C<SvPV> but will force the SV into containing just a string
3220 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
3221 directly. Doesn't process magic.
3223 char* SvPV_force_nomg(SV* sv, STRLEN len)
3230 Returns a pointer to the string in the SV, or a stringified form of
3231 the SV if the SV does not contain a string. The SV may cache the
3232 stringified form becoming C<SvPOK>. Handles 'get' magic.
3234 char* SvPV_nolen(SV* sv)
3241 Returns the value of the object's reference count.
3243 U32 SvREFCNT(SV* sv)
3250 Decrements the reference count of the given SV.
3252 void SvREFCNT_dec(SV* sv)
3259 Increments the reference count of the given SV.
3261 SV* SvREFCNT_inc(SV* sv)
3268 Tests if the SV is an RV.
3277 Unsets the RV status of an SV.
3279 void SvROK_off(SV* sv)
3286 Tells an SV that it is an RV.
3288 void SvROK_on(SV* sv)
3295 Dereferences an RV to return the SV.
3304 Returns the stash of the SV.
3313 Taints an SV if tainting is enabled
3315 void SvTAINT(SV* sv)
3322 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
3325 bool SvTAINTED(SV* sv)
3332 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
3333 some of Perl's fundamental security features. XS module authors should not
3334 use this function unless they fully understand all the implications of
3335 unconditionally untainting the value. Untainting should be done in the
3336 standard perl fashion, via a carefully crafted regexp, rather than directly
3337 untainting variables.
3339 void SvTAINTED_off(SV* sv)
3346 Marks an SV as tainted.
3348 void SvTAINTED_on(SV* sv)
3355 Returns a boolean indicating whether Perl would evaluate the SV as true or
3356 false, defined or undefined. Does not handle 'get' magic.
3365 Returns the type of the SV. See C<svtype>.
3367 svtype SvTYPE(SV* sv)
3374 Releases a mutual exclusion lock on sv if a suitable module
3378 void SvUNLOCK(SV* sv)
3385 Returns a boolean indicating whether the SV contains an unsigned integer.
3394 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
3395 perform the upgrade if necessary. See C<svtype>.
3397 void SvUPGRADE(SV* sv, svtype type)
3404 Returns a boolean indicating whether the SV contains UTF-8 encoded data.
3413 Unsets the UTF8 status of an SV.
3415 void SvUTF8_off(SV *sv)
3422 Turn on the UTF8 status of an SV (the data is not changed, just the flag).
3423 Do not use frivolously.
3425 void SvUTF8_on(SV *sv)
3432 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
3433 for a version which guarantees to evaluate sv only once.
3442 Returns the raw value in the SV's UV slot, without checks or conversions.
3443 Only use when you are sure SvIOK is true. See also C<SvUV()>.
3452 Coerces the given SV to an unsigned integer and returns it. Guarantees to
3453 evaluate sv only once. Use the more efficient C<SvUV> otherwise.
3462 Returns a boolean indicating whether the SV contains a v-string.
3471 This function is only called on magical items, and is only used by
3472 sv_true() or its macro equivalent.
3474 bool sv_2bool(SV* sv)
3481 Using various gambits, try to get a CV from an SV; in addition, try if
3482 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
3484 CV* sv_2cv(SV* sv, HV** st, GV** gvp, I32 lref)
3491 Using various gambits, try to get an IO from an SV: the IO slot if its a
3492 GV; or the recursive result if we're an RV; or the IO slot of the symbol
3493 named after the PV if we're a string.
3502 Return the integer value of an SV, doing any necessary string conversion,
3503 magic etc. Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
3512 Marks an existing SV as mortal. The SV will be destroyed "soon", either
3513 by an explicit call to FREETMPS, or by an implicit call at places such as
3514 statement boundaries. See also C<sv_newmortal> and C<sv_mortalcopy>.
3516 SV* sv_2mortal(SV* sv)
3523 Return the num value of an SV, doing any necessary string or integer
3524 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
3534 Return a pointer to the byte-encoded representation of the SV, and set *lp
3535 to its length. May cause the SV to be downgraded from UTF8 as a
3538 Usually accessed via the C<SvPVbyte> macro.
3540 char* sv_2pvbyte(SV* sv, STRLEN* lp)
3545 =item sv_2pvbyte_nolen
3547 Return a pointer to the byte-encoded representation of the SV.
3548 May cause the SV to be downgraded from UTF8 as a side-effect.
3550 Usually accessed via the C<SvPVbyte_nolen> macro.
3552 char* sv_2pvbyte_nolen(SV* sv)
3559 Return a pointer to the UTF8-encoded representation of the SV, and set *lp
3560 to its length. May cause the SV to be upgraded to UTF8 as a side-effect.
3562 Usually accessed via the C<SvPVutf8> macro.
3564 char* sv_2pvutf8(SV* sv, STRLEN* lp)
3569 =item sv_2pvutf8_nolen
3571 Return a pointer to the UTF8-encoded representation of the SV.
3572 May cause the SV to be upgraded to UTF8 as a side-effect.
3574 Usually accessed via the C<SvPVutf8_nolen> macro.
3576 char* sv_2pvutf8_nolen(SV* sv)
3583 Returns a pointer to the string value of an SV, and sets *lp to its length.
3584 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
3586 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
3587 usually end up here too.
3589 char* sv_2pv_flags(SV* sv, STRLEN* lp, I32 flags)
3596 Like C<sv_2pv()>, but doesn't return the length too. You should usually
3597 use the macro wrapper C<SvPV_nolen(sv)> instead.
3598 char* sv_2pv_nolen(SV* sv)
3605 Return the unsigned integer value of an SV, doing any necessary string
3606 conversion, magic etc. Normally used via the C<SvUV(sv)> and C<SvUVx(sv)>
3616 Remove any string offset. You should normally use the C<SvOOK_off> macro
3619 int sv_backoff(SV* sv)
3626 Blesses an SV into a specified package. The SV must be an RV. The package
3627 must be designated by its stash (see C<gv_stashpv()>). The reference count
3628 of the SV is unaffected.
3630 SV* sv_bless(SV* sv, HV* stash)
3637 Concatenates the string onto the end of the string which is in the SV.
3638 If the SV has the UTF8 status set, then the bytes appended should be
3639 valid UTF8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
3641 void sv_catpv(SV* sv, const char* ptr)
3648 Processes its arguments like C<sprintf> and appends the formatted
3649 output to an SV. If the appended data contains "wide" characters
3650 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
3651 and characters >255 formatted with %c), the original SV might get
3652 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic.
3653 C<SvSETMAGIC()> must typically be called after calling this function
3654 to handle 'set' magic.
3656 void sv_catpvf(SV* sv, const char* pat, ...)
3663 Like C<sv_catpvf>, but also handles 'set' magic.
3665 void sv_catpvf_mg(SV *sv, const char* pat, ...)
3672 Concatenates the string onto the end of the string which is in the SV. The
3673 C<len> indicates number of bytes to copy. If the SV has the UTF8
3674 status set, then the bytes appended should be valid UTF8.
3675 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
3677 void sv_catpvn(SV* sv, const char* ptr, STRLEN len)
3682 =item sv_catpvn_flags
3684 Concatenates the string onto the end of the string which is in the SV. The
3685 C<len> indicates number of bytes to copy. If the SV has the UTF8
3686 status set, then the bytes appended should be valid UTF8.
3687 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
3688 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
3689 in terms of this function.
3691 void sv_catpvn_flags(SV* sv, const char* ptr, STRLEN len, I32 flags)
3698 Like C<sv_catpvn>, but also handles 'set' magic.
3700 void sv_catpvn_mg(SV *sv, const char *ptr, STRLEN len)
3707 Like C<sv_catpv>, but also handles 'set' magic.
3709 void sv_catpv_mg(SV *sv, const char *ptr)
3716 Concatenates the string from SV C<ssv> onto the end of the string in
3717 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
3718 not 'set' magic. See C<sv_catsv_mg>.
3720 void sv_catsv(SV* dsv, SV* ssv)
3725 =item sv_catsv_flags
3727 Concatenates the string from SV C<ssv> onto the end of the string in
3728 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
3729 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
3730 and C<sv_catsv_nomg> are implemented in terms of this function.
3732 void sv_catsv_flags(SV* dsv, SV* ssv, I32 flags)
3739 Like C<sv_catsv>, but also handles 'set' magic.
3741 void sv_catsv_mg(SV *dstr, SV *sstr)
3748 Efficient removal of characters from the beginning of the string buffer.
3749 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
3750 the string buffer. The C<ptr> becomes the first character of the adjusted
3751 string. Uses the "OOK hack".
3752 Beware: after this function returns, C<ptr> and SvPVX(sv) may no longer
3753 refer to the same chunk of data.
3755 void sv_chop(SV* sv, char* ptr)
3762 Clear an SV: call any destructors, free up any memory used by the body,
3763 and free the body itself. The SV's head is I<not> freed, although
3764 its type is set to all 1's so that it won't inadvertently be assumed
3765 to be live during global destruction etc.
3766 This function should only be called when REFCNT is zero. Most of the time
3767 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
3770 void sv_clear(SV* sv)
3777 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
3778 string in C<sv1> is less than, equal to, or greater than the string in
3779 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
3780 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
3782 I32 sv_cmp(SV* sv1, SV* sv2)
3789 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
3790 'use bytes' aware, handles get magic, and will coerce its args to strings
3791 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
3793 I32 sv_cmp_locale(SV* sv1, SV* sv2)
3800 Add Collate Transform magic to an SV if it doesn't already have it.
3802 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
3803 scalar data of the variable, but transformed to such a format that a normal
3804 memory comparison can be used to compare the data according to the locale
3807 char* sv_collxfrm(SV* sv, STRLEN* nxp)
3814 Copies a stringified representation of the source SV into the
3815 destination SV. Automatically performs any necessary mg_get and
3816 coercion of numeric values into strings. Guaranteed to preserve
3817 UTF-8 flag even from overloaded objects. Similar in nature to
3818 sv_2pv[_flags] but operates directly on an SV instead of just the
3819 string. Mostly uses sv_2pv_flags to do its work, except when that
3820 would lose the UTF-8'ness of the PV.
3822 void sv_copypv(SV* dsv, SV* ssv)
3829 Auto-decrement of the value in the SV, doing string to numeric conversion
3830 if necessary. Handles 'get' magic.
3837 =item sv_derived_from
3839 Returns a boolean indicating whether the SV is derived from the specified
3840 class. This is the function that implements C<UNIVERSAL::isa>. It works
3841 for class names as well as for objects.
3843 bool sv_derived_from(SV* sv, const char* name)
3846 Found in file universal.c
3850 Returns a boolean indicating whether the strings in the two SVs are
3851 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
3852 coerce its args to strings if necessary.
3854 I32 sv_eq(SV* sv1, SV* sv2)
3859 =item sv_force_normal
3861 Undo various types of fakery on an SV: if the PV is a shared string, make
3862 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3863 an xpvmg. See also C<sv_force_normal_flags>.
3865 void sv_force_normal(SV *sv)
3870 =item sv_force_normal_flags
3872 Undo various types of fakery on an SV: if the PV is a shared string, make
3873 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3874 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
3875 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
3876 then a copy-on-write scalar drops its PV buffer (if any) and becomes
3877 SvPOK_off rather than making a copy. (Used where this scalar is about to be
3878 set to some other value.) In addition, the C<flags> parameter gets passed to
3879 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
3880 with flags set to 0.
3882 void sv_force_normal_flags(SV *sv, U32 flags)
3889 Decrement an SV's reference count, and if it drops to zero, call
3890 C<sv_clear> to invoke destructors and free up any memory used by
3891 the body; finally, deallocate the SV's head itself.
3892 Normally called via a wrapper macro C<SvREFCNT_dec>.
3894 void sv_free(SV* sv)
3901 Get a line from the filehandle and store it into the SV, optionally
3902 appending to the currently-stored string.
3904 char* sv_gets(SV* sv, PerlIO* fp, I32 append)
3911 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
3912 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
3913 Use the C<SvGROW> wrapper instead.
3915 char* sv_grow(SV* sv, STRLEN newlen)
3922 Auto-increment of the value in the SV, doing string to numeric conversion
3923 if necessary. Handles 'get' magic.
3932 Inserts a string at the specified offset/length within the SV. Similar to
3933 the Perl substr() function.
3935 void sv_insert(SV* bigsv, STRLEN offset, STRLEN len, char* little, STRLEN littlelen)
3942 Returns a boolean indicating whether the SV is blessed into the specified
3943 class. This does not check for subtypes; use C<sv_derived_from> to verify
3944 an inheritance relationship.
3946 int sv_isa(SV* sv, const char* name)
3953 Returns a boolean indicating whether the SV is an RV pointing to a blessed
3954 object. If the SV is not an RV, or if the object is not blessed, then this
3957 int sv_isobject(SV* sv)
3964 A private implementation of the C<SvIVx> macro for compilers which can't
3965 cope with complex macro expressions. Always use the macro instead.
3974 Returns the length of the string in the SV. Handles magic and type
3975 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
3977 STRLEN sv_len(SV* sv)
3984 Returns the number of characters in the string in an SV, counting wide
3985 UTF8 bytes as a single character. Handles magic and type coercion.
3987 STRLEN sv_len_utf8(SV* sv)
3994 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
3995 then adds a new magic item of type C<how> to the head of the magic list.
3997 void sv_magic(SV* sv, SV* obj, int how, const char* name, I32 namlen)
4004 Adds magic to an SV, upgrading it if necessary. Applies the
4005 supplied vtable and returns pointer to the magic added.
4007 Note that sv_magicext will allow things that sv_magic will not.
4008 In particular you can add magic to SvREADONLY SVs and and more than
4009 one instance of the same 'how'
4011 I C<namelen> is greater then zero then a savepvn() I<copy> of C<name> is stored,
4012 if C<namelen> is zero then C<name> is stored as-is and - as another special
4013 case - if C<(name && namelen == HEf_SVKEY)> then C<name> is assumed to contain
4014 an C<SV*> and has its REFCNT incremented
4016 (This is now used as a subroutine by sv_magic.)
4018 MAGIC * sv_magicext(SV* sv, SV* obj, int how, MGVTBL *vtbl, const char* name, I32 namlen )
4025 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
4026 The new SV is marked as mortal. It will be destroyed "soon", either by an
4027 explicit call to FREETMPS, or by an implicit call at places such as
4028 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
4030 SV* sv_mortalcopy(SV* oldsv)
4037 Creates a new null SV which is mortal. The reference count of the SV is
4038 set to 1. It will be destroyed "soon", either by an explicit call to
4039 FREETMPS, or by an implicit call at places such as statement boundaries.
4040 See also C<sv_mortalcopy> and C<sv_2mortal>.
4049 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
4052 SV* sv_newref(SV* sv)
4059 A private implementation of the C<SvNVx> macro for compilers which can't
4060 cope with complex macro expressions. Always use the macro instead.
4069 Converts the value pointed to by offsetp from a count of bytes from the
4070 start of the string, to a count of the equivalent number of UTF8 chars.
4071 Handles magic and type coercion.
4073 void sv_pos_b2u(SV* sv, I32* offsetp)
4080 Converts the value pointed to by offsetp from a count of UTF8 chars from
4081 the start of the string, to a count of the equivalent number of bytes; if
4082 lenp is non-zero, it does the same to lenp, but this time starting from
4083 the offset, rather than from the start of the string. Handles magic and
4086 void sv_pos_u2b(SV* sv, I32* offsetp, I32* lenp)
4093 Use the C<SvPV_nolen> macro instead
4102 Use C<SvPVbyte_nolen> instead.
4104 char* sv_pvbyte(SV *sv)
4111 A private implementation of the C<SvPVbyte> macro for compilers
4112 which can't cope with complex macro expressions. Always use the macro
4115 char* sv_pvbyten(SV *sv, STRLEN *len)
4120 =item sv_pvbyten_force
4122 A private implementation of the C<SvPVbytex_force> macro for compilers
4123 which can't cope with complex macro expressions. Always use the macro
4126 char* sv_pvbyten_force(SV* sv, STRLEN* lp)
4133 A private implementation of the C<SvPV> macro for compilers which can't
4134 cope with complex macro expressions. Always use the macro instead.
4136 char* sv_pvn(SV *sv, STRLEN *len)
4143 Get a sensible string out of the SV somehow.
4144 A private implementation of the C<SvPV_force> macro for compilers which
4145 can't cope with complex macro expressions. Always use the macro instead.
4147 char* sv_pvn_force(SV* sv, STRLEN* lp)
4152 =item sv_pvn_force_flags
4154 Get a sensible string out of the SV somehow.
4155 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
4156 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
4157 implemented in terms of this function.
4158 You normally want to use the various wrapper macros instead: see
4159 C<SvPV_force> and C<SvPV_force_nomg>
4161 char* sv_pvn_force_flags(SV* sv, STRLEN* lp, I32 flags)
4168 Use the C<SvPVutf8_nolen> macro instead
4170 char* sv_pvutf8(SV *sv)
4177 A private implementation of the C<SvPVutf8> macro for compilers
4178 which can't cope with complex macro expressions. Always use the macro
4181 char* sv_pvutf8n(SV *sv, STRLEN *len)
4186 =item sv_pvutf8n_force
4188 A private implementation of the C<SvPVutf8_force> macro for compilers
4189 which can't cope with complex macro expressions. Always use the macro
4192 char* sv_pvutf8n_force(SV* sv, STRLEN* lp)
4199 Returns a string describing what the SV is a reference to.
4201 char* sv_reftype(SV* sv, int ob)
4208 Make the first argument a copy of the second, then delete the original.
4209 The target SV physically takes over ownership of the body of the source SV
4210 and inherits its flags; however, the target keeps any magic it owns,
4211 and any magic in the source is discarded.
4212 Note that this is a rather specialist SV copying operation; most of the
4213 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4215 void sv_replace(SV* sv, SV* nsv)
4220 =item sv_report_used
4222 Dump the contents of all SVs not yet freed. (Debugging aid).
4224 void sv_report_used()
4231 Underlying implementation for the C<reset> Perl function.
4232 Note that the perl-level function is vaguely deprecated.
4234 void sv_reset(char* s, HV* stash)
4241 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4242 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4243 push a back-reference to this RV onto the array of backreferences
4244 associated with that magic.
4246 SV* sv_rvweaken(SV *sv)
4253 Copies an integer into the given SV, upgrading first if necessary.
4254 Does not handle 'set' magic. See also C<sv_setiv_mg>.
4256 void sv_setiv(SV* sv, IV num)
4263 Like C<sv_setiv>, but also handles 'set' magic.
4265 void sv_setiv_mg(SV *sv, IV i)
4272 Copies a double into the given SV, upgrading first if necessary.
4273 Does not handle 'set' magic. See also C<sv_setnv_mg>.
4275 void sv_setnv(SV* sv, NV num)
4282 Like C<sv_setnv>, but also handles 'set' magic.
4284 void sv_setnv_mg(SV *sv, NV num)
4291 Copies a string into an SV. The string must be null-terminated. Does not
4292 handle 'set' magic. See C<sv_setpv_mg>.
4294 void sv_setpv(SV* sv, const char* ptr)
4301 Processes its arguments like C<sprintf> and sets an SV to the formatted
4302 output. Does not handle 'set' magic. See C<sv_setpvf_mg>.
4304 void sv_setpvf(SV* sv, const char* pat, ...)
4311 Like C<sv_setpvf>, but also handles 'set' magic.
4313 void sv_setpvf_mg(SV *sv, const char* pat, ...)
4320 Copies an integer into the given SV, also updating its string value.
4321 Does not handle 'set' magic. See C<sv_setpviv_mg>.
4323 void sv_setpviv(SV* sv, IV num)
4330 Like C<sv_setpviv>, but also handles 'set' magic.
4332 void sv_setpviv_mg(SV *sv, IV iv)
4339 Copies a string into an SV. The C<len> parameter indicates the number of
4340 bytes to be copied. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4342 void sv_setpvn(SV* sv, const char* ptr, STRLEN len)
4349 Like C<sv_setpvn>, but also handles 'set' magic.
4351 void sv_setpvn_mg(SV *sv, const char *ptr, STRLEN len)
4358 Like C<sv_setpv>, but also handles 'set' magic.
4360 void sv_setpv_mg(SV *sv, const char *ptr)
4367 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
4368 argument will be upgraded to an RV. That RV will be modified to point to
4369 the new SV. The C<classname> argument indicates the package for the
4370 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4371 will be returned and will have a reference count of 1.
4373 SV* sv_setref_iv(SV* rv, const char* classname, IV iv)
4380 Copies a double into a new SV, optionally blessing the SV. The C<rv>
4381 argument will be upgraded to an RV. That RV will be modified to point to
4382 the new SV. The C<classname> argument indicates the package for the
4383 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4384 will be returned and will have a reference count of 1.
4386 SV* sv_setref_nv(SV* rv, const char* classname, NV nv)
4393 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
4394 argument will be upgraded to an RV. That RV will be modified to point to
4395 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
4396 into the SV. The C<classname> argument indicates the package for the
4397 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4398 will be returned and will have a reference count of 1.
4400 Do not use with other Perl types such as HV, AV, SV, CV, because those
4401 objects will become corrupted by the pointer copy process.
4403 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
4405 SV* sv_setref_pv(SV* rv, const char* classname, void* pv)
4412 Copies a string into a new SV, optionally blessing the SV. The length of the
4413 string must be specified with C<n>. The C<rv> argument will be upgraded to
4414 an RV. That RV will be modified to point to the new SV. The C<classname>
4415 argument indicates the package for the blessing. Set C<classname> to
4416 C<Nullch> to avoid the blessing. The new SV will be returned and will have
4417 a reference count of 1.
4419 Note that C<sv_setref_pv> copies the pointer while this copies the string.
4421 SV* sv_setref_pvn(SV* rv, const char* classname, char* pv, STRLEN n)
4428 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
4429 argument will be upgraded to an RV. That RV will be modified to point to
4430 the new SV. The C<classname> argument indicates the package for the
4431 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4432 will be returned and will have a reference count of 1.
4434 SV* sv_setref_uv(SV* rv, const char* classname, UV uv)
4441 Copies the contents of the source SV C<ssv> into the destination SV
4442 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4443 function if the source SV needs to be reused. Does not handle 'set' magic.
4444 Loosely speaking, it performs a copy-by-value, obliterating any previous
4445 content of the destination.
4447 You probably want to use one of the assortment of wrappers, such as
4448 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4449 C<SvSetMagicSV_nosteal>.
4451 void sv_setsv(SV* dsv, SV* ssv)
4456 =item sv_setsv_flags
4458 Copies the contents of the source SV C<ssv> into the destination SV
4459 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4460 function if the source SV needs to be reused. Does not handle 'set' magic.
4461 Loosely speaking, it performs a copy-by-value, obliterating any previous
4462 content of the destination.
4463 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
4464 C<ssv> if appropriate, else not. C<sv_setsv> and C<sv_setsv_nomg> are
4465 implemented in terms of this function.
4467 You probably want to use one of the assortment of wrappers, such as
4468 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4469 C<SvSetMagicSV_nosteal>.
4471 This is the primary function for copying scalars, and most other
4472 copy-ish functions and macros use this underneath.
4474 void sv_setsv_flags(SV* dsv, SV* ssv, I32 flags)
4481 Like C<sv_setsv>, but also handles 'set' magic.
4483 void sv_setsv_mg(SV *dstr, SV *sstr)
4490 Copies an unsigned integer into the given SV, upgrading first if necessary.
4491 Does not handle 'set' magic. See also C<sv_setuv_mg>.
4493 void sv_setuv(SV* sv, UV num)
4500 Like C<sv_setuv>, but also handles 'set' magic.
4502 void sv_setuv_mg(SV *sv, UV u)
4509 Taint an SV. Use C<SvTAINTED_on> instead.
4510 void sv_taint(SV* sv)
4517 Test an SV for taintedness. Use C<SvTAINTED> instead.
4518 bool sv_tainted(SV* sv)
4525 Returns true if the SV has a true value by Perl's rules.
4526 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
4527 instead use an in-line version.
4536 Removes all magic of type C<type> from an SV.
4538 int sv_unmagic(SV* sv, int type)
4545 Unsets the RV status of the SV, and decrements the reference count of
4546 whatever was being referenced by the RV. This can almost be thought of
4547 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
4548 being zero. See C<SvROK_off>.
4550 void sv_unref(SV* sv)
4555 =item sv_unref_flags
4557 Unsets the RV status of the SV, and decrements the reference count of
4558 whatever was being referenced by the RV. This can almost be thought of
4559 as a reversal of C<newSVrv>. The C<cflags> argument can contain
4560 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
4561 (otherwise the decrementing is conditional on the reference count being
4562 different from one or the reference being a readonly SV).
4565 void sv_unref_flags(SV* sv, U32 flags)
4572 Untaint an SV. Use C<SvTAINTED_off> instead.
4573 void sv_untaint(SV* sv)
4580 Upgrade an SV to a more complex form. Generally adds a new body type to the
4581 SV, then copies across as much information as possible from the old body.
4582 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
4584 bool sv_upgrade(SV* sv, U32 mt)
4591 Tells an SV to use C<ptr> to find its string value. Normally the string is
4592 stored inside the SV but sv_usepvn allows the SV to use an outside string.
4593 The C<ptr> should point to memory that was allocated by C<malloc>. The
4594 string length, C<len>, must be supplied. This function will realloc the
4595 memory pointed to by C<ptr>, so that pointer should not be freed or used by
4596 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
4597 See C<sv_usepvn_mg>.
4599 void sv_usepvn(SV* sv, char* ptr, STRLEN len)
4606 Like C<sv_usepvn>, but also handles 'set' magic.
4608 void sv_usepvn_mg(SV *sv, char *ptr, STRLEN len)
4613 =item sv_utf8_decode
4615 Convert the octets in the PV from UTF-8 to chars. Scan for validity and then
4616 turn off SvUTF8 if needed so that we see characters. Used as a building block
4617 for decode_utf8 in Encode.xs
4619 NOTE: this function is experimental and may change or be
4620 removed without notice.
4622 bool sv_utf8_decode(SV *sv)
4627 =item sv_utf8_downgrade
4629 Attempt to convert the PV of an SV from UTF8-encoded to byte encoding.
4630 This may not be possible if the PV contains non-byte encoding characters;
4631 if this is the case, either returns false or, if C<fail_ok> is not
4634 This is not as a general purpose Unicode to byte encoding interface:
4635 use the Encode extension for that.
4637 NOTE: this function is experimental and may change or be
4638 removed without notice.
4640 bool sv_utf8_downgrade(SV *sv, bool fail_ok)
4645 =item sv_utf8_encode
4647 Convert the PV of an SV to UTF8-encoded, but then turn off the C<SvUTF8>
4648 flag so that it looks like octets again. Used as a building block
4649 for encode_utf8 in Encode.xs
4651 void sv_utf8_encode(SV *sv)
4656 =item sv_utf8_upgrade
4658 Convert the PV of an SV to its UTF8-encoded form.
4659 Forces the SV to string form if it is not already.
4660 Always sets the SvUTF8 flag to avoid future validity checks even
4661 if all the bytes have hibit clear.
4663 This is not as a general purpose byte encoding to Unicode interface:
4664 use the Encode extension for that.
4666 STRLEN sv_utf8_upgrade(SV *sv)
4671 =item sv_utf8_upgrade_flags
4673 Convert the PV of an SV to its UTF8-encoded form.
4674 Forces the SV to string form if it is not already.
4675 Always sets the SvUTF8 flag to avoid future validity checks even
4676 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
4677 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
4678 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
4680 This is not as a general purpose byte encoding to Unicode interface:
4681 use the Encode extension for that.
4683 STRLEN sv_utf8_upgrade_flags(SV *sv, I32 flags)
4690 A private implementation of the C<SvUVx> macro for compilers which can't
4691 cope with complex macro expressions. Always use the macro instead.
4700 Processes its arguments like C<vsprintf> and appends the formatted output
4701 to an SV. Uses an array of SVs if the C style variable argument list is
4702 missing (NULL). When running with taint checks enabled, indicates via
4703 C<maybe_tainted> if results are untrustworthy (often due to the use of
4706 Usually used via one of its frontends C<sv_catpvf> and C<sv_catpvf_mg>.
4708 void sv_vcatpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
4715 Works like C<vcatpvfn> but copies the text into the SV instead of
4718 Usually used via one of its frontends C<sv_setpvf> and C<sv_setpvf_mg>.
4720 void sv_vsetpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
4728 =head1 Unicode Support
4732 =item bytes_from_utf8
4734 Converts a string C<s> of length C<len> from UTF8 into byte encoding.
4735 Unlike <utf8_to_bytes> but like C<bytes_to_utf8>, returns a pointer to
4736 the newly-created string, and updates C<len> to contain the new
4737 length. Returns the original string if no conversion occurs, C<len>
4738 is unchanged. Do nothing if C<is_utf8> points to 0. Sets C<is_utf8> to
4739 0 if C<s> is converted or contains all 7bit characters.
4741 NOTE: this function is experimental and may change or be
4742 removed without notice.
4744 U8* bytes_from_utf8(U8 *s, STRLEN *len, bool *is_utf8)
4747 Found in file utf8.c
4751 Converts a string C<s> of length C<len> from ASCII into UTF8 encoding.
4752 Returns a pointer to the newly-created string, and sets C<len> to
4753 reflect the new length.
4755 If you want to convert to UTF8 from other encodings than ASCII,
4756 see sv_recode_to_utf8().
4758 NOTE: this function is experimental and may change or be
4759 removed without notice.
4761 U8* bytes_to_utf8(U8 *s, STRLEN *len)
4764 Found in file utf8.c
4768 Return true if the strings s1 and s2 differ case-insensitively, false
4769 if not (if they are equal case-insensitively). If u1 is true, the
4770 string s1 is assumed to be in UTF-8-encoded Unicode. If u2 is true,
4771 the string s2 is assumed to be in UTF-8-encoded Unicode. If u1 or u2
4772 are false, the respective string is assumed to be in native 8-bit
4775 If the pe1 and pe2 are non-NULL, the scanning pointers will be copied
4776 in there (they will point at the beginning of the I<next> character).
4777 If the pointers behind pe1 or pe2 are non-NULL, they are the end
4778 pointers beyond which scanning will not continue under any
4779 circustances. If the byte lengths l1 and l2 are non-zero, s1+l1 and
4780 s2+l2 will be used as goal end pointers that will also stop the scan,
4781 and which qualify towards defining a successful match: all the scans
4782 that define an explicit length must reach their goal pointers for
4783 a match to succeed).
4785 For case-insensitiveness, the "casefolding" of Unicode is used
4786 instead of upper/lowercasing both the characters, see
4787 http://www.unicode.org/unicode/reports/tr21/ (Case Mappings).
4789 I32 ibcmp_utf8(const char* a, char **pe1, UV l1, bool u1, const char* b, char **pe2, UV l2, bool u2)
4792 Found in file utf8.c
4796 Tests if some arbitrary number of bytes begins in a valid UTF-8
4797 character. Note that an INVARIANT (i.e. ASCII) character is a valid
4798 UTF-8 character. The actual number of bytes in the UTF-8 character
4799 will be returned if it is valid, otherwise 0.
4801 STRLEN is_utf8_char(U8 *p)
4804 Found in file utf8.c
4806 =item is_utf8_string
4808 Returns true if first C<len> bytes of the given string form a valid
4809 UTF8 string, false otherwise. Note that 'a valid UTF8 string' does
4810 not mean 'a string that contains code points above 0x7F encoded in
4811 UTF8' because a valid ASCII string is a valid UTF8 string.
4813 bool is_utf8_string(U8 *s, STRLEN len)
4816 Found in file utf8.c
4818 =item pv_uni_display
4820 Build to the scalar dsv a displayable version of the string spv,
4821 length len, the displayable version being at most pvlim bytes long
4822 (if longer, the rest is truncated and "..." will be appended).
4824 The flags argument can have UNI_DISPLAY_ISPRINT set to display
4825 isPRINT()able characters as themselves, UNI_DISPLAY_BACKSLASH
4826 to display the \\[nrfta\\] as the backslashed versions (like '\n')
4827 (UNI_DISPLAY_BACKSLASH is preferred over UNI_DISPLAY_ISPRINT for \\).
4828 UNI_DISPLAY_QQ (and its alias UNI_DISPLAY_REGEX) have both
4829 UNI_DISPLAY_BACKSLASH and UNI_DISPLAY_ISPRINT turned on.
4831 The pointer to the PV of the dsv is returned.
4833 char* pv_uni_display(SV *dsv, U8 *spv, STRLEN len, STRLEN pvlim, UV flags)
4836 Found in file utf8.c
4840 The encoding is assumed to be an Encode object, the PV of the ssv is
4841 assumed to be octets in that encoding and decoding the input starts
4842 from the position which (PV + *offset) pointed to. The dsv will be
4843 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
4844 when the string tstr appears in decoding output or the input ends on
4845 the PV of the ssv. The value which the offset points will be modified
4846 to the last input position on the ssv.
4848 Returns TRUE if the terminator was found, else returns FALSE.
4850 bool sv_cat_decode(SV* dsv, SV *encoding, SV *ssv, int *offset, char* tstr, int tlen)
4855 =item sv_recode_to_utf8
4857 The encoding is assumed to be an Encode object, on entry the PV
4858 of the sv is assumed to be octets in that encoding, and the sv
4859 will be converted into Unicode (and UTF-8).
4861 If the sv already is UTF-8 (or if it is not POK), or if the encoding
4862 is not a reference, nothing is done to the sv. If the encoding is not
4863 an C<Encode::XS> Encoding object, bad things will happen.
4864 (See F<lib/encoding.pm> and L<Encode>).
4866 The PV of the sv is returned.
4868 char* sv_recode_to_utf8(SV* sv, SV *encoding)
4873 =item sv_uni_display
4875 Build to the scalar dsv a displayable version of the scalar sv,
4876 the displayable version being at most pvlim bytes long
4877 (if longer, the rest is truncated and "..." will be appended).
4879 The flags argument is as in pv_uni_display().
4881 The pointer to the PV of the dsv is returned.
4883 char* sv_uni_display(SV *dsv, SV *ssv, STRLEN pvlim, UV flags)
4886 Found in file utf8.c
4890 The "p" contains the pointer to the UTF-8 string encoding
4891 the character that is being converted.
4893 The "ustrp" is a pointer to the character buffer to put the
4894 conversion result to. The "lenp" is a pointer to the length
4897 The "swashp" is a pointer to the swash to use.
4899 Both the special and normal mappings are stored lib/unicore/To/Foo.pl,
4900 and loaded by SWASHGET, using lib/utf8_heavy.pl. The special (usually,
4901 but not always, a multicharacter mapping), is tried first.
4903 The "special" is a string like "utf8::ToSpecLower", which means the
4904 hash %utf8::ToSpecLower. The access to the hash is through
4905 Perl_to_utf8_case().
4907 The "normal" is a string like "ToLower" which means the swash
4910 UV to_utf8_case(U8 *p, U8* ustrp, STRLEN *lenp, SV **swash, char *normal, char *special)
4913 Found in file utf8.c
4917 Convert the UTF-8 encoded character at p to its foldcase version and
4918 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
4919 that the ustrp needs to be at least UTF8_MAXLEN_FOLD+1 bytes since the
4920 foldcase version may be longer than the original character (up to
4923 The first character of the foldcased version is returned
4924 (but note, as explained above, that there may be more.)
4926 UV to_utf8_fold(U8 *p, U8* ustrp, STRLEN *lenp)
4929 Found in file utf8.c
4933 Convert the UTF-8 encoded character at p to its lowercase version and
4934 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
4935 that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the
4936 lowercase version may be longer than the original character (up to two
4939 The first character of the lowercased version is returned
4940 (but note, as explained above, that there may be more.)
4942 UV to_utf8_lower(U8 *p, U8* ustrp, STRLEN *lenp)
4945 Found in file utf8.c
4949 Convert the UTF-8 encoded character at p to its titlecase version and
4950 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
4951 that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the
4952 titlecase version may be longer than the original character (up to two
4955 The first character of the titlecased version is returned
4956 (but note, as explained above, that there may be more.)
4958 UV to_utf8_title(U8 *p, U8* ustrp, STRLEN *lenp)
4961 Found in file utf8.c
4965 Convert the UTF-8 encoded character at p to its uppercase version and
4966 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
4967 that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the
4968 uppercase version may be longer than the original character (up to two
4971 The first character of the uppercased version is returned
4972 (but note, as explained above, that there may be more.)
4974 UV to_utf8_upper(U8 *p, U8* ustrp, STRLEN *lenp)
4977 Found in file utf8.c
4979 =item utf8n_to_uvchr
4981 Returns the native character value of the first character in the string C<s>
4982 which is assumed to be in UTF8 encoding; C<retlen> will be set to the
4983 length, in bytes, of that character.
4985 Allows length and flags to be passed to low level routine.
4987 UV utf8n_to_uvchr(U8 *s, STRLEN curlen, STRLEN* retlen, U32 flags)
4990 Found in file utf8.c
4992 =item utf8n_to_uvuni
4994 Bottom level UTF-8 decode routine.
4995 Returns the unicode code point value of the first character in the string C<s>
4996 which is assumed to be in UTF8 encoding and no longer than C<curlen>;
4997 C<retlen> will be set to the length, in bytes, of that character.
4999 If C<s> does not point to a well-formed UTF8 character, the behaviour
5000 is dependent on the value of C<flags>: if it contains UTF8_CHECK_ONLY,
5001 it is assumed that the caller will raise a warning, and this function
5002 will silently just set C<retlen> to C<-1> and return zero. If the
5003 C<flags> does not contain UTF8_CHECK_ONLY, warnings about
5004 malformations will be given, C<retlen> will be set to the expected
5005 length of the UTF-8 character in bytes, and zero will be returned.
5007 The C<flags> can also contain various flags to allow deviations from
5008 the strict UTF-8 encoding (see F<utf8.h>).
5010 Most code should use utf8_to_uvchr() rather than call this directly.
5012 UV utf8n_to_uvuni(U8 *s, STRLEN curlen, STRLEN* retlen, U32 flags)
5015 Found in file utf8.c
5019 Returns the number of UTF8 characters between the UTF-8 pointers C<a>
5022 WARNING: use only if you *know* that the pointers point inside the
5025 IV utf8_distance(U8 *a, U8 *b)
5028 Found in file utf8.c
5032 Return the UTF-8 pointer C<s> displaced by C<off> characters, either
5033 forward or backward.
5035 WARNING: do not use the following unless you *know* C<off> is within
5036 the UTF-8 data pointed to by C<s> *and* that on entry C<s> is aligned
5037 on the first byte of character or just after the last byte of a character.
5039 U8* utf8_hop(U8 *s, I32 off)
5042 Found in file utf8.c
5046 Return the length of the UTF-8 char encoded string C<s> in characters.
5047 Stops at C<e> (inclusive). If C<e E<lt> s> or if the scan would end
5048 up past C<e>, croaks.
5050 STRLEN utf8_length(U8* s, U8 *e)
5053 Found in file utf8.c
5057 Converts a string C<s> of length C<len> from UTF8 into byte encoding.
5058 Unlike C<bytes_to_utf8>, this over-writes the original string, and
5059 updates len to contain the new length.
5060 Returns zero on failure, setting C<len> to -1.
5062 NOTE: this function is experimental and may change or be
5063 removed without notice.
5065 U8* utf8_to_bytes(U8 *s, STRLEN *len)
5068 Found in file utf8.c
5072 Returns the native character value of the first character in the string C<s>
5073 which is assumed to be in UTF8 encoding; C<retlen> will be set to the
5074 length, in bytes, of that character.
5076 If C<s> does not point to a well-formed UTF8 character, zero is
5077 returned and retlen is set, if possible, to -1.
5079 UV utf8_to_uvchr(U8 *s, STRLEN* retlen)
5082 Found in file utf8.c
5086 Returns the Unicode code point of the first character in the string C<s>
5087 which is assumed to be in UTF8 encoding; C<retlen> will be set to the
5088 length, in bytes, of that character.
5090 This function should only be used when returned UV is considered
5091 an index into the Unicode semantic tables (e.g. swashes).
5093 If C<s> does not point to a well-formed UTF8 character, zero is
5094 returned and retlen is set, if possible, to -1.
5096 UV utf8_to_uvuni(U8 *s, STRLEN* retlen)
5099 Found in file utf8.c
5103 Adds the UTF8 representation of the Native codepoint C<uv> to the end
5104 of the string C<d>; C<d> should be have at least C<UTF8_MAXLEN+1> free
5105 bytes available. The return value is the pointer to the byte after the
5106 end of the new character. In other words,
5108 d = uvchr_to_utf8(d, uv);
5110 is the recommended wide native character-aware way of saying
5114 U8* uvchr_to_utf8(U8 *d, UV uv)
5117 Found in file utf8.c
5119 =item uvuni_to_utf8_flags
5121 Adds the UTF8 representation of the Unicode codepoint C<uv> to the end
5122 of the string C<d>; C<d> should be have at least C<UTF8_MAXLEN+1> free
5123 bytes available. The return value is the pointer to the byte after the
5124 end of the new character. In other words,
5126 d = uvuni_to_utf8_flags(d, uv, flags);
5130 d = uvuni_to_utf8(d, uv);
5132 (which is equivalent to)
5134 d = uvuni_to_utf8_flags(d, uv, 0);
5136 is the recommended Unicode-aware way of saying
5140 U8* uvuni_to_utf8_flags(U8 *d, UV uv, UV flags)
5143 Found in file utf8.c
5148 =head1 Variables created by C<xsubpp> and C<xsubpp> internal functions
5154 Variable which is setup by C<xsubpp> to indicate the stack base offset,
5155 used by the C<ST>, C<XSprePUSH> and C<XSRETURN> macros. The C<dMARK> macro
5156 must be called prior to setup the C<MARK> variable.
5161 Found in file XSUB.h
5165 Variable which is setup by C<xsubpp> to indicate the
5166 class name for a C++ XS constructor. This is always a C<char*>. See C<THIS>.
5171 Found in file XSUB.h
5175 Sets up the C<ax> variable.
5176 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
5181 Found in file XSUB.h
5185 Sets up the C<items> variable.
5186 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
5191 Found in file XSUB.h
5195 Sets up stack and mark pointers for an XSUB, calling dSP and dMARK.
5196 Sets up the C<ax> and C<items> variables by calling C<dAX> and C<dITEMS>.
5197 This is usually handled automatically by C<xsubpp>.
5202 Found in file XSUB.h
5206 Sets up the C<ix> variable for an XSUB which has aliases. This is usually
5207 handled automatically by C<xsubpp>.
5212 Found in file XSUB.h
5216 Variable which is setup by C<xsubpp> to indicate the number of
5217 items on the stack. See L<perlxs/"Variable-length Parameter Lists">.
5222 Found in file XSUB.h
5226 Variable which is setup by C<xsubpp> to indicate which of an
5227 XSUB's aliases was used to invoke it. See L<perlxs/"The ALIAS: Keyword">.
5232 Found in file XSUB.h
5236 Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
5240 Found in file XSUB.h
5244 Variable which is setup by C<xsubpp> to hold the return value for an
5245 XSUB. This is always the proper type for the XSUB. See
5246 L<perlxs/"The RETVAL Variable">.
5251 Found in file XSUB.h
5255 Used to access elements on the XSUB's stack.
5260 Found in file XSUB.h
5264 Variable which is setup by C<xsubpp> to designate the object in a C++
5265 XSUB. This is always the proper type for the C++ object. See C<CLASS> and
5266 L<perlxs/"Using XS With C++">.
5271 Found in file XSUB.h
5275 Macro to declare an XSUB and its C parameter list. This is handled by
5279 Found in file XSUB.h
5281 =item XSRETURN_EMPTY
5283 Return an empty list from an XSUB immediately.
5289 Found in file XSUB.h
5293 The version identifier for an XS module. This is usually
5294 handled automatically by C<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>.
5297 Found in file XSUB.h
5299 =item XS_VERSION_BOOTCHECK
5301 Macro to verify that a PM module's $VERSION variable matches the XS
5302 module's C<XS_VERSION> variable. This is usually handled automatically by
5303 C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">.
5305 XS_VERSION_BOOTCHECK;
5308 Found in file XSUB.h
5313 =head1 Warning and Dieing
5319 This is the XSUB-writer's interface to Perl's C<die> function.
5320 Normally use this function the same way you use the C C<printf>
5321 function. See C<warn>.
5323 If you want to throw an exception object, assign the object to
5324 C<$@> and then pass C<Nullch> to croak():
5326 errsv = get_sv("@", TRUE);
5327 sv_setsv(errsv, exception_object);
5330 void croak(const char* pat, ...)
5333 Found in file util.c
5337 This is the XSUB-writer's interface to Perl's C<warn> function. Use this
5338 function the same way you use the C C<printf> function. See
5341 void warn(const char* pat, ...)
5344 Found in file util.c
5351 Until May 1997, this document was maintained by Jeff Okamoto
5352 <okamoto@corp.hp.com>. It is now maintained as part of Perl itself.
5354 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
5355 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
5356 Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
5357 Stephen McCamant, and Gurusamy Sarathy.
5359 API Listing originally by Dean Roehrich <roehrich@cray.com>.
5361 Updated to be autogenerated from comments in the source by Benjamin Stuhl.
5365 perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
projects / p5sagit/p5-mst-13.2.git / blob