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