3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
4 * 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 by Larry Wall and others
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.
12 SV * gp_sv; /* scalar value */
13 struct io * gp_io; /* filehandle value */
14 CV * gp_cv; /* subroutine value */
15 U32 gp_cvgen; /* generational validity of cached gp_cv */
16 U32 gp_refcnt; /* how many globs point to this? */
17 HV * gp_hv; /* hash value */
18 AV * gp_av; /* array value */
19 CV * gp_form; /* format value */
20 GV * gp_egv; /* effective gv, if *glob */
21 PERL_BITFIELD32 gp_line:31; /* line first declared at (for -w) */
22 PERL_BITFIELD32 gp_flags:1;
23 HEK * gp_file_hek; /* file first declared in (for -w) */
26 #define GvXPVGV(gv) ((XPVGV*)SvANY(gv))
29 #if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN) && !defined(__INTEL_COMPILER)
31 (0+(*({GV *const _gvgp = (GV *) (gv); \
32 assert(SvTYPE(_gvgp) == SVt_PVGV || SvTYPE(_gvgp) == SVt_PVLV); \
33 assert(isGV_with_GP(_gvgp)); \
34 &((_gvgp)->sv_u.svu_gp);})))
35 # define GvGP_set(gv,gp) \
36 {GV *const _gvgp = (GV *) (gv); \
37 assert(SvTYPE(_gvgp) == SVt_PVGV || SvTYPE(_gvgp) == SVt_PVLV); \
38 assert(isGV_with_GP(_gvgp)); \
39 (_gvgp)->sv_u.svu_gp = (gp); }
40 # define GvFLAGS(gv) \
41 (*({GV *const _gvflags = (GV *) (gv); \
42 assert(SvTYPE(_gvflags) == SVt_PVGV || SvTYPE(_gvflags) == SVt_PVLV); \
43 assert(isGV_with_GP(_gvflags)); \
44 &(GvXPVGV(_gvflags)->xpv_cur);}))
45 # define GvSTASH(gv) \
46 (*({ GV * const _gvstash = (GV *) (gv); \
47 assert(isGV_with_GP(_gvstash)); \
48 assert(SvTYPE(_gvstash) == SVt_PVGV || SvTYPE(_gvstash) >= SVt_PVLV); \
49 &(GvXPVGV(_gvstash)->xnv_u.xgv_stash); \
51 # define GvNAME_HEK(gv) \
52 (*({ GV * const _gvname_hek = (GV *) (gv); \
53 assert(isGV_with_GP(_gvname_hek)); \
54 assert(SvTYPE(_gvname_hek) == SVt_PVGV || SvTYPE(_gvname_hek) >= SVt_PVLV); \
55 &(GvXPVGV(_gvname_hek)->xiv_u.xivu_namehek); \
57 # define GvNAME_get(gv) ({ assert(GvNAME_HEK(gv)); (char *)HEK_KEY(GvNAME_HEK(gv)); })
58 # define GvNAMELEN_get(gv) ({ assert(GvNAME_HEK(gv)); HEK_LEN(GvNAME_HEK(gv)); })
59 # define GvNAMEUTF8(gv) ({ assert(GvNAME_HEK(gv)); HEK_UTF8(GvNAME_HEK(gv)); })
61 # define GvGP(gv) (0+(gv)->sv_u.svu_gp)
62 # define GvGP_set(gv,gp) ((gv)->sv_u.svu_gp = (gp))
63 # define GvFLAGS(gv) (GvXPVGV(gv)->xpv_cur)
64 # define GvSTASH(gv) (GvXPVGV(gv)->xnv_u.xgv_stash)
65 # define GvNAME_HEK(gv) (GvXPVGV(gv)->xiv_u.xivu_namehek)
66 # define GvNAME_get(gv) HEK_KEY(GvNAME_HEK(gv))
67 # define GvNAMELEN_get(gv) HEK_LEN(GvNAME_HEK(gv))
68 # define GvNAMEUTF8(gv) HEK_UTF8(GvNAME_HEK(gv))
71 #define GvNAME(gv) GvNAME_get(gv)
72 #define GvNAMELEN(gv) GvNAMELEN_get(gv)
77 =for apidoc Am|SV*|GvSV|GV* gv
79 Return the SV from the GV.
81 =for apidoc Am|AV*|GvAV|GV* gv
83 Return the AV from the GV.
85 =for apidoc Am|HV*|GvHV|GV* gv
87 Return the HV from the GV.
89 =for apidoc Am|CV*|GvCV|GV* gv
91 Return the CV from the GV.
96 #define GvSV(gv) (GvGP(gv)->gp_sv)
97 #ifdef PERL_DONT_CREATE_GVSV
98 #define GvSVn(gv) (*(GvGP(gv)->gp_sv ? \
99 &(GvGP(gv)->gp_sv) : \
100 &(GvGP(gv_SVadd(gv))->gp_sv)))
102 #define GvSVn(gv) GvSV(gv)
105 #define GvREFCNT(gv) (GvGP(gv)->gp_refcnt)
110 SvTYPE((const SV*)(gv)) == SVt_PVGV \
111 || SvTYPE((const SV*)(gv)) == SVt_PVLV \
117 #define GvIOp(gv) (GvGP(gv)->gp_io)
118 #define GvIOn(gv) (GvIO(gv) ? GvIOp(gv) : GvIOp(gv_IOadd(gv)))
120 #define GvFORM(gv) (GvGP(gv)->gp_form)
121 #define GvAV(gv) (GvGP(gv)->gp_av)
123 #define GvAVn(gv) (GvGP(gv)->gp_av ? \
125 GvGP(gv_AVadd(gv))->gp_av)
126 #define GvHV(gv) ((GvGP(gv))->gp_hv)
128 #define GvHVn(gv) (GvGP(gv)->gp_hv ? \
130 GvGP(gv_HVadd(gv))->gp_hv)
132 #define GvCV(gv) (0+GvGP(gv)->gp_cv)
133 #define GvCV_set(gv,cv) (GvGP(gv)->gp_cv = (cv))
134 #define GvCVGEN(gv) (GvGP(gv)->gp_cvgen)
135 #define GvCVu(gv) (GvGP(gv)->gp_cvgen ? NULL : GvGP(gv)->gp_cv)
137 #define GvGPFLAGS(gv) (GvGP(gv)->gp_flags)
139 #define GvLINE(gv) (GvGP(gv)->gp_line)
140 #define GvFILE_HEK(gv) (GvGP(gv)->gp_file_hek)
141 #define GvFILEx(gv) HEK_KEY(GvFILE_HEK(gv))
142 #define GvFILE(gv) (GvFILE_HEK(gv) ? GvFILEx(gv) : NULL)
143 #define GvFILEGV(gv) (GvFILE_HEK(gv) ? gv_fetchfile(GvFILEx(gv)) : NULL)
145 #define GvEGV(gv) (GvGP(gv)->gp_egv)
146 #define GvEGVx(gv) (isGV_with_GP(gv) ? GvEGV(gv) : NULL)
147 #define GvENAME(gv) GvNAME(GvEGV(gv) ? GvEGV(gv) : gv)
148 #define GvENAMELEN(gv) GvNAMELEN(GvEGV(gv) ? GvEGV(gv) : gv)
149 #define GvENAMEUTF8(gv) GvNAMEUTF8(GvEGV(gv) ? GvEGV(gv) : gv)
150 #define GvENAME_HEK(gv) GvNAME_HEK(GvEGV(gv) ? GvEGV(gv) : gv)
151 #define GvESTASH(gv) GvSTASH(GvEGV(gv) ? GvEGV(gv) : gv)
153 /* GVf_INTRO is one-shot flag which indicates that the next assignment
154 of a reference to the glob is to be localised; it distinguishes
155 'local *g = $ref' from '*g = $ref'.
157 #define GVf_INTRO 0x01
158 #define GVf_MULTI 0x02
159 #define GVf_ASSUMECV 0x04
161 #define GVf_IMPORTED 0xF0
162 #define GVf_IMPORTED_SV 0x10
163 #define GVf_IMPORTED_AV 0x20
164 #define GVf_IMPORTED_HV 0x40
165 #define GVf_IMPORTED_CV 0x80
167 #define GvINTRO(gv) (GvFLAGS(gv) & GVf_INTRO)
168 #define GvINTRO_on(gv) (GvFLAGS(gv) |= GVf_INTRO)
169 #define GvINTRO_off(gv) (GvFLAGS(gv) &= ~GVf_INTRO)
171 #define GvMULTI(gv) (GvFLAGS(gv) & GVf_MULTI)
172 #define GvMULTI_on(gv) (GvFLAGS(gv) |= GVf_MULTI)
173 #define GvMULTI_off(gv) (GvFLAGS(gv) &= ~GVf_MULTI)
175 #define GvASSUMECV(gv) (GvFLAGS(gv) & GVf_ASSUMECV)
176 #define GvASSUMECV_on(gv) (GvFLAGS(gv) |= GVf_ASSUMECV)
177 #define GvASSUMECV_off(gv) (GvFLAGS(gv) &= ~GVf_ASSUMECV)
179 #define GvIMPORTED(gv) (GvFLAGS(gv) & GVf_IMPORTED)
180 #define GvIMPORTED_on(gv) (GvFLAGS(gv) |= GVf_IMPORTED)
181 #define GvIMPORTED_off(gv) (GvFLAGS(gv) &= ~GVf_IMPORTED)
183 #define GvIMPORTED_SV(gv) (GvFLAGS(gv) & GVf_IMPORTED_SV)
184 #define GvIMPORTED_SV_on(gv) (GvFLAGS(gv) |= GVf_IMPORTED_SV)
185 #define GvIMPORTED_SV_off(gv) (GvFLAGS(gv) &= ~GVf_IMPORTED_SV)
187 #define GvIMPORTED_AV(gv) (GvFLAGS(gv) & GVf_IMPORTED_AV)
188 #define GvIMPORTED_AV_on(gv) (GvFLAGS(gv) |= GVf_IMPORTED_AV)
189 #define GvIMPORTED_AV_off(gv) (GvFLAGS(gv) &= ~GVf_IMPORTED_AV)
191 #define GvIMPORTED_HV(gv) (GvFLAGS(gv) & GVf_IMPORTED_HV)
192 #define GvIMPORTED_HV_on(gv) (GvFLAGS(gv) |= GVf_IMPORTED_HV)
193 #define GvIMPORTED_HV_off(gv) (GvFLAGS(gv) &= ~GVf_IMPORTED_HV)
195 #define GvIMPORTED_CV(gv) (GvFLAGS(gv) & GVf_IMPORTED_CV)
196 #define GvIMPORTED_CV_on(gv) (GvFLAGS(gv) |= GVf_IMPORTED_CV)
197 #define GvIMPORTED_CV_off(gv) (GvFLAGS(gv) &= ~GVf_IMPORTED_CV)
200 # define GvIN_PAD(gv) 0
201 # define GvIN_PAD_on(gv) NOOP
202 # define GvIN_PAD_off(gv) NOOP
203 # define Nullgv Null(GV*)
206 #define DM_RUID 0x001
207 #define DM_EUID 0x002
208 #define DM_UID (DM_RUID|DM_EUID)
209 #define DM_ARRAY_ISA 0x004
210 #define DM_RGID 0x010
211 #define DM_EGID 0x020
212 #define DM_GID (DM_RGID|DM_EGID)
213 #define DM_DELAY 0x100
216 * symbol creation flags, for use in gv_fetchpv() and get_*v()
218 #define GV_ADD 0x01 /* add, if symbol not already there
219 For gv_name_set, adding a HEK for the first
220 time, so don't try to free what's there. */
221 #define GV_ADDMULTI 0x02 /* add, pretending it has been added
222 already; used also by gv_init_* */
223 #define GV_ADDWARN 0x04 /* add, but warn if symbol wasn't already there */
225 #define GV_NOINIT 0x10 /* add, but don't init symbol, if type != PVGV */
226 /* This is used by toke.c to avoid turing placeholder constants in the symbol
227 table into full PVGVs with attached constant subroutines. */
228 #define GV_NOADD_NOINIT 0x20 /* Don't add the symbol if it's not there.
229 Don't init it if it is there but ! PVGV */
230 #define GV_NOEXPAND 0x40 /* Don't expand SvOK() entries to PVGV */
231 #define GV_NOTQUAL 0x80 /* A plain symbol name, not qualified with a
232 package (so skip checks for :: and ') */
233 #define GV_AUTOLOAD 0x100 /* gv_fetchmethod_flags() should AUTOLOAD */
234 #define GV_CROAK 0x200 /* gv_fetchmethod_flags() should croak */
235 #define GV_ADDMG 0x400 /* add if magical */
236 #define GV_NO_SVGMAGIC 0x800 /* Skip get-magic on an SV argument;
237 used only by gv_fetchsv(_nomg) */
238 #define GV_CACHE_ONLY 0x1000 /* return stash only if found in cache;
239 used only in flags parameter to gv_stash* family */
241 /* Flags for gv_fetchmeth_pvn and gv_autoload_pvn*/
242 #define GV_SUPER 0x1000 /* SUPER::method */
244 /* Flags for gv_autoload_*/
245 #define GV_AUTOLOAD_ISMETHOD 1 /* autoloading a method? */
247 /* SVf_UTF8 (more accurately the return value from SvUTF8) is also valid
248 as a flag to various gv_* functions, so ensure it lies
252 #define GV_NOADD_MASK \
253 (SVf_UTF8|GV_NOADD_NOINIT|GV_NOEXPAND|GV_NOTQUAL|GV_ADDMG|GV_NO_SVGMAGIC)
254 /* The bit flags that don't cause gv_fetchpv() to add a symbol if not
255 found (with the exception GV_ADDMG, which *might* cause the symbol
258 #define gv_fullname3(sv,gv,prefix) gv_fullname4(sv,gv,prefix,TRUE)
259 #define gv_efullname3(sv,gv,prefix) gv_efullname4(sv,gv,prefix,TRUE)
260 #define gv_fetchmethod(stash, name) gv_fetchmethod_autoload(stash, name, TRUE)
261 #define gv_fetchsv_nomg(n,f,t) gv_fetchsv(n,(f)|GV_NO_SVGMAGIC,t)
262 #define gv_init(gv,stash,name,len,multi) \
263 gv_init_pvn(gv,stash,name,len,GV_ADDMULTI*!!(multi))
264 #define gv_fetchmeth(stash,name,len,level) gv_fetchmeth_pvn(stash, name, len, level, 0)
265 #define gv_fetchmeth_autoload(stash,name,len,level) gv_fetchmeth_pvn_autoload(stash, name, len, level, 0)
266 #define gv_fetchmethod_flags(stash,name,flags) gv_fetchmethod_pv_flags(stash, name, flags)
267 #define gv_autoload4(stash, name, len, method) \
268 gv_autoload_pvn(stash, name, len, !!(method))
269 #define newGVgen(pack) newGVgen_flags(pack, 0)
270 #define gv_method_changed(gv) \
272 assert_(isGV_with_GP(gv)) \
274 ? (void)++PL_sub_generation \
275 : mro_method_changed_in(GvSTASH(gv)) \
278 #define gv_AVadd(gv) gv_add_by_type((gv), SVt_PVAV)
279 #define gv_HVadd(gv) gv_add_by_type((gv), SVt_PVHV)
280 #define gv_IOadd(gv) gv_add_by_type((gv), SVt_PVIO)
281 #define gv_SVadd(gv) gv_add_by_type((gv), SVt_NULL)
284 * ex: set ts=8 sts=4 sw=4 et: