| | 1 | /* av.h |
| | 2 | * |
| | 3 | * Copyright (C) 1991, 1992, 1993, 1995, 1996, 1997, 1998, 1999, 2000, |
| | 4 | * 2001, 2002, 2005, 2006, 2007, 2008, by Larry Wall and others |
| | 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 | * |
| | 9 | */ |
| | 10 | |
| | 11 | struct xpvav { |
| | 12 | HV* xmg_stash; /* class package */ |
| | 13 | union _xmgu xmg_u; |
| | 14 | SSize_t xav_fill; /* Index of last element present */ |
| | 15 | SSize_t xav_max; /* max index for which array has space */ |
| | 16 | SV** xav_alloc; /* pointer to beginning of C array of SVs */ |
| | 17 | }; |
| | 18 | |
| | 19 | /* SV* xav_arylen; */ |
| | 20 | |
| | 21 | /* SVpav_REAL is set for all AVs whose xav_array contents are refcounted. |
| | 22 | * Some things like "@_" and the scratchpad list do not set this, to |
| | 23 | * indicate that they are cheating (for efficiency) by not refcounting |
| | 24 | * the AV's contents. |
| | 25 | * |
| | 26 | * SVpav_REIFY is only meaningful on such "fake" AVs (i.e. where SVpav_REAL |
| | 27 | * is not set). It indicates that the fake AV is capable of becoming |
| | 28 | * real if the array needs to be modified in some way. Functions that |
| | 29 | * modify fake AVs check both flags to call av_reify() as appropriate. |
| | 30 | * |
| | 31 | * Note that the Perl stack has neither flag set. (Thus, |
| | 32 | * items that go on the stack are never refcounted.) |
| | 33 | * |
| | 34 | * These internal details are subject to change any time. AV |
| | 35 | * manipulations external to perl should not care about any of this. |
| | 36 | * GSAR 1999-09-10 |
| | 37 | */ |
| | 38 | |
| | 39 | /* |
| | 40 | =head1 Handy Values |
| | 41 | |
| | 42 | =for apidoc AmU||Nullav |
| | 43 | Null AV pointer. |
| | 44 | |
| | 45 | (deprecated - use C<(AV *)NULL> instead) |
| | 46 | |
| | 47 | =head1 Array Manipulation Functions |
| | 48 | |
| | 49 | =for apidoc Am|int|AvFILL|AV* av |
| | 50 | Same as C<av_len()>. Deprecated, use C<av_len()> instead. |
| | 51 | |
| | 52 | =cut |
| | 53 | */ |
| | 54 | |
| | 55 | #ifndef PERL_CORE |
| | 56 | # define Nullav Null(AV*) |
| | 57 | #endif |
| | 58 | |
| | 59 | #define AvARRAY(av) ((av)->sv_u.svu_array) |
| | 60 | #define AvALLOC(av) ((XPVAV*) SvANY(av))->xav_alloc |
| | 61 | #define AvMAX(av) ((XPVAV*) SvANY(av))->xav_max |
| | 62 | #define AvFILLp(av) ((XPVAV*) SvANY(av))->xav_fill |
| | 63 | #define AvARYLEN(av) (*Perl_av_arylen_p(aTHX_ MUTABLE_AV(av))) |
| | 64 | |
| | 65 | #define AvREAL(av) (SvFLAGS(av) & SVpav_REAL) |
| | 66 | #define AvREAL_on(av) (SvFLAGS(av) |= SVpav_REAL) |
| | 67 | #define AvREAL_off(av) (SvFLAGS(av) &= ~SVpav_REAL) |
| | 68 | #define AvREAL_only(av) (AvREIFY_off(av), SvFLAGS(av) |= SVpav_REAL) |
| | 69 | #define AvREIFY(av) (SvFLAGS(av) & SVpav_REIFY) |
| | 70 | #define AvREIFY_on(av) (SvFLAGS(av) |= SVpav_REIFY) |
| | 71 | #define AvREIFY_off(av) (SvFLAGS(av) &= ~SVpav_REIFY) |
| | 72 | #define AvREIFY_only(av) (AvREAL_off(av), SvFLAGS(av) |= SVpav_REIFY) |
| | 73 | |
| | 74 | #define AvREALISH(av) (SvFLAGS(av) & (SVpav_REAL|SVpav_REIFY)) |
| | 75 | |
| | 76 | #define AvFILL(av) ((SvRMAGICAL((const SV *) (av))) \ |
| | 77 | ? mg_size(MUTABLE_SV(av)) : AvFILLp(av)) |
| | 78 | |
| | 79 | #define NEGATIVE_INDICES_VAR "NEGATIVE_INDICES" |
| | 80 | |
| | 81 | /* |
| | 82 | =for apidoc newAV |
| | 83 | |
| | 84 | Creates a new AV. The reference count is set to 1. |
| | 85 | |
| | 86 | Perl equivalent: C<my @array;>. |
| | 87 | |
| | 88 | =cut |
| | 89 | */ |
| | 90 | |
| | 91 | #define newAV() MUTABLE_AV(newSV_type(SVt_PVAV)) |
| | 92 | |
| | 93 | /* |
| | 94 | * Local variables: |
| | 95 | * c-indentation-style: bsd |
| | 96 | * c-basic-offset: 4 |
| | 97 | * indent-tabs-mode: t |
| | 98 | * End: |
| | 99 | * |
| | 100 | * ex: set ts=8 sts=4 sw=4 noet: |
| | 101 | */ |
https://perl5.git.perl.org / perl5.git / blame_incremental