This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Import perl5321delta.pod
[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 {
6e128786
NC
12 HV* xmg_stash; /* class package */
13 union _xmgu xmg_u;
c8e503bf
NC
14 SSize_t xav_fill; /* Index of last element present */
15 SSize_t xav_max; /* max index for which array has space */
4f7003f5 16 SV** xav_alloc; /* pointer to beginning of C array of SVs */
79072805
LW
17};
18
e4305a63 19/* SV* xav_arylen; */
61b858cf 20
8c18259e 21/* SVpav_REAL is set for all AVs whose xav_array contents are refcounted.
61b858cf
GS
22 * Some things like "@_" and the scratchpad list do not set this, to
23 * indicate that they are cheating (for efficiency) by not refcounting
24 * the AV's contents.
25 *
8c18259e 26 * SVpav_REIFY is only meaningful on such "fake" AVs (i.e. where SVpav_REAL
61b858cf
GS
27 * is not set). It indicates that the fake AV is capable of becoming
28 * real if the array needs to be modified in some way. Functions that
29 * modify fake AVs check both flags to call av_reify() as appropriate.
30 *
af80dd86 31 * Note that the Perl stack has neither flag set. (Thus,
3ddcf04c 32 * items that go on the stack are never refcounted.)
61b858cf
GS
33 *
34 * These internal details are subject to change any time. AV
35 * manipulations external to perl should not care about any of this.
36 * GSAR 1999-09-10
37 */
79072805 38
954c1994 39/*
78342678 40=for apidoc ADmnU||Nullav
954c1994
GS
41Null AV pointer.
42
3ae1b226
NC
43(deprecated - use C<(AV *)NULL> instead)
44
a56541eb
KW
45=for apidoc Am|SSize_t|AvFILL|AV* av
46Same as C<L</av_top_index>> or C<L</av_tindex>>.
954c1994 47
a56541eb 48=for apidoc Cm|SSize_t|AvFILLp|AV* av
12719193 49
a56541eb
KW
50If the array C<av> is empty, this returns -1; otherwise it returns the maximum
51value of the indices of all the array elements which are currently defined in
52C<av>. It does not handle magic, hence the C<p> private indication in its name.
bb7379d7 53
941f2f38
FG
54=for apidoc Am|SV**|AvARRAY|AV* av
55Returns a pointer to the AV's internal SV* array.
56
57This is useful for doing pointer arithmetic on the array.
58If all you need is to look up an array element, then prefer C<av_fetch>.
59
954c1994
GS
60=cut
61*/
62
3ae1b226
NC
63#ifndef PERL_CORE
64# define Nullav Null(AV*)
65#endif
79072805 66
339049b0 67#define AvARRAY(av) ((av)->sv_u.svu_array)
4f7003f5 68#define AvALLOC(av) ((XPVAV*) SvANY(av))->xav_alloc
79072805 69#define AvMAX(av) ((XPVAV*) SvANY(av))->xav_max
93965878 70#define AvFILLp(av) ((XPVAV*) SvANY(av))->xav_fill
a062e10d 71#define AvARYLEN(av) (*Perl_av_arylen_p(aTHX_ MUTABLE_AV(av)))
79072805 72
11ca45c0
NC
73#define AvREAL(av) (SvFLAGS(av) & SVpav_REAL)
74#define AvREAL_on(av) (SvFLAGS(av) |= SVpav_REAL)
75#define AvREAL_off(av) (SvFLAGS(av) &= ~SVpav_REAL)
76#define AvREAL_only(av) (AvREIFY_off(av), SvFLAGS(av) |= SVpav_REAL)
77#define AvREIFY(av) (SvFLAGS(av) & SVpav_REIFY)
78#define AvREIFY_on(av) (SvFLAGS(av) |= SVpav_REIFY)
79#define AvREIFY_off(av) (SvFLAGS(av) &= ~SVpav_REIFY)
80#define AvREIFY_only(av) (AvREAL_off(av), SvFLAGS(av) |= SVpav_REIFY)
7db6405c 81
a0d0e21e 82
11ca45c0 83#define AvREALISH(av) (SvFLAGS(av) & (SVpav_REAL|SVpav_REIFY))
93965878 84
b1bc3f34 85#define AvFILL(av) ((SvRMAGICAL((const SV *) (av))) \
1604cfb0 86 ? mg_size(MUTABLE_SV(av)) : AvFILLp(av))
87306e06
KW
87#define av_top_index(av) AvFILL(av)
88#define av_tindex(av) av_top_index(av)
a0d0e21e 89
8dbc0cc7
KW
90/* Note that it doesn't make sense to do this:
91 * SvGETMAGIC(av); IV x = av_tindex_nomg(av);
8dbc0cc7 92 */
9506e945
KW
93# define av_top_index_skip_len_mg(av) \
94 (__ASSERT_(SvTYPE(av) == SVt_PVAV) AvFILLp(av))
95# define av_tindex_skip_len_mg(av) av_top_index_skip_len_mg(av)
6be58040 96
6f12eb6d 97#define NEGATIVE_INDICES_VAR "NEGATIVE_INDICES"
102d3b8a
NC
98
99/*
ac572bf4
NC
100=for apidoc newAV
101
102Creates a new AV. The reference count is set to 1.
103
f0b90de1
SF
104Perl equivalent: C<my @array;>.
105
ac572bf4
NC
106=cut
107*/
108
a062e10d 109#define newAV() MUTABLE_AV(newSV_type(SVt_PVAV))
ac572bf4
NC
110
111/*
14d04a33 112 * ex: set ts=8 sts=4 sw=4 et:
102d3b8a 113 */