3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2003, 2004, 2005, 2006, 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 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 */
17 HV * gp_hv; /* hash value */
18 GV * gp_egv; /* effective gv, if *glob */
19 CV * gp_cv; /* subroutine value */
20 U32 gp_cvgen; /* generational validity of cached gv_cv */
21 U32 gp_flags; /* XXX unused */
22 line_t gp_line; /* line first declared at (for -w) */
23 char * gp_file; /* file first declared in (for -w) */
26 #define GvXPVGV(gv) ((XPVGV*)SvANY(gv))
28 #define GvGP(gv) (GvXPVGV(gv)->xgv_gp)
29 #define GvNAME(gv) (GvXPVGV(gv)->xgv_name)
30 #define GvNAMELEN(gv) (GvXPVGV(gv)->xgv_namelen)
31 #define GvSTASH(gv) (GvXPVGV(gv)->xgv_stash)
32 #define GvFLAGS(gv) (GvXPVGV(gv)->xgv_flags)
34 #define GvNAME_get(gv) (0 + GvXPVGV(gv)->xgv_name)
35 #define GvNAMELEN_get(gv) (0 + GvXPVGV(gv)->xgv_namelen)
36 #define GvASSIGN_GENERATION(gv) (0 + ((XPV*) SvANY(gv))->xpv_cur)
37 #define GvASSIGN_GENERATION_set(gv,val) \
38 STMT_START { assert(SvTYPE(gv) == SVt_PVGV); \
39 (((XPV*) SvANY(gv))->xpv_cur = (val)); } STMT_END
44 =for apidoc Am|SV*|GvSV|GV* gv
46 Return the SV from the GV.
51 #define GvSV(gv) (GvGP(gv)->gp_sv)
52 #ifdef PERL_DONT_CREATE_GVSV
53 #define GvSVn(gv) (*(GvGP(gv)->gp_sv ? \
54 &(GvGP(gv)->gp_sv) : \
55 &(GvGP(gv_SVadd(gv))->gp_sv)))
57 #define GvSVn(gv) GvSV(gv)
60 #define GvREFCNT(gv) (GvGP(gv)->gp_refcnt)
61 #define GvIO(gv) ((gv) && SvTYPE((SV*)gv) == SVt_PVGV && GvGP(gv) ? GvIOp(gv) : 0)
62 #define GvIOp(gv) (GvGP(gv)->gp_io)
63 #define GvIOn(gv) (GvIO(gv) ? GvIOp(gv) : GvIOp(gv_IOadd(gv)))
65 #define GvFORM(gv) (GvGP(gv)->gp_form)
66 #define GvAV(gv) (GvGP(gv)->gp_av)
68 /* This macro is deprecated. Do not use! */
69 #define GvREFCNT_inc(gv) ((GV*)SvREFCNT_inc(gv)) /* DO NOT USE */
71 #define GvAVn(gv) (GvGP(gv)->gp_av ? \
73 GvGP(gv_AVadd(gv))->gp_av)
74 #define GvHV(gv) ((GvGP(gv))->gp_hv)
76 #define GvHVn(gv) (GvGP(gv)->gp_hv ? \
78 GvGP(gv_HVadd(gv))->gp_hv)
80 #define GvCV(gv) (GvGP(gv)->gp_cv)
81 #define GvCVGEN(gv) (GvGP(gv)->gp_cvgen)
82 #define GvCVu(gv) (GvGP(gv)->gp_cvgen ? Nullcv : GvGP(gv)->gp_cv)
84 #define GvGPFLAGS(gv) (GvGP(gv)->gp_flags)
86 #define GvLINE(gv) (GvGP(gv)->gp_line)
87 #define GvFILE(gv) (GvGP(gv)->gp_file)
88 #define GvFILEGV(gv) (gv_fetchfile(GvFILE(gv)))
90 #define GvEGV(gv) (GvGP(gv)->gp_egv)
91 #define GvENAME(gv) GvNAME(GvEGV(gv) ? GvEGV(gv) : gv)
92 #define GvESTASH(gv) GvSTASH(GvEGV(gv) ? GvEGV(gv) : gv)
94 #define GVf_INTRO 0x01
95 #define GVf_MULTI 0x02
96 #define GVf_ASSUMECV 0x04
97 #define GVf_IN_PAD 0x08
98 #define GVf_IMPORTED 0xF0
99 #define GVf_IMPORTED_SV 0x10
100 #define GVf_IMPORTED_AV 0x20
101 #define GVf_IMPORTED_HV 0x40
102 #define GVf_IMPORTED_CV 0x80
104 #define GvINTRO(gv) (GvFLAGS(gv) & GVf_INTRO)
105 #define GvINTRO_on(gv) (GvFLAGS(gv) |= GVf_INTRO)
106 #define GvINTRO_off(gv) (GvFLAGS(gv) &= ~GVf_INTRO)
108 #define GvMULTI(gv) (GvFLAGS(gv) & GVf_MULTI)
109 #define GvMULTI_on(gv) (GvFLAGS(gv) |= GVf_MULTI)
110 #define GvMULTI_off(gv) (GvFLAGS(gv) &= ~GVf_MULTI)
112 #define GvASSUMECV(gv) (GvFLAGS(gv) & GVf_ASSUMECV)
113 #define GvASSUMECV_on(gv) (GvFLAGS(gv) |= GVf_ASSUMECV)
114 #define GvASSUMECV_off(gv) (GvFLAGS(gv) &= ~GVf_ASSUMECV)
116 #define GvIMPORTED(gv) (GvFLAGS(gv) & GVf_IMPORTED)
117 #define GvIMPORTED_on(gv) (GvFLAGS(gv) |= GVf_IMPORTED)
118 #define GvIMPORTED_off(gv) (GvFLAGS(gv) &= ~GVf_IMPORTED)
120 #define GvIMPORTED_SV(gv) (GvFLAGS(gv) & GVf_IMPORTED_SV)
121 #define GvIMPORTED_SV_on(gv) (GvFLAGS(gv) |= GVf_IMPORTED_SV)
122 #define GvIMPORTED_SV_off(gv) (GvFLAGS(gv) &= ~GVf_IMPORTED_SV)
124 #define GvIMPORTED_AV(gv) (GvFLAGS(gv) & GVf_IMPORTED_AV)
125 #define GvIMPORTED_AV_on(gv) (GvFLAGS(gv) |= GVf_IMPORTED_AV)
126 #define GvIMPORTED_AV_off(gv) (GvFLAGS(gv) &= ~GVf_IMPORTED_AV)
128 #define GvIMPORTED_HV(gv) (GvFLAGS(gv) & GVf_IMPORTED_HV)
129 #define GvIMPORTED_HV_on(gv) (GvFLAGS(gv) |= GVf_IMPORTED_HV)
130 #define GvIMPORTED_HV_off(gv) (GvFLAGS(gv) &= ~GVf_IMPORTED_HV)
132 #define GvIMPORTED_CV(gv) (GvFLAGS(gv) & GVf_IMPORTED_CV)
133 #define GvIMPORTED_CV_on(gv) (GvFLAGS(gv) |= GVf_IMPORTED_CV)
134 #define GvIMPORTED_CV_off(gv) (GvFLAGS(gv) &= ~GVf_IMPORTED_CV)
136 #define GvIN_PAD(gv) (GvFLAGS(gv) & GVf_IN_PAD)
137 #define GvIN_PAD_on(gv) (GvFLAGS(gv) |= GVf_IN_PAD)
138 #define GvIN_PAD_off(gv) (GvFLAGS(gv) &= ~GVf_IN_PAD)
140 /* XXX: all GvFLAGS options are used, borrowing GvGPFLAGS for the moment */
142 #define GVf_UNIQUE 0x0001
143 #define GvUNIQUE(gv) (GvGP(gv) && (GvGPFLAGS(gv) & GVf_UNIQUE))
144 #define GvUNIQUE_on(gv) (GvGPFLAGS(gv) |= GVf_UNIQUE)
145 #define GvUNIQUE_off(gv) (GvGPFLAGS(gv) &= ~GVf_UNIQUE)
148 #define GV_UNIQUE_CHECK
150 #undef GV_UNIQUE_CHECK
153 #define Nullgv Null(GV*)
156 #define DM_RUID 0x001
157 #define DM_EUID 0x002
159 #define DM_RGID 0x010
160 #define DM_EGID 0x020
161 #define DM_DELAY 0x100
164 * symbol creation flags, for use in gv_fetchpv() and get_*v()
166 #define GV_ADD 0x01 /* add, if symbol not already there
167 For gv_name_set, adding a HEK for the first
168 time, so don't try to free what's there. */
169 #define GV_ADDMULTI 0x02 /* add, pretending it has been added already */
170 #define GV_ADDWARN 0x04 /* add, but warn if symbol wasn't already there */
171 #define GV_ADDINEVAL 0x08 /* add, as though we're doing so within an eval */
172 #define GV_NOINIT 0x10 /* add, but don't init symbol, if type != PVGV */
173 /* This is used by toke.c to avoid turing placeholder constants in the symbol
174 table into full PVGVs with attached constant subroutines. */
175 #define GV_NOADD_NOINIT 0x20 /* Don't add the symbol if it's not there.
176 Don't init it if it is there but ! PVGV */
177 #define GV_NOEXPAND 0x40 /* Don't expand SvOK() entries to PVGV */
178 #define GV_NOTQUAL 0x80 /* A plain symbol name, not qualified with a
179 package (so skip checks for :: and ') */
181 /* SVf_UTF8 (more accurately the return value from SvUTF8) is also valid
182 as a flag to gv_fetch_pvn_flags, so ensure it lies outside this range.
184 #define gv_fullname3(sv,gv,prefix) gv_fullname4(sv,gv,prefix,TRUE)
185 #define gv_efullname3(sv,gv,prefix) gv_efullname4(sv,gv,prefix,TRUE)
186 #define gv_fetchmethod(stash, name) gv_fetchmethod_autoload(stash, name, TRUE)