X-Git-Url: https://perl5.git.perl.org/perl5.git/blobdiff_plain/a60c0954410db87be540ee8439afcd54350bbb8e..4f58fed66d9db68b8f40235b5d930c67f7aff64e:/av.h diff --git a/av.h b/av.h index 8de81f4..8874045 100644 --- a/av.h +++ b/av.h @@ -1,51 +1,114 @@ /* av.h * - * Copyright (c) 1991-1998, Larry Wall + * Copyright (C) 1991, 1992, 1993, 1995, 1996, 1997, 1998, 1999, + * 2000, 2001, 2002, 2005, 2006, 2007, by Larry Wall and others * * You may distribute under the terms of either the GNU General Public * License or the Artistic License, as specified in the README file. * */ +#define _XPVAV_ALLOCATED_HEAD \ + SSize_t xav_fill; /* Index of last element present */ \ + SSize_t xav_max /* max index for which array has space */ + +#define _XPVAV_HEAD \ + union _xnvu xnv_u; \ + _XPVAV_ALLOCATED_HEAD + struct xpvav { - char* xav_array; /* pointer to first array element */ - SSize_t xav_fill; /* Index of last element present */ - SSize_t xav_max; /* Number of elements for which array has space */ - IV xof_off; /* ptr is incremented by offset */ - double xnv_nv; /* numeric value, if any */ - MAGIC* xmg_magic; /* magic for scalar array */ - HV* xmg_stash; /* class package */ - - SV** xav_alloc; /* pointer to malloced string */ - SV* xav_arylen; - U8 xav_flags; + _XPVAV_HEAD; + _XPVMG_HEAD; }; -#define AVf_REAL 1 /* free old entries */ -#define AVf_REIFY 2 /* can become real */ -#define AVf_REUSED 4 /* got undeffed--don't turn old memory into SVs now */ +typedef struct { + _XPVAV_ALLOCATED_HEAD; + _XPVMG_HEAD; +} xpvav_allocated; + +#undef _XPVAV_ALLOCATED_HEAD +#undef _XPVAV_HEAD + +/* SV** xav_alloc; */ +#define xav_alloc xiv_u.xivu_p1 +/* SV* xav_arylen; */ + +/* SVpav_REAL is set for all AVs whose xav_array contents are refcounted. + * Some things like "@_" and the scratchpad list do not set this, to + * indicate that they are cheating (for efficiency) by not refcounting + * the AV's contents. + * + * SVpav_REIFY is only meaningful on such "fake" AVs (i.e. where SVpav_REAL + * is not set). It indicates that the fake AV is capable of becoming + * real if the array needs to be modified in some way. Functions that + * modify fake AVs check both flags to call av_reify() as appropriate. + * + * Note that the Perl stack and @DB::args have neither flag set. (Thus, + * items that go on the stack are never refcounted.) + * + * These internal details are subject to change any time. AV + * manipulations external to perl should not care about any of this. + * GSAR 1999-09-10 + */ + +/* +=head1 Handy Values + +=for apidoc AmU||Nullav +Null AV pointer. + +(deprecated - use C<(AV *)NULL> instead) + +=head1 Array Manipulation Functions -#define Nullav Null(AV*) +=for apidoc Am|int|AvFILL|AV* av +Same as C. Deprecated, use C instead. -#define AvARRAY(av) ((SV**)((XPVAV*) SvANY(av))->xav_array) -#define AvALLOC(av) ((XPVAV*) SvANY(av))->xav_alloc +=cut +*/ + +#ifndef PERL_CORE +# define Nullav Null(AV*) +#endif + +#define AvARRAY(av) ((av)->sv_u.svu_array) +#define AvALLOC(av) (*((SV***)&((XPVAV*) SvANY(av))->xav_alloc)) #define AvMAX(av) ((XPVAV*) SvANY(av))->xav_max #define AvFILLp(av) ((XPVAV*) SvANY(av))->xav_fill -#define AvARYLEN(av) ((XPVAV*) SvANY(av))->xav_arylen -#define AvFLAGS(av) ((XPVAV*) SvANY(av))->xav_flags - -#define AvREAL(av) (AvFLAGS(av) & AVf_REAL) -#define AvREAL_on(av) (AvFLAGS(av) |= AVf_REAL) -#define AvREAL_off(av) (AvFLAGS(av) &= ~AVf_REAL) -#define AvREIFY(av) (AvFLAGS(av) & AVf_REIFY) -#define AvREIFY_on(av) (AvFLAGS(av) |= AVf_REIFY) -#define AvREIFY_off(av) (AvFLAGS(av) &= ~AVf_REIFY) -#define AvREUSED(av) (AvFLAGS(av) & AVf_REUSED) -#define AvREUSED_on(av) (AvFLAGS(av) |= AVf_REUSED) -#define AvREUSED_off(av) (AvFLAGS(av) &= ~AVf_REUSED) - -#define AvREALISH(av) (AvFLAGS(av) & (AVf_REAL|AVf_REIFY)) +#define AvARYLEN(av) (*Perl_av_arylen_p(aTHX_ (AV*)av)) + +#define AvREAL(av) (SvFLAGS(av) & SVpav_REAL) +#define AvREAL_on(av) (SvFLAGS(av) |= SVpav_REAL) +#define AvREAL_off(av) (SvFLAGS(av) &= ~SVpav_REAL) +#define AvREAL_only(av) (AvREIFY_off(av), SvFLAGS(av) |= SVpav_REAL) +#define AvREIFY(av) (SvFLAGS(av) & SVpav_REIFY) +#define AvREIFY_on(av) (SvFLAGS(av) |= SVpav_REIFY) +#define AvREIFY_off(av) (SvFLAGS(av) &= ~SVpav_REIFY) +#define AvREIFY_only(av) (AvREAL_off(av), SvFLAGS(av) |= SVpav_REIFY) + +#define AvREALISH(av) (SvFLAGS(av) & (SVpav_REAL|SVpav_REIFY)) #define AvFILL(av) ((SvRMAGICAL((SV *) (av))) \ ? mg_size((SV *) av) : AvFILLp(av)) +#define NEGATIVE_INDICES_VAR "NEGATIVE_INDICES" + +/* +=for apidoc newAV + +Creates a new AV. The reference count is set to 1. + +=cut +*/ + +#define newAV() ((AV *)newSV_type(SVt_PVAV)) + +/* + * Local variables: + * c-indentation-style: bsd + * c-basic-offset: 4 + * indent-tabs-mode: t + * End: + * + * ex: set ts=8 sts=4 sw=4 noet: + */