Commit | Line | Data |
---|---|---|
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 | ||
11 | struct 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) \ |
603aa20d RU |
30 | (*({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);})) | |
dedf8e73 | 34 | # define GvFLAGS(gv) \ |
603aa20d RU |
35 | (*({GV *const _gvflags = (GV *) (gv); \ |
36 | assert(SvTYPE(_gvflags) == SVt_PVGV || SvTYPE(_gvflags) == SVt_PVLV); \ | |
37 | assert(isGV_with_GP(_gvflags)); \ | |
38 | &(GvXPVGV(_gvflags)->xpv_cur);})) | |
c72c5e99 | 39 | # define GvSTASH(gv) \ |
603aa20d RU |
40 | (*({ GV * const _gvstash = (GV *) (gv); \ |
41 | assert(isGV_with_GP(_gvstash)); \ | |
42 | assert(SvTYPE(_gvstash) == SVt_PVGV || SvTYPE(_gvstash) >= SVt_PVLV); \ | |
43 | &(GvXPVGV(_gvstash)->xnv_u.xgv_stash); \ | |
c72c5e99 | 44 | })) |
acda4c6a | 45 | # define GvNAME_HEK(gv) \ |
603aa20d RU |
46 | (*({ GV * const _gvname_hek = (GV *) (gv); \ |
47 | assert(isGV_with_GP(_gvname_hek)); \ | |
48 | assert(SvTYPE(_gvname_hek) == SVt_PVGV || SvTYPE(_gvname_hek) >= SVt_PVLV); \ | |
49 | assert(!SvVALID(_gvname_hek)); \ | |
50 | &(GvXPVGV(_gvname_hek)->xiv_u.xivu_namehek); \ | |
acda4c6a | 51 | })) |
1404b487 | 52 | # define GvNAME_get(gv) ({ assert(GvNAME_HEK(gv)); (char *)HEK_KEY(GvNAME_HEK(gv)); }) |
9f616d01 | 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 | ||
76 | Return 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) |
b1bc3f34 | 91 | #define GvIO(gv) ((gv) && SvTYPE((const SV*)gv) == SVt_PVGV && GvGP(gv) ? GvIOp(gv) : NULL) |
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 | 97 | |
79072805 LW |
98 | #define GvAVn(gv) (GvGP(gv)->gp_av ? \ |
99 | GvGP(gv)->gp_av : \ | |
100 | GvGP(gv_AVadd(gv))->gp_av) | |
79072805 LW |
101 | #define GvHV(gv) ((GvGP(gv))->gp_hv) |
102 | ||
79072805 LW |
103 | #define GvHVn(gv) (GvGP(gv)->gp_hv ? \ |
104 | GvGP(gv)->gp_hv : \ | |
105 | GvGP(gv_HVadd(gv))->gp_hv) | |
79072805 LW |
106 | |
107 | #define GvCV(gv) (GvGP(gv)->gp_cv) | |
463ee0b2 | 108 | #define GvCVGEN(gv) (GvGP(gv)->gp_cvgen) |
601f1833 | 109 | #define GvCVu(gv) (GvGP(gv)->gp_cvgen ? NULL : GvGP(gv)->gp_cv) |
79072805 | 110 | |
79072805 | 111 | #define GvLINE(gv) (GvGP(gv)->gp_line) |
f4890806 | 112 | #define GvFILE_HEK(gv) (GvGP(gv)->gp_file_hek) |
5be41be4 | 113 | #define GvFILE(gv) (GvFILE_HEK(gv) ? HEK_KEY(GvFILE_HEK(gv)) : NULL) |
57843af0 | 114 | #define GvFILEGV(gv) (gv_fetchfile(GvFILE(gv))) |
79072805 | 115 | |
79072805 | 116 | #define GvEGV(gv) (GvGP(gv)->gp_egv) |
099be4f1 | 117 | #define GvEGVx(gv) (isGV_with_GP(gv) ? GvEGV(gv) : NULL) |
748a9306 | 118 | #define GvENAME(gv) GvNAME(GvEGV(gv) ? GvEGV(gv) : gv) |
748a9306 | 119 | #define GvESTASH(gv) GvSTASH(GvEGV(gv) ? GvEGV(gv) : gv) |
79072805 | 120 | |
a5f75d66 AD |
121 | #define GVf_INTRO 0x01 |
122 | #define GVf_MULTI 0x02 | |
123 | #define GVf_ASSUMECV 0x04 | |
743e66e6 | 124 | #define GVf_IN_PAD 0x08 |
a5f75d66 AD |
125 | #define GVf_IMPORTED 0xF0 |
126 | #define GVf_IMPORTED_SV 0x10 | |
127 | #define GVf_IMPORTED_AV 0x20 | |
128 | #define GVf_IMPORTED_HV 0x40 | |
129 | #define GVf_IMPORTED_CV 0x80 | |
130 | ||
131 | #define GvINTRO(gv) (GvFLAGS(gv) & GVf_INTRO) | |
132 | #define GvINTRO_on(gv) (GvFLAGS(gv) |= GVf_INTRO) | |
133 | #define GvINTRO_off(gv) (GvFLAGS(gv) &= ~GVf_INTRO) | |
134 | ||
135 | #define GvMULTI(gv) (GvFLAGS(gv) & GVf_MULTI) | |
136 | #define GvMULTI_on(gv) (GvFLAGS(gv) |= GVf_MULTI) | |
137 | #define GvMULTI_off(gv) (GvFLAGS(gv) &= ~GVf_MULTI) | |
138 | ||
139 | #define GvASSUMECV(gv) (GvFLAGS(gv) & GVf_ASSUMECV) | |
140 | #define GvASSUMECV_on(gv) (GvFLAGS(gv) |= GVf_ASSUMECV) | |
141 | #define GvASSUMECV_off(gv) (GvFLAGS(gv) &= ~GVf_ASSUMECV) | |
142 | ||
143 | #define GvIMPORTED(gv) (GvFLAGS(gv) & GVf_IMPORTED) | |
144 | #define GvIMPORTED_on(gv) (GvFLAGS(gv) |= GVf_IMPORTED) | |
145 | #define GvIMPORTED_off(gv) (GvFLAGS(gv) &= ~GVf_IMPORTED) | |
146 | ||
147 | #define GvIMPORTED_SV(gv) (GvFLAGS(gv) & GVf_IMPORTED_SV) | |
148 | #define GvIMPORTED_SV_on(gv) (GvFLAGS(gv) |= GVf_IMPORTED_SV) | |
149 | #define GvIMPORTED_SV_off(gv) (GvFLAGS(gv) &= ~GVf_IMPORTED_SV) | |
150 | ||
151 | #define GvIMPORTED_AV(gv) (GvFLAGS(gv) & GVf_IMPORTED_AV) | |
152 | #define GvIMPORTED_AV_on(gv) (GvFLAGS(gv) |= GVf_IMPORTED_AV) | |
153 | #define GvIMPORTED_AV_off(gv) (GvFLAGS(gv) &= ~GVf_IMPORTED_AV) | |
154 | ||
155 | #define GvIMPORTED_HV(gv) (GvFLAGS(gv) & GVf_IMPORTED_HV) | |
156 | #define GvIMPORTED_HV_on(gv) (GvFLAGS(gv) |= GVf_IMPORTED_HV) | |
157 | #define GvIMPORTED_HV_off(gv) (GvFLAGS(gv) &= ~GVf_IMPORTED_HV) | |
158 | ||
159 | #define GvIMPORTED_CV(gv) (GvFLAGS(gv) & GVf_IMPORTED_CV) | |
160 | #define GvIMPORTED_CV_on(gv) (GvFLAGS(gv) |= GVf_IMPORTED_CV) | |
161 | #define GvIMPORTED_CV_off(gv) (GvFLAGS(gv) &= ~GVf_IMPORTED_CV) | |
162 | ||
743e66e6 GS |
163 | #define GvIN_PAD(gv) (GvFLAGS(gv) & GVf_IN_PAD) |
164 | #define GvIN_PAD_on(gv) (GvFLAGS(gv) |= GVf_IN_PAD) | |
165 | #define GvIN_PAD_off(gv) (GvFLAGS(gv) &= ~GVf_IN_PAD) | |
166 | ||
3ae1b226 NC |
167 | #ifndef PERL_CORE |
168 | # define Nullgv Null(GV*) | |
169 | #endif | |
79072805 | 170 | |
613a9ec2 DM |
171 | #define DM_RUID 0x001 |
172 | #define DM_EUID 0x002 | |
6ca8229d | 173 | #define DM_UID (DM_RUID|DM_EUID) |
354b0578 | 174 | #define DM_ARRAY_ISA 0x004 |
613a9ec2 DM |
175 | #define DM_RGID 0x010 |
176 | #define DM_EGID 0x020 | |
6ca8229d | 177 | #define DM_GID (DM_RGID|DM_EGID) |
613a9ec2 | 178 | #define DM_DELAY 0x100 |
79072805 | 179 | |
0f303493 | 180 | /* |
864dbfa3 | 181 | * symbol creation flags, for use in gv_fetchpv() and get_*v() |
0f303493 | 182 | */ |
ae8cc45f NC |
183 | #define GV_ADD 0x01 /* add, if symbol not already there |
184 | For gv_name_set, adding a HEK for the first | |
185 | time, so don't try to free what's there. */ | |
0f303493 GS |
186 | #define GV_ADDMULTI 0x02 /* add, pretending it has been added already */ |
187 | #define GV_ADDWARN 0x04 /* add, but warn if symbol wasn't already there */ | |
188 | #define GV_ADDINEVAL 0x08 /* add, as though we're doing so within an eval */ | |
189 | #define GV_NOINIT 0x10 /* add, but don't init symbol, if type != PVGV */ | |
add2581e NC |
190 | /* This is used by toke.c to avoid turing placeholder constants in the symbol |
191 | table into full PVGVs with attached constant subroutines. */ | |
192 | #define GV_NOADD_NOINIT 0x20 /* Don't add the symbol if it's not there. | |
193 | Don't init it if it is there but ! PVGV */ | |
e26df76a | 194 | #define GV_NOEXPAND 0x40 /* Don't expand SvOK() entries to PVGV */ |
fafc274c NC |
195 | #define GV_NOTQUAL 0x80 /* A plain symbol name, not qualified with a |
196 | package (so skip checks for :: and ') */ | |
256d1bb2 NC |
197 | #define GV_AUTOLOAD 0x100 /* gv_fetchmethod_flags() should AUTOLOAD */ |
198 | #define GV_CROAK 0x200 /* gv_fetchmethod_flags() should croak */ | |
add2581e | 199 | |
7a5fd60d NC |
200 | /* SVf_UTF8 (more accurately the return value from SvUTF8) is also valid |
201 | as a flag to gv_fetch_pvn_flags, so ensure it lies outside this range. | |
202 | */ | |
780a5241 NC |
203 | |
204 | #define GV_NOADD_MASK (SVf_UTF8|GV_NOADD_NOINIT|GV_NOEXPAND|GV_NOTQUAL) | |
205 | /* The bit flags that don't cause gv_fetchpv() to add a symbol if not found */ | |
206 | ||
d9a22066 NC |
207 | #define gv_fullname3(sv,gv,prefix) gv_fullname4(sv,gv,prefix,TRUE) |
208 | #define gv_efullname3(sv,gv,prefix) gv_efullname4(sv,gv,prefix,TRUE) | |
887986eb | 209 | #define gv_fetchmethod(stash, name) gv_fetchmethod_autoload(stash, name, TRUE) |
f4890806 | 210 | |
d5713896 NC |
211 | #define gv_AVadd(gv) gv_add_by_type((gv), SVt_PVAV) |
212 | #define gv_HVadd(gv) gv_add_by_type((gv), SVt_PVHV) | |
bb85b28a | 213 | #define gv_IOadd(gv) gv_add_by_type((gv), SVt_PVIO) |
d5713896 NC |
214 | #define gv_SVadd(gv) gv_add_by_type((gv), SVt_NULL) |
215 | ||
f4890806 NC |
216 | /* |
217 | * Local variables: | |
218 | * c-indentation-style: bsd | |
219 | * c-basic-offset: 4 | |
220 | * indent-tabs-mode: t | |
221 | * End: | |
222 | * | |
223 | * ex: set ts=8 sts=4 sw=4 noet: | |
224 | */ |