X-Git-Url: https://perl5.git.perl.org/perl5.git/blobdiff_plain/79072805bf63abe5b5978b5928ab00d360ea3e7f..b256460cd383b29766d66530f181b61c40a4eccb:/av.h

diff --git a/av.h b/av.h
index 40f2eb2..8d18d25 100644
--- a/av.h
+++ b/av.h
@@ -1,56 +1,101 @@
-/* $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.
- * 
  */
 
 struct xpvav {
-    char *	xpv_pv;		/* pointer to malloced string */
-    STRLEN	xpv_cur;	/* length of xp_pv as a C string */
-    STRLEN	xpv_len;	/* allocated size */
-    STRLEN	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 */
+    union _xmgu	xmg_u;
+    SSize_t	xav_fill;       /* Index of last element present */
+    SSize_t	xav_max;        /* max index for which array has space */
+    SV**	xav_alloc;	/* pointer to beginning of C array of SVs */
+};
 
-    MAGIC*      xav_magic;	/* magic for elements */
+/* SV*	xav_arylen; */
 
-    SV**	xav_array;
-    SV**	xav_alloc;
-    SV*		xav_arylen;
-    I32		xav_max;
-    I32		xav_fill;
-    U8		xav_flags;
-};
+/* 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 has 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)
 
-#define AVf_REAL 1	/* free old entries */
+=head1 Array Manipulation Functions
 
-#define Nullav Null(AV*)
+=for apidoc Am|int|AvFILL|AV* av
+Same as C<av_len()>.  Deprecated, use C<av_len()> instead.
 
-#define AvMAGIC(av)	((XPVAV*)  SvANY(av))->xav_magic
-#define AvARRAY(av)	((XPVAV*)  SvANY(av))->xav_array
+=cut
+*/
+
+#ifndef PERL_CORE
+#  define Nullav Null(AV*)
+#endif
+
+#define AvARRAY(av)	((av)->sv_u.svu_array)
 #define AvALLOC(av)	((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 NEGATIVE_INDICES_VAR "NEGATIVE_INDICES"
+
+/*
+=for apidoc newAV
 
-#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)
+Creates a new AV.  The reference count is set to 1.
+
+Perl equivalent: C<my @array;>.
+
+=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:
+ */