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             GvAV(defgv) = cx->blk_sub.savearray;                        \
  52         }                                                               \
  53         if (cx->blk_sub.cv) {                                           \
  54             if (!(CvDEPTH(cx->blk_sub.cv) = cx->blk_sub.olddepth)) {    \
  55                 if (cx->blk_sub.hasargs) {                              \
  56                     SvREFCNT_inc((SV*)cx->blk_sub.argarray);            \
  57                 }                                                       \
  58                 SvREFCNT_dec((SV*)cx->blk_sub.cv);                      \
  59             }                                                           \
  60         }
  61
  62 #define POPFORMAT(cx)                                                   \
  63         setdefout(cx->blk_sub.dfoutgv);                                 \
  64         SvREFCNT_dec(cx->blk_sub.dfoutgv);
  65
  66 /* eval context */
  67 struct block_eval {
  68     I32         old_in_eval;
  69     I32         old_op_type;
  70     char *      old_name;
  71     OP *        old_eval_root;
  72     SV *        cur_text;
  73 };
  74
  75 #define PUSHEVAL(cx,n,fgv)                                              \
  76         cx->blk_eval.old_in_eval = in_eval;                             \
  77         cx->blk_eval.old_op_type = op->op_type;                         \
  78         cx->blk_eval.old_name = n;                                      \
  79         cx->blk_eval.old_eval_root = eval_root;                         \
  80         cx->blk_eval.cur_text = linestr;
  81
  82 #define POPEVAL(cx)                                                     \
  83         in_eval = cx->blk_eval.old_in_eval;                             \
  84         optype = cx->blk_eval.old_op_type;                              \
  85         eval_root = cx->blk_eval.old_eval_root;
  86
  87 /* loop context */
  88 struct block_loop {
  89     char *      label;
  90     I32         resetsp;
  91     OP *        redo_op;
  92     OP *        next_op;
  93     OP *        last_op;
  94     SV **       itervar;
  95     SV *        itersave;
  96     SV *        iterlval;
  97     AV *        iterary;
  98     I32         iterix;
  99 };
 100
 101 #define PUSHLOOP(cx, ivar, s)                                           \
 102         cx->blk_loop.label = curcop->cop_label;                         \
 103         cx->blk_loop.resetsp = s - stack_base;                          \
 104         cx->blk_loop.redo_op = cLOOP->op_redoop;                        \
 105         cx->blk_loop.next_op = cLOOP->op_nextop;                        \
 106         cx->blk_loop.last_op = cLOOP->op_lastop;                        \
 107         cx->blk_loop.iterlval = Nullsv;                                 \
 108         if (cx->blk_loop.itervar = (ivar))                              \
 109             cx->blk_loop.itersave = SvREFCNT_inc(*cx->blk_loop.itervar);
 110
 111 #define POPLOOP(cx)                                                     \
 112         newsp           = stack_base + cx->blk_loop.resetsp;            \
 113         SvREFCNT_dec(cx->blk_loop.iterlval);                            \
 114         if (cx->blk_loop.itervar) {                                     \
 115             SvREFCNT_dec(*cx->blk_loop.itervar);                        \
 116             *cx->blk_loop.itervar = cx->blk_loop.itersave;              \
 117         }
 118
 119 /* context common to subroutines, evals and loops */
 120 struct block {
 121     I32         blku_oldsp;     /* stack pointer to copy stuff down to */
 122     COP *       blku_oldcop;    /* old curcop pointer */
 123     I32         blku_oldretsp;  /* return stack index */
 124     I32         blku_oldmarksp; /* mark stack index */
 125     I32         blku_oldscopesp;        /* scope stack index */
 126     PMOP *      blku_oldpm;     /* values of pattern match vars */
 127     U8          blku_gimme;     /* is this block running in list context? */
 128
 129     union {
 130         struct block_sub        blku_sub;
 131         struct block_eval       blku_eval;
 132         struct block_loop       blku_loop;
 133     } blk_u;
 134 };
 135 #define blk_oldsp       cx_u.cx_blk.blku_oldsp
 136 #define blk_oldcop      cx_u.cx_blk.blku_oldcop
 137 #define blk_oldretsp    cx_u.cx_blk.blku_oldretsp
 138 #define blk_oldmarksp   cx_u.cx_blk.blku_oldmarksp
 139 #define blk_oldscopesp  cx_u.cx_blk.blku_oldscopesp
 140 #define blk_oldpm       cx_u.cx_blk.blku_oldpm
 141 #define blk_gimme       cx_u.cx_blk.blku_gimme
 142 #define blk_sub         cx_u.cx_blk.blk_u.blku_sub
 143 #define blk_eval        cx_u.cx_blk.blk_u.blku_eval
 144 #define blk_loop        cx_u.cx_blk.blk_u.blku_loop
 145
 146 /* Enter a block. */
 147 #define PUSHBLOCK(cx,t,sp) CXINC, cx = &cxstack[cxstack_ix],            \
 148         cx->cx_type             = t,                                    \
 149         cx->blk_oldsp           = sp - stack_base,                      \
 150         cx->blk_oldcop          = curcop,                               \
 151         cx->blk_oldmarksp       = markstack_ptr - markstack,            \
 152         cx->blk_oldscopesp      = scopestack_ix,                        \
 153         cx->blk_oldretsp        = retstack_ix,                          \
 154         cx->blk_oldpm           = curpm,                                \
 155         cx->blk_gimme           = gimme;                                \
 156         DEBUG_l( PerlIO_printf(PerlIO_stderr(), "Entering block %ld, type %s\n",        \
 157                     (long)cxstack_ix, block_type[t]); )
 158
 159 /* Exit a block (RETURN and LAST). */
 160 #define POPBLOCK(cx,pm) cx = &cxstack[cxstack_ix--],                    \
 161         newsp           = stack_base + cx->blk_oldsp,                   \
 162         curcop          = cx->blk_oldcop,                               \
 163         markstack_ptr   = markstack + cx->blk_oldmarksp,                \
 164         scopestack_ix   = cx->blk_oldscopesp,                           \
 165         retstack_ix     = cx->blk_oldretsp,                             \
 166         pm              = cx->blk_oldpm,                                \
 167         gimme           = cx->blk_gimme;                                \
 168         DEBUG_l( PerlIO_printf(PerlIO_stderr(), "Leaving block %ld, type %s\n",         \
 169                     (long)cxstack_ix+1,block_type[cx->cx_type]); )
 170
 171 /* Continue a block elsewhere (NEXT and REDO). */
 172 #define TOPBLOCK(cx) cx = &cxstack[cxstack_ix],                         \
 173         stack_sp        = stack_base + cx->blk_oldsp,                   \
 174         markstack_ptr   = markstack + cx->blk_oldmarksp,                \
 175         scopestack_ix   = cx->blk_oldscopesp,                           \
 176         retstack_ix     = cx->blk_oldretsp
 177
 178 /* substitution context */
 179 struct subst {
 180     I32         sbu_iters;
 181     I32         sbu_maxiters;
 182     I32         sbu_safebase;
 183     I32         sbu_oldsave;
 184     bool        sbu_once;
 185     bool        sbu_rxtainted;
 186     char *      sbu_orig;
 187     SV *        sbu_dstr;
 188     SV *        sbu_targ;
 189     char *      sbu_s;
 190     char *      sbu_m;
 191     char *      sbu_strend;
 192     char *      sbu_subbase;
 193     REGEXP *    sbu_rx;
 194 };
 195 #define sb_iters        cx_u.cx_subst.sbu_iters
 196 #define sb_maxiters     cx_u.cx_subst.sbu_maxiters
 197 #define sb_safebase     cx_u.cx_subst.sbu_safebase
 198 #define sb_oldsave      cx_u.cx_subst.sbu_oldsave
 199 #define sb_once         cx_u.cx_subst.sbu_once
 200 #define sb_rxtainted    cx_u.cx_subst.sbu_rxtainted
 201 #define sb_orig         cx_u.cx_subst.sbu_orig
 202 #define sb_dstr         cx_u.cx_subst.sbu_dstr
 203 #define sb_targ         cx_u.cx_subst.sbu_targ
 204 #define sb_s            cx_u.cx_subst.sbu_s
 205 #define sb_m            cx_u.cx_subst.sbu_m
 206 #define sb_strend       cx_u.cx_subst.sbu_strend
 207 #define sb_subbase      cx_u.cx_subst.sbu_subbase
 208 #define sb_rx           cx_u.cx_subst.sbu_rx
 209
 210 #define PUSHSUBST(cx) CXINC, cx = &cxstack[cxstack_ix],                 \
 211         cx->sb_iters            = iters,                                \
 212         cx->sb_maxiters         = maxiters,                             \
 213         cx->sb_safebase         = safebase,                             \
 214         cx->sb_oldsave          = oldsave,                              \
 215         cx->sb_once             = once,                                 \
 216         cx->sb_rxtainted        = rxtainted,                            \
 217         cx->sb_orig             = orig,                                 \
 218         cx->sb_dstr             = dstr,                                 \
 219         cx->sb_targ             = targ,                                 \
 220         cx->sb_s                = s,                                    \
 221         cx->sb_m                = m,                                    \
 222         cx->sb_strend           = strend,                               \
 223         cx->sb_rx               = rx,                                   \
 224         cx->cx_type             = CXt_SUBST
 225
 226 #define POPSUBST(cx) cxstack_ix--
 227
 228 struct context {
 229     I32         cx_type;        /* what kind of context this is */
 230     union {
 231         struct block    cx_blk;
 232         struct subst    cx_subst;
 233     } cx_u;
 234 };
 235 #define CXt_NULL        0
 236 #define CXt_SUB         1
 237 #define CXt_EVAL        2
 238 #define CXt_LOOP        3
 239 #define CXt_SUBST       4
 240 #define CXt_BLOCK       5
 241
 242 #define CXINC (cxstack_ix < cxstack_max ? ++cxstack_ix : (cxstack_ix = cxinc()))
 243
 244 /* "gimme" values */
 245 #define G_SCALAR        0
 246 #define G_ARRAY         1
 247
 248 /* extra flags for perl_call_* routines */
 249 #define G_DISCARD       2       /* Call FREETMPS. */
 250 #define G_EVAL          4       /* Assume eval {} around subroutine call. */
 251 #define G_NOARGS        8       /* Don't construct a @_ array. */
 252 #define G_KEEPERR      16       /* Append errors to $@ rather than overwriting it */