This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Integrate:
[perl5.git] / gv.h
CommitLineData
a0d0e21e 1/* gv.h
79072805 2 *
4bb101f2 3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
acde74e1 4 * 2000, 2001, 2002, 2003, 2004, 2005, 2006, 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 */
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 */
aa689395 17 HV * gp_hv; /* hash value */
79072805
LW
18 GV * gp_egv; /* effective gv, if *glob */
19 CV * gp_cv; /* subroutine value */
463ee0b2 20 U32 gp_cvgen; /* generational validity of cached gv_cv */
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) \
76f523e8 30 (*({GV *const shplep = (GV *) (gv); \
d4c19fe8 31 assert(SvTYPE(shplep) == SVt_PVGV || SvTYPE(shplep) == SVt_PVLV); \
dedf8e73
NC
32 assert(isGV_with_GP(shplep)); \
33 &((shplep)->sv_u.svu_gp);}))
34# define GvFLAGS(gv) \
76f523e8 35 (*({GV *const yaah = (GV *) (gv); \
dedf8e73
NC
36 assert(SvTYPE(yaah) == SVt_PVGV || SvTYPE(yaah) == SVt_PVLV); \
37 assert(isGV_with_GP(yaah)); \
5526b5b3 38 &(GvXPVGV(yaah)->xpv_cur);}))
c72c5e99 39# define GvSTASH(gv) \
dd3874d7 40 (*({ GV * const _gv = (GV *) (gv); \
dedf8e73 41 assert(isGV_with_GP(_gv)); \
c72c5e99 42 assert(SvTYPE(_gv) == SVt_PVGV || SvTYPE(_gv) >= SVt_PVLV); \
58430790 43 &(GvXPVGV(_gv)->xnv_u.xgv_stash); \
c72c5e99 44 }))
acda4c6a
NC
45# define GvNAME_HEK(gv) \
46 (*({ GV * const zzzz = (GV *) (gv); \
f5c1e807
NC
47 assert(isGV_with_GP(zzzz)); \
48 assert(SvTYPE(zzzz) == SVt_PVGV || SvTYPE(zzzz) >= SVt_PVLV); \
85ffbbb0 49 assert(!SvVALID(zzzz)); \
69ecfd12 50 &(GvXPVGV(zzzz)->xiv_u.xivu_namehek); \
acda4c6a 51 }))
9f616d01
MHM
52# define GvNAME_get(gv) ({ assert(GvNAME_HEK(gv)); HEK_KEY(GvNAME_HEK(gv)); })
53# define GvNAMELEN_get(gv) ({ assert(GvNAME_HEK(gv)); HEK_LEN(GvNAME_HEK(gv)); })
c72c5e99 54#else
dedf8e73 55# define GvGP(gv) ((gv)->sv_u.svu_gp)
5526b5b3 56# define GvFLAGS(gv) (GvXPVGV(gv)->xpv_cur)
58430790 57# define GvSTASH(gv) (GvXPVGV(gv)->xnv_u.xgv_stash)
274ac62a 58# define GvNAME_HEK(gv) (GvXPVGV(gv)->xiv_u.xivu_namehek)
9f616d01
MHM
59# define GvNAME_get(gv) HEK_KEY(GvNAME_HEK(gv))
60# define GvNAMELEN_get(gv) HEK_LEN(GvNAME_HEK(gv))
c72c5e99 61#endif
dedf8e73 62
f5c1e807
NC
63#define GvNAME(gv) GvNAME_get(gv)
64#define GvNAMELEN(gv) GvNAMELEN_get(gv)
65
08002bbf 66#define GvASSIGN_GENERATION(gv) (0 + ((XPV*) SvANY(gv))->xpv_len)
169d2d72
NC
67#define GvASSIGN_GENERATION_set(gv,val) \
68 STMT_START { assert(SvTYPE(gv) == SVt_PVGV); \
08002bbf 69 (((XPV*) SvANY(gv))->xpv_len = (val)); } STMT_END
169d2d72 70
954c1994 71/*
ccfc67b7
JH
72=head1 GV Functions
73
954c1994
GS
74=for apidoc Am|SV*|GvSV|GV* gv
75
76Return the SV from the GV.
77
78=cut
79*/
80
79072805 81#define GvSV(gv) (GvGP(gv)->gp_sv)
c69033f2 82#ifdef PERL_DONT_CREATE_GVSV
547f15c3
NC
83#define GvSVn(gv) (*(GvGP(gv)->gp_sv ? \
84 &(GvGP(gv)->gp_sv) : \
85 &(GvGP(gv_SVadd(gv))->gp_sv)))
c69033f2
NC
86#else
87#define GvSVn(gv) GvSV(gv)
88#endif
89
79072805 90#define GvREFCNT(gv) (GvGP(gv)->gp_refcnt)
2035c5e8 91#define GvIO(gv) ((gv) && SvTYPE((SV*)gv) == SVt_PVGV && GvGP(gv) ? GvIOp(gv) : 0)
a0d0e21e
LW
92#define GvIOp(gv) (GvGP(gv)->gp_io)
93#define GvIOn(gv) (GvIO(gv) ? GvIOp(gv) : GvIOp(gv_IOadd(gv)))
79072805
LW
94
95#define GvFORM(gv) (GvGP(gv)->gp_form)
96#define GvAV(gv) (GvGP(gv)->gp_av)
44a8e56a
PP
97
98/* This macro is deprecated. Do not use! */
99#define GvREFCNT_inc(gv) ((GV*)SvREFCNT_inc(gv)) /* DO NOT USE */
79072805 100
79072805
LW
101#define GvAVn(gv) (GvGP(gv)->gp_av ? \
102 GvGP(gv)->gp_av : \
103 GvGP(gv_AVadd(gv))->gp_av)
79072805
LW
104#define GvHV(gv) ((GvGP(gv))->gp_hv)
105
79072805
LW
106#define GvHVn(gv) (GvGP(gv)->gp_hv ? \
107 GvGP(gv)->gp_hv : \
108 GvGP(gv_HVadd(gv))->gp_hv)
79072805
LW
109
110#define GvCV(gv) (GvGP(gv)->gp_cv)
463ee0b2 111#define GvCVGEN(gv) (GvGP(gv)->gp_cvgen)
601f1833 112#define GvCVu(gv) (GvGP(gv)->gp_cvgen ? NULL : GvGP(gv)->gp_cv)
79072805 113
79072805 114#define GvLINE(gv) (GvGP(gv)->gp_line)
f4890806 115#define GvFILE_HEK(gv) (GvGP(gv)->gp_file_hek)
5be41be4 116#define GvFILE(gv) (GvFILE_HEK(gv) ? HEK_KEY(GvFILE_HEK(gv)) : NULL)
57843af0 117#define GvFILEGV(gv) (gv_fetchfile(GvFILE(gv)))
79072805 118
79072805 119#define GvEGV(gv) (GvGP(gv)->gp_egv)
748a9306 120#define GvENAME(gv) GvNAME(GvEGV(gv) ? GvEGV(gv) : gv)
748a9306 121#define GvESTASH(gv) GvSTASH(GvEGV(gv) ? GvEGV(gv) : gv)
79072805 122
a5f75d66
AD
123#define GVf_INTRO 0x01
124#define GVf_MULTI 0x02
125#define GVf_ASSUMECV 0x04
743e66e6 126#define GVf_IN_PAD 0x08
a5f75d66
AD
127#define GVf_IMPORTED 0xF0
128#define GVf_IMPORTED_SV 0x10
129#define GVf_IMPORTED_AV 0x20
130#define GVf_IMPORTED_HV 0x40
131#define GVf_IMPORTED_CV 0x80
132
133#define GvINTRO(gv) (GvFLAGS(gv) & GVf_INTRO)
134#define GvINTRO_on(gv) (GvFLAGS(gv) |= GVf_INTRO)
135#define GvINTRO_off(gv) (GvFLAGS(gv) &= ~GVf_INTRO)
136
137#define GvMULTI(gv) (GvFLAGS(gv) & GVf_MULTI)
138#define GvMULTI_on(gv) (GvFLAGS(gv) |= GVf_MULTI)
139#define GvMULTI_off(gv) (GvFLAGS(gv) &= ~GVf_MULTI)
140
141#define GvASSUMECV(gv) (GvFLAGS(gv) & GVf_ASSUMECV)
142#define GvASSUMECV_on(gv) (GvFLAGS(gv) |= GVf_ASSUMECV)
143#define GvASSUMECV_off(gv) (GvFLAGS(gv) &= ~GVf_ASSUMECV)
144
145#define GvIMPORTED(gv) (GvFLAGS(gv) & GVf_IMPORTED)
146#define GvIMPORTED_on(gv) (GvFLAGS(gv) |= GVf_IMPORTED)
147#define GvIMPORTED_off(gv) (GvFLAGS(gv) &= ~GVf_IMPORTED)
148
149#define GvIMPORTED_SV(gv) (GvFLAGS(gv) & GVf_IMPORTED_SV)
150#define GvIMPORTED_SV_on(gv) (GvFLAGS(gv) |= GVf_IMPORTED_SV)
151#define GvIMPORTED_SV_off(gv) (GvFLAGS(gv) &= ~GVf_IMPORTED_SV)
152
153#define GvIMPORTED_AV(gv) (GvFLAGS(gv) & GVf_IMPORTED_AV)
154#define GvIMPORTED_AV_on(gv) (GvFLAGS(gv) |= GVf_IMPORTED_AV)
155#define GvIMPORTED_AV_off(gv) (GvFLAGS(gv) &= ~GVf_IMPORTED_AV)
156
157#define GvIMPORTED_HV(gv) (GvFLAGS(gv) & GVf_IMPORTED_HV)
158#define GvIMPORTED_HV_on(gv) (GvFLAGS(gv) |= GVf_IMPORTED_HV)
159#define GvIMPORTED_HV_off(gv) (GvFLAGS(gv) &= ~GVf_IMPORTED_HV)
160
161#define GvIMPORTED_CV(gv) (GvFLAGS(gv) & GVf_IMPORTED_CV)
162#define GvIMPORTED_CV_on(gv) (GvFLAGS(gv) |= GVf_IMPORTED_CV)
163#define GvIMPORTED_CV_off(gv) (GvFLAGS(gv) &= ~GVf_IMPORTED_CV)
164
743e66e6
GS
165#define GvIN_PAD(gv) (GvFLAGS(gv) & GVf_IN_PAD)
166#define GvIN_PAD_on(gv) (GvFLAGS(gv) |= GVf_IN_PAD)
167#define GvIN_PAD_off(gv) (GvFLAGS(gv) &= ~GVf_IN_PAD)
168
49c0300d 169#define GvUNIQUE(gv) 0
6f207bd3
AL
170#define GvUNIQUE_on(gv) NOOP
171#define GvUNIQUE_off(gv) NOOP
5bd07a3d
DM
172
173#ifdef USE_ITHREADS
7fb37951 174#define GV_UNIQUE_CHECK
5bd07a3d 175#else
7fb37951 176#undef GV_UNIQUE_CHECK
5bd07a3d
DM
177#endif
178
79072805
LW
179#define Nullgv Null(GV*)
180
181#define DM_UID 0x003
182#define DM_RUID 0x001
183#define DM_EUID 0x002
184#define DM_GID 0x030
185#define DM_RGID 0x010
186#define DM_EGID 0x020
187#define DM_DELAY 0x100
188
0f303493 189/*
864dbfa3 190 * symbol creation flags, for use in gv_fetchpv() and get_*v()
0f303493 191 */
ae8cc45f
NC
192#define GV_ADD 0x01 /* add, if symbol not already there
193 For gv_name_set, adding a HEK for the first
194 time, so don't try to free what's there. */
0f303493
GS
195#define GV_ADDMULTI 0x02 /* add, pretending it has been added already */
196#define GV_ADDWARN 0x04 /* add, but warn if symbol wasn't already there */
197#define GV_ADDINEVAL 0x08 /* add, as though we're doing so within an eval */
198#define GV_NOINIT 0x10 /* add, but don't init symbol, if type != PVGV */
add2581e
NC
199/* This is used by toke.c to avoid turing placeholder constants in the symbol
200 table into full PVGVs with attached constant subroutines. */
201#define GV_NOADD_NOINIT 0x20 /* Don't add the symbol if it's not there.
202 Don't init it if it is there but ! PVGV */
e26df76a 203#define GV_NOEXPAND 0x40 /* Don't expand SvOK() entries to PVGV */
fafc274c
NC
204#define GV_NOTQUAL 0x80 /* A plain symbol name, not qualified with a
205 package (so skip checks for :: and ') */
add2581e 206
7a5fd60d
NC
207/* SVf_UTF8 (more accurately the return value from SvUTF8) is also valid
208 as a flag to gv_fetch_pvn_flags, so ensure it lies outside this range.
209*/
780a5241
NC
210
211#define GV_NOADD_MASK (SVf_UTF8|GV_NOADD_NOINIT|GV_NOEXPAND|GV_NOTQUAL)
212/* The bit flags that don't cause gv_fetchpv() to add a symbol if not found */
213
d9a22066
NC
214#define gv_fullname3(sv,gv,prefix) gv_fullname4(sv,gv,prefix,TRUE)
215#define gv_efullname3(sv,gv,prefix) gv_efullname4(sv,gv,prefix,TRUE)
887986eb 216#define gv_fetchmethod(stash, name) gv_fetchmethod_autoload(stash, name, TRUE)
f4890806
NC
217
218/*
219 * Local variables:
220 * c-indentation-style: bsd
221 * c-basic-offset: 4
222 * indent-tabs-mode: t
223 * End:
224 *
225 * ex: set ts=8 sts=4 sw=4 noet:
226 */