3 perlapi - autogenerated documentation for the perl public API
7 This file contains the documentation of the perl public API generated by
8 embed.pl, specifically a listing of functions, macros, flags, and variables
9 that may be used by extension writers. The interfaces of any functions that
10 are not listed here are subject to change without notice. For this reason,
11 blindly using functions listed in proto.h is to be avoided when writing
14 Note that all Perl API global variables must be referenced with the C<PL_>
15 prefix. Some macros are provided for compatibility with the older,
16 unadorned names, but this support may be disabled in a future release.
18 The listing is alphabetical, case insensitive.
27 A backward-compatible version of C<GIMME_V> which can only return
28 C<G_SCALAR> or C<G_ARRAY>; in a void context, it returns C<G_SCALAR>.
29 Deprecated. Use C<GIMME_V> instead.
38 The XSUB-writer's equivalent to Perl's C<wantarray>. Returns C<G_VOID>,
39 C<G_SCALAR> or C<G_ARRAY> for void, scalar or list context,
49 Used to indicate list context. See C<GIMME_V>, C<GIMME> and
57 Indicates that arguments returned from a callback should be discarded. See
65 Used to force a Perl C<eval> wrapper around a callback. See
73 Indicates that no arguments are being sent to a callback. See
81 Used to indicate scalar context. See C<GIMME_V>, C<GIMME>, and
89 Used to indicate void context. See C<GIMME_V> and L<perlcall>.
97 =head1 Array Manipulation Functions
103 Same as C<av_len()>. Deprecated, use C<av_len()> instead.
112 Clears an array, making it empty. Does not free the memory used by the
115 void av_clear(AV* ar)
122 Deletes the element indexed by C<key> from the array. Returns the
123 deleted element. C<flags> is currently ignored.
125 SV* av_delete(AV* ar, I32 key, I32 flags)
132 Returns true if the element indexed by C<key> has been initialized.
134 This relies on the fact that uninitialized array elements are set to
137 bool av_exists(AV* ar, I32 key)
144 Pre-extend an array. The C<key> is the index to which the array should be
147 void av_extend(AV* ar, I32 key)
154 Returns the SV at the specified index in the array. The C<key> is the
155 index. If C<lval> is set then the fetch will be part of a store. Check
156 that the return value is non-null before dereferencing it to a C<SV*>.
158 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for
159 more information on how to use this function on tied arrays.
161 SV** av_fetch(AV* ar, I32 key, I32 lval)
168 Ensure than an array has a given number of elements, equivalent to
169 Perl's C<$#array = $fill;>.
171 void av_fill(AV* ar, I32 fill)
178 Returns the highest index in the array. Returns -1 if the array is
188 Creates a new AV and populates it with a list of SVs. The SVs are copied
189 into the array, so they may be freed after the call to av_make. The new AV
190 will have a reference count of 1.
192 AV* av_make(I32 size, SV** svp)
199 Pops an SV off the end of the array. Returns C<&PL_sv_undef> if the array
209 Pushes an SV onto the end of the array. The array will grow automatically
210 to accommodate the addition.
212 void av_push(AV* ar, SV* val)
219 Shifts an SV off the beginning of the array.
228 Stores an SV in an array. The array index is specified as C<key>. The
229 return value will be NULL if the operation failed or if the value did not
230 need to be actually stored within the array (as in the case of tied
231 arrays). Otherwise it can be dereferenced to get the original C<SV*>. Note
232 that the caller is responsible for suitably incrementing the reference
233 count of C<val> before the call, and decrementing it if the function
236 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for
237 more information on how to use this function on tied arrays.
239 SV** av_store(AV* ar, I32 key, SV* val)
246 Undefines the array. Frees the memory used by the array itself.
248 void av_undef(AV* ar)
255 Unshift the given number of C<undef> values onto the beginning of the
256 array. The array will grow automatically to accommodate the addition. You
257 must then use C<av_store> to assign values to these new elements.
259 void av_unshift(AV* ar, I32 num)
266 Returns the AV of the specified Perl array. If C<create> is set and the
267 Perl variable does not exist then it will be created. If C<create> is not
268 set and the variable does not exist then NULL is returned.
270 NOTE: the perl_ form of this function is deprecated.
272 AV* get_av(const char* name, I32 create)
279 Creates a new AV. The reference count is set to 1.
296 Sort an array. Here is an example:
298 sortsv(AvARRAY(av), av_len(av)+1, Perl_sv_cmp_locale);
300 See lib/sort.pm for details about controlling the sorting algorithm.
302 void sortsv(SV ** array, size_t num_elts, SVCOMPARE_t cmp)
305 Found in file pp_sort.c
310 =head1 Callback Functions
316 Performs a callback to the specified Perl sub. See L<perlcall>.
318 NOTE: the perl_ form of this function is deprecated.
320 I32 call_argv(const char* sub_name, I32 flags, char** argv)
327 Performs a callback to the specified Perl method. The blessed object must
328 be on the stack. See L<perlcall>.
330 NOTE: the perl_ form of this function is deprecated.
332 I32 call_method(const char* methname, I32 flags)
339 Performs a callback to the specified Perl sub. See L<perlcall>.
341 NOTE: the perl_ form of this function is deprecated.
343 I32 call_pv(const char* sub_name, I32 flags)
350 Performs a callback to the Perl sub whose name is in the SV. See
353 NOTE: the perl_ form of this function is deprecated.
355 I32 call_sv(SV* sv, I32 flags)
362 Opening bracket on a callback. See C<LEAVE> and L<perlcall>.
367 Found in file scope.h
371 Tells Perl to C<eval> the given string and return an SV* result.
373 NOTE: the perl_ form of this function is deprecated.
375 SV* eval_pv(const char* p, I32 croak_on_error)
382 Tells Perl to C<eval> the string in the SV.
384 NOTE: the perl_ form of this function is deprecated.
386 I32 eval_sv(SV* sv, I32 flags)
393 Closing bracket for temporaries on a callback. See C<SAVETMPS> and
399 Found in file scope.h
403 Closing bracket on a callback. See C<ENTER> and L<perlcall>.
408 Found in file scope.h
412 Opening bracket for temporaries on a callback. See C<FREETMPS> and
418 Found in file scope.h
423 =head1 Character classes
429 Returns a boolean indicating whether the C C<char> is an ASCII alphanumeric
430 character (including underscore) or digit.
432 bool isALNUM(char ch)
435 Found in file handy.h
439 Returns a boolean indicating whether the C C<char> is an ASCII alphabetic
442 bool isALPHA(char ch)
445 Found in file handy.h
449 Returns a boolean indicating whether the C C<char> is an ASCII
452 bool isDIGIT(char ch)
455 Found in file handy.h
459 Returns a boolean indicating whether the C C<char> is a lowercase
462 bool isLOWER(char ch)
465 Found in file handy.h
469 Returns a boolean indicating whether the C C<char> is whitespace.
471 bool isSPACE(char ch)
474 Found in file handy.h
478 Returns a boolean indicating whether the C C<char> is an uppercase
481 bool isUPPER(char ch)
484 Found in file handy.h
488 Converts the specified character to lowercase.
490 char toLOWER(char ch)
493 Found in file handy.h
497 Converts the specified character to uppercase.
499 char toUPPER(char ch)
502 Found in file handy.h
507 =head1 Cloning an interpreter
513 Create and return a new interpreter by cloning the current one.
515 perl_clone takes these flags as paramters:
517 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
518 without it we only clone the data and zero the stacks,
519 with it we copy the stacks and the new perl interpreter is
520 ready to run at the exact same point as the previous one.
521 The pseudo-fork code uses COPY_STACKS while the
522 threads->new doesn't.
524 CLONEf_KEEP_PTR_TABLE
525 perl_clone keeps a ptr_table with the pointer of the old
526 variable as a key and the new variable as a value,
527 this allows it to check if something has been cloned and not
528 clone it again but rather just use the value and increase the
529 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
530 the ptr_table using the function
531 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
532 reason to keep it around is if you want to dup some of your own
533 variable who are outside the graph perl scans, example of this
534 code is in threads.xs create
537 This is a win32 thing, it is ignored on unix, it tells perls
538 win32host code (which is c++) to clone itself, this is needed on
539 win32 if you want to run two threads at the same time,
540 if you just want to do some stuff in a separate perl interpreter
541 and then throw it away and return to the original one,
542 you don't need to do anything.
544 PerlInterpreter* perl_clone(PerlInterpreter* interp, UV flags)
552 =head1 CV Manipulation Functions
558 Returns the stash of the CV.
567 Returns the CV of the specified Perl subroutine. If C<create> is set and
568 the Perl subroutine does not exist then it will be declared (which has the
569 same effect as saying C<sub name;>). If C<create> is not set and the
570 subroutine does not exist then NULL is returned.
572 NOTE: the perl_ form of this function is deprecated.
574 CV* get_cv(const char* name, I32 create)
590 =head1 Embedding Functions
596 Clear out all the active components of a CV. This can happen either
597 by an explicit C<undef &foo>, or by the reference count going to zero.
598 In the former case, we keep the CvOUTSIDE pointer, so that any anonymous
599 children can still follow the full lexical scope chain.
601 void cv_undef(CV* cv)
608 Loads the module whose name is pointed to by the string part of name.
609 Note that the actual module name, not its filename, should be given.
610 Eg, "Foo::Bar" instead of "Foo/Bar.pm". flags can be any of
611 PERL_LOADMOD_DENY, PERL_LOADMOD_NOIMPORT, or PERL_LOADMOD_IMPORT_OPS
612 (or 0 for no flags). ver, if specified, provides version semantics
613 similar to C<use Foo::Bar VERSION>. The optional trailing SV*
614 arguments can be used to specify arguments to the module's import()
615 method, similar to C<use Foo::Bar VERSION LIST>.
617 void load_module(U32 flags, SV* name, SV* ver, ...)
624 Stub that provides thread hook for perl_destruct when there are
634 Allocates a new Perl interpreter. See L<perlembed>.
636 PerlInterpreter* perl_alloc()
643 Initializes a new Perl interpreter. See L<perlembed>.
645 void perl_construct(PerlInterpreter* interp)
652 Shuts down a Perl interpreter. See L<perlembed>.
654 int perl_destruct(PerlInterpreter* interp)
661 Releases a Perl interpreter. See L<perlembed>.
663 void perl_free(PerlInterpreter* interp)
670 Tells a Perl interpreter to parse a Perl script. See L<perlembed>.
672 int perl_parse(PerlInterpreter* interp, XSINIT_t xsinit, int argc, char** argv, char** env)
679 Tells a Perl interpreter to run. See L<perlembed>.
681 int perl_run(PerlInterpreter* interp)
688 Tells Perl to C<require> the file named by the string argument. It is
689 analogous to the Perl code C<eval "require '$file'">. It's even
690 implemented that way; consider using load_module instead.
692 NOTE: the perl_ form of this function is deprecated.
694 void require_pv(const char* pv)
702 =head1 Functions in file pp_pack.c
709 The engine implementing pack() Perl function.
711 void packlist(SV *cat, char *pat, char *patend, SV **beglist, SV **endlist)
714 Found in file pp_pack.c
718 The engine implementing pack() Perl function. Note: parameters next_in_list and
719 flags are not used. This call should not be used; use packlist instead.
721 void pack_cat(SV *cat, char *pat, char *patend, SV **beglist, SV **endlist, SV ***next_in_list, U32 flags)
724 Found in file pp_pack.c
728 The engine implementing unpack() Perl function.
730 I32 unpackstring(char *pat, char *patend, char *s, char *strend, U32 flags)
733 Found in file pp_pack.c
737 The engine implementing unpack() Perl function. Note: parameters strbeg, new_s
738 and ocnt are not used. This call should not be used, use unpackstring instead.
740 I32 unpack_str(char *pat, char *patend, char *s, char *strbeg, char *strend, char **new_s, I32 ocnt, U32 flags)
743 Found in file pp_pack.c
748 =head1 Global Variables
754 C<PL_modglobal> is a general purpose, interpreter global HV for use by
755 extensions that need to keep information on a per-interpreter basis.
756 In a pinch, it can also be used as a symbol table for extensions
757 to share data among each other. It is a good idea to use keys
758 prefixed by the package name of the extension that owns the data.
763 Found in file intrpvar.h
767 A convenience variable which is typically used with C<SvPV> when one
768 doesn't care about the length of the string. It is usually more efficient
769 to either declare a local variable and use that instead or to use the
775 Found in file thrdvar.h
779 This is the C<false> SV. See C<PL_sv_yes>. Always refer to this as
785 Found in file intrpvar.h
789 This is the C<undef> SV. Always refer to this as C<&PL_sv_undef>.
794 Found in file intrpvar.h
798 This is the C<true> SV. See C<PL_sv_no>. Always refer to this as
804 Found in file intrpvar.h
815 Return the SV from the GV.
824 Returns the glob with the given C<name> and a defined subroutine or
825 C<NULL>. The glob lives in the given C<stash>, or in the stashes
826 accessible via @ISA and UNIVERSAL::.
828 The argument C<level> should be either 0 or -1. If C<level==0>, as a
829 side-effect creates a glob with the given C<name> in the given C<stash>
830 which in the case of success contains an alias for the subroutine, and sets
831 up caching info for this glob. Similarly for all the searched stashes.
833 This function grants C<"SUPER"> token as a postfix of the stash name. The
834 GV returned from C<gv_fetchmeth> may be a method cache entry, which is not
835 visible to Perl code. So when calling C<call_sv>, you should not use
836 the GV directly; instead, you should use the method's CV, which can be
837 obtained from the GV with the C<GvCV> macro.
839 GV* gv_fetchmeth(HV* stash, const char* name, STRLEN len, I32 level)
846 See L<gv_fetchmethod_autoload>.
848 GV* gv_fetchmethod(HV* stash, const char* name)
853 =item gv_fetchmethod_autoload
855 Returns the glob which contains the subroutine to call to invoke the method
856 on the C<stash>. In fact in the presence of autoloading this may be the
857 glob for "AUTOLOAD". In this case the corresponding variable $AUTOLOAD is
860 The third parameter of C<gv_fetchmethod_autoload> determines whether
861 AUTOLOAD lookup is performed if the given method is not present: non-zero
862 means yes, look for AUTOLOAD; zero means no, don't look for AUTOLOAD.
863 Calling C<gv_fetchmethod> is equivalent to calling C<gv_fetchmethod_autoload>
864 with a non-zero C<autoload> parameter.
866 These functions grant C<"SUPER"> token as a prefix of the method name. Note
867 that if you want to keep the returned glob for a long time, you need to
868 check for it being "AUTOLOAD", since at the later time the call may load a
869 different subroutine due to $AUTOLOAD changing its value. Use the glob
870 created via a side effect to do this.
872 These functions have the same side-effects and as C<gv_fetchmeth> with
873 C<level==0>. C<name> should be writable if contains C<':'> or C<'
874 ''>. The warning against passing the GV returned by C<gv_fetchmeth> to
875 C<call_sv> apply equally to these functions.
877 GV* gv_fetchmethod_autoload(HV* stash, const char* name, I32 autoload)
882 =item gv_fetchmeth_autoload
884 Same as gv_fetchmeth(), but looks for autoloaded subroutines too.
885 Returns a glob for the subroutine.
887 For an autoloaded subroutine without a GV, will create a GV even
888 if C<level < 0>. For an autoloaded subroutine without a stub, GvCV()
889 of the result may be zero.
891 GV* gv_fetchmeth_autoload(HV* stash, const char* name, STRLEN len, I32 level)
898 Returns a pointer to the stash for a specified package. C<name> should
899 be a valid UTF-8 string. If C<create> is set then the package will be
900 created if it does not already exist. If C<create> is not set and the
901 package does not exist then NULL is returned.
903 HV* gv_stashpv(const char* name, I32 create)
910 Returns a pointer to the stash for a specified package, which must be a
911 valid UTF-8 string. See C<gv_stashpv>.
913 HV* gv_stashsv(SV* sv, I32 create)
927 This flag, used in the length slot of hash entries and magic structures,
928 specifies the structure contains an C<SV*> pointer where a C<char*> pointer
929 is to be expected. (For information only--not to be used).
937 Null character pointer.
940 Found in file handy.h
947 Found in file handy.h
952 =head1 Hash Manipulation Functions
958 Returns the HV of the specified Perl hash. If C<create> is set and the
959 Perl variable does not exist then it will be created. If C<create> is not
960 set and the variable does not exist then NULL is returned.
962 NOTE: the perl_ form of this function is deprecated.
964 HV* get_hv(const char* name, I32 create)
971 Returns the computed hash stored in the hash entry.
980 Returns the actual pointer stored in the key slot of the hash entry. The
981 pointer may be either C<char*> or C<SV*>, depending on the value of
982 C<HeKLEN()>. Can be assigned to. The C<HePV()> or C<HeSVKEY()> macros are
983 usually preferable for finding the value of a key.
992 If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry
993 holds an C<SV*> key. Otherwise, holds the actual length of the key. Can
994 be assigned to. The C<HePV()> macro is usually preferable for finding key
997 STRLEN HeKLEN(HE* he)
1004 Returns the key slot of the hash entry as a C<char*> value, doing any
1005 necessary dereferencing of possibly C<SV*> keys. The length of the string
1006 is placed in C<len> (this is a macro, so do I<not> use C<&len>). If you do
1007 not care about what the length of the key is, you may use the global
1008 variable C<PL_na>, though this is rather less efficient than using a local
1009 variable. Remember though, that hash keys in perl are free to contain
1010 embedded nulls, so using C<strlen()> or similar is not a good way to find
1011 the length of hash keys. This is very similar to the C<SvPV()> macro
1012 described elsewhere in this document.
1014 char* HePV(HE* he, STRLEN len)
1021 Returns the key as an C<SV*>, or C<Nullsv> if the hash entry does not
1022 contain an C<SV*> key.
1031 Returns the key as an C<SV*>. Will create and return a temporary mortal
1032 C<SV*> if the hash entry contains only a C<char*> key.
1034 SV* HeSVKEY_force(HE* he)
1041 Sets the key to a given C<SV*>, taking care to set the appropriate flags to
1042 indicate the presence of an C<SV*> key, and returns the same
1045 SV* HeSVKEY_set(HE* he, SV* sv)
1052 Returns the value slot (type C<SV*>) stored in the hash entry.
1061 Returns the package name of a stash. See C<SvSTASH>, C<CvSTASH>.
1063 char* HvNAME(HV* stash)
1070 Clears a hash, making it empty.
1072 void hv_clear(HV* tb)
1079 Deletes a key/value pair in the hash. The value SV is removed from the
1080 hash and returned to the caller. The C<klen> is the length of the key.
1081 The C<flags> value will normally be zero; if set to G_DISCARD then NULL
1084 SV* hv_delete(HV* tb, const char* key, I32 klen, I32 flags)
1091 Deletes a key/value pair in the hash. The value SV is removed from the
1092 hash and returned to the caller. The C<flags> value will normally be zero;
1093 if set to G_DISCARD then NULL will be returned. C<hash> can be a valid
1094 precomputed hash value, or 0 to ask for it to be computed.
1096 SV* hv_delete_ent(HV* tb, SV* key, I32 flags, U32 hash)
1103 Returns a boolean indicating whether the specified hash key exists. The
1104 C<klen> is the length of the key.
1106 bool hv_exists(HV* tb, const char* key, I32 klen)
1113 Returns a boolean indicating whether the specified hash key exists. C<hash>
1114 can be a valid precomputed hash value, or 0 to ask for it to be
1117 bool hv_exists_ent(HV* tb, SV* key, U32 hash)
1124 Returns the SV which corresponds to the specified key in the hash. The
1125 C<klen> is the length of the key. If C<lval> is set then the fetch will be
1126 part of a store. Check that the return value is non-null before
1127 dereferencing it to an C<SV*>.
1129 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1130 information on how to use this function on tied hashes.
1132 SV** hv_fetch(HV* tb, const char* key, I32 klen, I32 lval)
1139 Returns the hash entry which corresponds to the specified key in the hash.
1140 C<hash> must be a valid precomputed hash number for the given C<key>, or 0
1141 if you want the function to compute it. IF C<lval> is set then the fetch
1142 will be part of a store. Make sure the return value is non-null before
1143 accessing it. The return value when C<tb> is a tied hash is a pointer to a
1144 static location, so be sure to make a copy of the structure if you need to
1147 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1148 information on how to use this function on tied hashes.
1150 HE* hv_fetch_ent(HV* tb, SV* key, I32 lval, U32 hash)
1157 Prepares a starting point to traverse a hash table. Returns the number of
1158 keys in the hash (i.e. the same as C<HvKEYS(tb)>). The return value is
1159 currently only meaningful for hashes without tie magic.
1161 NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
1162 hash buckets that happen to be in use. If you still need that esoteric
1163 value, you can get it through the macro C<HvFILL(tb)>.
1166 I32 hv_iterinit(HV* tb)
1173 Returns the key from the current position of the hash iterator. See
1176 char* hv_iterkey(HE* entry, I32* retlen)
1183 Returns the key as an C<SV*> from the current position of the hash
1184 iterator. The return value will always be a mortal copy of the key. Also
1187 SV* hv_iterkeysv(HE* entry)
1194 Returns entries from a hash iterator. See C<hv_iterinit>.
1196 You may call C<hv_delete> or C<hv_delete_ent> on the hash entry that the
1197 iterator currently points to, without losing your place or invalidating your
1198 iterator. Note that in this case the current entry is deleted from the hash
1199 with your iterator holding the last reference to it. Your iterator is flagged
1200 to free the entry on the next call to C<hv_iternext>, so you must not discard
1201 your iterator immediately else the entry will leak - call C<hv_iternext> to
1202 trigger the resource deallocation.
1204 HE* hv_iternext(HV* tb)
1211 Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
1214 SV* hv_iternextsv(HV* hv, char** key, I32* retlen)
1219 =item hv_iternext_flags
1221 Returns entries from a hash iterator. See C<hv_iterinit> and C<hv_iternext>.
1222 The C<flags> value will normally be zero; if HV_ITERNEXT_WANTPLACEHOLDERS is
1223 set the placeholders keys (for restricted hashes) will be returned in addition
1224 to normal keys. By default placeholders are automatically skipped over.
1225 Currently a placeholder is implemented with a value that is literally
1226 <&Perl_sv_undef> (a regular C<undef> value is a normal read-write SV for which
1227 C<!SvOK> is false). Note that the implementation of placeholders and
1228 restricted hashes may change, and the implementation currently is
1229 insufficiently abstracted for any change to be tidy.
1231 NOTE: this function is experimental and may change or be
1232 removed without notice.
1234 HE* hv_iternext_flags(HV* tb, I32 flags)
1241 Returns the value from the current position of the hash iterator. See
1244 SV* hv_iterval(HV* tb, HE* entry)
1251 Adds magic to a hash. See C<sv_magic>.
1253 void hv_magic(HV* hv, GV* gv, int how)
1260 Stores an SV in a hash. The hash key is specified as C<key> and C<klen> is
1261 the length of the key. The C<hash> parameter is the precomputed hash
1262 value; if it is zero then Perl will compute it. The return value will be
1263 NULL if the operation failed or if the value did not need to be actually
1264 stored within the hash (as in the case of tied hashes). Otherwise it can
1265 be dereferenced to get the original C<SV*>. Note that the caller is
1266 responsible for suitably incrementing the reference count of C<val> before
1267 the call, and decrementing it if the function returned NULL. Effectively
1268 a successful hv_store takes ownership of one reference to C<val>. This is
1269 usually what you want; a newly created SV has a reference count of one, so
1270 if all your code does is create SVs then store them in a hash, hv_store
1271 will own the only reference to the new SV, and your code doesn't need to do
1272 anything further to tidy up. hv_store is not implemented as a call to
1273 hv_store_ent, and does not create a temporary SV for the key, so if your
1274 key data is not already in SV form then use hv_store in preference to
1277 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1278 information on how to use this function on tied hashes.
1280 SV** hv_store(HV* tb, const char* key, I32 klen, SV* val, U32 hash)
1287 Stores C<val> in a hash. The hash key is specified as C<key>. The C<hash>
1288 parameter is the precomputed hash value; if it is zero then Perl will
1289 compute it. The return value is the new hash entry so created. It will be
1290 NULL if the operation failed or if the value did not need to be actually
1291 stored within the hash (as in the case of tied hashes). Otherwise the
1292 contents of the return value can be accessed using the C<He?> macros
1293 described here. Note that the caller is responsible for suitably
1294 incrementing the reference count of C<val> before the call, and
1295 decrementing it if the function returned NULL. Effectively a successful
1296 hv_store_ent takes ownership of one reference to C<val>. This is
1297 usually what you want; a newly created SV has a reference count of one, so
1298 if all your code does is create SVs then store them in a hash, hv_store
1299 will own the only reference to the new SV, and your code doesn't need to do
1300 anything further to tidy up. Note that hv_store_ent only reads the C<key>;
1301 unlike C<val> it does not take ownership of it, so maintaining the correct
1302 reference count on C<key> is entirely the caller's responsibility. hv_store
1303 is not implemented as a call to hv_store_ent, and does not create a temporary
1304 SV for the key, so if your key data is not already in SV form then use
1305 hv_store in preference to hv_store_ent.
1307 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1308 information on how to use this function on tied hashes.
1310 HE* hv_store_ent(HV* tb, SV* key, SV* val, U32 hash)
1319 void hv_undef(HV* tb)
1326 Creates a new HV. The reference count is set to 1.
1344 =head1 Magical Functions
1350 Clear something magical that the SV represents. See C<sv_magic>.
1352 int mg_clear(SV* sv)
1359 Copies the magic from one SV to another. See C<sv_magic>.
1361 int mg_copy(SV* sv, SV* nsv, const char* key, I32 klen)
1368 Finds the magic pointer for type matching the SV. See C<sv_magic>.
1370 MAGIC* mg_find(SV* sv, int type)
1377 Free any magic storage used by the SV. See C<sv_magic>.
1386 Do magic after a value is retrieved from the SV. See C<sv_magic>.
1395 Report on the SV's length. See C<sv_magic>.
1397 U32 mg_length(SV* sv)
1404 Turns on the magical status of an SV. See C<sv_magic>.
1406 void mg_magical(SV* sv)
1413 Do magic after a value is assigned to the SV. See C<sv_magic>.
1422 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
1423 argument more than once.
1425 void SvGETMAGIC(SV* sv)
1432 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
1442 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
1443 argument more than once.
1445 void SvSETMAGIC(SV* sv)
1452 Like C<SvSetSV>, but does any set magic required afterwards.
1454 void SvSetMagicSV(SV* dsb, SV* ssv)
1459 =item SvSetMagicSV_nosteal
1461 Like C<SvSetMagicSV>, but does any set magic required afterwards.
1463 void SvSetMagicSV_nosteal(SV* dsv, SV* ssv)
1470 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
1473 void SvSetSV(SV* dsb, SV* ssv)
1478 =item SvSetSV_nosteal
1480 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
1481 ssv. May evaluate arguments more than once.
1483 void SvSetSV_nosteal(SV* dsv, SV* ssv)
1490 Arranges for sv to be shared between threads if a suitable module
1493 void SvSHARE(SV* sv)
1501 =head1 Memory Management
1507 The XSUB-writer's interface to the C C<memcpy> function. The C<src> is the
1508 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1509 the type. May fail on overlapping copies. See also C<Move>.
1511 void Copy(void* src, void* dest, int nitems, type)
1514 Found in file handy.h
1518 The XSUB-writer's interface to the C C<memmove> function. The C<src> is the
1519 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1520 the type. Can do overlapping moves. See also C<Copy>.
1522 void Move(void* src, void* dest, int nitems, type)
1525 Found in file handy.h
1529 The XSUB-writer's interface to the C C<malloc> function.
1531 void New(int id, void* ptr, int nitems, type)
1534 Found in file handy.h
1538 The XSUB-writer's interface to the C C<malloc> function, with
1541 void Newc(int id, void* ptr, int nitems, type, cast)
1544 Found in file handy.h
1548 Creates a new SV. A non-zero C<len> parameter indicates the number of
1549 bytes of preallocated string space the SV should have. An extra byte for a
1550 tailing NUL is also reserved. (SvPOK is not set for the SV even if string
1551 space is allocated.) The reference count for the new SV is set to 1.
1552 C<id> is an integer id between 0 and 1299 (used to identify leaks).
1555 SV* NEWSV(int id, STRLEN len)
1558 Found in file handy.h
1562 The XSUB-writer's interface to the C C<malloc> function. The allocated
1563 memory is zeroed with C<memzero>.
1565 void Newz(int id, void* ptr, int nitems, type)
1568 Found in file handy.h
1572 Fill up memory with a pattern (byte 0xAB over and over again) that
1573 hopefully catches attempts to access uninitialized memory.
1575 void Poison(void* dest, int nitems, type)
1578 Found in file handy.h
1582 The XSUB-writer's interface to the C C<realloc> function.
1584 void Renew(void* ptr, int nitems, type)
1587 Found in file handy.h
1591 The XSUB-writer's interface to the C C<realloc> function, with
1594 void Renewc(void* ptr, int nitems, type, cast)
1597 Found in file handy.h
1601 The XSUB-writer's interface to the C C<free> function.
1603 void Safefree(void* ptr)
1606 Found in file handy.h
1610 Perl's version of C<strdup()>. Returns a pointer to a newly allocated
1611 string which is a duplicate of C<pv>. The size of the string is
1612 determined by C<strlen()>. The memory allocated for the new string can
1613 be freed with the C<Safefree()> function.
1615 char* savepv(const char* pv)
1618 Found in file util.c
1622 Perl's version of what C<strndup()> would be if it existed. Returns a
1623 pointer to a newly allocated string which is a duplicate of the first
1624 C<len> bytes from C<pv>. The memory allocated for the new string can be
1625 freed with the C<Safefree()> function.
1627 char* savepvn(const char* pv, I32 len)
1630 Found in file util.c
1634 A version of C<savepv()> which allocates the duplicate string in memory
1635 which is shared between threads.
1637 char* savesharedpv(const char* pv)
1640 Found in file util.c
1644 This is an architecture-independent macro to copy one structure to another.
1646 void StructCopy(type src, type dest, type)
1649 Found in file handy.h
1653 The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the
1654 destination, C<nitems> is the number of items, and C<type> is the type.
1656 void Zero(void* dest, int nitems, type)
1659 Found in file handy.h
1664 =head1 Miscellaneous Functions
1670 Analyses the string in order to make fast searches on it using fbm_instr()
1671 -- the Boyer-Moore algorithm.
1673 void fbm_compile(SV* sv, U32 flags)
1676 Found in file util.c
1680 Returns the location of the SV in the string delimited by C<str> and
1681 C<strend>. It returns C<Nullch> if the string can't be found. The C<sv>
1682 does not have to be fbm_compiled, but the search will not be as fast
1685 char* fbm_instr(unsigned char* big, unsigned char* bigend, SV* littlesv, U32 flags)
1688 Found in file util.c
1692 Takes a sprintf-style format pattern and conventional
1693 (non-SV) arguments and returns the formatted string.
1695 (char *) Perl_form(pTHX_ const char* pat, ...)
1697 can be used any place a string (char *) is required:
1699 char * s = Perl_form("%d.%d",major,minor);
1701 Uses a single private buffer so if you want to format several strings you
1702 must explicitly copy the earlier strings away (and free the copies when you
1705 char* form(const char* pat, ...)
1708 Found in file util.c
1712 Fill the sv with current working directory
1714 int getcwd_sv(SV* sv)
1717 Found in file util.c
1721 Test two strings to see if they are equal. Returns true or false.
1723 bool strEQ(char* s1, char* s2)
1726 Found in file handy.h
1730 Test two strings to see if the first, C<s1>, is greater than or equal to
1731 the second, C<s2>. Returns true or false.
1733 bool strGE(char* s1, char* s2)
1736 Found in file handy.h
1740 Test two strings to see if the first, C<s1>, is greater than the second,
1741 C<s2>. Returns true or false.
1743 bool strGT(char* s1, char* s2)
1746 Found in file handy.h
1750 Test two strings to see if the first, C<s1>, is less than or equal to the
1751 second, C<s2>. Returns true or false.
1753 bool strLE(char* s1, char* s2)
1756 Found in file handy.h
1760 Test two strings to see if the first, C<s1>, is less than the second,
1761 C<s2>. Returns true or false.
1763 bool strLT(char* s1, char* s2)
1766 Found in file handy.h
1770 Test two strings to see if they are different. Returns true or
1773 bool strNE(char* s1, char* s2)
1776 Found in file handy.h
1780 Test two strings to see if they are equal. The C<len> parameter indicates
1781 the number of bytes to compare. Returns true or false. (A wrapper for
1784 bool strnEQ(char* s1, char* s2, STRLEN len)
1787 Found in file handy.h
1791 Test two strings to see if they are different. The C<len> parameter
1792 indicates the number of bytes to compare. Returns true or false. (A
1793 wrapper for C<strncmp>).
1795 bool strnNE(char* s1, char* s2, STRLEN len)
1798 Found in file handy.h
1803 =head1 Numeric functions
1809 converts a string representing a binary number to numeric form.
1811 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
1812 conversion flags, and I<result> should be NULL or a pointer to an NV.
1813 The scan stops at the end of the string, or the first invalid character.
1814 On return I<*len> is set to the length scanned string, and I<*flags> gives
1817 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
1818 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_bin>
1819 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
1820 and writes the value to I<*result> (or the value is discarded if I<result>
1823 The hex number may optionally be prefixed with "0b" or "b" unless
1824 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
1825 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the binary
1826 number may use '_' characters to separate digits.
1828 UV grok_bin(char* start, STRLEN* len, I32* flags, NV *result)
1831 Found in file numeric.c
1835 converts a string representing a hex number to numeric form.
1837 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
1838 conversion flags, and I<result> should be NULL or a pointer to an NV.
1839 The scan stops at the end of the string, or the first non-hex-digit character.
1840 On return I<*len> is set to the length scanned string, and I<*flags> gives
1843 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
1844 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_hex>
1845 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
1846 and writes the value to I<*result> (or the value is discarded if I<result>
1849 The hex number may optionally be prefixed with "0x" or "x" unless
1850 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
1851 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the hex
1852 number may use '_' characters to separate digits.
1854 UV grok_hex(char* start, STRLEN* len, I32* flags, NV *result)
1857 Found in file numeric.c
1861 Recognise (or not) a number. The type of the number is returned
1862 (0 if unrecognised), otherwise it is a bit-ORed combination of
1863 IS_NUMBER_IN_UV, IS_NUMBER_GREATER_THAN_UV_MAX, IS_NUMBER_NOT_INT,
1864 IS_NUMBER_NEG, IS_NUMBER_INFINITY, IS_NUMBER_NAN (defined in perl.h).
1866 If the value of the number can fit an in UV, it is returned in the *valuep
1867 IS_NUMBER_IN_UV will be set to indicate that *valuep is valid, IS_NUMBER_IN_UV
1868 will never be set unless *valuep is valid, but *valuep may have been assigned
1869 to during processing even though IS_NUMBER_IN_UV is not set on return.
1870 If valuep is NULL, IS_NUMBER_IN_UV will be set for the same cases as when
1871 valuep is non-NULL, but no actual assignment (or SEGV) will occur.
1873 IS_NUMBER_NOT_INT will be set with IS_NUMBER_IN_UV if trailing decimals were
1874 seen (in which case *valuep gives the true value truncated to an integer), and
1875 IS_NUMBER_NEG if the number is negative (in which case *valuep holds the
1876 absolute value). IS_NUMBER_IN_UV is not set if e notation was used or the
1877 number is larger than a UV.
1879 int grok_number(const char *pv, STRLEN len, UV *valuep)
1882 Found in file numeric.c
1884 =item grok_numeric_radix
1886 Scan and skip for a numeric decimal separator (radix).
1888 bool grok_numeric_radix(const char **sp, const char *send)
1891 Found in file numeric.c
1896 UV grok_oct(char* start, STRLEN* len, I32* flags, NV *result)
1899 Found in file numeric.c
1903 For backwards compatibility. Use C<grok_bin> instead.
1905 NV scan_bin(char* start, STRLEN len, STRLEN* retlen)
1908 Found in file numeric.c
1912 For backwards compatibility. Use C<grok_hex> instead.
1914 NV scan_hex(char* start, STRLEN len, STRLEN* retlen)
1917 Found in file numeric.c
1921 For backwards compatibility. Use C<grok_oct> instead.
1923 NV scan_oct(char* start, STRLEN len, STRLEN* retlen)
1926 Found in file numeric.c
1931 =head1 Optree Manipulation Functions
1937 If C<cv> is a constant sub eligible for inlining. returns the constant
1938 value returned by the sub. Otherwise, returns NULL.
1940 Constant subs can be created with C<newCONSTSUB> or as described in
1941 L<perlsub/"Constant Functions">.
1943 SV* cv_const_sv(CV* cv)
1950 Creates a constant sub equivalent to Perl C<sub FOO () { 123 }> which is
1951 eligible for inlining at compile-time.
1953 CV* newCONSTSUB(HV* stash, char* name, SV* sv)
1960 Used by C<xsubpp> to hook up XSUBs as Perl subs.
1968 =head1 Pad Data Structures
1974 Get the value at offset po in the current pad.
1975 Use macro PAD_SV instead of calling this function directly.
1977 SV* pad_sv(PADOFFSET po)
1985 =head1 Stack Manipulation Macros
1991 Declare a stack marker variable, C<mark>, for the XSUB. See C<MARK> and
2001 Saves the original stack mark for the XSUB. See C<ORIGMARK>.
2010 Declares a local copy of perl's stack pointer for the XSUB, available via
2011 the C<SP> macro. See C<SP>.
2020 Used to extend the argument stack for an XSUB's return values. Once
2021 used, guarantees that there is room for at least C<nitems> to be pushed
2024 void EXTEND(SP, int nitems)
2031 Stack marker variable for the XSUB. See C<dMARK>.
2038 The original stack mark for the XSUB. See C<dORIGMARK>.
2045 Pops an integer off the stack.
2054 Pops a long off the stack.
2063 Pops a double off the stack.
2072 Pops a string off the stack. Deprecated. New code should provide
2073 a STRLEN n_a and use POPpx.
2082 Pops a string off the stack which must consist of bytes i.e. characters < 256.
2083 Requires a variable STRLEN n_a in scope.
2092 Pops a string off the stack.
2093 Requires a variable STRLEN n_a in scope.
2102 Pops an SV off the stack.
2111 Push an integer onto the stack. The stack must have room for this element.
2112 Handles 'set' magic. See C<XPUSHi>.
2121 Opening bracket for arguments on a callback. See C<PUTBACK> and
2131 Push a double onto the stack. The stack must have room for this element.
2132 Handles 'set' magic. See C<XPUSHn>.
2141 Push a string onto the stack. The stack must have room for this element.
2142 The C<len> indicates the length of the string. Handles 'set' magic. See
2145 void PUSHp(char* str, STRLEN len)
2152 Push an SV onto the stack. The stack must have room for this element.
2153 Does not handle 'set' magic. See C<XPUSHs>.
2162 Push an unsigned integer onto the stack. The stack must have room for this
2163 element. See C<XPUSHu>.
2172 Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
2173 See C<PUSHMARK> and L<perlcall> for other uses.
2182 Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and
2190 Refetch the stack pointer. Used after a callback. See L<perlcall>.
2199 Push an integer onto the stack, extending the stack if necessary. Handles
2200 'set' magic. See C<PUSHi>.
2209 Push a double onto the stack, extending the stack if necessary. Handles
2210 'set' magic. See C<PUSHn>.
2219 Push a string onto the stack, extending the stack if necessary. The C<len>
2220 indicates the length of the string. Handles 'set' magic. See
2223 void XPUSHp(char* str, STRLEN len)
2230 Push an SV onto the stack, extending the stack if necessary. Does not
2231 handle 'set' magic. See C<PUSHs>.
2240 Push an unsigned integer onto the stack, extending the stack if necessary.
2250 Return from XSUB, indicating number of items on the stack. This is usually
2251 handled by C<xsubpp>.
2253 void XSRETURN(int nitems)
2256 Found in file XSUB.h
2260 Return an integer from an XSUB immediately. Uses C<XST_mIV>.
2262 void XSRETURN_IV(IV iv)
2265 Found in file XSUB.h
2269 Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
2274 Found in file XSUB.h
2278 Return a double from an XSUB immediately. Uses C<XST_mNV>.
2280 void XSRETURN_NV(NV nv)
2283 Found in file XSUB.h
2287 Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
2289 void XSRETURN_PV(char* str)
2292 Found in file XSUB.h
2294 =item XSRETURN_UNDEF
2296 Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
2301 Found in file XSUB.h
2305 Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
2310 Found in file XSUB.h
2314 Place an integer into the specified position C<pos> on the stack. The
2315 value is stored in a new mortal SV.
2317 void XST_mIV(int pos, IV iv)
2320 Found in file XSUB.h
2324 Place C<&PL_sv_no> into the specified position C<pos> on the
2327 void XST_mNO(int pos)
2330 Found in file XSUB.h
2334 Place a double into the specified position C<pos> on the stack. The value
2335 is stored in a new mortal SV.
2337 void XST_mNV(int pos, NV nv)
2340 Found in file XSUB.h
2344 Place a copy of a string into the specified position C<pos> on the stack.
2345 The value is stored in a new mortal SV.
2347 void XST_mPV(int pos, char* str)
2350 Found in file XSUB.h
2354 Place C<&PL_sv_undef> into the specified position C<pos> on the
2357 void XST_mUNDEF(int pos)
2360 Found in file XSUB.h
2364 Place C<&PL_sv_yes> into the specified position C<pos> on the
2367 void XST_mYES(int pos)
2370 Found in file XSUB.h
2381 An enum of flags for Perl types. These are found in the file B<sv.h>
2382 in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
2389 Integer type flag for scalars. See C<svtype>.
2396 Double type flag for scalars. See C<svtype>.
2403 Pointer type flag for scalars. See C<svtype>.
2410 Type flag for arrays. See C<svtype>.
2417 Type flag for code refs. See C<svtype>.
2424 Type flag for hashes. See C<svtype>.
2431 Type flag for blessed scalars. See C<svtype>.
2439 =head1 SV Manipulation Functions
2445 Returns the SV of the specified Perl scalar. If C<create> is set and the
2446 Perl variable does not exist then it will be created. If C<create> is not
2447 set and the variable does not exist then NULL is returned.
2449 NOTE: the perl_ form of this function is deprecated.
2451 SV* get_sv(const char* name, I32 create)
2454 Found in file perl.c
2456 =item looks_like_number
2458 Test if the content of an SV looks like a number (or is a number).
2459 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
2460 non-numeric warning), even if your atof() doesn't grok them.
2462 I32 looks_like_number(SV* sv)
2469 Creates an RV wrapper for an SV. The reference count for the original SV is
2472 SV* newRV_inc(SV* sv)
2479 Creates an RV wrapper for an SV. The reference count for the original
2480 SV is B<not> incremented.
2482 SV* newRV_noinc(SV *sv)
2489 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
2490 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
2493 SV* newSV(STRLEN len)
2500 Creates a new SV and copies an integer into it. The reference count for the
2510 Creates a new SV and copies a floating point value into it.
2511 The reference count for the SV is set to 1.
2520 Creates a new SV and copies a string into it. The reference count for the
2521 SV is set to 1. If C<len> is zero, Perl will compute the length using
2522 strlen(). For efficiency, consider using C<newSVpvn> instead.
2524 SV* newSVpv(const char* s, STRLEN len)
2531 Creates a new SV and initializes it with the string formatted like
2534 SV* newSVpvf(const char* pat, ...)
2541 Creates a new SV and copies a string into it. The reference count for the
2542 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
2543 string. You are responsible for ensuring that the source string is at least
2546 SV* newSVpvn(const char* s, STRLEN len)
2551 =item newSVpvn_share
2553 Creates a new SV with its SvPVX pointing to a shared string in the string
2554 table. If the string does not already exist in the table, it is created
2555 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
2556 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
2557 otherwise the hash is computed. The idea here is that as the string table
2558 is used for shared hash keys these strings will have SvPVX == HeKEY and
2559 hash lookup will avoid string compare.
2561 SV* newSVpvn_share(const char* s, I32 len, U32 hash)
2568 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
2569 it will be upgraded to one. If C<classname> is non-null then the new SV will
2570 be blessed in the specified package. The new SV is returned and its
2571 reference count is 1.
2573 SV* newSVrv(SV* rv, const char* classname)
2580 Creates a new SV which is an exact duplicate of the original SV.
2583 SV* newSVsv(SV* old)
2590 Creates a new SV and copies an unsigned integer into it.
2591 The reference count for the SV is set to 1.
2600 Returns a new version object based on the passed in SV:
2602 SV *sv = new_version(SV *ver);
2604 Does not alter the passed in ver SV. See "upg_version" if you
2605 want to upgrade the SV.
2607 SV* new_version(SV *ver)
2610 Found in file util.c
2614 Returns a pointer to the next character after the parsed
2615 version string, as well as upgrading the passed in SV to
2618 Function must be called with an already existing SV like
2621 s = scan_version(s,sv);
2623 Performs some preprocessing to the string to ensure that
2624 it has the correct characteristics of a version. Flags the
2625 object if it contains an underscore (which denotes this
2628 char* scan_version(char *vstr, SV *sv)
2631 Found in file util.c
2635 Returns a pointer to the next character after the parsed
2636 vstring, as well as updating the passed in sv.
2638 Function must be called like
2641 s = scan_vstring(s,sv);
2643 The sv should already be large enough to store the vstring
2644 passed in, for performance reasons.
2646 char* scan_vstring(char *vstr, SV *sv)
2649 Found in file util.c
2653 Returns the length of the string which is in the SV. See C<SvLEN>.
2655 STRLEN SvCUR(SV* sv)
2662 Set the length of the string which is in the SV. See C<SvCUR>.
2664 void SvCUR_set(SV* sv, STRLEN len)
2671 Returns a pointer to the last character in the string which is in the SV.
2672 See C<SvCUR>. Access the character as *(SvEND(sv)).
2681 Expands the character buffer in the SV so that it has room for the
2682 indicated number of bytes (remember to reserve space for an extra trailing
2683 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
2684 Returns a pointer to the character buffer.
2686 char * SvGROW(SV* sv, STRLEN len)
2693 Returns a boolean indicating whether the SV contains an integer.
2702 Returns a boolean indicating whether the SV contains an integer. Checks
2703 the B<private> setting. Use C<SvIOK>.
2712 Returns a boolean indicating whether the SV contains a signed integer.
2714 void SvIOK_notUV(SV* sv)
2721 Unsets the IV status of an SV.
2723 void SvIOK_off(SV* sv)
2730 Tells an SV that it is an integer.
2732 void SvIOK_on(SV* sv)
2739 Tells an SV that it is an integer and disables all other OK bits.
2741 void SvIOK_only(SV* sv)
2748 Tells and SV that it is an unsigned integer and disables all other OK bits.
2750 void SvIOK_only_UV(SV* sv)
2757 Returns a boolean indicating whether the SV contains an unsigned integer.
2759 void SvIOK_UV(SV* sv)
2766 Returns a boolean indicating whether the SV is Copy-On-Write. (either shared
2767 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
2770 bool SvIsCOW(SV* sv)
2775 =item SvIsCOW_shared_hash
2777 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
2780 bool SvIsCOW_shared_hash(SV* sv)
2787 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
2788 version which guarantees to evaluate sv only once.
2797 Coerces the given SV to an integer and returns it. Guarantees to evaluate
2798 sv only once. Use the more efficient C<SvIV> otherwise.
2807 Returns the raw value in the SV's IV slot, without checks or conversions.
2808 Only use when you are sure SvIOK is true. See also C<SvIV()>.
2817 Returns the size of the string buffer in the SV, not including any part
2818 attributable to C<SvOOK>. See C<SvCUR>.
2820 STRLEN SvLEN(SV* sv)
2827 Returns a boolean indicating whether the SV contains a number, integer or
2837 Returns a boolean indicating whether the SV contains a number, integer or
2838 double. Checks the B<private> setting. Use C<SvNIOK>.
2840 bool SvNIOKp(SV* sv)
2847 Unsets the NV/IV status of an SV.
2849 void SvNIOK_off(SV* sv)
2856 Returns a boolean indicating whether the SV contains a double.
2865 Returns a boolean indicating whether the SV contains a double. Checks the
2866 B<private> setting. Use C<SvNOK>.
2875 Unsets the NV status of an SV.
2877 void SvNOK_off(SV* sv)
2884 Tells an SV that it is a double.
2886 void SvNOK_on(SV* sv)
2893 Tells an SV that it is a double and disables all other OK bits.
2895 void SvNOK_only(SV* sv)
2902 Coerce the given SV to a double and return it. See C<SvNVx> for a version
2903 which guarantees to evaluate sv only once.
2912 Returns the raw value in the SV's NV slot, without checks or conversions.
2913 Only use when you are sure SvNOK is true. See also C<SvNV()>.
2922 Coerces the given SV to a double and returns it. Guarantees to evaluate
2923 sv only once. Use the more efficient C<SvNV> otherwise.
2932 Returns a boolean indicating whether the value is an SV.
2941 Returns a boolean indicating whether the SvIVX is a valid offset value for
2942 the SvPVX. This hack is used internally to speed up removal of characters
2943 from the beginning of a SvPV. When SvOOK is true, then the start of the
2944 allocated string buffer is really (SvPVX - SvIVX).
2953 Returns a boolean indicating whether the SV contains a character
2963 Returns a boolean indicating whether the SV contains a character string.
2964 Checks the B<private> setting. Use C<SvPOK>.
2973 Unsets the PV status of an SV.
2975 void SvPOK_off(SV* sv)
2982 Tells an SV that it is a string.
2984 void SvPOK_on(SV* sv)
2991 Tells an SV that it is a string and disables all other OK bits.
2992 Will also turn off the UTF8 status.
2994 void SvPOK_only(SV* sv)
2999 =item SvPOK_only_UTF8
3001 Tells an SV that it is a string and disables all other OK bits,
3002 and leaves the UTF8 status as it was.
3004 void SvPOK_only_UTF8(SV* sv)
3011 Returns a pointer to the string in the SV, or a stringified form of
3012 the SV if the SV does not contain a string. The SV may cache the
3013 stringified version becoming C<SvPOK>. Handles 'get' magic. See also
3014 C<SvPVx> for a version which guarantees to evaluate sv only once.
3016 char* SvPV(SV* sv, STRLEN len)
3023 Like C<SvPV>, but converts sv to byte representation first if necessary.
3025 char* SvPVbyte(SV* sv, STRLEN len)
3032 Like C<SvPV>, but converts sv to byte representation first if necessary.
3033 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
3036 char* SvPVbytex(SV* sv, STRLEN len)
3041 =item SvPVbytex_force
3043 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
3044 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
3047 char* SvPVbytex_force(SV* sv, STRLEN len)
3052 =item SvPVbyte_force
3054 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
3056 char* SvPVbyte_force(SV* sv, STRLEN len)
3061 =item SvPVbyte_nolen
3063 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
3065 char* SvPVbyte_nolen(SV* sv)
3072 Like C<SvPV>, but converts sv to utf8 first if necessary.
3074 char* SvPVutf8(SV* sv, STRLEN len)
3081 Like C<SvPV>, but converts sv to utf8 first if necessary.
3082 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
3085 char* SvPVutf8x(SV* sv, STRLEN len)
3090 =item SvPVutf8x_force
3092 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
3093 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
3096 char* SvPVutf8x_force(SV* sv, STRLEN len)
3101 =item SvPVutf8_force
3103 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
3105 char* SvPVutf8_force(SV* sv, STRLEN len)
3110 =item SvPVutf8_nolen
3112 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
3114 char* SvPVutf8_nolen(SV* sv)
3121 A version of C<SvPV> which guarantees to evaluate sv only once.
3123 char* SvPVx(SV* sv, STRLEN len)
3130 Returns a pointer to the physical string in the SV. The SV must contain a
3140 Like C<SvPV> but will force the SV into containing just a string
3141 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
3144 char* SvPV_force(SV* sv, STRLEN len)
3149 =item SvPV_force_nomg
3151 Like C<SvPV> but will force the SV into containing just a string
3152 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
3153 directly. Doesn't process magic.
3155 char* SvPV_force_nomg(SV* sv, STRLEN len)
3162 Returns a pointer to the string in the SV, or a stringified form of
3163 the SV if the SV does not contain a string. The SV may cache the
3164 stringified form becoming C<SvPOK>. Handles 'get' magic.
3166 char* SvPV_nolen(SV* sv)
3173 Returns the value of the object's reference count.
3175 U32 SvREFCNT(SV* sv)
3182 Decrements the reference count of the given SV.
3184 void SvREFCNT_dec(SV* sv)
3191 Increments the reference count of the given SV.
3193 SV* SvREFCNT_inc(SV* sv)
3200 Tests if the SV is an RV.
3209 Unsets the RV status of an SV.
3211 void SvROK_off(SV* sv)
3218 Tells an SV that it is an RV.
3220 void SvROK_on(SV* sv)
3227 Dereferences an RV to return the SV.
3236 Returns the stash of the SV.
3245 Taints an SV if tainting is enabled
3247 void SvTAINT(SV* sv)
3254 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
3257 bool SvTAINTED(SV* sv)
3264 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
3265 some of Perl's fundamental security features. XS module authors should not
3266 use this function unless they fully understand all the implications of
3267 unconditionally untainting the value. Untainting should be done in the
3268 standard perl fashion, via a carefully crafted regexp, rather than directly
3269 untainting variables.
3271 void SvTAINTED_off(SV* sv)
3278 Marks an SV as tainted.
3280 void SvTAINTED_on(SV* sv)
3287 Returns a boolean indicating whether Perl would evaluate the SV as true or
3288 false, defined or undefined. Does not handle 'get' magic.
3297 Returns the type of the SV. See C<svtype>.
3299 svtype SvTYPE(SV* sv)
3306 Releases a mutual exclusion lock on sv if a suitable module
3310 void SvUNLOCK(SV* sv)
3317 Returns a boolean indicating whether the SV contains an unsigned integer.
3326 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
3327 perform the upgrade if necessary. See C<svtype>.
3329 void SvUPGRADE(SV* sv, svtype type)
3336 Returns a boolean indicating whether the SV contains UTF-8 encoded data.
3345 Unsets the UTF8 status of an SV.
3347 void SvUTF8_off(SV *sv)
3354 Turn on the UTF8 status of an SV (the data is not changed, just the flag).
3355 Do not use frivolously.
3357 void SvUTF8_on(SV *sv)
3364 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
3365 for a version which guarantees to evaluate sv only once.
3374 Returns the raw value in the SV's UV slot, without checks or conversions.
3375 Only use when you are sure SvIOK is true. See also C<SvUV()>.
3384 Coerces the given SV to an unsigned integer and returns it. Guarantees to
3385 evaluate sv only once. Use the more efficient C<SvUV> otherwise.
3394 Returns a boolean indicating whether the SV contains a v-string.
3403 This function is only called on magical items, and is only used by
3404 sv_true() or its macro equivalent.
3406 bool sv_2bool(SV* sv)
3413 Using various gambits, try to get a CV from an SV; in addition, try if
3414 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
3416 CV* sv_2cv(SV* sv, HV** st, GV** gvp, I32 lref)
3423 Using various gambits, try to get an IO from an SV: the IO slot if its a
3424 GV; or the recursive result if we're an RV; or the IO slot of the symbol
3425 named after the PV if we're a string.
3434 Return the integer value of an SV, doing any necessary string conversion,
3435 magic etc. Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
3444 Marks an existing SV as mortal. The SV will be destroyed "soon", either
3445 by an explicit call to FREETMPS, or by an implicit call at places such as
3446 statement boundaries. See also C<sv_newmortal> and C<sv_mortalcopy>.
3448 SV* sv_2mortal(SV* sv)
3455 Return the num value of an SV, doing any necessary string or integer
3456 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
3466 Return a pointer to the byte-encoded representation of the SV, and set *lp
3467 to its length. May cause the SV to be downgraded from UTF8 as a
3470 Usually accessed via the C<SvPVbyte> macro.
3472 char* sv_2pvbyte(SV* sv, STRLEN* lp)
3477 =item sv_2pvbyte_nolen
3479 Return a pointer to the byte-encoded representation of the SV.
3480 May cause the SV to be downgraded from UTF8 as a side-effect.
3482 Usually accessed via the C<SvPVbyte_nolen> macro.
3484 char* sv_2pvbyte_nolen(SV* sv)
3491 Return a pointer to the UTF8-encoded representation of the SV, and set *lp
3492 to its length. May cause the SV to be upgraded to UTF8 as a side-effect.
3494 Usually accessed via the C<SvPVutf8> macro.
3496 char* sv_2pvutf8(SV* sv, STRLEN* lp)
3501 =item sv_2pvutf8_nolen
3503 Return a pointer to the UTF8-encoded representation of the SV.
3504 May cause the SV to be upgraded to UTF8 as a side-effect.
3506 Usually accessed via the C<SvPVutf8_nolen> macro.
3508 char* sv_2pvutf8_nolen(SV* sv)
3515 Returns a pointer to the string value of an SV, and sets *lp to its length.
3516 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
3518 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
3519 usually end up here too.
3521 char* sv_2pv_flags(SV* sv, STRLEN* lp, I32 flags)
3528 Like C<sv_2pv()>, but doesn't return the length too. You should usually
3529 use the macro wrapper C<SvPV_nolen(sv)> instead.
3530 char* sv_2pv_nolen(SV* sv)
3537 Return the unsigned integer value of an SV, doing any necessary string
3538 conversion, magic etc. Normally used via the C<SvUV(sv)> and C<SvUVx(sv)>
3548 Remove any string offset. You should normally use the C<SvOOK_off> macro
3551 int sv_backoff(SV* sv)
3558 Blesses an SV into a specified package. The SV must be an RV. The package
3559 must be designated by its stash (see C<gv_stashpv()>). The reference count
3560 of the SV is unaffected.
3562 SV* sv_bless(SV* sv, HV* stash)
3569 Concatenates the string onto the end of the string which is in the SV.
3570 If the SV has the UTF8 status set, then the bytes appended should be
3571 valid UTF8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
3573 void sv_catpv(SV* sv, const char* ptr)
3580 Processes its arguments like C<sprintf> and appends the formatted
3581 output to an SV. If the appended data contains "wide" characters
3582 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
3583 and characters >255 formatted with %c), the original SV might get
3584 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic.
3585 C<SvSETMAGIC()> must typically be called after calling this function
3586 to handle 'set' magic.
3588 void sv_catpvf(SV* sv, const char* pat, ...)
3595 Like C<sv_catpvf>, but also handles 'set' magic.
3597 void sv_catpvf_mg(SV *sv, const char* pat, ...)
3604 Concatenates the string onto the end of the string which is in the SV. The
3605 C<len> indicates number of bytes to copy. If the SV has the UTF8
3606 status set, then the bytes appended should be valid UTF8.
3607 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
3609 void sv_catpvn(SV* sv, const char* ptr, STRLEN len)
3614 =item sv_catpvn_flags
3616 Concatenates the string onto the end of the string which is in the SV. The
3617 C<len> indicates number of bytes to copy. If the SV has the UTF8
3618 status set, then the bytes appended should be valid UTF8.
3619 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
3620 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
3621 in terms of this function.
3623 void sv_catpvn_flags(SV* sv, const char* ptr, STRLEN len, I32 flags)
3630 Like C<sv_catpvn>, but also handles 'set' magic.
3632 void sv_catpvn_mg(SV *sv, const char *ptr, STRLEN len)
3639 Like C<sv_catpv>, but also handles 'set' magic.
3641 void sv_catpv_mg(SV *sv, const char *ptr)
3648 Concatenates the string from SV C<ssv> onto the end of the string in
3649 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
3650 not 'set' magic. See C<sv_catsv_mg>.
3652 void sv_catsv(SV* dsv, SV* ssv)
3657 =item sv_catsv_flags
3659 Concatenates the string from SV C<ssv> onto the end of the string in
3660 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
3661 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
3662 and C<sv_catsv_nomg> are implemented in terms of this function.
3664 void sv_catsv_flags(SV* dsv, SV* ssv, I32 flags)
3671 Like C<sv_catsv>, but also handles 'set' magic.
3673 void sv_catsv_mg(SV *dstr, SV *sstr)
3680 Efficient removal of characters from the beginning of the string buffer.
3681 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
3682 the string buffer. The C<ptr> becomes the first character of the adjusted
3683 string. Uses the "OOK hack".
3685 void sv_chop(SV* sv, char* ptr)
3692 Clear an SV: call any destructors, free up any memory used by the body,
3693 and free the body itself. The SV's head is I<not> freed, although
3694 its type is set to all 1's so that it won't inadvertently be assumed
3695 to be live during global destruction etc.
3696 This function should only be called when REFCNT is zero. Most of the time
3697 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
3700 void sv_clear(SV* sv)
3707 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
3708 string in C<sv1> is less than, equal to, or greater than the string in
3709 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
3710 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
3712 I32 sv_cmp(SV* sv1, SV* sv2)
3719 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
3720 'use bytes' aware, handles get magic, and will coerce its args to strings
3721 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
3723 I32 sv_cmp_locale(SV* sv1, SV* sv2)
3730 Add Collate Transform magic to an SV if it doesn't already have it.
3732 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
3733 scalar data of the variable, but transformed to such a format that a normal
3734 memory comparison can be used to compare the data according to the locale
3737 char* sv_collxfrm(SV* sv, STRLEN* nxp)
3744 Copies a stringified representation of the source SV into the
3745 destination SV. Automatically performs any necessary mg_get and
3746 coercion of numeric values into strings. Guaranteed to preserve
3747 UTF-8 flag even from overloaded objects. Similar in nature to
3748 sv_2pv[_flags] but operates directly on an SV instead of just the
3749 string. Mostly uses sv_2pv_flags to do its work, except when that
3750 would lose the UTF-8'ness of the PV.
3752 void sv_copypv(SV* dsv, SV* ssv)
3759 Auto-decrement of the value in the SV, doing string to numeric conversion
3760 if necessary. Handles 'get' magic.
3767 =item sv_derived_from
3769 Returns a boolean indicating whether the SV is derived from the specified
3770 class. This is the function that implements C<UNIVERSAL::isa>. It works
3771 for class names as well as for objects.
3773 bool sv_derived_from(SV* sv, const char* name)
3776 Found in file universal.c
3780 Returns a boolean indicating whether the strings in the two SVs are
3781 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
3782 coerce its args to strings if necessary.
3784 I32 sv_eq(SV* sv1, SV* sv2)
3789 =item sv_force_normal
3791 Undo various types of fakery on an SV: if the PV is a shared string, make
3792 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3793 an xpvmg. See also C<sv_force_normal_flags>.
3795 void sv_force_normal(SV *sv)
3800 =item sv_force_normal_flags
3802 Undo various types of fakery on an SV: if the PV is a shared string, make
3803 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3804 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
3805 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
3806 then a copy-on-write scalar drops its PV buffer (if any) and becomes
3807 SvPOK_off rather than making a copy. (Used where this scalar is about to be
3808 set to some other value.) In addition, the C<flags> parameter gets passed to
3809 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
3810 with flags set to 0.
3812 void sv_force_normal_flags(SV *sv, U32 flags)
3819 Decrement an SV's reference count, and if it drops to zero, call
3820 C<sv_clear> to invoke destructors and free up any memory used by
3821 the body; finally, deallocate the SV's head itself.
3822 Normally called via a wrapper macro C<SvREFCNT_dec>.
3824 void sv_free(SV* sv)
3831 Get a line from the filehandle and store it into the SV, optionally
3832 appending to the currently-stored string.
3834 char* sv_gets(SV* sv, PerlIO* fp, I32 append)
3841 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
3842 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
3843 Use the C<SvGROW> wrapper instead.
3845 char* sv_grow(SV* sv, STRLEN newlen)
3852 Auto-increment of the value in the SV, doing string to numeric conversion
3853 if necessary. Handles 'get' magic.
3862 Inserts a string at the specified offset/length within the SV. Similar to
3863 the Perl substr() function.
3865 void sv_insert(SV* bigsv, STRLEN offset, STRLEN len, char* little, STRLEN littlelen)
3872 Returns a boolean indicating whether the SV is blessed into the specified
3873 class. This does not check for subtypes; use C<sv_derived_from> to verify
3874 an inheritance relationship.
3876 int sv_isa(SV* sv, const char* name)
3883 Returns a boolean indicating whether the SV is an RV pointing to a blessed
3884 object. If the SV is not an RV, or if the object is not blessed, then this
3887 int sv_isobject(SV* sv)
3894 A private implementation of the C<SvIVx> macro for compilers which can't
3895 cope with complex macro expressions. Always use the macro instead.
3904 Returns the length of the string in the SV. Handles magic and type
3905 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
3907 STRLEN sv_len(SV* sv)
3914 Returns the number of characters in the string in an SV, counting wide
3915 UTF8 bytes as a single character. Handles magic and type coercion.
3917 STRLEN sv_len_utf8(SV* sv)
3924 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
3925 then adds a new magic item of type C<how> to the head of the magic list.
3927 void sv_magic(SV* sv, SV* obj, int how, const char* name, I32 namlen)
3934 Adds magic to an SV, upgrading it if necessary. Applies the
3935 supplied vtable and returns pointer to the magic added.
3937 Note that sv_magicext will allow things that sv_magic will not.
3938 In particular you can add magic to SvREADONLY SVs and and more than
3939 one instance of the same 'how'
3941 I C<namelen> is greater then zero then a savepvn() I<copy> of C<name> is stored,
3942 if C<namelen> is zero then C<name> is stored as-is and - as another special
3943 case - if C<(name && namelen == HEf_SVKEY)> then C<name> is assumed to contain
3944 an C<SV*> and has its REFCNT incremented
3946 (This is now used as a subroutine by sv_magic.)
3948 MAGIC * sv_magicext(SV* sv, SV* obj, int how, MGVTBL *vtbl, const char* name, I32 namlen )
3955 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
3956 The new SV is marked as mortal. It will be destroyed "soon", either by an
3957 explicit call to FREETMPS, or by an implicit call at places such as
3958 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
3960 SV* sv_mortalcopy(SV* oldsv)
3967 Creates a new null SV which is mortal. The reference count of the SV is
3968 set to 1. It will be destroyed "soon", either by an explicit call to
3969 FREETMPS, or by an implicit call at places such as statement boundaries.
3970 See also C<sv_mortalcopy> and C<sv_2mortal>.
3979 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
3982 SV* sv_newref(SV* sv)
3989 Dummy routine which "locks" an SV when there is no locking module present.
3990 Exists to avoid test for a NULL function pointer and because it could potentially warn under
3991 some level of strict-ness.
3993 void sv_nolocking(SV *)
3996 Found in file util.c
4000 Dummy routine which "shares" an SV when there is no sharing module present.
4001 Exists to avoid test for a NULL function pointer and because it could potentially warn under
4002 some level of strict-ness.
4004 void sv_nosharing(SV *)
4007 Found in file util.c
4009 =item sv_nounlocking
4011 Dummy routine which "unlocks" an SV when there is no locking module present.
4012 Exists to avoid test for a NULL function pointer and because it could potentially warn under
4013 some level of strict-ness.
4015 void sv_nounlocking(SV *)
4018 Found in file util.c
4022 A private implementation of the C<SvNVx> macro for compilers which can't
4023 cope with complex macro expressions. Always use the macro instead.
4032 Converts the value pointed to by offsetp from a count of bytes from the
4033 start of the string, to a count of the equivalent number of UTF8 chars.
4034 Handles magic and type coercion.
4036 void sv_pos_b2u(SV* sv, I32* offsetp)
4043 Converts the value pointed to by offsetp from a count of UTF8 chars from
4044 the start of the string, to a count of the equivalent number of bytes; if
4045 lenp is non-zero, it does the same to lenp, but this time starting from
4046 the offset, rather than from the start of the string. Handles magic and
4049 void sv_pos_u2b(SV* sv, I32* offsetp, I32* lenp)
4056 Use the C<SvPV_nolen> macro instead
4065 Use C<SvPVbyte_nolen> instead.
4067 char* sv_pvbyte(SV *sv)
4074 A private implementation of the C<SvPVbyte> macro for compilers
4075 which can't cope with complex macro expressions. Always use the macro
4078 char* sv_pvbyten(SV *sv, STRLEN *len)
4083 =item sv_pvbyten_force
4085 A private implementation of the C<SvPVbytex_force> macro for compilers
4086 which can't cope with complex macro expressions. Always use the macro
4089 char* sv_pvbyten_force(SV* sv, STRLEN* lp)
4096 A private implementation of the C<SvPV> macro for compilers which can't
4097 cope with complex macro expressions. Always use the macro instead.
4099 char* sv_pvn(SV *sv, STRLEN *len)
4106 Get a sensible string out of the SV somehow.
4107 A private implementation of the C<SvPV_force> macro for compilers which
4108 can't cope with complex macro expressions. Always use the macro instead.
4110 char* sv_pvn_force(SV* sv, STRLEN* lp)
4115 =item sv_pvn_force_flags
4117 Get a sensible string out of the SV somehow.
4118 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
4119 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
4120 implemented in terms of this function.
4121 You normally want to use the various wrapper macros instead: see
4122 C<SvPV_force> and C<SvPV_force_nomg>
4124 char* sv_pvn_force_flags(SV* sv, STRLEN* lp, I32 flags)
4131 Use the C<SvPVutf8_nolen> macro instead
4133 char* sv_pvutf8(SV *sv)
4140 A private implementation of the C<SvPVutf8> macro for compilers
4141 which can't cope with complex macro expressions. Always use the macro
4144 char* sv_pvutf8n(SV *sv, STRLEN *len)
4149 =item sv_pvutf8n_force
4151 A private implementation of the C<SvPVutf8_force> macro for compilers
4152 which can't cope with complex macro expressions. Always use the macro
4155 char* sv_pvutf8n_force(SV* sv, STRLEN* lp)
4162 Returns a string describing what the SV is a reference to.
4164 char* sv_reftype(SV* sv, int ob)
4171 Make the first argument a copy of the second, then delete the original.
4172 The target SV physically takes over ownership of the body of the source SV
4173 and inherits its flags; however, the target keeps any magic it owns,
4174 and any magic in the source is discarded.
4175 Note that this is a rather specialist SV copying operation; most of the
4176 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4178 void sv_replace(SV* sv, SV* nsv)
4183 =item sv_report_used
4185 Dump the contents of all SVs not yet freed. (Debugging aid).
4187 void sv_report_used()
4194 Underlying implementation for the C<reset> Perl function.
4195 Note that the perl-level function is vaguely deprecated.
4197 void sv_reset(char* s, HV* stash)
4204 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4205 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4206 push a back-reference to this RV onto the array of backreferences
4207 associated with that magic.
4209 SV* sv_rvweaken(SV *sv)
4216 Copies an integer into the given SV, upgrading first if necessary.
4217 Does not handle 'set' magic. See also C<sv_setiv_mg>.
4219 void sv_setiv(SV* sv, IV num)
4226 Like C<sv_setiv>, but also handles 'set' magic.
4228 void sv_setiv_mg(SV *sv, IV i)
4235 Copies a double into the given SV, upgrading first if necessary.
4236 Does not handle 'set' magic. See also C<sv_setnv_mg>.
4238 void sv_setnv(SV* sv, NV num)
4245 Like C<sv_setnv>, but also handles 'set' magic.
4247 void sv_setnv_mg(SV *sv, NV num)
4254 Copies a string into an SV. The string must be null-terminated. Does not
4255 handle 'set' magic. See C<sv_setpv_mg>.
4257 void sv_setpv(SV* sv, const char* ptr)
4264 Processes its arguments like C<sprintf> and sets an SV to the formatted
4265 output. Does not handle 'set' magic. See C<sv_setpvf_mg>.
4267 void sv_setpvf(SV* sv, const char* pat, ...)
4274 Like C<sv_setpvf>, but also handles 'set' magic.
4276 void sv_setpvf_mg(SV *sv, const char* pat, ...)
4283 Copies an integer into the given SV, also updating its string value.
4284 Does not handle 'set' magic. See C<sv_setpviv_mg>.
4286 void sv_setpviv(SV* sv, IV num)
4293 Like C<sv_setpviv>, but also handles 'set' magic.
4295 void sv_setpviv_mg(SV *sv, IV iv)
4302 Copies a string into an SV. The C<len> parameter indicates the number of
4303 bytes to be copied. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4305 void sv_setpvn(SV* sv, const char* ptr, STRLEN len)
4312 Like C<sv_setpvn>, but also handles 'set' magic.
4314 void sv_setpvn_mg(SV *sv, const char *ptr, STRLEN len)
4321 Like C<sv_setpv>, but also handles 'set' magic.
4323 void sv_setpv_mg(SV *sv, const char *ptr)
4330 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
4331 argument will be upgraded to an RV. That RV will be modified to point to
4332 the new SV. The C<classname> argument indicates the package for the
4333 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4334 will be returned and will have a reference count of 1.
4336 SV* sv_setref_iv(SV* rv, const char* classname, IV iv)
4343 Copies a double into a new SV, optionally blessing the SV. The C<rv>
4344 argument will be upgraded to an RV. That RV will be modified to point to
4345 the new SV. The C<classname> argument indicates the package for the
4346 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4347 will be returned and will have a reference count of 1.
4349 SV* sv_setref_nv(SV* rv, const char* classname, NV nv)
4356 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
4357 argument will be upgraded to an RV. That RV will be modified to point to
4358 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
4359 into the SV. The C<classname> argument indicates the package for the
4360 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4361 will be returned and will have a reference count of 1.
4363 Do not use with other Perl types such as HV, AV, SV, CV, because those
4364 objects will become corrupted by the pointer copy process.
4366 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
4368 SV* sv_setref_pv(SV* rv, const char* classname, void* pv)
4375 Copies a string into a new SV, optionally blessing the SV. The length of the
4376 string must be specified with C<n>. The C<rv> argument will be upgraded to
4377 an RV. That RV will be modified to point to the new SV. The C<classname>
4378 argument indicates the package for the blessing. Set C<classname> to
4379 C<Nullch> to avoid the blessing. The new SV will be returned and will have
4380 a reference count of 1.
4382 Note that C<sv_setref_pv> copies the pointer while this copies the string.
4384 SV* sv_setref_pvn(SV* rv, const char* classname, char* pv, STRLEN n)
4391 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
4392 argument will be upgraded to an RV. That RV will be modified to point to
4393 the new SV. The C<classname> argument indicates the package for the
4394 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4395 will be returned and will have a reference count of 1.
4397 SV* sv_setref_uv(SV* rv, const char* classname, UV uv)
4404 Copies the contents of the source SV C<ssv> into the destination SV
4405 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4406 function if the source SV needs to be reused. Does not handle 'set' magic.
4407 Loosely speaking, it performs a copy-by-value, obliterating any previous
4408 content of the destination.
4410 You probably want to use one of the assortment of wrappers, such as
4411 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4412 C<SvSetMagicSV_nosteal>.
4414 void sv_setsv(SV* dsv, SV* ssv)
4419 =item sv_setsv_flags
4421 Copies the contents of the source SV C<ssv> into the destination SV
4422 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4423 function if the source SV needs to be reused. Does not handle 'set' magic.
4424 Loosely speaking, it performs a copy-by-value, obliterating any previous
4425 content of the destination.
4426 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
4427 C<ssv> if appropriate, else not. C<sv_setsv> and C<sv_setsv_nomg> are
4428 implemented in terms of this function.
4430 You probably want to use one of the assortment of wrappers, such as
4431 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4432 C<SvSetMagicSV_nosteal>.
4434 This is the primary function for copying scalars, and most other
4435 copy-ish functions and macros use this underneath.
4437 void sv_setsv_flags(SV* dsv, SV* ssv, I32 flags)
4444 Like C<sv_setsv>, but also handles 'set' magic.
4446 void sv_setsv_mg(SV *dstr, SV *sstr)
4453 Copies an unsigned integer into the given SV, upgrading first if necessary.
4454 Does not handle 'set' magic. See also C<sv_setuv_mg>.
4456 void sv_setuv(SV* sv, UV num)
4463 Like C<sv_setuv>, but also handles 'set' magic.
4465 void sv_setuv_mg(SV *sv, UV u)
4472 Taint an SV. Use C<SvTAINTED_on> instead.
4473 void sv_taint(SV* sv)
4480 Test an SV for taintedness. Use C<SvTAINTED> instead.
4481 bool sv_tainted(SV* sv)
4488 Returns true if the SV has a true value by Perl's rules.
4489 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
4490 instead use an in-line version.
4499 Removes all magic of type C<type> from an SV.
4501 int sv_unmagic(SV* sv, int type)
4508 Unsets the RV status of the SV, and decrements the reference count of
4509 whatever was being referenced by the RV. This can almost be thought of
4510 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
4511 being zero. See C<SvROK_off>.
4513 void sv_unref(SV* sv)
4518 =item sv_unref_flags
4520 Unsets the RV status of the SV, and decrements the reference count of
4521 whatever was being referenced by the RV. This can almost be thought of
4522 as a reversal of C<newSVrv>. The C<cflags> argument can contain
4523 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
4524 (otherwise the decrementing is conditional on the reference count being
4525 different from one or the reference being a readonly SV).
4528 void sv_unref_flags(SV* sv, U32 flags)
4535 Untaint an SV. Use C<SvTAINTED_off> instead.
4536 void sv_untaint(SV* sv)
4543 Upgrade an SV to a more complex form. Generally adds a new body type to the
4544 SV, then copies across as much information as possible from the old body.
4545 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
4547 bool sv_upgrade(SV* sv, U32 mt)
4554 Tells an SV to use C<ptr> to find its string value. Normally the string is
4555 stored inside the SV but sv_usepvn allows the SV to use an outside string.
4556 The C<ptr> should point to memory that was allocated by C<malloc>. The
4557 string length, C<len>, must be supplied. This function will realloc the
4558 memory pointed to by C<ptr>, so that pointer should not be freed or used by
4559 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
4560 See C<sv_usepvn_mg>.
4562 void sv_usepvn(SV* sv, char* ptr, STRLEN len)
4569 Like C<sv_usepvn>, but also handles 'set' magic.
4571 void sv_usepvn_mg(SV *sv, char *ptr, STRLEN len)
4576 =item sv_utf8_decode
4578 Convert the octets in the PV from UTF-8 to chars. Scan for validity and then
4579 turn off SvUTF8 if needed so that we see characters. Used as a building block
4580 for decode_utf8 in Encode.xs
4582 NOTE: this function is experimental and may change or be
4583 removed without notice.
4585 bool sv_utf8_decode(SV *sv)
4590 =item sv_utf8_downgrade
4592 Attempt to convert the PV of an SV from UTF8-encoded to byte encoding.
4593 This may not be possible if the PV contains non-byte encoding characters;
4594 if this is the case, either returns false or, if C<fail_ok> is not
4597 This is not as a general purpose Unicode to byte encoding interface:
4598 use the Encode extension for that.
4600 NOTE: this function is experimental and may change or be
4601 removed without notice.
4603 bool sv_utf8_downgrade(SV *sv, bool fail_ok)
4608 =item sv_utf8_encode
4610 Convert the PV of an SV to UTF8-encoded, but then turn off the C<SvUTF8>
4611 flag so that it looks like octets again. Used as a building block
4612 for encode_utf8 in Encode.xs
4614 void sv_utf8_encode(SV *sv)
4619 =item sv_utf8_upgrade
4621 Convert the PV of an SV to its UTF8-encoded form.
4622 Forces the SV to string form if it is not already.
4623 Always sets the SvUTF8 flag to avoid future validity checks even
4624 if all the bytes have hibit clear.
4626 This is not as a general purpose byte encoding to Unicode interface:
4627 use the Encode extension for that.
4629 STRLEN sv_utf8_upgrade(SV *sv)
4634 =item sv_utf8_upgrade_flags
4636 Convert the PV of an SV to its UTF8-encoded form.
4637 Forces the SV to string form if it is not already.
4638 Always sets the SvUTF8 flag to avoid future validity checks even
4639 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
4640 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
4641 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
4643 This is not as a general purpose byte encoding to Unicode interface:
4644 use the Encode extension for that.
4646 STRLEN sv_utf8_upgrade_flags(SV *sv, I32 flags)
4653 A private implementation of the C<SvUVx> macro for compilers which can't
4654 cope with complex macro expressions. Always use the macro instead.
4663 Processes its arguments like C<vsprintf> and appends the formatted output
4664 to an SV. Uses an array of SVs if the C style variable argument list is
4665 missing (NULL). When running with taint checks enabled, indicates via
4666 C<maybe_tainted> if results are untrustworthy (often due to the use of
4669 Usually used via one of its frontends C<sv_catpvf> and C<sv_catpvf_mg>.
4671 void sv_vcatpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
4678 Works like C<vcatpvfn> but copies the text into the SV instead of
4681 Usually used via one of its frontends C<sv_setpvf> and C<sv_setpvf_mg>.
4683 void sv_vsetpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
4690 In-place upgrade of the supplied SV to a version object.
4692 SV *sv = upg_version(SV *sv);
4694 Returns a pointer to the upgraded SV.
4696 SV* upg_version(SV *ver)
4699 Found in file util.c
4703 Version object aware cmp. Both operands must already have been
4704 converted into version objects.
4706 int vcmp(SV *lvs, SV *rvs)
4709 Found in file util.c
4713 Accepts a version object and returns the normalized floating
4714 point representation. Call like:
4718 NOTE: you can pass either the object directly or the SV
4719 contained within the RV.
4724 Found in file util.c
4728 Accepts a version object and returns the normalized string
4729 representation. Call like:
4731 sv = vstringify(rv);
4733 NOTE: you can pass either the object directly or the SV
4734 contained within the RV.
4736 SV* vstringify(SV *vs)
4739 Found in file util.c
4744 =head1 Unicode Support
4748 =item bytes_from_utf8
4750 Converts a string C<s> of length C<len> from UTF8 into byte encoding.
4751 Unlike <utf8_to_bytes> but like C<bytes_to_utf8>, returns a pointer to
4752 the newly-created string, and updates C<len> to contain the new
4753 length. Returns the original string if no conversion occurs, C<len>
4754 is unchanged. Do nothing if C<is_utf8> points to 0. Sets C<is_utf8> to
4755 0 if C<s> is converted or contains all 7bit characters.
4757 NOTE: this function is experimental and may change or be
4758 removed without notice.
4760 U8* bytes_from_utf8(U8 *s, STRLEN *len, bool *is_utf8)
4763 Found in file utf8.c
4767 Converts a string C<s> of length C<len> from ASCII into UTF8 encoding.
4768 Returns a pointer to the newly-created string, and sets C<len> to
4769 reflect the new length.
4771 If you want to convert to UTF8 from other encodings than ASCII,
4772 see sv_recode_to_utf8().
4774 NOTE: this function is experimental and may change or be
4775 removed without notice.
4777 U8* bytes_to_utf8(U8 *s, STRLEN *len)
4780 Found in file utf8.c
4784 Return true if the strings s1 and s2 differ case-insensitively, false
4785 if not (if they are equal case-insensitively). If u1 is true, the
4786 string s1 is assumed to be in UTF-8-encoded Unicode. If u2 is true,
4787 the string s2 is assumed to be in UTF-8-encoded Unicode. If u1 or u2
4788 are false, the respective string is assumed to be in native 8-bit
4791 If the pe1 and pe2 are non-NULL, the scanning pointers will be copied
4792 in there (they will point at the beginning of the I<next> character).
4793 If the pointers behind pe1 or pe2 are non-NULL, they are the end
4794 pointers beyond which scanning will not continue under any
4795 circustances. If the byte lengths l1 and l2 are non-zero, s1+l1 and
4796 s2+l2 will be used as goal end pointers that will also stop the scan,
4797 and which qualify towards defining a successful match: all the scans
4798 that define an explicit length must reach their goal pointers for
4799 a match to succeed).
4801 For case-insensitiveness, the "casefolding" of Unicode is used
4802 instead of upper/lowercasing both the characters, see
4803 http://www.unicode.org/unicode/reports/tr21/ (Case Mappings).
4805 I32 ibcmp_utf8(const char* a, char **pe1, UV l1, bool u1, const char* b, char **pe2, UV l2, bool u2)
4808 Found in file utf8.c
4812 Tests if some arbitrary number of bytes begins in a valid UTF-8
4813 character. Note that an INVARIANT (i.e. ASCII) character is a valid
4814 UTF-8 character. The actual number of bytes in the UTF-8 character
4815 will be returned if it is valid, otherwise 0.
4817 STRLEN is_utf8_char(U8 *p)
4820 Found in file utf8.c
4822 =item is_utf8_string
4824 Returns true if first C<len> bytes of the given string form a valid
4825 UTF8 string, false otherwise. Note that 'a valid UTF8 string' does
4826 not mean 'a string that contains code points above 0x7F encoded in
4827 UTF8' because a valid ASCII string is a valid UTF8 string.
4829 bool is_utf8_string(U8 *s, STRLEN len)
4832 Found in file utf8.c
4834 =item pv_uni_display
4836 Build to the scalar dsv a displayable version of the string spv,
4837 length len, the displayable version being at most pvlim bytes long
4838 (if longer, the rest is truncated and "..." will be appended).
4840 The flags argument can have UNI_DISPLAY_ISPRINT set to display
4841 isPRINT()able characters as themselves, UNI_DISPLAY_BACKSLASH
4842 to display the \\[nrfta\\] as the backslashed versions (like '\n')
4843 (UNI_DISPLAY_BACKSLASH is preferred over UNI_DISPLAY_ISPRINT for \\).
4844 UNI_DISPLAY_QQ (and its alias UNI_DISPLAY_REGEX) have both
4845 UNI_DISPLAY_BACKSLASH and UNI_DISPLAY_ISPRINT turned on.
4847 The pointer to the PV of the dsv is returned.
4849 char* pv_uni_display(SV *dsv, U8 *spv, STRLEN len, STRLEN pvlim, UV flags)
4852 Found in file utf8.c
4856 The encoding is assumed to be an Encode object, the PV of the ssv is
4857 assumed to be octets in that encoding and decoding the input starts
4858 from the position which (PV + *offset) pointed to. The dsv will be
4859 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
4860 when the string tstr appears in decoding output or the input ends on
4861 the PV of the ssv. The value which the offset points will be modified
4862 to the last input position on the ssv.
4864 Returns TRUE if the terminator was found, else returns FALSE.
4866 bool sv_cat_decode(SV* dsv, SV *encoding, SV *ssv, int *offset, char* tstr, int tlen)
4871 =item sv_recode_to_utf8
4873 The encoding is assumed to be an Encode object, on entry the PV
4874 of the sv is assumed to be octets in that encoding, and the sv
4875 will be converted into Unicode (and UTF-8).
4877 If the sv already is UTF-8 (or if it is not POK), or if the encoding
4878 is not a reference, nothing is done to the sv. If the encoding is not
4879 an C<Encode::XS> Encoding object, bad things will happen.
4880 (See F<lib/encoding.pm> and L<Encode>).
4882 The PV of the sv is returned.
4884 char* sv_recode_to_utf8(SV* sv, SV *encoding)
4889 =item sv_uni_display
4891 Build to the scalar dsv a displayable version of the scalar sv,
4892 the displayable version being at most pvlim bytes long
4893 (if longer, the rest is truncated and "..." will be appended).
4895 The flags argument is as in pv_uni_display().
4897 The pointer to the PV of the dsv is returned.
4899 char* sv_uni_display(SV *dsv, SV *ssv, STRLEN pvlim, UV flags)
4902 Found in file utf8.c
4906 The "p" contains the pointer to the UTF-8 string encoding
4907 the character that is being converted.
4909 The "ustrp" is a pointer to the character buffer to put the
4910 conversion result to. The "lenp" is a pointer to the length
4913 The "swashp" is a pointer to the swash to use.
4915 Both the special and normal mappings are stored lib/unicore/To/Foo.pl,
4916 and loaded by SWASHGET, using lib/utf8_heavy.pl. The special (usually,
4917 but not always, a multicharacter mapping), is tried first.
4919 The "special" is a string like "utf8::ToSpecLower", which means the
4920 hash %utf8::ToSpecLower. The access to the hash is through
4921 Perl_to_utf8_case().
4923 The "normal" is a string like "ToLower" which means the swash
4926 UV to_utf8_case(U8 *p, U8* ustrp, STRLEN *lenp, SV **swash, char *normal, char *special)
4929 Found in file utf8.c
4933 Convert the UTF-8 encoded character at p to its foldcase version and
4934 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
4935 that the ustrp needs to be at least UTF8_MAXLEN_FOLD+1 bytes since the
4936 foldcase version may be longer than the original character (up to
4939 The first character of the foldcased version is returned
4940 (but note, as explained above, that there may be more.)
4942 UV to_utf8_fold(U8 *p, U8* ustrp, STRLEN *lenp)
4945 Found in file utf8.c
4949 Convert the UTF-8 encoded character at p to its lowercase version and
4950 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
4951 that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the
4952 lowercase version may be longer than the original character (up to two
4955 The first character of the lowercased version is returned
4956 (but note, as explained above, that there may be more.)
4958 UV to_utf8_lower(U8 *p, U8* ustrp, STRLEN *lenp)
4961 Found in file utf8.c
4965 Convert the UTF-8 encoded character at p to its titlecase version and
4966 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
4967 that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the
4968 titlecase version may be longer than the original character (up to two
4971 The first character of the titlecased version is returned
4972 (but note, as explained above, that there may be more.)
4974 UV to_utf8_title(U8 *p, U8* ustrp, STRLEN *lenp)
4977 Found in file utf8.c
4981 Convert the UTF-8 encoded character at p to its uppercase version and
4982 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
4983 that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the
4984 uppercase version may be longer than the original character (up to two
4987 The first character of the uppercased version is returned
4988 (but note, as explained above, that there may be more.)
4990 UV to_utf8_upper(U8 *p, U8* ustrp, STRLEN *lenp)
4993 Found in file utf8.c
4995 =item utf8n_to_uvchr
4997 Returns the native character value of the first character in the string C<s>
4998 which is assumed to be in UTF8 encoding; C<retlen> will be set to the
4999 length, in bytes, of that character.
5001 Allows length and flags to be passed to low level routine.
5003 UV utf8n_to_uvchr(U8 *s, STRLEN curlen, STRLEN* retlen, U32 flags)
5006 Found in file utf8.c
5008 =item utf8n_to_uvuni
5010 Bottom level UTF-8 decode routine.
5011 Returns the unicode code point value of the first character in the string C<s>
5012 which is assumed to be in UTF8 encoding and no longer than C<curlen>;
5013 C<retlen> will be set to the length, in bytes, of that character.
5015 If C<s> does not point to a well-formed UTF8 character, the behaviour
5016 is dependent on the value of C<flags>: if it contains UTF8_CHECK_ONLY,
5017 it is assumed that the caller will raise a warning, and this function
5018 will silently just set C<retlen> to C<-1> and return zero. If the
5019 C<flags> does not contain UTF8_CHECK_ONLY, warnings about
5020 malformations will be given, C<retlen> will be set to the expected
5021 length of the UTF-8 character in bytes, and zero will be returned.
5023 The C<flags> can also contain various flags to allow deviations from
5024 the strict UTF-8 encoding (see F<utf8.h>).
5026 Most code should use utf8_to_uvchr() rather than call this directly.
5028 UV utf8n_to_uvuni(U8 *s, STRLEN curlen, STRLEN* retlen, U32 flags)
5031 Found in file utf8.c
5035 Returns the number of UTF8 characters between the UTF-8 pointers C<a>
5038 WARNING: use only if you *know* that the pointers point inside the
5041 IV utf8_distance(U8 *a, U8 *b)
5044 Found in file utf8.c
5048 Return the UTF-8 pointer C<s> displaced by C<off> characters, either
5049 forward or backward.
5051 WARNING: do not use the following unless you *know* C<off> is within
5052 the UTF-8 data pointed to by C<s> *and* that on entry C<s> is aligned
5053 on the first byte of character or just after the last byte of a character.
5055 U8* utf8_hop(U8 *s, I32 off)
5058 Found in file utf8.c
5062 Return the length of the UTF-8 char encoded string C<s> in characters.
5063 Stops at C<e> (inclusive). If C<e E<lt> s> or if the scan would end
5064 up past C<e>, croaks.
5066 STRLEN utf8_length(U8* s, U8 *e)
5069 Found in file utf8.c
5073 Converts a string C<s> of length C<len> from UTF8 into byte encoding.
5074 Unlike C<bytes_to_utf8>, this over-writes the original string, and
5075 updates len to contain the new length.
5076 Returns zero on failure, setting C<len> to -1.
5078 NOTE: this function is experimental and may change or be
5079 removed without notice.
5081 U8* utf8_to_bytes(U8 *s, STRLEN *len)
5084 Found in file utf8.c
5088 Returns the native character value of the first character in the string C<s>
5089 which is assumed to be in UTF8 encoding; C<retlen> will be set to the
5090 length, in bytes, of that character.
5092 If C<s> does not point to a well-formed UTF8 character, zero is
5093 returned and retlen is set, if possible, to -1.
5095 UV utf8_to_uvchr(U8 *s, STRLEN* retlen)
5098 Found in file utf8.c
5102 Returns the Unicode code point of the first character in the string C<s>
5103 which is assumed to be in UTF8 encoding; C<retlen> will be set to the
5104 length, in bytes, of that character.
5106 This function should only be used when returned UV is considered
5107 an index into the Unicode semantic tables (e.g. swashes).
5109 If C<s> does not point to a well-formed UTF8 character, zero is
5110 returned and retlen is set, if possible, to -1.
5112 UV utf8_to_uvuni(U8 *s, STRLEN* retlen)
5115 Found in file utf8.c
5119 Adds the UTF8 representation of the Native codepoint C<uv> to the end
5120 of the string C<d>; C<d> should be have at least C<UTF8_MAXLEN+1> free
5121 bytes available. The return value is the pointer to the byte after the
5122 end of the new character. In other words,
5124 d = uvchr_to_utf8(d, uv);
5126 is the recommended wide native character-aware way of saying
5130 U8* uvchr_to_utf8(U8 *d, UV uv)
5133 Found in file utf8.c
5135 =item uvuni_to_utf8_flags
5137 Adds the UTF8 representation of the Unicode codepoint C<uv> to the end
5138 of the string C<d>; C<d> should be have at least C<UTF8_MAXLEN+1> free
5139 bytes available. The return value is the pointer to the byte after the
5140 end of the new character. In other words,
5142 d = uvuni_to_utf8_flags(d, uv, flags);
5146 d = uvuni_to_utf8(d, uv);
5148 (which is equivalent to)
5150 d = uvuni_to_utf8_flags(d, uv, 0);
5152 is the recommended Unicode-aware way of saying
5156 U8* uvuni_to_utf8_flags(U8 *d, UV uv, UV flags)
5159 Found in file utf8.c
5164 =head1 Variables created by C<xsubpp> and C<xsubpp> internal functions
5170 Variable which is setup by C<xsubpp> to indicate the stack base offset,
5171 used by the C<ST>, C<XSprePUSH> and C<XSRETURN> macros. The C<dMARK> macro
5172 must be called prior to setup the C<MARK> variable.
5177 Found in file XSUB.h
5181 Variable which is setup by C<xsubpp> to indicate the
5182 class name for a C++ XS constructor. This is always a C<char*>. See C<THIS>.
5187 Found in file XSUB.h
5191 Sets up the C<ax> variable.
5192 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
5197 Found in file XSUB.h
5201 Sets up the C<items> variable.
5202 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
5207 Found in file XSUB.h
5211 Sets up stack and mark pointers for an XSUB, calling dSP and dMARK.
5212 Sets up the C<ax> and C<items> variables by calling C<dAX> and C<dITEMS>.
5213 This is usually handled automatically by C<xsubpp>.
5218 Found in file XSUB.h
5222 Sets up the C<ix> variable for an XSUB which has aliases. This is usually
5223 handled automatically by C<xsubpp>.
5228 Found in file XSUB.h
5232 Variable which is setup by C<xsubpp> to indicate the number of
5233 items on the stack. See L<perlxs/"Variable-length Parameter Lists">.
5238 Found in file XSUB.h
5242 Variable which is setup by C<xsubpp> to indicate which of an
5243 XSUB's aliases was used to invoke it. See L<perlxs/"The ALIAS: Keyword">.
5248 Found in file XSUB.h
5252 Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
5256 Found in file XSUB.h
5260 Variable which is setup by C<xsubpp> to hold the return value for an
5261 XSUB. This is always the proper type for the XSUB. See
5262 L<perlxs/"The RETVAL Variable">.
5267 Found in file XSUB.h
5271 Used to access elements on the XSUB's stack.
5276 Found in file XSUB.h
5280 Variable which is setup by C<xsubpp> to designate the object in a C++
5281 XSUB. This is always the proper type for the C++ object. See C<CLASS> and
5282 L<perlxs/"Using XS With C++">.
5287 Found in file XSUB.h
5291 Macro to declare an XSUB and its C parameter list. This is handled by
5295 Found in file XSUB.h
5297 =item XSRETURN_EMPTY
5299 Return an empty list from an XSUB immediately.
5305 Found in file XSUB.h
5309 The version identifier for an XS module. This is usually
5310 handled automatically by C<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>.
5313 Found in file XSUB.h
5315 =item XS_VERSION_BOOTCHECK
5317 Macro to verify that a PM module's $VERSION variable matches the XS
5318 module's C<XS_VERSION> variable. This is usually handled automatically by
5319 C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">.
5321 XS_VERSION_BOOTCHECK;
5324 Found in file XSUB.h
5329 =head1 Warning and Dieing
5335 This is the XSUB-writer's interface to Perl's C<die> function.
5336 Normally use this function the same way you use the C C<printf>
5337 function. See C<warn>.
5339 If you want to throw an exception object, assign the object to
5340 C<$@> and then pass C<Nullch> to croak():
5342 errsv = get_sv("@", TRUE);
5343 sv_setsv(errsv, exception_object);
5346 void croak(const char* pat, ...)
5349 Found in file util.c
5353 This is the XSUB-writer's interface to Perl's C<warn> function. Use this
5354 function the same way you use the C C<printf> function. See
5357 void warn(const char* pat, ...)
5360 Found in file util.c
5367 Until May 1997, this document was maintained by Jeff Okamoto
5368 <okamoto@corp.hp.com>. It is now maintained as part of Perl itself.
5370 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
5371 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
5372 Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
5373 Stephen McCamant, and Gurusamy Sarathy.
5375 API Listing originally by Dean Roehrich <roehrich@cray.com>.
5377 Updated to be autogenerated from comments in the source by Benjamin Stuhl.
5381 perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
projects / p5sagit/p5-mst-13.2.git / blob