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 | ||
11 | struct xpvav { | |
6e128786 NC |
12 | HV* xmg_stash; /* class package */ |
13 | union _xmgu xmg_u; | |
c8e503bf NC |
14 | SSize_t xav_fill; /* Index of last element present */ |
15 | SSize_t xav_max; /* max index for which array has space */ | |
4f7003f5 | 16 | SV** xav_alloc; /* pointer to beginning of C array of SVs */ |
79072805 LW |
17 | }; |
18 | ||
e4305a63 | 19 | /* SV* xav_arylen; */ |
61b858cf | 20 | |
8c18259e | 21 | /* SVpav_REAL is set for all AVs whose xav_array contents are refcounted. |
61b858cf GS |
22 | * Some things like "@_" and the scratchpad list do not set this, to |
23 | * indicate that they are cheating (for efficiency) by not refcounting | |
24 | * the AV's contents. | |
25 | * | |
8c18259e | 26 | * SVpav_REIFY is only meaningful on such "fake" AVs (i.e. where SVpav_REAL |
61b858cf GS |
27 | * is not set). It indicates that the fake AV is capable of becoming |
28 | * real if the array needs to be modified in some way. Functions that | |
29 | * modify fake AVs check both flags to call av_reify() as appropriate. | |
30 | * | |
af80dd86 | 31 | * Note that the Perl stack has neither flag set. (Thus, |
3ddcf04c | 32 | * items that go on the stack are never refcounted.) |
61b858cf GS |
33 | * |
34 | * These internal details are subject to change any time. AV | |
35 | * manipulations external to perl should not care about any of this. | |
36 | * GSAR 1999-09-10 | |
37 | */ | |
79072805 | 38 | |
954c1994 | 39 | /* |
ccfc67b7 JH |
40 | =head1 Handy Values |
41 | ||
78342678 | 42 | =for apidoc ADmnU||Nullav |
954c1994 GS |
43 | Null AV pointer. |
44 | ||
3ae1b226 NC |
45 | (deprecated - use C<(AV *)NULL> instead) |
46 | ||
ccfc67b7 JH |
47 | =head1 Array Manipulation Functions |
48 | ||
954c1994 | 49 | =for apidoc Am|int|AvFILL|AV* av |
d29fa84a | 50 | Same as C<av_top_index()> or C<av_tindex()>. |
954c1994 | 51 | |
44170c9a | 52 | =for apidoc av_tindex |
12719193 KW |
53 | Same as C<av_top_index()>. |
54 | ||
bb7379d7 KW |
55 | =for apidoc m|int|AvFILLp|AV* av |
56 | ||
954c1994 GS |
57 | =cut |
58 | */ | |
59 | ||
3ae1b226 NC |
60 | #ifndef PERL_CORE |
61 | # define Nullav Null(AV*) | |
62 | #endif | |
79072805 | 63 | |
339049b0 | 64 | #define AvARRAY(av) ((av)->sv_u.svu_array) |
4f7003f5 | 65 | #define AvALLOC(av) ((XPVAV*) SvANY(av))->xav_alloc |
79072805 | 66 | #define AvMAX(av) ((XPVAV*) SvANY(av))->xav_max |
93965878 | 67 | #define AvFILLp(av) ((XPVAV*) SvANY(av))->xav_fill |
a062e10d | 68 | #define AvARYLEN(av) (*Perl_av_arylen_p(aTHX_ MUTABLE_AV(av))) |
79072805 | 69 | |
11ca45c0 NC |
70 | #define AvREAL(av) (SvFLAGS(av) & SVpav_REAL) |
71 | #define AvREAL_on(av) (SvFLAGS(av) |= SVpav_REAL) | |
72 | #define AvREAL_off(av) (SvFLAGS(av) &= ~SVpav_REAL) | |
73 | #define AvREAL_only(av) (AvREIFY_off(av), SvFLAGS(av) |= SVpav_REAL) | |
74 | #define AvREIFY(av) (SvFLAGS(av) & SVpav_REIFY) | |
75 | #define AvREIFY_on(av) (SvFLAGS(av) |= SVpav_REIFY) | |
76 | #define AvREIFY_off(av) (SvFLAGS(av) &= ~SVpav_REIFY) | |
77 | #define AvREIFY_only(av) (AvREAL_off(av), SvFLAGS(av) |= SVpav_REIFY) | |
7db6405c | 78 | |
a0d0e21e | 79 | |
11ca45c0 | 80 | #define AvREALISH(av) (SvFLAGS(av) & (SVpav_REAL|SVpav_REIFY)) |
93965878 | 81 | |
b1bc3f34 NC |
82 | #define AvFILL(av) ((SvRMAGICAL((const SV *) (av))) \ |
83 | ? mg_size(MUTABLE_SV(av)) : AvFILLp(av)) | |
12719193 | 84 | #define av_tindex(av) av_top_index(av) |
a0d0e21e | 85 | |
8dbc0cc7 KW |
86 | /* Note that it doesn't make sense to do this: |
87 | * SvGETMAGIC(av); IV x = av_tindex_nomg(av); | |
8dbc0cc7 | 88 | */ |
9506e945 KW |
89 | # define av_top_index_skip_len_mg(av) \ |
90 | (__ASSERT_(SvTYPE(av) == SVt_PVAV) AvFILLp(av)) | |
91 | # define av_tindex_skip_len_mg(av) av_top_index_skip_len_mg(av) | |
6be58040 | 92 | |
6f12eb6d | 93 | #define NEGATIVE_INDICES_VAR "NEGATIVE_INDICES" |
102d3b8a NC |
94 | |
95 | /* | |
ac572bf4 NC |
96 | =for apidoc newAV |
97 | ||
98 | Creates a new AV. The reference count is set to 1. | |
99 | ||
f0b90de1 SF |
100 | Perl equivalent: C<my @array;>. |
101 | ||
ac572bf4 NC |
102 | =cut |
103 | */ | |
104 | ||
a062e10d | 105 | #define newAV() MUTABLE_AV(newSV_type(SVt_PVAV)) |
ac572bf4 NC |
106 | |
107 | /* | |
14d04a33 | 108 | * ex: set ts=8 sts=4 sw=4 et: |
102d3b8a | 109 | */ |