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 GvFLAGS(gv)     (GvXPVGV(gv)->xgv_flags)
  42
  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
  52 /*
  53 =head1 GV Functions
  54
  55 =for apidoc Am|SV*|GvSV|GV* gv
  56
  57 Return the SV from the GV.
  58
  59 =cut
  60 */
  61
  62 #define GvSV(gv)        (GvGP(gv)->gp_sv)
  63 #ifdef PERL_DONT_CREATE_GVSV
  64 #define GvSVn(gv)       (*(GvGP(gv)->gp_sv ? \
  65                          &(GvGP(gv)->gp_sv) : \
  66                          &(GvGP(gv_SVadd(gv))->gp_sv)))
  67 #else
  68 #define GvSVn(gv)       GvSV(gv)
  69 #endif
  70
  71 #define GvREFCNT(gv)    (GvGP(gv)->gp_refcnt)
  72 #define GvIO(gv)        ((gv) && SvTYPE((SV*)gv) == SVt_PVGV && GvGP(gv) ? GvIOp(gv) : 0)
  73 #define GvIOp(gv)       (GvGP(gv)->gp_io)
  74 #define GvIOn(gv)       (GvIO(gv) ? GvIOp(gv) : GvIOp(gv_IOadd(gv)))
  75
  76 #define GvFORM(gv)      (GvGP(gv)->gp_form)
  77 #define GvAV(gv)        (GvGP(gv)->gp_av)
  78
  79 /* This macro is deprecated.  Do not use! */
  80 #define GvREFCNT_inc(gv) ((GV*)SvREFCNT_inc(gv))        /* DO NOT USE */
  81
  82 #define GvAVn(gv)       (GvGP(gv)->gp_av ? \
  83                          GvGP(gv)->gp_av : \
  84                          GvGP(gv_AVadd(gv))->gp_av)
  85 #define GvHV(gv)        ((GvGP(gv))->gp_hv)
  86
  87 #define GvHVn(gv)       (GvGP(gv)->gp_hv ? \
  88                          GvGP(gv)->gp_hv : \
  89                          GvGP(gv_HVadd(gv))->gp_hv)
  90
  91 #define GvCV(gv)        (GvGP(gv)->gp_cv)
  92 #define GvCVGEN(gv)     (GvGP(gv)->gp_cvgen)
  93 #define GvCVu(gv)       (GvGP(gv)->gp_cvgen ? NULL : GvGP(gv)->gp_cv)
  94
  95 #define GvLINE(gv)      (GvGP(gv)->gp_line)
  96 #define GvFILE(gv)      (GvGP(gv)->gp_file)
  97 #define GvFILEGV(gv)    (gv_fetchfile(GvFILE(gv)))
  98
  99 #define GvEGV(gv)       (GvGP(gv)->gp_egv)
 100 #define GvENAME(gv)     GvNAME(GvEGV(gv) ? GvEGV(gv) : gv)
 101 #define GvESTASH(gv)    GvSTASH(GvEGV(gv) ? GvEGV(gv) : gv)
 102
 103 #define GVf_INTRO       0x01
 104 #define GVf_MULTI       0x02
 105 #define GVf_ASSUMECV    0x04
 106 #define GVf_IN_PAD      0x08
 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
 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
 149 #define GvUNIQUE(gv)            0
 150 #define GvUNIQUE_on(gv)
 151 #define GvUNIQUE_off(gv)
 152
 153 #ifdef USE_ITHREADS
 154 #define GV_UNIQUE_CHECK
 155 #else
 156 #undef  GV_UNIQUE_CHECK
 157 #endif
 158
 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
 169 /*
 170  * symbol creation flags, for use in gv_fetchpv() and get_*v()
 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 */
 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 */
 181 #define GV_NOEXPAND     0x40    /* Don't expand SvOK() entries to PVGV */
 182 #define GV_NOTQUAL      0x80    /* A plain symbol name, not qualified with a
 183                                    package (so skip checks for :: and ')  */
 184
 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 */
 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)
 190 #define gv_fetchmethod(stash, name) gv_fetchmethod_autoload(stash, name, TRUE)