3 perlapi - autogenerated documentation for the perl public API
7 This file contains the documentation of the perl public API generated by
8 embed.pl, specifically a listing of functions, macros, flags, and variables
9 that may be used by extension writers. The interfaces of any functions that
10 are not listed here are subject to change without notice. For this reason,
11 blindly using functions listed in proto.h is to be avoided when writing
14 Note that all Perl API global variables must be referenced with the C<PL_>
15 prefix. Some macros are provided for compatibility with the older,
16 unadorned names, but this support may be disabled in a future release.
18 The listing is alphabetical, case insensitive.
27 A backward-compatible version of C<GIMME_V> which can only return
28 C<G_SCALAR> or C<G_ARRAY>; in a void context, it returns C<G_SCALAR>.
29 Deprecated. Use C<GIMME_V> instead.
38 The XSUB-writer's equivalent to Perl's C<wantarray>. Returns C<G_VOID>,
39 C<G_SCALAR> or C<G_ARRAY> for void, scalar or list context,
49 Used to indicate list context. See C<GIMME_V>, C<GIMME> and
57 Indicates that arguments returned from a callback should be discarded. See
65 Used to force a Perl C<eval> wrapper around a callback. See
73 Indicates that no arguments are being sent to a callback. See
81 Used to indicate scalar context. See C<GIMME_V>, C<GIMME>, and
89 Used to indicate void context. See C<GIMME_V> and L<perlcall>.
97 =head1 Array Manipulation Functions
103 Same as C<av_len()>. Deprecated, use C<av_len()> instead.
112 Clears an array, making it empty. Does not free the memory used by the
115 void av_clear(AV* ar)
122 Deletes the element indexed by C<key> from the array. Returns the
123 deleted element. C<flags> is currently ignored.
125 SV* av_delete(AV* ar, I32 key, I32 flags)
132 Returns true if the element indexed by C<key> has been initialized.
134 This relies on the fact that uninitialized array elements are set to
137 bool av_exists(AV* ar, I32 key)
144 Pre-extend an array. The C<key> is the index to which the array should be
147 void av_extend(AV* ar, I32 key)
154 Returns the SV at the specified index in the array. The C<key> is the
155 index. If C<lval> is set then the fetch will be part of a store. Check
156 that the return value is non-null before dereferencing it to a C<SV*>.
158 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for
159 more information on how to use this function on tied arrays.
161 SV** av_fetch(AV* ar, I32 key, I32 lval)
168 Ensure than an array has a given number of elements, equivalent to
169 Perl's C<$#array = $fill;>.
171 void av_fill(AV* ar, I32 fill)
178 Returns the highest index in the array. Returns -1 if the array is
188 Creates a new AV and populates it with a list of SVs. The SVs are copied
189 into the array, so they may be freed after the call to av_make. The new AV
190 will have a reference count of 1.
192 AV* av_make(I32 size, SV** svp)
199 Pops an SV off the end of the array. Returns C<&PL_sv_undef> if the array
209 Pushes an SV onto the end of the array. The array will grow automatically
210 to accommodate the addition.
212 void av_push(AV* ar, SV* val)
219 Shifts an SV off the beginning of the array.
228 Stores an SV in an array. The array index is specified as C<key>. The
229 return value will be NULL if the operation failed or if the value did not
230 need to be actually stored within the array (as in the case of tied
231 arrays). Otherwise it can be dereferenced to get the original C<SV*>. Note
232 that the caller is responsible for suitably incrementing the reference
233 count of C<val> before the call, and decrementing it if the function
236 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for
237 more information on how to use this function on tied arrays.
239 SV** av_store(AV* ar, I32 key, SV* val)
246 Undefines the array. Frees the memory used by the array itself.
248 void av_undef(AV* ar)
255 Unshift the given number of C<undef> values onto the beginning of the
256 array. The array will grow automatically to accommodate the addition. You
257 must then use C<av_store> to assign values to these new elements.
259 void av_unshift(AV* ar, I32 num)
266 Returns the AV of the specified Perl array. If C<create> is set and the
267 Perl variable does not exist then it will be created. If C<create> is not
268 set and the variable does not exist then NULL is returned.
270 NOTE: the perl_ form of this function is deprecated.
272 AV* get_av(const char* name, I32 create)
279 Creates a new AV. The reference count is set to 1.
296 Sort an array. Here is an example:
298 sortsv(AvARRAY(av), av_len(av)+1, Perl_sv_cmp_locale);
300 See lib/sort.pm for details about controlling the sorting algorithm.
302 void sortsv(SV ** array, size_t num_elts, SVCOMPARE_t cmp)
305 Found in file pp_sort.c
310 =head1 Callback Functions
316 Performs a callback to the specified Perl sub. See L<perlcall>.
318 NOTE: the perl_ form of this function is deprecated.
320 I32 call_argv(const char* sub_name, I32 flags, char** argv)
327 Performs a callback to the specified Perl method. The blessed object must
328 be on the stack. See L<perlcall>.
330 NOTE: the perl_ form of this function is deprecated.
332 I32 call_method(const char* methname, I32 flags)
339 Performs a callback to the specified Perl sub. See L<perlcall>.
341 NOTE: the perl_ form of this function is deprecated.
343 I32 call_pv(const char* sub_name, I32 flags)
350 Performs a callback to the Perl sub whose name is in the SV. See
353 NOTE: the perl_ form of this function is deprecated.
355 I32 call_sv(SV* sv, I32 flags)
362 Opening bracket on a callback. See C<LEAVE> and L<perlcall>.
367 Found in file scope.h
371 Tells Perl to C<eval> the given string and return an SV* result.
373 NOTE: the perl_ form of this function is deprecated.
375 SV* eval_pv(const char* p, I32 croak_on_error)
382 Tells Perl to C<eval> the string in the SV.
384 NOTE: the perl_ form of this function is deprecated.
386 I32 eval_sv(SV* sv, I32 flags)
393 Closing bracket for temporaries on a callback. See C<SAVETMPS> and
399 Found in file scope.h
403 Closing bracket on a callback. See C<ENTER> and L<perlcall>.
408 Found in file scope.h
412 Opening bracket for temporaries on a callback. See C<FREETMPS> and
418 Found in file scope.h
423 =head1 Character classes
429 Returns a boolean indicating whether the C C<char> is an ASCII alphanumeric
430 character (including underscore) or digit.
432 bool isALNUM(char ch)
435 Found in file handy.h
439 Returns a boolean indicating whether the C C<char> is an ASCII alphabetic
442 bool isALPHA(char ch)
445 Found in file handy.h
449 Returns a boolean indicating whether the C C<char> is an ASCII
452 bool isDIGIT(char ch)
455 Found in file handy.h
459 Returns a boolean indicating whether the C C<char> is a lowercase
462 bool isLOWER(char ch)
465 Found in file handy.h
469 Returns a boolean indicating whether the C C<char> is whitespace.
471 bool isSPACE(char ch)
474 Found in file handy.h
478 Returns a boolean indicating whether the C C<char> is an uppercase
481 bool isUPPER(char ch)
484 Found in file handy.h
488 Converts the specified character to lowercase.
490 char toLOWER(char ch)
493 Found in file handy.h
497 Converts the specified character to uppercase.
499 char toUPPER(char ch)
502 Found in file handy.h
507 =head1 Cloning an interpreter
513 Create and return a new interpreter by cloning the current one.
515 perl_clone takes these flags as parameters:
517 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
518 without it we only clone the data and zero the stacks,
519 with it we copy the stacks and the new perl interpreter is
520 ready to run at the exact same point as the previous one.
521 The pseudo-fork code uses COPY_STACKS while the
522 threads->new doesn't.
524 CLONEf_KEEP_PTR_TABLE
525 perl_clone keeps a ptr_table with the pointer of the old
526 variable as a key and the new variable as a value,
527 this allows it to check if something has been cloned and not
528 clone it again but rather just use the value and increase the
529 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
530 the ptr_table using the function
531 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
532 reason to keep it around is if you want to dup some of your own
533 variable who are outside the graph perl scans, example of this
534 code is in threads.xs create
537 This is a win32 thing, it is ignored on unix, it tells perls
538 win32host code (which is c++) to clone itself, this is needed on
539 win32 if you want to run two threads at the same time,
540 if you just want to do some stuff in a separate perl interpreter
541 and then throw it away and return to the original one,
542 you don't need to do anything.
544 PerlInterpreter* perl_clone(PerlInterpreter* interp, UV flags)
552 =head1 CV Manipulation Functions
558 Returns the stash of the CV.
567 Returns the CV of the specified Perl subroutine. If C<create> is set and
568 the Perl subroutine does not exist then it will be declared (which has the
569 same effect as saying C<sub name;>). If C<create> is not set and the
570 subroutine does not exist then NULL is returned.
572 NOTE: the perl_ form of this function is deprecated.
574 CV* get_cv(const char* name, I32 create)
590 =head1 Embedding Functions
596 Clear out all the active components of a CV. This can happen either
597 by an explicit C<undef &foo>, or by the reference count going to zero.
598 In the former case, we keep the CvOUTSIDE pointer, so that any anonymous
599 children can still follow the full lexical scope chain.
601 void cv_undef(CV* cv)
608 Loads the module whose name is pointed to by the string part of name.
609 Note that the actual module name, not its filename, should be given.
610 Eg, "Foo::Bar" instead of "Foo/Bar.pm". flags can be any of
611 PERL_LOADMOD_DENY, PERL_LOADMOD_NOIMPORT, or PERL_LOADMOD_IMPORT_OPS
612 (or 0 for no flags). ver, if specified, provides version semantics
613 similar to C<use Foo::Bar VERSION>. The optional trailing SV*
614 arguments can be used to specify arguments to the module's import()
615 method, similar to C<use Foo::Bar VERSION LIST>.
617 void load_module(U32 flags, SV* name, SV* ver, ...)
624 Stub that provides thread hook for perl_destruct when there are
634 Allocates a new Perl interpreter. See L<perlembed>.
636 PerlInterpreter* perl_alloc()
643 Initializes a new Perl interpreter. See L<perlembed>.
645 void perl_construct(PerlInterpreter* interp)
652 Shuts down a Perl interpreter. See L<perlembed>.
654 int perl_destruct(PerlInterpreter* interp)
661 Releases a Perl interpreter. See L<perlembed>.
663 void perl_free(PerlInterpreter* interp)
670 Tells a Perl interpreter to parse a Perl script. See L<perlembed>.
672 int perl_parse(PerlInterpreter* interp, XSINIT_t xsinit, int argc, char** argv, char** env)
679 Tells a Perl interpreter to run. See L<perlembed>.
681 int perl_run(PerlInterpreter* interp)
688 Tells Perl to C<require> the file named by the string argument. It is
689 analogous to the Perl code C<eval "require '$file'">. It's even
690 implemented that way; consider using load_module instead.
692 NOTE: the perl_ form of this function is deprecated.
694 void require_pv(const char* pv)
702 =head1 Functions in file pp_pack.c
709 The engine implementing pack() Perl function.
711 void packlist(SV *cat, char *pat, char *patend, SV **beglist, SV **endlist)
714 Found in file pp_pack.c
718 The engine implementing pack() Perl function. Note: parameters next_in_list and
719 flags are not used. This call should not be used; use packlist instead.
721 void pack_cat(SV *cat, char *pat, char *patend, SV **beglist, SV **endlist, SV ***next_in_list, U32 flags)
724 Found in file pp_pack.c
728 The engine implementing unpack() Perl function. C<unpackstring> puts the
729 extracted list items on the stack and returns the number of elements.
730 Issue C<PUTBACK> before and C<SPAGAIN> after the call to this function.
732 I32 unpackstring(char *pat, char *patend, char *s, char *strend, U32 flags)
735 Found in file pp_pack.c
739 The engine implementing unpack() Perl function. Note: parameters strbeg, new_s
740 and ocnt are not used. This call should not be used, use unpackstring instead.
742 I32 unpack_str(char *pat, char *patend, char *s, char *strbeg, char *strend, char **new_s, I32 ocnt, U32 flags)
745 Found in file pp_pack.c
750 =head1 Global Variables
756 C<PL_modglobal> is a general purpose, interpreter global HV for use by
757 extensions that need to keep information on a per-interpreter basis.
758 In a pinch, it can also be used as a symbol table for extensions
759 to share data among each other. It is a good idea to use keys
760 prefixed by the package name of the extension that owns the data.
765 Found in file intrpvar.h
769 A convenience variable which is typically used with C<SvPV> when one
770 doesn't care about the length of the string. It is usually more efficient
771 to either declare a local variable and use that instead or to use the
777 Found in file thrdvar.h
781 This is the C<false> SV. See C<PL_sv_yes>. Always refer to this as
787 Found in file intrpvar.h
791 This is the C<undef> SV. Always refer to this as C<&PL_sv_undef>.
796 Found in file intrpvar.h
800 This is the C<true> SV. See C<PL_sv_no>. Always refer to this as
806 Found in file intrpvar.h
817 Return the SV from the GV.
826 Returns the glob with the given C<name> and a defined subroutine or
827 C<NULL>. The glob lives in the given C<stash>, or in the stashes
828 accessible via @ISA and UNIVERSAL::.
830 The argument C<level> should be either 0 or -1. If C<level==0>, as a
831 side-effect creates a glob with the given C<name> in the given C<stash>
832 which in the case of success contains an alias for the subroutine, and sets
833 up caching info for this glob. Similarly for all the searched stashes.
835 This function grants C<"SUPER"> token as a postfix of the stash name. The
836 GV returned from C<gv_fetchmeth> may be a method cache entry, which is not
837 visible to Perl code. So when calling C<call_sv>, you should not use
838 the GV directly; instead, you should use the method's CV, which can be
839 obtained from the GV with the C<GvCV> macro.
841 GV* gv_fetchmeth(HV* stash, const char* name, STRLEN len, I32 level)
848 See L<gv_fetchmethod_autoload>.
850 GV* gv_fetchmethod(HV* stash, const char* name)
855 =item gv_fetchmethod_autoload
857 Returns the glob which contains the subroutine to call to invoke the method
858 on the C<stash>. In fact in the presence of autoloading this may be the
859 glob for "AUTOLOAD". In this case the corresponding variable $AUTOLOAD is
862 The third parameter of C<gv_fetchmethod_autoload> determines whether
863 AUTOLOAD lookup is performed if the given method is not present: non-zero
864 means yes, look for AUTOLOAD; zero means no, don't look for AUTOLOAD.
865 Calling C<gv_fetchmethod> is equivalent to calling C<gv_fetchmethod_autoload>
866 with a non-zero C<autoload> parameter.
868 These functions grant C<"SUPER"> token as a prefix of the method name. Note
869 that if you want to keep the returned glob for a long time, you need to
870 check for it being "AUTOLOAD", since at the later time the call may load a
871 different subroutine due to $AUTOLOAD changing its value. Use the glob
872 created via a side effect to do this.
874 These functions have the same side-effects and as C<gv_fetchmeth> with
875 C<level==0>. C<name> should be writable if contains C<':'> or C<'
876 ''>. The warning against passing the GV returned by C<gv_fetchmeth> to
877 C<call_sv> apply equally to these functions.
879 GV* gv_fetchmethod_autoload(HV* stash, const char* name, I32 autoload)
884 =item gv_fetchmeth_autoload
886 Same as gv_fetchmeth(), but looks for autoloaded subroutines too.
887 Returns a glob for the subroutine.
889 For an autoloaded subroutine without a GV, will create a GV even
890 if C<level < 0>. For an autoloaded subroutine without a stub, GvCV()
891 of the result may be zero.
893 GV* gv_fetchmeth_autoload(HV* stash, const char* name, STRLEN len, I32 level)
900 Returns a pointer to the stash for a specified package. C<name> should
901 be a valid UTF-8 string. If C<create> is set then the package will be
902 created if it does not already exist. If C<create> is not set and the
903 package does not exist then NULL is returned.
905 HV* gv_stashpv(const char* name, I32 create)
912 Returns a pointer to the stash for a specified package, which must be a
913 valid UTF-8 string. See C<gv_stashpv>.
915 HV* gv_stashsv(SV* sv, I32 create)
929 This flag, used in the length slot of hash entries and magic structures,
930 specifies the structure contains an C<SV*> pointer where a C<char*> pointer
931 is to be expected. (For information only--not to be used).
939 Null character pointer.
942 Found in file handy.h
949 Found in file handy.h
954 =head1 Hash Manipulation Functions
960 Returns the HV of the specified Perl hash. If C<create> is set and the
961 Perl variable does not exist then it will be created. If C<create> is not
962 set and the variable does not exist then NULL is returned.
964 NOTE: the perl_ form of this function is deprecated.
966 HV* get_hv(const char* name, I32 create)
973 Returns the computed hash stored in the hash entry.
982 Returns the actual pointer stored in the key slot of the hash entry. The
983 pointer may be either C<char*> or C<SV*>, depending on the value of
984 C<HeKLEN()>. Can be assigned to. The C<HePV()> or C<HeSVKEY()> macros are
985 usually preferable for finding the value of a key.
994 If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry
995 holds an C<SV*> key. Otherwise, holds the actual length of the key. Can
996 be assigned to. The C<HePV()> macro is usually preferable for finding key
999 STRLEN HeKLEN(HE* he)
1006 Returns the key slot of the hash entry as a C<char*> value, doing any
1007 necessary dereferencing of possibly C<SV*> keys. The length of the string
1008 is placed in C<len> (this is a macro, so do I<not> use C<&len>). If you do
1009 not care about what the length of the key is, you may use the global
1010 variable C<PL_na>, though this is rather less efficient than using a local
1011 variable. Remember though, that hash keys in perl are free to contain
1012 embedded nulls, so using C<strlen()> or similar is not a good way to find
1013 the length of hash keys. This is very similar to the C<SvPV()> macro
1014 described elsewhere in this document.
1016 char* HePV(HE* he, STRLEN len)
1023 Returns the key as an C<SV*>, or C<Nullsv> if the hash entry does not
1024 contain an C<SV*> key.
1033 Returns the key as an C<SV*>. Will create and return a temporary mortal
1034 C<SV*> if the hash entry contains only a C<char*> key.
1036 SV* HeSVKEY_force(HE* he)
1043 Sets the key to a given C<SV*>, taking care to set the appropriate flags to
1044 indicate the presence of an C<SV*> key, and returns the same
1047 SV* HeSVKEY_set(HE* he, SV* sv)
1054 Returns the value slot (type C<SV*>) stored in the hash entry.
1063 Returns the package name of a stash. See C<SvSTASH>, C<CvSTASH>.
1065 char* HvNAME(HV* stash)
1072 Check that a hash is in an internally consistent state.
1074 void hv_assert(HV* tb)
1081 Clears a hash, making it empty.
1083 void hv_clear(HV* tb)
1090 Deletes a key/value pair in the hash. The value SV is removed from the
1091 hash and returned to the caller. The C<klen> is the length of the key.
1092 The C<flags> value will normally be zero; if set to G_DISCARD then NULL
1095 SV* hv_delete(HV* tb, const char* key, I32 klen, I32 flags)
1102 Deletes a key/value pair in the hash. The value SV is removed from the
1103 hash and returned to the caller. The C<flags> value will normally be zero;
1104 if set to G_DISCARD then NULL will be returned. C<hash> can be a valid
1105 precomputed hash value, or 0 to ask for it to be computed.
1107 SV* hv_delete_ent(HV* tb, SV* key, I32 flags, U32 hash)
1114 Returns a boolean indicating whether the specified hash key exists. The
1115 C<klen> is the length of the key.
1117 bool hv_exists(HV* tb, const char* key, I32 klen)
1124 Returns a boolean indicating whether the specified hash key exists. C<hash>
1125 can be a valid precomputed hash value, or 0 to ask for it to be
1128 bool hv_exists_ent(HV* tb, SV* key, U32 hash)
1135 Returns the SV which corresponds to the specified key in the hash. The
1136 C<klen> is the length of the key. If C<lval> is set then the fetch will be
1137 part of a store. Check that the return value is non-null before
1138 dereferencing it to an C<SV*>.
1140 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1141 information on how to use this function on tied hashes.
1143 SV** hv_fetch(HV* tb, const char* key, I32 klen, I32 lval)
1150 Returns the hash entry which corresponds to the specified key in the hash.
1151 C<hash> must be a valid precomputed hash number for the given C<key>, or 0
1152 if you want the function to compute it. IF C<lval> is set then the fetch
1153 will be part of a store. Make sure the return value is non-null before
1154 accessing it. The return value when C<tb> is a tied hash is a pointer to a
1155 static location, so be sure to make a copy of the structure if you need to
1158 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1159 information on how to use this function on tied hashes.
1161 HE* hv_fetch_ent(HV* tb, SV* key, I32 lval, U32 hash)
1168 Prepares a starting point to traverse a hash table. Returns the number of
1169 keys in the hash (i.e. the same as C<HvKEYS(tb)>). The return value is
1170 currently only meaningful for hashes without tie magic.
1172 NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
1173 hash buckets that happen to be in use. If you still need that esoteric
1174 value, you can get it through the macro C<HvFILL(tb)>.
1177 I32 hv_iterinit(HV* tb)
1184 Returns the key from the current position of the hash iterator. See
1187 char* hv_iterkey(HE* entry, I32* retlen)
1194 Returns the key as an C<SV*> from the current position of the hash
1195 iterator. The return value will always be a mortal copy of the key. Also
1198 SV* hv_iterkeysv(HE* entry)
1205 Returns entries from a hash iterator. See C<hv_iterinit>.
1207 You may call C<hv_delete> or C<hv_delete_ent> on the hash entry that the
1208 iterator currently points to, without losing your place or invalidating your
1209 iterator. Note that in this case the current entry is deleted from the hash
1210 with your iterator holding the last reference to it. Your iterator is flagged
1211 to free the entry on the next call to C<hv_iternext>, so you must not discard
1212 your iterator immediately else the entry will leak - call C<hv_iternext> to
1213 trigger the resource deallocation.
1215 HE* hv_iternext(HV* tb)
1222 Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
1225 SV* hv_iternextsv(HV* hv, char** key, I32* retlen)
1230 =item hv_iternext_flags
1232 Returns entries from a hash iterator. See C<hv_iterinit> and C<hv_iternext>.
1233 The C<flags> value will normally be zero; if HV_ITERNEXT_WANTPLACEHOLDERS is
1234 set the placeholders keys (for restricted hashes) will be returned in addition
1235 to normal keys. By default placeholders are automatically skipped over.
1236 Currently a placeholder is implemented with a value that is
1237 C<&Perl_sv_placeholder>. Note that the implementation of placeholders and
1238 restricted hashes may change, and the implementation currently is
1239 insufficiently abstracted for any change to be tidy.
1241 NOTE: this function is experimental and may change or be
1242 removed without notice.
1244 HE* hv_iternext_flags(HV* tb, I32 flags)
1251 Returns the value from the current position of the hash iterator. See
1254 SV* hv_iterval(HV* tb, HE* entry)
1261 Adds magic to a hash. See C<sv_magic>.
1263 void hv_magic(HV* hv, GV* gv, int how)
1270 Stores an SV in a hash. The hash key is specified as C<key> and C<klen> is
1271 the length of the key. The C<hash> parameter is the precomputed hash
1272 value; if it is zero then Perl will compute it. The return value will be
1273 NULL if the operation failed or if the value did not need to be actually
1274 stored within the hash (as in the case of tied hashes). Otherwise it can
1275 be dereferenced to get the original C<SV*>. Note that the caller is
1276 responsible for suitably incrementing the reference count of C<val> before
1277 the call, and decrementing it if the function returned NULL. Effectively
1278 a successful hv_store takes ownership of one reference to C<val>. This is
1279 usually what you want; a newly created SV has a reference count of one, so
1280 if all your code does is create SVs then store them in a hash, hv_store
1281 will own the only reference to the new SV, and your code doesn't need to do
1282 anything further to tidy up. hv_store is not implemented as a call to
1283 hv_store_ent, and does not create a temporary SV for the key, so if your
1284 key data is not already in SV form then use hv_store in preference to
1287 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1288 information on how to use this function on tied hashes.
1290 SV** hv_store(HV* tb, const char* key, I32 klen, SV* val, U32 hash)
1297 Stores C<val> in a hash. The hash key is specified as C<key>. The C<hash>
1298 parameter is the precomputed hash value; if it is zero then Perl will
1299 compute it. The return value is the new hash entry so created. It will be
1300 NULL if the operation failed or if the value did not need to be actually
1301 stored within the hash (as in the case of tied hashes). Otherwise the
1302 contents of the return value can be accessed using the C<He?> macros
1303 described here. Note that the caller is responsible for suitably
1304 incrementing the reference count of C<val> before the call, and
1305 decrementing it if the function returned NULL. Effectively a successful
1306 hv_store_ent takes ownership of one reference to C<val>. This is
1307 usually what you want; a newly created SV has a reference count of one, so
1308 if all your code does is create SVs then store them in a hash, hv_store
1309 will own the only reference to the new SV, and your code doesn't need to do
1310 anything further to tidy up. Note that hv_store_ent only reads the C<key>;
1311 unlike C<val> it does not take ownership of it, so maintaining the correct
1312 reference count on C<key> is entirely the caller's responsibility. hv_store
1313 is not implemented as a call to hv_store_ent, and does not create a temporary
1314 SV for the key, so if your key data is not already in SV form then use
1315 hv_store in preference to hv_store_ent.
1317 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1318 information on how to use this function on tied hashes.
1320 HE* hv_store_ent(HV* tb, SV* key, SV* val, U32 hash)
1329 void hv_undef(HV* tb)
1336 Creates a new HV. The reference count is set to 1.
1354 =head1 Magical Functions
1360 Clear something magical that the SV represents. See C<sv_magic>.
1362 int mg_clear(SV* sv)
1369 Copies the magic from one SV to another. See C<sv_magic>.
1371 int mg_copy(SV* sv, SV* nsv, const char* key, I32 klen)
1378 Finds the magic pointer for type matching the SV. See C<sv_magic>.
1380 MAGIC* mg_find(SV* sv, int type)
1387 Free any magic storage used by the SV. See C<sv_magic>.
1396 Do magic after a value is retrieved from the SV. See C<sv_magic>.
1405 Report on the SV's length. See C<sv_magic>.
1407 U32 mg_length(SV* sv)
1414 Turns on the magical status of an SV. See C<sv_magic>.
1416 void mg_magical(SV* sv)
1423 Do magic after a value is assigned to the SV. See C<sv_magic>.
1432 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
1433 argument more than once.
1435 void SvGETMAGIC(SV* sv)
1442 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
1452 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
1453 argument more than once.
1455 void SvSETMAGIC(SV* sv)
1462 Like C<SvSetSV>, but does any set magic required afterwards.
1464 void SvSetMagicSV(SV* dsb, SV* ssv)
1469 =item SvSetMagicSV_nosteal
1471 Like C<SvSetMagicSV>, but does any set magic required afterwards.
1473 void SvSetMagicSV_nosteal(SV* dsv, SV* ssv)
1480 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
1483 void SvSetSV(SV* dsb, SV* ssv)
1488 =item SvSetSV_nosteal
1490 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
1491 ssv. May evaluate arguments more than once.
1493 void SvSetSV_nosteal(SV* dsv, SV* ssv)
1500 Arranges for sv to be shared between threads if a suitable module
1503 void SvSHARE(SV* sv)
1511 =head1 Memory Management
1517 The XSUB-writer's interface to the C C<memcpy> function. The C<src> is the
1518 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1519 the type. May fail on overlapping copies. See also C<Move>.
1521 void Copy(void* src, void* dest, int nitems, type)
1524 Found in file handy.h
1528 The XSUB-writer's interface to the C C<memmove> function. The C<src> is the
1529 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1530 the type. Can do overlapping moves. See also C<Copy>.
1532 void Move(void* src, void* dest, int nitems, type)
1535 Found in file handy.h
1539 The XSUB-writer's interface to the C C<malloc> function.
1541 void New(int id, void* ptr, int nitems, type)
1544 Found in file handy.h
1548 The XSUB-writer's interface to the C C<malloc> function, with
1551 void Newc(int id, void* ptr, int nitems, type, cast)
1554 Found in file handy.h
1558 Creates a new SV. A non-zero C<len> parameter indicates the number of
1559 bytes of preallocated string space the SV should have. An extra byte for a
1560 tailing NUL is also reserved. (SvPOK is not set for the SV even if string
1561 space is allocated.) The reference count for the new SV is set to 1.
1562 C<id> is an integer id between 0 and 1299 (used to identify leaks).
1565 SV* NEWSV(int id, STRLEN len)
1568 Found in file handy.h
1572 The XSUB-writer's interface to the C C<malloc> function. The allocated
1573 memory is zeroed with C<memzero>.
1575 void Newz(int id, void* ptr, int nitems, type)
1578 Found in file handy.h
1582 Fill up memory with a pattern (byte 0xAB over and over again) that
1583 hopefully catches attempts to access uninitialized memory.
1585 void Poison(void* dest, int nitems, type)
1588 Found in file handy.h
1592 The XSUB-writer's interface to the C C<realloc> function.
1594 void Renew(void* ptr, int nitems, type)
1597 Found in file handy.h
1601 The XSUB-writer's interface to the C C<realloc> function, with
1604 void Renewc(void* ptr, int nitems, type, cast)
1607 Found in file handy.h
1611 The XSUB-writer's interface to the C C<free> function.
1613 void Safefree(void* ptr)
1616 Found in file handy.h
1620 Perl's version of C<strdup()>. Returns a pointer to a newly allocated
1621 string which is a duplicate of C<pv>. The size of the string is
1622 determined by C<strlen()>. The memory allocated for the new string can
1623 be freed with the C<Safefree()> function.
1625 char* savepv(const char* pv)
1628 Found in file util.c
1632 Perl's version of what C<strndup()> would be if it existed. Returns a
1633 pointer to a newly allocated string which is a duplicate of the first
1634 C<len> bytes from C<pv>. The memory allocated for the new string can be
1635 freed with the C<Safefree()> function.
1637 char* savepvn(const char* pv, I32 len)
1640 Found in file util.c
1644 A version of C<savepv()> which allocates the duplicate string in memory
1645 which is shared between threads.
1647 char* savesharedpv(const char* pv)
1650 Found in file util.c
1654 This is an architecture-independent macro to copy one structure to another.
1656 void StructCopy(type src, type dest, type)
1659 Found in file handy.h
1663 The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the
1664 destination, C<nitems> is the number of items, and C<type> is the type.
1666 void Zero(void* dest, int nitems, type)
1669 Found in file handy.h
1674 =head1 Miscellaneous Functions
1680 Analyses the string in order to make fast searches on it using fbm_instr()
1681 -- the Boyer-Moore algorithm.
1683 void fbm_compile(SV* sv, U32 flags)
1686 Found in file util.c
1690 Returns the location of the SV in the string delimited by C<str> and
1691 C<strend>. It returns C<Nullch> if the string can't be found. The C<sv>
1692 does not have to be fbm_compiled, but the search will not be as fast
1695 char* fbm_instr(unsigned char* big, unsigned char* bigend, SV* littlesv, U32 flags)
1698 Found in file util.c
1702 Takes a sprintf-style format pattern and conventional
1703 (non-SV) arguments and returns the formatted string.
1705 (char *) Perl_form(pTHX_ const char* pat, ...)
1707 can be used any place a string (char *) is required:
1709 char * s = Perl_form("%d.%d",major,minor);
1711 Uses a single private buffer so if you want to format several strings you
1712 must explicitly copy the earlier strings away (and free the copies when you
1715 char* form(const char* pat, ...)
1718 Found in file util.c
1722 Fill the sv with current working directory
1724 int getcwd_sv(SV* sv)
1727 Found in file util.c
1731 Returns a new version object based on the passed in SV:
1733 SV *sv = new_version(SV *ver);
1735 Does not alter the passed in ver SV. See "upg_version" if you
1736 want to upgrade the SV.
1738 SV* new_version(SV *ver)
1741 Found in file util.c
1745 Returns a pointer to the next character after the parsed
1746 version string, as well as upgrading the passed in SV to
1749 Function must be called with an already existing SV like
1752 s = scan_version(s,sv);
1754 Performs some preprocessing to the string to ensure that
1755 it has the correct characteristics of a version. Flags the
1756 object if it contains an underscore (which denotes this
1759 char* scan_version(char *vstr, SV *sv)
1762 Found in file util.c
1766 Test two strings to see if they are equal. Returns true or false.
1768 bool strEQ(char* s1, char* s2)
1771 Found in file handy.h
1775 Test two strings to see if the first, C<s1>, is greater than or equal to
1776 the second, C<s2>. Returns true or false.
1778 bool strGE(char* s1, char* s2)
1781 Found in file handy.h
1785 Test two strings to see if the first, C<s1>, is greater than the second,
1786 C<s2>. Returns true or false.
1788 bool strGT(char* s1, char* s2)
1791 Found in file handy.h
1795 Test two strings to see if the first, C<s1>, is less than or equal to the
1796 second, C<s2>. Returns true or false.
1798 bool strLE(char* s1, char* s2)
1801 Found in file handy.h
1805 Test two strings to see if the first, C<s1>, is less than the second,
1806 C<s2>. Returns true or false.
1808 bool strLT(char* s1, char* s2)
1811 Found in file handy.h
1815 Test two strings to see if they are different. Returns true or
1818 bool strNE(char* s1, char* s2)
1821 Found in file handy.h
1825 Test two strings to see if they are equal. The C<len> parameter indicates
1826 the number of bytes to compare. Returns true or false. (A wrapper for
1829 bool strnEQ(char* s1, char* s2, STRLEN len)
1832 Found in file handy.h
1836 Test two strings to see if they are different. The C<len> parameter
1837 indicates the number of bytes to compare. Returns true or false. (A
1838 wrapper for C<strncmp>).
1840 bool strnNE(char* s1, char* s2, STRLEN len)
1843 Found in file handy.h
1847 Dummy routine which "locks" an SV when there is no locking module present.
1848 Exists to avoid test for a NULL function pointer and because it could potentially warn under
1849 some level of strict-ness.
1851 void sv_nolocking(SV *)
1854 Found in file util.c
1858 Dummy routine which "shares" an SV when there is no sharing module present.
1859 Exists to avoid test for a NULL function pointer and because it could potentially warn under
1860 some level of strict-ness.
1862 void sv_nosharing(SV *)
1865 Found in file util.c
1867 =item sv_nounlocking
1869 Dummy routine which "unlocks" an SV when there is no locking module present.
1870 Exists to avoid test for a NULL function pointer and because it could potentially warn under
1871 some level of strict-ness.
1873 void sv_nounlocking(SV *)
1876 Found in file util.c
1880 In-place upgrade of the supplied SV to a version object.
1882 SV *sv = upg_version(SV *sv);
1884 Returns a pointer to the upgraded SV.
1886 SV* upg_version(SV *ver)
1889 Found in file util.c
1893 Version object aware cmp. Both operands must already have been
1894 converted into version objects.
1896 int vcmp(SV *lvs, SV *rvs)
1899 Found in file util.c
1903 Accepts a version object and returns the normalized floating
1904 point representation. Call like:
1908 NOTE: you can pass either the object directly or the SV
1909 contained within the RV.
1914 Found in file util.c
1918 Accepts a version object and returns the normalized string
1919 representation. Call like:
1921 sv = vstringify(rv);
1923 NOTE: you can pass either the object directly or the SV
1924 contained within the RV.
1926 SV* vstringify(SV *vs)
1929 Found in file util.c
1934 =head1 Numeric functions
1940 converts a string representing a binary number to numeric form.
1942 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
1943 conversion flags, and I<result> should be NULL or a pointer to an NV.
1944 The scan stops at the end of the string, or the first invalid character.
1945 On return I<*len> is set to the length scanned string, and I<*flags> gives
1948 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
1949 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_bin>
1950 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
1951 and writes the value to I<*result> (or the value is discarded if I<result>
1954 The hex number may optionally be prefixed with "0b" or "b" unless
1955 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
1956 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the binary
1957 number may use '_' characters to separate digits.
1959 UV grok_bin(char* start, STRLEN* len, I32* flags, NV *result)
1962 Found in file numeric.c
1966 converts a string representing a hex number to numeric form.
1968 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
1969 conversion flags, and I<result> should be NULL or a pointer to an NV.
1970 The scan stops at the end of the string, or the first non-hex-digit character.
1971 On return I<*len> is set to the length scanned string, and I<*flags> gives
1974 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
1975 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_hex>
1976 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
1977 and writes the value to I<*result> (or the value is discarded if I<result>
1980 The hex number may optionally be prefixed with "0x" or "x" unless
1981 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
1982 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the hex
1983 number may use '_' characters to separate digits.
1985 UV grok_hex(char* start, STRLEN* len, I32* flags, NV *result)
1988 Found in file numeric.c
1992 Recognise (or not) a number. The type of the number is returned
1993 (0 if unrecognised), otherwise it is a bit-ORed combination of
1994 IS_NUMBER_IN_UV, IS_NUMBER_GREATER_THAN_UV_MAX, IS_NUMBER_NOT_INT,
1995 IS_NUMBER_NEG, IS_NUMBER_INFINITY, IS_NUMBER_NAN (defined in perl.h).
1997 If the value of the number can fit an in UV, it is returned in the *valuep
1998 IS_NUMBER_IN_UV will be set to indicate that *valuep is valid, IS_NUMBER_IN_UV
1999 will never be set unless *valuep is valid, but *valuep may have been assigned
2000 to during processing even though IS_NUMBER_IN_UV is not set on return.
2001 If valuep is NULL, IS_NUMBER_IN_UV will be set for the same cases as when
2002 valuep is non-NULL, but no actual assignment (or SEGV) will occur.
2004 IS_NUMBER_NOT_INT will be set with IS_NUMBER_IN_UV if trailing decimals were
2005 seen (in which case *valuep gives the true value truncated to an integer), and
2006 IS_NUMBER_NEG if the number is negative (in which case *valuep holds the
2007 absolute value). IS_NUMBER_IN_UV is not set if e notation was used or the
2008 number is larger than a UV.
2010 int grok_number(const char *pv, STRLEN len, UV *valuep)
2013 Found in file numeric.c
2015 =item grok_numeric_radix
2017 Scan and skip for a numeric decimal separator (radix).
2019 bool grok_numeric_radix(const char **sp, const char *send)
2022 Found in file numeric.c
2027 UV grok_oct(char* start, STRLEN* len, I32* flags, NV *result)
2030 Found in file numeric.c
2034 For backwards compatibility. Use C<grok_bin> instead.
2036 NV scan_bin(char* start, STRLEN len, STRLEN* retlen)
2039 Found in file numeric.c
2043 For backwards compatibility. Use C<grok_hex> instead.
2045 NV scan_hex(char* start, STRLEN len, STRLEN* retlen)
2048 Found in file numeric.c
2052 For backwards compatibility. Use C<grok_oct> instead.
2054 NV scan_oct(char* start, STRLEN len, STRLEN* retlen)
2057 Found in file numeric.c
2062 =head1 Optree Manipulation Functions
2068 If C<cv> is a constant sub eligible for inlining. returns the constant
2069 value returned by the sub. Otherwise, returns NULL.
2071 Constant subs can be created with C<newCONSTSUB> or as described in
2072 L<perlsub/"Constant Functions">.
2074 SV* cv_const_sv(CV* cv)
2081 Creates a constant sub equivalent to Perl C<sub FOO () { 123 }> which is
2082 eligible for inlining at compile-time.
2084 CV* newCONSTSUB(HV* stash, char* name, SV* sv)
2091 Used by C<xsubpp> to hook up XSUBs as Perl subs.
2099 =head1 Pad Data Structures
2105 Get the value at offset po in the current pad.
2106 Use macro PAD_SV instead of calling this function directly.
2108 SV* pad_sv(PADOFFSET po)
2116 =head1 Stack Manipulation Macros
2122 Declare a stack marker variable, C<mark>, for the XSUB. See C<MARK> and
2132 Saves the original stack mark for the XSUB. See C<ORIGMARK>.
2141 Declares a local copy of perl's stack pointer for the XSUB, available via
2142 the C<SP> macro. See C<SP>.
2151 Used to extend the argument stack for an XSUB's return values. Once
2152 used, guarantees that there is room for at least C<nitems> to be pushed
2155 void EXTEND(SP, int nitems)
2162 Stack marker variable for the XSUB. See C<dMARK>.
2169 The original stack mark for the XSUB. See C<dORIGMARK>.
2176 Pops an integer off the stack.
2185 Pops a long off the stack.
2194 Pops a double off the stack.
2203 Pops a string off the stack. Deprecated. New code should provide
2204 a STRLEN n_a and use POPpx.
2213 Pops a string off the stack which must consist of bytes i.e. characters < 256.
2214 Requires a variable STRLEN n_a in scope.
2223 Pops a string off the stack.
2224 Requires a variable STRLEN n_a in scope.
2233 Pops an SV off the stack.
2242 Push an integer onto the stack. The stack must have room for this element.
2243 Handles 'set' magic. See C<XPUSHi>.
2252 Opening bracket for arguments on a callback. See C<PUTBACK> and
2262 Push a double onto the stack. The stack must have room for this element.
2263 Handles 'set' magic. See C<XPUSHn>.
2272 Push a string onto the stack. The stack must have room for this element.
2273 The C<len> indicates the length of the string. Handles 'set' magic. See
2276 void PUSHp(char* str, STRLEN len)
2283 Push an SV onto the stack. The stack must have room for this element.
2284 Does not handle 'set' magic. See C<XPUSHs>.
2293 Push an unsigned integer onto the stack. The stack must have room for this
2294 element. See C<XPUSHu>.
2303 Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
2304 See C<PUSHMARK> and L<perlcall> for other uses.
2313 Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and
2321 Refetch the stack pointer. Used after a callback. See L<perlcall>.
2330 Push an integer onto the stack, extending the stack if necessary. Handles
2331 'set' magic. See C<PUSHi>.
2340 Push a double onto the stack, extending the stack if necessary. Handles
2341 'set' magic. See C<PUSHn>.
2350 Push a string onto the stack, extending the stack if necessary. The C<len>
2351 indicates the length of the string. Handles 'set' magic. See
2354 void XPUSHp(char* str, STRLEN len)
2361 Push an SV onto the stack, extending the stack if necessary. Does not
2362 handle 'set' magic. See C<PUSHs>.
2371 Push an unsigned integer onto the stack, extending the stack if necessary.
2381 Return from XSUB, indicating number of items on the stack. This is usually
2382 handled by C<xsubpp>.
2384 void XSRETURN(int nitems)
2387 Found in file XSUB.h
2391 Return an integer from an XSUB immediately. Uses C<XST_mIV>.
2393 void XSRETURN_IV(IV iv)
2396 Found in file XSUB.h
2400 Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
2405 Found in file XSUB.h
2409 Return a double from an XSUB immediately. Uses C<XST_mNV>.
2411 void XSRETURN_NV(NV nv)
2414 Found in file XSUB.h
2418 Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
2420 void XSRETURN_PV(char* str)
2423 Found in file XSUB.h
2425 =item XSRETURN_UNDEF
2427 Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
2432 Found in file XSUB.h
2436 Return an integer from an XSUB immediately. Uses C<XST_mUV>.
2438 void XSRETURN_UV(IV uv)
2441 Found in file XSUB.h
2445 Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
2450 Found in file XSUB.h
2454 Place an integer into the specified position C<pos> on the stack. The
2455 value is stored in a new mortal SV.
2457 void XST_mIV(int pos, IV iv)
2460 Found in file XSUB.h
2464 Place C<&PL_sv_no> into the specified position C<pos> on the
2467 void XST_mNO(int pos)
2470 Found in file XSUB.h
2474 Place a double into the specified position C<pos> on the stack. The value
2475 is stored in a new mortal SV.
2477 void XST_mNV(int pos, NV nv)
2480 Found in file XSUB.h
2484 Place a copy of a string into the specified position C<pos> on the stack.
2485 The value is stored in a new mortal SV.
2487 void XST_mPV(int pos, char* str)
2490 Found in file XSUB.h
2494 Place C<&PL_sv_undef> into the specified position C<pos> on the
2497 void XST_mUNDEF(int pos)
2500 Found in file XSUB.h
2504 Place C<&PL_sv_yes> into the specified position C<pos> on the
2507 void XST_mYES(int pos)
2510 Found in file XSUB.h
2521 An enum of flags for Perl types. These are found in the file B<sv.h>
2522 in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
2529 Integer type flag for scalars. See C<svtype>.
2536 Double type flag for scalars. See C<svtype>.
2543 Pointer type flag for scalars. See C<svtype>.
2550 Type flag for arrays. See C<svtype>.
2557 Type flag for code refs. See C<svtype>.
2564 Type flag for hashes. See C<svtype>.
2571 Type flag for blessed scalars. See C<svtype>.
2579 =head1 SV Manipulation Functions
2585 Returns the SV of the specified Perl scalar. If C<create> is set and the
2586 Perl variable does not exist then it will be created. If C<create> is not
2587 set and the variable does not exist then NULL is returned.
2589 NOTE: the perl_ form of this function is deprecated.
2591 SV* get_sv(const char* name, I32 create)
2594 Found in file perl.c
2596 =item looks_like_number
2598 Test if the content of an SV looks like a number (or is a number).
2599 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
2600 non-numeric warning), even if your atof() doesn't grok them.
2602 I32 looks_like_number(SV* sv)
2609 Creates an RV wrapper for an SV. The reference count for the original SV is
2612 SV* newRV_inc(SV* sv)
2619 Creates an RV wrapper for an SV. The reference count for the original
2620 SV is B<not> incremented.
2622 SV* newRV_noinc(SV *sv)
2629 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
2630 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
2633 SV* newSV(STRLEN len)
2640 Creates a new SV and copies an integer into it. The reference count for the
2650 Creates a new SV and copies a floating point value into it.
2651 The reference count for the SV is set to 1.
2660 Creates a new SV and copies a string into it. The reference count for the
2661 SV is set to 1. If C<len> is zero, Perl will compute the length using
2662 strlen(). For efficiency, consider using C<newSVpvn> instead.
2664 SV* newSVpv(const char* s, STRLEN len)
2671 Creates a new SV and initializes it with the string formatted like
2674 SV* newSVpvf(const char* pat, ...)
2681 Creates a new SV and copies a string into it. The reference count for the
2682 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
2683 string. You are responsible for ensuring that the source string is at least
2686 SV* newSVpvn(const char* s, STRLEN len)
2691 =item newSVpvn_share
2693 Creates a new SV with its SvPVX pointing to a shared string in the string
2694 table. If the string does not already exist in the table, it is created
2695 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
2696 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
2697 otherwise the hash is computed. The idea here is that as the string table
2698 is used for shared hash keys these strings will have SvPVX == HeKEY and
2699 hash lookup will avoid string compare.
2701 SV* newSVpvn_share(const char* s, I32 len, U32 hash)
2708 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
2709 it will be upgraded to one. If C<classname> is non-null then the new SV will
2710 be blessed in the specified package. The new SV is returned and its
2711 reference count is 1.
2713 SV* newSVrv(SV* rv, const char* classname)
2720 Creates a new SV which is an exact duplicate of the original SV.
2723 SV* newSVsv(SV* old)
2730 Creates a new SV and copies an unsigned integer into it.
2731 The reference count for the SV is set to 1.
2740 Returns the length of the string which is in the SV. See C<SvLEN>.
2742 STRLEN SvCUR(SV* sv)
2749 Set the length of the string which is in the SV. See C<SvCUR>.
2751 void SvCUR_set(SV* sv, STRLEN len)
2758 Returns a pointer to the last character in the string which is in the SV.
2759 See C<SvCUR>. Access the character as *(SvEND(sv)).
2768 Expands the character buffer in the SV so that it has room for the
2769 indicated number of bytes (remember to reserve space for an extra trailing
2770 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
2771 Returns a pointer to the character buffer.
2773 char * SvGROW(SV* sv, STRLEN len)
2780 Returns a boolean indicating whether the SV contains an integer.
2789 Returns a boolean indicating whether the SV contains an integer. Checks
2790 the B<private> setting. Use C<SvIOK>.
2799 Returns a boolean indicating whether the SV contains a signed integer.
2801 void SvIOK_notUV(SV* sv)
2808 Unsets the IV status of an SV.
2810 void SvIOK_off(SV* sv)
2817 Tells an SV that it is an integer.
2819 void SvIOK_on(SV* sv)
2826 Tells an SV that it is an integer and disables all other OK bits.
2828 void SvIOK_only(SV* sv)
2835 Tells and SV that it is an unsigned integer and disables all other OK bits.
2837 void SvIOK_only_UV(SV* sv)
2844 Returns a boolean indicating whether the SV contains an unsigned integer.
2846 void SvIOK_UV(SV* sv)
2853 Returns a boolean indicating whether the SV is Copy-On-Write. (either shared
2854 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
2857 bool SvIsCOW(SV* sv)
2862 =item SvIsCOW_shared_hash
2864 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
2867 bool SvIsCOW_shared_hash(SV* sv)
2874 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
2875 version which guarantees to evaluate sv only once.
2884 Coerces the given SV to an integer and returns it. Guarantees to evaluate
2885 sv only once. Use the more efficient C<SvIV> otherwise.
2894 Returns the raw value in the SV's IV slot, without checks or conversions.
2895 Only use when you are sure SvIOK is true. See also C<SvIV()>.
2904 Returns the size of the string buffer in the SV, not including any part
2905 attributable to C<SvOOK>. See C<SvCUR>.
2907 STRLEN SvLEN(SV* sv)
2914 Returns a boolean indicating whether the SV contains a number, integer or
2924 Returns a boolean indicating whether the SV contains a number, integer or
2925 double. Checks the B<private> setting. Use C<SvNIOK>.
2927 bool SvNIOKp(SV* sv)
2934 Unsets the NV/IV status of an SV.
2936 void SvNIOK_off(SV* sv)
2943 Returns a boolean indicating whether the SV contains a double.
2952 Returns a boolean indicating whether the SV contains a double. Checks the
2953 B<private> setting. Use C<SvNOK>.
2962 Unsets the NV status of an SV.
2964 void SvNOK_off(SV* sv)
2971 Tells an SV that it is a double.
2973 void SvNOK_on(SV* sv)
2980 Tells an SV that it is a double and disables all other OK bits.
2982 void SvNOK_only(SV* sv)
2989 Coerce the given SV to a double and return it. See C<SvNVx> for a version
2990 which guarantees to evaluate sv only once.
2999 Returns the raw value in the SV's NV slot, without checks or conversions.
3000 Only use when you are sure SvNOK is true. See also C<SvNV()>.
3009 Coerces the given SV to a double and returns it. Guarantees to evaluate
3010 sv only once. Use the more efficient C<SvNV> otherwise.
3019 Returns a boolean indicating whether the value is an SV.
3028 Returns a boolean indicating whether the SvIVX is a valid offset value for
3029 the SvPVX. This hack is used internally to speed up removal of characters
3030 from the beginning of a SvPV. When SvOOK is true, then the start of the
3031 allocated string buffer is really (SvPVX - SvIVX).
3040 Returns a boolean indicating whether the SV contains a character
3050 Returns a boolean indicating whether the SV contains a character string.
3051 Checks the B<private> setting. Use C<SvPOK>.
3060 Unsets the PV status of an SV.
3062 void SvPOK_off(SV* sv)
3069 Tells an SV that it is a string.
3071 void SvPOK_on(SV* sv)
3078 Tells an SV that it is a string and disables all other OK bits.
3079 Will also turn off the UTF-8 status.
3081 void SvPOK_only(SV* sv)
3086 =item SvPOK_only_UTF8
3088 Tells an SV that it is a string and disables all other OK bits,
3089 and leaves the UTF-8 status as it was.
3091 void SvPOK_only_UTF8(SV* sv)
3098 Returns a pointer to the string in the SV, or a stringified form of
3099 the SV if the SV does not contain a string. The SV may cache the
3100 stringified version becoming C<SvPOK>. Handles 'get' magic. See also
3101 C<SvPVx> for a version which guarantees to evaluate sv only once.
3103 char* SvPV(SV* sv, STRLEN len)
3110 Like C<SvPV>, but converts sv to byte representation first if necessary.
3112 char* SvPVbyte(SV* sv, STRLEN len)
3119 Like C<SvPV>, but converts sv to byte representation first if necessary.
3120 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
3123 char* SvPVbytex(SV* sv, STRLEN len)
3128 =item SvPVbytex_force
3130 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
3131 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
3134 char* SvPVbytex_force(SV* sv, STRLEN len)
3139 =item SvPVbyte_force
3141 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
3143 char* SvPVbyte_force(SV* sv, STRLEN len)
3148 =item SvPVbyte_nolen
3150 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
3152 char* SvPVbyte_nolen(SV* sv)
3159 Like C<SvPV>, but converts sv to utf8 first if necessary.
3161 char* SvPVutf8(SV* sv, STRLEN len)
3168 Like C<SvPV>, but converts sv to utf8 first if necessary.
3169 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
3172 char* SvPVutf8x(SV* sv, STRLEN len)
3177 =item SvPVutf8x_force
3179 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
3180 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
3183 char* SvPVutf8x_force(SV* sv, STRLEN len)
3188 =item SvPVutf8_force
3190 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
3192 char* SvPVutf8_force(SV* sv, STRLEN len)
3197 =item SvPVutf8_nolen
3199 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
3201 char* SvPVutf8_nolen(SV* sv)
3208 A version of C<SvPV> which guarantees to evaluate sv only once.
3210 char* SvPVx(SV* sv, STRLEN len)
3217 Returns a pointer to the physical string in the SV. The SV must contain a
3227 Like C<SvPV> but will force the SV into containing just a string
3228 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
3231 char* SvPV_force(SV* sv, STRLEN len)
3236 =item SvPV_force_nomg
3238 Like C<SvPV> but will force the SV into containing just a string
3239 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
3240 directly. Doesn't process magic.
3242 char* SvPV_force_nomg(SV* sv, STRLEN len)
3249 Returns a pointer to the string in the SV, or a stringified form of
3250 the SV if the SV does not contain a string. The SV may cache the
3251 stringified form becoming C<SvPOK>. Handles 'get' magic.
3253 char* SvPV_nolen(SV* sv)
3260 Returns the value of the object's reference count.
3262 U32 SvREFCNT(SV* sv)
3269 Decrements the reference count of the given SV.
3271 void SvREFCNT_dec(SV* sv)
3278 Increments the reference count of the given SV.
3280 SV* SvREFCNT_inc(SV* sv)
3287 Tests if the SV is an RV.
3296 Unsets the RV status of an SV.
3298 void SvROK_off(SV* sv)
3305 Tells an SV that it is an RV.
3307 void SvROK_on(SV* sv)
3314 Dereferences an RV to return the SV.
3323 Returns the stash of the SV.
3332 Taints an SV if tainting is enabled.
3334 void SvTAINT(SV* sv)
3341 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
3344 bool SvTAINTED(SV* sv)
3351 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
3352 some of Perl's fundamental security features. XS module authors should not
3353 use this function unless they fully understand all the implications of
3354 unconditionally untainting the value. Untainting should be done in the
3355 standard perl fashion, via a carefully crafted regexp, rather than directly
3356 untainting variables.
3358 void SvTAINTED_off(SV* sv)
3365 Marks an SV as tainted if tainting is enabled.
3367 void SvTAINTED_on(SV* sv)
3374 Returns a boolean indicating whether Perl would evaluate the SV as true or
3375 false, defined or undefined. Does not handle 'get' magic.
3384 Returns the type of the SV. See C<svtype>.
3386 svtype SvTYPE(SV* sv)
3393 Releases a mutual exclusion lock on sv if a suitable module
3397 void SvUNLOCK(SV* sv)
3404 Returns a boolean indicating whether the SV contains an unsigned integer.
3413 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
3414 perform the upgrade if necessary. See C<svtype>.
3416 void SvUPGRADE(SV* sv, svtype type)
3423 Returns a boolean indicating whether the SV contains UTF-8 encoded data.
3432 Unsets the UTF-8 status of an SV.
3434 void SvUTF8_off(SV *sv)
3441 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
3442 Do not use frivolously.
3444 void SvUTF8_on(SV *sv)
3451 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
3452 for a version which guarantees to evaluate sv only once.
3461 Returns the raw value in the SV's UV slot, without checks or conversions.
3462 Only use when you are sure SvIOK is true. See also C<SvUV()>.
3471 Coerces the given SV to an unsigned integer and returns it. Guarantees to
3472 evaluate sv only once. Use the more efficient C<SvUV> otherwise.
3481 Returns a boolean indicating whether the SV contains a v-string.
3490 This function is only called on magical items, and is only used by
3491 sv_true() or its macro equivalent.
3493 bool sv_2bool(SV* sv)
3500 Using various gambits, try to get a CV from an SV; in addition, try if
3501 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
3503 CV* sv_2cv(SV* sv, HV** st, GV** gvp, I32 lref)
3510 Using various gambits, try to get an IO from an SV: the IO slot if its a
3511 GV; or the recursive result if we're an RV; or the IO slot of the symbol
3512 named after the PV if we're a string.
3521 Return the integer value of an SV, doing any necessary string conversion,
3522 magic etc. Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
3531 Marks an existing SV as mortal. The SV will be destroyed "soon", either
3532 by an explicit call to FREETMPS, or by an implicit call at places such as
3533 statement boundaries. See also C<sv_newmortal> and C<sv_mortalcopy>.
3535 SV* sv_2mortal(SV* sv)
3542 Return the num value of an SV, doing any necessary string or integer
3543 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
3553 Return a pointer to the byte-encoded representation of the SV, and set *lp
3554 to its length. May cause the SV to be downgraded from UTF-8 as a
3557 Usually accessed via the C<SvPVbyte> macro.
3559 char* sv_2pvbyte(SV* sv, STRLEN* lp)
3564 =item sv_2pvbyte_nolen
3566 Return a pointer to the byte-encoded representation of the SV.
3567 May cause the SV to be downgraded from UTF-8 as a side-effect.
3569 Usually accessed via the C<SvPVbyte_nolen> macro.
3571 char* sv_2pvbyte_nolen(SV* sv)
3578 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3579 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
3581 Usually accessed via the C<SvPVutf8> macro.
3583 char* sv_2pvutf8(SV* sv, STRLEN* lp)
3588 =item sv_2pvutf8_nolen
3590 Return a pointer to the UTF-8-encoded representation of the SV.
3591 May cause the SV to be upgraded to UTF-8 as a side-effect.
3593 Usually accessed via the C<SvPVutf8_nolen> macro.
3595 char* sv_2pvutf8_nolen(SV* sv)
3602 Returns a pointer to the string value of an SV, and sets *lp to its length.
3603 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
3605 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
3606 usually end up here too.
3608 char* sv_2pv_flags(SV* sv, STRLEN* lp, I32 flags)
3615 Like C<sv_2pv()>, but doesn't return the length too. You should usually
3616 use the macro wrapper C<SvPV_nolen(sv)> instead.
3617 char* sv_2pv_nolen(SV* sv)
3624 Return the unsigned integer value of an SV, doing any necessary string
3625 conversion, magic etc. Normally used via the C<SvUV(sv)> and C<SvUVx(sv)>
3635 Remove any string offset. You should normally use the C<SvOOK_off> macro
3638 int sv_backoff(SV* sv)
3645 Blesses an SV into a specified package. The SV must be an RV. The package
3646 must be designated by its stash (see C<gv_stashpv()>). The reference count
3647 of the SV is unaffected.
3649 SV* sv_bless(SV* sv, HV* stash)
3656 Concatenates the string onto the end of the string which is in the SV.
3657 If the SV has the UTF-8 status set, then the bytes appended should be
3658 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
3660 void sv_catpv(SV* sv, const char* ptr)
3667 Processes its arguments like C<sprintf> and appends the formatted
3668 output to an SV. If the appended data contains "wide" characters
3669 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
3670 and characters >255 formatted with %c), the original SV might get
3671 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic.
3672 C<SvSETMAGIC()> must typically be called after calling this function
3673 to handle 'set' magic.
3675 void sv_catpvf(SV* sv, const char* pat, ...)
3682 Like C<sv_catpvf>, but also handles 'set' magic.
3684 void sv_catpvf_mg(SV *sv, const char* pat, ...)
3691 Concatenates the string onto the end of the string which is in the SV. The
3692 C<len> indicates number of bytes to copy. If the SV has the UTF-8
3693 status set, then the bytes appended should be valid UTF-8.
3694 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
3696 void sv_catpvn(SV* sv, const char* ptr, STRLEN len)
3701 =item sv_catpvn_flags
3703 Concatenates the string onto the end of the string which is in the SV. The
3704 C<len> indicates number of bytes to copy. If the SV has the UTF-8
3705 status set, then the bytes appended should be valid UTF-8.
3706 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
3707 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
3708 in terms of this function.
3710 void sv_catpvn_flags(SV* sv, const char* ptr, STRLEN len, I32 flags)
3717 Like C<sv_catpvn>, but also handles 'set' magic.
3719 void sv_catpvn_mg(SV *sv, const char *ptr, STRLEN len)
3726 Like C<sv_catpv>, but also handles 'set' magic.
3728 void sv_catpv_mg(SV *sv, const char *ptr)
3735 Concatenates the string from SV C<ssv> onto the end of the string in
3736 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
3737 not 'set' magic. See C<sv_catsv_mg>.
3739 void sv_catsv(SV* dsv, SV* ssv)
3744 =item sv_catsv_flags
3746 Concatenates the string from SV C<ssv> onto the end of the string in
3747 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
3748 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
3749 and C<sv_catsv_nomg> are implemented in terms of this function.
3751 void sv_catsv_flags(SV* dsv, SV* ssv, I32 flags)
3758 Like C<sv_catsv>, but also handles 'set' magic.
3760 void sv_catsv_mg(SV *dstr, SV *sstr)
3767 Efficient removal of characters from the beginning of the string buffer.
3768 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
3769 the string buffer. The C<ptr> becomes the first character of the adjusted
3770 string. Uses the "OOK hack".
3771 Beware: after this function returns, C<ptr> and SvPVX(sv) may no longer
3772 refer to the same chunk of data.
3774 void sv_chop(SV* sv, char* ptr)
3781 Clear an SV: call any destructors, free up any memory used by the body,
3782 and free the body itself. The SV's head is I<not> freed, although
3783 its type is set to all 1's so that it won't inadvertently be assumed
3784 to be live during global destruction etc.
3785 This function should only be called when REFCNT is zero. Most of the time
3786 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
3789 void sv_clear(SV* sv)
3796 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
3797 string in C<sv1> is less than, equal to, or greater than the string in
3798 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
3799 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
3801 I32 sv_cmp(SV* sv1, SV* sv2)
3808 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
3809 'use bytes' aware, handles get magic, and will coerce its args to strings
3810 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
3812 I32 sv_cmp_locale(SV* sv1, SV* sv2)
3819 Add Collate Transform magic to an SV if it doesn't already have it.
3821 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
3822 scalar data of the variable, but transformed to such a format that a normal
3823 memory comparison can be used to compare the data according to the locale
3826 char* sv_collxfrm(SV* sv, STRLEN* nxp)
3833 Copies a stringified representation of the source SV into the
3834 destination SV. Automatically performs any necessary mg_get and
3835 coercion of numeric values into strings. Guaranteed to preserve
3836 UTF-8 flag even from overloaded objects. Similar in nature to
3837 sv_2pv[_flags] but operates directly on an SV instead of just the
3838 string. Mostly uses sv_2pv_flags to do its work, except when that
3839 would lose the UTF-8'ness of the PV.
3841 void sv_copypv(SV* dsv, SV* ssv)
3848 Auto-decrement of the value in the SV, doing string to numeric conversion
3849 if necessary. Handles 'get' magic.
3856 =item sv_derived_from
3858 Returns a boolean indicating whether the SV is derived from the specified
3859 class. This is the function that implements C<UNIVERSAL::isa>. It works
3860 for class names as well as for objects.
3862 bool sv_derived_from(SV* sv, const char* name)
3865 Found in file universal.c
3869 Returns a boolean indicating whether the strings in the two SVs are
3870 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
3871 coerce its args to strings if necessary.
3873 I32 sv_eq(SV* sv1, SV* sv2)
3878 =item sv_force_normal
3880 Undo various types of fakery on an SV: if the PV is a shared string, make
3881 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3882 an xpvmg. See also C<sv_force_normal_flags>.
3884 void sv_force_normal(SV *sv)
3889 =item sv_force_normal_flags
3891 Undo various types of fakery on an SV: if the PV is a shared string, make
3892 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3893 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
3894 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
3895 then a copy-on-write scalar drops its PV buffer (if any) and becomes
3896 SvPOK_off rather than making a copy. (Used where this scalar is about to be
3897 set to some other value.) In addition, the C<flags> parameter gets passed to
3898 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
3899 with flags set to 0.
3901 void sv_force_normal_flags(SV *sv, U32 flags)
3908 Decrement an SV's reference count, and if it drops to zero, call
3909 C<sv_clear> to invoke destructors and free up any memory used by
3910 the body; finally, deallocate the SV's head itself.
3911 Normally called via a wrapper macro C<SvREFCNT_dec>.
3913 void sv_free(SV* sv)
3920 Get a line from the filehandle and store it into the SV, optionally
3921 appending to the currently-stored string.
3923 char* sv_gets(SV* sv, PerlIO* fp, I32 append)
3930 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
3931 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
3932 Use the C<SvGROW> wrapper instead.
3934 char* sv_grow(SV* sv, STRLEN newlen)
3941 Auto-increment of the value in the SV, doing string to numeric conversion
3942 if necessary. Handles 'get' magic.
3951 Inserts a string at the specified offset/length within the SV. Similar to
3952 the Perl substr() function.
3954 void sv_insert(SV* bigsv, STRLEN offset, STRLEN len, char* little, STRLEN littlelen)
3961 Returns a boolean indicating whether the SV is blessed into the specified
3962 class. This does not check for subtypes; use C<sv_derived_from> to verify
3963 an inheritance relationship.
3965 int sv_isa(SV* sv, const char* name)
3972 Returns a boolean indicating whether the SV is an RV pointing to a blessed
3973 object. If the SV is not an RV, or if the object is not blessed, then this
3976 int sv_isobject(SV* sv)
3983 A private implementation of the C<SvIVx> macro for compilers which can't
3984 cope with complex macro expressions. Always use the macro instead.
3993 Returns the length of the string in the SV. Handles magic and type
3994 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
3996 STRLEN sv_len(SV* sv)
4003 Returns the number of characters in the string in an SV, counting wide
4004 UTF-8 bytes as a single character. Handles magic and type coercion.
4006 STRLEN sv_len_utf8(SV* sv)
4013 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4014 then adds a new magic item of type C<how> to the head of the magic list.
4016 void sv_magic(SV* sv, SV* obj, int how, const char* name, I32 namlen)
4023 Adds magic to an SV, upgrading it if necessary. Applies the
4024 supplied vtable and returns pointer to the magic added.
4026 Note that sv_magicext will allow things that sv_magic will not.
4027 In particular you can add magic to SvREADONLY SVs and and more than
4028 one instance of the same 'how'
4030 I C<namelen> is greater then zero then a savepvn() I<copy> of C<name> is stored,
4031 if C<namelen> is zero then C<name> is stored as-is and - as another special
4032 case - if C<(name && namelen == HEf_SVKEY)> then C<name> is assumed to contain
4033 an C<SV*> and has its REFCNT incremented
4035 (This is now used as a subroutine by sv_magic.)
4037 MAGIC * sv_magicext(SV* sv, SV* obj, int how, MGVTBL *vtbl, const char* name, I32 namlen )
4044 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
4045 The new SV is marked as mortal. It will be destroyed "soon", either by an
4046 explicit call to FREETMPS, or by an implicit call at places such as
4047 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
4049 SV* sv_mortalcopy(SV* oldsv)
4056 Creates a new null SV which is mortal. The reference count of the SV is
4057 set to 1. It will be destroyed "soon", either by an explicit call to
4058 FREETMPS, or by an implicit call at places such as statement boundaries.
4059 See also C<sv_mortalcopy> and C<sv_2mortal>.
4068 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
4071 SV* sv_newref(SV* sv)
4078 A private implementation of the C<SvNVx> macro for compilers which can't
4079 cope with complex macro expressions. Always use the macro instead.
4088 Converts the value pointed to by offsetp from a count of bytes from the
4089 start of the string, to a count of the equivalent number of UTF-8 chars.
4090 Handles magic and type coercion.
4092 void sv_pos_b2u(SV* sv, I32* offsetp)
4099 Converts the value pointed to by offsetp from a count of UTF-8 chars from
4100 the start of the string, to a count of the equivalent number of bytes; if
4101 lenp is non-zero, it does the same to lenp, but this time starting from
4102 the offset, rather than from the start of the string. Handles magic and
4105 void sv_pos_u2b(SV* sv, I32* offsetp, I32* lenp)
4112 Use the C<SvPV_nolen> macro instead
4121 Use C<SvPVbyte_nolen> instead.
4123 char* sv_pvbyte(SV *sv)
4130 A private implementation of the C<SvPVbyte> macro for compilers
4131 which can't cope with complex macro expressions. Always use the macro
4134 char* sv_pvbyten(SV *sv, STRLEN *len)
4139 =item sv_pvbyten_force
4141 A private implementation of the C<SvPVbytex_force> macro for compilers
4142 which can't cope with complex macro expressions. Always use the macro
4145 char* sv_pvbyten_force(SV* sv, STRLEN* lp)
4152 A private implementation of the C<SvPV> macro for compilers which can't
4153 cope with complex macro expressions. Always use the macro instead.
4155 char* sv_pvn(SV *sv, STRLEN *len)
4162 Get a sensible string out of the SV somehow.
4163 A private implementation of the C<SvPV_force> macro for compilers which
4164 can't cope with complex macro expressions. Always use the macro instead.
4166 char* sv_pvn_force(SV* sv, STRLEN* lp)
4171 =item sv_pvn_force_flags
4173 Get a sensible string out of the SV somehow.
4174 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
4175 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
4176 implemented in terms of this function.
4177 You normally want to use the various wrapper macros instead: see
4178 C<SvPV_force> and C<SvPV_force_nomg>
4180 char* sv_pvn_force_flags(SV* sv, STRLEN* lp, I32 flags)
4187 Use the C<SvPVutf8_nolen> macro instead
4189 char* sv_pvutf8(SV *sv)
4196 A private implementation of the C<SvPVutf8> macro for compilers
4197 which can't cope with complex macro expressions. Always use the macro
4200 char* sv_pvutf8n(SV *sv, STRLEN *len)
4205 =item sv_pvutf8n_force
4207 A private implementation of the C<SvPVutf8_force> macro for compilers
4208 which can't cope with complex macro expressions. Always use the macro
4211 char* sv_pvutf8n_force(SV* sv, STRLEN* lp)
4218 Returns a string describing what the SV is a reference to.
4220 char* sv_reftype(SV* sv, int ob)
4227 Make the first argument a copy of the second, then delete the original.
4228 The target SV physically takes over ownership of the body of the source SV
4229 and inherits its flags; however, the target keeps any magic it owns,
4230 and any magic in the source is discarded.
4231 Note that this is a rather specialist SV copying operation; most of the
4232 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4234 void sv_replace(SV* sv, SV* nsv)
4239 =item sv_report_used
4241 Dump the contents of all SVs not yet freed. (Debugging aid).
4243 void sv_report_used()
4250 Underlying implementation for the C<reset> Perl function.
4251 Note that the perl-level function is vaguely deprecated.
4253 void sv_reset(char* s, HV* stash)
4260 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4261 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4262 push a back-reference to this RV onto the array of backreferences
4263 associated with that magic.
4265 SV* sv_rvweaken(SV *sv)
4272 Copies an integer into the given SV, upgrading first if necessary.
4273 Does not handle 'set' magic. See also C<sv_setiv_mg>.
4275 void sv_setiv(SV* sv, IV num)
4282 Like C<sv_setiv>, but also handles 'set' magic.
4284 void sv_setiv_mg(SV *sv, IV i)
4291 Copies a double into the given SV, upgrading first if necessary.
4292 Does not handle 'set' magic. See also C<sv_setnv_mg>.
4294 void sv_setnv(SV* sv, NV num)
4301 Like C<sv_setnv>, but also handles 'set' magic.
4303 void sv_setnv_mg(SV *sv, NV num)
4310 Copies a string into an SV. The string must be null-terminated. Does not
4311 handle 'set' magic. See C<sv_setpv_mg>.
4313 void sv_setpv(SV* sv, const char* ptr)
4320 Processes its arguments like C<sprintf> and sets an SV to the formatted
4321 output. Does not handle 'set' magic. See C<sv_setpvf_mg>.
4323 void sv_setpvf(SV* sv, const char* pat, ...)
4330 Like C<sv_setpvf>, but also handles 'set' magic.
4332 void sv_setpvf_mg(SV *sv, const char* pat, ...)
4339 Copies an integer into the given SV, also updating its string value.
4340 Does not handle 'set' magic. See C<sv_setpviv_mg>.
4342 void sv_setpviv(SV* sv, IV num)
4349 Like C<sv_setpviv>, but also handles 'set' magic.
4351 void sv_setpviv_mg(SV *sv, IV iv)
4358 Copies a string into an SV. The C<len> parameter indicates the number of
4359 bytes to be copied. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4361 void sv_setpvn(SV* sv, const char* ptr, STRLEN len)
4368 Like C<sv_setpvn>, but also handles 'set' magic.
4370 void sv_setpvn_mg(SV *sv, const char *ptr, STRLEN len)
4377 Like C<sv_setpv>, but also handles 'set' magic.
4379 void sv_setpv_mg(SV *sv, const char *ptr)
4386 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
4387 argument will be upgraded to an RV. That RV will be modified to point to
4388 the new SV. The C<classname> argument indicates the package for the
4389 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4390 will have a reference count of 1, and the RV will be returned.
4392 SV* sv_setref_iv(SV* rv, const char* classname, IV iv)
4399 Copies a double into a new SV, optionally blessing the SV. The C<rv>
4400 argument will be upgraded to an RV. That RV will be modified to point to
4401 the new SV. The C<classname> argument indicates the package for the
4402 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4403 will have a reference count of 1, and the RV will be returned.
4405 SV* sv_setref_nv(SV* rv, const char* classname, NV nv)
4412 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
4413 argument will be upgraded to an RV. That RV will be modified to point to
4414 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
4415 into the SV. The C<classname> argument indicates the package for the
4416 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4417 will have a reference count of 1, and the RV will be returned.
4419 Do not use with other Perl types such as HV, AV, SV, CV, because those
4420 objects will become corrupted by the pointer copy process.
4422 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
4424 SV* sv_setref_pv(SV* rv, const char* classname, void* pv)
4431 Copies a string into a new SV, optionally blessing the SV. The length of the
4432 string must be specified with C<n>. The C<rv> argument will be upgraded to
4433 an RV. That RV will be modified to point to the new SV. The C<classname>
4434 argument indicates the package for the blessing. Set C<classname> to
4435 C<Nullch> to avoid the blessing. The new SV will have a reference count
4436 of 1, and the RV will be returned.
4438 Note that C<sv_setref_pv> copies the pointer while this copies the string.
4440 SV* sv_setref_pvn(SV* rv, const char* classname, char* pv, STRLEN n)
4447 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
4448 argument will be upgraded to an RV. That RV will be modified to point to
4449 the new SV. The C<classname> argument indicates the package for the
4450 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4451 will have a reference count of 1, and the RV will be returned.
4453 SV* sv_setref_uv(SV* rv, const char* classname, UV uv)
4460 Copies the contents of the source SV C<ssv> into the destination SV
4461 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4462 function if the source SV needs to be reused. Does not handle 'set' magic.
4463 Loosely speaking, it performs a copy-by-value, obliterating any previous
4464 content of the destination.
4466 You probably want to use one of the assortment of wrappers, such as
4467 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4468 C<SvSetMagicSV_nosteal>.
4470 void sv_setsv(SV* dsv, SV* ssv)
4475 =item sv_setsv_flags
4477 Copies the contents of the source SV C<ssv> into the destination SV
4478 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4479 function if the source SV needs to be reused. Does not handle 'set' magic.
4480 Loosely speaking, it performs a copy-by-value, obliterating any previous
4481 content of the destination.
4482 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
4483 C<ssv> if appropriate, else not. C<sv_setsv> and C<sv_setsv_nomg> are
4484 implemented in terms of this function.
4486 You probably want to use one of the assortment of wrappers, such as
4487 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4488 C<SvSetMagicSV_nosteal>.
4490 This is the primary function for copying scalars, and most other
4491 copy-ish functions and macros use this underneath.
4493 void sv_setsv_flags(SV* dsv, SV* ssv, I32 flags)
4500 Like C<sv_setsv>, but also handles 'set' magic.
4502 void sv_setsv_mg(SV *dstr, SV *sstr)
4509 Copies an unsigned integer into the given SV, upgrading first if necessary.
4510 Does not handle 'set' magic. See also C<sv_setuv_mg>.
4512 void sv_setuv(SV* sv, UV num)
4519 Like C<sv_setuv>, but also handles 'set' magic.
4521 void sv_setuv_mg(SV *sv, UV u)
4528 Taint an SV. Use C<SvTAINTED_on> instead.
4529 void sv_taint(SV* sv)
4536 Test an SV for taintedness. Use C<SvTAINTED> instead.
4537 bool sv_tainted(SV* sv)
4544 Returns true if the SV has a true value by Perl's rules.
4545 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
4546 instead use an in-line version.
4555 Removes all magic of type C<type> from an SV.
4557 int sv_unmagic(SV* sv, int type)
4564 Unsets the RV status of the SV, and decrements the reference count of
4565 whatever was being referenced by the RV. This can almost be thought of
4566 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
4567 being zero. See C<SvROK_off>.
4569 void sv_unref(SV* sv)
4574 =item sv_unref_flags
4576 Unsets the RV status of the SV, and decrements the reference count of
4577 whatever was being referenced by the RV. This can almost be thought of
4578 as a reversal of C<newSVrv>. The C<cflags> argument can contain
4579 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
4580 (otherwise the decrementing is conditional on the reference count being
4581 different from one or the reference being a readonly SV).
4584 void sv_unref_flags(SV* sv, U32 flags)
4591 Untaint an SV. Use C<SvTAINTED_off> instead.
4592 void sv_untaint(SV* sv)
4599 Upgrade an SV to a more complex form. Generally adds a new body type to the
4600 SV, then copies across as much information as possible from the old body.
4601 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
4603 bool sv_upgrade(SV* sv, U32 mt)
4610 Tells an SV to use C<ptr> to find its string value. Normally the string is
4611 stored inside the SV but sv_usepvn allows the SV to use an outside string.
4612 The C<ptr> should point to memory that was allocated by C<malloc>. The
4613 string length, C<len>, must be supplied. This function will realloc the
4614 memory pointed to by C<ptr>, so that pointer should not be freed or used by
4615 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
4616 See C<sv_usepvn_mg>.
4618 void sv_usepvn(SV* sv, char* ptr, STRLEN len)
4625 Like C<sv_usepvn>, but also handles 'set' magic.
4627 void sv_usepvn_mg(SV *sv, char *ptr, STRLEN len)
4632 =item sv_utf8_decode
4634 Convert the octets in the PV from UTF-8 to chars. Scan for validity and then
4635 turn off SvUTF8 if needed so that we see characters. Used as a building block
4636 for decode_utf8 in Encode.xs
4638 NOTE: this function is experimental and may change or be
4639 removed without notice.
4641 bool sv_utf8_decode(SV *sv)
4646 =item sv_utf8_downgrade
4648 Attempt to convert the PV of an SV from UTF-8-encoded to byte encoding.
4649 This may not be possible if the PV contains non-byte encoding characters;
4650 if this is the case, either returns false or, if C<fail_ok> is not
4653 This is not as a general purpose Unicode to byte encoding interface:
4654 use the Encode extension for that.
4656 NOTE: this function is experimental and may change or be
4657 removed without notice.
4659 bool sv_utf8_downgrade(SV *sv, bool fail_ok)
4664 =item sv_utf8_encode
4666 Convert the PV of an SV to UTF-8-encoded, but then turn off the C<SvUTF8>
4667 flag so that it looks like octets again. Used as a building block
4668 for encode_utf8 in Encode.xs
4670 void sv_utf8_encode(SV *sv)
4675 =item sv_utf8_upgrade
4677 Convert the PV of an SV to its UTF-8-encoded form.
4678 Forces the SV to string form if it is not already.
4679 Always sets the SvUTF8 flag to avoid future validity checks even
4680 if all the bytes have hibit clear.
4682 This is not as a general purpose byte encoding to Unicode interface:
4683 use the Encode extension for that.
4685 STRLEN sv_utf8_upgrade(SV *sv)
4690 =item sv_utf8_upgrade_flags
4692 Convert the PV of an SV to its UTF-8-encoded form.
4693 Forces the SV to string form if it is not already.
4694 Always sets the SvUTF8 flag to avoid future validity checks even
4695 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
4696 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
4697 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
4699 This is not as a general purpose byte encoding to Unicode interface:
4700 use the Encode extension for that.
4702 STRLEN sv_utf8_upgrade_flags(SV *sv, I32 flags)
4709 A private implementation of the C<SvUVx> macro for compilers which can't
4710 cope with complex macro expressions. Always use the macro instead.
4719 Processes its arguments like C<vsprintf> and appends the formatted output
4720 to an SV. Uses an array of SVs if the C style variable argument list is
4721 missing (NULL). When running with taint checks enabled, indicates via
4722 C<maybe_tainted> if results are untrustworthy (often due to the use of
4725 Usually used via one of its frontends C<sv_catpvf> and C<sv_catpvf_mg>.
4727 void sv_vcatpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
4734 Works like C<vcatpvfn> but copies the text into the SV instead of
4737 Usually used via one of its frontends C<sv_setpvf> and C<sv_setpvf_mg>.
4739 void sv_vsetpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
4747 =head1 Unicode Support
4751 =item bytes_from_utf8
4753 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
4754 Unlike <utf8_to_bytes> but like C<bytes_to_utf8>, returns a pointer to
4755 the newly-created string, and updates C<len> to contain the new
4756 length. Returns the original string if no conversion occurs, C<len>
4757 is unchanged. Do nothing if C<is_utf8> points to 0. Sets C<is_utf8> to
4758 0 if C<s> is converted or contains all 7bit characters.
4760 NOTE: this function is experimental and may change or be
4761 removed without notice.
4763 U8* bytes_from_utf8(U8 *s, STRLEN *len, bool *is_utf8)
4766 Found in file utf8.c
4770 Converts a string C<s> of length C<len> from ASCII into UTF-8 encoding.
4771 Returns a pointer to the newly-created string, and sets C<len> to
4772 reflect the new length.
4774 If you want to convert to UTF-8 from other encodings than ASCII,
4775 see sv_recode_to_utf8().
4777 NOTE: this function is experimental and may change or be
4778 removed without notice.
4780 U8* bytes_to_utf8(U8 *s, STRLEN *len)
4783 Found in file utf8.c
4787 Return true if the strings s1 and s2 differ case-insensitively, false
4788 if not (if they are equal case-insensitively). If u1 is true, the
4789 string s1 is assumed to be in UTF-8-encoded Unicode. If u2 is true,
4790 the string s2 is assumed to be in UTF-8-encoded Unicode. If u1 or u2
4791 are false, the respective string is assumed to be in native 8-bit
4794 If the pe1 and pe2 are non-NULL, the scanning pointers will be copied
4795 in there (they will point at the beginning of the I<next> character).
4796 If the pointers behind pe1 or pe2 are non-NULL, they are the end
4797 pointers beyond which scanning will not continue under any
4798 circustances. If the byte lengths l1 and l2 are non-zero, s1+l1 and
4799 s2+l2 will be used as goal end pointers that will also stop the scan,
4800 and which qualify towards defining a successful match: all the scans
4801 that define an explicit length must reach their goal pointers for
4802 a match to succeed).
4804 For case-insensitiveness, the "casefolding" of Unicode is used
4805 instead of upper/lowercasing both the characters, see
4806 http://www.unicode.org/unicode/reports/tr21/ (Case Mappings).
4808 I32 ibcmp_utf8(const char* a, char **pe1, UV l1, bool u1, const char* b, char **pe2, UV l2, bool u2)
4811 Found in file utf8.c
4815 Tests if some arbitrary number of bytes begins in a valid UTF-8
4816 character. Note that an INVARIANT (i.e. ASCII) character is a valid
4817 UTF-8 character. The actual number of bytes in the UTF-8 character
4818 will be returned if it is valid, otherwise 0.
4820 STRLEN is_utf8_char(U8 *p)
4823 Found in file utf8.c
4825 =item is_utf8_string
4827 Returns true if first C<len> bytes of the given string form a valid
4828 UTF-8 string, false otherwise. Note that 'a valid UTF-8 string' does
4829 not mean 'a string that contains code points above 0x7F encoded in UTF-8'
4830 because a valid ASCII string is a valid UTF-8 string.
4832 bool is_utf8_string(U8 *s, STRLEN len)
4835 Found in file utf8.c
4837 =item is_utf8_string_loc
4839 Like is_ut8_string but store the location of the failure in
4842 bool is_utf8_string_loc(U8 *s, STRLEN len, U8 **p)
4845 Found in file utf8.c
4847 =item pv_uni_display
4849 Build to the scalar dsv a displayable version of the string spv,
4850 length len, the displayable version being at most pvlim bytes long
4851 (if longer, the rest is truncated and "..." will be appended).
4853 The flags argument can have UNI_DISPLAY_ISPRINT set to display
4854 isPRINT()able characters as themselves, UNI_DISPLAY_BACKSLASH
4855 to display the \\[nrfta\\] as the backslashed versions (like '\n')
4856 (UNI_DISPLAY_BACKSLASH is preferred over UNI_DISPLAY_ISPRINT for \\).
4857 UNI_DISPLAY_QQ (and its alias UNI_DISPLAY_REGEX) have both
4858 UNI_DISPLAY_BACKSLASH and UNI_DISPLAY_ISPRINT turned on.
4860 The pointer to the PV of the dsv is returned.
4862 char* pv_uni_display(SV *dsv, U8 *spv, STRLEN len, STRLEN pvlim, UV flags)
4865 Found in file utf8.c
4869 The encoding is assumed to be an Encode object, the PV of the ssv is
4870 assumed to be octets in that encoding and decoding the input starts
4871 from the position which (PV + *offset) pointed to. The dsv will be
4872 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
4873 when the string tstr appears in decoding output or the input ends on
4874 the PV of the ssv. The value which the offset points will be modified
4875 to the last input position on the ssv.
4877 Returns TRUE if the terminator was found, else returns FALSE.
4879 bool sv_cat_decode(SV* dsv, SV *encoding, SV *ssv, int *offset, char* tstr, int tlen)
4884 =item sv_recode_to_utf8
4886 The encoding is assumed to be an Encode object, on entry the PV
4887 of the sv is assumed to be octets in that encoding, and the sv
4888 will be converted into Unicode (and UTF-8).
4890 If the sv already is UTF-8 (or if it is not POK), or if the encoding
4891 is not a reference, nothing is done to the sv. If the encoding is not
4892 an C<Encode::XS> Encoding object, bad things will happen.
4893 (See F<lib/encoding.pm> and L<Encode>).
4895 The PV of the sv is returned.
4897 char* sv_recode_to_utf8(SV* sv, SV *encoding)
4902 =item sv_uni_display
4904 Build to the scalar dsv a displayable version of the scalar sv,
4905 the displayable version being at most pvlim bytes long
4906 (if longer, the rest is truncated and "..." will be appended).
4908 The flags argument is as in pv_uni_display().
4910 The pointer to the PV of the dsv is returned.
4912 char* sv_uni_display(SV *dsv, SV *ssv, STRLEN pvlim, UV flags)
4915 Found in file utf8.c
4919 The "p" contains the pointer to the UTF-8 string encoding
4920 the character that is being converted.
4922 The "ustrp" is a pointer to the character buffer to put the
4923 conversion result to. The "lenp" is a pointer to the length
4926 The "swashp" is a pointer to the swash to use.
4928 Both the special and normal mappings are stored lib/unicore/To/Foo.pl,
4929 and loaded by SWASHGET, using lib/utf8_heavy.pl. The special (usually,
4930 but not always, a multicharacter mapping), is tried first.
4932 The "special" is a string like "utf8::ToSpecLower", which means the
4933 hash %utf8::ToSpecLower. The access to the hash is through
4934 Perl_to_utf8_case().
4936 The "normal" is a string like "ToLower" which means the swash
4939 UV to_utf8_case(U8 *p, U8* ustrp, STRLEN *lenp, SV **swash, char *normal, char *special)
4942 Found in file utf8.c
4946 Convert the UTF-8 encoded character at p to its foldcase version and
4947 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
4948 that the ustrp needs to be at least UTF8_MAXLEN_FOLD+1 bytes since the
4949 foldcase version may be longer than the original character (up to
4952 The first character of the foldcased version is returned
4953 (but note, as explained above, that there may be more.)
4955 UV to_utf8_fold(U8 *p, U8* ustrp, STRLEN *lenp)
4958 Found in file utf8.c
4962 Convert the UTF-8 encoded character at p to its lowercase version and
4963 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
4964 that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the
4965 lowercase version may be longer than the original character (up to two
4968 The first character of the lowercased version is returned
4969 (but note, as explained above, that there may be more.)
4971 UV to_utf8_lower(U8 *p, U8* ustrp, STRLEN *lenp)
4974 Found in file utf8.c
4978 Convert the UTF-8 encoded character at p to its titlecase version and
4979 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
4980 that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the
4981 titlecase version may be longer than the original character (up to two
4984 The first character of the titlecased version is returned
4985 (but note, as explained above, that there may be more.)
4987 UV to_utf8_title(U8 *p, U8* ustrp, STRLEN *lenp)
4990 Found in file utf8.c
4994 Convert the UTF-8 encoded character at p to its uppercase version and
4995 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
4996 that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the
4997 uppercase version may be longer than the original character (up to two
5000 The first character of the uppercased version is returned
5001 (but note, as explained above, that there may be more.)
5003 UV to_utf8_upper(U8 *p, U8* ustrp, STRLEN *lenp)
5006 Found in file utf8.c
5008 =item utf8n_to_uvchr
5010 Returns the native character value of the first character in the string C<s>
5011 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
5012 length, in bytes, of that character.
5014 Allows length and flags to be passed to low level routine.
5016 UV utf8n_to_uvchr(U8 *s, STRLEN curlen, STRLEN* retlen, U32 flags)
5019 Found in file utf8.c
5021 =item utf8n_to_uvuni
5023 Bottom level UTF-8 decode routine.
5024 Returns the unicode code point value of the first character in the string C<s>
5025 which is assumed to be in UTF-8 encoding and no longer than C<curlen>;
5026 C<retlen> will be set to the length, in bytes, of that character.
5028 If C<s> does not point to a well-formed UTF-8 character, the behaviour
5029 is dependent on the value of C<flags>: if it contains UTF8_CHECK_ONLY,
5030 it is assumed that the caller will raise a warning, and this function
5031 will silently just set C<retlen> to C<-1> and return zero. If the
5032 C<flags> does not contain UTF8_CHECK_ONLY, warnings about
5033 malformations will be given, C<retlen> will be set to the expected
5034 length of the UTF-8 character in bytes, and zero will be returned.
5036 The C<flags> can also contain various flags to allow deviations from
5037 the strict UTF-8 encoding (see F<utf8.h>).
5039 Most code should use utf8_to_uvchr() rather than call this directly.
5041 UV utf8n_to_uvuni(U8 *s, STRLEN curlen, STRLEN* retlen, U32 flags)
5044 Found in file utf8.c
5048 Returns the number of UTF-8 characters between the UTF-8 pointers C<a>
5051 WARNING: use only if you *know* that the pointers point inside the
5054 IV utf8_distance(U8 *a, U8 *b)
5057 Found in file utf8.c
5061 Return the UTF-8 pointer C<s> displaced by C<off> characters, either
5062 forward or backward.
5064 WARNING: do not use the following unless you *know* C<off> is within
5065 the UTF-8 data pointed to by C<s> *and* that on entry C<s> is aligned
5066 on the first byte of character or just after the last byte of a character.
5068 U8* utf8_hop(U8 *s, I32 off)
5071 Found in file utf8.c
5075 Return the length of the UTF-8 char encoded string C<s> in characters.
5076 Stops at C<e> (inclusive). If C<e E<lt> s> or if the scan would end
5077 up past C<e>, croaks.
5079 STRLEN utf8_length(U8* s, U8 *e)
5082 Found in file utf8.c
5086 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
5087 Unlike C<bytes_to_utf8>, this over-writes the original string, and
5088 updates len to contain the new length.
5089 Returns zero on failure, setting C<len> to -1.
5091 NOTE: this function is experimental and may change or be
5092 removed without notice.
5094 U8* utf8_to_bytes(U8 *s, STRLEN *len)
5097 Found in file utf8.c
5101 Returns the native character value of the first character in the string C<s>
5102 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
5103 length, in bytes, of that character.
5105 If C<s> does not point to a well-formed UTF-8 character, zero is
5106 returned and retlen is set, if possible, to -1.
5108 UV utf8_to_uvchr(U8 *s, STRLEN* retlen)
5111 Found in file utf8.c
5115 Returns the Unicode code point of the first character in the string C<s>
5116 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
5117 length, in bytes, of that character.
5119 This function should only be used when returned UV is considered
5120 an index into the Unicode semantic tables (e.g. swashes).
5122 If C<s> does not point to a well-formed UTF-8 character, zero is
5123 returned and retlen is set, if possible, to -1.
5125 UV utf8_to_uvuni(U8 *s, STRLEN* retlen)
5128 Found in file utf8.c
5132 Adds the UTF-8 representation of the Native codepoint C<uv> to the end
5133 of the string C<d>; C<d> should be have at least C<UTF8_MAXLEN+1> free
5134 bytes available. The return value is the pointer to the byte after the
5135 end of the new character. In other words,
5137 d = uvchr_to_utf8(d, uv);
5139 is the recommended wide native character-aware way of saying
5143 U8* uvchr_to_utf8(U8 *d, UV uv)
5146 Found in file utf8.c
5148 =item uvuni_to_utf8_flags
5150 Adds the UTF-8 representation of the Unicode codepoint C<uv> to the end
5151 of the string C<d>; C<d> should be have at least C<UTF8_MAXLEN+1> free
5152 bytes available. The return value is the pointer to the byte after the
5153 end of the new character. In other words,
5155 d = uvuni_to_utf8_flags(d, uv, flags);
5159 d = uvuni_to_utf8(d, uv);
5161 (which is equivalent to)
5163 d = uvuni_to_utf8_flags(d, uv, 0);
5165 is the recommended Unicode-aware way of saying
5169 U8* uvuni_to_utf8_flags(U8 *d, UV uv, UV flags)
5172 Found in file utf8.c
5177 =head1 Variables created by C<xsubpp> and C<xsubpp> internal functions
5183 Variable which is setup by C<xsubpp> to indicate the stack base offset,
5184 used by the C<ST>, C<XSprePUSH> and C<XSRETURN> macros. The C<dMARK> macro
5185 must be called prior to setup the C<MARK> variable.
5190 Found in file XSUB.h
5194 Variable which is setup by C<xsubpp> to indicate the
5195 class name for a C++ XS constructor. This is always a C<char*>. See C<THIS>.
5200 Found in file XSUB.h
5204 Sets up the C<ax> variable.
5205 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
5210 Found in file XSUB.h
5214 Sets up the C<items> variable.
5215 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
5220 Found in file XSUB.h
5224 Sets up stack and mark pointers for an XSUB, calling dSP and dMARK.
5225 Sets up the C<ax> and C<items> variables by calling C<dAX> and C<dITEMS>.
5226 This is usually handled automatically by C<xsubpp>.
5231 Found in file XSUB.h
5235 Sets up the C<ix> variable for an XSUB which has aliases. This is usually
5236 handled automatically by C<xsubpp>.
5241 Found in file XSUB.h
5245 Variable which is setup by C<xsubpp> to indicate the number of
5246 items on the stack. See L<perlxs/"Variable-length Parameter Lists">.
5251 Found in file XSUB.h
5255 Variable which is setup by C<xsubpp> to indicate which of an
5256 XSUB's aliases was used to invoke it. See L<perlxs/"The ALIAS: Keyword">.
5261 Found in file XSUB.h
5265 Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
5269 Found in file XSUB.h
5273 Variable which is setup by C<xsubpp> to hold the return value for an
5274 XSUB. This is always the proper type for the XSUB. See
5275 L<perlxs/"The RETVAL Variable">.
5280 Found in file XSUB.h
5284 Used to access elements on the XSUB's stack.
5289 Found in file XSUB.h
5293 Variable which is setup by C<xsubpp> to designate the object in a C++
5294 XSUB. This is always the proper type for the C++ object. See C<CLASS> and
5295 L<perlxs/"Using XS With C++">.
5300 Found in file XSUB.h
5304 Macro to declare an XSUB and its C parameter list. This is handled by
5308 Found in file XSUB.h
5310 =item XSRETURN_EMPTY
5312 Return an empty list from an XSUB immediately.
5318 Found in file XSUB.h
5322 The version identifier for an XS module. This is usually
5323 handled automatically by C<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>.
5326 Found in file XSUB.h
5328 =item XS_VERSION_BOOTCHECK
5330 Macro to verify that a PM module's $VERSION variable matches the XS
5331 module's C<XS_VERSION> variable. This is usually handled automatically by
5332 C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">.
5334 XS_VERSION_BOOTCHECK;
5337 Found in file XSUB.h
5342 =head1 Warning and Dieing
5348 This is the XSUB-writer's interface to Perl's C<die> function.
5349 Normally use this function the same way you use the C C<printf>
5350 function. See C<warn>.
5352 If you want to throw an exception object, assign the object to
5353 C<$@> and then pass C<Nullch> to croak():
5355 errsv = get_sv("@", TRUE);
5356 sv_setsv(errsv, exception_object);
5359 void croak(const char* pat, ...)
5362 Found in file util.c
5366 This is the XSUB-writer's interface to Perl's C<warn> function. Use this
5367 function the same way you use the C C<printf> function. See
5370 void warn(const char* pat, ...)
5373 Found in file util.c
5380 Until May 1997, this document was maintained by Jeff Okamoto
5381 <okamoto@corp.hp.com>. It is now maintained as part of Perl itself.
5383 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
5384 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
5385 Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
5386 Stephen McCamant, and Gurusamy Sarathy.
5388 API Listing originally by Dean Roehrich <roehrich@cray.com>.
5390 Updated to be autogenerated from comments in the source by Benjamin Stuhl.
5394 perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
projects / p5sagit/p5-mst-13.2.git / blob