3 * Copyright (C) 1991, 1992, 1993, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2005, 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.
13 SSize_t xav_fill; /* Index of last element present */
14 SSize_t xav_max; /* max index for which array has space */
18 void *xnv_p1; /* pointer to beginning of C array of SVs */
25 MAGIC* xmg_magic; /* magic for scalar array */
26 HV* xmg_stash; /* class package */
29 typedef struct xpvav xpvav_allocated;
32 #define xav_alloc xnv_u.xnv_s.xnv_p1
34 #define xav_arylen xnv_u.xnv_s.xnv_u2.xnv_p2
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
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.
46 * Note that the Perl stack and @DB::args have neither flag set. (Thus,
47 * items that go on the stack are never refcounted.)
49 * These internal details are subject to change any time. AV
50 * manipulations external to perl should not care about any of this.
57 =for apidoc AmU||Nullav
60 =head1 Array Manipulation Functions
62 =for apidoc Am|int|AvFILL|AV* av
63 Same as C<av_len()>. Deprecated, use C<av_len()> instead.
68 #define Nullav Null(AV*)
70 #define AvARRAY(av) ((av)->sv_u.sv_array)
71 #define AvALLOC(av) (*((SV***)&((XPVAV*) SvANY(av))->xav_alloc))
72 #define AvMAX(av) ((XPVAV*) SvANY(av))->xav_max
73 #define AvFILLp(av) ((XPVAV*) SvANY(av))->xav_fill
74 #define AvARYLEN(av) (*((SV**)&((XPVAV*) SvANY(av))->xav_arylen))
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)
85 #define AvREALISH(av) (SvFLAGS(av) & (SVpav_REAL|SVpav_REIFY))
87 #define AvFILL(av) ((SvRMAGICAL((SV *) (av))) \
88 ? mg_size((SV *) av) : AvFILLp(av))
90 #define NEGATIVE_INDICES_VAR "NEGATIVE_INDICES"
94 * c-indentation-style: bsd
99 * ex: set ts=8 sts=4 sw=4 noet: