This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Amazingly, it seems that none of the other GV specific macros are
[perl5.git] / gv.h
1 /*    gv.h
2  *
3  *    Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4  *    2000, 2001, 2002, 2003, 2004, 2005, 2006, 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 gp {
12     SV *        gp_sv;          /* scalar value */
13     U32         gp_refcnt;      /* how many globs point to this? */
14     struct io * gp_io;          /* filehandle value */
15     CV *        gp_form;        /* format value */
16     AV *        gp_av;          /* array value */
17     HV *        gp_hv;          /* hash value */
18     GV *        gp_egv;         /* effective gv, if *glob */
19     CV *        gp_cv;          /* subroutine value */
20     U32         gp_cvgen;       /* generational validity of cached gv_cv */
21     line_t      gp_line;        /* line first declared at (for -w) */
22     char *      gp_file;        /* file first declared in (for -w) */
23 };
24
25 #define GvXPVGV(gv)     ((XPVGV*)SvANY(gv))
26
27
28 #if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
29 #  define GvGP(gv)                                                      \
30         (*({GV *const shplep = (GV *) gv;                               \
31             assert(SvTYPE(shplep) == SVt_PVGV ||                        \
32             SvTYPE(shplep) == SVt_PVLV);                                \
33             assert(isGV_with_GP(shplep));                               \
34             &((shplep)->sv_u.svu_gp);}))
35 #  define GvFLAGS(gv)                                                   \
36         (*({GV *const yaah  = (GV *) gv;                                \
37             assert(SvTYPE(yaah) == SVt_PVGV || SvTYPE(yaah) == SVt_PVLV); \
38             assert(isGV_with_GP(yaah));                                 \
39             &(GvXPVGV(yaah)->xgv_flags);}))
40 #  define GvSTASH(gv)                                                   \
41         (*({ GV *_gv = (GV *) gv;                                       \
42             assert(isGV_with_GP(_gv));                                  \
43             assert(SvTYPE(_gv) == SVt_PVGV || SvTYPE(_gv) >= SVt_PVLV); \
44             &(GvXPVGV(_gv)->xgv_stash);                                 \
45          }))
46 #  define GvNAME(gv)                                                    \
47         (*({ GV *zzzz = (GV *) gv;                                      \
48             assert(isGV_with_GP(zzzz));                                 \
49             assert(SvTYPE(zzzz) == SVt_PVGV || SvTYPE(zzzz) >= SVt_PVLV); \
50             &(GvXPVGV(zzzz)->xgv_name);                                 \
51          }))
52 #  define GvNAMELEN(gv)                                                 \
53         (*({ GV *glank = (GV *) gv;                                     \
54             assert(isGV_with_GP(glank));                                \
55             assert(SvTYPE(glank) == SVt_PVGV || SvTYPE(glank) >= SVt_PVLV); \
56             &(GvXPVGV(glank)->xgv_namelen);                             \
57          }))
58 #else
59 #  define GvGP(gv)      ((gv)->sv_u.svu_gp)
60 #  define GvFLAGS(gv)   (GvXPVGV(gv)->xgv_flags)
61 #  define GvSTASH(gv)   (GvXPVGV(gv)->xgv_stash)
62 #  define GvNAME(gv)    (GvXPVGV(gv)->xgv_name)
63 #  define GvNAMELEN(gv) (GvXPVGV(gv)->xgv_namelen)
64 #endif
65
66 /*
67 =head1 GV Functions
68
69 =for apidoc Am|SV*|GvSV|GV* gv
70
71 Return the SV from the GV.
72
73 =cut
74 */
75
76 #define GvSV(gv)        (GvGP(gv)->gp_sv)
77 #ifdef PERL_DONT_CREATE_GVSV
78 #define GvSVn(gv)       (*(GvGP(gv)->gp_sv ? \
79                          &(GvGP(gv)->gp_sv) : \
80                          &(GvGP(gv_SVadd(gv))->gp_sv)))
81 #else
82 #define GvSVn(gv)       GvSV(gv)
83 #endif
84
85 #define GvREFCNT(gv)    (GvGP(gv)->gp_refcnt)
86 #define GvIO(gv)        ((gv) && SvTYPE((SV*)gv) == SVt_PVGV && GvGP(gv) ? GvIOp(gv) : 0)
87 #define GvIOp(gv)       (GvGP(gv)->gp_io)
88 #define GvIOn(gv)       (GvIO(gv) ? GvIOp(gv) : GvIOp(gv_IOadd(gv)))
89
90 #define GvFORM(gv)      (GvGP(gv)->gp_form)
91 #define GvAV(gv)        (GvGP(gv)->gp_av)
92
93 /* This macro is deprecated.  Do not use! */
94 #define GvREFCNT_inc(gv) ((GV*)SvREFCNT_inc(gv))        /* DO NOT USE */
95
96 #define GvAVn(gv)       (GvGP(gv)->gp_av ? \
97                          GvGP(gv)->gp_av : \
98                          GvGP(gv_AVadd(gv))->gp_av)
99 #define GvHV(gv)        ((GvGP(gv))->gp_hv)
100
101 #define GvHVn(gv)       (GvGP(gv)->gp_hv ? \
102                          GvGP(gv)->gp_hv : \
103                          GvGP(gv_HVadd(gv))->gp_hv)
104
105 #define GvCV(gv)        (GvGP(gv)->gp_cv)
106 #define GvCVGEN(gv)     (GvGP(gv)->gp_cvgen)
107 #define GvCVu(gv)       (GvGP(gv)->gp_cvgen ? NULL : GvGP(gv)->gp_cv)
108
109 #define GvLINE(gv)      (GvGP(gv)->gp_line)
110 #define GvFILE(gv)      (GvGP(gv)->gp_file)
111 #define GvFILEGV(gv)    (gv_fetchfile(GvFILE(gv)))
112
113 #define GvEGV(gv)       (GvGP(gv)->gp_egv)
114 #define GvENAME(gv)     GvNAME(GvEGV(gv) ? GvEGV(gv) : gv)
115 #define GvESTASH(gv)    GvSTASH(GvEGV(gv) ? GvEGV(gv) : gv)
116
117 #define GVf_INTRO       0x01
118 #define GVf_MULTI       0x02
119 #define GVf_ASSUMECV    0x04
120 #define GVf_IN_PAD      0x08
121 #define GVf_IMPORTED    0xF0
122 #define GVf_IMPORTED_SV   0x10
123 #define GVf_IMPORTED_AV   0x20
124 #define GVf_IMPORTED_HV   0x40
125 #define GVf_IMPORTED_CV   0x80
126
127 #define GvINTRO(gv)             (GvFLAGS(gv) & GVf_INTRO)
128 #define GvINTRO_on(gv)          (GvFLAGS(gv) |= GVf_INTRO)
129 #define GvINTRO_off(gv)         (GvFLAGS(gv) &= ~GVf_INTRO)
130
131 #define GvMULTI(gv)             (GvFLAGS(gv) & GVf_MULTI)
132 #define GvMULTI_on(gv)          (GvFLAGS(gv) |= GVf_MULTI)
133 #define GvMULTI_off(gv)         (GvFLAGS(gv) &= ~GVf_MULTI)
134
135 #define GvASSUMECV(gv)          (GvFLAGS(gv) & GVf_ASSUMECV)
136 #define GvASSUMECV_on(gv)       (GvFLAGS(gv) |= GVf_ASSUMECV)
137 #define GvASSUMECV_off(gv)      (GvFLAGS(gv) &= ~GVf_ASSUMECV)
138
139 #define GvIMPORTED(gv)          (GvFLAGS(gv) & GVf_IMPORTED)
140 #define GvIMPORTED_on(gv)       (GvFLAGS(gv) |= GVf_IMPORTED)
141 #define GvIMPORTED_off(gv)      (GvFLAGS(gv) &= ~GVf_IMPORTED)
142
143 #define GvIMPORTED_SV(gv)       (GvFLAGS(gv) & GVf_IMPORTED_SV)
144 #define GvIMPORTED_SV_on(gv)    (GvFLAGS(gv) |= GVf_IMPORTED_SV)
145 #define GvIMPORTED_SV_off(gv)   (GvFLAGS(gv) &= ~GVf_IMPORTED_SV)
146
147 #define GvIMPORTED_AV(gv)       (GvFLAGS(gv) & GVf_IMPORTED_AV)
148 #define GvIMPORTED_AV_on(gv)    (GvFLAGS(gv) |= GVf_IMPORTED_AV)
149 #define GvIMPORTED_AV_off(gv)   (GvFLAGS(gv) &= ~GVf_IMPORTED_AV)
150
151 #define GvIMPORTED_HV(gv)       (GvFLAGS(gv) & GVf_IMPORTED_HV)
152 #define GvIMPORTED_HV_on(gv)    (GvFLAGS(gv) |= GVf_IMPORTED_HV)
153 #define GvIMPORTED_HV_off(gv)   (GvFLAGS(gv) &= ~GVf_IMPORTED_HV)
154
155 #define GvIMPORTED_CV(gv)       (GvFLAGS(gv) & GVf_IMPORTED_CV)
156 #define GvIMPORTED_CV_on(gv)    (GvFLAGS(gv) |= GVf_IMPORTED_CV)
157 #define GvIMPORTED_CV_off(gv)   (GvFLAGS(gv) &= ~GVf_IMPORTED_CV)
158
159 #define GvIN_PAD(gv)            (GvFLAGS(gv) & GVf_IN_PAD)
160 #define GvIN_PAD_on(gv)         (GvFLAGS(gv) |= GVf_IN_PAD)
161 #define GvIN_PAD_off(gv)        (GvFLAGS(gv) &= ~GVf_IN_PAD)
162
163 #define GvUNIQUE(gv)            0
164 #define GvUNIQUE_on(gv)
165 #define GvUNIQUE_off(gv)
166
167 #ifdef USE_ITHREADS
168 #define GV_UNIQUE_CHECK
169 #else
170 #undef  GV_UNIQUE_CHECK
171 #endif
172
173 #define Nullgv Null(GV*)
174
175 #define DM_UID   0x003
176 #define DM_RUID   0x001
177 #define DM_EUID   0x002
178 #define DM_GID   0x030
179 #define DM_RGID   0x010
180 #define DM_EGID   0x020
181 #define DM_DELAY 0x100
182
183 /*
184  * symbol creation flags, for use in gv_fetchpv() and get_*v()
185  */
186 #define GV_ADD          0x01    /* add, if symbol not already there */
187 #define GV_ADDMULTI     0x02    /* add, pretending it has been added already */
188 #define GV_ADDWARN      0x04    /* add, but warn if symbol wasn't already there */
189 #define GV_ADDINEVAL    0x08    /* add, as though we're doing so within an eval */
190 #define GV_NOINIT       0x10    /* add, but don't init symbol, if type != PVGV */
191 /* This is used by toke.c to avoid turing placeholder constants in the symbol
192    table into full PVGVs with attached constant subroutines.  */
193 #define GV_NOADD_NOINIT 0x20    /* Don't add the symbol if it's not there.
194                                    Don't init it if it is there but ! PVGV */
195 #define GV_NOEXPAND     0x40    /* Don't expand SvOK() entries to PVGV */
196 #define GV_NOTQUAL      0x80    /* A plain symbol name, not qualified with a
197                                    package (so skip checks for :: and ')  */
198
199 /*      SVf_UTF8 (more accurately the return value from SvUTF8) is also valid
200         as a flag to gv_fetch_pvn_flags, so ensure it lies outside this range.
201 */
202 #define gv_fullname3(sv,gv,prefix) gv_fullname4(sv,gv,prefix,TRUE)
203 #define gv_efullname3(sv,gv,prefix) gv_efullname4(sv,gv,prefix,TRUE)
204 #define gv_fetchmethod(stash, name) gv_fetchmethod_autoload(stash, name, TRUE)