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 (*({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 GvFLAGS(gv) \ 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);})) 39 # define GvSTASH(gv) \ 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); \ 44 })) 45 # define GvNAME_HEK(gv) \ 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); \ 51 })) 52 # define GvNAME_get(gv) ({ assert(GvNAME_HEK(gv)); (char *)HEK_KEY(GvNAME_HEK(gv)); }) 53 # define GvNAMELEN_get(gv) ({ assert(GvNAME_HEK(gv)); HEK_LEN(GvNAME_HEK(gv)); }) 54 #else 55 # define GvGP(gv) ((gv)->sv_u.svu_gp) 56 # define GvFLAGS(gv) (GvXPVGV(gv)->xpv_cur) 57 # define GvSTASH(gv) (GvXPVGV(gv)->xnv_u.xgv_stash) 58 # define GvNAME_HEK(gv) (GvXPVGV(gv)->xiv_u.xivu_namehek) 59 # define GvNAME_get(gv) HEK_KEY(GvNAME_HEK(gv)) 60 # define GvNAMELEN_get(gv) HEK_LEN(GvNAME_HEK(gv)) 61 #endif 62 63 #define GvNAME(gv) GvNAME_get(gv) 64 #define GvNAMELEN(gv) GvNAMELEN_get(gv) 65 66 #define GvASSIGN_GENERATION(gv) (0 + ((XPV*) SvANY(gv))->xpv_len) 67 #define GvASSIGN_GENERATION_set(gv,val) \ 68 STMT_START { assert(SvTYPE(gv) == SVt_PVGV); \ 69 (((XPV*) SvANY(gv))->xpv_len = (val)); } STMT_END 70 71 /* 72 =head1 GV Functions 73 74 =for apidoc Am|SV*|GvSV|GV* gv 75 76 Return the SV from the GV. 77 78 =cut 79 */ 80 81 #define GvSV(gv) (GvGP(gv)->gp_sv) 82 #ifdef PERL_DONT_CREATE_GVSV 83 #define GvSVn(gv) (*(GvGP(gv)->gp_sv ? \ 84 &(GvGP(gv)->gp_sv) : \ 85 &(GvGP(gv_SVadd(gv))->gp_sv))) 86 #else 87 #define GvSVn(gv) GvSV(gv) 88 #endif 89 90 #define GvREFCNT(gv) (GvGP(gv)->gp_refcnt) 91 #define GvIO(gv) ((gv) && SvTYPE((const SV*)gv) == SVt_PVGV && GvGP(gv) ? GvIOp(gv) : NULL) 92 #define GvIOp(gv) (GvGP(gv)->gp_io) 93 #define GvIOn(gv) (GvIO(gv) ? GvIOp(gv) : GvIOp(gv_IOadd(gv))) 94 95 #define GvFORM(gv) (GvGP(gv)->gp_form) 96 #define GvAV(gv) (GvGP(gv)->gp_av) 97 98 #define GvAVn(gv) (GvGP(gv)->gp_av ? \ 99 GvGP(gv)->gp_av : \ 100 GvGP(gv_AVadd(gv))->gp_av) 101 #define GvHV(gv) ((GvGP(gv))->gp_hv) 102 103 #define GvHVn(gv) (GvGP(gv)->gp_hv ? \ 104 GvGP(gv)->gp_hv : \ 105 GvGP(gv_HVadd(gv))->gp_hv) 106 107 #define GvCV(gv) (GvGP(gv)->gp_cv) 108 #define GvCVGEN(gv) (GvGP(gv)->gp_cvgen) 109 #define GvCVu(gv) (GvGP(gv)->gp_cvgen ? NULL : GvGP(gv)->gp_cv) 110 111 #define GvLINE(gv) (GvGP(gv)->gp_line) 112 #define GvFILE_HEK(gv) (GvGP(gv)->gp_file_hek) 113 #define GvFILE(gv) (GvFILE_HEK(gv) ? HEK_KEY(GvFILE_HEK(gv)) : NULL) 114 #define GvFILEGV(gv) (gv_fetchfile(GvFILE(gv))) 115 116 #define GvEGV(gv) (GvGP(gv)->gp_egv) 117 #define GvENAME(gv) GvNAME(GvEGV(gv) ? GvEGV(gv) : gv) 118 #define GvESTASH(gv) GvSTASH(GvEGV(gv) ? GvEGV(gv) : gv) 119 120 #define GVf_INTRO 0x01 121 #define GVf_MULTI 0x02 122 #define GVf_ASSUMECV 0x04 123 #define GVf_IN_PAD 0x08 124 #define GVf_IMPORTED 0xF0 125 #define GVf_IMPORTED_SV 0x10 126 #define GVf_IMPORTED_AV 0x20 127 #define GVf_IMPORTED_HV 0x40 128 #define GVf_IMPORTED_CV 0x80 129 130 #define GvINTRO(gv) (GvFLAGS(gv) & GVf_INTRO) 131 #define GvINTRO_on(gv) (GvFLAGS(gv) |= GVf_INTRO) 132 #define GvINTRO_off(gv) (GvFLAGS(gv) &= ~GVf_INTRO) 133 134 #define GvMULTI(gv) (GvFLAGS(gv) & GVf_MULTI) 135 #define GvMULTI_on(gv) (GvFLAGS(gv) |= GVf_MULTI) 136 #define GvMULTI_off(gv) (GvFLAGS(gv) &= ~GVf_MULTI) 137 138 #define GvASSUMECV(gv) (GvFLAGS(gv) & GVf_ASSUMECV) 139 #define GvASSUMECV_on(gv) (GvFLAGS(gv) |= GVf_ASSUMECV) 140 #define GvASSUMECV_off(gv) (GvFLAGS(gv) &= ~GVf_ASSUMECV) 141 142 #define GvIMPORTED(gv) (GvFLAGS(gv) & GVf_IMPORTED) 143 #define GvIMPORTED_on(gv) (GvFLAGS(gv) |= GVf_IMPORTED) 144 #define GvIMPORTED_off(gv) (GvFLAGS(gv) &= ~GVf_IMPORTED) 145 146 #define GvIMPORTED_SV(gv) (GvFLAGS(gv) & GVf_IMPORTED_SV) 147 #define GvIMPORTED_SV_on(gv) (GvFLAGS(gv) |= GVf_IMPORTED_SV) 148 #define GvIMPORTED_SV_off(gv) (GvFLAGS(gv) &= ~GVf_IMPORTED_SV) 149 150 #define GvIMPORTED_AV(gv) (GvFLAGS(gv) & GVf_IMPORTED_AV) 151 #define GvIMPORTED_AV_on(gv) (GvFLAGS(gv) |= GVf_IMPORTED_AV) 152 #define GvIMPORTED_AV_off(gv) (GvFLAGS(gv) &= ~GVf_IMPORTED_AV) 153 154 #define GvIMPORTED_HV(gv) (GvFLAGS(gv) & GVf_IMPORTED_HV) 155 #define GvIMPORTED_HV_on(gv) (GvFLAGS(gv) |= GVf_IMPORTED_HV) 156 #define GvIMPORTED_HV_off(gv) (GvFLAGS(gv) &= ~GVf_IMPORTED_HV) 157 158 #define GvIMPORTED_CV(gv) (GvFLAGS(gv) & GVf_IMPORTED_CV) 159 #define GvIMPORTED_CV_on(gv) (GvFLAGS(gv) |= GVf_IMPORTED_CV) 160 #define GvIMPORTED_CV_off(gv) (GvFLAGS(gv) &= ~GVf_IMPORTED_CV) 161 162 #define GvIN_PAD(gv) (GvFLAGS(gv) & GVf_IN_PAD) 163 #define GvIN_PAD_on(gv) (GvFLAGS(gv) |= GVf_IN_PAD) 164 #define GvIN_PAD_off(gv) (GvFLAGS(gv) &= ~GVf_IN_PAD) 165 166 #ifndef PERL_CORE 167 # define Nullgv Null(GV*) 168 #endif 169 170 #define DM_UID 0x003 171 #define DM_RUID 0x001 172 #define DM_EUID 0x002 173 #define DM_ARRAY 0x004 174 #define DM_GID 0x030 175 #define DM_RGID 0x010 176 #define DM_EGID 0x020 177 #define DM_DELAY 0x100 178 179 /* 180 * symbol creation flags, for use in gv_fetchpv() and get_*v() 181 */ 182 #define GV_ADD 0x01 /* add, if symbol not already there 183 For gv_name_set, adding a HEK for the first 184 time, so don't try to free what's there. */ 185 #define GV_ADDMULTI 0x02 /* add, pretending it has been added already */ 186 #define GV_ADDWARN 0x04 /* add, but warn if symbol wasn't already there */ 187 #define GV_ADDINEVAL 0x08 /* add, as though we're doing so within an eval */ 188 #define GV_NOINIT 0x10 /* add, but don't init symbol, if type != PVGV */ 189 /* This is used by toke.c to avoid turing placeholder constants in the symbol 190 table into full PVGVs with attached constant subroutines. */ 191 #define GV_NOADD_NOINIT 0x20 /* Don't add the symbol if it's not there. 192 Don't init it if it is there but ! PVGV */ 193 #define GV_NOEXPAND 0x40 /* Don't expand SvOK() entries to PVGV */ 194 #define GV_NOTQUAL 0x80 /* A plain symbol name, not qualified with a 195 package (so skip checks for :: and ') */ 196 #define GV_AUTOLOAD 0x100 /* gv_fetchmethod_flags() should AUTOLOAD */ 197 #define GV_CROAK 0x200 /* gv_fetchmethod_flags() should croak */ 198 199 /* SVf_UTF8 (more accurately the return value from SvUTF8) is also valid 200 as a flag to gv_fetch_pvn_flags, so ensure it lies outside this range. 201 */ 202 203 #define GV_NOADD_MASK (SVf_UTF8|GV_NOADD_NOINIT|GV_NOEXPAND|GV_NOTQUAL) 204 /* The bit flags that don't cause gv_fetchpv() to add a symbol if not found */ 205 206 #define gv_fullname3(sv,gv,prefix) gv_fullname4(sv,gv,prefix,TRUE) 207 #define gv_efullname3(sv,gv,prefix) gv_efullname4(sv,gv,prefix,TRUE) 208 #define gv_fetchmethod(stash, name) gv_fetchmethod_autoload(stash, name, TRUE) 209 210 #define gv_AVadd(gv) gv_add_by_type((gv), SVt_PVAV) 211 #define gv_HVadd(gv) gv_add_by_type((gv), SVt_PVHV) 212 #define gv_IOadd(gv) gv_add_by_type((gv), SVt_PVIO) 213 #define gv_SVadd(gv) gv_add_by_type((gv), SVt_NULL) 214 215 /* 216 * Local variables: 217 * c-indentation-style: bsd 218 * c-basic-offset: 4 219 * indent-tabs-mode: t 220 * End: 221 * 222 * ex: set ts=8 sts=4 sw=4 noet: 223 */ 224