This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
In the SV body, exchange the positions of the NV and stash/magic.
[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     union _xivu xiv_u;
17 };
18
19 /* SV** xav_alloc; */
20 #define xav_alloc xiv_u.xivu_p1
21 /* SV*  xav_arylen; */
22
23 /* SVpav_REAL is set for all AVs whose xav_array contents are refcounted.
24  * Some things like "@_" and the scratchpad list do not set this, to
25  * indicate that they are cheating (for efficiency) by not refcounting
26  * the AV's contents.
27  * 
28  * SVpav_REIFY is only meaningful on such "fake" AVs (i.e. where SVpav_REAL
29  * is not set).  It indicates that the fake AV is capable of becoming
30  * real if the array needs to be modified in some way.  Functions that
31  * modify fake AVs check both flags to call av_reify() as appropriate.
32  *
33  * Note that the Perl stack and @DB::args have neither flag set. (Thus,
34  * items that go on the stack are never refcounted.)
35  *
36  * These internal details are subject to change any time.  AV
37  * manipulations external to perl should not care about any of this.
38  * GSAR 1999-09-10
39  */
40
41 /*
42 =head1 Handy Values
43
44 =for apidoc AmU||Nullav
45 Null AV pointer.
46
47 (deprecated - use C<(AV *)NULL> instead)
48
49 =head1 Array Manipulation Functions
50
51 =for apidoc Am|int|AvFILL|AV* av
52 Same as C<av_len()>.  Deprecated, use C<av_len()> instead.
53
54 =cut
55 */
56
57 #ifndef PERL_CORE
58 #  define Nullav Null(AV*)
59 #endif
60
61 #define AvARRAY(av)     ((av)->sv_u.svu_array)
62 #define AvALLOC(av)     (*((SV***)&((XPVAV*)  SvANY(av))->xav_alloc))
63 #define AvMAX(av)       ((XPVAV*)  SvANY(av))->xav_max
64 #define AvFILLp(av)     ((XPVAV*)  SvANY(av))->xav_fill
65 #define AvARYLEN(av)    (*Perl_av_arylen_p(aTHX_ MUTABLE_AV(av)))
66
67 #define AvREAL(av)      (SvFLAGS(av) & SVpav_REAL)
68 #define AvREAL_on(av)   (SvFLAGS(av) |= SVpav_REAL)
69 #define AvREAL_off(av)  (SvFLAGS(av) &= ~SVpav_REAL)
70 #define AvREAL_only(av) (AvREIFY_off(av), SvFLAGS(av) |= SVpav_REAL)
71 #define AvREIFY(av)     (SvFLAGS(av) & SVpav_REIFY)
72 #define AvREIFY_on(av)  (SvFLAGS(av) |= SVpav_REIFY)
73 #define AvREIFY_off(av) (SvFLAGS(av) &= ~SVpav_REIFY)
74 #define AvREIFY_only(av)        (AvREAL_off(av), SvFLAGS(av) |= SVpav_REIFY)
75
76 #define AvREALISH(av)   (SvFLAGS(av) & (SVpav_REAL|SVpav_REIFY))
77                                           
78 #define AvFILL(av)      ((SvRMAGICAL((const SV *) (av))) \
79                          ? mg_size(MUTABLE_SV(av)) : AvFILLp(av))
80
81 #define NEGATIVE_INDICES_VAR "NEGATIVE_INDICES"
82
83 /*
84 =for apidoc newAV
85
86 Creates a new AV.  The reference count is set to 1.
87
88 =cut
89 */
90
91 #define newAV() MUTABLE_AV(newSV_type(SVt_PVAV))
92
93 /*
94  * Local variables:
95  * c-indentation-style: bsd
96  * c-basic-offset: 4
97  * indent-tabs-mode: t
98  * End:
99  *
100  * ex: set ts=8 sts=4 sw=4 noet:
101  */