3 perlapi - autogenerated documentation for the perl public API
7 This file contains the documentation of the perl public API generated by
8 embed.pl, specifically a listing of functions, macros, flags, and variables
9 that may be used by extension writers. The interfaces of any functions that
10 are not listed here are subject to change without notice. For this reason,
11 blindly using functions listed in proto.h is to be avoided when writing
14 Note that all Perl API global variables must be referenced with the C<PL_>
15 prefix. Some macros are provided for compatibility with the older,
16 unadorned names, but this support may be disabled in a future release.
18 The listing is alphabetical, case insensitive.
27 A backward-compatible version of C<GIMME_V> which can only return
28 C<G_SCALAR> or C<G_ARRAY>; in a void context, it returns C<G_SCALAR>.
29 Deprecated. Use C<GIMME_V> instead.
38 The XSUB-writer's equivalent to Perl's C<wantarray>. Returns C<G_VOID>,
39 C<G_SCALAR> or C<G_ARRAY> for void, scalar or list context,
49 Used to indicate list context. See C<GIMME_V>, C<GIMME> and
57 Indicates that arguments returned from a callback should be discarded. See
65 Used to force a Perl C<eval> wrapper around a callback. See
73 Indicates that no arguments are being sent to a callback. See
81 Used to indicate scalar context. See C<GIMME_V>, C<GIMME>, and
89 Used to indicate void context. See C<GIMME_V> and L<perlcall>.
97 =head1 Array Manipulation Functions
103 Same as C<av_len()>. Deprecated, use C<av_len()> instead.
112 Clears an array, making it empty. Does not free the memory used by the
115 void av_clear(AV* ar)
122 Deletes the element indexed by C<key> from the array. Returns the
123 deleted element. C<flags> is currently ignored.
125 SV* av_delete(AV* ar, I32 key, I32 flags)
132 Returns true if the element indexed by C<key> has been initialized.
134 This relies on the fact that uninitialized array elements are set to
137 bool av_exists(AV* ar, I32 key)
144 Pre-extend an array. The C<key> is the index to which the array should be
147 void av_extend(AV* ar, I32 key)
154 Returns the SV at the specified index in the array. The C<key> is the
155 index. If C<lval> is set then the fetch will be part of a store. Check
156 that the return value is non-null before dereferencing it to a C<SV*>.
158 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for
159 more information on how to use this function on tied arrays.
161 SV** av_fetch(AV* ar, I32 key, I32 lval)
168 Ensure than an array has a given number of elements, equivalent to
169 Perl's C<$#array = $fill;>.
171 void av_fill(AV* ar, I32 fill)
178 Returns the highest index in the array. Returns -1 if the array is
188 Creates a new AV and populates it with a list of SVs. The SVs are copied
189 into the array, so they may be freed after the call to av_make. The new AV
190 will have a reference count of 1.
192 AV* av_make(I32 size, SV** svp)
199 Pops an SV off the end of the array. Returns C<&PL_sv_undef> if the array
209 Pushes an SV onto the end of the array. The array will grow automatically
210 to accommodate the addition.
212 void av_push(AV* ar, SV* val)
219 Shifts an SV off the beginning of the array.
228 Stores an SV in an array. The array index is specified as C<key>. The
229 return value will be NULL if the operation failed or if the value did not
230 need to be actually stored within the array (as in the case of tied
231 arrays). Otherwise it can be dereferenced to get the original C<SV*>. Note
232 that the caller is responsible for suitably incrementing the reference
233 count of C<val> before the call, and decrementing it if the function
236 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for
237 more information on how to use this function on tied arrays.
239 SV** av_store(AV* ar, I32 key, SV* val)
246 Undefines the array. Frees the memory used by the array itself.
248 void av_undef(AV* ar)
255 Unshift the given number of C<undef> values onto the beginning of the
256 array. The array will grow automatically to accommodate the addition. You
257 must then use C<av_store> to assign values to these new elements.
259 void av_unshift(AV* ar, I32 num)
266 Returns the AV of the specified Perl array. If C<create> is set and the
267 Perl variable does not exist then it will be created. If C<create> is not
268 set and the variable does not exist then NULL is returned.
270 NOTE: the perl_ form of this function is deprecated.
272 AV* get_av(const char* name, I32 create)
279 Creates a new AV. The reference count is set to 1.
296 Sort an array. Here is an example:
298 sortsv(AvARRAY(av), av_len(av)+1, Perl_sv_cmp_locale);
300 See lib/sort.pm for details about controlling the sorting algorithm.
302 void sortsv(SV ** array, size_t num_elts, SVCOMPARE_t cmp)
305 Found in file pp_sort.c
310 =head1 Callback Functions
316 Performs a callback to the specified Perl sub. See L<perlcall>.
318 NOTE: the perl_ form of this function is deprecated.
320 I32 call_argv(const char* sub_name, I32 flags, char** argv)
327 Performs a callback to the specified Perl method. The blessed object must
328 be on the stack. See L<perlcall>.
330 NOTE: the perl_ form of this function is deprecated.
332 I32 call_method(const char* methname, I32 flags)
339 Performs a callback to the specified Perl sub. See L<perlcall>.
341 NOTE: the perl_ form of this function is deprecated.
343 I32 call_pv(const char* sub_name, I32 flags)
350 Performs a callback to the Perl sub whose name is in the SV. See
353 NOTE: the perl_ form of this function is deprecated.
355 I32 call_sv(SV* sv, I32 flags)
362 Opening bracket on a callback. See C<LEAVE> and L<perlcall>.
367 Found in file scope.h
371 Tells Perl to C<eval> the given string and return an SV* result.
373 NOTE: the perl_ form of this function is deprecated.
375 SV* eval_pv(const char* p, I32 croak_on_error)
382 Tells Perl to C<eval> the string in the SV.
384 NOTE: the perl_ form of this function is deprecated.
386 I32 eval_sv(SV* sv, I32 flags)
393 Closing bracket for temporaries on a callback. See C<SAVETMPS> and
399 Found in file scope.h
403 Closing bracket on a callback. See C<ENTER> and L<perlcall>.
408 Found in file scope.h
412 Opening bracket for temporaries on a callback. See C<FREETMPS> and
418 Found in file scope.h
423 =head1 Character classes
429 Returns a boolean indicating whether the C C<char> is an ASCII alphanumeric
430 character (including underscore) or digit.
432 bool isALNUM(char ch)
435 Found in file handy.h
439 Returns a boolean indicating whether the C C<char> is an ASCII alphabetic
442 bool isALPHA(char ch)
445 Found in file handy.h
449 Returns a boolean indicating whether the C C<char> is an ASCII
452 bool isDIGIT(char ch)
455 Found in file handy.h
459 Returns a boolean indicating whether the C C<char> is a lowercase
462 bool isLOWER(char ch)
465 Found in file handy.h
469 Returns a boolean indicating whether the C C<char> is whitespace.
471 bool isSPACE(char ch)
474 Found in file handy.h
478 Returns a boolean indicating whether the C C<char> is an uppercase
481 bool isUPPER(char ch)
484 Found in file handy.h
488 Converts the specified character to lowercase.
490 char toLOWER(char ch)
493 Found in file handy.h
497 Converts the specified character to uppercase.
499 char toUPPER(char ch)
502 Found in file handy.h
507 =head1 Cloning an interpreter
513 Create and return a new interpreter by cloning the current one.
515 perl_clone takes these flags as paramters:
517 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
518 without it we only clone the data and zero the stacks,
519 with it we copy the stacks and the new perl interpreter is
520 ready to run at the exact same point as the previous one.
521 The pseudo-fork code uses COPY_STACKS while the
522 threads->new doesn't.
524 CLONEf_KEEP_PTR_TABLE
525 perl_clone keeps a ptr_table with the pointer of the old
526 variable as a key and the new variable as a value,
527 this allows it to check if something has been cloned and not
528 clone it again but rather just use the value and increase the
529 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
530 the ptr_table using the function
531 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
532 reason to keep it around is if you want to dup some of your own
533 variable who are outside the graph perl scans, example of this
534 code is in threads.xs create
537 This is a win32 thing, it is ignored on unix, it tells perls
538 win32host code (which is c++) to clone itself, this is needed on
539 win32 if you want to run two threads at the same time,
540 if you just want to do some stuff in a separate perl interpreter
541 and then throw it away and return to the original one,
542 you don't need to do anything.
544 PerlInterpreter* perl_clone(PerlInterpreter* interp, UV flags)
552 =head1 CV Manipulation Functions
558 Returns the stash of the CV.
567 Returns the CV of the specified Perl subroutine. If C<create> is set and
568 the Perl subroutine does not exist then it will be declared (which has the
569 same effect as saying C<sub name;>). If C<create> is not set and the
570 subroutine does not exist then NULL is returned.
572 NOTE: the perl_ form of this function is deprecated.
574 CV* get_cv(const char* name, I32 create)
590 =head1 Embedding Functions
596 Clear out all the active components of a CV. This can happen either
597 by an explicit C<undef &foo>, or by the reference count going to zero.
598 In the former case, we keep the CvOUTSIDE pointer, so that any anonymous
599 children can still follow the full lexical scope chain.
601 void cv_undef(CV* cv)
608 Loads the module whose name is pointed to by the string part of name.
609 Note that the actual module name, not its filename, should be given.
610 Eg, "Foo::Bar" instead of "Foo/Bar.pm". flags can be any of
611 PERL_LOADMOD_DENY, PERL_LOADMOD_NOIMPORT, or PERL_LOADMOD_IMPORT_OPS
612 (or 0 for no flags). ver, if specified, provides version semantics
613 similar to C<use Foo::Bar VERSION>. The optional trailing SV*
614 arguments can be used to specify arguments to the module's import()
615 method, similar to C<use Foo::Bar VERSION LIST>.
617 void load_module(U32 flags, SV* name, SV* ver, ...)
624 Stub that provides thread hook for perl_destruct when there are
634 Allocates a new Perl interpreter. See L<perlembed>.
636 PerlInterpreter* perl_alloc()
643 Initializes a new Perl interpreter. See L<perlembed>.
645 void perl_construct(PerlInterpreter* interp)
652 Shuts down a Perl interpreter. See L<perlembed>.
654 int perl_destruct(PerlInterpreter* interp)
661 Releases a Perl interpreter. See L<perlembed>.
663 void perl_free(PerlInterpreter* interp)
670 Tells a Perl interpreter to parse a Perl script. See L<perlembed>.
672 int perl_parse(PerlInterpreter* interp, XSINIT_t xsinit, int argc, char** argv, char** env)
679 Tells a Perl interpreter to run. See L<perlembed>.
681 int perl_run(PerlInterpreter* interp)
688 Tells Perl to C<require> the file named by the string argument. It is
689 analogous to the Perl code C<eval "require '$file'">. It's even
690 implemented that way; consider using load_module instead.
692 NOTE: the perl_ form of this function is deprecated.
694 void require_pv(const char* pv)
702 =head1 Functions in file pp_pack.c
709 The engine implementing pack() Perl function.
711 void pack_cat(SV *cat, char *pat, char *patend, SV **beglist, SV **endlist, SV ***next_in_list, U32 flags)
714 Found in file pp_pack.c
718 The engine implementing unpack() Perl function.
720 I32 unpack_str(char *pat, char *patend, char *s, char *strbeg, char *strend, char **new_s, I32 ocnt, U32 flags)
723 Found in file pp_pack.c
728 =head1 Global Variables
734 C<PL_modglobal> is a general purpose, interpreter global HV for use by
735 extensions that need to keep information on a per-interpreter basis.
736 In a pinch, it can also be used as a symbol table for extensions
737 to share data among each other. It is a good idea to use keys
738 prefixed by the package name of the extension that owns the data.
743 Found in file intrpvar.h
747 A convenience variable which is typically used with C<SvPV> when one
748 doesn't care about the length of the string. It is usually more efficient
749 to either declare a local variable and use that instead or to use the
755 Found in file thrdvar.h
759 This is the C<false> SV. See C<PL_sv_yes>. Always refer to this as
765 Found in file intrpvar.h
769 This is the C<undef> SV. Always refer to this as C<&PL_sv_undef>.
774 Found in file intrpvar.h
778 This is the C<true> SV. See C<PL_sv_no>. Always refer to this as
784 Found in file intrpvar.h
795 Return the SV from the GV.
804 Returns the glob with the given C<name> and a defined subroutine or
805 C<NULL>. The glob lives in the given C<stash>, or in the stashes
806 accessible via @ISA and UNIVERSAL::.
808 The argument C<level> should be either 0 or -1. If C<level==0>, as a
809 side-effect creates a glob with the given C<name> in the given C<stash>
810 which in the case of success contains an alias for the subroutine, and sets
811 up caching info for this glob. Similarly for all the searched stashes.
813 This function grants C<"SUPER"> token as a postfix of the stash name. The
814 GV returned from C<gv_fetchmeth> may be a method cache entry, which is not
815 visible to Perl code. So when calling C<call_sv>, you should not use
816 the GV directly; instead, you should use the method's CV, which can be
817 obtained from the GV with the C<GvCV> macro.
819 GV* gv_fetchmeth(HV* stash, const char* name, STRLEN len, I32 level)
826 See L<gv_fetchmethod_autoload>.
828 GV* gv_fetchmethod(HV* stash, const char* name)
833 =item gv_fetchmethod_autoload
835 Returns the glob which contains the subroutine to call to invoke the method
836 on the C<stash>. In fact in the presence of autoloading this may be the
837 glob for "AUTOLOAD". In this case the corresponding variable $AUTOLOAD is
840 The third parameter of C<gv_fetchmethod_autoload> determines whether
841 AUTOLOAD lookup is performed if the given method is not present: non-zero
842 means yes, look for AUTOLOAD; zero means no, don't look for AUTOLOAD.
843 Calling C<gv_fetchmethod> is equivalent to calling C<gv_fetchmethod_autoload>
844 with a non-zero C<autoload> parameter.
846 These functions grant C<"SUPER"> token as a prefix of the method name. Note
847 that if you want to keep the returned glob for a long time, you need to
848 check for it being "AUTOLOAD", since at the later time the call may load a
849 different subroutine due to $AUTOLOAD changing its value. Use the glob
850 created via a side effect to do this.
852 These functions have the same side-effects and as C<gv_fetchmeth> with
853 C<level==0>. C<name> should be writable if contains C<':'> or C<'
854 ''>. The warning against passing the GV returned by C<gv_fetchmeth> to
855 C<call_sv> apply equally to these functions.
857 GV* gv_fetchmethod_autoload(HV* stash, const char* name, I32 autoload)
862 =item gv_fetchmeth_autoload
864 Same as gv_fetchmeth(), but looks for autoloaded subroutines too.
865 Returns a glob for the subroutine.
867 For an autoloaded subroutine without a GV, will create a GV even
868 if C<level < 0>. For an autoloaded subroutine without a stub, GvCV()
869 of the result may be zero.
871 GV* gv_fetchmeth_autoload(HV* stash, const char* name, STRLEN len, I32 level)
878 Returns a pointer to the stash for a specified package. C<name> should
879 be a valid UTF-8 string. If C<create> is set then the package will be
880 created if it does not already exist. If C<create> is not set and the
881 package does not exist then NULL is returned.
883 HV* gv_stashpv(const char* name, I32 create)
890 Returns a pointer to the stash for a specified package, which must be a
891 valid UTF-8 string. See C<gv_stashpv>.
893 HV* gv_stashsv(SV* sv, I32 create)
907 This flag, used in the length slot of hash entries and magic structures,
908 specifies the structure contains an C<SV*> pointer where a C<char*> pointer
909 is to be expected. (For information only--not to be used).
917 Null character pointer.
920 Found in file handy.h
927 Found in file handy.h
932 =head1 Hash Manipulation Functions
938 Returns the HV of the specified Perl hash. If C<create> is set and the
939 Perl variable does not exist then it will be created. If C<create> is not
940 set and the variable does not exist then NULL is returned.
942 NOTE: the perl_ form of this function is deprecated.
944 HV* get_hv(const char* name, I32 create)
951 Returns the computed hash stored in the hash entry.
960 Returns the actual pointer stored in the key slot of the hash entry. The
961 pointer may be either C<char*> or C<SV*>, depending on the value of
962 C<HeKLEN()>. Can be assigned to. The C<HePV()> or C<HeSVKEY()> macros are
963 usually preferable for finding the value of a key.
972 If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry
973 holds an C<SV*> key. Otherwise, holds the actual length of the key. Can
974 be assigned to. The C<HePV()> macro is usually preferable for finding key
977 STRLEN HeKLEN(HE* he)
984 Returns the key slot of the hash entry as a C<char*> value, doing any
985 necessary dereferencing of possibly C<SV*> keys. The length of the string
986 is placed in C<len> (this is a macro, so do I<not> use C<&len>). If you do
987 not care about what the length of the key is, you may use the global
988 variable C<PL_na>, though this is rather less efficient than using a local
989 variable. Remember though, that hash keys in perl are free to contain
990 embedded nulls, so using C<strlen()> or similar is not a good way to find
991 the length of hash keys. This is very similar to the C<SvPV()> macro
992 described elsewhere in this document.
994 char* HePV(HE* he, STRLEN len)
1001 Returns the key as an C<SV*>, or C<Nullsv> if the hash entry does not
1002 contain an C<SV*> key.
1011 Returns the key as an C<SV*>. Will create and return a temporary mortal
1012 C<SV*> if the hash entry contains only a C<char*> key.
1014 SV* HeSVKEY_force(HE* he)
1021 Sets the key to a given C<SV*>, taking care to set the appropriate flags to
1022 indicate the presence of an C<SV*> key, and returns the same
1025 SV* HeSVKEY_set(HE* he, SV* sv)
1032 Returns the value slot (type C<SV*>) stored in the hash entry.
1041 Returns the package name of a stash. See C<SvSTASH>, C<CvSTASH>.
1043 char* HvNAME(HV* stash)
1050 Clears a hash, making it empty.
1052 void hv_clear(HV* tb)
1059 Deletes a key/value pair in the hash. The value SV is removed from the
1060 hash and returned to the caller. The C<klen> is the length of the key.
1061 The C<flags> value will normally be zero; if set to G_DISCARD then NULL
1064 SV* hv_delete(HV* tb, const char* key, I32 klen, I32 flags)
1071 Deletes a key/value pair in the hash. The value SV is removed from the
1072 hash and returned to the caller. The C<flags> value will normally be zero;
1073 if set to G_DISCARD then NULL will be returned. C<hash> can be a valid
1074 precomputed hash value, or 0 to ask for it to be computed.
1076 SV* hv_delete_ent(HV* tb, SV* key, I32 flags, U32 hash)
1083 Returns a boolean indicating whether the specified hash key exists. The
1084 C<klen> is the length of the key.
1086 bool hv_exists(HV* tb, const char* key, I32 klen)
1093 Returns a boolean indicating whether the specified hash key exists. C<hash>
1094 can be a valid precomputed hash value, or 0 to ask for it to be
1097 bool hv_exists_ent(HV* tb, SV* key, U32 hash)
1104 Returns the SV which corresponds to the specified key in the hash. The
1105 C<klen> is the length of the key. If C<lval> is set then the fetch will be
1106 part of a store. Check that the return value is non-null before
1107 dereferencing it to an C<SV*>.
1109 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1110 information on how to use this function on tied hashes.
1112 SV** hv_fetch(HV* tb, const char* key, I32 klen, I32 lval)
1119 Returns the hash entry which corresponds to the specified key in the hash.
1120 C<hash> must be a valid precomputed hash number for the given C<key>, or 0
1121 if you want the function to compute it. IF C<lval> is set then the fetch
1122 will be part of a store. Make sure the return value is non-null before
1123 accessing it. The return value when C<tb> is a tied hash is a pointer to a
1124 static location, so be sure to make a copy of the structure if you need to
1127 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1128 information on how to use this function on tied hashes.
1130 HE* hv_fetch_ent(HV* tb, SV* key, I32 lval, U32 hash)
1137 Prepares a starting point to traverse a hash table. Returns the number of
1138 keys in the hash (i.e. the same as C<HvKEYS(tb)>). The return value is
1139 currently only meaningful for hashes without tie magic.
1141 NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
1142 hash buckets that happen to be in use. If you still need that esoteric
1143 value, you can get it through the macro C<HvFILL(tb)>.
1146 I32 hv_iterinit(HV* tb)
1153 Returns the key from the current position of the hash iterator. See
1156 char* hv_iterkey(HE* entry, I32* retlen)
1163 Returns the key as an C<SV*> from the current position of the hash
1164 iterator. The return value will always be a mortal copy of the key. Also
1167 SV* hv_iterkeysv(HE* entry)
1174 Returns entries from a hash iterator. See C<hv_iterinit>.
1176 You may call C<hv_delete> or C<hv_delete_ent> on the hash entry that the
1177 iterator currently points to, without losing your place or invalidating your
1178 iterator. Note that in this case the current entry is deleted from the hash
1179 with your iterator holding the last reference to it. Your iterator is flagged
1180 to free the entry on the next call to C<hv_iternext>, so you must not discard
1181 your iterator immediately else the entry will leak - call C<hv_iternext> to
1182 trigger the resource deallocation.
1184 HE* hv_iternext(HV* tb)
1191 Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
1194 SV* hv_iternextsv(HV* hv, char** key, I32* retlen)
1199 =item hv_iternext_flags
1201 Returns entries from a hash iterator. See C<hv_iterinit> and C<hv_iternext>.
1202 The C<flags> value will normally be zero; if HV_ITERNEXT_WANTPLACEHOLDERS is
1203 set the placeholders keys (for restricted hashes) will be returned in addition
1204 to normal keys. By default placeholders are automatically skipped over.
1205 Currently a placeholder is implemented with a value that is literally
1206 <&Perl_sv_undef> (a regular C<undef> value is a normal read-write SV for which
1207 C<!SvOK> is false). Note that the implementation of placeholders and
1208 restricted hashes may change, and the implementation currently is
1209 insufficiently abstracted for any change to be tidy.
1211 NOTE: this function is experimental and may change or be
1212 removed without notice.
1214 HE* hv_iternext_flags(HV* tb, I32 flags)
1221 Returns the value from the current position of the hash iterator. See
1224 SV* hv_iterval(HV* tb, HE* entry)
1231 Adds magic to a hash. See C<sv_magic>.
1233 void hv_magic(HV* hv, GV* gv, int how)
1240 Stores an SV in a hash. The hash key is specified as C<key> and C<klen> is
1241 the length of the key. The C<hash> parameter is the precomputed hash
1242 value; if it is zero then Perl will compute it. The return value will be
1243 NULL if the operation failed or if the value did not need to be actually
1244 stored within the hash (as in the case of tied hashes). Otherwise it can
1245 be dereferenced to get the original C<SV*>. Note that the caller is
1246 responsible for suitably incrementing the reference count of C<val> before
1247 the call, and decrementing it if the function returned NULL. Effectively
1248 a successful hv_store takes ownership of one reference to C<val>. This is
1249 usually what you want; a newly created SV has a reference count of one, so
1250 if all your code does is create SVs then store them in a hash, hv_store
1251 will own the only reference to the new SV, and your code doesn't need to do
1252 anything further to tidy up. hv_store is not implemented as a call to
1253 hv_store_ent, and does not create a temporary SV for the key, so if your
1254 key data is not already in SV form then use hv_store in preference to
1257 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1258 information on how to use this function on tied hashes.
1260 SV** hv_store(HV* tb, const char* key, I32 klen, SV* val, U32 hash)
1267 Stores C<val> in a hash. The hash key is specified as C<key>. The C<hash>
1268 parameter is the precomputed hash value; if it is zero then Perl will
1269 compute it. The return value is the new hash entry so created. It will be
1270 NULL if the operation failed or if the value did not need to be actually
1271 stored within the hash (as in the case of tied hashes). Otherwise the
1272 contents of the return value can be accessed using the C<He?> macros
1273 described here. Note that the caller is responsible for suitably
1274 incrementing the reference count of C<val> before the call, and
1275 decrementing it if the function returned NULL. Effectively a successful
1276 hv_store_ent takes ownership of one reference to C<val>. This is
1277 usually what you want; a newly created SV has a reference count of one, so
1278 if all your code does is create SVs then store them in a hash, hv_store
1279 will own the only reference to the new SV, and your code doesn't need to do
1280 anything further to tidy up. Note that hv_store_ent only reads the C<key>;
1281 unlike C<val> it does not take ownership of it, so maintaining the correct
1282 reference count on C<key> is entirely the caller's responsibility. hv_store
1283 is not implemented as a call to hv_store_ent, and does not create a temporary
1284 SV for the key, so if your key data is not already in SV form then use
1285 hv_store in preference to hv_store_ent.
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 HE* hv_store_ent(HV* tb, SV* key, SV* val, U32 hash)
1299 void hv_undef(HV* tb)
1306 Creates a new HV. The reference count is set to 1.
1324 =head1 Magical Functions
1330 Clear something magical that the SV represents. See C<sv_magic>.
1332 int mg_clear(SV* sv)
1339 Copies the magic from one SV to another. See C<sv_magic>.
1341 int mg_copy(SV* sv, SV* nsv, const char* key, I32 klen)
1348 Finds the magic pointer for type matching the SV. See C<sv_magic>.
1350 MAGIC* mg_find(SV* sv, int type)
1357 Free any magic storage used by the SV. See C<sv_magic>.
1366 Do magic after a value is retrieved from the SV. See C<sv_magic>.
1375 Report on the SV's length. See C<sv_magic>.
1377 U32 mg_length(SV* sv)
1384 Turns on the magical status of an SV. See C<sv_magic>.
1386 void mg_magical(SV* sv)
1393 Do magic after a value is assigned to the SV. See C<sv_magic>.
1402 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
1403 argument more than once.
1405 void SvGETMAGIC(SV* sv)
1412 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
1422 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
1423 argument more than once.
1425 void SvSETMAGIC(SV* sv)
1432 Like C<SvSetSV>, but does any set magic required afterwards.
1434 void SvSetMagicSV(SV* dsb, SV* ssv)
1439 =item SvSetMagicSV_nosteal
1441 Like C<SvSetMagicSV>, but does any set magic required afterwards.
1443 void SvSetMagicSV_nosteal(SV* dsv, SV* ssv)
1450 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
1453 void SvSetSV(SV* dsb, SV* ssv)
1458 =item SvSetSV_nosteal
1460 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
1461 ssv. May evaluate arguments more than once.
1463 void SvSetSV_nosteal(SV* dsv, SV* ssv)
1470 Arranges for sv to be shared between threads if a suitable module
1473 void SvSHARE(SV* sv)
1481 =head1 Memory Management
1487 The XSUB-writer's interface to the C C<memcpy> function. The C<src> is the
1488 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1489 the type. May fail on overlapping copies. See also C<Move>.
1491 void Copy(void* src, void* dest, int nitems, type)
1494 Found in file handy.h
1498 The XSUB-writer's interface to the C C<memmove> function. The C<src> is the
1499 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1500 the type. Can do overlapping moves. See also C<Copy>.
1502 void Move(void* src, void* dest, int nitems, type)
1505 Found in file handy.h
1509 The XSUB-writer's interface to the C C<malloc> function.
1511 void New(int id, void* ptr, int nitems, type)
1514 Found in file handy.h
1518 The XSUB-writer's interface to the C C<malloc> function, with
1521 void Newc(int id, void* ptr, int nitems, type, cast)
1524 Found in file handy.h
1528 Creates a new SV. A non-zero C<len> parameter indicates the number of
1529 bytes of preallocated string space the SV should have. An extra byte for a
1530 tailing NUL is also reserved. (SvPOK is not set for the SV even if string
1531 space is allocated.) The reference count for the new SV is set to 1.
1532 C<id> is an integer id between 0 and 1299 (used to identify leaks).
1535 SV* NEWSV(int id, STRLEN len)
1538 Found in file handy.h
1542 The XSUB-writer's interface to the C C<malloc> function. The allocated
1543 memory is zeroed with C<memzero>.
1545 void Newz(int id, void* ptr, int nitems, type)
1548 Found in file handy.h
1552 Fill up memory with a pattern (byte 0xAB over and over again) that
1553 hopefully catches attempts to access uninitialized memory.
1555 void Poison(void* dest, int nitems, type)
1558 Found in file handy.h
1562 The XSUB-writer's interface to the C C<realloc> function.
1564 void Renew(void* ptr, int nitems, type)
1567 Found in file handy.h
1571 The XSUB-writer's interface to the C C<realloc> function, with
1574 void Renewc(void* ptr, int nitems, type, cast)
1577 Found in file handy.h
1581 The XSUB-writer's interface to the C C<free> function.
1583 void Safefree(void* ptr)
1586 Found in file handy.h
1590 Perl's version of C<strdup()>. Returns a pointer to a newly allocated
1591 string which is a duplicate of C<pv>. The size of the string is
1592 determined by C<strlen()>. The memory allocated for the new string can
1593 be freed with the C<Safefree()> function.
1595 char* savepv(const char* pv)
1598 Found in file util.c
1602 Perl's version of what C<strndup()> would be if it existed. Returns a
1603 pointer to a newly allocated string which is a duplicate of the first
1604 C<len> bytes from C<pv>. The memory allocated for the new string can be
1605 freed with the C<Safefree()> function.
1607 char* savepvn(const char* pv, I32 len)
1610 Found in file util.c
1614 A version of C<savepv()> which allocates the duplicate string in memory
1615 which is shared between threads.
1617 char* savesharedpv(const char* pv)
1620 Found in file util.c
1624 This is an architecture-independent macro to copy one structure to another.
1626 void StructCopy(type src, type dest, type)
1629 Found in file handy.h
1633 The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the
1634 destination, C<nitems> is the number of items, and C<type> is the type.
1636 void Zero(void* dest, int nitems, type)
1639 Found in file handy.h
1644 =head1 Miscellaneous Functions
1650 Analyses the string in order to make fast searches on it using fbm_instr()
1651 -- the Boyer-Moore algorithm.
1653 void fbm_compile(SV* sv, U32 flags)
1656 Found in file util.c
1660 Returns the location of the SV in the string delimited by C<str> and
1661 C<strend>. It returns C<Nullch> if the string can't be found. The C<sv>
1662 does not have to be fbm_compiled, but the search will not be as fast
1665 char* fbm_instr(unsigned char* big, unsigned char* bigend, SV* littlesv, U32 flags)
1668 Found in file util.c
1672 Takes a sprintf-style format pattern and conventional
1673 (non-SV) arguments and returns the formatted string.
1675 (char *) Perl_form(pTHX_ const char* pat, ...)
1677 can be used any place a string (char *) is required:
1679 char * s = Perl_form("%d.%d",major,minor);
1681 Uses a single private buffer so if you want to format several strings you
1682 must explicitly copy the earlier strings away (and free the copies when you
1685 char* form(const char* pat, ...)
1688 Found in file util.c
1692 Fill the sv with current working directory
1694 int getcwd_sv(SV* sv)
1697 Found in file util.c
1701 Test two strings to see if they are equal. Returns true or false.
1703 bool strEQ(char* s1, char* s2)
1706 Found in file handy.h
1710 Test two strings to see if the first, C<s1>, is greater than or equal to
1711 the second, C<s2>. Returns true or false.
1713 bool strGE(char* s1, char* s2)
1716 Found in file handy.h
1720 Test two strings to see if the first, C<s1>, is greater than the second,
1721 C<s2>. Returns true or false.
1723 bool strGT(char* s1, char* s2)
1726 Found in file handy.h
1730 Test two strings to see if the first, C<s1>, is less than or equal to the
1731 second, C<s2>. Returns true or false.
1733 bool strLE(char* s1, char* s2)
1736 Found in file handy.h
1740 Test two strings to see if the first, C<s1>, is less than the second,
1741 C<s2>. Returns true or false.
1743 bool strLT(char* s1, char* s2)
1746 Found in file handy.h
1750 Test two strings to see if they are different. Returns true or
1753 bool strNE(char* s1, char* s2)
1756 Found in file handy.h
1760 Test two strings to see if they are equal. The C<len> parameter indicates
1761 the number of bytes to compare. Returns true or false. (A wrapper for
1764 bool strnEQ(char* s1, char* s2, STRLEN len)
1767 Found in file handy.h
1771 Test two strings to see if they are different. The C<len> parameter
1772 indicates the number of bytes to compare. Returns true or false. (A
1773 wrapper for C<strncmp>).
1775 bool strnNE(char* s1, char* s2, STRLEN len)
1778 Found in file handy.h
1783 =head1 Numeric functions
1789 converts a string representing a binary number to numeric form.
1791 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
1792 conversion flags, and I<result> should be NULL or a pointer to an NV.
1793 The scan stops at the end of the string, or the first invalid character.
1794 On return I<*len> is set to the length scanned string, and I<*flags> gives
1797 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
1798 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_bin>
1799 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
1800 and writes the value to I<*result> (or the value is discarded if I<result>
1803 The hex number may optionally be prefixed with "0b" or "b" unless
1804 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
1805 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the binary
1806 number may use '_' characters to separate digits.
1808 UV grok_bin(char* start, STRLEN* len, I32* flags, NV *result)
1811 Found in file numeric.c
1815 converts a string representing a hex number to numeric form.
1817 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
1818 conversion flags, and I<result> should be NULL or a pointer to an NV.
1819 The scan stops at the end of the string, or the first non-hex-digit character.
1820 On return I<*len> is set to the length scanned string, and I<*flags> gives
1823 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
1824 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_hex>
1825 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
1826 and writes the value to I<*result> (or the value is discarded if I<result>
1829 The hex number may optionally be prefixed with "0x" or "x" unless
1830 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
1831 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the hex
1832 number may use '_' characters to separate digits.
1834 UV grok_hex(char* start, STRLEN* len, I32* flags, NV *result)
1837 Found in file numeric.c
1841 Recognise (or not) a number. The type of the number is returned
1842 (0 if unrecognised), otherwise it is a bit-ORed combination of
1843 IS_NUMBER_IN_UV, IS_NUMBER_GREATER_THAN_UV_MAX, IS_NUMBER_NOT_INT,
1844 IS_NUMBER_NEG, IS_NUMBER_INFINITY, IS_NUMBER_NAN (defined in perl.h).
1846 If the value of the number can fit an in UV, it is returned in the *valuep
1847 IS_NUMBER_IN_UV will be set to indicate that *valuep is valid, IS_NUMBER_IN_UV
1848 will never be set unless *valuep is valid, but *valuep may have been assigned
1849 to during processing even though IS_NUMBER_IN_UV is not set on return.
1850 If valuep is NULL, IS_NUMBER_IN_UV will be set for the same cases as when
1851 valuep is non-NULL, but no actual assignment (or SEGV) will occur.
1853 IS_NUMBER_NOT_INT will be set with IS_NUMBER_IN_UV if trailing decimals were
1854 seen (in which case *valuep gives the true value truncated to an integer), and
1855 IS_NUMBER_NEG if the number is negative (in which case *valuep holds the
1856 absolute value). IS_NUMBER_IN_UV is not set if e notation was used or the
1857 number is larger than a UV.
1859 int grok_number(const char *pv, STRLEN len, UV *valuep)
1862 Found in file numeric.c
1864 =item grok_numeric_radix
1866 Scan and skip for a numeric decimal separator (radix).
1868 bool grok_numeric_radix(const char **sp, const char *send)
1871 Found in file numeric.c
1876 UV grok_oct(char* start, STRLEN* len, I32* flags, NV *result)
1879 Found in file numeric.c
1883 For backwards compatibility. Use C<grok_bin> instead.
1885 NV scan_bin(char* start, STRLEN len, STRLEN* retlen)
1888 Found in file numeric.c
1892 For backwards compatibility. Use C<grok_hex> instead.
1894 NV scan_hex(char* start, STRLEN len, STRLEN* retlen)
1897 Found in file numeric.c
1901 For backwards compatibility. Use C<grok_oct> instead.
1903 NV scan_oct(char* start, STRLEN len, STRLEN* retlen)
1906 Found in file numeric.c
1911 =head1 Optree Manipulation Functions
1917 If C<cv> is a constant sub eligible for inlining. returns the constant
1918 value returned by the sub. Otherwise, returns NULL.
1920 Constant subs can be created with C<newCONSTSUB> or as described in
1921 L<perlsub/"Constant Functions">.
1923 SV* cv_const_sv(CV* cv)
1930 Creates a constant sub equivalent to Perl C<sub FOO () { 123 }> which is
1931 eligible for inlining at compile-time.
1933 CV* newCONSTSUB(HV* stash, char* name, SV* sv)
1940 Used by C<xsubpp> to hook up XSUBs as Perl subs.
1948 =head1 Pad Data Structures
1954 Get the value at offset po in the current pad.
1955 Use macro PAD_SV instead of calling this function directly.
1957 SV* pad_sv(PADOFFSET po)
1965 =head1 Stack Manipulation Macros
1971 Declare a stack marker variable, C<mark>, for the XSUB. See C<MARK> and
1981 Saves the original stack mark for the XSUB. See C<ORIGMARK>.
1990 Declares a local copy of perl's stack pointer for the XSUB, available via
1991 the C<SP> macro. See C<SP>.
2000 Used to extend the argument stack for an XSUB's return values. Once
2001 used, guarantees that there is room for at least C<nitems> to be pushed
2004 void EXTEND(SP, int nitems)
2011 Stack marker variable for the XSUB. See C<dMARK>.
2018 The original stack mark for the XSUB. See C<dORIGMARK>.
2025 Pops an integer off the stack.
2034 Pops a long off the stack.
2043 Pops a double off the stack.
2052 Pops a string off the stack. Deprecated. New code should provide
2053 a STRLEN n_a and use POPpx.
2062 Pops a string off the stack which must consist of bytes i.e. characters < 256.
2063 Requires a variable STRLEN n_a in scope.
2072 Pops a string off the stack.
2073 Requires a variable STRLEN n_a in scope.
2082 Pops an SV off the stack.
2091 Push an integer onto the stack. The stack must have room for this element.
2092 Handles 'set' magic. See C<XPUSHi>.
2101 Opening bracket for arguments on a callback. See C<PUTBACK> and
2111 Push a double onto the stack. The stack must have room for this element.
2112 Handles 'set' magic. See C<XPUSHn>.
2121 Push a string onto the stack. The stack must have room for this element.
2122 The C<len> indicates the length of the string. Handles 'set' magic. See
2125 void PUSHp(char* str, STRLEN len)
2132 Push an SV onto the stack. The stack must have room for this element.
2133 Does not handle 'set' magic. See C<XPUSHs>.
2142 Push an unsigned integer onto the stack. The stack must have room for this
2143 element. See C<XPUSHu>.
2152 Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
2153 See C<PUSHMARK> and L<perlcall> for other uses.
2162 Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and
2170 Refetch the stack pointer. Used after a callback. See L<perlcall>.
2179 Push an integer onto the stack, extending the stack if necessary. Handles
2180 'set' magic. See C<PUSHi>.
2189 Push a double onto the stack, extending the stack if necessary. Handles
2190 'set' magic. See C<PUSHn>.
2199 Push a string onto the stack, extending the stack if necessary. The C<len>
2200 indicates the length of the string. Handles 'set' magic. See
2203 void XPUSHp(char* str, STRLEN len)
2210 Push an SV onto the stack, extending the stack if necessary. Does not
2211 handle 'set' magic. See C<PUSHs>.
2220 Push an unsigned integer onto the stack, extending the stack if necessary.
2230 Return from XSUB, indicating number of items on the stack. This is usually
2231 handled by C<xsubpp>.
2233 void XSRETURN(int nitems)
2236 Found in file XSUB.h
2240 Return an integer from an XSUB immediately. Uses C<XST_mIV>.
2242 void XSRETURN_IV(IV iv)
2245 Found in file XSUB.h
2249 Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
2254 Found in file XSUB.h
2258 Return a double from an XSUB immediately. Uses C<XST_mNV>.
2260 void XSRETURN_NV(NV nv)
2263 Found in file XSUB.h
2267 Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
2269 void XSRETURN_PV(char* str)
2272 Found in file XSUB.h
2274 =item XSRETURN_UNDEF
2276 Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
2281 Found in file XSUB.h
2285 Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
2290 Found in file XSUB.h
2294 Place an integer into the specified position C<pos> on the stack. The
2295 value is stored in a new mortal SV.
2297 void XST_mIV(int pos, IV iv)
2300 Found in file XSUB.h
2304 Place C<&PL_sv_no> into the specified position C<pos> on the
2307 void XST_mNO(int pos)
2310 Found in file XSUB.h
2314 Place a double into the specified position C<pos> on the stack. The value
2315 is stored in a new mortal SV.
2317 void XST_mNV(int pos, NV nv)
2320 Found in file XSUB.h
2324 Place a copy of a string into the specified position C<pos> on the stack.
2325 The value is stored in a new mortal SV.
2327 void XST_mPV(int pos, char* str)
2330 Found in file XSUB.h
2334 Place C<&PL_sv_undef> into the specified position C<pos> on the
2337 void XST_mUNDEF(int pos)
2340 Found in file XSUB.h
2344 Place C<&PL_sv_yes> into the specified position C<pos> on the
2347 void XST_mYES(int pos)
2350 Found in file XSUB.h
2361 An enum of flags for Perl types. These are found in the file B<sv.h>
2362 in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
2369 Integer type flag for scalars. See C<svtype>.
2376 Double type flag for scalars. See C<svtype>.
2383 Pointer type flag for scalars. See C<svtype>.
2390 Type flag for arrays. See C<svtype>.
2397 Type flag for code refs. See C<svtype>.
2404 Type flag for hashes. See C<svtype>.
2411 Type flag for blessed scalars. See C<svtype>.
2419 =head1 SV Manipulation Functions
2425 Returns the SV of the specified Perl scalar. If C<create> is set and the
2426 Perl variable does not exist then it will be created. If C<create> is not
2427 set and the variable does not exist then NULL is returned.
2429 NOTE: the perl_ form of this function is deprecated.
2431 SV* get_sv(const char* name, I32 create)
2434 Found in file perl.c
2436 =item looks_like_number
2438 Test if the content of an SV looks like a number (or is a number).
2439 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
2440 non-numeric warning), even if your atof() doesn't grok them.
2442 I32 looks_like_number(SV* sv)
2449 Creates an RV wrapper for an SV. The reference count for the original SV is
2452 SV* newRV_inc(SV* sv)
2459 Creates an RV wrapper for an SV. The reference count for the original
2460 SV is B<not> incremented.
2462 SV* newRV_noinc(SV *sv)
2469 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
2470 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
2473 SV* newSV(STRLEN len)
2480 Creates a new SV and copies an integer into it. The reference count for the
2490 Creates a new SV and copies a floating point value into it.
2491 The reference count for the SV is set to 1.
2500 Creates a new SV and copies a string into it. The reference count for the
2501 SV is set to 1. If C<len> is zero, Perl will compute the length using
2502 strlen(). For efficiency, consider using C<newSVpvn> instead.
2504 SV* newSVpv(const char* s, STRLEN len)
2511 Creates a new SV and initializes it with the string formatted like
2514 SV* newSVpvf(const char* pat, ...)
2521 Creates a new SV and copies a string into it. The reference count for the
2522 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
2523 string. You are responsible for ensuring that the source string is at least
2526 SV* newSVpvn(const char* s, STRLEN len)
2531 =item newSVpvn_share
2533 Creates a new SV with its SvPVX pointing to a shared string in the string
2534 table. If the string does not already exist in the table, it is created
2535 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
2536 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
2537 otherwise the hash is computed. The idea here is that as the string table
2538 is used for shared hash keys these strings will have SvPVX == HeKEY and
2539 hash lookup will avoid string compare.
2541 SV* newSVpvn_share(const char* s, I32 len, U32 hash)
2548 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
2549 it will be upgraded to one. If C<classname> is non-null then the new SV will
2550 be blessed in the specified package. The new SV is returned and its
2551 reference count is 1.
2553 SV* newSVrv(SV* rv, const char* classname)
2560 Creates a new SV which is an exact duplicate of the original SV.
2563 SV* newSVsv(SV* old)
2570 Creates a new SV and copies an unsigned integer into it.
2571 The reference count for the SV is set to 1.
2580 Returns a new version object based on the passed in SV:
2582 SV *sv = new_version(SV *ver);
2584 Does not alter the passed in ver SV. See "upg_version" if you
2585 want to upgrade the SV.
2587 SV* new_version(SV *ver)
2590 Found in file util.c
2594 Returns a pointer to the next character after the parsed
2595 version string, as well as upgrading the passed in SV to
2598 Function must be called with an already existing SV like
2601 s = scan_version(s,sv);
2603 Performs some preprocessing to the string to ensure that
2604 it has the correct characteristics of a version. Flags the
2605 object if it contains an underscore (which denotes this
2608 char* scan_version(char *vstr, SV *sv)
2611 Found in file util.c
2615 Returns a pointer to the next character after the parsed
2616 vstring, as well as updating the passed in sv.
2618 Function must be called like
2621 s = scan_vstring(s,sv);
2623 The sv should already be large enough to store the vstring
2624 passed in, for performance reasons.
2626 char* scan_vstring(char *vstr, SV *sv)
2629 Found in file util.c
2633 Returns the length of the string which is in the SV. See C<SvLEN>.
2635 STRLEN SvCUR(SV* sv)
2642 Set the length of the string which is in the SV. See C<SvCUR>.
2644 void SvCUR_set(SV* sv, STRLEN len)
2651 Returns a pointer to the last character in the string which is in the SV.
2652 See C<SvCUR>. Access the character as *(SvEND(sv)).
2661 Expands the character buffer in the SV so that it has room for the
2662 indicated number of bytes (remember to reserve space for an extra trailing
2663 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
2664 Returns a pointer to the character buffer.
2666 char * SvGROW(SV* sv, STRLEN len)
2673 Returns a boolean indicating whether the SV contains an integer.
2682 Returns a boolean indicating whether the SV contains an integer. Checks
2683 the B<private> setting. Use C<SvIOK>.
2692 Returns a boolean indicating whether the SV contains a signed integer.
2694 void SvIOK_notUV(SV* sv)
2701 Unsets the IV status of an SV.
2703 void SvIOK_off(SV* sv)
2710 Tells an SV that it is an integer.
2712 void SvIOK_on(SV* sv)
2719 Tells an SV that it is an integer and disables all other OK bits.
2721 void SvIOK_only(SV* sv)
2728 Tells and SV that it is an unsigned integer and disables all other OK bits.
2730 void SvIOK_only_UV(SV* sv)
2737 Returns a boolean indicating whether the SV contains an unsigned integer.
2739 void SvIOK_UV(SV* sv)
2746 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
2747 version which guarantees to evaluate sv only once.
2756 Coerces the given SV to an integer and returns it. Guarantees to evaluate
2757 sv only once. Use the more efficient C<SvIV> otherwise.
2766 Returns the raw value in the SV's IV slot, without checks or conversions.
2767 Only use when you are sure SvIOK is true. See also C<SvIV()>.
2776 Returns the size of the string buffer in the SV, not including any part
2777 attributable to C<SvOOK>. See C<SvCUR>.
2779 STRLEN SvLEN(SV* sv)
2786 Returns a boolean indicating whether the SV contains a number, integer or
2796 Returns a boolean indicating whether the SV contains a number, integer or
2797 double. Checks the B<private> setting. Use C<SvNIOK>.
2799 bool SvNIOKp(SV* sv)
2806 Unsets the NV/IV status of an SV.
2808 void SvNIOK_off(SV* sv)
2815 Returns a boolean indicating whether the SV contains a double.
2824 Returns a boolean indicating whether the SV contains a double. Checks the
2825 B<private> setting. Use C<SvNOK>.
2834 Unsets the NV status of an SV.
2836 void SvNOK_off(SV* sv)
2843 Tells an SV that it is a double.
2845 void SvNOK_on(SV* sv)
2852 Tells an SV that it is a double and disables all other OK bits.
2854 void SvNOK_only(SV* sv)
2861 Coerce the given SV to a double and return it. See C<SvNVx> for a version
2862 which guarantees to evaluate sv only once.
2871 Returns the raw value in the SV's NV slot, without checks or conversions.
2872 Only use when you are sure SvNOK is true. See also C<SvNV()>.
2881 Coerces the given SV to a double and returns it. Guarantees to evaluate
2882 sv only once. Use the more efficient C<SvNV> otherwise.
2891 Returns a boolean indicating whether the value is an SV.
2900 Returns a boolean indicating whether the SvIVX is a valid offset value for
2901 the SvPVX. This hack is used internally to speed up removal of characters
2902 from the beginning of a SvPV. When SvOOK is true, then the start of the
2903 allocated string buffer is really (SvPVX - SvIVX).
2912 Returns a boolean indicating whether the SV contains a character
2922 Returns a boolean indicating whether the SV contains a character string.
2923 Checks the B<private> setting. Use C<SvPOK>.
2932 Unsets the PV status of an SV.
2934 void SvPOK_off(SV* sv)
2941 Tells an SV that it is a string.
2943 void SvPOK_on(SV* sv)
2950 Tells an SV that it is a string and disables all other OK bits.
2951 Will also turn off the UTF8 status.
2953 void SvPOK_only(SV* sv)
2958 =item SvPOK_only_UTF8
2960 Tells an SV that it is a string and disables all other OK bits,
2961 and leaves the UTF8 status as it was.
2963 void SvPOK_only_UTF8(SV* sv)
2970 Returns a pointer to the string in the SV, or a stringified form of
2971 the SV if the SV does not contain a string. The SV may cache the
2972 stringified version becoming C<SvPOK>. Handles 'get' magic. See also
2973 C<SvPVx> for a version which guarantees to evaluate sv only once.
2975 char* SvPV(SV* sv, STRLEN len)
2982 Like C<SvPV>, but converts sv to byte representation first if necessary.
2984 char* SvPVbyte(SV* sv, STRLEN len)
2991 Like C<SvPV>, but converts sv to byte representation first if necessary.
2992 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
2996 char* SvPVbytex(SV* sv, STRLEN len)
3001 =item SvPVbytex_force
3003 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
3004 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
3007 char* SvPVbytex_force(SV* sv, STRLEN len)
3012 =item SvPVbyte_force
3014 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
3016 char* SvPVbyte_force(SV* sv, STRLEN len)
3021 =item SvPVbyte_nolen
3023 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
3025 char* SvPVbyte_nolen(SV* sv)
3032 Like C<SvPV>, but converts sv to utf8 first if necessary.
3034 char* SvPVutf8(SV* sv, STRLEN len)
3041 Like C<SvPV>, but converts sv to utf8 first if necessary.
3042 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
3045 char* SvPVutf8x(SV* sv, STRLEN len)
3050 =item SvPVutf8x_force
3052 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
3053 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
3056 char* SvPVutf8x_force(SV* sv, STRLEN len)
3061 =item SvPVutf8_force
3063 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
3065 char* SvPVutf8_force(SV* sv, STRLEN len)
3070 =item SvPVutf8_nolen
3072 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
3074 char* SvPVutf8_nolen(SV* sv)
3081 A version of C<SvPV> which guarantees to evaluate sv only once.
3083 char* SvPVx(SV* sv, STRLEN len)
3090 Returns a pointer to the physical string in the SV. The SV must contain a
3100 Like C<SvPV> but will force the SV into containing just a string
3101 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
3104 char* SvPV_force(SV* sv, STRLEN len)
3109 =item SvPV_force_nomg
3111 Like C<SvPV> but will force the SV into containing just a string
3112 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
3113 directly. Doesn't process magic.
3115 char* SvPV_force_nomg(SV* sv, STRLEN len)
3122 Returns a pointer to the string in the SV, or a stringified form of
3123 the SV if the SV does not contain a string. The SV may cache the
3124 stringified form becoming C<SvPOK>. Handles 'get' magic.
3126 char* SvPV_nolen(SV* sv)
3133 Returns the value of the object's reference count.
3135 U32 SvREFCNT(SV* sv)
3142 Decrements the reference count of the given SV.
3144 void SvREFCNT_dec(SV* sv)
3151 Increments the reference count of the given SV.
3153 SV* SvREFCNT_inc(SV* sv)
3160 Tests if the SV is an RV.
3169 Unsets the RV status of an SV.
3171 void SvROK_off(SV* sv)
3178 Tells an SV that it is an RV.
3180 void SvROK_on(SV* sv)
3187 Dereferences an RV to return the SV.
3196 Returns the stash of the SV.
3205 Taints an SV if tainting is enabled
3207 void SvTAINT(SV* sv)
3214 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
3217 bool SvTAINTED(SV* sv)
3224 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
3225 some of Perl's fundamental security features. XS module authors should not
3226 use this function unless they fully understand all the implications of
3227 unconditionally untainting the value. Untainting should be done in the
3228 standard perl fashion, via a carefully crafted regexp, rather than directly
3229 untainting variables.
3231 void SvTAINTED_off(SV* sv)
3238 Marks an SV as tainted.
3240 void SvTAINTED_on(SV* sv)
3247 Returns a boolean indicating whether Perl would evaluate the SV as true or
3248 false, defined or undefined. Does not handle 'get' magic.
3257 Returns the type of the SV. See C<svtype>.
3259 svtype SvTYPE(SV* sv)
3266 Releases a mutual exclusion lock on sv if a suitable module
3270 void SvUNLOCK(SV* sv)
3277 Returns a boolean indicating whether the SV contains an unsigned integer.
3286 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
3287 perform the upgrade if necessary. See C<svtype>.
3289 void SvUPGRADE(SV* sv, svtype type)
3296 Returns a boolean indicating whether the SV contains UTF-8 encoded data.
3305 Unsets the UTF8 status of an SV.
3307 void SvUTF8_off(SV *sv)
3314 Turn on the UTF8 status of an SV (the data is not changed, just the flag).
3315 Do not use frivolously.
3317 void SvUTF8_on(SV *sv)
3324 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
3325 for a version which guarantees to evaluate sv only once.
3334 Returns the raw value in the SV's UV slot, without checks or conversions.
3335 Only use when you are sure SvIOK is true. See also C<SvUV()>.
3344 Coerces the given SV to an unsigned integer and returns it. Guarantees to
3345 evaluate sv only once. Use the more efficient C<SvUV> otherwise.
3354 Returns a boolean indicating whether the SV contains a v-string.
3363 This function is only called on magical items, and is only used by
3364 sv_true() or its macro equivalent.
3366 bool sv_2bool(SV* sv)
3373 Using various gambits, try to get a CV from an SV; in addition, try if
3374 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
3376 CV* sv_2cv(SV* sv, HV** st, GV** gvp, I32 lref)
3383 Using various gambits, try to get an IO from an SV: the IO slot if its a
3384 GV; or the recursive result if we're an RV; or the IO slot of the symbol
3385 named after the PV if we're a string.
3394 Return the integer value of an SV, doing any necessary string conversion,
3395 magic etc. Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
3404 Marks an existing SV as mortal. The SV will be destroyed "soon", either
3405 by an explicit call to FREETMPS, or by an implicit call at places such as
3406 statement boundaries. See also C<sv_newmortal> and C<sv_mortalcopy>.
3408 SV* sv_2mortal(SV* sv)
3415 Return the num value of an SV, doing any necessary string or integer
3416 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
3426 Return a pointer to the byte-encoded representation of the SV, and set *lp
3427 to its length. May cause the SV to be downgraded from UTF8 as a
3430 Usually accessed via the C<SvPVbyte> macro.
3432 char* sv_2pvbyte(SV* sv, STRLEN* lp)
3437 =item sv_2pvbyte_nolen
3439 Return a pointer to the byte-encoded representation of the SV.
3440 May cause the SV to be downgraded from UTF8 as a side-effect.
3442 Usually accessed via the C<SvPVbyte_nolen> macro.
3444 char* sv_2pvbyte_nolen(SV* sv)
3451 Return a pointer to the UTF8-encoded representation of the SV, and set *lp
3452 to its length. May cause the SV to be upgraded to UTF8 as a side-effect.
3454 Usually accessed via the C<SvPVutf8> macro.
3456 char* sv_2pvutf8(SV* sv, STRLEN* lp)
3461 =item sv_2pvutf8_nolen
3463 Return a pointer to the UTF8-encoded representation of the SV.
3464 May cause the SV to be upgraded to UTF8 as a side-effect.
3466 Usually accessed via the C<SvPVutf8_nolen> macro.
3468 char* sv_2pvutf8_nolen(SV* sv)
3475 Returns a pointer to the string value of an SV, and sets *lp to its length.
3476 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
3478 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
3479 usually end up here too.
3481 char* sv_2pv_flags(SV* sv, STRLEN* lp, I32 flags)
3488 Like C<sv_2pv()>, but doesn't return the length too. You should usually
3489 use the macro wrapper C<SvPV_nolen(sv)> instead.
3490 char* sv_2pv_nolen(SV* sv)
3497 Return the unsigned integer value of an SV, doing any necessary string
3498 conversion, magic etc. Normally used via the C<SvUV(sv)> and C<SvUVx(sv)>
3508 Remove any string offset. You should normally use the C<SvOOK_off> macro
3511 int sv_backoff(SV* sv)
3518 Blesses an SV into a specified package. The SV must be an RV. The package
3519 must be designated by its stash (see C<gv_stashpv()>). The reference count
3520 of the SV is unaffected.
3522 SV* sv_bless(SV* sv, HV* stash)
3529 Concatenates the string onto the end of the string which is in the SV.
3530 If the SV has the UTF8 status set, then the bytes appended should be
3531 valid UTF8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
3533 void sv_catpv(SV* sv, const char* ptr)
3540 Processes its arguments like C<sprintf> and appends the formatted
3541 output to an SV. If the appended data contains "wide" characters
3542 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
3543 and characters >255 formatted with %c), the original SV might get
3544 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic.
3545 C<SvSETMAGIC()> must typically be called after calling this function
3546 to handle 'set' magic.
3548 void sv_catpvf(SV* sv, const char* pat, ...)
3555 Like C<sv_catpvf>, but also handles 'set' magic.
3557 void sv_catpvf_mg(SV *sv, const char* pat, ...)
3564 Concatenates the string onto the end of the string which is in the SV. The
3565 C<len> indicates number of bytes to copy. If the SV has the UTF8
3566 status set, then the bytes appended should be valid UTF8.
3567 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
3569 void sv_catpvn(SV* sv, const char* ptr, STRLEN len)
3574 =item sv_catpvn_flags
3576 Concatenates the string onto the end of the string which is in the SV. The
3577 C<len> indicates number of bytes to copy. If the SV has the UTF8
3578 status set, then the bytes appended should be valid UTF8.
3579 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
3580 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
3581 in terms of this function.
3583 void sv_catpvn_flags(SV* sv, const char* ptr, STRLEN len, I32 flags)
3590 Like C<sv_catpvn>, but also handles 'set' magic.
3592 void sv_catpvn_mg(SV *sv, const char *ptr, STRLEN len)
3599 Like C<sv_catpv>, but also handles 'set' magic.
3601 void sv_catpv_mg(SV *sv, const char *ptr)
3608 Concatenates the string from SV C<ssv> onto the end of the string in
3609 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
3610 not 'set' magic. See C<sv_catsv_mg>.
3612 void sv_catsv(SV* dsv, SV* ssv)
3617 =item sv_catsv_flags
3619 Concatenates the string from SV C<ssv> onto the end of the string in
3620 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
3621 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
3622 and C<sv_catsv_nomg> are implemented in terms of this function.
3624 void sv_catsv_flags(SV* dsv, SV* ssv, I32 flags)
3631 Like C<sv_catsv>, but also handles 'set' magic.
3633 void sv_catsv_mg(SV *dstr, SV *sstr)
3640 Efficient removal of characters from the beginning of the string buffer.
3641 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
3642 the string buffer. The C<ptr> becomes the first character of the adjusted
3643 string. Uses the "OOK hack".
3645 void sv_chop(SV* sv, char* ptr)
3652 Clear an SV: call any destructors, free up any memory used by the body,
3653 and free the body itself. The SV's head is I<not> freed, although
3654 its type is set to all 1's so that it won't inadvertently be assumed
3655 to be live during global destruction etc.
3656 This function should only be called when REFCNT is zero. Most of the time
3657 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
3660 void sv_clear(SV* sv)
3667 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
3668 string in C<sv1> is less than, equal to, or greater than the string in
3669 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
3670 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
3672 I32 sv_cmp(SV* sv1, SV* sv2)
3679 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
3680 'use bytes' aware, handles get magic, and will coerce its args to strings
3681 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
3683 I32 sv_cmp_locale(SV* sv1, SV* sv2)
3690 Add Collate Transform magic to an SV if it doesn't already have it.
3692 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
3693 scalar data of the variable, but transformed to such a format that a normal
3694 memory comparison can be used to compare the data according to the locale
3697 char* sv_collxfrm(SV* sv, STRLEN* nxp)
3704 Copies a stringified representation of the source SV into the
3705 destination SV. Automatically performs any necessary mg_get and
3706 coercion of numeric values into strings. Guaranteed to preserve
3707 UTF-8 flag even from overloaded objects. Similar in nature to
3708 sv_2pv[_flags] but operates directly on an SV instead of just the
3709 string. Mostly uses sv_2pv_flags to do its work, except when that
3710 would lose the UTF-8'ness of the PV.
3712 void sv_copypv(SV* dsv, SV* ssv)
3719 Auto-decrement of the value in the SV, doing string to numeric conversion
3720 if necessary. Handles 'get' magic.
3727 =item sv_derived_from
3729 Returns a boolean indicating whether the SV is derived from the specified
3730 class. This is the function that implements C<UNIVERSAL::isa>. It works
3731 for class names as well as for objects.
3733 bool sv_derived_from(SV* sv, const char* name)
3736 Found in file universal.c
3740 Returns a boolean indicating whether the strings in the two SVs are
3741 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
3742 coerce its args to strings if necessary.
3744 I32 sv_eq(SV* sv1, SV* sv2)
3749 =item sv_force_normal
3751 Undo various types of fakery on an SV: if the PV is a shared string, make
3752 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3753 an xpvmg. See also C<sv_force_normal_flags>.
3755 void sv_force_normal(SV *sv)
3760 =item sv_force_normal_flags
3762 Undo various types of fakery on an SV: if the PV is a shared string, make
3763 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3764 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
3765 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
3766 then a copy-on-write scalar drops its PV buffer (if any) and becomes
3767 SvPOK_off rather than making a copy. (Used where this scalar is about to be
3768 set to some other value.) In addition, the C<flags> parameter gets passed to
3769 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
3770 with flags set to 0.
3772 void sv_force_normal_flags(SV *sv, U32 flags)
3779 Decrement an SV's reference count, and if it drops to zero, call
3780 C<sv_clear> to invoke destructors and free up any memory used by
3781 the body; finally, deallocate the SV's head itself.
3782 Normally called via a wrapper macro C<SvREFCNT_dec>.
3784 void sv_free(SV* sv)
3791 Get a line from the filehandle and store it into the SV, optionally
3792 appending to the currently-stored string.
3794 char* sv_gets(SV* sv, PerlIO* fp, I32 append)
3801 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
3802 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
3803 Use the C<SvGROW> wrapper instead.
3805 char* sv_grow(SV* sv, STRLEN newlen)
3812 Auto-increment of the value in the SV, doing string to numeric conversion
3813 if necessary. Handles 'get' magic.
3822 Inserts a string at the specified offset/length within the SV. Similar to
3823 the Perl substr() function.
3825 void sv_insert(SV* bigsv, STRLEN offset, STRLEN len, char* little, STRLEN littlelen)
3832 Returns a boolean indicating whether the SV is blessed into the specified
3833 class. This does not check for subtypes; use C<sv_derived_from> to verify
3834 an inheritance relationship.
3836 int sv_isa(SV* sv, const char* name)
3843 Returns a boolean indicating whether the SV is an RV pointing to a blessed
3844 object. If the SV is not an RV, or if the object is not blessed, then this
3847 int sv_isobject(SV* sv)
3854 A private implementation of the C<SvIVx> macro for compilers which can't
3855 cope with complex macro expressions. Always use the macro instead.
3864 Returns the length of the string in the SV. Handles magic and type
3865 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
3867 STRLEN sv_len(SV* sv)
3874 Returns the number of characters in the string in an SV, counting wide
3875 UTF8 bytes as a single character. Handles magic and type coercion.
3877 STRLEN sv_len_utf8(SV* sv)
3884 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
3885 then adds a new magic item of type C<how> to the head of the magic list.
3887 void sv_magic(SV* sv, SV* obj, int how, const char* name, I32 namlen)
3894 Adds magic to an SV, upgrading it if necessary. Applies the
3895 supplied vtable and returns pointer to the magic added.
3897 Note that sv_magicext will allow things that sv_magic will not.
3898 In particular you can add magic to SvREADONLY SVs and and more than
3899 one instance of the same 'how'
3901 I C<namelen> is greater then zero then a savepvn() I<copy> of C<name> is stored,
3902 if C<namelen> is zero then C<name> is stored as-is and - as another special
3903 case - if C<(name && namelen == HEf_SVKEY)> then C<name> is assumed to contain
3904 an C<SV*> and has its REFCNT incremented
3906 (This is now used as a subroutine by sv_magic.)
3908 MAGIC * sv_magicext(SV* sv, SV* obj, int how, MGVTBL *vtbl, const char* name, I32 namlen )
3915 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
3916 The new SV is marked as mortal. It will be destroyed "soon", either by an
3917 explicit call to FREETMPS, or by an implicit call at places such as
3918 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
3920 SV* sv_mortalcopy(SV* oldsv)
3927 Creates a new null SV which is mortal. The reference count of the SV is
3928 set to 1. It will be destroyed "soon", either by an explicit call to
3929 FREETMPS, or by an implicit call at places such as statement boundaries.
3930 See also C<sv_mortalcopy> and C<sv_2mortal>.
3939 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
3942 SV* sv_newref(SV* sv)
3949 Dummy routine which "locks" an SV when there is no locking module present.
3950 Exists to avoid test for a NULL function pointer and because it could potentially warn under
3951 some level of strict-ness.
3953 void sv_nolocking(SV *)
3956 Found in file util.c
3960 Dummy routine which "shares" an SV when there is no sharing module present.
3961 Exists to avoid test for a NULL function pointer and because it could potentially warn under
3962 some level of strict-ness.
3964 void sv_nosharing(SV *)
3967 Found in file util.c
3969 =item sv_nounlocking
3971 Dummy routine which "unlocks" an SV when there is no locking module present.
3972 Exists to avoid test for a NULL function pointer and because it could potentially warn under
3973 some level of strict-ness.
3975 void sv_nounlocking(SV *)
3978 Found in file util.c
3982 A private implementation of the C<SvNVx> macro for compilers which can't
3983 cope with complex macro expressions. Always use the macro instead.
3992 Converts the value pointed to by offsetp from a count of bytes from the
3993 start of the string, to a count of the equivalent number of UTF8 chars.
3994 Handles magic and type coercion.
3996 void sv_pos_b2u(SV* sv, I32* offsetp)
4003 Converts the value pointed to by offsetp from a count of UTF8 chars from
4004 the start of the string, to a count of the equivalent number of bytes; if
4005 lenp is non-zero, it does the same to lenp, but this time starting from
4006 the offset, rather than from the start of the string. Handles magic and
4009 void sv_pos_u2b(SV* sv, I32* offsetp, I32* lenp)
4016 Use the C<SvPV_nolen> macro instead
4025 Use C<SvPVbyte_nolen> instead.
4027 char* sv_pvbyte(SV *sv)
4034 A private implementation of the C<SvPVbyte> macro for compilers
4035 which can't cope with complex macro expressions. Always use the macro
4038 char* sv_pvbyten(SV *sv, STRLEN *len)
4043 =item sv_pvbyten_force
4045 A private implementation of the C<SvPVbytex_force> macro for compilers
4046 which can't cope with complex macro expressions. Always use the macro
4049 char* sv_pvbyten_force(SV* sv, STRLEN* lp)
4056 A private implementation of the C<SvPV> macro for compilers which can't
4057 cope with complex macro expressions. Always use the macro instead.
4059 char* sv_pvn(SV *sv, STRLEN *len)
4066 Get a sensible string out of the SV somehow.
4067 A private implementation of the C<SvPV_force> macro for compilers which
4068 can't cope with complex macro expressions. Always use the macro instead.
4070 char* sv_pvn_force(SV* sv, STRLEN* lp)
4075 =item sv_pvn_force_flags
4077 Get a sensible string out of the SV somehow.
4078 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
4079 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
4080 implemented in terms of this function.
4081 You normally want to use the various wrapper macros instead: see
4082 C<SvPV_force> and C<SvPV_force_nomg>
4084 char* sv_pvn_force_flags(SV* sv, STRLEN* lp, I32 flags)
4091 Use the C<SvPVutf8_nolen> macro instead
4093 char* sv_pvutf8(SV *sv)
4100 A private implementation of the C<SvPVutf8> macro for compilers
4101 which can't cope with complex macro expressions. Always use the macro
4104 char* sv_pvutf8n(SV *sv, STRLEN *len)
4109 =item sv_pvutf8n_force
4111 A private implementation of the C<SvPVutf8_force> macro for compilers
4112 which can't cope with complex macro expressions. Always use the macro
4115 char* sv_pvutf8n_force(SV* sv, STRLEN* lp)
4122 Returns a string describing what the SV is a reference to.
4124 char* sv_reftype(SV* sv, int ob)
4131 Make the first argument a copy of the second, then delete the original.
4132 The target SV physically takes over ownership of the body of the source SV
4133 and inherits its flags; however, the target keeps any magic it owns,
4134 and any magic in the source is discarded.
4135 Note that this is a rather specialist SV copying operation; most of the
4136 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4138 void sv_replace(SV* sv, SV* nsv)
4143 =item sv_report_used
4145 Dump the contents of all SVs not yet freed. (Debugging aid).
4147 void sv_report_used()
4154 Underlying implementation for the C<reset> Perl function.
4155 Note that the perl-level function is vaguely deprecated.
4157 void sv_reset(char* s, HV* stash)
4164 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4165 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4166 push a back-reference to this RV onto the array of backreferences
4167 associated with that magic.
4169 SV* sv_rvweaken(SV *sv)
4176 Copies an integer into the given SV, upgrading first if necessary.
4177 Does not handle 'set' magic. See also C<sv_setiv_mg>.
4179 void sv_setiv(SV* sv, IV num)
4186 Like C<sv_setiv>, but also handles 'set' magic.
4188 void sv_setiv_mg(SV *sv, IV i)
4195 Copies a double into the given SV, upgrading first if necessary.
4196 Does not handle 'set' magic. See also C<sv_setnv_mg>.
4198 void sv_setnv(SV* sv, NV num)
4205 Like C<sv_setnv>, but also handles 'set' magic.
4207 void sv_setnv_mg(SV *sv, NV num)
4214 Copies a string into an SV. The string must be null-terminated. Does not
4215 handle 'set' magic. See C<sv_setpv_mg>.
4217 void sv_setpv(SV* sv, const char* ptr)
4224 Processes its arguments like C<sprintf> and sets an SV to the formatted
4225 output. Does not handle 'set' magic. See C<sv_setpvf_mg>.
4227 void sv_setpvf(SV* sv, const char* pat, ...)
4234 Like C<sv_setpvf>, but also handles 'set' magic.
4236 void sv_setpvf_mg(SV *sv, const char* pat, ...)
4243 Copies an integer into the given SV, also updating its string value.
4244 Does not handle 'set' magic. See C<sv_setpviv_mg>.
4246 void sv_setpviv(SV* sv, IV num)
4253 Like C<sv_setpviv>, but also handles 'set' magic.
4255 void sv_setpviv_mg(SV *sv, IV iv)
4262 Copies a string into an SV. The C<len> parameter indicates the number of
4263 bytes to be copied. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4265 void sv_setpvn(SV* sv, const char* ptr, STRLEN len)
4272 Like C<sv_setpvn>, but also handles 'set' magic.
4274 void sv_setpvn_mg(SV *sv, const char *ptr, STRLEN len)
4281 Like C<sv_setpv>, but also handles 'set' magic.
4283 void sv_setpv_mg(SV *sv, const char *ptr)
4290 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
4291 argument will be upgraded to an RV. That RV will be modified to point to
4292 the new SV. The C<classname> argument indicates the package for the
4293 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4294 will be returned and will have a reference count of 1.
4296 SV* sv_setref_iv(SV* rv, const char* classname, IV iv)
4303 Copies a double into a new SV, optionally blessing the SV. The C<rv>
4304 argument will be upgraded to an RV. That RV will be modified to point to
4305 the new SV. The C<classname> argument indicates the package for the
4306 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4307 will be returned and will have a reference count of 1.
4309 SV* sv_setref_nv(SV* rv, const char* classname, NV nv)
4316 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
4317 argument will be upgraded to an RV. That RV will be modified to point to
4318 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
4319 into the SV. The C<classname> argument indicates the package for the
4320 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4321 will be returned and will have a reference count of 1.
4323 Do not use with other Perl types such as HV, AV, SV, CV, because those
4324 objects will become corrupted by the pointer copy process.
4326 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
4328 SV* sv_setref_pv(SV* rv, const char* classname, void* pv)
4335 Copies a string into a new SV, optionally blessing the SV. The length of the
4336 string must be specified with C<n>. The C<rv> argument will be upgraded to
4337 an RV. That RV will be modified to point to the new SV. The C<classname>
4338 argument indicates the package for the blessing. Set C<classname> to
4339 C<Nullch> to avoid the blessing. The new SV will be returned and will have
4340 a reference count of 1.
4342 Note that C<sv_setref_pv> copies the pointer while this copies the string.
4344 SV* sv_setref_pvn(SV* rv, const char* classname, char* pv, STRLEN n)
4351 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
4352 argument will be upgraded to an RV. That RV will be modified to point to
4353 the new SV. The C<classname> argument indicates the package for the
4354 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4355 will be returned and will have a reference count of 1.
4357 SV* sv_setref_uv(SV* rv, const char* classname, UV uv)
4364 Copies the contents of the source SV C<ssv> into the destination SV
4365 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4366 function if the source SV needs to be reused. Does not handle 'set' magic.
4367 Loosely speaking, it performs a copy-by-value, obliterating any previous
4368 content of the destination.
4370 You probably want to use one of the assortment of wrappers, such as
4371 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4372 C<SvSetMagicSV_nosteal>.
4374 void sv_setsv(SV* dsv, SV* ssv)
4379 =item sv_setsv_flags
4381 Copies the contents of the source SV C<ssv> into the destination SV
4382 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4383 function if the source SV needs to be reused. Does not handle 'set' magic.
4384 Loosely speaking, it performs a copy-by-value, obliterating any previous
4385 content of the destination.
4386 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
4387 C<ssv> if appropriate, else not. C<sv_setsv> and C<sv_setsv_nomg> are
4388 implemented in terms of this function.
4390 You probably want to use one of the assortment of wrappers, such as
4391 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4392 C<SvSetMagicSV_nosteal>.
4394 This is the primary function for copying scalars, and most other
4395 copy-ish functions and macros use this underneath.
4397 void sv_setsv_flags(SV* dsv, SV* ssv, I32 flags)
4404 Like C<sv_setsv>, but also handles 'set' magic.
4406 void sv_setsv_mg(SV *dstr, SV *sstr)
4413 Copies an unsigned integer into the given SV, upgrading first if necessary.
4414 Does not handle 'set' magic. See also C<sv_setuv_mg>.
4416 void sv_setuv(SV* sv, UV num)
4423 Like C<sv_setuv>, but also handles 'set' magic.
4425 void sv_setuv_mg(SV *sv, UV u)
4432 Taint an SV. Use C<SvTAINTED_on> instead.
4433 void sv_taint(SV* sv)
4440 Test an SV for taintedness. Use C<SvTAINTED> instead.
4441 bool sv_tainted(SV* sv)
4448 Returns true if the SV has a true value by Perl's rules.
4449 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
4450 instead use an in-line version.
4459 Removes all magic of type C<type> from an SV.
4461 int sv_unmagic(SV* sv, int type)
4468 Unsets the RV status of the SV, and decrements the reference count of
4469 whatever was being referenced by the RV. This can almost be thought of
4470 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
4471 being zero. See C<SvROK_off>.
4473 void sv_unref(SV* sv)
4478 =item sv_unref_flags
4480 Unsets the RV status of the SV, and decrements the reference count of
4481 whatever was being referenced by the RV. This can almost be thought of
4482 as a reversal of C<newSVrv>. The C<cflags> argument can contain
4483 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
4484 (otherwise the decrementing is conditional on the reference count being
4485 different from one or the reference being a readonly SV).
4488 void sv_unref_flags(SV* sv, U32 flags)
4495 Untaint an SV. Use C<SvTAINTED_off> instead.
4496 void sv_untaint(SV* sv)
4503 Upgrade an SV to a more complex form. Generally adds a new body type to the
4504 SV, then copies across as much information as possible from the old body.
4505 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
4507 bool sv_upgrade(SV* sv, U32 mt)
4514 Tells an SV to use C<ptr> to find its string value. Normally the string is
4515 stored inside the SV but sv_usepvn allows the SV to use an outside string.
4516 The C<ptr> should point to memory that was allocated by C<malloc>. The
4517 string length, C<len>, must be supplied. This function will realloc the
4518 memory pointed to by C<ptr>, so that pointer should not be freed or used by
4519 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
4520 See C<sv_usepvn_mg>.
4522 void sv_usepvn(SV* sv, char* ptr, STRLEN len)
4529 Like C<sv_usepvn>, but also handles 'set' magic.
4531 void sv_usepvn_mg(SV *sv, char *ptr, STRLEN len)
4536 =item sv_utf8_decode
4538 Convert the octets in the PV from UTF-8 to chars. Scan for validity and then
4539 turn off SvUTF8 if needed so that we see characters. Used as a building block
4540 for decode_utf8 in Encode.xs
4542 NOTE: this function is experimental and may change or be
4543 removed without notice.
4545 bool sv_utf8_decode(SV *sv)
4550 =item sv_utf8_downgrade
4552 Attempt to convert the PV of an SV from UTF8-encoded to byte encoding.
4553 This may not be possible if the PV contains non-byte encoding characters;
4554 if this is the case, either returns false or, if C<fail_ok> is not
4557 This is not as a general purpose Unicode to byte encoding interface:
4558 use the Encode extension for that.
4560 NOTE: this function is experimental and may change or be
4561 removed without notice.
4563 bool sv_utf8_downgrade(SV *sv, bool fail_ok)
4568 =item sv_utf8_encode
4570 Convert the PV of an SV to UTF8-encoded, but then turn off the C<SvUTF8>
4571 flag so that it looks like octets again. Used as a building block
4572 for encode_utf8 in Encode.xs
4574 void sv_utf8_encode(SV *sv)
4579 =item sv_utf8_upgrade
4581 Convert the PV of an SV to its UTF8-encoded form.
4582 Forces the SV to string form if it is not already.
4583 Always sets the SvUTF8 flag to avoid future validity checks even
4584 if all the bytes have hibit clear.
4586 This is not as a general purpose byte encoding to Unicode interface:
4587 use the Encode extension for that.
4589 STRLEN sv_utf8_upgrade(SV *sv)
4594 =item sv_utf8_upgrade_flags
4596 Convert the PV of an SV to its UTF8-encoded form.
4597 Forces the SV to string form if it is not already.
4598 Always sets the SvUTF8 flag to avoid future validity checks even
4599 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
4600 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
4601 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
4603 This is not as a general purpose byte encoding to Unicode interface:
4604 use the Encode extension for that.
4606 STRLEN sv_utf8_upgrade_flags(SV *sv, I32 flags)
4613 A private implementation of the C<SvUVx> macro for compilers which can't
4614 cope with complex macro expressions. Always use the macro instead.
4623 Processes its arguments like C<vsprintf> and appends the formatted output
4624 to an SV. Uses an array of SVs if the C style variable argument list is
4625 missing (NULL). When running with taint checks enabled, indicates via
4626 C<maybe_tainted> if results are untrustworthy (often due to the use of
4629 Usually used via one of its frontends C<sv_catpvf> and C<sv_catpvf_mg>.
4631 void sv_vcatpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
4638 Works like C<vcatpvfn> but copies the text into the SV instead of
4641 Usually used via one of its frontends C<sv_setpvf> and C<sv_setpvf_mg>.
4643 void sv_vsetpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
4650 In-place upgrade of the supplied SV to a version object.
4652 SV *sv = upg_version(SV *sv);
4654 Returns a pointer to the upgraded SV.
4656 SV* upg_version(SV *ver)
4659 Found in file util.c
4663 Version object aware cmp. Both operands must already have been
4664 converted into version objects.
4666 int vcmp(SV *lvs, SV *rvs)
4669 Found in file util.c
4673 Accepts a version object and returns the normalized floating
4674 point representation. Call like:
4678 NOTE: you can pass either the object directly or the SV
4679 contained within the RV.
4684 Found in file util.c
4688 Accepts a version object and returns the normalized string
4689 representation. Call like:
4691 sv = vstringify(rv);
4693 NOTE: you can pass either the object directly or the SV
4694 contained within the RV.
4696 SV* vstringify(SV *vs)
4699 Found in file util.c
4704 =head1 Unicode Support
4708 =item bytes_from_utf8
4710 Converts a string C<s> of length C<len> from UTF8 into byte encoding.
4711 Unlike <utf8_to_bytes> but like C<bytes_to_utf8>, returns a pointer to
4712 the newly-created string, and updates C<len> to contain the new
4713 length. Returns the original string if no conversion occurs, C<len>
4714 is unchanged. Do nothing if C<is_utf8> points to 0. Sets C<is_utf8> to
4715 0 if C<s> is converted or contains all 7bit characters.
4717 NOTE: this function is experimental and may change or be
4718 removed without notice.
4720 U8* bytes_from_utf8(U8 *s, STRLEN *len, bool *is_utf8)
4723 Found in file utf8.c
4727 Converts a string C<s> of length C<len> from ASCII into UTF8 encoding.
4728 Returns a pointer to the newly-created string, and sets C<len> to
4729 reflect the new length.
4731 If you want to convert to UTF8 from other encodings than ASCII,
4732 see sv_recode_to_utf8().
4734 NOTE: this function is experimental and may change or be
4735 removed without notice.
4737 U8* bytes_to_utf8(U8 *s, STRLEN *len)
4740 Found in file utf8.c
4744 Return true if the strings s1 and s2 differ case-insensitively, false
4745 if not (if they are equal case-insensitively). If u1 is true, the
4746 string s1 is assumed to be in UTF-8-encoded Unicode. If u2 is true,
4747 the string s2 is assumed to be in UTF-8-encoded Unicode. If u1 or u2
4748 are false, the respective string is assumed to be in native 8-bit
4751 If the pe1 and pe2 are non-NULL, the scanning pointers will be copied
4752 in there (they will point at the beginning of the I<next> character).
4753 If the pointers behind pe1 or pe2 are non-NULL, they are the end
4754 pointers beyond which scanning will not continue under any
4755 circustances. If the byte lengths l1 and l2 are non-zero, s1+l1 and
4756 s2+l2 will be used as goal end pointers that will also stop the scan,
4757 and which qualify towards defining a successful match: all the scans
4758 that define an explicit length must reach their goal pointers for
4759 a match to succeed).
4761 For case-insensitiveness, the "casefolding" of Unicode is used
4762 instead of upper/lowercasing both the characters, see
4763 http://www.unicode.org/unicode/reports/tr21/ (Case Mappings).
4765 I32 ibcmp_utf8(const char* a, char **pe1, UV l1, bool u1, const char* b, char **pe2, UV l2, bool u2)
4768 Found in file utf8.c
4772 Tests if some arbitrary number of bytes begins in a valid UTF-8
4773 character. Note that an INVARIANT (i.e. ASCII) character is a valid
4774 UTF-8 character. The actual number of bytes in the UTF-8 character
4775 will be returned if it is valid, otherwise 0.
4777 STRLEN is_utf8_char(U8 *p)
4780 Found in file utf8.c
4782 =item is_utf8_string
4784 Returns true if first C<len> bytes of the given string form a valid
4785 UTF8 string, false otherwise. Note that 'a valid UTF8 string' does
4786 not mean 'a string that contains code points above 0x7F encoded in
4787 UTF8' because a valid ASCII string is a valid UTF8 string.
4789 bool is_utf8_string(U8 *s, STRLEN len)
4792 Found in file utf8.c
4794 =item pv_uni_display
4796 Build to the scalar dsv a displayable version of the string spv,
4797 length len, the displayable version being at most pvlim bytes long
4798 (if longer, the rest is truncated and "..." will be appended).
4800 The flags argument can have UNI_DISPLAY_ISPRINT set to display
4801 isPRINT()able characters as themselves, UNI_DISPLAY_BACKSLASH
4802 to display the \\[nrfta\\] as the backslashed versions (like '\n')
4803 (UNI_DISPLAY_BACKSLASH is preferred over UNI_DISPLAY_ISPRINT for \\).
4804 UNI_DISPLAY_QQ (and its alias UNI_DISPLAY_REGEX) have both
4805 UNI_DISPLAY_BACKSLASH and UNI_DISPLAY_ISPRINT turned on.
4807 The pointer to the PV of the dsv is returned.
4809 char* pv_uni_display(SV *dsv, U8 *spv, STRLEN len, STRLEN pvlim, UV flags)
4812 Found in file utf8.c
4816 The encoding is assumed to be an Encode object, the PV of the ssv is
4817 assumed to be octets in that encoding and decoding the input starts
4818 from the position which (PV + *offset) pointed to. The dsv will be
4819 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
4820 when the string tstr appears in decoding output or the input ends on
4821 the PV of the ssv. The value which the offset points will be modified
4822 to the last input position on the ssv.
4824 Returns TRUE if the terminator was found, else returns FALSE.
4826 bool sv_cat_decode(SV* dsv, SV *encoding, SV *ssv, int *offset, char* tstr, int tlen)
4831 =item sv_recode_to_utf8
4833 The encoding is assumed to be an Encode object, on entry the PV
4834 of the sv is assumed to be octets in that encoding, and the sv
4835 will be converted into Unicode (and UTF-8).
4837 If the sv already is UTF-8 (or if it is not POK), or if the encoding
4838 is not a reference, nothing is done to the sv. If the encoding is not
4839 an C<Encode::XS> Encoding object, bad things will happen.
4840 (See F<lib/encoding.pm> and L<Encode>).
4842 The PV of the sv is returned.
4844 char* sv_recode_to_utf8(SV* sv, SV *encoding)
4849 =item sv_uni_display
4851 Build to the scalar dsv a displayable version of the scalar sv,
4852 the displayable version being at most pvlim bytes long
4853 (if longer, the rest is truncated and "..." will be appended).
4855 The flags argument is as in pv_uni_display().
4857 The pointer to the PV of the dsv is returned.
4859 char* sv_uni_display(SV *dsv, SV *ssv, STRLEN pvlim, UV flags)
4862 Found in file utf8.c
4866 The "p" contains the pointer to the UTF-8 string encoding
4867 the character that is being converted.
4869 The "ustrp" is a pointer to the character buffer to put the
4870 conversion result to. The "lenp" is a pointer to the length
4873 The "swashp" is a pointer to the swash to use.
4875 Both the special and normal mappings are stored lib/unicore/To/Foo.pl,
4876 and loaded by SWASHGET, using lib/utf8_heavy.pl. The special (usually,
4877 but not always, a multicharacter mapping), is tried first.
4879 The "special" is a string like "utf8::ToSpecLower", which means the
4880 hash %utf8::ToSpecLower. The access to the hash is through
4881 Perl_to_utf8_case().
4883 The "normal" is a string like "ToLower" which means the swash
4886 UV to_utf8_case(U8 *p, U8* ustrp, STRLEN *lenp, SV **swash, char *normal, char *special)
4889 Found in file utf8.c
4893 Convert the UTF-8 encoded character at p to its foldcase version and
4894 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
4895 that the ustrp needs to be at least UTF8_MAXLEN_FOLD+1 bytes since the
4896 foldcase version may be longer than the original character (up to
4899 The first character of the foldcased version is returned
4900 (but note, as explained above, that there may be more.)
4902 UV to_utf8_fold(U8 *p, U8* ustrp, STRLEN *lenp)
4905 Found in file utf8.c
4909 Convert the UTF-8 encoded character at p to its lowercase version and
4910 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
4911 that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the
4912 lowercase version may be longer than the original character (up to two
4915 The first character of the lowercased version is returned
4916 (but note, as explained above, that there may be more.)
4918 UV to_utf8_lower(U8 *p, U8* ustrp, STRLEN *lenp)
4921 Found in file utf8.c
4925 Convert the UTF-8 encoded character at p to its titlecase version and
4926 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
4927 that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the
4928 titlecase version may be longer than the original character (up to two
4931 The first character of the titlecased version is returned
4932 (but note, as explained above, that there may be more.)
4934 UV to_utf8_title(U8 *p, U8* ustrp, STRLEN *lenp)
4937 Found in file utf8.c
4941 Convert the UTF-8 encoded character at p to its uppercase version and
4942 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
4943 that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the
4944 uppercase version may be longer than the original character (up to two
4947 The first character of the uppercased version is returned
4948 (but note, as explained above, that there may be more.)
4950 UV to_utf8_upper(U8 *p, U8* ustrp, STRLEN *lenp)
4953 Found in file utf8.c
4955 =item utf8n_to_uvchr
4957 Returns the native character value of the first character in the string C<s>
4958 which is assumed to be in UTF8 encoding; C<retlen> will be set to the
4959 length, in bytes, of that character.
4961 Allows length and flags to be passed to low level routine.
4963 UV utf8n_to_uvchr(U8 *s, STRLEN curlen, STRLEN* retlen, U32 flags)
4966 Found in file utf8.c
4968 =item utf8n_to_uvuni
4970 Bottom level UTF-8 decode routine.
4971 Returns the unicode code point value of the first character in the string C<s>
4972 which is assumed to be in UTF8 encoding and no longer than C<curlen>;
4973 C<retlen> will be set to the length, in bytes, of that character.
4975 If C<s> does not point to a well-formed UTF8 character, the behaviour
4976 is dependent on the value of C<flags>: if it contains UTF8_CHECK_ONLY,
4977 it is assumed that the caller will raise a warning, and this function
4978 will silently just set C<retlen> to C<-1> and return zero. If the
4979 C<flags> does not contain UTF8_CHECK_ONLY, warnings about
4980 malformations will be given, C<retlen> will be set to the expected
4981 length of the UTF-8 character in bytes, and zero will be returned.
4983 The C<flags> can also contain various flags to allow deviations from
4984 the strict UTF-8 encoding (see F<utf8.h>).
4986 Most code should use utf8_to_uvchr() rather than call this directly.
4988 UV utf8n_to_uvuni(U8 *s, STRLEN curlen, STRLEN* retlen, U32 flags)
4991 Found in file utf8.c
4995 Returns the number of UTF8 characters between the UTF-8 pointers C<a>
4998 WARNING: use only if you *know* that the pointers point inside the
5001 IV utf8_distance(U8 *a, U8 *b)
5004 Found in file utf8.c
5008 Return the UTF-8 pointer C<s> displaced by C<off> characters, either
5009 forward or backward.
5011 WARNING: do not use the following unless you *know* C<off> is within
5012 the UTF-8 data pointed to by C<s> *and* that on entry C<s> is aligned
5013 on the first byte of character or just after the last byte of a character.
5015 U8* utf8_hop(U8 *s, I32 off)
5018 Found in file utf8.c
5022 Return the length of the UTF-8 char encoded string C<s> in characters.
5023 Stops at C<e> (inclusive). If C<e E<lt> s> or if the scan would end
5024 up past C<e>, croaks.
5026 STRLEN utf8_length(U8* s, U8 *e)
5029 Found in file utf8.c
5033 Converts a string C<s> of length C<len> from UTF8 into byte encoding.
5034 Unlike C<bytes_to_utf8>, this over-writes the original string, and
5035 updates len to contain the new length.
5036 Returns zero on failure, setting C<len> to -1.
5038 NOTE: this function is experimental and may change or be
5039 removed without notice.
5041 U8* utf8_to_bytes(U8 *s, STRLEN *len)
5044 Found in file utf8.c
5048 Returns the native character value of the first character in the string C<s>
5049 which is assumed to be in UTF8 encoding; C<retlen> will be set to the
5050 length, in bytes, of that character.
5052 If C<s> does not point to a well-formed UTF8 character, zero is
5053 returned and retlen is set, if possible, to -1.
5055 UV utf8_to_uvchr(U8 *s, STRLEN* retlen)
5058 Found in file utf8.c
5062 Returns the Unicode code point of the first character in the string C<s>
5063 which is assumed to be in UTF8 encoding; C<retlen> will be set to the
5064 length, in bytes, of that character.
5066 This function should only be used when returned UV is considered
5067 an index into the Unicode semantic tables (e.g. swashes).
5069 If C<s> does not point to a well-formed UTF8 character, zero is
5070 returned and retlen is set, if possible, to -1.
5072 UV utf8_to_uvuni(U8 *s, STRLEN* retlen)
5075 Found in file utf8.c
5079 Adds the UTF8 representation of the Native codepoint C<uv> to the end
5080 of the string C<d>; C<d> should be have at least C<UTF8_MAXLEN+1> free
5081 bytes available. The return value is the pointer to the byte after the
5082 end of the new character. In other words,
5084 d = uvchr_to_utf8(d, uv);
5086 is the recommended wide native character-aware way of saying
5090 U8* uvchr_to_utf8(U8 *d, UV uv)
5093 Found in file utf8.c
5095 =item uvuni_to_utf8_flags
5097 Adds the UTF8 representation of the Unicode codepoint C<uv> to the end
5098 of the string C<d>; C<d> should be have at least C<UTF8_MAXLEN+1> free
5099 bytes available. The return value is the pointer to the byte after the
5100 end of the new character. In other words,
5102 d = uvuni_to_utf8_flags(d, uv, flags);
5106 d = uvuni_to_utf8(d, uv);
5108 (which is equivalent to)
5110 d = uvuni_to_utf8_flags(d, uv, 0);
5112 is the recommended Unicode-aware way of saying
5116 U8* uvuni_to_utf8_flags(U8 *d, UV uv, UV flags)
5119 Found in file utf8.c
5124 =head1 Variables created by C<xsubpp> and C<xsubpp> internal functions
5130 Variable which is setup by C<xsubpp> to indicate the stack base offset,
5131 used by the C<ST>, C<XSprePUSH> and C<XSRETURN> macros. The C<dMARK> macro
5132 must be called prior to setup the C<MARK> variable.
5137 Found in file XSUB.h
5141 Variable which is setup by C<xsubpp> to indicate the
5142 class name for a C++ XS constructor. This is always a C<char*>. See C<THIS>.
5147 Found in file XSUB.h
5151 Sets up the C<ax> variable.
5152 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
5157 Found in file XSUB.h
5161 Sets up the C<items> variable.
5162 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
5167 Found in file XSUB.h
5171 Sets up stack and mark pointers for an XSUB, calling dSP and dMARK.
5172 Sets up the C<ax> and C<items> variables by calling C<dAX> and C<dITEMS>.
5173 This is usually handled automatically by C<xsubpp>.
5178 Found in file XSUB.h
5182 Sets up the C<ix> variable for an XSUB which has aliases. This is usually
5183 handled automatically by C<xsubpp>.
5188 Found in file XSUB.h
5192 Variable which is setup by C<xsubpp> to indicate the number of
5193 items on the stack. See L<perlxs/"Variable-length Parameter Lists">.
5198 Found in file XSUB.h
5202 Variable which is setup by C<xsubpp> to indicate which of an
5203 XSUB's aliases was used to invoke it. See L<perlxs/"The ALIAS: Keyword">.
5208 Found in file XSUB.h
5212 Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
5216 Found in file XSUB.h
5220 Variable which is setup by C<xsubpp> to hold the return value for an
5221 XSUB. This is always the proper type for the XSUB. See
5222 L<perlxs/"The RETVAL Variable">.
5227 Found in file XSUB.h
5231 Used to access elements on the XSUB's stack.
5236 Found in file XSUB.h
5240 Variable which is setup by C<xsubpp> to designate the object in a C++
5241 XSUB. This is always the proper type for the C++ object. See C<CLASS> and
5242 L<perlxs/"Using XS With C++">.
5247 Found in file XSUB.h
5251 Macro to declare an XSUB and its C parameter list. This is handled by
5255 Found in file XSUB.h
5257 =item XSRETURN_EMPTY
5259 Return an empty list from an XSUB immediately.
5265 Found in file XSUB.h
5269 The version identifier for an XS module. This is usually
5270 handled automatically by C<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>.
5273 Found in file XSUB.h
5275 =item XS_VERSION_BOOTCHECK
5277 Macro to verify that a PM module's $VERSION variable matches the XS
5278 module's C<XS_VERSION> variable. This is usually handled automatically by
5279 C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">.
5281 XS_VERSION_BOOTCHECK;
5284 Found in file XSUB.h
5289 =head1 Warning and Dieing
5295 This is the XSUB-writer's interface to Perl's C<die> function.
5296 Normally use this function the same way you use the C C<printf>
5297 function. See C<warn>.
5299 If you want to throw an exception object, assign the object to
5300 C<$@> and then pass C<Nullch> to croak():
5302 errsv = get_sv("@", TRUE);
5303 sv_setsv(errsv, exception_object);
5306 void croak(const char* pat, ...)
5309 Found in file util.c
5313 This is the XSUB-writer's interface to Perl's C<warn> function. Use this
5314 function the same way you use the C C<printf> function. See
5317 void warn(const char* pat, ...)
5320 Found in file util.c
5327 Until May 1997, this document was maintained by Jeff Okamoto
5328 <okamoto@corp.hp.com>. It is now maintained as part of Perl itself.
5330 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
5331 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
5332 Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
5333 Stephen McCamant, and Gurusamy Sarathy.
5335 API Listing originally by Dean Roehrich <roehrich@cray.com>.
5337 Updated to be autogenerated from comments in the source by Benjamin Stuhl.
5341 perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
https://perl5.git.perl.org / perl5.git / blob