-/* $RCSfile: array.h,v $$Revision: 4.1 $$Date: 92/08/07 17:18:24 $
+/* av.h
*
- * Copyright (c) 1991, Larry Wall
+ * Copyright (c) 1991-1999, Larry Wall
*
* 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 */
+ char* xav_array; /* pointer to first array element */
+ SSize_t xav_fill; /* Index of last element present */
+ SSize_t xav_max; /* max index for which array has space */
+ IV xof_off; /* ptr is incremented by offset */
+ NV xnv_nv; /* numeric value, if any */
MAGIC* xmg_magic; /* magic for scalar array */
HV* xmg_stash; /* class package */
- MAGIC* xav_magic; /* magic for elements */
-
- SV** xav_array;
- SV** xav_alloc;
+ SV** xav_alloc; /* pointer to malloced string */
SV* xav_arylen;
- I32 xav_max;
- I32 xav_fill;
U8 xav_flags;
};
+
+/* AVf_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.
+ *
+ * AVf_REIFY is only meaningful on such "fake" AVs (i.e. where AVf_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
+ */
#define AVf_REAL 1 /* free old entries */
+#define AVf_REIFY 2 /* can become real */
+
+/* XXX this is not used anywhere */
+#define AVf_REUSED 4 /* got undeffed--don't turn old memory into SVs now */
#define Nullav Null(AV*)
-#define AvMAGIC(av) ((XPVAV*) SvANY(av))->xav_magic
-#define AvARRAY(av) ((XPVAV*) SvANY(av))->xav_array
+#define AvARRAY(av) ((SV**)((XPVAV*) SvANY(av))->xav_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 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) (((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 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 AvFILL(av) ((SvRMAGICAL((SV *) (av))) \
+ ? mg_size((SV *) av) : AvFILLp(av))
+