This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Remove all space optimisations from SV body structures.
[perl5.git] / av.h
CommitLineData
a0d0e21e 1/* av.h
79072805 2 *
1129b882
NC
3 * Copyright (C) 1991, 1992, 1993, 1995, 1996, 1997, 1998, 1999, 2000,
4 * 2001, 2002, 2005, 2006, 2007, 2008, 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 {
c8e503bf
NC
12 union _xnvu xnv_u;
13 SSize_t xav_fill; /* Index of last element present */
14 SSize_t xav_max; /* max index for which array has space */
20f4945e 15 _XPVMG_HEAD;
79072805
LW
16};
17
e4305a63 18/* SV** xav_alloc; */
311a25d9 19#define xav_alloc xiv_u.xivu_p1
e4305a63 20/* SV* xav_arylen; */
61b858cf 21
8c18259e 22/* SVpav_REAL is set for all AVs whose xav_array contents are refcounted.
61b858cf
GS
23 * Some things like "@_" and the scratchpad list do not set this, to
24 * indicate that they are cheating (for efficiency) by not refcounting
25 * the AV's contents.
26 *
8c18259e 27 * SVpav_REIFY is only meaningful on such "fake" AVs (i.e. where SVpav_REAL
61b858cf
GS
28 * is not set). It indicates that the fake AV is capable of becoming
29 * real if the array needs to be modified in some way. Functions that
30 * modify fake AVs check both flags to call av_reify() as appropriate.
31 *
3ddcf04c
GS
32 * Note that the Perl stack and @DB::args have neither flag set. (Thus,
33 * items that go on the stack are never refcounted.)
61b858cf
GS
34 *
35 * These internal details are subject to change any time. AV
36 * manipulations external to perl should not care about any of this.
37 * GSAR 1999-09-10
38 */
79072805 39
954c1994 40/*
ccfc67b7
JH
41=head1 Handy Values
42
954c1994
GS
43=for apidoc AmU||Nullav
44Null AV pointer.
45
3ae1b226
NC
46(deprecated - use C<(AV *)NULL> instead)
47
ccfc67b7
JH
48=head1 Array Manipulation Functions
49
954c1994
GS
50=for apidoc Am|int|AvFILL|AV* av
51Same as C<av_len()>. Deprecated, use C<av_len()> instead.
52
53=cut
54*/
55
3ae1b226
NC
56#ifndef PERL_CORE
57# define Nullav Null(AV*)
58#endif
79072805 59
339049b0 60#define AvARRAY(av) ((av)->sv_u.svu_array)
e4305a63 61#define AvALLOC(av) (*((SV***)&((XPVAV*) SvANY(av))->xav_alloc))
79072805 62#define AvMAX(av) ((XPVAV*) SvANY(av))->xav_max
93965878 63#define AvFILLp(av) ((XPVAV*) SvANY(av))->xav_fill
a062e10d 64#define AvARYLEN(av) (*Perl_av_arylen_p(aTHX_ MUTABLE_AV(av)))
79072805 65
11ca45c0
NC
66#define AvREAL(av) (SvFLAGS(av) & SVpav_REAL)
67#define AvREAL_on(av) (SvFLAGS(av) |= SVpav_REAL)
68#define AvREAL_off(av) (SvFLAGS(av) &= ~SVpav_REAL)
69#define AvREAL_only(av) (AvREIFY_off(av), SvFLAGS(av) |= SVpav_REAL)
70#define AvREIFY(av) (SvFLAGS(av) & SVpav_REIFY)
71#define AvREIFY_on(av) (SvFLAGS(av) |= SVpav_REIFY)
72#define AvREIFY_off(av) (SvFLAGS(av) &= ~SVpav_REIFY)
73#define AvREIFY_only(av) (AvREAL_off(av), SvFLAGS(av) |= SVpav_REIFY)
a0d0e21e 74
11ca45c0 75#define AvREALISH(av) (SvFLAGS(av) & (SVpav_REAL|SVpav_REIFY))
93965878 76
b1bc3f34
NC
77#define AvFILL(av) ((SvRMAGICAL((const SV *) (av))) \
78 ? mg_size(MUTABLE_SV(av)) : AvFILLp(av))
a0d0e21e 79
6f12eb6d 80#define NEGATIVE_INDICES_VAR "NEGATIVE_INDICES"
102d3b8a
NC
81
82/*
ac572bf4
NC
83=for apidoc newAV
84
85Creates a new AV. The reference count is set to 1.
86
87=cut
88*/
89
a062e10d 90#define newAV() MUTABLE_AV(newSV_type(SVt_PVAV))
ac572bf4
NC
91
92/*
102d3b8a
NC
93 * Local variables:
94 * c-indentation-style: bsd
95 * c-basic-offset: 4
96 * indent-tabs-mode: t
97 * End:
98 *
99 * ex: set ts=8 sts=4 sw=4 noet:
100 */