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 Recognise (or not) a number. The type of the number is returned
525 (0 if unrecognised), otherwise it is a bit-ORed combination of
526 IS_NUMBER_IN_UV, IS_NUMBER_GREATER_THAN_UV_MAX, IS_NUMBER_NOT_INT,
527 IS_NUMBER_NEG, IS_NUMBER_INFINITY (defined in perl.h). If the value
528 of the number can fit an in UV, it is returned in the *valuep.
530 int grok_number(const char *pv, STRLEN len, UV *valuep)
535 =item grok_numeric_radix
537 Scan and skip for a numeric decimal separator (radix).
539 bool grok_numeric_radix(const char **sp, const char *send)
546 Return the SV from the GV.
555 Returns the glob with the given C<name> and a defined subroutine or
556 C<NULL>. The glob lives in the given C<stash>, or in the stashes
557 accessible via @ISA and UNIVERSAL::.
559 The argument C<level> should be either 0 or -1. If C<level==0>, as a
560 side-effect creates a glob with the given C<name> in the given C<stash>
561 which in the case of success contains an alias for the subroutine, and sets
562 up caching info for this glob. Similarly for all the searched stashes.
564 This function grants C<"SUPER"> token as a postfix of the stash name. The
565 GV returned from C<gv_fetchmeth> may be a method cache entry, which is not
566 visible to Perl code. So when calling C<call_sv>, you should not use
567 the GV directly; instead, you should use the method's CV, which can be
568 obtained from the GV with the C<GvCV> macro.
570 GV* gv_fetchmeth(HV* stash, const char* name, STRLEN len, I32 level)
577 See L<gv_fetchmethod_autoload>.
579 GV* gv_fetchmethod(HV* stash, const char* name)
584 =item gv_fetchmethod_autoload
586 Returns the glob which contains the subroutine to call to invoke the method
587 on the C<stash>. In fact in the presence of autoloading this may be the
588 glob for "AUTOLOAD". In this case the corresponding variable $AUTOLOAD is
591 The third parameter of C<gv_fetchmethod_autoload> determines whether
592 AUTOLOAD lookup is performed if the given method is not present: non-zero
593 means yes, look for AUTOLOAD; zero means no, don't look for AUTOLOAD.
594 Calling C<gv_fetchmethod> is equivalent to calling C<gv_fetchmethod_autoload>
595 with a non-zero C<autoload> parameter.
597 These functions grant C<"SUPER"> token as a prefix of the method name. Note
598 that if you want to keep the returned glob for a long time, you need to
599 check for it being "AUTOLOAD", since at the later time the call may load a
600 different subroutine due to $AUTOLOAD changing its value. Use the glob
601 created via a side effect to do this.
603 These functions have the same side-effects and as C<gv_fetchmeth> with
604 C<level==0>. C<name> should be writable if contains C<':'> or C<'
605 ''>. The warning against passing the GV returned by C<gv_fetchmeth> to
606 C<call_sv> apply equally to these functions.
608 GV* gv_fetchmethod_autoload(HV* stash, const char* name, I32 autoload)
615 Returns a pointer to the stash for a specified package. C<name> should
616 be a valid UTF-8 string. If C<create> is set then the package will be
617 created if it does not already exist. If C<create> is not set and the
618 package does not exist then NULL is returned.
620 HV* gv_stashpv(const char* name, I32 create)
627 Returns a pointer to the stash for a specified package, which must be a
628 valid UTF-8 string. See C<gv_stashpv>.
630 HV* gv_stashsv(SV* sv, I32 create)
637 Used to indicate list context. See C<GIMME_V>, C<GIMME> and
645 Indicates that arguments returned from a callback should be discarded. See
653 Used to force a Perl C<eval> wrapper around a callback. See
661 Indicates that no arguments are being sent to a callback. See
669 Used to indicate scalar context. See C<GIMME_V>, C<GIMME>, and
677 Used to indicate void context. See C<GIMME_V> and L<perlcall>.
684 This flag, used in the length slot of hash entries and magic structures,
685 specifies the structure contains a C<SV*> pointer where a C<char*> pointer
686 is to be expected. (For information only--not to be used).
693 Returns the computed hash stored in the hash entry.
702 Returns the actual pointer stored in the key slot of the hash entry. The
703 pointer may be either C<char*> or C<SV*>, depending on the value of
704 C<HeKLEN()>. Can be assigned to. The C<HePV()> or C<HeSVKEY()> macros are
705 usually preferable for finding the value of a key.
714 If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry
715 holds an C<SV*> key. Otherwise, holds the actual length of the key. Can
716 be assigned to. The C<HePV()> macro is usually preferable for finding key
719 STRLEN HeKLEN(HE* he)
726 Returns the key slot of the hash entry as a C<char*> value, doing any
727 necessary dereferencing of possibly C<SV*> keys. The length of the string
728 is placed in C<len> (this is a macro, so do I<not> use C<&len>). If you do
729 not care about what the length of the key is, you may use the global
730 variable C<PL_na>, though this is rather less efficient than using a local
731 variable. Remember though, that hash keys in perl are free to contain
732 embedded nulls, so using C<strlen()> or similar is not a good way to find
733 the length of hash keys. This is very similar to the C<SvPV()> macro
734 described elsewhere in this document.
736 char* HePV(HE* he, STRLEN len)
743 Returns the key as an C<SV*>, or C<Nullsv> if the hash entry does not
744 contain an C<SV*> key.
753 Returns the key as an C<SV*>. Will create and return a temporary mortal
754 C<SV*> if the hash entry contains only a C<char*> key.
756 SV* HeSVKEY_force(HE* he)
763 Sets the key to a given C<SV*>, taking care to set the appropriate flags to
764 indicate the presence of an C<SV*> key, and returns the same
767 SV* HeSVKEY_set(HE* he, SV* sv)
774 Returns the value slot (type C<SV*>) stored in the hash entry.
783 Returns the package name of a stash. See C<SvSTASH>, C<CvSTASH>.
785 char* HvNAME(HV* stash)
792 Clears a hash, making it empty.
794 void hv_clear(HV* tb)
801 Deletes a key/value pair in the hash. The value SV is removed from the
802 hash and returned to the caller. The C<klen> is the length of the key.
803 The C<flags> value will normally be zero; if set to G_DISCARD then NULL
806 SV* hv_delete(HV* tb, const char* key, I32 klen, I32 flags)
813 Deletes a key/value pair in the hash. The value SV is removed from the
814 hash and returned to the caller. The C<flags> value will normally be zero;
815 if set to G_DISCARD then NULL will be returned. C<hash> can be a valid
816 precomputed hash value, or 0 to ask for it to be computed.
818 SV* hv_delete_ent(HV* tb, SV* key, I32 flags, U32 hash)
825 Returns a boolean indicating whether the specified hash key exists. The
826 C<klen> is the length of the key.
828 bool hv_exists(HV* tb, const char* key, I32 klen)
835 Returns a boolean indicating whether the specified hash key exists. C<hash>
836 can be a valid precomputed hash value, or 0 to ask for it to be
839 bool hv_exists_ent(HV* tb, SV* key, U32 hash)
846 Returns the SV which corresponds to the specified key in the hash. The
847 C<klen> is the length of the key. If C<lval> is set then the fetch will be
848 part of a store. Check that the return value is non-null before
849 dereferencing it to a C<SV*>.
851 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
852 information on how to use this function on tied hashes.
854 SV** hv_fetch(HV* tb, const char* key, I32 klen, I32 lval)
861 Returns the hash entry which corresponds to the specified key in the hash.
862 C<hash> must be a valid precomputed hash number for the given C<key>, or 0
863 if you want the function to compute it. IF C<lval> is set then the fetch
864 will be part of a store. Make sure the return value is non-null before
865 accessing it. The return value when C<tb> is a tied hash is a pointer to a
866 static location, so be sure to make a copy of the structure if you need to
869 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
870 information on how to use this function on tied hashes.
872 HE* hv_fetch_ent(HV* tb, SV* key, I32 lval, U32 hash)
879 Prepares a starting point to traverse a hash table. Returns the number of
880 keys in the hash (i.e. the same as C<HvKEYS(tb)>). The return value is
881 currently only meaningful for hashes without tie magic.
883 NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
884 hash buckets that happen to be in use. If you still need that esoteric
885 value, you can get it through the macro C<HvFILL(tb)>.
887 I32 hv_iterinit(HV* tb)
894 Returns the key from the current position of the hash iterator. See
897 char* hv_iterkey(HE* entry, I32* retlen)
904 Returns the key as an C<SV*> from the current position of the hash
905 iterator. The return value will always be a mortal copy of the key. Also
908 SV* hv_iterkeysv(HE* entry)
915 Returns entries from a hash iterator. See C<hv_iterinit>.
917 HE* hv_iternext(HV* tb)
924 Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
927 SV* hv_iternextsv(HV* hv, char** key, I32* retlen)
934 Returns the value from the current position of the hash iterator. See
937 SV* hv_iterval(HV* tb, HE* entry)
944 Adds magic to a hash. See C<sv_magic>.
946 void hv_magic(HV* hv, GV* gv, int how)
953 Stores an SV in a hash. The hash key is specified as C<key> and C<klen> is
954 the length of the key. The C<hash> parameter is the precomputed hash
955 value; if it is zero then Perl will compute it. The return value will be
956 NULL if the operation failed or if the value did not need to be actually
957 stored within the hash (as in the case of tied hashes). Otherwise it can
958 be dereferenced to get the original C<SV*>. Note that the caller is
959 responsible for suitably incrementing the reference count of C<val> before
960 the call, and decrementing it if the function returned NULL.
962 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
963 information on how to use this function on tied hashes.
965 SV** hv_store(HV* tb, const char* key, I32 klen, SV* val, U32 hash)
972 Stores C<val> in a hash. The hash key is specified as C<key>. The C<hash>
973 parameter is the precomputed hash value; if it is zero then Perl will
974 compute it. The return value is the new hash entry so created. It will be
975 NULL if the operation failed or if the value did not need to be actually
976 stored within the hash (as in the case of tied hashes). Otherwise the
977 contents of the return value can be accessed using the C<He?> macros
978 described here. Note that the caller is responsible for suitably
979 incrementing the reference count of C<val> before the call, and
980 decrementing it if the function returned NULL.
982 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
983 information on how to use this function on tied hashes.
985 HE* hv_store_ent(HV* tb, SV* key, SV* val, U32 hash)
994 void hv_undef(HV* tb)
1001 Returns a boolean indicating whether the C C<char> is an ASCII alphanumeric
1002 character (including underscore) or digit.
1004 bool isALNUM(char ch)
1007 Found in file handy.h
1011 Returns a boolean indicating whether the C C<char> is an ASCII alphabetic
1014 bool isALPHA(char ch)
1017 Found in file handy.h
1021 Returns a boolean indicating whether the C C<char> is an ASCII
1024 bool isDIGIT(char ch)
1027 Found in file handy.h
1031 Returns a boolean indicating whether the C C<char> is a lowercase
1034 bool isLOWER(char ch)
1037 Found in file handy.h
1041 Returns a boolean indicating whether the C C<char> is whitespace.
1043 bool isSPACE(char ch)
1046 Found in file handy.h
1050 Returns a boolean indicating whether the C C<char> is an uppercase
1053 bool isUPPER(char ch)
1056 Found in file handy.h
1060 Tests if some arbitrary number of bytes begins in a valid UTF-8
1061 character. Note that an INVARIANT (i.e. ASCII) character is a valid UTF-8 character.
1062 The actual number of bytes in the UTF-8 character will be returned if
1063 it is valid, otherwise 0.
1065 STRLEN is_utf8_char(U8 *p)
1068 Found in file utf8.c
1070 =item is_utf8_string
1072 Returns true if first C<len> bytes of the given string form a valid UTF8
1073 string, false otherwise. Note that 'a valid UTF8 string' does not mean
1074 'a string that contains UTF8' because a valid ASCII string is a valid
1077 bool is_utf8_string(U8 *s, STRLEN len)
1080 Found in file utf8.c
1084 Variable which is setup by C<xsubpp> to indicate the number of
1085 items on the stack. See L<perlxs/"Variable-length Parameter Lists">.
1090 Found in file XSUB.h
1094 Variable which is setup by C<xsubpp> to indicate which of an
1095 XSUB's aliases was used to invoke it. See L<perlxs/"The ALIAS: Keyword">.
1100 Found in file XSUB.h
1104 Closing bracket on a callback. See C<ENTER> and L<perlcall>.
1109 Found in file scope.h
1113 Loads the module whose name is pointed to by the string part of name.
1114 Note that the actual module name, not its filename, should be given.
1115 Eg, "Foo::Bar" instead of "Foo/Bar.pm". flags can be any of
1116 PERL_LOADMOD_DENY, PERL_LOADMOD_NOIMPORT, or PERL_LOADMOD_IMPORT_OPS
1117 (or 0 for no flags). ver, if specified, provides version semantics
1118 similar to C<use Foo::Bar VERSION>. The optional trailing SV*
1119 arguments can be used to specify arguments to the module's import()
1120 method, similar to C<use Foo::Bar VERSION LIST>.
1122 void load_module(U32 flags, SV* name, SV* ver, ...)
1127 =item looks_like_number
1129 Test if an the content of an SV looks like a number (or is a
1130 number). C<Inf> and C<Infinity> are treated as numbers (so will not
1131 issue a non-numeric warning), even if your atof() doesn't grok them.
1133 I32 looks_like_number(SV* sv)
1140 Stack marker variable for the XSUB. See C<dMARK>.
1147 Clear something magical that the SV represents. See C<sv_magic>.
1149 int mg_clear(SV* sv)
1156 Copies the magic from one SV to another. See C<sv_magic>.
1158 int mg_copy(SV* sv, SV* nsv, const char* key, I32 klen)
1165 Finds the magic pointer for type matching the SV. See C<sv_magic>.
1167 MAGIC* mg_find(SV* sv, int type)
1174 Free any magic storage used by the SV. See C<sv_magic>.
1183 Do magic after a value is retrieved from the SV. See C<sv_magic>.
1192 Report on the SV's length. See C<sv_magic>.
1194 U32 mg_length(SV* sv)
1201 Turns on the magical status of an SV. See C<sv_magic>.
1203 void mg_magical(SV* sv)
1210 Do magic after a value is assigned to the SV. See C<sv_magic>.
1219 The XSUB-writer's interface to the C C<memmove> function. The C<src> is the
1220 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1221 the type. Can do overlapping moves. See also C<Copy>.
1223 void Move(void* src, void* dest, int nitems, type)
1226 Found in file handy.h
1230 The XSUB-writer's interface to the C C<malloc> function.
1232 void New(int id, void* ptr, int nitems, type)
1235 Found in file handy.h
1239 Creates a new AV. The reference count is set to 1.
1248 The XSUB-writer's interface to the C C<malloc> function, with
1251 void Newc(int id, void* ptr, int nitems, type, cast)
1254 Found in file handy.h
1258 Creates a constant sub equivalent to Perl C<sub FOO () { 123 }> which is
1259 eligible for inlining at compile-time.
1261 CV* newCONSTSUB(HV* stash, char* name, SV* sv)
1268 Creates a new HV. The reference count is set to 1.
1277 Creates an RV wrapper for an SV. The reference count for the original SV is
1280 SV* newRV_inc(SV* sv)
1287 Creates an RV wrapper for an SV. The reference count for the original
1288 SV is B<not> incremented.
1290 SV* newRV_noinc(SV *sv)
1297 Creates a new SV. A non-zero C<len> parameter indicates the number of
1298 bytes of preallocated string space the SV should have. An extra byte for a
1299 tailing NUL is also reserved. (SvPOK is not set for the SV even if string
1300 space is allocated.) The reference count for the new SV is set to 1.
1301 C<id> is an integer id between 0 and 1299 (used to identify leaks).
1303 SV* NEWSV(int id, STRLEN len)
1306 Found in file handy.h
1310 Creates a new SV and copies an integer into it. The reference count for the
1320 Creates a new SV and copies a floating point value into it.
1321 The reference count for the SV is set to 1.
1330 Creates a new SV and copies a string into it. The reference count for the
1331 SV is set to 1. If C<len> is zero, Perl will compute the length using
1332 strlen(). For efficiency, consider using C<newSVpvn> instead.
1334 SV* newSVpv(const char* s, STRLEN len)
1341 Creates a new SV an initialize it with the string formatted like
1344 SV* newSVpvf(const char* pat, ...)
1351 Creates a new SV and copies a string into it. The reference count for the
1352 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
1353 string. You are responsible for ensuring that the source string is at least
1356 SV* newSVpvn(const char* s, STRLEN len)
1361 =item newSVpvn_share
1363 Creates a new SV and populates it with a string from
1364 the string table. Turns on READONLY and FAKE.
1365 The idea here is that as string table is used for shared hash
1366 keys these strings will have SvPVX == HeKEY and hash lookup
1367 will avoid string compare.
1369 SV* newSVpvn_share(const char* s, I32 len, U32 hash)
1376 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
1377 it will be upgraded to one. If C<classname> is non-null then the new SV will
1378 be blessed in the specified package. The new SV is returned and its
1379 reference count is 1.
1381 SV* newSVrv(SV* rv, const char* classname)
1388 Creates a new SV which is an exact duplicate of the original SV.
1390 SV* newSVsv(SV* old)
1397 Creates a new SV and copies an unsigned integer into it.
1398 The reference count for the SV is set to 1.
1407 Used by C<xsubpp> to hook up XSUBs as Perl subs.
1414 Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
1418 Found in file XSUB.h
1422 The XSUB-writer's interface to the C C<malloc> function. The allocated
1423 memory is zeroed with C<memzero>.
1425 void Newz(int id, void* ptr, int nitems, type)
1428 Found in file handy.h
1439 Null character pointer.
1442 Found in file handy.h
1463 Found in file handy.h
1467 The original stack mark for the XSUB. See C<dORIGMARK>.
1474 Allocates a new Perl interpreter. See L<perlembed>.
1476 PerlInterpreter* perl_alloc()
1479 Found in file perl.c
1481 =item perl_construct
1483 Initializes a new Perl interpreter. See L<perlembed>.
1485 void perl_construct(PerlInterpreter* interp)
1488 Found in file perl.c
1492 Shuts down a Perl interpreter. See L<perlembed>.
1494 void perl_destruct(PerlInterpreter* interp)
1497 Found in file perl.c
1501 Releases a Perl interpreter. See L<perlembed>.
1503 void perl_free(PerlInterpreter* interp)
1506 Found in file perl.c
1510 Tells a Perl interpreter to parse a Perl script. See L<perlembed>.
1512 int perl_parse(PerlInterpreter* interp, XSINIT_t xsinit, int argc, char** argv, char** env)
1515 Found in file perl.c
1519 Tells a Perl interpreter to run. See L<perlembed>.
1521 int perl_run(PerlInterpreter* interp)
1524 Found in file perl.c
1528 C<PL_modglobal> is a general purpose, interpreter global HV for use by
1529 extensions that need to keep information on a per-interpreter basis.
1530 In a pinch, it can also be used as a symbol table for extensions
1531 to share data among each other. It is a good idea to use keys
1532 prefixed by the package name of the extension that owns the data.
1537 Found in file intrpvar.h
1541 A convenience variable which is typically used with C<SvPV> when one
1542 doesn't care about the length of the string. It is usually more efficient
1543 to either declare a local variable and use that instead or to use the
1544 C<SvPV_nolen> macro.
1549 Found in file thrdvar.h
1553 This is the C<false> SV. See C<PL_sv_yes>. Always refer to this as
1559 Found in file intrpvar.h
1563 This is the C<undef> SV. Always refer to this as C<&PL_sv_undef>.
1568 Found in file intrpvar.h
1572 This is the C<true> SV. See C<PL_sv_no>. Always refer to this as
1578 Found in file intrpvar.h
1582 Pops an integer off the stack.
1591 Pops a long off the stack.
1600 Pops a double off the stack.
1609 Pops a string off the stack. Deprecated. New code should provide
1610 a STRLEN n_a and use POPpx.
1619 Pops a string off the stack which must consist of bytes i.e. characters < 256.
1620 Requires a variable STRLEN n_a in scope.
1629 Pops a string off the stack.
1630 Requires a variable STRLEN n_a in scope.
1639 Pops an SV off the stack.
1648 Push an integer onto the stack. The stack must have room for this element.
1649 Handles 'set' magic. See C<XPUSHi>.
1658 Opening bracket for arguments on a callback. See C<PUTBACK> and
1668 Push a double onto the stack. The stack must have room for this element.
1669 Handles 'set' magic. See C<XPUSHn>.
1678 Push a string onto the stack. The stack must have room for this element.
1679 The C<len> indicates the length of the string. Handles 'set' magic. See
1682 void PUSHp(char* str, STRLEN len)
1689 Push an SV onto the stack. The stack must have room for this element.
1690 Does not handle 'set' magic. See C<XPUSHs>.
1699 Push an unsigned integer onto the stack. The stack must have room for this
1700 element. See C<XPUSHu>.
1709 Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
1710 See C<PUSHMARK> and L<perlcall> for other uses.
1719 The XSUB-writer's interface to the C C<realloc> function.
1721 void Renew(void* ptr, int nitems, type)
1724 Found in file handy.h
1728 The XSUB-writer's interface to the C C<realloc> function, with
1731 void Renewc(void* ptr, int nitems, type, cast)
1734 Found in file handy.h
1738 Tells Perl to C<require> the file named by the string argument. It is
1739 analogous to the Perl code C<eval "require '$file'">. It's even
1740 implemented that way; consider using Perl_load_module instead.
1742 NOTE: the perl_ form of this function is deprecated.
1744 void require_pv(const char* pv)
1747 Found in file perl.c
1751 Variable which is setup by C<xsubpp> to hold the return value for an
1752 XSUB. This is always the proper type for the XSUB. See
1753 L<perlxs/"The RETVAL Variable">.
1758 Found in file XSUB.h
1762 The XSUB-writer's interface to the C C<free> function.
1764 void Safefree(void* ptr)
1767 Found in file handy.h
1771 Copy a string to a safe spot. This does not use an SV.
1773 char* savepv(const char* sv)
1776 Found in file util.c
1780 Copy a string to a safe spot. The C<len> indicates number of bytes to
1781 copy. This does not use an SV.
1783 char* savepvn(const char* sv, I32 len)
1786 Found in file util.c
1790 Opening bracket for temporaries on a callback. See C<FREETMPS> and
1796 Found in file scope.h
1800 Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and
1808 Refetch the stack pointer. Used after a callback. See L<perlcall>.
1817 Used to access elements on the XSUB's stack.
1822 Found in file XSUB.h
1826 Test two strings to see if they are equal. Returns true or false.
1828 bool strEQ(char* s1, char* s2)
1831 Found in file handy.h
1835 Test two strings to see if the first, C<s1>, is greater than or equal to
1836 the second, C<s2>. Returns true or false.
1838 bool strGE(char* s1, char* s2)
1841 Found in file handy.h
1845 Test two strings to see if the first, C<s1>, is greater than the second,
1846 C<s2>. Returns true or false.
1848 bool strGT(char* s1, char* s2)
1851 Found in file handy.h
1855 Test two strings to see if the first, C<s1>, is less than or equal to the
1856 second, C<s2>. Returns true or false.
1858 bool strLE(char* s1, char* s2)
1861 Found in file handy.h
1865 Test two strings to see if the first, C<s1>, is less than the second,
1866 C<s2>. Returns true or false.
1868 bool strLT(char* s1, char* s2)
1871 Found in file handy.h
1875 Test two strings to see if they are different. Returns true or
1878 bool strNE(char* s1, char* s2)
1881 Found in file handy.h
1885 Test two strings to see if they are equal. The C<len> parameter indicates
1886 the number of bytes to compare. Returns true or false. (A wrapper for
1889 bool strnEQ(char* s1, char* s2, STRLEN len)
1892 Found in file handy.h
1896 Test two strings to see if they are different. The C<len> parameter
1897 indicates the number of bytes to compare. Returns true or false. (A
1898 wrapper for C<strncmp>).
1900 bool strnNE(char* s1, char* s2, STRLEN len)
1903 Found in file handy.h
1907 This is an architecture-independent macro to copy one structure to another.
1909 void StructCopy(type src, type dest, type)
1912 Found in file handy.h
1916 Returns the length of the string which is in the SV. See C<SvLEN>.
1918 STRLEN SvCUR(SV* sv)
1925 Set the length of the string which is in the SV. See C<SvCUR>.
1927 void SvCUR_set(SV* sv, STRLEN len)
1934 Returns a pointer to the last character in the string which is in the SV.
1935 See C<SvCUR>. Access the character as *(SvEND(sv)).
1944 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
1945 argument more than once.
1947 void SvGETMAGIC(SV* sv)
1954 Expands the character buffer in the SV so that it has room for the
1955 indicated number of bytes (remember to reserve space for an extra trailing
1956 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
1957 Returns a pointer to the character buffer.
1959 char * SvGROW(SV* sv, STRLEN len)
1966 Returns a boolean indicating whether the SV contains an integer.
1975 Returns a boolean indicating whether the SV contains an integer. Checks
1976 the B<private> setting. Use C<SvIOK>.
1985 Returns a boolean indicating whether the SV contains an signed integer.
1987 void SvIOK_notUV(SV* sv)
1994 Unsets the IV status of an SV.
1996 void SvIOK_off(SV* sv)
2003 Tells an SV that it is an integer.
2005 void SvIOK_on(SV* sv)
2012 Tells an SV that it is an integer and disables all other OK bits.
2014 void SvIOK_only(SV* sv)
2021 Tells and SV that it is an unsigned integer and disables all other OK bits.
2023 void SvIOK_only_UV(SV* sv)
2030 Returns a boolean indicating whether the SV contains an unsigned integer.
2032 void SvIOK_UV(SV* sv)
2039 Coerces the given SV to an integer and returns it.
2048 Returns the integer which is stored in the SV, assuming SvIOK is
2058 Returns the size of the string buffer in the SV, not including any part
2059 attributable to C<SvOOK>. See C<SvCUR>.
2061 STRLEN SvLEN(SV* sv)
2068 Returns a boolean indicating whether the SV contains a number, integer or
2078 Returns a boolean indicating whether the SV contains a number, integer or
2079 double. Checks the B<private> setting. Use C<SvNIOK>.
2081 bool SvNIOKp(SV* sv)
2088 Unsets the NV/IV status of an SV.
2090 void SvNIOK_off(SV* sv)
2097 Returns a boolean indicating whether the SV contains a double.
2106 Returns a boolean indicating whether the SV contains a double. Checks the
2107 B<private> setting. Use C<SvNOK>.
2116 Unsets the NV status of an SV.
2118 void SvNOK_off(SV* sv)
2125 Tells an SV that it is a double.
2127 void SvNOK_on(SV* sv)
2134 Tells an SV that it is a double and disables all other OK bits.
2136 void SvNOK_only(SV* sv)
2143 Coerce the given SV to a double and return it.
2152 Returns the double which is stored in the SV, assuming SvNOK is
2162 Returns a boolean indicating whether the value is an SV.
2171 Returns a boolean indicating whether the SvIVX is a valid offset value for
2172 the SvPVX. This hack is used internally to speed up removal of characters
2173 from the beginning of a SvPV. When SvOOK is true, then the start of the
2174 allocated string buffer is really (SvPVX - SvIVX).
2183 Returns a boolean indicating whether the SV contains a character
2193 Returns a boolean indicating whether the SV contains a character string.
2194 Checks the B<private> setting. Use C<SvPOK>.
2203 Unsets the PV status of an SV.
2205 void SvPOK_off(SV* sv)
2212 Tells an SV that it is a string.
2214 void SvPOK_on(SV* sv)
2221 Tells an SV that it is a string and disables all other OK bits.
2222 Will also turn off the UTF8 status.
2224 void SvPOK_only(SV* sv)
2229 =item SvPOK_only_UTF8
2231 Tells an SV that it is a string and disables all other OK bits,
2232 and leaves the UTF8 status as it was.
2234 void SvPOK_only_UTF8(SV* sv)
2241 Returns a pointer to the string in the SV, or a stringified form of the SV
2242 if the SV does not contain a string. Handles 'get' magic.
2244 char* SvPV(SV* sv, STRLEN len)
2251 Returns a pointer to the string in the SV. The SV must contain a
2261 Like <SvPV> but will force the SV into becoming a string (SvPOK). You want
2262 force if you are going to update the SvPVX directly.
2264 char* SvPV_force(SV* sv, STRLEN len)
2271 Returns a pointer to the string in the SV, or a stringified form of the SV
2272 if the SV does not contain a string. Handles 'get' magic.
2274 char* SvPV_nolen(SV* sv)
2281 Returns the value of the object's reference count.
2283 U32 SvREFCNT(SV* sv)
2290 Decrements the reference count of the given SV.
2292 void SvREFCNT_dec(SV* sv)
2299 Increments the reference count of the given SV.
2301 SV* SvREFCNT_inc(SV* sv)
2308 Tests if the SV is an RV.
2317 Unsets the RV status of an SV.
2319 void SvROK_off(SV* sv)
2326 Tells an SV that it is an RV.
2328 void SvROK_on(SV* sv)
2335 Dereferences an RV to return the SV.
2344 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
2345 argument more than once.
2347 void SvSETMAGIC(SV* sv)
2354 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
2357 void SvSetSV(SV* dsb, SV* ssv)
2362 =item SvSetSV_nosteal
2364 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
2365 ssv. May evaluate arguments more than once.
2367 void SvSetSV_nosteal(SV* dsv, SV* ssv)
2374 Returns the stash of the SV.
2383 Taints an SV if tainting is enabled
2385 void SvTAINT(SV* sv)
2392 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
2395 bool SvTAINTED(SV* sv)
2402 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
2403 some of Perl's fundamental security features. XS module authors should not
2404 use this function unless they fully understand all the implications of
2405 unconditionally untainting the value. Untainting should be done in the
2406 standard perl fashion, via a carefully crafted regexp, rather than directly
2407 untainting variables.
2409 void SvTAINTED_off(SV* sv)
2416 Marks an SV as tainted.
2418 void SvTAINTED_on(SV* sv)
2425 Returns a boolean indicating whether Perl would evaluate the SV as true or
2426 false, defined or undefined. Does not handle 'get' magic.
2435 Returns the type of the SV. See C<svtype>.
2437 svtype SvTYPE(SV* sv)
2444 An enum of flags for Perl types. These are found in the file B<sv.h>
2445 in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
2452 Integer type flag for scalars. See C<svtype>.
2459 Double type flag for scalars. See C<svtype>.
2466 Pointer type flag for scalars. See C<svtype>.
2473 Type flag for arrays. See C<svtype>.
2480 Type flag for code refs. See C<svtype>.
2487 Type flag for hashes. See C<svtype>.
2494 Type flag for blessed scalars. See C<svtype>.
2501 Returns a boolean indicating whether the SV contains an unsigned integer.
2510 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
2511 perform the upgrade if necessary. See C<svtype>.
2513 void SvUPGRADE(SV* sv, svtype type)
2520 Returns a boolean indicating whether the SV contains UTF-8 encoded data.
2529 Unsets the UTF8 status of an SV.
2531 void SvUTF8_off(SV *sv)
2538 Turn on the UTF8 status of an SV (the data is not changed, just the flag).
2539 Do not use frivolously.
2541 void SvUTF8_on(SV *sv)
2548 Coerces the given SV to an unsigned integer and returns it.
2557 Returns the unsigned integer which is stored in the SV, assuming SvIOK is
2567 Marks an SV as mortal. The SV will be destroyed when the current context
2570 SV* sv_2mortal(SV* sv)
2577 Blesses an SV into a specified package. The SV must be an RV. The package
2578 must be designated by its stash (see C<gv_stashpv()>). The reference count
2579 of the SV is unaffected.
2581 SV* sv_bless(SV* sv, HV* stash)
2588 Concatenates the string onto the end of the string which is in the SV.
2589 If the SV has the UTF8 status set, then the bytes appended should be
2590 valid UTF8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
2592 void sv_catpv(SV* sv, const char* ptr)
2599 Processes its arguments like C<sprintf> and appends the formatted
2600 output to an SV. If the appended data contains "wide" characters
2601 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
2602 and characters >255 formatted with %c), the original SV might get
2603 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic.
2604 C<SvSETMAGIC()> must typically be called after calling this function
2605 to handle 'set' magic.
2607 void sv_catpvf(SV* sv, const char* pat, ...)
2614 Like C<sv_catpvf>, but also handles 'set' magic.
2616 void sv_catpvf_mg(SV *sv, const char* pat, ...)
2623 Concatenates the string onto the end of the string which is in the SV. The
2624 C<len> indicates number of bytes to copy. If the SV has the UTF8
2625 status set, then the bytes appended should be valid UTF8.
2626 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
2628 void sv_catpvn(SV* sv, const char* ptr, STRLEN len)
2633 =item sv_catpvn_flags
2635 Concatenates the string onto the end of the string which is in the SV. The
2636 C<len> indicates number of bytes to copy. If the SV has the UTF8
2637 status set, then the bytes appended should be valid UTF8.
2638 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
2639 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
2640 in terms of this function.
2642 void sv_catpvn_flags(SV* sv, const char* ptr, STRLEN len, I32 flags)
2649 Like C<sv_catpvn>, but also handles 'set' magic.
2651 void sv_catpvn_mg(SV *sv, const char *ptr, STRLEN len)
2658 Like C<sv_catpv>, but also handles 'set' magic.
2660 void sv_catpv_mg(SV *sv, const char *ptr)
2667 Concatenates the string from SV C<ssv> onto the end of the string in
2668 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
2669 not 'set' magic. See C<sv_catsv_mg>.
2671 void sv_catsv(SV* dsv, SV* ssv)
2676 =item sv_catsv_flags
2678 Concatenates the string from SV C<ssv> onto the end of the string in
2679 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
2680 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
2681 and C<sv_catsv_nomg> are implemented in terms of this function.
2683 void sv_catsv_flags(SV* dsv, SV* ssv, I32 flags)
2690 Like C<sv_catsv>, but also handles 'set' magic.
2692 void sv_catsv_mg(SV *dstr, SV *sstr)
2699 Efficient removal of characters from the beginning of the string buffer.
2700 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
2701 the string buffer. The C<ptr> becomes the first character of the adjusted
2704 void sv_chop(SV* sv, char* ptr)
2711 Clear an SV, making it empty. Does not free the memory used by the SV
2714 void sv_clear(SV* sv)
2721 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
2722 string in C<sv1> is less than, equal to, or greater than the string in
2725 I32 sv_cmp(SV* sv1, SV* sv2)
2732 Compares the strings in two SVs in a locale-aware manner. See
2735 I32 sv_cmp_locale(SV* sv1, SV* sv2)
2742 Auto-decrement of the value in the SV.
2749 =item sv_derived_from
2751 Returns a boolean indicating whether the SV is derived from the specified
2752 class. This is the function that implements C<UNIVERSAL::isa>. It works
2753 for class names as well as for objects.
2755 bool sv_derived_from(SV* sv, const char* name)
2758 Found in file universal.c
2762 Returns a boolean indicating whether the strings in the two SVs are
2765 I32 sv_eq(SV* sv1, SV* sv2)
2772 Free the memory used by an SV.
2774 void sv_free(SV* sv)
2781 Fill the sv with current working directory
2783 int sv_getcwd(SV* sv)
2786 Found in file util.c
2790 Get a line from the filehandle and store it into the SV, optionally
2791 appending to the currently-stored string.
2793 char* sv_gets(SV* sv, PerlIO* fp, I32 append)
2800 Expands the character buffer in the SV. This will use C<sv_unref> and will
2801 upgrade the SV to C<SVt_PV>. Returns a pointer to the character buffer.
2804 char* sv_grow(SV* sv, STRLEN newlen)
2811 Auto-increment of the value in the SV.
2820 Inserts a string at the specified offset/length within the SV. Similar to
2821 the Perl substr() function.
2823 void sv_insert(SV* bigsv, STRLEN offset, STRLEN len, char* little, STRLEN littlelen)
2830 Returns a boolean indicating whether the SV is blessed into the specified
2831 class. This does not check for subtypes; use C<sv_derived_from> to verify
2832 an inheritance relationship.
2834 int sv_isa(SV* sv, const char* name)
2841 Returns a boolean indicating whether the SV is an RV pointing to a blessed
2842 object. If the SV is not an RV, or if the object is not blessed, then this
2845 int sv_isobject(SV* sv)
2852 Returns the length of the string in the SV. See also C<SvCUR>.
2854 STRLEN sv_len(SV* sv)
2861 Returns the number of characters in the string in an SV, counting wide
2862 UTF8 bytes as a single character.
2864 STRLEN sv_len_utf8(SV* sv)
2871 Adds magic to an SV.
2873 void sv_magic(SV* sv, SV* obj, int how, const char* name, I32 namlen)
2880 Creates a new SV which is a copy of the original SV. The new SV is marked
2883 SV* sv_mortalcopy(SV* oldsv)
2890 Creates a new SV which is mortal. The reference count of the SV is set to 1.
2899 Get a sensible string out of the SV somehow.
2901 char* sv_pvn_force(SV* sv, STRLEN* lp)
2906 =item sv_pvn_force_flags
2908 Get a sensible string out of the SV somehow.
2909 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
2910 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
2911 implemented in terms of this function.
2913 char* sv_pvn_force_flags(SV* sv, STRLEN* lp, I32 flags)
2918 =item sv_pvutf8n_force
2920 Get a sensible UTF8-encoded string out of the SV somehow. See
2923 char* sv_pvutf8n_force(SV* sv, STRLEN* lp)
2930 Wrap or emulate realpath(3).
2932 int sv_realpath(SV* sv, char *path, STRLEN len)
2935 Found in file util.c
2939 Returns a string describing what the SV is a reference to.
2941 char* sv_reftype(SV* sv, int ob)
2948 Make the first argument a copy of the second, then delete the original.
2950 void sv_replace(SV* sv, SV* nsv)
2959 SV* sv_rvweaken(SV *sv)
2966 Copies an integer into the given SV. Does not handle 'set' magic. See
2969 void sv_setiv(SV* sv, IV num)
2976 Like C<sv_setiv>, but also handles 'set' magic.
2978 void sv_setiv_mg(SV *sv, IV i)
2985 Copies a double into the given SV. Does not handle 'set' magic. See
2988 void sv_setnv(SV* sv, NV num)
2995 Like C<sv_setnv>, but also handles 'set' magic.
2997 void sv_setnv_mg(SV *sv, NV num)
3004 Copies a string into an SV. The string must be null-terminated. Does not
3005 handle 'set' magic. See C<sv_setpv_mg>.
3007 void sv_setpv(SV* sv, const char* ptr)
3014 Processes its arguments like C<sprintf> and sets an SV to the formatted
3015 output. Does not handle 'set' magic. See C<sv_setpvf_mg>.
3017 void sv_setpvf(SV* sv, const char* pat, ...)
3024 Like C<sv_setpvf>, but also handles 'set' magic.
3026 void sv_setpvf_mg(SV *sv, const char* pat, ...)
3033 Copies an integer into the given SV, also updating its string value.
3034 Does not handle 'set' magic. See C<sv_setpviv_mg>.
3036 void sv_setpviv(SV* sv, IV num)
3043 Like C<sv_setpviv>, but also handles 'set' magic.
3045 void sv_setpviv_mg(SV *sv, IV iv)
3052 Copies a string into an SV. The C<len> parameter indicates the number of
3053 bytes to be copied. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3055 void sv_setpvn(SV* sv, const char* ptr, STRLEN len)
3062 Like C<sv_setpvn>, but also handles 'set' magic.
3064 void sv_setpvn_mg(SV *sv, const char *ptr, STRLEN len)
3071 Like C<sv_setpv>, but also handles 'set' magic.
3073 void sv_setpv_mg(SV *sv, const char *ptr)
3080 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
3081 argument will be upgraded to an RV. That RV will be modified to point to
3082 the new SV. The C<classname> argument indicates the package for the
3083 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
3084 will be returned and will have a reference count of 1.
3086 SV* sv_setref_iv(SV* rv, const char* classname, IV iv)
3093 Copies a double into a new SV, optionally blessing the SV. The C<rv>
3094 argument will be upgraded to an RV. That RV will be modified to point to
3095 the new SV. The C<classname> argument indicates the package for the
3096 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
3097 will be returned and will have a reference count of 1.
3099 SV* sv_setref_nv(SV* rv, const char* classname, NV nv)
3106 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
3107 argument will be upgraded to an RV. That RV will be modified to point to
3108 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
3109 into the SV. The C<classname> argument indicates the package for the
3110 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
3111 will be returned and will have a reference count of 1.
3113 Do not use with other Perl types such as HV, AV, SV, CV, because those
3114 objects will become corrupted by the pointer copy process.
3116 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
3118 SV* sv_setref_pv(SV* rv, const char* classname, void* pv)
3125 Copies a string into a new SV, optionally blessing the SV. The length of the
3126 string must be specified with C<n>. The C<rv> argument will be upgraded to
3127 an RV. That RV will be modified to point to the new SV. The C<classname>
3128 argument indicates the package for the blessing. Set C<classname> to
3129 C<Nullch> to avoid the blessing. The new SV will be returned and will have
3130 a reference count of 1.
3132 Note that C<sv_setref_pv> copies the pointer while this copies the string.
3134 SV* sv_setref_pvn(SV* rv, const char* classname, char* pv, STRLEN n)
3141 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
3142 argument will be upgraded to an RV. That RV will be modified to point to
3143 the new SV. The C<classname> argument indicates the package for the
3144 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
3145 will be returned and will have a reference count of 1.
3147 SV* sv_setref_uv(SV* rv, const char* classname, UV uv)
3154 Copies the contents of the source SV C<ssv> into the destination SV C<dsv>.
3155 The source SV may be destroyed if it is mortal. Does not handle 'set'
3156 magic. See the macro forms C<SvSetSV>, C<SvSetSV_nosteal> and
3159 void sv_setsv(SV* dsv, SV* ssv)
3164 =item sv_setsv_flags
3166 Copies the contents of the source SV C<ssv> into the destination SV C<dsv>.
3167 The source SV may be destroyed if it is mortal. Does not handle 'set'
3168 magic. If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<ssv> if
3169 appropriate, else not. C<sv_setsv> and C<sv_setsv_nomg> are implemented
3170 in terms of this function.
3172 void sv_setsv_flags(SV* dsv, SV* ssv, I32 flags)
3179 Like C<sv_setsv>, but also handles 'set' magic.
3181 void sv_setsv_mg(SV *dstr, SV *sstr)
3188 Copies an unsigned integer into the given SV. Does not handle 'set' magic.
3191 void sv_setuv(SV* sv, UV num)
3198 Like C<sv_setuv>, but also handles 'set' magic.
3200 void sv_setuv_mg(SV *sv, UV u)
3207 Returns true if the SV has a true value by Perl's rules.
3216 Removes magic from an SV.
3218 int sv_unmagic(SV* sv, int type)
3225 Unsets the RV status of the SV, and decrements the reference count of
3226 whatever was being referenced by the RV. This can almost be thought of
3227 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
3228 being zero. See C<SvROK_off>.
3230 void sv_unref(SV* sv)
3235 =item sv_unref_flags
3237 Unsets the RV status of the SV, and decrements the reference count of
3238 whatever was being referenced by the RV. This can almost be thought of
3239 as a reversal of C<newSVrv>. The C<cflags> argument can contain
3240 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
3241 (otherwise the decrementing is conditional on the reference count being
3242 different from one or the reference being a readonly SV).
3245 void sv_unref_flags(SV* sv, U32 flags)
3252 Upgrade an SV to a more complex form. Use C<SvUPGRADE>. See
3255 bool sv_upgrade(SV* sv, U32 mt)
3262 Tells an SV to use C<ptr> to find its string value. Normally the string is
3263 stored inside the SV but sv_usepvn allows the SV to use an outside string.
3264 The C<ptr> should point to memory that was allocated by C<malloc>. The
3265 string length, C<len>, must be supplied. This function will realloc the
3266 memory pointed to by C<ptr>, so that pointer should not be freed or used by
3267 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
3268 See C<sv_usepvn_mg>.
3270 void sv_usepvn(SV* sv, char* ptr, STRLEN len)
3277 Like C<sv_usepvn>, but also handles 'set' magic.
3279 void sv_usepvn_mg(SV *sv, char *ptr, STRLEN len)
3284 =item sv_utf8_decode
3286 Convert the octets in the PV from UTF-8 to chars. Scan for validity and then
3287 turn of SvUTF8 if needed so that we see characters. Used as a building block
3288 for decode_utf8 in Encode.xs
3290 NOTE: this function is experimental and may change or be
3291 removed without notice.
3293 bool sv_utf8_decode(SV *sv)
3298 =item sv_utf8_downgrade
3300 Attempt to convert the PV of an SV from UTF8-encoded to byte encoding.
3301 This may not be possible if the PV contains non-byte encoding characters;
3302 if this is the case, either returns false or, if C<fail_ok> is not
3305 NOTE: this function is experimental and may change or be
3306 removed without notice.
3308 bool sv_utf8_downgrade(SV *sv, bool fail_ok)
3313 =item sv_utf8_encode
3315 Convert the PV of an SV to UTF8-encoded, but then turn off the C<SvUTF8>
3316 flag so that it looks like octets again. Used as a building block
3317 for encode_utf8 in Encode.xs
3319 void sv_utf8_encode(SV *sv)
3324 =item sv_utf8_upgrade
3326 Convert the PV of an SV to its UTF8-encoded form.
3327 Forces the SV to string form it it is not already.
3328 Always sets the SvUTF8 flag to avoid future validity checks even
3329 if all the bytes have hibit clear.
3331 STRLEN sv_utf8_upgrade(SV *sv)
3336 =item sv_utf8_upgrade_flags
3338 Convert the PV of an SV to its UTF8-encoded form.
3339 Forces the SV to string form it it is not already.
3340 Always sets the SvUTF8 flag to avoid future validity checks even
3341 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
3342 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
3343 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3345 STRLEN sv_utf8_upgrade_flags(SV *sv, I32 flags)
3352 Processes its arguments like C<vsprintf> and appends the formatted output
3353 to an SV. Uses an array of SVs if the C style variable argument list is
3354 missing (NULL). When running with taint checks enabled, indicates via
3355 C<maybe_tainted> if results are untrustworthy (often due to the use of
3358 void sv_vcatpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
3365 Works like C<vcatpvfn> but copies the text into the SV instead of
3368 void sv_vsetpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
3375 Variable which is setup by C<xsubpp> to designate the object in a C++
3376 XSUB. This is always the proper type for the C++ object. See C<CLASS> and
3377 L<perlxs/"Using XS With C++">.
3382 Found in file XSUB.h
3386 Converts the specified character to lowercase.
3388 char toLOWER(char ch)
3391 Found in file handy.h
3395 Converts the specified character to uppercase.
3397 char toUPPER(char ch)
3400 Found in file handy.h
3402 =item utf8n_to_uvchr
3404 Returns the native character value of the first character in the string C<s>
3405 which is assumed to be in UTF8 encoding; C<retlen> will be set to the
3406 length, in bytes, of that character.
3408 Allows length and flags to be passed to low level routine.
3410 UV utf8n_to_uvchr(U8 *s, STRLEN curlen, STRLEN* retlen, U32 flags)
3413 Found in file utf8.c
3415 =item utf8n_to_uvuni
3417 Bottom level UTF-8 decode routine.
3418 Returns the unicode code point value of the first character in the string C<s>
3419 which is assumed to be in UTF8 encoding and no longer than C<curlen>;
3420 C<retlen> will be set to the length, in bytes, of that character.
3422 If C<s> does not point to a well-formed UTF8 character, the behaviour
3423 is dependent on the value of C<flags>: if it contains UTF8_CHECK_ONLY,
3424 it is assumed that the caller will raise a warning, and this function
3425 will silently just set C<retlen> to C<-1> and return zero. If the
3426 C<flags> does not contain UTF8_CHECK_ONLY, warnings about
3427 malformations will be given, C<retlen> will be set to the expected
3428 length of the UTF-8 character in bytes, and zero will be returned.
3430 The C<flags> can also contain various flags to allow deviations from
3431 the strict UTF-8 encoding (see F<utf8.h>).
3433 Most code should use utf8_to_uvchr() rather than call this directly.
3435 UV utf8n_to_uvuni(U8 *s, STRLEN curlen, STRLEN* retlen, U32 flags)
3438 Found in file utf8.c
3442 Returns the number of UTF8 characters between the UTF-8 pointers C<a>
3445 WARNING: use only if you *know* that the pointers point inside the
3448 IV utf8_distance(U8 *a, U8 *b)
3451 Found in file utf8.c
3455 Return the UTF-8 pointer C<s> displaced by C<off> characters, either
3456 forward or backward.
3458 WARNING: do not use the following unless you *know* C<off> is within
3459 the UTF-8 data pointed to by C<s> *and* that on entry C<s> is aligned
3460 on the first byte of character or just after the last byte of a character.
3462 U8* utf8_hop(U8 *s, I32 off)
3465 Found in file utf8.c
3469 Return the length of the UTF-8 char encoded string C<s> in characters.
3470 Stops at C<e> (inclusive). If C<e E<lt> s> or if the scan would end
3471 up past C<e>, croaks.
3473 STRLEN utf8_length(U8* s, U8 *e)
3476 Found in file utf8.c
3480 Converts a string C<s> of length C<len> from UTF8 into byte encoding.
3481 Unlike C<bytes_to_utf8>, this over-writes the original string, and
3482 updates len to contain the new length.
3483 Returns zero on failure, setting C<len> to -1.
3485 NOTE: this function is experimental and may change or be
3486 removed without notice.
3488 U8* utf8_to_bytes(U8 *s, STRLEN *len)
3491 Found in file utf8.c
3495 Returns the native character value of the first character in the string C<s>
3496 which is assumed to be in UTF8 encoding; C<retlen> will be set to the
3497 length, in bytes, of that character.
3499 If C<s> does not point to a well-formed UTF8 character, zero is
3500 returned and retlen is set, if possible, to -1.
3502 UV utf8_to_uvchr(U8 *s, STRLEN* retlen)
3505 Found in file utf8.c
3509 Returns the Unicode code point of the first character in the string C<s>
3510 which is assumed to be in UTF8 encoding; C<retlen> will be set to the
3511 length, in bytes, of that character.
3513 This function should only be used when returned UV is considered
3514 an index into the Unicode semantic tables (e.g. swashes).
3516 If C<s> does not point to a well-formed UTF8 character, zero is
3517 returned and retlen is set, if possible, to -1.
3519 UV utf8_to_uvuni(U8 *s, STRLEN* retlen)
3522 Found in file utf8.c
3526 Adds the UTF8 representation of the Native codepoint C<uv> to the end
3527 of the string C<d>; C<d> should be have at least C<UTF8_MAXLEN+1> free
3528 bytes available. The return value is the pointer to the byte after the
3529 end of the new character. In other words,
3531 d = uvchr_to_utf8(d, uv);
3533 is the recommended wide native character-aware way of saying
3537 U8* uvchr_to_utf8(U8 *d, UV uv)
3540 Found in file utf8.c
3544 Adds the UTF8 representation of the Unicode codepoint C<uv> to the end
3545 of the string C<d>; C<d> should be have at least C<UTF8_MAXLEN+1> free
3546 bytes available. The return value is the pointer to the byte after the
3547 end of the new character. In other words,
3549 d = uvuni_to_utf8(d, uv);
3551 is the recommended Unicode-aware way of saying
3555 U8* uvuni_to_utf8(U8 *d, UV uv)
3558 Found in file utf8.c
3562 This is the XSUB-writer's interface to Perl's C<warn> function. Use this
3563 function the same way you use the C C<printf> function. See
3566 void warn(const char* pat, ...)
3569 Found in file util.c
3573 Push an integer onto the stack, extending the stack if necessary. Handles
3574 'set' magic. See C<PUSHi>.
3583 Push a double onto the stack, extending the stack if necessary. Handles
3584 'set' magic. See C<PUSHn>.
3593 Push a string onto the stack, extending the stack if necessary. The C<len>
3594 indicates the length of the string. Handles 'set' magic. See
3597 void XPUSHp(char* str, STRLEN len)
3604 Push an SV onto the stack, extending the stack if necessary. Does not
3605 handle 'set' magic. See C<PUSHs>.
3614 Push an unsigned integer onto the stack, extending the stack if necessary.
3624 Macro to declare an XSUB and its C parameter list. This is handled by
3628 Found in file XSUB.h
3632 Return from XSUB, indicating number of items on the stack. This is usually
3633 handled by C<xsubpp>.
3635 void XSRETURN(int nitems)
3638 Found in file XSUB.h
3640 =item XSRETURN_EMPTY
3642 Return an empty list from an XSUB immediately.
3647 Found in file XSUB.h
3651 Return an integer from an XSUB immediately. Uses C<XST_mIV>.
3653 void XSRETURN_IV(IV iv)
3656 Found in file XSUB.h
3660 Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
3665 Found in file XSUB.h
3669 Return an double from an XSUB immediately. Uses C<XST_mNV>.
3671 void XSRETURN_NV(NV nv)
3674 Found in file XSUB.h
3678 Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
3680 void XSRETURN_PV(char* str)
3683 Found in file XSUB.h
3685 =item XSRETURN_UNDEF
3687 Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
3692 Found in file XSUB.h
3696 Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
3701 Found in file XSUB.h
3705 Place an integer into the specified position C<pos> on the stack. The
3706 value is stored in a new mortal SV.
3708 void XST_mIV(int pos, IV iv)
3711 Found in file XSUB.h
3715 Place C<&PL_sv_no> into the specified position C<pos> on the
3718 void XST_mNO(int pos)
3721 Found in file XSUB.h
3725 Place a double into the specified position C<pos> on the stack. The value
3726 is stored in a new mortal SV.
3728 void XST_mNV(int pos, NV nv)
3731 Found in file XSUB.h
3735 Place a copy of a string into the specified position C<pos> on the stack.
3736 The value is stored in a new mortal SV.
3738 void XST_mPV(int pos, char* str)
3741 Found in file XSUB.h
3745 Place C<&PL_sv_undef> into the specified position C<pos> on the
3748 void XST_mUNDEF(int pos)
3751 Found in file XSUB.h
3755 Place C<&PL_sv_yes> into the specified position C<pos> on the
3758 void XST_mYES(int pos)
3761 Found in file XSUB.h
3765 The version identifier for an XS module. This is usually
3766 handled automatically by C<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>.
3769 Found in file XSUB.h
3771 =item XS_VERSION_BOOTCHECK
3773 Macro to verify that a PM module's $VERSION variable matches the XS
3774 module's C<XS_VERSION> variable. This is usually handled automatically by
3775 C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">.
3777 XS_VERSION_BOOTCHECK;
3780 Found in file XSUB.h
3784 The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the
3785 destination, C<nitems> is the number of items, and C<type> is the type.
3787 void Zero(void* dest, int nitems, type)
3790 Found in file handy.h
3796 Until May 1997, this document was maintained by Jeff Okamoto
3797 <okamoto@corp.hp.com>. It is now maintained as part of Perl itself.
3799 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
3800 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
3801 Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
3802 Stephen McCamant, and Gurusamy Sarathy.
3804 API Listing originally by Dean Roehrich <roehrich@cray.com>.
3806 Updated to be autogenerated from comments in the source by Benjamin Stuhl.
3810 perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
projects / p5sagit/p5-mst-13.2.git / blob