warn and fail on writes to SVf_UTF8 SVs
[perl.git] / gv.h
1 /*    gv.h
2  *
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
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  *
9  */
10
11 struct gp {
12     SV *        gp_sv;          /* scalar value */
13     struct io * gp_io;          /* filehandle value */
14     CV *        gp_cv;          /* subroutine value */
15     U32         gp_cvgen;       /* generational validity of cached gv_cv */
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 */
21     line_t      gp_line;        /* line first declared at (for -w) */
22     HEK *       gp_file_hek;    /* file first declared in (for -w) */
23 };
24
25 #define GvXPVGV(gv)     ((XPVGV*)SvANY(gv))
26
27
28 #if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN) && !defined(__INTEL_COMPILER)
29 #  define GvGP(gv)                                                      \
30         (0+(*({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);})))
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); }
39 #  define GvFLAGS(gv)                                                   \
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);}))
44 #  define GvSTASH(gv)                                                   \
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);                      \
49          }))
50 #  define GvNAME_HEK(gv)                                                \
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);                 \
56          }))
57 #  define GvNAME_get(gv)        ({ assert(GvNAME_HEK(gv)); (char *)HEK_KEY(GvNAME_HEK(gv)); })
58 #  define GvNAMELEN_get(gv)     ({ assert(GvNAME_HEK(gv)); HEK_LEN(GvNAME_HEK(gv)); })
59 #  define GvNAMEUTF8(gv)        ({ assert(GvNAME_HEK(gv)); HEK_UTF8(GvNAME_HEK(gv)); })
60 #else
61 #  define GvGP(gv)      (0+(gv)->sv_u.svu_gp)
62 #  define GvGP_set(gv,gp)       ((gv)->sv_u.svu_gp = (gp))
63 #  define GvFLAGS(gv)   (GvXPVGV(gv)->xpv_cur)
64 #  define GvSTASH(gv)   (GvXPVGV(gv)->xnv_u.xgv_stash)
65 #  define GvNAME_HEK(gv)        (GvXPVGV(gv)->xiv_u.xivu_namehek)
66 #  define GvNAME_get(gv)        HEK_KEY(GvNAME_HEK(gv))
67 #  define GvNAMELEN_get(gv)     HEK_LEN(GvNAME_HEK(gv))
68 #  define GvNAMEUTF8(gv)        HEK_UTF8(GvNAME_HEK(gv))
69 #endif
70
71 #define GvNAME(gv)      GvNAME_get(gv)
72 #define GvNAMELEN(gv)   GvNAMELEN_get(gv)
73
74 #define GvASSIGN_GENERATION(gv)         (0 + ((XPV*) SvANY(gv))->xpv_len)
75 #define GvASSIGN_GENERATION_set(gv,val)                 \
76         STMT_START { assert(SvTYPE(gv) == SVt_PVGV);    \
77                 (((XPV*) SvANY(gv))->xpv_len = (val)); } STMT_END
78
79 /*
80 =head1 GV Functions
81
82 =for apidoc Am|SV*|GvSV|GV* gv
83
84 Return the SV from the GV.
85
86 =for apidoc Am|AV*|GvAV|GV* gv
87
88 Return the AV from the GV.
89
90 =for apidoc Am|HV*|GvHV|GV* gv
91
92 Return the HV from the GV.
93
94 =for apidoc Am|CV*|GvCV|GV* gv
95
96 Return the CV from the GV.
97
98 =cut
99 */
100
101 #define GvSV(gv)        (GvGP(gv)->gp_sv)
102 #ifdef PERL_DONT_CREATE_GVSV
103 #define GvSVn(gv)       (*(GvGP(gv)->gp_sv ? \
104                          &(GvGP(gv)->gp_sv) : \
105                          &(GvGP(gv_SVadd(gv))->gp_sv)))
106 #else
107 #define GvSVn(gv)       GvSV(gv)
108 #endif
109
110 #define GvREFCNT(gv)    (GvGP(gv)->gp_refcnt)
111 #define GvIO(gv)                         \
112  (                                        \
113      (gv)                                  \
114   && (                                      \
115          SvTYPE((const SV*)(gv)) == SVt_PVGV \
116       || SvTYPE((const SV*)(gv)) == SVt_PVLV  \
117      )                                         \
118   && GvGP(gv)                                   \
119    ? GvIOp(gv)                                   \
120    : NULL                                         \
121  )
122 #define GvIOp(gv)       (GvGP(gv)->gp_io)
123 #define GvIOn(gv)       (GvIO(gv) ? GvIOp(gv) : GvIOp(gv_IOadd(gv)))
124
125 #define GvFORM(gv)      (GvGP(gv)->gp_form)
126 #define GvAV(gv)        (GvGP(gv)->gp_av)
127
128 #define GvAVn(gv)       (GvGP(gv)->gp_av ? \
129                          GvGP(gv)->gp_av : \
130                          GvGP(gv_AVadd(gv))->gp_av)
131 #define GvHV(gv)        ((GvGP(gv))->gp_hv)
132
133 #define GvHVn(gv)       (GvGP(gv)->gp_hv ? \
134                          GvGP(gv)->gp_hv : \
135                          GvGP(gv_HVadd(gv))->gp_hv)
136
137 #define GvCV(gv)        (0+GvGP(gv)->gp_cv)
138 #define GvCV_set(gv,cv) (GvGP(gv)->gp_cv = (cv))
139 #define GvCVGEN(gv)     (GvGP(gv)->gp_cvgen)
140 #define GvCVu(gv)       (GvGP(gv)->gp_cvgen ? NULL : GvGP(gv)->gp_cv)
141
142 #define GvLINE(gv)      (GvGP(gv)->gp_line)
143 #define GvFILE_HEK(gv)  (GvGP(gv)->gp_file_hek)
144 #define GvFILE(gv)      (GvFILE_HEK(gv) ? HEK_KEY(GvFILE_HEK(gv)) : NULL)
145 #define GvFILEGV(gv)    (gv_fetchfile(GvFILE(gv)))
146
147 #define GvEGV(gv)       (GvGP(gv)->gp_egv)
148 #define GvEGVx(gv)      (isGV_with_GP(gv) ? GvEGV(gv) : NULL)
149 #define GvENAME(gv)     GvNAME(GvEGV(gv) ? GvEGV(gv) : gv)
150 #define GvENAMELEN(gv)  GvNAMELEN(GvEGV(gv) ? GvEGV(gv) : gv)
151 #define GvENAMEUTF8(gv) GvNAMEUTF8(GvEGV(gv) ? GvEGV(gv) : gv)
152 #define GvENAME_HEK(gv) GvNAME_HEK(GvEGV(gv) ? GvEGV(gv) : gv)
153 #define GvESTASH(gv)    GvSTASH(GvEGV(gv) ? GvEGV(gv) : gv)
154
155 #define GVf_INTRO       0x01
156 #define GVf_MULTI       0x02
157 #define GVf_ASSUMECV    0x04
158 #define GVf_IN_PAD      0x08
159 #define GVf_IMPORTED    0xF0
160 #define GVf_IMPORTED_SV   0x10
161 #define GVf_IMPORTED_AV   0x20
162 #define GVf_IMPORTED_HV   0x40
163 #define GVf_IMPORTED_CV   0x80
164
165 #define GvINTRO(gv)             (GvFLAGS(gv) & GVf_INTRO)
166 #define GvINTRO_on(gv)          (GvFLAGS(gv) |= GVf_INTRO)
167 #define GvINTRO_off(gv)         (GvFLAGS(gv) &= ~GVf_INTRO)
168
169 #define GvMULTI(gv)             (GvFLAGS(gv) & GVf_MULTI)
170 #define GvMULTI_on(gv)          (GvFLAGS(gv) |= GVf_MULTI)
171 #define GvMULTI_off(gv)         (GvFLAGS(gv) &= ~GVf_MULTI)
172
173 #define GvASSUMECV(gv)          (GvFLAGS(gv) & GVf_ASSUMECV)
174 #define GvASSUMECV_on(gv)       (GvFLAGS(gv) |= GVf_ASSUMECV)
175 #define GvASSUMECV_off(gv)      (GvFLAGS(gv) &= ~GVf_ASSUMECV)
176
177 #define GvIMPORTED(gv)          (GvFLAGS(gv) & GVf_IMPORTED)
178 #define GvIMPORTED_on(gv)       (GvFLAGS(gv) |= GVf_IMPORTED)
179 #define GvIMPORTED_off(gv)      (GvFLAGS(gv) &= ~GVf_IMPORTED)
180
181 #define GvIMPORTED_SV(gv)       (GvFLAGS(gv) & GVf_IMPORTED_SV)
182 #define GvIMPORTED_SV_on(gv)    (GvFLAGS(gv) |= GVf_IMPORTED_SV)
183 #define GvIMPORTED_SV_off(gv)   (GvFLAGS(gv) &= ~GVf_IMPORTED_SV)
184
185 #define GvIMPORTED_AV(gv)       (GvFLAGS(gv) & GVf_IMPORTED_AV)
186 #define GvIMPORTED_AV_on(gv)    (GvFLAGS(gv) |= GVf_IMPORTED_AV)
187 #define GvIMPORTED_AV_off(gv)   (GvFLAGS(gv) &= ~GVf_IMPORTED_AV)
188
189 #define GvIMPORTED_HV(gv)       (GvFLAGS(gv) & GVf_IMPORTED_HV)
190 #define GvIMPORTED_HV_on(gv)    (GvFLAGS(gv) |= GVf_IMPORTED_HV)
191 #define GvIMPORTED_HV_off(gv)   (GvFLAGS(gv) &= ~GVf_IMPORTED_HV)
192
193 #define GvIMPORTED_CV(gv)       (GvFLAGS(gv) & GVf_IMPORTED_CV)
194 #define GvIMPORTED_CV_on(gv)    (GvFLAGS(gv) |= GVf_IMPORTED_CV)
195 #define GvIMPORTED_CV_off(gv)   (GvFLAGS(gv) &= ~GVf_IMPORTED_CV)
196
197 #define GvIN_PAD(gv)            (GvFLAGS(gv) & GVf_IN_PAD)
198 #define GvIN_PAD_on(gv)         (GvFLAGS(gv) |= GVf_IN_PAD)
199 #define GvIN_PAD_off(gv)        (GvFLAGS(gv) &= ~GVf_IN_PAD)
200
201 #ifndef PERL_CORE
202 #  define Nullgv Null(GV*)
203 #endif
204
205 #define DM_RUID      0x001
206 #define DM_EUID      0x002
207 #define DM_UID       (DM_RUID|DM_EUID)
208 #define DM_ARRAY_ISA 0x004
209 #define DM_RGID      0x010
210 #define DM_EGID      0x020
211 #define DM_GID       (DM_RGID|DM_EGID)
212 #define DM_DELAY     0x100
213
214 /*
215  * symbol creation flags, for use in gv_fetchpv() and get_*v()
216  */
217 #define GV_ADD          0x01    /* add, if symbol not already there
218                                    For gv_name_set, adding a HEK for the first
219                                    time, so don't try to free what's there.  */
220 #define GV_ADDMULTI     0x02    /* add, pretending it has been added
221                                    already; used also by gv_init_* */
222 #define GV_ADDWARN      0x04    /* add, but warn if symbol wasn't already there */
223 #define GV_ADDINEVAL    0x08    /* add, as though we're doing so within an eval */
224 #define GV_NOINIT       0x10    /* add, but don't init symbol, if type != PVGV */
225 /* This is used by toke.c to avoid turing placeholder constants in the symbol
226    table into full PVGVs with attached constant subroutines.  */
227 #define GV_NOADD_NOINIT 0x20    /* Don't add the symbol if it's not there.
228                                    Don't init it if it is there but ! PVGV */
229 #define GV_NOEXPAND     0x40    /* Don't expand SvOK() entries to PVGV */
230 #define GV_NOTQUAL      0x80    /* A plain symbol name, not qualified with a
231                                    package (so skip checks for :: and ')  */
232 #define GV_AUTOLOAD     0x100   /* gv_fetchmethod_flags() should AUTOLOAD  */
233 #define GV_CROAK        0x200   /* gv_fetchmethod_flags() should croak  */
234 #define GV_ADDMG        0x400   /* add if magical */
235 #define GV_NO_SVGMAGIC  0x800   /* Skip get-magic on an SV argument;
236                                    used only by gv_fetchsv(_nomg) */
237
238 /* Flags for gv_fetchmeth_pvn and gv_autoload_pvn*/
239 #define GV_SUPER        0x1000  /* SUPER::method */
240
241 /* Flags for gv_autoload_*/
242 #define GV_AUTOLOAD_ISMETHOD 1  /* autoloading a method? */
243
244 /*      SVf_UTF8 (more accurately the return value from SvUTF8) is also valid
245         as a flag to various gv_* functions, so ensure it lies
246         outside this range.
247 */
248
249 #define GV_NOADD_MASK \
250   (SVf_UTF8|GV_NOADD_NOINIT|GV_NOEXPAND|GV_NOTQUAL|GV_ADDMG|GV_NO_SVGMAGIC)
251 /* The bit flags that don't cause gv_fetchpv() to add a symbol if not
252    found (with the exception GV_ADDMG, which *might* cause the symbol
253    to be added) */
254
255 #define gv_fullname3(sv,gv,prefix) gv_fullname4(sv,gv,prefix,TRUE)
256 #define gv_efullname3(sv,gv,prefix) gv_efullname4(sv,gv,prefix,TRUE)
257 #define gv_fetchmethod(stash, name) gv_fetchmethod_autoload(stash, name, TRUE)
258 #define gv_fetchsv_nomg(n,f,t) gv_fetchsv(n,(f)|GV_NO_SVGMAGIC,t)
259 #define gv_init(gv,stash,name,len,multi) \
260         gv_init_pvn(gv,stash,name,len,GV_ADDMULTI*!!(multi))
261 #define gv_fetchmeth(stash,name,len,level) gv_fetchmeth_pvn(stash, name, len, level, 0)
262 #define gv_fetchmeth_autoload(stash,name,len,level) gv_fetchmeth_pvn_autoload(stash, name, len, level, 0)
263 #define gv_fetchmethod_flags(stash,name,flags) gv_fetchmethod_pv_flags(stash, name, flags)
264 #define gv_autoload4(stash, name, len, method) \
265         gv_autoload_pvn(stash, name, len, !!(method))
266 #define newGVgen(pack)  newGVgen_flags(pack, 0)
267 #define gv_method_changed(gv)               \
268     (                                        \
269         assert_(isGV_with_GP(gv))             \
270         GvREFCNT(gv) > 1                       \
271             ? (void)++PL_sub_generation         \
272             : mro_method_changed_in(GvSTASH(gv)) \
273     )
274
275 #define gv_AVadd(gv) gv_add_by_type((gv), SVt_PVAV)
276 #define gv_HVadd(gv) gv_add_by_type((gv), SVt_PVHV)
277 #define gv_IOadd(gv) gv_add_by_type((gv), SVt_PVIO)
278 #define gv_SVadd(gv) gv_add_by_type((gv), SVt_NULL)
279
280 /*
281  * Local variables:
282  * c-indentation-style: bsd
283  * c-basic-offset: 4
284  * indent-tabs-mode: nil
285  * End:
286  *
287  * ex: set ts=8 sts=4 sw=4 et:
288  */