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