| Commit | Line | Data |
|---|
| a0d0e21e |
1 | /* av.h |
| 79072805 |
2 | * |
| 4bb101f2 |
3 | * Copyright (C) 1991, 1992, 1993, 1995, 1996, 1997, 1998, 1999, |
| 4 | * 2000, 2001, 2002, by Larry Wall and others |
| 79072805 |
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 |
9 | */ |
| 10 | |
| 11 | struct xpvav { |
| 93965878 |
12 | SSize_t xav_fill; /* Index of last element present */ |
| d18c6117 |
13 | SSize_t xav_max; /* max index 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 |
16 | MAGIC* xmg_magic; /* magic for scalar array */ |
| 17 | HV* xmg_stash; /* class package */ |
| 18 | |
| 2fc34c7b |
19 | SV** xav_alloc; /* pointer to beginning of C array of SVs */ |
| 79072805 |
20 | SV* xav_arylen; |
| 79072805 |
21 | }; |
| 22 | |
| 61b858cf |
23 | |
| 24 | /* AVf_REAL is set for all AVs whose xav_array contents are refcounted. |
| 25 | * Some things like "@_" and the scratchpad list do not set this, to |
| 26 | * indicate that they are cheating (for efficiency) by not refcounting |
| 27 | * the AV's contents. |
| 28 | * |
| 29 | * AVf_REIFY is only meaningful on such "fake" AVs (i.e. where AVf_REAL |
| 30 | * is not set). It indicates that the fake AV is capable of becoming |
| 31 | * real if the array needs to be modified in some way. Functions that |
| 32 | * modify fake AVs check both flags to call av_reify() as appropriate. |
| 33 | * |
| 3ddcf04c |
34 | * Note that the Perl stack and @DB::args have neither flag set. (Thus, |
| 35 | * items that go on the stack are never refcounted.) |
| 61b858cf |
36 | * |
| 37 | * These internal details are subject to change any time. AV |
| 38 | * manipulations external to perl should not care about any of this. |
| 39 | * GSAR 1999-09-10 |
| 40 | */ |
| 79072805 |
41 | |
| 954c1994 |
42 | /* |
| ccfc67b7 |
43 | =head1 Handy Values |
| 44 | |
| 954c1994 |
45 | =for apidoc AmU||Nullav |
| 46 | Null AV pointer. |
| 47 | |
| ccfc67b7 |
48 | =head1 Array Manipulation Functions |
| 49 | |
| 954c1994 |
50 | =for apidoc Am|int|AvFILL|AV* av |
| 51 | Same as C<av_len()>. Deprecated, use C<av_len()> instead. |
| 52 | |
| 53 | =cut |
| 54 | */ |
| 55 | |
| 79072805 |
56 | #define Nullav Null(AV*) |
| 57 | |
| 7b2c381c |
58 | #define AvARRAY(av) ((av)->sv_u.sv_array) |
| 79072805 |
59 | #define AvALLOC(av) ((XPVAV*) SvANY(av))->xav_alloc |
| 60 | #define AvMAX(av) ((XPVAV*) SvANY(av))->xav_max |
| 93965878 |
61 | #define AvFILLp(av) ((XPVAV*) SvANY(av))->xav_fill |
| 79072805 |
62 | #define AvARYLEN(av) ((XPVAV*) SvANY(av))->xav_arylen |
| 79072805 |
63 | |
| 11ca45c0 |
64 | #define AvREAL(av) (SvFLAGS(av) & SVpav_REAL) |
| 65 | #define AvREAL_on(av) (SvFLAGS(av) |= SVpav_REAL) |
| 66 | #define AvREAL_off(av) (SvFLAGS(av) &= ~SVpav_REAL) |
| 67 | #define AvREAL_only(av) (AvREIFY_off(av), SvFLAGS(av) |= SVpav_REAL) |
| 68 | #define AvREIFY(av) (SvFLAGS(av) & SVpav_REIFY) |
| 69 | #define AvREIFY_on(av) (SvFLAGS(av) |= SVpav_REIFY) |
| 70 | #define AvREIFY_off(av) (SvFLAGS(av) &= ~SVpav_REIFY) |
| 71 | #define AvREIFY_only(av) (AvREAL_off(av), SvFLAGS(av) |= SVpav_REIFY) |
| a0d0e21e |
72 | |
| 11ca45c0 |
73 | #define AvREALISH(av) (SvFLAGS(av) & (SVpav_REAL|SVpav_REIFY)) |
| 93965878 |
74 | |
| 75 | #define AvFILL(av) ((SvRMAGICAL((SV *) (av))) \ |
| a60c0954 |
76 | ? mg_size((SV *) av) : AvFILLp(av)) |
| a0d0e21e |
77 | |
| 6f12eb6d |
78 | #define NEGATIVE_INDICES_VAR "NEGATIVE_INDICES" |
projects / p5sagit/p5-mst-13.2.git / blame