3 * Copyright (C) 1991, 1992, 1993, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, by Larry Wall and others
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.
12 char* xav_array; /* pointer to first array element */
13 SSize_t xav_fill; /* Index of last element present */
14 SSize_t xav_max; /* max index for which array has space */
15 IV xof_off; /* ptr is incremented by offset */
16 NV xnv_nv; /* numeric value, if any */
17 MAGIC* xmg_magic; /* magic for scalar array */
18 HV* xmg_stash; /* class package */
20 SV** xav_alloc; /* pointer to beginning of C array of SVs */
25 typedef struct xpvav xpvav_allocated;
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
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.
38 * Note that the Perl stack and @DB::args have neither flag set. (Thus,
39 * items that go on the stack are never refcounted.)
41 * These internal details are subject to change any time. AV
42 * manipulations external to perl should not care about any of this.
45 #define AVf_REAL 1 /* free old entries */
46 #define AVf_REIFY 2 /* can become real */
48 /* XXX this is not used anywhere */
49 #define AVf_REUSED 4 /* got undeffed--don't turn old memory into SVs now */
54 =for apidoc AmU||Nullav
57 =head1 Array Manipulation Functions
59 =for apidoc Am|int|AvFILL|AV* av
60 Same as C<av_len()>. Deprecated, use C<av_len()> instead.
65 #define Nullav Null(AV*)
67 #define AvARRAY(av) ((SV**)((XPVAV*) SvANY(av))->xav_array)
68 #define AvALLOC(av) ((XPVAV*) SvANY(av))->xav_alloc
69 #define AvMAX(av) ((XPVAV*) SvANY(av))->xav_max
70 #define AvFILLp(av) ((XPVAV*) SvANY(av))->xav_fill
71 #define AvARYLEN(av) ((XPVAV*) SvANY(av))->xav_arylen
72 #define AvFLAGS(av) ((XPVAV*) SvANY(av))->xav_flags
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)
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)
84 #define AvREALISH(av) (AvFLAGS(av) & (AVf_REAL|AVf_REIFY))
86 #define AvFILL(av) ((SvRMAGICAL((SV *) (av))) \
87 ? mg_size((SV *) av) : AvFILLp(av))
89 #define NEGATIVE_INDICES_VAR "NEGATIVE_INDICES"