This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Increase page file quota advice in README.vms
[perl5.git] / av.h
diff --git a/av.h b/av.h
index a11a05b..41cb6fe 100644 (file)
--- a/av.h
+++ b/av.h
@@ -8,29 +8,14 @@
  *
  */
 
-#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 {
-    _XPVAV_HEAD;
-    _XPVMG_HEAD;
+    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 */
 };
 
-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.
@@ -43,7 +28,7 @@ typedef struct {
  * 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,
+ * 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
@@ -52,17 +37,25 @@ typedef struct {
  */
 
 /*
-=head1 Handy Values
-
-=for apidoc AmU||Nullav
+=for apidoc ADmnU||Nullav
 Null AV pointer.
 
 (deprecated - use C<(AV *)NULL> instead)
 
-=head1 Array Manipulation Functions
+=for apidoc Am|SSize_t|AvFILL|AV* av
+Same as C<L</av_top_index>> or C<L</av_tindex>>.
+
+=for apidoc Cm|SSize_t|AvFILLp|AV* av
+
+If the array C<av> is empty, this returns -1; otherwise it returns the maximum
+value of the indices of all the array elements which are currently defined in
+C<av>.  It does not handle magic, hence the C<p> private indication in its name.
 
-=for apidoc Am|int|AvFILL|AV* av
-Same as C<av_len()>.  Deprecated, use C<av_len()> instead.
+=for apidoc Am|SV**|AvARRAY|AV* av
+Returns a pointer to the AV's internal SV* array.
+
+This is useful for doing pointer arithmetic on the array.
+If all you need is to look up an array element, then prefer C<av_fetch>.
 
 =cut
 */
@@ -72,10 +65,10 @@ Same as C<av_len()>.  Deprecated, use C<av_len()> instead.
 #endif
 
 #define AvARRAY(av)    ((av)->sv_u.svu_array)
-#define AvALLOC(av)    (*((SV***)&((XPVAV*)  SvANY(av))->xav_alloc))
+#define AvALLOC(av)    ((XPVAV*)  SvANY(av))->xav_alloc
 #define AvMAX(av)      ((XPVAV*)  SvANY(av))->xav_max
 #define AvFILLp(av)    ((XPVAV*)  SvANY(av))->xav_fill
-#define AvARYLEN(av)   (*Perl_av_arylen_p(aTHX_ (AV*)av))
+#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)
@@ -86,10 +79,20 @@ Same as C<av_len()>.  Deprecated, use C<av_len()> instead.
 #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((SV *) (av))) \
-                         ? mg_size((SV *) av) : AvFILLp(av))
+#define AvFILL(av)     ((SvRMAGICAL((const SV *) (av))) \
+                         ? mg_size(MUTABLE_SV(av)) : AvFILLp(av))
+#define av_top_index(av) AvFILL(av)
+#define av_tindex(av)    av_top_index(av)
+
+/* Note that it doesn't make sense to do this:
+ *      SvGETMAGIC(av); IV x = av_tindex_nomg(av);
+ */
+#   define av_top_index_skip_len_mg(av)                                     \
+                            (__ASSERT_(SvTYPE(av) == SVt_PVAV) AvFILLp(av))
+#   define av_tindex_skip_len_mg(av)  av_top_index_skip_len_mg(av)
 
 #define NEGATIVE_INDICES_VAR "NEGATIVE_INDICES"
 
@@ -98,17 +101,13 @@ Same as C<av_len()>.  Deprecated, use C<av_len()> instead.
 
 Creates a new AV.  The reference count is set to 1.
 
+Perl equivalent: C<my @array;>.
+
 =cut
 */
 
-#define newAV()        ((AV *)newSV_type(SVt_PVAV))
+#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:
+ * ex: set ts=8 sts=4 sw=4 et:
  */