Commit | Line | Data |
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 |
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 |
9 | */ |
10 | |
11 | struct 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 |
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) */ |
1cb0ed9b |
22 | char * gp_file; /* file first declared in (for -w) */ |
79072805 |
23 | }; |
24 | |
79072805 |
25 | #define GvXPVGV(gv) ((XPVGV*)SvANY(gv)) |
26 | |
a5f75d66 |
27 | |
c72c5e99 |
28 | #if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN) |
dedf8e73 |
29 | # define GvGP(gv) \ |
76f523e8 |
30 | (*({GV *const shplep = (GV *) (gv); \ |
dedf8e73 |
31 | assert(SvTYPE(shplep) == SVt_PVGV || \ |
32 | SvTYPE(shplep) == SVt_PVLV); \ |
33 | assert(isGV_with_GP(shplep)); \ |
34 | &((shplep)->sv_u.svu_gp);})) |
35 | # define GvFLAGS(gv) \ |
76f523e8 |
36 | (*({GV *const yaah = (GV *) (gv); \ |
dedf8e73 |
37 | assert(SvTYPE(yaah) == SVt_PVGV || SvTYPE(yaah) == SVt_PVLV); \ |
38 | assert(isGV_with_GP(yaah)); \ |
5526b5b3 |
39 | &(GvXPVGV(yaah)->xpv_cur);})) |
c72c5e99 |
40 | # define GvSTASH(gv) \ |
dd3874d7 |
41 | (*({ GV * const _gv = (GV *) (gv); \ |
dedf8e73 |
42 | assert(isGV_with_GP(_gv)); \ |
c72c5e99 |
43 | assert(SvTYPE(_gv) == SVt_PVGV || SvTYPE(_gv) >= SVt_PVLV); \ |
58430790 |
44 | &(GvXPVGV(_gv)->xnv_u.xgv_stash); \ |
c72c5e99 |
45 | })) |
acda4c6a |
46 | # define GvNAME_HEK(gv) \ |
47 | (*({ GV * const zzzz = (GV *) (gv); \ |
f5c1e807 |
48 | assert(isGV_with_GP(zzzz)); \ |
49 | assert(SvTYPE(zzzz) == SVt_PVGV || SvTYPE(zzzz) >= SVt_PVLV); \ |
69ecfd12 |
50 | &(GvXPVGV(zzzz)->xiv_u.xivu_namehek); \ |
acda4c6a |
51 | })) |
c72c5e99 |
52 | #else |
dedf8e73 |
53 | # define GvGP(gv) ((gv)->sv_u.svu_gp) |
5526b5b3 |
54 | # define GvFLAGS(gv) (GvXPVGV(gv)->xpv_cur) |
58430790 |
55 | # define GvSTASH(gv) (GvXPVGV(gv)->xnv_u.xgv_stash) |
274ac62a |
56 | # define GvNAME_HEK(gv) (GvXPVGV(gv)->xiv_u.xivu_namehek) |
c72c5e99 |
57 | #endif |
dedf8e73 |
58 | |
acda4c6a |
59 | #define GvNAME_get(gv) (GvNAME_HEK(gv) ? HEK_KEY(GvNAME_HEK(gv)) : 0) |
60 | #define GvNAMELEN_get(gv) (GvNAME_HEK(gv) ? HEK_LEN(GvNAME_HEK(gv)) : 0) |
61 | |
f5c1e807 |
62 | #define GvNAME(gv) GvNAME_get(gv) |
63 | #define GvNAMELEN(gv) GvNAMELEN_get(gv) |
64 | |
08002bbf |
65 | #define GvASSIGN_GENERATION(gv) (0 + ((XPV*) SvANY(gv))->xpv_len) |
169d2d72 |
66 | #define GvASSIGN_GENERATION_set(gv,val) \ |
67 | STMT_START { assert(SvTYPE(gv) == SVt_PVGV); \ |
08002bbf |
68 | (((XPV*) SvANY(gv))->xpv_len = (val)); } STMT_END |
169d2d72 |
69 | |
954c1994 |
70 | /* |
ccfc67b7 |
71 | =head1 GV Functions |
72 | |
954c1994 |
73 | =for apidoc Am|SV*|GvSV|GV* gv |
74 | |
75 | Return the SV from the GV. |
76 | |
77 | =cut |
78 | */ |
79 | |
79072805 |
80 | #define GvSV(gv) (GvGP(gv)->gp_sv) |
c69033f2 |
81 | #ifdef PERL_DONT_CREATE_GVSV |
547f15c3 |
82 | #define GvSVn(gv) (*(GvGP(gv)->gp_sv ? \ |
83 | &(GvGP(gv)->gp_sv) : \ |
84 | &(GvGP(gv_SVadd(gv))->gp_sv))) |
c69033f2 |
85 | #else |
86 | #define GvSVn(gv) GvSV(gv) |
87 | #endif |
88 | |
79072805 |
89 | #define GvREFCNT(gv) (GvGP(gv)->gp_refcnt) |
2035c5e8 |
90 | #define GvIO(gv) ((gv) && SvTYPE((SV*)gv) == SVt_PVGV && GvGP(gv) ? GvIOp(gv) : 0) |
a0d0e21e |
91 | #define GvIOp(gv) (GvGP(gv)->gp_io) |
92 | #define GvIOn(gv) (GvIO(gv) ? GvIOp(gv) : GvIOp(gv_IOadd(gv))) |
79072805 |
93 | |
94 | #define GvFORM(gv) (GvGP(gv)->gp_form) |
95 | #define GvAV(gv) (GvGP(gv)->gp_av) |
44a8e56a |
96 | |
97 | /* This macro is deprecated. Do not use! */ |
98 | #define GvREFCNT_inc(gv) ((GV*)SvREFCNT_inc(gv)) /* DO NOT USE */ |
79072805 |
99 | |
79072805 |
100 | #define GvAVn(gv) (GvGP(gv)->gp_av ? \ |
101 | GvGP(gv)->gp_av : \ |
102 | GvGP(gv_AVadd(gv))->gp_av) |
79072805 |
103 | #define GvHV(gv) ((GvGP(gv))->gp_hv) |
104 | |
79072805 |
105 | #define GvHVn(gv) (GvGP(gv)->gp_hv ? \ |
106 | GvGP(gv)->gp_hv : \ |
107 | GvGP(gv_HVadd(gv))->gp_hv) |
79072805 |
108 | |
109 | #define GvCV(gv) (GvGP(gv)->gp_cv) |
463ee0b2 |
110 | #define GvCVGEN(gv) (GvGP(gv)->gp_cvgen) |
601f1833 |
111 | #define GvCVu(gv) (GvGP(gv)->gp_cvgen ? NULL : GvGP(gv)->gp_cv) |
79072805 |
112 | |
79072805 |
113 | #define GvLINE(gv) (GvGP(gv)->gp_line) |
b195d487 |
114 | #define GvFILE(gv) (GvGP(gv)->gp_file) |
57843af0 |
115 | #define GvFILEGV(gv) (gv_fetchfile(GvFILE(gv))) |
79072805 |
116 | |
79072805 |
117 | #define GvEGV(gv) (GvGP(gv)->gp_egv) |
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 |
121 | #define GVf_INTRO 0x01 |
122 | #define GVf_MULTI 0x02 |
123 | #define GVf_ASSUMECV 0x04 |
743e66e6 |
124 | #define GVf_IN_PAD 0x08 |
a5f75d66 |
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 |
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 | |
49c0300d |
167 | #define GvUNIQUE(gv) 0 |
40e48b40 |
168 | #define GvUNIQUE_on(gv) |
169 | #define GvUNIQUE_off(gv) |
5bd07a3d |
170 | |
171 | #ifdef USE_ITHREADS |
7fb37951 |
172 | #define GV_UNIQUE_CHECK |
5bd07a3d |
173 | #else |
7fb37951 |
174 | #undef GV_UNIQUE_CHECK |
5bd07a3d |
175 | #endif |
176 | |
79072805 |
177 | #define Nullgv Null(GV*) |
178 | |
179 | #define DM_UID 0x003 |
180 | #define DM_RUID 0x001 |
181 | #define DM_EUID 0x002 |
182 | #define DM_GID 0x030 |
183 | #define DM_RGID 0x010 |
184 | #define DM_EGID 0x020 |
185 | #define DM_DELAY 0x100 |
186 | |
0f303493 |
187 | /* |
864dbfa3 |
188 | * symbol creation flags, for use in gv_fetchpv() and get_*v() |
0f303493 |
189 | */ |
ae8cc45f |
190 | #define GV_ADD 0x01 /* add, if symbol not already there |
191 | For gv_name_set, adding a HEK for the first |
192 | time, so don't try to free what's there. */ |
0f303493 |
193 | #define GV_ADDMULTI 0x02 /* add, pretending it has been added already */ |
194 | #define GV_ADDWARN 0x04 /* add, but warn if symbol wasn't already there */ |
195 | #define GV_ADDINEVAL 0x08 /* add, as though we're doing so within an eval */ |
196 | #define GV_NOINIT 0x10 /* add, but don't init symbol, if type != PVGV */ |
add2581e |
197 | /* This is used by toke.c to avoid turing placeholder constants in the symbol |
198 | table into full PVGVs with attached constant subroutines. */ |
199 | #define GV_NOADD_NOINIT 0x20 /* Don't add the symbol if it's not there. |
200 | Don't init it if it is there but ! PVGV */ |
e26df76a |
201 | #define GV_NOEXPAND 0x40 /* Don't expand SvOK() entries to PVGV */ |
fafc274c |
202 | #define GV_NOTQUAL 0x80 /* A plain symbol name, not qualified with a |
203 | package (so skip checks for :: and ') */ |
add2581e |
204 | |
7a5fd60d |
205 | /* SVf_UTF8 (more accurately the return value from SvUTF8) is also valid |
206 | as a flag to gv_fetch_pvn_flags, so ensure it lies outside this range. |
207 | */ |
d9a22066 |
208 | #define gv_fullname3(sv,gv,prefix) gv_fullname4(sv,gv,prefix,TRUE) |
209 | #define gv_efullname3(sv,gv,prefix) gv_efullname4(sv,gv,prefix,TRUE) |
887986eb |
210 | #define gv_fetchmethod(stash, name) gv_fetchmethod_autoload(stash, name, TRUE) |