This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Note that AvFILLp is not for public use
[perl5.git] / av.h
1 /*    av.h
2  *
3  *    Copyright (C) 1991, 1992, 1993, 1995, 1996, 1997, 1998, 1999, 2000,
4  *    2001, 2002, 2005, 2006, 2007, 2008, by Larry Wall and others
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  *
9  */
10
11 struct xpvav {
12     HV*         xmg_stash;      /* class package */
13     union _xmgu xmg_u;
14     SSize_t     xav_fill;       /* Index of last element present */
15     SSize_t     xav_max;        /* max index for which array has space */
16     SV**        xav_alloc;      /* pointer to beginning of C array of SVs */
17 };
18
19 /* SV*  xav_arylen; */
20
21 /* SVpav_REAL is set for all AVs whose xav_array contents are refcounted.
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  * 
26  * SVpav_REIFY is only meaningful on such "fake" AVs (i.e. where SVpav_REAL
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  *
31  * Note that the Perl stack has neither flag set. (Thus,
32  * items that go on the stack are never refcounted.)
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  */
38
39 /*
40 =head1 Handy Values
41
42 =for apidoc ADmnU||Nullav
43 Null AV pointer.
44
45 (deprecated - use C<(AV *)NULL> instead)
46
47 =head1 Array Manipulation Functions
48
49 =for apidoc Am|int|AvFILL|AV* av
50 Same as C<av_top_index()> or C<av_tindex()>.
51
52 =for apidoc av_tindex
53 Same as C<av_top_index()>.
54
55 =for apidoc m|int|AvFILLp|AV* av
56
57 =cut
58 */
59
60 #ifndef PERL_CORE
61 #  define Nullav Null(AV*)
62 #endif
63
64 #define AvARRAY(av)     ((av)->sv_u.svu_array)
65 #define AvALLOC(av)     ((XPVAV*)  SvANY(av))->xav_alloc
66 #define AvMAX(av)       ((XPVAV*)  SvANY(av))->xav_max
67 #define AvFILLp(av)     ((XPVAV*)  SvANY(av))->xav_fill
68 #define AvARYLEN(av)    (*Perl_av_arylen_p(aTHX_ MUTABLE_AV(av)))
69
70 #define AvREAL(av)      (SvFLAGS(av) & SVpav_REAL)
71 #define AvREAL_on(av)   (SvFLAGS(av) |= SVpav_REAL)
72 #define AvREAL_off(av)  (SvFLAGS(av) &= ~SVpav_REAL)
73 #define AvREAL_only(av) (AvREIFY_off(av), SvFLAGS(av) |= SVpav_REAL)
74 #define AvREIFY(av)     (SvFLAGS(av) & SVpav_REIFY)
75 #define AvREIFY_on(av)  (SvFLAGS(av) |= SVpav_REIFY)
76 #define AvREIFY_off(av) (SvFLAGS(av) &= ~SVpav_REIFY)
77 #define AvREIFY_only(av)        (AvREAL_off(av), SvFLAGS(av) |= SVpav_REIFY)
78
79
80 #define AvREALISH(av)   (SvFLAGS(av) & (SVpav_REAL|SVpav_REIFY))
81                                           
82 #define AvFILL(av)      ((SvRMAGICAL((const SV *) (av))) \
83                          ? mg_size(MUTABLE_SV(av)) : AvFILLp(av))
84 #define av_tindex(av)   av_top_index(av)
85
86 /* Note that it doesn't make sense to do this:
87  *      SvGETMAGIC(av); IV x = av_tindex_nomg(av);
88  */
89 #   define av_top_index_skip_len_mg(av)                                     \
90                             (__ASSERT_(SvTYPE(av) == SVt_PVAV) AvFILLp(av))
91 #   define av_tindex_skip_len_mg(av)  av_top_index_skip_len_mg(av)
92
93 #define NEGATIVE_INDICES_VAR "NEGATIVE_INDICES"
94
95 /*
96 =for apidoc newAV
97
98 Creates a new AV.  The reference count is set to 1.
99
100 Perl equivalent: C<my @array;>.
101
102 =cut
103 */
104
105 #define newAV() MUTABLE_AV(newSV_type(SVt_PVAV))
106
107 /*
108  * ex: set ts=8 sts=4 sw=4 et:
109  */