sv.h revision 7c478bd95313f5f23a4c958a745db2134aa03244
/* sv.h
*
* Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
* 2000, 2001, 2002, 2003, 2004, by Larry Wall and others
*
* You may distribute under the terms of either the GNU General Public
* License or the Artistic License, as specified in the README file.
*
*/
#ifdef sv_flags
#endif
/*
=head1 SV Flags
=for apidoc AmU||svtype
An enum of flags for Perl types. These are found in the file B<sv.h>
in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
=for apidoc AmU||SVt_PV
Pointer type flag for scalars. See C<svtype>.
=for apidoc AmU||SVt_IV
Integer type flag for scalars. See C<svtype>.
=for apidoc AmU||SVt_NV
Double type flag for scalars. See C<svtype>.
=for apidoc AmU||SVt_PVMG
Type flag for blessed scalars. See C<svtype>.
=for apidoc AmU||SVt_PVAV
Type flag for arrays. See C<svtype>.
=for apidoc AmU||SVt_PVHV
Type flag for hashes. See C<svtype>.
=for apidoc AmU||SVt_PVCV
Type flag for code refs. See C<svtype>.
=cut
*/
typedef enum {
SVt_NULL, /* 0 */
SVt_IV, /* 1 */
SVt_NV, /* 2 */
SVt_RV, /* 3 */
SVt_PV, /* 4 */
SVt_PVIV, /* 5 */
SVt_PVNV, /* 6 */
SVt_PVMG, /* 7 */
SVt_PVBM, /* 8 */
SVt_PVLV, /* 9 */
SVt_PVAV, /* 10 */
SVt_PVHV, /* 11 */
SVt_PVCV, /* 12 */
SVt_PVGV, /* 13 */
SVt_PVFM, /* 14 */
SVt_PVIO /* 15 */
} svtype;
/* Using C's structural equivalence to help emulate C++ inheritance here... */
struct STRUCT_SV { /* struct sv { */
void* sv_any; /* pointer to something */
};
struct gv {
};
struct cv {
};
struct av {
};
struct hv {
};
struct io {
};
/*
=head1 SV Manipulation Functions
=for apidoc Am|U32|SvREFCNT|SV* sv
Returns the value of the object's reference count.
=for apidoc Am|SV*|SvREFCNT_inc|SV* sv
Increments the reference count of the given SV.
=for apidoc Am|void|SvREFCNT_dec|SV* sv
Decrements the reference count of the given SV.
=for apidoc Am|svtype|SvTYPE|SV* sv
Returns the type of the SV. See C<svtype>.
=for apidoc Am|void|SvUPGRADE|SV* sv|svtype type
Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
perform the upgrade if necessary. See C<svtype>.
=cut
*/
#ifdef USE_5005THREADS
# if defined(VMS)
# else
# ifdef EMULATE_ATOMIC_REFCOUNTS
MUTEX_LOCK(&PL_svref_mutex); \
++count; \
} STMT_END
MUTEX_LOCK(&PL_svref_mutex); \
} STMT_END
# else
# endif /* EMULATE_ATOMIC_REFCOUNTS */
# endif /* VMS */
#else
#endif /* USE_5005THREADS */
# define SvREFCNT_inc(sv) \
({ \
if (_sv) \
_sv; \
})
#else
# ifdef USE_5005THREADS
# define SvREFCNT_inc(sv) \
# else
# endif
# else
# define SvREFCNT_inc(sv) \
# endif
#endif
#define SVTYPEMASK 0xff
* by SV's in final arena cleanup */
/* Some private flags. */
/* SVpad_OUR may be set on SVt_PV{NV,MG,GV} types */
#define SVpbm_VALID 0x80000000
#define SVpbm_TAIL 0x40000000
struct xrv {
};
struct xpv {
char * xpv_pv; /* pointer to malloced string */
};
struct xpviv {
char * xpv_pv; /* pointer to malloced string */
};
struct xpvuv {
char * xpv_pv; /* pointer to malloced string */
};
struct xpvnv {
char * xpv_pv; /* pointer to malloced string */
};
/* These structure must match the beginning of struct xpvhv in hv.h. */
struct xpvmg {
char * xpv_pv; /* pointer to malloced string */
};
struct xpvlv {
char * xpv_pv; /* pointer to malloced string */
};
struct xpvgv {
char * xpv_pv; /* pointer to malloced string */
char* xgv_name;
};
struct xpvbm {
char * xpv_pv; /* pointer to malloced string */
};
/* This structure must match XPVCV in cv.h */
typedef U16 cv_flags_t;
struct xpvfm {
char * xpv_pv; /* pointer to malloced string */
char * xcv_file;
long xcv_depth; /* >= 2 indicates recursive call */
AV * xcv_padlist;
CV * xcv_outside;
#ifdef USE_5005THREADS
#endif /* USE_5005THREADS */
* compilation) in the lexically enclosing
* sub */
};
struct xpvio {
char * xpv_pv; /* pointer to malloced string */
/* Cray addresses everything by word boundaries (64 bits) and
* code and data pointers cannot be mixed (which is exactly what
* Perl_filter_add() tries to do with the dirp), hence the following
* union trick (as suggested by Gurusamy Sarathy).
* For further information see Geir Johansen's problem report titled
[ID 20000612.002] Perl problem on Cray system
* The any pointer (known as IoANY()) will also be a good place
* to hang any IO disciplines to.
*/
union {
void * xiou_any; /* for alignment */
} xio_dirpu;
char * xio_top_name; /* $^ */
char * xio_fmt_name; /* $~ */
char * xio_bottom_name;/* $^B */
short xio_subprocess; /* -| or |- */
char xio_type;
char xio_flags;
};
/* The following macros define implementation-independent predicates on SVs. */
/*
=for apidoc Am|bool|SvNIOK|SV* sv
Returns a boolean indicating whether the SV contains a number, integer or
double.
=for apidoc Am|bool|SvNIOKp|SV* sv
Returns a boolean indicating whether the SV contains a number, integer or
double. Checks the B<private> setting. Use C<SvNIOK>.
=for apidoc Am|void|SvNIOK_off|SV* sv
=for apidoc Am|bool|SvOK|SV* sv
Returns a boolean indicating whether the value is an SV.
=for apidoc Am|bool|SvIOKp|SV* sv
Returns a boolean indicating whether the SV contains an integer. Checks
the B<private> setting. Use C<SvIOK>.
=for apidoc Am|bool|SvNOKp|SV* sv
Returns a boolean indicating whether the SV contains a double. Checks the
B<private> setting. Use C<SvNOK>.
=for apidoc Am|bool|SvPOKp|SV* sv
Returns a boolean indicating whether the SV contains a character string.
Checks the B<private> setting. Use C<SvPOK>.
=for apidoc Am|bool|SvIOK|SV* sv
Returns a boolean indicating whether the SV contains an integer.
=for apidoc Am|void|SvIOK_on|SV* sv
Tells an SV that it is an integer.
=for apidoc Am|void|SvIOK_off|SV* sv
Unsets the IV status of an SV.
=for apidoc Am|void|SvIOK_only|SV* sv
Tells an SV that it is an integer and disables all other OK bits.
=for apidoc Am|void|SvIOK_only_UV|SV* sv
Tells and SV that it is an unsigned integer and disables all other OK bits.
=for apidoc Am|bool|SvIOK_UV|SV* sv
Returns a boolean indicating whether the SV contains an unsigned integer.
=for apidoc Am|void|SvUOK|SV* sv
Returns a boolean indicating whether the SV contains an unsigned integer.
=for apidoc Am|bool|SvIOK_notUV|SV* sv
Returns a boolean indicating whether the SV contains a signed integer.
=for apidoc Am|bool|SvNOK|SV* sv
Returns a boolean indicating whether the SV contains a double.
=for apidoc Am|void|SvNOK_on|SV* sv
Tells an SV that it is a double.
=for apidoc Am|void|SvNOK_off|SV* sv
Unsets the NV status of an SV.
=for apidoc Am|void|SvNOK_only|SV* sv
Tells an SV that it is a double and disables all other OK bits.
=for apidoc Am|bool|SvPOK|SV* sv
Returns a boolean indicating whether the SV contains a character
string.
=for apidoc Am|void|SvPOK_on|SV* sv
Tells an SV that it is a string.
=for apidoc Am|void|SvPOK_off|SV* sv
Unsets the PV status of an SV.
=for apidoc Am|void|SvPOK_only|SV* sv
Tells an SV that it is a string and disables all other OK bits.
Will also turn off the UTF-8 status.
=for apidoc Am|bool|SvOOK|SV* sv
Returns a boolean indicating whether the SvIVX is a valid offset value for
the SvPVX. This hack is used internally to speed up removal of characters
from the beginning of a SvPV. When SvOOK is true, then the start of the
allocated string buffer is really (SvPVX - SvIVX).
=for apidoc Am|bool|SvROK|SV* sv
Tests if the SV is an RV.
=for apidoc Am|void|SvROK_on|SV* sv
Tells an SV that it is an RV.
=for apidoc Am|void|SvROK_off|SV* sv
Unsets the RV status of an SV.
=for apidoc Am|SV*|SvRV|SV* sv
Dereferences an RV to return the SV.
=for apidoc Am|IV|SvIVX|SV* sv
Returns the raw value in the SV's IV slot, without checks or conversions.
Only use when you are sure SvIOK is true. See also C<SvIV()>.
=for apidoc Am|UV|SvUVX|SV* sv
Returns the raw value in the SV's UV slot, without checks or conversions.
Only use when you are sure SvIOK is true. See also C<SvUV()>.
=for apidoc Am|NV|SvNVX|SV* sv
Returns the raw value in the SV's NV slot, without checks or conversions.
Only use when you are sure SvNOK is true. See also C<SvNV()>.
=for apidoc Am|char*|SvPVX|SV* sv
Returns a pointer to the physical string in the SV. The SV must contain a
string.
=for apidoc Am|STRLEN|SvCUR|SV* sv
Returns the length of the string which is in the SV. See C<SvLEN>.
=for apidoc Am|STRLEN|SvLEN|SV* sv
Returns the size of the string buffer in the SV, not including any part
attributable to C<SvOOK>. See C<SvCUR>.
=for apidoc Am|char*|SvEND|SV* sv
Returns a pointer to the last character in the string which is in the SV.
See C<SvCUR>. Access the character as *(SvEND(sv)).
=for apidoc Am|HV*|SvSTASH|SV* sv
Returns the stash of the SV.
=for apidoc Am|void|SvCUR_set|SV* sv|STRLEN len
Set the length of the string which is in the SV. See C<SvCUR>.
=cut
*/
#if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
#else
#define assert_not_ROK(sv)
#endif
SVf_IVisUV|SVf_UTF8), \
SVf_UTF8), \
== (SVf_IOK|SVf_IVisUV))
== SVf_IOK)
/*
=for apidoc Am|bool|SvUTF8|SV* sv
Returns a boolean indicating whether the SV contains UTF-8 encoded data.
=for apidoc Am|void|SvUTF8_on|SV *sv
Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
Do not use frivolously.
=for apidoc Am|void|SvUTF8_off|SV *sv
Unsets the UTF-8 status of an SV.
=for apidoc Am|void|SvPOK_only_UTF8|SV* sv
Tells an SV that it is a string and disables all other OK bits,
and leaves the UTF-8 status as it was.
=cut
*/
SVf_IVisUV|SVf_UTF8), \
SVf_IVisUV), \
/*
#define Gv_AMG(stash) \
(HV_AMAGICmb(stash) && \
((!HV_AMAGICbad(stash) && HV_AMAGIC(stash)) || Gv_AMupdate(stash)))
*/
== (SVf_ROK|SVprv_WEAKREF))
#ifdef USE_ITHREADS
/* The following uses the FAKE flag to show that a regex pointer is infact
its own offset in the regexpad for ithreads */
#endif
/* Ask a scalar nicely to try to become an IV, if possible.
Not guaranteed to stay returning void */
/* Macro won't actually call sv_2iv if already IOK */
#define SvIV_please(sv) \
/* IoTYPE(sv) is a single character telling the type of I/O connection. */
#define IoTYPE_RDONLY '<'
#define IoTYPE_WRONLY '>'
#define IoTYPE_RDWR '+'
#define IoTYPE_APPEND 'a'
#define IoTYPE_PIPE '|'
#define IoTYPE_SOCKET 's'
#define IoTYPE_CLOSED ' '
/*
=for apidoc Am|bool|SvTAINTED|SV* sv
Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
not.
=for apidoc Am|void|SvTAINTED_on|SV* sv
Marks an SV as tainted if tainting is enabled.
=for apidoc Am|void|SvTAINTED_off|SV* sv
Untaints an SV. Be I<very> careful with this routine, as it short-circuits
some of Perl's fundamental security features. XS module authors should not
use this function unless they fully understand all the implications of
unconditionally untainting the value. Untainting should be done in the
standard perl fashion, via a carefully crafted regexp, rather than directly
untainting variables.
=for apidoc Am|void|SvTAINT|SV* sv
Taints an SV if tainting is enabled.
=cut
*/
STMT_START { \
if (PL_tainting) { \
if (PL_tainted) \
SvTAINTED_on(sv); \
} \
} STMT_END
/*
=for apidoc Am|char*|SvPV_force|SV* sv|STRLEN len
Like C<SvPV> but will force the SV into containing just a string
(C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
directly.
=for apidoc Am|char*|SvPV_force_nomg|SV* sv|STRLEN len
Like C<SvPV> but will force the SV into containing just a string
(C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
directly. Doesn't process magic.
=for apidoc Am|char*|SvPV|SV* sv|STRLEN len
Returns a pointer to the string in the SV, or a stringified form of
the SV if the SV does not contain a string. The SV may cache the
stringified version becoming C<SvPOK>. Handles 'get' magic. See also
C<SvPVx> for a version which guarantees to evaluate sv only once.
=for apidoc Am|char*|SvPVx|SV* sv|STRLEN len
A version of C<SvPV> which guarantees to evaluate sv only once.
=for apidoc Am|char*|SvPV_nolen|SV* sv
Returns a pointer to the string in the SV, or a stringified form of
the SV if the SV does not contain a string. The SV may cache the
stringified form becoming C<SvPOK>. Handles 'get' magic.
=for apidoc Am|IV|SvIV|SV* sv
Coerces the given SV to an integer and returns it. See C<SvIVx> for a
version which guarantees to evaluate sv only once.
=for apidoc Am|IV|SvIVx|SV* sv
Coerces the given SV to an integer and returns it. Guarantees to evaluate
sv only once. Use the more efficient C<SvIV> otherwise.
=for apidoc Am|NV|SvNV|SV* sv
Coerce the given SV to a double and return it. See C<SvNVx> for a version
which guarantees to evaluate sv only once.
=for apidoc Am|NV|SvNVx|SV* sv
Coerces the given SV to a double and returns it. Guarantees to evaluate
sv only once. Use the more efficient C<SvNV> otherwise.
=for apidoc Am|UV|SvUV|SV* sv
Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
for a version which guarantees to evaluate sv only once.
=for apidoc Am|UV|SvUVx|SV* sv
Coerces the given SV to an unsigned integer and returns it. Guarantees to
evaluate sv only once. Use the more efficient C<SvUV> otherwise.
=for apidoc Am|bool|SvTRUE|SV* sv
Returns a boolean indicating whether Perl would evaluate the SV as true or
false, defined or undefined. Does not handle 'get' magic.
=for apidoc Am|char*|SvPVutf8_force|SV* sv|STRLEN len
Like C<SvPV_force>, but converts sv to utf8 first if necessary.
=for apidoc Am|char*|SvPVutf8|SV* sv|STRLEN len
Like C<SvPV>, but converts sv to utf8 first if necessary.
=for apidoc Am|char*|SvPVutf8_nolen|SV* sv
Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
=for apidoc Am|char*|SvPVbyte_force|SV* sv|STRLEN len
Like C<SvPV_force>, but converts sv to byte representation first if necessary.
=for apidoc Am|char*|SvPVbyte|SV* sv|STRLEN len
Like C<SvPV>, but converts sv to byte representation first if necessary.
=for apidoc Am|char*|SvPVbyte_nolen|SV* sv
Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
=for apidoc Am|char*|SvPVutf8x_force|SV* sv|STRLEN len
Like C<SvPV_force>, but converts sv to utf8 first if necessary.
Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
otherwise.
=for apidoc Am|char*|SvPVutf8x|SV* sv|STRLEN len
Like C<SvPV>, but converts sv to utf8 first if necessary.
Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
otherwise.
=for apidoc Am|char*|SvPVbytex_force|SV* sv|STRLEN len
Like C<SvPV_force>, but converts sv to byte representation first if necessary.
Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
otherwise.
=for apidoc Am|char*|SvPVbytex|SV* sv|STRLEN len
Like C<SvPV>, but converts sv to byte representation first if necessary.
Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
otherwise.
=for apidoc Am|bool|SvIsCOW|SV* sv
Returns a boolean indicating whether the SV is Copy-On-Write. (either shared
hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
COW)
=for apidoc Am|bool|SvIsCOW_shared_hash|SV* sv
Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
scalar.
=cut
*/
/* Let us hope that bitmaps for UV and IV are the same */
/* ----*/
#define SvPV_nolen(sv) \
/* ----*/
#define SvPVutf8_nolen(sv) \
/* ----*/
#define SvPVbyte_nolen(sv) \
/* define FOOx(): idempotent versions of FOO(). If possible, use a local
* var to evaluate the arg once; failing that, use a global if possible;
* failing that, call a function to do the work
*/
#if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
!sv \
? 0 \
nxpv && \
? 1 \
: 0) \
: \
#else /* __GNUC__ */
# ifdef USE_5005THREADS
# else /* USE_5005THREADS */
/* These inlined macros use globals, which will require a thread
* declaration in user code, so we avoid them under threads */
!sv \
? 0 \
? 1 \
: 0) \
: \
# endif /* USE_5005THREADS */
#endif /* __GNU__ */
(SVf_FAKE | SVf_READONLY))
/* flag values for sv_*_flags functions */
#define SV_IMMEDIATE_UNREF 1
#define SV_GMAGIC 2
#define SV_UTF8_NO_ENCODING 8
/* all these 'functions' are now just macros */
/* Should be named SvCatPVN_utf8_upgrade? */
STMT_START { \
if (!(nsv)) \
else \
SvUTF8_off(nsv); \
sv_utf8_upgrade(nsv); \
} STMT_END
/*
=for apidoc Am|SV*|newRV_inc|SV* sv
Creates an RV wrapper for an SV. The reference count for the original SV is
incremented.
=cut
*/
/* the following macros update any magic values this sv is associated with */
/*
=head1 Magical Functions
=for apidoc Am|void|SvGETMAGIC|SV* sv
Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
argument more than once.
=for apidoc Am|void|SvSETMAGIC|SV* sv
Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
argument more than once.
=for apidoc Am|void|SvSetSV|SV* dsb|SV* ssv
Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
more than once.
=for apidoc Am|void|SvSetSV_nosteal|SV* dsv|SV* ssv
Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
ssv. May evaluate arguments more than once.
=for apidoc Am|void|SvSetMagicSV|SV* dsb|SV* ssv
Like C<SvSetSV>, but does any set magic required afterwards.
=for apidoc Am|void|SvSetMagicSV_nosteal|SV* dsv|SV* ssv
Like C<SvSetMagicSV>, but does any set magic required afterwards.
=for apidoc Am|void|SvSHARE|SV* sv
Arranges for sv to be shared between threads if a suitable module
has been loaded.
=for apidoc Am|void|SvLOCK|SV* sv
Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
has been loaded.
=for apidoc Am|void|SvUNLOCK|SV* sv
Releases a mutual exclusion lock on sv if a suitable module
has been loaded.
=head1 SV Manipulation Functions
=for apidoc Am|char *|SvGROW|SV* sv|STRLEN len
Expands the character buffer in the SV so that it has room for the
indicated number of bytes (remember to reserve space for an extra trailing
NUL character). Calls C<sv_grow> to perform the expansion if necessary.
Returns a pointer to the character buffer.
=cut
*/
STMT_START { \
finally; \
} \
} STMT_END
STMT_START { \
SvTEMP_off(src); \
finally; \
} \
} STMT_END
#if !defined(SKIP_DEBUGGING)
#else
#endif
#define SvIMMORTAL(sv) ((sv)==&PL_sv_undef || (sv)==&PL_sv_yes || (sv)==&PL_sv_no || (sv)==&PL_sv_placeholder)
#define CLONEf_COPY_STACKS 1
#define CLONEf_KEEP_PTR_TABLE 2
#define CLONEf_CLONE_HOST 4
#define CLONEf_JOIN_IN 8
struct clone_params {
};