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