toplevel Makefile.SH
[perl.git] / gv.h
1 /*    gv.h
2  *
3  *    Copyright (c) 1991-2002, Larry Wall
4  *
5  *    You may distribute under the terms of either the GNU General Public
6  *    License or the Artistic License, as specified in the README file.
7  *
8  */
9
10 struct gp {
11     SV *        gp_sv;          /* scalar value */
12     U32         gp_refcnt;      /* how many globs point to this? */
13     struct io * gp_io;          /* filehandle value */
14     CV *        gp_form;        /* format value */
15     AV *        gp_av;          /* array value */
16     HV *        gp_hv;          /* hash value */
17     GV *        gp_egv;         /* effective gv, if *glob */
18     CV *        gp_cv;          /* subroutine value */
19     U32         gp_cvgen;       /* generational validity of cached gv_cv */
20     U32         gp_flags;       /* XXX unused */
21     line_t      gp_line;        /* line first declared at (for -w) */
22     char *      gp_file;        /* file first declared in (for -w) */
23 };
24
25 #if defined(CRIPPLED_CC) && (defined(iAPX286) || defined(M_I286) || defined(I80286))
26 #define MICROPORT
27 #endif
28
29 #define GvXPVGV(gv)     ((XPVGV*)SvANY(gv))
30
31 #define GvGP(gv)        (GvXPVGV(gv)->xgv_gp)
32 #define GvNAME(gv)      (GvXPVGV(gv)->xgv_name)
33 #define GvNAMELEN(gv)   (GvXPVGV(gv)->xgv_namelen)
34 #define GvSTASH(gv)     (GvXPVGV(gv)->xgv_stash)
35 #define GvFLAGS(gv)     (GvXPVGV(gv)->xgv_flags)
36
37 /*
38 =head1 GV Functions
39
40 =for apidoc Am|SV*|GvSV|GV* gv
41
42 Return the SV from the GV.
43
44 =cut
45 */
46
47 #define GvSV(gv)        (GvGP(gv)->gp_sv)
48 #define GvREFCNT(gv)    (GvGP(gv)->gp_refcnt)
49 #define GvIO(gv)        ((gv) && SvTYPE((SV*)gv) == SVt_PVGV ? GvIOp(gv) : 0)
50 #define GvIOp(gv)       (GvGP(gv)->gp_io)
51 #define GvIOn(gv)       (GvIO(gv) ? GvIOp(gv) : GvIOp(gv_IOadd(gv)))
52
53 #define GvFORM(gv)      (GvGP(gv)->gp_form)
54 #define GvAV(gv)        (GvGP(gv)->gp_av)
55
56 /* This macro is deprecated.  Do not use! */
57 #define GvREFCNT_inc(gv) ((GV*)SvREFCNT_inc(gv))        /* DO NOT USE */
58
59 #ifdef  MICROPORT       /* Microport 2.4 hack */
60 AV *GvAVn();
61 #else
62 #define GvAVn(gv)       (GvGP(gv)->gp_av ? \
63                          GvGP(gv)->gp_av : \
64                          GvGP(gv_AVadd(gv))->gp_av)
65 #endif
66 #define GvHV(gv)        ((GvGP(gv))->gp_hv)
67
68 #ifdef  MICROPORT       /* Microport 2.4 hack */
69 HV *GvHVn();
70 #else
71 #define GvHVn(gv)       (GvGP(gv)->gp_hv ? \
72                          GvGP(gv)->gp_hv : \
73                          GvGP(gv_HVadd(gv))->gp_hv)
74 #endif                  /* Microport 2.4 hack */
75
76 #define GvCV(gv)        (GvGP(gv)->gp_cv)
77 #define GvCVGEN(gv)     (GvGP(gv)->gp_cvgen)
78 #define GvCVu(gv)       (GvGP(gv)->gp_cvgen ? Nullcv : GvGP(gv)->gp_cv)
79
80 #define GvGPFLAGS(gv)   (GvGP(gv)->gp_flags)
81
82 #define GvLINE(gv)      (GvGP(gv)->gp_line)
83 #define GvFILE(gv)      (GvGP(gv)->gp_file)
84 #define GvFILEGV(gv)    (gv_fetchfile(GvFILE(gv)))
85
86 #define GvEGV(gv)       (GvGP(gv)->gp_egv)
87 #define GvENAME(gv)     GvNAME(GvEGV(gv) ? GvEGV(gv) : gv)
88 #define GvESTASH(gv)    GvSTASH(GvEGV(gv) ? GvEGV(gv) : gv)
89
90 #define GVf_INTRO       0x01
91 #define GVf_MULTI       0x02
92 #define GVf_ASSUMECV    0x04
93 #define GVf_IN_PAD      0x08
94 #define GVf_IMPORTED    0xF0
95 #define GVf_IMPORTED_SV   0x10
96 #define GVf_IMPORTED_AV   0x20
97 #define GVf_IMPORTED_HV   0x40
98 #define GVf_IMPORTED_CV   0x80
99
100 #define GvINTRO(gv)             (GvFLAGS(gv) & GVf_INTRO)
101 #define GvINTRO_on(gv)          (GvFLAGS(gv) |= GVf_INTRO)
102 #define GvINTRO_off(gv)         (GvFLAGS(gv) &= ~GVf_INTRO)
103
104 #define GvMULTI(gv)             (GvFLAGS(gv) & GVf_MULTI)
105 #define GvMULTI_on(gv)          (GvFLAGS(gv) |= GVf_MULTI)
106 #define GvMULTI_off(gv)         (GvFLAGS(gv) &= ~GVf_MULTI)
107
108 #define GvASSUMECV(gv)          (GvFLAGS(gv) & GVf_ASSUMECV)
109 #define GvASSUMECV_on(gv)       (GvFLAGS(gv) |= GVf_ASSUMECV)
110 #define GvASSUMECV_off(gv)      (GvFLAGS(gv) &= ~GVf_ASSUMECV)
111
112 #define GvIMPORTED(gv)          (GvFLAGS(gv) & GVf_IMPORTED)
113 #define GvIMPORTED_on(gv)       (GvFLAGS(gv) |= GVf_IMPORTED)
114 #define GvIMPORTED_off(gv)      (GvFLAGS(gv) &= ~GVf_IMPORTED)
115
116 #define GvIMPORTED_SV(gv)       (GvFLAGS(gv) & GVf_IMPORTED_SV)
117 #define GvIMPORTED_SV_on(gv)    (GvFLAGS(gv) |= GVf_IMPORTED_SV)
118 #define GvIMPORTED_SV_off(gv)   (GvFLAGS(gv) &= ~GVf_IMPORTED_SV)
119
120 #define GvIMPORTED_AV(gv)       (GvFLAGS(gv) & GVf_IMPORTED_AV)
121 #define GvIMPORTED_AV_on(gv)    (GvFLAGS(gv) |= GVf_IMPORTED_AV)
122 #define GvIMPORTED_AV_off(gv)   (GvFLAGS(gv) &= ~GVf_IMPORTED_AV)
123
124 #define GvIMPORTED_HV(gv)       (GvFLAGS(gv) & GVf_IMPORTED_HV)
125 #define GvIMPORTED_HV_on(gv)    (GvFLAGS(gv) |= GVf_IMPORTED_HV)
126 #define GvIMPORTED_HV_off(gv)   (GvFLAGS(gv) &= ~GVf_IMPORTED_HV)
127
128 #define GvIMPORTED_CV(gv)       (GvFLAGS(gv) & GVf_IMPORTED_CV)
129 #define GvIMPORTED_CV_on(gv)    (GvFLAGS(gv) |= GVf_IMPORTED_CV)
130 #define GvIMPORTED_CV_off(gv)   (GvFLAGS(gv) &= ~GVf_IMPORTED_CV)
131
132 #define GvIN_PAD(gv)            (GvFLAGS(gv) & GVf_IN_PAD)
133 #define GvIN_PAD_on(gv)         (GvFLAGS(gv) |= GVf_IN_PAD)
134 #define GvIN_PAD_off(gv)        (GvFLAGS(gv) &= ~GVf_IN_PAD)
135
136 /* XXX: all GvFLAGS options are used, borrowing GvGPFLAGS for the moment */
137
138 #define GVf_UNIQUE           0x0001
139 #define GvUNIQUE(gv)         (GvGP(gv) && (GvGPFLAGS(gv) & GVf_UNIQUE))
140 #define GvUNIQUE_on(gv)      (GvGPFLAGS(gv) |= GVf_UNIQUE)
141 #define GvUNIQUE_off(gv)     (GvGPFLAGS(gv) &= ~GVf_UNIQUE)
142
143 #ifdef USE_ITHREADS
144 #define GV_UNIQUE_CHECK
145 #else
146 #undef  GV_UNIQUE_CHECK
147 #endif
148
149 #define Nullgv Null(GV*)
150
151 #define DM_UID   0x003
152 #define DM_RUID   0x001
153 #define DM_EUID   0x002
154 #define DM_GID   0x030
155 #define DM_RGID   0x010
156 #define DM_EGID   0x020
157 #define DM_DELAY 0x100
158
159 /*
160  * symbol creation flags, for use in gv_fetchpv() and get_*v()
161  */
162 #define GV_ADD          0x01    /* add, if symbol not already there */
163 #define GV_ADDMULTI     0x02    /* add, pretending it has been added already */
164 #define GV_ADDWARN      0x04    /* add, but warn if symbol wasn't already there */
165 #define GV_ADDINEVAL    0x08    /* add, as though we're doing so within an eval */
166 #define GV_NOINIT       0x10    /* add, but don't init symbol, if type != PVGV */