This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Skip no-common-vars optimisation for aliases
[perl5.git] / gv.h
CommitLineData
a0d0e21e 1/* gv.h
79072805 2 *
1129b882
NC
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
79072805
LW
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 *
79072805
LW
9 */
10
11struct gp {
12 SV * gp_sv; /* scalar value */
79072805 13 struct io * gp_io; /* filehandle value */
79072805 14 CV * gp_cv; /* subroutine value */
5d855216 15 U32 gp_cvgen; /* generational validity of cached gp_cv */
9bd87817
NC
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 */
79072805 21 line_t gp_line; /* line first declared at (for -w) */
4a8cd1ba 22 U32 gp_flags;
f4890806 23 HEK * gp_file_hek; /* file first declared in (for -w) */
79072805
LW
24};
25
79072805
LW
26#define GvXPVGV(gv) ((XPVGV*)SvANY(gv))
27
a5f75d66 28
e51a6fb1 29#if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN) && !defined(__INTEL_COMPILER)
dedf8e73 30# define GvGP(gv) \
c43ae56f 31 (0+(*({GV *const _gvgp = (GV *) (gv); \
603aa20d
RU
32 assert(SvTYPE(_gvgp) == SVt_PVGV || SvTYPE(_gvgp) == SVt_PVLV); \
33 assert(isGV_with_GP(_gvgp)); \
c43ae56f
DM
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); }
dedf8e73 40# define GvFLAGS(gv) \
603aa20d
RU
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);}))
c72c5e99 45# define GvSTASH(gv) \
603aa20d
RU
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); \
c72c5e99 50 }))
acda4c6a 51# define GvNAME_HEK(gv) \
603aa20d
RU
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 assert(!SvVALID(_gvname_hek)); \
56 &(GvXPVGV(_gvname_hek)->xiv_u.xivu_namehek); \
acda4c6a 57 }))
1404b487 58# define GvNAME_get(gv) ({ assert(GvNAME_HEK(gv)); (char *)HEK_KEY(GvNAME_HEK(gv)); })
9f616d01 59# define GvNAMELEN_get(gv) ({ assert(GvNAME_HEK(gv)); HEK_LEN(GvNAME_HEK(gv)); })
b2c03ebd 60# define GvNAMEUTF8(gv) ({ assert(GvNAME_HEK(gv)); HEK_UTF8(GvNAME_HEK(gv)); })
c72c5e99 61#else
c43ae56f
DM
62# define GvGP(gv) (0+(gv)->sv_u.svu_gp)
63# define GvGP_set(gv,gp) ((gv)->sv_u.svu_gp = (gp))
5526b5b3 64# define GvFLAGS(gv) (GvXPVGV(gv)->xpv_cur)
58430790 65# define GvSTASH(gv) (GvXPVGV(gv)->xnv_u.xgv_stash)
274ac62a 66# define GvNAME_HEK(gv) (GvXPVGV(gv)->xiv_u.xivu_namehek)
9f616d01
MHM
67# define GvNAME_get(gv) HEK_KEY(GvNAME_HEK(gv))
68# define GvNAMELEN_get(gv) HEK_LEN(GvNAME_HEK(gv))
b2c03ebd 69# define GvNAMEUTF8(gv) HEK_UTF8(GvNAME_HEK(gv))
c72c5e99 70#endif
dedf8e73 71
f5c1e807
NC
72#define GvNAME(gv) GvNAME_get(gv)
73#define GvNAMELEN(gv) GvNAMELEN_get(gv)
74
08002bbf 75#define GvASSIGN_GENERATION(gv) (0 + ((XPV*) SvANY(gv))->xpv_len)
169d2d72
NC
76#define GvASSIGN_GENERATION_set(gv,val) \
77 STMT_START { assert(SvTYPE(gv) == SVt_PVGV); \
08002bbf 78 (((XPV*) SvANY(gv))->xpv_len = (val)); } STMT_END
169d2d72 79
954c1994 80/*
ccfc67b7
JH
81=head1 GV Functions
82
954c1994
GS
83=for apidoc Am|SV*|GvSV|GV* gv
84
85Return the SV from the GV.
86
b019ef6e
JL
87=for apidoc Am|AV*|GvAV|GV* gv
88
89Return the AV from the GV.
90
91=for apidoc Am|HV*|GvHV|GV* gv
92
93Return the HV from the GV.
94
95=for apidoc Am|CV*|GvCV|GV* gv
96
97Return the CV from the GV.
98
954c1994
GS
99=cut
100*/
101
79072805 102#define GvSV(gv) (GvGP(gv)->gp_sv)
c69033f2 103#ifdef PERL_DONT_CREATE_GVSV
547f15c3
NC
104#define GvSVn(gv) (*(GvGP(gv)->gp_sv ? \
105 &(GvGP(gv)->gp_sv) : \
106 &(GvGP(gv_SVadd(gv))->gp_sv)))
c69033f2
NC
107#else
108#define GvSVn(gv) GvSV(gv)
109#endif
110
79072805 111#define GvREFCNT(gv) (GvGP(gv)->gp_refcnt)
13be902c
FC
112#define GvIO(gv) \
113 ( \
114 (gv) \
115 && ( \
116 SvTYPE((const SV*)(gv)) == SVt_PVGV \
117 || SvTYPE((const SV*)(gv)) == SVt_PVLV \
118 ) \
119 && GvGP(gv) \
120 ? GvIOp(gv) \
121 : NULL \
122 )
a0d0e21e
LW
123#define GvIOp(gv) (GvGP(gv)->gp_io)
124#define GvIOn(gv) (GvIO(gv) ? GvIOp(gv) : GvIOp(gv_IOadd(gv)))
79072805
LW
125
126#define GvFORM(gv) (GvGP(gv)->gp_form)
127#define GvAV(gv) (GvGP(gv)->gp_av)
44a8e56a 128
79072805
LW
129#define GvAVn(gv) (GvGP(gv)->gp_av ? \
130 GvGP(gv)->gp_av : \
131 GvGP(gv_AVadd(gv))->gp_av)
79072805
LW
132#define GvHV(gv) ((GvGP(gv))->gp_hv)
133
79072805
LW
134#define GvHVn(gv) (GvGP(gv)->gp_hv ? \
135 GvGP(gv)->gp_hv : \
136 GvGP(gv_HVadd(gv))->gp_hv)
79072805 137
c43ae56f
DM
138#define GvCV(gv) (0+GvGP(gv)->gp_cv)
139#define GvCV_set(gv,cv) (GvGP(gv)->gp_cv = (cv))
463ee0b2 140#define GvCVGEN(gv) (GvGP(gv)->gp_cvgen)
601f1833 141#define GvCVu(gv) (GvGP(gv)->gp_cvgen ? NULL : GvGP(gv)->gp_cv)
79072805 142
4a8cd1ba
FC
143#define GvGPFLAGS(gv) (GvGP(gv)->gp_flags)
144
79072805 145#define GvLINE(gv) (GvGP(gv)->gp_line)
f4890806 146#define GvFILE_HEK(gv) (GvGP(gv)->gp_file_hek)
c835650e
DM
147#define GvFILEx(gv) HEK_KEY(GvFILE_HEK(gv))
148#define GvFILE(gv) (GvFILE_HEK(gv) ? GvFILEx(gv) : NULL)
149#define GvFILEGV(gv) (GvFILE_HEK(gv) ? gv_fetchfile(GvFILEx(gv)) : NULL)
79072805 150
79072805 151#define GvEGV(gv) (GvGP(gv)->gp_egv)
099be4f1 152#define GvEGVx(gv) (isGV_with_GP(gv) ? GvEGV(gv) : NULL)
748a9306 153#define GvENAME(gv) GvNAME(GvEGV(gv) ? GvEGV(gv) : gv)
f2462604
BF
154#define GvENAMELEN(gv) GvNAMELEN(GvEGV(gv) ? GvEGV(gv) : gv)
155#define GvENAMEUTF8(gv) GvNAMEUTF8(GvEGV(gv) ? GvEGV(gv) : gv)
156#define GvENAME_HEK(gv) GvNAME_HEK(GvEGV(gv) ? GvEGV(gv) : gv)
748a9306 157#define GvESTASH(gv) GvSTASH(GvEGV(gv) ? GvEGV(gv) : gv)
79072805 158
a5f75d66
AD
159#define GVf_INTRO 0x01
160#define GVf_MULTI 0x02
161#define GVf_ASSUMECV 0x04
a5bc03e9 162/* UNUSED 0x08 */
a5f75d66
AD
163#define GVf_IMPORTED 0xF0
164#define GVf_IMPORTED_SV 0x10
165#define GVf_IMPORTED_AV 0x20
166#define GVf_IMPORTED_HV 0x40
167#define GVf_IMPORTED_CV 0x80
168
169#define GvINTRO(gv) (GvFLAGS(gv) & GVf_INTRO)
170#define GvINTRO_on(gv) (GvFLAGS(gv) |= GVf_INTRO)
171#define GvINTRO_off(gv) (GvFLAGS(gv) &= ~GVf_INTRO)
172
173#define GvMULTI(gv) (GvFLAGS(gv) & GVf_MULTI)
174#define GvMULTI_on(gv) (GvFLAGS(gv) |= GVf_MULTI)
175#define GvMULTI_off(gv) (GvFLAGS(gv) &= ~GVf_MULTI)
176
177#define GvASSUMECV(gv) (GvFLAGS(gv) & GVf_ASSUMECV)
178#define GvASSUMECV_on(gv) (GvFLAGS(gv) |= GVf_ASSUMECV)
179#define GvASSUMECV_off(gv) (GvFLAGS(gv) &= ~GVf_ASSUMECV)
180
181#define GvIMPORTED(gv) (GvFLAGS(gv) & GVf_IMPORTED)
182#define GvIMPORTED_on(gv) (GvFLAGS(gv) |= GVf_IMPORTED)
183#define GvIMPORTED_off(gv) (GvFLAGS(gv) &= ~GVf_IMPORTED)
184
185#define GvIMPORTED_SV(gv) (GvFLAGS(gv) & GVf_IMPORTED_SV)
186#define GvIMPORTED_SV_on(gv) (GvFLAGS(gv) |= GVf_IMPORTED_SV)
187#define GvIMPORTED_SV_off(gv) (GvFLAGS(gv) &= ~GVf_IMPORTED_SV)
188
189#define GvIMPORTED_AV(gv) (GvFLAGS(gv) & GVf_IMPORTED_AV)
190#define GvIMPORTED_AV_on(gv) (GvFLAGS(gv) |= GVf_IMPORTED_AV)
191#define GvIMPORTED_AV_off(gv) (GvFLAGS(gv) &= ~GVf_IMPORTED_AV)
192
193#define GvIMPORTED_HV(gv) (GvFLAGS(gv) & GVf_IMPORTED_HV)
194#define GvIMPORTED_HV_on(gv) (GvFLAGS(gv) |= GVf_IMPORTED_HV)
195#define GvIMPORTED_HV_off(gv) (GvFLAGS(gv) &= ~GVf_IMPORTED_HV)
196
197#define GvIMPORTED_CV(gv) (GvFLAGS(gv) & GVf_IMPORTED_CV)
198#define GvIMPORTED_CV_on(gv) (GvFLAGS(gv) |= GVf_IMPORTED_CV)
199#define GvIMPORTED_CV_off(gv) (GvFLAGS(gv) &= ~GVf_IMPORTED_CV)
200
ff2a62e0
FC
201#define GPf_ALIASED_SV 1
202
203#define GvALIASED_SV(gv) (GvGPFLAGS(gv) & GPf_ALIASED_SV)
204#define GvALIASED_SV_on(gv) (GvGPFLAGS(gv) |= GPf_ALIASED_SV)
205#define GvALIASED_SV_off(gv) (GvGPFLAGS(gv) &= ~GPf_ALIASED_SV)
206
3ae1b226 207#ifndef PERL_CORE
a5bc03e9
FC
208# define GvIN_PAD(gv) 0
209# define GvIN_PAD_on(gv) NOOP
210# define GvIN_PAD_off(gv) NOOP
3ae1b226
NC
211# define Nullgv Null(GV*)
212#endif
79072805 213
613a9ec2
DM
214#define DM_RUID 0x001
215#define DM_EUID 0x002
6ca8229d 216#define DM_UID (DM_RUID|DM_EUID)
354b0578 217#define DM_ARRAY_ISA 0x004
613a9ec2
DM
218#define DM_RGID 0x010
219#define DM_EGID 0x020
6ca8229d 220#define DM_GID (DM_RGID|DM_EGID)
613a9ec2 221#define DM_DELAY 0x100
79072805 222
0f303493 223/*
864dbfa3 224 * symbol creation flags, for use in gv_fetchpv() and get_*v()
0f303493 225 */
ae8cc45f
NC
226#define GV_ADD 0x01 /* add, if symbol not already there
227 For gv_name_set, adding a HEK for the first
228 time, so don't try to free what's there. */
04ec7e59
FC
229#define GV_ADDMULTI 0x02 /* add, pretending it has been added
230 already; used also by gv_init_* */
0f303493 231#define GV_ADDWARN 0x04 /* add, but warn if symbol wasn't already there */
4bff32c5 232 /* 0x08 UNUSED */
0f303493 233#define GV_NOINIT 0x10 /* add, but don't init symbol, if type != PVGV */
add2581e
NC
234/* This is used by toke.c to avoid turing placeholder constants in the symbol
235 table into full PVGVs with attached constant subroutines. */
236#define GV_NOADD_NOINIT 0x20 /* Don't add the symbol if it's not there.
237 Don't init it if it is there but ! PVGV */
e26df76a 238#define GV_NOEXPAND 0x40 /* Don't expand SvOK() entries to PVGV */
fafc274c
NC
239#define GV_NOTQUAL 0x80 /* A plain symbol name, not qualified with a
240 package (so skip checks for :: and ') */
256d1bb2
NC
241#define GV_AUTOLOAD 0x100 /* gv_fetchmethod_flags() should AUTOLOAD */
242#define GV_CROAK 0x200 /* gv_fetchmethod_flags() should croak */
23496c6e 243#define GV_ADDMG 0x400 /* add if magical */
77cb3b01
FC
244#define GV_NO_SVGMAGIC 0x800 /* Skip get-magic on an SV argument;
245 used only by gv_fetchsv(_nomg) */
d283e876 246#define GV_CACHE_ONLY 0x1000 /* return stash only if found in cache;
247 used only in flags parameter to gv_stash* family */
add2581e 248
aae43805
FC
249/* Flags for gv_fetchmeth_pvn and gv_autoload_pvn*/
250#define GV_SUPER 0x1000 /* SUPER::method */
251
0eeb01b9
FC
252/* Flags for gv_autoload_*/
253#define GV_AUTOLOAD_ISMETHOD 1 /* autoloading a method? */
254
7a5fd60d 255/* SVf_UTF8 (more accurately the return value from SvUTF8) is also valid
04ec7e59 256 as a flag to various gv_* functions, so ensure it lies
0eeb01b9 257 outside this range.
7a5fd60d 258*/
780a5241 259
23496c6e 260#define GV_NOADD_MASK \
77cb3b01 261 (SVf_UTF8|GV_NOADD_NOINIT|GV_NOEXPAND|GV_NOTQUAL|GV_ADDMG|GV_NO_SVGMAGIC)
23496c6e
FC
262/* The bit flags that don't cause gv_fetchpv() to add a symbol if not
263 found (with the exception GV_ADDMG, which *might* cause the symbol
264 to be added) */
780a5241 265
d9a22066
NC
266#define gv_fullname3(sv,gv,prefix) gv_fullname4(sv,gv,prefix,TRUE)
267#define gv_efullname3(sv,gv,prefix) gv_efullname4(sv,gv,prefix,TRUE)
887986eb 268#define gv_fetchmethod(stash, name) gv_fetchmethod_autoload(stash, name, TRUE)
77cb3b01 269#define gv_fetchsv_nomg(n,f,t) gv_fetchsv(n,(f)|GV_NO_SVGMAGIC,t)
04ec7e59
FC
270#define gv_init(gv,stash,name,len,multi) \
271 gv_init_pvn(gv,stash,name,len,GV_ADDMULTI*!!(multi))
d21989ed
BF
272#define gv_fetchmeth(stash,name,len,level) gv_fetchmeth_pvn(stash, name, len, level, 0)
273#define gv_fetchmeth_autoload(stash,name,len,level) gv_fetchmeth_pvn_autoload(stash, name, len, level, 0)
44130a26 274#define gv_fetchmethod_flags(stash,name,flags) gv_fetchmethod_pv_flags(stash, name, flags)
0eeb01b9
FC
275#define gv_autoload4(stash, name, len, method) \
276 gv_autoload_pvn(stash, name, len, !!(method))
9cc50d5b 277#define newGVgen(pack) newGVgen_flags(pack, 0)
978a498e
FC
278#define gv_method_changed(gv) \
279 ( \
280 assert_(isGV_with_GP(gv)) \
281 GvREFCNT(gv) > 1 \
282 ? (void)++PL_sub_generation \
283 : mro_method_changed_in(GvSTASH(gv)) \
284 )
f4890806 285
d5713896
NC
286#define gv_AVadd(gv) gv_add_by_type((gv), SVt_PVAV)
287#define gv_HVadd(gv) gv_add_by_type((gv), SVt_PVHV)
bb85b28a 288#define gv_IOadd(gv) gv_add_by_type((gv), SVt_PVIO)
d5713896
NC
289#define gv_SVadd(gv) gv_add_by_type((gv), SVt_NULL)
290
f4890806
NC
291/*
292 * Local variables:
293 * c-indentation-style: bsd
294 * c-basic-offset: 4
14d04a33 295 * indent-tabs-mode: nil
f4890806
NC
296 * End:
297 *
14d04a33 298 * ex: set ts=8 sts=4 sw=4 et:
f4890806 299 */