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