cop.h

   1 /*    cop.h
   2  *
   3  *    Copyright (c) 1991-1994, Larry Wall
   4  *
   5  *    You may distribute under the terms of either the GNU General Public
   6  *    License or the Artistic License, as specified in the README file.
   7  *
   8  */
   9
  10 struct cop {
  11     BASEOP
  12     char *      cop_label;      /* label for this construct */
  13     HV *        cop_stash;      /* package line was compiled in */
  14     GV *        cop_filegv;     /* file the following line # is from */
  15     U32         cop_seq;        /* parse sequence number */
  16     I32         cop_arybase;    /* array base this line was compiled with */
  17     line_t      cop_line;       /* line # of this command */
  18 };
  19
  20 #define Nullcop Null(COP*)
  21
  22 /*
  23  * Here we have some enormously heavy (or at least ponderous) wizardry.
  24  */
  25
  26 /* subroutine context */
  27 struct block_sub {
  28     CV *        cv;
  29     GV *        gv;
  30     GV *        dfoutgv;
  31     AV *        savearray;
  32     AV *        argarray;
  33     U16         olddepth;
  34     U8          hasargs;
  35 };
  36
  37 #define PUSHSUB(cx)                                                     \
  38         cx->blk_sub.cv = cv;                                            \
  39         cx->blk_sub.olddepth = CvDEPTH(cv);                             \
  40         cx->blk_sub.hasargs = hasargs;
  41
  42 #define PUSHFORMAT(cx)                                                  \
  43         cx->blk_sub.cv = cv;                                            \
  44         cx->blk_sub.gv = gv;                                            \
  45         cx->blk_sub.hasargs = 0;                                        \
  46         cx->blk_sub.dfoutgv = defoutgv;                                 \
  47         (void)SvREFCNT_inc(cx->blk_sub.dfoutgv)
  48
  49 #define POPSUB(cx)                                                      \
  50         if (cx->blk_sub.hasargs) {   /* put back old @_ */              \
  51             SvREFCNT_dec(GvAV(defgv));                                  \
  52             GvAV(defgv) = cx->blk_sub.savearray;                        \
  53         }                                                               \
  54         if (cx->blk_sub.cv) {                                           \
  55             if (!(CvDEPTH(cx->blk_sub.cv) = cx->blk_sub.olddepth))      \
  56                 SvREFCNT_dec((SV*)cx->blk_sub.cv);                      \
  57         }
  58
  59 #define POPFORMAT(cx)                                                   \
  60         setdefout(cx->blk_sub.dfoutgv);                                 \
  61         SvREFCNT_dec(cx->blk_sub.dfoutgv);
  62
  63 /* eval context */
  64 struct block_eval {
  65     I32         old_in_eval;
  66     I32         old_op_type;
  67     char *      old_name;
  68     OP *        old_eval_root;
  69     SV *        cur_text;
  70 };
  71
  72 #define PUSHEVAL(cx,n,fgv)                                              \
  73         cx->blk_eval.old_in_eval = in_eval;                             \
  74         cx->blk_eval.old_op_type = op->op_type;                         \
  75         cx->blk_eval.old_name = n;                                      \
  76         cx->blk_eval.old_eval_root = eval_root;                         \
  77         cx->blk_eval.cur_text = linestr;
  78
  79 #define POPEVAL(cx)                                                     \
  80         in_eval = cx->blk_eval.old_in_eval;                             \
  81         optype = cx->blk_eval.old_op_type;                              \
  82         eval_root = cx->blk_eval.old_eval_root;
  83
  84 /* loop context */
  85 struct block_loop {
  86     char *      label;
  87     I32         resetsp;
  88     OP *        redo_op;
  89     OP *        next_op;
  90     OP *        last_op;
  91     SV **       itervar;
  92     SV *        itersave;
  93     SV *        iterlval;
  94     AV *        iterary;
  95     I32         iterix;
  96 };
  97
  98 #define PUSHLOOP(cx, ivar, s)                                           \
  99         cx->blk_loop.label = curcop->cop_label;                         \
 100         cx->blk_loop.resetsp = s - stack_base;                          \
 101         cx->blk_loop.redo_op = cLOOP->op_redoop;                        \
 102         cx->blk_loop.next_op = cLOOP->op_nextop;                        \
 103         cx->blk_loop.last_op = cLOOP->op_lastop;                        \
 104         cx->blk_loop.iterlval = Nullsv;                                 \
 105         if (cx->blk_loop.itervar = (ivar))                              \
 106             cx->blk_loop.itersave = SvREFCNT_inc(*cx->blk_loop.itervar);
 107
 108 #define POPLOOP(cx)                                                     \
 109         newsp           = stack_base + cx->blk_loop.resetsp;            \
 110         SvREFCNT_dec(cx->blk_loop.iterlval);                            \
 111         if (cx->blk_loop.itervar) {                                     \
 112             SvREFCNT_dec(*cx->blk_loop.itervar);                        \
 113             *cx->blk_loop.itervar = cx->blk_loop.itersave;              \
 114         }
 115
 116 /* context common to subroutines, evals and loops */
 117 struct block {
 118     I32         blku_oldsp;     /* stack pointer to copy stuff down to */
 119     COP *       blku_oldcop;    /* old curcop pointer */
 120     I32         blku_oldretsp;  /* return stack index */
 121     I32         blku_oldmarksp; /* mark stack index */
 122     I32         blku_oldscopesp;        /* scope stack index */
 123     PMOP *      blku_oldpm;     /* values of pattern match vars */
 124     U8          blku_gimme;     /* is this block running in list context? */
 125
 126     union {
 127         struct block_sub        blku_sub;
 128         struct block_eval       blku_eval;
 129         struct block_loop       blku_loop;
 130     } blk_u;
 131 };
 132 #define blk_oldsp       cx_u.cx_blk.blku_oldsp
 133 #define blk_oldcop      cx_u.cx_blk.blku_oldcop
 134 #define blk_oldretsp    cx_u.cx_blk.blku_oldretsp
 135 #define blk_oldmarksp   cx_u.cx_blk.blku_oldmarksp
 136 #define blk_oldscopesp  cx_u.cx_blk.blku_oldscopesp
 137 #define blk_oldpm       cx_u.cx_blk.blku_oldpm
 138 #define blk_gimme       cx_u.cx_blk.blku_gimme
 139 #define blk_sub         cx_u.cx_blk.blk_u.blku_sub
 140 #define blk_eval        cx_u.cx_blk.blk_u.blku_eval
 141 #define blk_loop        cx_u.cx_blk.blk_u.blku_loop
 142
 143 /* Enter a block. */
 144 #define PUSHBLOCK(cx,t,sp) CXINC, cx = &cxstack[cxstack_ix],            \
 145         cx->cx_type             = t,                                    \
 146         cx->blk_oldsp           = sp - stack_base,                      \
 147         cx->blk_oldcop          = curcop,                               \
 148         cx->blk_oldmarksp       = markstack_ptr - markstack,            \
 149         cx->blk_oldscopesp      = scopestack_ix,                        \
 150         cx->blk_oldretsp        = retstack_ix,                          \
 151         cx->blk_oldpm           = curpm,                                \
 152         cx->blk_gimme           = gimme;                                \
 153         DEBUG_l( PerlIO_printf(PerlIO_stderr(), "Entering block %ld, type %s\n",        \
 154                     (long)cxstack_ix, block_type[t]); )
 155
 156 /* Exit a block (RETURN and LAST). */
 157 #define POPBLOCK(cx,pm) cx = &cxstack[cxstack_ix--],                    \
 158         newsp           = stack_base + cx->blk_oldsp,                   \
 159         curcop          = cx->blk_oldcop,                               \
 160         markstack_ptr   = markstack + cx->blk_oldmarksp,                \
 161         scopestack_ix   = cx->blk_oldscopesp,                           \
 162         retstack_ix     = cx->blk_oldretsp,                             \
 163         pm              = cx->blk_oldpm,                                \
 164         gimme           = cx->blk_gimme;                                \
 165         DEBUG_l( PerlIO_printf(PerlIO_stderr(), "Leaving block %ld, type %s\n",         \
 166                     (long)cxstack_ix+1,block_type[cx->cx_type]); )
 167
 168 /* Continue a block elsewhere (NEXT and REDO). */
 169 #define TOPBLOCK(cx) cx = &cxstack[cxstack_ix],                         \
 170         stack_sp        = stack_base + cx->blk_oldsp,                   \
 171         markstack_ptr   = markstack + cx->blk_oldmarksp,                \
 172         scopestack_ix   = cx->blk_oldscopesp,                           \
 173         retstack_ix     = cx->blk_oldretsp
 174
 175 /* substitution context */
 176 struct subst {
 177     I32         sbu_iters;
 178     I32         sbu_maxiters;
 179     I32         sbu_safebase;
 180     I32         sbu_oldsave;
 181     bool        sbu_once;
 182     bool        sbu_rxtainted;
 183     char *      sbu_orig;
 184     SV *        sbu_dstr;
 185     SV *        sbu_targ;
 186     char *      sbu_s;
 187     char *      sbu_m;
 188     char *      sbu_strend;
 189     char *      sbu_subbase;
 190     REGEXP *    sbu_rx;
 191 };
 192 #define sb_iters        cx_u.cx_subst.sbu_iters
 193 #define sb_maxiters     cx_u.cx_subst.sbu_maxiters
 194 #define sb_safebase     cx_u.cx_subst.sbu_safebase
 195 #define sb_oldsave      cx_u.cx_subst.sbu_oldsave
 196 #define sb_once         cx_u.cx_subst.sbu_once
 197 #define sb_rxtainted    cx_u.cx_subst.sbu_rxtainted
 198 #define sb_orig         cx_u.cx_subst.sbu_orig
 199 #define sb_dstr         cx_u.cx_subst.sbu_dstr
 200 #define sb_targ         cx_u.cx_subst.sbu_targ
 201 #define sb_s            cx_u.cx_subst.sbu_s
 202 #define sb_m            cx_u.cx_subst.sbu_m
 203 #define sb_strend       cx_u.cx_subst.sbu_strend
 204 #define sb_subbase      cx_u.cx_subst.sbu_subbase
 205 #define sb_rx           cx_u.cx_subst.sbu_rx
 206
 207 #define PUSHSUBST(cx) CXINC, cx = &cxstack[cxstack_ix],                 \
 208         cx->sb_iters            = iters,                                \
 209         cx->sb_maxiters         = maxiters,                             \
 210         cx->sb_safebase         = safebase,                             \
 211         cx->sb_oldsave          = oldsave,                              \
 212         cx->sb_once             = once,                                 \
 213         cx->sb_rxtainted        = rxtainted,                            \
 214         cx->sb_orig             = orig,                                 \
 215         cx->sb_dstr             = dstr,                                 \
 216         cx->sb_targ             = targ,                                 \
 217         cx->sb_s                = s,                                    \
 218         cx->sb_m                = m,                                    \
 219         cx->sb_strend           = strend,                               \
 220         cx->sb_rx               = rx,                                   \
 221         cx->cx_type             = CXt_SUBST
 222
 223 #define POPSUBST(cx) cxstack_ix--
 224
 225 struct context {
 226     I32         cx_type;        /* what kind of context this is */
 227     union {
 228         struct block    cx_blk;
 229         struct subst    cx_subst;
 230     } cx_u;
 231 };
 232 #define CXt_NULL        0
 233 #define CXt_SUB         1
 234 #define CXt_EVAL        2
 235 #define CXt_LOOP        3
 236 #define CXt_SUBST       4
 237 #define CXt_BLOCK       5
 238
 239 #define CXINC (cxstack_ix < cxstack_max ? ++cxstack_ix : (cxstack_ix = cxinc()))
 240
 241 /* "gimme" values */
 242 #define G_SCALAR        0
 243 #define G_ARRAY         1
 244
 245 /* extra flags for perl_call_* routines */
 246 #define G_DISCARD       2       /* Call FREETMPS. */
 247 #define G_EVAL          4       /* Assume eval {} around subroutine call. */
 248 #define G_NOARGS        8       /* Don't construct a @_ array. */
 249 #define G_KEEPERR      16       /* Append errors to $@ rather than overwriting it */