perl5.git.perl.org Git - perl5.git/blame_incremental

... / ...

Commit	Line	Data
	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_top_index()>. Deprecated, use C<av_top_index()> instead.
	51
	52	=for apidoc Am\|int\|av_tindex\|AV* av
	53	Same as C<av_top_index()>.
	54
	55	=cut
	56	*/
	57
	58	#ifndef PERL_CORE
	59	# define Nullav Null(AV*)
	60	#endif
	61
	62	#define AvARRAY(av) ((av)->sv_u.svu_array)
	63	#define AvALLOC(av) ((XPVAV*) SvANY(av))->xav_alloc
	64	#define AvMAX(av) ((XPVAV*) SvANY(av))->xav_max
	65	#define AvFILLp(av) ((XPVAV*) SvANY(av))->xav_fill
	66	#define AvARYLEN(av) (*Perl_av_arylen_p(aTHX_ MUTABLE_AV(av)))
	67
	68	#define AvREAL(av) (SvFLAGS(av) & SVpav_REAL)
	69	#define AvREAL_on(av) (SvFLAGS(av) \|= SVpav_REAL)
	70	#define AvREAL_off(av) (SvFLAGS(av) &= ~SVpav_REAL)
	71	#define AvREAL_only(av) (AvREIFY_off(av), SvFLAGS(av) \|= SVpav_REAL)
	72	#define AvREIFY(av) (SvFLAGS(av) & SVpav_REIFY)
	73	#define AvREIFY_on(av) (SvFLAGS(av) \|= SVpav_REIFY)
	74	#define AvREIFY_off(av) (SvFLAGS(av) &= ~SVpav_REIFY)
	75	#define AvREIFY_only(av) (AvREAL_off(av), SvFLAGS(av) \|= SVpav_REIFY)
	76
	77
	78	#define AvREALISH(av) (SvFLAGS(av) & (SVpav_REAL\|SVpav_REIFY))
	79
	80	#define AvFILL(av) ((SvRMAGICAL((const SV *) (av))) \
	81	? mg_size(MUTABLE_SV(av)) : AvFILLp(av))
	82	#define av_tindex(av) av_top_index(av)
	83
	84	#if defined(PERL_IN_REGCOMP_C) \|\| defined(PERL_IN_REGEXEC_C) \|\| defined(PERL_IN_UTF8_C)
	85	/* Note that it doesn't make sense to do this:
	86	* SvGETMAGIC(av); IV x = av_tindex_nomg(av);
	87	* This name is controversial, and so is restricted by the #ifdef to the places
	88	* it already occurs
	89	*/
	90	# define av_tindex_nomg(av) (__ASSERT_(SvTYPE(av) == SVt_PVAV) AvFILLp(av))
	91	#endif
	92
	93	#define NEGATIVE_INDICES_VAR "NEGATIVE_INDICES"
	94
	95	/*
	96	=for apidoc newAV
	97
	98	Creates a new AV. The reference count is set to 1.
	99
	100	Perl equivalent: C<my @array;>.
	101
	102	=cut
	103	*/
	104
	105	#define newAV() MUTABLE_AV(newSV_type(SVt_PVAV))
	106
	107	/*
	108	* ex: set ts=8 sts=4 sw=4 et:
	109	*/