This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
manually apply patch with a dependency on unapplied patch
[perl5.git] / cop.h
diff --git a/cop.h b/cop.h
index 8e7a88d..644f456 100644 (file)
--- a/cop.h
+++ b/cop.h
@@ -1,61 +1,20 @@
-/* $RCSfile: cmd.h,v $$Revision: 4.1 $$Date: 92/08/07 17:19:19 $
+/*    cop.h
  *
- *    Copyright (c) 1991, Larry Wall
+ *    Copyright (c) 1991-1997, Larry Wall
  *
  *    You may distribute under the terms of either the GNU General Public
  *    License or the Artistic License, as specified in the README file.
  *
- * $Log:       cmd.h,v $
- * Revision 4.1  92/08/07  17:19:19  lwall
- * Stage 6 Snapshot
- * 
- * Revision 4.0.1.2  92/06/08  12:01:02  lwall
- * patch20: removed implicit int declarations on funcions
- * 
- * Revision 4.0.1.1  91/06/07  10:28:50  lwall
- * patch4: new copyright notice
- * patch4: length($`), length($&), length($') now optimized to avoid string copy
- * 
- * Revision 4.0  91/03/20  01:04:34  lwall
- * 4.0 baseline.
- * 
  */
 
-struct acop {
-    GV         *acop_gv;       /* a symbol table entry */
-    OP         *acop_expr;     /* any associated expression */
-};
-
-struct ccop {
-    OP         *ccop_true;     /* normal code to do on if and while */
-    OP         *ccop_alt;      /* else cmd ptr or continue code */
-};
-
-struct scop {
-    OP         **scop_next;    /* array of pointers to commands */
-    short      scop_offset;    /* first value - 1 */
-    short      scop_max;       /* last value + 1 */
-};
-
 struct cop {
     BASEOP
-    OP         *cop_expr;      /* conditional expression */
-    OP         *cop_head;      /* head of this command list */
-    SV         *cop_short;     /* string to match as shortcut */
-    GV         *cop_gv;        /* a symbol table entry, mostly for fp */
-    char       *cop_label;     /* label for this construct */
-    union uop {
-       struct acop acop;       /* normal command */
-       struct ccop ccop;       /* compound command */
-       struct scop scop;       /* switch command */
-    } uop;
-    U32                cop_seq;        /* parse sequence number */
-    short      cop_slen;       /* len of cop_short, if not null */
-    VOL short  cop_flags;      /* optimization flags--see above */
+    char *     cop_label;      /* label for this construct */
     HV *       cop_stash;      /* package line was compiled in */
     GV *       cop_filegv;     /* file the following line # is from */
+    U32                cop_seq;        /* parse sequence number */
+    I32                cop_arybase;    /* array base this line was compiled with */
     line_t      cop_line;       /* line # of this command */
-    char       cop_type;       /* what this command does */
 };
 
 #define Nullcop Null(COP*)
@@ -68,38 +27,60 @@ struct cop {
 struct block_sub {
     CV *       cv;
     GV *       gv;
-    GV *       defgv;
+    GV *       dfoutgv;
+#ifndef USE_THREADS
     AV *       savearray;
+#endif /* USE_THREADS */
     AV *       argarray;
-    AV *       comppad;
     U16                olddepth;
     U8         hasargs;
 };
 
 #define PUSHSUB(cx)                                                    \
        cx->blk_sub.cv = cv;                                            \
-       cx->blk_sub.gv = gv;                                            \
        cx->blk_sub.olddepth = CvDEPTH(cv);                             \
        cx->blk_sub.hasargs = hasargs;
 
 #define PUSHFORMAT(cx)                                                 \
        cx->blk_sub.cv = cv;                                            \
        cx->blk_sub.gv = gv;                                            \
-       cx->blk_sub.defgv = defoutgv;                                   \
-       cx->blk_sub.hasargs = 0;
+       cx->blk_sub.hasargs = 0;                                        \
+       cx->blk_sub.dfoutgv = defoutgv;                                 \
+       (void)SvREFCNT_inc(cx->blk_sub.dfoutgv)
 
 #define POPSUB(cx)                                                     \
-       if (cx->blk_sub.hasargs) {   /* put back old @_ */              \
-           av_free(cx->blk_sub.argarray);                              \
-           GvAV(defgv) = cx->blk_sub.savearray;                        \
+       { struct block_sub cxsub;                                       \
+         POPSUB1(cx);                                                  \
+         POPSUB2(); }
+
+#define POPSUB1(cx)                                                    \
+       cxsub = cx->blk_sub;    /* because DESTROY may clobber *cx */
+
+#ifdef USE_THREADS
+#define POPSAVEARRAY() NOOP
+#else
+#define POPSAVEARRAY()                                                 \
+    STMT_START {                                                       \
+       SvREFCNT_dec(GvAV(defgv));                                      \
+       GvAV(defgv) = cxsub.savearray;                                  \
+    } STMT_END
+#endif /* USE_THREADS */
+
+#define POPSUB2()                                                      \
+       if (cxsub.hasargs) {                                            \
+           POPSAVEARRAY();                                             \
+           /* destroy arg array */                                     \
+           av_clear(cxsub.argarray);                                   \
+           AvREAL_off(cxsub.argarray);                                 \
        }                                                               \
-       if (!(CvDEPTH(cx->blk_sub.cv) = cx->blk_sub.olddepth)) {        \
-           if (CvDELETED(cx->blk_sub.cv))                              \
-               cv_free(cx->blk_sub.cv);                                \
+       if (cxsub.cv) {                                                 \
+           if (!(CvDEPTH(cxsub.cv) = cxsub.olddepth))                  \
+               SvREFCNT_dec(cxsub.cv);                                 \
        }
 
 #define POPFORMAT(cx)                                                  \
-       defoutgv = cx->blk_sub.defgv;
+       setdefout(cx->blk_sub.dfoutgv);                                 \
+       SvREFCNT_dec(cx->blk_sub.dfoutgv);
 
 /* eval context */
 struct block_eval {
@@ -107,13 +88,15 @@ struct block_eval {
     I32                old_op_type;
     char *     old_name;
     OP *       old_eval_root;
+    SV *       cur_text;
 };
 
-#define PUSHEVAL(cx,n)                                                 \
+#define PUSHEVAL(cx,n,fgv)                                             \
        cx->blk_eval.old_in_eval = in_eval;                             \
        cx->blk_eval.old_op_type = op->op_type;                         \
        cx->blk_eval.old_name = n;                                      \
-       cx->blk_eval.old_eval_root = eval_root;
+       cx->blk_eval.old_eval_root = eval_root;                         \
+       cx->blk_eval.cur_text = linestr;
 
 #define POPEVAL(cx)                                                    \
        in_eval = cx->blk_eval.old_in_eval;                             \
@@ -129,8 +112,10 @@ struct block_loop {
     OP *       last_op;
     SV **      itervar;
     SV *       itersave;
+    SV *       iterlval;
     AV *       iterary;
-    I32                iterix;
+    IV         iterix;
+    IV         itermax;
 };
 
 #define PUSHLOOP(cx, ivar, s)                                          \
@@ -139,14 +124,29 @@ struct block_loop {
        cx->blk_loop.redo_op = cLOOP->op_redoop;                        \
        cx->blk_loop.next_op = cLOOP->op_nextop;                        \
        cx->blk_loop.last_op = cLOOP->op_lastop;                        \
-       cx->blk_loop.itervar = ivar;                                    \
-       if (ivar)                                                       \
-           cx->blk_loop.itersave = *cx->blk_loop.itervar;
+       if (cx->blk_loop.itervar = (ivar))                              \
+           cx->blk_loop.itersave = SvREFCNT_inc(*cx->blk_loop.itervar);\
+       cx->blk_loop.iterlval = Nullsv;                                 \
+       cx->blk_loop.iterary = Nullav;                                  \
+       cx->blk_loop.iterix = -1;
 
 #define POPLOOP(cx)                                                    \
-       newsp           = stack_base + cx->blk_loop.resetsp;            \
-       if (cx->blk_loop.itervar)                                       \
-           *cx->blk_loop.itervar = cx->blk_loop.itersave;
+       { struct block_loop cxloop;                                     \
+         POPLOOP1(cx);                                                 \
+         POPLOOP2(); }
+
+#define POPLOOP1(cx)                                                   \
+       cxloop = cx->blk_loop;  /* because DESTROY may clobber *cx */   \
+       newsp = stack_base + cxloop.resetsp;
+
+#define POPLOOP2()                                                     \
+       SvREFCNT_dec(cxloop.iterlval);                                  \
+       if (cxloop.itervar) {                                           \
+           SvREFCNT_dec(*cxloop.itervar);                              \
+           *cxloop.itervar = cxloop.itersave;                          \
+       }                                                               \
+       if (cxloop.iterary && cxloop.iterary != curstack)               \
+           SvREFCNT_dec(cxloop.iterary);
 
 /* context common to subroutines, evals and loops */
 struct block {
@@ -176,31 +176,29 @@ struct block {
 #define blk_loop       cx_u.cx_blk.blk_u.blku_loop
 
 /* Enter a block. */
-#define PUSHBLOCK(cx,t,s) CXINC, cx = &cxstack[cxstack_ix],            \
+#define PUSHBLOCK(cx,t,sp) CXINC, cx = &cxstack[cxstack_ix],           \
        cx->cx_type             = t,                                    \
-       cx->blk_oldsp           = s - stack_base,                       \
+       cx->blk_oldsp           = sp - stack_base,                      \
        cx->blk_oldcop          = curcop,                               \
        cx->blk_oldmarksp       = markstack_ptr - markstack,            \
        cx->blk_oldscopesp      = scopestack_ix,                        \
        cx->blk_oldretsp        = retstack_ix,                          \
        cx->blk_oldpm           = curpm,                                \
        cx->blk_gimme           = gimme;                                \
-       if (debug & 4)                                                  \
-           fprintf(stderr,"Entering block %d, type %d\n",              \
-               cxstack_ix, t); 
+       DEBUG_l( PerlIO_printf(PerlIO_stderr(), "Entering block %ld, type %s\n",        \
+                   (long)cxstack_ix, block_type[t]); )
 
 /* Exit a block (RETURN and LAST). */
-#define POPBLOCK(cx) cx = &cxstack[cxstack_ix--],                      \
+#define POPBLOCK(cx,pm) cx = &cxstack[cxstack_ix--],                   \
        newsp           = stack_base + cx->blk_oldsp,                   \
        curcop          = cx->blk_oldcop,                               \
        markstack_ptr   = markstack + cx->blk_oldmarksp,                \
        scopestack_ix   = cx->blk_oldscopesp,                           \
        retstack_ix     = cx->blk_oldretsp,                             \
-       curpm           = cx->blk_oldpm,                                \
+       pm              = cx->blk_oldpm,                                \
        gimme           = cx->blk_gimme;                                \
-       if (debug & 4)                                                  \
-           fprintf(stderr,"Leaving block %d, type %d\n",               \
-               cxstack_ix+1,cx->cx_type);
+       DEBUG_l( PerlIO_printf(PerlIO_stderr(), "Leaving block %ld, type %s\n",         \
+                   (long)cxstack_ix+1,block_type[cx->cx_type]); )
 
 /* Continue a block elsewhere (NEXT and REDO). */
 #define TOPBLOCK(cx) cx = &cxstack[cxstack_ix],                                \
@@ -214,41 +212,53 @@ struct subst {
     I32                sbu_iters;
     I32                sbu_maxiters;
     I32                sbu_safebase;
-    I32                sbu_once;
+    I32                sbu_oldsave;
+    bool       sbu_once;
+    bool       sbu_rxtainted;
     char *     sbu_orig;
     SV *       sbu_dstr;
     SV *       sbu_targ;
     char *     sbu_s;
     char *     sbu_m;
     char *     sbu_strend;
-    char *     sbu_subbase;
+    void *     sbu_rxres;
+    REGEXP *   sbu_rx;
 };
 #define sb_iters       cx_u.cx_subst.sbu_iters
 #define sb_maxiters    cx_u.cx_subst.sbu_maxiters
 #define sb_safebase    cx_u.cx_subst.sbu_safebase
+#define sb_oldsave     cx_u.cx_subst.sbu_oldsave
 #define sb_once                cx_u.cx_subst.sbu_once
+#define sb_rxtainted   cx_u.cx_subst.sbu_rxtainted
 #define sb_orig                cx_u.cx_subst.sbu_orig
 #define sb_dstr                cx_u.cx_subst.sbu_dstr
 #define sb_targ                cx_u.cx_subst.sbu_targ
 #define sb_s           cx_u.cx_subst.sbu_s
 #define sb_m           cx_u.cx_subst.sbu_m
 #define sb_strend      cx_u.cx_subst.sbu_strend
-#define sb_subbase     cx_u.cx_subst.sbu_subbase
+#define sb_rxres       cx_u.cx_subst.sbu_rxres
+#define sb_rx          cx_u.cx_subst.sbu_rx
 
 #define PUSHSUBST(cx) CXINC, cx = &cxstack[cxstack_ix],                        \
        cx->sb_iters            = iters,                                \
        cx->sb_maxiters         = maxiters,                             \
        cx->sb_safebase         = safebase,                             \
+       cx->sb_oldsave          = oldsave,                              \
        cx->sb_once             = once,                                 \
+       cx->sb_rxtainted        = rxtainted,                            \
        cx->sb_orig             = orig,                                 \
        cx->sb_dstr             = dstr,                                 \
        cx->sb_targ             = targ,                                 \
        cx->sb_s                = s,                                    \
        cx->sb_m                = m,                                    \
        cx->sb_strend           = strend,                               \
-       cx->cx_type             = CXt_SUBST
+       cx->sb_rxres            = Null(void*),                          \
+       cx->sb_rx               = rx,                                   \
+       cx->cx_type             = CXt_SUBST;                            \
+       rxres_save(&cx->sb_rxres, rx)
 
-#define POPSUBST(cx) cxstack_ix--
+#define POPSUBST(cx) cx = &cxstack[cxstack_ix--];                      \
+       rxres_free(&cx->sb_rxres)
 
 struct context {
     I32                cx_type;        /* what kind of context this is */
@@ -267,6 +277,92 @@ struct context {
 #define CXINC (cxstack_ix < cxstack_max ? ++cxstack_ix : (cxstack_ix = cxinc()))
 
 /* "gimme" values */
-#define G_SCALAR 0
-#define G_ARRAY 1
+#define G_SCALAR       0
+#define G_ARRAY                1
+#define G_VOID         128     /* skip this bit when adding flags below */
 
+/* extra flags for perl_call_* routines */
+#define G_DISCARD      2       /* Call FREETMPS. */
+#define G_EVAL         4       /* Assume eval {} around subroutine call. */
+#define G_NOARGS       8       /* Don't construct a @_ array. */
+#define G_KEEPERR      16      /* Append errors to $@, don't overwrite it */
+#define G_NODEBUG      32      /* Disable debugging at toplevel.  */
+
+/* Support for switching (stack and block) contexts.
+ * This ensures magic doesn't invalidate local stack and cx pointers.
+ */
+
+#define PERLSI_UNKNOWN         -1
+#define PERLSI_UNDEF           0
+#define PERLSI_MAIN            1
+#define PERLSI_MAGIC           2
+#define PERLSI_SORT            3
+#define PERLSI_SIGNAL          4
+#define PERLSI_OVERLOAD                5
+#define PERLSI_DESTROY         6
+#define PERLSI_WARNHOOK                7
+#define PERLSI_DIEHOOK         8
+#define PERLSI_REQUIRE         9
+
+struct stackinfo {
+    AV *               si_stack;       /* stack for current runlevel */
+    PERL_CONTEXT *     si_cxstack;     /* context stack for runlevel */
+    I32                        si_cxix;        /* current context index */
+    I32                        si_cxmax;       /* maximum allocated index */
+    I32                        si_type;        /* type of runlevel */
+    struct stackinfo * si_prev;
+    struct stackinfo * si_next;
+    I32 *              si_markbase;    /* where markstack begins for us.
+                                        * currently used only with DEBUGGING,
+                                        * but not #ifdef-ed for bincompat */
+};
+
+typedef struct stackinfo PERL_SI;
+
+#define cxstack                (curstackinfo->si_cxstack)
+#define cxstack_ix     (curstackinfo->si_cxix)
+#define cxstack_max    (curstackinfo->si_cxmax)
+
+#ifdef DEBUGGING
+#  define      SET_MARKBASE curstackinfo->si_markbase = markstack_ptr
+#else
+#  define      SET_MARKBASE NOOP
+#endif
+
+#define PUSHSTACKi(type) \
+    STMT_START {                                                       \
+       PERL_SI *next = curstackinfo->si_next;                          \
+       if (!next) {                                                    \
+           next = new_stackinfo(32, 2048/sizeof(PERL_CONTEXT) - 1);    \
+           next->si_prev = curstackinfo;                               \
+           curstackinfo->si_next = next;                               \
+       }                                                               \
+       next->si_type = type;                                           \
+       next->si_cxix = -1;                                             \
+       AvFILLp(next->si_stack) = 0;                                    \
+       SWITCHSTACK(curstack,next->si_stack);                           \
+       curstackinfo = next;                                            \
+       SET_MARKBASE;                                                   \
+    } STMT_END
+
+#define PUSHSTACK PUSHSTACKi(PERLSI_UNKNOWN)
+
+#define POPSTACK \
+    STMT_START {                                                       \
+       PERL_SI *prev = curstackinfo->si_prev;                          \
+       if (!prev) {                                                    \
+           PerlIO_printf(PerlIO_stderr(), "panic: POPSTACK\n");        \
+           my_exit(1);                                                 \
+       }                                                               \
+       SWITCHSTACK(curstack,prev->si_stack);                           \
+       /* don't free prev here, free them all at the END{} */          \
+       curstackinfo = prev;                                            \
+    } STMT_END
+
+#define POPSTACK_TO(s) \
+    STMT_START {                                                       \
+       while (curstack != s) {                                         \
+           dounwind(-1);                                               \
+           POPSTACK;                                                   \
+       }                                                               \
+    } STMT_END