This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Change the IV to a union.
[perl5.git] / av.h
CommitLineData
a0d0e21e 1/* av.h
79072805 2 *
4bb101f2 3 * Copyright (C) 1991, 1992, 1993, 1995, 1996, 1997, 1998, 1999,
102d3b8a 4 * 2000, 2001, 2002, 2005, by Larry Wall and others
79072805
LW
5 *
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
8 *
79072805
LW
9 */
10
11struct xpvav {
311a25d9 12 NV xnv_nv; /* numeric value, if any */
93965878 13 SSize_t xav_fill; /* Index of last element present */
d18c6117 14 SSize_t xav_max; /* max index for which array has space */
e4305a63 15 union {
311a25d9
NC
16 IV xivu_iv; /* integer value or pv offset */
17 UV xivu_uv;
18 void * xivu_p1;
19 } xiv_u;
79072805
LW
20 MAGIC* xmg_magic; /* magic for scalar array */
21 HV* xmg_stash; /* class package */
311a25d9 22 SV* xav_arylen;
79072805
LW
23};
24
209b62a3 25#if !defined(PERL_EXPERIMENTAL_LAYOUT)
59813432 26typedef struct xpvav xpvav_allocated;
9f1501b2
NC
27#else
28typedef struct {
29 SSize_t xav_fill; /* Index of last element present */
30 SSize_t xav_max; /* max index for which array has space */
31 union {
311a25d9
NC
32 IV xivu_iv; /* integer value or pv offset */
33 UV xivu_uv;
34 void * xivu_p1;
35 } xiv_u;
9f1501b2
NC
36 MAGIC* xmg_magic; /* magic for scalar array */
37 HV* xmg_stash; /* class package */
311a25d9 38 SV* xav_arylen;
9f1501b2
NC
39} xpvav_allocated;
40#endif
59813432 41
e4305a63 42/* SV** xav_alloc; */
311a25d9 43#define xav_alloc xiv_u.xivu_p1
e4305a63 44/* SV* xav_arylen; */
61b858cf
GS
45
46/* AVf_REAL is set for all AVs whose xav_array contents are refcounted.
47 * Some things like "@_" and the scratchpad list do not set this, to
48 * indicate that they are cheating (for efficiency) by not refcounting
49 * the AV's contents.
50 *
51 * AVf_REIFY is only meaningful on such "fake" AVs (i.e. where AVf_REAL
52 * is not set). It indicates that the fake AV is capable of becoming
53 * real if the array needs to be modified in some way. Functions that
54 * modify fake AVs check both flags to call av_reify() as appropriate.
55 *
3ddcf04c
GS
56 * Note that the Perl stack and @DB::args have neither flag set. (Thus,
57 * items that go on the stack are never refcounted.)
61b858cf
GS
58 *
59 * These internal details are subject to change any time. AV
60 * manipulations external to perl should not care about any of this.
61 * GSAR 1999-09-10
62 */
79072805 63
954c1994 64/*
ccfc67b7
JH
65=head1 Handy Values
66
954c1994
GS
67=for apidoc AmU||Nullav
68Null AV pointer.
69
ccfc67b7
JH
70=head1 Array Manipulation Functions
71
954c1994
GS
72=for apidoc Am|int|AvFILL|AV* av
73Same as C<av_len()>. Deprecated, use C<av_len()> instead.
74
75=cut
76*/
77
79072805
LW
78#define Nullav Null(AV*)
79
339049b0 80#define AvARRAY(av) ((av)->sv_u.svu_array)
e4305a63 81#define AvALLOC(av) (*((SV***)&((XPVAV*) SvANY(av))->xav_alloc))
79072805 82#define AvMAX(av) ((XPVAV*) SvANY(av))->xav_max
93965878 83#define AvFILLp(av) ((XPVAV*) SvANY(av))->xav_fill
e4305a63 84#define AvARYLEN(av) (*((SV**)&((XPVAV*) SvANY(av))->xav_arylen))
79072805 85
11ca45c0
NC
86#define AvREAL(av) (SvFLAGS(av) & SVpav_REAL)
87#define AvREAL_on(av) (SvFLAGS(av) |= SVpav_REAL)
88#define AvREAL_off(av) (SvFLAGS(av) &= ~SVpav_REAL)
89#define AvREAL_only(av) (AvREIFY_off(av), SvFLAGS(av) |= SVpav_REAL)
90#define AvREIFY(av) (SvFLAGS(av) & SVpav_REIFY)
91#define AvREIFY_on(av) (SvFLAGS(av) |= SVpav_REIFY)
92#define AvREIFY_off(av) (SvFLAGS(av) &= ~SVpav_REIFY)
93#define AvREIFY_only(av) (AvREAL_off(av), SvFLAGS(av) |= SVpav_REIFY)
a0d0e21e 94
11ca45c0 95#define AvREALISH(av) (SvFLAGS(av) & (SVpav_REAL|SVpav_REIFY))
93965878
NIS
96
97#define AvFILL(av) ((SvRMAGICAL((SV *) (av))) \
a60c0954 98 ? mg_size((SV *) av) : AvFILLp(av))
a0d0e21e 99
6f12eb6d 100#define NEGATIVE_INDICES_VAR "NEGATIVE_INDICES"
102d3b8a
NC
101
102/*
103 * Local variables:
104 * c-indentation-style: bsd
105 * c-basic-offset: 4
106 * indent-tabs-mode: t
107 * End:
108 *
109 * ex: set ts=8 sts=4 sw=4 noet:
110 */