X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=av.h;h=77df033dc7e89fd4723d3aedb38af5a85708d790;hb=47a7661deb880b9c5c3ea4517c4908096fdff41f;hp=42f5c8558778509d4f588641dbe1d0ef6f9987af;hpb=463ee0b2acbd047c27e8b5393cdd8398881824c5;p=p5sagit%2Fp5-mst-13.2.git diff --git a/av.h b/av.h index 42f5c85..77df033 100644 --- a/av.h +++ b/av.h @@ -1,50 +1,114 @@ -/* $RCSfile: array.h,v $$Revision: 4.1 $$Date: 92/08/07 17:18:24 $ +/* av.h * - * Copyright (c) 1991, Larry Wall + * Copyright (C) 1991, 1992, 1993, 1995, 1996, 1997, 1998, 1999, 2000, + * 2001, 2002, 2005, 2006, 2007, 2008, 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. * - * $Log: array.h,v $ - * Revision 4.1 92/08/07 17:18:24 lwall - * Stage 6 Snapshot - * - * Revision 4.0.1.2 92/06/08 11:45:57 lwall - * patch20: removed implicit int declarations on funcions - * - * Revision 4.0.1.1 91/06/07 10:19:20 lwall - * patch4: new copyright notice - * - * Revision 4.0 91/03/20 01:03:44 lwall - * 4.0 baseline. - * */ +#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 malloced string */ - int xav_fill; - int xav_max; - int 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; - SV* xav_arylen; - U8 xav_flags; + _XPVAV_HEAD; + _XPVMG_HEAD; }; -#define AVf_REAL 1 /* free old entries */ +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 -#define Nullav Null(AV*) +=for apidoc AmU||Nullav +Null AV pointer. -#define AvARRAY(av) ((SV**)((XPVAV*) SvANY(av))->xav_array) -#define AvALLOC(av) ((XPVAV*) SvANY(av))->xav_alloc +(deprecated - use C<(AV *)NULL> instead) + +=head1 Array Manipulation Functions + +=for apidoc Am|int|AvFILL|AV* av +Same as C. Deprecated, use C instead. + +=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 AvFILL(av) ((XPVAV*) SvANY(av))->xav_fill -#define AvARYLEN(av) ((XPVAV*) SvANY(av))->xav_arylen -#define AvFLAGS(av) ((XPVAV*) SvANY(av))->xav_flags +#define AvFILLp(av) ((XPVAV*) SvANY(av))->xav_fill +#define AvARYLEN(av) (*Perl_av_arylen_p(aTHX_ MUTABLE_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((const SV *) (av))) \ + ? mg_size(MUTABLE_SV(av)) : AvFILLp(av)) -#define AvREAL(av) (((XPVAV*) SvANY(av))->xav_flags & AVf_REAL) -#define AvREAL_on(av) (((XPVAV*) SvANY(av))->xav_flags |= AVf_REAL) -#define AvREAL_off(av) (((XPVAV*) SvANY(av))->xav_flags &= ~AVf_REAL) +#define NEGATIVE_INDICES_VAR "NEGATIVE_INDICES" + +/* +=for apidoc newAV + +Creates a new AV. The reference count is set to 1. + +=cut +*/ + +#define newAV() MUTABLE_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: + */