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 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 */ | |
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) */ |
1cb0ed9b | 22 | char * gp_file; /* file first declared in (for -w) */ |
79072805 LW |
23 | }; |
24 | ||
79072805 LW |
25 | #define GvXPVGV(gv) ((XPVGV*)SvANY(gv)) |
26 | ||
834268b8 SH |
27 | /* MSVC++ 6.0 (_MSC_VER == 1200) can't compile pp_hot.c with DEBUGGING enabled |
28 | * if we include the following assert(). Must be a compiler bug because it | |
1b94edb6 | 29 | * works fine with MSVC++ 7.0. Borland (5.5.1) has the same problem. */ |
834268b8 | 30 | #if defined(DEBUGGING) && \ |
1b94edb6 | 31 | ((!defined(_MSC_VER) || _MSC_VER > 1200) && !defined(__BORLANDC__)) |
f4b190e6 NC |
32 | # define GvGP(gv) (*(assert(SvTYPE(gv) == SVt_PVGV || \ |
33 | SvTYPE(gv) == SVt_PVLV), \ | |
34 | &(GvXPVGV(gv)->xgv_gp))) | |
35 | #else | |
36 | # define GvGP(gv) (GvXPVGV(gv)->xgv_gp) | |
37 | #endif | |
38 | ||
a5f75d66 AD |
39 | #define GvNAME(gv) (GvXPVGV(gv)->xgv_name) |
40 | #define GvNAMELEN(gv) (GvXPVGV(gv)->xgv_namelen) | |
a5f75d66 AD |
41 | #define GvFLAGS(gv) (GvXPVGV(gv)->xgv_flags) |
42 | ||
c72c5e99 NC |
43 | #if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN) |
44 | # define GvSTASH(gv) \ | |
45 | (*({ GV *_gv = (GV *) gv; \ | |
46 | assert(SvTYPE(_gv) == SVt_PVGV || SvTYPE(_gv) >= SVt_PVLV); \ | |
47 | &(GvXPVGV(_gv)->xgv_stash); \ | |
48 | })) | |
49 | #else | |
50 | #define GvSTASH(gv) (GvXPVGV(gv)->xgv_stash) | |
51 | #endif | |
954c1994 | 52 | /* |
ccfc67b7 JH |
53 | =head1 GV Functions |
54 | ||
954c1994 GS |
55 | =for apidoc Am|SV*|GvSV|GV* gv |
56 | ||
57 | Return the SV from the GV. | |
58 | ||
59 | =cut | |
60 | */ | |
61 | ||
79072805 | 62 | #define GvSV(gv) (GvGP(gv)->gp_sv) |
c69033f2 | 63 | #ifdef PERL_DONT_CREATE_GVSV |
547f15c3 NC |
64 | #define GvSVn(gv) (*(GvGP(gv)->gp_sv ? \ |
65 | &(GvGP(gv)->gp_sv) : \ | |
66 | &(GvGP(gv_SVadd(gv))->gp_sv))) | |
c69033f2 NC |
67 | #else |
68 | #define GvSVn(gv) GvSV(gv) | |
69 | #endif | |
70 | ||
79072805 | 71 | #define GvREFCNT(gv) (GvGP(gv)->gp_refcnt) |
2035c5e8 | 72 | #define GvIO(gv) ((gv) && SvTYPE((SV*)gv) == SVt_PVGV && GvGP(gv) ? GvIOp(gv) : 0) |
a0d0e21e LW |
73 | #define GvIOp(gv) (GvGP(gv)->gp_io) |
74 | #define GvIOn(gv) (GvIO(gv) ? GvIOp(gv) : GvIOp(gv_IOadd(gv))) | |
79072805 LW |
75 | |
76 | #define GvFORM(gv) (GvGP(gv)->gp_form) | |
77 | #define GvAV(gv) (GvGP(gv)->gp_av) | |
44a8e56a | 78 | |
79 | /* This macro is deprecated. Do not use! */ | |
80 | #define GvREFCNT_inc(gv) ((GV*)SvREFCNT_inc(gv)) /* DO NOT USE */ | |
79072805 | 81 | |
79072805 LW |
82 | #define GvAVn(gv) (GvGP(gv)->gp_av ? \ |
83 | GvGP(gv)->gp_av : \ | |
84 | GvGP(gv_AVadd(gv))->gp_av) | |
79072805 LW |
85 | #define GvHV(gv) ((GvGP(gv))->gp_hv) |
86 | ||
79072805 LW |
87 | #define GvHVn(gv) (GvGP(gv)->gp_hv ? \ |
88 | GvGP(gv)->gp_hv : \ | |
89 | GvGP(gv_HVadd(gv))->gp_hv) | |
79072805 LW |
90 | |
91 | #define GvCV(gv) (GvGP(gv)->gp_cv) | |
463ee0b2 | 92 | #define GvCVGEN(gv) (GvGP(gv)->gp_cvgen) |
601f1833 | 93 | #define GvCVu(gv) (GvGP(gv)->gp_cvgen ? NULL : GvGP(gv)->gp_cv) |
79072805 | 94 | |
79072805 | 95 | #define GvLINE(gv) (GvGP(gv)->gp_line) |
b195d487 | 96 | #define GvFILE(gv) (GvGP(gv)->gp_file) |
57843af0 | 97 | #define GvFILEGV(gv) (gv_fetchfile(GvFILE(gv))) |
79072805 | 98 | |
79072805 | 99 | #define GvEGV(gv) (GvGP(gv)->gp_egv) |
748a9306 | 100 | #define GvENAME(gv) GvNAME(GvEGV(gv) ? GvEGV(gv) : gv) |
748a9306 | 101 | #define GvESTASH(gv) GvSTASH(GvEGV(gv) ? GvEGV(gv) : gv) |
79072805 | 102 | |
a5f75d66 AD |
103 | #define GVf_INTRO 0x01 |
104 | #define GVf_MULTI 0x02 | |
105 | #define GVf_ASSUMECV 0x04 | |
743e66e6 | 106 | #define GVf_IN_PAD 0x08 |
a5f75d66 AD |
107 | #define GVf_IMPORTED 0xF0 |
108 | #define GVf_IMPORTED_SV 0x10 | |
109 | #define GVf_IMPORTED_AV 0x20 | |
110 | #define GVf_IMPORTED_HV 0x40 | |
111 | #define GVf_IMPORTED_CV 0x80 | |
112 | ||
113 | #define GvINTRO(gv) (GvFLAGS(gv) & GVf_INTRO) | |
114 | #define GvINTRO_on(gv) (GvFLAGS(gv) |= GVf_INTRO) | |
115 | #define GvINTRO_off(gv) (GvFLAGS(gv) &= ~GVf_INTRO) | |
116 | ||
117 | #define GvMULTI(gv) (GvFLAGS(gv) & GVf_MULTI) | |
118 | #define GvMULTI_on(gv) (GvFLAGS(gv) |= GVf_MULTI) | |
119 | #define GvMULTI_off(gv) (GvFLAGS(gv) &= ~GVf_MULTI) | |
120 | ||
121 | #define GvASSUMECV(gv) (GvFLAGS(gv) & GVf_ASSUMECV) | |
122 | #define GvASSUMECV_on(gv) (GvFLAGS(gv) |= GVf_ASSUMECV) | |
123 | #define GvASSUMECV_off(gv) (GvFLAGS(gv) &= ~GVf_ASSUMECV) | |
124 | ||
125 | #define GvIMPORTED(gv) (GvFLAGS(gv) & GVf_IMPORTED) | |
126 | #define GvIMPORTED_on(gv) (GvFLAGS(gv) |= GVf_IMPORTED) | |
127 | #define GvIMPORTED_off(gv) (GvFLAGS(gv) &= ~GVf_IMPORTED) | |
128 | ||
129 | #define GvIMPORTED_SV(gv) (GvFLAGS(gv) & GVf_IMPORTED_SV) | |
130 | #define GvIMPORTED_SV_on(gv) (GvFLAGS(gv) |= GVf_IMPORTED_SV) | |
131 | #define GvIMPORTED_SV_off(gv) (GvFLAGS(gv) &= ~GVf_IMPORTED_SV) | |
132 | ||
133 | #define GvIMPORTED_AV(gv) (GvFLAGS(gv) & GVf_IMPORTED_AV) | |
134 | #define GvIMPORTED_AV_on(gv) (GvFLAGS(gv) |= GVf_IMPORTED_AV) | |
135 | #define GvIMPORTED_AV_off(gv) (GvFLAGS(gv) &= ~GVf_IMPORTED_AV) | |
136 | ||
137 | #define GvIMPORTED_HV(gv) (GvFLAGS(gv) & GVf_IMPORTED_HV) | |
138 | #define GvIMPORTED_HV_on(gv) (GvFLAGS(gv) |= GVf_IMPORTED_HV) | |
139 | #define GvIMPORTED_HV_off(gv) (GvFLAGS(gv) &= ~GVf_IMPORTED_HV) | |
140 | ||
141 | #define GvIMPORTED_CV(gv) (GvFLAGS(gv) & GVf_IMPORTED_CV) | |
142 | #define GvIMPORTED_CV_on(gv) (GvFLAGS(gv) |= GVf_IMPORTED_CV) | |
143 | #define GvIMPORTED_CV_off(gv) (GvFLAGS(gv) &= ~GVf_IMPORTED_CV) | |
144 | ||
743e66e6 GS |
145 | #define GvIN_PAD(gv) (GvFLAGS(gv) & GVf_IN_PAD) |
146 | #define GvIN_PAD_on(gv) (GvFLAGS(gv) |= GVf_IN_PAD) | |
147 | #define GvIN_PAD_off(gv) (GvFLAGS(gv) &= ~GVf_IN_PAD) | |
148 | ||
49c0300d | 149 | #define GvUNIQUE(gv) 0 |
40e48b40 DM |
150 | #define GvUNIQUE_on(gv) |
151 | #define GvUNIQUE_off(gv) | |
5bd07a3d DM |
152 | |
153 | #ifdef USE_ITHREADS | |
7fb37951 | 154 | #define GV_UNIQUE_CHECK |
5bd07a3d | 155 | #else |
7fb37951 | 156 | #undef GV_UNIQUE_CHECK |
5bd07a3d DM |
157 | #endif |
158 | ||
79072805 LW |
159 | #define Nullgv Null(GV*) |
160 | ||
161 | #define DM_UID 0x003 | |
162 | #define DM_RUID 0x001 | |
163 | #define DM_EUID 0x002 | |
164 | #define DM_GID 0x030 | |
165 | #define DM_RGID 0x010 | |
166 | #define DM_EGID 0x020 | |
167 | #define DM_DELAY 0x100 | |
168 | ||
0f303493 | 169 | /* |
864dbfa3 | 170 | * symbol creation flags, for use in gv_fetchpv() and get_*v() |
0f303493 GS |
171 | */ |
172 | #define GV_ADD 0x01 /* add, if symbol not already there */ | |
173 | #define GV_ADDMULTI 0x02 /* add, pretending it has been added already */ | |
174 | #define GV_ADDWARN 0x04 /* add, but warn if symbol wasn't already there */ | |
175 | #define GV_ADDINEVAL 0x08 /* add, as though we're doing so within an eval */ | |
176 | #define GV_NOINIT 0x10 /* add, but don't init symbol, if type != PVGV */ | |
add2581e NC |
177 | /* This is used by toke.c to avoid turing placeholder constants in the symbol |
178 | table into full PVGVs with attached constant subroutines. */ | |
179 | #define GV_NOADD_NOINIT 0x20 /* Don't add the symbol if it's not there. | |
180 | Don't init it if it is there but ! PVGV */ | |
e26df76a | 181 | #define GV_NOEXPAND 0x40 /* Don't expand SvOK() entries to PVGV */ |
fafc274c NC |
182 | #define GV_NOTQUAL 0x80 /* A plain symbol name, not qualified with a |
183 | package (so skip checks for :: and ') */ | |
add2581e | 184 | |
7a5fd60d NC |
185 | /* SVf_UTF8 (more accurately the return value from SvUTF8) is also valid |
186 | as a flag to gv_fetch_pvn_flags, so ensure it lies outside this range. | |
187 | */ | |
d9a22066 NC |
188 | #define gv_fullname3(sv,gv,prefix) gv_fullname4(sv,gv,prefix,TRUE) |
189 | #define gv_efullname3(sv,gv,prefix) gv_efullname4(sv,gv,prefix,TRUE) | |
887986eb | 190 | #define gv_fetchmethod(stash, name) gv_fetchmethod_autoload(stash, name, TRUE) |