xsubpp and xsubpp internal functions
perlapi - autogenerated documentation for the perl public API
This file contains the documentation of the perl public API generated by embed.pl, specifically a listing of functions, macros, flags, and variables that may be used by extension writers. The interfaces of any functions that are not listed here are subject to change without notice. For this reason, blindly using functions listed in proto.h is to be avoided when writing extensions.
Note that all Perl API global variables must be referenced with the PL_
prefix. Some macros are provided for compatibility with the older,
unadorned names, but this support may be disabled in a future release.
The listing is alphabetical, case insensitive.
GIMME_V which can only return
G_SCALAR or G_ARRAY; in a void context, it returns G_SCALAR.
Deprecated. Use GIMME_V instead.
U32 GIMME
wantarray. Returns G_VOID,
G_SCALAR or G_ARRAY for void, scalar or list context,
respectively.
U32 GIMME_V
GIMME_V, GIMME and
perlcall.
eval wrapper around a callback. See
perlcall.
GIMME_V, GIMME, and
perlcall.
GIMME_V and perlcall.
av_len(). Deprecated, use av_len() instead.
int AvFILL(AV* av)
void av_clear(AV* ar)
key from the array. Returns the
deleted element. If flags equals G_DISCARD, the element is freed
and null is returned.
SV* av_delete(AV* ar, I32 key, I32 flags)
key has been initialized.
This relies on the fact that uninitialized array elements are set to
&PL_sv_undef.
bool av_exists(AV* ar, I32 key)
key is the index to which the array should be
extended.
void av_extend(AV* ar, I32 key)
key is the
index. If lval is set then the fetch will be part of a store. Check
that the return value is non-null before dereferencing it to a SV*.
See perlguts/``Understanding the Magic of Tied Hashes and Arrays'' for more information on how to use this function on tied arrays.
SV** av_fetch(AV* ar, I32 key, I32 lval)
$#array = $fill;.
void av_fill(AV* ar, I32 fill)
I32 av_len(AV* ar)
AV* av_make(I32 size, SV** svp)
&PL_sv_undef if the array
is empty.
SV* av_pop(AV* ar)
void av_push(AV* ar, SV* val)
SV* av_shift(AV* ar)
key. The
return value will be NULL if the operation failed or if the value did not
need to be actually stored within the array (as in the case of tied
arrays). Otherwise it can be dereferenced to get the original SV*. Note
that the caller is responsible for suitably incrementing the reference
count of val before the call, and decrementing it if the function
returned NULL.
See perlguts/``Understanding the Magic of Tied Hashes and Arrays'' for more information on how to use this function on tied arrays.
SV** av_store(AV* ar, I32 key, SV* val)
void av_undef(AV* ar)
undef values onto the beginning of the
array. The array will grow automatically to accommodate the addition. You
must then use av_store to assign values to these new elements.
void av_unshift(AV* ar, I32 num)
create is set and the
Perl variable does not exist then it will be created. If create is not
set and the variable does not exist then NULL is returned.
NOTE: the perl_ form of this function is deprecated.
AV* get_av(const char* name, I32 create)
AV* newAV()
sortsv(AvARRAY(av), av_len(av)+1, Perl_sv_cmp_locale);
See lib/sort.pm for details about controlling the sorting algorithm.
void sortsv(SV ** array, size_t num_elts, SVCOMPARE_t cmp)
NOTE: the perl_ form of this function is deprecated.
I32 call_argv(const char* sub_name, I32 flags, char** argv)
NOTE: the perl_ form of this function is deprecated.
I32 call_method(const char* methname, I32 flags)
NOTE: the perl_ form of this function is deprecated.
I32 call_pv(const char* sub_name, I32 flags)
NOTE: the perl_ form of this function is deprecated.
I32 call_sv(SV* sv, I32 flags)
LEAVE and perlcall.
ENTER;
eval the given string and return an SV* result.
NOTE: the perl_ form of this function is deprecated.
SV* eval_pv(const char* p, I32 croak_on_error)
eval the string in the SV.
NOTE: the perl_ form of this function is deprecated.
I32 eval_sv(SV* sv, I32 flags)
SAVETMPS and
perlcall.
FREETMPS;
ENTER and perlcall.
LEAVE;
FREETMPS and
perlcall.
SAVETMPS;
char is an ASCII alphanumeric
character (including underscore) or digit.
bool isALNUM(char ch)
char is an ASCII alphabetic
character.
bool isALPHA(char ch)
char is an ASCII
digit.
bool isDIGIT(char ch)
char is a lowercase
character.
bool isLOWER(char ch)
char is whitespace.
bool isSPACE(char ch)
char is an uppercase
character.
bool isUPPER(char ch)
char toLOWER(char ch)
char toUPPER(char ch)
perl_clone takes these flags as parameters:
CLONEf_COPY_STACKS - is used to, well, copy the stacks also, without it we only clone the data and zero the stacks, with it we copy the stacks and the new perl interpreter is ready to run at the exact same point as the previous one. The pseudo-fork code uses COPY_STACKS while the threads->new doesn't.
CLONEf_KEEP_PTR_TABLE
perl_clone keeps a ptr_table with the pointer of the old
variable as a key and the new variable as a value,
this allows it to check if something has been cloned and not
clone it again but rather just use the value and increase the
refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
the ptr_table using the function
ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;,
reason to keep it around is if you want to dup some of your own
variable who are outside the graph perl scans, example of this
code is in threads.xs create
CLONEf_CLONE_HOST This is a win32 thing, it is ignored on unix, it tells perls win32host code (which is c++) to clone itself, this is needed on win32 if you want to run two threads at the same time, if you just want to do some stuff in a separate perl interpreter and then throw it away and return to the original one, you don't need to do anything.
PerlInterpreter* perl_clone(PerlInterpreter* interp, UV flags)
HV* CvSTASH(CV* cv)
create is set and
the Perl subroutine does not exist then it will be declared (which has the
same effect as saying sub name;). If create is not set and the
subroutine does not exist then NULL is returned.
NOTE: the perl_ form of this function is deprecated.
CV* get_cv(const char* name, I32 create)
undef &foo, or by the reference count going to zero.
In the former case, we keep the CvOUTSIDE pointer, so that any anonymous
children can still follow the full lexical scope chain.
void cv_undef(CV* cv)
use Foo::Bar VERSION. The optional trailing SV*
arguments can be used to specify arguments to the module's import()
method, similar to use Foo::Bar VERSION LIST.
void load_module(U32 flags, SV* name, SV* ver, ...)
int nothreadhook()
PerlInterpreter* perl_alloc()
void perl_construct(PerlInterpreter* interp)
int perl_destruct(PerlInterpreter* interp)
void perl_free(PerlInterpreter* interp)
int perl_parse(PerlInterpreter* interp, XSINIT_t xsinit, int argc, char** argv, char** env)
int perl_run(PerlInterpreter* interp)
require the file named by the string argument. It is
analogous to the Perl code eval "require '$file'". It's even
implemented that way; consider using load_module instead.
NOTE: the perl_ form of this function is deprecated.
void require_pv(const char* pv)
pack() Perl function.
void packlist(SV *cat, char *pat, char *patend, SV **beglist, SV **endlist)
pack() Perl function. Note: parameters next_in_list and
flags are not used. This call should not be used; use packlist instead.
void pack_cat(SV *cat, char *pat, char *patend, SV **beglist, SV **endlist, SV ***next_in_list, U32 flags)
unpack() Perl function. unpackstring puts the
extracted list items on the stack and returns the number of elements.
Issue PUTBACK before and SPAGAIN after the call to this function.
I32 unpackstring(char *pat, char *patend, char *s, char *strend, U32 flags)
unpack() Perl function. Note: parameters strbeg, new_s
and ocnt are not used. This call should not be used, use unpackstring instead.
I32 unpack_str(char *pat, char *patend, char *s, char *strbeg, char *strend, char **new_s, I32 ocnt, U32 flags)
PL_modglobal is a general purpose, interpreter global HV for use by
extensions that need to keep information on a per-interpreter basis.
In a pinch, it can also be used as a symbol table for extensions
to share data among each other. It is a good idea to use keys
prefixed by the package name of the extension that owns the data.
HV* PL_modglobal
SvPV when one
doesn't care about the length of the string. It is usually more efficient
to either declare a local variable and use that instead or to use the
SvPV_nolen macro.
STRLEN PL_na
false SV. See PL_sv_yes. Always refer to this as
&PL_sv_no.
SV PL_sv_no
undef SV. Always refer to this as &PL_sv_undef.
SV PL_sv_undef
true SV. See PL_sv_no. Always refer to this as
&PL_sv_yes.
SV PL_sv_yes
SV* GvSV(GV* gv)
name and a defined subroutine or
NULL. The glob lives in the given stash, or in the stashes
accessible via @ISA and UNIVERSAL::.
The argument level should be either 0 or -1. If level==0, as a
side-effect creates a glob with the given name in the given stash
which in the case of success contains an alias for the subroutine, and sets
up caching info for this glob. Similarly for all the searched stashes.
This function grants "SUPER" token as a postfix of the stash name. The
GV returned from gv_fetchmeth may be a method cache entry, which is not
visible to Perl code. So when calling call_sv, you should not use
the GV directly; instead, you should use the method's CV, which can be
obtained from the GV with the GvCV macro.
GV* gv_fetchmeth(HV* stash, const char* name, STRLEN len, I32 level)
GV* gv_fetchmethod(HV* stash, const char* name)
stash. In fact in the presence of autoloading this may be the
glob for ``AUTOLOAD''. In this case the corresponding variable $AUTOLOAD is
already setup.
The third parameter of gv_fetchmethod_autoload determines whether
AUTOLOAD lookup is performed if the given method is not present: non-zero
means yes, look for AUTOLOAD; zero means no, don't look for AUTOLOAD.
Calling gv_fetchmethod is equivalent to calling gv_fetchmethod_autoload
with a non-zero autoload parameter.
These functions grant "SUPER" token as a prefix of the method name. Note
that if you want to keep the returned glob for a long time, you need to
check for it being ``AUTOLOAD'', since at the later time the call may load a
different subroutine due to $AUTOLOAD changing its value. Use the glob
created via a side effect to do this.
These functions have the same side-effects and as gv_fetchmeth with
level==0. name should be writable if contains ':' or '
''. The warning against passing the GV returned by gv_fetchmeth to
call_sv apply equally to these functions.
GV* gv_fetchmethod_autoload(HV* stash, const char* name, I32 autoload)
For an autoloaded subroutine without a GV, will create a GV even
if level < 0. For an autoloaded subroutine without a stub, GvCV()
of the result may be zero.
GV* gv_fetchmeth_autoload(HV* stash, const char* name, STRLEN len, I32 level)
name should
be a valid UTF-8 string. If create is set then the package will be
created if it does not already exist. If create is not set and the
package does not exist then NULL is returned.
HV* gv_stashpv(const char* name, I32 create)
gv_stashpv.
HV* gv_stashsv(SV* sv, I32 create)
create is set and the
Perl variable does not exist then it will be created. If create is not
set and the variable does not exist then NULL is returned.
NOTE: the perl_ form of this function is deprecated.
HV* get_hv(const char* name, I32 create)
SV* pointer where a char* pointer
is to be expected. (For information only--not to be used).
U32 HeHASH(HE* he)
char* or SV*, depending on the value of
HeKLEN(). Can be assigned to. The HePV() or HeSVKEY() macros are
usually preferable for finding the value of a key.
void* HeKEY(HE* he)
HEf_SVKEY, it indicates the entry
holds an SV* key. Otherwise, holds the actual length of the key. Can
be assigned to. The HePV() macro is usually preferable for finding key
lengths.
STRLEN HeKLEN(HE* he)
char* value, doing any
necessary dereferencing of possibly SV* keys. The length of the string
is placed in len (this is a macro, so do not use &len). If you do
not care about what the length of the key is, you may use the global
variable PL_na, though this is rather less efficient than using a local
variable. Remember though, that hash keys in perl are free to contain
embedded nulls, so using strlen() or similar is not a good way to find
the length of hash keys. This is very similar to the SvPV() macro
described elsewhere in this document.
char* HePV(HE* he, STRLEN len)
SV*, or Nullsv if the hash entry does not
contain an SV* key.
SV* HeSVKEY(HE* he)
SV*. Will create and return a temporary mortal
SV* if the hash entry contains only a char* key.
SV* HeSVKEY_force(HE* he)
SV*, taking care to set the appropriate flags to
indicate the presence of an SV* key, and returns the same
SV*.
SV* HeSVKEY_set(HE* he, SV* sv)
SV*) stored in the hash entry.
SV* HeVAL(HE* he)
SvSTASH, CvSTASH.
char* HvNAME(HV* stash)
void hv_clear(HV* tb)
void hv_clear_placeholders(HV* hb)
klen is the length of the key.
The flags value will normally be zero; if set to G_DISCARD then NULL
will be returned.
SV* hv_delete(HV* tb, const char* key, I32 klen, I32 flags)
flags value will normally be zero;
if set to G_DISCARD then NULL will be returned. hash can be a valid
precomputed hash value, or 0 to ask for it to be computed.
SV* hv_delete_ent(HV* tb, SV* key, I32 flags, U32 hash)
klen is the length of the key.
bool hv_exists(HV* tb, const char* key, I32 klen)
hash
can be a valid precomputed hash value, or 0 to ask for it to be
computed.
bool hv_exists_ent(HV* tb, SV* key, U32 hash)
klen is the length of the key. If lval is set then the fetch will be
part of a store. Check that the return value is non-null before
dereferencing it to an SV*.
See perlguts/``Understanding the Magic of Tied Hashes and Arrays'' for more information on how to use this function on tied hashes.
SV** hv_fetch(HV* tb, const char* key, I32 klen, I32 lval)
hash must be a valid precomputed hash number for the given key, or 0
if you want the function to compute it. IF lval is set then the fetch
will be part of a store. Make sure the return value is non-null before
accessing it. The return value when tb is a tied hash is a pointer to a
static location, so be sure to make a copy of the structure if you need to
store it somewhere.
See perlguts/``Understanding the Magic of Tied Hashes and Arrays'' for more information on how to use this function on tied hashes.
HE* hv_fetch_ent(HV* tb, SV* key, I32 lval, U32 hash)
HvKEYS(tb)). The return value is
currently only meaningful for hashes without tie magic.
NOTE: Before version 5.004_65, hv_iterinit used to return the number of
hash buckets that happen to be in use. If you still need that esoteric
value, you can get it through the macro HvFILL(tb).
I32 hv_iterinit(HV* tb)
hv_iterinit.
char* hv_iterkey(HE* entry, I32* retlen)
SV* from the current position of the hash
iterator. The return value will always be a mortal copy of the key. Also
see hv_iterinit.
SV* hv_iterkeysv(HE* entry)
hv_iterinit.
You may call hv_delete or hv_delete_ent on the hash entry that the
iterator currently points to, without losing your place or invalidating your
iterator. Note that in this case the current entry is deleted from the hash
with your iterator holding the last reference to it. Your iterator is flagged
to free the entry on the next call to hv_iternext, so you must not discard
your iterator immediately else the entry will leak - call hv_iternext to
trigger the resource deallocation.
HE* hv_iternext(HV* tb)
hv_iternext, hv_iterkey, and hv_iterval in one
operation.
SV* hv_iternextsv(HV* hv, char** key, I32* retlen)
hv_iterinit and hv_iternext.
The flags value will normally be zero; if HV_ITERNEXT_WANTPLACEHOLDERS is
set the placeholders keys (for restricted hashes) will be returned in addition
to normal keys. By default placeholders are automatically skipped over.
Currently a placeholder is implemented with a value that is
&Perl_sv_placeholder. Note that the implementation of placeholders and
restricted hashes may change, and the implementation currently is
insufficiently abstracted for any change to be tidy.
NOTE: this function is experimental and may change or be removed without notice.
HE* hv_iternext_flags(HV* tb, I32 flags)
hv_iterkey.
SV* hv_iterval(HV* tb, HE* entry)
sv_magic.
void hv_magic(HV* hv, GV* gv, int how)
SV* hv_scalar(HV* hv)
key and klen is
the length of the key. The hash parameter is the precomputed hash
value; if it is zero then Perl will compute it. The return value will be
NULL if the operation failed or if the value did not need to be actually
stored within the hash (as in the case of tied hashes). Otherwise it can
be dereferenced to get the original SV*. Note that the caller is
responsible for suitably incrementing the reference count of val before
the call, and decrementing it if the function returned NULL. Effectively
a successful hv_store takes ownership of one reference to val. This is
usually what you want; a newly created SV has a reference count of one, so
if all your code does is create SVs then store them in a hash, hv_store
will own the only reference to the new SV, and your code doesn't need to do
anything further to tidy up. hv_store is not implemented as a call to
hv_store_ent, and does not create a temporary SV for the key, so if your
key data is not already in SV form then use hv_store in preference to
hv_store_ent.
See perlguts/``Understanding the Magic of Tied Hashes and Arrays'' for more information on how to use this function on tied hashes.
SV** hv_store(HV* tb, const char* key, I32 klen, SV* val, U32 hash)
val in a hash. The hash key is specified as key. The hash
parameter is the precomputed hash value; if it is zero then Perl will
compute it. The return value is the new hash entry so created. It will be
NULL if the operation failed or if the value did not need to be actually
stored within the hash (as in the case of tied hashes). Otherwise the
contents of the return value can be accessed using the He? macros
described here. Note that the caller is responsible for suitably
incrementing the reference count of val before the call, and
decrementing it if the function returned NULL. Effectively a successful
hv_store_ent takes ownership of one reference to val. This is
usually what you want; a newly created SV has a reference count of one, so
if all your code does is create SVs then store them in a hash, hv_store
will own the only reference to the new SV, and your code doesn't need to do
anything further to tidy up. Note that hv_store_ent only reads the key;
unlike val it does not take ownership of it, so maintaining the correct
reference count on key is entirely the caller's responsibility. hv_store
is not implemented as a call to hv_store_ent, and does not create a temporary
SV for the key, so if your key data is not already in SV form then use
hv_store in preference to hv_store_ent.
See perlguts/``Understanding the Magic of Tied Hashes and Arrays'' for more information on how to use this function on tied hashes.
HE* hv_store_ent(HV* tb, SV* key, SV* val, U32 hash)
void hv_undef(HV* tb)
HV* newHV()
sv_magic.
int mg_clear(SV* sv)
sv_magic.
int mg_copy(SV* sv, SV* nsv, const char* key, I32 klen)
sv_magic.
MAGIC* mg_find(SV* sv, int type)
sv_magic.
int mg_free(SV* sv)
sv_magic.
int mg_get(SV* sv)
sv_magic.
U32 mg_length(SV* sv)
sv_magic.
void mg_magical(SV* sv)
sv_magic.
int mg_set(SV* sv)
mg_get on an SV if it has 'get' magic. This macro evaluates its
argument more than once.
void SvGETMAGIC(SV* sv)
void SvLOCK(SV* sv)
mg_set on an SV if it has 'set' magic. This macro evaluates its
argument more than once.
void SvSETMAGIC(SV* sv)
SvSetSV, but does any set magic required afterwards.
void SvSetMagicSV(SV* dsb, SV* ssv)
SvSetSV_nosteal, but does any set magic required afterwards.
void SvSetMagicSV_nosteal(SV* dsv, SV* ssv)
sv_setsv if dsv is not the same as ssv. May evaluate arguments
more than once.
void SvSetSV(SV* dsb, SV* ssv)
sv_setsv if dsv is not the same as
ssv. May evaluate arguments more than once.
void SvSetSV_nosteal(SV* dsv, SV* ssv)
void SvSHARE(SV* sv)
void SvUNLOCK(SV* sv)
memcpy function. The src is the
source, dest is the destination, nitems is the number of items, and type is
the type. May fail on overlapping copies. See also Move.
void Copy(void* src, void* dest, int nitems, type)
Copy but returns dest. Useful for encouraging compilers to tail-call
optimise.
void * CopyD(void* src, void* dest, int nitems, type)
memmove function. The src is the
source, dest is the destination, nitems is the number of items, and type is
the type. Can do overlapping moves. See also Copy.
void Move(void* src, void* dest, int nitems, type)
Move but returns dest. Useful for encouraging compilers to tail-call
optimise.
void * MoveD(void* src, void* dest, int nitems, type)
malloc function.
void New(int id, void* ptr, int nitems, type)
malloc function, with
cast.
void Newc(int id, void* ptr, int nitems, type, cast)
malloc function. The allocated
memory is zeroed with memzero.
void Newz(int id, void* ptr, int nitems, type)
void Poison(void* dest, int nitems, type)
realloc function.
void Renew(void* ptr, int nitems, type)
realloc function, with
cast.
void Renewc(void* ptr, int nitems, type, cast)
free function.
void Safefree(void* ptr)
strdup(). Returns a pointer to a newly allocated
string which is a duplicate of pv. The size of the string is
determined by strlen(). The memory allocated for the new string can
be freed with the Safefree() function.
char* savepv(const char* pv)
strndup() would be if it existed. Returns a
pointer to a newly allocated string which is a duplicate of the first
len bytes from pv. The memory allocated for the new string can be
freed with the Safefree() function.
char* savepvn(const char* pv, I32 len)
savepv() which allocates the duplicate string in memory
which is shared between threads.
char* savesharedpv(const char* pv)
void StructCopy(type src, type dest, type)
memzero function. The dest is the
destination, nitems is the number of items, and type is the type.
void Zero(void* dest, int nitems, type)
Zero but returns dest. Useful for encouraging compilers to tail-call
optimise.
void * ZeroD(void* dest, int nitems, type)
fbm_instr()
-- the Boyer-Moore algorithm.
void fbm_compile(SV* sv, U32 flags)
str and
strend. It returns Nullch if the string can't be found. The sv
does not have to be fbm_compiled, but the search will not be as fast
then.
char* fbm_instr(unsigned char* big, unsigned char* bigend, SV* littlesv, U32 flags)
(char *) Perl_form(pTHX_ const char* pat, ...)
can be used any place a string (char *) is required:
char * s = Perl_form("%d.%d",major,minor);
Uses a single private buffer so if you want to format several strings you must explicitly copy the earlier strings away (and free the copies when you are done).
char* form(const char* pat, ...)
int getcwd_sv(SV* sv)
bool strEQ(char* s1, char* s2)
s1, is greater than or equal to
the second, s2. Returns true or false.
bool strGE(char* s1, char* s2)
s1, is greater than the second,
s2. Returns true or false.
bool strGT(char* s1, char* s2)
s1, is less than or equal to the
second, s2. Returns true or false.
bool strLE(char* s1, char* s2)
s1, is less than the second,
s2. Returns true or false.
bool strLT(char* s1, char* s2)
bool strNE(char* s1, char* s2)
len parameter indicates
the number of bytes to compare. Returns true or false. (A wrapper for
strncmp).
bool strnEQ(char* s1, char* s2, STRLEN len)
len parameter
indicates the number of bytes to compare. Returns true or false. (A
wrapper for strncmp).
bool strnNE(char* s1, char* s2, STRLEN len)
void sv_nolocking(SV *)
void sv_nosharing(SV *)
void sv_nounlocking(SV *)
On entry start and *len give the string to scan, *flags gives
conversion flags, and result should be NULL or a pointer to an NV.
The scan stops at the end of the string, or the first invalid character.
Unless PERL_SCAN_SILENT_ILLDIGIT is set in *flags, encountering an
invalid character will also trigger a warning.
On return *len is set to the length of the scanned string,
and *flags gives output flags.
If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
and nothing is written to *result. If the value is > UV_MAX grok_bin
returns UV_MAX, sets PERL_SCAN_GREATER_THAN_UV_MAX in the output flags,
and writes the value to *result (or the value is discarded if result
is NULL).
The binary number may optionally be prefixed with ``0b'' or ``b'' unless
PERL_SCAN_DISALLOW_PREFIX is set in *flags on entry. If
PERL_SCAN_ALLOW_UNDERSCORES is set in *flags then the binary
number may use '_' characters to separate digits.
UV grok_bin(char* start, STRLEN* len, I32* flags, NV *result)
On entry start and *len give the string to scan, *flags gives
conversion flags, and result should be NULL or a pointer to an NV.
The scan stops at the end of the string, or the first invalid character.
Unless PERL_SCAN_SILENT_ILLDIGIT is set in *flags, encountering an
invalid character will also trigger a warning.
On return *len is set to the length of the scanned string,
and *flags gives output flags.
If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
and nothing is written to *result. If the value is > UV_MAX grok_hex
returns UV_MAX, sets PERL_SCAN_GREATER_THAN_UV_MAX in the output flags,
and writes the value to *result (or the value is discarded if result
is NULL).
The hex number may optionally be prefixed with ``0x'' or ``x'' unless
PERL_SCAN_DISALLOW_PREFIX is set in *flags on entry. If
PERL_SCAN_ALLOW_UNDERSCORES is set in *flags then the hex
number may use '_' characters to separate digits.
UV grok_hex(char* start, STRLEN* len, I32* flags, NV *result)
If the value of the number can fit an in UV, it is returned in the *valuep IS_NUMBER_IN_UV will be set to indicate that *valuep is valid, IS_NUMBER_IN_UV will never be set unless *valuep is valid, but *valuep may have been assigned to during processing even though IS_NUMBER_IN_UV is not set on return. If valuep is NULL, IS_NUMBER_IN_UV will be set for the same cases as when valuep is non-NULL, but no actual assignment (or SEGV) will occur.
IS_NUMBER_NOT_INT will be set with IS_NUMBER_IN_UV if trailing decimals were seen (in which case *valuep gives the true value truncated to an integer), and IS_NUMBER_NEG if the number is negative (in which case *valuep holds the absolute value). IS_NUMBER_IN_UV is not set if e notation was used or the number is larger than a UV.
int grok_number(const char *pv, STRLEN len, UV *valuep)
bool grok_numeric_radix(const char **sp, const char *send)
On entry start and *len give the string to scan, *flags gives
conversion flags, and result should be NULL or a pointer to an NV.
The scan stops at the end of the string, or the first invalid character.
Unless PERL_SCAN_SILENT_ILLDIGIT is set in *flags, encountering an
invalid character will also trigger a warning.
On return *len is set to the length of the scanned string,
and *flags gives output flags.
If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
and nothing is written to *result. If the value is > UV_MAX grok_oct
returns UV_MAX, sets PERL_SCAN_GREATER_THAN_UV_MAX in the output flags,
and writes the value to *result (or the value is discarded if result
is NULL).
If PERL_SCAN_ALLOW_UNDERSCORES is set in *flags then the octal
number may use '_' characters to separate digits.
UV grok_oct(char* start, STRLEN* len, I32* flags, NV *result)
grok_bin instead.
NV scan_bin(char* start, STRLEN len, STRLEN* retlen)
grok_hex instead.
NV scan_hex(char* start, STRLEN len, STRLEN* retlen)
grok_oct instead.
NV scan_oct(char* start, STRLEN len, STRLEN* retlen)
cv is a constant sub eligible for inlining. returns the constant
value returned by the sub. Otherwise, returns NULL.
Constant subs can be created with newCONSTSUB or as described in
perlsub/``Constant Functions''.
SV* cv_const_sv(CV* cv)
sub FOO () { 123 } which is
eligible for inlining at compile-time.
CV* newCONSTSUB(HV* stash, char* name, SV* sv)
xsubpp to hook up XSUBs as Perl subs.
SV* pad_sv(PADOFFSET po)
mark, for the XSUB. See MARK and
dORIGMARK.
dMARK;
ORIGMARK.
dORIGMARK;
SP macro. See SP.
dSP;
nitems to be pushed
onto the stack.
void EXTEND(SP, int nitems)
dMARK.
TARG. See also PUSHi, mXPUSHi
and XPUSHi.
void mPUSHi(IV iv)
TARG. See also PUSHn, mXPUSHn
and XPUSHn.
void mPUSHn(NV nv)
len indicates the length of the string. Handles 'set' magic. Does
not use TARG. See also PUSHp, mXPUSHp and XPUSHp.
void mPUSHp(char* str, STRLEN len)
TARG. See also PUSHu,
mXPUSHu and XPUSHu.
void mPUSHu(UV uv)
TARG. See also XPUSHi, mPUSHi and
PUSHi.
void mXPUSHi(IV iv)
TARG. See also XPUSHn, mPUSHn and
PUSHn.
void mXPUSHn(NV nv)
len
indicates the length of the string. Handles 'set' magic. Does not use
TARG. See also XPUSHp, mPUSHp and PUSHp.
void mXPUSHp(char* str, STRLEN len)
TARG. See also XPUSHu, mPUSHu
and PUSHu.
void mXPUSHu(UV uv)
dORIGMARK.
IV POPi
long POPl
NV POPn
char* POPp
char* POPpbytex
char* POPpx
SV* POPs
TARG, so dTARGET or dXSTARG should be
called to declare it. Do not call multiple TARG-oriented macros to
return lists from XSUB's - see mPUSHi instead. See also XPUSHi and
mXPUSHi.
void PUSHi(IV iv)
PUTBACK and
perlcall.
void PUSHMARK(SP)
TARG. See also
PUSHs, XPUSHmortal and XPUSHs.
void PUSHmortal()
TARG, so dTARGET or dXSTARG should be
called to declare it. Do not call multiple TARG-oriented macros to
return lists from XSUB's - see mPUSHn instead. See also XPUSHn and
mXPUSHn.
void PUSHn(NV nv)
len indicates the length of the string. Handles 'set' magic. Uses
TARG, so dTARGET or dXSTARG should be called to declare it. Do not
call multiple TARG-oriented macros to return lists from XSUB's - see
mPUSHp instead. See also XPUSHp and mXPUSHp.
void PUSHp(char* str, STRLEN len)
TARG. See also PUSHmortal,
XPUSHs and XPUSHmortal.
void PUSHs(SV* sv)
TARG, so dTARGET or dXSTARG
should be called to declare it. Do not call multiple TARG-oriented
macros to return lists from XSUB's - see mPUSHu instead. See also
XPUSHu and mXPUSHu.
void PUSHu(UV uv)
xsubpp.
See PUSHMARK and perlcall for other uses.
PUTBACK;
xsubpp. See dSP and
SPAGAIN.
SPAGAIN;
TARG, so dTARGET or dXSTARG should be called to
declare it. Do not call multiple TARG-oriented macros to return lists
from XSUB's - see mXPUSHi instead. See also PUSHi and mPUSHi.
void XPUSHi(IV iv)
TARG. See also XPUSHs,
PUSHmortal and PUSHs.
void XPUSHmortal()
TARG, so dTARGET or dXSTARG should be called to
declare it. Do not call multiple TARG-oriented macros to return lists
from XSUB's - see mXPUSHn instead. See also PUSHn and mPUSHn.
void XPUSHn(NV nv)
len
indicates the length of the string. Handles 'set' magic. Uses TARG, so
dTARGET or dXSTARG should be called to declare it. Do not call
multiple TARG-oriented macros to return lists from XSUB's - see
mXPUSHp instead. See also PUSHp and mPUSHp.
void XPUSHp(char* str, STRLEN len)
TARG. See also XPUSHmortal,
PUSHs and PUSHmortal.
void XPUSHs(SV* sv)
TARG, so dTARGET or dXSTARG should be
called to declare it. Do not call multiple TARG-oriented macros to
return lists from XSUB's - see mXPUSHu instead. See also PUSHu and
mPUSHu.
void XPUSHu(UV uv)
xsubpp.
void XSRETURN(int nitems)
XSRETURN_EMPTY;
XST_mIV.
void XSRETURN_IV(IV iv)
&PL_sv_no from an XSUB immediately. Uses XST_mNO.
XSRETURN_NO;
XST_mNV.
void XSRETURN_NV(NV nv)
XST_mPV.
void XSRETURN_PV(char* str)
&PL_sv_undef from an XSUB immediately. Uses XST_mUNDEF.
XSRETURN_UNDEF;
XST_mUV.
void XSRETURN_UV(IV uv)
&PL_sv_yes from an XSUB immediately. Uses XST_mYES.
XSRETURN_YES;
pos on the stack. The
value is stored in a new mortal SV.
void XST_mIV(int pos, IV iv)
&PL_sv_no into the specified position pos on the
stack.
void XST_mNO(int pos)
pos on the stack. The value
is stored in a new mortal SV.
void XST_mNV(int pos, NV nv)
pos on the stack.
The value is stored in a new mortal SV.
void XST_mPV(int pos, char* str)
&PL_sv_undef into the specified position pos on the
stack.
void XST_mUNDEF(int pos)
&PL_sv_yes into the specified position pos on the
stack.
void XST_mYES(int pos)
svtype enum. Test these flags with the SvTYPE macro.
svtype.
svtype.
svtype.
svtype.
svtype.
svtype.
svtype.
create is set and the
Perl variable does not exist then it will be created. If create is not
set and the variable does not exist then NULL is returned.
NOTE: the perl_ form of this function is deprecated.
SV* get_sv(const char* name, I32 create)
Inf and Infinity are treated as numbers (so will not issue a
non-numeric warning), even if your atof() doesn't grok them.
I32 looks_like_number(SV* sv)
SV* newRV_inc(SV* sv)
SV* newRV_noinc(SV *sv)
len parameter indicates the number of
bytes of preallocated string space the SV should have. An extra byte for a
tailing NUL is also reserved. (SvPOK is not set for the SV even if string
space is allocated.) The reference count for the new SV is set to 1.
id is an integer id between 0 and 1299 (used to identify leaks).
SV* NEWSV(int id, STRLEN len)
NEWSV
macro.
SV* newSV(STRLEN len)
SV* newSViv(IV i)
SV* newSVnv(NV n)
len is zero, Perl will compute the length using
strlen(). For efficiency, consider using newSVpvn instead.
SV* newSVpv(const char* s, STRLEN len)
sprintf.
SV* newSVpvf(const char* pat, ...)
len is zero, Perl will create a zero length
string. You are responsible for ensuring that the source string is at least
len bytes long. If the s argument is NULL the new SV will be undefined.
SV* newSVpvn(const char* s, STRLEN len)
hash parameter is non-zero, that value is used;
otherwise the hash is computed. The idea here is that as the string table
is used for shared hash keys these strings will have SvPVX == HeKEY and
hash lookup will avoid string compare.
SV* newSVpvn_share(const char* s, I32 len, U32 hash)
rv, to point to. If rv is not an RV then
it will be upgraded to one. If classname is non-null then the new SV will
be blessed in the specified package. The new SV is returned and its
reference count is 1.
SV* newSVrv(SV* rv, const char* classname)
sv_setsv).
SV* newSVsv(SV* old)
SV* newSVuv(UV u)
SvLEN.
STRLEN SvCUR(SV* sv)
SvCUR.
void SvCUR_set(SV* sv, STRLEN len)
SvCUR. Access the character as *(SvEND(sv)).
char* SvEND(SV* sv)
sv_grow to perform the expansion if necessary.
Returns a pointer to the character buffer.
char * SvGROW(SV* sv, STRLEN len)
bool SvIOK(SV* sv)
SvIOK.
bool SvIOKp(SV* sv)
bool SvIOK_notUV(SV* sv)
void SvIOK_off(SV* sv)
void SvIOK_on(SV* sv)
void SvIOK_only(SV* sv)
void SvIOK_only_UV(SV* sv)
bool SvIOK_UV(SV* sv)
bool SvIsCOW(SV* sv)
bool SvIsCOW_shared_hash(SV* sv)
SvIVx for a
version which guarantees to evaluate sv only once.
IV SvIV(SV* sv)
SvIV otherwise.
IV SvIVx(SV* sv)
SvIV().
IV SvIVX(SV* sv)
SvOOK. See SvCUR.
STRLEN SvLEN(SV* sv)
bool SvNIOK(SV* sv)
SvNIOK.
bool SvNIOKp(SV* sv)
void SvNIOK_off(SV* sv)
bool SvNOK(SV* sv)
SvNOK.
bool SvNOKp(SV* sv)
void SvNOK_off(SV* sv)
void SvNOK_on(SV* sv)
void SvNOK_only(SV* sv)
SvNVx for a version
which guarantees to evaluate sv only once.
NV SvNV(SV* sv)
SvNV otherwise.
NV SvNVx(SV* sv)
SvNV().
NV SvNVX(SV* sv)
bool SvOK(SV* sv)
bool SvOOK(SV* sv)
bool SvPOK(SV* sv)
SvPOK.
bool SvPOKp(SV* sv)
void SvPOK_off(SV* sv)
void SvPOK_on(SV* sv)
void SvPOK_only(SV* sv)
void SvPOK_only_UTF8(SV* sv)
SvPOK. Handles 'get' magic. See also
SvPVx for a version which guarantees to evaluate sv only once.
char* SvPV(SV* sv, STRLEN len)
SvPV, but converts sv to byte representation first if necessary.
char* SvPVbyte(SV* sv, STRLEN len)
SvPV, but converts sv to byte representation first if necessary.
Guarantees to evaluate sv only once; use the more efficient SvPVbyte
otherwise.
char* SvPVbytex(SV* sv, STRLEN len)
SvPV_force, but converts sv to byte representation first if necessary.
Guarantees to evaluate sv only once; use the more efficient SvPVbyte_force
otherwise.
char* SvPVbytex_force(SV* sv, STRLEN len)
SvPV_force, but converts sv to byte representation first if necessary.
char* SvPVbyte_force(SV* sv, STRLEN len)
SvPV_nolen, but converts sv to byte representation first if necessary.
char* SvPVbyte_nolen(SV* sv)
SvPV, but converts sv to utf8 first if necessary.
char* SvPVutf8(SV* sv, STRLEN len)
SvPV, but converts sv to utf8 first if necessary.
Guarantees to evaluate sv only once; use the more efficient SvPVutf8
otherwise.
char* SvPVutf8x(SV* sv, STRLEN len)
SvPV_force, but converts sv to utf8 first if necessary.
Guarantees to evaluate sv only once; use the more efficient SvPVutf8_force
otherwise.
char* SvPVutf8x_force(SV* sv, STRLEN len)
SvPV_force, but converts sv to utf8 first if necessary.
char* SvPVutf8_force(SV* sv, STRLEN len)
SvPV_nolen, but converts sv to utf8 first if necessary.
char* SvPVutf8_nolen(SV* sv)
SvPV which guarantees to evaluate sv only once.
char* SvPVx(SV* sv, STRLEN len)
char* SvPVX(SV* sv)
SvPV but will force the SV into containing just a string
(SvPOK_only). You want force if you are going to update the SvPVX
directly.
char* SvPV_force(SV* sv, STRLEN len)
SvPV but will force the SV into containing just a string
(SvPOK_only). You want force if you are going to update the SvPVX
directly. Doesn't process magic.
char* SvPV_force_nomg(SV* sv, STRLEN len)
SvPOK. Handles 'get' magic.
char* SvPV_nolen(SV* sv)
U32 SvREFCNT(SV* sv)
void SvREFCNT_dec(SV* sv)
SV* SvREFCNT_inc(SV* sv)
bool SvROK(SV* sv)
void SvROK_off(SV* sv)
void SvROK_on(SV* sv)
SV* SvRV(SV* sv)
HV* SvSTASH(SV* sv)
void SvTAINT(SV* sv)
bool SvTAINTED(SV* sv)
void SvTAINTED_off(SV* sv)
void SvTAINTED_on(SV* sv)
bool SvTRUE(SV* sv)
svtype.
svtype SvTYPE(SV* sv)
void SvUOK(SV* sv)
sv_upgrade to
perform the upgrade if necessary. See svtype.
void SvUPGRADE(SV* sv, svtype type)
bool SvUTF8(SV* sv)
void SvUTF8_off(SV *sv)
void SvUTF8_on(SV *sv)
SvUVx
for a version which guarantees to evaluate sv only once.
UV SvUV(SV* sv)
SvUV otherwise.
UV SvUVx(SV* sv)
SvUV().
UV SvUVX(SV* sv)
sv_true() or its macro equivalent.
bool sv_2bool(SV* sv)
*st and *gvp to the stash and GV associated with it.
CV* sv_2cv(SV* sv, HV** st, GV** gvp, I32 lref)
IO* sv_2io(SV* sv)
SvIV(sv) and SvIVx(sv) macros.
IV sv_2iv(SV* sv)
SvTEMP() is turned on which means that the SV's
string buffer can be ``stolen'' if this SV is copied. See also sv_newmortal
and sv_mortalcopy.
SV* sv_2mortal(SV* sv)
SvNV(sv) and SvNVx(sv)
macros.
NV sv_2nv(SV* sv)
Usually accessed via the SvPVbyte macro.
char* sv_2pvbyte(SV* sv, STRLEN* lp)
Usually accessed via the SvPVbyte_nolen macro.
char* sv_2pvbyte_nolen(SV* sv)
Usually accessed via the SvPVutf8 macro.
char* sv_2pvutf8(SV* sv, STRLEN* lp)
Usually accessed via the SvPVutf8_nolen macro.
char* sv_2pvutf8_nolen(SV* sv)
mg_get() first. Coerces sv to a string
if necessary.
Normally invoked via the SvPV_flags macro. sv_2pv() and sv_2pv_nomg
usually end up here too.
char* sv_2pv_flags(SV* sv, STRLEN* lp, I32 flags)
sv_2pv(), but doesn't return the length too. You should usually
use the macro wrapper SvPV_nolen(sv) instead.
char* sv_2pv_nolen(SV* sv)
SvUV(sv) and SvUVx(sv)
macros.
UV sv_2uv(SV* sv)
SvOOK_off macro
wrapper instead.
int sv_backoff(SV* sv)
gv_stashpv()). The reference count
of the SV is unaffected.
SV* sv_bless(SV* sv, HV* stash)
sv_catpv_mg.
void sv_catpv(SV* sv, const char* ptr)
sprintf and appends the formatted
output to an SV. If the appended data contains ``wide'' characters
(including, but not limited to, SVs with a UTF-8 PV formatted with %s,
and characters >255 formatted with %c), the original SV might get
upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
sv_catpvf_mg.
void sv_catpvf(SV* sv, const char* pat, ...)
sv_catpvf, but also handles 'set' magic.
void sv_catpvf_mg(SV *sv, const char* pat, ...)
len indicates number of bytes to copy. If the SV has the UTF-8
status set, then the bytes appended should be valid UTF-8.
Handles 'get' magic, but not 'set' magic. See sv_catpvn_mg.
void sv_catpvn(SV* sv, const char* ptr, STRLEN len)
len indicates number of bytes to copy. If the SV has the UTF-8
status set, then the bytes appended should be valid UTF-8.
If flags has SV_GMAGIC bit set, will mg_get on dsv if
appropriate, else not. sv_catpvn and sv_catpvn_nomg are implemented
in terms of this function.
void sv_catpvn_flags(SV* sv, const char*