Commit | Line | Data |
---|---|---|
a0d0e21e | 1 | /* av.h |
79072805 | 2 | * |
e6906430 JH |
3 | * Copyright (C) 1991, 1992, 1993, 1995, 1996, 1997, 1998, 1999, |
4 | * 2000, 2001, 2002, 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 { | |
ff0cee69 | 12 | char* xav_array; /* pointer to first array element */ |
93965878 | 13 | SSize_t xav_fill; /* Index of last element present */ |
d18c6117 | 14 | SSize_t xav_max; /* max index for which array has space */ |
a0d0e21e | 15 | IV xof_off; /* ptr is incremented by offset */ |
65202027 | 16 | NV xnv_nv; /* numeric value, if any */ |
79072805 LW |
17 | MAGIC* xmg_magic; /* magic for scalar array */ |
18 | HV* xmg_stash; /* class package */ | |
19 | ||
2fc34c7b | 20 | SV** xav_alloc; /* pointer to beginning of C array of SVs */ |
79072805 | 21 | SV* xav_arylen; |
79072805 LW |
22 | U8 xav_flags; |
23 | }; | |
24 | ||
6513d6ca NC |
25 | typedef struct xpvav xpvav_allocated; |
26 | ||
61b858cf GS |
27 | |
28 | /* AVf_REAL is set for all AVs whose xav_array contents are refcounted. | |
29 | * Some things like "@_" and the scratchpad list do not set this, to | |
30 | * indicate that they are cheating (for efficiency) by not refcounting | |
31 | * the AV's contents. | |
32 | * | |
33 | * AVf_REIFY is only meaningful on such "fake" AVs (i.e. where AVf_REAL | |
34 | * is not set). It indicates that the fake AV is capable of becoming | |
35 | * real if the array needs to be modified in some way. Functions that | |
36 | * modify fake AVs check both flags to call av_reify() as appropriate. | |
37 | * | |
3ddcf04c GS |
38 | * Note that the Perl stack and @DB::args have neither flag set. (Thus, |
39 | * items that go on the stack are never refcounted.) | |
61b858cf GS |
40 | * |
41 | * These internal details are subject to change any time. AV | |
42 | * manipulations external to perl should not care about any of this. | |
43 | * GSAR 1999-09-10 | |
44 | */ | |
79072805 | 45 | #define AVf_REAL 1 /* free old entries */ |
a0d0e21e | 46 | #define AVf_REIFY 2 /* can become real */ |
61b858cf GS |
47 | |
48 | /* XXX this is not used anywhere */ | |
4633a7c4 | 49 | #define AVf_REUSED 4 /* got undeffed--don't turn old memory into SVs now */ |
79072805 | 50 | |
954c1994 | 51 | /* |
ccfc67b7 JH |
52 | =head1 Handy Values |
53 | ||
954c1994 GS |
54 | =for apidoc AmU||Nullav |
55 | Null AV pointer. | |
56 | ||
ccfc67b7 JH |
57 | =head1 Array Manipulation Functions |
58 | ||
954c1994 GS |
59 | =for apidoc Am|int|AvFILL|AV* av |
60 | Same as C<av_len()>. Deprecated, use C<av_len()> instead. | |
61 | ||
62 | =cut | |
63 | */ | |
64 | ||
79072805 LW |
65 | #define Nullav Null(AV*) |
66 | ||
463ee0b2 | 67 | #define AvARRAY(av) ((SV**)((XPVAV*) SvANY(av))->xav_array) |
79072805 LW |
68 | #define AvALLOC(av) ((XPVAV*) SvANY(av))->xav_alloc |
69 | #define AvMAX(av) ((XPVAV*) SvANY(av))->xav_max | |
93965878 | 70 | #define AvFILLp(av) ((XPVAV*) SvANY(av))->xav_fill |
79072805 LW |
71 | #define AvARYLEN(av) ((XPVAV*) SvANY(av))->xav_arylen |
72 | #define AvFLAGS(av) ((XPVAV*) SvANY(av))->xav_flags | |
73 | ||
a0d0e21e LW |
74 | #define AvREAL(av) (AvFLAGS(av) & AVf_REAL) |
75 | #define AvREAL_on(av) (AvFLAGS(av) |= AVf_REAL) | |
76 | #define AvREAL_off(av) (AvFLAGS(av) &= ~AVf_REAL) | |
77 | #define AvREIFY(av) (AvFLAGS(av) & AVf_REIFY) | |
78 | #define AvREIFY_on(av) (AvFLAGS(av) |= AVf_REIFY) | |
79 | #define AvREIFY_off(av) (AvFLAGS(av) &= ~AVf_REIFY) | |
4633a7c4 LW |
80 | #define AvREUSED(av) (AvFLAGS(av) & AVf_REUSED) |
81 | #define AvREUSED_on(av) (AvFLAGS(av) |= AVf_REUSED) | |
82 | #define AvREUSED_off(av) (AvFLAGS(av) &= ~AVf_REUSED) | |
a0d0e21e | 83 | |
0a5de7f0 | 84 | #define AvREALISH(av) (AvFLAGS(av) & (AVf_REAL|AVf_REIFY)) |
93965878 NIS |
85 | |
86 | #define AvFILL(av) ((SvRMAGICAL((SV *) (av))) \ | |
a60c0954 | 87 | ? mg_size((SV *) av) : AvFILLp(av)) |
a0d0e21e | 88 | |
5b7ea690 | 89 | #define NEGATIVE_INDICES_VAR "NEGATIVE_INDICES" |