Commit | Line | Data |
---|---|---|
a0d0e21e | 1 | /* av.h |
79072805 | 2 | * |
1129b882 NC |
3 | * Copyright (C) 1991, 1992, 1993, 1995, 1996, 1997, 1998, 1999, 2000, |
4 | * 2001, 2002, 2005, 2006, 2007, 2008, 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 | ||
20f4945e MHM |
11 | #define _XPVAV_ALLOCATED_HEAD \ |
12 | SSize_t xav_fill; /* Index of last element present */ \ | |
13 | SSize_t xav_max /* max index for which array has space */ | |
14 | ||
15 | #define _XPVAV_HEAD \ | |
16 | union _xnvu xnv_u; \ | |
17 | _XPVAV_ALLOCATED_HEAD | |
18 | ||
79072805 | 19 | struct xpvav { |
20f4945e MHM |
20 | _XPVAV_HEAD; |
21 | _XPVMG_HEAD; | |
79072805 LW |
22 | }; |
23 | ||
9f1501b2 | 24 | typedef struct { |
20f4945e MHM |
25 | _XPVAV_ALLOCATED_HEAD; |
26 | _XPVMG_HEAD; | |
9f1501b2 | 27 | } xpvav_allocated; |
59813432 | 28 | |
20f4945e MHM |
29 | #undef _XPVAV_ALLOCATED_HEAD |
30 | #undef _XPVAV_HEAD | |
31 | ||
e4305a63 | 32 | /* SV** xav_alloc; */ |
311a25d9 | 33 | #define xav_alloc xiv_u.xivu_p1 |
e4305a63 | 34 | /* SV* xav_arylen; */ |
61b858cf | 35 | |
8c18259e | 36 | /* SVpav_REAL is set for all AVs whose xav_array contents are refcounted. |
61b858cf GS |
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 | * | |
8c18259e | 41 | * SVpav_REIFY is only meaningful on such "fake" AVs (i.e. where SVpav_REAL |
61b858cf GS |
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 GS |
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 GS |
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 JH |
55 | =head1 Handy Values |
56 | ||
954c1994 GS |
57 | =for apidoc AmU||Nullav |
58 | Null AV pointer. | |
59 | ||
3ae1b226 NC |
60 | (deprecated - use C<(AV *)NULL> instead) |
61 | ||
ccfc67b7 JH |
62 | =head1 Array Manipulation Functions |
63 | ||
954c1994 GS |
64 | =for apidoc Am|int|AvFILL|AV* av |
65 | Same as C<av_len()>. Deprecated, use C<av_len()> instead. | |
66 | ||
67 | =cut | |
68 | */ | |
69 | ||
3ae1b226 NC |
70 | #ifndef PERL_CORE |
71 | # define Nullav Null(AV*) | |
72 | #endif | |
79072805 | 73 | |
339049b0 | 74 | #define AvARRAY(av) ((av)->sv_u.svu_array) |
e4305a63 | 75 | #define AvALLOC(av) (*((SV***)&((XPVAV*) SvANY(av))->xav_alloc)) |
79072805 | 76 | #define AvMAX(av) ((XPVAV*) SvANY(av))->xav_max |
93965878 | 77 | #define AvFILLp(av) ((XPVAV*) SvANY(av))->xav_fill |
a062e10d | 78 | #define AvARYLEN(av) (*Perl_av_arylen_p(aTHX_ MUTABLE_AV(av))) |
79072805 | 79 | |
11ca45c0 NC |
80 | #define AvREAL(av) (SvFLAGS(av) & SVpav_REAL) |
81 | #define AvREAL_on(av) (SvFLAGS(av) |= SVpav_REAL) | |
82 | #define AvREAL_off(av) (SvFLAGS(av) &= ~SVpav_REAL) | |
83 | #define AvREAL_only(av) (AvREIFY_off(av), SvFLAGS(av) |= SVpav_REAL) | |
84 | #define AvREIFY(av) (SvFLAGS(av) & SVpav_REIFY) | |
85 | #define AvREIFY_on(av) (SvFLAGS(av) |= SVpav_REIFY) | |
86 | #define AvREIFY_off(av) (SvFLAGS(av) &= ~SVpav_REIFY) | |
87 | #define AvREIFY_only(av) (AvREAL_off(av), SvFLAGS(av) |= SVpav_REIFY) | |
a0d0e21e | 88 | |
11ca45c0 | 89 | #define AvREALISH(av) (SvFLAGS(av) & (SVpav_REAL|SVpav_REIFY)) |
93965878 | 90 | |
b1bc3f34 NC |
91 | #define AvFILL(av) ((SvRMAGICAL((const SV *) (av))) \ |
92 | ? mg_size(MUTABLE_SV(av)) : AvFILLp(av)) | |
a0d0e21e | 93 | |
6f12eb6d | 94 | #define NEGATIVE_INDICES_VAR "NEGATIVE_INDICES" |
102d3b8a NC |
95 | |
96 | /* | |
ac572bf4 NC |
97 | =for apidoc newAV |
98 | ||
99 | Creates a new AV. The reference count is set to 1. | |
100 | ||
101 | =cut | |
102 | */ | |
103 | ||
a062e10d | 104 | #define newAV() MUTABLE_AV(newSV_type(SVt_PVAV)) |
ac572bf4 NC |
105 | |
106 | /* | |
102d3b8a NC |
107 | * Local variables: |
108 | * c-indentation-style: bsd | |
109 | * c-basic-offset: 4 | |
110 | * indent-tabs-mode: t | |
111 | * End: | |
112 | * | |
113 | * ex: set ts=8 sts=4 sw=4 noet: | |
114 | */ |