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 void sortsv(SV ** array, size_t num_elts, SVCOMPARE_t cmp)
303 Found in file pp_sort.c
308 =head1 Callback Functions
314 Performs a callback to the specified Perl sub. See L<perlcall>.
316 NOTE: the perl_ form of this function is deprecated.
318 I32 call_argv(const char* sub_name, I32 flags, char** argv)
325 Performs a callback to the specified Perl method. The blessed object must
326 be on the stack. See L<perlcall>.
328 NOTE: the perl_ form of this function is deprecated.
330 I32 call_method(const char* methname, I32 flags)
337 Performs a callback to the specified Perl sub. See L<perlcall>.
339 NOTE: the perl_ form of this function is deprecated.
341 I32 call_pv(const char* sub_name, I32 flags)
348 Performs a callback to the Perl sub whose name is in the SV. See
351 NOTE: the perl_ form of this function is deprecated.
353 I32 call_sv(SV* sv, I32 flags)
360 Opening bracket on a callback. See C<LEAVE> and L<perlcall>.
365 Found in file scope.h
369 Tells Perl to C<eval> the given string and return an SV* result.
371 NOTE: the perl_ form of this function is deprecated.
373 SV* eval_pv(const char* p, I32 croak_on_error)
380 Tells Perl to C<eval> the string in the SV.
382 NOTE: the perl_ form of this function is deprecated.
384 I32 eval_sv(SV* sv, I32 flags)
391 Closing bracket for temporaries on a callback. See C<SAVETMPS> and
397 Found in file scope.h
401 Closing bracket on a callback. See C<ENTER> and L<perlcall>.
406 Found in file scope.h
410 Opening bracket for temporaries on a callback. See C<FREETMPS> and
416 Found in file scope.h
421 =head1 Character classes
427 Returns a boolean indicating whether the C C<char> is an ASCII alphanumeric
428 character (including underscore) or digit.
430 bool isALNUM(char ch)
433 Found in file handy.h
437 Returns a boolean indicating whether the C C<char> is an ASCII alphabetic
440 bool isALPHA(char ch)
443 Found in file handy.h
447 Returns a boolean indicating whether the C C<char> is an ASCII
450 bool isDIGIT(char ch)
453 Found in file handy.h
457 Returns a boolean indicating whether the C C<char> is a lowercase
460 bool isLOWER(char ch)
463 Found in file handy.h
467 Returns a boolean indicating whether the C C<char> is whitespace.
469 bool isSPACE(char ch)
472 Found in file handy.h
476 Returns a boolean indicating whether the C C<char> is an uppercase
479 bool isUPPER(char ch)
482 Found in file handy.h
486 Converts the specified character to lowercase.
488 char toLOWER(char ch)
491 Found in file handy.h
495 Converts the specified character to uppercase.
497 char toUPPER(char ch)
500 Found in file handy.h
505 =head1 Cloning an interpreter
511 Create and return a new interpreter by cloning the current one.
513 PerlInterpreter* perl_clone(PerlInterpreter* interp, UV flags)
521 =head1 CV Manipulation Functions
527 Returns the stash of the CV.
536 Returns the CV of the specified Perl subroutine. If C<create> is set and
537 the Perl subroutine does not exist then it will be declared (which has the
538 same effect as saying C<sub name;>). If C<create> is not set and the
539 subroutine does not exist then NULL is returned.
541 NOTE: the perl_ form of this function is deprecated.
543 CV* get_cv(const char* name, I32 create)
559 =head1 Embedding Functions
565 Loads the module whose name is pointed to by the string part of name.
566 Note that the actual module name, not its filename, should be given.
567 Eg, "Foo::Bar" instead of "Foo/Bar.pm". flags can be any of
568 PERL_LOADMOD_DENY, PERL_LOADMOD_NOIMPORT, or PERL_LOADMOD_IMPORT_OPS
569 (or 0 for no flags). ver, if specified, provides version semantics
570 similar to C<use Foo::Bar VERSION>. The optional trailing SV*
571 arguments can be used to specify arguments to the module's import()
572 method, similar to C<use Foo::Bar VERSION LIST>.
574 void load_module(U32 flags, SV* name, SV* ver, ...)
581 Allocates a new Perl interpreter. See L<perlembed>.
583 PerlInterpreter* perl_alloc()
590 Initializes a new Perl interpreter. See L<perlembed>.
592 void perl_construct(PerlInterpreter* interp)
599 Shuts down a Perl interpreter. See L<perlembed>.
601 int perl_destruct(PerlInterpreter* interp)
608 Releases a Perl interpreter. See L<perlembed>.
610 void perl_free(PerlInterpreter* interp)
617 Tells a Perl interpreter to parse a Perl script. See L<perlembed>.
619 int perl_parse(PerlInterpreter* interp, XSINIT_t xsinit, int argc, char** argv, char** env)
626 Tells a Perl interpreter to run. See L<perlembed>.
628 int perl_run(PerlInterpreter* interp)
635 Tells Perl to C<require> the file named by the string argument. It is
636 analogous to the Perl code C<eval "require '$file'">. It's even
637 implemented that way; consider using Perl_load_module instead.
639 NOTE: the perl_ form of this function is deprecated.
641 void require_pv(const char* pv)
649 =head1 Global Variables
655 C<PL_modglobal> is a general purpose, interpreter global HV for use by
656 extensions that need to keep information on a per-interpreter basis.
657 In a pinch, it can also be used as a symbol table for extensions
658 to share data among each other. It is a good idea to use keys
659 prefixed by the package name of the extension that owns the data.
664 Found in file intrpvar.h
668 A convenience variable which is typically used with C<SvPV> when one
669 doesn't care about the length of the string. It is usually more efficient
670 to either declare a local variable and use that instead or to use the
676 Found in file thrdvar.h
680 This is the C<false> SV. See C<PL_sv_yes>. Always refer to this as
686 Found in file intrpvar.h
690 This is the C<undef> SV. Always refer to this as C<&PL_sv_undef>.
695 Found in file intrpvar.h
699 This is the C<true> SV. See C<PL_sv_no>. Always refer to this as
705 Found in file intrpvar.h
716 Return the SV from the GV.
725 Returns the glob with the given C<name> and a defined subroutine or
726 C<NULL>. The glob lives in the given C<stash>, or in the stashes
727 accessible via @ISA and UNIVERSAL::.
729 The argument C<level> should be either 0 or -1. If C<level==0>, as a
730 side-effect creates a glob with the given C<name> in the given C<stash>
731 which in the case of success contains an alias for the subroutine, and sets
732 up caching info for this glob. Similarly for all the searched stashes.
734 This function grants C<"SUPER"> token as a postfix of the stash name. The
735 GV returned from C<gv_fetchmeth> may be a method cache entry, which is not
736 visible to Perl code. So when calling C<call_sv>, you should not use
737 the GV directly; instead, you should use the method's CV, which can be
738 obtained from the GV with the C<GvCV> macro.
740 GV* gv_fetchmeth(HV* stash, const char* name, STRLEN len, I32 level)
747 See L<gv_fetchmethod_autoload>.
749 GV* gv_fetchmethod(HV* stash, const char* name)
754 =item gv_fetchmethod_autoload
756 Returns the glob which contains the subroutine to call to invoke the method
757 on the C<stash>. In fact in the presence of autoloading this may be the
758 glob for "AUTOLOAD". In this case the corresponding variable $AUTOLOAD is
761 The third parameter of C<gv_fetchmethod_autoload> determines whether
762 AUTOLOAD lookup is performed if the given method is not present: non-zero
763 means yes, look for AUTOLOAD; zero means no, don't look for AUTOLOAD.
764 Calling C<gv_fetchmethod> is equivalent to calling C<gv_fetchmethod_autoload>
765 with a non-zero C<autoload> parameter.
767 These functions grant C<"SUPER"> token as a prefix of the method name. Note
768 that if you want to keep the returned glob for a long time, you need to
769 check for it being "AUTOLOAD", since at the later time the call may load a
770 different subroutine due to $AUTOLOAD changing its value. Use the glob
771 created via a side effect to do this.
773 These functions have the same side-effects and as C<gv_fetchmeth> with
774 C<level==0>. C<name> should be writable if contains C<':'> or C<'
775 ''>. The warning against passing the GV returned by C<gv_fetchmeth> to
776 C<call_sv> apply equally to these functions.
778 GV* gv_fetchmethod_autoload(HV* stash, const char* name, I32 autoload)
785 Returns a pointer to the stash for a specified package. C<name> should
786 be a valid UTF-8 string. If C<create> is set then the package will be
787 created if it does not already exist. If C<create> is not set and the
788 package does not exist then NULL is returned.
790 HV* gv_stashpv(const char* name, I32 create)
797 Returns a pointer to the stash for a specified package, which must be a
798 valid UTF-8 string. See C<gv_stashpv>.
800 HV* gv_stashsv(SV* sv, I32 create)
814 This flag, used in the length slot of hash entries and magic structures,
815 specifies the structure contains an C<SV*> pointer where a C<char*> pointer
816 is to be expected. (For information only--not to be used).
824 Null character pointer.
826 Found in file handy.h
833 Found in file handy.h
838 =head1 Hash Manipulation Functions
844 Returns the HV of the specified Perl hash. If C<create> is set and the
845 Perl variable does not exist then it will be created. If C<create> is not
846 set and the variable does not exist then NULL is returned.
848 NOTE: the perl_ form of this function is deprecated.
850 HV* get_hv(const char* name, I32 create)
857 Returns the computed hash stored in the hash entry.
866 Returns the actual pointer stored in the key slot of the hash entry. The
867 pointer may be either C<char*> or C<SV*>, depending on the value of
868 C<HeKLEN()>. Can be assigned to. The C<HePV()> or C<HeSVKEY()> macros are
869 usually preferable for finding the value of a key.
878 If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry
879 holds an C<SV*> key. Otherwise, holds the actual length of the key. Can
880 be assigned to. The C<HePV()> macro is usually preferable for finding key
883 STRLEN HeKLEN(HE* he)
890 Returns the key slot of the hash entry as a C<char*> value, doing any
891 necessary dereferencing of possibly C<SV*> keys. The length of the string
892 is placed in C<len> (this is a macro, so do I<not> use C<&len>). If you do
893 not care about what the length of the key is, you may use the global
894 variable C<PL_na>, though this is rather less efficient than using a local
895 variable. Remember though, that hash keys in perl are free to contain
896 embedded nulls, so using C<strlen()> or similar is not a good way to find
897 the length of hash keys. This is very similar to the C<SvPV()> macro
898 described elsewhere in this document.
900 char* HePV(HE* he, STRLEN len)
907 Returns the key as an C<SV*>, or C<Nullsv> if the hash entry does not
908 contain an C<SV*> key.
917 Returns the key as an C<SV*>. Will create and return a temporary mortal
918 C<SV*> if the hash entry contains only a C<char*> key.
920 SV* HeSVKEY_force(HE* he)
927 Sets the key to a given C<SV*>, taking care to set the appropriate flags to
928 indicate the presence of an C<SV*> key, and returns the same
931 SV* HeSVKEY_set(HE* he, SV* sv)
938 Returns the value slot (type C<SV*>) stored in the hash entry.
947 Returns the package name of a stash. See C<SvSTASH>, C<CvSTASH>.
949 char* HvNAME(HV* stash)
956 Clears a hash, making it empty.
958 void hv_clear(HV* tb)
965 Deletes a key/value pair in the hash. The value SV is removed from the
966 hash and returned to the caller. The C<klen> is the length of the key.
967 The C<flags> value will normally be zero; if set to G_DISCARD then NULL
970 SV* hv_delete(HV* tb, const char* key, I32 klen, I32 flags)
977 Deletes a key/value pair in the hash. The value SV is removed from the
978 hash and returned to the caller. The C<flags> value will normally be zero;
979 if set to G_DISCARD then NULL will be returned. C<hash> can be a valid
980 precomputed hash value, or 0 to ask for it to be computed.
982 SV* hv_delete_ent(HV* tb, SV* key, I32 flags, U32 hash)
989 Returns a boolean indicating whether the specified hash key exists. The
990 C<klen> is the length of the key.
992 bool hv_exists(HV* tb, const char* key, I32 klen)
999 Returns a boolean indicating whether the specified hash key exists. C<hash>
1000 can be a valid precomputed hash value, or 0 to ask for it to be
1003 bool hv_exists_ent(HV* tb, SV* key, U32 hash)
1010 Returns the SV which corresponds to the specified key in the hash. The
1011 C<klen> is the length of the key. If C<lval> is set then the fetch will be
1012 part of a store. Check that the return value is non-null before
1013 dereferencing it to an C<SV*>.
1015 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1016 information on how to use this function on tied hashes.
1018 SV** hv_fetch(HV* tb, const char* key, I32 klen, I32 lval)
1025 Returns the hash entry which corresponds to the specified key in the hash.
1026 C<hash> must be a valid precomputed hash number for the given C<key>, or 0
1027 if you want the function to compute it. IF C<lval> is set then the fetch
1028 will be part of a store. Make sure the return value is non-null before
1029 accessing it. The return value when C<tb> is a tied hash is a pointer to a
1030 static location, so be sure to make a copy of the structure if you need to
1033 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1034 information on how to use this function on tied hashes.
1036 HE* hv_fetch_ent(HV* tb, SV* key, I32 lval, U32 hash)
1043 Prepares a starting point to traverse a hash table. Returns the number of
1044 keys in the hash (i.e. the same as C<HvKEYS(tb)>). The return value is
1045 currently only meaningful for hashes without tie magic.
1047 NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
1048 hash buckets that happen to be in use. If you still need that esoteric
1049 value, you can get it through the macro C<HvFILL(tb)>.
1051 I32 hv_iterinit(HV* tb)
1058 Returns the key from the current position of the hash iterator. See
1061 char* hv_iterkey(HE* entry, I32* retlen)
1068 Returns the key as an C<SV*> from the current position of the hash
1069 iterator. The return value will always be a mortal copy of the key. Also
1072 SV* hv_iterkeysv(HE* entry)
1079 Returns entries from a hash iterator. See C<hv_iterinit>.
1081 HE* hv_iternext(HV* tb)
1088 Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
1091 SV* hv_iternextsv(HV* hv, char** key, I32* retlen)
1098 Returns the value from the current position of the hash iterator. See
1101 SV* hv_iterval(HV* tb, HE* entry)
1108 Adds magic to a hash. See C<sv_magic>.
1110 void hv_magic(HV* hv, GV* gv, int how)
1117 Stores an SV in a hash. The hash key is specified as C<key> and C<klen> is
1118 the length of the key. The C<hash> parameter is the precomputed hash
1119 value; if it is zero then Perl will compute it. The return value will be
1120 NULL if the operation failed or if the value did not need to be actually
1121 stored within the hash (as in the case of tied hashes). Otherwise it can
1122 be dereferenced to get the original C<SV*>. Note that the caller is
1123 responsible for suitably incrementing the reference count of C<val> before
1124 the call, and decrementing it if the function returned NULL.
1126 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1127 information on how to use this function on tied hashes.
1129 SV** hv_store(HV* tb, const char* key, I32 klen, SV* val, U32 hash)
1136 Stores C<val> in a hash. The hash key is specified as C<key>. The C<hash>
1137 parameter is the precomputed hash value; if it is zero then Perl will
1138 compute it. The return value is the new hash entry so created. It will be
1139 NULL if the operation failed or if the value did not need to be actually
1140 stored within the hash (as in the case of tied hashes). Otherwise the
1141 contents of the return value can be accessed using the C<He?> macros
1142 described here. Note that the caller is responsible for suitably
1143 incrementing the reference count of C<val> before the call, and
1144 decrementing it if the function returned NULL.
1146 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1147 information on how to use this function on tied hashes.
1149 HE* hv_store_ent(HV* tb, SV* key, SV* val, U32 hash)
1158 void hv_undef(HV* tb)
1165 Creates a new HV. The reference count is set to 1.
1183 =head1 Magical Functions
1189 Clear something magical that the SV represents. See C<sv_magic>.
1191 int mg_clear(SV* sv)
1198 Copies the magic from one SV to another. See C<sv_magic>.
1200 int mg_copy(SV* sv, SV* nsv, const char* key, I32 klen)
1207 Finds the magic pointer for type matching the SV. See C<sv_magic>.
1209 MAGIC* mg_find(SV* sv, int type)
1216 Free any magic storage used by the SV. See C<sv_magic>.
1225 Do magic after a value is retrieved from the SV. See C<sv_magic>.
1234 Report on the SV's length. See C<sv_magic>.
1236 U32 mg_length(SV* sv)
1243 Turns on the magical status of an SV. See C<sv_magic>.
1245 void mg_magical(SV* sv)
1252 Do magic after a value is assigned to the SV. See C<sv_magic>.
1261 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
1262 argument more than once.
1264 void SvGETMAGIC(SV* sv)
1271 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
1272 argument more than once.
1274 void SvSETMAGIC(SV* sv)
1281 Like C<SvSetSV>, but does any set magic required afterwards.
1283 void SvSetMagicSV(SV* dsb, SV* ssv)
1290 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
1293 void SvSetSV(SV* dsb, SV* ssv)
1298 =item SvSetSV_nosteal
1300 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
1301 ssv. May evaluate arguments more than once.
1303 void SvSetSV_nosteal(SV* dsv, SV* ssv)
1311 =head1 Memory Management
1317 The XSUB-writer's interface to the C C<memcpy> function. The C<src> is the
1318 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1319 the type. May fail on overlapping copies. See also C<Move>.
1321 void Copy(void* src, void* dest, int nitems, type)
1324 Found in file handy.h
1328 The XSUB-writer's interface to the C C<memmove> function. The C<src> is the
1329 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1330 the type. Can do overlapping moves. See also C<Copy>.
1332 void Move(void* src, void* dest, int nitems, type)
1335 Found in file handy.h
1339 The XSUB-writer's interface to the C C<malloc> function.
1341 void New(int id, void* ptr, int nitems, type)
1344 Found in file handy.h
1348 The XSUB-writer's interface to the C C<malloc> function, with
1351 void Newc(int id, void* ptr, int nitems, type, cast)
1354 Found in file handy.h
1358 Creates a new SV. A non-zero C<len> parameter indicates the number of
1359 bytes of preallocated string space the SV should have. An extra byte for a
1360 tailing NUL is also reserved. (SvPOK is not set for the SV even if string
1361 space is allocated.) The reference count for the new SV is set to 1.
1362 C<id> is an integer id between 0 and 1299 (used to identify leaks).
1365 SV* NEWSV(int id, STRLEN len)
1368 Found in file handy.h
1372 The XSUB-writer's interface to the C C<malloc> function. The allocated
1373 memory is zeroed with C<memzero>.
1375 void Newz(int id, void* ptr, int nitems, type)
1378 Found in file handy.h
1382 The XSUB-writer's interface to the C C<realloc> function.
1384 void Renew(void* ptr, int nitems, type)
1387 Found in file handy.h
1391 The XSUB-writer's interface to the C C<realloc> function, with
1394 void Renewc(void* ptr, int nitems, type, cast)
1397 Found in file handy.h
1401 The XSUB-writer's interface to the C C<free> function.
1403 void Safefree(void* ptr)
1406 Found in file handy.h
1410 Copy a string to a safe spot. This does not use an SV.
1412 char* savepv(const char* sv)
1415 Found in file util.c
1419 Copy a string to a safe spot. The C<len> indicates number of bytes to
1420 copy. This does not use an SV.
1422 char* savepvn(const char* sv, I32 len)
1425 Found in file util.c
1429 This is an architecture-independent macro to copy one structure to another.
1431 void StructCopy(type src, type dest, type)
1434 Found in file handy.h
1438 The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the
1439 destination, C<nitems> is the number of items, and C<type> is the type.
1441 void Zero(void* dest, int nitems, type)
1444 Found in file handy.h
1449 =head1 Miscellaneous Functions
1455 Analyses the string in order to make fast searches on it using fbm_instr()
1456 -- the Boyer-Moore algorithm.
1458 void fbm_compile(SV* sv, U32 flags)
1461 Found in file util.c
1465 Returns the location of the SV in the string delimited by C<str> and
1466 C<strend>. It returns C<Nullch> if the string can't be found. The C<sv>
1467 does not have to be fbm_compiled, but the search will not be as fast
1470 char* fbm_instr(unsigned char* big, unsigned char* bigend, SV* littlesv, U32 flags)
1473 Found in file util.c
1477 Takes a sprintf-style format pattern and conventional
1478 (non-SV) arguments and returns the formatted string.
1480 (char *) Perl_form(pTHX_ const char* pat, ...)
1482 can be used any place a string (char *) is required:
1484 char * s = Perl_form("%d.%d",major,minor);
1486 Uses a single private buffer so if you want to format several strings you
1487 must explicitly copy the earlier strings away (and free the copies when you
1490 char* form(const char* pat, ...)
1493 Found in file util.c
1497 Fill the sv with current working directory
1499 int getcwd_sv(SV* sv)
1502 Found in file util.c
1506 Test two strings to see if they are equal. Returns true or false.
1508 bool strEQ(char* s1, char* s2)
1511 Found in file handy.h
1515 Test two strings to see if the first, C<s1>, is greater than or equal to
1516 the second, C<s2>. Returns true or false.
1518 bool strGE(char* s1, char* s2)
1521 Found in file handy.h
1525 Test two strings to see if the first, C<s1>, is greater than the second,
1526 C<s2>. Returns true or false.
1528 bool strGT(char* s1, char* s2)
1531 Found in file handy.h
1535 Test two strings to see if the first, C<s1>, is less than or equal to the
1536 second, C<s2>. Returns true or false.
1538 bool strLE(char* s1, char* s2)
1541 Found in file handy.h
1545 Test two strings to see if the first, C<s1>, is less than the second,
1546 C<s2>. Returns true or false.
1548 bool strLT(char* s1, char* s2)
1551 Found in file handy.h
1555 Test two strings to see if they are different. Returns true or
1558 bool strNE(char* s1, char* s2)
1561 Found in file handy.h
1565 Test two strings to see if they are equal. The C<len> parameter indicates
1566 the number of bytes to compare. Returns true or false. (A wrapper for
1569 bool strnEQ(char* s1, char* s2, STRLEN len)
1572 Found in file handy.h
1576 Test two strings to see if they are different. The C<len> parameter
1577 indicates the number of bytes to compare. Returns true or false. (A
1578 wrapper for C<strncmp>).
1580 bool strnNE(char* s1, char* s2, STRLEN len)
1583 Found in file handy.h
1588 =head1 Numeric functions
1594 converts a string representing a binary number to numeric form.
1596 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
1597 conversion flags, and I<result> should be NULL or a pointer to an NV.
1598 The scan stops at the end of the string, or the first invalid character.
1599 On return I<*len> is set to the length scanned string, and I<*flags> gives
1602 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
1603 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_bin>
1604 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
1605 and writes the value to I<*result> (or the value is discarded if I<result>
1608 The hex number may optionally be prefixed with "0b" or "b" unless
1609 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
1610 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the binary
1611 number may use '_' characters to separate digits.
1613 UV grok_bin(char* start, STRLEN* len, I32* flags, NV *result)
1616 Found in file numeric.c
1620 converts a string representing a hex number to numeric form.
1622 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
1623 conversion flags, and I<result> should be NULL or a pointer to an NV.
1624 The scan stops at the end of the string, or the first non-hex-digit character.
1625 On return I<*len> is set to the length scanned string, and I<*flags> gives
1628 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
1629 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_hex>
1630 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
1631 and writes the value to I<*result> (or the value is discarded if I<result>
1634 The hex number may optionally be prefixed with "0x" or "x" unless
1635 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
1636 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the hex
1637 number may use '_' characters to separate digits.
1639 UV grok_hex(char* start, STRLEN* len, I32* flags, NV *result)
1642 Found in file numeric.c
1646 Recognise (or not) a number. The type of the number is returned
1647 (0 if unrecognised), otherwise it is a bit-ORed combination of
1648 IS_NUMBER_IN_UV, IS_NUMBER_GREATER_THAN_UV_MAX, IS_NUMBER_NOT_INT,
1649 IS_NUMBER_NEG, IS_NUMBER_INFINITY, IS_NUMBER_NAN (defined in perl.h).
1651 If the value of the number can fit an in UV, it is returned in the *valuep
1652 IS_NUMBER_IN_UV will be set to indicate that *valuep is valid, IS_NUMBER_IN_UV
1653 will never be set unless *valuep is valid, but *valuep may have been assigned
1654 to during processing even though IS_NUMBER_IN_UV is not set on return.
1655 If valuep is NULL, IS_NUMBER_IN_UV will be set for the same cases as when
1656 valuep is non-NULL, but no actual assignment (or SEGV) will occur.
1658 IS_NUMBER_NOT_INT will be set with IS_NUMBER_IN_UV if trailing decimals were
1659 seen (in which case *valuep gives the true value truncated to an integer), and
1660 IS_NUMBER_NEG if the number is negative (in which case *valuep holds the
1661 absolute value). IS_NUMBER_IN_UV is not set if e notation was used or the
1662 number is larger than a UV.
1664 int grok_number(const char *pv, STRLEN len, UV *valuep)
1667 Found in file numeric.c
1669 =item grok_numeric_radix
1671 Scan and skip for a numeric decimal separator (radix).
1673 bool grok_numeric_radix(const char **sp, const char *send)
1676 Found in file numeric.c
1681 UV grok_oct(char* start, STRLEN* len, I32* flags, NV *result)
1684 Found in file numeric.c
1688 For backwards compatibility. Use C<grok_bin> instead.
1690 NV scan_bin(char* start, STRLEN len, STRLEN* retlen)
1693 Found in file numeric.c
1697 For backwards compatibility. Use C<grok_hex> instead.
1699 NV scan_hex(char* start, STRLEN len, STRLEN* retlen)
1702 Found in file numeric.c
1706 For backwards compatibility. Use C<grok_oct> instead.
1708 NV scan_oct(char* start, STRLEN len, STRLEN* retlen)
1711 Found in file numeric.c
1716 =head1 Optree Manipulation Functions
1722 If C<cv> is a constant sub eligible for inlining. returns the constant
1723 value returned by the sub. Otherwise, returns NULL.
1725 Constant subs can be created with C<newCONSTSUB> or as described in
1726 L<perlsub/"Constant Functions">.
1728 SV* cv_const_sv(CV* cv)
1735 Creates a constant sub equivalent to Perl C<sub FOO () { 123 }> which is
1736 eligible for inlining at compile-time.
1738 CV* newCONSTSUB(HV* stash, char* name, SV* sv)
1745 Used by C<xsubpp> to hook up XSUBs as Perl subs.
1753 =head1 Shared SV Functions
1759 Tries to find if a given SV has a shared backend, either by
1760 looking at magic, or by checking if it is tied again threads::shared.
1762 shared_sv* sharedsv_find(SV* sv)
1765 Found in file sharedsv.c
1769 Saves a space for keeping SVs wider than an interpreter,
1770 currently only stores a pointer to the first interpreter.
1772 void sharedsv_init()
1775 Found in file sharedsv.c
1779 Recursive locks on a sharedsv.
1780 Locks are dynamically scoped at the level of the first lock.
1781 void sharedsv_lock(shared_sv* ssv)
1784 Found in file sharedsv.c
1788 Allocates a new shared sv struct, you must yourself create the SV/AV/HV.
1789 shared_sv* sharedsv_new()
1792 Found in file sharedsv.c
1794 =item sharedsv_thrcnt_dec
1796 Decrements the threadcount of a shared sv. When a threads frontend is freed
1797 this function should be called.
1799 void sharedsv_thrcnt_dec(shared_sv* ssv)
1802 Found in file sharedsv.c
1804 =item sharedsv_thrcnt_inc
1806 Increments the threadcount of a sharedsv.
1807 void sharedsv_thrcnt_inc(shared_sv* ssv)
1810 Found in file sharedsv.c
1812 =item sharedsv_unlock
1814 Recursively unlocks a shared sv.
1816 void sharedsv_unlock(shared_sv* ssv)
1819 Found in file sharedsv.c
1824 =head1 Stack Manipulation Macros
1830 Declare a stack marker variable, C<mark>, for the XSUB. See C<MARK> and
1840 Saves the original stack mark for the XSUB. See C<ORIGMARK>.
1849 Declares a local copy of perl's stack pointer for the XSUB, available via
1850 the C<SP> macro. See C<SP>.
1859 Used to extend the argument stack for an XSUB's return values. Once
1860 used, guarantees that there is room for at least C<nitems> to be pushed
1863 void EXTEND(SP, int nitems)
1870 Stack marker variable for the XSUB. See C<dMARK>.
1877 The original stack mark for the XSUB. See C<dORIGMARK>.
1884 Pops an integer off the stack.
1893 Pops a long off the stack.
1902 Pops a double off the stack.
1911 Pops a string off the stack. Deprecated. New code should provide
1912 a STRLEN n_a and use POPpx.
1921 Pops a string off the stack which must consist of bytes i.e. characters < 256.
1922 Requires a variable STRLEN n_a in scope.
1931 Pops a string off the stack.
1932 Requires a variable STRLEN n_a in scope.
1941 Pops an SV off the stack.
1950 Push an integer onto the stack. The stack must have room for this element.
1951 Handles 'set' magic. See C<XPUSHi>.
1960 Opening bracket for arguments on a callback. See C<PUTBACK> and
1970 Push a double onto the stack. The stack must have room for this element.
1971 Handles 'set' magic. See C<XPUSHn>.
1980 Push a string onto the stack. The stack must have room for this element.
1981 The C<len> indicates the length of the string. Handles 'set' magic. See
1984 void PUSHp(char* str, STRLEN len)
1991 Push an SV onto the stack. The stack must have room for this element.
1992 Does not handle 'set' magic. See C<XPUSHs>.
2001 Push an unsigned integer onto the stack. The stack must have room for this
2002 element. See C<XPUSHu>.
2011 Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
2012 See C<PUSHMARK> and L<perlcall> for other uses.
2021 Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and
2029 Refetch the stack pointer. Used after a callback. See L<perlcall>.
2038 Push an integer onto the stack, extending the stack if necessary. Handles
2039 'set' magic. See C<PUSHi>.
2048 Push a double onto the stack, extending the stack if necessary. Handles
2049 'set' magic. See C<PUSHn>.
2058 Push a string onto the stack, extending the stack if necessary. The C<len>
2059 indicates the length of the string. Handles 'set' magic. See
2062 void XPUSHp(char* str, STRLEN len)
2069 Push an SV onto the stack, extending the stack if necessary. Does not
2070 handle 'set' magic. See C<PUSHs>.
2079 Push an unsigned integer onto the stack, extending the stack if necessary.
2089 Return from XSUB, indicating number of items on the stack. This is usually
2090 handled by C<xsubpp>.
2092 void XSRETURN(int nitems)
2095 Found in file XSUB.h
2099 Return an integer from an XSUB immediately. Uses C<XST_mIV>.
2101 void XSRETURN_IV(IV iv)
2104 Found in file XSUB.h
2108 Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
2113 Found in file XSUB.h
2117 Return a double from an XSUB immediately. Uses C<XST_mNV>.
2119 void XSRETURN_NV(NV nv)
2122 Found in file XSUB.h
2126 Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
2128 void XSRETURN_PV(char* str)
2131 Found in file XSUB.h
2133 =item XSRETURN_UNDEF
2135 Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
2140 Found in file XSUB.h
2144 Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
2149 Found in file XSUB.h
2153 Place an integer into the specified position C<pos> on the stack. The
2154 value is stored in a new mortal SV.
2156 void XST_mIV(int pos, IV iv)
2159 Found in file XSUB.h
2163 Place C<&PL_sv_no> into the specified position C<pos> on the
2166 void XST_mNO(int pos)
2169 Found in file XSUB.h
2173 Place a double into the specified position C<pos> on the stack. The value
2174 is stored in a new mortal SV.
2176 void XST_mNV(int pos, NV nv)
2179 Found in file XSUB.h
2183 Place a copy of a string into the specified position C<pos> on the stack.
2184 The value is stored in a new mortal SV.
2186 void XST_mPV(int pos, char* str)
2189 Found in file XSUB.h
2193 Place C<&PL_sv_undef> into the specified position C<pos> on the
2196 void XST_mUNDEF(int pos)
2199 Found in file XSUB.h
2203 Place C<&PL_sv_yes> into the specified position C<pos> on the
2206 void XST_mYES(int pos)
2209 Found in file XSUB.h
2220 An enum of flags for Perl types. These are found in the file B<sv.h>
2221 in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
2228 Integer type flag for scalars. See C<svtype>.
2235 Double type flag for scalars. See C<svtype>.
2242 Pointer type flag for scalars. See C<svtype>.
2249 Type flag for arrays. See C<svtype>.
2256 Type flag for code refs. See C<svtype>.
2263 Type flag for hashes. See C<svtype>.
2270 Type flag for blessed scalars. See C<svtype>.
2278 =head1 SV Manipulation Functions
2284 Returns the SV of the specified Perl scalar. If C<create> is set and the
2285 Perl variable does not exist then it will be created. If C<create> is not
2286 set and the variable does not exist then NULL is returned.
2288 NOTE: the perl_ form of this function is deprecated.
2290 SV* get_sv(const char* name, I32 create)
2293 Found in file perl.c
2295 =item looks_like_number
2297 Test if the content of an SV looks like a number (or is a number).
2298 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
2299 non-numeric warning), even if your atof() doesn't grok them.
2301 I32 looks_like_number(SV* sv)
2308 Creates an RV wrapper for an SV. The reference count for the original SV is
2311 SV* newRV_inc(SV* sv)
2318 Creates an RV wrapper for an SV. The reference count for the original
2319 SV is B<not> incremented.
2321 SV* newRV_noinc(SV *sv)
2328 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
2329 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
2332 SV* newSV(STRLEN len)
2339 Creates a new SV and copies an integer into it. The reference count for the
2349 Creates a new SV and copies a floating point value into it.
2350 The reference count for the SV is set to 1.
2359 Creates a new SV and copies a string into it. The reference count for the
2360 SV is set to 1. If C<len> is zero, Perl will compute the length using
2361 strlen(). For efficiency, consider using C<newSVpvn> instead.
2363 SV* newSVpv(const char* s, STRLEN len)
2370 Creates a new SV and initializes it with the string formatted like
2373 SV* newSVpvf(const char* pat, ...)
2380 Creates a new SV and copies a string into it. The reference count for the
2381 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
2382 string. You are responsible for ensuring that the source string is at least
2385 SV* newSVpvn(const char* s, STRLEN len)
2390 =item newSVpvn_share
2392 Creates a new SV with its SvPVX pointing to a shared string in the string
2393 table. If the string does not already exist in the table, it is created
2394 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
2395 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
2396 otherwise the hash is computed. The idea here is that as the string table
2397 is used for shared hash keys these strings will have SvPVX == HeKEY and
2398 hash lookup will avoid string compare.
2400 SV* newSVpvn_share(const char* s, I32 len, U32 hash)
2407 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
2408 it will be upgraded to one. If C<classname> is non-null then the new SV will
2409 be blessed in the specified package. The new SV is returned and its
2410 reference count is 1.
2412 SV* newSVrv(SV* rv, const char* classname)
2419 Creates a new SV which is an exact duplicate of the original SV.
2422 SV* newSVsv(SV* old)
2429 Creates a new SV and copies an unsigned integer into it.
2430 The reference count for the SV is set to 1.
2439 Returns a pointer to the next character after the parsed
2440 vstring, as well as updating the passed in sv.
2442 Function must be called like
2445 s = new_vstring(s,sv);
2447 The sv must already be large enough to store the vstring
2450 char* new_vstring(char *vstr, SV *sv)
2453 Found in file util.c
2457 Returns the length of the string which is in the SV. See C<SvLEN>.
2459 STRLEN SvCUR(SV* sv)
2466 Set the length of the string which is in the SV. See C<SvCUR>.
2468 void SvCUR_set(SV* sv, STRLEN len)
2475 Returns a pointer to the last character in the string which is in the SV.
2476 See C<SvCUR>. Access the character as *(SvEND(sv)).
2485 Expands the character buffer in the SV so that it has room for the
2486 indicated number of bytes (remember to reserve space for an extra trailing
2487 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
2488 Returns a pointer to the character buffer.
2490 char * SvGROW(SV* sv, STRLEN len)
2497 Returns a boolean indicating whether the SV contains an integer.
2506 Returns a boolean indicating whether the SV contains an integer. Checks
2507 the B<private> setting. Use C<SvIOK>.
2516 Returns a boolean indicating whether the SV contains a signed integer.
2518 void SvIOK_notUV(SV* sv)
2525 Unsets the IV status of an SV.
2527 void SvIOK_off(SV* sv)
2534 Tells an SV that it is an integer.
2536 void SvIOK_on(SV* sv)
2543 Tells an SV that it is an integer and disables all other OK bits.
2545 void SvIOK_only(SV* sv)
2552 Tells and SV that it is an unsigned integer and disables all other OK bits.
2554 void SvIOK_only_UV(SV* sv)
2561 Returns a boolean indicating whether the SV contains an unsigned integer.
2563 void SvIOK_UV(SV* sv)
2570 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
2571 version which guarantees to evaluate sv only once.
2580 Coerces the given SV to an integer and returns it. Guarantees to evaluate
2581 sv only once. Use the more efficient C<SvIV> otherwise.
2590 Returns the raw value in the SV's IV slot, without checks or conversions.
2591 Only use when you are sure SvIOK is true. See also C<SvIV()>.
2600 Returns the size of the string buffer in the SV, not including any part
2601 attributable to C<SvOOK>. See C<SvCUR>.
2603 STRLEN SvLEN(SV* sv)
2610 Returns a boolean indicating whether the SV contains a number, integer or
2620 Returns a boolean indicating whether the SV contains a number, integer or
2621 double. Checks the B<private> setting. Use C<SvNIOK>.
2623 bool SvNIOKp(SV* sv)
2630 Unsets the NV/IV status of an SV.
2632 void SvNIOK_off(SV* sv)
2639 Returns a boolean indicating whether the SV contains a double.
2648 Returns a boolean indicating whether the SV contains a double. Checks the
2649 B<private> setting. Use C<SvNOK>.
2658 Unsets the NV status of an SV.
2660 void SvNOK_off(SV* sv)
2667 Tells an SV that it is a double.
2669 void SvNOK_on(SV* sv)
2676 Tells an SV that it is a double and disables all other OK bits.
2678 void SvNOK_only(SV* sv)
2685 Coerce the given SV to a double and return it. See C<SvNVx> for a version
2686 which guarantees to evaluate sv only once.
2695 Returns the raw value in the SV's NV slot, without checks or conversions.
2696 Only use when you are sure SvNOK is true. See also C<SvNV()>.
2705 Coerces the given SV to a double and returns it. Guarantees to evaluate
2706 sv only once. Use the more efficient C<SvNV> otherwise.
2715 Returns a boolean indicating whether the value is an SV.
2724 Returns a boolean indicating whether the SvIVX is a valid offset value for
2725 the SvPVX. This hack is used internally to speed up removal of characters
2726 from the beginning of a SvPV. When SvOOK is true, then the start of the
2727 allocated string buffer is really (SvPVX - SvIVX).
2736 Returns a boolean indicating whether the SV contains a character
2746 Returns a boolean indicating whether the SV contains a character string.
2747 Checks the B<private> setting. Use C<SvPOK>.
2756 Unsets the PV status of an SV.
2758 void SvPOK_off(SV* sv)
2765 Tells an SV that it is a string.
2767 void SvPOK_on(SV* sv)
2774 Tells an SV that it is a string and disables all other OK bits.
2775 Will also turn off the UTF8 status.
2777 void SvPOK_only(SV* sv)
2782 =item SvPOK_only_UTF8
2784 Tells an SV that it is a string and disables all other OK bits,
2785 and leaves the UTF8 status as it was.
2787 void SvPOK_only_UTF8(SV* sv)
2794 Returns a pointer to the string in the SV, or a stringified form of the SV
2795 if the SV does not contain a string. Handles 'get' magic. See also
2796 C<SvPVx> for a version which guarantees to evaluate sv only once.
2798 char* SvPV(SV* sv, STRLEN len)
2805 Like C<SvPV>, but converts sv to byte representation first if necessary.
2807 char* SvPVbyte(SV* sv, STRLEN len)
2814 Like C<SvPV>, but converts sv to byte representation first if necessary.
2815 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
2819 char* SvPVbytex(SV* sv, STRLEN len)
2824 =item SvPVbytex_force
2826 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
2827 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
2830 char* SvPVbytex_force(SV* sv, STRLEN len)
2835 =item SvPVbyte_force
2837 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
2839 char* SvPVbyte_force(SV* sv, STRLEN len)
2844 =item SvPVbyte_nolen
2846 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
2848 char* SvPVbyte_nolen(SV* sv)
2855 Like C<SvPV>, but converts sv to utf8 first if necessary.
2857 char* SvPVutf8(SV* sv, STRLEN len)
2864 Like C<SvPV>, but converts sv to utf8 first if necessary.
2865 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
2868 char* SvPVutf8x(SV* sv, STRLEN len)
2873 =item SvPVutf8x_force
2875 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
2876 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
2879 char* SvPVutf8x_force(SV* sv, STRLEN len)
2884 =item SvPVutf8_force
2886 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
2888 char* SvPVutf8_force(SV* sv, STRLEN len)
2893 =item SvPVutf8_nolen
2895 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
2897 char* SvPVutf8_nolen(SV* sv)
2904 Returns a pointer to the physical string in the SV. The SV must contain a
2914 A version of C<SvPV> which guarantees to evaluate sv only once.
2916 char* SvPVx(SV* sv, STRLEN len)
2923 Like <SvPV> but will force the SV into becoming a string (SvPOK). You want
2924 force if you are going to update the SvPVX directly.
2926 char* SvPV_force(SV* sv, STRLEN len)
2931 =item SvPV_force_nomg
2933 Like <SvPV> but will force the SV into becoming a string (SvPOK). You want
2934 force if you are going to update the SvPVX directly. Doesn't process magic.
2936 char* SvPV_force_nomg(SV* sv, STRLEN len)
2943 Returns a pointer to the string in the SV, or a stringified form of the SV
2944 if the SV does not contain a string. Handles 'get' magic.
2946 char* SvPV_nolen(SV* sv)
2953 Returns the value of the object's reference count.
2955 U32 SvREFCNT(SV* sv)
2962 Decrements the reference count of the given SV.
2964 void SvREFCNT_dec(SV* sv)
2971 Increments the reference count of the given SV.
2973 SV* SvREFCNT_inc(SV* sv)
2980 Tests if the SV is an RV.
2989 Unsets the RV status of an SV.
2991 void SvROK_off(SV* sv)
2998 Tells an SV that it is an RV.
3000 void SvROK_on(SV* sv)
3007 Dereferences an RV to return the SV.
3014 =item SvSetMagicSV_nosteal
3016 Like C<SvSetMagicSV>, but does any set magic required afterwards.
3019 void SvSetMagicSV_nosteal(SV* dsv, SV* ssv)
3026 Returns the stash of the SV.
3035 Taints an SV if tainting is enabled
3037 void SvTAINT(SV* sv)
3044 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
3047 bool SvTAINTED(SV* sv)
3054 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
3055 some of Perl's fundamental security features. XS module authors should not
3056 use this function unless they fully understand all the implications of
3057 unconditionally untainting the value. Untainting should be done in the
3058 standard perl fashion, via a carefully crafted regexp, rather than directly
3059 untainting variables.
3061 void SvTAINTED_off(SV* sv)
3068 Marks an SV as tainted.
3070 void SvTAINTED_on(SV* sv)
3077 Returns a boolean indicating whether Perl would evaluate the SV as true or
3078 false, defined or undefined. Does not handle 'get' magic.
3087 Returns the type of the SV. See C<svtype>.
3089 svtype SvTYPE(SV* sv)
3096 Returns a boolean indicating whether the SV contains an unsigned integer.
3105 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
3106 perform the upgrade if necessary. See C<svtype>.
3108 void SvUPGRADE(SV* sv, svtype type)
3115 Returns a boolean indicating whether the SV contains UTF-8 encoded data.
3124 Unsets the UTF8 status of an SV.
3126 void SvUTF8_off(SV *sv)
3133 Turn on the UTF8 status of an SV (the data is not changed, just the flag).
3134 Do not use frivolously.
3136 void SvUTF8_on(SV *sv)
3143 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
3144 for a version which guarantees to evaluate sv only once.
3153 Coerces the given SV to an unsigned integer and returns it. Guarantees to
3154 evaluate sv only once. Use the more efficient C<SvUV> otherwise.
3163 Returns the raw value in the SV's UV slot, without checks or conversions.
3164 Only use when you are sure SvIOK is true. See also C<SvUV()>.
3173 This function is only called on magical items, and is only used by
3174 sv_true() or its macro equivalent.
3176 bool sv_2bool(SV* sv)
3183 Using various gambits, try to get a CV from an SV; in addition, try if
3184 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
3186 CV* sv_2cv(SV* sv, HV** st, GV** gvp, I32 lref)
3193 Using various gambits, try to get an IO from an SV: the IO slot if its a
3194 GV; or the recursive result if we're an RV; or the IO slot of the symbol
3195 named after the PV if we're a string.
3204 Return the integer value of an SV, doing any necessary string conversion,
3205 magic etc. Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
3214 Marks an existing SV as mortal. The SV will be destroyed "soon", either
3215 by an explicit call to FREETMPS, or by an implicit call at places such as
3216 statement boundaries. See also C<sv_newmortal> and C<sv_mortalcopy>.
3218 SV* sv_2mortal(SV* sv)
3225 Return the num value of an SV, doing any necessary string or integer
3226 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
3236 Return a pointer to the byte-encoded representation of the SV, and set *lp
3237 to its length. May cause the SV to be downgraded from UTF8 as a
3240 Usually accessed via the C<SvPVbyte> macro.
3242 char* sv_2pvbyte(SV* sv, STRLEN* lp)
3247 =item sv_2pvbyte_nolen
3249 Return a pointer to the byte-encoded representation of the SV.
3250 May cause the SV to be downgraded from UTF8 as a side-effect.
3252 Usually accessed via the C<SvPVbyte_nolen> macro.
3254 char* sv_2pvbyte_nolen(SV* sv)
3261 Return a pointer to the UTF8-encoded representation of the SV, and set *lp
3262 to its length. May cause the SV to be upgraded to UTF8 as a side-effect.
3264 Usually accessed via the C<SvPVutf8> macro.
3266 char* sv_2pvutf8(SV* sv, STRLEN* lp)
3271 =item sv_2pvutf8_nolen
3273 Return a pointer to the UTF8-encoded representation of the SV.
3274 May cause the SV to be upgraded to UTF8 as a side-effect.
3276 Usually accessed via the C<SvPVutf8_nolen> macro.
3278 char* sv_2pvutf8_nolen(SV* sv)
3285 Returns a pointer to the string value of an SV, and sets *lp to its length.
3286 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
3288 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
3289 usually end up here too.
3291 char* sv_2pv_flags(SV* sv, STRLEN* lp, I32 flags)
3298 Like C<sv_2pv()>, but doesn't return the length too. You should usually
3299 use the macro wrapper C<SvPV_nolen(sv)> instead.
3300 char* sv_2pv_nolen(SV* sv)
3307 Return the unsigned integer value of an SV, doing any necessary string
3308 conversion, magic etc. Normally used via the C<SvUV(sv)> and C<SvUVx(sv)>
3318 Remove any string offset. You should normally use the C<SvOOK_off> macro
3321 int sv_backoff(SV* sv)
3328 Blesses an SV into a specified package. The SV must be an RV. The package
3329 must be designated by its stash (see C<gv_stashpv()>). The reference count
3330 of the SV is unaffected.
3332 SV* sv_bless(SV* sv, HV* stash)
3339 Concatenates the string onto the end of the string which is in the SV.
3340 If the SV has the UTF8 status set, then the bytes appended should be
3341 valid UTF8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
3343 void sv_catpv(SV* sv, const char* ptr)
3350 Processes its arguments like C<sprintf> and appends the formatted
3351 output to an SV. If the appended data contains "wide" characters
3352 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
3353 and characters >255 formatted with %c), the original SV might get
3354 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic.
3355 C<SvSETMAGIC()> must typically be called after calling this function
3356 to handle 'set' magic.
3358 void sv_catpvf(SV* sv, const char* pat, ...)
3365 Like C<sv_catpvf>, but also handles 'set' magic.
3367 void sv_catpvf_mg(SV *sv, const char* pat, ...)
3374 Concatenates the string onto the end of the string which is in the SV. The
3375 C<len> indicates number of bytes to copy. If the SV has the UTF8
3376 status set, then the bytes appended should be valid UTF8.
3377 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
3379 void sv_catpvn(SV* sv, const char* ptr, STRLEN len)
3384 =item sv_catpvn_flags
3386 Concatenates the string onto the end of the string which is in the SV. The
3387 C<len> indicates number of bytes to copy. If the SV has the UTF8
3388 status set, then the bytes appended should be valid UTF8.
3389 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
3390 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
3391 in terms of this function.
3393 void sv_catpvn_flags(SV* sv, const char* ptr, STRLEN len, I32 flags)
3400 Like C<sv_catpvn>, but also handles 'set' magic.
3402 void sv_catpvn_mg(SV *sv, const char *ptr, STRLEN len)
3409 Like C<sv_catpv>, but also handles 'set' magic.
3411 void sv_catpv_mg(SV *sv, const char *ptr)
3418 Concatenates the string from SV C<ssv> onto the end of the string in
3419 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
3420 not 'set' magic. See C<sv_catsv_mg>.
3422 void sv_catsv(SV* dsv, SV* ssv)
3427 =item sv_catsv_flags
3429 Concatenates the string from SV C<ssv> onto the end of the string in
3430 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
3431 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
3432 and C<sv_catsv_nomg> are implemented in terms of this function.
3434 void sv_catsv_flags(SV* dsv, SV* ssv, I32 flags)
3441 Like C<sv_catsv>, but also handles 'set' magic.
3443 void sv_catsv_mg(SV *dstr, SV *sstr)
3450 Efficient removal of characters from the beginning of the string buffer.
3451 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
3452 the string buffer. The C<ptr> becomes the first character of the adjusted
3453 string. Uses the "OOK hack".
3455 void sv_chop(SV* sv, char* ptr)
3462 Clear an SV: call any destructors, free up any memory used by the body,
3463 and free the body itself. The SV's head is I<not> freed, although
3464 its type is set to all 1's so that it won't inadvertently be assumed
3465 to be live during global destruction etc.
3466 This function should only be called when REFCNT is zero. Most of the time
3467 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
3470 void sv_clear(SV* sv)
3477 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
3478 string in C<sv1> is less than, equal to, or greater than the string in
3479 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
3480 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
3482 I32 sv_cmp(SV* sv1, SV* sv2)
3489 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
3490 'use bytes' aware, handles get magic, and will coerce its args to strings
3491 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
3493 I32 sv_cmp_locale(SV* sv1, SV* sv2)
3500 Add Collate Transform magic to an SV if it doesn't already have it.
3502 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
3503 scalar data of the variable, but transformed to such a format that a normal
3504 memory comparison can be used to compare the data according to the locale
3507 char* sv_collxfrm(SV* sv, STRLEN* nxp)
3514 Auto-decrement of the value in the SV, doing string to numeric conversion
3515 if necessary. Handles 'get' magic.
3522 =item sv_derived_from
3524 Returns a boolean indicating whether the SV is derived from the specified
3525 class. This is the function that implements C<UNIVERSAL::isa>. It works
3526 for class names as well as for objects.
3528 bool sv_derived_from(SV* sv, const char* name)
3531 Found in file universal.c
3535 Returns a boolean indicating whether the strings in the two SVs are
3536 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
3537 coerce its args to strings if necessary.
3539 I32 sv_eq(SV* sv1, SV* sv2)
3544 =item sv_force_normal
3546 Undo various types of fakery on an SV: if the PV is a shared string, make
3547 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3548 an xpvmg. See also C<sv_force_normal_flags>.
3550 void sv_force_normal(SV *sv)
3555 =item sv_force_normal_flags
3557 Undo various types of fakery on an SV: if the PV is a shared string, make
3558 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3559 an xpvmg. The C<flags> parameter gets passed to C<sv_unref_flags()>
3560 when unrefing. C<sv_force_normal> calls this function with flags set to 0.
3562 void sv_force_normal_flags(SV *sv, U32 flags)
3569 Decrement an SV's reference count, and if it drops to zero, call
3570 C<sv_clear> to invoke destructors and free up any memory used by
3571 the body; finally, deallocate the SV's head itself.
3572 Normally called via a wrapper macro C<SvREFCNT_dec>.
3574 void sv_free(SV* sv)
3581 Get a line from the filehandle and store it into the SV, optionally
3582 appending to the currently-stored string.
3584 char* sv_gets(SV* sv, PerlIO* fp, I32 append)
3591 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
3592 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
3593 Use the C<SvGROW> wrapper instead.
3595 char* sv_grow(SV* sv, STRLEN newlen)
3602 Auto-increment of the value in the SV, doing string to numeric conversion
3603 if necessary. Handles 'get' magic.
3612 Inserts a string at the specified offset/length within the SV. Similar to
3613 the Perl substr() function.
3615 void sv_insert(SV* bigsv, STRLEN offset, STRLEN len, char* little, STRLEN littlelen)
3622 Returns a boolean indicating whether the SV is blessed into the specified
3623 class. This does not check for subtypes; use C<sv_derived_from> to verify
3624 an inheritance relationship.
3626 int sv_isa(SV* sv, const char* name)
3633 Returns a boolean indicating whether the SV is an RV pointing to a blessed
3634 object. If the SV is not an RV, or if the object is not blessed, then this
3637 int sv_isobject(SV* sv)
3644 A private implementation of the C<SvIVx> macro for compilers which can't
3645 cope with complex macro expressions. Always use the macro instead.
3654 Returns the length of the string in the SV. Handles magic and type
3655 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
3657 STRLEN sv_len(SV* sv)
3664 Returns the number of characters in the string in an SV, counting wide
3665 UTF8 bytes as a single character. Handles magic and type coercion.
3667 STRLEN sv_len_utf8(SV* sv)
3674 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
3675 then adds a new magic item of type C<how> to the head of the magic list.
3677 C<name> is assumed to contain an C<SV*> if C<(name && namelen == HEf_SVKEY)>
3679 void sv_magic(SV* sv, SV* obj, int how, const char* name, I32 namlen)
3686 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
3687 The new SV is marked as mortal. It will be destroyed "soon", either by an
3688 explicit call to FREETMPS, or by an implicit call at places such as
3689 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
3691 SV* sv_mortalcopy(SV* oldsv)
3698 Creates a new null SV which is mortal. The reference count of the SV is
3699 set to 1. It will be destroyed "soon", either by an explicit call to
3700 FREETMPS, or by an implicit call at places such as statement boundaries.
3701 See also C<sv_mortalcopy> and C<sv_2mortal>.
3710 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
3713 SV* sv_newref(SV* sv)
3720 A private implementation of the C<SvNVx> macro for compilers which can't
3721 cope with complex macro expressions. Always use the macro instead.
3730 Converts the value pointed to by offsetp from a count of bytes from the
3731 start of the string, to a count of the equivalent number of UTF8 chars.
3732 Handles magic and type coercion.
3734 void sv_pos_b2u(SV* sv, I32* offsetp)
3741 Converts the value pointed to by offsetp from a count of UTF8 chars from
3742 the start of the string, to a count of the equivalent number of bytes; if
3743 lenp is non-zero, it does the same to lenp, but this time starting from
3744 the offset, rather than from the start of the string. Handles magic and
3747 void sv_pos_u2b(SV* sv, I32* offsetp, I32* lenp)
3754 A private implementation of the C<SvPV_nolen> macro for compilers which can't
3755 cope with complex macro expressions. Always use the macro instead.
3764 A private implementation of the C<SvPVbyte_nolen> macro for compilers
3765 which can't cope with complex macro expressions. Always use the macro
3768 char* sv_pvbyte(SV *sv)
3775 A private implementation of the C<SvPVbyte> macro for compilers
3776 which can't cope with complex macro expressions. Always use the macro
3779 char* sv_pvbyten(SV *sv, STRLEN *len)
3784 =item sv_pvbyten_force
3786 A private implementation of the C<SvPVbytex_force> macro for compilers
3787 which can't cope with complex macro expressions. Always use the macro
3790 char* sv_pvbyten_force(SV* sv, STRLEN* lp)
3797 A private implementation of the C<SvPV> macro for compilers which can't
3798 cope with complex macro expressions. Always use the macro instead.
3800 char* sv_pvn(SV *sv, STRLEN *len)
3807 Get a sensible string out of the SV somehow.
3808 A private implementation of the C<SvPV_force> macro for compilers which
3809 can't cope with complex macro expressions. Always use the macro instead.
3811 char* sv_pvn_force(SV* sv, STRLEN* lp)
3816 =item sv_pvn_force_flags
3818 Get a sensible string out of the SV somehow.
3819 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
3820 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
3821 implemented in terms of this function.
3822 You normally want to use the various wrapper macros instead: see
3823 C<SvPV_force> and C<SvPV_force_nomg>
3825 char* sv_pvn_force_flags(SV* sv, STRLEN* lp, I32 flags)
3832 A private implementation of the C<SvPVutf8_nolen> macro for compilers
3833 which can't cope with complex macro expressions. Always use the macro
3836 char* sv_pvutf8(SV *sv)
3843 A private implementation of the C<SvPVutf8> macro for compilers
3844 which can't cope with complex macro expressions. Always use the macro
3847 char* sv_pvutf8n(SV *sv, STRLEN *len)
3852 =item sv_pvutf8n_force
3854 A private implementation of the C<SvPVutf8_force> macro for compilers
3855 which can't cope with complex macro expressions. Always use the macro
3858 char* sv_pvutf8n_force(SV* sv, STRLEN* lp)
3865 Returns a string describing what the SV is a reference to.
3867 char* sv_reftype(SV* sv, int ob)
3874 Make the first argument a copy of the second, then delete the original.
3875 The target SV physically takes over ownership of the body of the source SV
3876 and inherits its flags; however, the target keeps any magic it owns,
3877 and any magic in the source is discarded.
3878 Note that this is a rather specialist SV copying operation; most of the
3879 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
3881 void sv_replace(SV* sv, SV* nsv)
3886 =item sv_report_used
3888 Dump the contents of all SVs not yet freed. (Debugging aid).
3890 void sv_report_used()
3897 Underlying implementation for the C<reset> Perl function.
3898 Note that the perl-level function is vaguely deprecated.
3900 void sv_reset(char* s, HV* stash)
3907 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
3908 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
3909 push a back-reference to this RV onto the array of backreferences
3910 associated with that magic.
3912 SV* sv_rvweaken(SV *sv)
3919 Copies an integer into the given SV, upgrading first if necessary.
3920 Does not handle 'set' magic. See also C<sv_setiv_mg>.
3922 void sv_setiv(SV* sv, IV num)
3929 Like C<sv_setiv>, but also handles 'set' magic.
3931 void sv_setiv_mg(SV *sv, IV i)
3938 Copies a double into the given SV, upgrading first if necessary.
3939 Does not handle 'set' magic. See also C<sv_setnv_mg>.
3941 void sv_setnv(SV* sv, NV num)
3948 Like C<sv_setnv>, but also handles 'set' magic.
3950 void sv_setnv_mg(SV *sv, NV num)
3957 Copies a string into an SV. The string must be null-terminated. Does not
3958 handle 'set' magic. See C<sv_setpv_mg>.
3960 void sv_setpv(SV* sv, const char* ptr)
3967 Processes its arguments like C<sprintf> and sets an SV to the formatted
3968 output. Does not handle 'set' magic. See C<sv_setpvf_mg>.
3970 void sv_setpvf(SV* sv, const char* pat, ...)
3977 Like C<sv_setpvf>, but also handles 'set' magic.
3979 void sv_setpvf_mg(SV *sv, const char* pat, ...)
3986 Copies an integer into the given SV, also updating its string value.
3987 Does not handle 'set' magic. See C<sv_setpviv_mg>.
3989 void sv_setpviv(SV* sv, IV num)
3996 Like C<sv_setpviv>, but also handles 'set' magic.
3998 void sv_setpviv_mg(SV *sv, IV iv)
4005 Copies a string into an SV. The C<len> parameter indicates the number of
4006 bytes to be copied. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4008 void sv_setpvn(SV* sv, const char* ptr, STRLEN len)
4015 Like C<sv_setpvn>, but also handles 'set' magic.
4017 void sv_setpvn_mg(SV *sv, const char *ptr, STRLEN len)
4024 Like C<sv_setpv>, but also handles 'set' magic.
4026 void sv_setpv_mg(SV *sv, const char *ptr)
4033 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
4034 argument will be upgraded to an RV. That RV will be modified to point to
4035 the new SV. The C<classname> argument indicates the package for the
4036 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4037 will be returned and will have a reference count of 1.
4039 SV* sv_setref_iv(SV* rv, const char* classname, IV iv)
4046 Copies a double into a new SV, optionally blessing the SV. The C<rv>
4047 argument will be upgraded to an RV. That RV will be modified to point to
4048 the new SV. The C<classname> argument indicates the package for the
4049 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4050 will be returned and will have a reference count of 1.
4052 SV* sv_setref_nv(SV* rv, const char* classname, NV nv)
4059 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
4060 argument will be upgraded to an RV. That RV will be modified to point to
4061 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
4062 into the SV. The C<classname> argument indicates the package for the
4063 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4064 will be returned and will have a reference count of 1.
4066 Do not use with other Perl types such as HV, AV, SV, CV, because those
4067 objects will become corrupted by the pointer copy process.
4069 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
4071 SV* sv_setref_pv(SV* rv, const char* classname, void* pv)
4078 Copies a string into a new SV, optionally blessing the SV. The length of the
4079 string must be specified with C<n>. The C<rv> argument will be upgraded to
4080 an RV. That RV will be modified to point to the new SV. The C<classname>
4081 argument indicates the package for the blessing. Set C<classname> to
4082 C<Nullch> to avoid the blessing. The new SV will be returned and will have
4083 a reference count of 1.
4085 Note that C<sv_setref_pv> copies the pointer while this copies the string.
4087 SV* sv_setref_pvn(SV* rv, const char* classname, char* pv, STRLEN n)
4094 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
4095 argument will be upgraded to an RV. That RV will be modified to point to
4096 the new SV. The C<classname> argument indicates the package for the
4097 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
4098 will be returned and will have a reference count of 1.
4100 SV* sv_setref_uv(SV* rv, const char* classname, UV uv)
4107 Copies the contents of the source SV C<ssv> into the destination SV
4108 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4109 function if the source SV needs to be reused. Does not handle 'set' magic.
4110 Loosely speaking, it performs a copy-by-value, obliterating any previous
4111 content of the destination.
4113 You probably want to use one of the assortment of wrappers, such as
4114 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4115 C<SvSetMagicSV_nosteal>.
4118 void sv_setsv(SV* dsv, SV* ssv)
4123 =item sv_setsv_flags
4125 Copies the contents of the source SV C<ssv> into the destination SV
4126 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4127 function if the source SV needs to be reused. Does not handle 'set' magic.
4128 Loosely speaking, it performs a copy-by-value, obliterating any previous
4129 content of the destination.
4130 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
4131 C<ssv> if appropriate, else not. C<sv_setsv> and C<sv_setsv_nomg> are
4132 implemented in terms of this function.
4134 You probably want to use one of the assortment of wrappers, such as
4135 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4136 C<SvSetMagicSV_nosteal>.
4138 This is the primary function for copying scalars, and most other
4139 copy-ish functions and macros use this underneath.
4141 void sv_setsv_flags(SV* dsv, SV* ssv, I32 flags)
4148 Like C<sv_setsv>, but also handles 'set' magic.
4150 void sv_setsv_mg(SV *dstr, SV *sstr)
4157 Copies an unsigned integer into the given SV, upgrading first if necessary.
4158 Does not handle 'set' magic. See also C<sv_setuv_mg>.
4160 void sv_setuv(SV* sv, UV num)
4167 Like C<sv_setuv>, but also handles 'set' magic.
4169 void sv_setuv_mg(SV *sv, UV u)
4176 Taint an SV. Use C<SvTAINTED_on> instead.
4177 void sv_taint(SV* sv)
4184 Test an SV for taintedness. Use C<SvTAINTED> instead.
4185 bool sv_tainted(SV* sv)
4192 Returns true if the SV has a true value by Perl's rules.
4193 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
4194 instead use an in-line version.
4203 Removes all magic of type C<type> from an SV.
4205 int sv_unmagic(SV* sv, int type)
4212 Unsets the RV status of the SV, and decrements the reference count of
4213 whatever was being referenced by the RV. This can almost be thought of
4214 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
4215 being zero. See C<SvROK_off>.
4217 void sv_unref(SV* sv)
4222 =item sv_unref_flags
4224 Unsets the RV status of the SV, and decrements the reference count of
4225 whatever was being referenced by the RV. This can almost be thought of
4226 as a reversal of C<newSVrv>. The C<cflags> argument can contain
4227 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
4228 (otherwise the decrementing is conditional on the reference count being
4229 different from one or the reference being a readonly SV).
4232 void sv_unref_flags(SV* sv, U32 flags)
4239 Untaint an SV. Use C<SvTAINTED_off> instead.
4240 void sv_untaint(SV* sv)
4247 Upgrade an SV to a more complex form. Generally adds a new body type to the
4248 SV, then copies across as much information as possible from the old body.
4249 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
4251 bool sv_upgrade(SV* sv, U32 mt)
4258 Tells an SV to use C<ptr> to find its string value. Normally the string is
4259 stored inside the SV but sv_usepvn allows the SV to use an outside string.
4260 The C<ptr> should point to memory that was allocated by C<malloc>. The
4261 string length, C<len>, must be supplied. This function will realloc the
4262 memory pointed to by C<ptr>, so that pointer should not be freed or used by
4263 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
4264 See C<sv_usepvn_mg>.
4266 void sv_usepvn(SV* sv, char* ptr, STRLEN len)
4273 Like C<sv_usepvn>, but also handles 'set' magic.
4275 void sv_usepvn_mg(SV *sv, char *ptr, STRLEN len)
4280 =item sv_utf8_decode
4282 Convert the octets in the PV from UTF-8 to chars. Scan for validity and then
4283 turn off SvUTF8 if needed so that we see characters. Used as a building block
4284 for decode_utf8 in Encode.xs
4286 NOTE: this function is experimental and may change or be
4287 removed without notice.
4289 bool sv_utf8_decode(SV *sv)
4294 =item sv_utf8_downgrade
4296 Attempt to convert the PV of an SV from UTF8-encoded to byte encoding.
4297 This may not be possible if the PV contains non-byte encoding characters;
4298 if this is the case, either returns false or, if C<fail_ok> is not
4301 NOTE: this function is experimental and may change or be
4302 removed without notice.
4304 bool sv_utf8_downgrade(SV *sv, bool fail_ok)
4309 =item sv_utf8_encode
4311 Convert the PV of an SV to UTF8-encoded, but then turn off the C<SvUTF8>
4312 flag so that it looks like octets again. Used as a building block
4313 for encode_utf8 in Encode.xs
4315 void sv_utf8_encode(SV *sv)
4320 =item sv_utf8_upgrade
4322 Convert the PV of an SV to its UTF8-encoded form.
4323 Forces the SV to string form if it is not already.
4324 Always sets the SvUTF8 flag to avoid future validity checks even
4325 if all the bytes have hibit clear.
4327 STRLEN sv_utf8_upgrade(SV *sv)
4332 =item sv_utf8_upgrade_flags
4334 Convert the PV of an SV to its UTF8-encoded form.
4335 Forces the SV to string form if it is not already.
4336 Always sets the SvUTF8 flag to avoid future validity checks even
4337 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
4338 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
4339 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
4341 STRLEN sv_utf8_upgrade_flags(SV *sv, I32 flags)
4348 A private implementation of the C<SvUVx> macro for compilers which can't
4349 cope with complex macro expressions. Always use the macro instead.
4358 Processes its arguments like C<vsprintf> and appends the formatted output
4359 to an SV. Uses an array of SVs if the C style variable argument list is
4360 missing (NULL). When running with taint checks enabled, indicates via
4361 C<maybe_tainted> if results are untrustworthy (often due to the use of
4364 Usually used via one of its frontends C<sv_catpvf> and C<sv_catpvf_mg>.
4366 void sv_vcatpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
4373 Works like C<vcatpvfn> but copies the text into the SV instead of
4376 Usually used via one of its frontends C<sv_setpvf> and C<sv_setpvf_mg>.
4378 void sv_vsetpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
4386 =head1 Unicode Support
4390 =item bytes_from_utf8
4392 Converts a string C<s> of length C<len> from UTF8 into byte encoding.
4393 Unlike <utf8_to_bytes> but like C<bytes_to_utf8>, returns a pointer to
4394 the newly-created string, and updates C<len> to contain the new
4395 length. Returns the original string if no conversion occurs, C<len>
4396 is unchanged. Do nothing if C<is_utf8> points to 0. Sets C<is_utf8> to
4397 0 if C<s> is converted or contains all 7bit characters.
4399 NOTE: this function is experimental and may change or be
4400 removed without notice.
4402 U8* bytes_from_utf8(U8 *s, STRLEN *len, bool *is_utf8)
4405 Found in file utf8.c
4409 Converts a string C<s> of length C<len> from ASCII into UTF8 encoding.
4410 Returns a pointer to the newly-created string, and sets C<len> to
4411 reflect the new length.
4413 NOTE: this function is experimental and may change or be
4414 removed without notice.
4416 U8* bytes_to_utf8(U8 *s, STRLEN *len)
4419 Found in file utf8.c
4423 Return true if the strings s1 and s2 differ case-insensitively, false
4424 if not (if they are equal case-insensitively). If u1 is true, the
4425 string s1 is assumed to be in UTF-8-encoded Unicode. If u2 is true,
4426 the string s2 is assumed to be in UTF-8-encoded Unicode. If u1 or u2
4427 are false, the respective string is assumed to be in native 8-bit
4430 If the pe1 and pe2 are non-NULL, the scanning pointers will be copied
4431 in there (they will point at the beginning of the I<next> character).
4432 If the pointers behind pe1 or pe2 are non-NULL, they are the end
4433 pointers beyond which scanning will not continue under any
4434 circustances. If the byte lengths l1 and l2 are non-zero, s1+l1 and
4435 s2+l2 will be used as goal end pointers that will also stop the scan,
4436 and which qualify towards defining a successful match: all the scans
4437 that define an explicit length must reach their goal pointers for
4438 a match to succeed).
4440 For case-insensitiveness, the "casefolding" of Unicode is used
4441 instead of upper/lowercasing both the characters, see
4442 http://www.unicode.org/unicode/reports/tr21/ (Case Mappings).
4444 I32 ibcmp_utf8(const char* a, char **pe1, UV l1, bool u1, const char* b, char **pe2, UV l2, bool u2)
4447 Found in file utf8.c
4451 Tests if some arbitrary number of bytes begins in a valid UTF-8
4452 character. Note that an INVARIANT (i.e. ASCII) character is a valid UTF-8 character.
4453 The actual number of bytes in the UTF-8 character will be returned if
4454 it is valid, otherwise 0.
4456 STRLEN is_utf8_char(U8 *p)
4459 Found in file utf8.c
4461 =item is_utf8_string
4463 Returns true if first C<len> bytes of the given string form a valid UTF8
4464 string, false otherwise. Note that 'a valid UTF8 string' does not mean
4465 'a string that contains UTF8' because a valid ASCII string is a valid
4468 bool is_utf8_string(U8 *s, STRLEN len)
4471 Found in file utf8.c
4473 =item pv_uni_display
4475 Build to the scalar dsv a displayable version of the string spv,
4476 length len, the displayable version being at most pvlim bytes long
4477 (if longer, the rest is truncated and "..." will be appended).
4478 The flags argument is currently unused but available for future extensions.
4479 The pointer to the PV of the dsv is returned.
4481 char* pv_uni_display(SV *dsv, U8 *spv, STRLEN len, STRLEN pvlim, UV flags)
4484 Found in file utf8.c
4486 =item sv_recode_to_utf8
4488 The encoding is assumed to be an Encode object, on entry the PV
4489 of the sv is assumed to be octets in that encoding, and the sv
4490 will be converted into Unicode (and UTF-8).
4492 If the sv already is UTF-8 (or if it is not POK), or if the encoding
4493 is not a reference, nothing is done to the sv. If the encoding is not
4494 an C<Encode::XS> Encoding object, bad things will happen.
4495 (See F<lib/encoding.pm> and L<Encode>).
4497 The PV of the sv is returned.
4499 char* sv_recode_to_utf8(SV* sv, SV *encoding)
4504 =item sv_uni_display
4506 Build to the scalar dsv a displayable version of the scalar sv,
4507 he displayable version being at most pvlim bytes long
4508 (if longer, the rest is truncated and "..." will be appended).
4509 The flags argument is currently unused but available for future extensions.
4510 The pointer to the PV of the dsv is returned.
4512 char* sv_uni_display(SV *dsv, SV *ssv, STRLEN pvlim, UV flags)
4515 Found in file utf8.c
4519 The "p" contains the pointer to the UTF-8 string encoding
4520 the character that is being converted.
4522 The "ustrp" is a pointer to the character buffer to put the
4523 conversion result to. The "lenp" is a pointer to the length
4526 The "swash" is a pointer to the swash to use.
4528 The "normal" is a string like "ToLower" which means the swash
4529 $utf8::ToLower, which is stored in lib/unicore/To/Lower.pl,
4530 and loaded by SWASHGET, using lib/utf8_heavy.pl.
4532 The "special" is a string like "utf8::ToSpecLower", which means
4533 the hash %utf8::ToSpecLower, which is stored in the same file,
4534 lib/unicore/To/Lower.pl, and also loaded by SWASHGET. The access
4535 to the hash is by Perl_to_utf8_case().
4537 UV to_utf8_case(U8 *p, U8* ustrp, STRLEN *lenp, SV **swash, char *normal, char *special)
4540 Found in file utf8.c
4544 Convert the UTF-8 encoded character at p to its foldcase version and
4545 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
4546 that the ustrp needs to be at least UTF8_MAXLEN_FOLD+1 bytes since the
4547 foldcase version may be longer than the original character (up to
4550 The first character of the foldcased version is returned
4551 (but note, as explained above, that there may be more.)
4553 UV to_utf8_fold(U8 *p, U8* ustrp, STRLEN *lenp)
4556 Found in file utf8.c
4560 Convert the UTF-8 encoded character at p to its lowercase version and
4561 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
4562 that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the
4563 lowercase version may be longer than the original character (up to two
4566 The first character of the lowercased version is returned
4567 (but note, as explained above, that there may be more.)
4569 UV to_utf8_lower(U8 *p, U8* ustrp, STRLEN *lenp)
4572 Found in file utf8.c
4576 Convert the UTF-8 encoded character at p to its titlecase version and
4577 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
4578 that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the
4579 titlecase version may be longer than the original character (up to two
4582 The first character of the titlecased version is returned
4583 (but note, as explained above, that there may be more.)
4585 UV to_utf8_title(U8 *p, U8* ustrp, STRLEN *lenp)
4588 Found in file utf8.c
4592 Convert the UTF-8 encoded character at p to its uppercase version and
4593 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
4594 that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the
4595 uppercase version may be longer than the original character (up to two
4598 The first character of the uppercased version is returned
4599 (but note, as explained above, that there may be more.)
4601 UV to_utf8_upper(U8 *p, U8* ustrp, STRLEN *lenp)
4604 Found in file utf8.c
4606 =item utf8n_to_uvchr
4608 Returns the native character value of the first character in the string C<s>
4609 which is assumed to be in UTF8 encoding; C<retlen> will be set to the
4610 length, in bytes, of that character.
4612 Allows length and flags to be passed to low level routine.
4614 UV utf8n_to_uvchr(U8 *s, STRLEN curlen, STRLEN* retlen, U32 flags)
4617 Found in file utf8.c
4619 =item utf8n_to_uvuni
4621 Bottom level UTF-8 decode routine.
4622 Returns the unicode code point value of the first character in the string C<s>
4623 which is assumed to be in UTF8 encoding and no longer than C<curlen>;
4624 C<retlen> will be set to the length, in bytes, of that character.
4626 If C<s> does not point to a well-formed UTF8 character, the behaviour
4627 is dependent on the value of C<flags>: if it contains UTF8_CHECK_ONLY,
4628 it is assumed that the caller will raise a warning, and this function
4629 will silently just set C<retlen> to C<-1> and return zero. If the
4630 C<flags> does not contain UTF8_CHECK_ONLY, warnings about
4631 malformations will be given, C<retlen> will be set to the expected
4632 length of the UTF-8 character in bytes, and zero will be returned.
4634 The C<flags> can also contain various flags to allow deviations from
4635 the strict UTF-8 encoding (see F<utf8.h>).
4637 Most code should use utf8_to_uvchr() rather than call this directly.
4639 UV utf8n_to_uvuni(U8 *s, STRLEN curlen, STRLEN* retlen, U32 flags)
4642 Found in file utf8.c
4646 Returns the number of UTF8 characters between the UTF-8 pointers C<a>
4649 WARNING: use only if you *know* that the pointers point inside the
4652 IV utf8_distance(U8 *a, U8 *b)
4655 Found in file utf8.c
4659 Return the UTF-8 pointer C<s> displaced by C<off> characters, either
4660 forward or backward.
4662 WARNING: do not use the following unless you *know* C<off> is within
4663 the UTF-8 data pointed to by C<s> *and* that on entry C<s> is aligned
4664 on the first byte of character or just after the last byte of a character.
4666 U8* utf8_hop(U8 *s, I32 off)
4669 Found in file utf8.c
4673 Return the length of the UTF-8 char encoded string C<s> in characters.
4674 Stops at C<e> (inclusive). If C<e E<lt> s> or if the scan would end
4675 up past C<e>, croaks.
4677 STRLEN utf8_length(U8* s, U8 *e)
4680 Found in file utf8.c
4684 Converts a string C<s> of length C<len> from UTF8 into byte encoding.
4685 Unlike C<bytes_to_utf8>, this over-writes the original string, and
4686 updates len to contain the new length.
4687 Returns zero on failure, setting C<len> to -1.
4689 NOTE: this function is experimental and may change or be
4690 removed without notice.
4692 U8* utf8_to_bytes(U8 *s, STRLEN *len)
4695 Found in file utf8.c
4699 Returns the native character value of the first character in the string C<s>
4700 which is assumed to be in UTF8 encoding; C<retlen> will be set to the
4701 length, in bytes, of that character.
4703 If C<s> does not point to a well-formed UTF8 character, zero is
4704 returned and retlen is set, if possible, to -1.
4706 UV utf8_to_uvchr(U8 *s, STRLEN* retlen)
4709 Found in file utf8.c
4713 Returns the Unicode code point of the first character in the string C<s>
4714 which is assumed to be in UTF8 encoding; C<retlen> will be set to the
4715 length, in bytes, of that character.
4717 This function should only be used when returned UV is considered
4718 an index into the Unicode semantic tables (e.g. swashes).
4720 If C<s> does not point to a well-formed UTF8 character, zero is
4721 returned and retlen is set, if possible, to -1.
4723 UV utf8_to_uvuni(U8 *s, STRLEN* retlen)
4726 Found in file utf8.c
4730 Adds the UTF8 representation of the Native codepoint C<uv> to the end
4731 of the string C<d>; C<d> should be have at least C<UTF8_MAXLEN+1> free
4732 bytes available. The return value is the pointer to the byte after the
4733 end of the new character. In other words,
4735 d = uvchr_to_utf8(d, uv);
4737 is the recommended wide native character-aware way of saying
4741 U8* uvchr_to_utf8(U8 *d, UV uv)
4744 Found in file utf8.c
4746 =item uvuni_to_utf8_flags
4748 Adds the UTF8 representation of the Unicode codepoint C<uv> to the end
4749 of the string C<d>; C<d> should be have at least C<UTF8_MAXLEN+1> free
4750 bytes available. The return value is the pointer to the byte after the
4751 end of the new character. In other words,
4753 d = uvuni_to_utf8_flags(d, uv, flags);
4757 d = uvuni_to_utf8(d, uv);
4759 (which is equivalent to)
4761 d = uvuni_to_utf8_flags(d, uv, 0);
4763 is the recommended Unicode-aware way of saying
4767 U8* uvuni_to_utf8_flags(U8 *d, UV uv, UV flags)
4770 Found in file utf8.c
4775 =head1 Variables created by C<xsubpp> and C<xsubpp> internal functions
4781 Variable which is setup by C<xsubpp> to indicate the stack base offset,
4782 used by the C<ST>, C<XSprePUSH> and C<XSRETURN> macros. The C<dMARK> macro
4783 must be called prior to setup the C<MARK> variable.
4788 Found in file XSUB.h
4792 Variable which is setup by C<xsubpp> to indicate the
4793 class name for a C++ XS constructor. This is always a C<char*>. See C<THIS>.
4798 Found in file XSUB.h
4802 Sets up the C<ax> variable.
4803 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
4808 Found in file XSUB.h
4812 Sets up the C<items> variable.
4813 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
4818 Found in file XSUB.h
4822 Sets up stack and mark pointers for an XSUB, calling dSP and dMARK.
4823 Sets up the C<ax> and C<items> variables by calling C<dAX> and C<dITEMS>.
4824 This is usually handled automatically by C<xsubpp>.
4829 Found in file XSUB.h
4833 Sets up the C<ix> variable for an XSUB which has aliases. This is usually
4834 handled automatically by C<xsubpp>.
4839 Found in file XSUB.h
4843 Variable which is setup by C<xsubpp> to indicate the number of
4844 items on the stack. See L<perlxs/"Variable-length Parameter Lists">.
4849 Found in file XSUB.h
4853 Variable which is setup by C<xsubpp> to indicate which of an
4854 XSUB's aliases was used to invoke it. See L<perlxs/"The ALIAS: Keyword">.
4859 Found in file XSUB.h
4863 Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
4867 Found in file XSUB.h
4871 Variable which is setup by C<xsubpp> to hold the return value for an
4872 XSUB. This is always the proper type for the XSUB. See
4873 L<perlxs/"The RETVAL Variable">.
4878 Found in file XSUB.h
4882 Used to access elements on the XSUB's stack.
4887 Found in file XSUB.h
4891 Variable which is setup by C<xsubpp> to designate the object in a C++
4892 XSUB. This is always the proper type for the C++ object. See C<CLASS> and
4893 L<perlxs/"Using XS With C++">.
4898 Found in file XSUB.h
4902 Macro to declare an XSUB and its C parameter list. This is handled by
4906 Found in file XSUB.h
4908 =item XSRETURN_EMPTY
4910 Return an empty list from an XSUB immediately.
4916 Found in file XSUB.h
4920 The version identifier for an XS module. This is usually
4921 handled automatically by C<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>.
4924 Found in file XSUB.h
4926 =item XS_VERSION_BOOTCHECK
4928 Macro to verify that a PM module's $VERSION variable matches the XS
4929 module's C<XS_VERSION> variable. This is usually handled automatically by
4930 C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">.
4932 XS_VERSION_BOOTCHECK;
4935 Found in file XSUB.h
4940 =head1 Warning and Dieing
4946 This is the XSUB-writer's interface to Perl's C<die> function.
4947 Normally use this function the same way you use the C C<printf>
4948 function. See C<warn>.
4950 If you want to throw an exception object, assign the object to
4951 C<$@> and then pass C<Nullch> to croak():
4953 errsv = get_sv("@", TRUE);
4954 sv_setsv(errsv, exception_object);
4957 void croak(const char* pat, ...)
4960 Found in file util.c
4964 This is the XSUB-writer's interface to Perl's C<warn> function. Use this
4965 function the same way you use the C C<printf> function. See
4968 void warn(const char* pat, ...)
4971 Found in file util.c
4978 Until May 1997, this document was maintained by Jeff Okamoto
4979 <okamoto@corp.hp.com>. It is now maintained as part of Perl itself.
4981 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
4982 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
4983 Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
4984 Stephen McCamant, and Gurusamy Sarathy.
4986 API Listing originally by Dean Roehrich <roehrich@cray.com>.
4988 Updated to be autogenerated from comments in the source by Benjamin Stuhl.
4992 perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
projects / p5sagit/p5-mst-13.2.git / blob