This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
xgv_stash can be stored as a union with the NV, reducing the size of
[perl5.git] / av.h
1 /*    av.h
2  *
3  *    Copyright (C) 1991, 1992, 1993, 1995, 1996, 1997, 1998, 1999,
4  *    2000, 2001, 2002, 2005, 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     union {
13         NV      xnv_nv;         /* numeric value, if any */
14         HV *    xgv_stash;
15     }           xnv_u;
16     SSize_t     xav_fill;       /* Index of last element present */
17     SSize_t     xav_max;        /* max index for which array has space */
18     union {
19         IV      xivu_iv;        /* integer value or pv offset */
20         UV      xivu_uv;
21         void *  xivu_p1;
22     }           xiv_u;
23     union {
24         MAGIC*  xmg_magic;      /* linked list of magicalness */
25         HV*     xmg_ourstash;   /* Stash for our (when SvPAD_OUR is true) */
26     } xmg_u;
27     HV*         xmg_stash;      /* class package */
28 };
29
30 #if 0
31 typedef struct xpvav xpvav_allocated;
32 #else
33 typedef struct {
34     SSize_t     xav_fill;       /* Index of last element present */
35     SSize_t     xav_max;        /* max index for which array has space */
36     union {
37         IV      xivu_iv;        /* integer value or pv offset */
38         UV      xivu_uv;
39         void *  xivu_p1;
40     }           xiv_u;
41     union {
42         MAGIC*  xmg_magic;      /* linked list of magicalness */
43         HV*     xmg_ourstash;   /* Stash for our (when SvPAD_OUR is true) */
44     } xmg_u;
45     HV*         xmg_stash;      /* class package */
46 } xpvav_allocated;
47 #endif
48
49 /* SV** xav_alloc; */
50 #define xav_alloc xiv_u.xivu_p1
51 /* SV*  xav_arylen; */
52
53 /* SVpav_REAL is set for all AVs whose xav_array contents are refcounted.
54  * Some things like "@_" and the scratchpad list do not set this, to
55  * indicate that they are cheating (for efficiency) by not refcounting
56  * the AV's contents.
57  * 
58  * SVpav_REIFY is only meaningful on such "fake" AVs (i.e. where SVpav_REAL
59  * is not set).  It indicates that the fake AV is capable of becoming
60  * real if the array needs to be modified in some way.  Functions that
61  * modify fake AVs check both flags to call av_reify() as appropriate.
62  *
63  * Note that the Perl stack and @DB::args have neither flag set. (Thus,
64  * items that go on the stack are never refcounted.)
65  *
66  * These internal details are subject to change any time.  AV
67  * manipulations external to perl should not care about any of this.
68  * GSAR 1999-09-10
69  */
70
71 /*
72 =head1 Handy Values
73
74 =for apidoc AmU||Nullav
75 Null AV pointer.
76
77 =head1 Array Manipulation Functions
78
79 =for apidoc Am|int|AvFILL|AV* av
80 Same as C<av_len()>.  Deprecated, use C<av_len()> instead.
81
82 =cut
83 */
84
85 #define Nullav Null(AV*)
86
87 #define AvARRAY(av)     ((av)->sv_u.svu_array)
88 #define AvALLOC(av)     (*((SV***)&((XPVAV*)  SvANY(av))->xav_alloc))
89 #define AvMAX(av)       ((XPVAV*)  SvANY(av))->xav_max
90 #define AvFILLp(av)     ((XPVAV*)  SvANY(av))->xav_fill
91 #define AvARYLEN(av)    (*Perl_av_arylen_p(aTHX_ (AV*)av))
92
93 #define AvREAL(av)      (SvFLAGS(av) & SVpav_REAL)
94 #define AvREAL_on(av)   (SvFLAGS(av) |= SVpav_REAL)
95 #define AvREAL_off(av)  (SvFLAGS(av) &= ~SVpav_REAL)
96 #define AvREAL_only(av) (AvREIFY_off(av), SvFLAGS(av) |= SVpav_REAL)
97 #define AvREIFY(av)     (SvFLAGS(av) & SVpav_REIFY)
98 #define AvREIFY_on(av)  (SvFLAGS(av) |= SVpav_REIFY)
99 #define AvREIFY_off(av) (SvFLAGS(av) &= ~SVpav_REIFY)
100 #define AvREIFY_only(av)        (AvREAL_off(av), SvFLAGS(av) |= SVpav_REIFY)
101
102 #define AvREALISH(av)   (SvFLAGS(av) & (SVpav_REAL|SVpav_REIFY))
103                                           
104 #define AvFILL(av)      ((SvRMAGICAL((SV *) (av))) \
105                           ? mg_size((SV *) av) : AvFILLp(av))
106
107 #define NEGATIVE_INDICES_VAR "NEGATIVE_INDICES"
108
109 /*
110  * Local variables:
111  * c-indentation-style: bsd
112  * c-basic-offset: 4
113  * indent-tabs-mode: t
114  * End:
115  *
116  * ex: set ts=8 sts=4 sw=4 noet:
117  */