av.h

   1 /*    av.h
   2  *
   3  *    Copyright (C) 1991, 1992, 1993, 1995, 1996, 1997, 1998, 1999,
   4  *    2000, 2001, 2002, by Larry Wall and others
   5  *
   6  *    You may distribute under the terms of either the GNU General Public
   7  *    License or the Artistic License, as specified in the README file.
   8  *
   9  */
  10
  11 struct xpvav {
  12     char*       xav_array;      /* pointer to first array element */
  13     SSize_t     xav_fill;       /* Index of last element present */
  14     SSize_t     xav_max;        /* max index for which array has space */
  15     IV          xof_off;        /* ptr is incremented by offset */
  16     NV          xnv_nv;         /* numeric value, if any */
  17     MAGIC*      xmg_magic;      /* magic for scalar array */
  18     HV*         xmg_stash;      /* class package */
  19
  20     SV**        xav_alloc;      /* pointer to beginning of C array of SVs */
  21     SV*         xav_arylen;
  22 };
  23
  24
  25 /* AVf_REAL is set for all AVs whose xav_array contents are refcounted.
  26  * Some things like "@_" and the scratchpad list do not set this, to
  27  * indicate that they are cheating (for efficiency) by not refcounting
  28  * the AV's contents.
  29  *
  30  * AVf_REIFY is only meaningful on such "fake" AVs (i.e. where AVf_REAL
  31  * is not set).  It indicates that the fake AV is capable of becoming
  32  * real if the array needs to be modified in some way.  Functions that
  33  * modify fake AVs check both flags to call av_reify() as appropriate.
  34  *
  35  * Note that the Perl stack and @DB::args have neither flag set. (Thus,
  36  * items that go on the stack are never refcounted.)
  37  *
  38  * These internal details are subject to change any time.  AV
  39  * manipulations external to perl should not care about any of this.
  40  * GSAR 1999-09-10
  41  */
  42
  43 /*
  44 =head1 Handy Values
  45
  46 =for apidoc AmU||Nullav
  47 Null AV pointer.
  48
  49 =head1 Array Manipulation Functions
  50
  51 =for apidoc Am|int|AvFILL|AV* av
  52 Same as C<av_len()>.  Deprecated, use C<av_len()> instead.
  53
  54 =cut
  55 */
  56
  57 #define Nullav Null(AV*)
  58
  59 #define AvARRAY(av)     ((SV**)((XPVAV*)  SvANY(av))->xav_array)
  60 #define AvALLOC(av)     ((XPVAV*)  SvANY(av))->xav_alloc
  61 #define AvMAX(av)       ((XPVAV*)  SvANY(av))->xav_max
  62 #define AvFILLp(av)     ((XPVAV*)  SvANY(av))->xav_fill
  63 #define AvARYLEN(av)    ((XPVAV*)  SvANY(av))->xav_arylen
  64
  65 #define AvREAL(av)      (SvFLAGS(av) & SVpav_REAL)
  66 #define AvREAL_on(av)   (SvFLAGS(av) |= SVpav_REAL)
  67 #define AvREAL_off(av)  (SvFLAGS(av) &= ~SVpav_REAL)
  68 #define AvREAL_only(av) (AvREIFY_off(av), SvFLAGS(av) |= SVpav_REAL)
  69 #define AvREIFY(av)     (SvFLAGS(av) & SVpav_REIFY)
  70 #define AvREIFY_on(av)  (SvFLAGS(av) |= SVpav_REIFY)
  71 #define AvREIFY_off(av) (SvFLAGS(av) &= ~SVpav_REIFY)
  72 #define AvREIFY_only(av)        (AvREAL_off(av), SvFLAGS(av) |= SVpav_REIFY)
  73
  74 #define AvREALISH(av)   (SvFLAGS(av) & (SVpav_REAL|SVpav_REIFY))
  75
  76 #define AvFILL(av)      ((SvRMAGICAL((SV *) (av))) \
  77                           ? mg_size((SV *) av) : AvFILLp(av))
  78
  79 #define NEGATIVE_INDICES_VAR "NEGATIVE_INDICES"