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)
185 =item bytes_from_utf8
187 Converts a string C<s> of length C<len> from UTF8 into byte encoding.
188 Unlike <utf8_to_bytes> but like C<bytes_to_utf8>, returns a pointer to
189 the newly-created string, and updates C<len> to contain the new
190 length. Returns the original string if no conversion occurs, C<len>
191 is unchanged. Do nothing if C<is_utf8> points to 0. Sets C<is_utf8> to
192 0 if C<s> is converted or contains all 7bit characters.
194 NOTE: this function is experimental and may change or be
195 removed without notice.
197 U8* bytes_from_utf8(U8 *s, STRLEN *len, bool *is_utf8)
204 Converts a string C<s> of length C<len> from ASCII into UTF8 encoding.
205 Returns a pointer to the newly-created string, and sets C<len> to
206 reflect the new length.
208 NOTE: this function is experimental and may change or be
209 removed without notice.
211 U8* bytes_to_utf8(U8 *s, STRLEN *len)
218 Performs a callback to the specified Perl sub. See L<perlcall>.
220 NOTE: the perl_ form of this function is deprecated.
222 I32 call_argv(const char* sub_name, I32 flags, char** argv)
229 Performs a callback to the specified Perl method. The blessed object must
230 be on the stack. See L<perlcall>.
232 NOTE: the perl_ form of this function is deprecated.
234 I32 call_method(const char* methname, I32 flags)
241 Performs a callback to the specified Perl sub. See L<perlcall>.
243 NOTE: the perl_ form of this function is deprecated.
245 I32 call_pv(const char* sub_name, I32 flags)
252 Performs a callback to the Perl sub whose name is in the SV. See
255 NOTE: the perl_ form of this function is deprecated.
257 I32 call_sv(SV* sv, I32 flags)
264 Variable which is setup by C<xsubpp> to indicate the
265 class name for a C++ XS constructor. This is always a C<char*>. See C<THIS>.
274 The XSUB-writer's interface to the C C<memcpy> function. The C<src> is the
275 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
276 the type. May fail on overlapping copies. See also C<Move>.
278 void Copy(void* src, void* dest, int nitems, type)
281 Found in file handy.h
285 This is the XSUB-writer's interface to Perl's C<die> function.
286 Normally use this function the same way you use the C C<printf>
287 function. See C<warn>.
289 If you want to throw an exception object, assign the object to
290 C<$@> and then pass C<Nullch> to croak():
292 errsv = get_sv("@", TRUE);
293 sv_setsv(errsv, exception_object);
296 void croak(const char* pat, ...)
303 Returns the stash of the CV.
312 If C<cv> is a constant sub eligible for inlining. returns the constant
313 value returned by the sub. Otherwise, returns NULL.
315 Constant subs can be created with C<newCONSTSUB> or as described in
316 L<perlsub/"Constant Functions">.
318 SV* cv_const_sv(CV* cv)
325 Declare a stack marker variable, C<mark>, for the XSUB. See C<MARK> and
335 Saves the original stack mark for the XSUB. See C<ORIGMARK>.
344 Declares a local copy of perl's stack pointer for the XSUB, available via
345 the C<SP> macro. See C<SP>.
354 Sets up stack and mark pointers for an XSUB, calling dSP and dMARK. This
355 is usually handled automatically by C<xsubpp>. Declares the C<items>
356 variable to indicate the number of items on the stack.
365 Sets up the C<ix> variable for an XSUB which has aliases. This is usually
366 handled automatically by C<xsubpp>.
375 Opening bracket on a callback. See C<LEAVE> and L<perlcall>.
380 Found in file scope.h
384 Tells Perl to C<eval> the given string and return an SV* result.
386 NOTE: the perl_ form of this function is deprecated.
388 SV* eval_pv(const char* p, I32 croak_on_error)
395 Tells Perl to C<eval> the string in the SV.
397 NOTE: the perl_ form of this function is deprecated.
399 I32 eval_sv(SV* sv, I32 flags)
406 Used to extend the argument stack for an XSUB's return values. Once
407 used, guarantees that there is room for at least C<nitems> to be pushed
410 void EXTEND(SP, int nitems)
417 Analyses the string in order to make fast searches on it using fbm_instr()
418 -- the Boyer-Moore algorithm.
420 void fbm_compile(SV* sv, U32 flags)
427 Returns the location of the SV in the string delimited by C<str> and
428 C<strend>. It returns C<Nullch> if the string can't be found. The C<sv>
429 does not have to be fbm_compiled, but the search will not be as fast
432 char* fbm_instr(unsigned char* big, unsigned char* bigend, SV* littlesv, U32 flags)
439 Closing bracket for temporaries on a callback. See C<SAVETMPS> and
445 Found in file scope.h
449 Returns the AV of the specified Perl array. If C<create> is set and the
450 Perl variable does not exist then it will be created. If C<create> is not
451 set and the variable does not exist then NULL is returned.
453 NOTE: the perl_ form of this function is deprecated.
455 AV* get_av(const char* name, I32 create)
462 Returns the CV of the specified Perl subroutine. If C<create> is set and
463 the Perl subroutine does not exist then it will be declared (which has the
464 same effect as saying C<sub name;>). If C<create> is not set and the
465 subroutine does not exist then NULL is returned.
467 NOTE: the perl_ form of this function is deprecated.
469 CV* get_cv(const char* name, I32 create)
476 Returns the HV of the specified Perl hash. If C<create> is set and the
477 Perl variable does not exist then it will be created. If C<create> is not
478 set and the variable does not exist then NULL is returned.
480 NOTE: the perl_ form of this function is deprecated.
482 HV* get_hv(const char* name, I32 create)
489 Returns the SV of the specified Perl scalar. If C<create> is set and the
490 Perl variable does not exist then it will be created. If C<create> is not
491 set and the variable does not exist then NULL is returned.
493 NOTE: the perl_ form of this function is deprecated.
495 SV* get_sv(const char* name, I32 create)
502 A backward-compatible version of C<GIMME_V> which can only return
503 C<G_SCALAR> or C<G_ARRAY>; in a void context, it returns C<G_SCALAR>.
504 Deprecated. Use C<GIMME_V> instead.
513 The XSUB-writer's equivalent to Perl's C<wantarray>. Returns C<G_VOID>,
514 C<G_SCALAR> or C<G_ARRAY> for void, scalar or list context,
524 Return the SV from the GV.
533 Returns the glob with the given C<name> and a defined subroutine or
534 C<NULL>. The glob lives in the given C<stash>, or in the stashes
535 accessible via @ISA and @UNIVERSAL.
537 The argument C<level> should be either 0 or -1. If C<level==0>, as a
538 side-effect creates a glob with the given C<name> in the given C<stash>
539 which in the case of success contains an alias for the subroutine, and sets
540 up caching info for this glob. Similarly for all the searched stashes.
542 This function grants C<"SUPER"> token as a postfix of the stash name. The
543 GV returned from C<gv_fetchmeth> may be a method cache entry, which is not
544 visible to Perl code. So when calling C<call_sv>, you should not use
545 the GV directly; instead, you should use the method's CV, which can be
546 obtained from the GV with the C<GvCV> macro.
548 GV* gv_fetchmeth(HV* stash, const char* name, STRLEN len, I32 level)
555 See L<gv_fetchmethod_autoload>.
557 GV* gv_fetchmethod(HV* stash, const char* name)
562 =item gv_fetchmethod_autoload
564 Returns the glob which contains the subroutine to call to invoke the method
565 on the C<stash>. In fact in the presence of autoloading this may be the
566 glob for "AUTOLOAD". In this case the corresponding variable $AUTOLOAD is
569 The third parameter of C<gv_fetchmethod_autoload> determines whether
570 AUTOLOAD lookup is performed if the given method is not present: non-zero
571 means yes, look for AUTOLOAD; zero means no, don't look for AUTOLOAD.
572 Calling C<gv_fetchmethod> is equivalent to calling C<gv_fetchmethod_autoload>
573 with a non-zero C<autoload> parameter.
575 These functions grant C<"SUPER"> token as a prefix of the method name. Note
576 that if you want to keep the returned glob for a long time, you need to
577 check for it being "AUTOLOAD", since at the later time the call may load a
578 different subroutine due to $AUTOLOAD changing its value. Use the glob
579 created via a side effect to do this.
581 These functions have the same side-effects and as C<gv_fetchmeth> with
582 C<level==0>. C<name> should be writable if contains C<':'> or C<'
583 ''>. The warning against passing the GV returned by C<gv_fetchmeth> to
584 C<call_sv> apply equally to these functions.
586 GV* gv_fetchmethod_autoload(HV* stash, const char* name, I32 autoload)
593 Returns a pointer to the stash for a specified package. C<name> should
594 be a valid UTF-8 string. If C<create> is set then the package will be
595 created if it does not already exist. If C<create> is not set and the
596 package does not exist then NULL is returned.
598 HV* gv_stashpv(const char* name, I32 create)
605 Returns a pointer to the stash for a specified package, which must be a
606 valid UTF-8 string. See C<gv_stashpv>.
608 HV* gv_stashsv(SV* sv, I32 create)
615 Used to indicate list context. See C<GIMME_V>, C<GIMME> and
623 Indicates that arguments returned from a callback should be discarded. See
631 Used to force a Perl C<eval> wrapper around a callback. See
639 Indicates that no arguments are being sent to a callback. See
647 Used to indicate scalar context. See C<GIMME_V>, C<GIMME>, and
655 Used to indicate void context. See C<GIMME_V> and L<perlcall>.
662 This flag, used in the length slot of hash entries and magic structures,
663 specifies the structure contains a C<SV*> pointer where a C<char*> pointer
664 is to be expected. (For information only--not to be used).
671 Returns the computed hash stored in the hash entry.
680 Returns the actual pointer stored in the key slot of the hash entry. The
681 pointer may be either C<char*> or C<SV*>, depending on the value of
682 C<HeKLEN()>. Can be assigned to. The C<HePV()> or C<HeSVKEY()> macros are
683 usually preferable for finding the value of a key.
692 If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry
693 holds an C<SV*> key. Otherwise, holds the actual length of the key. Can
694 be assigned to. The C<HePV()> macro is usually preferable for finding key
697 STRLEN HeKLEN(HE* he)
704 Returns the key slot of the hash entry as a C<char*> value, doing any
705 necessary dereferencing of possibly C<SV*> keys. The length of the string
706 is placed in C<len> (this is a macro, so do I<not> use C<&len>). If you do
707 not care about what the length of the key is, you may use the global
708 variable C<PL_na>, though this is rather less efficient than using a local
709 variable. Remember though, that hash keys in perl are free to contain
710 embedded nulls, so using C<strlen()> or similar is not a good way to find
711 the length of hash keys. This is very similar to the C<SvPV()> macro
712 described elsewhere in this document.
714 char* HePV(HE* he, STRLEN len)
721 Returns the key as an C<SV*>, or C<Nullsv> if the hash entry does not
722 contain an C<SV*> key.
731 Returns the key as an C<SV*>. Will create and return a temporary mortal
732 C<SV*> if the hash entry contains only a C<char*> key.
734 SV* HeSVKEY_force(HE* he)
741 Sets the key to a given C<SV*>, taking care to set the appropriate flags to
742 indicate the presence of an C<SV*> key, and returns the same
745 SV* HeSVKEY_set(HE* he, SV* sv)
752 Returns the value slot (type C<SV*>) stored in the hash entry.
761 Returns the package name of a stash. See C<SvSTASH>, C<CvSTASH>.
763 char* HvNAME(HV* stash)
770 Clears a hash, making it empty.
772 void hv_clear(HV* tb)
779 Deletes a key/value pair in the hash. The value SV is removed from the
780 hash and returned to the caller. The C<klen> is the length of the key.
781 The C<flags> value will normally be zero; if set to G_DISCARD then NULL
784 SV* hv_delete(HV* tb, const char* key, I32 klen, I32 flags)
791 Deletes a key/value pair in the hash. The value SV is removed from the
792 hash and returned to the caller. The C<flags> value will normally be zero;
793 if set to G_DISCARD then NULL will be returned. C<hash> can be a valid
794 precomputed hash value, or 0 to ask for it to be computed.
796 SV* hv_delete_ent(HV* tb, SV* key, I32 flags, U32 hash)
803 Returns a boolean indicating whether the specified hash key exists. The
804 C<klen> is the length of the key.
806 bool hv_exists(HV* tb, const char* key, I32 klen)
813 Returns a boolean indicating whether the specified hash key exists. C<hash>
814 can be a valid precomputed hash value, or 0 to ask for it to be
817 bool hv_exists_ent(HV* tb, SV* key, U32 hash)
824 Returns the SV which corresponds to the specified key in the hash. The
825 C<klen> is the length of the key. If C<lval> is set then the fetch will be
826 part of a store. Check that the return value is non-null before
827 dereferencing it to a C<SV*>.
829 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
830 information on how to use this function on tied hashes.
832 SV** hv_fetch(HV* tb, const char* key, I32 klen, I32 lval)
839 Returns the hash entry which corresponds to the specified key in the hash.
840 C<hash> must be a valid precomputed hash number for the given C<key>, or 0
841 if you want the function to compute it. IF C<lval> is set then the fetch
842 will be part of a store. Make sure the return value is non-null before
843 accessing it. The return value when C<tb> is a tied hash is a pointer to a
844 static location, so be sure to make a copy of the structure if you need to
847 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
848 information on how to use this function on tied hashes.
850 HE* hv_fetch_ent(HV* tb, SV* key, I32 lval, U32 hash)
857 Prepares a starting point to traverse a hash table. Returns the number of
858 keys in the hash (i.e. the same as C<HvKEYS(tb)>). The return value is
859 currently only meaningful for hashes without tie magic.
861 NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
862 hash buckets that happen to be in use. If you still need that esoteric
863 value, you can get it through the macro C<HvFILL(tb)>.
865 I32 hv_iterinit(HV* tb)
872 Returns the key from the current position of the hash iterator. See
875 char* hv_iterkey(HE* entry, I32* retlen)
882 Returns the key as an C<SV*> from the current position of the hash
883 iterator. The return value will always be a mortal copy of the key. Also
886 SV* hv_iterkeysv(HE* entry)
893 Returns entries from a hash iterator. See C<hv_iterinit>.
895 HE* hv_iternext(HV* tb)
902 Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
905 SV* hv_iternextsv(HV* hv, char** key, I32* retlen)
912 Returns the value from the current position of the hash iterator. See
915 SV* hv_iterval(HV* tb, HE* entry)
922 Adds magic to a hash. See C<sv_magic>.
924 void hv_magic(HV* hv, GV* gv, int how)
931 Stores an SV in a hash. The hash key is specified as C<key> and C<klen> is
932 the length of the key. The C<hash> parameter is the precomputed hash
933 value; if it is zero then Perl will compute it. The return value will be
934 NULL if the operation failed or if the value did not need to be actually
935 stored within the hash (as in the case of tied hashes). Otherwise it can
936 be dereferenced to get the original C<SV*>. Note that the caller is
937 responsible for suitably incrementing the reference count of C<val> before
938 the call, and decrementing it if the function returned NULL.
940 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
941 information on how to use this function on tied hashes.
943 SV** hv_store(HV* tb, const char* key, I32 klen, SV* val, U32 hash)
950 Stores C<val> in a hash. The hash key is specified as C<key>. The C<hash>
951 parameter is the precomputed hash value; if it is zero then Perl will
952 compute it. The return value is the new hash entry so created. It will be
953 NULL if the operation failed or if the value did not need to be actually
954 stored within the hash (as in the case of tied hashes). Otherwise the
955 contents of the return value can be accessed using the C<He???> macros
956 described here. Note that the caller is responsible for suitably
957 incrementing the reference count of C<val> before the call, and
958 decrementing it if the function returned NULL.
960 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
961 information on how to use this function on tied hashes.
963 HE* hv_store_ent(HV* tb, SV* key, SV* val, U32 hash)
972 void hv_undef(HV* tb)
979 Returns a boolean indicating whether the C C<char> is an ASCII alphanumeric
980 character (including underscore) or digit.
982 bool isALNUM(char ch)
985 Found in file handy.h
989 Returns a boolean indicating whether the C C<char> is an ASCII alphabetic
992 bool isALPHA(char ch)
995 Found in file handy.h
999 Returns a boolean indicating whether the C C<char> is an ASCII
1002 bool isDIGIT(char ch)
1005 Found in file handy.h
1009 Returns a boolean indicating whether the C C<char> is a lowercase
1012 bool isLOWER(char ch)
1015 Found in file handy.h
1019 Returns a boolean indicating whether the C C<char> is whitespace.
1021 bool isSPACE(char ch)
1024 Found in file handy.h
1028 Returns a boolean indicating whether the C C<char> is an uppercase
1031 bool isUPPER(char ch)
1034 Found in file handy.h
1038 Tests if some arbitrary number of bytes begins in a valid UTF-8 character.
1039 The actual number of bytes in the UTF-8 character will be returned if it
1040 is valid, otherwise 0.
1042 STRLEN is_utf8_char(U8 *p)
1045 Found in file utf8.c
1047 =item is_utf8_string
1049 Returns true if first C<len> bytes of the given string form valid a UTF8
1050 string, false otherwise.
1052 bool is_utf8_string(U8 *s, STRLEN len)
1055 Found in file utf8.c
1059 Variable which is setup by C<xsubpp> to indicate the number of
1060 items on the stack. See L<perlxs/"Variable-length Parameter Lists">.
1065 Found in file XSUB.h
1069 Variable which is setup by C<xsubpp> to indicate which of an
1070 XSUB's aliases was used to invoke it. See L<perlxs/"The ALIAS: Keyword">.
1075 Found in file XSUB.h
1079 Closing bracket on a callback. See C<ENTER> and L<perlcall>.
1084 Found in file scope.h
1086 =item looks_like_number
1088 Test if an the content of an SV looks like a number (or is a
1089 number). C<Inf> and C<Infinity> are treated as numbers (so will not
1090 issue a non-numeric warning), even if your atof() doesn't grok them.
1092 I32 looks_like_number(SV* sv)
1099 Stack marker variable for the XSUB. See C<dMARK>.
1106 Clear something magical that the SV represents. See C<sv_magic>.
1108 int mg_clear(SV* sv)
1115 Copies the magic from one SV to another. See C<sv_magic>.
1117 int mg_copy(SV* sv, SV* nsv, const char* key, I32 klen)
1124 Finds the magic pointer for type matching the SV. See C<sv_magic>.
1126 MAGIC* mg_find(SV* sv, int type)
1133 Free any magic storage used by the SV. See C<sv_magic>.
1142 Do magic after a value is retrieved from the SV. See C<sv_magic>.
1151 Report on the SV's length. See C<sv_magic>.
1153 U32 mg_length(SV* sv)
1160 Turns on the magical status of an SV. See C<sv_magic>.
1162 void mg_magical(SV* sv)
1169 Do magic after a value is assigned to the SV. See C<sv_magic>.
1178 The XSUB-writer's interface to the C C<memmove> function. The C<src> is the
1179 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1180 the type. Can do overlapping moves. See also C<Copy>.
1182 void Move(void* src, void* dest, int nitems, type)
1185 Found in file handy.h
1189 The XSUB-writer's interface to the C C<malloc> function.
1191 void New(int id, void* ptr, int nitems, type)
1194 Found in file handy.h
1198 Creates a new AV. The reference count is set to 1.
1207 The XSUB-writer's interface to the C C<malloc> function, with
1210 void Newc(int id, void* ptr, int nitems, type, cast)
1213 Found in file handy.h
1217 Creates a constant sub equivalent to Perl C<sub FOO () { 123 }> which is
1218 eligible for inlining at compile-time.
1220 CV* newCONSTSUB(HV* stash, char* name, SV* sv)
1227 Creates a new HV. The reference count is set to 1.
1236 Creates an RV wrapper for an SV. The reference count for the original SV is
1239 SV* newRV_inc(SV* sv)
1246 Creates an RV wrapper for an SV. The reference count for the original
1247 SV is B<not> incremented.
1249 SV* newRV_noinc(SV *sv)
1256 Creates a new SV. A non-zero C<len> parameter indicates the number of
1257 bytes of preallocated string space the SV should have. An extra byte for a
1258 tailing NUL is also reserved. (SvPOK is not set for the SV even if string
1259 space is allocated.) The reference count for the new SV is set to 1.
1260 C<id> is an integer id between 0 and 1299 (used to identify leaks).
1262 SV* NEWSV(int id, STRLEN len)
1265 Found in file handy.h
1269 Creates a new SV and copies an integer into it. The reference count for the
1279 Creates a new SV and copies a floating point value into it.
1280 The reference count for the SV is set to 1.
1289 Creates a new SV and copies a string into it. The reference count for the
1290 SV is set to 1. If C<len> is zero, Perl will compute the length using
1291 strlen(). For efficiency, consider using C<newSVpvn> instead.
1293 SV* newSVpv(const char* s, STRLEN len)
1300 Creates a new SV an initialize it with the string formatted like
1303 SV* newSVpvf(const char* pat, ...)
1310 Creates a new SV and copies a string into it. The reference count for the
1311 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
1312 string. You are responsible for ensuring that the source string is at least
1315 SV* newSVpvn(const char* s, STRLEN len)
1320 =item newSVpvn_share
1322 Creates a new SV and populates it with a string from
1323 the string table. Turns on READONLY and FAKE.
1324 The idea here is that as string table is used for shared hash
1325 keys these strings will have SvPVX == HeKEY and hash lookup
1326 will avoid string compare.
1328 SV* newSVpvn_share(const char* s, I32 len, U32 hash)
1335 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
1336 it will be upgraded to one. If C<classname> is non-null then the new SV will
1337 be blessed in the specified package. The new SV is returned and its
1338 reference count is 1.
1340 SV* newSVrv(SV* rv, const char* classname)
1347 Creates a new SV which is an exact duplicate of the original SV.
1349 SV* newSVsv(SV* old)
1356 Creates a new SV and copies an unsigned integer into it.
1357 The reference count for the SV is set to 1.
1366 Used by C<xsubpp> to hook up XSUBs as Perl subs.
1373 Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
1377 Found in file XSUB.h
1381 The XSUB-writer's interface to the C C<malloc> function. The allocated
1382 memory is zeroed with C<memzero>.
1384 void Newz(int id, void* ptr, int nitems, type)
1387 Found in file handy.h
1398 Null character pointer.
1401 Found in file handy.h
1422 Found in file handy.h
1426 The original stack mark for the XSUB. See C<dORIGMARK>.
1433 Allocates a new Perl interpreter. See L<perlembed>.
1435 PerlInterpreter* perl_alloc()
1438 Found in file perl.c
1440 =item perl_construct
1442 Initializes a new Perl interpreter. See L<perlembed>.
1444 void perl_construct(PerlInterpreter* interp)
1447 Found in file perl.c
1451 Shuts down a Perl interpreter. See L<perlembed>.
1453 void perl_destruct(PerlInterpreter* interp)
1456 Found in file perl.c
1460 Releases a Perl interpreter. See L<perlembed>.
1462 void perl_free(PerlInterpreter* interp)
1465 Found in file perl.c
1469 Tells a Perl interpreter to parse a Perl script. See L<perlembed>.
1471 int perl_parse(PerlInterpreter* interp, XSINIT_t xsinit, int argc, char** argv, char** env)
1474 Found in file perl.c
1478 Tells a Perl interpreter to run. See L<perlembed>.
1480 int perl_run(PerlInterpreter* interp)
1483 Found in file perl.c
1487 C<PL_modglobal> is a general purpose, interpreter global HV for use by
1488 extensions that need to keep information on a per-interpreter basis.
1489 In a pinch, it can also be used as a symbol table for extensions
1490 to share data among each other. It is a good idea to use keys
1491 prefixed by the package name of the extension that owns the data.
1496 Found in file intrpvar.h
1500 A convenience variable which is typically used with C<SvPV> when one
1501 doesn't care about the length of the string. It is usually more efficient
1502 to either declare a local variable and use that instead or to use the
1503 C<SvPV_nolen> macro.
1508 Found in file thrdvar.h
1512 This is the C<false> SV. See C<PL_sv_yes>. Always refer to this as
1518 Found in file intrpvar.h
1522 This is the C<undef> SV. Always refer to this as C<&PL_sv_undef>.
1527 Found in file intrpvar.h
1531 This is the C<true> SV. See C<PL_sv_no>. Always refer to this as
1537 Found in file intrpvar.h
1541 Pops an integer off the stack.
1550 Pops a long off the stack.
1559 Pops a double off the stack.
1568 Pops a string off the stack.
1577 Pops an SV off the stack.
1586 Push an integer onto the stack. The stack must have room for this element.
1587 Handles 'set' magic. See C<XPUSHi>.
1596 Opening bracket for arguments on a callback. See C<PUTBACK> and
1606 Push a double onto the stack. The stack must have room for this element.
1607 Handles 'set' magic. See C<XPUSHn>.
1616 Push a string onto the stack. The stack must have room for this element.
1617 The C<len> indicates the length of the string. Handles 'set' magic. See
1620 void PUSHp(char* str, STRLEN len)
1627 Push an SV onto the stack. The stack must have room for this element.
1628 Does not handle 'set' magic. See C<XPUSHs>.
1637 Push an unsigned integer onto the stack. The stack must have room for this
1638 element. See C<XPUSHu>.
1647 Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
1648 See C<PUSHMARK> and L<perlcall> for other uses.
1657 The XSUB-writer's interface to the C C<realloc> function.
1659 void Renew(void* ptr, int nitems, type)
1662 Found in file handy.h
1666 The XSUB-writer's interface to the C C<realloc> function, with
1669 void Renewc(void* ptr, int nitems, type, cast)
1672 Found in file handy.h
1676 Tells Perl to C<require> a module.
1678 NOTE: the perl_ form of this function is deprecated.
1680 void require_pv(const char* pv)
1683 Found in file perl.c
1687 Variable which is setup by C<xsubpp> to hold the return value for an
1688 XSUB. This is always the proper type for the XSUB. See
1689 L<perlxs/"The RETVAL Variable">.
1694 Found in file XSUB.h
1698 The XSUB-writer's interface to the C C<free> function.
1700 void Safefree(void* ptr)
1703 Found in file handy.h
1707 Copy a string to a safe spot. This does not use an SV.
1709 char* savepv(const char* sv)
1712 Found in file util.c
1716 Copy a string to a safe spot. The C<len> indicates number of bytes to
1717 copy. This does not use an SV.
1719 char* savepvn(const char* sv, I32 len)
1722 Found in file util.c
1726 Opening bracket for temporaries on a callback. See C<FREETMPS> and
1732 Found in file scope.h
1736 Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and
1744 Refetch the stack pointer. Used after a callback. See L<perlcall>.
1753 Used to access elements on the XSUB's stack.
1758 Found in file XSUB.h
1762 Test two strings to see if they are equal. Returns true or false.
1764 bool strEQ(char* s1, char* s2)
1767 Found in file handy.h
1771 Test two strings to see if the first, C<s1>, is greater than or equal to
1772 the second, C<s2>. Returns true or false.
1774 bool strGE(char* s1, char* s2)
1777 Found in file handy.h
1781 Test two strings to see if the first, C<s1>, is greater than the second,
1782 C<s2>. Returns true or false.
1784 bool strGT(char* s1, char* s2)
1787 Found in file handy.h
1791 Test two strings to see if the first, C<s1>, is less than or equal to the
1792 second, C<s2>. Returns true or false.
1794 bool strLE(char* s1, char* s2)
1797 Found in file handy.h
1801 Test two strings to see if the first, C<s1>, is less than the second,
1802 C<s2>. Returns true or false.
1804 bool strLT(char* s1, char* s2)
1807 Found in file handy.h
1811 Test two strings to see if they are different. Returns true or
1814 bool strNE(char* s1, char* s2)
1817 Found in file handy.h
1821 Test two strings to see if they are equal. The C<len> parameter indicates
1822 the number of bytes to compare. Returns true or false. (A wrapper for
1825 bool strnEQ(char* s1, char* s2, STRLEN len)
1828 Found in file handy.h
1832 Test two strings to see if they are different. The C<len> parameter
1833 indicates the number of bytes to compare. Returns true or false. (A
1834 wrapper for C<strncmp>).
1836 bool strnNE(char* s1, char* s2, STRLEN len)
1839 Found in file handy.h
1843 This is an architecture-independent macro to copy one structure to another.
1845 void StructCopy(type src, type dest, type)
1848 Found in file handy.h
1852 Returns the length of the string which is in the SV. See C<SvLEN>.
1854 STRLEN SvCUR(SV* sv)
1861 Set the length of the string which is in the SV. See C<SvCUR>.
1863 void SvCUR_set(SV* sv, STRLEN len)
1870 Returns a pointer to the last character in the string which is in the SV.
1871 See C<SvCUR>. Access the character as *(SvEND(sv)).
1880 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
1881 argument more than once.
1883 void SvGETMAGIC(SV* sv)
1890 Expands the character buffer in the SV so that it has room for the
1891 indicated number of bytes (remember to reserve space for an extra trailing
1892 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
1893 Returns a pointer to the character buffer.
1895 void SvGROW(SV* sv, STRLEN len)
1902 Returns a boolean indicating whether the SV contains an integer.
1911 Returns a boolean indicating whether the SV contains an integer. Checks
1912 the B<private> setting. Use C<SvIOK>.
1921 Returns a boolean indicating whether the SV contains an signed integer.
1923 void SvIOK_notUV(SV* sv)
1930 Unsets the IV status of an SV.
1932 void SvIOK_off(SV* sv)
1939 Tells an SV that it is an integer.
1941 void SvIOK_on(SV* sv)
1948 Tells an SV that it is an integer and disables all other OK bits.
1950 void SvIOK_only(SV* sv)
1957 Tells and SV that it is an unsigned integer and disables all other OK bits.
1959 void SvIOK_only_UV(SV* sv)
1966 Returns a boolean indicating whether the SV contains an unsigned integer.
1968 void SvIOK_UV(SV* sv)
1975 Coerces the given SV to an integer and returns it.
1984 Returns the integer which is stored in the SV, assuming SvIOK is
1994 Returns the size of the string buffer in the SV, not including any part
1995 attributable to C<SvOOK>. See C<SvCUR>.
1997 STRLEN SvLEN(SV* sv)
2004 Returns a boolean indicating whether the SV contains a number, integer or
2014 Returns a boolean indicating whether the SV contains a number, integer or
2015 double. Checks the B<private> setting. Use C<SvNIOK>.
2017 bool SvNIOKp(SV* sv)
2024 Unsets the NV/IV status of an SV.
2026 void SvNIOK_off(SV* sv)
2033 Returns a boolean indicating whether the SV contains a double.
2042 Returns a boolean indicating whether the SV contains a double. Checks the
2043 B<private> setting. Use C<SvNOK>.
2052 Unsets the NV status of an SV.
2054 void SvNOK_off(SV* sv)
2061 Tells an SV that it is a double.
2063 void SvNOK_on(SV* sv)
2070 Tells an SV that it is a double and disables all other OK bits.
2072 void SvNOK_only(SV* sv)
2079 Coerce the given SV to a double and return it.
2088 Returns the double which is stored in the SV, assuming SvNOK is
2098 Returns a boolean indicating whether the value is an SV.
2107 Returns a boolean indicating whether the SvIVX is a valid offset value for
2108 the SvPVX. This hack is used internally to speed up removal of characters
2109 from the beginning of a SvPV. When SvOOK is true, then the start of the
2110 allocated string buffer is really (SvPVX - SvIVX).
2119 Returns a boolean indicating whether the SV contains a character
2129 Returns a boolean indicating whether the SV contains a character string.
2130 Checks the B<private> setting. Use C<SvPOK>.
2139 Unsets the PV status of an SV.
2141 void SvPOK_off(SV* sv)
2148 Tells an SV that it is a string.
2150 void SvPOK_on(SV* sv)
2157 Tells an SV that it is a string and disables all other OK bits.
2159 void SvPOK_only(SV* sv)
2164 =item SvPOK_only_UTF8
2166 Tells an SV that it is a UTF8 string (do not use frivolously)
2167 and disables all other OK bits.
2169 void SvPOK_only_UTF8(SV* sv)
2176 Returns a pointer to the string in the SV, or a stringified form of the SV
2177 if the SV does not contain a string. Handles 'get' magic.
2179 char* SvPV(SV* sv, STRLEN len)
2186 Returns a pointer to the string in the SV. The SV must contain a
2196 Like <SvPV> but will force the SV into becoming a string (SvPOK). You want
2197 force if you are going to update the SvPVX directly.
2199 char* SvPV_force(SV* sv, STRLEN len)
2206 Returns a pointer to the string in the SV, or a stringified form of the SV
2207 if the SV does not contain a string. Handles 'get' magic.
2209 char* SvPV_nolen(SV* sv)
2216 Returns the value of the object's reference count.
2218 U32 SvREFCNT(SV* sv)
2225 Decrements the reference count of the given SV.
2227 void SvREFCNT_dec(SV* sv)
2234 Increments the reference count of the given SV.
2236 SV* SvREFCNT_inc(SV* sv)
2243 Tests if the SV is an RV.
2252 Unsets the RV status of an SV.
2254 void SvROK_off(SV* sv)
2261 Tells an SV that it is an RV.
2263 void SvROK_on(SV* sv)
2270 Dereferences an RV to return the SV.
2279 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
2280 argument more than once.
2282 void SvSETMAGIC(SV* sv)
2289 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
2292 void SvSetSV(SV* dsb, SV* ssv)
2297 =item SvSetSV_nosteal
2299 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
2300 ssv. May evaluate arguments more than once.
2302 void SvSetSV_nosteal(SV* dsv, SV* ssv)
2309 Returns the stash of the SV.
2318 Taints an SV if tainting is enabled
2320 void SvTAINT(SV* sv)
2327 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
2330 bool SvTAINTED(SV* sv)
2337 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
2338 some of Perl's fundamental security features. XS module authors should not
2339 use this function unless they fully understand all the implications of
2340 unconditionally untainting the value. Untainting should be done in the
2341 standard perl fashion, via a carefully crafted regexp, rather than directly
2342 untainting variables.
2344 void SvTAINTED_off(SV* sv)
2351 Marks an SV as tainted.
2353 void SvTAINTED_on(SV* sv)
2360 Returns a boolean indicating whether Perl would evaluate the SV as true or
2361 false, defined or undefined. Does not handle 'get' magic.
2370 An enum of flags for Perl types. These are found in the file B<sv.h>
2371 in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
2378 Returns the type of the SV. See C<svtype>.
2380 svtype SvTYPE(SV* sv)
2387 Integer type flag for scalars. See C<svtype>.
2394 Double type flag for scalars. See C<svtype>.
2401 Pointer type flag for scalars. See C<svtype>.
2408 Type flag for arrays. See C<svtype>.
2415 Type flag for code refs. See C<svtype>.
2422 Type flag for hashes. See C<svtype>.
2429 Type flag for blessed scalars. See C<svtype>.
2436 Returns a boolean indicating whether the SV contains an unsigned integer.
2445 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
2446 perform the upgrade if necessary. See C<svtype>.
2448 void SvUPGRADE(SV* sv, svtype type)
2455 Returns a boolean indicating whether the SV contains UTF-8 encoded data.
2464 Unsets the UTF8 status of an SV.
2466 void SvUTF8_off(SV *sv)
2473 Tells an SV that it is a string and encoded in UTF8. Do not use frivolously.
2475 void SvUTF8_on(SV *sv)
2482 Coerces the given SV to an unsigned integer and returns it.
2491 Returns the unsigned integer which is stored in the SV, assuming SvIOK is
2501 Marks an SV as mortal. The SV will be destroyed when the current context
2504 SV* sv_2mortal(SV* sv)
2511 Blesses an SV into a specified package. The SV must be an RV. The package
2512 must be designated by its stash (see C<gv_stashpv()>). The reference count
2513 of the SV is unaffected.
2515 SV* sv_bless(SV* sv, HV* stash)
2522 Concatenates the string onto the end of the string which is in the SV.
2523 Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
2525 void sv_catpv(SV* sv, const char* ptr)
2532 Processes its arguments like C<sprintf> and appends the formatted output
2533 to an SV. Handles 'get' magic, but not 'set' magic. C<SvSETMAGIC()> must
2534 typically be called after calling this function to handle 'set' magic.
2536 void sv_catpvf(SV* sv, const char* pat, ...)
2543 Like C<sv_catpvf>, but also handles 'set' magic.
2545 void sv_catpvf_mg(SV *sv, const char* pat, ...)
2552 Concatenates the string onto the end of the string which is in the SV. The
2553 C<len> indicates number of bytes to copy. Handles 'get' magic, but not
2554 'set' magic. See C<sv_catpvn_mg>.
2556 void sv_catpvn(SV* sv, const char* ptr, STRLEN len)
2563 Like C<sv_catpvn>, but also handles 'set' magic.
2565 void sv_catpvn_mg(SV *sv, const char *ptr, STRLEN len)
2572 Like C<sv_catpv>, but also handles 'set' magic.
2574 void sv_catpv_mg(SV *sv, const char *ptr)
2581 Concatenates the string from SV C<ssv> onto the end of the string in
2582 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
2583 not 'set' magic. See C<sv_catsv_mg>.
2585 void sv_catsv(SV* dsv, SV* ssv)
2592 Like C<sv_catsv>, but also handles 'set' magic.
2594 void sv_catsv_mg(SV *dstr, SV *sstr)
2601 Efficient removal of characters from the beginning of the string buffer.
2602 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
2603 the string buffer. The C<ptr> becomes the first character of the adjusted
2606 void sv_chop(SV* sv, char* ptr)
2613 Clear an SV, making it empty. Does not free the memory used by the SV
2616 void sv_clear(SV* sv)
2623 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
2624 string in C<sv1> is less than, equal to, or greater than the string in
2627 I32 sv_cmp(SV* sv1, SV* sv2)
2634 Compares the strings in two SVs in a locale-aware manner. See
2637 I32 sv_cmp_locale(SV* sv1, SV* sv2)
2644 Auto-decrement of the value in the SV.
2651 =item sv_derived_from
2653 Returns a boolean indicating whether the SV is derived from the specified
2654 class. This is the function that implements C<UNIVERSAL::isa>. It works
2655 for class names as well as for objects.
2657 bool sv_derived_from(SV* sv, const char* name)
2660 Found in file universal.c
2664 Returns a boolean indicating whether the strings in the two SVs are
2667 I32 sv_eq(SV* sv1, SV* sv2)
2674 Free the memory used by an SV.
2676 void sv_free(SV* sv)
2683 Get a line from the filehandle and store it into the SV, optionally
2684 appending to the currently-stored string.
2686 char* sv_gets(SV* sv, PerlIO* fp, I32 append)
2693 Expands the character buffer in the SV. This will use C<sv_unref> and will
2694 upgrade the SV to C<SVt_PV>. Returns a pointer to the character buffer.
2697 char* sv_grow(SV* sv, STRLEN newlen)
2704 Auto-increment of the value in the SV.
2713 Inserts a string at the specified offset/length within the SV. Similar to
2714 the Perl substr() function.
2716 void sv_insert(SV* bigsv, STRLEN offset, STRLEN len, char* little, STRLEN littlelen)
2723 Returns a boolean indicating whether the SV is blessed into the specified
2724 class. This does not check for subtypes; use C<sv_derived_from> to verify
2725 an inheritance relationship.
2727 int sv_isa(SV* sv, const char* name)
2734 Returns a boolean indicating whether the SV is an RV pointing to a blessed
2735 object. If the SV is not an RV, or if the object is not blessed, then this
2738 int sv_isobject(SV* sv)
2745 Returns the length of the string in the SV. See also C<SvCUR>.
2747 STRLEN sv_len(SV* sv)
2754 Returns the number of characters in the string in an SV, counting wide
2755 UTF8 bytes as a single character.
2757 STRLEN sv_len_utf8(SV* sv)
2764 Adds magic to an SV.
2766 void sv_magic(SV* sv, SV* obj, int how, const char* name, I32 namlen)
2773 Creates a new SV which is a copy of the original SV. The new SV is marked
2776 SV* sv_mortalcopy(SV* oldsv)
2783 Creates a new SV which is mortal. The reference count of the SV is set to 1.
2792 Get a sensible string out of the SV somehow.
2794 char* sv_pvn_force(SV* sv, STRLEN* lp)
2799 =item sv_pvutf8n_force
2801 Get a sensible UTF8-encoded string out of the SV somehow. See
2804 char* sv_pvutf8n_force(SV* sv, STRLEN* lp)
2811 Returns a string describing what the SV is a reference to.
2813 char* sv_reftype(SV* sv, int ob)
2820 Make the first argument a copy of the second, then delete the original.
2822 void sv_replace(SV* sv, SV* nsv)
2831 SV* sv_rvweaken(SV *sv)
2838 Copies an integer into the given SV. Does not handle 'set' magic. See
2841 void sv_setiv(SV* sv, IV num)
2848 Like C<sv_setiv>, but also handles 'set' magic.
2850 void sv_setiv_mg(SV *sv, IV i)
2857 Copies a double into the given SV. Does not handle 'set' magic. See
2860 void sv_setnv(SV* sv, NV num)
2867 Like C<sv_setnv>, but also handles 'set' magic.
2869 void sv_setnv_mg(SV *sv, NV num)
2876 Copies a string into an SV. The string must be null-terminated. Does not
2877 handle 'set' magic. See C<sv_setpv_mg>.
2879 void sv_setpv(SV* sv, const char* ptr)
2886 Processes its arguments like C<sprintf> and sets an SV to the formatted
2887 output. Does not handle 'set' magic. See C<sv_setpvf_mg>.
2889 void sv_setpvf(SV* sv, const char* pat, ...)
2896 Like C<sv_setpvf>, but also handles 'set' magic.
2898 void sv_setpvf_mg(SV *sv, const char* pat, ...)
2905 Copies an integer into the given SV, also updating its string value.
2906 Does not handle 'set' magic. See C<sv_setpviv_mg>.
2908 void sv_setpviv(SV* sv, IV num)
2915 Like C<sv_setpviv>, but also handles 'set' magic.
2917 void sv_setpviv_mg(SV *sv, IV iv)
2924 Copies a string into an SV. The C<len> parameter indicates the number of
2925 bytes to be copied. Does not handle 'set' magic. See C<sv_setpvn_mg>.
2927 void sv_setpvn(SV* sv, const char* ptr, STRLEN len)
2934 Like C<sv_setpvn>, but also handles 'set' magic.
2936 void sv_setpvn_mg(SV *sv, const char *ptr, STRLEN len)
2943 Like C<sv_setpv>, but also handles 'set' magic.
2945 void sv_setpv_mg(SV *sv, const char *ptr)
2952 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
2953 argument will be upgraded to an RV. That RV will be modified to point to
2954 the new SV. The C<classname> argument indicates the package for the
2955 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
2956 will be returned and will have a reference count of 1.
2958 SV* sv_setref_iv(SV* rv, const char* classname, IV iv)
2965 Copies a double into a new SV, optionally blessing the SV. The C<rv>
2966 argument will be upgraded to an RV. That RV will be modified to point to
2967 the new SV. The C<classname> argument indicates the package for the
2968 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
2969 will be returned and will have a reference count of 1.
2971 SV* sv_setref_nv(SV* rv, const char* classname, NV nv)
2978 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
2979 argument will be upgraded to an RV. That RV will be modified to point to
2980 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
2981 into the SV. The C<classname> argument indicates the package for the
2982 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
2983 will be returned and will have a reference count of 1.
2985 Do not use with other Perl types such as HV, AV, SV, CV, because those
2986 objects will become corrupted by the pointer copy process.
2988 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
2990 SV* sv_setref_pv(SV* rv, const char* classname, void* pv)
2997 Copies a string into a new SV, optionally blessing the SV. The length of the
2998 string must be specified with C<n>. The C<rv> argument will be upgraded to
2999 an RV. That RV will be modified to point to the new SV. The C<classname>
3000 argument indicates the package for the blessing. Set C<classname> to
3001 C<Nullch> to avoid the blessing. The new SV will be returned and will have
3002 a reference count of 1.
3004 Note that C<sv_setref_pv> copies the pointer while this copies the string.
3006 SV* sv_setref_pvn(SV* rv, const char* classname, char* pv, STRLEN n)
3013 Copies the contents of the source SV C<ssv> into the destination SV C<dsv>.
3014 The source SV may be destroyed if it is mortal. Does not handle 'set'
3015 magic. See the macro forms C<SvSetSV>, C<SvSetSV_nosteal> and
3018 void sv_setsv(SV* dsv, SV* ssv)
3025 Like C<sv_setsv>, but also handles 'set' magic.
3027 void sv_setsv_mg(SV *dstr, SV *sstr)
3034 Copies an unsigned integer into the given SV. Does not handle 'set' magic.
3037 void sv_setuv(SV* sv, UV num)
3044 Like C<sv_setuv>, but also handles 'set' magic.
3046 void sv_setuv_mg(SV *sv, UV u)
3053 Returns true if the SV has a true value by Perl's rules.
3062 Removes magic from an SV.
3064 int sv_unmagic(SV* sv, int type)
3071 Unsets the RV status of the SV, and decrements the reference count of
3072 whatever was being referenced by the RV. This can almost be thought of
3073 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
3074 being zero. See C<SvROK_off>.
3076 void sv_unref(SV* sv)
3081 =item sv_unref_flags
3083 Unsets the RV status of the SV, and decrements the reference count of
3084 whatever was being referenced by the RV. This can almost be thought of
3085 as a reversal of C<newSVrv>. The C<cflags> argument can contain
3086 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
3087 (otherwise the decrementing is conditional on the reference count being
3088 different from one or the reference being a readonly SV).
3091 void sv_unref_flags(SV* sv, U32 flags)
3098 Upgrade an SV to a more complex form. Use C<SvUPGRADE>. See
3101 bool sv_upgrade(SV* sv, U32 mt)
3108 Tells an SV to use C<ptr> to find its string value. Normally the string is
3109 stored inside the SV but sv_usepvn allows the SV to use an outside string.
3110 The C<ptr> should point to memory that was allocated by C<malloc>. The
3111 string length, C<len>, must be supplied. This function will realloc the
3112 memory pointed to by C<ptr>, so that pointer should not be freed or used by
3113 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
3114 See C<sv_usepvn_mg>.
3116 void sv_usepvn(SV* sv, char* ptr, STRLEN len)
3123 Like C<sv_usepvn>, but also handles 'set' magic.
3125 void sv_usepvn_mg(SV *sv, char *ptr, STRLEN len)
3130 =item sv_utf8_downgrade
3132 Attempt to convert the PV of an SV from UTF8-encoded to byte encoding.
3133 This may not be possible if the PV contains non-byte encoding characters;
3134 if this is the case, either returns false or, if C<fail_ok> is not
3137 NOTE: this function is experimental and may change or be
3138 removed without notice.
3140 bool sv_utf8_downgrade(SV *sv, bool fail_ok)
3145 =item sv_utf8_encode
3147 Convert the PV of an SV to UTF8-encoded, but then turn off the C<SvUTF8>
3148 flag so that it looks like bytes again. Nothing calls this.
3150 NOTE: this function is experimental and may change or be
3151 removed without notice.
3153 void sv_utf8_encode(SV *sv)
3158 =item sv_utf8_upgrade
3160 Convert the PV of an SV to its UTF8-encoded form.
3162 void sv_utf8_upgrade(SV *sv)
3169 Processes its arguments like C<vsprintf> and appends the formatted output
3170 to an SV. Uses an array of SVs if the C style variable argument list is
3171 missing (NULL). When running with taint checks enabled, indicates via
3172 C<maybe_tainted> if results are untrustworthy (often due to the use of
3175 void sv_vcatpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
3182 Works like C<vcatpvfn> but copies the text into the SV instead of
3185 void sv_vsetpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
3192 Variable which is setup by C<xsubpp> to designate the object in a C++
3193 XSUB. This is always the proper type for the C++ object. See C<CLASS> and
3194 L<perlxs/"Using XS With C++">.
3199 Found in file XSUB.h
3203 Converts the specified character to lowercase.
3205 char toLOWER(char ch)
3208 Found in file handy.h
3212 Converts the specified character to uppercase.
3214 char toUPPER(char ch)
3217 Found in file handy.h
3221 Returns the number of UTF8 characters between the UTF-8 pointers C<a>
3224 WARNING: use only if you *know* that the pointers point inside the
3227 IV utf8_distance(U8 *a, U8 *b)
3230 Found in file utf8.c
3234 Return the UTF-8 pointer C<s> displaced by C<off> characters, either
3235 forward or backward.
3237 WARNING: do not use the following unless you *know* C<off> is within
3238 the UTF-8 data pointed to by C<s> *and* that on entry C<s> is aligned
3239 on the first byte of character or just after the last byte of a character.
3241 U8* utf8_hop(U8 *s, I32 off)
3244 Found in file utf8.c
3248 Return the length of the UTF-8 char encoded string C<s> in characters.
3249 Stops at C<e> (inclusive). If C<e E<lt> s> or if the scan would end
3250 up past C<e>, croaks.
3252 STRLEN utf8_length(U8* s, U8 *e)
3255 Found in file utf8.c
3259 Converts a string C<s> of length C<len> from UTF8 into byte encoding.
3260 Unlike C<bytes_to_utf8>, this over-writes the original string, and
3261 updates len to contain the new length.
3262 Returns zero on failure, setting C<len> to -1.
3264 NOTE: this function is experimental and may change or be
3265 removed without notice.
3267 U8* utf8_to_bytes(U8 *s, STRLEN *len)
3270 Found in file utf8.c
3274 Returns the character value of the first character in the string C<s>
3275 which is assumed to be in UTF8 encoding and no longer than C<curlen>;
3276 C<retlen> will be set to the length, in bytes, of that character.
3278 If C<s> does not point to a well-formed UTF8 character, the behaviour
3279 is dependent on the value of C<flags>: if it contains UTF8_CHECK_ONLY,
3280 it is assumed that the caller will raise a warning, and this function
3281 will silently just set C<retlen> to C<-1> and return zero. If the
3282 C<flags> does not contain UTF8_CHECK_ONLY, warnings about
3283 malformations will be given, C<retlen> will be set to the expected
3284 length of the UTF-8 character in bytes, and zero will be returned.
3286 The C<flags> can also contain various flags to allow deviations from
3287 the strict UTF-8 encoding (see F<utf8.h>).
3289 UV utf8_to_uv(U8 *s, STRLEN curlen, STRLEN* retlen, U32 flags)
3292 Found in file utf8.c
3294 =item utf8_to_uv_simple
3296 Returns the character value of the first character in the string C<s>
3297 which is assumed to be in UTF8 encoding; C<retlen> will be set to the
3298 length, in bytes, of that character.
3300 If C<s> does not point to a well-formed UTF8 character, zero is
3301 returned and retlen is set, if possible, to -1.
3303 UV utf8_to_uv_simple(U8 *s, STRLEN* retlen)
3306 Found in file utf8.c
3310 Adds the UTF8 representation of the Unicode codepoint C<uv> to the end
3311 of the string C<d>; C<d> should be have at least C<UTF8_MAXLEN+1> free
3312 bytes available. The return value is the pointer to the byte after the
3313 end of the new character. In other words,
3315 d = uv_to_utf8(d, uv);
3317 is the recommended Unicode-aware way of saying
3321 U8* uv_to_utf8(U8 *d, UV uv)
3324 Found in file utf8.c
3328 This is the XSUB-writer's interface to Perl's C<warn> function. Use this
3329 function the same way you use the C C<printf> function. See
3332 void warn(const char* pat, ...)
3335 Found in file util.c
3339 Push an integer onto the stack, extending the stack if necessary. Handles
3340 'set' magic. See C<PUSHi>.
3349 Push a double onto the stack, extending the stack if necessary. Handles
3350 'set' magic. See C<PUSHn>.
3359 Push a string onto the stack, extending the stack if necessary. The C<len>
3360 indicates the length of the string. Handles 'set' magic. See
3363 void XPUSHp(char* str, STRLEN len)
3370 Push an SV onto the stack, extending the stack if necessary. Does not
3371 handle 'set' magic. See C<PUSHs>.
3380 Push an unsigned integer onto the stack, extending the stack if necessary.
3390 Macro to declare an XSUB and its C parameter list. This is handled by
3394 Found in file XSUB.h
3398 Return from XSUB, indicating number of items on the stack. This is usually
3399 handled by C<xsubpp>.
3401 void XSRETURN(int nitems)
3404 Found in file XSUB.h
3406 =item XSRETURN_EMPTY
3408 Return an empty list from an XSUB immediately.
3413 Found in file XSUB.h
3417 Return an integer from an XSUB immediately. Uses C<XST_mIV>.
3419 void XSRETURN_IV(IV iv)
3422 Found in file XSUB.h
3426 Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
3431 Found in file XSUB.h
3435 Return an double from an XSUB immediately. Uses C<XST_mNV>.
3437 void XSRETURN_NV(NV nv)
3440 Found in file XSUB.h
3444 Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
3446 void XSRETURN_PV(char* str)
3449 Found in file XSUB.h
3451 =item XSRETURN_UNDEF
3453 Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
3458 Found in file XSUB.h
3462 Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
3467 Found in file XSUB.h
3471 Place an integer into the specified position C<pos> on the stack. The
3472 value is stored in a new mortal SV.
3474 void XST_mIV(int pos, IV iv)
3477 Found in file XSUB.h
3481 Place C<&PL_sv_no> into the specified position C<pos> on the
3484 void XST_mNO(int pos)
3487 Found in file XSUB.h
3491 Place a double into the specified position C<pos> on the stack. The value
3492 is stored in a new mortal SV.
3494 void XST_mNV(int pos, NV nv)
3497 Found in file XSUB.h
3501 Place a copy of a string into the specified position C<pos> on the stack.
3502 The value is stored in a new mortal SV.
3504 void XST_mPV(int pos, char* str)
3507 Found in file XSUB.h
3511 Place C<&PL_sv_undef> into the specified position C<pos> on the
3514 void XST_mUNDEF(int pos)
3517 Found in file XSUB.h
3521 Place C<&PL_sv_yes> into the specified position C<pos> on the
3524 void XST_mYES(int pos)
3527 Found in file XSUB.h
3531 The version identifier for an XS module. This is usually
3532 handled automatically by C<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>.
3535 Found in file XSUB.h
3537 =item XS_VERSION_BOOTCHECK
3539 Macro to verify that a PM module's $VERSION variable matches the XS
3540 module's C<XS_VERSION> variable. This is usually handled automatically by
3541 C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">.
3543 XS_VERSION_BOOTCHECK;
3546 Found in file XSUB.h
3550 The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the
3551 destination, C<nitems> is the number of items, and C<type> is the type.
3553 void Zero(void* dest, int nitems, type)
3556 Found in file handy.h
3562 Until May 1997, this document was maintained by Jeff Okamoto
3563 <okamoto@corp.hp.com>. It is now maintained as part of Perl itself.
3565 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
3566 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
3567 Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
3568 Stephen McCamant, and Gurusamy Sarathy.
3570 API Listing originally by Dean Roehrich <roehrich@cray.com>.
3572 Updated to be autogenerated from comments in the source by Benjamin Stuhl.
3576 perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
projects / p5sagit/p5-mst-13.2.git / blob