This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Re-order IVX slot in SV bodies
[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 {
102d3b8a 12 IV this_space;
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
NC
15 union {
16 NV xnvu_nv;
17 struct {
18 void *xnv_p1; /* pointer to beginning of C array of SVs */
19 union {
20 void *xnv_p2;
21 IV xnv_i2;
22 } xnv_u2;
23 } xnv_s;
24 } xnv_u;
79072805
LW
25 MAGIC* xmg_magic; /* magic for scalar array */
26 HV* xmg_stash; /* class package */
79072805
LW
27};
28
e4305a63
NC
29/* SV** xav_alloc; */
30#define xav_alloc xnv_u.xnv_s.xnv_p1
31/* SV* xav_arylen; */
32#define xav_arylen xnv_u.xnv_s.xnv_u2.xnv_p2
61b858cf
GS
33
34/* AVf_REAL is set for all AVs whose xav_array contents are refcounted.
35 * Some things like "@_" and the scratchpad list do not set this, to
36 * indicate that they are cheating (for efficiency) by not refcounting
37 * the AV's contents.
38 *
39 * AVf_REIFY is only meaningful on such "fake" AVs (i.e. where AVf_REAL
40 * is not set). It indicates that the fake AV is capable of becoming
41 * real if the array needs to be modified in some way. Functions that
42 * modify fake AVs check both flags to call av_reify() as appropriate.
43 *
3ddcf04c
GS
44 * Note that the Perl stack and @DB::args have neither flag set. (Thus,
45 * items that go on the stack are never refcounted.)
61b858cf
GS
46 *
47 * These internal details are subject to change any time. AV
48 * manipulations external to perl should not care about any of this.
49 * GSAR 1999-09-10
50 */
79072805 51
954c1994 52/*
ccfc67b7
JH
53=head1 Handy Values
54
954c1994
GS
55=for apidoc AmU||Nullav
56Null AV pointer.
57
ccfc67b7
JH
58=head1 Array Manipulation Functions
59
954c1994
GS
60=for apidoc Am|int|AvFILL|AV* av
61Same as C<av_len()>. Deprecated, use C<av_len()> instead.
62
63=cut
64*/
65
79072805
LW
66#define Nullav Null(AV*)
67
7b2c381c 68#define AvARRAY(av) ((av)->sv_u.sv_array)
e4305a63 69#define AvALLOC(av) (*((SV***)&((XPVAV*) SvANY(av))->xav_alloc))
79072805 70#define AvMAX(av) ((XPVAV*) SvANY(av))->xav_max
93965878 71#define AvFILLp(av) ((XPVAV*) SvANY(av))->xav_fill
e4305a63 72#define AvARYLEN(av) (*((SV**)&((XPVAV*) SvANY(av))->xav_arylen))
79072805 73
11ca45c0
NC
74#define AvREAL(av) (SvFLAGS(av) & SVpav_REAL)
75#define AvREAL_on(av) (SvFLAGS(av) |= SVpav_REAL)
76#define AvREAL_off(av) (SvFLAGS(av) &= ~SVpav_REAL)
77#define AvREAL_only(av) (AvREIFY_off(av), SvFLAGS(av) |= SVpav_REAL)
78#define AvREIFY(av) (SvFLAGS(av) & SVpav_REIFY)
79#define AvREIFY_on(av) (SvFLAGS(av) |= SVpav_REIFY)
80#define AvREIFY_off(av) (SvFLAGS(av) &= ~SVpav_REIFY)
81#define AvREIFY_only(av) (AvREAL_off(av), SvFLAGS(av) |= SVpav_REIFY)
a0d0e21e 82
11ca45c0 83#define AvREALISH(av) (SvFLAGS(av) & (SVpav_REAL|SVpav_REIFY))
93965878
NIS
84
85#define AvFILL(av) ((SvRMAGICAL((SV *) (av))) \
a60c0954 86 ? mg_size((SV *) av) : AvFILLp(av))
a0d0e21e 87
6f12eb6d 88#define NEGATIVE_INDICES_VAR "NEGATIVE_INDICES"
102d3b8a
NC
89
90/*
91 * Local variables:
92 * c-indentation-style: bsd
93 * c-basic-offset: 4
94 * indent-tabs-mode: t
95 * End:
96 *
97 * ex: set ts=8 sts=4 sw=4 noet:
98 */