Add MUTABLE_AV(), and remove (AV *) casts from headers.

[perl5.git] / av.h

diff --git a/av.h b/av.h
index a1f0259..77df033 100644 (file)
--- a/av.h
+++ b/av.h
@@ -1,63 +1,44 @@
 /*    av.h
  *
- *    Copyright (C) 1991, 1992, 1993, 1995, 1996, 1997, 1998, 1999,
- *    2000, 2001, 2002, 2005, by Larry Wall and others
+ *    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.
  *
  */
 
+#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 {
-    IV         this_space;
-    SSize_t    xav_fill;       /* Index of last element present */
-    SSize_t    xav_max;        /* max index for which array has space */
-    union {
-       struct {
-           void *xnv_p1;       /* pointer to beginning of C array of SVs */
-           union {
-               void *xnv_p2;
-               IV xnv_i2;
-           }   xnv_u2;
-       }       xnv_s;
-       NV      xnvu_nv;
-    }          xnv_u;
-    MAGIC*     xmg_magic;      /* magic for scalar array */
-    HV*                xmg_stash;      /* class package */
+    _XPVAV_HEAD;
+    _XPVMG_HEAD;
 };
 
-#if 0
-typedef struct xpvav xpvav_allocated;
-#else
 typedef struct {
-    SSize_t    xav_fill;       /* Index of last element present */
-    SSize_t    xav_max;        /* max index for which array has space */
-    union {
-       NV      xnvu_nv;
-       struct {
-           void *xnv_p1;       /* pointer to beginning of C array of SVs */
-           union {
-               void *xnv_p2;
-               IV xnv_i2;
-           }   xnv_u2;
-       }       xnv_s;
-    }          xnv_u;
-    MAGIC*     xmg_magic;      /* magic for scalar array */
-    HV*                xmg_stash;      /* class package */
+    _XPVAV_ALLOCATED_HEAD;
+    _XPVMG_HEAD;
 } xpvav_allocated;
-#endif
+
+#undef _XPVAV_ALLOCATED_HEAD
+#undef _XPVAV_HEAD
 
 /* SV**        xav_alloc; */
-#define xav_alloc xnv_u.xnv_s.xnv_p1
+#define xav_alloc xiv_u.xivu_p1
 /* SV* xav_arylen; */
-#define xav_arylen xnv_u.xnv_s.xnv_u2.xnv_p2
 
-/* AVf_REAL is set for all AVs whose xav_array contents are refcounted.
+/* 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.
  * 
- * AVf_REIFY is only meaningful on such "fake" AVs (i.e. where AVf_REAL
+ * 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.
@@ -76,6 +57,8 @@ typedef struct {
 =for apidoc AmU||Nullav
 Null AV pointer.
 
+(deprecated - use C<(AV *)NULL> instead)
+
 =head1 Array Manipulation Functions
 
 =for apidoc Am|int|AvFILL|AV* av
@@ -84,13 +67,15 @@ Same as C<av_len()>.  Deprecated, use C<av_len()> instead.
 =cut
 */
 
-#define Nullav Null(AV*)
+#ifndef PERL_CORE
+#  define Nullav Null(AV*)
+#endif
 
-#define AvARRAY(av)    ((av)->sv_u.sv_array)
+#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)   (*((SV**)&((XPVAV*)  SvANY(av))->xav_arylen))
+#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)
@@ -103,12 +88,22 @@ Same as C<av_len()>.  Deprecated, use C<av_len()> instead.
 
 #define AvREALISH(av)  (SvFLAGS(av) & (SVpav_REAL|SVpav_REIFY))
                                           
-#define AvFILL(av)     ((SvRMAGICAL((SV *) (av))) \
-                         ? mg_size((SV *) av) : AvFILLp(av))
+#define AvFILL(av)     ((SvRMAGICAL((const SV *) (av))) \
+                        ? mg_size(MUTABLE_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()        MUTABLE_AV(newSV_type(SVt_PVAV))
+
+/*
  * Local variables:
  * c-indentation-style: bsd
  * c-basic-offset: 4