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