This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
allow 'text' in L<text|A::B/"C"> (from Martin Lichtin
[perl5.git] / av.h
CommitLineData
a0d0e21e 1/* av.h
79072805 2 *
4eb8286e 3 * Copyright (c) 1991-1999, Larry Wall
79072805
LW
4 *
5 * You may distribute under the terms of either the GNU General Public
6 * License or the Artistic License, as specified in the README file.
7 *
79072805
LW
8 */
9
10struct xpvav {
ff0cee69 11 char* xav_array; /* pointer to first array element */
93965878
NIS
12 SSize_t xav_fill; /* Index of last element present */
13 SSize_t xav_max; /* Number of elements for which array has space */
a0d0e21e 14 IV xof_off; /* ptr is incremented by offset */
65202027 15 NV xnv_nv; /* numeric value, if any */
79072805
LW
16 MAGIC* xmg_magic; /* magic for scalar array */
17 HV* xmg_stash; /* class package */
18
ff0cee69 19 SV** xav_alloc; /* pointer to malloced string */
79072805 20 SV* xav_arylen;
79072805
LW
21 U8 xav_flags;
22};
23
24#define AVf_REAL 1 /* free old entries */
a0d0e21e 25#define AVf_REIFY 2 /* can become real */
4633a7c4 26#define AVf_REUSED 4 /* got undeffed--don't turn old memory into SVs now */
79072805
LW
27
28#define Nullav Null(AV*)
29
463ee0b2 30#define AvARRAY(av) ((SV**)((XPVAV*) SvANY(av))->xav_array)
79072805
LW
31#define AvALLOC(av) ((XPVAV*) SvANY(av))->xav_alloc
32#define AvMAX(av) ((XPVAV*) SvANY(av))->xav_max
93965878 33#define AvFILLp(av) ((XPVAV*) SvANY(av))->xav_fill
79072805
LW
34#define AvARYLEN(av) ((XPVAV*) SvANY(av))->xav_arylen
35#define AvFLAGS(av) ((XPVAV*) SvANY(av))->xav_flags
36
a0d0e21e
LW
37#define AvREAL(av) (AvFLAGS(av) & AVf_REAL)
38#define AvREAL_on(av) (AvFLAGS(av) |= AVf_REAL)
39#define AvREAL_off(av) (AvFLAGS(av) &= ~AVf_REAL)
40#define AvREIFY(av) (AvFLAGS(av) & AVf_REIFY)
41#define AvREIFY_on(av) (AvFLAGS(av) |= AVf_REIFY)
42#define AvREIFY_off(av) (AvFLAGS(av) &= ~AVf_REIFY)
4633a7c4
LW
43#define AvREUSED(av) (AvFLAGS(av) & AVf_REUSED)
44#define AvREUSED_on(av) (AvFLAGS(av) |= AVf_REUSED)
45#define AvREUSED_off(av) (AvFLAGS(av) &= ~AVf_REUSED)
a0d0e21e 46
0a5de7f0 47#define AvREALISH(av) (AvFLAGS(av) & (AVf_REAL|AVf_REIFY))
93965878
NIS
48
49#define AvFILL(av) ((SvRMAGICAL((SV *) (av))) \
a60c0954 50 ? mg_size((SV *) av) : AvFILLp(av))
a0d0e21e 51