av.h

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