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