av.h

   1 /*    av.h
   2  *
   3  *    Copyright (C) 1991, 1992, 1993, 1995, 1996, 1997, 1998, 1999,
   4  *    2000, 2001, 2002, 2005, 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     NV          xnv_nv;         /* numeric value, if any */
  13     SSize_t     xav_fill;       /* Index of last element present */
  14     SSize_t     xav_max;        /* max index for which array has space */
  15     union {
  16         IV      xivu_iv;        /* integer value or pv offset */
  17         UV      xivu_uv;
  18         void *  xivu_p1;
  19     }           xiv_u;
  20     MAGIC*      xmg_magic;      /* magic for scalar array */
  21     HV*         xmg_stash;      /* class package */
  22     SV*         xav_arylen;
  23 };
  24
  25 #if !defined(PERL_EXPERIMENTAL_LAYOUT)
  26 typedef struct xpvav xpvav_allocated;
  27 #else
  28 typedef struct {
  29     SSize_t     xav_fill;       /* Index of last element present */
  30     SSize_t     xav_max;        /* max index for which array has space */
  31     union {
  32         IV      xivu_iv;        /* integer value or pv offset */
  33         UV      xivu_uv;
  34         void *  xivu_p1;
  35     }           xiv_u;
  36     MAGIC*      xmg_magic;      /* magic for scalar array */
  37     HV*         xmg_stash;      /* class package */
  38     SV*         xav_arylen;
  39 } xpvav_allocated;
  40 #endif
  41
  42 /* SV** xav_alloc; */
  43 #define xav_alloc xiv_u.xivu_p1
  44 /* SV*  xav_arylen; */
  45
  46 /* AVf_REAL is set for all AVs whose xav_array contents are refcounted.
  47  * Some things like "@_" and the scratchpad list do not set this, to
  48  * indicate that they are cheating (for efficiency) by not refcounting
  49  * the AV's contents.
  50  *
  51  * AVf_REIFY is only meaningful on such "fake" AVs (i.e. where AVf_REAL
  52  * is not set).  It indicates that the fake AV is capable of becoming
  53  * real if the array needs to be modified in some way.  Functions that
  54  * modify fake AVs check both flags to call av_reify() as appropriate.
  55  *
  56  * Note that the Perl stack and @DB::args have neither flag set. (Thus,
  57  * items that go on the stack are never refcounted.)
  58  *
  59  * These internal details are subject to change any time.  AV
  60  * manipulations external to perl should not care about any of this.
  61  * GSAR 1999-09-10
  62  */
  63
  64 /*
  65 =head1 Handy Values
  66
  67 =for apidoc AmU||Nullav
  68 Null AV pointer.
  69
  70 =head1 Array Manipulation Functions
  71
  72 =for apidoc Am|int|AvFILL|AV* av
  73 Same as C<av_len()>.  Deprecated, use C<av_len()> instead.
  74
  75 =cut
  76 */
  77
  78 #define Nullav Null(AV*)
  79
  80 #define AvARRAY(av)     ((av)->sv_u.svu_array)
  81 #define AvALLOC(av)     (*((SV***)&((XPVAV*)  SvANY(av))->xav_alloc))
  82 #define AvMAX(av)       ((XPVAV*)  SvANY(av))->xav_max
  83 #define AvFILLp(av)     ((XPVAV*)  SvANY(av))->xav_fill
  84 #define AvARYLEN(av)    (*((SV**)&((XPVAV*)  SvANY(av))->xav_arylen))
  85
  86 #define AvREAL(av)      (SvFLAGS(av) & SVpav_REAL)
  87 #define AvREAL_on(av)   (SvFLAGS(av) |= SVpav_REAL)
  88 #define AvREAL_off(av)  (SvFLAGS(av) &= ~SVpav_REAL)
  89 #define AvREAL_only(av) (AvREIFY_off(av), SvFLAGS(av) |= SVpav_REAL)
  90 #define AvREIFY(av)     (SvFLAGS(av) & SVpav_REIFY)
  91 #define AvREIFY_on(av)  (SvFLAGS(av) |= SVpav_REIFY)
  92 #define AvREIFY_off(av) (SvFLAGS(av) &= ~SVpav_REIFY)
  93 #define AvREIFY_only(av)        (AvREAL_off(av), SvFLAGS(av) |= SVpav_REIFY)
  94
  95 #define AvREALISH(av)   (SvFLAGS(av) & (SVpav_REAL|SVpav_REIFY))
  96
  97 #define AvFILL(av)      ((SvRMAGICAL((SV *) (av))) \
  98                           ? mg_size((SV *) av) : AvFILLp(av))
  99
 100 #define NEGATIVE_INDICES_VAR "NEGATIVE_INDICES"
 101
 102 /*
 103  * Local variables:
 104  * c-indentation-style: bsd
 105  * c-basic-offset: 4
 106  * indent-tabs-mode: t
 107  * End:
 108  *
 109  * ex: set ts=8 sts=4 sw=4 noet:
 110  */