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