This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Bump Data::Dumper version
[perl5.git] / av.h
diff --git a/av.h b/av.h
index 5231c4d..41cb6fe 100644 (file)
--- a/av.h
+++ b/av.h
@@ -28,7 +28,7 @@ struct xpvav {
  * 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
@@ -37,17 +37,25 @@ struct xpvav {
  */
 
 /*
-=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
 */
@@ -71,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((const SV *) (av))) \
-                        ? mg_size(MUTABLE_SV(av)) : AvFILLp(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"
 
@@ -83,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()        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:
  */