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