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