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