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 gv_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 line_t gp_line; /* line first declared at (for -w) */
22 HEK * gp_file_hek; /* file first declared in (for -w) */
25 #define GvXPVGV(gv) ((XPVGV*)SvANY(gv))
28 #if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN) && !defined(__INTEL_COMPILER)
30 (0+(*({GV *const _gvgp = (GV *) (gv); \
31 assert(SvTYPE(_gvgp) == SVt_PVGV || SvTYPE(_gvgp) == SVt_PVLV); \
32 assert(isGV_with_GP(_gvgp)); \
33 &((_gvgp)->sv_u.svu_gp);})))
34 # define GvGP_set(gv,gp) \
35 {GV *const _gvgp = (GV *) (gv); \
36 assert(SvTYPE(_gvgp) == SVt_PVGV || SvTYPE(_gvgp) == SVt_PVLV); \
37 assert(isGV_with_GP(_gvgp)); \
38 (_gvgp)->sv_u.svu_gp = (gp); }
39 # define GvFLAGS(gv) \
40 (*({GV *const _gvflags = (GV *) (gv); \
41 assert(SvTYPE(_gvflags) == SVt_PVGV || SvTYPE(_gvflags) == SVt_PVLV); \
42 assert(isGV_with_GP(_gvflags)); \
43 &(GvXPVGV(_gvflags)->xpv_cur);}))
44 # define GvSTASH(gv) \
45 (*({ GV * const _gvstash = (GV *) (gv); \
46 assert(isGV_with_GP(_gvstash)); \
47 assert(SvTYPE(_gvstash) == SVt_PVGV || SvTYPE(_gvstash) >= SVt_PVLV); \
48 &(GvXPVGV(_gvstash)->xnv_u.xgv_stash); \
50 # define GvNAME_HEK(gv) \
51 (*({ GV * const _gvname_hek = (GV *) (gv); \
52 assert(isGV_with_GP(_gvname_hek)); \
53 assert(SvTYPE(_gvname_hek) == SVt_PVGV || SvTYPE(_gvname_hek) >= SVt_PVLV); \
54 assert(!SvVALID(_gvname_hek)); \
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)); })
60 # define GvGP(gv) (0+(gv)->sv_u.svu_gp)
61 # define GvGP_set(gv,gp) ((gv)->sv_u.svu_gp = (gp))
62 # define GvFLAGS(gv) (GvXPVGV(gv)->xpv_cur)
63 # define GvSTASH(gv) (GvXPVGV(gv)->xnv_u.xgv_stash)
64 # define GvNAME_HEK(gv) (GvXPVGV(gv)->xiv_u.xivu_namehek)
65 # define GvNAME_get(gv) HEK_KEY(GvNAME_HEK(gv))
66 # define GvNAMELEN_get(gv) HEK_LEN(GvNAME_HEK(gv))
69 #define GvNAME(gv) GvNAME_get(gv)
70 #define GvNAMELEN(gv) GvNAMELEN_get(gv)
72 #define GvASSIGN_GENERATION(gv) (0 + ((XPV*) SvANY(gv))->xpv_len)
73 #define GvASSIGN_GENERATION_set(gv,val) \
74 STMT_START { assert(SvTYPE(gv) == SVt_PVGV); \
75 (((XPV*) SvANY(gv))->xpv_len = (val)); } STMT_END
80 =for apidoc Am|SV*|GvSV|GV* gv
82 Return the SV from the GV.
87 #define GvSV(gv) (GvGP(gv)->gp_sv)
88 #ifdef PERL_DONT_CREATE_GVSV
89 #define GvSVn(gv) (*(GvGP(gv)->gp_sv ? \
90 &(GvGP(gv)->gp_sv) : \
91 &(GvGP(gv_SVadd(gv))->gp_sv)))
93 #define GvSVn(gv) GvSV(gv)
96 #define GvREFCNT(gv) (GvGP(gv)->gp_refcnt)
101 SvTYPE((const SV*)(gv)) == SVt_PVGV \
102 || SvTYPE((const SV*)(gv)) == SVt_PVLV \
108 #define GvIOp(gv) (GvGP(gv)->gp_io)
109 #define GvIOn(gv) (GvIO(gv) ? GvIOp(gv) : GvIOp(gv_IOadd(gv)))
111 #define GvFORM(gv) (GvGP(gv)->gp_form)
112 #define GvAV(gv) (GvGP(gv)->gp_av)
114 #define GvAVn(gv) (GvGP(gv)->gp_av ? \
116 GvGP(gv_AVadd(gv))->gp_av)
117 #define GvHV(gv) ((GvGP(gv))->gp_hv)
119 #define GvHVn(gv) (GvGP(gv)->gp_hv ? \
121 GvGP(gv_HVadd(gv))->gp_hv)
123 #define GvCV(gv) (0+GvGP(gv)->gp_cv)
124 #define GvCV_set(gv,cv) (GvGP(gv)->gp_cv = (cv))
125 #define GvCVGEN(gv) (GvGP(gv)->gp_cvgen)
126 #define GvCVu(gv) (GvGP(gv)->gp_cvgen ? NULL : GvGP(gv)->gp_cv)
128 #define GvLINE(gv) (GvGP(gv)->gp_line)
129 #define GvFILE_HEK(gv) (GvGP(gv)->gp_file_hek)
130 #define GvFILE(gv) (GvFILE_HEK(gv) ? HEK_KEY(GvFILE_HEK(gv)) : NULL)
131 #define GvFILEGV(gv) (gv_fetchfile(GvFILE(gv)))
133 #define GvEGV(gv) (GvGP(gv)->gp_egv)
134 #define GvEGVx(gv) (isGV_with_GP(gv) ? GvEGV(gv) : NULL)
135 #define GvENAME(gv) GvNAME(GvEGV(gv) ? GvEGV(gv) : gv)
136 #define GvESTASH(gv) GvSTASH(GvEGV(gv) ? GvEGV(gv) : gv)
138 #define GVf_INTRO 0x01
139 #define GVf_MULTI 0x02
140 #define GVf_ASSUMECV 0x04
141 #define GVf_IN_PAD 0x08
142 #define GVf_IMPORTED 0xF0
143 #define GVf_IMPORTED_SV 0x10
144 #define GVf_IMPORTED_AV 0x20
145 #define GVf_IMPORTED_HV 0x40
146 #define GVf_IMPORTED_CV 0x80
148 #define GvINTRO(gv) (GvFLAGS(gv) & GVf_INTRO)
149 #define GvINTRO_on(gv) (GvFLAGS(gv) |= GVf_INTRO)
150 #define GvINTRO_off(gv) (GvFLAGS(gv) &= ~GVf_INTRO)
152 #define GvMULTI(gv) (GvFLAGS(gv) & GVf_MULTI)
153 #define GvMULTI_on(gv) (GvFLAGS(gv) |= GVf_MULTI)
154 #define GvMULTI_off(gv) (GvFLAGS(gv) &= ~GVf_MULTI)
156 #define GvASSUMECV(gv) (GvFLAGS(gv) & GVf_ASSUMECV)
157 #define GvASSUMECV_on(gv) (GvFLAGS(gv) |= GVf_ASSUMECV)
158 #define GvASSUMECV_off(gv) (GvFLAGS(gv) &= ~GVf_ASSUMECV)
160 #define GvIMPORTED(gv) (GvFLAGS(gv) & GVf_IMPORTED)
161 #define GvIMPORTED_on(gv) (GvFLAGS(gv) |= GVf_IMPORTED)
162 #define GvIMPORTED_off(gv) (GvFLAGS(gv) &= ~GVf_IMPORTED)
164 #define GvIMPORTED_SV(gv) (GvFLAGS(gv) & GVf_IMPORTED_SV)
165 #define GvIMPORTED_SV_on(gv) (GvFLAGS(gv) |= GVf_IMPORTED_SV)
166 #define GvIMPORTED_SV_off(gv) (GvFLAGS(gv) &= ~GVf_IMPORTED_SV)
168 #define GvIMPORTED_AV(gv) (GvFLAGS(gv) & GVf_IMPORTED_AV)
169 #define GvIMPORTED_AV_on(gv) (GvFLAGS(gv) |= GVf_IMPORTED_AV)
170 #define GvIMPORTED_AV_off(gv) (GvFLAGS(gv) &= ~GVf_IMPORTED_AV)
172 #define GvIMPORTED_HV(gv) (GvFLAGS(gv) & GVf_IMPORTED_HV)
173 #define GvIMPORTED_HV_on(gv) (GvFLAGS(gv) |= GVf_IMPORTED_HV)
174 #define GvIMPORTED_HV_off(gv) (GvFLAGS(gv) &= ~GVf_IMPORTED_HV)
176 #define GvIMPORTED_CV(gv) (GvFLAGS(gv) & GVf_IMPORTED_CV)
177 #define GvIMPORTED_CV_on(gv) (GvFLAGS(gv) |= GVf_IMPORTED_CV)
178 #define GvIMPORTED_CV_off(gv) (GvFLAGS(gv) &= ~GVf_IMPORTED_CV)
180 #define GvIN_PAD(gv) (GvFLAGS(gv) & GVf_IN_PAD)
181 #define GvIN_PAD_on(gv) (GvFLAGS(gv) |= GVf_IN_PAD)
182 #define GvIN_PAD_off(gv) (GvFLAGS(gv) &= ~GVf_IN_PAD)
185 # define Nullgv Null(GV*)
188 #define DM_RUID 0x001
189 #define DM_EUID 0x002
190 #define DM_UID (DM_RUID|DM_EUID)
191 #define DM_ARRAY_ISA 0x004
192 #define DM_RGID 0x010
193 #define DM_EGID 0x020
194 #define DM_GID (DM_RGID|DM_EGID)
195 #define DM_DELAY 0x100
198 * symbol creation flags, for use in gv_fetchpv() and get_*v()
200 #define GV_ADD 0x01 /* add, if symbol not already there
201 For gv_name_set, adding a HEK for the first
202 time, so don't try to free what's there. */
203 #define GV_ADDMULTI 0x02 /* add, pretending it has been added already */
204 #define GV_ADDWARN 0x04 /* add, but warn if symbol wasn't already there */
205 #define GV_ADDINEVAL 0x08 /* add, as though we're doing so within an eval */
206 #define GV_NOINIT 0x10 /* add, but don't init symbol, if type != PVGV */
207 /* This is used by toke.c to avoid turing placeholder constants in the symbol
208 table into full PVGVs with attached constant subroutines. */
209 #define GV_NOADD_NOINIT 0x20 /* Don't add the symbol if it's not there.
210 Don't init it if it is there but ! PVGV */
211 #define GV_NOEXPAND 0x40 /* Don't expand SvOK() entries to PVGV */
212 #define GV_NOTQUAL 0x80 /* A plain symbol name, not qualified with a
213 package (so skip checks for :: and ') */
214 #define GV_AUTOLOAD 0x100 /* gv_fetchmethod_flags() should AUTOLOAD */
215 #define GV_CROAK 0x200 /* gv_fetchmethod_flags() should croak */
216 #define GV_ADDMG 0x400 /* add if magical */
217 #define GV_NO_SVGMAGIC 0x800 /* Skip get-magic on an SV argument;
218 used only by gv_fetchsv(_nomg) */
220 /* SVf_UTF8 (more accurately the return value from SvUTF8) is also valid
221 as a flag to gv_fetch_pvn_flags, so ensure it lies outside this range.
224 #define GV_NOADD_MASK \
225 (SVf_UTF8|GV_NOADD_NOINIT|GV_NOEXPAND|GV_NOTQUAL|GV_ADDMG|GV_NO_SVGMAGIC)
226 /* The bit flags that don't cause gv_fetchpv() to add a symbol if not
227 found (with the exception GV_ADDMG, which *might* cause the symbol
230 #define gv_fullname3(sv,gv,prefix) gv_fullname4(sv,gv,prefix,TRUE)
231 #define gv_efullname3(sv,gv,prefix) gv_efullname4(sv,gv,prefix,TRUE)
232 #define gv_fetchmethod(stash, name) gv_fetchmethod_autoload(stash, name, TRUE)
233 #define gv_fetchsv_nomg(n,f,t) gv_fetchsv(n,(f)|GV_NO_SVGMAGIC,t)
235 #define gv_AVadd(gv) gv_add_by_type((gv), SVt_PVAV)
236 #define gv_HVadd(gv) gv_add_by_type((gv), SVt_PVHV)
237 #define gv_IOadd(gv) gv_add_by_type((gv), SVt_PVIO)
238 #define gv_SVadd(gv) gv_add_by_type((gv), SVt_NULL)
242 * c-indentation-style: bsd
244 * indent-tabs-mode: t
247 * ex: set ts=8 sts=4 sw=4 noet: