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.
24 Same as C<av_len()>. Deprecated, use C<av_len()> instead.
33 Clears an array, making it empty. Does not free the memory used by the
43 Deletes the element indexed by C<key> from the array. Returns the
44 deleted element. C<flags> is currently ignored.
46 SV* av_delete(AV* ar, I32 key, I32 flags)
53 Returns true if the element indexed by C<key> has been initialized.
55 This relies on the fact that uninitialized array elements are set to
58 bool av_exists(AV* ar, I32 key)
65 Pre-extend an array. The C<key> is the index to which the array should be
68 void av_extend(AV* ar, I32 key)
75 Returns the SV at the specified index in the array. The C<key> is the
76 index. If C<lval> is set then the fetch will be part of a store. Check
77 that the return value is non-null before dereferencing it to a C<SV*>.
79 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for
80 more information on how to use this function on tied arrays.
82 SV** av_fetch(AV* ar, I32 key, I32 lval)
89 Ensure than an array has a given number of elements, equivalent to
90 Perl's C<$#array = $fill;>.
92 void av_fill(AV* ar, I32 fill)
99 Returns the highest index in the array. Returns -1 if the array is
109 Creates a new AV and populates it with a list of SVs. The SVs are copied
110 into the array, so they may be freed after the call to av_make. The new AV
111 will have a reference count of 1.
113 AV* av_make(I32 size, SV** svp)
120 Pops an SV off the end of the array. Returns C<&PL_sv_undef> if the array
130 Pushes an SV onto the end of the array. The array will grow automatically
131 to accommodate the addition.
133 void av_push(AV* ar, SV* val)
140 Shifts an SV off the beginning of the array.
149 Stores an SV in an array. The array index is specified as C<key>. The
150 return value will be NULL if the operation failed or if the value did not
151 need to be actually stored within the array (as in the case of tied
152 arrays). Otherwise it can be dereferenced to get the original C<SV*>. Note
153 that the caller is responsible for suitably incrementing the reference
154 count of C<val> before the call, and decrementing it if the function
157 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for
158 more information on how to use this function on tied arrays.
160 SV** av_store(AV* ar, I32 key, SV* val)
167 Undefines the array. Frees the memory used by the array itself.
169 void av_undef(AV* ar)
176 Unshift the given number of C<undef> values onto the beginning of the
177 array. The array will grow automatically to accommodate the addition. You
178 must then use C<av_store> to assign values to these new elements.
180 void av_unshift(AV* ar, I32 num)
187 Converts a string C<s> of length C<len> from ASCII into UTF8 encoding.
188 Returns a pointer to the newly-created string, and sets C<len> to
189 reflect the new length.
191 U8 * bytes_to_utf8(U8 *s, STRLEN *len)
198 Performs a callback to the specified Perl sub. See L<perlcall>.
200 NOTE: the perl_ form of this function is deprecated.
202 I32 call_argv(const char* sub_name, I32 flags, char** argv)
209 Performs a callback to the specified Perl method. The blessed object must
210 be on the stack. See L<perlcall>.
212 NOTE: the perl_ form of this function is deprecated.
214 I32 call_method(const char* methname, I32 flags)
221 Performs a callback to the specified Perl sub. See L<perlcall>.
223 NOTE: the perl_ form of this function is deprecated.
225 I32 call_pv(const char* sub_name, I32 flags)
232 Performs a callback to the Perl sub whose name is in the SV. See
235 NOTE: the perl_ form of this function is deprecated.
237 I32 call_sv(SV* sv, I32 flags)
244 Variable which is setup by C<xsubpp> to indicate the
245 class name for a C++ XS constructor. This is always a C<char*>. See C<THIS>.
254 The XSUB-writer's interface to the C C<memcpy> function. The C<src> is the
255 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
256 the type. May fail on overlapping copies. See also C<Move>.
258 void Copy(void* src, void* dest, int nitems, type)
261 Found in file handy.h
265 This is the XSUB-writer's interface to Perl's C<die> function.
266 Normally use this function the same way you use the C C<printf>
267 function. See C<warn>.
269 If you want to throw an exception object, assign the object to
270 C<$@> and then pass C<Nullch> to croak():
272 errsv = get_sv("@", TRUE);
273 sv_setsv(errsv, exception_object);
276 void croak(const char* pat, ...)
283 Returns the stash of the CV.
292 Declare a stack marker variable, C<mark>, for the XSUB. See C<MARK> and
302 Saves the original stack mark for the XSUB. See C<ORIGMARK>.
311 Declares a local copy of perl's stack pointer for the XSUB, available via
312 the C<SP> macro. See C<SP>.
321 Sets up stack and mark pointers for an XSUB, calling dSP and dMARK. This
322 is usually handled automatically by C<xsubpp>. Declares the C<items>
323 variable to indicate the number of items on the stack.
332 Sets up the C<ix> variable for an XSUB which has aliases. This is usually
333 handled automatically by C<xsubpp>.
342 Opening bracket on a callback. See C<LEAVE> and L<perlcall>.
347 Found in file scope.h
351 Tells Perl to C<eval> the given string and return an SV* result.
353 NOTE: the perl_ form of this function is deprecated.
355 SV* eval_pv(const char* p, I32 croak_on_error)
362 Tells Perl to C<eval> the string in the SV.
364 NOTE: the perl_ form of this function is deprecated.
366 I32 eval_sv(SV* sv, I32 flags)
373 Used to extend the argument stack for an XSUB's return values. Once
374 used, guarantees that there is room for at least C<nitems> to be pushed
377 void EXTEND(SP, int nitems)
384 Analyses the string in order to make fast searches on it using fbm_instr()
385 -- the Boyer-Moore algorithm.
387 void fbm_compile(SV* sv, U32 flags)
394 Returns the location of the SV in the string delimited by C<str> and
395 C<strend>. It returns C<Nullch> if the string can't be found. The C<sv>
396 does not have to be fbm_compiled, but the search will not be as fast
399 char* fbm_instr(unsigned char* big, unsigned char* bigend, SV* littlesv, U32 flags)
406 Closing bracket for temporaries on a callback. See C<SAVETMPS> and
412 Found in file scope.h
416 Returns the AV of the specified Perl array. If C<create> is set and the
417 Perl variable does not exist then it will be created. If C<create> is not
418 set and the variable does not exist then NULL is returned.
420 NOTE: the perl_ form of this function is deprecated.
422 AV* get_av(const char* name, I32 create)
429 Returns the CV of the specified Perl subroutine. If C<create> is set and
430 the Perl subroutine does not exist then it will be declared (which has the
431 same effect as saying C<sub name;>). If C<create> is not set and the
432 subroutine does not exist then NULL is returned.
434 NOTE: the perl_ form of this function is deprecated.
436 CV* get_cv(const char* name, I32 create)
443 Returns the HV of the specified Perl hash. If C<create> is set and the
444 Perl variable does not exist then it will be created. If C<create> is not
445 set and the variable does not exist then NULL is returned.
447 NOTE: the perl_ form of this function is deprecated.
449 HV* get_hv(const char* name, I32 create)
456 Returns the SV of the specified Perl scalar. If C<create> is set and the
457 Perl variable does not exist then it will be created. If C<create> is not
458 set and the variable does not exist then NULL is returned.
460 NOTE: the perl_ form of this function is deprecated.
462 SV* get_sv(const char* name, I32 create)
469 A backward-compatible version of C<GIMME_V> which can only return
470 C<G_SCALAR> or C<G_ARRAY>; in a void context, it returns C<G_SCALAR>.
471 Deprecated. Use C<GIMME_V> instead.
480 The XSUB-writer's equivalent to Perl's C<wantarray>. Returns C<G_VOID>,
481 C<G_SCALAR> or C<G_ARRAY> for void, scalar or list context,
491 Return the SV from the GV.
500 Returns the glob with the given C<name> and a defined subroutine or
501 C<NULL>. The glob lives in the given C<stash>, or in the stashes
502 accessible via @ISA and @UNIVERSAL.
504 The argument C<level> should be either 0 or -1. If C<level==0>, as a
505 side-effect creates a glob with the given C<name> in the given C<stash>
506 which in the case of success contains an alias for the subroutine, and sets
507 up caching info for this glob. Similarly for all the searched stashes.
509 This function grants C<"SUPER"> token as a postfix of the stash name. The
510 GV returned from C<gv_fetchmeth> may be a method cache entry, which is not
511 visible to Perl code. So when calling C<call_sv>, you should not use
512 the GV directly; instead, you should use the method's CV, which can be
513 obtained from the GV with the C<GvCV> macro.
515 GV* gv_fetchmeth(HV* stash, const char* name, STRLEN len, I32 level)
522 See L<gv_fetchmethod_autoload>.
524 GV* gv_fetchmethod(HV* stash, const char* name)
529 =item gv_fetchmethod_autoload
531 Returns the glob which contains the subroutine to call to invoke the method
532 on the C<stash>. In fact in the presence of autoloading this may be the
533 glob for "AUTOLOAD". In this case the corresponding variable $AUTOLOAD is
536 The third parameter of C<gv_fetchmethod_autoload> determines whether
537 AUTOLOAD lookup is performed if the given method is not present: non-zero
538 means yes, look for AUTOLOAD; zero means no, don't look for AUTOLOAD.
539 Calling C<gv_fetchmethod> is equivalent to calling C<gv_fetchmethod_autoload>
540 with a non-zero C<autoload> parameter.
542 These functions grant C<"SUPER"> token as a prefix of the method name. Note
543 that if you want to keep the returned glob for a long time, you need to
544 check for it being "AUTOLOAD", since at the later time the call may load a
545 different subroutine due to $AUTOLOAD changing its value. Use the glob
546 created via a side effect to do this.
548 These functions have the same side-effects and as C<gv_fetchmeth> with
549 C<level==0>. C<name> should be writable if contains C<':'> or C<'
550 ''>. The warning against passing the GV returned by C<gv_fetchmeth> to
551 C<call_sv> apply equally to these functions.
553 GV* gv_fetchmethod_autoload(HV* stash, const char* name, I32 autoload)
560 Returns a pointer to the stash for a specified package. C<name> should
561 be a valid UTF-8 string. If C<create> is set then the package will be
562 created if it does not already exist. If C<create> is not set and the
563 package does not exist then NULL is returned.
565 HV* gv_stashpv(const char* name, I32 create)
572 Returns a pointer to the stash for a specified package, which must be a
573 valid UTF-8 string. See C<gv_stashpv>.
575 HV* gv_stashsv(SV* sv, I32 create)
582 Used to indicate list context. See C<GIMME_V>, C<GIMME> and
590 Indicates that arguments returned from a callback should be discarded. See
598 Used to force a Perl C<eval> wrapper around a callback. See
606 Indicates that no arguments are being sent to a callback. See
614 Used to indicate scalar context. See C<GIMME_V>, C<GIMME>, and
622 Used to indicate void context. See C<GIMME_V> and L<perlcall>.
629 This flag, used in the length slot of hash entries and magic structures,
630 specifies the structure contains a C<SV*> pointer where a C<char*> pointer
631 is to be expected. (For information only--not to be used).
638 Returns the computed hash stored in the hash entry.
647 Returns the actual pointer stored in the key slot of the hash entry. The
648 pointer may be either C<char*> or C<SV*>, depending on the value of
649 C<HeKLEN()>. Can be assigned to. The C<HePV()> or C<HeSVKEY()> macros are
650 usually preferable for finding the value of a key.
659 If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry
660 holds an C<SV*> key. Otherwise, holds the actual length of the key. Can
661 be assigned to. The C<HePV()> macro is usually preferable for finding key
664 STRLEN HeKLEN(HE* he)
671 Returns the key slot of the hash entry as a C<char*> value, doing any
672 necessary dereferencing of possibly C<SV*> keys. The length of the string
673 is placed in C<len> (this is a macro, so do I<not> use C<&len>). If you do
674 not care about what the length of the key is, you may use the global
675 variable C<PL_na>, though this is rather less efficient than using a local
676 variable. Remember though, that hash keys in perl are free to contain
677 embedded nulls, so using C<strlen()> or similar is not a good way to find
678 the length of hash keys. This is very similar to the C<SvPV()> macro
679 described elsewhere in this document.
681 char* HePV(HE* he, STRLEN len)
688 Returns the key as an C<SV*>, or C<Nullsv> if the hash entry does not
689 contain an C<SV*> key.
698 Returns the key as an C<SV*>. Will create and return a temporary mortal
699 C<SV*> if the hash entry contains only a C<char*> key.
701 SV* HeSVKEY_force(HE* he)
708 Sets the key to a given C<SV*>, taking care to set the appropriate flags to
709 indicate the presence of an C<SV*> key, and returns the same
712 SV* HeSVKEY_set(HE* he, SV* sv)
719 Returns the value slot (type C<SV*>) stored in the hash entry.
728 Returns the package name of a stash. See C<SvSTASH>, C<CvSTASH>.
730 char* HvNAME(HV* stash)
737 Clears a hash, making it empty.
739 void hv_clear(HV* tb)
746 Deletes a key/value pair in the hash. The value SV is removed from the
747 hash and returned to the caller. The C<klen> is the length of the key.
748 The C<flags> value will normally be zero; if set to G_DISCARD then NULL
751 SV* hv_delete(HV* tb, const char* key, U32 klen, I32 flags)
758 Deletes a key/value pair in the hash. The value SV is removed from the
759 hash and returned to the caller. The C<flags> value will normally be zero;
760 if set to G_DISCARD then NULL will be returned. C<hash> can be a valid
761 precomputed hash value, or 0 to ask for it to be computed.
763 SV* hv_delete_ent(HV* tb, SV* key, I32 flags, U32 hash)
770 Returns a boolean indicating whether the specified hash key exists. The
771 C<klen> is the length of the key.
773 bool hv_exists(HV* tb, const char* key, U32 klen)
780 Returns a boolean indicating whether the specified hash key exists. C<hash>
781 can be a valid precomputed hash value, or 0 to ask for it to be
784 bool hv_exists_ent(HV* tb, SV* key, U32 hash)
791 Returns the SV which corresponds to the specified key in the hash. The
792 C<klen> is the length of the key. If C<lval> is set then the fetch will be
793 part of a store. Check that the return value is non-null before
794 dereferencing it to a C<SV*>.
796 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
797 information on how to use this function on tied hashes.
799 SV** hv_fetch(HV* tb, const char* key, U32 klen, I32 lval)
806 Returns the hash entry which corresponds to the specified key in the hash.
807 C<hash> must be a valid precomputed hash number for the given C<key>, or 0
808 if you want the function to compute it. IF C<lval> is set then the fetch
809 will be part of a store. Make sure the return value is non-null before
810 accessing it. The return value when C<tb> is a tied hash is a pointer to a
811 static location, so be sure to make a copy of the structure if you need to
814 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
815 information on how to use this function on tied hashes.
817 HE* hv_fetch_ent(HV* tb, SV* key, I32 lval, U32 hash)
824 Prepares a starting point to traverse a hash table. Returns the number of
825 keys in the hash (i.e. the same as C<HvKEYS(tb)>). The return value is
826 currently only meaningful for hashes without tie magic.
828 NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
829 hash buckets that happen to be in use. If you still need that esoteric
830 value, you can get it through the macro C<HvFILL(tb)>.
832 I32 hv_iterinit(HV* tb)
839 Returns the key from the current position of the hash iterator. See
842 char* hv_iterkey(HE* entry, I32* retlen)
849 Returns the key as an C<SV*> from the current position of the hash
850 iterator. The return value will always be a mortal copy of the key. Also
853 SV* hv_iterkeysv(HE* entry)
860 Returns entries from a hash iterator. See C<hv_iterinit>.
862 HE* hv_iternext(HV* tb)
869 Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
872 SV* hv_iternextsv(HV* hv, char** key, I32* retlen)
879 Returns the value from the current position of the hash iterator. See
882 SV* hv_iterval(HV* tb, HE* entry)
889 Adds magic to a hash. See C<sv_magic>.
891 void hv_magic(HV* hv, GV* gv, int how)
898 Stores an SV in a hash. The hash key is specified as C<key> and C<klen> is
899 the length of the key. The C<hash> parameter is the precomputed hash
900 value; if it is zero then Perl will compute it. The return value will be
901 NULL if the operation failed or if the value did not need to be actually
902 stored within the hash (as in the case of tied hashes). Otherwise it can
903 be dereferenced to get the original C<SV*>. Note that the caller is
904 responsible for suitably incrementing the reference count of C<val> before
905 the call, and decrementing it if the function returned NULL.
907 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
908 information on how to use this function on tied hashes.
910 SV** hv_store(HV* tb, const char* key, U32 klen, SV* val, U32 hash)
917 Stores C<val> in a hash. The hash key is specified as C<key>. The C<hash>
918 parameter is the precomputed hash value; if it is zero then Perl will
919 compute it. The return value is the new hash entry so created. It will be
920 NULL if the operation failed or if the value did not need to be actually
921 stored within the hash (as in the case of tied hashes). Otherwise the
922 contents of the return value can be accessed using the C<He???> macros
923 described here. Note that the caller is responsible for suitably
924 incrementing the reference count of C<val> before the call, and
925 decrementing it if the function returned NULL.
927 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
928 information on how to use this function on tied hashes.
930 HE* hv_store_ent(HV* tb, SV* key, SV* val, U32 hash)
939 void hv_undef(HV* tb)
946 Returns a boolean indicating whether the C C<char> is an ASCII alphanumeric
947 character (including underscore) or digit.
949 bool isALNUM(char ch)
952 Found in file handy.h
956 Returns a boolean indicating whether the C C<char> is an ASCII alphabetic
959 bool isALPHA(char ch)
962 Found in file handy.h
966 Returns a boolean indicating whether the C C<char> is an ASCII
969 bool isDIGIT(char ch)
972 Found in file handy.h
976 Returns a boolean indicating whether the C C<char> is a lowercase
979 bool isLOWER(char ch)
982 Found in file handy.h
986 Returns a boolean indicating whether the C C<char> is whitespace.
988 bool isSPACE(char ch)
991 Found in file handy.h
995 Returns a boolean indicating whether the C C<char> is an uppercase
998 bool isUPPER(char ch)
1001 Found in file handy.h
1005 Variable which is setup by C<xsubpp> to indicate the number of
1006 items on the stack. See L<perlxs/"Variable-length Parameter Lists">.
1011 Found in file XSUB.h
1015 Variable which is setup by C<xsubpp> to indicate which of an
1016 XSUB's aliases was used to invoke it. See L<perlxs/"The ALIAS: Keyword">.
1021 Found in file XSUB.h
1025 Closing bracket on a callback. See C<ENTER> and L<perlcall>.
1030 Found in file scope.h
1032 =item looks_like_number
1034 Test if an the content of an SV looks like a number (or is a
1037 I32 looks_like_number(SV* sv)
1044 Stack marker variable for the XSUB. See C<dMARK>.
1051 Clear something magical that the SV represents. See C<sv_magic>.
1053 int mg_clear(SV* sv)
1060 Copies the magic from one SV to another. See C<sv_magic>.
1062 int mg_copy(SV* sv, SV* nsv, const char* key, I32 klen)
1069 Finds the magic pointer for type matching the SV. See C<sv_magic>.
1071 MAGIC* mg_find(SV* sv, int type)
1078 Free any magic storage used by the SV. See C<sv_magic>.
1087 Do magic after a value is retrieved from the SV. See C<sv_magic>.
1096 Report on the SV's length. See C<sv_magic>.
1098 U32 mg_length(SV* sv)
1105 Turns on the magical status of an SV. See C<sv_magic>.
1107 void mg_magical(SV* sv)
1114 Do magic after a value is assigned to the SV. See C<sv_magic>.
1123 The XSUB-writer's interface to the C C<memmove> function. The C<src> is the
1124 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1125 the type. Can do overlapping moves. See also C<Copy>.
1127 void Move(void* src, void* dest, int nitems, type)
1130 Found in file handy.h
1134 The XSUB-writer's interface to the C C<malloc> function.
1136 void New(int id, void* ptr, int nitems, type)
1139 Found in file handy.h
1143 Creates a new AV. The reference count is set to 1.
1152 The XSUB-writer's interface to the C C<malloc> function, with
1155 void Newc(int id, void* ptr, int nitems, type, cast)
1158 Found in file handy.h
1162 Creates a constant sub equivalent to Perl C<sub FOO () { 123 }> which is
1163 eligible for inlining at compile-time.
1165 void newCONSTSUB(HV* stash, char* name, SV* sv)
1172 Creates a new HV. The reference count is set to 1.
1181 Creates an RV wrapper for an SV. The reference count for the original SV is
1184 SV* newRV_inc(SV* sv)
1191 Creates an RV wrapper for an SV. The reference count for the original
1192 SV is B<not> incremented.
1194 SV* newRV_noinc(SV *sv)
1201 Creates a new SV. A non-zero C<len> parameter indicates the number of
1202 bytes of preallocated string space the SV should have. An extra byte for a
1203 tailing NUL is also reserved. (SvPOK is not set for the SV even if string
1204 space is allocated.) The reference count for the new SV is set to 1.
1205 C<id> is an integer id between 0 and 1299 (used to identify leaks).
1207 SV* NEWSV(int id, STRLEN len)
1210 Found in file handy.h
1214 Creates a new SV and copies an integer into it. The reference count for the
1224 Creates a new SV and copies a floating point value into it.
1225 The reference count for the SV is set to 1.
1234 Creates a new SV and copies a string into it. The reference count for the
1235 SV is set to 1. If C<len> is zero, Perl will compute the length using
1236 strlen(). For efficiency, consider using C<newSVpvn> instead.
1238 SV* newSVpv(const char* s, STRLEN len)
1245 Creates a new SV an initialize it with the string formatted like
1248 SV* newSVpvf(const char* pat, ...)
1255 Creates a new SV and copies a string into it. The reference count for the
1256 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
1257 string. You are responsible for ensuring that the source string is at least
1260 SV* newSVpvn(const char* s, STRLEN len)
1267 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
1268 it will be upgraded to one. If C<classname> is non-null then the new SV will
1269 be blessed in the specified package. The new SV is returned and its
1270 reference count is 1.
1272 SV* newSVrv(SV* rv, const char* classname)
1279 Creates a new SV which is an exact duplicate of the original SV.
1281 SV* newSVsv(SV* old)
1288 Creates a new SV and copies an unsigned integer into it.
1289 The reference count for the SV is set to 1.
1298 Used by C<xsubpp> to hook up XSUBs as Perl subs.
1305 Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
1309 Found in file XSUB.h
1313 The XSUB-writer's interface to the C C<malloc> function. The allocated
1314 memory is zeroed with C<memzero>.
1316 void Newz(int id, void* ptr, int nitems, type)
1319 Found in file handy.h
1330 Null character pointer.
1333 Found in file handy.h
1354 Found in file handy.h
1358 The original stack mark for the XSUB. See C<dORIGMARK>.
1365 Allocates a new Perl interpreter. See L<perlembed>.
1367 PerlInterpreter* perl_alloc()
1370 Found in file perl.c
1372 =item perl_construct
1374 Initializes a new Perl interpreter. See L<perlembed>.
1376 void perl_construct(PerlInterpreter* interp)
1379 Found in file perl.c
1383 Shuts down a Perl interpreter. See L<perlembed>.
1385 void perl_destruct(PerlInterpreter* interp)
1388 Found in file perl.c
1392 Releases a Perl interpreter. See L<perlembed>.
1394 void perl_free(PerlInterpreter* interp)
1397 Found in file perl.c
1401 Tells a Perl interpreter to parse a Perl script. See L<perlembed>.
1403 int perl_parse(PerlInterpreter* interp, XSINIT_t xsinit, int argc, char** argv, char** env)
1406 Found in file perl.c
1410 Tells a Perl interpreter to run. See L<perlembed>.
1412 int perl_run(PerlInterpreter* interp)
1415 Found in file perl.c
1419 When Perl is run in debugging mode, with the B<-d> switch, this SV is a
1420 boolean which indicates whether subs are being single-stepped.
1421 Single-stepping is automatically turned on after every step. This is the C
1422 variable which corresponds to Perl's $DB::single variable. See
1428 Found in file intrpvar.h
1432 When Perl is run in debugging mode, with the B<-d> switch, this GV contains
1433 the SV which holds the name of the sub being debugged. This is the C
1434 variable which corresponds to Perl's $DB::sub variable. See
1440 Found in file intrpvar.h
1444 Trace variable used when Perl is run in debugging mode, with the B<-d>
1445 switch. This is the C variable which corresponds to Perl's $DB::trace
1446 variable. See C<PL_DBsingle>.
1451 Found in file intrpvar.h
1455 The C variable which corresponds to Perl's $^W warning variable.
1460 Found in file intrpvar.h
1464 C<PL_modglobal> is a general purpose, interpreter global HV for use by
1465 extensions that need to keep information on a per-interpreter basis.
1466 In a pinch, it can also be used as a symbol table for extensions
1467 to share data among each other. It is a good idea to use keys
1468 prefixed by the package name of the extension that owns the data.
1473 Found in file intrpvar.h
1477 A convenience variable which is typically used with C<SvPV> when one
1478 doesn't care about the length of the string. It is usually more efficient
1479 to either declare a local variable and use that instead or to use the
1480 C<SvPV_nolen> macro.
1485 Found in file thrdvar.h
1489 This is the C<false> SV. See C<PL_sv_yes>. Always refer to this as
1495 Found in file intrpvar.h
1499 This is the C<undef> SV. Always refer to this as C<&PL_sv_undef>.
1504 Found in file intrpvar.h
1508 This is the C<true> SV. See C<PL_sv_no>. Always refer to this as
1514 Found in file intrpvar.h
1518 Pops an integer off the stack.
1527 Pops a long off the stack.
1536 Pops a double off the stack.
1545 Pops a string off the stack.
1554 Pops an SV off the stack.
1563 Push an integer onto the stack. The stack must have room for this element.
1564 Handles 'set' magic. See C<XPUSHi>.
1573 Opening bracket for arguments on a callback. See C<PUTBACK> and
1583 Push a double onto the stack. The stack must have room for this element.
1584 Handles 'set' magic. See C<XPUSHn>.
1593 Push a string onto the stack. The stack must have room for this element.
1594 The C<len> indicates the length of the string. Handles 'set' magic. See
1597 void PUSHp(char* str, STRLEN len)
1604 Push an SV onto the stack. The stack must have room for this element.
1605 Does not handle 'set' magic. See C<XPUSHs>.
1614 Push an unsigned integer onto the stack. The stack must have room for this
1615 element. See C<XPUSHu>.
1624 Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
1625 See C<PUSHMARK> and L<perlcall> for other uses.
1634 The XSUB-writer's interface to the C C<realloc> function.
1636 void Renew(void* ptr, int nitems, type)
1639 Found in file handy.h
1643 The XSUB-writer's interface to the C C<realloc> function, with
1646 void Renewc(void* ptr, int nitems, type, cast)
1649 Found in file handy.h
1653 Tells Perl to C<require> a module.
1655 NOTE: the perl_ form of this function is deprecated.
1657 void require_pv(const char* pv)
1660 Found in file perl.c
1664 Variable which is setup by C<xsubpp> to hold the return value for an
1665 XSUB. This is always the proper type for the XSUB. See
1666 L<perlxs/"The RETVAL Variable">.
1671 Found in file XSUB.h
1675 The XSUB-writer's interface to the C C<free> function.
1677 void Safefree(void* ptr)
1680 Found in file handy.h
1684 Copy a string to a safe spot. This does not use an SV.
1686 char* savepv(const char* sv)
1689 Found in file util.c
1693 Copy a string to a safe spot. The C<len> indicates number of bytes to
1694 copy. This does not use an SV.
1696 char* savepvn(const char* sv, I32 len)
1699 Found in file util.c
1703 Opening bracket for temporaries on a callback. See C<FREETMPS> and
1709 Found in file scope.h
1713 Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and
1721 Refetch the stack pointer. Used after a callback. See L<perlcall>.
1730 Used to access elements on the XSUB's stack.
1735 Found in file XSUB.h
1739 Test two strings to see if they are equal. Returns true or false.
1741 bool strEQ(char* s1, char* s2)
1744 Found in file handy.h
1748 Test two strings to see if the first, C<s1>, is greater than or equal to
1749 the second, C<s2>. Returns true or false.
1751 bool strGE(char* s1, char* s2)
1754 Found in file handy.h
1758 Test two strings to see if the first, C<s1>, is greater than the second,
1759 C<s2>. Returns true or false.
1761 bool strGT(char* s1, char* s2)
1764 Found in file handy.h
1768 Test two strings to see if the first, C<s1>, is less than or equal to the
1769 second, C<s2>. Returns true or false.
1771 bool strLE(char* s1, char* s2)
1774 Found in file handy.h
1778 Test two strings to see if the first, C<s1>, is less than the second,
1779 C<s2>. Returns true or false.
1781 bool strLT(char* s1, char* s2)
1784 Found in file handy.h
1788 Test two strings to see if they are different. Returns true or
1791 bool strNE(char* s1, char* s2)
1794 Found in file handy.h
1798 Test two strings to see if they are equal. The C<len> parameter indicates
1799 the number of bytes to compare. Returns true or false. (A wrapper for
1802 bool strnEQ(char* s1, char* s2, STRLEN len)
1805 Found in file handy.h
1809 Test two strings to see if they are different. The C<len> parameter
1810 indicates the number of bytes to compare. Returns true or false. (A
1811 wrapper for C<strncmp>).
1813 bool strnNE(char* s1, char* s2, STRLEN len)
1816 Found in file handy.h
1820 This is an architecture-independent macro to copy one structure to another.
1822 void StructCopy(type src, type dest, type)
1825 Found in file handy.h
1829 Returns the length of the string which is in the SV. See C<SvLEN>.
1831 STRLEN SvCUR(SV* sv)
1838 Set the length of the string which is in the SV. See C<SvCUR>.
1840 void SvCUR_set(SV* sv, STRLEN len)
1847 Returns a pointer to the last character in the string which is in the SV.
1848 See C<SvCUR>. Access the character as *(SvEND(sv)).
1857 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
1858 argument more than once.
1860 void SvGETMAGIC(SV* sv)
1867 Expands the character buffer in the SV so that it has room for the
1868 indicated number of bytes (remember to reserve space for an extra trailing
1869 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
1870 Returns a pointer to the character buffer.
1872 void SvGROW(SV* sv, STRLEN len)
1879 Returns a boolean indicating whether the SV contains an integer.
1888 Returns a boolean indicating whether the SV contains an integer. Checks
1889 the B<private> setting. Use C<SvIOK>.
1898 Unsets the IV status of an SV.
1900 void SvIOK_off(SV* sv)
1907 Tells an SV that it is an integer.
1909 void SvIOK_on(SV* sv)
1916 Tells an SV that it is an integer and disables all other OK bits.
1918 void SvIOK_only(SV* sv)
1925 Coerces the given SV to an integer and returns it.
1934 Returns the integer which is stored in the SV, assuming SvIOK is
1944 Returns the size of the string buffer in the SV. See C<SvCUR>.
1946 STRLEN SvLEN(SV* sv)
1953 Returns a boolean indicating whether the SV contains a number, integer or
1963 Returns a boolean indicating whether the SV contains a number, integer or
1964 double. Checks the B<private> setting. Use C<SvNIOK>.
1966 bool SvNIOKp(SV* sv)
1973 Unsets the NV/IV status of an SV.
1975 void SvNIOK_off(SV* sv)
1982 Returns a boolean indicating whether the SV contains a double.
1991 Returns a boolean indicating whether the SV contains a double. Checks the
1992 B<private> setting. Use C<SvNOK>.
2001 Unsets the NV status of an SV.
2003 void SvNOK_off(SV* sv)
2010 Tells an SV that it is a double.
2012 void SvNOK_on(SV* sv)
2019 Tells an SV that it is a double and disables all other OK bits.
2021 void SvNOK_only(SV* sv)
2028 Coerce the given SV to a double and return it.
2037 Returns the double which is stored in the SV, assuming SvNOK is
2047 Returns a boolean indicating whether the value is an SV.
2056 Returns a boolean indicating whether the SvIVX is a valid offset value for
2057 the SvPVX. This hack is used internally to speed up removal of characters
2058 from the beginning of a SvPV. When SvOOK is true, then the start of the
2059 allocated string buffer is really (SvPVX - SvIVX).
2068 Returns a boolean indicating whether the SV contains a character
2078 Returns a boolean indicating whether the SV contains a character string.
2079 Checks the B<private> setting. Use C<SvPOK>.
2088 Unsets the PV status of an SV.
2090 void SvPOK_off(SV* sv)
2097 Tells an SV that it is a string.
2099 void SvPOK_on(SV* sv)
2106 Tells an SV that it is a string and disables all other OK bits.
2108 void SvPOK_only(SV* sv)
2115 Returns a pointer to the string in the SV, or a stringified form of the SV
2116 if the SV does not contain a string. Handles 'get' magic.
2118 char* SvPV(SV* sv, STRLEN len)
2125 Returns a pointer to the string in the SV. The SV must contain a
2135 Like <SvPV> but will force the SV into becoming a string (SvPOK). You want
2136 force if you are going to update the SvPVX directly.
2138 char* SvPV_force(SV* sv, STRLEN len)
2145 Returns a pointer to the string in the SV, or a stringified form of the SV
2146 if the SV does not contain a string. Handles 'get' magic.
2148 char* SvPV_nolen(SV* sv)
2155 Returns the value of the object's reference count.
2157 U32 SvREFCNT(SV* sv)
2164 Decrements the reference count of the given SV.
2166 void SvREFCNT_dec(SV* sv)
2173 Increments the reference count of the given SV.
2175 SV* SvREFCNT_inc(SV* sv)
2182 Tests if the SV is an RV.
2191 Unsets the RV status of an SV.
2193 void SvROK_off(SV* sv)
2200 Tells an SV that it is an RV.
2202 void SvROK_on(SV* sv)
2209 Dereferences an RV to return the SV.
2218 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
2219 argument more than once.
2221 void SvSETMAGIC(SV* sv)
2228 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
2231 void SvSetSV(SV* dsb, SV* ssv)
2236 =item SvSetSV_nosteal
2238 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
2239 ssv. May evaluate arguments more than once.
2241 void SvSetSV_nosteal(SV* dsv, SV* ssv)
2248 Returns the stash of the SV.
2257 Taints an SV if tainting is enabled
2259 void SvTAINT(SV* sv)
2266 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
2269 bool SvTAINTED(SV* sv)
2276 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
2277 some of Perl's fundamental security features. XS module authors should not
2278 use this function unless they fully understand all the implications of
2279 unconditionally untainting the value. Untainting should be done in the
2280 standard perl fashion, via a carefully crafted regexp, rather than directly
2281 untainting variables.
2283 void SvTAINTED_off(SV* sv)
2290 Marks an SV as tainted.
2292 void SvTAINTED_on(SV* sv)
2299 Returns a boolean indicating whether Perl would evaluate the SV as true or
2300 false, defined or undefined. Does not handle 'get' magic.
2309 An enum of flags for Perl types. These are found in the file B<sv.h>
2310 in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
2317 Returns the type of the SV. See C<svtype>.
2319 svtype SvTYPE(SV* sv)
2326 Integer type flag for scalars. See C<svtype>.
2333 Double type flag for scalars. See C<svtype>.
2340 Pointer type flag for scalars. See C<svtype>.
2347 Type flag for arrays. See C<svtype>.
2354 Type flag for code refs. See C<svtype>.
2361 Type flag for hashes. See C<svtype>.
2368 Type flag for blessed scalars. See C<svtype>.
2375 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
2376 perform the upgrade if necessary. See C<svtype>.
2378 void SvUPGRADE(SV* sv, svtype type)
2385 Coerces the given SV to an unsigned integer and returns it.
2394 Returns the unsigned integer which is stored in the SV, assuming SvIOK is
2404 Marks an SV as mortal. The SV will be destroyed when the current context
2407 SV* sv_2mortal(SV* sv)
2414 Blesses an SV into a specified package. The SV must be an RV. The package
2415 must be designated by its stash (see C<gv_stashpv()>). The reference count
2416 of the SV is unaffected.
2418 SV* sv_bless(SV* sv, HV* stash)
2425 Concatenates the string onto the end of the string which is in the SV.
2426 Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
2428 void sv_catpv(SV* sv, const char* ptr)
2435 Processes its arguments like C<sprintf> and appends the formatted output
2436 to an SV. Handles 'get' magic, but not 'set' magic. C<SvSETMAGIC()> must
2437 typically be called after calling this function to handle 'set' magic.
2439 void sv_catpvf(SV* sv, const char* pat, ...)
2446 Like C<sv_catpvf>, but also handles 'set' magic.
2448 void sv_catpvf_mg(SV *sv, const char* pat, ...)
2455 Concatenates the string onto the end of the string which is in the SV. The
2456 C<len> indicates number of bytes to copy. Handles 'get' magic, but not
2457 'set' magic. See C<sv_catpvn_mg>.
2459 void sv_catpvn(SV* sv, const char* ptr, STRLEN len)
2466 Like C<sv_catpvn>, but also handles 'set' magic.
2468 void sv_catpvn_mg(SV *sv, const char *ptr, STRLEN len)
2475 Like C<sv_catpv>, but also handles 'set' magic.
2477 void sv_catpv_mg(SV *sv, const char *ptr)
2484 Concatenates the string from SV C<ssv> onto the end of the string in SV
2485 C<dsv>. Handles 'get' magic, but not 'set' magic. See C<sv_catsv_mg>.
2487 void sv_catsv(SV* dsv, SV* ssv)
2494 Like C<sv_catsv>, but also handles 'set' magic.
2496 void sv_catsv_mg(SV *dstr, SV *sstr)
2503 Efficient removal of characters from the beginning of the string buffer.
2504 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
2505 the string buffer. The C<ptr> becomes the first character of the adjusted
2508 void sv_chop(SV* sv, char* ptr)
2515 Clear an SV, making it empty. Does not free the memory used by the SV
2518 void sv_clear(SV* sv)
2525 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
2526 string in C<sv1> is less than, equal to, or greater than the string in
2529 I32 sv_cmp(SV* sv1, SV* sv2)
2536 Compares the strings in two SVs in a locale-aware manner. See
2539 I32 sv_cmp_locale(SV* sv1, SV* sv2)
2546 Auto-decrement of the value in the SV.
2553 =item sv_derived_from
2555 Returns a boolean indicating whether the SV is derived from the specified
2556 class. This is the function that implements C<UNIVERSAL::isa>. It works
2557 for class names as well as for objects.
2559 bool sv_derived_from(SV* sv, const char* name)
2562 Found in file universal.c
2566 Returns a boolean indicating whether the strings in the two SVs are
2569 I32 sv_eq(SV* sv1, SV* sv2)
2576 Free the memory used by an SV.
2578 void sv_free(SV* sv)
2585 Get a line from the filehandle and store it into the SV, optionally
2586 appending to the currently-stored string.
2588 char* sv_gets(SV* sv, PerlIO* fp, I32 append)
2595 Expands the character buffer in the SV. This will use C<sv_unref> and will
2596 upgrade the SV to C<SVt_PV>. Returns a pointer to the character buffer.
2599 char* sv_grow(SV* sv, STRLEN newlen)
2606 Auto-increment of the value in the SV.
2615 Inserts a string at the specified offset/length within the SV. Similar to
2616 the Perl substr() function.
2618 void sv_insert(SV* bigsv, STRLEN offset, STRLEN len, char* little, STRLEN littlelen)
2625 Returns a boolean indicating whether the SV is blessed into the specified
2626 class. This does not check for subtypes; use C<sv_derived_from> to verify
2627 an inheritance relationship.
2629 int sv_isa(SV* sv, const char* name)
2636 Returns a boolean indicating whether the SV is an RV pointing to a blessed
2637 object. If the SV is not an RV, or if the object is not blessed, then this
2640 int sv_isobject(SV* sv)
2647 Returns the length of the string in the SV. See also C<SvCUR>.
2649 STRLEN sv_len(SV* sv)
2656 Returns the number of characters in the string in an SV, counting wide
2657 UTF8 bytes as a single character.
2659 STRLEN sv_len_utf8(SV* sv)
2666 Adds magic to an SV.
2668 void sv_magic(SV* sv, SV* obj, int how, const char* name, I32 namlen)
2675 Creates a new SV which is a copy of the original SV. The new SV is marked
2678 SV* sv_mortalcopy(SV* oldsv)
2685 Creates a new SV which is mortal. The reference count of the SV is set to 1.
2694 Get a sensible string out of the SV somehow.
2696 char* sv_pvn_force(SV* sv, STRLEN* lp)
2701 =item sv_pvutf8n_force
2703 Get a sensible UTF8-encoded string out of the SV somehow. See
2706 char* sv_pvutf8n_force(SV* sv, STRLEN* lp)
2713 Returns a string describing what the SV is a reference to.
2715 char* sv_reftype(SV* sv, int ob)
2722 Make the first argument a copy of the second, then delete the original.
2724 void sv_replace(SV* sv, SV* nsv)
2733 SV* sv_rvweaken(SV *sv)
2740 Copies an integer into the given SV. Does not handle 'set' magic. See
2743 void sv_setiv(SV* sv, IV num)
2750 Like C<sv_setiv>, but also handles 'set' magic.
2752 void sv_setiv_mg(SV *sv, IV i)
2759 Copies a double into the given SV. Does not handle 'set' magic. See
2762 void sv_setnv(SV* sv, NV num)
2769 Like C<sv_setnv>, but also handles 'set' magic.
2771 void sv_setnv_mg(SV *sv, NV num)
2778 Copies a string into an SV. The string must be null-terminated. Does not
2779 handle 'set' magic. See C<sv_setpv_mg>.
2781 void sv_setpv(SV* sv, const char* ptr)
2788 Processes its arguments like C<sprintf> and sets an SV to the formatted
2789 output. Does not handle 'set' magic. See C<sv_setpvf_mg>.
2791 void sv_setpvf(SV* sv, const char* pat, ...)
2798 Like C<sv_setpvf>, but also handles 'set' magic.
2800 void sv_setpvf_mg(SV *sv, const char* pat, ...)
2807 Copies an integer into the given SV, also updating its string value.
2808 Does not handle 'set' magic. See C<sv_setpviv_mg>.
2810 void sv_setpviv(SV* sv, IV num)
2817 Like C<sv_setpviv>, but also handles 'set' magic.
2819 void sv_setpviv_mg(SV *sv, IV iv)
2826 Copies a string into an SV. The C<len> parameter indicates the number of
2827 bytes to be copied. Does not handle 'set' magic. See C<sv_setpvn_mg>.
2829 void sv_setpvn(SV* sv, const char* ptr, STRLEN len)
2836 Like C<sv_setpvn>, but also handles 'set' magic.
2838 void sv_setpvn_mg(SV *sv, const char *ptr, STRLEN len)
2845 Like C<sv_setpv>, but also handles 'set' magic.
2847 void sv_setpv_mg(SV *sv, const char *ptr)
2854 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
2855 argument will be upgraded to an RV. That RV will be modified to point to
2856 the new SV. The C<classname> argument indicates the package for the
2857 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
2858 will be returned and will have a reference count of 1.
2860 SV* sv_setref_iv(SV* rv, const char* classname, IV iv)
2867 Copies a double into a new SV, optionally blessing the SV. The C<rv>
2868 argument will be upgraded to an RV. That RV will be modified to point to
2869 the new SV. The C<classname> argument indicates the package for the
2870 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
2871 will be returned and will have a reference count of 1.
2873 SV* sv_setref_nv(SV* rv, const char* classname, NV nv)
2880 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
2881 argument will be upgraded to an RV. That RV will be modified to point to
2882 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
2883 into the SV. The C<classname> argument indicates the package for the
2884 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
2885 will be returned and will have a reference count of 1.
2887 Do not use with other Perl types such as HV, AV, SV, CV, because those
2888 objects will become corrupted by the pointer copy process.
2890 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
2892 SV* sv_setref_pv(SV* rv, const char* classname, void* pv)
2899 Copies a string into a new SV, optionally blessing the SV. The length of the
2900 string must be specified with C<n>. The C<rv> argument will be upgraded to
2901 an RV. That RV will be modified to point to the new SV. The C<classname>
2902 argument indicates the package for the blessing. Set C<classname> to
2903 C<Nullch> to avoid the blessing. The new SV will be returned and will have
2904 a reference count of 1.
2906 Note that C<sv_setref_pv> copies the pointer while this copies the string.
2908 SV* sv_setref_pvn(SV* rv, const char* classname, char* pv, STRLEN n)
2915 Copies the contents of the source SV C<ssv> into the destination SV C<dsv>.
2916 The source SV may be destroyed if it is mortal. Does not handle 'set'
2917 magic. See the macro forms C<SvSetSV>, C<SvSetSV_nosteal> and
2920 void sv_setsv(SV* dsv, SV* ssv)
2927 Like C<sv_setsv>, but also handles 'set' magic.
2929 void sv_setsv_mg(SV *dstr, SV *sstr)
2936 Copies an unsigned integer into the given SV. Does not handle 'set' magic.
2939 void sv_setuv(SV* sv, UV num)
2946 Like C<sv_setuv>, but also handles 'set' magic.
2948 void sv_setuv_mg(SV *sv, UV u)
2955 Returns true if the SV has a true value by Perl's rules.
2964 Removes magic from an SV.
2966 int sv_unmagic(SV* sv, int type)
2973 Unsets the RV status of the SV, and decrements the reference count of
2974 whatever was being referenced by the RV. This can almost be thought of
2975 as a reversal of C<newSVrv>. See C<SvROK_off>.
2977 void sv_unref(SV* sv)
2984 Upgrade an SV to a more complex form. Use C<SvUPGRADE>. See
2987 bool sv_upgrade(SV* sv, U32 mt)
2994 Tells an SV to use C<ptr> to find its string value. Normally the string is
2995 stored inside the SV but sv_usepvn allows the SV to use an outside string.
2996 The C<ptr> should point to memory that was allocated by C<malloc>. The
2997 string length, C<len>, must be supplied. This function will realloc the
2998 memory pointed to by C<ptr>, so that pointer should not be freed or used by
2999 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
3000 See C<sv_usepvn_mg>.
3002 void sv_usepvn(SV* sv, char* ptr, STRLEN len)
3009 Like C<sv_usepvn>, but also handles 'set' magic.
3011 void sv_usepvn_mg(SV *sv, char *ptr, STRLEN len)
3016 =item sv_utf8_downgrade
3018 Attempt to convert the PV of an SV from UTF8-encoded to byte encoding.
3019 This may not be possible if the PV contains non-byte encoding characters;
3020 if this is the case, either returns false or, if C<fail_ok> is not
3023 NOTE: this function is experimental and may change or be
3024 removed without notice.
3026 bool sv_utf8_downgrade(SV *sv, bool fail_ok)
3031 =item sv_utf8_encode
3033 Convert the PV of an SV to UTF8-encoded, but then turn off the C<SvUTF8>
3034 flag so that it looks like bytes again. Nothing calls this.
3036 NOTE: this function is experimental and may change or be
3037 removed without notice.
3039 void sv_utf8_encode(SV *sv)
3044 =item sv_utf8_upgrade
3046 Convert the PV of an SV to its UTF8-encoded form.
3048 void sv_utf8_upgrade(SV *sv)
3055 Processes its arguments like C<vsprintf> and appends the formatted output
3056 to an SV. Uses an array of SVs if the C style variable argument list is
3057 missing (NULL). When running with taint checks enabled, indicates via
3058 C<maybe_tainted> if results are untrustworthy (often due to the use of
3061 void sv_vcatpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
3068 Works like C<vcatpvfn> but copies the text into the SV instead of
3071 void sv_vsetpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
3078 Variable which is setup by C<xsubpp> to designate the object in a C++
3079 XSUB. This is always the proper type for the C++ object. See C<CLASS> and
3080 L<perlxs/"Using XS With C++">.
3085 Found in file XSUB.h
3089 Converts the specified character to lowercase.
3091 char toLOWER(char ch)
3094 Found in file handy.h
3098 Converts the specified character to uppercase.
3100 char toUPPER(char ch)
3103 Found in file handy.h
3107 Returns true if first C<len> bytes of the given string form valid a UTF8
3108 string, false otherwise.
3110 bool_utf8_string U8 *s(STRLEN len)
3113 Found in file utf8.c
3117 Converts a string C<s> of length C<len> from UTF8 into ASCII encoding.
3118 Unlike C<bytes_to_utf8>, this over-writes the original string.
3119 Returns zero on failure after converting as much as possible.
3121 U8 * utf8_to_bytes(U8 *s, STRLEN len)
3124 Found in file utf8.c
3128 This is the XSUB-writer's interface to Perl's C<warn> function. Use this
3129 function the same way you use the C C<printf> function. See
3132 void warn(const char* pat, ...)
3135 Found in file util.c
3139 Push an integer onto the stack, extending the stack if necessary. Handles
3140 'set' magic. See C<PUSHi>.
3149 Push a double onto the stack, extending the stack if necessary. Handles
3150 'set' magic. See C<PUSHn>.
3159 Push a string onto the stack, extending the stack if necessary. The C<len>
3160 indicates the length of the string. Handles 'set' magic. See
3163 void XPUSHp(char* str, STRLEN len)
3170 Push an SV onto the stack, extending the stack if necessary. Does not
3171 handle 'set' magic. See C<PUSHs>.
3180 Push an unsigned integer onto the stack, extending the stack if necessary.
3190 Macro to declare an XSUB and its C parameter list. This is handled by
3194 Found in file XSUB.h
3198 Return from XSUB, indicating number of items on the stack. This is usually
3199 handled by C<xsubpp>.
3201 void XSRETURN(int nitems)
3204 Found in file XSUB.h
3206 =item XSRETURN_EMPTY
3208 Return an empty list from an XSUB immediately.
3213 Found in file XSUB.h
3217 Return an integer from an XSUB immediately. Uses C<XST_mIV>.
3219 void XSRETURN_IV(IV iv)
3222 Found in file XSUB.h
3226 Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
3231 Found in file XSUB.h
3235 Return an double from an XSUB immediately. Uses C<XST_mNV>.
3237 void XSRETURN_NV(NV nv)
3240 Found in file XSUB.h
3244 Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
3246 void XSRETURN_PV(char* str)
3249 Found in file XSUB.h
3251 =item XSRETURN_UNDEF
3253 Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
3258 Found in file XSUB.h
3262 Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
3267 Found in file XSUB.h
3271 Place an integer into the specified position C<pos> on the stack. The
3272 value is stored in a new mortal SV.
3274 void XST_mIV(int pos, IV iv)
3277 Found in file XSUB.h
3281 Place C<&PL_sv_no> into the specified position C<pos> on the
3284 void XST_mNO(int pos)
3287 Found in file XSUB.h
3291 Place a double into the specified position C<pos> on the stack. The value
3292 is stored in a new mortal SV.
3294 void XST_mNV(int pos, NV nv)
3297 Found in file XSUB.h
3301 Place a copy of a string into the specified position C<pos> on the stack.
3302 The value is stored in a new mortal SV.
3304 void XST_mPV(int pos, char* str)
3307 Found in file XSUB.h
3311 Place C<&PL_sv_undef> into the specified position C<pos> on the
3314 void XST_mUNDEF(int pos)
3317 Found in file XSUB.h
3321 Place C<&PL_sv_yes> into the specified position C<pos> on the
3324 void XST_mYES(int pos)
3327 Found in file XSUB.h
3331 The version identifier for an XS module. This is usually
3332 handled automatically by C<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>.
3335 Found in file XSUB.h
3337 =item XS_VERSION_BOOTCHECK
3339 Macro to verify that a PM module's $VERSION variable matches the XS
3340 module's C<XS_VERSION> variable. This is usually handled automatically by
3341 C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">.
3343 XS_VERSION_BOOTCHECK;
3346 Found in file XSUB.h
3350 The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the
3351 destination, C<nitems> is the number of items, and C<type> is the type.
3353 void Zero(void* dest, int nitems, type)
3356 Found in file handy.h
3362 Until May 1997, this document was maintained by Jeff Okamoto
3363 <okamoto@corp.hp.com>. It is now maintained as part of Perl itself.
3365 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
3366 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
3367 Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
3368 Stephen McCamant, and Gurusamy Sarathy.
3370 API Listing originally by Dean Roehrich <roehrich@cray.com>.
3372 Updated to be autogenerated from comments in the source by Benjamin Stuhl.
3376 perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
projects / p5sagit/p5-mst-13.2.git / blob