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
1226 C<&Perl_sv_placeholder>. Note that the implementation of placeholders and
1227 restricted hashes may change, and the implementation currently is
1228 insufficiently abstracted for any change to be tidy.
1230 NOTE: this function is experimental and may change or be
1231 removed without notice.
1233 HE* hv_iternext_flags(HV* tb, I32 flags)
1240 Returns the value from the current position of the hash iterator. See
1243 SV* hv_iterval(HV* tb, HE* entry)
1250 Adds magic to a hash. See C<sv_magic>.
1252 void hv_magic(HV* hv, GV* gv, int how)
1259 Stores an SV in a hash. The hash key is specified as C<key> and C<klen> is
1260 the length of the key. The C<hash> parameter is the precomputed hash
1261 value; if it is zero then Perl will compute it. The return value will be
1262 NULL if the operation failed or if the value did not need to be actually
1263 stored within the hash (as in the case of tied hashes). Otherwise it can
1264 be dereferenced to get the original C<SV*>. Note that the caller is
1265 responsible for suitably incrementing the reference count of C<val> before
1266 the call, and decrementing it if the function returned NULL. Effectively
1267 a successful hv_store takes ownership of one reference to C<val>. This is
1268 usually what you want; a newly created SV has a reference count of one, so
1269 if all your code does is create SVs then store them in a hash, hv_store
1270 will own the only reference to the new SV, and your code doesn't need to do
1271 anything further to tidy up. hv_store is not implemented as a call to
1272 hv_store_ent, and does not create a temporary SV for the key, so if your
1273 key data is not already in SV form then use hv_store in preference to
1276 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1277 information on how to use this function on tied hashes.
1279 SV** hv_store(HV* tb, const char* key, I32 klen, SV* val, U32 hash)
1286 Stores C<val> in a hash. The hash key is specified as C<key>. The C<hash>
1287 parameter is the precomputed hash value; if it is zero then Perl will
1288 compute it. The return value is the new hash entry so created. It will be
1289 NULL if the operation failed or if the value did not need to be actually
1290 stored within the hash (as in the case of tied hashes). Otherwise the
1291 contents of the return value can be accessed using the C<He?> macros
1292 described here. Note that the caller is responsible for suitably
1293 incrementing the reference count of C<val> before the call, and
1294 decrementing it if the function returned NULL. Effectively a successful
1295 hv_store_ent takes ownership of one reference to C<val>. This is
1296 usually what you want; a newly created SV has a reference count of one, so
1297 if all your code does is create SVs then store them in a hash, hv_store
1298 will own the only reference to the new SV, and your code doesn't need to do
1299 anything further to tidy up. Note that hv_store_ent only reads the C<key>;
1300 unlike C<val> it does not take ownership of it, so maintaining the correct
1301 reference count on C<key> is entirely the caller's responsibility. hv_store
1302 is not implemented as a call to hv_store_ent, and does not create a temporary
1303 SV for the key, so if your key data is not already in SV form then use
1304 hv_store in preference to hv_store_ent.
1306 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1307 information on how to use this function on tied hashes.
1309 HE* hv_store_ent(HV* tb, SV* key, SV* val, U32 hash)
1318 void hv_undef(HV* tb)
1325 Creates a new HV. The reference count is set to 1.
1343 =head1 Magical Functions
1349 Clear something magical that the SV represents. See C<sv_magic>.
1351 int mg_clear(SV* sv)
1358 Copies the magic from one SV to another. See C<sv_magic>.
1360 int mg_copy(SV* sv, SV* nsv, const char* key, I32 klen)
1367 Finds the magic pointer for type matching the SV. See C<sv_magic>.
1369 MAGIC* mg_find(SV* sv, int type)
1376 Free any magic storage used by the SV. See C<sv_magic>.
1385 Do magic after a value is retrieved from the SV. See C<sv_magic>.
1394 Report on the SV's length. See C<sv_magic>.
1396 U32 mg_length(SV* sv)
1403 Turns on the magical status of an SV. See C<sv_magic>.
1405 void mg_magical(SV* sv)
1412 Do magic after a value is assigned to the SV. See C<sv_magic>.
1421 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
1422 argument more than once.
1424 void SvGETMAGIC(SV* sv)
1431 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
1441 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
1442 argument more than once.
1444 void SvSETMAGIC(SV* sv)
1451 Like C<SvSetSV>, but does any set magic required afterwards.
1453 void SvSetMagicSV(SV* dsb, SV* ssv)
1458 =item SvSetMagicSV_nosteal
1460 Like C<SvSetMagicSV>, but does any set magic required afterwards.
1462 void SvSetMagicSV_nosteal(SV* dsv, SV* ssv)
1469 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
1472 void SvSetSV(SV* dsb, SV* ssv)
1477 =item SvSetSV_nosteal
1479 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
1480 ssv. May evaluate arguments more than once.
1482 void SvSetSV_nosteal(SV* dsv, SV* ssv)
1489 Arranges for sv to be shared between threads if a suitable module
1492 void SvSHARE(SV* sv)
1500 =head1 Memory Management
1506 The XSUB-writer's interface to the C C<memcpy> function. The C<src> is the
1507 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1508 the type. May fail on overlapping copies. See also C<Move>.
1510 void Copy(void* src, void* dest, int nitems, type)
1513 Found in file handy.h
1517 The XSUB-writer's interface to the C C<memmove> function. The C<src> is the
1518 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1519 the type. Can do overlapping moves. See also C<Copy>.
1521 void Move(void* src, void* dest, int nitems, type)
1524 Found in file handy.h
1528 The XSUB-writer's interface to the C C<malloc> function.
1530 void New(int id, void* ptr, int nitems, type)
1533 Found in file handy.h
1537 The XSUB-writer's interface to the C C<malloc> function, with
1540 void Newc(int id, void* ptr, int nitems, type, cast)
1543 Found in file handy.h
1547 Creates a new SV. A non-zero C<len> parameter indicates the number of
1548 bytes of preallocated string space the SV should have. An extra byte for a
1549 tailing NUL is also reserved. (SvPOK is not set for the SV even if string
1550 space is allocated.) The reference count for the new SV is set to 1.
1551 C<id> is an integer id between 0 and 1299 (used to identify leaks).
1554 SV* NEWSV(int id, STRLEN len)
1557 Found in file handy.h
1561 The XSUB-writer's interface to the C C<malloc> function. The allocated
1562 memory is zeroed with C<memzero>.
1564 void Newz(int id, void* ptr, int nitems, type)
1567 Found in file handy.h
1571 Fill up memory with a pattern (byte 0xAB over and over again) that
1572 hopefully catches attempts to access uninitialized memory.
1574 void Poison(void* dest, int nitems, type)
1577 Found in file handy.h
1581 The XSUB-writer's interface to the C C<realloc> function.
1583 void Renew(void* ptr, int nitems, type)
1586 Found in file handy.h
1590 The XSUB-writer's interface to the C C<realloc> function, with
1593 void Renewc(void* ptr, int nitems, type, cast)
1596 Found in file handy.h
1600 The XSUB-writer's interface to the C C<free> function.
1602 void Safefree(void* ptr)
1605 Found in file handy.h
1609 Perl's version of C<strdup()>. Returns a pointer to a newly allocated
1610 string which is a duplicate of C<pv>. The size of the string is
1611 determined by C<strlen()>. The memory allocated for the new string can
1612 be freed with the C<Safefree()> function.
1614 char* savepv(const char* pv)
1617 Found in file util.c
1621 Perl's version of what C<strndup()> would be if it existed. Returns a
1622 pointer to a newly allocated string which is a duplicate of the first
1623 C<len> bytes from C<pv>. The memory allocated for the new string can be
1624 freed with the C<Safefree()> function.
1626 char* savepvn(const char* pv, I32 len)
1629 Found in file util.c
1633 A version of C<savepv()> which allocates the duplicate string in memory
1634 which is shared between threads.
1636 char* savesharedpv(const char* pv)
1639 Found in file util.c
1643 This is an architecture-independent macro to copy one structure to another.
1645 void StructCopy(type src, type dest, type)
1648 Found in file handy.h
1652 The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the
1653 destination, C<nitems> is the number of items, and C<type> is the type.
1655 void Zero(void* dest, int nitems, type)
1658 Found in file handy.h
1663 =head1 Miscellaneous Functions
1669 Analyses the string in order to make fast searches on it using fbm_instr()
1670 -- the Boyer-Moore algorithm.
1672 void fbm_compile(SV* sv, U32 flags)
1675 Found in file util.c
1679 Returns the location of the SV in the string delimited by C<str> and
1680 C<strend>. It returns C<Nullch> if the string can't be found. The C<sv>
1681 does not have to be fbm_compiled, but the search will not be as fast
1684 char* fbm_instr(unsigned char* big, unsigned char* bigend, SV* littlesv, U32 flags)
1687 Found in file util.c
1691 Takes a sprintf-style format pattern and conventional
1692 (non-SV) arguments and returns the formatted string.
1694 (char *) Perl_form(pTHX_ const char* pat, ...)
1696 can be used any place a string (char *) is required:
1698 char * s = Perl_form("%d.%d",major,minor);
1700 Uses a single private buffer so if you want to format several strings you
1701 must explicitly copy the earlier strings away (and free the copies when you
1704 char* form(const char* pat, ...)
1707 Found in file util.c
1711 Fill the sv with current working directory
1713 int getcwd_sv(SV* sv)
1716 Found in file util.c
1720 Returns a new version object based on the passed in SV:
1722 SV *sv = new_version(SV *ver);
1724 Does not alter the passed in ver SV. See "upg_version" if you
1725 want to upgrade the SV.
1727 SV* new_version(SV *ver)
1730 Found in file util.c
1734 Returns a pointer to the next character after the parsed
1735 version string, as well as upgrading the passed in SV to
1738 Function must be called with an already existing SV like
1741 s = scan_version(s,sv);
1743 Performs some preprocessing to the string to ensure that
1744 it has the correct characteristics of a version. Flags the
1745 object if it contains an underscore (which denotes this
1748 char* scan_version(char *vstr, SV *sv)
1751 Found in file util.c
1755 Test two strings to see if they are equal. Returns true or false.
1757 bool strEQ(char* s1, char* s2)
1760 Found in file handy.h
1764 Test two strings to see if the first, C<s1>, is greater than or equal to
1765 the second, C<s2>. Returns true or false.
1767 bool strGE(char* s1, char* s2)
1770 Found in file handy.h
1774 Test two strings to see if the first, C<s1>, is greater than the second,
1775 C<s2>. Returns true or false.
1777 bool strGT(char* s1, char* s2)
1780 Found in file handy.h
1784 Test two strings to see if the first, C<s1>, is less than or equal to the
1785 second, C<s2>. Returns true or false.
1787 bool strLE(char* s1, char* s2)
1790 Found in file handy.h
1794 Test two strings to see if the first, C<s1>, is less than the second,
1795 C<s2>. Returns true or false.
1797 bool strLT(char* s1, char* s2)
1800 Found in file handy.h
1804 Test two strings to see if they are different. Returns true or
1807 bool strNE(char* s1, char* s2)
1810 Found in file handy.h
1814 Test two strings to see if they are equal. The C<len> parameter indicates
1815 the number of bytes to compare. Returns true or false. (A wrapper for
1818 bool strnEQ(char* s1, char* s2, STRLEN len)
1821 Found in file handy.h
1825 Test two strings to see if they are different. The C<len> parameter
1826 indicates the number of bytes to compare. Returns true or false. (A
1827 wrapper for C<strncmp>).
1829 bool strnNE(char* s1, char* s2, STRLEN len)
1832 Found in file handy.h
1836 Dummy routine which "locks" an SV when there is no locking module present.
1837 Exists to avoid test for a NULL function pointer and because it could potentially warn under
1838 some level of strict-ness.
1840 void sv_nolocking(SV *)
1843 Found in file util.c
1847 Dummy routine which "shares" an SV when there is no sharing module present.
1848 Exists to avoid test for a NULL function pointer and because it could potentially warn under
1849 some level of strict-ness.
1851 void sv_nosharing(SV *)
1854 Found in file util.c
1856 =item sv_nounlocking
1858 Dummy routine which "unlocks" an SV when there is no locking module present.
1859 Exists to avoid test for a NULL function pointer and because it could potentially warn under
1860 some level of strict-ness.
1862 void sv_nounlocking(SV *)
1865 Found in file util.c
1869 In-place upgrade of the supplied SV to a version object.
1871 SV *sv = upg_version(SV *sv);
1873 Returns a pointer to the upgraded SV.
1875 SV* upg_version(SV *ver)
1878 Found in file util.c
1882 Version object aware cmp. Both operands must already have been
1883 converted into version objects.
1885 int vcmp(SV *lvs, SV *rvs)
1888 Found in file util.c
1892 Accepts a version object and returns the normalized floating
1893 point representation. Call like:
1897 NOTE: you can pass either the object directly or the SV
1898 contained within the RV.
1903 Found in file util.c
1907 Accepts a version object and returns the normalized string
1908 representation. Call like:
1910 sv = vstringify(rv);
1912 NOTE: you can pass either the object directly or the SV
1913 contained within the RV.
1915 SV* vstringify(SV *vs)
1918 Found in file util.c
1923 =head1 Numeric functions
1929 converts a string representing a binary number to numeric form.
1931 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
1932 conversion flags, and I<result> should be NULL or a pointer to an NV.
1933 The scan stops at the end of the string, or the first invalid character.
1934 On return I<*len> is set to the length scanned string, and I<*flags> gives
1937 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
1938 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_bin>
1939 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
1940 and writes the value to I<*result> (or the value is discarded if I<result>
1943 The hex number may optionally be prefixed with "0b" or "b" unless
1944 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
1945 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the binary
1946 number may use '_' characters to separate digits.
1948 UV grok_bin(char* start, STRLEN* len, I32* flags, NV *result)
1951 Found in file numeric.c
1955 converts a string representing a hex number to numeric form.
1957 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
1958 conversion flags, and I<result> should be NULL or a pointer to an NV.
1959 The scan stops at the end of the string, or the first non-hex-digit character.
1960 On return I<*len> is set to the length scanned string, and I<*flags> gives
1963 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
1964 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_hex>
1965 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
1966 and writes the value to I<*result> (or the value is discarded if I<result>
1969 The hex number may optionally be prefixed with "0x" or "x" unless
1970 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
1971 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the hex
1972 number may use '_' characters to separate digits.
1974 UV grok_hex(char* start, STRLEN* len, I32* flags, NV *result)
1977 Found in file numeric.c
1981 Recognise (or not) a number. The type of the number is returned
1982 (0 if unrecognised), otherwise it is a bit-ORed combination of
1983 IS_NUMBER_IN_UV, IS_NUMBER_GREATER_THAN_UV_MAX, IS_NUMBER_NOT_INT,
1984 IS_NUMBER_NEG, IS_NUMBER_INFINITY, IS_NUMBER_NAN (defined in perl.h).
1986 If the value of the number can fit an in UV, it is returned in the *valuep
1987 IS_NUMBER_IN_UV will be set to indicate that *valuep is valid, IS_NUMBER_IN_UV
1988 will never be set unless *valuep is valid, but *valuep may have been assigned
1989 to during processing even though IS_NUMBER_IN_UV is not set on return.
1990 If valuep is NULL, IS_NUMBER_IN_UV will be set for the same cases as when
1991 valuep is non-NULL, but no actual assignment (or SEGV) will occur.
1993 IS_NUMBER_NOT_INT will be set with IS_NUMBER_IN_UV if trailing decimals were
1994 seen (in which case *valuep gives the true value truncated to an integer), and
1995 IS_NUMBER_NEG if the number is negative (in which case *valuep holds the
1996 absolute value). IS_NUMBER_IN_UV is not set if e notation was used or the
1997 number is larger than a UV.
1999 int grok_number(const char *pv, STRLEN len, UV *valuep)
2002 Found in file numeric.c
2004 =item grok_numeric_radix
2006 Scan and skip for a numeric decimal separator (radix).
2008 bool grok_numeric_radix(const char **sp, const char *send)
2011 Found in file numeric.c
2016 UV grok_oct(char* start, STRLEN* len, I32* flags, NV *result)
2019 Found in file numeric.c
2023 For backwards compatibility. Use C<grok_bin> instead.
2025 NV scan_bin(char* start, STRLEN len, STRLEN* retlen)
2028 Found in file numeric.c
2032 For backwards compatibility. Use C<grok_hex> instead.
2034 NV scan_hex(char* start, STRLEN len, STRLEN* retlen)
2037 Found in file numeric.c
2041 For backwards compatibility. Use C<grok_oct> instead.
2043 NV scan_oct(char* start, STRLEN len, STRLEN* retlen)
2046 Found in file numeric.c
2051 =head1 Optree Manipulation Functions
2057 If C<cv> is a constant sub eligible for inlining. returns the constant
2058 value returned by the sub. Otherwise, returns NULL.
2060 Constant subs can be created with C<newCONSTSUB> or as described in
2061 L<perlsub/"Constant Functions">.
2063 SV* cv_const_sv(CV* cv)
2070 Creates a constant sub equivalent to Perl C<sub FOO () { 123 }> which is
2071 eligible for inlining at compile-time.
2073 CV* newCONSTSUB(HV* stash, char* name, SV* sv)
2080 Used by C<xsubpp> to hook up XSUBs as Perl subs.
2088 =head1 Pad Data Structures
2094 Get the value at offset po in the current pad.
2095 Use macro PAD_SV instead of calling this function directly.
2097 SV* pad_sv(PADOFFSET po)
2105 =head1 Stack Manipulation Macros
2111 Declare a stack marker variable, C<mark>, for the XSUB. See C<MARK> and
2121 Saves the original stack mark for the XSUB. See C<ORIGMARK>.
2130 Declares a local copy of perl's stack pointer for the XSUB, available via
2131 the C<SP> macro. See C<SP>.
2140 Used to extend the argument stack for an XSUB's return values. Once
2141 used, guarantees that there is room for at least C<nitems> to be pushed
2144 void EXTEND(SP, int nitems)
2151 Stack marker variable for the XSUB. See C<dMARK>.
2158 The original stack mark for the XSUB. See C<dORIGMARK>.
2165 Pops an integer off the stack.
2174 Pops a long off the stack.
2183 Pops a double off the stack.
2192 Pops a string off the stack. Deprecated. New code should provide
2193 a STRLEN n_a and use POPpx.
2202 Pops a string off the stack which must consist of bytes i.e. characters < 256.
2203 Requires a variable STRLEN n_a in scope.
2212 Pops a string off the stack.
2213 Requires a variable STRLEN n_a in scope.
2222 Pops an SV off the stack.
2231 Push an integer onto the stack. The stack must have room for this element.
2232 Handles 'set' magic. See C<XPUSHi>.
2241 Opening bracket for arguments on a callback. See C<PUTBACK> and
2251 Push a double onto the stack. The stack must have room for this element.
2252 Handles 'set' magic. See C<XPUSHn>.
2261 Push a string onto the stack. The stack must have room for this element.
2262 The C<len> indicates the length of the string. Handles 'set' magic. See
2265 void PUSHp(char* str, STRLEN len)
2272 Push an SV onto the stack. The stack must have room for this element.
2273 Does not handle 'set' magic. See C<XPUSHs>.
2282 Push an unsigned integer onto the stack. The stack must have room for this
2283 element. See C<XPUSHu>.
2292 Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
2293 See C<PUSHMARK> and L<perlcall> for other uses.
2302 Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and
2310 Refetch the stack pointer. Used after a callback. See L<perlcall>.
2319 Push an integer onto the stack, extending the stack if necessary. Handles
2320 'set' magic. See C<PUSHi>.
2329 Push a double onto the stack, extending the stack if necessary. Handles
2330 'set' magic. See C<PUSHn>.
2339 Push a string onto the stack, extending the stack if necessary. The C<len>
2340 indicates the length of the string. Handles 'set' magic. See
2343 void XPUSHp(char* str, STRLEN len)
2350 Push an SV onto the stack, extending the stack if necessary. Does not
2351 handle 'set' magic. See C<PUSHs>.
2360 Push an unsigned integer onto the stack, extending the stack if necessary.
2370 Return from XSUB, indicating number of items on the stack. This is usually
2371 handled by C<xsubpp>.
2373 void XSRETURN(int nitems)
2376 Found in file XSUB.h
2380 Return an integer from an XSUB immediately. Uses C<XST_mIV>.
2382 void XSRETURN_IV(IV iv)
2385 Found in file XSUB.h
2389 Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
2394 Found in file XSUB.h
2398 Return a double from an XSUB immediately. Uses C<XST_mNV>.
2400 void XSRETURN_NV(NV nv)
2403 Found in file XSUB.h
2407 Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
2409 void XSRETURN_PV(char* str)
2412 Found in file XSUB.h
2414 =item XSRETURN_UNDEF
2416 Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
2421 Found in file XSUB.h
2425 Return an integer from an XSUB immediately. Uses C<XST_mUV>.
2427 void XSRETURN_UV(IV uv)
2430 Found in file XSUB.h
2434 Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
2439 Found in file XSUB.h
2443 Place an integer into the specified position C<pos> on the stack. The
2444 value is stored in a new mortal SV.
2446 void XST_mIV(int pos, IV iv)
2449 Found in file XSUB.h
2453 Place C<&PL_sv_no> into the specified position C<pos> on the
2456 void XST_mNO(int pos)
2459 Found in file XSUB.h
2463 Place a double into the specified position C<pos> on the stack. The value
2464 is stored in a new mortal SV.
2466 void XST_mNV(int pos, NV nv)
2469 Found in file XSUB.h
2473 Place a copy of a string into the specified position C<pos> on the stack.
2474 The value is stored in a new mortal SV.
2476 void XST_mPV(int pos, char* str)
2479 Found in file XSUB.h
2483 Place C<&PL_sv_undef> into the specified position C<pos> on the
2486 void XST_mUNDEF(int pos)
2489 Found in file XSUB.h
2493 Place C<&PL_sv_yes> into the specified position C<pos> on the
2496 void XST_mYES(int pos)
2499 Found in file XSUB.h
2510 An enum of flags for Perl types. These are found in the file B<sv.h>
2511 in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
2518 Integer type flag for scalars. See C<svtype>.
2525 Double type flag for scalars. See C<svtype>.
2532 Pointer type flag for scalars. See C<svtype>.
2539 Type flag for arrays. See C<svtype>.
2546 Type flag for code refs. See C<svtype>.
2553 Type flag for hashes. See C<svtype>.
2560 Type flag for blessed scalars. See C<svtype>.
2568 =head1 SV Manipulation Functions
2574 Returns the SV of the specified Perl scalar. If C<create> is set and the
2575 Perl variable does not exist then it will be created. If C<create> is not
2576 set and the variable does not exist then NULL is returned.
2578 NOTE: the perl_ form of this function is deprecated.
2580 SV* get_sv(const char* name, I32 create)
2583 Found in file perl.c
2585 =item looks_like_number
2587 Test if the content of an SV looks like a number (or is a number).
2588 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
2589 non-numeric warning), even if your atof() doesn't grok them.
2591 I32 looks_like_number(SV* sv)
2598 Creates an RV wrapper for an SV. The reference count for the original SV is
2601 SV* newRV_inc(SV* sv)
2608 Creates an RV wrapper for an SV. The reference count for the original
2609 SV is B<not> incremented.
2611 SV* newRV_noinc(SV *sv)
2618 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
2619 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
2622 SV* newSV(STRLEN len)
2629 Creates a new SV and copies an integer into it. The reference count for the
2639 Creates a new SV and copies a floating point value into it.
2640 The reference count for the SV is set to 1.
2649 Creates a new SV and copies a string into it. The reference count for the
2650 SV is set to 1. If C<len> is zero, Perl will compute the length using
2651 strlen(). For efficiency, consider using C<newSVpvn> instead.
2653 SV* newSVpv(const char* s, STRLEN len)
2660 Creates a new SV and initializes it with the string formatted like
2663 SV* newSVpvf(const char* pat, ...)
2670 Creates a new SV and copies a string into it. The reference count for the
2671 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
2672 string. You are responsible for ensuring that the source string is at least
2675 SV* newSVpvn(const char* s, STRLEN len)
2680 =item newSVpvn_share
2682 Creates a new SV with its SvPVX pointing to a shared string in the string
2683 table. If the string does not already exist in the table, it is created
2684 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
2685 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
2686 otherwise the hash is computed. The idea here is that as the string table
2687 is used for shared hash keys these strings will have SvPVX == HeKEY and
2688 hash lookup will avoid string compare.
2690 SV* newSVpvn_share(const char* s, I32 len, U32 hash)
2697 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
2698 it will be upgraded to one. If C<classname> is non-null then the new SV will
2699 be blessed in the specified package. The new SV is returned and its
2700 reference count is 1.
2702 SV* newSVrv(SV* rv, const char* classname)
2709 Creates a new SV which is an exact duplicate of the original SV.
2712 SV* newSVsv(SV* old)
2719 Creates a new SV and copies an unsigned integer into it.
2720 The reference count for the SV is set to 1.
2729 Returns the length of the string which is in the SV. See C<SvLEN>.
2731 STRLEN SvCUR(SV* sv)
2738 Set the length of the string which is in the SV. See C<SvCUR>.
2740 void SvCUR_set(SV* sv, STRLEN len)
2747 Returns a pointer to the last character in the string which is in the SV.
2748 See C<SvCUR>. Access the character as *(SvEND(sv)).
2757 Expands the character buffer in the SV so that it has room for the
2758 indicated number of bytes (remember to reserve space for an extra trailing
2759 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
2760 Returns a pointer to the character buffer.
2762 char * SvGROW(SV* sv, STRLEN len)
2769 Returns a boolean indicating whether the SV contains an integer.
2778 Returns a boolean indicating whether the SV contains an integer. Checks
2779 the B<private> setting. Use C<SvIOK>.
2788 Returns a boolean indicating whether the SV contains a signed integer.
2790 void SvIOK_notUV(SV* sv)
2797 Unsets the IV status of an SV.
2799 void SvIOK_off(SV* sv)
2806 Tells an SV that it is an integer.
2808 void SvIOK_on(SV* sv)
2815 Tells an SV that it is an integer and disables all other OK bits.
2817 void SvIOK_only(SV* sv)
2824 Tells and SV that it is an unsigned integer and disables all other OK bits.
2826 void SvIOK_only_UV(SV* sv)
2833 Returns a boolean indicating whether the SV contains an unsigned integer.
2835 void SvIOK_UV(SV* sv)
2842 Returns a boolean indicating whether the SV is Copy-On-Write. (either shared
2843 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
2846 bool SvIsCOW(SV* sv)
2851 =item SvIsCOW_shared_hash
2853 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
2856 bool SvIsCOW_shared_hash(SV* sv)
2863 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
2864 version which guarantees to evaluate sv only once.
2873 Returns the raw value in the SV's IV slot, without checks or conversions.
2874 Only use when you are sure SvIOK is true. See also C<SvIV()>.
2883 Coerces the given SV to an integer and returns it. Guarantees to evaluate
2884 sv only once. Use the more efficient C<SvIV> otherwise.
2893 Returns the size of the string buffer in the SV, not including any part
2894 attributable to C<SvOOK>. See C<SvCUR>.
2896 STRLEN SvLEN(SV* sv)
2903 Returns a boolean indicating whether the SV contains a number, integer or
2913 Returns a boolean indicating whether the SV contains a number, integer or
2914 double. Checks the B<private> setting. Use C<SvNIOK>.
2916 bool SvNIOKp(SV* sv)
2923 Unsets the NV/IV status of an SV.
2925 void SvNIOK_off(SV* sv)
2932 Returns a boolean indicating whether the SV contains a double.
2941 Returns a boolean indicating whether the SV contains a double. Checks the
2942 B<private> setting. Use C<SvNOK>.
2951 Unsets the NV status of an SV.
2953 void SvNOK_off(SV* sv)
2960 Tells an SV that it is a double.
2962 void SvNOK_on(SV* sv)
2969 Tells an SV that it is a double and disables all other OK bits.
2971 void SvNOK_only(SV* sv)
2978 Coerce the given SV to a double and return it. See C<SvNVx> for a version
2979 which guarantees to evaluate sv only once.
2988 Coerces the given SV to a double and returns it. Guarantees to evaluate
2989 sv only once. Use the more efficient C<SvNV> otherwise.
2998 Returns the raw value in the SV's NV slot, without checks or conversions.
2999 Only use when you are sure SvNOK is true. See also C<SvNV()>.
3008 Returns a boolean indicating whether the value is an SV.
3017 Returns a boolean indicating whether the SvIVX is a valid offset value for
3018 the SvPVX. This hack is used internally to speed up removal of characters
3019 from the beginning of a SvPV. When SvOOK is true, then the start of the
3020 allocated string buffer is really (SvPVX - SvIVX).
3029 Returns a boolean indicating whether the SV contains a character
3039 Returns a boolean indicating whether the SV contains a character string.
3040 Checks the B<private> setting. Use C<SvPOK>.
3049 Unsets the PV status of an SV.
3051 void SvPOK_off(SV* sv)
3058 Tells an SV that it is a string.
3060 void SvPOK_on(SV* sv)
3067 Tells an SV that it is a string and disables all other OK bits.
3068 Will also turn off the UTF-8 status.
3070 void SvPOK_only(SV* sv)
3075 =item SvPOK_only_UTF8
3077 Tells an SV that it is a string and disables all other OK bits,
3078 and leaves the UTF-8 status as it was.
3080 void SvPOK_only_UTF8(SV* sv)
3087 Returns a pointer to the string in the SV, or a stringified form of
3088 the SV if the SV does not contain a string. The SV may cache the
3089 stringified version becoming C<SvPOK>. Handles 'get' magic. See also
3090 C<SvPVx> for a version which guarantees to evaluate sv only once.
3092 char* SvPV(SV* sv, STRLEN len)
3099 Like C<SvPV>, but converts sv to byte representation first if necessary.
3101 char* SvPVbyte(SV* sv, STRLEN len)
3108 Like C<SvPV>, but converts sv to byte representation first if necessary.
3109 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
3112 char* SvPVbytex(SV* sv, STRLEN len)
3117 =item SvPVbytex_force
3119 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
3120 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
3123 char* SvPVbytex_force(SV* sv, STRLEN len)
3128 =item SvPVbyte_force
3130 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
3132 char* SvPVbyte_force(SV* sv, STRLEN len)
3137 =item SvPVbyte_nolen
3139 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
3141 char* SvPVbyte_nolen(SV* sv)
3148 Like C<SvPV>, but converts sv to utf8 first if necessary.
3150 char* SvPVutf8(SV* sv, STRLEN len)
3157 Like C<SvPV>, but converts sv to utf8 first if necessary.
3158 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
3161 char* SvPVutf8x(SV* sv, STRLEN len)
3166 =item SvPVutf8x_force
3168 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
3169 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
3172 char* SvPVutf8x_force(SV* sv, STRLEN len)
3177 =item SvPVutf8_force
3179 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
3181 char* SvPVutf8_force(SV* sv, STRLEN len)
3186 =item SvPVutf8_nolen
3188 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
3190 char* SvPVutf8_nolen(SV* sv)
3197 Returns a pointer to the physical string in the SV. The SV must contain a
3207 A version of C<SvPV> which guarantees to evaluate sv only once.
3209 char* SvPVx(SV* sv, STRLEN len)
3216 Like C<SvPV> but will force the SV into containing just a string
3217 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
3220 char* SvPV_force(SV* sv, STRLEN len)
3225 =item SvPV_force_nomg
3227 Like C<SvPV> but will force the SV into containing just a string
3228 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
3229 directly. Doesn't process magic.
3231 char* SvPV_force_nomg(SV* sv, STRLEN len)
3238 Returns a pointer to the string in the SV, or a stringified form of
3239 the SV if the SV does not contain a string. The SV may cache the
3240 stringified form becoming C<SvPOK>. Handles 'get' magic.
3242 char* SvPV_nolen(SV* sv)
3249 Returns the value of the object's reference count.
3251 U32 SvREFCNT(SV* sv)
3258 Decrements the reference count of the given SV.
3260 void SvREFCNT_dec(SV* sv)
3267 Increments the reference count of the given SV.
3269 SV* SvREFCNT_inc(SV* sv)
3276 Tests if the SV is an RV.
3285 Unsets the RV status of an SV.
3287 void SvROK_off(SV* sv)
3294 Tells an SV that it is an RV.
3296 void SvROK_on(SV* sv)
3303 Dereferences an RV to return the SV.
3312 Returns the stash of the SV.
3321 Taints an SV if tainting is enabled.
3323 void SvTAINT(SV* sv)
3330 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
3333 bool SvTAINTED(SV* sv)
3340 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
3341 some of Perl's fundamental security features. XS module authors should not
3342 use this function unless they fully understand all the implications of
3343 unconditionally untainting the value. Untainting should be done in the
3344 standard perl fashion, via a carefully crafted regexp, rather than directly
3345 untainting variables.
3347 void SvTAINTED_off(SV* sv)
3354 Marks an SV as tainted if tainting is enabled.
3356 void SvTAINTED_on(SV* sv)
3363 Returns a boolean indicating whether Perl would evaluate the SV as true or
3364 false, defined or undefined. Does not handle 'get' magic.
3373 Returns the type of the SV. See C<svtype>.
3375 svtype SvTYPE(SV* sv)
3382 Releases a mutual exclusion lock on sv if a suitable module
3386 void SvUNLOCK(SV* sv)
3393 Returns a boolean indicating whether the SV contains an unsigned integer.
3402 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
3403 perform the upgrade if necessary. See C<svtype>.
3405 void SvUPGRADE(SV* sv, svtype type)
3412 Returns a boolean indicating whether the SV contains UTF-8 encoded data.
3421 Unsets the UTF-8 status of an SV.
3423 void SvUTF8_off(SV *sv)
3430 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
3431 Do not use frivolously.
3433 void SvUTF8_on(SV *sv)
3440 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
3441 for a version which guarantees to evaluate sv only once.
3450 Returns the raw value in the SV's UV slot, without checks or conversions.
3451 Only use when you are sure SvIOK is true. See also C<SvUV()>.
3460 Coerces the given SV to an unsigned integer and returns it. Guarantees to
3461 evaluate sv only once. Use the more efficient C<SvUV> otherwise.
3470 Returns a boolean indicating whether the SV contains a v-string.
3479 This function is only called on magical items, and is only used by
3480 sv_true() or its macro equivalent.
3482 bool sv_2bool(SV* sv)
3489 Using various gambits, try to get a CV from an SV; in addition, try if
3490 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
3492 CV* sv_2cv(SV* sv, HV** st, GV** gvp, I32 lref)
3499 Using various gambits, try to get an IO from an SV: the IO slot if its a
3500 GV; or the recursive result if we're an RV; or the IO slot of the symbol
3501 named after the PV if we're a string.
3510 Return the integer value of an SV, doing any necessary string conversion,
3511 magic etc. Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
3520 Marks an existing SV as mortal. The SV will be destroyed "soon", either
3521 by an explicit call to FREETMPS, or by an implicit call at places such as
3522 statement boundaries. See also C<sv_newmortal> and C<sv_mortalcopy>.
3524 SV* sv_2mortal(SV* sv)
3531 Return the num value of an SV, doing any necessary string or integer
3532 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
3542 Return a pointer to the byte-encoded representation of the SV, and set *lp
3543 to its length. May cause the SV to be downgraded from UTF-8 as a
3546 Usually accessed via the C<SvPVbyte> macro.
3548 char* sv_2pvbyte(SV* sv, STRLEN* lp)
3553 =item sv_2pvbyte_nolen
3555 Return a pointer to the byte-encoded representation of the SV.
3556 May cause the SV to be downgraded from UTF-8 as a side-effect.
3558 Usually accessed via the C<SvPVbyte_nolen> macro.
3560 char* sv_2pvbyte_nolen(SV* sv)
3567 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3568 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
3570 Usually accessed via the C<SvPVutf8> macro.
3572 char* sv_2pvutf8(SV* sv, STRLEN* lp)
3577 =item sv_2pvutf8_nolen
3579 Return a pointer to the UTF-8-encoded representation of the SV.
3580 May cause the SV to be upgraded to UTF-8 as a side-effect.
3582 Usually accessed via the C<SvPVutf8_nolen> macro.
3584 char* sv_2pvutf8_nolen(SV* sv)
3591 Returns a pointer to the string value of an SV, and sets *lp to its length.
3592 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
3594 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
3595 usually end up here too.
3597 char* sv_2pv_flags(SV* sv, STRLEN* lp, I32 flags)
3604 Like C<sv_2pv()>, but doesn't return the length too. You should usually
3605 use the macro wrapper C<SvPV_nolen(sv)> instead.
3606 char* sv_2pv_nolen(SV* sv)
3613 Return the unsigned integer value of an SV, doing any necessary string
3614 conversion, magic etc. Normally used via the C<SvUV(sv)> and C<SvUVx(sv)>
3624 Remove any string offset. You should normally use the C<SvOOK_off> macro
3627 int sv_backoff(SV* sv)
3634 Blesses an SV into a specified package. The SV must be an RV. The package
3635 must be designated by its stash (see C<gv_stashpv()>). The reference count
3636 of the SV is unaffected.
3638 SV* sv_bless(SV* sv, HV* stash)
3645 Concatenates the string onto the end of the string which is in the SV.
3646 If the SV has the UTF-8 status set, then the bytes appended should be
3647 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
3649 void sv_catpv(SV* sv, const char* ptr)
3656 Processes its arguments like C<sprintf> and appends the formatted
3657 output to an SV. If the appended data contains "wide" characters
3658 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
3659 and characters >255 formatted with %c), the original SV might get
3660 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic.
3661 C<SvSETMAGIC()> must typically be called after calling this function
3662 to handle 'set' magic.
3664 void sv_catpvf(SV* sv, const char* pat, ...)
3671 Like C<sv_catpvf>, but also handles 'set' magic.
3673 void sv_catpvf_mg(SV *sv, const char* pat, ...)
3680 Concatenates the string onto the end of the string which is in the SV. The
3681 C<len> indicates number of bytes to copy. If the SV has the UTF-8
3682 status set, then the bytes appended should be valid UTF-8.
3683 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
3685 void sv_catpvn(SV* sv, const char* ptr, STRLEN len)
3690 =item sv_catpvn_flags
3692 Concatenates the string onto the end of the string which is in the SV. The
3693 C<len> indicates number of bytes to copy. If the SV has the UTF-8
3694 status set, then the bytes appended should be valid UTF-8.
3695 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
3696 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
3697 in terms of this function.
3699 void sv_catpvn_flags(SV* sv, const char* ptr, STRLEN len, I32 flags)
3706 Like C<sv_catpvn>, but also handles 'set' magic.
3708 void sv_catpvn_mg(SV *sv, const char *ptr, STRLEN len)
3715 Like C<sv_catpv>, but also handles 'set' magic.
3717 void sv_catpv_mg(SV *sv, const char *ptr)
3724 Concatenates the string from SV C<ssv> onto the end of the string in
3725 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
3726 not 'set' magic. See C<sv_catsv_mg>.
3728 void sv_catsv(SV* dsv, SV* ssv)
3733 =item sv_catsv_flags
3735 Concatenates the string from SV C<ssv> onto the end of the string in
3736 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
3737 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
3738 and C<sv_catsv_nomg> are implemented in terms of this function.
3740 void sv_catsv_flags(SV* dsv, SV* ssv, I32 flags)
3747 Like C<sv_catsv>, but also handles 'set' magic.
3749 void sv_catsv_mg(SV *dstr, SV *sstr)
3756 Efficient removal of characters from the beginning of the string buffer.
3757 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
3758 the string buffer. The C<ptr> becomes the first character of the adjusted
3759 string. Uses the "OOK hack".
3760 Beware: after this function returns, C<ptr> and SvPVX(sv) may no longer
3761 refer to the same chunk of data.
3763 void sv_chop(SV* sv, char* ptr)
3770 Clear an SV: call any destructors, free up any memory used by the body,
3771 and free the body itself. The SV's head is I<not> freed, although
3772 its type is set to all 1's so that it won't inadvertently be assumed
3773 to be live during global destruction etc.
3774 This function should only be called when REFCNT is zero. Most of the time
3775 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
3778 void sv_clear(SV* sv)
3785 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
3786 string in C<sv1> is less than, equal to, or greater than the string in
3787 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
3788 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
3790 I32 sv_cmp(SV* sv1, SV* sv2)
3797 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
3798 'use bytes' aware, handles get magic, and will coerce its args to strings
3799 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
3801 I32 sv_cmp_locale(SV* sv1, SV* sv2)
3808 Add Collate Transform magic to an SV if it doesn't already have it.
3810 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
3811 scalar data of the variable, but transformed to such a format that a normal
3812 memory comparison can be used to compare the data according to the locale
3815 char* sv_collxfrm(SV* sv, STRLEN* nxp)
3822 Copies a stringified representation of the source SV into the
3823 destination SV. Automatically performs any necessary mg_get and
3824 coercion of numeric values into strings. Guaranteed to preserve
3825 UTF-8 flag even from overloaded objects. Similar in nature to
3826 sv_2pv[_flags] but operates directly on an SV instead of just the
3827 string. Mostly uses sv_2pv_flags to do its work, except when that
3828 would lose the UTF-8'ness of the PV.
3830 void sv_copypv(SV* dsv, SV* ssv)
3837 Auto-decrement of the value in the SV, doing string to numeric conversion
3838 if necessary. Handles 'get' magic.
3845 =item sv_derived_from
3847 Returns a boolean indicating whether the SV is derived from the specified
3848 class. This is the function that implements C<UNIVERSAL::isa>. It works
3849 for class names as well as for objects.
3851 bool sv_derived_from(SV* sv, const char* name)
3854 Found in file universal.c
3858 Returns a boolean indicating whether the strings in the two SVs are
3859 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
3860 coerce its args to strings if necessary.
3862 I32 sv_eq(SV* sv1, SV* sv2)
3867 =item sv_force_normal
3869 Undo various types of fakery on an SV: if the PV is a shared string, make
3870 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3871 an xpvmg. See also C<sv_force_normal_flags>.
3873 void sv_force_normal(SV *sv)
3878 =item sv_force_normal_flags
3880 Undo various types of fakery on an SV: if the PV is a shared string, make
3881 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3882 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
3883 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
3884 then a copy-on-write scalar drops its PV buffer (if any) and becomes
3885 SvPOK_off rather than making a copy. (Used where this scalar is about to be
3886 set to some other value.) In addition, the C<flags> parameter gets passed to
3887 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
3888 with flags set to 0.
3890 void sv_force_normal_flags(SV *sv, U32 flags)
3897 Decrement an SV's reference count, and if it drops to zero, call
3898 C<sv_clear> to invoke destructors and free up any memory used by
3899 the body; finally, deallocate the SV's head itself.
3900 Normally called via a wrapper macro C<SvREFCNT_dec>.
3902 void sv_free(SV* sv)
3909 Get a line from the filehandle and store it into the SV, optionally
3910 appending to the currently-stored string.
3912 char* sv_gets(SV* sv, PerlIO* fp, I32 append)
3919 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
3920 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
3921 Use the C<SvGROW> wrapper instead.
3923 char* sv_grow(SV* sv, STRLEN newlen)
3930 Auto-increment of the value in the SV, doing string to numeric conversion
3931 if necessary. Handles 'get' magic.
3940 Inserts a string at the specified offset/length within the SV. Similar to
3941 the Perl substr() function.
3943 void sv_insert(SV* bigsv, STRLEN offset, STRLEN len, char* little, STRLEN littlelen)
3950 Returns a boolean indicating whether the SV is blessed into the specified
3951 class. This does not check for subtypes; use C<sv_derived_from> to verify
3952 an inheritance relationship.
3954 int sv_isa(SV* sv, const char* name)
3961 Returns a boolean indicating whether the SV is an RV pointing to a blessed
3962 object. If the SV is not an RV, or if the object is not blessed, then this
3965 int sv_isobject(SV* sv)
3972 A private implementation of the C<SvIVx> macro for compilers which can't
3973 cope with complex macro expressions. Always use the macro instead.
3982 Returns the length of the string in the SV. Handles magic and type
3983 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
3985 STRLEN sv_len(SV* sv)
3992 Returns the number of characters in the string in an SV, counting wide
3993 UTF-8 bytes as a single character. Handles magic and type coercion.
3995 STRLEN sv_len_utf8(SV* sv)
4002 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4003 then adds a new magic item of type C<how> to the head of the magic list.
4005 void sv_magic(SV* sv, SV* obj, int how, const char* name, I32 namlen)
4012 Adds magic to an SV, upgrading it if necessary. Applies the
4013 supplied vtable and returns pointer to the magic added.
4015 Note that sv_magicext will allow things that sv_magic will not.
4016 In particular you can add magic to SvREADONLY SVs and and more than
4017 one instance of the same 'how'
4019 I C<namelen> is greater then zero then a savepvn() I<copy> of C<name> is stored,
4020 if C<namelen> is zero then C<name> is stored as-is and - as another special
4021 case - if C<(name && namelen == HEf_SVKEY)> then C<name> is assumed to contain
4022 an C<SV*> and has its REFCNT incremented
4024 (This is now used as a subroutine by sv_magic.)
4026 MAGIC * sv_magicext(SV* sv, SV* obj, int how, MGVTBL *vtbl, const char* name, I32 namlen )
4033 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
4034 The new SV is marked as mortal. It will be destroyed "soon", either by an
4035 explicit call to FREETMPS, or by an implicit call at places such as
4036 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
4038 SV* sv_mortalcopy(SV* oldsv)
4045 Creates a new null SV which is mortal. The reference count of the SV is
4046 set to 1. It will be destroyed "soon", either by an explicit call to
4047 FREETMPS, or by an implicit call at places such as statement boundaries.
4048 See also C<sv_mortalcopy> and C<sv_2mortal>.
4057 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
4060 SV* sv_newref(SV* sv)
4067 A private implementation of the C<SvNVx> macro for compilers which can't
4068 cope with complex macro expressions. Always use the macro instead.
4077 Converts the value pointed to by offsetp from a count of bytes from the
4078 start of the string, to a count of the equivalent number of UTF-8 chars.
4079 Handles magic and type coercion.
4081 void sv_pos_b2u(SV* sv, I32* offsetp)
4088 Converts the value pointed to by offsetp from a count of UTF-8 chars from
4089 the start of the string, to a count of the equivalent number of bytes; if
4090 lenp is non-zero, it does the same to lenp, but this time starting from
4091 the offset, rather than from the start of the string. Handles magic and
4094 void sv_pos_u2b(SV* sv, I32* offsetp, I32* lenp)
4101 Use the C<SvPV_nolen> macro instead
4110 Use C<SvPVbyte_nolen> instead.
4112 char* sv_pvbyte(SV *sv)
4119 A private implementation of the C<SvPVbyte> macro for compilers
4120 which can't cope with complex macro expressions. Always use the macro
4123 char* sv_pvbyten(SV *sv, STRLEN *len)
4128 =item sv_pvbyten_force
4130 A private implementation of the C<SvPVbytex_force> macro for compilers
4131 which can't cope with complex macro expressions. Always use the macro
4134 char* sv_pvbyten_force(SV* sv, STRLEN* lp)
4141 A private implementation of the C<SvPV> macro for compilers which can't
4142 cope with complex macro expressions. Always use the macro instead.
4144 char* sv_pvn(SV *sv, STRLEN *len)
4151 Get a sensible string out of the SV somehow.
4152 A private implementation of the C<SvPV_force> macro for compilers which
4153 can't cope with complex macro expressions. Always use the macro instead.
4155 char* sv_pvn_force(SV* sv, STRLEN* lp)
4160 =item sv_pvn_force_flags
4162 Get a sensible string out of the SV somehow.
4163 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
4164 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
4165 implemented in terms of this function.
4166 You normally want to use the various wrapper macros instead: see
4167 C<SvPV_force> and C<SvPV_force_nomg>
4169 char* sv_pvn_force_flags(SV* sv, STRLEN* lp, I32 flags)
4176 Use the C<SvPVutf8_nolen> macro instead
4178 char* sv_pvutf8(SV *sv)
4185 A private implementation of the C<SvPVutf8> macro for compilers
4186 which can't cope with complex macro expressions. Always use the macro
4189 char* sv_pvutf8n(SV *sv, STRLEN *len)
4194 =item sv_pvutf8n_force
4196 A private implementation of the C<SvPVutf8_force> macro for compilers
4197 which can't cope with complex macro expressions. Always use the macro
4200 char* sv_pvutf8n_force(SV* sv, STRLEN* lp)
4207 Returns a string describing what the SV is a reference to.
4209 char* sv_reftype(SV* sv, int ob)
4216 Make the first argument a copy of the second, then delete the original.
4217 The target SV physically takes over ownership of the body of the source SV
4218 and inherits its flags; however, the target keeps any magic it owns,
4219 and any magic in the source is discarded.
4220 Note that this is a rather specialist SV copying operation; most of the
4221 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4223 void sv_replace(SV* sv, SV* nsv)
4228 =item sv_report_used
4230 Dump the contents of all SVs not yet freed. (Debugging aid).
4232 void sv_report_used()
4239 Underlying implementation for the C<reset> Perl function.
4240 Note that the perl-level function is vaguely deprecated.
4242 void sv_reset(char* s, HV* stash)
4249 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4250 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4251 push a back-reference to this RV onto the array of backreferences
4252 associated with that magic.
4254 SV* sv_rvweaken(SV *sv)
4261 Copies an integer into the given SV, upgrading first if necessary.
4262 Does not handle 'set' magic. See also C<sv_setiv_mg>.
4264 void sv_setiv(SV* sv, IV num)
4271 Like C<sv_setiv>, but also handles 'set' magic.
4273 void sv_setiv_mg(SV *sv, IV i)
4280 Copies a double into the given SV, upgrading first if necessary.
4281 Does not handle 'set' magic. See also C<sv_setnv_mg>.
4283 void sv_setnv(SV* sv, NV num)
4290 Like C<sv_setnv>, but also handles 'set' magic.
4292 void sv_setnv_mg(SV *sv, NV num)
4299 Copies a string into an SV. The string must be null-terminated. Does not
4300 handle 'set' magic. See C<sv_setpv_mg>.
4302 void sv_setpv(SV* sv, const char* ptr)
4309 Processes its arguments like C<sprintf> and sets an SV to the formatted
4310 output. Does not handle 'set' magic. See C<sv_setpvf_mg>.
4312 void sv_setpvf(SV* sv, const char* pat, ...)
4319 Like C<sv_setpvf>, but also handles 'set' magic.
4321 void sv_setpvf_mg(SV *sv, const char* pat, ...)
4328 Copies an integer into the given SV, also updating its string value.
4329 Does not handle 'set' magic. See C<sv_setpviv_mg>.
4331 void sv_setpviv(SV* sv, IV num)
4338 Like C<sv_setpviv>, but also handles 'set' magic.
4340 void sv_setpviv_mg(SV *sv, IV iv)
4347 Copies a string into an SV. The C<len> parameter indicates the number of
4348 bytes to be copied. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4350 void sv_setpvn(SV* sv, const char* ptr, STRLEN len)
4357 Like C<sv_setpvn>, but also handles 'set' magic.
4359 void sv_setpvn_mg(SV *sv, const char *ptr, STRLEN len)
4366 Like C<sv_setpv>, but also handles 'set' magic.
4368 void sv_setpv_mg(SV *sv, const char *ptr)
4375 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
4376 argument will be upgraded to an RV. That RV will be modified to point to
4377 the new SV. The C<classname> argument indicates the package for the
4378 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4379 will have a reference count of 1, and the RV will be returned.
4381 SV* sv_setref_iv(SV* rv, const char* classname, IV iv)
4388 Copies a double into a new SV, optionally blessing the SV. The C<rv>
4389 argument will be upgraded to an RV. That RV will be modified to point to
4390 the new SV. The C<classname> argument indicates the package for the
4391 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4392 will have a reference count of 1, and the RV will be returned.
4394 SV* sv_setref_nv(SV* rv, const char* classname, NV nv)
4401 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
4402 argument will be upgraded to an RV. That RV will be modified to point to
4403 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
4404 into the SV. The C<classname> argument indicates the package for the
4405 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4406 will have a reference count of 1, and the RV will be returned.
4408 Do not use with other Perl types such as HV, AV, SV, CV, because those
4409 objects will become corrupted by the pointer copy process.
4411 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
4413 SV* sv_setref_pv(SV* rv, const char* classname, void* pv)
4420 Copies a string into a new SV, optionally blessing the SV. The length of the
4421 string must be specified with C<n>. The C<rv> argument will be upgraded to
4422 an RV. That RV will be modified to point to the new SV. The C<classname>
4423 argument indicates the package for the blessing. Set C<classname> to
4424 C<Nullch> to avoid the blessing. The new SV will have a reference count
4425 of 1, and the RV will be returned.
4427 Note that C<sv_setref_pv> copies the pointer while this copies the string.
4429 SV* sv_setref_pvn(SV* rv, const char* classname, char* pv, STRLEN n)
4436 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
4437 argument will be upgraded to an RV. That RV will be modified to point to
4438 the new SV. The C<classname> argument indicates the package for the
4439 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4440 will have a reference count of 1, and the RV will be returned.
4442 SV* sv_setref_uv(SV* rv, const char* classname, UV uv)
4449 Copies the contents of the source SV C<ssv> into the destination SV
4450 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4451 function if the source SV needs to be reused. Does not handle 'set' magic.
4452 Loosely speaking, it performs a copy-by-value, obliterating any previous
4453 content of the destination.
4455 You probably want to use one of the assortment of wrappers, such as
4456 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4457 C<SvSetMagicSV_nosteal>.
4459 void sv_setsv(SV* dsv, SV* ssv)
4464 =item sv_setsv_flags
4466 Copies the contents of the source SV C<ssv> into the destination SV
4467 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4468 function if the source SV needs to be reused. Does not handle 'set' magic.
4469 Loosely speaking, it performs a copy-by-value, obliterating any previous
4470 content of the destination.
4471 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
4472 C<ssv> if appropriate, else not. C<sv_setsv> and C<sv_setsv_nomg> are
4473 implemented in terms of this function.
4475 You probably want to use one of the assortment of wrappers, such as
4476 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4477 C<SvSetMagicSV_nosteal>.
4479 This is the primary function for copying scalars, and most other
4480 copy-ish functions and macros use this underneath.
4482 void sv_setsv_flags(SV* dsv, SV* ssv, I32 flags)
4489 Like C<sv_setsv>, but also handles 'set' magic.
4491 void sv_setsv_mg(SV *dstr, SV *sstr)
4498 Copies an unsigned integer into the given SV, upgrading first if necessary.
4499 Does not handle 'set' magic. See also C<sv_setuv_mg>.
4501 void sv_setuv(SV* sv, UV num)
4508 Like C<sv_setuv>, but also handles 'set' magic.
4510 void sv_setuv_mg(SV *sv, UV u)
4517 Taint an SV. Use C<SvTAINTED_on> instead.
4518 void sv_taint(SV* sv)
4525 Test an SV for taintedness. Use C<SvTAINTED> instead.
4526 bool sv_tainted(SV* sv)
4533 Returns true if the SV has a true value by Perl's rules.
4534 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
4535 instead use an in-line version.
4544 Removes all magic of type C<type> from an SV.
4546 int sv_unmagic(SV* sv, int type)
4553 Unsets the RV status of the SV, and decrements the reference count of
4554 whatever was being referenced by the RV. This can almost be thought of
4555 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
4556 being zero. See C<SvROK_off>.
4558 void sv_unref(SV* sv)
4563 =item sv_unref_flags
4565 Unsets the RV status of the SV, and decrements the reference count of
4566 whatever was being referenced by the RV. This can almost be thought of
4567 as a reversal of C<newSVrv>. The C<cflags> argument can contain
4568 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
4569 (otherwise the decrementing is conditional on the reference count being
4570 different from one or the reference being a readonly SV).
4573 void sv_unref_flags(SV* sv, U32 flags)
4580 Untaint an SV. Use C<SvTAINTED_off> instead.
4581 void sv_untaint(SV* sv)
4588 Upgrade an SV to a more complex form. Generally adds a new body type to the
4589 SV, then copies across as much information as possible from the old body.
4590 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
4592 bool sv_upgrade(SV* sv, U32 mt)
4599 Tells an SV to use C<ptr> to find its string value. Normally the string is
4600 stored inside the SV but sv_usepvn allows the SV to use an outside string.
4601 The C<ptr> should point to memory that was allocated by C<malloc>. The
4602 string length, C<len>, must be supplied. This function will realloc the
4603 memory pointed to by C<ptr>, so that pointer should not be freed or used by
4604 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
4605 See C<sv_usepvn_mg>.
4607 void sv_usepvn(SV* sv, char* ptr, STRLEN len)
4614 Like C<sv_usepvn>, but also handles 'set' magic.
4616 void sv_usepvn_mg(SV *sv, char *ptr, STRLEN len)
4621 =item sv_utf8_decode
4623 Convert the octets in the PV from UTF-8 to chars. Scan for validity and then
4624 turn off SvUTF8 if needed so that we see characters. Used as a building block
4625 for decode_utf8 in Encode.xs
4627 NOTE: this function is experimental and may change or be
4628 removed without notice.
4630 bool sv_utf8_decode(SV *sv)
4635 =item sv_utf8_downgrade
4637 Attempt to convert the PV of an SV from UTF-8-encoded to byte encoding.
4638 This may not be possible if the PV contains non-byte encoding characters;
4639 if this is the case, either returns false or, if C<fail_ok> is not
4642 This is not as a general purpose Unicode to byte encoding interface:
4643 use the Encode extension for that.
4645 NOTE: this function is experimental and may change or be
4646 removed without notice.
4648 bool sv_utf8_downgrade(SV *sv, bool fail_ok)
4653 =item sv_utf8_encode
4655 Convert the PV of an SV to UTF-8-encoded, but then turn off the C<SvUTF8>
4656 flag so that it looks like octets again. Used as a building block
4657 for encode_utf8 in Encode.xs
4659 void sv_utf8_encode(SV *sv)
4664 =item sv_utf8_upgrade
4666 Convert the PV of an SV to its UTF-8-encoded form.
4667 Forces the SV to string form if it is not already.
4668 Always sets the SvUTF8 flag to avoid future validity checks even
4669 if all the bytes have hibit clear.
4671 This is not as a general purpose byte encoding to Unicode interface:
4672 use the Encode extension for that.
4674 STRLEN sv_utf8_upgrade(SV *sv)
4679 =item sv_utf8_upgrade_flags
4681 Convert the PV of an SV to its UTF-8-encoded form.
4682 Forces the SV to string form if it is not already.
4683 Always sets the SvUTF8 flag to avoid future validity checks even
4684 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
4685 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
4686 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
4688 This is not as a general purpose byte encoding to Unicode interface:
4689 use the Encode extension for that.
4691 STRLEN sv_utf8_upgrade_flags(SV *sv, I32 flags)
4698 A private implementation of the C<SvUVx> macro for compilers which can't
4699 cope with complex macro expressions. Always use the macro instead.
4708 Processes its arguments like C<vsprintf> and appends the formatted output
4709 to an SV. Uses an array of SVs if the C style variable argument list is
4710 missing (NULL). When running with taint checks enabled, indicates via
4711 C<maybe_tainted> if results are untrustworthy (often due to the use of
4714 Usually used via one of its frontends C<sv_catpvf> and C<sv_catpvf_mg>.
4716 void sv_vcatpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
4723 Works like C<vcatpvfn> but copies the text into the SV instead of
4726 Usually used via one of its frontends C<sv_setpvf> and C<sv_setpvf_mg>.
4728 void sv_vsetpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
4736 =head1 Unicode Support
4740 =item bytes_from_utf8
4742 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
4743 Unlike <utf8_to_bytes> but like C<bytes_to_utf8>, returns a pointer to
4744 the newly-created string, and updates C<len> to contain the new
4745 length. Returns the original string if no conversion occurs, C<len>
4746 is unchanged. Do nothing if C<is_utf8> points to 0. Sets C<is_utf8> to
4747 0 if C<s> is converted or contains all 7bit characters.
4749 NOTE: this function is experimental and may change or be
4750 removed without notice.
4752 U8* bytes_from_utf8(U8 *s, STRLEN *len, bool *is_utf8)
4755 Found in file utf8.c
4759 Converts a string C<s> of length C<len> from ASCII into UTF-8 encoding.
4760 Returns a pointer to the newly-created string, and sets C<len> to
4761 reflect the new length.
4763 If you want to convert to UTF-8 from other encodings than ASCII,
4764 see sv_recode_to_utf8().
4766 NOTE: this function is experimental and may change or be
4767 removed without notice.
4769 U8* bytes_to_utf8(U8 *s, STRLEN *len)
4772 Found in file utf8.c
4776 Return true if the strings s1 and s2 differ case-insensitively, false
4777 if not (if they are equal case-insensitively). If u1 is true, the
4778 string s1 is assumed to be in UTF-8-encoded Unicode. If u2 is true,
4779 the string s2 is assumed to be in UTF-8-encoded Unicode. If u1 or u2
4780 are false, the respective string is assumed to be in native 8-bit
4783 If the pe1 and pe2 are non-NULL, the scanning pointers will be copied
4784 in there (they will point at the beginning of the I<next> character).
4785 If the pointers behind pe1 or pe2 are non-NULL, they are the end
4786 pointers beyond which scanning will not continue under any
4787 circustances. If the byte lengths l1 and l2 are non-zero, s1+l1 and
4788 s2+l2 will be used as goal end pointers that will also stop the scan,
4789 and which qualify towards defining a successful match: all the scans
4790 that define an explicit length must reach their goal pointers for
4791 a match to succeed).
4793 For case-insensitiveness, the "casefolding" of Unicode is used
4794 instead of upper/lowercasing both the characters, see
4795 http://www.unicode.org/unicode/reports/tr21/ (Case Mappings).
4797 I32 ibcmp_utf8(const char* a, char **pe1, UV l1, bool u1, const char* b, char **pe2, UV l2, bool u2)
4800 Found in file utf8.c
4804 Tests if some arbitrary number of bytes begins in a valid UTF-8
4805 character. Note that an INVARIANT (i.e. ASCII) character is a valid
4806 UTF-8 character. The actual number of bytes in the UTF-8 character
4807 will be returned if it is valid, otherwise 0.
4809 STRLEN is_utf8_char(U8 *p)
4812 Found in file utf8.c
4814 =item is_utf8_string
4816 Returns true if first C<len> bytes of the given string form a valid
4817 UTF-8 string, false otherwise. Note that 'a valid UTF-8 string' does
4818 not mean 'a string that contains code points above 0x7F encoded in UTF-8'
4819 because a valid ASCII string is a valid UTF-8 string.
4821 bool is_utf8_string(U8 *s, STRLEN len)
4824 Found in file utf8.c
4826 =item is_utf8_string_loc
4828 Like is_ut8_string but store the location of the failure in
4831 bool is_utf8_string_loc(U8 *s, STRLEN len, U8 **p)
4834 Found in file utf8.c
4836 =item pv_uni_display
4838 Build to the scalar dsv a displayable version of the string spv,
4839 length len, the displayable version being at most pvlim bytes long
4840 (if longer, the rest is truncated and "..." will be appended).
4842 The flags argument can have UNI_DISPLAY_ISPRINT set to display
4843 isPRINT()able characters as themselves, UNI_DISPLAY_BACKSLASH
4844 to display the \\[nrfta\\] as the backslashed versions (like '\n')
4845 (UNI_DISPLAY_BACKSLASH is preferred over UNI_DISPLAY_ISPRINT for \\).
4846 UNI_DISPLAY_QQ (and its alias UNI_DISPLAY_REGEX) have both
4847 UNI_DISPLAY_BACKSLASH and UNI_DISPLAY_ISPRINT turned on.
4849 The pointer to the PV of the dsv is returned.
4851 char* pv_uni_display(SV *dsv, U8 *spv, STRLEN len, STRLEN pvlim, UV flags)
4854 Found in file utf8.c
4858 The encoding is assumed to be an Encode object, the PV of the ssv is
4859 assumed to be octets in that encoding and decoding the input starts
4860 from the position which (PV + *offset) pointed to. The dsv will be
4861 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
4862 when the string tstr appears in decoding output or the input ends on
4863 the PV of the ssv. The value which the offset points will be modified
4864 to the last input position on the ssv.
4866 Returns TRUE if the terminator was found, else returns FALSE.
4868 bool sv_cat_decode(SV* dsv, SV *encoding, SV *ssv, int *offset, char* tstr, int tlen)
4873 =item sv_recode_to_utf8
4875 The encoding is assumed to be an Encode object, on entry the PV
4876 of the sv is assumed to be octets in that encoding, and the sv
4877 will be converted into Unicode (and UTF-8).
4879 If the sv already is UTF-8 (or if it is not POK), or if the encoding
4880 is not a reference, nothing is done to the sv. If the encoding is not
4881 an C<Encode::XS> Encoding object, bad things will happen.
4882 (See F<lib/encoding.pm> and L<Encode>).
4884 The PV of the sv is returned.
4886 char* sv_recode_to_utf8(SV* sv, SV *encoding)
4891 =item sv_uni_display
4893 Build to the scalar dsv a displayable version of the scalar sv,
4894 the displayable version being at most pvlim bytes long
4895 (if longer, the rest is truncated and "..." will be appended).
4897 The flags argument is as in pv_uni_display().
4899 The pointer to the PV of the dsv is returned.
4901 char* sv_uni_display(SV *dsv, SV *ssv, STRLEN pvlim, UV flags)
4904 Found in file utf8.c
4908 The "p" contains the pointer to the UTF-8 string encoding
4909 the character that is being converted.
4911 The "ustrp" is a pointer to the character buffer to put the
4912 conversion result to. The "lenp" is a pointer to the length
4915 The "swashp" is a pointer to the swash to use.
4917 Both the special and normal mappings are stored lib/unicore/To/Foo.pl,
4918 and loaded by SWASHGET, using lib/utf8_heavy.pl. The special (usually,
4919 but not always, a multicharacter mapping), is tried first.
4921 The "special" is a string like "utf8::ToSpecLower", which means the
4922 hash %utf8::ToSpecLower. The access to the hash is through
4923 Perl_to_utf8_case().
4925 The "normal" is a string like "ToLower" which means the swash
4928 UV to_utf8_case(U8 *p, U8* ustrp, STRLEN *lenp, SV **swash, char *normal, char *special)
4931 Found in file utf8.c
4935 Convert the UTF-8 encoded character at p to its foldcase version and
4936 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
4937 that the ustrp needs to be at least UTF8_MAXLEN_FOLD+1 bytes since the
4938 foldcase version may be longer than the original character (up to
4941 The first character of the foldcased version is returned
4942 (but note, as explained above, that there may be more.)
4944 UV to_utf8_fold(U8 *p, U8* ustrp, STRLEN *lenp)
4947 Found in file utf8.c
4951 Convert the UTF-8 encoded character at p to its lowercase version and
4952 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
4953 that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the
4954 lowercase version may be longer than the original character (up to two
4957 The first character of the lowercased version is returned
4958 (but note, as explained above, that there may be more.)
4960 UV to_utf8_lower(U8 *p, U8* ustrp, STRLEN *lenp)
4963 Found in file utf8.c
4967 Convert the UTF-8 encoded character at p to its titlecase version and
4968 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
4969 that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the
4970 titlecase version may be longer than the original character (up to two
4973 The first character of the titlecased version is returned
4974 (but note, as explained above, that there may be more.)
4976 UV to_utf8_title(U8 *p, U8* ustrp, STRLEN *lenp)
4979 Found in file utf8.c
4983 Convert the UTF-8 encoded character at p to its uppercase version and
4984 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
4985 that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the
4986 uppercase version may be longer than the original character (up to two
4989 The first character of the uppercased version is returned
4990 (but note, as explained above, that there may be more.)
4992 UV to_utf8_upper(U8 *p, U8* ustrp, STRLEN *lenp)
4995 Found in file utf8.c
4997 =item utf8n_to_uvchr
4999 Returns the native character value of the first character in the string C<s>
5000 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
5001 length, in bytes, of that character.
5003 Allows length and flags to be passed to low level routine.
5005 UV utf8n_to_uvchr(U8 *s, STRLEN curlen, STRLEN* retlen, U32 flags)
5008 Found in file utf8.c
5010 =item utf8n_to_uvuni
5012 Bottom level UTF-8 decode routine.
5013 Returns the unicode code point value of the first character in the string C<s>
5014 which is assumed to be in UTF-8 encoding and no longer than C<curlen>;
5015 C<retlen> will be set to the length, in bytes, of that character.
5017 If C<s> does not point to a well-formed UTF-8 character, the behaviour
5018 is dependent on the value of C<flags>: if it contains UTF8_CHECK_ONLY,
5019 it is assumed that the caller will raise a warning, and this function
5020 will silently just set C<retlen> to C<-1> and return zero. If the
5021 C<flags> does not contain UTF8_CHECK_ONLY, warnings about
5022 malformations will be given, C<retlen> will be set to the expected
5023 length of the UTF-8 character in bytes, and zero will be returned.
5025 The C<flags> can also contain various flags to allow deviations from
5026 the strict UTF-8 encoding (see F<utf8.h>).
5028 Most code should use utf8_to_uvchr() rather than call this directly.
5030 UV utf8n_to_uvuni(U8 *s, STRLEN curlen, STRLEN* retlen, U32 flags)
5033 Found in file utf8.c
5037 Returns the number of UTF-8 characters between the UTF-8 pointers C<a>
5040 WARNING: use only if you *know* that the pointers point inside the
5043 IV utf8_distance(U8 *a, U8 *b)
5046 Found in file utf8.c
5050 Return the UTF-8 pointer C<s> displaced by C<off> characters, either
5051 forward or backward.
5053 WARNING: do not use the following unless you *know* C<off> is within
5054 the UTF-8 data pointed to by C<s> *and* that on entry C<s> is aligned
5055 on the first byte of character or just after the last byte of a character.
5057 U8* utf8_hop(U8 *s, I32 off)
5060 Found in file utf8.c
5064 Return the length of the UTF-8 char encoded string C<s> in characters.
5065 Stops at C<e> (inclusive). If C<e E<lt> s> or if the scan would end
5066 up past C<e>, croaks.
5068 STRLEN utf8_length(U8* s, U8 *e)
5071 Found in file utf8.c
5075 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
5076 Unlike C<bytes_to_utf8>, this over-writes the original string, and
5077 updates len to contain the new length.
5078 Returns zero on failure, setting C<len> to -1.
5080 NOTE: this function is experimental and may change or be
5081 removed without notice.
5083 U8* utf8_to_bytes(U8 *s, STRLEN *len)
5086 Found in file utf8.c
5090 Returns the native character value of the first character in the string C<s>
5091 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
5092 length, in bytes, of that character.
5094 If C<s> does not point to a well-formed UTF-8 character, zero is
5095 returned and retlen is set, if possible, to -1.
5097 UV utf8_to_uvchr(U8 *s, STRLEN* retlen)
5100 Found in file utf8.c
5104 Returns the Unicode code point of the first character in the string C<s>
5105 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
5106 length, in bytes, of that character.
5108 This function should only be used when returned UV is considered
5109 an index into the Unicode semantic tables (e.g. swashes).
5111 If C<s> does not point to a well-formed UTF-8 character, zero is
5112 returned and retlen is set, if possible, to -1.
5114 UV utf8_to_uvuni(U8 *s, STRLEN* retlen)
5117 Found in file utf8.c
5121 Adds the UTF-8 representation of the Native 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 = uvchr_to_utf8(d, uv);
5128 is the recommended wide native character-aware way of saying
5132 U8* uvchr_to_utf8(U8 *d, UV uv)
5135 Found in file utf8.c
5137 =item uvuni_to_utf8_flags
5139 Adds the UTF-8 representation of the Unicode codepoint C<uv> to the end
5140 of the string C<d>; C<d> should be have at least C<UTF8_MAXLEN+1> free
5141 bytes available. The return value is the pointer to the byte after the
5142 end of the new character. In other words,
5144 d = uvuni_to_utf8_flags(d, uv, flags);
5148 d = uvuni_to_utf8(d, uv);
5150 (which is equivalent to)
5152 d = uvuni_to_utf8_flags(d, uv, 0);
5154 is the recommended Unicode-aware way of saying
5158 U8* uvuni_to_utf8_flags(U8 *d, UV uv, UV flags)
5161 Found in file utf8.c
5166 =head1 Variables created by C<xsubpp> and C<xsubpp> internal functions
5172 Variable which is setup by C<xsubpp> to indicate the stack base offset,
5173 used by the C<ST>, C<XSprePUSH> and C<XSRETURN> macros. The C<dMARK> macro
5174 must be called prior to setup the C<MARK> variable.
5179 Found in file XSUB.h
5183 Variable which is setup by C<xsubpp> to indicate the
5184 class name for a C++ XS constructor. This is always a C<char*>. See C<THIS>.
5189 Found in file XSUB.h
5193 Sets up the C<ax> variable.
5194 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
5199 Found in file XSUB.h
5203 Sets up the C<items> variable.
5204 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
5209 Found in file XSUB.h
5213 Sets up stack and mark pointers for an XSUB, calling dSP and dMARK.
5214 Sets up the C<ax> and C<items> variables by calling C<dAX> and C<dITEMS>.
5215 This is usually handled automatically by C<xsubpp>.
5220 Found in file XSUB.h
5224 Sets up the C<ix> variable for an XSUB which has aliases. This is usually
5225 handled automatically by C<xsubpp>.
5230 Found in file XSUB.h
5234 Variable which is setup by C<xsubpp> to indicate the number of
5235 items on the stack. See L<perlxs/"Variable-length Parameter Lists">.
5240 Found in file XSUB.h
5244 Variable which is setup by C<xsubpp> to indicate which of an
5245 XSUB's aliases was used to invoke it. See L<perlxs/"The ALIAS: Keyword">.
5250 Found in file XSUB.h
5254 Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
5258 Found in file XSUB.h
5262 Variable which is setup by C<xsubpp> to hold the return value for an
5263 XSUB. This is always the proper type for the XSUB. See
5264 L<perlxs/"The RETVAL Variable">.
5269 Found in file XSUB.h
5273 Used to access elements on the XSUB's stack.
5278 Found in file XSUB.h
5282 Variable which is setup by C<xsubpp> to designate the object in a C++
5283 XSUB. This is always the proper type for the C++ object. See C<CLASS> and
5284 L<perlxs/"Using XS With C++">.
5289 Found in file XSUB.h
5293 Macro to declare an XSUB and its C parameter list. This is handled by
5297 Found in file XSUB.h
5299 =item XSRETURN_EMPTY
5301 Return an empty list from an XSUB immediately.
5307 Found in file XSUB.h
5311 The version identifier for an XS module. This is usually
5312 handled automatically by C<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>.
5315 Found in file XSUB.h
5317 =item XS_VERSION_BOOTCHECK
5319 Macro to verify that a PM module's $VERSION variable matches the XS
5320 module's C<XS_VERSION> variable. This is usually handled automatically by
5321 C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">.
5323 XS_VERSION_BOOTCHECK;
5326 Found in file XSUB.h
5331 =head1 Warning and Dieing
5337 This is the XSUB-writer's interface to Perl's C<die> function.
5338 Normally use this function the same way you use the C C<printf>
5339 function. See C<warn>.
5341 If you want to throw an exception object, assign the object to
5342 C<$@> and then pass C<Nullch> to croak():
5344 errsv = get_sv("@", TRUE);
5345 sv_setsv(errsv, exception_object);
5348 void croak(const char* pat, ...)
5351 Found in file util.c
5355 This is the XSUB-writer's interface to Perl's C<warn> function. Use this
5356 function the same way you use the C C<printf> function. See
5359 void warn(const char* pat, ...)
5362 Found in file util.c
5369 Until May 1997, this document was maintained by Jeff Okamoto
5370 <okamoto@corp.hp.com>. It is now maintained as part of Perl itself.
5372 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
5373 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
5374 Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
5375 Stephen McCamant, and Gurusamy Sarathy.
5377 API Listing originally by Dean Roehrich <roehrich@cray.com>.
5379 Updated to be autogenerated from comments in the source by Benjamin Stuhl.
5383 perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
projects / p5sagit/p5-mst-13.2.git / blob