| perlapi - autogenerated documentation for the perl public API |
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.
av_len(). Deprecated, use av_len() instead.
int AvFILL(AV* av)
void av_clear(AV* ar)
key from the array. Returns the
deleted element. flags is currently ignored.
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 Understanding the Magic of Tied Hashes and Arrays dans la page de manuel perlguts 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 Understanding the Magic of Tied Hashes and Arrays dans la page de manuel perlguts 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)
s of length len from UTF8 into byte encoding.
Unlike <utf8_to_bytes> but like bytes_to_utf8, returns a pointer to
the newly-created string, and updates len to contain the new
length. Returns the original string if no conversion occurs, len
is unchanged. Do nothing if is_utf8 points to 0. Sets is_utf8 to
0 if s is converted or contains all 7bit characters.
NOTE: this function is experimental and may change or be removed without notice.
U8* bytes_from_utf8(U8 *s, STRLEN *len, bool *is_utf8)
s of length len from ASCII into UTF8 encoding.
Returns a pointer to the newly-created string, and sets len to
reflect the new length.
NOTE: this function is experimental and may change or be removed without notice.
U8* bytes_to_utf8(U8 *s, STRLEN *len)
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)
xsubpp to indicate the
class name for a C++ XS constructor. This is always a char*. See THIS.
char* CLASS
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)
die function.
Normally use this function the same way you use the C printf
function. See warn.
If you want to throw an exception object, assign the object to
$@ and then pass Nullch to croak():
errsv = get_sv("@", TRUE);
sv_setsv(errsv, exception_object);
croak(Nullch);
void croak(const char* pat, ...)
HV* CvSTASH(CV* cv)
mark, for the XSUB. See MARK and
dORIGMARK.
dMARK;
ORIGMARK.
dORIGMARK;
SP macro. See SP.
dSP;
xsubpp. Declares the items
variable to indicate the number of items on the stack.
dXSARGS;
ix variable for an XSUB which has aliases. This is usually
handled automatically by xsubpp.
dXSI32;
LEAVE and la page de manuel 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)
nitems to be pushed
onto the stack.
void EXTEND(SP, int nitems)
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)
SAVETMPS and
la page de manuel perlcall.
FREETMPS;
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)
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)
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)
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)
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
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)
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)
GIMME_V, GIMME and
la page de manuel perlcall.
eval wrapper around a callback. See
la page de manuel perlcall.
GIMME_V, GIMME, and
la page de manuel perlcall.
GIMME_V and la page de manuel perlcall.
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)
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, U32 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, U32 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 a SV*.
See Understanding the Magic of Tied Hashes and Arrays dans la page de manuel perlguts for more information on how to use this function on tied hashes.
SV** hv_fetch(HV* tb, const char* key, U32 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 Understanding the Magic of Tied Hashes and Arrays dans la page de manuel perlguts 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.
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_iterkey.
SV* hv_iterval(HV* tb, HE* entry)
sv_magic.
void hv_magic(HV* hv, GV* gv, int how)
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.
See Understanding the Magic of Tied Hashes and Arrays dans la page de manuel perlguts for more information on how to use this function on tied hashes.
SV** hv_store(HV* tb, const char* key, U32 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.
See Understanding the Magic of Tied Hashes and Arrays dans la page de manuel perlguts 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)
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)
STRLEN is_utf8_char(U8 *p)
len bytes of the given string form valid a UTF8
string, false otherwise.
bool is_utf8_string(U8 *s, STRLEN len)
xsubpp to indicate the number of
items on the stack. See Listes de paramètres de longueur variable dans la page de manuel perlxs.
I32 items
xsubpp to indicate which of an
XSUB's aliases was used to invoke it. See Le mot-clé ALIAS dans la page de manuel perlxs.
I32 ix
ENTER and la page de manuel perlcall.
LEAVE;
I32 looks_like_number(SV* sv)
dMARK.
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)
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)
malloc function.
void New(int id, void* ptr, int nitems, type)
AV* newAV()
malloc function, with
cast.
void Newc(int id, void* ptr, int nitems, type, cast)
sub FOO () { 123 } which is
eligible for inlining at compile-time.
void newCONSTSUB(HV* stash, char* name, SV* sv)
HV* newHV()
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)
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.
SV* newSVpvn(const char* s, STRLEN len)
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* newSVsv(SV* old)
SV* newSVuv(UV u)
xsubpp to hook up XSUBs as Perl subs.
xsubpp to hook up XSUBs as Perl subs. Adds Perl prototypes to
the subs.
malloc function. The allocated
memory is zeroed with memzero.
void Newz(int id, void* ptr, int nitems, type)
dORIGMARK.
PerlInterpreter* perl_alloc()
void perl_construct(PerlInterpreter* interp)
void 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)
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
IV POPi
long POPl
NV POPn
char* POPp
SV* POPs
XPUSHi.
void PUSHi(IV iv)
PUTBACK and
la page de manuel perlcall.
PUSHMARK;
XPUSHn.
void PUSHn(NV nv)
len indicates the length of the string. Handles 'set' magic. See
XPUSHp.
void PUSHp(char* str, STRLEN len)
XPUSHs.
void PUSHs(SV* sv)
XPUSHu.
void PUSHu(UV uv)
xsubpp.
See PUSHMARK and la page de manuel perlcall for other uses.
PUTBACK;
realloc function.
void Renew(void* ptr, int nitems, type)
realloc function, with
cast.
void Renewc(void* ptr, int nitems, type, cast)
require a module.
NOTE: the perl_ form of this function is deprecated.
void require_pv(const char* pv)
xsubpp to hold the return value for an
XSUB. This is always the proper type for the XSUB. See
La variable RETVAL dans la page de manuel perlxs.
(whatever) RETVAL
free function.
void Safefree(void* ptr)
char* savepv(const char* sv)
len indicates number of bytes to
copy. This does not use an SV.
char* savepvn(const char* sv, I32 len)
FREETMPS and
la page de manuel perlcall.
SAVETMPS;
xsubpp. See dSP and
SPAGAIN.
SPAGAIN;
SV* ST(int ix)
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 StructCopy(type src, type dest, type)
SvLEN.
STRLEN SvCUR(SV* sv)
SvCUR.
void SvCUR_set(SV* sv, STRLEN len)
SvCUR. Access the character as *(SvEND(sv)).
char* SvEND(SV* sv)
mg_get on an SV if it has 'get' magic. This macro evaluates its
argument more than once.
void SvGETMAGIC(SV* sv)
sv_grow to perform the expansion if necessary.
Returns a pointer to the character buffer.
void SvGROW(SV* sv, STRLEN len)
bool SvIOK(SV* sv)
SvIOK.
bool SvIOKp(SV* sv)
void 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)
void SvIOK_UV(SV* sv)
IV SvIV(SV* sv)
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)
NV SvNV(SV* sv)
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)
char* SvPV(SV* sv, STRLEN len)
char* SvPVX(SV* sv)
char* SvPV_force(SV* sv, STRLEN len)
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)
mg_set on an SV if it has 'set' magic. This macro evaluates its
argument more than once.
void SvSETMAGIC(SV* sv)
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)
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 enum. Test these flags with the SvTYPE macro.
svtype.
svtype SvTYPE(SV* sv)
svtype.
svtype.
svtype.
svtype.
svtype.
svtype.
svtype.
sv_upgrade to
perform the upgrade if necessary. See svtype.
void SvUPGRADE(SV* sv, svtype type)
void SvUTF8(SV* sv)
void SvUTF8_off(SV *sv)
void SvUTF8_on(SV *sv)
UV SvUV(SV* sv)
UV SvUVX(SV* sv)
SV* sv_2mortal(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. Handles 'get' magic, but not 'set' magic. SvSETMAGIC() must
typically be called after calling this function to handle 'set' magic.
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. Handles 'get' magic, but not
'set' magic. See sv_catpvn_mg.
void sv_catpvn(SV* sv, const char* ptr, STRLEN len)
sv_catpvn, but also handles 'set' magic.
void sv_catpvn_mg(SV *sv, const char *ptr, STRLEN len)
sv_catpv, but also handles 'set' magic.
void sv_catpv_mg(SV *sv, const char *ptr)
ssv onto the end of the string in
SV dsv. Modifies dsv but not ssv. Handles 'get' magic, but
not 'set' magic. See sv_catsv_mg.
void sv_catsv(SV* dsv, SV* ssv)
sv_catsv, but also handles 'set' magic.
void sv_catsv_mg(SV *dstr, SV *sstr)
SvPOK(sv) must be true and the ptr must be a pointer to somewhere inside
the string buffer. The ptr becomes the first character of the adjusted
string.
void sv_chop(SV* sv, char* ptr)
void sv_clear(SV* sv)
sv1 is less than, equal to, or greater than the string in
sv2.
I32 sv_cmp(SV* sv1, SV* sv2)
I32 sv_cmp_locale(SV* sv1, SV* sv2)
void sv_dec(SV* sv)
UNIVERSAL::isa. It works
for class names as well as for objects.
bool sv_derived_from(SV* sv, const char* name)
I32 sv_eq(SV* sv1, SV* sv2)
void sv_free(SV* sv)
char* sv_gets(SV* sv, PerlIO* fp, I32 append)
sv_unref and will
upgrade the SV to SVt_PV. Returns a pointer to the character buffer.
Use SvGROW.
char* sv_grow(SV* sv, STRLEN newlen)
void sv_inc(SV* sv)
substr() function.
void sv_insert(SV* bigsv, STRLEN offset, STRLEN len, char* little, STRLEN littlelen)
sv_derived_from to verify
an inheritance relationship.
int sv_isa(SV* sv, const char* name)
int sv_isobject(SV* sv)
SvCUR.
STRLEN sv_len(SV* sv)
STRLEN sv_len_utf8(SV* sv)
void sv_magic(SV* sv, SV* obj, int how, const char* name, I32 namlen)
SV* sv_mortalcopy(SV* oldsv)
SV* sv_newmortal()
char* sv_pvn_force(SV* sv, STRLEN* lp)
char* sv_pvutf8n_force(SV* sv, STRLEN* lp)
char* sv_reftype(SV* sv, int ob)
void sv_replace(SV* sv, SV* nsv)
SV* sv_rvweaken(SV *sv)
sv_setiv_mg.
void sv_setiv(SV* sv, IV num)
sv_setiv, but also handles 'set' magic.
void sv_setiv_mg(SV *sv, IV i)
sv_setnv_mg.
void sv_setnv(SV* sv, NV num)
sv_setnv, but also handles 'set' magic.
void sv_setnv_mg(SV *sv, NV num)
sv_setpv_mg.
void sv_setpv(SV* sv, const char* ptr)
sprintf and sets an SV to the formatted
output. Does not handle 'set' magic. See sv_setpvf_mg.
void sv_setpvf(SV* sv, const char* pat, ...)
sv_setpvf, but also handles 'set' magic.
void sv_setpvf_mg(SV *sv, const char* pat, ...)
sv_setpviv_mg.
void sv_setpviv(SV* sv, IV num)
sv_setpviv, but also handles 'set' magic.
void sv_setpviv_mg(SV *sv, IV iv)
len parameter indicates the number of
bytes to be copied. Does not handle 'set' magic. See sv_setpvn_mg.
void sv_setpvn(SV* sv, const char* ptr, STRLEN len)
sv_setpvn, but also handles 'set' magic.
void sv_setpvn_mg(SV *sv, const char *ptr, STRLEN len)
sv_setpv, but also handles 'set' magic.
void sv_setpv_mg(SV *sv, const char *ptr)
rv
argument will be upgraded to an RV. That RV will be modified to point to
the new SV. The classname argument indicates the package for the
blessing. Set classname to Nullch to avoid the blessing. The new SV
will be returned and will have a reference count of 1.
SV* sv_setref_iv(SV* rv, const char* classname, IV iv)
rv
argument will be upgraded to an RV. That RV will be modified to point to
the new SV. The classname argument indicates the package for the
blessing. Set classname to Nullch to avoid the blessing. The new SV
will be returned and will have a reference count of 1.
SV* sv_setref_nv(SV* rv, const char* classname, NV nv)
rv
argument will be upgraded to an RV. That RV will be modified to point to
the new SV. If the pv argument is NULL then PL_sv_undef will be placed
into the SV. The classname argument indicates the package for the
blessing. Set classname to Nullch to avoid the blessing. The new SV
will be returned and will have a reference count of 1.
Do not use with other Perl types such as HV, AV, SV, CV, because those objects will become corrupted by the pointer copy process.
Note that sv_setref_pvn copies the string while this copies the pointer.
SV* sv_setref_pv(SV* rv, const char* classname, void* pv)
n. The rv argument will be upgraded to
an RV. That RV will be modified to point to the new SV. The classname
argument indicates the package for the blessing. Set classname to
Nullch to avoid the blessing. The new SV will be returned and will have
a reference count of 1.
Note that sv_setref_pv copies the pointer while this copies the string.
SV* sv_setref_pvn(SV* rv, const char* classname, char* pv, STRLEN n)
ssv into the destination SV dsv.
The source SV may be destroyed if it is mortal. Does not handle 'set'
magic. See the macro forms SvSetSV, SvSetSV_nosteal and
sv_setsv_mg.
void sv_setsv(SV* dsv, SV* ssv)
sv_setsv, but also handles 'set' magic.
void sv_setsv_mg(SV *dstr, SV *sstr)
sv_setuv_mg.
void sv_setuv(SV* sv, UV num)
sv_setuv, but also handles 'set' magic.
void sv_setuv_mg(SV *sv, UV u)
I32 sv_true(SV *sv)
int sv_unmagic(SV* sv, int type)
newSVrv. See SvROK_off.
void sv_unref(SV* sv)
SvUPGRADE. See
svtype.
bool sv_upgrade(SV* sv, U32 mt)
ptr to find its string value. Normally the string is
stored inside the SV but sv_usepvn allows the SV to use an outside string.
The ptr should point to memory that was allocated by malloc. The
string length, len, must be supplied. This function will realloc the
memory pointed to by ptr, so that pointer should not be freed or used by
the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
See sv_usepvn_mg.
void sv_usepvn(SV* sv, char* ptr, STRLEN len)
sv_usepvn, but also handles 'set' magic.
void sv_usepvn_mg(SV *sv, char *ptr, STRLEN len)
fail_ok is not
true, croaks.
NOTE: this function is experimental and may change or be removed without notice.
bool sv_utf8_downgrade(SV *sv, bool fail_ok)
SvUTF8
flag so that it looks like bytes again. Nothing calls this.
NOTE: this function is experimental and may change or be removed without notice.
void sv_utf8_encode(SV *sv)
NOTE: this function is experimental and may change or be removed without notice.
void sv_utf8_upgrade(SV *sv)
vsprintf and appends the formatted output
to an SV. Uses an array of SVs if the C style variable argument list is
missing (NULL). When running with taint checks enabled, indicates via
maybe_tainted if results are untrustworthy (often due to the use of
locales).
void sv_vcatpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
vcatpvfn but copies the text into the SV instead of
appending it.
void sv_vsetpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
xsubpp to designate the object in a C++
XSUB. This is always the proper type for the C++ object. See CLASS and
Utiliser XS avec C++ dans la page de manuel perlxs.
(whatever) THIS
char toLOWER(char ch)
char toUPPER(char ch)
a
and b.
WARNING: use only if you *know* that the pointers point inside the same UTF-8 buffer.
NOTE: this function is experimental and may change or be removed without notice.
IV utf8_distance(U8 *a, U8 *b)
s displaced by off characters, either
forward or backward.
WARNING: do not use the following unless you *know* off is within
the UTF-8 data pointed to by s *and* that on entry s is aligned
on the first byte of character or just after the last byte of a character.
NOTE: this function is experimental and may change or be removed without notice.
U8* utf8_hop(U8 *s, I32 off)
s in characters.
Stops at e (inclusive). If e < s or if the scan would end
up past e, croaks.
NOTE: this function is experimental and may change or be removed without notice.
STRLEN utf8_length(U8* s, U8 *e)
s of length len from UTF8 into byte encoding.
Unlike bytes_to_utf8, this over-writes the original string, and
updates len to contain the new length.
Returns zero on failure, setting len to -1.
NOTE: this function is experimental and may change or be removed without notice.
U8* utf8_to_bytes(U8 *s, STRLEN *len)
s
which is assumed to be in UTF8 encoding and no longer than curlen;
retlen will be set to the length, in bytes, of that character.
If s does not point to a well-formed UTF8 character, the behaviour
is dependent on the value of flags: if it contains UTF8_CHECK_ONLY,
it is assumed that the caller will raise a warning, and this function
will silently just set retlen to -1 and return zero. If the
flags does not contain UTF8_CHECK_ONLY, warnings about
malformations will be given, retlen will be set to the expected
length of the UTF-8 character in bytes, and zero will be returned.
The flags can also contain various flags to allow deviations from
the strict UTF-8 encoding (see utf8.h).
NOTE: this function is experimental and may change or be removed without notice.
UV utf8_to_uv(U8 *s, STRLEN curlen, STRLEN* retlen, U32 flags)
s
which is assumed to be in UTF8 encoding; retlen will be set to the
length, in bytes, of that character.
If s does not point to a well-formed UTF8 character, zero is
returned and retlen is set, if possible, to -1.
NOTE: this function is experimental and may change or be removed without notice.
UV utf8_to_uv_simple(U8 *s, STRLEN* retlen)
uv to the end
of the string d; d should be have at least UTF8_MAXLEN+1 free
bytes available. The return value is the pointer to the byte after the
end of the new character. In other words,
d = uv_to_utf8(d, uv);
is the recommended Unicode-aware way of saying
*(d++) = uv;
NOTE: this function is experimental and may change or be removed without notice.
U8* uv_to_utf8(U8 *d, UV uv)
warn function. Use this
function the same way you use the C printf function. See
croak.
void warn(const char* pat, ...)
PUSHi.
void XPUSHi(IV iv)
PUSHn.
void XPUSHn(NV nv)
len
indicates the length of the string. Handles 'set' magic. See
PUSHp.
void XPUSHp(char* str, STRLEN len)
PUSHs.
void XPUSHs(SV* sv)
PUSHu.
void XPUSHu(UV uv)
xsubpp.
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;
&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)
ExtUtils::MakeMaker. See XS_VERSION_BOOTCHECK.
XS_VERSION variable. This is usually handled automatically by
xsubpp. See Le mot-clé VERSIONCHECK dans la page de manuel perlxs.
XS_VERSION_BOOTCHECK;
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)
Until May 1997, this document was maintained by Jeff Okamoto <okamoto@corp.hp.com>. It is now maintained as part of Perl itself.
With lots of help and suggestions from Dean Roehrich, Malcolm Beattie, Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer, Stephen McCamant, and Gurusamy Sarathy.
API Listing originally by Dean Roehrich <roehrich@cray.com>.
Updated to be autogenerated from comments in the source by Benjamin Stuhl.
perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
| perlapi - autogenerated documentation for the perl public API |