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
CommitLineData
a0d0e21e 1/* av.h
79072805 2 *
4bb101f2 3 * Copyright (C) 1991, 1992, 1993, 1995, 1996, 1997, 1998, 1999,
102d3b8a 4 * 2000, 2001, 2002, 2005, by Larry Wall and others
79072805
LW
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 *
79072805
LW
9 */
10
11struct xpvav {
58430790
NC
12 union {
13 NV xnv_nv; /* numeric value, if any */
14 HV * xgv_stash;
3441fb63
NC
15 struct {
16 U32 xlow;
17 U32 xhigh;
18 } xpad_cop_seq; /* used by pad.c for cop_sequence */
58430790 19 } xnv_u;
93965878 20 SSize_t xav_fill; /* Index of last element present */
d18c6117 21 SSize_t xav_max; /* max index for which array has space */
e4305a63 22 union {
311a25d9
NC
23 IV xivu_iv; /* integer value or pv offset */
24 UV xivu_uv;
25 void * xivu_p1;
69ecfd12
NC
26 I32 xivu_i32;
27 HEK * xivu_namehek;
311a25d9 28 } xiv_u;
e736a858
NC
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;
79072805 33 HV* xmg_stash; /* class package */
79072805
LW
34};
35
c5f87f51 36#if 0
59813432 37typedef struct xpvav xpvav_allocated;
9f1501b2
NC
38#else
39typedef 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 {
311a25d9
NC
43 IV xivu_iv; /* integer value or pv offset */
44 UV xivu_uv;
45 void * xivu_p1;
69ecfd12
NC
46 I32 xivu_i32;
47 HEK * xivu_namehek;
311a25d9 48 } xiv_u;
e736a858
NC
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;
9f1501b2
NC
53 HV* xmg_stash; /* class package */
54} xpvav_allocated;
55#endif
59813432 56
e4305a63 57/* SV** xav_alloc; */
311a25d9 58#define xav_alloc xiv_u.xivu_p1
e4305a63 59/* SV* xav_arylen; */
61b858cf 60
8c18259e 61/* SVpav_REAL is set for all AVs whose xav_array contents are refcounted.
61b858cf
GS
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 *
8c18259e 66 * SVpav_REIFY is only meaningful on such "fake" AVs (i.e. where SVpav_REAL
61b858cf
GS
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 *
3ddcf04c
GS
71 * Note that the Perl stack and @DB::args have neither flag set. (Thus,
72 * items that go on the stack are never refcounted.)
61b858cf
GS
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 */
79072805 78
954c1994 79/*
ccfc67b7
JH
80=head1 Handy Values
81
954c1994
GS
82=for apidoc AmU||Nullav
83Null AV pointer.
84
ccfc67b7
JH
85=head1 Array Manipulation Functions
86
954c1994
GS
87=for apidoc Am|int|AvFILL|AV* av
88Same as C<av_len()>. Deprecated, use C<av_len()> instead.
89
90=cut
91*/
92
79072805
LW
93#define Nullav Null(AV*)
94
339049b0 95#define AvARRAY(av) ((av)->sv_u.svu_array)
e4305a63 96#define AvALLOC(av) (*((SV***)&((XPVAV*) SvANY(av))->xav_alloc))
79072805 97#define AvMAX(av) ((XPVAV*) SvANY(av))->xav_max
93965878 98#define AvFILLp(av) ((XPVAV*) SvANY(av))->xav_fill
a3874608 99#define AvARYLEN(av) (*Perl_av_arylen_p(aTHX_ (AV*)av))
79072805 100
11ca45c0
NC
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)
a0d0e21e 109
11ca45c0 110#define AvREALISH(av) (SvFLAGS(av) & (SVpav_REAL|SVpav_REIFY))
93965878
NIS
111
112#define AvFILL(av) ((SvRMAGICAL((SV *) (av))) \
a60c0954 113 ? mg_size((SV *) av) : AvFILLp(av))
a0d0e21e 114
6f12eb6d 115#define NEGATIVE_INDICES_VAR "NEGATIVE_INDICES"
102d3b8a
NC
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 */