| | 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 | =cut |
| | 87 | */ |
| | 88 | |
| | 89 | #define GvSV(gv) (GvGP(gv)->gp_sv) |
| | 90 | #ifdef PERL_DONT_CREATE_GVSV |
| | 91 | #define GvSVn(gv) (*(GvGP(gv)->gp_sv ? \ |
| | 92 | &(GvGP(gv)->gp_sv) : \ |
| | 93 | &(GvGP(gv_SVadd(gv))->gp_sv))) |
| | 94 | #else |
| | 95 | #define GvSVn(gv) GvSV(gv) |
| | 96 | #endif |
| | 97 | |
| | 98 | #define GvREFCNT(gv) (GvGP(gv)->gp_refcnt) |
| | 99 | #define GvIO(gv) \ |
| | 100 | ( \ |
| | 101 | (gv) \ |
| | 102 | && ( \ |
| | 103 | SvTYPE((const SV*)(gv)) == SVt_PVGV \ |
| | 104 | || SvTYPE((const SV*)(gv)) == SVt_PVLV \ |
| | 105 | ) \ |
| | 106 | && GvGP(gv) \ |
| | 107 | ? GvIOp(gv) \ |
| | 108 | : NULL \ |
| | 109 | ) |
| | 110 | #define GvIOp(gv) (GvGP(gv)->gp_io) |
| | 111 | #define GvIOn(gv) (GvIO(gv) ? GvIOp(gv) : GvIOp(gv_IOadd(gv))) |
| | 112 | |
| | 113 | #define GvFORM(gv) (GvGP(gv)->gp_form) |
| | 114 | #define GvAV(gv) (GvGP(gv)->gp_av) |
| | 115 | |
| | 116 | #define GvAVn(gv) (GvGP(gv)->gp_av ? \ |
| | 117 | GvGP(gv)->gp_av : \ |
| | 118 | GvGP(gv_AVadd(gv))->gp_av) |
| | 119 | #define GvHV(gv) ((GvGP(gv))->gp_hv) |
| | 120 | |
| | 121 | #define GvHVn(gv) (GvGP(gv)->gp_hv ? \ |
| | 122 | GvGP(gv)->gp_hv : \ |
| | 123 | GvGP(gv_HVadd(gv))->gp_hv) |
| | 124 | |
| | 125 | #define GvCV(gv) (0+GvGP(gv)->gp_cv) |
| | 126 | #define GvCV_set(gv,cv) (GvGP(gv)->gp_cv = (cv)) |
| | 127 | #define GvCVGEN(gv) (GvGP(gv)->gp_cvgen) |
| | 128 | #define GvCVu(gv) (GvGP(gv)->gp_cvgen ? NULL : GvGP(gv)->gp_cv) |
| | 129 | |
| | 130 | #define GvLINE(gv) (GvGP(gv)->gp_line) |
| | 131 | #define GvFILE_HEK(gv) (GvGP(gv)->gp_file_hek) |
| | 132 | #define GvFILE(gv) (GvFILE_HEK(gv) ? HEK_KEY(GvFILE_HEK(gv)) : NULL) |
| | 133 | #define GvFILEGV(gv) (gv_fetchfile(GvFILE(gv))) |
| | 134 | |
| | 135 | #define GvEGV(gv) (GvGP(gv)->gp_egv) |
| | 136 | #define GvEGVx(gv) (isGV_with_GP(gv) ? GvEGV(gv) : NULL) |
| | 137 | #define GvENAME(gv) GvNAME(GvEGV(gv) ? GvEGV(gv) : gv) |
| | 138 | #define GvENAMELEN(gv) GvNAMELEN(GvEGV(gv) ? GvEGV(gv) : gv) |
| | 139 | #define GvENAMEUTF8(gv) GvNAMEUTF8(GvEGV(gv) ? GvEGV(gv) : gv) |
| | 140 | #define GvENAME_HEK(gv) GvNAME_HEK(GvEGV(gv) ? GvEGV(gv) : gv) |
| | 141 | #define GvESTASH(gv) GvSTASH(GvEGV(gv) ? GvEGV(gv) : gv) |
| | 142 | |
| | 143 | #define GVf_INTRO 0x01 |
| | 144 | #define GVf_MULTI 0x02 |
| | 145 | #define GVf_ASSUMECV 0x04 |
| | 146 | #define GVf_IN_PAD 0x08 |
| | 147 | #define GVf_IMPORTED 0xF0 |
| | 148 | #define GVf_IMPORTED_SV 0x10 |
| | 149 | #define GVf_IMPORTED_AV 0x20 |
| | 150 | #define GVf_IMPORTED_HV 0x40 |
| | 151 | #define GVf_IMPORTED_CV 0x80 |
| | 152 | |
| | 153 | #define GvINTRO(gv) (GvFLAGS(gv) & GVf_INTRO) |
| | 154 | #define GvINTRO_on(gv) (GvFLAGS(gv) |= GVf_INTRO) |
| | 155 | #define GvINTRO_off(gv) (GvFLAGS(gv) &= ~GVf_INTRO) |
| | 156 | |
| | 157 | #define GvMULTI(gv) (GvFLAGS(gv) & GVf_MULTI) |
| | 158 | #define GvMULTI_on(gv) (GvFLAGS(gv) |= GVf_MULTI) |
| | 159 | #define GvMULTI_off(gv) (GvFLAGS(gv) &= ~GVf_MULTI) |
| | 160 | |
| | 161 | #define GvASSUMECV(gv) (GvFLAGS(gv) & GVf_ASSUMECV) |
| | 162 | #define GvASSUMECV_on(gv) (GvFLAGS(gv) |= GVf_ASSUMECV) |
| | 163 | #define GvASSUMECV_off(gv) (GvFLAGS(gv) &= ~GVf_ASSUMECV) |
| | 164 | |
| | 165 | #define GvIMPORTED(gv) (GvFLAGS(gv) & GVf_IMPORTED) |
| | 166 | #define GvIMPORTED_on(gv) (GvFLAGS(gv) |= GVf_IMPORTED) |
| | 167 | #define GvIMPORTED_off(gv) (GvFLAGS(gv) &= ~GVf_IMPORTED) |
| | 168 | |
| | 169 | #define GvIMPORTED_SV(gv) (GvFLAGS(gv) & GVf_IMPORTED_SV) |
| | 170 | #define GvIMPORTED_SV_on(gv) (GvFLAGS(gv) |= GVf_IMPORTED_SV) |
| | 171 | #define GvIMPORTED_SV_off(gv) (GvFLAGS(gv) &= ~GVf_IMPORTED_SV) |
| | 172 | |
| | 173 | #define GvIMPORTED_AV(gv) (GvFLAGS(gv) & GVf_IMPORTED_AV) |
| | 174 | #define GvIMPORTED_AV_on(gv) (GvFLAGS(gv) |= GVf_IMPORTED_AV) |
| | 175 | #define GvIMPORTED_AV_off(gv) (GvFLAGS(gv) &= ~GVf_IMPORTED_AV) |
| | 176 | |
| | 177 | #define GvIMPORTED_HV(gv) (GvFLAGS(gv) & GVf_IMPORTED_HV) |
| | 178 | #define GvIMPORTED_HV_on(gv) (GvFLAGS(gv) |= GVf_IMPORTED_HV) |
| | 179 | #define GvIMPORTED_HV_off(gv) (GvFLAGS(gv) &= ~GVf_IMPORTED_HV) |
| | 180 | |
| | 181 | #define GvIMPORTED_CV(gv) (GvFLAGS(gv) & GVf_IMPORTED_CV) |
| | 182 | #define GvIMPORTED_CV_on(gv) (GvFLAGS(gv) |= GVf_IMPORTED_CV) |
| | 183 | #define GvIMPORTED_CV_off(gv) (GvFLAGS(gv) &= ~GVf_IMPORTED_CV) |
| | 184 | |
| | 185 | #define GvIN_PAD(gv) (GvFLAGS(gv) & GVf_IN_PAD) |
| | 186 | #define GvIN_PAD_on(gv) (GvFLAGS(gv) |= GVf_IN_PAD) |
| | 187 | #define GvIN_PAD_off(gv) (GvFLAGS(gv) &= ~GVf_IN_PAD) |
| | 188 | |
| | 189 | #ifndef PERL_CORE |
| | 190 | # define Nullgv Null(GV*) |
| | 191 | #endif |
| | 192 | |
| | 193 | #define DM_RUID 0x001 |
| | 194 | #define DM_EUID 0x002 |
| | 195 | #define DM_UID (DM_RUID|DM_EUID) |
| | 196 | #define DM_ARRAY_ISA 0x004 |
| | 197 | #define DM_RGID 0x010 |
| | 198 | #define DM_EGID 0x020 |
| | 199 | #define DM_GID (DM_RGID|DM_EGID) |
| | 200 | #define DM_DELAY 0x100 |
| | 201 | |
| | 202 | /* |
| | 203 | * symbol creation flags, for use in gv_fetchpv() and get_*v() |
| | 204 | */ |
| | 205 | #define GV_ADD 0x01 /* add, if symbol not already there |
| | 206 | For gv_name_set, adding a HEK for the first |
| | 207 | time, so don't try to free what's there. */ |
| | 208 | #define GV_ADDMULTI 0x02 /* add, pretending it has been added |
| | 209 | already; used also by gv_init_* */ |
| | 210 | #define GV_ADDWARN 0x04 /* add, but warn if symbol wasn't already there */ |
| | 211 | #define GV_ADDINEVAL 0x08 /* add, as though we're doing so within an eval */ |
| | 212 | #define GV_NOINIT 0x10 /* add, but don't init symbol, if type != PVGV */ |
| | 213 | /* This is used by toke.c to avoid turing placeholder constants in the symbol |
| | 214 | table into full PVGVs with attached constant subroutines. */ |
| | 215 | #define GV_NOADD_NOINIT 0x20 /* Don't add the symbol if it's not there. |
| | 216 | Don't init it if it is there but ! PVGV */ |
| | 217 | #define GV_NOEXPAND 0x40 /* Don't expand SvOK() entries to PVGV */ |
| | 218 | #define GV_NOTQUAL 0x80 /* A plain symbol name, not qualified with a |
| | 219 | package (so skip checks for :: and ') */ |
| | 220 | #define GV_AUTOLOAD 0x100 /* gv_fetchmethod_flags() should AUTOLOAD */ |
| | 221 | #define GV_CROAK 0x200 /* gv_fetchmethod_flags() should croak */ |
| | 222 | #define GV_ADDMG 0x400 /* add if magical */ |
| | 223 | #define GV_NO_SVGMAGIC 0x800 /* Skip get-magic on an SV argument; |
| | 224 | used only by gv_fetchsv(_nomg) */ |
| | 225 | |
| | 226 | /* Flags for gv_autoload_*/ |
| | 227 | #define GV_AUTOLOAD_ISMETHOD 1 /* autoloading a method? */ |
| | 228 | |
| | 229 | /* SVf_UTF8 (more accurately the return value from SvUTF8) is also valid |
| | 230 | as a flag to various gv_* functions, so ensure it lies |
| | 231 | outside this range. |
| | 232 | */ |
| | 233 | |
| | 234 | #define GV_NOADD_MASK \ |
| | 235 | (SVf_UTF8|GV_NOADD_NOINIT|GV_NOEXPAND|GV_NOTQUAL|GV_ADDMG|GV_NO_SVGMAGIC) |
| | 236 | /* The bit flags that don't cause gv_fetchpv() to add a symbol if not |
| | 237 | found (with the exception GV_ADDMG, which *might* cause the symbol |
| | 238 | to be added) */ |
| | 239 | |
| | 240 | #define gv_fullname3(sv,gv,prefix) gv_fullname4(sv,gv,prefix,TRUE) |
| | 241 | #define gv_efullname3(sv,gv,prefix) gv_efullname4(sv,gv,prefix,TRUE) |
| | 242 | #define gv_fetchmethod(stash, name) gv_fetchmethod_autoload(stash, name, TRUE) |
| | 243 | #define gv_fetchsv_nomg(n,f,t) gv_fetchsv(n,(f)|GV_NO_SVGMAGIC,t) |
| | 244 | #define gv_init(gv,stash,name,len,multi) \ |
| | 245 | gv_init_pvn(gv,stash,name,len,GV_ADDMULTI*!!(multi)) |
| | 246 | #define gv_fetchmeth(stash,name,len,level) gv_fetchmeth_pvn(stash, name, len, level, 0) |
| | 247 | #define gv_fetchmeth_autoload(stash,name,len,level) gv_fetchmeth_pvn_autoload(stash, name, len, level, 0) |
| | 248 | #define gv_fetchmethod_flags(stash,name,flags) gv_fetchmethod_pv_flags(stash, name, flags) |
| | 249 | #define gv_autoload4(stash, name, len, method) \ |
| | 250 | gv_autoload_pvn(stash, name, len, !!(method)) |
| | 251 | #define newGVgen(pack) newGVgen_flags(pack, 0) |
| | 252 | |
| | 253 | #define gv_AVadd(gv) gv_add_by_type((gv), SVt_PVAV) |
| | 254 | #define gv_HVadd(gv) gv_add_by_type((gv), SVt_PVHV) |
| | 255 | #define gv_IOadd(gv) gv_add_by_type((gv), SVt_PVIO) |
| | 256 | #define gv_SVadd(gv) gv_add_by_type((gv), SVt_NULL) |
| | 257 | |
| | 258 | /* |
| | 259 | * Local variables: |
| | 260 | * c-indentation-style: bsd |
| | 261 | * c-basic-offset: 4 |
| | 262 | * indent-tabs-mode: nil |
| | 263 | * End: |
| | 264 | * |
| | 265 | * ex: set ts=8 sts=4 sw=4 et: |
| | 266 | */ |
https://perl5.git.perl.org / perl5.git / blame_incremental