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