This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
fix bug in change#4515 (STOP blocks now see @ARGV like the rest)
[perl5.git] / cop.h
CommitLineData
a0d0e21e 1/* cop.h
79072805 2 *
4eb8286e 3 * Copyright (c) 1991-1999, 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 */
57843af0 13#ifdef USE_ITHREADS
11faa288 14 char * cop_stashpv; /* package line was compiled in */
57843af0
GS
15 char * cop_file; /* file name the following line # is from */
16#else
11faa288 17 HV * cop_stash; /* package line was compiled in */
79072805 18 GV * cop_filegv; /* file the following line # is from */
57843af0 19#endif
a0d0e21e
LW
20 U32 cop_seq; /* parse sequence number */
21 I32 cop_arybase; /* array base this line was compiled with */
79072805 22 line_t cop_line; /* line # of this command */
599cee73 23 SV * cop_warnings; /* lexical warnings bitmask */
79072805
LW
24};
25
26#define Nullcop Null(COP*)
27
57843af0
GS
28#ifdef USE_ITHREADS
29# define CopFILE(c) ((c)->cop_file)
30# define CopFILEGV(c) (CopFILE(c) \
31 ? gv_fetchfile(CopFILE(c)) : Nullgv)
32# define CopFILE_set(c,pv) ((c)->cop_file = savepv(pv)) /* XXX */
33# define CopFILESV(c) (CopFILE(c) \
34 ? GvSV(gv_fetchfile(CopFILE(c))) : Nullsv)
35# define CopFILEAV(c) (CopFILE(c) \
36 ? GvAV(gv_fetchfile(CopFILE(c))) : Nullav)
57843af0 37# define CopSTASHPV(c) ((c)->cop_stashpv)
11faa288
GS
38# define CopSTASHPV_set(c,pv) ((c)->cop_stashpv = savepv(pv)) /* XXX */
39# define CopSTASH(c) (CopSTASHPV(c) \
40 ? gv_stashpv(CopSTASHPV(c),GV_ADD) : Nullhv)
41# define CopSTASH_set(c,hv) CopSTASHPV_set(c, HvNAME(hv))
57843af0
GS
42#else
43# define CopFILEGV(c) ((c)->cop_filegv)
44# define CopFILEGV_set(c,gv) ((c)->cop_filegv = gv)
45# define CopFILE_set(c,pv) ((c)->cop_filegv = gv_fetchfile(pv))
46# define CopFILESV(c) (CopFILEGV(c) ? GvSV(CopFILEGV(c)) : Nullsv)
47# define CopFILEAV(c) (CopFILEGV(c) ? GvAV(CopFILEGV(c)) : Nullav)
48# define CopFILE(c) (CopFILESV(c) ? SvPVX(CopFILESV(c)) : Nullch)
49# define CopSTASH(c) ((c)->cop_stash)
50# define CopSTASH_set(c,hv) ((c)->cop_stash = hv)
51# define CopSTASHPV(c) (CopSTASH(c) ? HvNAME(CopSTASH(c)) : Nullch)
11faa288 52# define CopSTASHPV_set(c,pv) CopSTASH_set(c, gv_stashpv(pv,GV_ADD))
57843af0
GS
53#endif /* USE_ITHREADS */
54
cc49e20b 55#define CopLINE(c) ((c)->cop_line)
57843af0
GS
56#define CopLINE_inc(c) (++CopLINE(c))
57#define CopLINE_dec(c) (--CopLINE(c))
58#define CopLINE_set(c,l) (CopLINE(c) = (l))
cc49e20b 59
79072805
LW
60/*
61 * Here we have some enormously heavy (or at least ponderous) wizardry.
62 */
63
64/* subroutine context */
65struct block_sub {
66 CV * cv;
67 GV * gv;
463ee0b2 68 GV * dfoutgv;
6d4ff0d2 69#ifndef USE_THREADS
79072805 70 AV * savearray;
6d4ff0d2 71#endif /* USE_THREADS */
79072805
LW
72 AV * argarray;
73 U16 olddepth;
74 U8 hasargs;
cd06dffe 75 U8 lval; /* XXX merge lval and hasargs? */
79072805
LW
76};
77
78#define PUSHSUB(cx) \
79 cx->blk_sub.cv = cv; \
79072805 80 cx->blk_sub.olddepth = CvDEPTH(cv); \
cd06dffe
GS
81 cx->blk_sub.hasargs = hasargs; \
82 cx->blk_sub.lval = PL_op->op_private & \
83 (OPpLVAL_INTRO|OPpENTERSUB_INARGS);
79072805
LW
84
85#define PUSHFORMAT(cx) \
86 cx->blk_sub.cv = cv; \
87 cx->blk_sub.gv = gv; \
4633a7c4 88 cx->blk_sub.hasargs = 0; \
3280af22 89 cx->blk_sub.dfoutgv = PL_defoutgv; \
4633a7c4 90 (void)SvREFCNT_inc(cx->blk_sub.dfoutgv)
79072805 91
6d4ff0d2
MB
92#ifdef USE_THREADS
93#define POPSAVEARRAY() NOOP
94#else
95#define POPSAVEARRAY() \
96 STMT_START { \
3280af22 97 SvREFCNT_dec(GvAV(PL_defgv)); \
a8bba7fa 98 GvAV(PL_defgv) = cx->blk_sub.savearray; \
6d4ff0d2
MB
99 } STMT_END
100#endif /* USE_THREADS */
101
b0d9ce38
GS
102#define POPSUB(cx,sv) \
103 STMT_START { \
a8bba7fa 104 if (cx->blk_sub.hasargs) { \
6d4ff0d2 105 POPSAVEARRAY(); \
d8b46c1b 106 /* abandon @_ if it got reified */ \
a8bba7fa
GS
107 if (AvREAL(cx->blk_sub.argarray)) { \
108 SSize_t fill = AvFILLp(cx->blk_sub.argarray); \
109 SvREFCNT_dec(cx->blk_sub.argarray); \
110 cx->blk_sub.argarray = newAV(); \
111 av_extend(cx->blk_sub.argarray, fill); \
112 AvFLAGS(cx->blk_sub.argarray) = AVf_REIFY; \
113 PL_curpad[0] = (SV*)cx->blk_sub.argarray; \
d8b46c1b 114 } \
79072805 115 } \
b0d9ce38
GS
116 sv = (SV*)cx->blk_sub.cv; \
117 if (sv && (CvDEPTH((CV*)sv) = cx->blk_sub.olddepth)) \
118 sv = Nullsv; \
119 } STMT_END
120
121#define LEAVESUB(sv) \
122 STMT_START { \
123 if (sv) \
124 SvREFCNT_dec(sv); \
125 } STMT_END
79072805
LW
126
127#define POPFORMAT(cx) \
4633a7c4
LW
128 setdefout(cx->blk_sub.dfoutgv); \
129 SvREFCNT_dec(cx->blk_sub.dfoutgv);
79072805
LW
130
131/* eval context */
132struct block_eval {
133 I32 old_in_eval;
134 I32 old_op_type;
135 char * old_name;
136 OP * old_eval_root;
748a9306 137 SV * cur_text;
79072805
LW
138};
139
8990e307 140#define PUSHEVAL(cx,n,fgv) \
3280af22 141 cx->blk_eval.old_in_eval = PL_in_eval; \
a8bba7fa 142 cx->blk_eval.old_op_type = PL_op->op_type; \
79072805 143 cx->blk_eval.old_name = n; \
a8bba7fa 144 cx->blk_eval.old_eval_root = PL_eval_root; \
3280af22 145 cx->blk_eval.cur_text = PL_linestr;
79072805
LW
146
147#define POPEVAL(cx) \
3280af22 148 PL_in_eval = cx->blk_eval.old_in_eval; \
79072805 149 optype = cx->blk_eval.old_op_type; \
3280af22 150 PL_eval_root = cx->blk_eval.old_eval_root;
79072805
LW
151
152/* loop context */
153struct block_loop {
154 char * label;
155 I32 resetsp;
156 OP * redo_op;
157 OP * next_op;
158 OP * last_op;
159 SV ** itervar;
160 SV * itersave;
5f05dabc 161 SV * iterlval;
79072805 162 AV * iterary;
89ea2908
GA
163 IV iterix;
164 IV itermax;
79072805
LW
165};
166
167#define PUSHLOOP(cx, ivar, s) \
38a230cb
GS
168 cx->blk_loop.label = PL_curcop->cop_label; \
169 cx->blk_loop.resetsp = s - PL_stack_base; \
79072805
LW
170 cx->blk_loop.redo_op = cLOOP->op_redoop; \
171 cx->blk_loop.next_op = cLOOP->op_nextop; \
172 cx->blk_loop.last_op = cLOOP->op_lastop; \
7a4c00b4 173 if (cx->blk_loop.itervar = (ivar)) \
44a8e56a
PP
174 cx->blk_loop.itersave = SvREFCNT_inc(*cx->blk_loop.itervar);\
175 cx->blk_loop.iterlval = Nullsv; \
176 cx->blk_loop.iterary = Nullav; \
177 cx->blk_loop.iterix = -1;
79072805
LW
178
179#define POPLOOP(cx) \
a8bba7fa
GS
180 SvREFCNT_dec(cx->blk_loop.iterlval); \
181 if (cx->blk_loop.itervar) { \
182 sv_2mortal(*(cx->blk_loop.itervar)); \
183 *(cx->blk_loop.itervar) = cx->blk_loop.itersave; \
44a8e56a 184 } \
a8bba7fa
GS
185 if (cx->blk_loop.iterary && cx->blk_loop.iterary != PL_curstack)\
186 SvREFCNT_dec(cx->blk_loop.iterary);
79072805
LW
187
188/* context common to subroutines, evals and loops */
189struct block {
190 I32 blku_oldsp; /* stack pointer to copy stuff down to */
191 COP * blku_oldcop; /* old curcop pointer */
192 I32 blku_oldretsp; /* return stack index */
193 I32 blku_oldmarksp; /* mark stack index */
194 I32 blku_oldscopesp; /* scope stack index */
195 PMOP * blku_oldpm; /* values of pattern match vars */
196 U8 blku_gimme; /* is this block running in list context? */
197
198 union {
199 struct block_sub blku_sub;
200 struct block_eval blku_eval;
201 struct block_loop blku_loop;
202 } blk_u;
203};
204#define blk_oldsp cx_u.cx_blk.blku_oldsp
205#define blk_oldcop cx_u.cx_blk.blku_oldcop
206#define blk_oldretsp cx_u.cx_blk.blku_oldretsp
207#define blk_oldmarksp cx_u.cx_blk.blku_oldmarksp
208#define blk_oldscopesp cx_u.cx_blk.blku_oldscopesp
209#define blk_oldpm cx_u.cx_blk.blku_oldpm
210#define blk_gimme cx_u.cx_blk.blku_gimme
211#define blk_sub cx_u.cx_blk.blk_u.blku_sub
212#define blk_eval cx_u.cx_blk.blk_u.blku_eval
213#define blk_loop cx_u.cx_blk.blk_u.blku_loop
214
215/* Enter a block. */
8990e307 216#define PUSHBLOCK(cx,t,sp) CXINC, cx = &cxstack[cxstack_ix], \
79072805 217 cx->cx_type = t, \
3280af22
NIS
218 cx->blk_oldsp = sp - PL_stack_base, \
219 cx->blk_oldcop = PL_curcop, \
1aff0e91 220 cx->blk_oldmarksp = PL_markstack_ptr - PL_markstack, \
3280af22 221 cx->blk_oldscopesp = PL_scopestack_ix, \
1aff0e91 222 cx->blk_oldretsp = PL_retstack_ix, \
3280af22 223 cx->blk_oldpm = PL_curpm, \
79072805 224 cx->blk_gimme = gimme; \
bf49b057 225 DEBUG_l( PerlIO_printf(Perl_debug_log, "Entering block %ld, type %s\n", \
1aff0e91 226 (long)cxstack_ix, PL_block_type[CxTYPE(cx)]); )
79072805
LW
227
228/* Exit a block (RETURN and LAST). */
a0d0e21e 229#define POPBLOCK(cx,pm) cx = &cxstack[cxstack_ix--], \
1aff0e91 230 newsp = PL_stack_base + cx->blk_oldsp, \
3280af22
NIS
231 PL_curcop = cx->blk_oldcop, \
232 PL_markstack_ptr = PL_markstack + cx->blk_oldmarksp, \
233 PL_scopestack_ix = cx->blk_oldscopesp, \
234 PL_retstack_ix = cx->blk_oldretsp, \
235 pm = cx->blk_oldpm, \
236 gimme = cx->blk_gimme; \
bf49b057 237 DEBUG_l( PerlIO_printf(Perl_debug_log, "Leaving block %ld, type %s\n", \
22c35a8c 238 (long)cxstack_ix+1,PL_block_type[CxTYPE(cx)]); )
79072805
LW
239
240/* Continue a block elsewhere (NEXT and REDO). */
3280af22 241#define TOPBLOCK(cx) cx = &cxstack[cxstack_ix], \
1aff0e91 242 PL_stack_sp = PL_stack_base + cx->blk_oldsp, \
3280af22
NIS
243 PL_markstack_ptr = PL_markstack + cx->blk_oldmarksp, \
244 PL_scopestack_ix = cx->blk_oldscopesp, \
2158dd9b
GS
245 PL_retstack_ix = cx->blk_oldretsp, \
246 PL_curpm = cx->blk_oldpm
79072805
LW
247
248/* substitution context */
249struct subst {
250 I32 sbu_iters;
251 I32 sbu_maxiters;
22e551b9 252 I32 sbu_rflags;
4633a7c4 253 I32 sbu_oldsave;
71be2cbc
PP
254 bool sbu_once;
255 bool sbu_rxtainted;
79072805
LW
256 char * sbu_orig;
257 SV * sbu_dstr;
258 SV * sbu_targ;
259 char * sbu_s;
260 char * sbu_m;
261 char * sbu_strend;
c90c0ff4 262 void * sbu_rxres;
c07a80fd 263 REGEXP * sbu_rx;
79072805
LW
264};
265#define sb_iters cx_u.cx_subst.sbu_iters
266#define sb_maxiters cx_u.cx_subst.sbu_maxiters
22e551b9 267#define sb_rflags cx_u.cx_subst.sbu_rflags
4633a7c4 268#define sb_oldsave cx_u.cx_subst.sbu_oldsave
71be2cbc
PP
269#define sb_once cx_u.cx_subst.sbu_once
270#define sb_rxtainted cx_u.cx_subst.sbu_rxtainted
79072805
LW
271#define sb_orig cx_u.cx_subst.sbu_orig
272#define sb_dstr cx_u.cx_subst.sbu_dstr
273#define sb_targ cx_u.cx_subst.sbu_targ
274#define sb_s cx_u.cx_subst.sbu_s
275#define sb_m cx_u.cx_subst.sbu_m
276#define sb_strend cx_u.cx_subst.sbu_strend
c90c0ff4 277#define sb_rxres cx_u.cx_subst.sbu_rxres
c07a80fd 278#define sb_rx cx_u.cx_subst.sbu_rx
79072805
LW
279
280#define PUSHSUBST(cx) CXINC, cx = &cxstack[cxstack_ix], \
281 cx->sb_iters = iters, \
282 cx->sb_maxiters = maxiters, \
22e551b9 283 cx->sb_rflags = r_flags, \
4633a7c4 284 cx->sb_oldsave = oldsave, \
71be2cbc
PP
285 cx->sb_once = once, \
286 cx->sb_rxtainted = rxtainted, \
79072805
LW
287 cx->sb_orig = orig, \
288 cx->sb_dstr = dstr, \
289 cx->sb_targ = targ, \
290 cx->sb_s = s, \
291 cx->sb_m = m, \
292 cx->sb_strend = strend, \
c90c0ff4 293 cx->sb_rxres = Null(void*), \
c07a80fd 294 cx->sb_rx = rx, \
c90c0ff4
PP
295 cx->cx_type = CXt_SUBST; \
296 rxres_save(&cx->sb_rxres, rx)
79072805 297
c90c0ff4
PP
298#define POPSUBST(cx) cx = &cxstack[cxstack_ix--]; \
299 rxres_free(&cx->sb_rxres)
79072805
LW
300
301struct context {
6b35e009 302 U32 cx_type; /* what kind of context this is */
79072805
LW
303 union {
304 struct block cx_blk;
305 struct subst cx_subst;
306 } cx_u;
307};
6b35e009
GS
308
309#define CXTYPEMASK 0xff
79072805
LW
310#define CXt_NULL 0
311#define CXt_SUB 1
312#define CXt_EVAL 2
313#define CXt_LOOP 3
314#define CXt_SUBST 4
315#define CXt_BLOCK 5
316
6b35e009
GS
317/* private flags for CXt_EVAL */
318#define CXp_REAL 0x00000100 /* truly eval'', not a lookalike */
319
320#define CxTYPE(c) ((c)->cx_type & CXTYPEMASK)
321#define CxREALEVAL(c) (((c)->cx_type & (CXt_EVAL|CXp_REAL)) == (CXt_EVAL|CXp_REAL))
322
79072805
LW
323#define CXINC (cxstack_ix < cxstack_max ? ++cxstack_ix : (cxstack_ix = cxinc()))
324
325/* "gimme" values */
a0d0e21e
LW
326#define G_SCALAR 0
327#define G_ARRAY 1
54310121 328#define G_VOID 128 /* skip this bit when adding flags below */
79072805 329
864dbfa3 330/* extra flags for Perl_call_* routines */
a0d0e21e
LW
331#define G_DISCARD 2 /* Call FREETMPS. */
332#define G_EVAL 4 /* Assume eval {} around subroutine call. */
333#define G_NOARGS 8 /* Don't construct a @_ array. */
54310121 334#define G_KEEPERR 16 /* Append errors to $@, don't overwrite it */
491527d0 335#define G_NODEBUG 32 /* Disable debugging at toplevel. */
e336de0d 336
faef0170
HS
337/* flag bits for PL_in_eval */
338#define EVAL_NULL 0 /* not in an eval */
339#define EVAL_INEVAL 1 /* some enclosing scope is an eval */
340#define EVAL_WARNONLY 2 /* used by yywarn() when calling yyerror() */
864dbfa3 341#define EVAL_KEEPERR 4 /* set by Perl_call_sv if G_KEEPERR */
faef0170 342
e336de0d
GS
343/* Support for switching (stack and block) contexts.
344 * This ensures magic doesn't invalidate local stack and cx pointers.
345 */
346
e788e7d3
GS
347#define PERLSI_UNKNOWN -1
348#define PERLSI_UNDEF 0
349#define PERLSI_MAIN 1
350#define PERLSI_MAGIC 2
351#define PERLSI_SORT 3
352#define PERLSI_SIGNAL 4
353#define PERLSI_OVERLOAD 5
354#define PERLSI_DESTROY 6
355#define PERLSI_WARNHOOK 7
356#define PERLSI_DIEHOOK 8
357#define PERLSI_REQUIRE 9
e336de0d
GS
358
359struct stackinfo {
360 AV * si_stack; /* stack for current runlevel */
361 PERL_CONTEXT * si_cxstack; /* context stack for runlevel */
362 I32 si_cxix; /* current context index */
363 I32 si_cxmax; /* maximum allocated index */
364 I32 si_type; /* type of runlevel */
365 struct stackinfo * si_prev;
366 struct stackinfo * si_next;
367 I32 * si_markbase; /* where markstack begins for us.
368 * currently used only with DEBUGGING,
369 * but not #ifdef-ed for bincompat */
370};
371
372typedef struct stackinfo PERL_SI;
373
3280af22
NIS
374#define cxstack (PL_curstackinfo->si_cxstack)
375#define cxstack_ix (PL_curstackinfo->si_cxix)
376#define cxstack_max (PL_curstackinfo->si_cxmax)
e336de0d
GS
377
378#ifdef DEBUGGING
3280af22 379# define SET_MARKBASE PL_curstackinfo->si_markbase = PL_markstack_ptr
e336de0d
GS
380#else
381# define SET_MARKBASE NOOP
382#endif
383
d3acc0f7 384#define PUSHSTACKi(type) \
e336de0d 385 STMT_START { \
3280af22 386 PERL_SI *next = PL_curstackinfo->si_next; \
e336de0d
GS
387 if (!next) { \
388 next = new_stackinfo(32, 2048/sizeof(PERL_CONTEXT) - 1); \
3280af22
NIS
389 next->si_prev = PL_curstackinfo; \
390 PL_curstackinfo->si_next = next; \
e336de0d
GS
391 } \
392 next->si_type = type; \
393 next->si_cxix = -1; \
394 AvFILLp(next->si_stack) = 0; \
3280af22
NIS
395 SWITCHSTACK(PL_curstack,next->si_stack); \
396 PL_curstackinfo = next; \
e336de0d
GS
397 SET_MARKBASE; \
398 } STMT_END
399
e788e7d3 400#define PUSHSTACK PUSHSTACKi(PERLSI_UNKNOWN)
d3acc0f7 401
3095d977
GS
402/* POPSTACK works with PL_stack_sp, so it may need to be bracketed by
403 * PUTBACK/SPAGAIN to flush/refresh any local SP that may be active */
d3acc0f7 404#define POPSTACK \
e336de0d 405 STMT_START { \
de616352 406 djSP; \
3280af22 407 PERL_SI *prev = PL_curstackinfo->si_prev; \
e336de0d 408 if (!prev) { \
bf49b057 409 PerlIO_printf(Perl_error_log, "panic: POPSTACK\n"); \
e336de0d
GS
410 my_exit(1); \
411 } \
3280af22 412 SWITCHSTACK(PL_curstack,prev->si_stack); \
e336de0d 413 /* don't free prev here, free them all at the END{} */ \
3280af22 414 PL_curstackinfo = prev; \
e336de0d
GS
415 } STMT_END
416
417#define POPSTACK_TO(s) \
418 STMT_START { \
3280af22 419 while (PL_curstack != s) { \
bac4b2ad 420 dounwind(-1); \
d3acc0f7 421 POPSTACK; \
bac4b2ad 422 } \
e336de0d 423 } STMT_END