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